Acl expansions: tests and documentation
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing. 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 The distributions are currently signed with Nigel Metheringham's GPG key. The
537 corresponding public key is available from a number of keyservers, and there is
538 also a copy in the file &_nigel-pubkey.asc_&. The signatures for the tar bundles are
539 in:
540 .display
541 &_exim-n.nn.tar.gz.asc_&
542 &_exim-n.nn.tar.bz2.asc_&
543 .endd
544 For each released version, the log of changes is made separately available in a
545 separate file in the directory &_ChangeLogs_& so that it is possible to
546 find out what has changed without having to download the entire distribution.
547
548 .cindex "documentation" "available formats"
549 The main distribution contains ASCII versions of this specification and other
550 documentation; other formats of the documents are available in separate files
551 inside the &_exim4_& directory of the FTP site:
552 .display
553 &_exim-html-n.nn.tar.gz_&
554 &_exim-pdf-n.nn.tar.gz_&
555 &_exim-postscript-n.nn.tar.gz_&
556 &_exim-texinfo-n.nn.tar.gz_&
557 .endd
558 These tar files contain only the &_doc_& directory, not the complete
559 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
560
561
562 .section "Limitations" "SECID6"
563 .ilist
564 .cindex "limitations of Exim"
565 .cindex "bang paths" "not handled by Exim"
566 Exim is designed for use as an Internet MTA, and therefore handles addresses in
567 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
568 simple two-component bang paths can be converted by a straightforward rewriting
569 configuration. This restriction does not prevent Exim from being interfaced to
570 UUCP as a transport mechanism, provided that domain addresses are used.
571 .next
572 .cindex "domainless addresses"
573 .cindex "address" "without domain"
574 Exim insists that every address it handles has a domain attached. For incoming
575 local messages, domainless addresses are automatically qualified with a
576 configured domain value. Configuration options specify from which remote
577 systems unqualified addresses are acceptable. These are then qualified on
578 arrival.
579 .next
580 .cindex "transport" "external"
581 .cindex "external transports"
582 The only external transport mechanisms that are currently implemented are SMTP
583 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
584 transport is available, and there are facilities for writing messages to files
585 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
586 to send messages to other transport mechanisms such as UUCP, provided they can
587 handle domain-style addresses. Batched SMTP input is also catered for.
588 .next
589 Exim is not designed for storing mail for dial-in hosts. When the volumes of
590 such mail are large, it is better to get the messages &"delivered"& into files
591 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
592 other means.
593 .next
594 Although Exim does have basic facilities for scanning incoming messages, these
595 are not comprehensive enough to do full virus or spam scanning. Such operations
596 are best carried out using additional specialized software packages. If you
597 compile Exim with the content-scanning extension, straightforward interfaces to
598 a number of common scanners are provided.
599 .endlist
600
601
602 .section "Run time configuration" "SECID7"
603 Exim's run time configuration is held in a single text file that is divided
604 into a number of sections. The entries in this file consist of keywords and
605 values, in the style of Smail 3 configuration files. A default configuration
606 file which is suitable for simple online installations is provided in the
607 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
608
609
610 .section "Calling interface" "SECID8"
611 .cindex "Sendmail compatibility" "command line interface"
612 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
613 can be a straight replacement for &_/usr/lib/sendmail_& or
614 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
615 about Sendmail in order to run Exim. For actions other than sending messages,
616 Sendmail-compatible options also exist, but those that produce output (for
617 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
618 format. There are also some additional options that are compatible with Smail
619 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
620 documents all Exim's command line options. This information is automatically
621 made into the man page that forms part of the Exim distribution.
622
623 Control of messages on the queue can be done via certain privileged command
624 line options. There is also an optional monitor program called &'eximon'&,
625 which displays current information in an X window, and which contains a menu
626 interface to Exim's command line administration options.
627
628
629
630 .section "Terminology" "SECID9"
631 .cindex "terminology definitions"
632 .cindex "body of message" "definition of"
633 The &'body'& of a message is the actual data that the sender wants to transmit.
634 It is the last part of a message, and is separated from the &'header'& (see
635 below) by a blank line.
636
637 .cindex "bounce message" "definition of"
638 When a message cannot be delivered, it is normally returned to the sender in a
639 delivery failure message or a &"non-delivery report"& (NDR). The term
640 &'bounce'& is commonly used for this action, and the error reports are often
641 called &'bounce messages'&. This is a convenient shorthand for &"delivery
642 failure error report"&. Such messages have an empty sender address in the
643 message's &'envelope'& (see below) to ensure that they cannot themselves give
644 rise to further bounce messages.
645
646 The term &'default'& appears frequently in this manual. It is used to qualify a
647 value which is used in the absence of any setting in the configuration. It may
648 also qualify an action which is taken unless a configuration setting specifies
649 otherwise.
650
651 The term &'defer'& is used when the delivery of a message to a specific
652 destination cannot immediately take place for some reason (a remote host may be
653 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
654 until a later time.
655
656 The word &'domain'& is sometimes used to mean all but the first component of a
657 host's name. It is &'not'& used in that sense here, where it normally refers to
658 the part of an email address following the @ sign.
659
660 .cindex "envelope, definition of"
661 .cindex "sender" "definition of"
662 A message in transit has an associated &'envelope'&, as well as a header and a
663 body. The envelope contains a sender address (to which bounce messages should
664 be delivered), and any number of recipient addresses. References to the
665 sender or the recipients of a message usually mean the addresses in the
666 envelope. An MTA uses these addresses for delivery, and for returning bounce
667 messages, not the addresses that appear in the header lines.
668
669 .cindex "message" "header, definition of"
670 .cindex "header section" "definition of"
671 The &'header'& of a message is the first part of a message's text, consisting
672 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
673 &'Subject:'&, etc. Long header lines can be split over several text lines by
674 indenting the continuations. The header is separated from the body by a blank
675 line.
676
677 .cindex "local part" "definition of"
678 .cindex "domain" "definition of"
679 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
680 part of an email address that precedes the @ sign. The part that follows the
681 @ sign is called the &'domain'& or &'mail domain'&.
682
683 .cindex "local delivery" "definition of"
684 .cindex "remote delivery, definition of"
685 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
686 delivery to a file or a pipe on the local host from delivery by SMTP over
687 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
688 host it is running on are &'remote'&.
689
690 .cindex "return path" "definition of"
691 &'Return path'& is another name that is used for the sender address in a
692 message's envelope.
693
694 .cindex "queue" "definition of"
695 The term &'queue'& is used to refer to the set of messages awaiting delivery,
696 because this term is in widespread use in the context of MTAs. However, in
697 Exim's case the reality is more like a pool than a queue, because there is
698 normally no ordering of waiting messages.
699
700 .cindex "queue runner" "definition of"
701 The term &'queue runner'& is used to describe a process that scans the queue
702 and attempts to deliver those messages whose retry times have come. This term
703 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
704 the waiting messages are normally processed in an unpredictable order.
705
706 .cindex "spool directory" "definition of"
707 The term &'spool directory'& is used for a directory in which Exim keeps the
708 messages on its queue &-- that is, those that it is in the process of
709 delivering. This should not be confused with the directory in which local
710 mailboxes are stored, which is called a &"spool directory"& by some people. In
711 the Exim documentation, &"spool"& is always used in the first sense.
712
713
714
715
716
717
718 . ////////////////////////////////////////////////////////////////////////////
719 . ////////////////////////////////////////////////////////////////////////////
720
721 .chapter "Incorporated code" "CHID2"
722 .cindex "incorporated code"
723 .cindex "regular expressions" "library"
724 .cindex "PCRE"
725 A number of pieces of external code are included in the Exim distribution.
726
727 .ilist
728 Regular expressions are supported in the main Exim program and in the
729 Exim monitor using the freely-distributable PCRE library, copyright
730 &copy; University of Cambridge. The source to PCRE is no longer shipped with
731 Exim, so you will need to use the version of PCRE shipped with your system,
732 or obtain and install the full version of the library from
733 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
734 .next
735 .cindex "cdb" "acknowledgment"
736 Support for the cdb (Constant DataBase) lookup method is provided by code
737 contributed by Nigel Metheringham of (at the time he contributed it) Planet
738 Online Ltd. The implementation is completely contained within the code of Exim.
739 It does not link against an external cdb library. The code contains the
740 following statements:
741
742 .blockquote
743 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
744
745 This program is free software; you can redistribute it and/or modify it under
746 the terms of the GNU General Public License as published by the Free Software
747 Foundation; either version 2 of the License, or (at your option) any later
748 version.
749 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
750 the spec and sample code for cdb can be obtained from
751 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
752 some code from Dan Bernstein's implementation (which has no license
753 restrictions applied to it).
754 .endblockquote
755 .next
756 .cindex "SPA authentication"
757 .cindex "Samba project"
758 .cindex "Microsoft Secure Password Authentication"
759 Client support for Microsoft's &'Secure Password Authentication'& is provided
760 by code contributed by Marc Prud'hommeaux. Server support was contributed by
761 Tom Kistner. This includes code taken from the Samba project, which is released
762 under the Gnu GPL.
763 .next
764 .cindex "Cyrus"
765 .cindex "&'pwcheck'& daemon"
766 .cindex "&'pwauthd'& daemon"
767 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
768 by code taken from the Cyrus-SASL library and adapted by Alexander S.
769 Sabourenkov. The permission notice appears below, in accordance with the
770 conditions expressed therein.
771
772 .blockquote
773 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
774
775 Redistribution and use in source and binary forms, with or without
776 modification, are permitted provided that the following conditions
777 are met:
778
779 .olist
780 Redistributions of source code must retain the above copyright
781 notice, this list of conditions and the following disclaimer.
782 .next
783 Redistributions in binary form must reproduce the above copyright
784 notice, this list of conditions and the following disclaimer in
785 the documentation and/or other materials provided with the
786 distribution.
787 .next
788 The name &"Carnegie Mellon University"& must not be used to
789 endorse or promote products derived from this software without
790 prior written permission. For permission or any other legal
791 details, please contact
792 .display
793               Office of Technology Transfer
794               Carnegie Mellon University
795               5000 Forbes Avenue
796               Pittsburgh, PA  15213-3890
797               (412) 268-4387, fax: (412) 268-7395
798               tech-transfer@andrew.cmu.edu
799 .endd
800 .next
801 Redistributions of any form whatsoever must retain the following
802 acknowledgment:
803
804 &"This product includes software developed by Computing Services
805 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
806
807 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
808 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
809 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
810 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
811 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
812 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
813 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
814 .endlist
815 .endblockquote
816
817 .next
818 .cindex "Exim monitor" "acknowledgment"
819 .cindex "X-windows"
820 .cindex "Athena"
821 The Exim Monitor program, which is an X-Window application, includes
822 modified versions of the Athena StripChart and TextPop widgets.
823 This code is copyright by DEC and MIT, and their permission notice appears
824 below, in accordance with the conditions expressed therein.
825
826 .blockquote
827 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
828 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
829
830 All Rights Reserved
831
832 Permission to use, copy, modify, and distribute this software and its
833 documentation for any purpose and without fee is hereby granted,
834 provided that the above copyright notice appear in all copies and that
835 both that copyright notice and this permission notice appear in
836 supporting documentation, and that the names of Digital or MIT not be
837 used in advertising or publicity pertaining to distribution of the
838 software without specific, written prior permission.
839
840 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
841 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
842 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
843 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
844 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
845 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
846 SOFTWARE.
847 .endblockquote
848
849 .next
850 Many people have contributed code fragments, some large, some small, that were
851 not covered by any specific licence requirements. It is assumed that the
852 contributors are happy to see their code incorporated into Exim under the GPL.
853 .endlist
854
855
856
857
858
859 . ////////////////////////////////////////////////////////////////////////////
860 . ////////////////////////////////////////////////////////////////////////////
861
862 .chapter "How Exim receives and delivers mail" "CHID11" &&&
863          "Receiving and delivering mail"
864
865
866 .section "Overall philosophy" "SECID10"
867 .cindex "design philosophy"
868 Exim is designed to work efficiently on systems that are permanently connected
869 to the Internet and are handling a general mix of mail. In such circumstances,
870 most messages can be delivered immediately. Consequently, Exim does not
871 maintain independent queues of messages for specific domains or hosts, though
872 it does try to send several messages in a single SMTP connection after a host
873 has been down, and it also maintains per-host retry information.
874
875
876 .section "Policy control" "SECID11"
877 .cindex "policy control" "overview"
878 Policy controls are now an important feature of MTAs that are connected to the
879 Internet. Perhaps their most important job is to stop MTAs being abused as
880 &"open relays"& by misguided individuals who send out vast amounts of
881 unsolicited junk, and want to disguise its source. Exim provides flexible
882 facilities for specifying policy controls on incoming mail:
883
884 .ilist
885 .cindex "&ACL;" "introduction"
886 Exim 4 (unlike previous versions of Exim) implements policy controls on
887 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
888 series of statements that may either grant or deny access. ACLs can be used at
889 several places in the SMTP dialogue while receiving a message from a remote
890 host. However, the most common places are after each RCPT command, and at the
891 very end of the message. The sysadmin can specify conditions for accepting or
892 rejecting individual recipients or the entire message, respectively, at these
893 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
894 error code.
895 .next
896 An ACL is also available for locally generated, non-SMTP messages. In this
897 case, the only available actions are to accept or deny the entire message.
898 .next
899 When Exim is compiled with the content-scanning extension, facilities are
900 provided in the ACL mechanism for passing the message to external virus and/or
901 spam scanning software. The result of such a scan is passed back to the ACL,
902 which can then use it to decide what to do with the message.
903 .next
904 When a message has been received, either from a remote host or from the local
905 host, but before the final acknowledgment has been sent, a locally supplied C
906 function called &[local_scan()]& can be run to inspect the message and decide
907 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
908 is accepted, the list of recipients can be modified by the function.
909 .next
910 Using the &[local_scan()]& mechanism is another way of calling external scanner
911 software. The &%SA-Exim%& add-on package works this way. It does not require
912 Exim to be compiled with the content-scanning extension.
913 .next
914 After a message has been accepted, a further checking mechanism is available in
915 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
916 runs at the start of every delivery process.
917 .endlist
918
919
920
921 .section "User filters" "SECID12"
922 .cindex "filter" "introduction"
923 .cindex "Sieve filter"
924 In a conventional Exim configuration, users are able to run private filters by
925 setting up appropriate &_.forward_& files in their home directories. See
926 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
927 configuration needed to support this, and the separate document entitled
928 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
929 of filtering are available:
930
931 .ilist
932 Sieve filters are written in the standard filtering language that is defined
933 by RFC 3028.
934 .next
935 Exim filters are written in a syntax that is unique to Exim, but which is more
936 powerful than Sieve, which it pre-dates.
937 .endlist
938
939 User filters are run as part of the routing process, described below.
940
941
942
943 .section "Message identification" "SECTmessiden"
944 .cindex "message ids" "details of format"
945 .cindex "format" "of message id"
946 .cindex "id of message"
947 .cindex "base62"
948 .cindex "base36"
949 .cindex "Darwin"
950 .cindex "Cygwin"
951 Every message handled by Exim is given a &'message id'& which is sixteen
952 characters long. It is divided into three parts, separated by hyphens, for
953 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
954 normally encoding numbers in base 62. However, in the Darwin operating
955 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
956 (avoiding the use of lower case letters) is used instead, because the message
957 id is used to construct file names, and the names of files in those systems are
958 not always case-sensitive.
959
960 .cindex "pid (process id)" "re-use of"
961 The detail of the contents of the message id have changed as Exim has evolved.
962 Earlier versions relied on the operating system not re-using a process id (pid)
963 within one second. On modern operating systems, this assumption can no longer
964 be made, so the algorithm had to be changed. To retain backward compatibility,
965 the format of the message id was retained, which is why the following rules are
966 somewhat eccentric:
967
968 .ilist
969 The first six characters of the message id are the time at which the message
970 started to be received, to a granularity of one second. That is, this field
971 contains the number of seconds since the start of the epoch (the normal Unix
972 way of representing the date and time of day).
973 .next
974 After the first hyphen, the next six characters are the id of the process that
975 received the message.
976 .next
977 There are two different possibilities for the final two characters:
978 .olist
979 .oindex "&%localhost_number%&"
980 If &%localhost_number%& is not set, this value is the fractional part of the
981 time of reception, normally in units of 1/2000 of a second, but for systems
982 that must use base 36 instead of base 62 (because of case-insensitive file
983 systems), the units are 1/1000 of a second.
984 .next
985 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
986 the fractional part of the time, which in this case is in units of 1/200
987 (1/100) of a second.
988 .endlist
989 .endlist
990
991 After a message has been received, Exim waits for the clock to tick at the
992 appropriate resolution before proceeding, so that if another message is
993 received by the same process, or by another process with the same (re-used)
994 pid, it is guaranteed that the time will be different. In most cases, the clock
995 will already have ticked while the message was being received.
996
997
998 .section "Receiving mail" "SECID13"
999 .cindex "receiving mail"
1000 .cindex "message" "reception"
1001 The only way Exim can receive mail from another host is using SMTP over
1002 TCP/IP, in which case the sender and recipient addresses are transferred using
1003 SMTP commands. However, from a locally running process (such as a user's MUA),
1004 there are several possibilities:
1005
1006 .ilist
1007 If the process runs Exim with the &%-bm%& option, the message is read
1008 non-interactively (usually via a pipe), with the recipients taken from the
1009 command line, or from the body of the message if &%-t%& is also used.
1010 .next
1011 If the process runs Exim with the &%-bS%& option, the message is also read
1012 non-interactively, but in this case the recipients are listed at the start of
1013 the message in a series of SMTP RCPT commands, terminated by a DATA
1014 command. This is so-called &"batch SMTP"& format,
1015 but it isn't really SMTP. The SMTP commands are just another way of passing
1016 envelope addresses in a non-interactive submission.
1017 .next
1018 If the process runs Exim with the &%-bs%& option, the message is read
1019 interactively, using the SMTP protocol. A two-way pipe is normally used for
1020 passing data between the local process and the Exim process.
1021 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1022 example, the ACLs for SMTP commands are used for this form of submission.
1023 .next
1024 A local process may also make a TCP/IP call to the host's loopback address
1025 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1026 does not treat the loopback address specially. It treats all such connections
1027 in the same way as connections from other hosts.
1028 .endlist
1029
1030
1031 .cindex "message sender, constructed by Exim"
1032 .cindex "sender" "constructed by Exim"
1033 In the three cases that do not involve TCP/IP, the sender address is
1034 constructed from the login name of the user that called Exim and a default
1035 qualification domain (which can be set by the &%qualify_domain%& configuration
1036 option). For local or batch SMTP, a sender address that is passed using the
1037 SMTP MAIL command is ignored. However, the system administrator may allow
1038 certain users (&"trusted users"&) to specify a different sender address
1039 unconditionally, or all users to specify certain forms of different sender
1040 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1041 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1042 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1043 users to change sender addresses.
1044
1045 Messages received by either of the non-interactive mechanisms are subject to
1046 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1047 (either over TCP/IP, or interacting with a local process) can be checked by a
1048 number of ACLs that operate at different times during the SMTP session. Either
1049 individual recipients, or the entire message, can be rejected if local policy
1050 requirements are not met. The &[local_scan()]& function (see chapter
1051 &<<CHAPlocalscan>>&) is run for all incoming messages.
1052
1053 Exim can be configured not to start a delivery process when a message is
1054 received; this can be unconditional, or depend on the number of incoming SMTP
1055 connections or the system load. In these situations, new messages wait on the
1056 queue until a queue runner process picks them up. However, in standard
1057 configurations under normal conditions, delivery is started as soon as a
1058 message is received.
1059
1060
1061
1062
1063
1064 .section "Handling an incoming message" "SECID14"
1065 .cindex "spool directory" "files that hold a message"
1066 .cindex "file" "how a message is held"
1067 When Exim accepts a message, it writes two files in its spool directory. The
1068 first contains the envelope information, the current status of the message, and
1069 the header lines, and the second contains the body of the message. The names of
1070 the two spool files consist of the message id, followed by &`-H`& for the
1071 file containing the envelope and header, and &`-D`& for the data file.
1072
1073 .cindex "spool directory" "&_input_& sub-directory"
1074 By default all these message files are held in a single directory called
1075 &_input_& inside the general Exim spool directory. Some operating systems do
1076 not perform very well if the number of files in a directory gets large; to
1077 improve performance in such cases, the &%split_spool_directory%& option can be
1078 used. This causes Exim to split up the input files into 62 sub-directories
1079 whose names are single letters or digits. When this is done, the queue is
1080 processed one sub-directory at a time instead of all at once, which can improve
1081 overall performance even when there are not enough files in each directory to
1082 affect file system performance.
1083
1084 The envelope information consists of the address of the message's sender and
1085 the addresses of the recipients. This information is entirely separate from
1086 any addresses contained in the header lines. The status of the message includes
1087 a list of recipients who have already received the message. The format of the
1088 first spool file is described in chapter &<<CHAPspool>>&.
1089
1090 .cindex "rewriting" "addresses"
1091 Address rewriting that is specified in the rewrite section of the configuration
1092 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1093 both in the header lines and the envelope, at the time the message is accepted.
1094 If during the course of delivery additional addresses are generated (for
1095 example, via aliasing), these new addresses are rewritten as soon as they are
1096 generated. At the time a message is actually delivered (transported) further
1097 rewriting can take place; because this is a transport option, it can be
1098 different for different forms of delivery. It is also possible to specify the
1099 addition or removal of certain header lines at the time the message is
1100 delivered (see chapters &<<CHAProutergeneric>>& and
1101 &<<CHAPtransportgeneric>>&).
1102
1103
1104
1105 .section "Life of a message" "SECID15"
1106 .cindex "message" "life of"
1107 .cindex "message" "frozen"
1108 A message remains in the spool directory until it is completely delivered to
1109 its recipients or to an error address, or until it is deleted by an
1110 administrator or by the user who originally created it. In cases when delivery
1111 cannot proceed &-- for example, when a message can neither be delivered to its
1112 recipients nor returned to its sender, the message is marked &"frozen"& on the
1113 spool, and no more deliveries are attempted.
1114
1115 .cindex "frozen messages" "thawing"
1116 .cindex "message" "thawing frozen"
1117 An administrator can &"thaw"& such messages when the problem has been
1118 corrected, and can also freeze individual messages by hand if necessary. In
1119 addition, an administrator can force a delivery error, causing a bounce message
1120 to be sent.
1121
1122 .oindex "&%timeout_frozen_after%&"
1123 .oindex "&%ignore_bounce_errors_after%&"
1124 There are options called &%ignore_bounce_errors_after%& and
1125 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1126 The first applies only to frozen bounces, the second to any frozen messages.
1127
1128 .cindex "message" "log file for"
1129 .cindex "log" "file for each message"
1130 While Exim is working on a message, it writes information about each delivery
1131 attempt to its main log file. This includes successful, unsuccessful, and
1132 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1133 lines are also written to a separate &'message log'& file for each message.
1134 These logs are solely for the benefit of the administrator, and are normally
1135 deleted along with the spool files when processing of a message is complete.
1136 The use of individual message logs can be disabled by setting
1137 &%no_message_logs%&; this might give an improvement in performance on very busy
1138 systems.
1139
1140 .cindex "journal file"
1141 .cindex "file" "journal"
1142 All the information Exim itself needs to set up a delivery is kept in the first
1143 spool file, along with the header lines. When a successful delivery occurs, the
1144 address is immediately written at the end of a journal file, whose name is the
1145 message id followed by &`-J`&. At the end of a delivery run, if there are some
1146 addresses left to be tried again later, the first spool file (the &`-H`& file)
1147 is updated to indicate which these are, and the journal file is then deleted.
1148 Updating the spool file is done by writing a new file and renaming it, to
1149 minimize the possibility of data loss.
1150
1151 Should the system or the program crash after a successful delivery but before
1152 the spool file has been updated, the journal is left lying around. The next
1153 time Exim attempts to deliver the message, it reads the journal file and
1154 updates the spool file before proceeding. This minimizes the chances of double
1155 deliveries caused by crashes.
1156
1157
1158
1159 .section "Processing an address for delivery" "SECTprocaddress"
1160 .cindex "drivers" "definition of"
1161 .cindex "router" "definition of"
1162 .cindex "transport" "definition of"
1163 The main delivery processing elements of Exim are called &'routers'& and
1164 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1165 number of them is provided in the source distribution, and compile-time options
1166 specify which ones are included in the binary. Run time options specify which
1167 ones are actually used for delivering messages.
1168
1169 .cindex "drivers" "instance definition"
1170 Each driver that is specified in the run time configuration is an &'instance'&
1171 of that particular driver type. Multiple instances are allowed; for example,
1172 you can set up several different &(smtp)& transports, each with different
1173 option values that might specify different ports or different timeouts. Each
1174 instance has its own identifying name. In what follows we will normally use the
1175 instance name when discussing one particular instance (that is, one specific
1176 configuration of the driver), and the generic driver name when discussing
1177 the driver's features in general.
1178
1179 A &'router'& is a driver that operates on an address, either determining how
1180 its delivery should happen, by assigning it to a specific transport, or
1181 converting the address into one or more new addresses (for example, via an
1182 alias file). A router may also explicitly choose to fail an address, causing it
1183 to be bounced.
1184
1185 A &'transport'& is a driver that transmits a copy of the message from Exim's
1186 spool to some destination. There are two kinds of transport: for a &'local'&
1187 transport, the destination is a file or a pipe on the local host, whereas for a
1188 &'remote'& transport the destination is some other host. A message is passed
1189 to a specific transport as a result of successful routing. If a message has
1190 several recipients, it may be passed to a number of different transports.
1191
1192 .cindex "preconditions" "definition of"
1193 An address is processed by passing it to each configured router instance in
1194 turn, subject to certain preconditions, until a router accepts the address or
1195 specifies that it should be bounced. We will describe this process in more
1196 detail shortly. First, as a simple example, we consider how each recipient
1197 address in a message is processed in a small configuration of three routers.
1198
1199 To make this a more concrete example, it is described in terms of some actual
1200 routers, but remember, this is only an example. You can configure Exim's
1201 routers in many different ways, and there may be any number of routers in a
1202 configuration.
1203
1204 The first router that is specified in a configuration is often one that handles
1205 addresses in domains that are not recognized specially by the local host. These
1206 are typically addresses for arbitrary domains on the Internet. A precondition
1207 is set up which looks for the special domains known to the host (for example,
1208 its own domain name), and the router is run for addresses that do &'not'&
1209 match. Typically, this is a router that looks up domains in the DNS in order to
1210 find the hosts to which this address routes. If it succeeds, the address is
1211 assigned to a suitable SMTP transport; if it does not succeed, the router is
1212 configured to fail the address.
1213
1214 The second router is reached only when the domain is recognized as one that
1215 &"belongs"& to the local host. This router does redirection &-- also known as
1216 aliasing and forwarding. When it generates one or more new addresses from the
1217 original, each of them is routed independently from the start. Otherwise, the
1218 router may cause an address to fail, or it may simply decline to handle the
1219 address, in which case the address is passed to the next router.
1220
1221 The final router in many configurations is one that checks to see if the
1222 address belongs to a local mailbox. The precondition may involve a check to
1223 see if the local part is the name of a login account, or it may look up the
1224 local part in a file or a database. If its preconditions are not met, or if
1225 the router declines, we have reached the end of the routers. When this happens,
1226 the address is bounced.
1227
1228
1229
1230 .section "Processing an address for verification" "SECID16"
1231 .cindex "router" "for verification"
1232 .cindex "verifying address" "overview"
1233 As well as being used to decide how to deliver to an address, Exim's routers
1234 are also used for &'address verification'&. Verification can be requested as
1235 one of the checks to be performed in an ACL for incoming messages, on both
1236 sender and recipient addresses, and it can be tested using the &%-bv%& and
1237 &%-bvs%& command line options.
1238
1239 When an address is being verified, the routers are run in &"verify mode"&. This
1240 does not affect the way the routers work, but it is a state that can be
1241 detected. By this means, a router can be skipped or made to behave differently
1242 when verifying. A common example is a configuration in which the first router
1243 sends all messages to a message-scanning program, unless they have been
1244 previously scanned. Thus, the first router accepts all addresses without any
1245 checking, making it useless for verifying. Normally, the &%no_verify%& option
1246 would be set for such a router, causing it to be skipped in verify mode.
1247
1248
1249
1250
1251 .section "Running an individual router" "SECTrunindrou"
1252 .cindex "router" "running details"
1253 .cindex "preconditions" "checking"
1254 .cindex "router" "result of running"
1255 As explained in the example above, a number of preconditions are checked before
1256 running a router. If any are not met, the router is skipped, and the address is
1257 passed to the next router. When all the preconditions on a router &'are'& met,
1258 the router is run. What happens next depends on the outcome, which is one of
1259 the following:
1260
1261 .ilist
1262 &'accept'&: The router accepts the address, and either assigns it to a
1263 transport, or generates one or more &"child"& addresses. Processing the
1264 original address ceases,
1265 .oindex "&%unseen%&"
1266 unless the &%unseen%& option is set on the router. This option
1267 can be used to set up multiple deliveries with different routing (for example,
1268 for keeping archive copies of messages). When &%unseen%& is set, the address is
1269 passed to the next router. Normally, however, an &'accept'& return marks the
1270 end of routing.
1271
1272 Any child addresses generated by the router are processed independently,
1273 starting with the first router by default. It is possible to change this by
1274 setting the &%redirect_router%& option to specify which router to start at for
1275 child addresses. Unlike &%pass_router%& (see below) the router specified by
1276 &%redirect_router%& may be anywhere in the router configuration.
1277 .next
1278 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1279 requests that the address be passed to another router. By default the address
1280 is passed to the next router, but this can be changed by setting the
1281 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1282 must be below the current router (to avoid loops).
1283 .next
1284 &'decline'&: The router declines to accept the address because it does not
1285 recognize it at all. By default, the address is passed to the next router, but
1286 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1287 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1288 &'decline'& into &'fail'&.
1289 .next
1290 &'fail'&: The router determines that the address should fail, and queues it for
1291 the generation of a bounce message. There is no further processing of the
1292 original address unless &%unseen%& is set on the router.
1293 .next
1294 &'defer'&: The router cannot handle the address at the present time. (A
1295 database may be offline, or a DNS lookup may have timed out.) No further
1296 processing of the address happens in this delivery attempt. It is tried again
1297 next time the message is considered for delivery.
1298 .next
1299 &'error'&: There is some error in the router (for example, a syntax error in
1300 its configuration). The action is as for defer.
1301 .endlist
1302
1303 If an address reaches the end of the routers without having been accepted by
1304 any of them, it is bounced as unrouteable. The default error message in this
1305 situation is &"unrouteable address"&, but you can set your own message by
1306 making use of the &%cannot_route_message%& option. This can be set for any
1307 router; the value from the last router that &"saw"& the address is used.
1308
1309 Sometimes while routing you want to fail a delivery when some conditions are
1310 met but others are not, instead of passing the address on for further routing.
1311 You can do this by having a second router that explicitly fails the delivery
1312 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1313 facility for this purpose.
1314
1315
1316 .section "Duplicate addresses" "SECID17"
1317 .cindex "case of local parts"
1318 .cindex "address duplicate, discarding"
1319 .cindex "duplicate addresses"
1320 Once routing is complete, Exim scans the addresses that are assigned to local
1321 and remote transports, and discards any duplicates that it finds. During this
1322 check, local parts are treated as case-sensitive. This happens only when
1323 actually delivering a message; when testing routers with &%-bt%&, all the
1324 routed addresses are shown.
1325
1326
1327
1328 .section "Router preconditions" "SECTrouprecon"
1329 .cindex "router" "preconditions, order of processing"
1330 .cindex "preconditions" "order of processing"
1331 The preconditions that are tested for each router are listed below, in the
1332 order in which they are tested. The individual configuration options are
1333 described in more detail in chapter &<<CHAProutergeneric>>&.
1334
1335 .ilist
1336 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1337 the local parts handled by the router may or must have certain prefixes and/or
1338 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1339 skipped. These conditions are tested first. When an affix is present, it is
1340 removed from the local part before further processing, including the evaluation
1341 of any other conditions.
1342 .next
1343 Routers can be designated for use only when not verifying an address, that is,
1344 only when routing it for delivery (or testing its delivery routing). If the
1345 &%verify%& option is set false, the router is skipped when Exim is verifying an
1346 address.
1347 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1348 &%verify_recipient%&, which independently control the use of the router for
1349 sender and recipient verification. You can set these options directly if
1350 you want a router to be used for only one type of verification.
1351 .next
1352 If the &%address_test%& option is set false, the router is skipped when Exim is
1353 run with the &%-bt%& option to test an address routing. This can be helpful
1354 when the first router sends all new messages to a scanner of some sort; it
1355 makes it possible to use &%-bt%& to test subsequent delivery routing without
1356 having to simulate the effect of the scanner.
1357 .next
1358 Routers can be designated for use only when verifying an address, as
1359 opposed to routing it for delivery. The &%verify_only%& option controls this.
1360 .next
1361 Individual routers can be explicitly skipped when running the routers to
1362 check an address given in the SMTP EXPN command (see the &%expn%& option).
1363 .next
1364 If the &%domains%& option is set, the domain of the address must be in the set
1365 of domains that it defines.
1366 .next
1367 .vindex "&$local_part_prefix$&"
1368 .vindex "&$local_part$&"
1369 .vindex "&$local_part_suffix$&"
1370 If the &%local_parts%& option is set, the local part of the address must be in
1371 the set of local parts that it defines. If &%local_part_prefix%& or
1372 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1373 part before this check. If you want to do precondition tests on local parts
1374 that include affixes, you can do so by using a &%condition%& option (see below)
1375 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1376 &$local_part_suffix$& as necessary.
1377 .next
1378 .vindex "&$local_user_uid$&"
1379 .vindex "&$local_user_gid$&"
1380 .vindex "&$home$&"
1381 If the &%check_local_user%& option is set, the local part must be the name of
1382 an account on the local host. If this check succeeds, the uid and gid of the
1383 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1384 user's home directory is placed in &$home$&; these values can be used in the
1385 remaining preconditions.
1386 .next
1387 If the &%router_home_directory%& option is set, it is expanded at this point,
1388 because it overrides the value of &$home$&. If this expansion were left till
1389 later, the value of &$home$& as set by &%check_local_user%& would be used in
1390 subsequent tests. Having two different values of &$home$& in the same router
1391 could lead to confusion.
1392 .next
1393 If the &%senders%& option is set, the envelope sender address must be in the
1394 set of addresses that it defines.
1395 .next
1396 If the &%require_files%& option is set, the existence or non-existence of
1397 specified files is tested.
1398 .next
1399 .cindex "customizing" "precondition"
1400 If the &%condition%& option is set, it is evaluated and tested. This option
1401 uses an expanded string to allow you to set up your own custom preconditions.
1402 Expanded strings are described in chapter &<<CHAPexpand>>&.
1403 .endlist
1404
1405
1406 Note that &%require_files%& comes near the end of the list, so you cannot use
1407 it to check for the existence of a file in which to lookup up a domain, local
1408 part, or sender. However, as these options are all expanded, you can use the
1409 &%exists%& expansion condition to make such tests within each condition. The
1410 &%require_files%& option is intended for checking files that the router may be
1411 going to use internally, or which are needed by a specific transport (for
1412 example, &_.procmailrc_&).
1413
1414
1415
1416 .section "Delivery in detail" "SECID18"
1417 .cindex "delivery" "in detail"
1418 When a message is to be delivered, the sequence of events is as follows:
1419
1420 .ilist
1421 If a system-wide filter file is specified, the message is passed to it. The
1422 filter may add recipients to the message, replace the recipients, discard the
1423 message, cause a new message to be generated, or cause the message delivery to
1424 fail. The format of the system filter file is the same as for Exim user filter
1425 files, described in the separate document entitled &'Exim's interfaces to mail
1426 filtering'&.
1427 .cindex "Sieve filter" "not available for system filter"
1428 (&*Note*&: Sieve cannot be used for system filter files.)
1429
1430 Some additional features are available in system filters &-- see chapter
1431 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1432 filter only once per delivery attempt, however many recipients it has. However,
1433 if there are several delivery attempts because one or more addresses could not
1434 be immediately delivered, the system filter is run each time. The filter
1435 condition &%first_delivery%& can be used to detect the first run of the system
1436 filter.
1437 .next
1438 Each recipient address is offered to each configured router in turn, subject to
1439 its preconditions, until one is able to handle it. If no router can handle the
1440 address, that is, if they all decline, the address is failed. Because routers
1441 can be targeted at particular domains, several locally handled domains can be
1442 processed entirely independently of each other.
1443 .next
1444 .cindex "routing" "loops in"
1445 .cindex "loop" "while routing"
1446 A router that accepts an address may assign it to a local or a remote
1447 transport. However, the transport is not run at this time. Instead, the address
1448 is placed on a list for the particular transport, which will be run later.
1449 Alternatively, the router may generate one or more new addresses (typically
1450 from alias, forward, or filter files). New addresses are fed back into this
1451 process from the top, but in order to avoid loops, a router ignores any address
1452 which has an identically-named ancestor that was processed by itself.
1453 .next
1454 When all the routing has been done, addresses that have been successfully
1455 handled are passed to their assigned transports. When local transports are
1456 doing real local deliveries, they handle only one address at a time, but if a
1457 local transport is being used as a pseudo-remote transport (for example, to
1458 collect batched SMTP messages for transmission by some other means) multiple
1459 addresses can be handled. Remote transports can always handle more than one
1460 address at a time, but can be configured not to do so, or to restrict multiple
1461 addresses to the same domain.
1462 .next
1463 Each local delivery to a file or a pipe runs in a separate process under a
1464 non-privileged uid, and these deliveries are run one at a time. Remote
1465 deliveries also run in separate processes, normally under a uid that is private
1466 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1467 run in parallel. The maximum number of simultaneous remote deliveries for any
1468 one message is set by the &%remote_max_parallel%& option.
1469 The order in which deliveries are done is not defined, except that all local
1470 deliveries happen before any remote deliveries.
1471 .next
1472 .cindex "queue runner"
1473 When it encounters a local delivery during a queue run, Exim checks its retry
1474 database to see if there has been a previous temporary delivery failure for the
1475 address before running the local transport. If there was a previous failure,
1476 Exim does not attempt a new delivery until the retry time for the address is
1477 reached. However, this happens only for delivery attempts that are part of a
1478 queue run. Local deliveries are always attempted when delivery immediately
1479 follows message reception, even if retry times are set for them. This makes for
1480 better behaviour if one particular message is causing problems (for example,
1481 causing quota overflow, or provoking an error in a filter file).
1482 .next
1483 .cindex "delivery" "retry in remote transports"
1484 Remote transports do their own retry handling, since an address may be
1485 deliverable to one of a number of hosts, each of which may have a different
1486 retry time. If there have been previous temporary failures and no host has
1487 reached its retry time, no delivery is attempted, whether in a queue run or
1488 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1489 .next
1490 If there were any permanent errors, a bounce message is returned to an
1491 appropriate address (the sender in the common case), with details of the error
1492 for each failing address. Exim can be configured to send copies of bounce
1493 messages to other addresses.
1494 .next
1495 .cindex "delivery" "deferral"
1496 If one or more addresses suffered a temporary failure, the message is left on
1497 the queue, to be tried again later. Delivery of these addresses is said to be
1498 &'deferred'&.
1499 .next
1500 When all the recipient addresses have either been delivered or bounced,
1501 handling of the message is complete. The spool files and message log are
1502 deleted, though the message log can optionally be preserved if required.
1503 .endlist
1504
1505
1506
1507
1508 .section "Retry mechanism" "SECID19"
1509 .cindex "delivery" "retry mechanism"
1510 .cindex "retry" "description of mechanism"
1511 .cindex "queue runner"
1512 Exim's mechanism for retrying messages that fail to get delivered at the first
1513 attempt is the queue runner process. You must either run an Exim daemon that
1514 uses the &%-q%& option with a time interval to start queue runners at regular
1515 intervals, or use some other means (such as &'cron'&) to start them. If you do
1516 not arrange for queue runners to be run, messages that fail temporarily at the
1517 first attempt will remain on your queue for ever. A queue runner process works
1518 its way through the queue, one message at a time, trying each delivery that has
1519 passed its retry time.
1520 You can run several queue runners at once.
1521
1522 Exim uses a set of configured rules to determine when next to retry the failing
1523 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1524 should give up trying to deliver to the address, at which point it generates a
1525 bounce message. If no retry rules are set for a particular host, address, and
1526 error combination, no retries are attempted, and temporary errors are treated
1527 as permanent.
1528
1529
1530
1531 .section "Temporary delivery failure" "SECID20"
1532 .cindex "delivery" "temporary failure"
1533 There are many reasons why a message may not be immediately deliverable to a
1534 particular address. Failure to connect to a remote machine (because it, or the
1535 connection to it, is down) is one of the most common. Temporary failures may be
1536 detected during routing as well as during the transport stage of delivery.
1537 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1538 is on a file system where the user is over quota. Exim can be configured to
1539 impose its own quotas on local mailboxes; where system quotas are set they will
1540 also apply.
1541
1542 If a host is unreachable for a period of time, a number of messages may be
1543 waiting for it by the time it recovers, and sending them in a single SMTP
1544 connection is clearly beneficial. Whenever a delivery to a remote host is
1545 deferred,
1546 .cindex "hints database"
1547 Exim makes a note in its hints database, and whenever a successful
1548 SMTP delivery has happened, it looks to see if any other messages are waiting
1549 for the same host. If any are found, they are sent over the same SMTP
1550 connection, subject to a configuration limit as to the maximum number in any
1551 one connection.
1552
1553
1554
1555 .section "Permanent delivery failure" "SECID21"
1556 .cindex "delivery" "permanent failure"
1557 .cindex "bounce message" "when generated"
1558 When a message cannot be delivered to some or all of its intended recipients, a
1559 bounce message is generated. Temporary delivery failures turn into permanent
1560 errors when their timeout expires. All the addresses that fail in a given
1561 delivery attempt are listed in a single message. If the original message has
1562 many recipients, it is possible for some addresses to fail in one delivery
1563 attempt and others to fail subsequently, giving rise to more than one bounce
1564 message. The wording of bounce messages can be customized by the administrator.
1565 See chapter &<<CHAPemsgcust>>& for details.
1566
1567 .cindex "&'X-Failed-Recipients:'& header line"
1568 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1569 failed addresses, for the benefit of programs that try to analyse such messages
1570 automatically.
1571
1572 .cindex "bounce message" "recipient of"
1573 A bounce message is normally sent to the sender of the original message, as
1574 obtained from the message's envelope. For incoming SMTP messages, this is the
1575 address given in the MAIL command. However, when an address is expanded via a
1576 forward or alias file, an alternative address can be specified for delivery
1577 failures of the generated addresses. For a mailing list expansion (see section
1578 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1579 of the list.
1580
1581
1582
1583 .section "Failures to deliver bounce messages" "SECID22"
1584 .cindex "bounce message" "failure to deliver"
1585 If a bounce message (either locally generated or received from a remote host)
1586 itself suffers a permanent delivery failure, the message is left on the queue,
1587 but it is frozen, awaiting the attention of an administrator. There are options
1588 that can be used to make Exim discard such failed messages, or to keep them
1589 for only a short time (see &%timeout_frozen_after%& and
1590 &%ignore_bounce_errors_after%&).
1591
1592
1593
1594
1595
1596 . ////////////////////////////////////////////////////////////////////////////
1597 . ////////////////////////////////////////////////////////////////////////////
1598
1599 .chapter "Building and installing Exim" "CHID3"
1600 .scindex IIDbuex "building Exim"
1601
1602 .section "Unpacking" "SECID23"
1603 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1604 creates a directory with the name of the current release (for example,
1605 &_exim-&version;_&) into which the following files are placed:
1606
1607 .table2 140pt
1608 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1609 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1610   documented"
1611 .irow &_LICENCE_&         "the GNU General Public Licence"
1612 .irow &_Makefile_&        "top-level make file"
1613 .irow &_NOTICE_&          "conditions for the use of Exim"
1614 .irow &_README_&          "list of files, directories and simple build &&&
1615   instructions"
1616 .endtable
1617
1618 Other files whose names begin with &_README_& may also be present. The
1619 following subdirectories are created:
1620
1621 .table2 140pt
1622 .irow &_Local_&           "an empty directory for local configuration files"
1623 .irow &_OS_&              "OS-specific files"
1624 .irow &_doc_&             "documentation files"
1625 .irow &_exim_monitor_&    "source files for the Exim monitor"
1626 .irow &_scripts_&         "scripts used in the build process"
1627 .irow &_src_&             "remaining source files"
1628 .irow &_util_&            "independent utilities"
1629 .endtable
1630
1631 The main utility programs are contained in the &_src_& directory, and are built
1632 with the Exim binary. The &_util_& directory contains a few optional scripts
1633 that may be useful to some sites.
1634
1635
1636 .section "Multiple machine architectures and operating systems" "SECID24"
1637 .cindex "building Exim" "multiple OS/architectures"
1638 The building process for Exim is arranged to make it easy to build binaries for
1639 a number of different architectures and operating systems from the same set of
1640 source files. Compilation does not take place in the &_src_& directory.
1641 Instead, a &'build directory'& is created for each architecture and operating
1642 system.
1643 .cindex "symbolic link" "to build directory"
1644 Symbolic links to the sources are installed in this directory, which is where
1645 the actual building takes place. In most cases, Exim can discover the machine
1646 architecture and operating system for itself, but the defaults can be
1647 overridden if necessary.
1648
1649
1650 .section "PCRE library" "SECTpcre"
1651 .cindex "PCRE library"
1652 Exim no longer has an embedded PCRE library as the vast majority of
1653 modern systems include PCRE as a system library, although you may need
1654 to install the PCRE or PCRE development package for your operating
1655 system. If your system has a normal PCRE installation the Exim build
1656 process will need no further configuration. If the library or the
1657 headers are in an unusual location you will need to either set the PCRE_LIBS
1658 and INCLUDE directives appropriately,
1659 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1660 If your operating system has no
1661 PCRE support then you will need to obtain and build the current PCRE
1662 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1663 More information on PCRE is available at &url(http://www.pcre.org/).
1664
1665 .section "DBM libraries" "SECTdb"
1666 .cindex "DBM libraries" "discussion of"
1667 .cindex "hints database" "DBM files used for"
1668 Even if you do not use any DBM files in your configuration, Exim still needs a
1669 DBM library in order to operate, because it uses indexed files for its hints
1670 databases. Unfortunately, there are a number of DBM libraries in existence, and
1671 different operating systems often have different ones installed.
1672
1673 .cindex "Solaris" "DBM library for"
1674 .cindex "IRIX, DBM library for"
1675 .cindex "BSD, DBM library for"
1676 .cindex "Linux, DBM library for"
1677 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1678 Linux distribution, the DBM configuration should happen automatically, and you
1679 may be able to ignore this section. Otherwise, you may have to learn more than
1680 you would like about DBM libraries from what follows.
1681
1682 .cindex "&'ndbm'& DBM library"
1683 Licensed versions of Unix normally contain a library of DBM functions operating
1684 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1685 versions of Unix seem to vary in what they contain as standard. In particular,
1686 some early versions of Linux have no default DBM library, and different
1687 distributors have chosen to bundle different libraries with their packaged
1688 versions. However, the more recent releases seem to have standardized on the
1689 Berkeley DB library.
1690
1691 Different DBM libraries have different conventions for naming the files they
1692 use. When a program opens a file called &_dbmfile_&, there are several
1693 possibilities:
1694
1695 .olist
1696 A traditional &'ndbm'& implementation, such as that supplied as part of
1697 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1698 .next
1699 .cindex "&'gdbm'& DBM library"
1700 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1701 compatibility interface it makes two different hard links to it with names
1702 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1703 file name is used unmodified.
1704 .next
1705 .cindex "Berkeley DB library"
1706 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1707 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1708 programmer exactly the same as the traditional &'ndbm'& implementation.
1709 .next
1710 If the Berkeley package is used in its native mode, it operates on a single
1711 file called &_dbmfile_&; the programmer's interface is somewhat different to
1712 the traditional &'ndbm'& interface.
1713 .next
1714 To complicate things further, there are several very different versions of the
1715 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1716 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1717 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1718 versions of Berkeley DB can be obtained from
1719 &url(http://www.sleepycat.com/).
1720 .next
1721 .cindex "&'tdb'& DBM library"
1722 Yet another DBM library, called &'tdb'&, is available from
1723 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1724 operates on a single file.
1725 .endlist
1726
1727 .cindex "USE_DB"
1728 .cindex "DBM libraries" "configuration for building"
1729 Exim and its utilities can be compiled to use any of these interfaces. In order
1730 to use any version of the Berkeley DB package in native mode, you must set
1731 USE_DB in an appropriate configuration file (typically
1732 &_Local/Makefile_&). For example:
1733 .code
1734 USE_DB=yes
1735 .endd
1736 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1737 error is diagnosed if you set more than one of these.
1738
1739 At the lowest level, the build-time configuration sets none of these options,
1740 thereby assuming an interface of type (1). However, some operating system
1741 configuration files (for example, those for the BSD operating systems and
1742 Linux) assume type (4) by setting USE_DB as their default, and the
1743 configuration files for Cygwin set USE_GDBM. Anything you set in
1744 &_Local/Makefile_&, however, overrides these system defaults.
1745
1746 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1747 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1748 in one of these lines:
1749 .code
1750 DBMLIB = -ldb
1751 DBMLIB = -ltdb
1752 .endd
1753 Settings like that will work if the DBM library is installed in the standard
1754 place. Sometimes it is not, and the library's header file may also not be in
1755 the default path. You may need to set INCLUDE to specify where the header
1756 file is, and to specify the path to the library more fully in DBMLIB, as in
1757 this example:
1758 .code
1759 INCLUDE=-I/usr/local/include/db-4.1
1760 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1761 .endd
1762 There is further detailed discussion about the various DBM libraries in the
1763 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1764
1765
1766
1767 .section "Pre-building configuration" "SECID25"
1768 .cindex "building Exim" "pre-building configuration"
1769 .cindex "configuration for building Exim"
1770 .cindex "&_Local/Makefile_&"
1771 .cindex "&_src/EDITME_&"
1772 Before building Exim, a local configuration file that specifies options
1773 independent of any operating system has to be created with the name
1774 &_Local/Makefile_&. A template for this file is supplied as the file
1775 &_src/EDITME_&, and it contains full descriptions of all the option settings
1776 therein. These descriptions are therefore not repeated here. If you are
1777 building Exim for the first time, the simplest thing to do is to copy
1778 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1779
1780 There are three settings that you must supply, because Exim will not build
1781 without them. They are the location of the run time configuration file
1782 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1783 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1784 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1785 a colon-separated list of file names; Exim uses the first of them that exists.
1786
1787 There are a few other parameters that can be specified either at build time or
1788 at run time, to enable the same binary to be used on a number of different
1789 machines. However, if the locations of Exim's spool directory and log file
1790 directory (if not within the spool directory) are fixed, it is recommended that
1791 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1792 detected early in Exim's execution (such as a malformed configuration file) can
1793 be logged.
1794
1795 .cindex "content scanning" "specifying at build time"
1796 Exim's interfaces for calling virus and spam scanning software directly from
1797 access control lists are not compiled by default. If you want to include these
1798 facilities, you need to set
1799 .code
1800 WITH_CONTENT_SCAN=yes
1801 .endd
1802 in your &_Local/Makefile_&. For details of the facilities themselves, see
1803 chapter &<<CHAPexiscan>>&.
1804
1805
1806 .cindex "&_Local/eximon.conf_&"
1807 .cindex "&_exim_monitor/EDITME_&"
1808 If you are going to build the Exim monitor, a similar configuration process is
1809 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1810 your installation and saved under the name &_Local/eximon.conf_&. If you are
1811 happy with the default settings described in &_exim_monitor/EDITME_&,
1812 &_Local/eximon.conf_& can be empty, but it must exist.
1813
1814 This is all the configuration that is needed in straightforward cases for known
1815 operating systems. However, the building process is set up so that it is easy
1816 to override options that are set by default or by operating-system-specific
1817 configuration files, for example to change the name of the C compiler, which
1818 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1819 do this.
1820
1821
1822
1823 .section "Support for iconv()" "SECID26"
1824 .cindex "&[iconv()]& support"
1825 .cindex "RFC 2047"
1826 The contents of header lines in messages may be encoded according to the rules
1827 described RFC 2047. This makes it possible to transmit characters that are not
1828 in the ASCII character set, and to label them as being in a particular
1829 character set. When Exim is inspecting header lines by means of the &%$h_%&
1830 mechanism, it decodes them, and translates them into a specified character set
1831 (default ISO-8859-1). The translation is possible only if the operating system
1832 supports the &[iconv()]& function.
1833
1834 However, some of the operating systems that supply &[iconv()]& do not support
1835 very many conversions. The GNU &%libiconv%& library (available from
1836 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1837 systems to remedy this deficiency, as well as on systems that do not supply
1838 &[iconv()]& at all. After installing &%libiconv%&, you should add
1839 .code
1840 HAVE_ICONV=yes
1841 .endd
1842 to your &_Local/Makefile_& and rebuild Exim.
1843
1844
1845
1846 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1847 .cindex "TLS" "including support for TLS"
1848 .cindex "encryption" "including support for"
1849 .cindex "SUPPORT_TLS"
1850 .cindex "OpenSSL" "building Exim with"
1851 .cindex "GnuTLS" "building Exim with"
1852 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1853 command as per RFC 2487. It can also support legacy clients that expect to
1854 start a TLS session immediately on connection to a non-standard port (see the
1855 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1856 line option).
1857
1858 If you want to build Exim with TLS support, you must first install either the
1859 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1860 implementing SSL.
1861
1862 If OpenSSL is installed, you should set
1863 .code
1864 SUPPORT_TLS=yes
1865 TLS_LIBS=-lssl -lcrypto
1866 .endd
1867 in &_Local/Makefile_&. You may also need to specify the locations of the
1868 OpenSSL library and include files. For example:
1869 .code
1870 SUPPORT_TLS=yes
1871 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1872 TLS_INCLUDE=-I/usr/local/openssl/include/
1873 .endd
1874 .cindex "pkg-config" "OpenSSL"
1875 If you have &'pkg-config'& available, then instead you can just use:
1876 .code
1877 SUPPORT_TLS=yes
1878 USE_OPENSSL_PC=openssl
1879 .endd
1880 .cindex "USE_GNUTLS"
1881 If GnuTLS is installed, you should set
1882 .code
1883 SUPPORT_TLS=yes
1884 USE_GNUTLS=yes
1885 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1886 .endd
1887 in &_Local/Makefile_&, and again you may need to specify the locations of the
1888 library and include files. For example:
1889 .code
1890 SUPPORT_TLS=yes
1891 USE_GNUTLS=yes
1892 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1893 TLS_INCLUDE=-I/usr/gnu/include
1894 .endd
1895 .cindex "pkg-config" "GnuTLS"
1896 If you have &'pkg-config'& available, then instead you can just use:
1897 .code
1898 SUPPORT_TLS=yes
1899 USE_GNUTLS=yes
1900 USE_GNUTLS_PC=gnutls
1901 .endd
1902
1903 You do not need to set TLS_INCLUDE if the relevant directory is already
1904 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1905 given in chapter &<<CHAPTLS>>&.
1906
1907
1908
1909
1910 .section "Use of tcpwrappers" "SECID27"
1911
1912 .cindex "tcpwrappers, building Exim to support"
1913 .cindex "USE_TCP_WRAPPERS"
1914 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1915 .cindex "tcp_wrappers_daemon_name"
1916 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1917 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1918 alternative to Exim's own checking facilities for installations that are
1919 already making use of &'tcpwrappers'& for other purposes. To do this, you
1920 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1921 &_tcpd.h_& to be available at compile time, and also ensure that the library
1922 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1923 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1924 you might have
1925 .code
1926 USE_TCP_WRAPPERS=yes
1927 CFLAGS=-O -I/usr/local/include
1928 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1929 .endd
1930 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1931 files is &"exim"&. For example, the line
1932 .code
1933 exim : LOCAL  192.168.1.  .friendly.domain.example
1934 .endd
1935 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1936 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1937 All other connections are denied. The daemon name used by &'tcpwrappers'&
1938 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1939 in &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1940 configure file. Consult the &'tcpwrappers'& documentation for
1941 further details.
1942
1943
1944 .section "Including support for IPv6" "SECID28"
1945 .cindex "IPv6" "including support for"
1946 Exim contains code for use on systems that have IPv6 support. Setting
1947 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1948 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1949 where the IPv6 support is not fully integrated into the normal include and
1950 library files.
1951
1952 Two different types of DNS record for handling IPv6 addresses have been
1953 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1954 currently seen as the mainstream. Another record type called A6 was proposed
1955 as better than AAAA because it had more flexibility. However, it was felt to be
1956 over-complex, and its status was reduced to &"experimental"&. It is not known
1957 if anyone is actually using A6 records. Exim has support for A6 records, but
1958 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1959 support has not been tested for some time.
1960
1961
1962
1963 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1964 .cindex "lookup modules"
1965 .cindex "dynamic modules"
1966 .cindex ".so building"
1967 On some platforms, Exim supports not compiling all lookup types directly into
1968 the main binary, instead putting some into external modules which can be loaded
1969 on demand.
1970 This permits packagers to build Exim with support for lookups with extensive
1971 library dependencies without requiring all users to install all of those
1972 dependencies.
1973 Most, but not all, lookup types can be built this way.
1974
1975 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1976 installed; Exim will only load modules from that directory, as a security
1977 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1978 for your OS; see &_OS/Makefile-Linux_& for an example.
1979 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1980 see &_src/EDITME_& for details.
1981
1982 Then, for each module to be loaded dynamically, define the relevant
1983 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1984 For example, this will build in lsearch but load sqlite and mysql support
1985 on demand:
1986 .code
1987 LOOKUP_LSEARCH=yes
1988 LOOKUP_SQLITE=2
1989 LOOKUP_MYSQL=2
1990 .endd
1991
1992
1993 .section "The building process" "SECID29"
1994 .cindex "build directory"
1995 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1996 created, run &'make'& at the top level. It determines the architecture and
1997 operating system types, and creates a build directory if one does not exist.
1998 For example, on a Sun system running Solaris 8, the directory
1999 &_build-SunOS5-5.8-sparc_& is created.
2000 .cindex "symbolic link" "to source files"
2001 Symbolic links to relevant source files are installed in the build directory.
2002
2003 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2004 building process fails if it is set.
2005
2006 If this is the first time &'make'& has been run, it calls a script that builds
2007 a make file inside the build directory, using the configuration files from the
2008 &_Local_& directory. The new make file is then passed to another instance of
2009 &'make'&. This does the real work, building a number of utility scripts, and
2010 then compiling and linking the binaries for the Exim monitor (if configured), a
2011 number of utility programs, and finally Exim itself. The command &`make
2012 makefile`& can be used to force a rebuild of the make file in the build
2013 directory, should this ever be necessary.
2014
2015 If you have problems building Exim, check for any comments there may be in the
2016 &_README_& file concerning your operating system, and also take a look at the
2017 FAQ, where some common problems are covered.
2018
2019
2020
2021 .section 'Output from &"make"&' "SECID283"
2022 The output produced by the &'make'& process for compile lines is often very
2023 unreadable, because these lines can be very long. For this reason, the normal
2024 output is suppressed by default, and instead output similar to that which
2025 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2026 each module that is being compiled or linked. However, it is still possible to
2027 get the full output, by calling &'make'& like this:
2028 .code
2029 FULLECHO='' make -e
2030 .endd
2031 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2032 command reflection in &'make'&. When you ask for the full output, it is
2033 given in addition to the short output.
2034
2035
2036
2037 .section "Overriding build-time options for Exim" "SECToverride"
2038 .cindex "build-time options, overriding"
2039 The main make file that is created at the beginning of the building process
2040 consists of the concatenation of a number of files which set configuration
2041 values, followed by a fixed set of &'make'& instructions. If a value is set
2042 more than once, the last setting overrides any previous ones. This provides a
2043 convenient way of overriding defaults. The files that are concatenated are, in
2044 order:
2045 .display
2046 &_OS/Makefile-Default_&
2047 &_OS/Makefile-_&<&'ostype'&>
2048 &_Local/Makefile_&
2049 &_Local/Makefile-_&<&'ostype'&>
2050 &_Local/Makefile-_&<&'archtype'&>
2051 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2052 &_OS/Makefile-Base_&
2053 .endd
2054 .cindex "&_Local/Makefile_&"
2055 .cindex "building Exim" "operating system type"
2056 .cindex "building Exim" "architecture type"
2057 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2058 architecture type. &_Local/Makefile_& is required to exist, and the building
2059 process fails if it is absent. The other three &_Local_& files are optional,
2060 and are often not needed.
2061
2062 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2063 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2064 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2065 values are used, thereby providing a means of forcing particular settings.
2066 Otherwise, the scripts try to get values from the &%uname%& command. If this
2067 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2068 of &'ad hoc'& transformations are then applied, to produce the standard names
2069 that Exim expects. You can run these scripts directly from the shell in order
2070 to find out what values are being used on your system.
2071
2072
2073 &_OS/Makefile-Default_& contains comments about the variables that are set
2074 therein. Some (but not all) are mentioned below. If there is something that
2075 needs changing, review the contents of this file and the contents of the make
2076 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2077 default values are.
2078
2079
2080 .cindex "building Exim" "overriding default settings"
2081 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2082 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2083 need to change the original files. Instead, you should make the changes by
2084 putting the new values in an appropriate &_Local_& file. For example,
2085 .cindex "Tru64-Unix build-time settings"
2086 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2087 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2088 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2089 called with the option &%-std1%&, to make it recognize some of the features of
2090 Standard C that Exim uses. (Most other compilers recognize Standard C by
2091 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2092 containing the lines
2093 .code
2094 CC=cc
2095 CFLAGS=-std1
2096 .endd
2097 If you are compiling for just one operating system, it may be easier to put
2098 these lines directly into &_Local/Makefile_&.
2099
2100 Keeping all your local configuration settings separate from the distributed
2101 files makes it easy to transfer them to new versions of Exim simply by copying
2102 the contents of the &_Local_& directory.
2103
2104
2105 .cindex "NIS lookup type" "including support for"
2106 .cindex "NIS+ lookup type" "including support for"
2107 .cindex "LDAP" "including support for"
2108 .cindex "lookup" "inclusion in binary"
2109 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2110 lookup, but not all systems have these components installed, so the default is
2111 not to include the relevant code in the binary. All the different kinds of file
2112 and database lookup that Exim supports are implemented as separate code modules
2113 which are included only if the relevant compile-time options are set. In the
2114 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2115 .code
2116 LOOKUP_LDAP=yes
2117 LOOKUP_NIS=yes
2118 LOOKUP_NISPLUS=yes
2119 .endd
2120 and similar settings apply to the other lookup types. They are all listed in
2121 &_src/EDITME_&. In many cases the relevant include files and interface
2122 libraries need to be installed before compiling Exim.
2123 .cindex "cdb" "including support for"
2124 However, there are some optional lookup types (such as cdb) for which
2125 the code is entirely contained within Exim, and no external include
2126 files or libraries are required. When a lookup type is not included in the
2127 binary, attempts to configure Exim to use it cause run time configuration
2128 errors.
2129
2130 .cindex "pkg-config" "lookups"
2131 .cindex "pkg-config" "authenticators"
2132 Many systems now use a tool called &'pkg-config'& to encapsulate information
2133 about how to compile against a library; Exim has some initial support for
2134 being able to use pkg-config for lookups and authenticators.  For any given
2135 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2136 variable with the &`_PC`& suffix in the name and assign as the value the
2137 name of the package to be queried.  The results of querying via the
2138 &'pkg-config'& command will be added to the appropriate Makefile variables
2139 with &`+=`& directives, so your version of &'make'& will need to support that
2140 syntax.  For instance:
2141 .code
2142 LOOKUP_SQLITE=yes
2143 LOOKUP_SQLITE_PC=sqlite3
2144 AUTH_GSASL=yes
2145 AUTH_GSASL_PC=libgsasl
2146 AUTH_HEIMDAL_GSSAPI=yes
2147 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2148 .endd
2149
2150 .cindex "Perl" "including support for"
2151 Exim can be linked with an embedded Perl interpreter, allowing Perl
2152 subroutines to be called during string expansion. To enable this facility,
2153 .code
2154 EXIM_PERL=perl.o
2155 .endd
2156 must be defined in &_Local/Makefile_&. Details of this facility are given in
2157 chapter &<<CHAPperl>>&.
2158
2159 .cindex "X11 libraries, location of"
2160 The location of the X11 libraries is something that varies a lot between
2161 operating systems, and there may be different versions of X11 to cope
2162 with. Exim itself makes no use of X11, but if you are compiling the Exim
2163 monitor, the X11 libraries must be available.
2164 The following three variables are set in &_OS/Makefile-Default_&:
2165 .code
2166 X11=/usr/X11R6
2167 XINCLUDE=-I$(X11)/include
2168 XLFLAGS=-L$(X11)/lib
2169 .endd
2170 These are overridden in some of the operating-system configuration files. For
2171 example, in &_OS/Makefile-SunOS5_& there is
2172 .code
2173 X11=/usr/openwin
2174 XINCLUDE=-I$(X11)/include
2175 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2176 .endd
2177 If you need to override the default setting for your operating system, place a
2178 definition of all three of these variables into your
2179 &_Local/Makefile-<ostype>_& file.
2180
2181 .cindex "EXTRALIBS"
2182 If you need to add any extra libraries to the link steps, these can be put in a
2183 variable called EXTRALIBS, which appears in all the link commands, but by
2184 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2185 command for linking the main Exim binary, and not for any associated utilities.
2186
2187 .cindex "DBM libraries" "configuration for building"
2188 There is also DBMLIB, which appears in the link commands for binaries that
2189 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2190 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2191 binary, and which can be used, for example, to include additional X11
2192 libraries.
2193
2194 .cindex "configuration file" "editing"
2195 The make file copes with rebuilding Exim correctly if any of the configuration
2196 files are edited. However, if an optional configuration file is deleted, it is
2197 necessary to touch the associated non-optional file (that is,
2198 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2199
2200
2201 .section "OS-specific header files" "SECID30"
2202 .cindex "&_os.h_&"
2203 .cindex "building Exim" "OS-specific C header files"
2204 The &_OS_& directory contains a number of files with names of the form
2205 &_os.h-<ostype>_&. These are system-specific C header files that should not
2206 normally need to be changed. There is a list of macro settings that are
2207 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2208 are porting Exim to a new operating system.
2209
2210
2211
2212 .section "Overriding build-time options for the monitor" "SECID31"
2213 .cindex "building Eximon"
2214 A similar process is used for overriding things when building the Exim monitor,
2215 where the files that are involved are
2216 .display
2217 &_OS/eximon.conf-Default_&
2218 &_OS/eximon.conf-_&<&'ostype'&>
2219 &_Local/eximon.conf_&
2220 &_Local/eximon.conf-_&<&'ostype'&>
2221 &_Local/eximon.conf-_&<&'archtype'&>
2222 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2223 .endd
2224 .cindex "&_Local/eximon.conf_&"
2225 As with Exim itself, the final three files need not exist, and in this case the
2226 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2227 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2228 variables of the same name, preceded by EXIMON_. For example, setting
2229 EXIMON_LOG_DEPTH in the environment overrides the value of
2230 LOG_DEPTH at run time.
2231 .ecindex IIDbuex
2232
2233
2234 .section "Installing Exim binaries and scripts" "SECID32"
2235 .cindex "installing Exim"
2236 .cindex "BIN_DIRECTORY"
2237 The command &`make install`& runs the &(exim_install)& script with no
2238 arguments. The script copies binaries and utility scripts into the directory
2239 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2240 .cindex "setuid" "installing Exim with"
2241 The install script copies files only if they are newer than the files they are
2242 going to replace. The Exim binary is required to be owned by root and have the
2243 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2244 install`& as root so that it can set up the Exim binary in this way. However, in
2245 some special situations (for example, if a host is doing no local deliveries)
2246 it may be possible to run Exim without making the binary setuid root (see
2247 chapter &<<CHAPsecurity>>& for details).
2248
2249 .cindex "CONFIGURE_FILE"
2250 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2251 in &_Local/Makefile_&. If this names a single file, and the file does not
2252 exist, the default configuration file &_src/configure.default_& is copied there
2253 by the installation script. If a run time configuration file already exists, it
2254 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2255 alternative files, no default is installed.
2256
2257 .cindex "system aliases file"
2258 .cindex "&_/etc/aliases_&"
2259 One change is made to the default configuration file when it is installed: the
2260 default configuration contains a router that references a system aliases file.
2261 The path to this file is set to the value specified by
2262 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2263 If the system aliases file does not exist, the installation script creates it,
2264 and outputs a comment to the user.
2265
2266 The created file contains no aliases, but it does contain comments about the
2267 aliases a site should normally have. Mail aliases have traditionally been
2268 kept in &_/etc/aliases_&. However, some operating systems are now using
2269 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2270 Exim's configuration if necessary.
2271
2272 The default configuration uses the local host's name as the only local domain,
2273 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2274 running as the local user. System aliases and &_.forward_& files in users' home
2275 directories are supported, but no NIS or NIS+ support is configured. Domains
2276 other than the name of the local host are routed using the DNS, with delivery
2277 over SMTP.
2278
2279 It is possible to install Exim for special purposes (such as building a binary
2280 distribution) in a private part of the file system. You can do this by a
2281 command such as
2282 .code
2283 make DESTDIR=/some/directory/ install
2284 .endd
2285 This has the effect of pre-pending the specified directory to all the file
2286 paths, except the name of the system aliases file that appears in the default
2287 configuration. (If a default alias file is created, its name &'is'& modified.)
2288 For backwards compatibility, ROOT is used if DESTDIR is not set,
2289 but this usage is deprecated.
2290
2291 .cindex "installing Exim" "what is not installed"
2292 Running &'make install'& does not copy the Exim 4 conversion script
2293 &'convert4r4'&. You will probably run this only once if you are
2294 upgrading from Exim 3. None of the documentation files in the &_doc_&
2295 directory are copied, except for the info files when you have set
2296 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2297
2298 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2299 to their names. The Exim binary itself, however, is handled differently. It is
2300 installed under a name that includes the version number and the compile number,
2301 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2302 called &_exim_& to point to the binary. If you are updating a previous version
2303 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2304 from the directory (as seen by other processes).
2305
2306 .cindex "installing Exim" "testing the script"
2307 If you want to see what the &'make install'& will do before running it for
2308 real, you can pass the &%-n%& option to the installation script by this
2309 command:
2310 .code
2311 make INSTALL_ARG=-n install
2312 .endd
2313 The contents of the variable INSTALL_ARG are passed to the installation
2314 script. You do not need to be root to run this test. Alternatively, you can run
2315 the installation script directly, but this must be from within the build
2316 directory. For example, from the top-level Exim directory you could use this
2317 command:
2318 .code
2319 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2320 .endd
2321 .cindex "installing Exim" "install script options"
2322 There are two other options that can be supplied to the installation script.
2323
2324 .ilist
2325 &%-no_chown%& bypasses the call to change the owner of the installed binary
2326 to root, and the call to make it a setuid binary.
2327 .next
2328 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2329 installed binary.
2330 .endlist
2331
2332 INSTALL_ARG can be used to pass these options to the script. For example:
2333 .code
2334 make INSTALL_ARG=-no_symlink install
2335 .endd
2336 The installation script can also be given arguments specifying which files are
2337 to be copied. For example, to install just the Exim binary, and nothing else,
2338 without creating the symbolic link, you could use:
2339 .code
2340 make INSTALL_ARG='-no_symlink exim' install
2341 .endd
2342
2343
2344
2345 .section "Installing info documentation" "SECTinsinfdoc"
2346 .cindex "installing Exim" "&'info'& documentation"
2347 Not all systems use the GNU &'info'& system for documentation, and for this
2348 reason, the Texinfo source of Exim's documentation is not included in the main
2349 distribution. Instead it is available separately from the ftp site (see section
2350 &<<SECTavail>>&).
2351
2352 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2353 source of the documentation is found in the source tree, running &`make
2354 install`& automatically builds the info files and installs them.
2355
2356
2357
2358 .section "Setting up the spool directory" "SECID33"
2359 .cindex "spool directory" "creating"
2360 When it starts up, Exim tries to create its spool directory if it does not
2361 exist. The Exim uid and gid are used for the owner and group of the spool
2362 directory. Sub-directories are automatically created in the spool directory as
2363 necessary.
2364
2365
2366
2367
2368 .section "Testing" "SECID34"
2369 .cindex "testing" "installation"
2370 Having installed Exim, you can check that the run time configuration file is
2371 syntactically valid by running the following command, which assumes that the
2372 Exim binary directory is within your PATH environment variable:
2373 .code
2374 exim -bV
2375 .endd
2376 If there are any errors in the configuration file, Exim outputs error messages.
2377 Otherwise it outputs the version number and build date,
2378 the DBM library that is being used, and information about which drivers and
2379 other optional code modules are included in the binary.
2380 Some simple routing tests can be done by using the address testing option. For
2381 example,
2382 .display
2383 &`exim -bt`& <&'local username'&>
2384 .endd
2385 should verify that it recognizes a local mailbox, and
2386 .display
2387 &`exim -bt`& <&'remote address'&>
2388 .endd
2389 a remote one. Then try getting it to deliver mail, both locally and remotely.
2390 This can be done by passing messages directly to Exim, without going through a
2391 user agent. For example:
2392 .code
2393 exim -v postmaster@your.domain.example
2394 From: user@your.domain.example
2395 To: postmaster@your.domain.example
2396 Subject: Testing Exim
2397
2398 This is a test message.
2399 ^D
2400 .endd
2401 The &%-v%& option causes Exim to output some verification of what it is doing.
2402 In this case you should see copies of three log lines, one for the message's
2403 arrival, one for its delivery, and one containing &"Completed"&.
2404
2405 .cindex "delivery" "problems with"
2406 If you encounter problems, look at Exim's log files (&'mainlog'& and
2407 &'paniclog'&) to see if there is any relevant information there. Another source
2408 of information is running Exim with debugging turned on, by specifying the
2409 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2410 with debugging turned on by a command of the form
2411 .display
2412 &`exim -d -M`& <&'exim-message-id'&>
2413 .endd
2414 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2415 produces rather a lot of output, but you can cut this down to specific areas.
2416 For example, if you use &%-d-all+route%& only the debugging information
2417 relevant to routing is included. (See the &%-d%& option in chapter
2418 &<<CHAPcommandline>>& for more details.)
2419
2420 .cindex '&"sticky"& bit'
2421 .cindex "lock files"
2422 One specific problem that has shown up on some sites is the inability to do
2423 local deliveries into a shared mailbox directory, because it does not have the
2424 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2425 writing to a mailbox file, and if it cannot create the lock file, the delivery
2426 is deferred. You can get round this either by setting the &"sticky bit"& on the
2427 directory, or by setting a specific group for local deliveries and allowing
2428 that group to create files in the directory (see the comments above the
2429 &(local_delivery)& transport in the default configuration file). Another
2430 approach is to configure Exim not to use lock files, but just to rely on
2431 &[fcntl()]& locking instead. However, you should do this only if all user
2432 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2433 see chapter &<<CHAPappendfile>>&.
2434
2435 One thing that cannot be tested on a system that is already running an MTA is
2436 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2437 &%-oX%& option can be used to run an Exim daemon that listens on some other
2438 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2439 &'exim_checkaccess'& utility can be used to check out policy controls on
2440 incoming SMTP mail.
2441
2442 Testing a new version on a system that is already running Exim can most easily
2443 be done by building a binary with a different CONFIGURE_FILE setting. From
2444 within the run time configuration, all other file and directory names
2445 that Exim uses can be altered, in order to keep it entirely clear of the
2446 production version.
2447
2448
2449 .section "Replacing another MTA with Exim" "SECID35"
2450 .cindex "replacing another MTA"
2451 Building and installing Exim for the first time does not of itself put it in
2452 general use. The name by which the system's MTA is called by mail user agents
2453 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2454 operating system), and it is necessary to make this name point to the &'exim'&
2455 binary in order to get the user agents to pass messages to Exim. This is
2456 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2457 or &_/usr/lib/sendmail_&
2458 .cindex "symbolic link" "to &'exim'& binary"
2459 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2460 privilege and executable status from the old MTA. It is then necessary to stop
2461 and restart the mailer daemon, if one is running.
2462
2463 .cindex "FreeBSD, MTA indirection"
2464 .cindex "&_/etc/mail/mailer.conf_&"
2465 Some operating systems have introduced alternative ways of switching MTAs. For
2466 example, if you are running FreeBSD, you need to edit the file
2467 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2468 described. A typical example of the contents of this file for running Exim is
2469 as follows:
2470 .code
2471 sendmail            /usr/exim/bin/exim
2472 send-mail           /usr/exim/bin/exim
2473 mailq               /usr/exim/bin/exim -bp
2474 newaliases          /usr/bin/true
2475 .endd
2476 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2477 your Exim installation is &"live"&. Check it by sending a message from your
2478 favourite user agent.
2479
2480 You should consider what to tell your users about the change of MTA. Exim may
2481 have different capabilities to what was previously running, and there are
2482 various operational differences such as the text of messages produced by
2483 command line options and in bounce messages. If you allow your users to make
2484 use of Exim's filtering capabilities, you should make the document entitled
2485 &'Exim's interface to mail filtering'& available to them.
2486
2487
2488
2489 .section "Upgrading Exim" "SECID36"
2490 .cindex "upgrading Exim"
2491 If you are already running Exim on your host, building and installing a new
2492 version automatically makes it available to MUAs, or any other programs that
2493 call the MTA directly. However, if you are running an Exim daemon, you do need
2494 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2495 new binary. You do not need to stop processing mail in order to install a new
2496 version of Exim. The install script does not modify an existing runtime
2497 configuration file.
2498
2499
2500
2501
2502 .section "Stopping the Exim daemon on Solaris" "SECID37"
2503 .cindex "Solaris" "stopping Exim on"
2504 The standard command for stopping the mailer daemon on Solaris is
2505 .code
2506 /etc/init.d/sendmail stop
2507 .endd
2508 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2509 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2510 for the text &"sendmail"&; this is not present because the actual program name
2511 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2512 solution is to replace the line that finds the process id with something like
2513 .code
2514 pid=`cat /var/spool/exim/exim-daemon.pid`
2515 .endd
2516 to obtain the daemon's pid directly from the file that Exim saves it in.
2517
2518 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2519 still be received from local processes, and if automatic delivery is configured
2520 (the normal case), deliveries will still occur.
2521
2522
2523
2524
2525 . ////////////////////////////////////////////////////////////////////////////
2526 . ////////////////////////////////////////////////////////////////////////////
2527
2528 .chapter "The Exim command line" "CHAPcommandline"
2529 .scindex IIDclo1 "command line" "options"
2530 .scindex IIDclo2 "options" "command line"
2531 Exim's command line takes the standard Unix form of a sequence of options,
2532 each starting with a hyphen character, followed by a number of arguments. The
2533 options are compatible with the main options of Sendmail, and there are also
2534 some additional options, some of which are compatible with Smail 3. Certain
2535 combinations of options do not make sense, and provoke an error if used.
2536 The form of the arguments depends on which options are set.
2537
2538
2539 .section "Setting options by program name" "SECID38"
2540 .cindex "&'mailq'&"
2541 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2542 were present before any other options.
2543 The &%-bp%& option requests a listing of the contents of the mail queue on the
2544 standard output.
2545 This feature is for compatibility with some systems that contain a command of
2546 that name in one of the standard libraries, symbolically linked to
2547 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2548
2549 .cindex "&'rsmtp'&"
2550 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2551 were present before any other options, for compatibility with Smail. The
2552 &%-bS%& option is used for reading in a number of messages in batched SMTP
2553 format.
2554
2555 .cindex "&'rmail'&"
2556 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2557 &%-oee%& options were present before any other options, for compatibility with
2558 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2559
2560 .cindex "&'runq'&"
2561 .cindex "queue runner"
2562 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2563 were present before any other options, for compatibility with Smail. The &%-q%&
2564 option causes a single queue runner process to be started.
2565
2566 .cindex "&'newaliases'&"
2567 .cindex "alias file" "building"
2568 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2569 If Exim is called under the name &'newaliases'& it behaves as if the option
2570 &%-bi%& were present before any other options, for compatibility with Sendmail.
2571 This option is used for rebuilding Sendmail's alias file. Exim does not have
2572 the concept of a single alias file, but can be configured to run a given
2573 command if called with the &%-bi%& option.
2574
2575
2576 .section "Trusted and admin users" "SECTtrustedadmin"
2577 Some Exim options are available only to &'trusted users'& and others are
2578 available only to &'admin users'&. In the description below, the phrases &"Exim
2579 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2580 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2581 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2582
2583 .ilist
2584 .cindex "trusted users" "definition of"
2585 .cindex "user" "trusted definition of"
2586 The trusted users are root, the Exim user, any user listed in the
2587 &%trusted_users%& configuration option, and any user whose current group or any
2588 supplementary group is one of those listed in the &%trusted_groups%&
2589 configuration option. Note that the Exim group is not automatically trusted.
2590
2591 .cindex '&"From"& line'
2592 .cindex "envelope sender"
2593 Trusted users are always permitted to use the &%-f%& option or a leading
2594 &"From&~"& line to specify the envelope sender of a message that is passed to
2595 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2596 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2597 users to set envelope senders.
2598
2599 .cindex "&'From:'& header line"
2600 .cindex "&'Sender:'& header line"
2601 For a trusted user, there is never any check on the contents of the &'From:'&
2602 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2603 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2604
2605 Trusted users may also specify a host name, host address, interface address,
2606 protocol name, ident value, and authentication data when submitting a message
2607 locally. Thus, they are able to insert messages into Exim's queue locally that
2608 have the characteristics of messages received from a remote host. Untrusted
2609 users may in some circumstances use &%-f%&, but can never set the other values
2610 that are available to trusted users.
2611 .next
2612 .cindex "user" "admin definition of"
2613 .cindex "admin user" "definition of"
2614 The admin users are root, the Exim user, and any user that is a member of the
2615 Exim group or of any group listed in the &%admin_groups%& configuration option.
2616 The current group does not have to be one of these groups.
2617
2618 Admin users are permitted to list the queue, and to carry out certain
2619 operations on messages, for example, to force delivery failures. It is also
2620 necessary to be an admin user in order to see the full information provided by
2621 the Exim monitor, and full debugging output.
2622
2623 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2624 Exim to attempt delivery of messages on its queue is restricted to admin users.
2625 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2626 option false (that is, specifying &%no_prod_requires_admin%&).
2627
2628 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2629 is restricted to admin users unless &%queue_list_requires_admin%& is set
2630 false.
2631 .endlist
2632
2633
2634 &*Warning*&: If you configure your system so that admin users are able to
2635 edit Exim's configuration file, you are giving those users an easy way of
2636 getting root. There is further discussion of this issue at the start of chapter
2637 &<<CHAPconf>>&.
2638
2639
2640
2641
2642 .section "Command line options" "SECID39"
2643 Exim's command line options are described in alphabetical order below. If none
2644 of the options that specifies a specific action (such as starting the daemon or
2645 a queue runner, or testing an address, or receiving a message in a specific
2646 format, or listing the queue) are present, and there is at least one argument
2647 on the command line, &%-bm%& (accept a local message on the standard input,
2648 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2649 outputs a brief message about itself and exits.
2650
2651 . ////////////////////////////////////////////////////////////////////////////
2652 . Insert a stylized XML comment here, to identify the start of the command line
2653 . options. This is for the benefit of the Perl script that automatically
2654 . creates a man page for the options.
2655 . ////////////////////////////////////////////////////////////////////////////
2656
2657 .literal xml
2658 <!-- === Start of command line options === -->
2659 .literal off
2660
2661
2662 .vlist
2663 .vitem &%--%&
2664 .oindex "--"
2665 .cindex "options" "command line; terminating"
2666 This is a pseudo-option whose only purpose is to terminate the options and
2667 therefore to cause subsequent command line items to be treated as arguments
2668 rather than options, even if they begin with hyphens.
2669
2670 .vitem &%--help%&
2671 .oindex "&%--help%&"
2672 This option causes Exim to output a few sentences stating what it is.
2673 The same output is generated if the Exim binary is called with no options and
2674 no arguments.
2675
2676 .vitem &%--version%&
2677 .oindex "&%--version%&"
2678 This option is an alias for &%-bV%& and causes version information to be
2679 displayed.
2680
2681 .new
2682 .vitem &%-Ac%& &&&
2683        &%-Am%&
2684 .oindex "&%-Ac%&"
2685 .oindex "&%-Am%&"
2686 These options are used by Sendmail for selecting configuration files and are
2687 ignored by Exim.
2688 .wen
2689
2690 .vitem &%-B%&<&'type'&>
2691 .oindex "&%-B%&"
2692 .cindex "8-bit characters"
2693 .cindex "Sendmail compatibility" "8-bit characters"
2694 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2695 clean; it ignores this option.
2696
2697 .vitem &%-bd%&
2698 .oindex "&%-bd%&"
2699 .cindex "daemon"
2700 .cindex "SMTP" "listener"
2701 .cindex "queue runner"
2702 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2703 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2704 that the daemon should also initiate periodic queue runs.
2705
2706 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2707 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2708 disconnect from the controlling terminal. When running this way, it can be
2709 stopped by pressing ctrl-C.
2710
2711 By default, Exim listens for incoming connections to the standard SMTP port on
2712 all the host's running interfaces. However, it is possible to listen on other
2713 ports, on multiple ports, and only on specific interfaces. Chapter
2714 &<<CHAPinterfaces>>& contains a description of the options that control this.
2715
2716 When a listening daemon
2717 .cindex "daemon" "process id (pid)"
2718 .cindex "pid (process id)" "of daemon"
2719 is started without the use of &%-oX%& (that is, without overriding the normal
2720 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2721 in Exim's spool directory. This location can be overridden by setting
2722 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2723 running as root.
2724
2725 When &%-oX%& is used on the command line to start a listening daemon, the
2726 process id is not written to the normal pid file path. However, &%-oP%& can be
2727 used to specify a path on the command line if a pid file is required.
2728
2729 The SIGHUP signal
2730 .cindex "SIGHUP"
2731 .cindex "daemon" "restarting"
2732 can be used to cause the daemon to re-execute itself. This should be done
2733 whenever Exim's configuration file, or any file that is incorporated into it by
2734 means of the &%.include%& facility, is changed, and also whenever a new version
2735 of Exim is installed. It is not necessary to do this when other files that are
2736 referenced from the configuration (for example, alias files) are changed,
2737 because these are reread each time they are used.
2738
2739 .vitem &%-bdf%&
2740 .oindex "&%-bdf%&"
2741 This option has the same effect as &%-bd%& except that it never disconnects
2742 from the controlling terminal, even when no debugging is specified.
2743
2744 .vitem &%-be%&
2745 .oindex "&%-be%&"
2746 .cindex "testing" "string expansion"
2747 .cindex "expansion" "testing"
2748 Run Exim in expansion testing mode. Exim discards its root privilege, to
2749 prevent ordinary users from using this mode to read otherwise inaccessible
2750 files. If no arguments are given, Exim runs interactively, prompting for lines
2751 of data. Otherwise, it processes each argument in turn.
2752
2753 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2754 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2755 used without command line arguments. If successful, it uses the &[readline()]&
2756 function, which provides extensive line-editing facilities, for reading the
2757 test data. A line history is supported.
2758
2759 Long expansion expressions can be split over several lines by using backslash
2760 continuations. As in Exim's run time configuration, white space at the start of
2761 continuation lines is ignored. Each argument or data line is passed through the
2762 string expansion mechanism, and the result is output. Variable values from the
2763 configuration file (for example, &$qualify_domain$&) are available, but no
2764 message-specific values (such as &$sender_domain$&) are set, because no message
2765 is being processed (but see &%-bem%& and &%-Mset%&).
2766
2767 &*Note*&: If you use this mechanism to test lookups, and you change the data
2768 files or databases you are using, you must exit and restart Exim before trying
2769 the same lookup again. Otherwise, because each Exim process caches the results
2770 of lookups, you will just get the same result as before.
2771
2772 .vitem &%-bem%&&~<&'filename'&>
2773 .oindex "&%-bem%&"
2774 .cindex "testing" "string expansion"
2775 .cindex "expansion" "testing"
2776 This option operates like &%-be%& except that it must be followed by the name
2777 of a file. For example:
2778 .code
2779 exim -bem /tmp/testmessage
2780 .endd
2781 The file is read as a message (as if receiving a locally-submitted non-SMTP
2782 message) before any of the test expansions are done. Thus, message-specific
2783 variables such as &$message_size$& and &$header_from:$& are available. However,
2784 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2785 recipients are read from the headers in the normal way, and are shown in the
2786 &$recipients$& variable. Note that recipients cannot be given on the command
2787 line, because further arguments are taken as strings to expand (just like
2788 &%-be%&).
2789
2790 .vitem &%-bF%&&~<&'filename'&>
2791 .oindex "&%-bF%&"
2792 .cindex "system filter" "testing"
2793 .cindex "testing" "system filter"
2794 This option is the same as &%-bf%& except that it assumes that the filter being
2795 tested is a system filter. The additional commands that are available only in
2796 system filters are recognized.
2797
2798 .vitem &%-bf%&&~<&'filename'&>
2799 .oindex "&%-bf%&"
2800 .cindex "filter" "testing"
2801 .cindex "testing" "filter file"
2802 .cindex "forward file" "testing"
2803 .cindex "testing" "forward file"
2804 .cindex "Sieve filter" "testing"
2805 This option runs Exim in user filter testing mode; the file is the filter file
2806 to be tested, and a test message must be supplied on the standard input. If
2807 there are no message-dependent tests in the filter, an empty file can be
2808 supplied.
2809
2810 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2811 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2812 filter and a user filter in the same run. For example:
2813 .code
2814 exim -bF /system/filter -bf /user/filter </test/message
2815 .endd
2816 This is helpful when the system filter adds header lines or sets filter
2817 variables that are used by the user filter.
2818
2819 If the test filter file does not begin with one of the special lines
2820 .code
2821 # Exim filter
2822 # Sieve filter
2823 .endd
2824 it is taken to be a normal &_.forward_& file, and is tested for validity under
2825 that interpretation. See sections &<<SECTitenonfilred>>& to
2826 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2827 redirection lists.
2828
2829 The result of an Exim command that uses &%-bf%&, provided no errors are
2830 detected, is a list of the actions that Exim would try to take if presented
2831 with the message for real. More details of filter testing are given in the
2832 separate document entitled &'Exim's interfaces to mail filtering'&.
2833
2834 When testing a filter file,
2835 .cindex "&""From""& line"
2836 .cindex "envelope sender"
2837 .oindex "&%-f%&" "for filter testing"
2838 the envelope sender can be set by the &%-f%& option,
2839 or by a &"From&~"& line at the start of the test message. Various parameters
2840 that would normally be taken from the envelope recipient address of the message
2841 can be set by means of additional command line options (see the next four
2842 options).
2843
2844 .vitem &%-bfd%&&~<&'domain'&>
2845 .oindex "&%-bfd%&"
2846 .vindex "&$qualify_domain$&"
2847 This sets the domain of the recipient address when a filter file is being
2848 tested by means of the &%-bf%& option. The default is the value of
2849 &$qualify_domain$&.
2850
2851 .vitem &%-bfl%&&~<&'local&~part'&>
2852 .oindex "&%-bfl%&"
2853 This sets the local part of the recipient address when a filter file is being
2854 tested by means of the &%-bf%& option. The default is the username of the
2855 process that calls Exim. A local part should be specified with any prefix or
2856 suffix stripped, because that is how it appears to the filter when a message is
2857 actually being delivered.
2858
2859 .vitem &%-bfp%&&~<&'prefix'&>
2860 .oindex "&%-bfp%&"
2861 This sets the prefix of the local part of the recipient address when a filter
2862 file is being tested by means of the &%-bf%& option. The default is an empty
2863 prefix.
2864
2865 .vitem &%-bfs%&&~<&'suffix'&>
2866 .oindex "&%-bfs%&"
2867 This sets the suffix of the local part of the recipient address when a filter
2868 file is being tested by means of the &%-bf%& option. The default is an empty
2869 suffix.
2870
2871 .vitem &%-bh%&&~<&'IP&~address'&>
2872 .oindex "&%-bh%&"
2873 .cindex "testing" "incoming SMTP"
2874 .cindex "SMTP" "testing incoming"
2875 .cindex "testing" "relay control"
2876 .cindex "relaying" "testing configuration"
2877 .cindex "policy control" "testing"
2878 .cindex "debugging" "&%-bh%& option"
2879 This option runs a fake SMTP session as if from the given IP address, using the
2880 standard input and output. The IP address may include a port number at the end,
2881 after a full stop. For example:
2882 .code
2883 exim -bh 10.9.8.7.1234
2884 exim -bh fe80::a00:20ff:fe86:a061.5678
2885 .endd
2886 When an IPv6 address is given, it is converted into canonical form. In the case
2887 of the second example above, the value of &$sender_host_address$& after
2888 conversion to the canonical form is
2889 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2890
2891 Comments as to what is going on are written to the standard error file. These
2892 include lines beginning with &"LOG"& for anything that would have been logged.
2893 This facility is provided for testing configuration options for incoming
2894 messages, to make sure they implement the required policy. For example, you can
2895 test your relay controls using &%-bh%&.
2896
2897 &*Warning 1*&:
2898 .cindex "RFC 1413"
2899 You can test features of the configuration that rely on ident (RFC 1413)
2900 information by using the &%-oMt%& option. However, Exim cannot actually perform
2901 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2902 connection.
2903
2904 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2905 are also skipped when testing using &%-bh%&. If you want these callouts to
2906 occur, use &%-bhc%& instead.
2907
2908 Messages supplied during the testing session are discarded, and nothing is
2909 written to any of the real log files. There may be pauses when DNS (and other)
2910 lookups are taking place, and of course these may time out. The &%-oMi%& option
2911 can be used to specify a specific IP interface and port if this is important,
2912 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2913 session were authenticated.
2914
2915 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2916 output just states whether a given recipient address from a given host is
2917 acceptable or not. See section &<<SECTcheckaccess>>&.
2918
2919 Features such as authentication and encryption, where the client input is not
2920 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2921 specialized SMTP test program such as
2922 &url(http://jetmore.org/john/code/#swaks,swaks).
2923
2924 .vitem &%-bhc%&&~<&'IP&~address'&>
2925 .oindex "&%-bhc%&"
2926 This option operates in the same way as &%-bh%&, except that address
2927 verification callouts are performed if required. This includes consulting and
2928 updating the callout cache database.
2929
2930 .vitem &%-bi%&
2931 .oindex "&%-bi%&"
2932 .cindex "alias file" "building"
2933 .cindex "building alias file"
2934 .cindex "Sendmail compatibility" "&%-bi%& option"
2935 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2936 Exim does not have the concept of a single alias file, and so it cannot mimic
2937 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2938 tend to appear in various scripts such as NIS make files, so the option must be
2939 recognized.
2940
2941 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2942 configuration option is run, under the uid and gid of the caller of Exim. If
2943 the &%-oA%& option is used, its value is passed to the command as an argument.
2944 The command set by &%bi_command%& may not contain arguments. The command can
2945 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2946 if this is required. If the &%bi_command%& option is not set, calling Exim with
2947 &%-bi%& is a no-op.
2948
2949 .new
2950 . // Keep :help first, then the rest in alphabetical order
2951 .vitem &%-bI:help%&
2952 .oindex "&%-bI:help%&"
2953 .cindex "querying exim information"
2954 We shall provide various options starting &`-bI:`& for querying Exim for
2955 information.  The output of many of these will be intended for machine
2956 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2957 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2958 options shall cause Exim to exit after producing the requested output.
2959
2960 .vitem &%-bI:dscp%&
2961 .oindex "&%-bI:dscp%&"
2962 .cindex "DSCP" "values"
2963 This option causes Exim to emit an alphabetically sorted list of all
2964 recognised DSCP names.
2965
2966 .vitem &%-bI:sieve%&
2967 .oindex "&%-bI:sieve%&"
2968 .cindex "Sieve filter" "capabilities"
2969 This option causes Exim to emit an alphabetically sorted list of all supported
2970 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2971 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2972 &`SIEVE`& capability response line.  As the precise list may depend upon
2973 compile-time build options, which this option will adapt to, this is the only
2974 way to guarantee a correct response.
2975 .wen
2976
2977 .vitem &%-bm%&
2978 .oindex "&%-bm%&"
2979 .cindex "local message reception"
2980 This option runs an Exim receiving process that accepts an incoming,
2981 locally-generated message on the current input. The recipients are given as the
2982 command arguments (except when &%-t%& is also present &-- see below). Each
2983 argument can be a comma-separated list of RFC 2822 addresses. This is the
2984 default option for selecting the overall action of an Exim call; it is assumed
2985 if no other conflicting option is present.
2986
2987 If any addresses in the message are unqualified (have no domain), they are
2988 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2989 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2990 suppressing this for special cases.
2991
2992 Policy checks on the contents of local messages can be enforced by means of
2993 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2994
2995 .cindex "return code" "for &%-bm%&"
2996 The return code is zero if the message is successfully accepted. Otherwise, the
2997 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2998
2999 The format
3000 .cindex "message" "format"
3001 .cindex "format" "message"
3002 .cindex "&""From""& line"
3003 .cindex "UUCP" "&""From""& line"
3004 .cindex "Sendmail compatibility" "&""From""& line"
3005 of the message must be as defined in RFC 2822, except that, for
3006 compatibility with Sendmail and Smail, a line in one of the forms
3007 .code
3008 From sender Fri Jan  5 12:55 GMT 1997
3009 From sender Fri, 5 Jan 97 12:55:01
3010 .endd
3011 (with the weekday optional, and possibly with additional text after the date)
3012 is permitted to appear at the start of the message. There appears to be no
3013 authoritative specification of the format of this line. Exim recognizes it by
3014 matching against the regular expression defined by the &%uucp_from_pattern%&
3015 option, which can be changed if necessary.
3016
3017 .oindex "&%-f%&" "overriding &""From""& line"
3018 The specified sender is treated as if it were given as the argument to the
3019 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3020 preference to the address taken from the message. The caller of Exim must be a
3021 trusted user for the sender of a message to be set in this way.
3022
3023 .vitem &%-bmalware%&&~<&'filename'&>
3024 .oindex "&%-bmalware%&"
3025 .cindex "testing", "malware"
3026 .cindex "malware scan test"
3027 This debugging option causes Exim to scan the given file,
3028 using the malware scanning framework.  The option of &%av_scanner%& influences
3029 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3030 the expansion should have defaults which apply to this invocation.  ACLs are
3031 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3032 will never be populated and &%-bmalware%& will fail.
3033
3034 Exim will have changed working directory before resolving the filename, so
3035 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3036 user when it tries to open the file, rather than as the invoking user.
3037 This option requires admin privileges.
3038
3039 The &%-bmalware%& option will not be extended to be more generally useful,
3040 there are better tools for file-scanning.  This option exists to help
3041 administrators verify their Exim and AV scanner configuration.
3042
3043 .vitem &%-bnq%&
3044 .oindex "&%-bnq%&"
3045 .cindex "address qualification, suppressing"
3046 By default, Exim automatically qualifies unqualified addresses (those
3047 without domains) that appear in messages that are submitted locally (that
3048 is, not over TCP/IP). This qualification applies both to addresses in
3049 envelopes, and addresses in header lines. Sender addresses are qualified using
3050 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3051 defaults to the value of &%qualify_domain%&).
3052
3053 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3054 being used to re-submit messages that originally came from remote hosts after
3055 content scanning, you probably do not want to qualify unqualified addresses in
3056 header lines. (Such lines will be present only if you have not enabled a header
3057 syntax check in the appropriate ACL.)
3058
3059 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3060 messages that originate on the local host. When this is used, unqualified
3061 addresses in the envelope provoke errors (causing message rejection) and
3062 unqualified addresses in header lines are left alone.
3063
3064
3065 .vitem &%-bP%&
3066 .oindex "&%-bP%&"
3067 .cindex "configuration options" "extracting"
3068 .cindex "options" "configuration &-- extracting"
3069 If this option is given with no arguments, it causes the values of all Exim's
3070 main configuration options to be written to the standard output. The values
3071 of one or more specific options can be requested by giving their names as
3072 arguments, for example:
3073 .code
3074 exim -bP qualify_domain hold_domains
3075 .endd
3076 .cindex "hiding configuration option values"
3077 .cindex "configuration options" "hiding value of"
3078 .cindex "options" "hiding value of"
3079 However, any option setting that is preceded by the word &"hide"& in the
3080 configuration file is not shown in full, except to an admin user. For other
3081 users, the output is as in this example:
3082 .code
3083 mysql_servers = <value not displayable>
3084 .endd
3085 If &%configure_file%& is given as an argument, the name of the run time
3086 configuration file is output.
3087 If a list of configuration files was supplied, the value that is output here
3088 is the name of the file that was actually used.
3089
3090 .new
3091 .cindex "options" "hiding name of"
3092 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3093 name will not be output.
3094 .wen
3095
3096 .cindex "daemon" "process id (pid)"
3097 .cindex "pid (process id)" "of daemon"
3098 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3099 directories where log files and daemon pid files are written are output,
3100 respectively. If these values are unset, log files are written in a
3101 sub-directory of the spool directory called &%log%&, and the pid file is
3102 written directly into the spool directory.
3103
3104 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3105 .code
3106 exim -bP +local_domains
3107 .endd
3108 it searches for a matching named list of any type (domain, host, address, or
3109 local part) and outputs what it finds.
3110
3111 .cindex "options" "router &-- extracting"
3112 .cindex "options" "transport &-- extracting"
3113 .cindex "options" "authenticator &-- extracting"
3114 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3115 followed by the name of an appropriate driver instance, the option settings for
3116 that driver are output. For example:
3117 .code
3118 exim -bP transport local_delivery
3119 .endd
3120 The generic driver options are output first, followed by the driver's private
3121 options. A list of the names of drivers of a particular type can be obtained by
3122 using one of the words &%router_list%&, &%transport_list%&, or
3123 &%authenticator_list%&, and a complete list of all drivers with their option
3124 settings can be obtained by using &%routers%&, &%transports%&, or
3125 &%authenticators%&.
3126
3127 .cindex "options" "macro &-- extracting"
3128 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3129 are available, similarly to the drivers.  Because macros are sometimes used
3130 for storing passwords, this option is restricted.
3131 The output format is one item per line.
3132
3133 .vitem &%-bp%&
3134 .oindex "&%-bp%&"
3135 .cindex "queue" "listing messages on"
3136 .cindex "listing" "messages on the queue"
3137 This option requests a listing of the contents of the mail queue on the
3138 standard output. If the &%-bp%& option is followed by a list of message ids,
3139 just those messages are listed. By default, this option can be used only by an
3140 admin user. However, the &%queue_list_requires_admin%& option can be set false
3141 to allow any user to see the queue.
3142
3143 Each message on the queue is displayed as in the following example:
3144 .code
3145 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3146           red.king@looking-glass.fict.example
3147           <other addresses>
3148 .endd
3149 .cindex "message" "size in queue listing"
3150 .cindex "size" "of message"
3151 The first line contains the length of time the message has been on the queue
3152 (in this case 25 minutes), the size of the message (2.9K), the unique local
3153 identifier for the message, and the message sender, as contained in the
3154 envelope. For bounce messages, the sender address is empty, and appears as
3155 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3156 the default sender address, the user's login name is shown in parentheses
3157 before the sender address.
3158
3159 .cindex "frozen messages" "in queue listing"
3160 If the message is frozen (attempts to deliver it are suspended) then the text
3161 &"*** frozen ***"& is displayed at the end of this line.
3162
3163 The recipients of the message (taken from the envelope, not the headers) are
3164 displayed on subsequent lines. Those addresses to which the message has already
3165 been delivered are marked with the letter D. If an original address gets
3166 expanded into several addresses via an alias or forward file, the original is
3167 displayed with a D only when deliveries for all of its child addresses are
3168 complete.
3169
3170
3171 .vitem &%-bpa%&
3172 .oindex "&%-bpa%&"
3173 This option operates like &%-bp%&, but in addition it shows delivered addresses
3174 that were generated from the original top level address(es) in each message by
3175 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3176 of just &"D"&.
3177
3178
3179 .vitem &%-bpc%&
3180 .oindex "&%-bpc%&"
3181 .cindex "queue" "count of messages on"
3182 This option counts the number of messages on the queue, and writes the total
3183 to the standard output. It is restricted to admin users, unless
3184 &%queue_list_requires_admin%& is set false.
3185
3186
3187 .vitem &%-bpr%&
3188 .oindex "&%-bpr%&"
3189 This option operates like &%-bp%&, but the output is not sorted into
3190 chronological order of message arrival. This can speed it up when there are
3191 lots of messages on the queue, and is particularly useful if the output is
3192 going to be post-processed in a way that doesn't need the sorting.
3193
3194 .vitem &%-bpra%&
3195 .oindex "&%-bpra%&"
3196 This option is a combination of &%-bpr%& and &%-bpa%&.
3197
3198 .vitem &%-bpru%&
3199 .oindex "&%-bpru%&"
3200 This option is a combination of &%-bpr%& and &%-bpu%&.
3201
3202
3203 .vitem &%-bpu%&
3204 .oindex "&%-bpu%&"
3205 This option operates like &%-bp%& but shows only undelivered top-level
3206 addresses for each message displayed. Addresses generated by aliasing or
3207 forwarding are not shown, unless the message was deferred after processing by a
3208 router with the &%one_time%& option set.
3209
3210
3211 .vitem &%-brt%&
3212 .oindex "&%-brt%&"
3213 .cindex "testing" "retry configuration"
3214 .cindex "retry" "configuration testing"
3215 This option is for testing retry rules, and it must be followed by up to three
3216 arguments. It causes Exim to look for a retry rule that matches the values
3217 and to write it to the standard output. For example:
3218 .code
3219 exim -brt bach.comp.mus.example
3220 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3221 .endd
3222 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3223 argument, which is required, can be a complete address in the form
3224 &'local_part@domain'&, or it can be just a domain name. If the second argument
3225 contains a dot, it is interpreted as an optional second domain name; if no
3226 retry rule is found for the first argument, the second is tried. This ties in
3227 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3228 rule is found that matches the host, one that matches the mail domain is
3229 sought. Finally, an argument that is the name of a specific delivery error, as
3230 used in setting up retry rules, can be given. For example:
3231 .code
3232 exim -brt haydn.comp.mus.example quota_3d
3233 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3234 .endd
3235
3236 .vitem &%-brw%&
3237 .oindex "&%-brw%&"
3238 .cindex "testing" "rewriting"
3239 .cindex "rewriting" "testing"
3240 This option is for testing address rewriting rules, and it must be followed by
3241 a single argument, consisting of either a local part without a domain, or a
3242 complete address with a fully qualified domain. Exim outputs how this address
3243 would be rewritten for each possible place it might appear. See chapter
3244 &<<CHAPrewrite>>& for further details.
3245
3246 .vitem &%-bS%&
3247 .oindex "&%-bS%&"
3248 .cindex "SMTP" "batched incoming"
3249 .cindex "batched SMTP input"
3250 This option is used for batched SMTP input, which is an alternative interface
3251 for non-interactive local message submission. A number of messages can be
3252 submitted in a single run. However, despite its name, this is not really SMTP
3253 input. Exim reads each message's envelope from SMTP commands on the standard
3254 input, but generates no responses. If the caller is trusted, or
3255 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3256 believed; otherwise the sender is always the caller of Exim.
3257
3258 The message itself is read from the standard input, in SMTP format (leading
3259 dots doubled), terminated by a line containing just a single dot. An error is
3260 provoked if the terminating dot is missing. A further message may then follow.
3261
3262 As for other local message submissions, the contents of incoming batch SMTP
3263 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3264 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3265 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3266
3267 Some other SMTP commands are recognized in the input. HELO and EHLO act
3268 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3269 QUIT quits, ignoring the rest of the standard input.
3270
3271 .cindex "return code" "for &%-bS%&"
3272 If any error is encountered, reports are written to the standard output and
3273 error streams, and Exim gives up immediately. The return code is 0 if no error
3274 was detected; it is 1 if one or more messages were accepted before the error
3275 was detected; otherwise it is 2.
3276
3277 More details of input using batched SMTP are given in section
3278 &<<SECTincomingbatchedSMTP>>&.
3279
3280 .vitem &%-bs%&
3281 .oindex "&%-bs%&"
3282 .cindex "SMTP" "local input"
3283 .cindex "local SMTP input"
3284 This option causes Exim to accept one or more messages by reading SMTP commands
3285 on the standard input, and producing SMTP replies on the standard output. SMTP
3286 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3287 Some user agents use this interface as a way of passing locally-generated
3288 messages to the MTA.
3289
3290 In
3291 .cindex "sender" "source of"
3292 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3293 set, the senders of messages are taken from the SMTP MAIL commands.
3294 Otherwise the content of these commands is ignored and the sender is set up as
3295 the calling user. Unqualified addresses are automatically qualified using
3296 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3297 &%-bnq%& option is used.
3298
3299 .cindex "inetd"
3300 The
3301 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3302 using a listening daemon. Exim can distinguish the two cases by checking
3303 whether the standard input is a TCP/IP socket. When Exim is called from
3304 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3305 above concerning senders and qualification do not apply. In this situation,
3306 Exim behaves in exactly the same way as it does when receiving a message via
3307 the listening daemon.
3308
3309 .vitem &%-bt%&
3310 .oindex "&%-bt%&"
3311 .cindex "testing" "addresses"
3312 .cindex "address" "testing"
3313 This option runs Exim in address testing mode, in which each argument is taken
3314 as a recipient address to be tested for deliverability. The results are
3315 written to the standard output. If a test fails, and the caller is not an admin
3316 user, no details of the failure are output, because these might contain
3317 sensitive information such as usernames and passwords for database lookups.
3318
3319 If no arguments are given, Exim runs in an interactive manner, prompting with a
3320 right angle bracket for addresses to be tested.
3321
3322 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3323 &[readline()]& function, because it is running as &'root'& and there are
3324 security issues.
3325
3326 Each address is handled as if it were the recipient address of a message
3327 (compare the &%-bv%& option). It is passed to the routers and the result is
3328 written to the standard output. However, any router that has
3329 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3330 genuine routing tests if your first router passes everything to a scanner
3331 program.
3332
3333 .cindex "return code" "for &%-bt%&"
3334 The return code is 2 if any address failed outright; it is 1 if no address
3335 failed outright but at least one could not be resolved for some reason. Return
3336 code 0 is given only when all addresses succeed.
3337
3338 .cindex "duplicate addresses"
3339 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3340 addresses after routing is complete, so that only one delivery takes place.
3341 This does not happen when testing with &%-bt%&; the full results of routing are
3342 always shown.
3343
3344 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3345 routers in the configuration makes any tests on the sender address of a
3346 message,
3347 .oindex "&%-f%&" "for address testing"
3348 you can use the &%-f%& option to set an appropriate sender when running
3349 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3350 default qualifying domain. However, if you have set up (for example) routers
3351 whose behaviour depends on the contents of an incoming message, you cannot test
3352 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3353 doing such tests.
3354
3355 .vitem &%-bV%&
3356 .oindex "&%-bV%&"
3357 .cindex "version number of Exim"
3358 This option causes Exim to write the current version number, compilation
3359 number, and compilation date of the &'exim'& binary to the standard output.
3360 It also lists the DBM library that is being used, the optional modules (such as
3361 specific lookup types), the drivers that are included in the binary, and the
3362 name of the run time configuration file that is in use.
3363
3364 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3365 configuration file. However, this is a static check only. It cannot check
3366 values that are to be expanded. For example, although a misspelt ACL verb is
3367 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3368 alone to discover (for example) all the typos in the configuration; some
3369 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3370 dynamic testing facilities.
3371
3372 .vitem &%-bv%&
3373 .oindex "&%-bv%&"
3374 .cindex "verifying address" "using &%-bv%&"
3375 .cindex "address" "verification"
3376 This option runs Exim in address verification mode, in which each argument is
3377 taken as a recipient address to be verified by the routers. (This does
3378 not involve any verification callouts). During normal operation, verification
3379 happens mostly as a consequence processing a &%verify%& condition in an ACL
3380 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3381 including callouts, see the &%-bh%& and &%-bhc%& options.
3382
3383 If verification fails, and the caller is not an admin user, no details of the
3384 failure are output, because these might contain sensitive information such as
3385 usernames and passwords for database lookups.
3386
3387 If no arguments are given, Exim runs in an interactive manner, prompting with a
3388 right angle bracket for addresses to be verified.
3389
3390 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3391 &[readline()]& function, because it is running as &'exim'& and there are
3392 security issues.
3393
3394 Verification differs from address testing (the &%-bt%& option) in that routers
3395 that have &%no_verify%& set are skipped, and if the address is accepted by a
3396 router that has &%fail_verify%& set, verification fails. The address is
3397 verified as a recipient if &%-bv%& is used; to test verification for a sender
3398 address, &%-bvs%& should be used.
3399
3400 If the &%-v%& option is not set, the output consists of a single line for each
3401 address, stating whether it was verified or not, and giving a reason in the
3402 latter case. Without &%-v%&, generating more than one address by redirection
3403 causes verification to end successfully, without considering the generated
3404 addresses. However, if just one address is generated, processing continues,
3405 and the generated address must verify successfully for the overall verification
3406 to succeed.
3407
3408 When &%-v%& is set, more details are given of how the address has been handled,
3409 and in the case of address redirection, all the generated addresses are also
3410 considered. Verification may succeed for some and fail for others.
3411
3412 The
3413 .cindex "return code" "for &%-bv%&"
3414 return code is 2 if any address failed outright; it is 1 if no address
3415 failed outright but at least one could not be resolved for some reason. Return
3416 code 0 is given only when all addresses succeed.
3417
3418 If any of the routers in the configuration makes any tests on the sender
3419 address of a message, you should use the &%-f%& option to set an appropriate
3420 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3421 calling user at the default qualifying domain.
3422
3423 .vitem &%-bvs%&
3424 .oindex "&%-bvs%&"
3425 This option acts like &%-bv%&, but verifies the address as a sender rather
3426 than a recipient address. This affects any rewriting and qualification that
3427 might happen.
3428
3429 .vitem &%-bw%&
3430 .oindex "&%-bw%&"
3431 .cindex "daemon"
3432 .cindex "inetd"
3433 .cindex "inetd" "wait mode"
3434 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3435 similarly to the &%-bd%& option.  All port specifications on the command-line
3436 and in the configuration file are ignored.  Queue-running may not be specified.
3437
3438 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3439 listening for connections.  This permits the system to start up and have
3440 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3441 each port only when the first connection is received.
3442
3443 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3444 which the daemon will exit, which should cause inetd to listen once more.
3445
3446 .vitem &%-C%&&~<&'filelist'&>
3447 .oindex "&%-C%&"
3448 .cindex "configuration file" "alternate"
3449 .cindex "CONFIGURE_FILE"
3450 .cindex "alternate configuration file"
3451 This option causes Exim to find the run time configuration file from the given
3452 list instead of from the list specified by the CONFIGURE_FILE
3453 compile-time setting. Usually, the list will consist of just a single file
3454 name, but it can be a colon-separated list of names. In this case, the first
3455 file that exists is used. Failure to open an existing file stops Exim from
3456 proceeding any further along the list, and an error is generated.
3457
3458 When this option is used by a caller other than root, and the list is different
3459 from the compiled-in list, Exim gives up its root privilege immediately, and
3460 runs with the real and effective uid and gid set to those of the caller.
3461 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3462 file contains a list of full pathnames, one per line, for configuration files
3463 which are trusted. Root privilege is retained for any configuration file so
3464 listed, as long as the caller is the Exim user (or the user specified in the
3465 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3466 not writeable by inappropriate users or groups.
3467
3468 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3469 configuration using &%-C%& right through message reception and delivery,
3470 even if the caller is root. The reception works, but by that time, Exim is
3471 running as the Exim user, so when it re-executes to regain privilege for the
3472 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3473 test reception and delivery using two separate commands (one to put a message
3474 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3475
3476 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3477 prefix string with which any file named in a &%-C%& command line option
3478 must start. In addition, the file name must not contain the sequence &`/../`&.
3479 However, if the value of the &%-C%& option is identical to the value of
3480 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3481 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3482 unset, any file name can be used with &%-C%&.
3483
3484 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3485 to a directory to which only root has access. This prevents someone who has
3486 broken into the Exim account from running a privileged Exim with an arbitrary
3487 configuration file.
3488
3489 The &%-C%& facility is useful for ensuring that configuration files are
3490 syntactically correct, but cannot be used for test deliveries, unless the
3491 caller is privileged, or unless it is an exotic configuration that does not
3492 require privilege. No check is made on the owner or group of the files
3493 specified by this option.
3494
3495
3496 .vitem &%-D%&<&'macro'&>=<&'value'&>
3497 .oindex "&%-D%&"
3498 .cindex "macro" "setting on command line"
3499 This option can be used to override macro definitions in the configuration file
3500 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3501 unprivileged caller, it causes Exim to give up its root privilege.
3502 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3503 completely disabled, and its use causes an immediate error exit.
3504
3505 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3506 colon-separated list of macros which are considered safe and, if &%-D%& only
3507 supplies macros from this list, and the values are acceptable, then Exim will
3508 not give up root privilege if the caller is root, the Exim run-time user, or
3509 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3510 to be removed in the future.  Acceptable values for the macros satisfy the
3511 regexp: &`^[A-Za-z0-9_/.-]*$`&
3512
3513 The entire option (including equals sign if present) must all be within one
3514 command line item. &%-D%& can be used to set the value of a macro to the empty
3515 string, in which case the equals sign is optional. These two commands are
3516 synonymous:
3517 .code
3518 exim -DABC  ...
3519 exim -DABC= ...
3520 .endd
3521 To include spaces in a macro definition item, quotes must be used. If you use
3522 quotes, spaces are permitted around the macro name and the equals sign. For
3523 example:
3524 .code
3525 exim '-D ABC = something' ...
3526 .endd
3527 &%-D%& may be repeated up to 10 times on a command line.
3528
3529
3530 .vitem &%-d%&<&'debug&~options'&>
3531 .oindex "&%-d%&"
3532 .cindex "debugging" "list of selectors"
3533 .cindex "debugging" "&%-d%& option"
3534 This option causes debugging information to be written to the standard
3535 error stream. It is restricted to admin users because debugging output may show
3536 database queries that contain password information. Also, the details of users'
3537 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3538 writes an error message to the standard error stream and exits with a non-zero
3539 return code.
3540
3541 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3542 standard debugging data is output. This can be reduced, or increased to include
3543 some more rarely needed information, by directly following &%-d%& with a string
3544 made up of names preceded by plus or minus characters. These add or remove sets
3545 of debugging data, respectively. For example, &%-d+filter%& adds filter
3546 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3547 no spaces are allowed in the debug setting. The available debugging categories
3548 are:
3549 .display
3550 &`acl            `& ACL interpretation
3551 &`auth           `& authenticators
3552 &`deliver        `& general delivery logic
3553 &`dns            `& DNS lookups (see also resolver)
3554 &`dnsbl          `& DNS black list (aka RBL) code
3555 &`exec           `& arguments for &[execv()]& calls
3556 &`expand         `& detailed debugging for string expansions
3557 &`filter         `& filter handling
3558 &`hints_lookup   `& hints data lookups
3559 &`host_lookup    `& all types of name-to-IP address handling
3560 &`ident          `& ident lookup
3561 &`interface      `& lists of local interfaces
3562 &`lists          `& matching things in lists
3563 &`load           `& system load checks
3564 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3565                     &<<CHAPlocalscan>>&)
3566 &`lookup         `& general lookup code and all lookups
3567 &`memory         `& memory handling
3568 &`pid            `& add pid to debug output lines
3569 &`process_info   `& setting info for the process log
3570 &`queue_run      `& queue runs
3571 &`receive        `& general message reception logic
3572 &`resolver       `& turn on the DNS resolver's debugging output
3573 &`retry          `& retry handling
3574 &`rewrite        `& address rewriting
3575 &`route          `& address routing
3576 &`timestamp      `& add timestamp to debug output lines
3577 &`tls            `& TLS logic
3578 &`transport      `& transports
3579 &`uid            `& changes of uid/gid and looking up uid/gid
3580 &`verify         `& address verification logic
3581 &`all            `& almost all of the above (see below), and also &%-v%&
3582 .endd
3583 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3584 for &`-all`&. The reason for this is that &`+all`& is something that people
3585 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3586 is included, an awful lot of output that is very rarely of interest is
3587 generated, so it now has to be explicitly requested. However, &`-all`& does
3588 turn everything off.
3589
3590 .cindex "resolver, debugging output"
3591 .cindex "DNS resolver, debugging output"
3592 The &`resolver`& option produces output only if the DNS resolver was compiled
3593 with DEBUG enabled. This is not the case in some operating systems. Also,
3594 unfortunately, debugging output from the DNS resolver is written to stdout
3595 rather than stderr.
3596
3597 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3598 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3599 However, the &`pid`& selector is forced when debugging is turned on for a
3600 daemon, which then passes it on to any re-executed Exims. Exim also
3601 automatically adds the pid to debug lines when several remote deliveries are
3602 run in parallel.
3603
3604 The &`timestamp`& selector causes the current time to be inserted at the start
3605 of all debug output lines. This can be useful when trying to track down delays
3606 in processing.
3607
3608 If the &%debug_print%& option is set in any driver, it produces output whenever
3609 any debugging is selected, or if &%-v%& is used.
3610
3611 .vitem &%-dd%&<&'debug&~options'&>
3612 .oindex "&%-dd%&"
3613 This option behaves exactly like &%-d%& except when used on a command that
3614 starts a daemon process. In that case, debugging is turned off for the
3615 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3616 behaviour of the daemon without creating as much output as full debugging does.
3617
3618 .vitem &%-dropcr%&
3619 .oindex "&%-dropcr%&"
3620 This is an obsolete option that is now a no-op. It used to affect the way Exim
3621 handled CR and LF characters in incoming messages. What happens now is
3622 described in section &<<SECTlineendings>>&.
3623
3624 .vitem &%-E%&
3625 .oindex "&%-E%&"
3626 .cindex "bounce message" "generating"
3627 This option specifies that an incoming message is a locally-generated delivery
3628 failure report. It is used internally by Exim when handling delivery failures
3629 and is not intended for external use. Its only effect is to stop Exim
3630 generating certain messages to the postmaster, as otherwise message cascades
3631 could occur in some situations. As part of the same option, a message id may
3632 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3633 new message contains the id, following &"R="&, as a cross-reference.
3634
3635 .vitem &%-e%&&'x'&
3636 .oindex "&%-e%&&'x'&"
3637 There are a number of Sendmail options starting with &%-oe%& which seem to be
3638 called by various programs without the leading &%o%& in the option. For
3639 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3640 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3641
3642 .vitem &%-F%&&~<&'string'&>
3643 .oindex "&%-F%&"
3644 .cindex "sender" "name"
3645 .cindex "name" "of sender"
3646 This option sets the sender's full name for use when a locally-generated
3647 message is being accepted. In the absence of this option, the user's &'gecos'&
3648 entry from the password data is used. As users are generally permitted to alter
3649 their &'gecos'& entries, no security considerations are involved. White space
3650 between &%-F%& and the <&'string'&> is optional.
3651
3652 .vitem &%-f%&&~<&'address'&>
3653 .oindex "&%-f%&"
3654 .cindex "sender" "address"
3655 .cindex "address" "sender"
3656 .cindex "trusted users"
3657 .cindex "envelope sender"
3658 .cindex "user" "trusted"
3659 This option sets the address of the envelope sender of a locally-generated
3660 message (also known as the return path). The option can normally be used only
3661 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3662 users to use it.
3663
3664 Processes running as root or the Exim user are always trusted. Other
3665 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3666 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3667 of a local message is set to the caller's login name at the default qualify
3668 domain.
3669
3670 There is one exception to the restriction on the use of &%-f%&: an empty sender
3671 can be specified by any user, trusted or not, to create a message that can
3672 never provoke a bounce. An empty sender can be specified either as an empty
3673 string, or as a pair of angle brackets with nothing between them, as in these
3674 examples of shell commands:
3675 .code
3676 exim -f '<>' user@domain
3677 exim -f "" user@domain
3678 .endd
3679 In addition, the use of &%-f%& is not restricted when testing a filter file
3680 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3681 &%-bv%& options.
3682
3683 Allowing untrusted users to change the sender address does not of itself make
3684 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3685 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3686 though this can be overridden by setting &%no_local_from_check%&.
3687
3688 White
3689 .cindex "&""From""& line"
3690 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3691 given as two arguments or one combined argument). The sender of a
3692 locally-generated message can also be set (when permitted) by an initial
3693 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3694 if &%-f%& is also present, it overrides &"From&~"&.
3695
3696 .vitem &%-G%&
3697 .oindex "&%-G%&"
3698 .cindex "submission fixups, suppressing (command-line)"
3699 .new
3700 This option is equivalent to an ACL applying:
3701 .code
3702 control = suppress_local_fixups
3703 .endd
3704 for every message received.  Note that Sendmail will complain about such
3705 bad formatting, where Exim silently just does not fix it up.  This may change
3706 in future.
3707
3708 As this affects audit information, the caller must be a trusted user to use
3709 this option.
3710 .wen
3711
3712 .vitem &%-h%&&~<&'number'&>
3713 .oindex "&%-h%&"
3714 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3715 This option is accepted for compatibility with Sendmail, but has no effect. (In
3716 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3717 headers.)
3718
3719 .vitem &%-i%&
3720 .oindex "&%-i%&"
3721 .cindex "Solaris" "&'mail'& command"
3722 .cindex "dot" "in incoming non-SMTP message"
3723 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3724 line by itself should not terminate an incoming, non-SMTP message. I can find
3725 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3726 command in Solaris 2.4 uses it. See also &%-ti%&.
3727
3728 .new
3729 .vitem &%-L%&&~<&'tag'&>
3730 .oindex "&%-L%&"
3731 .cindex "syslog" "process name; set with flag"
3732 This option is equivalent to setting &%syslog_processname%& in the config
3733 file and setting &%log_file_path%& to &`syslog`&.
3734 Its use is restricted to administrators.  The configuration file has to be
3735 read and parsed, to determine access rights, before this is set and takes
3736 effect, so early configuration file errors will not honour this flag.
3737
3738 The tag should not be longer than 32 characters.
3739 .wen
3740
3741 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3742 .oindex "&%-M%&"
3743 .cindex "forcing delivery"
3744 .cindex "delivery" "forcing attempt"
3745 .cindex "frozen messages" "forcing delivery"
3746 This option requests Exim to run a delivery attempt on each message in turn. If
3747 any of the messages are frozen, they are automatically thawed before the
3748 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3749 and &%hold_domains%& are ignored.
3750
3751 Retry
3752 .cindex "hints database" "overriding retry hints"
3753 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3754 the normal retry time has not yet been reached. This option requires the caller
3755 to be an admin user. However, there is an option called &%prod_requires_admin%&
3756 which can be set false to relax this restriction (and also the same requirement
3757 for the &%-q%&, &%-R%&, and &%-S%& options).
3758
3759 The deliveries happen synchronously, that is, the original Exim process does
3760 not terminate until all the delivery attempts have finished. No output is
3761 produced unless there is a serious error. If you want to see what is happening,
3762 use the &%-v%& option as well, or inspect Exim's main log.
3763
3764 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3765 .oindex "&%-Mar%&"
3766 .cindex "message" "adding recipients"
3767 .cindex "recipient" "adding"
3768 This option requests Exim to add the addresses to the list of recipients of the
3769 message (&"ar"& for &"add recipients"&). The first argument must be a message
3770 id, and the remaining ones must be email addresses. However, if the message is
3771 active (in the middle of a delivery attempt), it is not altered. This option
3772 can be used only by an admin user.
3773
3774 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3775         &~<&'message&~id'&>"
3776 .oindex "&%-MC%&"
3777 .cindex "SMTP" "passed connection"
3778 .cindex "SMTP" "multiple deliveries"
3779 .cindex "multiple SMTP deliveries"
3780 This option is not intended for use by external callers. It is used internally
3781 by Exim to invoke another instance of itself to deliver a waiting message using
3782 an existing SMTP connection, which is passed as the standard input. Details are
3783 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3784 must be root or the Exim user in order to use it.
3785
3786 .vitem &%-MCA%&
3787 .oindex "&%-MCA%&"
3788 This option is not intended for use by external callers. It is used internally
3789 by Exim in conjunction with the &%-MC%& option. It signifies that the
3790 connection to the remote host has been authenticated.
3791
3792 .vitem &%-MCP%&
3793 .oindex "&%-MCP%&"
3794 This option is not intended for use by external callers. It is used internally
3795 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3796 which Exim is connected supports pipelining.
3797
3798 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3799 .oindex "&%-MCQ%&"
3800 This option is not intended for use by external callers. It is used internally
3801 by Exim in conjunction with the &%-MC%& option when the original delivery was
3802 started by a queue runner. It passes on the process id of the queue runner,
3803 together with the file descriptor number of an open pipe. Closure of the pipe
3804 signals the final completion of the sequence of processes that are passing
3805 messages through the same SMTP connection.
3806
3807 .vitem &%-MCS%&
3808 .oindex "&%-MCS%&"
3809 This option is not intended for use by external callers. It is used internally
3810 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3811 SMTP SIZE option should be used on messages delivered down the existing
3812 connection.
3813
3814 .vitem &%-MCT%&
3815 .oindex "&%-MCT%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3818 host to which Exim is connected supports TLS encryption.
3819
3820 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3821 .oindex "&%-Mc%&"
3822 .cindex "hints database" "not overridden by &%-Mc%&"
3823 .cindex "delivery" "manually started &-- not forced"
3824 This option requests Exim to run a delivery attempt on each message in turn,
3825 but unlike the &%-M%& option, it does check for retry hints, and respects any
3826 that are found. This option is not very useful to external callers. It is
3827 provided mainly for internal use by Exim when it needs to re-invoke itself in
3828 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3829 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3830 respects retry times and other options such as &%hold_domains%& that are
3831 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3832 If you want to run a specific delivery as if in a queue run, you should use
3833 &%-q%& with a message id argument. A distinction between queue run deliveries
3834 and other deliveries is made in one or two places.
3835
3836 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3837 .oindex "&%-Mes%&"
3838 .cindex "message" "changing sender"
3839 .cindex "sender" "changing"
3840 This option requests Exim to change the sender address in the message to the
3841 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3842 &"edit sender"&). There must be exactly two arguments. The first argument must
3843 be a message id, and the second one an email address. However, if the message
3844 is active (in the middle of a delivery attempt), its status is not altered.
3845 This option can be used only by an admin user.
3846
3847 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3848 .oindex "&%-Mf%&"
3849 .cindex "freezing messages"
3850 .cindex "message" "manually freezing"
3851 This option requests Exim to mark each listed message as &"frozen"&. This
3852 prevents any delivery attempts taking place until the message is &"thawed"&,
3853 either manually or as a result of the &%auto_thaw%& configuration option.
3854 However, if any of the messages are active (in the middle of a delivery
3855 attempt), their status is not altered. This option can be used only by an admin
3856 user.
3857
3858 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3859 .oindex "&%-Mg%&"
3860 .cindex "giving up on messages"
3861 .cindex "message" "abandoning delivery attempts"
3862 .cindex "delivery" "abandoning further attempts"
3863 This option requests Exim to give up trying to deliver the listed messages,
3864 including any that are frozen. However, if any of the messages are active,
3865 their status is not altered. For non-bounce messages, a delivery error message
3866 is sent to the sender, containing the text &"cancelled by administrator"&.
3867 Bounce messages are just discarded. This option can be used only by an admin
3868 user.
3869
3870 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3871 .oindex "&%-Mmad%&"
3872 .cindex "delivery" "cancelling all"
3873 This option requests Exim to mark all the recipient addresses in the messages
3874 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3875 message is active (in the middle of a delivery attempt), its status is not
3876 altered. This option can be used only by an admin user.
3877
3878 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3879 .oindex "&%-Mmd%&"
3880 .cindex "delivery" "cancelling by address"
3881 .cindex "recipient" "removing"
3882 .cindex "removing recipients"
3883 This option requests Exim to mark the given addresses as already delivered
3884 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3885 the remaining ones must be email addresses. These are matched to recipient
3886 addresses in the message in a case-sensitive manner. If the message is active
3887 (in the middle of a delivery attempt), its status is not altered. This option
3888 can be used only by an admin user.
3889
3890 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3891 .oindex "&%-Mrm%&"
3892 .cindex "removing messages"
3893 .cindex "abandoning mail"
3894 .cindex "message" "manually discarding"
3895 This option requests Exim to remove the given messages from the queue. No
3896 bounce messages are sent; each message is simply forgotten. However, if any of
3897 the messages are active, their status is not altered. This option can be used
3898 only by an admin user or by the user who originally caused the message to be
3899 placed on the queue.
3900
3901 .vitem &%-Mset%&&~<&'message&~id'&>
3902 .oindex "&%-Mset%&
3903 .cindex "testing" "string expansion"
3904 .cindex "expansion" "testing"
3905 This option is useful only in conjunction with &%-be%& (that is, when testing
3906 string expansions). Exim loads the given message from its spool before doing
3907 the test expansions, thus setting message-specific variables such as
3908 &$message_size$& and the header variables. The &$recipients$& variable is made
3909 available. This feature is provided to make it easier to test expansions that
3910 make use of these variables. However, this option can be used only by an admin
3911 user. See also &%-bem%&.
3912
3913 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3914 .oindex "&%-Mt%&"
3915 .cindex "thawing messages"
3916 .cindex "unfreezing messages"
3917 .cindex "frozen messages" "thawing"
3918 .cindex "message" "thawing frozen"
3919 This option requests Exim to &"thaw"& any of the listed messages that are
3920 &"frozen"&, so that delivery attempts can resume. However, if any of the
3921 messages are active, their status is not altered. This option can be used only
3922 by an admin user.
3923
3924 .vitem &%-Mvb%&&~<&'message&~id'&>
3925 .oindex "&%-Mvb%&"
3926 .cindex "listing" "message body"
3927 .cindex "message" "listing body of"
3928 This option causes the contents of the message body (-D) spool file to be
3929 written to the standard output. This option can be used only by an admin user.
3930
3931 .vitem &%-Mvc%&&~<&'message&~id'&>
3932 .oindex "&%-Mvc%&"
3933 .cindex "message" "listing in RFC 2822 format"
3934 .cindex "listing" "message in RFC 2822 format"
3935 This option causes a copy of the complete message (header lines plus body) to
3936 be written to the standard output in RFC 2822 format. This option can be used
3937 only by an admin user.
3938
3939 .vitem &%-Mvh%&&~<&'message&~id'&>
3940 .oindex "&%-Mvh%&"
3941 .cindex "listing" "message headers"
3942 .cindex "header lines" "listing"
3943 .cindex "message" "listing header lines"
3944 This option causes the contents of the message headers (-H) spool file to be
3945 written to the standard output. This option can be used only by an admin user.
3946
3947 .vitem &%-Mvl%&&~<&'message&~id'&>
3948 .oindex "&%-Mvl%&"
3949 .cindex "listing" "message log"
3950 .cindex "message" "listing message log"
3951 This option causes the contents of the message log spool file to be written to
3952 the standard output. This option can be used only by an admin user.
3953
3954 .vitem &%-m%&
3955 .oindex "&%-m%&"
3956 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3957 treats it that way too.
3958
3959 .vitem &%-N%&
3960 .oindex "&%-N%&"
3961 .cindex "debugging" "&%-N%& option"
3962 .cindex "debugging" "suppressing delivery"
3963 This is a debugging option that inhibits delivery of a message at the transport
3964 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3965 it just doesn't actually transport the message, but instead behaves as if it
3966 had successfully done so. However, it does not make any updates to the retry
3967 database, and the log entries for deliveries are flagged with &"*>"& rather
3968 than &"=>"&.
3969
3970 Because &%-N%& discards any message to which it applies, only root or the Exim
3971 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3972 words, an ordinary user can use it only when supplying an incoming message to
3973 which it will apply. Although transportation never fails when &%-N%& is set, an
3974 address may be deferred because of a configuration problem on a transport, or a
3975 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3976 the message, and applies to any subsequent delivery attempts that may happen
3977 for that message.
3978
3979 .vitem &%-n%&
3980 .oindex "&%-n%&"
3981 This option is interpreted by Sendmail to mean &"no aliasing"&.
3982 For normal modes of operation, it is ignored by Exim.
3983 When combined with &%-bP%& it suppresses the name of an option from being output.
3984
3985 .vitem &%-O%&&~<&'data'&>
3986 .oindex "&%-O%&"
3987 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3988 Exim.
3989
3990 .vitem &%-oA%&&~<&'file&~name'&>
3991 .oindex "&%-oA%&"
3992 .cindex "Sendmail compatibility" "&%-oA%& option"
3993 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3994 alternative alias file name. Exim handles &%-bi%& differently; see the
3995 description above.
3996
3997 .vitem &%-oB%&&~<&'n'&>
3998 .oindex "&%-oB%&"
3999 .cindex "SMTP" "passed connection"
4000 .cindex "SMTP" "multiple deliveries"
4001 .cindex "multiple SMTP deliveries"
4002 This is a debugging option which limits the maximum number of messages that can
4003 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4004 transport. If <&'n'&> is omitted, the limit is set to 1.
4005
4006 .vitem &%-odb%&
4007 .oindex "&%-odb%&"
4008 .cindex "background delivery"
4009 .cindex "delivery" "in the background"
4010 This option applies to all modes in which Exim accepts incoming messages,
4011 including the listening daemon. It requests &"background"& delivery of such
4012 messages, which means that the accepting process automatically starts a
4013 delivery process for each message received, but does not wait for the delivery
4014 processes to finish.
4015
4016 When all the messages have been received, the reception process exits,
4017 leaving the delivery processes to finish in their own time. The standard output
4018 and error streams are closed at the start of each delivery process.
4019 This is the default action if none of the &%-od%& options are present.
4020
4021 If one of the queueing options in the configuration file
4022 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4023 overrides it if &%queue_only_override%& is set true, which is the default
4024 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4025
4026 .vitem &%-odf%&
4027 .oindex "&%-odf%&"
4028 .cindex "foreground delivery"
4029 .cindex "delivery" "in the foreground"
4030 This option requests &"foreground"& (synchronous) delivery when Exim has
4031 accepted a locally-generated message. (For the daemon it is exactly the same as
4032 &%-odb%&.) A delivery process is automatically started to deliver the message,
4033 and Exim waits for it to complete before proceeding.
4034
4035 The original Exim reception process does not finish until the delivery
4036 process for the final message has ended. The standard error stream is left open
4037 during deliveries.
4038
4039 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4040 false and one of the queueing options in the configuration file is in effect.
4041
4042 If there is a temporary delivery error during foreground delivery, the
4043 message is left on the queue for later delivery, and the original reception
4044 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4045 restricted configuration that never queues messages.
4046
4047
4048 .vitem &%-odi%&
4049 .oindex "&%-odi%&"
4050 This option is synonymous with &%-odf%&. It is provided for compatibility with
4051 Sendmail.
4052
4053 .vitem &%-odq%&
4054 .oindex "&%-odq%&"
4055 .cindex "non-immediate delivery"
4056 .cindex "delivery" "suppressing immediate"
4057 .cindex "queueing incoming messages"
4058 This option applies to all modes in which Exim accepts incoming messages,
4059 including the listening daemon. It specifies that the accepting process should
4060 not automatically start a delivery process for each message received. Messages
4061 are placed on the queue, and remain there until a subsequent queue runner
4062 process encounters them. There are several configuration options (such as
4063 &%queue_only%&) that can be used to queue incoming messages under certain
4064 conditions. This option overrides all of them and also &%-odqs%&. It always
4065 forces queueing.
4066
4067 .vitem &%-odqs%&
4068 .oindex "&%-odqs%&"
4069 .cindex "SMTP" "delaying delivery"
4070 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4071 However, like &%-odb%& and &%-odi%&, this option has no effect if
4072 &%queue_only_override%& is false and one of the queueing options in the
4073 configuration file is in effect.
4074
4075 When &%-odqs%& does operate, a delivery process is started for each incoming
4076 message, in the background by default, but in the foreground if &%-odi%& is
4077 also present. The recipient addresses are routed, and local deliveries are done
4078 in the normal way. However, if any SMTP deliveries are required, they are not
4079 done at this time, so the message remains on the queue until a subsequent queue
4080 runner process encounters it. Because routing was done, Exim knows which
4081 messages are waiting for which hosts, and so a number of messages for the same
4082 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4083 configuration option has the same effect for specific domains. See also the
4084 &%-qq%& option.
4085
4086 .vitem &%-oee%&
4087 .oindex "&%-oee%&"
4088 .cindex "error" "reporting"
4089 If an error is detected while a non-SMTP message is being received (for
4090 example, a malformed address), the error is reported to the sender in a mail
4091 message.
4092
4093 .cindex "return code" "for &%-oee%&"
4094 Provided
4095 this error message is successfully sent, the Exim receiving process
4096 exits with a return code of zero. If not, the return code is 2 if the problem
4097 is that the original message has no recipients, or 1 any other error. This is
4098 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4099
4100 .vitem &%-oem%&
4101 .oindex "&%-oem%&"
4102 .cindex "error" "reporting"
4103 .cindex "return code" "for &%-oem%&"
4104 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4105 return code, whether or not the error message was successfully sent.
4106 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4107
4108 .vitem &%-oep%&
4109 .oindex "&%-oep%&"
4110 .cindex "error" "reporting"
4111 If an error is detected while a non-SMTP message is being received, the
4112 error is reported by writing a message to the standard error file (stderr).
4113 .cindex "return code" "for &%-oep%&"
4114 The return code is 1 for all errors.
4115
4116 .vitem &%-oeq%&
4117 .oindex "&%-oeq%&"
4118 .cindex "error" "reporting"
4119 This option is supported for compatibility with Sendmail, but has the same
4120 effect as &%-oep%&.
4121
4122 .vitem &%-oew%&
4123 .oindex "&%-oew%&"
4124 .cindex "error" "reporting"
4125 This option is supported for compatibility with Sendmail, but has the same
4126 effect as &%-oem%&.
4127
4128 .vitem &%-oi%&
4129 .oindex "&%-oi%&"
4130 .cindex "dot" "in incoming non-SMTP message"
4131 This option, which has the same effect as &%-i%&, specifies that a dot on a
4132 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4133 single dot does terminate, though Exim does no special processing for other
4134 lines that start with a dot. This option is set by default if Exim is called as
4135 &'rmail'&. See also &%-ti%&.
4136
4137 .vitem &%-oitrue%&
4138 .oindex "&%-oitrue%&"
4139 This option is treated as synonymous with &%-oi%&.
4140
4141 .vitem &%-oMa%&&~<&'host&~address'&>
4142 .oindex "&%-oMa%&"
4143 .cindex "sender" "host address, specifying for local message"
4144 A number of options starting with &%-oM%& can be used to set values associated
4145 with remote hosts on locally-submitted messages (that is, messages not received
4146 over TCP/IP). These options can be used by any caller in conjunction with the
4147 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4148 other circumstances, they are ignored unless the caller is trusted.
4149
4150 The &%-oMa%& option sets the sender host address. This may include a port
4151 number at the end, after a full stop (period). For example:
4152 .code
4153 exim -bs -oMa 10.9.8.7.1234
4154 .endd
4155 An alternative syntax is to enclose the IP address in square brackets,
4156 followed by a colon and the port number:
4157 .code
4158 exim -bs -oMa [10.9.8.7]:1234
4159 .endd
4160 The IP address is placed in the &$sender_host_address$& variable, and the
4161 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4162 are present on the command line, the sender host IP address is taken from
4163 whichever one is last.
4164
4165 .vitem &%-oMaa%&&~<&'name'&>
4166 .oindex "&%-oMaa%&"
4167 .cindex "authentication" "name, specifying for local message"
4168 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4169 option sets the value of &$sender_host_authenticated$& (the authenticator
4170 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4171 This option can be used with &%-bh%& and &%-bs%& to set up an
4172 authenticated SMTP session without actually using the SMTP AUTH command.
4173
4174 .vitem &%-oMai%&&~<&'string'&>
4175 .oindex "&%-oMai%&"
4176 .cindex "authentication" "id, specifying for local message"
4177 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4178 option sets the value of &$authenticated_id$& (the id that was authenticated).
4179 This overrides the default value (the caller's login id, except with &%-bh%&,
4180 where there is no default) for messages from local sources. See chapter
4181 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4182
4183 .vitem &%-oMas%&&~<&'address'&>
4184 .oindex "&%-oMas%&"
4185 .cindex "authentication" "sender, specifying for local message"
4186 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4187 option sets the authenticated sender value in &$authenticated_sender$&. It
4188 overrides the sender address that is created from the caller's login id for
4189 messages from local sources, except when &%-bh%& is used, when there is no
4190 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4191 specified on a MAIL command overrides this value. See chapter
4192 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4193
4194 .vitem &%-oMi%&&~<&'interface&~address'&>
4195 .oindex "&%-oMi%&"
4196 .cindex "interface" "address, specifying for local message"
4197 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4198 option sets the IP interface address value. A port number may be included,
4199 using the same syntax as for &%-oMa%&. The interface address is placed in
4200 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4201
4202 .vitem &%-oMr%&&~<&'protocol&~name'&>
4203 .oindex "&%-oMr%&"
4204 .cindex "protocol, specifying for local message"
4205 .vindex "&$received_protocol$&"
4206 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4207 option sets the received protocol value that is stored in
4208 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4209 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4210 SMTP protocol names (see the description of &$received_protocol$& in section
4211 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4212 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4213 be set by &%-oMr%&.
4214
4215 .vitem &%-oMs%&&~<&'host&~name'&>
4216 .oindex "&%-oMs%&"
4217 .cindex "sender" "host name, specifying for local message"
4218 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4219 option sets the sender host name in &$sender_host_name$&. When this option is
4220 present, Exim does not attempt to look up a host name from an IP address; it
4221 uses the name it is given.
4222
4223 .vitem &%-oMt%&&~<&'ident&~string'&>
4224 .oindex "&%-oMt%&"
4225 .cindex "sender" "ident string, specifying for local message"
4226 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4227 option sets the sender ident value in &$sender_ident$&. The default setting for
4228 local callers is the login id of the calling process, except when &%-bh%& is
4229 used, when there is no default.
4230
4231 .vitem &%-om%&
4232 .oindex "&%-om%&"
4233 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4234 In Sendmail, this option means &"me too"&, indicating that the sender of a
4235 message should receive a copy of the message if the sender appears in an alias
4236 expansion. Exim always does this, so the option does nothing.
4237
4238 .vitem &%-oo%&
4239 .oindex "&%-oo%&"
4240 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4241 This option is ignored. In Sendmail it specifies &"old style headers"&,
4242 whatever that means.
4243
4244 .vitem &%-oP%&&~<&'path'&>
4245 .oindex "&%-oP%&"
4246 .cindex "pid (process id)" "of daemon"
4247 .cindex "daemon" "process id (pid)"
4248 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4249 value. The option specifies the file to which the process id of the daemon is
4250 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4251 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4252 because in those cases, the normal pid file is not used.
4253
4254 .vitem &%-or%&&~<&'time'&>
4255 .oindex "&%-or%&"
4256 .cindex "timeout" "for non-SMTP input"
4257 This option sets a timeout value for incoming non-SMTP messages. If it is not
4258 set, Exim will wait forever for the standard input. The value can also be set
4259 by the &%receive_timeout%& option. The format used for specifying times is
4260 described in section &<<SECTtimeformat>>&.
4261
4262 .vitem &%-os%&&~<&'time'&>
4263 .oindex "&%-os%&"
4264 .cindex "timeout" "for SMTP input"
4265 .cindex "SMTP" "input timeout"
4266 This option sets a timeout value for incoming SMTP messages. The timeout
4267 applies to each SMTP command and block of data. The value can also be set by
4268 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4269 for specifying times is described in section &<<SECTtimeformat>>&.
4270
4271 .vitem &%-ov%&
4272 .oindex "&%-ov%&"
4273 This option has exactly the same effect as &%-v%&.
4274
4275 .vitem &%-oX%&&~<&'number&~or&~string'&>
4276 .oindex "&%-oX%&"
4277 .cindex "TCP/IP" "setting listening ports"
4278 .cindex "TCP/IP" "setting listening interfaces"
4279 .cindex "port" "receiving TCP/IP"
4280 This option is relevant only when the &%-bd%& (start listening daemon) option
4281 is also given. It controls which ports and interfaces the daemon uses. Details
4282 of the syntax, and how it interacts with configuration file options, are given
4283 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4284 file is written unless &%-oP%& is also present to specify a pid file name.
4285
4286 .vitem &%-pd%&
4287 .oindex "&%-pd%&"
4288 .cindex "Perl" "starting the interpreter"
4289 This option applies when an embedded Perl interpreter is linked with Exim (see
4290 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4291 option, forcing the starting of the interpreter to be delayed until it is
4292 needed.
4293
4294 .vitem &%-ps%&
4295 .oindex "&%-ps%&"
4296 .cindex "Perl" "starting the interpreter"
4297 This option applies when an embedded Perl interpreter is linked with Exim (see
4298 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4299 option, forcing the starting of the interpreter to occur as soon as Exim is
4300 started.
4301
4302 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4303 .oindex "&%-p%&"
4304 For compatibility with Sendmail, this option is equivalent to
4305 .display
4306 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4307 .endd
4308 It sets the incoming protocol and host name (for trusted callers). The
4309 host name and its colon can be omitted when only the protocol is to be set.
4310 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4311 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4312 or &`s`& using this option (but that does not seem a real limitation).
4313
4314 .vitem &%-q%&
4315 .oindex "&%-q%&"
4316 .cindex "queue runner" "starting manually"
4317 This option is normally restricted to admin users. However, there is a
4318 configuration option called &%prod_requires_admin%& which can be set false to
4319 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4320 and &%-S%& options).
4321
4322 .cindex "queue runner" "description of operation"
4323 The &%-q%& option starts one queue runner process. This scans the queue of
4324 waiting messages, and runs a delivery process for each one in turn. It waits
4325 for each delivery process to finish before starting the next one. A delivery
4326 process may not actually do any deliveries if the retry times for the addresses
4327 have not been reached. Use &%-qf%& (see below) if you want to override this.
4328
4329 If
4330 .cindex "SMTP" "passed connection"
4331 .cindex "SMTP" "multiple deliveries"
4332 .cindex "multiple SMTP deliveries"
4333 the delivery process spawns other processes to deliver other messages down
4334 passed SMTP connections, the queue runner waits for these to finish before
4335 proceeding.
4336
4337 When all the queued messages have been considered, the original queue runner
4338 process terminates. In other words, a single pass is made over the waiting
4339 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4340 this to be repeated periodically.
4341
4342 Exim processes the waiting messages in an unpredictable order. It isn't very
4343 random, but it is likely to be different each time, which is all that matters.
4344 If one particular message screws up a remote MTA, other messages to the same
4345 MTA have a chance of getting through if they get tried first.
4346
4347 It is possible to cause the messages to be processed in lexical message id
4348 order, which is essentially the order in which they arrived, by setting the
4349 &%queue_run_in_order%& option, but this is not recommended for normal use.
4350
4351 .vitem &%-q%&<&'qflags'&>
4352 The &%-q%& option may be followed by one or more flag letters that change its
4353 behaviour. They are all optional, but if more than one is present, they must
4354 appear in the correct order. Each flag is described in a separate item below.
4355
4356 .vitem &%-qq...%&
4357 .oindex "&%-qq%&"
4358 .cindex "queue" "double scanning"
4359 .cindex "queue" "routing"
4360 .cindex "routing" "whole queue before delivery"
4361 An option starting with &%-qq%& requests a two-stage queue run. In the first
4362 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4363 every domain. Addresses are routed, local deliveries happen, but no remote
4364 transports are run.
4365
4366 .cindex "hints database" "remembering routing"
4367 The hints database that remembers which messages are waiting for specific hosts
4368 is updated, as if delivery to those hosts had been deferred. After this is
4369 complete, a second, normal queue scan happens, with routing and delivery taking
4370 place as normal. Messages that are routed to the same host should mostly be
4371 delivered down a single SMTP
4372 .cindex "SMTP" "passed connection"
4373 .cindex "SMTP" "multiple deliveries"
4374 .cindex "multiple SMTP deliveries"
4375 connection because of the hints that were set up during the first queue scan.
4376 This option may be useful for hosts that are connected to the Internet
4377 intermittently.
4378
4379 .vitem &%-q[q]i...%&
4380 .oindex "&%-qi%&"
4381 .cindex "queue" "initial delivery"
4382 If the &'i'& flag is present, the queue runner runs delivery processes only for
4383 those messages that haven't previously been tried. (&'i'& stands for &"initial
4384 delivery"&.) This can be helpful if you are putting messages on the queue using
4385 &%-odq%& and want a queue runner just to process the new messages.
4386
4387 .vitem &%-q[q][i]f...%&
4388 .oindex "&%-qf%&"
4389 .cindex "queue" "forcing delivery"
4390 .cindex "delivery" "forcing in queue run"
4391 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4392 message, whereas without &'f'& only those non-frozen addresses that have passed
4393 their retry times are tried.
4394
4395 .vitem &%-q[q][i]ff...%&
4396 .oindex "&%-qff%&"
4397 .cindex "frozen messages" "forcing delivery"
4398 If &'ff'& is present, a delivery attempt is forced for every message, whether
4399 frozen or not.
4400
4401 .vitem &%-q[q][i][f[f]]l%&
4402 .oindex "&%-ql%&"
4403 .cindex "queue" "local deliveries only"
4404 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4405 be done. If a message requires any remote deliveries, it remains on the queue
4406 for later delivery.
4407
4408 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4409 .cindex "queue" "delivering specific messages"
4410 When scanning the queue, Exim can be made to skip over messages whose ids are
4411 lexically less than a given value by following the &%-q%& option with a
4412 starting message id. For example:
4413 .code
4414 exim -q 0t5C6f-0000c8-00
4415 .endd
4416 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4417 second message id is given, messages whose ids are lexically greater than it
4418 are also skipped. If the same id is given twice, for example,
4419 .code
4420 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4421 .endd
4422 just one delivery process is started, for that message. This differs from
4423 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4424 that it counts as a delivery from a queue run. Note that the selection
4425 mechanism does not affect the order in which the messages are scanned. There
4426 are also other ways of selecting specific sets of messages for delivery in a
4427 queue run &-- see &%-R%& and &%-S%&.
4428
4429 .vitem &%-q%&<&'qflags'&><&'time'&>
4430 .cindex "queue runner" "starting periodically"
4431 .cindex "periodic queue running"
4432 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4433 starting a queue runner process at intervals specified by the given time value
4434 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4435 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4436 single daemon process handles both functions. A common way of starting up a
4437 combined daemon at system boot time is to use a command such as
4438 .code
4439 /usr/exim/bin/exim -bd -q30m
4440 .endd
4441 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4442 process every 30 minutes.
4443
4444 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4445 pid file is written unless one is explicitly requested by the &%-oP%& option.
4446
4447 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4448 .oindex "&%-qR%&"
4449 This option is synonymous with &%-R%&. It is provided for Sendmail
4450 compatibility.
4451
4452 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4453 .oindex "&%-qS%&"
4454 This option is synonymous with &%-S%&.
4455
4456 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4457 .oindex "&%-R%&"
4458 .cindex "queue runner" "for specific recipients"
4459 .cindex "delivery" "to given domain"
4460 .cindex "domain" "delivery to"
4461 The <&'rsflags'&> may be empty, in which case the white space before the string
4462 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4463 which are the possible values for <&'rsflags'&>. White space is required if
4464 <&'rsflags'&> is not empty.
4465
4466 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4467 perform a single queue run, except that, when scanning the messages on the
4468 queue, Exim processes only those that have at least one undelivered recipient
4469 address containing the given string, which is checked in a case-independent
4470 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4471 regular expression; otherwise it is a literal string.
4472
4473 If you want to do periodic queue runs for messages with specific recipients,
4474 you can combine &%-R%& with &%-q%& and a time value. For example:
4475 .code
4476 exim -q25m -R @special.domain.example
4477 .endd
4478 This example does a queue run for messages with recipients in the given domain
4479 every 25 minutes. Any additional flags that are specified with &%-q%& are
4480 applied to each queue run.
4481
4482 Once a message is selected for delivery by this mechanism, all its addresses
4483 are processed. For the first selected message, Exim overrides any retry
4484 information and forces a delivery attempt for each undelivered address. This
4485 means that if delivery of any address in the first message is successful, any
4486 existing retry information is deleted, and so delivery attempts for that
4487 address in subsequently selected messages (which are processed without forcing)
4488 will run. However, if delivery of any address does not succeed, the retry
4489 information is updated, and in subsequently selected messages, the failing
4490 address will be skipped.
4491
4492 .cindex "frozen messages" "forcing delivery"
4493 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4494 all selected messages, not just the first; frozen messages are included when
4495 &'ff'& is present.
4496
4497 The &%-R%& option makes it straightforward to initiate delivery of all messages
4498 to a given domain after a host has been down for some time. When the SMTP
4499 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4500 effect is to run Exim with the &%-R%& option, but it can be configured to run
4501 an arbitrary command instead.
4502
4503 .vitem &%-r%&
4504 .oindex "&%-r%&"
4505 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4506
4507 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4508 .oindex "&%-S%&"
4509 .cindex "delivery" "from given sender"
4510 .cindex "queue runner" "for specific senders"
4511 This option acts like &%-R%& except that it checks the string against each
4512 message's sender instead of against the recipients. If &%-R%& is also set, both
4513 conditions must be met for a message to be selected. If either of the options
4514 has &'f'& or &'ff'& in its flags, the associated action is taken.
4515
4516 .vitem &%-Tqt%&&~<&'times'&>
4517 .oindex "&%-Tqt%&"
4518 This an option that is exclusively for use by the Exim testing suite. It is not
4519 recognized when Exim is run normally. It allows for the setting up of explicit
4520 &"queue times"& so that various warning/retry features can be tested.
4521
4522 .vitem &%-t%&
4523 .oindex "&%-t%&"
4524 .cindex "recipient" "extracting from header lines"
4525 .cindex "&'Bcc:'& header line"
4526 .cindex "&'Cc:'& header line"
4527 .cindex "&'To:'& header line"
4528 When Exim is receiving a locally-generated, non-SMTP message on its standard
4529 input, the &%-t%& option causes the recipients of the message to be obtained
4530 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4531 from the command arguments. The addresses are extracted before any rewriting
4532 takes place and the &'Bcc:'& header line, if present, is then removed.
4533
4534 .cindex "Sendmail compatibility" "&%-t%& option"
4535 If the command has any arguments, they specify addresses to which the message
4536 is &'not'& to be delivered. That is, the argument addresses are removed from
4537 the recipients list obtained from the headers. This is compatible with Smail 3
4538 and in accordance with the documented behaviour of several versions of
4539 Sendmail, as described in man pages on a number of operating systems (e.g.
4540 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4541 argument addresses to those obtained from the headers, and the O'Reilly
4542 Sendmail book documents it that way. Exim can be made to add argument addresses
4543 instead of subtracting them by setting the option
4544 &%extract_addresses_remove_arguments%& false.
4545
4546 .cindex "&%Resent-%& header lines" "with &%-t%&"
4547 If there are any &%Resent-%& header lines in the message, Exim extracts
4548 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4549 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4550 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4551 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4552
4553 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4554 message is resent several times). The RFC also specifies that they should be
4555 added at the front of the message, and separated by &'Received:'& lines. It is
4556 not at all clear how &%-t%& should operate in the present of multiple sets,
4557 nor indeed exactly what constitutes a &"set"&.
4558 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4559 are often added at the end of the header, and if a message is resent more than
4560 once, it is common for the original set of &%Resent-%& headers to be renamed as
4561 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4562
4563 .vitem &%-ti%&
4564 .oindex "&%-ti%&"
4565 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4566 compatibility with Sendmail.
4567
4568 .vitem &%-tls-on-connect%&
4569 .oindex "&%-tls-on-connect%&"
4570 .cindex "TLS" "use without STARTTLS"
4571 .cindex "TLS" "automatic start"
4572 This option is available when Exim is compiled with TLS support. It forces all
4573 incoming SMTP connections to behave as if the incoming port is listed in the
4574 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4575 &<<CHAPTLS>>& for further details.
4576
4577
4578 .vitem &%-U%&
4579 .oindex "&%-U%&"
4580 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4581 Sendmail uses this option for &"initial message submission"&, and its
4582 documentation states that in future releases, it may complain about
4583 syntactically invalid messages rather than fixing them when this flag is not
4584 set. Exim ignores this option.
4585
4586 .vitem &%-v%&
4587 .oindex "&%-v%&"
4588 This option causes Exim to write information to the standard error stream,
4589 describing what it is doing. In particular, it shows the log lines for
4590 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4591 dialogue is shown. Some of the log lines shown may not actually be written to
4592 the log if the setting of &%log_selector%& discards them. Any relevant
4593 selectors are shown with each log line. If none are shown, the logging is
4594 unconditional.
4595
4596 .vitem &%-x%&
4597 .oindex "&%-x%&"
4598 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4599 National Language Support extended characters in the body of the mail item"&).
4600 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4601 this option.
4602
4603 .new
4604 .vitem &%-X%&&~<&'logfile'&>
4605 .oindex "&%-X%&"
4606 This option is interpreted by Sendmail to cause debug information to be sent
4607 to the named file.  It is ignored by Exim.
4608 .wen
4609 .endlist
4610
4611 .ecindex IIDclo1
4612 .ecindex IIDclo2
4613
4614
4615 . ////////////////////////////////////////////////////////////////////////////
4616 . Insert a stylized DocBook comment here, to identify the end of the command
4617 . line options. This is for the benefit of the Perl script that automatically
4618 . creates a man page for the options.
4619 . ////////////////////////////////////////////////////////////////////////////
4620
4621 .literal xml
4622 <!-- === End of command line options === -->
4623 .literal off
4624
4625
4626
4627
4628
4629 . ////////////////////////////////////////////////////////////////////////////
4630 . ////////////////////////////////////////////////////////////////////////////
4631
4632
4633 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4634          "The runtime configuration file"
4635
4636 .cindex "run time configuration"
4637 .cindex "configuration file" "general description"
4638 .cindex "CONFIGURE_FILE"
4639 .cindex "configuration file" "errors in"
4640 .cindex "error" "in configuration file"
4641 .cindex "return code" "for bad configuration"
4642 Exim uses a single run time configuration file that is read whenever an Exim
4643 binary is executed. Note that in normal operation, this happens frequently,
4644 because Exim is designed to operate in a distributed manner, without central
4645 control.
4646
4647 If a syntax error is detected while reading the configuration file, Exim
4648 writes a message on the standard error, and exits with a non-zero return code.
4649 The message is also written to the panic log. &*Note*&: Only simple syntax
4650 errors can be detected at this time. The values of any expanded options are
4651 not checked until the expansion happens, even when the expansion does not
4652 actually alter the string.
4653
4654 The name of the configuration file is compiled into the binary for security
4655 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4656 most configurations, this specifies a single file. However, it is permitted to
4657 give a colon-separated list of file names, in which case Exim uses the first
4658 existing file in the list.
4659
4660 .cindex "EXIM_USER"
4661 .cindex "EXIM_GROUP"
4662 .cindex "CONFIGURE_OWNER"
4663 .cindex "CONFIGURE_GROUP"
4664 .cindex "configuration file" "ownership"
4665 .cindex "ownership" "configuration file"
4666 The run time configuration file must be owned by root or by the user that is
4667 specified at compile time by the CONFIGURE_OWNER option (if set). The
4668 configuration file must not be world-writeable, or group-writeable unless its
4669 group is the root group or the one specified at compile time by the
4670 CONFIGURE_GROUP option.
4671
4672 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4673 to root, anybody who is able to edit the run time configuration file has an
4674 easy way to run commands as root. If you specify a user or group in the
4675 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4676 who are members of that group will trivially be able to obtain root privileges.
4677
4678 Up to Exim version 4.72, the run time configuration file was also permitted to
4679 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4680 since it offered a simple privilege escalation for any attacker who managed to
4681 compromise the Exim user account.
4682
4683 A default configuration file, which will work correctly in simple situations,
4684 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4685 defines just one file name, the installation process copies the default
4686 configuration to a new file of that name if it did not previously exist. If
4687 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4688 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4689 configuration.
4690
4691
4692
4693 .section "Using a different configuration file" "SECID40"
4694 .cindex "configuration file" "alternate"
4695 A one-off alternate configuration can be specified by the &%-C%& command line
4696 option, which may specify a single file or a list of files. However, when
4697 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4698 unless the argument for &%-C%& is identical to the built-in value from
4699 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4700 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4701 is useful mainly for checking the syntax of configuration files before
4702 installing them. No owner or group checks are done on a configuration file
4703 specified by &%-C%&, if root privilege has been dropped.
4704
4705 Even the Exim user is not trusted to specify an arbitrary configuration file
4706 with the &%-C%& option to be used with root privileges, unless that file is
4707 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4708 testing a configuration using &%-C%& right through message reception and
4709 delivery, even if the caller is root. The reception works, but by that time,
4710 Exim is running as the Exim user, so when it re-execs to regain privilege for
4711 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4712 can test reception and delivery using two separate commands (one to put a
4713 message on the queue, using &%-odq%&, and another to do the delivery, using
4714 &%-M%&).
4715
4716 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4717 prefix string with which any file named in a &%-C%& command line option must
4718 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4719 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4720 name can be used with &%-C%&.
4721
4722 One-off changes to a configuration can be specified by the &%-D%& command line
4723 option, which defines and overrides values for macros used inside the
4724 configuration file. However, like &%-C%&, the use of this option by a
4725 non-privileged user causes Exim to discard its root privilege.
4726 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4727 completely disabled, and its use causes an immediate error exit.
4728
4729 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4730 to declare certain macro names trusted, such that root privilege will not
4731 necessarily be discarded.
4732 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4733 considered safe and, if &%-D%& only supplies macros from this list, and the
4734 values are acceptable, then Exim will not give up root privilege if the caller
4735 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4736 transition mechanism and is expected to be removed in the future.  Acceptable
4737 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4738
4739 Some sites may wish to use the same Exim binary on different machines that
4740 share a file system, but to use different configuration files on each machine.
4741 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4742 looks for a file whose name is the configuration file name followed by a dot
4743 and the machine's node name, as obtained from the &[uname()]& function. If this
4744 file does not exist, the standard name is tried. This processing occurs for
4745 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4746
4747 In some esoteric situations different versions of Exim may be run under
4748 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4749 help with this. See the comments in &_src/EDITME_& for details.
4750
4751
4752
4753 .section "Configuration file format" "SECTconffilfor"
4754 .cindex "configuration file" "format of"
4755 .cindex "format" "configuration file"
4756 Exim's configuration file is divided into a number of different parts. General
4757 option settings must always appear at the start of the file. The other parts
4758 are all optional, and may appear in any order. Each part other than the first
4759 is introduced by the word &"begin"& followed by the name of the part. The
4760 optional parts are:
4761
4762 .ilist
4763 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4764 &<<CHAPACL>>&).
4765 .next
4766 .cindex "AUTH" "configuration"
4767 &'authenticators'&: Configuration settings for the authenticator drivers. These
4768 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4769 .next
4770 &'routers'&: Configuration settings for the router drivers. Routers process
4771 addresses and determine how the message is to be delivered (see chapters
4772 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4773 .next
4774 &'transports'&: Configuration settings for the transport drivers. Transports
4775 define mechanisms for copying messages to destinations (see chapters
4776 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4777 .next
4778 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4779 If there is no retry section, or if it is empty (that is, no retry rules are
4780 defined), Exim will not retry deliveries. In this situation, temporary errors
4781 are treated the same as permanent errors. Retry rules are discussed in chapter
4782 &<<CHAPretry>>&.
4783 .next
4784 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4785 when new addresses are generated during delivery. Rewriting is discussed in
4786 chapter &<<CHAPrewrite>>&.
4787 .next
4788 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4789 want to use this feature, you must set
4790 .code
4791 LOCAL_SCAN_HAS_OPTIONS=yes
4792 .endd
4793 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4794 facility are given in chapter &<<CHAPlocalscan>>&.
4795 .endlist
4796
4797 .cindex "configuration file" "leading white space in"
4798 .cindex "configuration file" "trailing white space in"
4799 .cindex "white space" "in configuration file"
4800 Leading and trailing white space in configuration lines is always ignored.
4801
4802 Blank lines in the file, and lines starting with a # character (ignoring
4803 leading white space) are treated as comments and are ignored. &*Note*&: A
4804 # character other than at the beginning of a line is not treated specially,
4805 and does not introduce a comment.
4806
4807 Any non-comment line can be continued by ending it with a backslash. Note that
4808 the general rule for white space means that trailing white space after the
4809 backslash and leading white space at the start of continuation
4810 lines is ignored. Comment lines beginning with # (but not empty lines) may
4811 appear in the middle of a sequence of continuation lines.
4812
4813 A convenient way to create a configuration file is to start from the
4814 default, which is supplied in &_src/configure.default_&, and add, delete, or
4815 change settings as required.
4816
4817 The ACLs, retry rules, and rewriting rules have their own syntax which is
4818 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4819 respectively. The other parts of the configuration file have some syntactic
4820 items in common, and these are described below, from section &<<SECTcos>>&
4821 onwards. Before that, the inclusion, macro, and conditional facilities are
4822 described.
4823
4824
4825
4826 .section "File inclusions in the configuration file" "SECID41"
4827 .cindex "inclusions in configuration file"
4828 .cindex "configuration file" "including other files"
4829 .cindex "&`.include`& in configuration file"
4830 .cindex "&`.include_if_exists`& in configuration file"
4831 You can include other files inside Exim's run time configuration file by
4832 using this syntax:
4833 .display
4834 &`.include`& <&'file name'&>
4835 &`.include_if_exists`& <&'file name'&>
4836 .endd
4837 on a line by itself. Double quotes round the file name are optional. If you use
4838 the first form, a configuration error occurs if the file does not exist; the
4839 second form does nothing for non-existent files. In all cases, an absolute file
4840 name is required.
4841
4842 Includes may be nested to any depth, but remember that Exim reads its
4843 configuration file often, so it is a good idea to keep them to a minimum.
4844 If you change the contents of an included file, you must HUP the daemon,
4845 because an included file is read only when the configuration itself is read.
4846
4847 The processing of inclusions happens early, at a physical line level, so, like
4848 comment lines, an inclusion can be used in the middle of an option setting,
4849 for example:
4850 .code
4851 hosts_lookup = a.b.c \
4852                .include /some/file
4853 .endd
4854 Include processing happens after macro processing (see below). Its effect is to
4855 process the lines of the included file as if they occurred inline where the
4856 inclusion appears.
4857
4858
4859
4860 .section "Macros in the configuration file" "SECTmacrodefs"
4861 .cindex "macro" "description of"
4862 .cindex "configuration file" "macros"
4863 If a line in the main part of the configuration (that is, before the first
4864 &"begin"& line) begins with an upper case letter, it is taken as a macro
4865 definition, and must be of the form
4866 .display
4867 <&'name'&> = <&'rest of line'&>
4868 .endd
4869 The name must consist of letters, digits, and underscores, and need not all be
4870 in upper case, though that is recommended. The rest of the line, including any
4871 continuations, is the replacement text, and has leading and trailing white
4872 space removed. Quotes are not removed. The replacement text can never end with
4873 a backslash character, but this doesn't seem to be a serious limitation.
4874
4875 Macros may also be defined between router, transport, authenticator, or ACL
4876 definitions. They may not, however, be defined within an individual driver or
4877 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4878
4879 .section "Macro substitution" "SECID42"
4880 Once a macro is defined, all subsequent lines in the file (and any included
4881 files) are scanned for the macro name; if there are several macros, the line is
4882 scanned for each in turn, in the order in which the macros are defined. The
4883 replacement text is not re-scanned for the current macro, though it is scanned
4884 for subsequently defined macros. For this reason, a macro name may not contain
4885 the name of a previously defined macro as a substring. You could, for example,
4886 define
4887 .display
4888 &`ABCD_XYZ = `&<&'something'&>
4889 &`ABCD = `&<&'something else'&>
4890 .endd
4891 but putting the definitions in the opposite order would provoke a configuration
4892 error. Macro expansion is applied to individual physical lines from the file,
4893 before checking for line continuation or file inclusion (see above). If a line
4894 consists solely of a macro name, and the expansion of the macro is empty, the
4895 line is ignored. A macro at the start of a line may turn the line into a
4896 comment line or a &`.include`& line.
4897
4898
4899 .section "Redefining macros" "SECID43"
4900 Once defined, the value of a macro can be redefined later in the configuration
4901 (or in an included file). Redefinition is specified by using &'=='& instead of
4902 &'='&. For example:
4903 .code
4904 MAC =  initial value
4905 ...
4906 MAC == updated value
4907 .endd
4908 Redefinition does not alter the order in which the macros are applied to the
4909 subsequent lines of the configuration file. It is still the same order in which
4910 the macros were originally defined. All that changes is the macro's value.
4911 Redefinition makes it possible to accumulate values. For example:
4912 .code
4913 MAC =  initial value
4914 ...
4915 MAC == MAC and something added
4916 .endd
4917 This can be helpful in situations where the configuration file is built
4918 from a number of other files.
4919
4920 .section "Overriding macro values" "SECID44"
4921 The values set for macros in the configuration file can be overridden by the
4922 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4923 used, unless called by root or the Exim user. A definition on the command line
4924 using the &%-D%& option causes all definitions and redefinitions within the
4925 file to be ignored.
4926
4927
4928
4929 .section "Example of macro usage" "SECID45"
4930 As an example of macro usage, consider a configuration where aliases are looked
4931 up in a MySQL database. It helps to keep the file less cluttered if long
4932 strings such as SQL statements are defined separately as macros, for example:
4933 .code
4934 ALIAS_QUERY = select mailbox from user where \
4935               login='${quote_mysql:$local_part}';
4936 .endd
4937 This can then be used in a &(redirect)& router setting like this:
4938 .code
4939 data = ${lookup mysql{ALIAS_QUERY}}
4940 .endd
4941 In earlier versions of Exim macros were sometimes used for domain, host, or
4942 address lists. In Exim 4 these are handled better by named lists &-- see
4943 section &<<SECTnamedlists>>&.
4944
4945
4946 .section "Conditional skips in the configuration file" "SECID46"
4947 .cindex "configuration file" "conditional skips"
4948 .cindex "&`.ifdef`&"
4949 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4950 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4951 portions of the configuration file. The processing happens whenever the file is
4952 read (that is, when an Exim binary starts to run).
4953
4954 The implementation is very simple. Instances of the first four directives must
4955 be followed by text that includes the names of one or macros. The condition
4956 that is tested is whether or not any macro substitution has taken place in the
4957 line. Thus:
4958 .code
4959 .ifdef AAA
4960 message_size_limit = 50M
4961 .else
4962 message_size_limit = 100M
4963 .endif
4964 .endd
4965 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4966 otherwise. If there is more than one macro named on the line, the condition
4967 is true if any of them are defined. That is, it is an &"or"& condition. To
4968 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4969
4970 Although you can use a macro expansion to generate one of these directives,
4971 it is not very useful, because the condition &"there was a macro substitution
4972 in this line"& will always be true.
4973
4974 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4975 to clarify complicated nestings.
4976
4977
4978
4979 .section "Common option syntax" "SECTcos"
4980 .cindex "common option syntax"
4981 .cindex "syntax of common options"
4982 .cindex "configuration file" "common option syntax"
4983 For the main set of options, driver options, and &[local_scan()]& options,
4984 each setting is on a line by itself, and starts with a name consisting of
4985 lower-case letters and underscores. Many options require a data value, and in
4986 these cases the name must be followed by an equals sign (with optional white
4987 space) and then the value. For example:
4988 .code
4989 qualify_domain = mydomain.example.com
4990 .endd
4991 .cindex "hiding configuration option values"
4992 .cindex "configuration options" "hiding value of"
4993 .cindex "options" "hiding value of"
4994 Some option settings may contain sensitive data, for example, passwords for
4995 accessing databases. To stop non-admin users from using the &%-bP%& command
4996 line option to read these values, you can precede the option settings with the
4997 word &"hide"&. For example:
4998 .code
4999 hide mysql_servers = localhost/users/admin/secret-password
5000 .endd
5001 For non-admin users, such options are displayed like this:
5002 .code
5003 mysql_servers = <value not displayable>
5004 .endd
5005 If &"hide"& is used on a driver option, it hides the value of that option on
5006 all instances of the same driver.
5007
5008 The following sections describe the syntax used for the different data types
5009 that are found in option settings.
5010
5011
5012 .section "Boolean options" "SECID47"
5013 .cindex "format" "boolean"
5014 .cindex "boolean configuration values"
5015 .oindex "&%no_%&&'xxx'&"
5016 .oindex "&%not_%&&'xxx'&"
5017 Options whose type is given as boolean are on/off switches. There are two
5018 different ways of specifying such options: with and without a data value. If
5019 the option name is specified on its own without data, the switch is turned on;
5020 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5021 boolean options may be followed by an equals sign and one of the words
5022 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5023 the following two settings have exactly the same effect:
5024 .code
5025 queue_only
5026 queue_only = true
5027 .endd
5028 The following two lines also have the same (opposite) effect:
5029 .code
5030 no_queue_only
5031 queue_only = false
5032 .endd
5033 You can use whichever syntax you prefer.
5034
5035
5036
5037
5038 .section "Integer values" "SECID48"
5039 .cindex "integer configuration values"
5040 .cindex "format" "integer"
5041 If an option's type is given as &"integer"&, the value can be given in decimal,
5042 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5043 number is assumed. Otherwise, it is treated as an octal number unless it starts
5044 with the characters &"0x"&, in which case the remainder is interpreted as a
5045 hexadecimal number.
5046
5047 If an integer value is followed by the letter K, it is multiplied by 1024; if
5048 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5049 of integer option settings are output, values which are an exact multiple of
5050 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5051 and M. The printing style is independent of the actual input format that was
5052 used.
5053
5054
5055 .section "Octal integer values" "SECID49"
5056 .cindex "integer format"
5057 .cindex "format" "octal integer"
5058 If an option's type is given as &"octal integer"&, its value is always
5059 interpreted as an octal number, whether or not it starts with the digit zero.
5060 Such options are always output in octal.
5061
5062
5063 .section "Fixed point numbers" "SECID50"
5064 .cindex "fixed point configuration values"
5065 .cindex "format" "fixed point"
5066 If an option's type is given as &"fixed-point"&, its value must be a decimal
5067 integer, optionally followed by a decimal point and up to three further digits.
5068
5069
5070
5071 .section "Time intervals" "SECTtimeformat"
5072 .cindex "time interval" "specifying in configuration"
5073 .cindex "format" "time interval"
5074 A time interval is specified as a sequence of numbers, each followed by one of
5075 the following letters, with no intervening white space:
5076
5077 .table2 30pt
5078 .irow &%s%& seconds
5079 .irow &%m%& minutes
5080 .irow &%h%& hours
5081 .irow &%d%& days
5082 .irow &%w%& weeks
5083 .endtable
5084
5085 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5086 intervals are output in the same format. Exim does not restrict the values; it
5087 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5088
5089
5090
5091 .section "String values" "SECTstrings"
5092 .cindex "string" "format of configuration values"
5093 .cindex "format" "string"
5094 If an option's type is specified as &"string"&, the value can be specified with
5095 or without double-quotes. If it does not start with a double-quote, the value
5096 consists of the remainder of the line plus any continuation lines, starting at
5097 the first character after any leading white space, with trailing white space
5098 removed, and with no interpretation of the characters in the string. Because
5099 Exim removes comment lines (those beginning with #) at an early stage, they can
5100 appear in the middle of a multi-line string. The following two settings are
5101 therefore equivalent:
5102 .code
5103 trusted_users = uucp:mail
5104 trusted_users = uucp:\
5105                 # This comment line is ignored
5106                 mail
5107 .endd
5108 .cindex "string" "quoted"
5109 .cindex "escape characters in quoted strings"
5110 If a string does start with a double-quote, it must end with a closing
5111 double-quote, and any backslash characters other than those used for line
5112 continuation are interpreted as escape characters, as follows:
5113
5114 .table2 100pt
5115 .irow &`\\`&                     "single backslash"
5116 .irow &`\n`&                     "newline"
5117 .irow &`\r`&                     "carriage return"
5118 .irow &`\t`&                     "tab"
5119 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5120 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5121                                    character"
5122 .endtable
5123
5124 If a backslash is followed by some other character, including a double-quote
5125 character, that character replaces the pair.
5126
5127 Quoting is necessary only if you want to make use of the backslash escapes to
5128 insert special characters, or if you need to specify a value with leading or
5129 trailing spaces. These cases are rare, so quoting is almost never needed in
5130 current versions of Exim. In versions of Exim before 3.14, quoting was required
5131 in order to continue lines, so you may come across older configuration files
5132 and examples that apparently quote unnecessarily.
5133
5134
5135 .section "Expanded strings" "SECID51"
5136 .cindex "expansion" "definition of"
5137 Some strings in the configuration file are subjected to &'string expansion'&,
5138 by which means various parts of the string may be changed according to the
5139 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5140 is as just described; in particular, the handling of backslashes in quoted
5141 strings is done as part of the input process, before expansion takes place.
5142 However, backslash is also an escape character for the expander, so any
5143 backslashes that are required for that reason must be doubled if they are
5144 within a quoted configuration string.
5145
5146
5147 .section "User and group names" "SECID52"
5148 .cindex "user name" "format of"
5149 .cindex "format" "user name"
5150 .cindex "groups" "name format"
5151 .cindex "format" "group name"
5152 User and group names are specified as strings, using the syntax described
5153 above, but the strings are interpreted specially. A user or group name must
5154 either consist entirely of digits, or be a name that can be looked up using the
5155 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5156
5157
5158 .section "List construction" "SECTlistconstruct"
5159 .cindex "list" "syntax of in configuration"
5160 .cindex "format" "list item in configuration"
5161 .cindex "string" "list, definition of"
5162 The data for some configuration options is a list of items, with colon as the
5163 default separator. Many of these options are shown with type &"string list"& in
5164 the descriptions later in this document. Others are listed as &"domain list"&,
5165 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5166 are all the same; however, those other than &"string list"& are subject to
5167 particular kinds of interpretation, as described in chapter
5168 &<<CHAPdomhosaddlists>>&.
5169
5170 In all these cases, the entire list is treated as a single string as far as the
5171 input syntax is concerned. The &%trusted_users%& setting in section
5172 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5173 in a list, it must be entered as two colons. Leading and trailing white space
5174 on each item in a list is ignored. This makes it possible to include items that
5175 start with a colon, and in particular, certain forms of IPv6 address. For
5176 example, the list
5177 .code
5178 local_interfaces = 127.0.0.1 : ::::1
5179 .endd
5180 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5181
5182 &*Note*&: Although leading and trailing white space is ignored in individual
5183 list items, it is not ignored when parsing the list. The space after the first
5184 colon in the example above is necessary. If it were not there, the list would
5185 be interpreted as the two items 127.0.0.1:: and 1.
5186
5187 .section "Changing list separators" "SECID53"
5188 .cindex "list separator" "changing"
5189 .cindex "IPv6" "addresses in lists"
5190 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5191 introduced to allow the separator character to be changed. If a list begins
5192 with a left angle bracket, followed by any punctuation character, that
5193 character is used instead of colon as the list separator. For example, the list
5194 above can be rewritten to use a semicolon separator like this:
5195 .code
5196 local_interfaces = <; 127.0.0.1 ; ::1
5197 .endd
5198 This facility applies to all lists, with the exception of the list in
5199 &%log_file_path%&. It is recommended that the use of non-colon separators be
5200 confined to circumstances where they really are needed.
5201
5202 .cindex "list separator" "newline as"
5203 .cindex "newline" "as list separator"
5204 It is also possible to use newline and other control characters (those with
5205 code values less than 32, plus DEL) as separators in lists. Such separators
5206 must be provided literally at the time the list is processed. For options that
5207 are string-expanded, you can write the separator using a normal escape
5208 sequence. This will be processed by the expander before the string is
5209 interpreted as a list. For example, if a newline-separated list of domains is
5210 generated by a lookup, you can process it directly by a line such as this:
5211 .code
5212 domains = <\n ${lookup mysql{.....}}
5213 .endd
5214 This avoids having to change the list separator in such data. You are unlikely
5215 to want to use a control character as a separator in an option that is not
5216 expanded, because the value is literal text. However, it can be done by giving
5217 the value in quotes. For example:
5218 .code
5219 local_interfaces = "<\n 127.0.0.1 \n ::1"
5220 .endd
5221 Unlike printing character separators, which can be included in list items by
5222 doubling, it is not possible to include a control character as data when it is
5223 set as the separator. Two such characters in succession are interpreted as
5224 enclosing an empty list item.
5225
5226
5227
5228 .section "Empty items in lists" "SECTempitelis"
5229 .cindex "list" "empty item in"
5230 An empty item at the end of a list is always ignored. In other words, trailing
5231 separator characters are ignored. Thus, the list in
5232 .code
5233 senders = user@domain :
5234 .endd
5235 contains only a single item. If you want to include an empty string as one item
5236 in a list, it must not be the last item. For example, this list contains three
5237 items, the second of which is empty:
5238 .code
5239 senders = user1@domain : : user2@domain
5240 .endd
5241 &*Note*&: There must be white space between the two colons, as otherwise they
5242 are interpreted as representing a single colon data character (and the list
5243 would then contain just one item). If you want to specify a list that contains
5244 just one, empty item, you can do it as in this example:
5245 .code
5246 senders = :
5247 .endd
5248 In this case, the first item is empty, and the second is discarded because it
5249 is at the end of the list.
5250
5251
5252
5253
5254 .section "Format of driver configurations" "SECTfordricon"
5255 .cindex "drivers" "configuration format"
5256 There are separate parts in the configuration for defining routers, transports,
5257 and authenticators. In each part, you are defining a number of driver
5258 instances, each with its own set of options. Each driver instance is defined by
5259 a sequence of lines like this:
5260 .display
5261 <&'instance name'&>:
5262   <&'option'&>
5263   ...
5264   <&'option'&>
5265 .endd
5266 In the following example, the instance name is &(localuser)&, and it is
5267 followed by three options settings:
5268 .code
5269 localuser:
5270   driver = accept
5271   check_local_user
5272   transport = local_delivery
5273 .endd
5274 For each driver instance, you specify which Exim code module it uses &-- by the
5275 setting of the &%driver%& option &-- and (optionally) some configuration
5276 settings. For example, in the case of transports, if you want a transport to
5277 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5278 a local file you would use the &(appendfile)& driver. Each of the drivers is
5279 described in detail in its own separate chapter later in this manual.
5280
5281 You can have several routers, transports, or authenticators that are based on
5282 the same underlying driver (each must have a different instance name).
5283
5284 The order in which routers are defined is important, because addresses are
5285 passed to individual routers one by one, in order. The order in which
5286 transports are defined does not matter at all. The order in which
5287 authenticators are defined is used only when Exim, as a client, is searching
5288 them to find one that matches an authentication mechanism offered by the
5289 server.
5290
5291 .cindex "generic options"
5292 .cindex "options" "generic &-- definition of"
5293 Within a driver instance definition, there are two kinds of option: &'generic'&
5294 and &'private'&. The generic options are those that apply to all drivers of the
5295 same type (that is, all routers, all transports or all authenticators). The
5296 &%driver%& option is a generic option that must appear in every definition.
5297 .cindex "private options"
5298 The private options are special for each driver, and none need appear, because
5299 they all have default values.
5300
5301 The options may appear in any order, except that the &%driver%& option must
5302 precede any private options, since these depend on the particular driver. For
5303 this reason, it is recommended that &%driver%& always be the first option.
5304
5305 Driver instance names, which are used for reference in log entries and
5306 elsewhere, can be any sequence of letters, digits, and underscores (starting
5307 with a letter) and must be unique among drivers of the same type. A router and
5308 a transport (for example) can each have the same name, but no two router
5309 instances can have the same name. The name of a driver instance should not be
5310 confused with the name of the underlying driver module. For example, the
5311 configuration lines:
5312 .code
5313 remote_smtp:
5314   driver = smtp
5315 .endd
5316 create an instance of the &(smtp)& transport driver whose name is
5317 &(remote_smtp)&. The same driver code can be used more than once, with
5318 different instance names and different option settings each time. A second
5319 instance of the &(smtp)& transport, with different options, might be defined
5320 thus:
5321 .code
5322 special_smtp:
5323   driver = smtp
5324   port = 1234
5325   command_timeout = 10s
5326 .endd
5327 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5328 these transport instances from routers, and these names would appear in log
5329 lines.
5330
5331 Comment lines may be present in the middle of driver specifications. The full
5332 list of option settings for any particular driver instance, including all the
5333 defaulted values, can be extracted by making use of the &%-bP%& command line
5334 option.
5335
5336
5337
5338
5339
5340
5341 . ////////////////////////////////////////////////////////////////////////////
5342 . ////////////////////////////////////////////////////////////////////////////
5343
5344 .chapter "The default configuration file" "CHAPdefconfil"
5345 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5346 .cindex "default" "configuration file &""walk through""&"
5347 The default configuration file supplied with Exim as &_src/configure.default_&
5348 is sufficient for a host with simple mail requirements. As an introduction to
5349 the way Exim is configured, this chapter &"walks through"& the default
5350 configuration, giving brief explanations of the settings. Detailed descriptions
5351 of the options are given in subsequent chapters. The default configuration file
5352 itself contains extensive comments about ways you might want to modify the
5353 initial settings. However, note that there are many options that are not
5354 mentioned at all in the default configuration.
5355
5356
5357
5358 .section "Main configuration settings" "SECTdefconfmain"
5359 The main (global) configuration option settings must always come first in the
5360 file. The first thing you'll see in the file, after some initial comments, is
5361 the line
5362 .code
5363 # primary_hostname =
5364 .endd
5365 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5366 to know the official, fully qualified name of your host, and this is where you
5367 can specify it. However, in most cases you do not need to set this option. When
5368 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5369
5370 The first three non-comment configuration lines are as follows:
5371 .code
5372 domainlist local_domains    = @
5373 domainlist relay_to_domains =
5374 hostlist   relay_from_hosts = 127.0.0.1
5375 .endd
5376 These are not, in fact, option settings. They are definitions of two named
5377 domain lists and one named host list. Exim allows you to give names to lists of
5378 domains, hosts, and email addresses, in order to make it easier to manage the
5379 configuration file (see section &<<SECTnamedlists>>&).
5380
5381 The first line defines a domain list called &'local_domains'&; this is used
5382 later in the configuration to identify domains that are to be delivered
5383 on the local host.
5384
5385 .cindex "@ in a domain list"
5386 There is just one item in this list, the string &"@"&. This is a special form
5387 of entry which means &"the name of the local host"&. Thus, if the local host is
5388 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5389 be delivered locally. Because the local host's name is referenced indirectly,
5390 the same configuration file can be used on different hosts.
5391
5392 The second line defines a domain list called &'relay_to_domains'&, but the
5393 list itself is empty. Later in the configuration we will come to the part that
5394 controls mail relaying through the local host; it allows relaying to any
5395 domains in this list. By default, therefore, no relaying on the basis of a mail
5396 domain is permitted.
5397
5398 The third line defines a host list called &'relay_from_hosts'&. This list is
5399 used later in the configuration to permit relaying from any host or IP address
5400 that matches the list. The default contains just the IP address of the IPv4
5401 loopback interface, which means that processes on the local host are able to
5402 submit mail for relaying by sending it over TCP/IP to that interface. No other
5403 hosts are permitted to submit messages for relaying.
5404
5405 Just to be sure there's no misunderstanding: at this point in the configuration
5406 we aren't actually setting up any controls. We are just defining some domains
5407 and hosts that will be used in the controls that are specified later.
5408
5409 The next two configuration lines are genuine option settings:
5410 .code
5411 acl_smtp_rcpt = acl_check_rcpt
5412 acl_smtp_data = acl_check_data
5413 .endd
5414 These options specify &'Access Control Lists'& (ACLs) that are to be used
5415 during an incoming SMTP session for every recipient of a message (every RCPT
5416 command), and after the contents of the message have been received,
5417 respectively. The names of the lists are &'acl_check_rcpt'& and
5418 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5419 section of the configuration. The RCPT ACL controls which recipients are
5420 accepted for an incoming message &-- if a configuration does not provide an ACL
5421 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5422 contents of a message to be checked.
5423
5424 Two commented-out option settings are next:
5425 .code
5426 # av_scanner = clamd:/tmp/clamd
5427 # spamd_address = 127.0.0.1 783
5428 .endd
5429 These are example settings that can be used when Exim is compiled with the
5430 content-scanning extension. The first specifies the interface to the virus
5431 scanner, and the second specifies the interface to SpamAssassin. Further
5432 details are given in chapter &<<CHAPexiscan>>&.
5433
5434 Three more commented-out option settings follow:
5435 .code
5436 # tls_advertise_hosts = *
5437 # tls_certificate = /etc/ssl/exim.crt
5438 # tls_privatekey = /etc/ssl/exim.pem
5439 .endd
5440 These are example settings that can be used when Exim is compiled with
5441 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5442 first one specifies the list of clients that are allowed to use TLS when
5443 connecting to this server; in this case the wildcard means all clients. The
5444 other options specify where Exim should find its TLS certificate and private
5445 key, which together prove the server's identity to any clients that connect.
5446 More details are given in chapter &<<CHAPTLS>>&.
5447
5448 Another two commented-out option settings follow:
5449 .code
5450 # daemon_smtp_ports = 25 : 465 : 587
5451 # tls_on_connect_ports = 465
5452 .endd
5453 .cindex "port" "465 and 587"
5454 .cindex "port" "for message submission"
5455 .cindex "message" "submission, ports for"
5456 .cindex "ssmtp protocol"
5457 .cindex "smtps protocol"
5458 .cindex "SMTP" "ssmtp protocol"
5459 .cindex "SMTP" "smtps protocol"
5460 These options provide better support for roaming users who wish to use this
5461 server for message submission. They are not much use unless you have turned on
5462 TLS (as described in the previous paragraph) and authentication (about which
5463 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5464 on end-user networks, so RFC 4409 specifies that message submission should use
5465 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5466 configured to use port 587 correctly, so these settings also enable the
5467 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5468 &<<SECTsupobssmt>>&).
5469
5470 Two more commented-out options settings follow:
5471 .code
5472 # qualify_domain =
5473 # qualify_recipient =
5474 .endd
5475 The first of these specifies a domain that Exim uses when it constructs a
5476 complete email address from a local login name. This is often needed when Exim
5477 receives a message from a local process. If you do not set &%qualify_domain%&,
5478 the value of &%primary_hostname%& is used. If you set both of these options,
5479 you can have different qualification domains for sender and recipient
5480 addresses. If you set only the first one, its value is used in both cases.
5481
5482 .cindex "domain literal" "recognizing format"
5483 The following line must be uncommented if you want Exim to recognize
5484 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5485 (an IP address within square brackets) instead of a named domain.
5486 .code
5487 # allow_domain_literals
5488 .endd
5489 The RFCs still require this form, but many people think that in the modern
5490 Internet it makes little sense to permit mail to be sent to specific hosts by
5491 quoting their IP addresses. This ancient format has been used by people who
5492 try to abuse hosts by using them for unwanted relaying. However, some
5493 people believe there are circumstances (for example, messages addressed to
5494 &'postmaster'&) where domain literals are still useful.
5495
5496 The next configuration line is a kind of trigger guard:
5497 .code
5498 never_users = root
5499 .endd
5500 It specifies that no delivery must ever be run as the root user. The normal
5501 convention is to set up &'root'& as an alias for the system administrator. This
5502 setting is a guard against slips in the configuration.
5503 The list of users specified by &%never_users%& is not, however, the complete
5504 list; the build-time configuration in &_Local/Makefile_& has an option called
5505 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5506 contents of &%never_users%& are added to this list. By default
5507 FIXED_NEVER_USERS also specifies root.
5508
5509 When a remote host connects to Exim in order to send mail, the only information
5510 Exim has about the host's identity is its IP address. The next configuration
5511 line,
5512 .code
5513 host_lookup = *
5514 .endd
5515 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5516 in order to get a host name. This improves the quality of the logging
5517 information, but if you feel it is too expensive, you can remove it entirely,
5518 or restrict the lookup to hosts on &"nearby"& networks.
5519 Note that it is not always possible to find a host name from an IP address,
5520 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5521 unreachable.
5522
5523 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5524 1413 (hence their names):
5525 .code
5526 rfc1413_hosts = *
5527 rfc1413_query_timeout = 5s
5528 .endd
5529 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5530 You can limit the hosts to which these calls are made, or change the timeout
5531 that is used. If you set the timeout to zero, all ident calls are disabled.
5532 Although they are cheap and can provide useful information for tracing problem
5533 messages, some hosts and firewalls have problems with ident calls. This can
5534 result in a timeout instead of an immediate refused connection, leading to
5535 delays on starting up an incoming SMTP session.
5536
5537 When Exim receives messages over SMTP connections, it expects all addresses to
5538 be fully qualified with a domain, as required by the SMTP definition. However,
5539 if you are running a server to which simple clients submit messages, you may
5540 find that they send unqualified addresses. The two commented-out options:
5541 .code
5542 # sender_unqualified_hosts =
5543 # recipient_unqualified_hosts =
5544 .endd
5545 show how you can specify hosts that are permitted to send unqualified sender
5546 and recipient addresses, respectively.
5547
5548 The &%percent_hack_domains%& option is also commented out:
5549 .code
5550 # percent_hack_domains =
5551 .endd
5552 It provides a list of domains for which the &"percent hack"& is to operate.
5553 This is an almost obsolete form of explicit email routing. If you do not know
5554 anything about it, you can safely ignore this topic.
5555
5556 The last two settings in the main part of the default configuration are
5557 concerned with messages that have been &"frozen"& on Exim's queue. When a
5558 message is frozen, Exim no longer continues to try to deliver it. Freezing
5559 occurs when a bounce message encounters a permanent failure because the sender
5560 address of the original message that caused the bounce is invalid, so the
5561 bounce cannot be delivered. This is probably the most common case, but there
5562 are also other conditions that cause freezing, and frozen messages are not
5563 always bounce messages.
5564 .code
5565 ignore_bounce_errors_after = 2d
5566 timeout_frozen_after = 7d
5567 .endd
5568 The first of these options specifies that failing bounce messages are to be
5569 discarded after 2 days on the queue. The second specifies that any frozen
5570 message (whether a bounce message or not) is to be timed out (and discarded)
5571 after a week. In this configuration, the first setting ensures that no failing
5572 bounce message ever lasts a week.
5573
5574
5575
5576 .section "ACL configuration" "SECID54"
5577 .cindex "default" "ACLs"
5578 .cindex "&ACL;" "default configuration"
5579 In the default configuration, the ACL section follows the main configuration.
5580 It starts with the line
5581 .code
5582 begin acl
5583 .endd
5584 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5585 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5586 and &%acl_smtp_data%& above.
5587
5588 .cindex "RCPT" "ACL for"
5589 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5590 RCPT command specifies one of the message's recipients. The ACL statements
5591 are considered in order, until the recipient address is either accepted or
5592 rejected. The RCPT command is then accepted or rejected, according to the
5593 result of the ACL processing.
5594 .code
5595 acl_check_rcpt:
5596 .endd
5597 This line, consisting of a name terminated by a colon, marks the start of the
5598 ACL, and names it.
5599 .code
5600 accept  hosts = :
5601 .endd
5602 This ACL statement accepts the recipient if the sending host matches the list.
5603 But what does that strange list mean? It doesn't actually contain any host
5604 names or IP addresses. The presence of the colon puts an empty item in the
5605 list; Exim matches this only if the incoming message did not come from a remote
5606 host, because in that case, the remote hostname is empty. The colon is
5607 important. Without it, the list itself is empty, and can never match anything.
5608
5609 What this statement is doing is to accept unconditionally all recipients in
5610 messages that are submitted by SMTP from local processes using the standard
5611 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5612 manner.
5613 .code
5614 deny    message       = Restricted characters in address
5615         domains       = +local_domains
5616         local_parts   = ^[.] : ^.*[@%!/|]
5617
5618 deny    message       = Restricted characters in address
5619         domains       = !+local_domains
5620         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5621 .endd
5622 These statements are concerned with local parts that contain any of the
5623 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5624 Although these characters are entirely legal in local parts (in the case of
5625 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5626 in Internet mail addresses.
5627
5628 The first three have in the past been associated with explicitly routed
5629 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5630 option). Addresses containing these characters are regularly tried by spammers
5631 in an attempt to bypass relaying restrictions, and also by open relay testing
5632 programs. Unless you really need them it is safest to reject these characters
5633 at this early stage. This configuration is heavy-handed in rejecting these
5634 characters for all messages it accepts from remote hosts. This is a deliberate
5635 policy of being as safe as possible.
5636
5637 The first rule above is stricter, and is applied to messages that are addressed
5638 to one of the local domains handled by this host. This is implemented by the
5639 first condition, which restricts it to domains that are listed in the
5640 &'local_domains'& domain list. The &"+"& character is used to indicate a
5641 reference to a named list. In this configuration, there is just one domain in
5642 &'local_domains'&, but in general there may be many.
5643
5644 The second condition on the first statement uses two regular expressions to
5645 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5646 or &"|"&. If you have local accounts that include these characters, you will
5647 have to modify this rule.
5648
5649 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5650 allows them because they have been encountered in practice. (Consider the
5651 common convention of local parts constructed as
5652 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5653 the author of Exim, who has no second initial.) However, a local part starting
5654 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5655 file name (for example, for a mailing list). This is also true for local parts
5656 that contain slashes. A pipe symbol can also be troublesome if the local part
5657 is incorporated unthinkingly into a shell command line.
5658
5659 The second rule above applies to all other domains, and is less strict. This
5660 allows your own users to send outgoing messages to sites that use slashes
5661 and vertical bars in their local parts. It blocks local parts that begin
5662 with a dot, slash, or vertical bar, but allows these characters within the
5663 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5664 and &"!"& is blocked, as before. The motivation here is to prevent your users
5665 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5666 .code
5667 accept  local_parts   = postmaster
5668         domains       = +local_domains
5669 .endd
5670 This statement, which has two conditions, accepts an incoming address if the
5671 local part is &'postmaster'& and the domain is one of those listed in the
5672 &'local_domains'& domain list. The &"+"& character is used to indicate a
5673 reference to a named list. In this configuration, there is just one domain in
5674 &'local_domains'&, but in general there may be many.
5675
5676 The presence of this statement means that mail to postmaster is never blocked
5677 by any of the subsequent tests. This can be helpful while sorting out problems
5678 in cases where the subsequent tests are incorrectly denying access.
5679 .code
5680 require verify        = sender
5681 .endd
5682 This statement requires the sender address to be verified before any subsequent
5683 ACL statement can be used. If verification fails, the incoming recipient
5684 address is refused. Verification consists of trying to route the address, to
5685 see if a bounce message could be delivered to it. In the case of remote
5686 addresses, basic verification checks only the domain, but &'callouts'& can be
5687 used for more verification if required. Section &<<SECTaddressverification>>&
5688 discusses the details of address verification.
5689 .code
5690 accept  hosts         = +relay_from_hosts
5691         control       = submission
5692 .endd
5693 This statement accepts the address if the message is coming from one of the
5694 hosts that are defined as being allowed to relay through this host. Recipient
5695 verification is omitted here, because in many cases the clients are dumb MUAs
5696 that do not cope well with SMTP error responses. For the same reason, the
5697 second line specifies &"submission mode"& for messages that are accepted. This
5698 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5699 messages that are deficient in some way, for example, because they lack a
5700 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5701 probably add recipient verification here, and disable submission mode.
5702 .code
5703 accept  authenticated = *
5704         control       = submission
5705 .endd
5706 This statement accepts the address if the client host has authenticated itself.
5707 Submission mode is again specified, on the grounds that such messages are most
5708 likely to come from MUAs. The default configuration does not define any
5709 authenticators, though it does include some nearly complete commented-out
5710 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5711 fact authenticate until you complete the authenticator definitions.
5712 .code
5713 require message = relay not permitted
5714         domains = +local_domains : +relay_to_domains
5715 .endd
5716 This statement rejects the address if its domain is neither a local domain nor
5717 one of the domains for which this host is a relay.
5718 .code
5719 require verify = recipient
5720 .endd
5721 This statement requires the recipient address to be verified; if verification
5722 fails, the address is rejected.
5723 .code
5724 # deny    message     = rejected because $sender_host_address \
5725 #                       is in a black list at $dnslist_domain\n\
5726 #                       $dnslist_text
5727 #         dnslists    = black.list.example
5728 #
5729 # warn    dnslists    = black.list.example
5730 #         add_header  = X-Warning: $sender_host_address is in \
5731 #                       a black list at $dnslist_domain
5732 #         log_message = found in $dnslist_domain
5733 .endd
5734 These commented-out lines are examples of how you could configure Exim to check
5735 sending hosts against a DNS black list. The first statement rejects messages
5736 from blacklisted hosts, whereas the second just inserts a warning header
5737 line.
5738 .code
5739 # require verify = csa
5740 .endd
5741 This commented-out line is an example of how you could turn on client SMTP
5742 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5743 records.
5744 .code
5745 accept
5746 .endd
5747 The final statement in the first ACL unconditionally accepts any recipient
5748 address that has successfully passed all the previous tests.
5749 .code
5750 acl_check_data:
5751 .endd
5752 This line marks the start of the second ACL, and names it. Most of the contents
5753 of this ACL are commented out:
5754 .code
5755 # deny    malware   = *
5756 #         message   = This message contains a virus \
5757 #                     ($malware_name).
5758 .endd
5759 These lines are examples of how to arrange for messages to be scanned for
5760 viruses when Exim has been compiled with the content-scanning extension, and a
5761 suitable virus scanner is installed. If the message is found to contain a
5762 virus, it is rejected with the given custom error message.
5763 .code
5764 # warn    spam      = nobody
5765 #         message   = X-Spam_score: $spam_score\n\
5766 #                     X-Spam_score_int: $spam_score_int\n\
5767 #                     X-Spam_bar: $spam_bar\n\
5768 #                     X-Spam_report: $spam_report
5769 .endd
5770 These lines are an example of how to arrange for messages to be scanned by
5771 SpamAssassin when Exim has been compiled with the content-scanning extension,
5772 and SpamAssassin has been installed. The SpamAssassin check is run with
5773 &`nobody`& as its user parameter, and the results are added to the message as a
5774 series of extra header line. In this case, the message is not rejected,
5775 whatever the spam score.
5776 .code
5777 accept
5778 .endd
5779 This final line in the DATA ACL accepts the message unconditionally.
5780
5781
5782 .section "Router configuration" "SECID55"
5783 .cindex "default" "routers"
5784 .cindex "routers" "default"
5785 The router configuration comes next in the default configuration, introduced
5786 by the line
5787 .code
5788 begin routers
5789 .endd
5790 Routers are the modules in Exim that make decisions about where to send
5791 messages. An address is passed to each router in turn, until it is either
5792 accepted, or failed. This means that the order in which you define the routers
5793 matters. Each router is fully described in its own chapter later in this
5794 manual. Here we give only brief overviews.
5795 .code
5796 # domain_literal:
5797 #   driver = ipliteral
5798 #   domains = !+local_domains
5799 #   transport = remote_smtp
5800 .endd
5801 .cindex "domain literal" "default router"
5802 This router is commented out because the majority of sites do not want to
5803 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5804 you uncomment this router, you also need to uncomment the setting of
5805 &%allow_domain_literals%& in the main part of the configuration.
5806 .code
5807 dnslookup:
5808   driver = dnslookup
5809   domains = ! +local_domains
5810   transport = remote_smtp
5811   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5812   no_more
5813 .endd
5814 The first uncommented router handles addresses that do not involve any local
5815 domains. This is specified by the line
5816 .code
5817 domains = ! +local_domains
5818 .endd
5819 The &%domains%& option lists the domains to which this router applies, but the
5820 exclamation mark is a negation sign, so the router is used only for domains
5821 that are not in the domain list called &'local_domains'& (which was defined at
5822 the start of the configuration). The plus sign before &'local_domains'&
5823 indicates that it is referring to a named list. Addresses in other domains are
5824 passed on to the following routers.
5825
5826 The name of the router driver is &(dnslookup)&,
5827 and is specified by the &%driver%& option. Do not be confused by the fact that
5828 the name of this router instance is the same as the name of the driver. The
5829 instance name is arbitrary, but the name set in the &%driver%& option must be
5830 one of the driver modules that is in the Exim binary.
5831
5832 The &(dnslookup)& router routes addresses by looking up their domains in the
5833 DNS in order to obtain a list of hosts to which the address is routed. If the
5834 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5835 specified by the &%transport%& option. If the router does not find the domain
5836 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5837 the address fails and is bounced.
5838
5839 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5840 be entirely ignored. This option is present because a number of cases have been
5841 encountered where MX records in the DNS point to host names
5842 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5843 Completely ignoring these IP addresses causes Exim to fail to route the
5844 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5845 continue to try to deliver the message periodically until the address timed
5846 out.
5847 .code
5848 system_aliases:
5849   driver = redirect
5850   allow_fail
5851   allow_defer
5852   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5853 # user = exim
5854   file_transport = address_file
5855   pipe_transport = address_pipe
5856 .endd
5857 Control reaches this and subsequent routers only for addresses in the local
5858 domains. This router checks to see whether the local part is defined as an
5859 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5860 data that it looks up from that file. If no data is found for the local part,
5861 the value of the &%data%& option is empty, causing the address to be passed to
5862 the next router.
5863
5864 &_/etc/aliases_& is a conventional name for the system aliases file that is
5865 often used. That is why it is referenced by from the default configuration
5866 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5867 &_Local/Makefile_& before building Exim.
5868 .code
5869 userforward:
5870   driver = redirect
5871   check_local_user
5872 # local_part_suffix = +* : -*
5873 # local_part_suffix_optional
5874   file = $home/.forward
5875 # allow_filter
5876   no_verify
5877   no_expn
5878   check_ancestor
5879   file_transport = address_file
5880   pipe_transport = address_pipe
5881   reply_transport = address_reply
5882 .endd
5883 This is the most complicated router in the default configuration. It is another
5884 redirection router, but this time it is looking for forwarding data set up by
5885 individual users. The &%check_local_user%& setting specifies a check that the
5886 local part of the address is the login name of a local user. If it is not, the
5887 router is skipped. The two commented options that follow &%check_local_user%&,
5888 namely:
5889 .code
5890 # local_part_suffix = +* : -*
5891 # local_part_suffix_optional
5892 .endd
5893 .vindex "&$local_part_suffix$&"
5894 show how you can specify the recognition of local part suffixes. If the first
5895 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5896 by any sequence of characters, is removed from the local part and placed in the
5897 variable &$local_part_suffix$&. The second suffix option specifies that the
5898 presence of a suffix in the local part is optional. When a suffix is present,
5899 the check for a local login uses the local part with the suffix removed.
5900
5901 When a local user account is found, the file called &_.forward_& in the user's
5902 home directory is consulted. If it does not exist, or is empty, the router
5903 declines. Otherwise, the contents of &_.forward_& are interpreted as
5904 redirection data (see chapter &<<CHAPredirect>>& for more details).
5905
5906 .cindex "Sieve filter" "enabling in default router"
5907 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5908 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5909 is commented out by default), the contents of the file are interpreted as a set
5910 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5911 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5912 separate document entitled &'Exim's interfaces to mail filtering'&.
5913
5914 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5915 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5916 There are two reasons for doing this:
5917
5918 .olist
5919 Whether or not a local user has a &_.forward_& file is not really relevant when
5920 checking an address for validity; it makes sense not to waste resources doing
5921 unnecessary work.
5922 .next
5923 More importantly, when Exim is verifying addresses or handling an EXPN
5924 command during an SMTP session, it is running as the Exim user, not as root.
5925 The group is the Exim group, and no additional groups are set up.
5926 It may therefore not be possible for Exim to read users' &_.forward_& files at
5927 this time.
5928 .endlist
5929
5930 The setting of &%check_ancestor%& prevents the router from generating a new
5931 address that is the same as any previous address that was redirected. (This
5932 works round a problem concerning a bad interaction between aliasing and
5933 forwarding &-- see section &<<SECTredlocmai>>&).
5934
5935 The final three option settings specify the transports that are to be used when
5936 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5937 auto-reply, respectively. For example, if a &_.forward_& file contains
5938 .code
5939 a.nother@elsewhere.example, /home/spqr/archive
5940 .endd
5941 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5942 transport.
5943 .code
5944 localuser:
5945   driver = accept
5946   check_local_user
5947 # local_part_suffix = +* : -*
5948 # local_part_suffix_optional
5949   transport = local_delivery
5950 .endd
5951 The final router sets up delivery into local mailboxes, provided that the local
5952 part is the name of a local login, by accepting the address and assigning it to
5953 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5954 routers, so the address is bounced. The commented suffix settings fulfil the
5955 same purpose as they do for the &(userforward)& router.
5956
5957
5958 .section "Transport configuration" "SECID56"
5959 .cindex "default" "transports"
5960 .cindex "transports" "default"
5961 Transports define mechanisms for actually delivering messages. They operate
5962 only when referenced from routers, so the order in which they are defined does
5963 not matter. The transports section of the configuration starts with
5964 .code
5965 begin transports
5966 .endd
5967 One remote transport and four local transports are defined.
5968 .code
5969 remote_smtp:
5970   driver = smtp
5971 .endd
5972 This transport is used for delivering messages over SMTP connections. All its
5973 options are defaulted. The list of remote hosts comes from the router.
5974 .code
5975 local_delivery:
5976   driver = appendfile
5977   file = /var/mail/$local_part
5978   delivery_date_add
5979   envelope_to_add
5980   return_path_add
5981 # group = mail
5982 # mode = 0660
5983 .endd
5984 This &(appendfile)& transport is used for local delivery to user mailboxes in
5985 traditional BSD mailbox format. By default it runs under the uid and gid of the
5986 local user, which requires the sticky bit to be set on the &_/var/mail_&
5987 directory. Some systems use the alternative approach of running mail deliveries
5988 under a particular group instead of using the sticky bit. The commented options
5989 show how this can be done.
5990
5991 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5992 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5993 similarly-named options above.
5994 .code
5995 address_pipe:
5996   driver = pipe
5997   return_output
5998 .endd
5999 This transport is used for handling deliveries to pipes that are generated by
6000 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6001 option specifies that any output generated by the pipe is to be returned to the
6002 sender.
6003 .code
6004 address_file:
6005   driver = appendfile
6006   delivery_date_add
6007   envelope_to_add
6008   return_path_add
6009 .endd
6010 This transport is used for handling deliveries to files that are generated by
6011 redirection. The name of the file is not specified in this instance of
6012 &(appendfile)&, because it comes from the &(redirect)& router.
6013 .code
6014 address_reply:
6015   driver = autoreply
6016 .endd
6017 This transport is used for handling automatic replies generated by users'
6018 filter files.
6019
6020
6021
6022 .section "Default retry rule" "SECID57"
6023 .cindex "retry" "default rule"
6024 .cindex "default" "retry rule"
6025 The retry section of the configuration file contains rules which affect the way
6026 Exim retries deliveries that cannot be completed at the first attempt. It is
6027 introduced by the line
6028 .code
6029 begin retry
6030 .endd
6031 In the default configuration, there is just one rule, which applies to all
6032 errors:
6033 .code
6034 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6035 .endd
6036 This causes any temporarily failing address to be retried every 15 minutes for
6037 2 hours, then at intervals starting at one hour and increasing by a factor of
6038 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6039 is not delivered after 4 days of temporary failure, it is bounced.
6040
6041 If the retry section is removed from the configuration, or is empty (that is,
6042 if no retry rules are defined), Exim will not retry deliveries. This turns
6043 temporary errors into permanent errors.
6044
6045
6046 .section "Rewriting configuration" "SECID58"
6047 The rewriting section of the configuration, introduced by
6048 .code
6049 begin rewrite
6050 .endd
6051 contains rules for rewriting addresses in messages as they arrive. There are no
6052 rewriting rules in the default configuration file.
6053
6054
6055
6056 .section "Authenticators configuration" "SECTdefconfauth"
6057 .cindex "AUTH" "configuration"
6058 The authenticators section of the configuration, introduced by
6059 .code
6060 begin authenticators
6061 .endd
6062 defines mechanisms for the use of the SMTP AUTH command. The default
6063 configuration file contains two commented-out example authenticators
6064 which support plaintext username/password authentication using the
6065 standard PLAIN mechanism and the traditional but non-standard LOGIN
6066 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6067 to support most MUA software.
6068
6069 The example PLAIN authenticator looks like this:
6070 .code
6071 #PLAIN:
6072 #  driver                  = plaintext
6073 #  server_set_id           = $auth2
6074 #  server_prompts          = :
6075 #  server_condition        = Authentication is not yet configured
6076 #  server_advertise_condition = ${if def:tls_in_cipher }
6077 .endd
6078 And the example LOGIN authenticator looks like this:
6079 .code
6080 #LOGIN:
6081 #  driver                  = plaintext
6082 #  server_set_id           = $auth1
6083 #  server_prompts          = <| Username: | Password:
6084 #  server_condition        = Authentication is not yet configured
6085 #  server_advertise_condition = ${if def:tls_in_cipher }
6086 .endd
6087
6088 The &%server_set_id%& option makes Exim remember the authenticated username
6089 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6090 &%server_prompts%& option configures the &(plaintext)& authenticator so
6091 that it implements the details of the specific authentication mechanism,
6092 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6093 when Exim offers authentication to clients; in the examples, this is only
6094 when TLS or SSL has been started, so to enable the authenticators you also
6095 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6096
6097 The &%server_condition%& setting defines how to verify that the username and
6098 password are correct. In the examples it just produces an error message.
6099 To make the authenticators work, you can use a string expansion
6100 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6101
6102 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6103 usercode and password are in different positions.
6104 Chapter &<<CHAPplaintext>>& covers both.
6105
6106 .ecindex IIDconfiwal
6107
6108
6109
6110 . ////////////////////////////////////////////////////////////////////////////
6111 . ////////////////////////////////////////////////////////////////////////////
6112
6113 .chapter "Regular expressions" "CHAPregexp"
6114
6115 .cindex "regular expressions" "library"
6116 .cindex "PCRE"
6117 Exim supports the use of regular expressions in many of its options. It
6118 uses the PCRE regular expression library; this provides regular expression
6119 matching that is compatible with Perl 5. The syntax and semantics of
6120 regular expressions is discussed in many Perl reference books, and also in
6121 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6122 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6123
6124 The documentation for the syntax and semantics of the regular expressions that
6125 are supported by PCRE is included in the PCRE distribution, and no further
6126 description is included here. The PCRE functions are called from Exim using
6127 the default option settings (that is, with no PCRE options set), except that
6128 the PCRE_CASELESS option is set when the matching is required to be
6129 case-insensitive.
6130
6131 In most cases, when a regular expression is required in an Exim configuration,
6132 it has to start with a circumflex, in order to distinguish it from plain text
6133 or an &"ends with"& wildcard. In this example of a configuration setting, the
6134 second item in the colon-separated list is a regular expression.
6135 .code
6136 domains = a.b.c : ^\\d{3} : *.y.z : ...
6137 .endd
6138 The doubling of the backslash is required because of string expansion that
6139 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6140 of this issue, and a way of avoiding the need for doubling backslashes. The
6141 regular expression that is eventually used in this example contains just one
6142 backslash. The circumflex is included in the regular expression, and has the
6143 normal effect of &"anchoring"& it to the start of the string that is being
6144 matched.
6145
6146 There are, however, two cases where a circumflex is not required for the
6147 recognition of a regular expression: these are the &%match%& condition in a
6148 string expansion, and the &%matches%& condition in an Exim filter file. In
6149 these cases, the relevant string is always treated as a regular expression; if
6150 it does not start with a circumflex, the expression is not anchored, and can
6151 match anywhere in the subject string.
6152
6153 In all cases, if you want a regular expression to match at the end of a string,
6154 you must code the $ metacharacter to indicate this. For example:
6155 .code
6156 domains = ^\\d{3}\\.example
6157 .endd
6158 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6159 You need to use:
6160 .code
6161 domains = ^\\d{3}\\.example\$
6162 .endd
6163 if you want &'example'& to be the top-level domain. The backslash before the
6164 $ is needed because string expansion also interprets dollar characters.
6165
6166
6167
6168 . ////////////////////////////////////////////////////////////////////////////
6169 . ////////////////////////////////////////////////////////////////////////////
6170
6171 .chapter "File and database lookups" "CHAPfdlookup"
6172 .scindex IIDfidalo1 "file" "lookups"
6173 .scindex IIDfidalo2 "database" "lookups"
6174 .cindex "lookup" "description of"
6175 Exim can be configured to look up data in files or databases as it processes
6176 messages. Two different kinds of syntax are used:
6177
6178 .olist
6179 A string that is to be expanded may contain explicit lookup requests. These
6180 cause parts of the string to be replaced by data that is obtained from the
6181 lookup. Lookups of this type are conditional expansion items. Different results
6182 can be defined for the cases of lookup success and failure. See chapter
6183 &<<CHAPexpand>>&, where string expansions are described in detail.
6184 .next
6185 Lists of domains, hosts, and email addresses can contain lookup requests as a
6186 way of avoiding excessively long linear lists. In this case, the data that is
6187 returned by the lookup is often (but not always) discarded; whether the lookup
6188 succeeds or fails is what really counts. These kinds of list are described in
6189 chapter &<<CHAPdomhosaddlists>>&.
6190 .endlist
6191
6192 String expansions, lists, and lookups interact with each other in such a way
6193 that there is no order in which to describe any one of them that does not
6194 involve references to the others. Each of these three chapters makes more sense
6195 if you have read the other two first. If you are reading this for the first
6196 time, be aware that some of it will make a lot more sense after you have read
6197 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6198
6199 .section "Examples of different lookup syntax" "SECID60"
6200 It is easy to confuse the two different kinds of lookup, especially as the
6201 lists that may contain the second kind are always expanded before being
6202 processed as lists. Therefore, they may also contain lookups of the first kind.
6203 Be careful to distinguish between the following two examples:
6204 .code
6205 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6206 domains = lsearch;/some/file
6207 .endd
6208 The first uses a string expansion, the result of which must be a domain list.
6209 No strings have been specified for a successful or a failing lookup; the
6210 defaults in this case are the looked-up data and an empty string, respectively.
6211 The expansion takes place before the string is processed as a list, and the
6212 file that is searched could contain lines like this:
6213 .code
6214 192.168.3.4: domain1:domain2:...
6215 192.168.1.9: domain3:domain4:...
6216 .endd
6217 When the lookup succeeds, the result of the expansion is a list of domains (and
6218 possibly other types of item that are allowed in domain lists).
6219
6220 In the second example, the lookup is a single item in a domain list. It causes
6221 Exim to use a lookup to see if the domain that is being processed can be found
6222 in the file. The file could contains lines like this:
6223 .code
6224 domain1:
6225 domain2:
6226 .endd
6227 Any data that follows the keys is not relevant when checking that the domain
6228 matches the list item.
6229
6230 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6231 Consider a file containing lines like this:
6232 .code
6233 192.168.5.6: lsearch;/another/file
6234 .endd
6235 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6236 first &%domains%& setting above generates the second setting, which therefore
6237 causes a second lookup to occur.
6238
6239 The rest of this chapter describes the different lookup types that are
6240 available. Any of them can be used in any part of the configuration where a
6241 lookup is permitted.
6242
6243
6244 .section "Lookup types" "SECID61"
6245 .cindex "lookup" "types of"
6246 .cindex "single-key lookup" "definition of"
6247 Two different types of data lookup are implemented:
6248
6249 .ilist
6250 The &'single-key'& type requires the specification of a file in which to look,
6251 and a single key to search for. The key must be a non-empty string for the
6252 lookup to succeed. The lookup type determines how the file is searched.
6253 .next
6254 .cindex "query-style lookup" "definition of"
6255 The &'query-style'& type accepts a generalized database query. No particular
6256 key value is assumed by Exim for query-style lookups. You can use whichever
6257 Exim variables you need to construct the database query.
6258 .endlist
6259
6260 The code for each lookup type is in a separate source file that is included in
6261 the binary of Exim only if the corresponding compile-time option is set. The
6262 default settings in &_src/EDITME_& are:
6263 .code
6264 LOOKUP_DBM=yes
6265 LOOKUP_LSEARCH=yes
6266 .endd
6267 which means that only linear searching and DBM lookups are included by default.
6268 For some types of lookup (e.g. SQL databases), you need to install appropriate
6269 libraries and header files before building Exim.
6270
6271
6272
6273
6274 .section "Single-key lookup types" "SECTsinglekeylookups"
6275 .cindex "lookup" "single-key types"
6276 .cindex "single-key lookup" "list of types"
6277 The following single-key lookup types are implemented:
6278
6279 .ilist
6280 .cindex "cdb" "description of"
6281 .cindex "lookup" "cdb"
6282 .cindex "binary zero" "in lookup key"
6283 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6284 string without a terminating binary zero. The cdb format is designed for
6285 indexed files that are read frequently and never updated, except by total
6286 re-creation. As such, it is particularly suitable for large files containing
6287 aliases or other indexed data referenced by an MTA. Information about cdb can
6288 be found in several places:
6289 .display
6290 &url(http://www.pobox.com/~djb/cdb.html)
6291 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6292 &url(http://packages.debian.org/stable/utils/freecdb.html)
6293 .endd
6294 A cdb distribution is not needed in order to build Exim with cdb support,
6295 because the code for reading cdb files is included directly in Exim itself.
6296 However, no means of building or testing cdb files is provided with Exim, so
6297 you need to obtain a cdb distribution in order to do this.
6298 .next
6299 .cindex "DBM" "lookup type"
6300 .cindex "lookup" "dbm"
6301 .cindex "binary zero" "in lookup key"
6302 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6303 DBM file by looking up the record with the given key. A terminating binary
6304 zero is included in the key that is passed to the DBM library. See section
6305 &<<SECTdb>>& for a discussion of DBM libraries.
6306
6307 .cindex "Berkeley DB library" "file format"
6308 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6309 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6310 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6311 the DB_UNKNOWN option. This enables it to handle any of the types of database
6312 that the library supports, and can be useful for accessing DBM files created by
6313 other applications. (For earlier DB versions, DB_HASH is always used.)
6314 .next
6315 .cindex "lookup" "dbmjz"
6316 .cindex "lookup" "dbm &-- embedded NULs"
6317 .cindex "sasldb2"
6318 .cindex "dbmjz lookup type"
6319 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6320 interpreted as an Exim list; the elements of the list are joined together with
6321 ASCII NUL characters to form the lookup key.  An example usage would be to
6322 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6323 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6324 &(cram_md5)& authenticator.
6325 .next
6326 .cindex "lookup" "dbmnz"
6327 .cindex "lookup" "dbm &-- terminating zero"
6328 .cindex "binary zero" "in lookup key"
6329 .cindex "Courier"
6330 .cindex "&_/etc/userdbshadow.dat_&"
6331 .cindex "dbmnz lookup type"
6332 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6333 is not included in the key that is passed to the DBM library. You may need this
6334 if you want to look up data in files that are created by or shared with some
6335 other application that does not use terminating zeros. For example, you need to
6336 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6337 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6338 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6339 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6340 .next
6341 .cindex "lookup" "dsearch"
6342 .cindex "dsearch lookup type"
6343 &(dsearch)&: The given file must be a directory; this is searched for an entry
6344 whose name is the key by calling the &[lstat()]& function. The key may not
6345 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6346 the lookup is the name of the entry, which may be a file, directory,
6347 symbolic link, or any other kind of directory entry. An example of how this
6348 lookup can be used to support virtual domains is given in section
6349 &<<SECTvirtualdomains>>&.
6350 .next
6351 .cindex "lookup" "iplsearch"
6352 .cindex "iplsearch lookup type"
6353 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6354 terminated by a colon or white space or the end of the line. The keys in the
6355 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6356 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6357 being interpreted as a key terminator. For example:
6358 .code
6359 1.2.3.4:           data for 1.2.3.4
6360 192.168.0.0/16:    data for 192.168.0.0/16
6361 "abcd::cdab":      data for abcd::cdab
6362 "abcd:abcd::/32"   data for abcd:abcd::/32
6363 .endd
6364 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6365 file is searched linearly, using the CIDR masks where present, until a matching
6366 key is found. The first key that matches is used; there is no attempt to find a
6367 &"best"& match. Apart from the way the keys are matched, the processing for
6368 &(iplsearch)& is the same as for &(lsearch)&.
6369
6370 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6371 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6372 lookup types support only literal keys.
6373
6374 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6375 the implicit key is the host's IP address rather than its name (see section
6376 &<<SECThoslispatsikey>>&).
6377 .next
6378 .cindex "linear search"
6379 .cindex "lookup" "lsearch"
6380 .cindex "lsearch lookup type"
6381 .cindex "case sensitivity" "in lsearch lookup"
6382 &(lsearch)&: The given file is a text file that is searched linearly for a
6383 line beginning with the search key, terminated by a colon or white space or the
6384 end of the line. The search is case-insensitive; that is, upper and lower case
6385 letters are treated as the same. The first occurrence of the key that is found
6386 in the file is used.
6387
6388 White space between the key and the colon is permitted. The remainder of the
6389 line, with leading and trailing white space removed, is the data. This can be
6390 continued onto subsequent lines by starting them with any amount of white
6391 space, but only a single space character is included in the data at such a
6392 junction. If the data begins with a colon, the key must be terminated by a
6393 colon, for example:
6394 .code
6395 baduser:  :fail:
6396 .endd
6397 Empty lines and lines beginning with # are ignored, even if they occur in the
6398 middle of an item. This is the traditional textual format of alias files. Note
6399 that the keys in an &(lsearch)& file are literal strings. There is no
6400 wildcarding of any kind.
6401
6402 .cindex "lookup" "lsearch &-- colons in keys"
6403 .cindex "white space" "in lsearch key"
6404 In most &(lsearch)& files, keys are not required to contain colons or #
6405 characters, or white space. However, if you need this feature, it is available.
6406 If a key begins with a doublequote character, it is terminated only by a
6407 matching quote (or end of line), and the normal escaping rules apply to its
6408 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6409 quoted keys (exactly as for unquoted keys). There is no special handling of
6410 quotes for the data part of an &(lsearch)& line.
6411
6412 .next
6413 .cindex "NIS lookup type"
6414 .cindex "lookup" "NIS"
6415 .cindex "binary zero" "in lookup key"
6416 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6417 the given key, without a terminating binary zero. There is a variant called
6418 &(nis0)& which does include the terminating binary zero in the key. This is
6419 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6420 aliases; the full map names must be used.
6421
6422 .next
6423 .cindex "wildlsearch lookup type"
6424 .cindex "lookup" "wildlsearch"
6425 .cindex "nwildlsearch lookup type"
6426 .cindex "lookup" "nwildlsearch"
6427 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6428 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6429 the file may be wildcarded. The difference between these two lookup types is
6430 that for &(wildlsearch)&, each key in the file is string-expanded before being
6431 used, whereas for &(nwildlsearch)&, no expansion takes place.
6432
6433 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6434 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6435 file that are regular expressions can be made case-sensitive by the use of
6436 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6437
6438 . ==== As this is a nested list, any displays it contains must be indented
6439 . ==== as otherwise they are too far to the left.
6440
6441 .olist
6442 The string may begin with an asterisk to mean &"ends with"&. For example:
6443 .code
6444     *.a.b.c       data for anything.a.b.c
6445     *fish         data for anythingfish
6446 .endd
6447 .next
6448 The string may begin with a circumflex to indicate a regular expression. For
6449 example, for &(wildlsearch)&:
6450 .code
6451     ^\N\d+\.a\.b\N    data for <digits>.a.b
6452 .endd
6453 Note the use of &`\N`& to disable expansion of the contents of the regular
6454 expression. If you are using &(nwildlsearch)&, where the keys are not
6455 string-expanded, the equivalent entry is:
6456 .code
6457     ^\d+\.a\.b        data for <digits>.a.b
6458 .endd
6459 The case-insensitive flag is set at the start of compiling the regular
6460 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6461 For example, to make the entire pattern case-sensitive:
6462 .code
6463     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6464 .endd
6465
6466 If the regular expression contains white space or colon characters, you must
6467 either quote it (see &(lsearch)& above), or represent these characters in other
6468 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6469 colon. This may be easier than quoting, because if you quote, you have to
6470 escape all the backslashes inside the quotes.
6471
6472 &*Note*&: It is not possible to capture substrings in a regular expression
6473 match for later use, because the results of all lookups are cached. If a lookup
6474 is repeated, the result is taken from the cache, and no actual pattern matching
6475 takes place. The values of all the numeric variables are unset after a
6476 &((n)wildlsearch)& match.
6477
6478 .next
6479 Although I cannot see it being of much use, the general matching function that
6480 is used to implement &((n)wildlsearch)& means that the string may begin with a
6481 lookup name terminated by a semicolon, and followed by lookup data. For
6482 example:
6483 .code
6484     cdb;/some/file  data for keys that match the file
6485 .endd
6486 The data that is obtained from the nested lookup is discarded.
6487 .endlist olist
6488
6489 Keys that do not match any of these patterns are interpreted literally. The
6490 continuation rules for the data are the same as for &(lsearch)&, and keys may
6491 be followed by optional colons.
6492
6493 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6494 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6495 lookup types support only literal keys.
6496 .endlist ilist
6497
6498
6499 .section "Query-style lookup types" "SECID62"
6500 .cindex "lookup" "query-style types"
6501 .cindex "query-style lookup" "list of types"
6502 The supported query-style lookup types are listed below. Further details about
6503 many of them are given in later sections.
6504
6505 .ilist
6506 .cindex "DNS" "as a lookup type"
6507 .cindex "lookup" "DNS"
6508 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6509 are given in the supplied query. The resulting data is the contents of the
6510 records. See section &<<SECTdnsdb>>&.
6511 .next
6512 .cindex "InterBase lookup type"
6513 .cindex "lookup" "InterBase"
6514 &(ibase)&: This does a lookup in an InterBase database.
6515 .next
6516 .cindex "LDAP" "lookup type"
6517 .cindex "lookup" "LDAP"
6518 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6519 returns attributes from a single entry. There is a variant called &(ldapm)&
6520 that permits values from multiple entries to be returned. A third variant
6521 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6522 any attribute values. See section &<<SECTldap>>&.
6523 .next
6524 .cindex "MySQL" "lookup type"
6525 .cindex "lookup" "MySQL"
6526 &(mysql)&: The format of the query is an SQL statement that is passed to a
6527 MySQL database. See section &<<SECTsql>>&.
6528 .next
6529 .cindex "NIS+ lookup type"
6530 .cindex "lookup" "NIS+"
6531 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6532 the field to be returned. See section &<<SECTnisplus>>&.
6533 .next
6534 .cindex "Oracle" "lookup type"
6535 .cindex "lookup" "Oracle"
6536 &(oracle)&: The format of the query is an SQL statement that is passed to an
6537 Oracle database. See section &<<SECTsql>>&.
6538 .next
6539 .cindex "lookup" "passwd"
6540 .cindex "passwd lookup type"
6541 .cindex "&_/etc/passwd_&"
6542 &(passwd)& is a query-style lookup with queries that are just user names. The
6543 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6544 success, the result string is the same as you would get from an &(lsearch)&
6545 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6546 password value. For example:
6547 .code
6548 *:42:42:King Rat:/home/kr:/bin/bash
6549 .endd
6550 .next
6551 .cindex "PostgreSQL lookup type"
6552 .cindex "lookup" "PostgreSQL"
6553 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6554 PostgreSQL database. See section &<<SECTsql>>&.
6555
6556 .next
6557 .cindex "sqlite lookup type"
6558 .cindex "lookup" "sqlite"
6559 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6560 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6561
6562 .next
6563 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6564 not likely to be useful in normal operation.
6565 .next
6566 .cindex "whoson lookup type"
6567 .cindex "lookup" "whoson"
6568 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6569 allows a server to check whether a particular (dynamically allocated) IP
6570 address is currently allocated to a known (trusted) user and, optionally, to
6571 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6572 at one time for &"POP before SMTP"& authentication, but that approach has been
6573 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6574 &"POP before SMTP"& checking using ACL statements such as
6575 .code
6576 require condition = \
6577   ${lookup whoson {$sender_host_address}{yes}{no}}
6578 .endd
6579 The query consists of a single IP address. The value returned is the name of
6580 the authenticated user, which is stored in the variable &$value$&. However, in
6581 this example, the data in &$value$& is not used; the result of the lookup is
6582 one of the fixed strings &"yes"& or &"no"&.
6583 .endlist
6584
6585
6586
6587 .section "Temporary errors in lookups" "SECID63"
6588 .cindex "lookup" "temporary error in"
6589 Lookup functions can return temporary error codes if the lookup cannot be
6590 completed. For example, an SQL or LDAP database might be unavailable. For this
6591 reason, it is not advisable to use a lookup that might do this for critical
6592 options such as a list of local domains.
6593
6594 When a lookup cannot be completed in a router or transport, delivery
6595 of the message (to the relevant address) is deferred, as for any other
6596 temporary error. In other circumstances Exim may assume the lookup has failed,
6597 or may give up altogether.
6598
6599
6600
6601 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6602 .cindex "wildcard lookups"
6603 .cindex "lookup" "default values"
6604 .cindex "lookup" "wildcard"
6605 .cindex "lookup" "* added to type"
6606 .cindex "default" "in single-key lookups"
6607 In this context, a &"default value"& is a value specified by the administrator
6608 that is to be used if a lookup fails.
6609
6610 &*Note:*& This section applies only to single-key lookups. For query-style
6611 lookups, the facilities of the query language must be used. An attempt to
6612 specify a default for a query-style lookup provokes an error.
6613
6614 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6615 and the initial lookup fails, the key &"*"& is looked up in the file to
6616 provide a default value. See also the section on partial matching below.
6617
6618 .cindex "*@ with single-key lookup"
6619 .cindex "lookup" "*@ added to type"
6620 .cindex "alias file" "per-domain default"
6621 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6622 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6623 character, a second lookup is done with everything before the last @ replaced
6624 by *. This makes it possible to provide per-domain defaults in alias files
6625 that include the domains in the keys. If the second lookup fails (or doesn't
6626 take place because there is no @ in the key), &"*"& is looked up.
6627 For example, a &(redirect)& router might contain:
6628 .code
6629 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6630 .endd
6631 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6632 looks up these keys, in this order:
6633 .code
6634 jane@eyre.example
6635 *@eyre.example
6636 *
6637 .endd
6638 The data is taken from whichever key it finds first. &*Note*&: In an
6639 &(lsearch)& file, this does not mean the first of these keys in the file. A
6640 complete scan is done for each key, and only if it is not found at all does
6641 Exim move on to try the next key.
6642
6643
6644
6645 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6646 .cindex "partial matching"
6647 .cindex "wildcard lookups"
6648 .cindex "lookup" "partial matching"
6649 .cindex "lookup" "wildcard"
6650 .cindex "asterisk" "in search type"
6651 The normal operation of a single-key lookup is to search the file for an exact
6652 match with the given key. However, in a number of situations where domains are
6653 being looked up, it is useful to be able to do partial matching. In this case,
6654 information in the file that has a key starting with &"*."& is matched by any
6655 domain that ends with the components that follow the full stop. For example, if
6656 a key in a DBM file is
6657 .code
6658 *.dates.fict.example
6659 .endd
6660 then when partial matching is enabled this is matched by (amongst others)
6661 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6662 by &'dates.fict.example'&, if that does not appear as a separate key in the
6663 file.
6664
6665 &*Note*&: Partial matching is not available for query-style lookups. It is
6666 also not available for any lookup items in address lists (see section
6667 &<<SECTaddresslist>>&).
6668
6669 Partial matching is implemented by doing a series of separate lookups using
6670 keys constructed by modifying the original subject key. This means that it can
6671 be used with any of the single-key lookup types, provided that
6672 partial matching keys
6673 beginning with a special prefix (default &"*."&) are included in the data file.
6674 Keys in the file that do not begin with the prefix are matched only by
6675 unmodified subject keys when partial matching is in use.
6676
6677 Partial matching is requested by adding the string &"partial-"& to the front of
6678 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6679 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6680 is added at the start of the subject key, and it is looked up again. If that
6681 fails, further lookups are tried with dot-separated components removed from the
6682 start of the subject key, one-by-one, and &"*."& added on the front of what
6683 remains.
6684
6685 A minimum number of two non-* components are required. This can be adjusted
6686 by including a number before the hyphen in the search type. For example,
6687 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6688 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6689 subject key is &'2250.dates.fict.example'& then the following keys are looked
6690 up when the minimum number of non-* components is two:
6691 .code
6692 2250.dates.fict.example
6693 *.2250.dates.fict.example
6694 *.dates.fict.example
6695 *.fict.example
6696 .endd
6697 As soon as one key in the sequence is successfully looked up, the lookup
6698 finishes.
6699
6700 .cindex "lookup" "partial matching &-- changing prefix"
6701 .cindex "prefix" "for partial matching"
6702 The use of &"*."& as the partial matching prefix is a default that can be
6703 changed. The motivation for this feature is to allow Exim to operate with file
6704 formats that are used by other MTAs. A different prefix can be supplied in
6705 parentheses instead of the hyphen after &"partial"&. For example:
6706 .code
6707 domains = partial(.)lsearch;/some/file
6708 .endd
6709 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6710 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6711 components is unchanged). The prefix may consist of any punctuation characters
6712 other than a closing parenthesis. It may be empty, for example:
6713 .code
6714 domains = partial1()cdb;/some/file
6715 .endd
6716 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6717 &`a.b.c`&, &`b.c`&, and &`c`&.
6718
6719 If &"partial0"& is specified, what happens at the end (when the lookup with
6720 just one non-wild component has failed, and the original key is shortened right
6721 down to the null string) depends on the prefix:
6722
6723 .ilist
6724 If the prefix has zero length, the whole lookup fails.
6725 .next
6726 If the prefix has length 1, a lookup for just the prefix is done. For
6727 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6728 .next
6729 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6730 remainder is looked up. With the default prefix, therefore, the final lookup is
6731 for &"*"& on its own.
6732 .next
6733 Otherwise, the whole prefix is looked up.
6734 .endlist
6735
6736
6737 If the search type ends in &"*"& or &"*@"& (see section
6738 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6739 this implies happens after all partial lookups have failed. If &"partial0"& is
6740 specified, adding &"*"& to the search type has no effect with the default
6741 prefix, because the &"*"& key is already included in the sequence of partial
6742 lookups. However, there might be a use for lookup types such as
6743 &"partial0(.)lsearch*"&.
6744
6745 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6746 in domain lists and the like. Partial matching works only in terms of
6747 dot-separated components; a key such as &`*fict.example`&
6748 in a database file is useless, because the asterisk in a partial matching
6749 subject key is always followed by a dot.
6750
6751
6752
6753
6754 .section "Lookup caching" "SECID64"
6755 .cindex "lookup" "caching"
6756 .cindex "caching" "lookup data"
6757 Exim caches all lookup results in order to avoid needless repetition of
6758 lookups. However, because (apart from the daemon) Exim operates as a collection
6759 of independent, short-lived processes, this caching applies only within a
6760 single Exim process. There is no inter-process lookup caching facility.
6761
6762 For single-key lookups, Exim keeps the relevant files open in case there is
6763 another lookup that needs them. In some types of configuration this can lead to
6764 many files being kept open for messages with many recipients. To avoid hitting
6765 the operating system limit on the number of simultaneously open files, Exim
6766 closes the least recently used file when it needs to open more files than its
6767 own internal limit, which can be changed via the &%lookup_open_max%& option.
6768
6769 The single-key lookup files are closed and the lookup caches are flushed at
6770 strategic points during delivery &-- for example, after all routing is
6771 complete.
6772
6773
6774
6775
6776 .section "Quoting lookup data" "SECID65"
6777 .cindex "lookup" "quoting"
6778 .cindex "quoting" "in lookups"
6779 When data from an incoming message is included in a query-style lookup, there
6780 is the possibility of special characters in the data messing up the syntax of
6781 the query. For example, a NIS+ query that contains
6782 .code
6783 [name=$local_part]
6784 .endd
6785 will be broken if the local part happens to contain a closing square bracket.
6786 For NIS+, data can be enclosed in double quotes like this:
6787 .code
6788 [name="$local_part"]
6789 .endd
6790 but this still leaves the problem of a double quote in the data. The rule for
6791 NIS+ is that double quotes must be doubled. Other lookup types have different
6792 rules, and to cope with the differing requirements, an expansion operator
6793 of the following form is provided:
6794 .code
6795 ${quote_<lookup-type>:<string>}
6796 .endd
6797 For example, the safest way to write the NIS+ query is
6798 .code
6799 [name="${quote_nisplus:$local_part}"]
6800 .endd
6801 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6802 operator can be used for all lookup types, but has no effect for single-key
6803 lookups, since no quoting is ever needed in their key strings.
6804
6805
6806
6807
6808 .section "More about dnsdb" "SECTdnsdb"
6809 .cindex "dnsdb lookup"
6810 .cindex "lookup" "dnsdb"
6811 .cindex "DNS" "as a lookup type"
6812 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6813 of a record type and a domain name, separated by an equals sign. For example,
6814 an expansion string could contain:
6815 .code
6816 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6817 .endd
6818 If the lookup succeeds, the result is placed in &$value$&, which in this case
6819 is used on its own as the result. If the lookup does not succeed, the
6820 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6821 &<<SECTforexpfai>>& for an explanation of what this means.
6822
6823 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6824 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6825 configured). If no type is given, TXT is assumed. When the type is PTR,
6826 the data can be an IP address, written as normal; inversion and the addition of
6827 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6828 .code
6829 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6830 .endd
6831 If the data for a PTR record is not a syntactically valid IP address, it is not
6832 altered and nothing is added.
6833
6834 .cindex "MX record" "in &(dnsdb)& lookup"
6835 .cindex "SRV record" "in &(dnsdb)& lookup"
6836 For an MX lookup, both the preference value and the host name are returned for
6837 each record, separated by a space. For an SRV lookup, the priority, weight,
6838 port, and host name are returned for each record, separated by spaces.
6839
6840 For any record type, if multiple records are found (or, for A6 lookups, if a
6841 single record leads to multiple addresses), the data is returned as a
6842 concatenation, with newline as the default separator. The order, of course,
6843 depends on the DNS resolver. You can specify a different separator character
6844 between multiple records by putting a right angle-bracket followed immediately
6845 by the new separator at the start of the query. For example:
6846 .code
6847 ${lookup dnsdb{>: a=host1.example}}
6848 .endd
6849 It is permitted to specify a space as the separator character. Further
6850 white space is ignored.
6851
6852 .cindex "TXT record" "in &(dnsdb)& lookup"
6853 .cindex "SPF record" "in &(dnsdb)& lookup"
6854 For TXT records with multiple items of data, only the first item is returned,
6855 unless a separator for them is specified using a comma after the separator
6856 character followed immediately by the TXT record item separator. To concatenate
6857 items without a separator, use a semicolon instead. For SPF records the
6858 default behaviour is to concatenate multiple items without using a separator.
6859 .code
6860 ${lookup dnsdb{>\n,: txt=a.b.example}}
6861 ${lookup dnsdb{>\n; txt=a.b.example}}
6862 ${lookup dnsdb{spf=example.org}}
6863 .endd
6864 It is permitted to specify a space as the separator character. Further
6865 white space is ignored.
6866
6867 .section "Pseudo dnsdb record types" "SECID66"
6868 .cindex "MX record" "in &(dnsdb)& lookup"
6869 By default, both the preference value and the host name are returned for
6870 each MX record, separated by a space. If you want only host names, you can use
6871 the pseudo-type MXH:
6872 .code
6873 ${lookup dnsdb{mxh=a.b.example}}
6874 .endd
6875 In this case, the preference values are omitted, and just the host names are
6876 returned.
6877
6878 .cindex "name server for enclosing domain"
6879 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6880 records on the given domain, but if none are found, it removes the first
6881 component of the domain name, and tries again. This process continues until NS
6882 records are found or there are no more components left (or there is a DNS
6883 error). In other words, it may return the name servers for a top-level domain,
6884 but it never returns the root name servers. If there are no NS records for the
6885 top-level domain, the lookup fails. Consider these examples:
6886 .code
6887 ${lookup dnsdb{zns=xxx.quercite.com}}
6888 ${lookup dnsdb{zns=xxx.edu}}
6889 .endd
6890 Assuming that in each case there are no NS records for the full domain name,
6891 the first returns the name servers for &%quercite.com%&, and the second returns
6892 the name servers for &%edu%&.
6893
6894 You should be careful about how you use this lookup because, unless the
6895 top-level domain does not exist, the lookup always returns some host names. The
6896 sort of use to which this might be put is for seeing if the name servers for a
6897 given domain are on a blacklist. You can probably assume that the name servers
6898 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6899 such a list.
6900
6901 .cindex "CSA" "in &(dnsdb)& lookup"
6902 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6903 records according to the CSA rules, which are described in section
6904 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6905 not sufficient because of the extra parent domain search behaviour of CSA. The
6906 result of a successful lookup such as:
6907 .code
6908 ${lookup dnsdb {csa=$sender_helo_name}}
6909 .endd
6910 has two space-separated fields: an authorization code and a target host name.
6911 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6912 authorization required but absent, or &"?"& for unknown.
6913
6914
6915 .section "Multiple dnsdb lookups" "SECID67"
6916 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6917 However, you can specify a list of domains or IP addresses in a single
6918 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6919 the default separator, but with the ability to change this. For example:
6920 .code
6921 ${lookup dnsdb{one.domain.com:two.domain.com}}
6922 ${lookup dnsdb{a=one.host.com:two.host.com}}
6923 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6924 .endd
6925 In order to retain backwards compatibility, there is one special case: if
6926 the lookup type is PTR and no change of separator is specified, Exim looks
6927 to see if the rest of the string is precisely one IPv6 address. In this
6928 case, it does not treat it as a list.
6929
6930 The data from each lookup is concatenated, with newline separators by default,
6931 in the same way that multiple DNS records for a single item are handled. A
6932 different separator can be specified, as described above.
6933
6934 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6935 temporary DNS error for any of them, the behaviour is controlled by
6936 an optional keyword followed by a comma that may appear before the record
6937 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6938 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6939 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6940 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6941 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6942 error causes the whole lookup to defer only if none of the other lookups
6943 succeed. The default is &"lax"&, so the following lookups are equivalent:
6944 .code
6945 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6946 ${lookup dnsdb{a=one.host.com:two.host.com}}
6947 .endd
6948 Thus, in the default case, as long as at least one of the DNS lookups
6949 yields some data, the lookup succeeds.
6950
6951
6952
6953
6954 .section "More about LDAP" "SECTldap"
6955 .cindex "LDAP" "lookup, more about"
6956 .cindex "lookup" "LDAP"
6957 .cindex "Solaris" "LDAP"
6958 The original LDAP implementation came from the University of Michigan; this has
6959 become &"Open LDAP"&, and there are now two different releases. Another
6960 implementation comes from Netscape, and Solaris 7 and subsequent releases
6961 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6962 the lookup function level, their error handling is different. For this reason
6963 it is necessary to set a compile-time variable when building Exim with LDAP, to
6964 indicate which LDAP library is in use. One of the following should appear in
6965 your &_Local/Makefile_&:
6966 .code
6967 LDAP_LIB_TYPE=UMICHIGAN
6968 LDAP_LIB_TYPE=OPENLDAP1
6969 LDAP_LIB_TYPE=OPENLDAP2
6970 LDAP_LIB_TYPE=NETSCAPE
6971 LDAP_LIB_TYPE=SOLARIS
6972 .endd
6973 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6974 same interface as the University of Michigan version.
6975
6976 There are three LDAP lookup types in Exim. These behave slightly differently in
6977 the way they handle the results of a query:
6978
6979 .ilist
6980 &(ldap)& requires the result to contain just one entry; if there are more, it
6981 gives an error.
6982 .next
6983 &(ldapdn)& also requires the result to contain just one entry, but it is the
6984 Distinguished Name that is returned rather than any attribute values.
6985 .next
6986 &(ldapm)& permits the result to contain more than one entry; the attributes
6987 from all of them are returned.
6988 .endlist
6989
6990
6991 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6992 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6993 the data returned by a successful lookup is described in the next section.
6994 First we explain how LDAP queries are coded.
6995
6996
6997 .section "Format of LDAP queries" "SECTforldaque"
6998 .cindex "LDAP" "query format"
6999 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7000 the configuration of a &(redirect)& router one might have this setting:
7001 .code
7002 data = ${lookup ldap \
7003   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7004   c=UK?mailbox?base?}}
7005 .endd
7006 .cindex "LDAP" "with TLS"
7007 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7008 secure (encrypted) LDAP connections. The second of these ensures that an
7009 encrypted TLS connection is used.
7010
7011 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7012 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7013 See the &%ldap_start_tls%& option.
7014
7015
7016 .section "LDAP quoting" "SECID68"
7017 .cindex "LDAP" "quoting"
7018 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7019 and the second because the LDAP query is represented as a URL. Furthermore,
7020 within an LDAP query, two different kinds of quoting are required. For this
7021 reason, there are two different LDAP-specific quoting operators.
7022
7023 The &%quote_ldap%& operator is designed for use on strings that are part of
7024 filter specifications. Conceptually, it first does the following conversions on
7025 the string:
7026 .code
7027 *   =>   \2A
7028 (   =>   \28
7029 )   =>   \29
7030 \   =>   \5C
7031 .endd
7032 in accordance with RFC 2254. The resulting string is then quoted according
7033 to the rules for URLs, that is, all non-alphanumeric characters except
7034 .code
7035 ! $ ' - . _ ( ) * +
7036 .endd
7037 are converted to their hex values, preceded by a percent sign. For example:
7038 .code
7039 ${quote_ldap: a(bc)*, a<yz>; }
7040 .endd
7041 yields
7042 .code
7043 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7044 .endd
7045 Removing the URL quoting, this is (with a leading and a trailing space):
7046 .code
7047 a\28bc\29\2A, a<yz>;
7048 .endd
7049 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7050 base DN specifications in queries. Conceptually, it first converts the string
7051 by inserting a backslash in front of any of the following characters:
7052 .code
7053 , + " \ < > ;
7054 .endd
7055 It also inserts a backslash before any leading spaces or # characters, and
7056 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7057 is then quoted according to the rules for URLs. For example:
7058 .code
7059 ${quote_ldap_dn: a(bc)*, a<yz>; }
7060 .endd
7061 yields
7062 .code
7063 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7064 .endd
7065 Removing the URL quoting, this is (with a trailing space):
7066 .code
7067 \ a(bc)*\, a\<yz\>\;\
7068 .endd
7069 There are some further comments about quoting in the section on LDAP
7070 authentication below.
7071
7072
7073 .section "LDAP connections" "SECID69"
7074 .cindex "LDAP" "connections"
7075 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7076 is in use, via a Unix domain socket. The example given above does not specify
7077 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7078 by starting it with
7079 .code
7080 ldap://<hostname>:<port>/...
7081 .endd
7082 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7083 used. When no server is specified in a query, a list of default servers is
7084 taken from the &%ldap_default_servers%& configuration option. This supplies a
7085 colon-separated list of servers which are tried in turn until one successfully
7086 handles a query, or there is a serious error. Successful handling either
7087 returns the requested data, or indicates that it does not exist. Serious errors
7088 are syntactical, or multiple values when only a single value is expected.
7089 Errors which cause the next server to be tried are connection failures, bind
7090 failures, and timeouts.
7091
7092 For each server name in the list, a port number can be given. The standard way
7093 of specifying a host and port is to use a colon separator (RFC 1738). Because
7094 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7095 doubled. For example
7096 .code
7097 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7098 .endd
7099 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7100 to the LDAP library with no server name, and the library's default (normally
7101 the local host) is used.
7102
7103 If you are using the OpenLDAP library, you can connect to an LDAP server using
7104 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7105 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7106 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7107 not available.
7108
7109 For this type of connection, instead of a host name for the server, a pathname
7110 for the socket is required, and the port number is not relevant. The pathname
7111 can be specified either as an item in &%ldap_default_servers%&, or inline in
7112 the query. In the former case, you can have settings such as
7113 .code
7114 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7115 .endd
7116 When the pathname is given in the query, you have to escape the slashes as
7117 &`%2F`& to fit in with the LDAP URL syntax. For example:
7118 .code
7119 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7120 .endd
7121 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7122 a pathname, it uses the Unix domain socket code, even if the query actually
7123 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7124 socket connection. This behaviour means that you can use a setting of
7125 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7126 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7127 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7128 backup host.
7129
7130 If an explicit &`ldapi`& type is given in a query when a host name is
7131 specified, an error is diagnosed. However, if there are more items in
7132 &%ldap_default_servers%&, they are tried. In other words:
7133
7134 .ilist
7135 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7136 interface.
7137 .next
7138 Using &`ldapi`& with a host name causes an error.
7139 .endlist
7140
7141
7142 Using &`ldapi`& with no host or path in the query, and no setting of
7143 &%ldap_default_servers%&, does whatever the library does by default.
7144
7145
7146
7147 .section "LDAP authentication and control information" "SECID70"
7148 .cindex "LDAP" "authentication"
7149 The LDAP URL syntax provides no way of passing authentication and other control
7150 information to the server. To make this possible, the URL in an LDAP query may
7151 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7152 spaces. If a value contains spaces it must be enclosed in double quotes, and
7153 when double quotes are used, backslash is interpreted in the usual way inside
7154 them. The following names are recognized:
7155 .display
7156 &`DEREFERENCE`&  set the dereferencing parameter
7157 &`NETTIME    `&  set a timeout for a network operation
7158 &`USER       `&  set the DN, for authenticating the LDAP bind
7159 &`PASS       `&  set the password, likewise
7160 &`REFERRALS  `&  set the referrals parameter
7161 &`SIZE       `&  set the limit for the number of entries returned
7162 &`TIME       `&  set the maximum waiting time for a query
7163 .endd
7164 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7165 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7166 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7167 library from trying to follow referrals issued by the LDAP server.
7168
7169 The name CONNECT is an obsolete name for NETTIME, retained for
7170 backwards compatibility. This timeout (specified as a number of seconds) is
7171 enforced from the client end for operations that can be carried out over a
7172 network. Specifically, it applies to network connections and calls to the
7173 &'ldap_result()'& function. If the value is greater than zero, it is used if
7174 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7175 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7176 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7177 Netscape SDK; for OpenLDAP no action is taken.
7178
7179 The TIME parameter (also a number of seconds) is passed to the server to
7180 set a server-side limit on the time taken to complete a search.
7181
7182
7183 Here is an example of an LDAP query in an Exim lookup that uses some of these
7184 values. This is a single line, folded to fit on the page:
7185 .code
7186 ${lookup ldap
7187   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7188   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7189   {$value}fail}
7190 .endd
7191 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7192 any of the auxiliary data. Exim configuration settings that include lookups
7193 which contain password information should be preceded by &"hide"& to prevent
7194 non-admin users from using the &%-bP%& option to see their values.
7195
7196 The auxiliary data items may be given in any order. The default is no
7197 connection timeout (the system timeout is used), no user or password, no limit
7198 on the number of entries returned, and no time limit on queries.
7199
7200 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7201 removes any URL quoting that it may contain before passing it LDAP. Apparently
7202 some libraries do this for themselves, but some do not. Removing the URL
7203 quoting has two advantages:
7204
7205 .ilist
7206 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7207 DNs as with DNs inside actual queries.
7208 .next
7209 It permits spaces inside USER= DNs.
7210 .endlist
7211
7212 For example, a setting such as
7213 .code
7214 USER=cn=${quote_ldap_dn:$1}
7215 .endd
7216 should work even if &$1$& contains spaces.
7217
7218 Expanded data for the PASS= value should be quoted using the &%quote%&
7219 expansion operator, rather than the LDAP quote operators. The only reason this
7220 field needs quoting is to ensure that it conforms to the Exim syntax, which
7221 does not allow unquoted spaces. For example:
7222 .code
7223 PASS=${quote:$3}
7224 .endd
7225 The LDAP authentication mechanism can be used to check passwords as part of
7226 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7227 &<<CHAPexpand>>&.
7228
7229
7230
7231 .section "Format of data returned by LDAP" "SECID71"
7232 .cindex "LDAP" "returned data formats"
7233 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7234 as a sequence of values, for example
7235 .code
7236 cn=manager, o=University of Cambridge, c=UK
7237 .endd
7238 The &(ldap)& lookup type generates an error if more than one entry matches the
7239 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7240 the result between the data from different entries. It is possible for multiple
7241 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7242 you know that whatever values are returned all came from a single entry in the
7243 directory.
7244
7245 In the common case where you specify a single attribute in your LDAP query, the
7246 result is not quoted, and does not contain the attribute name. If the attribute
7247 has multiple values, they are separated by commas.
7248
7249 If you specify multiple attributes, the result contains space-separated, quoted
7250 strings, each preceded by the attribute name and an equals sign. Within the
7251 quotes, the quote character, backslash, and newline are escaped with
7252 backslashes, and commas are used to separate multiple values for the attribute.
7253 Apart from the escaping, the string within quotes takes the same form as the
7254 output when a single attribute is requested. Specifying no attributes is the
7255 same as specifying all of an entry's attributes.
7256
7257 Here are some examples of the output format. The first line of each pair is an
7258 LDAP query, and the second is the data that is returned. The attribute called
7259 &%attr1%& has two values, whereas &%attr2%& has only one value:
7260 .code
7261 ldap:///o=base?attr1?sub?(uid=fred)
7262 value1.1, value1.2
7263
7264 ldap:///o=base?attr2?sub?(uid=fred)
7265 value two
7266
7267 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7268 attr1="value1.1, value1.2" attr2="value two"
7269
7270 ldap:///o=base??sub?(uid=fred)
7271 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7272 .endd
7273 The &%extract%& operator in string expansions can be used to pick out
7274 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7275 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7276 results of LDAP lookups.
7277
7278
7279
7280
7281 .section "More about NIS+" "SECTnisplus"
7282 .cindex "NIS+ lookup type"
7283 .cindex "lookup" "NIS+"
7284 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7285 and field name. If this is given, the result of a successful query is the
7286 contents of the named field; otherwise the result consists of a concatenation
7287 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7288 values containing spaces are quoted. For example, the query
7289 .code
7290 [name=mg1456],passwd.org_dir
7291 .endd
7292 might return the string
7293 .code
7294 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7295 home=/home/mg1456 shell=/bin/bash shadow=""
7296 .endd
7297 (split over two lines here to fit on the page), whereas
7298 .code
7299 [name=mg1456],passwd.org_dir:gcos
7300 .endd
7301 would just return
7302 .code
7303 Martin Guerre
7304 .endd
7305 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7306 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7307 operator is to double any quote characters within the text.
7308
7309
7310
7311 .section "SQL lookups" "SECTsql"
7312 .cindex "SQL lookup types"
7313 .cindex "MySQL" "lookup type"
7314 .cindex "PostgreSQL lookup type"
7315 .cindex "lookup" "MySQL"
7316 .cindex "lookup" "PostgreSQL"
7317 .cindex "Oracle" "lookup type"
7318 .cindex "lookup" "Oracle"
7319 .cindex "InterBase lookup type"
7320 .cindex "lookup" "InterBase"
7321 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7322 databases. Queries for these databases contain SQL statements, so an example
7323 might be
7324 .code
7325 ${lookup mysql{select mailbox from users where id='userx'}\
7326   {$value}fail}
7327 .endd
7328 If the result of the query contains more than one field, the data for each
7329 field in the row is returned, preceded by its name, so the result of
7330 .code
7331 ${lookup pgsql{select home,name from users where id='userx'}\
7332   {$value}}
7333 .endd
7334 might be
7335 .code
7336 home=/home/userx name="Mister X"
7337 .endd
7338 Empty values and values containing spaces are double quoted, with embedded
7339 quotes escaped by a backslash. If the result of the query contains just one
7340 field, the value is passed back verbatim, without a field name, for example:
7341 .code
7342 Mister X
7343 .endd
7344 If the result of the query yields more than one row, it is all concatenated,
7345 with a newline between the data for each row.
7346
7347
7348 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7349 .cindex "MySQL" "lookup type"
7350 .cindex "PostgreSQL lookup type"
7351 .cindex "lookup" "MySQL"
7352 .cindex "lookup" "PostgreSQL"
7353 .cindex "Oracle" "lookup type"
7354 .cindex "lookup" "Oracle"
7355 .cindex "InterBase lookup type"
7356 .cindex "lookup" "InterBase"
7357 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7358 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7359 option (as appropriate) must be set to a colon-separated list of server
7360 information.
7361 (For MySQL and PostgreSQL only, the global option need not be set if all
7362 queries contain their own server information &-- see section
7363 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7364 items: host name, database name, user name, and password. In the case of
7365 Oracle, the host name field is used for the &"service name"&, and the database
7366 name field is not used and should be empty. For example:
7367 .code
7368 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7369 .endd
7370 Because password data is sensitive, you should always precede the setting with
7371 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7372 option. Here is an example where two MySQL servers are listed:
7373 .code
7374 hide mysql_servers = localhost/users/root/secret:\
7375                      otherhost/users/root/othersecret
7376 .endd
7377 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7378 because this is a colon-separated list, the colon has to be doubled. For each
7379 query, these parameter groups are tried in order until a connection is made and
7380 a query is successfully processed. The result of a query may be that no data is
7381 found, but that is still a successful query. In other words, the list of
7382 servers provides a backup facility, not a list of different places to look.
7383
7384 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7385 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7386 respectively, and the characters single-quote, double-quote, and backslash
7387 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7388 addition, escapes the percent and underscore characters. This cannot be done
7389 for MySQL because these escapes are not recognized in contexts where these
7390 characters are not special.
7391
7392 .section "Specifying the server in the query" "SECTspeserque"
7393 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7394 it is possible to specify a list of servers with an individual query. This is
7395 done by starting the query with
7396 .display
7397 &`servers=`&&'server1:server2:server3:...'&&`;`&
7398 .endd
7399 Each item in the list may take one of two forms:
7400 .olist
7401 If it contains no slashes it is assumed to be just a host name. The appropriate
7402 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7403 of the same name, and the remaining parameters (database, user, password) are
7404 taken from there.
7405 .next
7406 If it contains any slashes, it is taken as a complete parameter set.
7407 .endlist
7408 The list of servers is used in exactly the same way as the global list.
7409 Once a connection to a server has happened and a query has been
7410 successfully executed, processing of the lookup ceases.
7411
7412 This feature is intended for use in master/slave situations where updates
7413 are occurring and you want to update the master rather than a slave. If the
7414 master is in the list as a backup for reading, you might have a global setting
7415 like this:
7416 .code
7417 mysql_servers = slave1/db/name/pw:\
7418                 slave2/db/name/pw:\
7419                 master/db/name/pw
7420 .endd
7421 In an updating lookup, you could then write:
7422 .code
7423 ${lookup mysql{servers=master; UPDATE ...} }
7424 .endd
7425 That query would then be sent only to the master server. If, on the other hand,
7426 the master is not to be used for reading, and so is not present in the global
7427 option, you can still update it by a query of this form:
7428 .code
7429 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7430 .endd
7431
7432
7433 .section "Special MySQL features" "SECID73"
7434 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7435 causes a connection to the server on the local host by means of a Unix domain
7436 socket. An alternate socket can be specified in parentheses. The full syntax of
7437 each item in &%mysql_servers%& is:
7438 .display
7439 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7440   <&'user'&>/<&'password'&>
7441 .endd
7442 Any of the three sub-parts of the first field can be omitted. For normal use on
7443 the local host it can be left blank or set to just &"localhost"&.
7444
7445 No database need be supplied &-- but if it is absent here, it must be given in
7446 the queries.
7447
7448 If a MySQL query is issued that does not request any data (an insert, update,
7449 or delete command), the result of the lookup is the number of rows affected.
7450
7451 &*Warning*&: This can be misleading. If an update does not actually change
7452 anything (for example, setting a field to the value it already has), the result
7453 is zero because no rows are affected.
7454
7455
7456 .section "Special PostgreSQL features" "SECID74"
7457 PostgreSQL lookups can also use Unix domain socket connections to the database.
7458 This is usually faster and costs less CPU time than a TCP/IP connection.
7459 However it can be used only if the mail server runs on the same machine as the
7460 database server. A configuration line for PostgreSQL via Unix domain sockets
7461 looks like this:
7462 .code
7463 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7464 .endd
7465 In other words, instead of supplying a host name, a path to the socket is
7466 given. The path name is enclosed in parentheses so that its slashes aren't
7467 visually confused with the delimiters for the other server parameters.
7468
7469 If a PostgreSQL query is issued that does not request any data (an insert,
7470 update, or delete command), the result of the lookup is the number of rows
7471 affected.
7472
7473 .section "More about SQLite" "SECTsqlite"
7474 .cindex "lookup" "SQLite"
7475 .cindex "sqlite lookup type"
7476 SQLite is different to the other SQL lookups because a file name is required in
7477 addition to the SQL query. An SQLite database is a single file, and there is no
7478 daemon as in the other SQL databases. The interface to Exim requires the name
7479 of the file, as an absolute path, to be given at the start of the query. It is
7480 separated from the query by white space. This means that the path name cannot
7481 contain white space. Here is a lookup expansion example:
7482 .code
7483 ${lookup sqlite {/some/thing/sqlitedb \
7484   select name from aliases where id='userx';}}
7485 .endd
7486 In a list, the syntax is similar. For example:
7487 .code
7488 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7489    select * from relays where ip='$sender_host_address';
7490 .endd
7491 The only character affected by the &%quote_sqlite%& operator is a single
7492 quote, which it doubles.
7493
7494 The SQLite library handles multiple simultaneous accesses to the database
7495 internally. Multiple readers are permitted, but only one process can
7496 update at once. Attempts to access the database while it is being updated
7497 are rejected after a timeout period, during which the SQLite library
7498 waits for the lock to be released. In Exim, the default timeout is set
7499 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7500 option.
7501 .ecindex IIDfidalo1
7502 .ecindex IIDfidalo2
7503
7504
7505 . ////////////////////////////////////////////////////////////////////////////
7506 . ////////////////////////////////////////////////////////////////////////////
7507
7508 .chapter "Domain, host, address, and local part lists" &&&
7509          "CHAPdomhosaddlists" &&&
7510          "Domain, host, and address lists"
7511 .scindex IIDdohoadli "lists of domains; hosts; etc."
7512 A number of Exim configuration options contain lists of domains, hosts,
7513 email addresses, or local parts. For example, the &%hold_domains%& option
7514 contains a list of domains whose delivery is currently suspended. These lists
7515 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7516 arguments to expansion conditions such as &%match_domain%&.
7517
7518 Each item in one of these lists is a pattern to be matched against a domain,
7519 host, email address, or local part, respectively. In the sections below, the
7520 different types of pattern for each case are described, but first we cover some
7521 general facilities that apply to all four kinds of list.
7522
7523
7524
7525 .section "Expansion of lists" "SECID75"
7526 .cindex "expansion" "of lists"
7527 Each list is expanded as a single string before it is used. The result of
7528 expansion must be a list, possibly containing empty items, which is split up
7529 into separate items for matching. By default, colon is the separator character,
7530 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7531 &<<SECTempitelis>>& for details of the list syntax; the second of these
7532 discusses the way to specify empty list items.
7533
7534
7535 If the string expansion is forced to fail, Exim behaves as if the item it is
7536 testing (domain, host, address, or local part) is not in the list. Other
7537 expansion failures cause temporary errors.
7538
7539 If an item in a list is a regular expression, backslashes, dollars and possibly
7540 other special characters in the expression must be protected against
7541 misinterpretation by the string expander. The easiest way to do this is to use
7542 the &`\N`& expansion feature to indicate that the contents of the regular
7543 expression should not be expanded. For example, in an ACL you might have:
7544 .code
7545 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7546                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7547 .endd
7548 The first item is a regular expression that is protected from expansion by
7549 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7550 senders based on the receiving domain.
7551
7552
7553
7554
7555 .section "Negated items in lists" "SECID76"
7556 .cindex "list" "negation"
7557 .cindex "negation" "in lists"
7558 Items in a list may be positive or negative. Negative items are indicated by a
7559 leading exclamation mark, which may be followed by optional white space. A list
7560 defines a set of items (domains, etc). When Exim processes one of these lists,
7561 it is trying to find out whether a domain, host, address, or local part
7562 (respectively) is in the set that is defined by the list. It works like this:
7563
7564 The list is scanned from left to right. If a positive item is matched, the
7565 subject that is being checked is in the set; if a negative item is matched, the
7566 subject is not in the set. If the end of the list is reached without the
7567 subject having matched any of the patterns, it is in the set if the last item
7568 was a negative one, but not if it was a positive one. For example, the list in
7569 .code
7570 domainlist relay_to_domains = !a.b.c : *.b.c
7571 .endd
7572 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7573 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7574 list is positive. However, if the setting were
7575 .code
7576 domainlist relay_to_domains = !a.b.c
7577 .endd
7578 then all domains other than &'a.b.c'& would match because the last item in the
7579 list is negative. In other words, a list that ends with a negative item behaves
7580 as if it had an extra item &`:*`& on the end.
7581
7582 Another way of thinking about positive and negative items in lists is to read
7583 the connector as &"or"& after a positive item and as &"and"& after a negative
7584 item.
7585
7586
7587
7588 .section "File names in lists" "SECTfilnamlis"
7589 .cindex "list" "file name in"
7590 If an item in a domain, host, address, or local part list is an absolute file
7591 name (beginning with a slash character), each line of the file is read and
7592 processed as if it were an independent item in the list, except that further
7593 file names are not allowed,
7594 and no expansion of the data from the file takes place.
7595 Empty lines in the file are ignored, and the file may also contain comment
7596 lines:
7597
7598 .ilist
7599 For domain and host lists, if a # character appears anywhere in a line of the
7600 file, it and all following characters are ignored.
7601 .next
7602 Because local parts may legitimately contain # characters, a comment in an
7603 address list or local part list file is recognized only if # is preceded by
7604 white space or the start of the line. For example:
7605 .code
7606 not#comment@x.y.z   # but this is a comment
7607 .endd
7608 .endlist
7609
7610 Putting a file name in a list has the same effect as inserting each line of the
7611 file as an item in the list (blank lines and comments excepted). However, there
7612 is one important difference: the file is read each time the list is processed,
7613 so if its contents vary over time, Exim's behaviour changes.
7614
7615 If a file name is preceded by an exclamation mark, the sense of any match
7616 within the file is inverted. For example, if
7617 .code
7618 hold_domains = !/etc/nohold-domains
7619 .endd
7620 and the file contains the lines
7621 .code
7622 !a.b.c
7623 *.b.c
7624 .endd
7625 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7626 any domain matching &`*.b.c`& is not.
7627
7628
7629
7630 .section "An lsearch file is not an out-of-line list" "SECID77"
7631 As will be described in the sections that follow, lookups can be used in lists
7632 to provide indexed methods of checking list membership. There has been some
7633 confusion about the way &(lsearch)& lookups work in lists. Because
7634 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7635 sometimes thought that it is allowed to contain wild cards and other kinds of
7636 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7637 always fixed strings, just as for any other single-key lookup type.
7638
7639 If you want to use a file to contain wild-card patterns that form part of a
7640 list, just give the file name on its own, without a search type, as described
7641 in the previous section. You could also use the &(wildlsearch)& or
7642 &(nwildlsearch)&, but there is no advantage in doing this.
7643
7644
7645
7646
7647 .section "Named lists" "SECTnamedlists"
7648 .cindex "named lists"
7649 .cindex "list" "named"
7650 A list of domains, hosts, email addresses, or local parts can be given a name
7651 which is then used to refer to the list elsewhere in the configuration. This is
7652 particularly convenient if the same list is required in several different
7653 places. It also allows lists to be given meaningful names, which can improve
7654 the readability of the configuration. For example, it is conventional to define
7655 a domain list called &'local_domains'& for all the domains that are handled
7656 locally on a host, using a configuration line such as
7657 .code
7658 domainlist local_domains = localhost:my.dom.example
7659 .endd
7660 Named lists are referenced by giving their name preceded by a plus sign, so,
7661 for example, a router that is intended to handle local domains would be
7662 configured with the line
7663 .code
7664 domains = +local_domains
7665 .endd
7666 The first router in a configuration is often one that handles all domains
7667 except the local ones, using a configuration with a negated item like this:
7668 .code
7669 dnslookup:
7670   driver = dnslookup
7671   domains = ! +local_domains
7672   transport = remote_smtp
7673   no_more
7674 .endd
7675 The four kinds of named list are created by configuration lines starting with
7676 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7677 respectively. Then there follows the name that you are defining, followed by an
7678 equals sign and the list itself. For example:
7679 .code
7680 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7681 addresslist bad_senders = cdb;/etc/badsenders
7682 .endd
7683 A named list may refer to other named lists:
7684 .code
7685 domainlist  dom1 = first.example : second.example
7686 domainlist  dom2 = +dom1 : third.example
7687 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7688 .endd
7689 &*Warning*&: If the last item in a referenced list is a negative one, the
7690 effect may not be what you intended, because the negation does not propagate
7691 out to the higher level. For example, consider:
7692 .code
7693 domainlist  dom1 = !a.b
7694 domainlist  dom2 = +dom1 : *.b
7695 .endd
7696 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7697 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7698 means it matches the second list as well. The effect is not the same as
7699 .code
7700 domainlist  dom2 = !a.b : *.b
7701 .endd
7702 where &'x.y'& does not match. It's best to avoid negation altogether in
7703 referenced lists if you can.
7704
7705 Named lists may have a performance advantage. When Exim is routing an
7706 address or checking an incoming message, it caches the result of tests on named
7707 lists. So, if you have a setting such as
7708 .code
7709 domains = +local_domains
7710 .endd
7711 on several of your routers
7712 or in several ACL statements,
7713 the actual test is done only for the first one. However, the caching works only
7714 if there are no expansions within the list itself or any sublists that it
7715 references. In other words, caching happens only for lists that are known to be
7716 the same each time they are referenced.
7717
7718 By default, there may be up to 16 named lists of each type. This limit can be
7719 extended by changing a compile-time variable. The use of domain and host lists
7720 is recommended for concepts such as local domains, relay domains, and relay
7721 hosts. The default configuration is set up like this.
7722
7723
7724
7725 .section "Named lists compared with macros" "SECID78"
7726 .cindex "list" "named compared with macro"
7727 .cindex "macro" "compared with named list"
7728 At first sight, named lists might seem to be no different from macros in the
7729 configuration file. However, macros are just textual substitutions. If you
7730 write
7731 .code
7732 ALIST = host1 : host2
7733 auth_advertise_hosts = !ALIST
7734 .endd
7735 it probably won't do what you want, because that is exactly the same as
7736 .code
7737 auth_advertise_hosts = !host1 : host2
7738 .endd
7739 Notice that the second host name is not negated. However, if you use a host
7740 list, and write
7741 .code
7742 hostlist alist = host1 : host2
7743 auth_advertise_hosts = ! +alist
7744 .endd
7745 the negation applies to the whole list, and so that is equivalent to
7746 .code
7747 auth_advertise_hosts = !host1 : !host2
7748 .endd
7749
7750
7751 .section "Named list caching" "SECID79"
7752 .cindex "list" "caching of named"
7753 .cindex "caching" "named lists"
7754 While processing a message, Exim caches the result of checking a named list if
7755 it is sure that the list is the same each time. In practice, this means that
7756 the cache operates only if the list contains no $ characters, which guarantees
7757 that it will not change when it is expanded. Sometimes, however, you may have
7758 an expanded list that you know will be the same each time within a given
7759 message. For example:
7760 .code
7761 domainlist special_domains = \
7762            ${lookup{$sender_host_address}cdb{/some/file}}
7763 .endd
7764 This provides a list of domains that depends only on the sending host's IP
7765 address. If this domain list is referenced a number of times (for example,
7766 in several ACL lines, or in several routers) the result of the check is not
7767 cached by default, because Exim does not know that it is going to be the
7768 same list each time.
7769
7770 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7771 cache the result anyway. For example:
7772 .code
7773 domainlist_cache special_domains = ${lookup{...
7774 .endd
7775 If you do this, you should be absolutely sure that caching is going to do
7776 the right thing in all cases. When in doubt, leave it out.
7777
7778
7779
7780 .section "Domain lists" "SECTdomainlist"
7781 .cindex "domain list" "patterns for"
7782 .cindex "list" "domain list"
7783 Domain lists contain patterns that are to be matched against a mail domain.
7784 The following types of item may appear in domain lists:
7785
7786 .ilist
7787 .cindex "primary host name"
7788 .cindex "host name" "matched in domain list"
7789 .oindex "&%primary_hostname%&"
7790 .cindex "domain list" "matching primary host name"
7791 .cindex "@ in a domain list"
7792 If a pattern consists of a single @ character, it matches the local host name,
7793 as set by the &%primary_hostname%& option (or defaulted). This makes it
7794 possible to use the same configuration file on several different hosts that
7795 differ only in their names.
7796 .next
7797 .cindex "@[] in a domain list"
7798 .cindex "domain list" "matching local IP interfaces"
7799 .cindex "domain literal"
7800 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7801 in square brackets (as in an email address that contains a domain literal), but
7802 only if that IP address is recognized as local for email routing purposes. The
7803 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7804 control which of a host's several IP addresses are treated as local.
7805 In today's Internet, the use of domain literals is controversial.
7806 .next
7807 .cindex "@mx_any"
7808 .cindex "@mx_primary"
7809 .cindex "@mx_secondary"
7810 .cindex "domain list" "matching MX pointers to local host"
7811 If a pattern consists of the string &`@mx_any`& it matches any domain that
7812 has an MX record pointing to the local host or to any host that is listed in
7813 .oindex "&%hosts_treat_as_local%&"
7814 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7815 are similar, except that the first matches only when a primary MX target is the
7816 local host, and the second only when no primary MX target is the local host,
7817 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7818 preference value &-- there may of course be more than one of them.
7819
7820 The MX lookup that takes place when matching a pattern of this type is
7821 performed with the resolver options for widening names turned off. Thus, for
7822 example, a single-component domain will &'not'& be expanded by adding the
7823 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7824 options of the &(dnslookup)& router for a discussion of domain widening.
7825
7826 Sometimes you may want to ignore certain IP addresses when using one of these
7827 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7828 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7829 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7830 on a router). For example:
7831 .code
7832 domains = @mx_any/ignore=127.0.0.1
7833 .endd
7834 This example matches any domain that has an MX record pointing to one of
7835 the local host's IP addresses other than 127.0.0.1.
7836
7837 The list of IP addresses is in fact processed by the same code that processes
7838 host lists, so it may contain CIDR-coded network specifications and it may also
7839 contain negative items.
7840
7841 Because the list of IP addresses is a sublist within a domain list, you have to
7842 be careful about delimiters if there is more than one address. Like any other
7843 list, the default delimiter can be changed. Thus, you might have:
7844 .code
7845 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7846           an.other.domain : ...
7847 .endd
7848 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7849 involved, it is easiest to change the delimiter for the main list as well:
7850 .code
7851 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7852           an.other.domain ? ...
7853 .endd
7854 .next
7855 .cindex "asterisk" "in domain list"
7856 .cindex "domain list" "asterisk in"
7857 .cindex "domain list" "matching &""ends with""&"
7858 If a pattern starts with an asterisk, the remaining characters of the pattern
7859 are compared with the terminating characters of the domain. The use of &"*"& in
7860 domain lists differs from its use in partial matching lookups. In a domain
7861 list, the character following the asterisk need not be a dot, whereas partial
7862 matching works only in terms of dot-separated components. For example, a domain
7863 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7864 &'cipher.key.ex'&.
7865
7866 .next
7867 .cindex "regular expressions" "in domain list"
7868 .cindex "domain list" "matching regular expression"
7869 If a pattern starts with a circumflex character, it is treated as a regular
7870 expression, and matched against the domain using a regular expression matching
7871 function. The circumflex is treated as part of the regular expression.
7872 Email domains are case-independent, so this regular expression match is by
7873 default case-independent, but you can make it case-dependent by starting it
7874 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7875 are given in chapter &<<CHAPregexp>>&.
7876
7877 &*Warning*&: Because domain lists are expanded before being processed, you
7878 must escape any backslash and dollar characters in the regular expression, or
7879 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7880 it is not to be expanded (unless you really do want to build a regular
7881 expression by expansion, of course).
7882 .next
7883 .cindex "lookup" "in domain list"
7884 .cindex "domain list" "matching by lookup"
7885 If a pattern starts with the name of a single-key lookup type followed by a
7886 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7887 must be a file name in a suitable format for the lookup type. For example, for
7888 &"cdb;"& it must be an absolute path:
7889 .code
7890 domains = cdb;/etc/mail/local_domains.cdb
7891 .endd
7892 The appropriate type of lookup is done on the file using the domain name as the
7893 key. In most cases, the data that is looked up is not used; Exim is interested
7894 only in whether or not the key is present in the file. However, when a lookup
7895 is used for the &%domains%& option on a router
7896 or a &%domains%& condition in an ACL statement, the data is preserved in the
7897 &$domain_data$& variable and can be referred to in other router options or
7898 other statements in the same ACL.
7899
7900 .next
7901 Any of the single-key lookup type names may be preceded by
7902 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7903 .code
7904 domains = partial-dbm;/partial/domains
7905 .endd
7906 This causes partial matching logic to be invoked; a description of how this
7907 works is given in section &<<SECTpartiallookup>>&.
7908
7909 .next
7910 .cindex "asterisk" "in lookup type"
7911 Any of the single-key lookup types may be followed by an asterisk. This causes
7912 a default lookup for a key consisting of a single asterisk to be done if the
7913 original lookup fails. This is not a useful feature when using a domain list to
7914 select particular domains (because any domain would match), but it might have
7915 value if the result of the lookup is being used via the &$domain_data$&
7916 expansion variable.
7917 .next
7918 If the pattern starts with the name of a query-style lookup type followed by a
7919 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7920 pattern must be an appropriate query for the lookup type, as described in
7921 chapter &<<CHAPfdlookup>>&. For example:
7922 .code
7923 hold_domains = mysql;select domain from holdlist \
7924   where domain = '${quote_mysql:$domain}';
7925 .endd
7926 In most cases, the data that is looked up is not used (so for an SQL query, for
7927 example, it doesn't matter what field you select). Exim is interested only in
7928 whether or not the query succeeds. However, when a lookup is used for the
7929 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7930 variable and can be referred to in other options.
7931 .next
7932 .cindex "domain list" "matching literal domain name"
7933 If none of the above cases apply, a caseless textual comparison is made
7934 between the pattern and the domain.
7935 .endlist
7936
7937 Here is an example that uses several different kinds of pattern:
7938 .code
7939 domainlist funny_domains = \
7940   @ : \
7941   lib.unseen.edu : \
7942   *.foundation.fict.example : \
7943   \N^[1-2]\d{3}\.fict\.example$\N : \
7944   partial-dbm;/opt/data/penguin/book : \
7945   nis;domains.byname : \
7946   nisplus;[name=$domain,status=local],domains.org_dir
7947 .endd
7948 There are obvious processing trade-offs among the various matching modes. Using
7949 an asterisk is faster than a regular expression, and listing a few names
7950 explicitly probably is too. The use of a file or database lookup is expensive,
7951 but may be the only option if hundreds of names are required. Because the
7952 patterns are tested in order, it makes sense to put the most commonly matched
7953 patterns earlier.
7954
7955
7956
7957 .section "Host lists" "SECThostlist"
7958 .cindex "host list" "patterns in"
7959 .cindex "list" "host list"
7960 Host lists are used to control what remote hosts are allowed to do. For
7961 example, some hosts may be allowed to use the local host as a relay, and some
7962 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7963 two different ways, by name or by IP address. In a host list, some types of
7964 pattern are matched to a host name, and some are matched to an IP address.
7965 You need to be particularly careful with this when single-key lookups are
7966 involved, to ensure that the right value is being used as the key.
7967
7968
7969 .section "Special host list patterns" "SECID80"
7970 .cindex "empty item in hosts list"
7971 .cindex "host list" "empty string in"
7972 If a host list item is the empty string, it matches only when no remote host is
7973 involved. This is the case when a message is being received from a local
7974 process using SMTP on the standard input, that is, when a TCP/IP connection is
7975 not used.
7976
7977 .cindex "asterisk" "in host list"
7978 The special pattern &"*"& in a host list matches any host or no host. Neither
7979 the IP address nor the name is actually inspected.
7980
7981
7982
7983 .section "Host list patterns that match by IP address" "SECThoslispatip"
7984 .cindex "host list" "matching IP addresses"
7985 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7986 the incoming address actually appears in the IPv6 host as
7987 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7988 list, it is converted into a traditional IPv4 address first. (Not all operating
7989 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7990 concerns.)
7991
7992 The following types of pattern in a host list check the remote host by
7993 inspecting its IP address:
7994
7995 .ilist
7996 If the pattern is a plain domain name (not a regular expression, not starting
7997 with *, not a lookup of any kind), Exim calls the operating system function
7998 to find the associated IP address(es). Exim uses the newer
7999 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8000 This typically causes a forward DNS lookup of the name. The result is compared
8001 with the IP address of the subject host.
8002
8003 If there is a temporary problem (such as a DNS timeout) with the host name
8004 lookup, a temporary error occurs. For example, if the list is being used in an
8005 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8006 temporary SMTP error code. If no IP address can be found for the host name,
8007 what happens is described in section &<<SECTbehipnot>>& below.
8008
8009 .next
8010 .cindex "@ in a host list"
8011 If the pattern is &"@"&, the primary host name is substituted and used as a
8012 domain name, as just described.
8013
8014 .next
8015 If the pattern is an IP address, it is matched against the IP address of the
8016 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8017 IPv6 addresses can be given in colon-separated format, but the colons have to
8018 be doubled so as not to be taken as item separators when the default list
8019 separator is used. IPv6 addresses are recognized even when Exim is compiled
8020 without IPv6 support. This means that if they appear in a host list on an
8021 IPv4-only host, Exim will not treat them as host names. They are just addresses
8022 that can never match a client host.
8023
8024 .next
8025 .cindex "@[] in a host list"
8026 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8027 the local host. For example, if the local host is an IPv4 host with one
8028 interface address 10.45.23.56, these two ACL statements have the same effect:
8029 .code
8030 accept hosts = 127.0.0.1 : 10.45.23.56
8031 accept hosts = @[]
8032 .endd
8033 .next
8034 .cindex "CIDR notation"
8035 If the pattern is an IP address followed by a slash and a mask length (for
8036 example 10.11.42.0/24), it is matched against the IP address of the subject
8037 host under the given mask. This allows, an entire network of hosts to be
8038 included (or excluded) by a single item. The mask uses CIDR notation; it
8039 specifies the number of address bits that must match, starting from the most
8040 significant end of the address.
8041
8042 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8043 of a range of addresses. It is the number of bits in the network portion of the
8044 address. The above example specifies a 24-bit netmask, so it matches all 256
8045 addresses in the 10.11.42.0 network. An item such as
8046 .code
8047 192.168.23.236/31
8048 .endd
8049 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8050 32 for an IPv4 address is the same as no mask at all; just a single address
8051 matches.
8052
8053 Here is another example which shows an IPv4 and an IPv6 network:
8054 .code
8055 recipient_unqualified_hosts = 192.168.0.0/16: \
8056                               3ffe::ffff::836f::::/48
8057 .endd
8058 The doubling of list separator characters applies only when these items
8059 appear inline in a host list. It is not required when indirecting via a file.
8060 For example:
8061 .code
8062 recipient_unqualified_hosts = /opt/exim/unqualnets
8063 .endd
8064 could make use of a file containing
8065 .code
8066 172.16.0.0/12
8067 3ffe:ffff:836f::/48
8068 .endd
8069 to have exactly the same effect as the previous example. When listing IPv6
8070 addresses inline, it is usually more convenient to use the facility for
8071 changing separator characters. This list contains the same two networks:
8072 .code
8073 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8074                                  3ffe:ffff:836f::/48
8075 .endd
8076 The separator is changed to semicolon by the leading &"<;"& at the start of the
8077 list.
8078 .endlist
8079
8080
8081
8082 .section "Host list patterns for single-key lookups by host address" &&&
8083          "SECThoslispatsikey"
8084 .cindex "host list" "lookup of IP address"
8085 When a host is to be identified by a single-key lookup of its complete IP
8086 address, the pattern takes this form:
8087 .display
8088 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8089 .endd
8090 For example:
8091 .code
8092 hosts_lookup = net-cdb;/hosts-by-ip.db
8093 .endd
8094 The text form of the IP address of the subject host is used as the lookup key.
8095 IPv6 addresses are converted to an unabbreviated form, using lower case
8096 letters, with dots as separators because colon is the key terminator in
8097 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8098 quoting the keys, but this is a facility that was added later.] The data
8099 returned by the lookup is not used.
8100
8101 .cindex "IP address" "masking"
8102 .cindex "host list" "masked IP address"
8103 Single-key lookups can also be performed using masked IP addresses, using
8104 patterns of this form:
8105 .display
8106 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8107 .endd
8108 For example:
8109 .code
8110 net24-dbm;/networks.db
8111 .endd
8112 The IP address of the subject host is masked using <&'number'&> as the mask
8113 length. A textual string is constructed from the masked value, followed by the
8114 mask, and this is used as the lookup key. For example, if the host's IP address
8115 is 192.168.34.6, the key that is looked up for the above example is
8116 &"192.168.34.0/24"&.
8117
8118 When an IPv6 address is converted to a string, dots are normally used instead
8119 of colons, so that keys in &(lsearch)& files need not contain colons (which
8120 terminate &(lsearch)& keys). This was implemented some time before the ability
8121 to quote keys was made available in &(lsearch)& files. However, the more
8122 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8123 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8124 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8125 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8126 addresses are always used.
8127
8128 Ideally, it would be nice to tidy up this anomalous situation by changing to
8129 colons in all cases, given that quoting is now available for &(lsearch)&.
8130 However, this would be an incompatible change that might break some existing
8131 configurations.
8132
8133 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8134 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8135 the former case the key strings include the mask value, whereas in the latter
8136 case the IP address is used on its own.
8137
8138
8139
8140 .section "Host list patterns that match by host name" "SECThoslispatnam"
8141 .cindex "host" "lookup failures"
8142 .cindex "unknown host name"
8143 .cindex "host list" "matching host name"
8144 There are several types of pattern that require Exim to know the name of the
8145 remote host. These are either wildcard patterns or lookups by name. (If a
8146 complete hostname is given without any wildcarding, it is used to find an IP
8147 address to match against, as described in the section &<<SECThoslispatip>>&
8148 above.)
8149
8150 If the remote host name is not already known when Exim encounters one of these
8151 patterns, it has to be found from the IP address.
8152 Although many sites on the Internet are conscientious about maintaining reverse
8153 DNS data for their hosts, there are also many that do not do this.
8154 Consequently, a name cannot always be found, and this may lead to unwanted
8155 effects. Take care when configuring host lists with wildcarded name patterns.
8156 Consider what will happen if a name cannot be found.
8157
8158 Because of the problems of determining host names from IP addresses, matching
8159 against host names is not as common as matching against IP addresses.
8160
8161 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8162 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8163 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8164 are done can be changed by setting the &%host_lookup_order%& option. For
8165 security, once Exim has found one or more names, it looks up the IP addresses
8166 for these names and compares them with the IP address that it started with.
8167 Only those names whose IP addresses match are accepted. Any other names are
8168 discarded. If no names are left, Exim behaves as if the host name cannot be
8169 found. In the most common case there is only one name and one IP address.
8170
8171 There are some options that control what happens if a host name cannot be
8172 found. These are described in section &<<SECTbehipnot>>& below.
8173
8174 .cindex "host" "alias for"
8175 .cindex "alias for host"
8176 As a result of aliasing, hosts may have more than one name. When processing any
8177 of the following types of pattern, all the host's names are checked:
8178
8179 .ilist
8180 .cindex "asterisk" "in host list"
8181 If a pattern starts with &"*"& the remainder of the item must match the end of
8182 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8183 &'.b.c'&. This special simple form is provided because this is a very common
8184 requirement. Other kinds of wildcarding require the use of a regular
8185 expression.
8186 .next
8187 .cindex "regular expressions" "in host list"
8188 .cindex "host list" "regular expression in"
8189 If the item starts with &"^"& it is taken to be a regular expression which is
8190 matched against the host name. Host names are case-independent, so this regular
8191 expression match is by default case-independent, but you can make it
8192 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8193 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8194 example,
8195 .code
8196 ^(a|b)\.c\.d$
8197 .endd
8198 is a regular expression that matches either of the two hosts &'a.c.d'& or
8199 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8200 that backslash and dollar characters are not misinterpreted as part of the
8201 string expansion. The simplest way to do this is to use &`\N`& to mark that
8202 part of the string as non-expandable. For example:
8203 .code
8204 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8205 .endd
8206 &*Warning*&: If you want to match a complete host name, you must include the
8207 &`$`& terminating metacharacter in the regular expression, as in the above
8208 example. Without it, a match at the start of the host name is all that is
8209 required.
8210 .endlist
8211
8212
8213
8214
8215 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8216 .cindex "host" "lookup failures, permanent"
8217 While processing a host list, Exim may need to look up an IP address from a
8218 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8219 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8220 behaviour when it fails to find the information it is seeking is the same.
8221
8222 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8223 apply to temporary DNS errors, whose handling is described in the next section.
8224
8225 .cindex "&`+include_unknown`&"
8226 .cindex "&`+ignore_unknown`&"
8227 By default, Exim behaves as if the host does not match the list. This may not
8228 always be what you want to happen. To change Exim's behaviour, the special
8229 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8230 top level &-- they are not recognized in an indirected file).
8231
8232 .ilist
8233 If any item that follows &`+include_unknown`& requires information that
8234 cannot found, Exim behaves as if the host does match the list. For example,
8235 .code
8236 host_reject_connection = +include_unknown:*.enemy.ex
8237 .endd
8238 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8239 any hosts whose name it cannot find.
8240
8241 .next
8242 If any item that follows &`+ignore_unknown`& requires information that cannot
8243 be found, Exim ignores that item and proceeds to the rest of the list. For
8244 example:
8245 .code
8246 accept hosts = +ignore_unknown : friend.example : \
8247                192.168.4.5
8248 .endd
8249 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8250 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8251 name can be found for 192.168.4.5, it is rejected.
8252 .endlist
8253
8254 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8255 list. The effect of each one lasts until the next, or until the end of the
8256 list.
8257
8258
8259 .section "Temporary DNS errors when looking up host information" &&&
8260          "SECTtemdnserr"
8261 .cindex "host" "lookup failures, temporary"
8262 .cindex "&`+include_defer`&"
8263 .cindex "&`+ignore_defer`&"
8264 A temporary DNS lookup failure normally causes a defer action (except when
8265 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8266 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8267 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8268 section. These options should be used with care, probably only in non-critical
8269 host lists such as whitelists.
8270
8271
8272
8273 .section "Host list patterns for single-key lookups by host name" &&&
8274          "SECThoslispatnamsk"
8275 .cindex "unknown host name"
8276 .cindex "host list" "matching host name"
8277 If a pattern is of the form
8278 .display
8279 <&'single-key-search-type'&>;<&'search-data'&>
8280 .endd
8281 for example
8282 .code
8283 dbm;/host/accept/list
8284 .endd
8285 a single-key lookup is performed, using the host name as its key. If the
8286 lookup succeeds, the host matches the item. The actual data that is looked up
8287 is not used.
8288
8289 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8290 keys in the file, not IP addresses. If you want to do lookups based on IP
8291 addresses, you must precede the search type with &"net-"& (see section
8292 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8293 two items in the same list, one doing an address lookup and one doing a name
8294 lookup, both using the same file.
8295
8296
8297
8298 .section "Host list patterns for query-style lookups" "SECID81"
8299 If a pattern is of the form
8300 .display
8301 <&'query-style-search-type'&>;<&'query'&>
8302 .endd
8303 the query is obeyed, and if it succeeds, the host matches the item. The actual
8304 data that is looked up is not used. The variables &$sender_host_address$& and
8305 &$sender_host_name$& can be used in the query. For example:
8306 .code
8307 hosts_lookup = pgsql;\
8308   select ip from hostlist where ip='$sender_host_address'
8309 .endd
8310 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8311 can use the &%sg%& expansion item to change this if you need to. If you want to
8312 use masked IP addresses in database queries, you can use the &%mask%& expansion
8313 operator.
8314
8315 If the query contains a reference to &$sender_host_name$&, Exim automatically
8316 looks up the host name if has not already done so. (See section
8317 &<<SECThoslispatnam>>& for comments on finding host names.)
8318
8319 Historical note: prior to release 4.30, Exim would always attempt to find a
8320 host name before running the query, unless the search type was preceded by
8321 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8322 still recognized for query-style lookups, but its presence or absence has no
8323 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8324 See section &<<SECThoslispatsikey>>&.)
8325
8326
8327
8328 .section "Mixing wildcarded host names and addresses in host lists" &&&
8329          "SECTmixwilhos"
8330 .cindex "host list" "mixing names and addresses in"
8331 If you have name lookups or wildcarded host names and IP addresses in the same
8332 host list, you should normally put the IP addresses first. For example, in an
8333 ACL you could have:
8334 .code
8335 accept hosts = 10.9.8.7 : *.friend.example
8336 .endd
8337 The reason for this lies in the left-to-right way that Exim processes lists.
8338 It can test IP addresses without doing any DNS lookups, but when it reaches an
8339 item that requires a host name, it fails if it cannot find a host name to
8340 compare with the pattern. If the above list is given in the opposite order, the
8341 &%accept%& statement fails for a host whose name cannot be found, even if its
8342 IP address is 10.9.8.7.
8343
8344 If you really do want to do the name check first, and still recognize the IP
8345 address, you can rewrite the ACL like this:
8346 .code
8347 accept hosts = *.friend.example
8348 accept hosts = 10.9.8.7
8349 .endd
8350 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8351 &<<CHAPACL>>& for details of ACLs.
8352
8353
8354
8355
8356
8357 .section "Address lists" "SECTaddresslist"
8358 .cindex "list" "address list"
8359 .cindex "address list" "empty item"
8360 .cindex "address list" "patterns"
8361 Address lists contain patterns that are matched against mail addresses. There
8362 is one special case to be considered: the sender address of a bounce message is
8363 always empty. You can test for this by providing an empty item in an address
8364 list. For example, you can set up a router to process bounce messages by
8365 using this option setting:
8366 .code
8367 senders = :
8368 .endd
8369 The presence of the colon creates an empty item. If you do not provide any
8370 data, the list is empty and matches nothing. The empty sender can also be
8371 detected by a regular expression that matches an empty string,
8372 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8373
8374 Non-empty items in an address list can be straightforward email addresses. For
8375 example:
8376 .code
8377 senders = jbc@askone.example : hs@anacreon.example
8378 .endd
8379 A certain amount of wildcarding is permitted. If a pattern contains an @
8380 character, but is not a regular expression and does not begin with a
8381 semicolon-terminated lookup type (described below), the local part of the
8382 subject address is compared with the local part of the pattern, which may start
8383 with an asterisk. If the local parts match, the domain is checked in exactly
8384 the same way as for a pattern in a domain list. For example, the domain can be
8385 wildcarded, refer to a named list, or be a lookup:
8386 .code
8387 deny senders = *@*.spamming.site:\
8388                *@+hostile_domains:\
8389                bozo@partial-lsearch;/list/of/dodgy/sites:\
8390                *@dbm;/bad/domains.db
8391 .endd
8392 .cindex "local part" "starting with !"
8393 .cindex "address list" "local part starting with !"
8394 If a local part that begins with an exclamation mark is required, it has to be
8395 specified using a regular expression, because otherwise the exclamation mark is
8396 treated as a sign of negation, as is standard in lists.
8397
8398 If a non-empty pattern that is not a regular expression or a lookup does not
8399 contain an @ character, it is matched against the domain part of the subject
8400 address. The only two formats that are recognized this way are a literal
8401 domain, or a domain pattern that starts with *. In both these cases, the effect
8402 is the same as if &`*@`& preceded the pattern. For example:
8403 .code
8404 deny senders = enemy.domain : *.enemy.domain
8405 .endd
8406
8407 The following kinds of more complicated address list pattern can match any
8408 address, including the empty address that is characteristic of bounce message
8409 senders:
8410
8411 .ilist
8412 .cindex "regular expressions" "in address list"
8413 .cindex "address list" "regular expression in"
8414 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8415 done against the complete address, with the pattern as the regular expression.
8416 You must take care that backslash and dollar characters are not misinterpreted
8417 as part of the string expansion. The simplest way to do this is to use &`\N`&
8418 to mark that part of the string as non-expandable. For example:
8419 .code
8420 deny senders = \N^.*this.*@example\.com$\N : \
8421                \N^\d{8}.+@spamhaus.example$\N : ...
8422 .endd
8423 The &`\N`& sequences are removed by the expansion, so these items do indeed
8424 start with &"^"& by the time they are being interpreted as address patterns.
8425
8426 .next
8427 .cindex "address list" "lookup for complete address"
8428 Complete addresses can be looked up by using a pattern that starts with a
8429 lookup type terminated by a semicolon, followed by the data for the lookup. For
8430 example:
8431 .code
8432 deny senders = cdb;/etc/blocked.senders : \
8433   mysql;select address from blocked where \
8434   address='${quote_mysql:$sender_address}'
8435 .endd
8436 Both query-style and single-key lookup types can be used. For a single-key
8437 lookup type, Exim uses the complete address as the key. However, empty keys are
8438 not supported for single-key lookups, so a match against the empty address
8439 always fails. This restriction does not apply to query-style lookups.
8440
8441 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8442 cannot be used, and is ignored if specified, with an entry being written to the
8443 panic log.
8444 .cindex "*@ with single-key lookup"
8445 However, you can configure lookup defaults, as described in section
8446 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8447 default. For example, with this lookup:
8448 .code
8449 accept senders = lsearch*@;/some/file
8450 .endd
8451 the file could contains lines like this:
8452 .code
8453 user1@domain1.example
8454 *@domain2.example
8455 .endd
8456 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8457 that are tried is:
8458 .code
8459 nimrod@jaeger.example
8460 *@jaeger.example
8461 *
8462 .endd
8463 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8464 would mean that every address matches, thus rendering the test useless.
8465
8466 &*Warning 2*&: Do not confuse these two kinds of item:
8467 .code
8468 deny recipients = dbm*@;/some/file
8469 deny recipients = *@dbm;/some/file
8470 .endd
8471 The first does a whole address lookup, with defaulting, as just described,
8472 because it starts with a lookup type. The second matches the local part and
8473 domain independently, as described in a bullet point below.
8474 .endlist
8475
8476
8477 The following kinds of address list pattern can match only non-empty addresses.
8478 If the subject address is empty, a match against any of these pattern types
8479 always fails.
8480
8481
8482 .ilist
8483 .cindex "@@ with single-key lookup"
8484 .cindex "address list" "@@ lookup type"
8485 .cindex "address list" "split local part and domain"
8486 If a pattern starts with &"@@"& followed by a single-key lookup item
8487 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8488 split into a local part and a domain. The domain is looked up in the file. If
8489 it is not found, there is no match. If it is found, the data that is looked up
8490 from the file is treated as a colon-separated list of local part patterns, each
8491 of which is matched against the subject local part in turn.
8492
8493 .cindex "asterisk" "in address list"
8494 The lookup may be a partial one, and/or one involving a search for a default
8495 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8496 patterns that are looked up can be regular expressions or begin with &"*"&, or
8497 even be further lookups. They may also be independently negated. For example,
8498 with
8499 .code
8500 deny senders = @@dbm;/etc/reject-by-domain
8501 .endd
8502 the data from which the DBM file is built could contain lines like
8503 .code
8504 baddomain.com:  !postmaster : *
8505 .endd
8506 to reject all senders except &%postmaster%& from that domain.
8507
8508 .cindex "local part" "starting with !"
8509 If a local part that actually begins with an exclamation mark is required, it
8510 has to be specified using a regular expression. In &(lsearch)& files, an entry
8511 may be split over several lines by indenting the second and subsequent lines,
8512 but the separating colon must still be included at line breaks. White space
8513 surrounding the colons is ignored. For example:
8514 .code
8515 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8516 spammer3 : spammer4
8517 .endd
8518 As in all colon-separated lists in Exim, a colon can be included in an item by
8519 doubling.
8520
8521 If the last item in the list starts with a right angle-bracket, the remainder
8522 of the item is taken as a new key to look up in order to obtain a continuation
8523 list of local parts. The new key can be any sequence of characters. Thus one
8524 might have entries like
8525 .code
8526 aol.com: spammer1 : spammer 2 : >*
8527 xyz.com: spammer3 : >*
8528 *:       ^\d{8}$
8529 .endd
8530 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8531 local parts for all domains, in addition to the specific local parts listed for
8532 each domain. Of course, using this feature costs another lookup each time a
8533 chain is followed, but the effort needed to maintain the data is reduced.
8534
8535 .cindex "loop" "in lookups"
8536 It is possible to construct loops using this facility, and in order to catch
8537 them, the chains may be no more than fifty items long.
8538
8539 .next
8540 The @@<&'lookup'&> style of item can also be used with a query-style
8541 lookup, but in this case, the chaining facility is not available. The lookup
8542 can only return a single list of local parts.
8543 .endlist
8544
8545 &*Warning*&: There is an important difference between the address list items
8546 in these two examples:
8547 .code
8548 senders = +my_list
8549 senders = *@+my_list
8550 .endd
8551 In the first one, &`my_list`& is a named address list, whereas in the second
8552 example it is a named domain list.
8553
8554
8555
8556
8557 .section "Case of letters in address lists" "SECTcasletadd"
8558 .cindex "case of local parts"
8559 .cindex "address list" "case forcing"
8560 .cindex "case forcing in address lists"
8561 Domains in email addresses are always handled caselessly, but for local parts
8562 case may be significant on some systems (see &%caseful_local_part%& for how
8563 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8564 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8565 blocking lists should be done in a case-independent manner. Since most address
8566 lists in Exim are used for this kind of control, Exim attempts to do this by
8567 default.
8568
8569 The domain portion of an address is always lowercased before matching it to an
8570 address list. The local part is lowercased by default, and any string
8571 comparisons that take place are done caselessly. This means that the data in
8572 the address list itself, in files included as plain file names, and in any file
8573 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8574 keys in files that are looked up by a search type other than &(lsearch)& (which
8575 works caselessly) must be in lower case, because these lookups are not
8576 case-independent.
8577
8578 .cindex "&`+caseful`&"
8579 To allow for the possibility of caseful address list matching, if an item in
8580 an address list is the string &"+caseful"&, the original case of the local
8581 part is restored for any comparisons that follow, and string comparisons are no
8582 longer case-independent. This does not affect the domain, which remains in
8583 lower case. However, although independent matches on the domain alone are still
8584 performed caselessly, regular expressions that match against an entire address
8585 become case-sensitive after &"+caseful"& has been seen.
8586
8587
8588
8589 .section "Local part lists" "SECTlocparlis"
8590 .cindex "list" "local part list"
8591 .cindex "local part" "list"
8592 Case-sensitivity in local part lists is handled in the same way as for address
8593 lists, as just described. The &"+caseful"& item can be used if required. In a
8594 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8595 set false, the subject is lowercased and the matching is initially
8596 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8597 matching in the local part list, but not elsewhere in the router. If
8598 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8599 option is case-sensitive from the start.
8600
8601 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8602 comments are handled in the same way as address lists &-- they are recognized
8603 only if the # is preceded by white space or the start of the line.
8604 Otherwise, local part lists are matched in the same way as domain lists, except
8605 that the special items that refer to the local host (&`@`&, &`@[]`&,
8606 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8607 Refer to section &<<SECTdomainlist>>& for details of the other available item
8608 types.
8609 .ecindex IIDdohoadli
8610
8611
8612
8613
8614 . ////////////////////////////////////////////////////////////////////////////
8615 . ////////////////////////////////////////////////////////////////////////////
8616
8617 .chapter "String expansions" "CHAPexpand"
8618 .scindex IIDstrexp "expansion" "of strings"
8619 Many strings in Exim's run time configuration are expanded before use. Some of
8620 them are expanded every time they are used; others are expanded only once.
8621
8622 When a string is being expanded it is copied verbatim from left to right except
8623 when a dollar or backslash character is encountered. A dollar specifies the
8624 start of a portion of the string that is interpreted and replaced as described
8625 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8626 escape character, as described in the following section.
8627
8628 Whether a string is expanded depends upon the context.  Usually this is solely
8629 dependent upon the option for which a value is sought; in this documentation,
8630 options for which string expansion is performed are marked with &dagger; after
8631 the data type.  ACL rules always expand strings.  A couple of expansion
8632 conditions do not expand some of the brace-delimited branches, for security
8633 reasons.
8634
8635
8636
8637 .section "Literal text in expanded strings" "SECTlittext"
8638 .cindex "expansion" "including literal text"
8639 An uninterpreted dollar can be included in an expanded string by putting a
8640 backslash in front of it. A backslash can be used to prevent any special
8641 character being treated specially in an expansion, including backslash itself.
8642 If the string appears in quotes in the configuration file, two backslashes are
8643 required because the quotes themselves cause interpretation of backslashes when
8644 the string is read in (see section &<<SECTstrings>>&).
8645
8646 .cindex "expansion" "non-expandable substrings"
8647 A portion of the string can specified as non-expandable by placing it between
8648 two occurrences of &`\N`&. This is particularly useful for protecting regular
8649 expressions, which often contain backslashes and dollar signs. For example:
8650 .code
8651 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8652 .endd
8653 On encountering the first &`\N`&, the expander copies subsequent characters
8654 without interpretation until it reaches the next &`\N`& or the end of the
8655 string.
8656
8657
8658
8659 .section "Character escape sequences in expanded strings" "SECID82"
8660 .cindex "expansion" "escape sequences"
8661 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8662 expanded string is recognized as an escape sequence for the character newline,
8663 carriage return, or tab, respectively. A backslash followed by up to three
8664 octal digits is recognized as an octal encoding for a single character, and a
8665 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8666 encoding.
8667
8668 These escape sequences are also recognized in quoted strings when they are read
8669 in. Their interpretation in expansions as well is useful for unquoted strings,
8670 and for other cases such as looked-up strings that are then expanded.
8671
8672
8673 .section "Testing string expansions" "SECID83"
8674 .cindex "expansion" "testing"
8675 .cindex "testing" "string expansion"
8676 .oindex "&%-be%&"
8677 Many expansions can be tested by calling Exim with the &%-be%& option. This
8678 takes the command arguments, or lines from the standard input if there are no
8679 arguments, runs them through the string expansion code, and writes the results
8680 to the standard output. Variables based on configuration values are set up, but
8681 since no message is being processed, variables such as &$local_part$& have no
8682 value. Nevertheless the &%-be%& option can be useful for checking out file and
8683 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8684 and &%nhash%&.
8685
8686 Exim gives up its root privilege when it is called with the &%-be%& option, and
8687 instead runs under the uid and gid it was called with, to prevent users from
8688 using &%-be%& for reading files to which they do not have access.
8689
8690 .oindex "&%-bem%&"
8691 If you want to test expansions that include variables whose values are taken
8692 from a message, there are two other options that can be used. The &%-bem%&
8693 option is like &%-be%& except that it is followed by a file name. The file is
8694 read as a message before doing the test expansions. For example:
8695 .code
8696 exim -bem /tmp/test.message '$h_subject:'
8697 .endd
8698 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8699 Exim message identifier. For example:
8700 .code
8701 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8702 .endd
8703 This loads the message from Exim's spool before doing the test expansions, and
8704 is therefore restricted to admin users.
8705
8706
8707 .section "Forced expansion failure" "SECTforexpfai"
8708 .cindex "expansion" "forced failure"
8709 A number of expansions that are described in the following section have
8710 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8711 (which are sometimes called &"curly brackets"&). Which of the two strings is
8712 used depends on some condition that is evaluated as part of the expansion. If,
8713 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8714 the entire string expansion fails in a way that can be detected by the code
8715 that requested the expansion. This is called &"forced expansion failure"&, and
8716 its consequences depend on the circumstances. In some cases it is no different
8717 from any other expansion failure, but in others a different action may be
8718 taken. Such variations are mentioned in the documentation of the option that is
8719 being expanded.
8720
8721
8722
8723
8724 .section "Expansion items" "SECTexpansionitems"
8725 The following items are recognized in expanded strings. White space may be used
8726 between sub-items that are keywords or substrings enclosed in braces inside an
8727 outer set of braces, to improve readability. &*Warning*&: Within braces,
8728 white space is significant.
8729
8730 .vlist
8731 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8732 .cindex "expansion" "variables"
8733 Substitute the contents of the named variable, for example:
8734 .code
8735 $local_part
8736 ${domain}
8737 .endd
8738 The second form can be used to separate the name from subsequent alphanumeric
8739 characters. This form (using braces) is available only for variables; it does
8740 &'not'& apply to message headers. The names of the variables are given in
8741 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8742 given, the expansion fails.
8743
8744 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8745 .cindex "expansion" "operators"
8746 The string is first itself expanded, and then the operation specified by
8747 <&'op'&> is applied to it. For example:
8748 .code
8749 ${lc:$local_part}
8750 .endd
8751 The string starts with the first character after the colon, which may be
8752 leading white space. A list of operators is given in section &<<SECTexpop>>&
8753 below. The operator notation is used for simple expansion items that have just
8754 one argument, because it reduces the number of braces and therefore makes the
8755 string easier to understand.
8756
8757 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8758 This item inserts &"basic"& header lines. It is described with the &%header%&
8759 expansion item below.
8760
8761
8762 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8763 .cindex "expansion" "calling an acl"
8764 .cindex "&%acl%&" "call from expansion"
8765 The name and zero to nine argument strings are first expanded separately.  The expanded
8766 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8767 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8768 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8769 and may use the variables; if another acl expansion is used the values
8770 are overwritten.  If the ACL sets
8771 a value using a "message =" modifier and returns accept or deny, the value becomes
8772 the result of the expansion.
8773 If no message was set and the ACL returned accept or deny
8774 the value is an empty string.
8775 If the ACL returned defer the result is a forced-fail.  Otherwise the expansion fails.
8776
8777
8778 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8779        {*&<&'arg'&>&*}...}*&"
8780 .cindex &%dlfunc%&
8781 This expansion dynamically loads and then calls a locally-written C function.
8782 This functionality is available only if Exim is compiled with
8783 .code
8784 EXPAND_DLFUNC=yes
8785 .endd
8786 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8787 object so that it doesn't reload the same object file in the same Exim process
8788 (but of course Exim does start new processes frequently).
8789
8790 There may be from zero to eight arguments to the function. When compiling
8791 a local function that is to be called in this way, &_local_scan.h_& should be
8792 included. The Exim variables and functions that are defined by that API
8793 are also available for dynamically loaded functions. The function itself
8794 must have the following type:
8795 .code
8796 int dlfunction(uschar **yield, int argc, uschar *argv[])
8797 .endd
8798 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8799 function should return one of the following values:
8800
8801 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8802 into the expanded string that is being built.
8803
8804 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8805 from &'yield'&, if it is set.
8806
8807 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8808 taken from &'yield'& if it is set.
8809
8810 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8811
8812 When compiling a function that is to be used in this way with gcc,
8813 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8814 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8815
8816 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8817        {*&<&'string3'&>&*}}*&"
8818 .cindex "expansion" "extracting substrings by key"
8819 .cindex "&%extract%&" "substrings by key"
8820 The key and <&'string1'&> are first expanded separately. Leading and trailing
8821 white space is removed from the key (but not from any of the strings). The key
8822 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8823 form:
8824 .display
8825 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8826 .endd
8827 .vindex "&$value$&"
8828 where the equals signs and spaces (but not both) are optional. If any of the
8829 values contain white space, they must be enclosed in double quotes, and any
8830 values that are enclosed in double quotes are subject to escape processing as
8831 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8832 for the value that corresponds to the key. The search is case-insensitive. If
8833 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8834 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8835 variable &$value$& contains the value that has been extracted. Afterwards, it
8836 is restored to any previous value it might have had.
8837
8838 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8839 key is not found. If {<&'string2'&>} is also omitted, the value that was
8840 extracted is used. Thus, for example, these two expansions are identical, and
8841 yield &"2001"&:
8842 .code
8843 ${extract{gid}{uid=1984 gid=2001}}
8844 ${extract{gid}{uid=1984 gid=2001}{$value}}
8845 .endd
8846 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8847 appear, for example:
8848 .code
8849 ${extract{Z}{A=... B=...}{$value} fail }
8850 .endd
8851 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8852 {<&'string2'&>} must be present for &"fail"& to be recognized.
8853
8854
8855 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8856         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8857 .cindex "expansion" "extracting substrings by number"
8858 .cindex "&%extract%&" "substrings by number"
8859 The <&'number'&> argument must consist entirely of decimal digits,
8860 apart from leading and trailing white space, which is ignored.
8861 This is what distinguishes this form of &%extract%& from the previous kind. It
8862 behaves in the same way, except that, instead of extracting a named field, it
8863 extracts from <&'string1'&> the field whose number is given as the first
8864 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8865 <&'string3'&> as before.
8866
8867 The fields in the string are separated by any one of the characters in the
8868 separator string. These may include space or tab characters.
8869 The first field is numbered one. If the number is negative, the fields are
8870 counted from the end of the string, with the rightmost one numbered -1. If the
8871 number given is zero, the entire string is returned. If the modulus of the
8872 number is greater than the number of fields in the string, the result is the
8873 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8874 provided. For example:
8875 .code
8876 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8877 .endd
8878 yields &"42"&, and
8879 .code
8880 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8881 .endd
8882 yields &"99"&. Two successive separators mean that the field between them is
8883 empty (for example, the fifth field above).
8884
8885
8886 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8887 .cindex "list" "selecting by condition"
8888 .cindex "expansion" "selecting from list by condition"
8889 .vindex "&$item$&"
8890 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8891 default, but the separator can be changed in the usual way. For each item
8892 in this list, its value is place in &$item$&, and then the condition is
8893 evaluated. If the condition is true, &$item$& is added to the output as an
8894 item in a new list; if the condition is false, the item is discarded. The
8895 separator used for the output list is the same as the one used for the
8896 input, but a separator setting is not included in the output. For example:
8897 .code
8898 ${filter{a:b:c}{!eq{$item}{b}}
8899 .endd
8900 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8901 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8902
8903
8904 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8905 .cindex "hash function" "textual"
8906 .cindex "expansion" "textual hash"
8907 This is a textual hashing function, and was the first to be implemented in
8908 early versions of Exim. In current releases, there are other hashing functions
8909 (numeric, MD5, and SHA-1), which are described below.
8910
8911 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8912 <&'n'&>. If you are using fixed values for these numbers, that is, if
8913 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8914 use the simpler operator notation that avoids some of the braces:
8915 .code
8916 ${hash_<n>_<m>:<string>}
8917 .endd
8918 The second number is optional (in both notations). If <&'n'&> is greater than
8919 or equal to the length of the string, the expansion item returns the string.
8920 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8921 function to the string. The new string consists of characters taken from the
8922 first <&'m'&> characters of the string
8923 .code
8924 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8925 .endd
8926 If <&'m'&> is not present the value 26 is used, so that only lower case
8927 letters appear. For example:
8928 .display
8929 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8930 &`$hash{5}{monty}}           `&   yields  &`monty`&
8931 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8932 .endd
8933
8934 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8935         &*$h_*&<&'header&~name'&>&*:*&" &&&
8936        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8937         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8938        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8939         &*$rh_*&<&'header&~name'&>&*:*&"
8940 .cindex "expansion" "header insertion"
8941 .vindex "&$header_$&"
8942 .vindex "&$bheader_$&"
8943 .vindex "&$rheader_$&"
8944 .cindex "header lines" "in expansion strings"
8945 .cindex "header lines" "character sets"
8946 .cindex "header lines" "decoding"
8947 Substitute the contents of the named message header line, for example
8948 .code
8949 $header_reply-to:
8950 .endd
8951 The newline that terminates a header line is not included in the expansion, but
8952 internal newlines (caused by splitting the header line over several physical
8953 lines) may be present.
8954
8955 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8956 the data in the header line is interpreted.
8957
8958 .ilist
8959 .cindex "white space" "in header lines"
8960 &%rheader%& gives the original &"raw"& content of the header line, with no
8961 processing at all, and without the removal of leading and trailing white space.
8962
8963 .next
8964 .cindex "base64 encoding" "in header lines"
8965 &%bheader%& removes leading and trailing white space, and then decodes base64
8966 or quoted-printable MIME &"words"& within the header text, but does no
8967 character set translation. If decoding of what looks superficially like a MIME
8968 &"word"& fails, the raw string is returned. If decoding
8969 .cindex "binary zero" "in header line"
8970 produces a binary zero character, it is replaced by a question mark &-- this is
8971 what Exim does for binary zeros that are actually received in header lines.
8972
8973 .next
8974 &%header%& tries to translate the string as decoded by &%bheader%& to a
8975 standard character set. This is an attempt to produce the same string as would
8976 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8977 returned. Translation is attempted only on operating systems that support the
8978 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8979 a system Makefile or in &_Local/Makefile_&.
8980 .endlist ilist
8981
8982 In a filter file, the target character set for &%header%& can be specified by a
8983 command of the following form:
8984 .code
8985 headers charset "UTF-8"
8986 .endd
8987 This command affects all references to &$h_$& (or &$header_$&) expansions in
8988 subsequently obeyed filter commands. In the absence of this command, the target
8989 character set in a filter is taken from the setting of the &%headers_charset%&
8990 option in the runtime configuration. The value of this option defaults to the
8991 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8992 ISO-8859-1.
8993
8994 Header names follow the syntax of RFC 2822, which states that they may contain
8995 any printing characters except space and colon. Consequently, curly brackets
8996 &'do not'& terminate header names, and should not be used to enclose them as
8997 if they were variables. Attempting to do so causes a syntax error.
8998
8999 Only header lines that are common to all copies of a message are visible to
9000 this mechanism. These are the original header lines that are received with the
9001 message, and any that are added by an ACL statement or by a system
9002 filter. Header lines that are added to a particular copy of a message by a
9003 router or transport are not accessible.
9004
9005 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9006 before the DATA ACL, because the header structure is not set up until the
9007 message is received. Header lines that are added in a RCPT ACL (for example)
9008 are saved until the message's incoming header lines are available, at which
9009 point they are added. When a DATA ACL is running, however, header lines added
9010 by earlier ACLs are visible.
9011
9012 Upper case and lower case letters are synonymous in header names. If the
9013 following character is white space, the terminating colon may be omitted, but
9014 this is not recommended, because you may then forget it when it is needed. When
9015 white space terminates the header name, it is included in the expanded string.
9016 If the message does not contain the given header, the expansion item is
9017 replaced by an empty string. (See the &%def%& condition in section
9018 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9019
9020 If there is more than one header with the same name, they are all concatenated
9021 to form the substitution string, up to a maximum length of 64K. Unless
9022 &%rheader%& is being used, leading and trailing white space is removed from
9023 each header before concatenation, and a completely empty header is ignored. A
9024 newline character is then inserted between non-empty headers, but there is no
9025 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9026 those headers that contain lists of addresses, a comma is also inserted at the
9027 junctions between headers. This does not happen for the &%rheader%& expansion.
9028
9029
9030 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9031 .cindex "expansion" "hmac hashing"
9032 .cindex &%hmac%&
9033 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9034 shared secret and some text into a message authentication code, as specified in
9035 RFC 2104. This differs from &`${md5:secret_text...}`& or
9036 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9037 cryptographic hash, allowing for authentication that is not possible with MD5
9038 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9039 present. For example:
9040 .code
9041 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9042 .endd
9043 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9044 produces:
9045 .code
9046 dd97e3ba5d1a61b5006108f8c8252953
9047 .endd
9048 As an example of how this might be used, you might put in the main part of
9049 an Exim configuration:
9050 .code
9051 SPAMSCAN_SECRET=cohgheeLei2thahw
9052 .endd
9053 In a router or a transport you could then have:
9054 .code
9055 headers_add = \
9056   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9057   ${hmac{md5}{SPAMSCAN_SECRET}\
9058   {${primary_hostname},${message_exim_id},$h_message-id:}}
9059 .endd
9060 Then given a message, you can check where it was scanned by looking at the
9061 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9062 this header line is authentic by recomputing the authentication code from the
9063 host name, message ID and the &'Message-id:'& header line. This can be done
9064 using Exim's &%-be%& option, or by other means, for example by using the
9065 &'hmac_md5_hex()'& function in Perl.
9066
9067
9068 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9069 .cindex "expansion" "conditional"
9070 .cindex "&%if%&, expansion item"
9071 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9072 item; otherwise <&'string2'&> is used. The available conditions are described
9073 in section &<<SECTexpcond>>& below. For example:
9074 .code
9075 ${if eq {$local_part}{postmaster} {yes}{no} }
9076 .endd
9077 The second string need not be present; if it is not and the condition is not
9078 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9079 be present instead of the second string (without any curly brackets). In this
9080 case, the expansion is forced to fail if the condition is not true (see section
9081 &<<SECTforexpfai>>&).
9082
9083 If both strings are omitted, the result is the string &`true`& if the condition
9084 is true, and the empty string if the condition is false. This makes it less
9085 cumbersome to write custom ACL and router conditions. For example, instead of
9086 .code
9087 condition = ${if >{$acl_m4}{3}{true}{false}}
9088 .endd
9089 you can use
9090 .code
9091 condition = ${if >{$acl_m4}{3}}
9092 .endd
9093
9094 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9095 .cindex "expansion" "string truncation"
9096 .cindex "&%length%& expansion item"
9097 The &%length%& item is used to extract the initial portion of a string. Both
9098 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9099 you are using a fixed value for the number, that is, if <&'string1'&> does not
9100 change when expanded, you can use the simpler operator notation that avoids
9101 some of the braces:
9102 .code
9103 ${length_<n>:<string>}
9104 .endd
9105 The result of this item is either the first <&'n'&> characters or the whole
9106 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9107 &%strlen%&, which gives the length of a string.
9108
9109
9110 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9111         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9112 This is the first of one of two different types of lookup item, which are both
9113 described in the next item.
9114
9115 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9116         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9117 .cindex "expansion" "lookup in"
9118 .cindex "file" "lookups"
9119 .cindex "lookup" "in expanded string"
9120 The two forms of lookup item specify data lookups in files and databases, as
9121 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9122 lookups, and the second is used for query-style lookups. The <&'key'&>,
9123 <&'file'&>, and <&'query'&> strings are expanded before use.
9124
9125 If there is any white space in a lookup item which is part of a filter command,
9126 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9127 other place where white space is significant, the lookup item must be enclosed
9128 in double quotes. The use of data lookups in users' filter files may be locked
9129 out by the system administrator.
9130
9131 .vindex "&$value$&"
9132 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9133 During its expansion, the variable &$value$& contains the data returned by the
9134 lookup. Afterwards it reverts to the value it had previously (at the outer
9135 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9136 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9137 string on failure. If <&'string2'&> is provided, it can itself be a nested
9138 lookup, thus providing a mechanism for looking up a default value when the
9139 original lookup fails.
9140
9141 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9142 data for the outer lookup while the parameters of the second lookup are
9143 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9144 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9145 appear, and in this case, if the lookup fails, the entire expansion is forced
9146 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9147 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9148 successful lookup, and nothing in the case of failure.
9149
9150 For single-key lookups, the string &"partial"& is permitted to precede the
9151 search type in order to do partial matching, and * or *@ may follow a search
9152 type to request default lookups if the key does not match (see sections
9153 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9154
9155 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9156 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9157 and non-wild parts of the key during the expansion of the replacement text.
9158 They return to their previous values at the end of the lookup item.
9159
9160 This example looks up the postmaster alias in the conventional alias file:
9161 .code
9162 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9163 .endd
9164 This example uses NIS+ to look up the full name of the user corresponding to
9165 the local part of an address, forcing the expansion to fail if it is not found:
9166 .code
9167 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9168   {$value}fail}
9169 .endd
9170
9171
9172 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9173 .cindex "expansion" "list creation"
9174 .vindex "&$item$&"
9175 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9176 default, but the separator can be changed in the usual way. For each item
9177 in this list, its value is place in &$item$&, and then <&'string2'&> is
9178 expanded and added to the output as an item in a new list. The separator used
9179 for the output list is the same as the one used for the input, but a separator
9180 setting is not included in the output. For example:
9181 .code
9182 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9183 .endd
9184 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9185 value of &$item$& is restored to what it was before. See also the &*filter*&
9186 and &*reduce*& expansion items.
9187
9188 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9189 .cindex "expansion" "numeric hash"
9190 .cindex "hash function" "numeric"
9191 The three strings are expanded; the first two must yield numbers. Call them
9192 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9193 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9194 can use the simpler operator notation that avoids some of the braces:
9195 .code
9196 ${nhash_<n>_<m>:<string>}
9197 .endd
9198 The second number is optional (in both notations). If there is only one number,
9199 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9200 processed by a div/mod hash function that returns two numbers, separated by a
9201 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9202 example,
9203 .code
9204 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9205 .endd
9206 returns the string &"6/33"&.
9207
9208
9209
9210 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9211 .cindex "Perl" "use in expanded string"
9212 .cindex "expansion" "calling Perl from"
9213 This item is available only if Exim has been built to include an embedded Perl
9214 interpreter. The subroutine name and the arguments are first separately
9215 expanded, and then the Perl subroutine is called with those arguments. No
9216 additional arguments need be given; the maximum number permitted, including the
9217 name of the subroutine, is nine.
9218
9219 The return value of the subroutine is inserted into the expanded string, unless
9220 the return value is &%undef%&. In that case, the expansion fails in the same
9221 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9222 Whatever you return is evaluated in a scalar context. For example, if you
9223 return the name of a Perl vector, the return value is the size of the vector,
9224 not its contents.
9225
9226 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9227 with the error message that was passed to &%die%&. More details of the embedded
9228 Perl facility are given in chapter &<<CHAPperl>>&.
9229
9230 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9231 out the use of this expansion item in filter files.
9232
9233
9234 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9235 .cindex "&%prvs%& expansion item"
9236 The first argument is a complete email address and the second is secret
9237 keystring. The third argument, specifying a key number, is optional. If absent,
9238 it defaults to 0. The result of the expansion is a prvs-signed email address,
9239 to be typically used with the &%return_path%& option on an &(smtp)& transport
9240 as part of a bounce address tag validation (BATV) scheme. For more discussion
9241 and an example, see section &<<SECTverifyPRVS>>&.
9242
9243 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9244         {*&<&'string'&>&*}}*&"
9245 .cindex "&%prvscheck%& expansion item"
9246 This expansion item is the complement of the &%prvs%& item. It is used for
9247 checking prvs-signed addresses. If the expansion of the first argument does not
9248 yield a syntactically valid prvs-signed address, the whole item expands to the
9249 empty string. When the first argument does expand to a syntactically valid
9250 prvs-signed address, the second argument is expanded, with the prvs-decoded
9251 version of the address and the key number extracted from the address in the
9252 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9253
9254 These two variables can be used in the expansion of the second argument to
9255 retrieve the secret. The validity of the prvs-signed address is then checked
9256 against the secret. The result is stored in the variable &$prvscheck_result$&,
9257 which is empty for failure or &"1"& for success.
9258
9259 The third argument is optional; if it is missing, it defaults to an empty
9260 string. This argument is now expanded. If the result is an empty string, the
9261 result of the expansion is the decoded version of the address. This is the case
9262 whether or not the signature was valid. Otherwise, the result of the expansion
9263 is the expansion of the third argument.
9264
9265 All three variables can be used in the expansion of the third argument.
9266 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9267 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9268
9269 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9270 .cindex "expansion" "inserting an entire file"
9271 .cindex "file" "inserting into expansion"
9272 .cindex "&%readfile%& expansion item"
9273 The file name and end-of-line string are first expanded separately. The file is
9274 then read, and its contents replace the entire item. All newline characters in
9275 the file are replaced by the end-of-line string if it is present. Otherwise,
9276 newlines are left in the string.
9277 String expansion is not applied to the contents of the file. If you want this,
9278 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9279 the string expansion fails.
9280
9281 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9282 locks out the use of this expansion item in filter files.
9283
9284
9285
9286 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9287         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9288 .cindex "expansion" "inserting from a socket"
9289 .cindex "socket, use of in expansion"
9290 .cindex "&%readsocket%& expansion item"
9291 This item inserts data from a Unix domain or Internet socket into the expanded
9292 string. The minimal way of using it uses just two arguments, as in these
9293 examples:
9294 .code
9295 ${readsocket{/socket/name}{request string}}
9296 ${readsocket{inet:some.host:1234}{request string}}
9297 .endd
9298 For a Unix domain socket, the first substring must be the path to the socket.
9299 For an Internet socket, the first substring must contain &`inet:`& followed by
9300 a host name or IP address, followed by a colon and a port, which can be a
9301 number or the name of a TCP port in &_/etc/services_&. An IP address may
9302 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9303 example:
9304 .code
9305 ${readsocket{inet:[::1]:1234}{request string}}
9306 .endd
9307 Only a single host name may be given, but if looking it up yields more than
9308 one IP address, they are each tried in turn until a connection is made. For
9309 both kinds of socket, Exim makes a connection, writes the request string
9310 (unless it is an empty string) and reads from the socket until an end-of-file
9311 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9312 extend what can be done. Firstly, you can vary the timeout. For example:
9313 .code
9314 ${readsocket{/socket/name}{request string}{3s}}
9315 .endd
9316 A fourth argument allows you to change any newlines that are in the data
9317 that is read, in the same way as for &%readfile%& (see above). This example
9318 turns them into spaces:
9319 .code
9320 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9321 .endd
9322 As with all expansions, the substrings are expanded before the processing
9323 happens. Errors in these sub-expansions cause the expansion to fail. In
9324 addition, the following errors can occur:
9325
9326 .ilist
9327 Failure to create a socket file descriptor;
9328 .next
9329 Failure to connect the socket;
9330 .next
9331 Failure to write the request string;
9332 .next
9333 Timeout on reading from the socket.
9334 .endlist
9335
9336 By default, any of these errors causes the expansion to fail. However, if
9337 you supply a fifth substring, it is expanded and used when any of the above
9338 errors occurs. For example:
9339 .code
9340 ${readsocket{/socket/name}{request string}{3s}{\n}\
9341   {socket failure}}
9342 .endd
9343 You can test for the existence of a Unix domain socket by wrapping this
9344 expansion in &`${if exists`&, but there is a race condition between that test
9345 and the actual opening of the socket, so it is safer to use the fifth argument
9346 if you want to be absolutely sure of avoiding an expansion error for a
9347 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9348
9349 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9350 locks out the use of this expansion item in filter files.
9351
9352
9353 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9354 .cindex "expansion" "reducing a list to a scalar"
9355 .cindex "list" "reducing to a scalar"
9356 .vindex "&$value$&"
9357 .vindex "&$item$&"
9358 This operation reduces a list to a single, scalar string. After expansion,
9359 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9360 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9361 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9362 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9363 them. The result of that expansion is assigned to &$value$& before the next
9364 iteration. When the end of the list is reached, the final value of &$value$& is
9365 added to the expansion output. The &*reduce*& expansion item can be used in a
9366 number of ways. For example, to add up a list of numbers:
9367 .code
9368 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9369 .endd
9370 The result of that expansion would be &`6`&. The maximum of a list of numbers
9371 can be found:
9372 .code
9373 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9374 .endd
9375 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9376 restored to what they were before. See also the &*filter*& and &*map*&
9377 expansion items.
9378
9379 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9380 This item inserts &"raw"& header lines. It is described with the &%header%&
9381 expansion item above.
9382
9383 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9384         {*&<&'string2'&>&*}}*&"
9385 .cindex "expansion" "running a command"
9386 .cindex "&%run%& expansion item"
9387 The command and its arguments are first expanded separately, and then the
9388 command is run in a separate process, but under the same uid and gid. As in
9389 other command executions from Exim, a shell is not used by default. If you want
9390 a shell, you must explicitly code it.
9391
9392 The standard input for the command exists, but is empty. The standard output
9393 and standard error are set to the same file descriptor.
9394 .cindex "return code" "from &%run%& expansion"
9395 .vindex "&$value$&"
9396 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9397 and replaces the entire item; during this expansion, the standard output/error
9398 from the command is in the variable &$value$&. If the command fails,
9399 <&'string2'&>, if present, is expanded and used. Once again, during the
9400 expansion, the standard output/error from the command is in the variable
9401 &$value$&.
9402
9403 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9404 can be the word &"fail"& (not in braces) to force expansion failure if the
9405 command does not succeed. If both strings are omitted, the result is contents
9406 of the standard output/error on success, and nothing on failure.
9407
9408 .vindex "&$runrc$&"
9409 The return code from the command is put in the variable &$runrc$&, and this
9410 remains set afterwards, so in a filter file you can do things like this:
9411 .code
9412 if "${run{x y z}{}}$runrc" is 1 then ...
9413   elif $runrc is 2 then ...
9414   ...
9415 endif
9416 .endd
9417 If execution of the command fails (for example, the command does not exist),
9418 the return code is 127 &-- the same code that shells use for non-existent
9419 commands.
9420
9421 &*Warning*&: In a router or transport, you cannot assume the order in which
9422 option values are expanded, except for those preconditions whose order of
9423 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9424 by the expansion of one option, and use it in another.
9425
9426 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9427 out the use of this expansion item in filter files.
9428
9429
9430 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9431 .cindex "expansion" "string substitution"
9432 .cindex "&%sg%& expansion item"
9433 This item works like Perl's substitution operator (s) with the global (/g)
9434 option; hence its name. However, unlike the Perl equivalent, Exim does not
9435 modify the subject string; instead it returns the modified string for insertion
9436 into the overall expansion. The item takes three arguments: the subject string,
9437 a regular expression, and a substitution string. For example:
9438 .code
9439 ${sg{abcdefabcdef}{abc}{xyz}}
9440 .endd
9441 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9442 if any $ or \ characters are required in the regular expression or in the
9443 substitution string, they have to be escaped. For example:
9444 .code
9445 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9446 .endd
9447 yields &"defabc"&, and
9448 .code
9449 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9450 .endd
9451 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9452 the regular expression from string expansion.
9453
9454
9455
9456 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9457 .cindex "&%substr%& expansion item"
9458 .cindex "substring extraction"
9459 .cindex "expansion" "substring extraction"
9460 The three strings are expanded; the first two must yield numbers. Call them
9461 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9462 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9463 can use the simpler operator notation that avoids some of the braces:
9464 .code
9465 ${substr_<n>_<m>:<string>}
9466 .endd
9467 The second number is optional (in both notations).
9468 If it is absent in the simpler format, the preceding underscore must also be
9469 omitted.
9470
9471 The &%substr%& item can be used to extract more general substrings than
9472 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9473 length required. For example
9474 .code
9475 ${substr{3}{2}{$local_part}}
9476 .endd
9477 If the starting offset is greater than the string length the result is the
9478 null string; if the length plus starting offset is greater than the string
9479 length, the result is the right-hand part of the string, starting from the
9480 given offset. The first character in the string has offset zero.
9481
9482 The &%substr%& expansion item can take negative offset values to count
9483 from the right-hand end of its operand. The last character is offset -1, the
9484 second-last is offset -2, and so on. Thus, for example,
9485 .code
9486 ${substr{-5}{2}{1234567}}
9487 .endd
9488 yields &"34"&. If the absolute value of a negative offset is greater than the
9489 length of the string, the substring starts at the beginning of the string, and
9490 the length is reduced by the amount of overshoot. Thus, for example,
9491 .code
9492 ${substr{-5}{2}{12}}
9493 .endd
9494 yields an empty string, but
9495 .code
9496 ${substr{-3}{2}{12}}
9497 .endd
9498 yields &"1"&.
9499
9500 When the second number is omitted from &%substr%&, the remainder of the string
9501 is taken if the offset is positive. If it is negative, all characters in the
9502 string preceding the offset point are taken. For example, an offset of -1 and
9503 no length, as in these semantically identical examples:
9504 .code
9505 ${substr_-1:abcde}
9506 ${substr{-1}{abcde}}
9507 .endd
9508 yields all but the last character of the string, that is, &"abcd"&.
9509
9510
9511
9512 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9513         {*&<&'replacements'&>&*}}*&"
9514 .cindex "expansion" "character translation"
9515 .cindex "&%tr%& expansion item"
9516 This item does single-character translation on its subject string. The second
9517 argument is a list of characters to be translated in the subject string. Each
9518 matching character is replaced by the corresponding character from the
9519 replacement list. For example
9520 .code
9521 ${tr{abcdea}{ac}{13}}
9522 .endd
9523 yields &`1b3de1`&. If there are duplicates in the second character string, the
9524 last occurrence is used. If the third string is shorter than the second, its
9525 last character is replicated. However, if it is empty, no translation takes
9526 place.
9527 .endlist
9528
9529
9530
9531 .section "Expansion operators" "SECTexpop"
9532 .cindex "expansion" "operators"
9533 For expansion items that perform transformations on a single argument string,
9534 the &"operator"& notation is used because it is simpler and uses fewer braces.
9535 The substring is first expanded before the operation is applied to it. The
9536 following operations can be performed:
9537
9538 .vlist
9539 .vitem &*${address:*&<&'string'&>&*}*&
9540 .cindex "expansion" "RFC 2822 address handling"
9541 .cindex "&%address%& expansion item"
9542 The string is interpreted as an RFC 2822 address, as it might appear in a
9543 header line, and the effective address is extracted from it. If the string does
9544 not parse successfully, the result is empty.
9545
9546
9547 .vitem &*${addresses:*&<&'string'&>&*}*&
9548 .cindex "expansion" "RFC 2822 address handling"
9549 .cindex "&%addresses%& expansion item"
9550 The string (after expansion) is interpreted as a list of addresses in RFC
9551 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9552 operative address (&'local-part@domain'&) is extracted from each item, and the
9553 result of the expansion is a colon-separated list, with appropriate
9554 doubling of colons should any happen to be present in the email addresses.
9555 Syntactically invalid RFC2822 address items are omitted from the output.
9556
9557 It is possible to specify a character other than colon for the output
9558 separator by starting the string with > followed by the new separator
9559 character. For example:
9560 .code
9561 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9562 .endd
9563 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9564 expansion item, which extracts the working address from a single RFC2822
9565 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9566 processing lists.
9567
9568
9569 .vitem &*${base62:*&<&'digits'&>&*}*&
9570 .cindex "&%base62%& expansion item"
9571 .cindex "expansion" "conversion to base 62"
9572 The string must consist entirely of decimal digits. The number is converted to
9573 base 62 and output as a string of six characters, including leading zeros. In
9574 the few operating environments where Exim uses base 36 instead of base 62 for
9575 its message identifiers (because those systems do not have case-sensitive file
9576 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9577 be absolutely clear: this is &'not'& base64 encoding.
9578
9579 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9580 .cindex "&%base62d%& expansion item"
9581 .cindex "expansion" "conversion to base 62"
9582 The string must consist entirely of base-62 digits, or, in operating
9583 environments where Exim uses base 36 instead of base 62 for its message
9584 identifiers, base-36 digits. The number is converted to decimal and output as a
9585 string.
9586
9587
9588 .vitem &*${domain:*&<&'string'&>&*}*&
9589 .cindex "domain" "extraction"
9590 .cindex "expansion" "domain extraction"
9591 The string is interpreted as an RFC 2822 address and the domain is extracted
9592 from it. If the string does not parse successfully, the result is empty.
9593
9594
9595 .vitem &*${escape:*&<&'string'&>&*}*&
9596 .cindex "expansion" "escaping non-printing characters"
9597 .cindex "&%escape%& expansion item"
9598 If the string contains any non-printing characters, they are converted to
9599 escape sequences starting with a backslash. Whether characters with the most
9600 significant bit set (so-called &"8-bit characters"&) count as printing or not
9601 is controlled by the &%print_topbitchars%& option.
9602
9603
9604 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9605 .cindex "expansion" "expression evaluation"
9606 .cindex "expansion" "arithmetic expression"
9607 .cindex "&%eval%& expansion item"
9608 These items supports simple arithmetic and bitwise logical operations in
9609 expansion strings. The string (after expansion) must be a conventional
9610 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9611 logical operators, and parentheses. All operations are carried out using
9612 integer arithmetic. The operator priorities are as follows (the same as in the
9613 C programming language):
9614 .table2 70pt 300pt
9615 .irow &'highest:'& "not (~), negate (-)"
9616 .irow ""   "multiply (*), divide (/), remainder (%)"
9617 .irow ""   "plus (+), minus (-)"
9618 .irow ""   "shift-left (<<), shift-right (>>)"
9619 .irow ""   "and (&&)"
9620 .irow ""   "xor (^)"
9621 .irow &'lowest:'&  "or (|)"
9622 .endtable
9623 Binary operators with the same priority are evaluated from left to right. White
9624 space is permitted before or after operators.
9625
9626 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9627 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9628 decimal, even if they start with a leading zero; hexadecimal numbers are not
9629 permitted. This can be useful when processing numbers extracted from dates or
9630 times, which often do have leading zeros.
9631
9632 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9633 or 1024*1024*1024,
9634 respectively. Negative numbers are supported. The result of the computation is
9635 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9636
9637 .display
9638 &`${eval:1+1}            `&  yields 2
9639 &`${eval:1+2*3}          `&  yields 7
9640 &`${eval:(1+2)*3}        `&  yields 9
9641 &`${eval:2+42%5}         `&  yields 4
9642 &`${eval:0xc&amp;5}          `&  yields 4
9643 &`${eval:0xc|5}          `&  yields 13
9644 &`${eval:0xc^5}          `&  yields 9
9645 &`${eval:0xc>>1}         `&  yields 6
9646 &`${eval:0xc<<1}         `&  yields 24
9647 &`${eval:~255&amp;0x1234}    `&  yields 4608
9648 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9649 .endd
9650
9651 As a more realistic example, in an ACL you might have
9652 .code
9653 deny   message = Too many bad recipients
9654        condition =                    \
9655          ${if and {                   \
9656            {>{$rcpt_count}{10}}       \
9657            {                          \
9658            <                          \
9659              {$recipients_count}      \
9660              {${eval:$rcpt_count/2}}  \
9661            }                          \
9662          }{yes}{no}}
9663 .endd
9664 The condition is true if there have been more than 10 RCPT commands and
9665 fewer than half of them have resulted in a valid recipient.
9666
9667
9668 .vitem &*${expand:*&<&'string'&>&*}*&
9669 .cindex "expansion" "re-expansion of substring"
9670 The &%expand%& operator causes a string to be expanded for a second time. For
9671 example,
9672 .code
9673 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9674 .endd
9675 first looks up a string in a file while expanding the operand for &%expand%&,
9676 and then re-expands what it has found.
9677
9678
9679 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9680 .cindex "Unicode"
9681 .cindex "UTF-8" "conversion from"
9682 .cindex "expansion" "UTF-8 conversion"
9683 .cindex "&%from_utf8%& expansion item"
9684 The world is slowly moving towards Unicode, although there are no standards for
9685 email yet. However, other applications (including some databases) are starting
9686 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9687 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9688 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9689 the result is an undefined sequence of bytes.
9690
9691 Unicode code points with values less than 256 are compatible with ASCII and
9692 ISO-8859-1 (also known as Latin-1).
9693 For example, character 169 is the copyright symbol in both cases, though the
9694 way it is encoded is different. In UTF-8, more than one byte is needed for
9695 characters with code values greater than 127, whereas ISO-8859-1 is a
9696 single-byte encoding (but thereby limited to 256 characters). This makes
9697 translation from UTF-8 to ISO-8859-1 straightforward.
9698
9699
9700 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9701 .cindex "hash function" "textual"
9702 .cindex "expansion" "textual hash"
9703 The &%hash%& operator is a simpler interface to the hashing function that can
9704 be used when the two parameters are fixed numbers (as opposed to strings that
9705 change when expanded). The effect is the same as
9706 .code
9707 ${hash{<n>}{<m>}{<string>}}
9708 .endd
9709 See the description of the general &%hash%& item above for details. The
9710 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9711
9712
9713
9714 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9715 .cindex "base64 encoding" "conversion from hex"
9716 .cindex "expansion" "hex to base64"
9717 .cindex "&%hex2b64%& expansion item"
9718 This operator converts a hex string into one that is base64 encoded. This can
9719 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9720
9721
9722 .vitem &*${lc:*&<&'string'&>&*}*&
9723 .cindex "case forcing in strings"
9724 .cindex "string" "case forcing"
9725 .cindex "lower casing"
9726 .cindex "expansion" "case forcing"
9727 .cindex "&%lc%& expansion item"
9728 This forces the letters in the string into lower-case, for example:
9729 .code
9730 ${lc:$local_part}
9731 .endd
9732
9733 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9734 .cindex "expansion" "string truncation"
9735 .cindex "&%length%& expansion item"
9736 The &%length%& operator is a simpler interface to the &%length%& function that
9737 can be used when the parameter is a fixed number (as opposed to a string that
9738 changes when expanded). The effect is the same as
9739 .code
9740 ${length{<number>}{<string>}}
9741 .endd
9742 See the description of the general &%length%& item above for details. Note that
9743 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9744 when &%length%& is used as an operator.
9745
9746
9747 .vitem &*${listcount:*&<&'string'&>&*}*&
9748 .cindex "expansion" "list item count"
9749 .cindex "list" "item count"
9750 .cindex "list" "count of items"
9751 .cindex "&%listcount%& expansion item"
9752 The string is interpreted as a list and the number of items is returned.
9753
9754
9755 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${list_*&<&'type'&>&*name'&>&*}*&
9756 .cindex "expansion" "named list"
9757 .cindex "&%listnamed%& expansion item"
9758 The name is interpreted as a named list and the content of the list is returned,
9759 expanding any referenced lists, re-quoting as needed for colon-separation.
9760 If the optional type if given it must be one of "a", "d", "h" or "l"
9761 and selects address-, domain-, host- or localpart- lists to search among respectively.
9762 Otherwise all types are searched in an undefined order and the first
9763 matching list is returned.
9764
9765
9766 .vitem &*${local_part:*&<&'string'&>&*}*&
9767 .cindex "expansion" "local part extraction"
9768 .cindex "&%local_part%& expansion item"
9769 The string is interpreted as an RFC 2822 address and the local part is
9770 extracted from it. If the string does not parse successfully, the result is
9771 empty.
9772
9773
9774 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9775 .cindex "masked IP address"
9776 .cindex "IP address" "masking"
9777 .cindex "CIDR notation"
9778 .cindex "expansion" "IP address masking"
9779 .cindex "&%mask%& expansion item"
9780 If the form of the string to be operated on is not an IP address followed by a
9781 slash and an integer (that is, a network address in CIDR notation), the
9782 expansion fails. Otherwise, this operator converts the IP address to binary,
9783 masks off the least significant bits according to the bit count, and converts
9784 the result back to text, with mask appended. For example,
9785 .code
9786 ${mask:10.111.131.206/28}
9787 .endd
9788 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9789 be mostly used for looking up masked addresses in files, the result for an IPv6
9790 address uses dots to separate components instead of colons, because colon
9791 terminates a key string in lsearch files. So, for example,
9792 .code
9793 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9794 .endd
9795 returns the string
9796 .code
9797 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9798 .endd
9799 Letters in IPv6 addresses are always output in lower case.
9800
9801
9802 .vitem &*${md5:*&<&'string'&>&*}*&
9803 .cindex "MD5 hash"
9804 .cindex "expansion" "MD5 hash"
9805 .cindex "&%md5%& expansion item"
9806 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9807 as a 32-digit hexadecimal number, in which any letters are in lower case.
9808
9809
9810 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9811 .cindex "expansion" "numeric hash"
9812 .cindex "hash function" "numeric"
9813 The &%nhash%& operator is a simpler interface to the numeric hashing function
9814 that can be used when the two parameters are fixed numbers (as opposed to
9815 strings that change when expanded). The effect is the same as
9816 .code
9817 ${nhash{<n>}{<m>}{<string>}}
9818 .endd
9819 See the description of the general &%nhash%& item above for details.
9820
9821
9822 .vitem &*${quote:*&<&'string'&>&*}*&
9823 .cindex "quoting" "in string expansions"
9824 .cindex "expansion" "quoting"
9825 .cindex "&%quote%& expansion item"
9826 The &%quote%& operator puts its argument into double quotes if it
9827 is an empty string or
9828 contains anything other than letters, digits, underscores, dots, and hyphens.
9829 Any occurrences of double quotes and backslashes are escaped with a backslash.
9830 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9831 respectively For example,
9832 .code
9833 ${quote:ab"*"cd}
9834 .endd
9835 becomes
9836 .code
9837 "ab\"*\"cd"
9838 .endd
9839 The place where this is useful is when the argument is a substitution from a
9840 variable or a message header.
9841
9842 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9843 .cindex "&%quote_local_part%& expansion item"
9844 This operator is like &%quote%&, except that it quotes the string only if
9845 required to do so by the rules of RFC 2822 for quoting local parts. For
9846 example, a plus sign would not cause quoting (but it would for &%quote%&).
9847 If you are creating a new email address from the contents of &$local_part$&
9848 (or any other unknown data), you should always use this operator.
9849
9850
9851 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9852 .cindex "quoting" "lookup-specific"
9853 This operator applies lookup-specific quoting rules to the string. Each
9854 query-style lookup type has its own quoting rules which are described with
9855 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9856 .code
9857 ${quote_ldap:two * two}
9858 .endd
9859 returns
9860 .code
9861 two%20%5C2A%20two
9862 .endd
9863 For single-key lookup types, no quoting is ever necessary and this operator
9864 yields an unchanged string.
9865
9866
9867 .vitem &*${randint:*&<&'n'&>&*}*&
9868 .cindex "random number"
9869 This operator returns a somewhat random number which is less than the
9870 supplied number and is at least 0.  The quality of this randomness depends
9871 on how Exim was built; the values are not suitable for keying material.
9872 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9873 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
9874 for versions of GnuTLS with that function.
9875 Otherwise, the implementation may be arc4random(), random() seeded by
9876 srandomdev() or srandom(), or a custom implementation even weaker than
9877 random().
9878
9879
9880 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9881 .cindex "expansion" "IP address"
9882 This operator reverses an IP address; for IPv4 addresses, the result is in
9883 dotted-quad decimal form, while for IPv6 addreses the result is in
9884 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9885 for DNS.  For example,
9886 .code
9887 ${reverse_ip:192.0.2.4}
9888 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9889 .endd
9890 returns
9891 .code
9892 4.2.0.192
9893 3.0.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
9894 .endd
9895
9896
9897 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9898 .cindex "expansion" "RFC 2047"
9899 .cindex "RFC 2047" "expansion operator"
9900 .cindex "&%rfc2047%& expansion item"
9901 This operator encodes text according to the rules of RFC 2047. This is an
9902 encoding that is used in header lines to encode non-ASCII characters. It is
9903 assumed that the input string is in the encoding specified by the
9904 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9905 contains only characters in the range 33&--126, and no instances of the
9906 characters
9907 .code
9908 ? = ( ) < > @ , ; : \ " . [ ] _
9909 .endd
9910 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9911 string, using as many &"encoded words"& as necessary to encode all the
9912 characters.
9913
9914
9915 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9916 .cindex "expansion" "RFC 2047"
9917 .cindex "RFC 2047" "decoding"
9918 .cindex "&%rfc2047d%& expansion item"
9919 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9920 bytes are replaced by question marks. Characters are converted into the
9921 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9922 not recognized unless &%check_rfc2047_length%& is set false.
9923
9924 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9925 access a header line, RFC 2047 decoding is done automatically. You do not need
9926 to use this operator as well.
9927
9928
9929
9930 .vitem &*${rxquote:*&<&'string'&>&*}*&
9931 .cindex "quoting" "in regular expressions"
9932 .cindex "regular expressions" "quoting"
9933 .cindex "&%rxquote%& expansion item"
9934 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9935 characters in its argument. This is useful when substituting the values of
9936 variables or headers inside regular expressions.
9937
9938
9939 .vitem &*${sha1:*&<&'string'&>&*}*&
9940 .cindex "SHA-1 hash"
9941 .cindex "expansion" "SHA-1 hashing"
9942 .cindex "&%sha2%& expansion item"
9943 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9944 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9945
9946
9947 .vitem &*${stat:*&<&'string'&>&*}*&
9948 .cindex "expansion" "statting a file"
9949 .cindex "file" "extracting characteristics"
9950 .cindex "&%stat%& expansion item"
9951 The string, after expansion, must be a file path. A call to the &[stat()]&
9952 function is made for this path. If &[stat()]& fails, an error occurs and the
9953 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9954 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9955 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9956 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9957 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9958 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9959 can extract individual fields using the &%extract%& expansion item.
9960
9961 The use of the &%stat%& expansion in users' filter files can be locked out by
9962 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9963 systems for files larger than 2GB.
9964
9965 .vitem &*${str2b64:*&<&'string'&>&*}*&
9966 .cindex "expansion" "base64 encoding"
9967 .cindex "base64 encoding" "in string expansion"
9968 .cindex "&%str2b64%& expansion item"
9969 This operator converts a string into one that is base64 encoded.
9970
9971
9972
9973 .vitem &*${strlen:*&<&'string'&>&*}*&
9974 .cindex "expansion" "string length"
9975 .cindex "string" "length in expansion"
9976 .cindex "&%strlen%& expansion item"
9977 The item is replace by the length of the expanded string, expressed as a
9978 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9979
9980
9981 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9982 .cindex "&%substr%& expansion item"
9983 .cindex "substring extraction"
9984 .cindex "expansion" "substring expansion"
9985 The &%substr%& operator is a simpler interface to the &%substr%& function that
9986 can be used when the two parameters are fixed numbers (as opposed to strings
9987 that change when expanded). The effect is the same as
9988 .code
9989 ${substr{<start>}{<length>}{<string>}}
9990 .endd
9991 See the description of the general &%substr%& item above for details. The
9992 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9993
9994 .vitem &*${time_eval:*&<&'string'&>&*}*&
9995 .cindex "&%time_eval%& expansion item"
9996 .cindex "time interval" "decoding"
9997 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9998 seconds.
9999
10000 .vitem &*${time_interval:*&<&'string'&>&*}*&
10001 .cindex "&%time_interval%& expansion item"
10002 .cindex "time interval" "formatting"
10003 The argument (after sub-expansion) must be a sequence of decimal digits that
10004 represents an interval of time as a number of seconds. It is converted into a
10005 number of larger units and output in Exim's normal time format, for example,
10006 &`1w3d4h2m6s`&.
10007
10008 .vitem &*${uc:*&<&'string'&>&*}*&
10009 .cindex "case forcing in strings"
10010 .cindex "string" "case forcing"
10011 .cindex "upper casing"
10012 .cindex "expansion" "case forcing"
10013 .cindex "&%uc%& expansion item"
10014 This forces the letters in the string into upper-case.
10015 .endlist
10016
10017
10018
10019
10020
10021
10022 .section "Expansion conditions" "SECTexpcond"
10023 .scindex IIDexpcond "expansion" "conditions"
10024 The following conditions are available for testing by the &%${if%& construct
10025 while expanding strings:
10026
10027 .vlist
10028 .vitem &*!*&<&'condition'&>
10029 .cindex "expansion" "negating a condition"
10030 .cindex "negation" "in expansion condition"
10031 Preceding any condition with an exclamation mark negates the result of the
10032 condition.
10033
10034 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10035 .cindex "numeric comparison"
10036 .cindex "expansion" "numeric comparison"
10037 There are a number of symbolic operators for doing numeric comparisons. They
10038 are:
10039 .display
10040 &`=   `&   equal
10041 &`==  `&   equal
10042 &`>   `&   greater
10043 &`>=  `&   greater or equal
10044 &`<   `&   less
10045 &`<=  `&   less or equal
10046 .endd
10047 For example:
10048 .code
10049 ${if >{$message_size}{10M} ...
10050 .endd
10051 Note that the general negation operator provides for inequality testing. The
10052 two strings must take the form of optionally signed decimal integers,
10053 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10054 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10055 As a special case, the numerical value of an empty string is taken as
10056 zero.
10057
10058 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10059 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10060 10M, not if 10M is larger than &$message_size$&.
10061
10062
10063 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10064         {*&<&'arg2'&>&*}...}*&
10065 .cindex "expansion" "calling an acl"
10066 .cindex "&%acl%&" "expansion condition"
10067 The name and zero to nine argument strings are first expanded separately.  The expanded
10068 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10069 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10070 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10071 and may use the variables; if another acl expansion is used the values
10072 are overwritten.  If the ACL sets
10073 a value using a "message =" modifier the variable $value becomes
10074 the result of the expansion, otherwise it is empty.
10075 If the ACL returns accept the condition is true; if deny, false.
10076 If the ACL returns defer the result is a forced-fail.
10077
10078 .vitem &*bool&~{*&<&'string'&>&*}*&
10079 .cindex "expansion" "boolean parsing"
10080 .cindex "&%bool%& expansion condition"
10081 This condition turns a string holding a true or false representation into
10082 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10083 (case-insensitively); also positive integer numbers map to true if non-zero,
10084 false if zero.
10085 An empty string is treated as false.
10086 Leading and trailing whitespace is ignored;
10087 thus a string consisting only of whitespace is false.
10088 All other string values will result in expansion failure.
10089
10090 When combined with ACL variables, this expansion condition will let you
10091 make decisions in one place and act on those decisions in another place.
10092 For example:
10093 .code
10094 ${if bool{$acl_m_privileged_sender} ...
10095 .endd
10096
10097
10098 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10099 .cindex "expansion" "boolean parsing"
10100 .cindex "&%bool_lax%& expansion condition"
10101 Like &%bool%&, this condition turns a string into a boolean state.  But
10102 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10103 loose definition that the Router &%condition%& option uses.  The empty string
10104 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10105 true.  Leading and trailing whitespace is ignored.
10106
10107 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10108
10109 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10110 .cindex "expansion" "encrypted comparison"
10111 .cindex "encrypted strings, comparing"
10112 .cindex "&%crypteq%& expansion condition"
10113 This condition is included in the Exim binary if it is built to support any
10114 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10115 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10116 included in the binary.
10117
10118 The &%crypteq%& condition has two arguments. The first is encrypted and
10119 compared against the second, which is already encrypted. The second string may
10120 be in the LDAP form for storing encrypted strings, which starts with the
10121 encryption type in curly brackets, followed by the data. If the second string
10122 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10123 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10124 Typically this will be a field from a password file. An example of an encrypted
10125 string in LDAP form is:
10126 .code
10127 {md5}CY9rzUYh03PK3k6DJie09g==
10128 .endd
10129 If such a string appears directly in an expansion, the curly brackets have to
10130 be quoted, because they are part of the expansion syntax. For example:
10131 .code
10132 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10133 .endd
10134 The following encryption types (whose names are matched case-independently) are
10135 supported:
10136
10137 .ilist
10138 .cindex "MD5 hash"
10139 .cindex "base64 encoding" "in encrypted password"
10140 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10141 printable characters to compare with the remainder of the second string. If the
10142 length of the comparison string is 24, Exim assumes that it is base64 encoded
10143 (as in the above example). If the length is 32, Exim assumes that it is a
10144 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10145 comparison fails.
10146
10147 .next
10148 .cindex "SHA-1 hash"
10149 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10150 printable characters to compare with the remainder of the second string. If the
10151 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10152 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10153 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10154
10155 .next
10156 .cindex "&[crypt()]&"
10157 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10158 only the first eight characters of the password. However, in modern operating
10159 systems this is no longer true, and in many cases the entire password is used,
10160 whatever its length.
10161
10162 .next
10163 .cindex "&[crypt16()]&"
10164 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10165 use up to 16 characters of the password in some operating systems. Again, in
10166 modern operating systems, more characters may be used.
10167 .endlist
10168 Exim has its own version of &[crypt16()]&, which is just a double call to
10169 &[crypt()]&. For operating systems that have their own version, setting
10170 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10171 operating system version instead of its own. This option is set by default in
10172 the OS-dependent &_Makefile_& for those operating systems that are known to
10173 support &[crypt16()]&.
10174
10175 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10176 it was not using the same algorithm as some operating systems' versions. It
10177 turns out that as well as &[crypt16()]& there is a function called
10178 &[bigcrypt()]& in some operating systems. This may or may not use the same
10179 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10180
10181 However, since there is now a move away from the traditional &[crypt()]&
10182 functions towards using SHA1 and other algorithms, tidying up this area of
10183 Exim is seen as very low priority.
10184
10185 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10186 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10187 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10188 default is &`{crypt}`&. Whatever the default, you can always use either
10189 function by specifying it explicitly in curly brackets.
10190
10191 .vitem &*def:*&<&'variable&~name'&>
10192 .cindex "expansion" "checking for empty variable"
10193 .cindex "&%def%& expansion condition"
10194 The &%def%& condition must be followed by the name of one of the expansion
10195 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10196 variable does not contain the empty string. For example:
10197 .code
10198 ${if def:sender_ident {from $sender_ident}}
10199 .endd
10200 Note that the variable name is given without a leading &%$%& character. If the
10201 variable does not exist, the expansion fails.
10202
10203 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10204         &~&*def:h_*&<&'header&~name'&>&*:*&"
10205 .cindex "expansion" "checking header line existence"
10206 This condition is true if a message is being processed and the named header
10207 exists in the message. For example,
10208 .code
10209 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10210 .endd
10211 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10212 the header name must be terminated by a colon if white space does not follow.
10213
10214 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10215        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10216 .cindex "string" "comparison"
10217 .cindex "expansion" "string comparison"
10218 .cindex "&%eq%& expansion condition"
10219 .cindex "&%eqi%& expansion condition"
10220 The two substrings are first expanded. The condition is true if the two
10221 resulting strings are identical. For &%eq%& the comparison includes the case of
10222 letters, whereas for &%eqi%& the comparison is case-independent.
10223
10224 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10225 .cindex "expansion" "file existence test"
10226 .cindex "file" "existence test"
10227 .cindex "&%exists%&, expansion condition"
10228 The substring is first expanded and then interpreted as an absolute path. The
10229 condition is true if the named file (or directory) exists. The existence test
10230 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10231 users' filter files may be locked out by the system administrator.
10232
10233 .vitem &*first_delivery*&
10234 .cindex "delivery" "first"
10235 .cindex "first delivery"
10236 .cindex "expansion" "first delivery test"
10237 .cindex "&%first_delivery%& expansion condition"
10238 This condition, which has no data, is true during a message's first delivery
10239 attempt. It is false during any subsequent delivery attempts.
10240
10241
10242 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10243        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10244 .cindex "list" "iterative conditions"
10245 .cindex "expansion" "&*forall*& condition"
10246 .cindex "expansion" "&*forany*& condition"
10247 .vindex "&$item$&"
10248 These conditions iterate over a list. The first argument is expanded to form
10249 the list. By default, the list separator is a colon, but it can be changed by
10250 the normal method. The second argument is interpreted as a condition that is to
10251 be applied to each item in the list in turn. During the interpretation of the
10252 condition, the current list item is placed in a variable called &$item$&.
10253 .ilist
10254 For &*forany*&, interpretation stops if the condition is true for any item, and
10255 the result of the whole condition is true. If the condition is false for all
10256 items in the list, the overall condition is false.
10257 .next
10258 For &*forall*&, interpretation stops if the condition is false for any item,
10259 and the result of the whole condition is false. If the condition is true for
10260 all items in the list, the overall condition is true.
10261 .endlist
10262 Note that negation of &*forany*& means that the condition must be false for all
10263 items for the overall condition to succeed, and negation of &*forall*& means
10264 that the condition must be false for at least one item. In this example, the
10265 list separator is changed to a comma:
10266 .code
10267 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10268 .endd
10269 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10270 being processed, to enable these expansion items to be nested.
10271
10272
10273 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10274        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10275 .cindex "string" "comparison"
10276 .cindex "expansion" "string comparison"
10277 .cindex "&%ge%& expansion condition"
10278 .cindex "&%gei%& expansion condition"
10279 The two substrings are first expanded. The condition is true if the first
10280 string is lexically greater than or equal to the second string. For &%ge%& the
10281 comparison includes the case of letters, whereas for &%gei%& the comparison is
10282 case-independent.
10283
10284 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10285        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10286 .cindex "string" "comparison"
10287 .cindex "expansion" "string comparison"
10288 .cindex "&%gt%& expansion condition"
10289 .cindex "&%gti%& expansion condition"
10290 The two substrings are first expanded. The condition is true if the first
10291 string is lexically greater than the second string. For &%gt%& the comparison
10292 includes the case of letters, whereas for &%gti%& the comparison is
10293 case-independent.
10294
10295 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10296        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10297 .cindex "string" "comparison"
10298 .cindex "list" "iterative conditions"
10299 Both strings are expanded; the second string is treated as a list of simple
10300 strings; if the first string is a member of the second, then the condition
10301 is true.
10302
10303 These are simpler to use versions of the more powerful &*forany*& condition.
10304 Examples, and the &*forany*& equivalents:
10305 .code
10306 ${if inlist{needle}{foo:needle:bar}}
10307   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10308 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10309   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10310 .endd
10311
10312 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10313        &*isip4&~{*&<&'string'&>&*}*& &&&
10314        &*isip6&~{*&<&'string'&>&*}*&
10315 .cindex "IP address" "testing string format"
10316 .cindex "string" "testing for IP address"
10317 .cindex "&%isip%& expansion condition"
10318 .cindex "&%isip4%& expansion condition"
10319 .cindex "&%isip6%& expansion condition"
10320 The substring is first expanded, and then tested to see if it has the form of
10321 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10322 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10323
10324 For an IPv4 address, the test is for four dot-separated components, each of
10325 which consists of from one to three digits. For an IPv6 address, up to eight
10326 colon-separated components are permitted, each containing from one to four
10327 hexadecimal digits. There may be fewer than eight components if an empty
10328 component (adjacent colons) is present. Only one empty component is permitted.
10329
10330 &*Note*&: The checks are just on the form of the address; actual numerical
10331 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10332 check. The main use of these tests is to distinguish between IP addresses and
10333 host names, or between IPv4 and IPv6 addresses. For example, you could use
10334 .code
10335 ${if isip4{$sender_host_address}...
10336 .endd
10337 to test which IP version an incoming SMTP connection is using.
10338
10339 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10340 .cindex "LDAP" "use for authentication"
10341 .cindex "expansion" "LDAP authentication test"
10342 .cindex "&%ldapauth%& expansion condition"
10343 This condition supports user authentication using LDAP. See section
10344 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10345 queries. For this use, the query must contain a user name and password. The
10346 query itself is not used, and can be empty. The condition is true if the
10347 password is not empty, and the user name and password are accepted by the LDAP
10348 server. An empty password is rejected without calling LDAP because LDAP binds
10349 with an empty password are considered anonymous regardless of the username, and
10350 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10351 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10352 this can be used.
10353
10354
10355 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10356        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10357 .cindex "string" "comparison"
10358 .cindex "expansion" "string comparison"
10359 .cindex "&%le%& expansion condition"
10360 .cindex "&%lei%& expansion condition"
10361 The two substrings are first expanded. The condition is true if the first
10362 string is lexically less than or equal to the second string. For &%le%& the
10363 comparison includes the case of letters, whereas for &%lei%& the comparison is
10364 case-independent.
10365
10366 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10367        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10368 .cindex "string" "comparison"
10369 .cindex "expansion" "string comparison"
10370 .cindex "&%lt%& expansion condition"
10371 .cindex "&%lti%& expansion condition"
10372 The two substrings are first expanded. The condition is true if the first
10373 string is lexically less than the second string. For &%lt%& the comparison
10374 includes the case of letters, whereas for &%lti%& the comparison is
10375 case-independent.
10376
10377
10378 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10379 .cindex "expansion" "regular expression comparison"
10380 .cindex "regular expressions" "match in expanded string"
10381 .cindex "&%match%& expansion condition"
10382 The two substrings are first expanded. The second is then treated as a regular
10383 expression and applied to the first. Because of the pre-expansion, if the
10384 regular expression contains dollar, or backslash characters, they must be
10385 escaped. Care must also be taken if the regular expression contains braces
10386 (curly brackets). A closing brace must be escaped so that it is not taken as a
10387 premature termination of <&'string2'&>. The easiest approach is to use the
10388 &`\N`& feature to disable expansion of the regular expression.
10389 For example,
10390 .code
10391 ${if match {$local_part}{\N^\d{3}\N} ...
10392 .endd
10393 If the whole expansion string is in double quotes, further escaping of
10394 backslashes is also required.
10395
10396 The condition is true if the regular expression match succeeds.
10397 The regular expression is not required to begin with a circumflex
10398 metacharacter, but if there is no circumflex, the expression is not anchored,
10399 and it may match anywhere in the subject, not just at the start. If you want
10400 the pattern to match at the end of the subject, you must include the &`$`&
10401 metacharacter at an appropriate point.
10402
10403 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10404 At the start of an &%if%& expansion the values of the numeric variable
10405 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10406 succeeds causes them to be reset to the substrings of that condition and they
10407 will have these values during the expansion of the success string. At the end
10408 of the &%if%& expansion, the previous values are restored. After testing a
10409 combination of conditions using &%or%&, the subsequent values of the numeric
10410 variables are those of the condition that succeeded.
10411
10412 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10413 .cindex "&%match_address%& expansion condition"
10414 See &*match_local_part*&.
10415
10416 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10417 .cindex "&%match_domain%& expansion condition"
10418 See &*match_local_part*&.
10419
10420 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10421 .cindex "&%match_ip%& expansion condition"
10422 This condition matches an IP address to a list of IP address patterns. It must
10423 be followed by two argument strings. The first (after expansion) must be an IP
10424 address or an empty string. The second (not expanded) is a restricted host
10425 list that can match only an IP address, not a host name. For example:
10426 .code
10427 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10428 .endd
10429 The specific types of host list item that are permitted in the list are:
10430
10431 .ilist
10432 An IP address, optionally with a CIDR mask.
10433 .next
10434 A single asterisk, which matches any IP address.
10435 .next
10436 An empty item, which matches only if the IP address is empty. This could be
10437 useful for testing for a locally submitted message or one from specific hosts
10438 in a single test such as
10439 . ==== As this is a nested list, any displays it contains must be indented
10440 . ==== as otherwise they are too far to the left. This comment applies to
10441 . ==== the use of xmlto plus fop. There's no problem when formatting with
10442 . ==== sdop, with or without the extra indent.
10443 .code
10444   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10445 .endd
10446 where the first item in the list is the empty string.
10447 .next
10448 The item @[] matches any of the local host's interface addresses.
10449 .next
10450 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10451 even if &`net-`& is not specified. There is never any attempt to turn the IP
10452 address into a host name. The most common type of linear search for
10453 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10454 masks. For example:
10455 .code
10456   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10457 .endd
10458 It is of course possible to use other kinds of lookup, and in such a case, you
10459 do need to specify the &`net-`& prefix if you want to specify a specific
10460 address mask, for example:
10461 .code
10462   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10463 .endd
10464 However, unless you are combining a &%match_ip%& condition with others, it is
10465 just as easy to use the fact that a lookup is itself a condition, and write:
10466 .code
10467   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10468 .endd
10469 .endlist ilist
10470
10471 Note that <&'string2'&> is not itself subject to string expansion, unless
10472 Exim was built with the EXPAND_LISTMATCH_RHS option.
10473
10474 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10475
10476 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10477 .cindex "domain list" "in expansion condition"
10478 .cindex "address list" "in expansion condition"
10479 .cindex "local part" "list, in expansion condition"
10480 .cindex "&%match_local_part%& expansion condition"
10481 This condition, together with &%match_address%& and &%match_domain%&, make it
10482 possible to test domain, address, and local part lists within expansions. Each
10483 condition requires two arguments: an item and a list to match. A trivial
10484 example is:
10485 .code
10486 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10487 .endd
10488 In each case, the second argument may contain any of the allowable items for a
10489 list of the appropriate type. Also, because the second argument (after
10490 expansion) is a standard form of list, it is possible to refer to a named list.
10491 Thus, you can use conditions like this:
10492 .code
10493 ${if match_domain{$domain}{+local_domains}{...
10494 .endd
10495 .cindex "&`+caseful`&"
10496 For address lists, the matching starts off caselessly, but the &`+caseful`&
10497 item can be used, as in all address lists, to cause subsequent items to
10498 have their local parts matched casefully. Domains are always matched
10499 caselessly.
10500
10501 Note that <&'string2'&> is not itself subject to string expansion, unless
10502 Exim was built with the EXPAND_LISTMATCH_RHS option.
10503
10504 &*Note*&: Host lists are &'not'& supported in this way. This is because
10505 hosts have two identities: a name and an IP address, and it is not clear
10506 how to specify cleanly how such a test would work. However, IP addresses can be
10507 matched using &%match_ip%&.
10508
10509 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10510 .cindex "PAM authentication"
10511 .cindex "AUTH" "with PAM"
10512 .cindex "Solaris" "PAM support"
10513 .cindex "expansion" "PAM authentication test"
10514 .cindex "&%pam%& expansion condition"
10515 &'Pluggable Authentication Modules'&
10516 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10517 available in the latest releases of Solaris and in some GNU/Linux
10518 distributions. The Exim support, which is intended for use in conjunction with
10519 the SMTP AUTH command, is available only if Exim is compiled with
10520 .code
10521 SUPPORT_PAM=yes
10522 .endd
10523 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10524 in some releases of GNU/Linux &%-ldl%& is also needed.
10525
10526 The argument string is first expanded, and the result must be a
10527 colon-separated list of strings. Leading and trailing white space is ignored.
10528 The PAM module is initialized with the service name &"exim"& and the user name
10529 taken from the first item in the colon-separated data string (<&'string1'&>).
10530 The remaining items in the data string are passed over in response to requests
10531 from the authentication function. In the simple case there will only be one
10532 request, for a password, so the data consists of just two strings.
10533
10534 There can be problems if any of the strings are permitted to contain colon
10535 characters. In the usual way, these have to be doubled to avoid being taken as
10536 separators. If the data is being inserted from a variable, the &%sg%& expansion
10537 item can be used to double any existing colons. For example, the configuration
10538 of a LOGIN authenticator might contain this setting:
10539 .code
10540 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10541 .endd
10542 For a PLAIN authenticator you could use:
10543 .code
10544 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10545 .endd
10546 In some operating systems, PAM authentication can be done only from a process
10547 running as root. Since Exim is running as the Exim user when receiving
10548 messages, this means that PAM cannot be used directly in those systems.
10549 A patched version of the &'pam_unix'& module that comes with the
10550 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10551 The patched module allows one special uid/gid combination, in addition to root,
10552 to authenticate. If you build the patched module to allow the Exim user and
10553 group, PAM can then be used from an Exim authenticator.
10554
10555
10556 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10557 .cindex "&'pwcheck'& daemon"
10558 .cindex "Cyrus"
10559 .cindex "expansion" "&'pwcheck'& authentication test"
10560 .cindex "&%pwcheck%& expansion condition"
10561 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10562 This is one way of making it possible for passwords to be checked by a process
10563 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10564 deprecated. Its replacement is &'saslauthd'& (see below).
10565
10566 The pwcheck support is not included in Exim by default. You need to specify
10567 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10568 building Exim. For example:
10569 .code
10570 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10571 .endd
10572 You do not need to install the full Cyrus software suite in order to use
10573 the pwcheck daemon. You can compile and install just the daemon alone
10574 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10575 access to the &_/var/pwcheck_& directory.
10576
10577 The &%pwcheck%& condition takes one argument, which must be the user name and
10578 password, separated by a colon. For example, in a LOGIN authenticator
10579 configuration, you might have this:
10580 .code
10581 server_condition = ${if pwcheck{$auth1:$auth2}}
10582 .endd
10583 Again, for a PLAIN authenticator configuration, this would be:
10584 .code
10585 server_condition = ${if pwcheck{$auth2:$auth3}}
10586 .endd
10587 .vitem &*queue_running*&
10588 .cindex "queue runner" "detecting when delivering from"
10589 .cindex "expansion" "queue runner test"
10590 .cindex "&%queue_running%& expansion condition"
10591 This condition, which has no data, is true during delivery attempts that are
10592 initiated by queue runner processes, and false otherwise.
10593
10594
10595 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10596 .cindex "Radius"
10597 .cindex "expansion" "Radius authentication"
10598 .cindex "&%radius%& expansion condition"
10599 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10600 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10601 the Radius client configuration file in order to build Exim with Radius
10602 support.
10603
10604 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10605 library, using the original API. If you are using release 0.4.0 or later of
10606 this library, you need to set
10607 .code
10608 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10609 .endd
10610 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10611 &%libradius%& library that comes with FreeBSD. To do this, set
10612 .code
10613 RADIUS_LIB_TYPE=RADLIB
10614 .endd
10615 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10616 You may also have to supply a suitable setting in EXTRALIBS so that the
10617 Radius library can be found when Exim is linked.
10618
10619 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10620 Radius client library, which calls the Radius server. The condition is true if
10621 the authentication is successful. For example:
10622 .code
10623 server_condition = ${if radius{<arguments>}}
10624 .endd
10625
10626
10627 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10628         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10629 .cindex "&'saslauthd'& daemon"
10630 .cindex "Cyrus"
10631 .cindex "expansion" "&'saslauthd'& authentication test"
10632 .cindex "&%saslauthd%& expansion condition"
10633 This condition supports user authentication using the Cyrus &'saslauthd'&
10634 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10635 Using this daemon is one way of making it possible for passwords to be checked
10636 by a process that is not running as root.
10637
10638 The saslauthd support is not included in Exim by default. You need to specify
10639 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10640 building Exim. For example:
10641 .code
10642 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10643 .endd
10644 You do not need to install the full Cyrus software suite in order to use
10645 the saslauthd daemon. You can compile and install just the daemon alone
10646 from the Cyrus SASL library.
10647
10648 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10649 two are mandatory. For example:
10650 .code
10651 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10652 .endd
10653 The service and the realm are optional (which is why the arguments are enclosed
10654 in their own set of braces). For details of the meaning of the service and
10655 realm, and how to run the daemon, consult the Cyrus documentation.
10656 .endlist vlist
10657
10658
10659
10660 .section "Combining expansion conditions" "SECID84"
10661 .cindex "expansion" "combining conditions"
10662 Several conditions can be tested at once by combining them using the &%and%&
10663 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10664 conditions on their own, and precede their lists of sub-conditions. Each
10665 sub-condition must be enclosed in braces within the overall braces that contain
10666 the list. No repetition of &%if%& is used.
10667
10668
10669 .vlist
10670 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10671 .cindex "&""or""& expansion condition"
10672 .cindex "expansion" "&""or""& of conditions"
10673 The sub-conditions are evaluated from left to right. The condition is true if
10674 any one of the sub-conditions is true.
10675 For example,
10676 .code
10677 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10678 .endd
10679 When a true sub-condition is found, the following ones are parsed but not
10680 evaluated. If there are several &"match"& sub-conditions the values of the
10681 numeric variables afterwards are taken from the first one that succeeds.
10682
10683 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10684 .cindex "&""and""& expansion condition"
10685 .cindex "expansion" "&""and""& of conditions"
10686 The sub-conditions are evaluated from left to right. The condition is true if
10687 all of the sub-conditions are true. If there are several &"match"&
10688 sub-conditions, the values of the numeric variables afterwards are taken from
10689 the last one. When a false sub-condition is found, the following ones are
10690 parsed but not evaluated.
10691 .endlist
10692 .ecindex IIDexpcond
10693
10694
10695
10696
10697 .section "Expansion variables" "SECTexpvar"
10698 .cindex "expansion" "variables, list of"
10699 This section contains an alphabetical list of all the expansion variables. Some
10700 of them are available only when Exim is compiled with specific options such as
10701 support for TLS or the content scanning extension.
10702
10703 .vlist
10704 .vitem "&$0$&, &$1$&, etc"
10705 .cindex "numerical variables (&$1$& &$2$& etc)"
10706 When a &%match%& expansion condition succeeds, these variables contain the
10707 captured substrings identified by the regular expression during subsequent
10708 processing of the success string of the containing &%if%& expansion item.
10709 However, they do not retain their values afterwards; in fact, their previous
10710 values are restored at the end of processing an &%if%& item. The numerical
10711 variables may also be set externally by some other matching process which
10712 precedes the expansion of the string. For example, the commands available in
10713 Exim filter files include an &%if%& command with its own regular expression
10714 matching condition.
10715
10716 .vitem "&$acl_c...$&"
10717 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10718 can be given any name that starts with &$acl_c$& and is at least six characters
10719 long, but the sixth character must be either a digit or an underscore. For
10720 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10721 variables persist throughout the lifetime of an SMTP connection. They can be
10722 used to pass information between ACLs and between different invocations of the
10723 same ACL. When a message is received, the values of these variables are saved
10724 with the message, and can be accessed by filters, routers, and transports
10725 during subsequent delivery.
10726
10727 .vitem "&$acl_m...$&"
10728 These variables are like the &$acl_c...$& variables, except that their values
10729 are reset after a message has been received. Thus, if several messages are
10730 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10731 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10732 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10733 message is received, the values of these variables are saved with the message,
10734 and can be accessed by filters, routers, and transports during subsequent
10735 delivery.
10736
10737 .vitem &$acl_verify_message$&
10738 .vindex "&$acl_verify_message$&"
10739 After an address verification has failed, this variable contains the failure
10740 message. It retains its value for use in subsequent modifiers. The message can
10741 be preserved by coding like this:
10742 .code
10743 warn !verify = sender
10744      set acl_m0 = $acl_verify_message
10745 .endd
10746 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10747 &%log_message%& modifiers, to include information about the verification
10748 failure.
10749
10750 .vitem &$address_data$&
10751 .vindex "&$address_data$&"
10752 This variable is set by means of the &%address_data%& option in routers. The
10753 value then remains with the address while it is processed by subsequent routers
10754 and eventually a transport. If the transport is handling multiple addresses,
10755 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10756 for more details. &*Note*&: The contents of &$address_data$& are visible in
10757 user filter files.
10758
10759 If &$address_data$& is set when the routers are called from an ACL to verify
10760 a recipient address, the final value is still in the variable for subsequent
10761 conditions and modifiers of the ACL statement. If routing the address caused it
10762 to be redirected to just one address, the child address is also routed as part
10763 of the verification, and in this case the final value of &$address_data$& is
10764 from the child's routing.
10765
10766 If &$address_data$& is set when the routers are called from an ACL to verify a
10767 sender address, the final value is also preserved, but this time in
10768 &$sender_address_data$&, to distinguish it from data from a recipient
10769 address.
10770
10771 In both cases (recipient and sender verification), the value does not persist
10772 after the end of the current ACL statement. If you want to preserve
10773 these values for longer, you can save them in ACL variables.
10774
10775 .vitem &$address_file$&
10776 .vindex "&$address_file$&"
10777 When, as a result of aliasing, forwarding, or filtering, a message is directed
10778 to a specific file, this variable holds the name of the file when the transport
10779 is running. At other times, the variable is empty. For example, using the
10780 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10781 .code
10782 /home/r2d2/savemail
10783 .endd
10784 then when the &(address_file)& transport is running, &$address_file$&
10785 contains the text string &`/home/r2d2/savemail`&.
10786 .cindex "Sieve filter" "value of &$address_file$&"
10787 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10788 then up to the transport configuration to generate an appropriate absolute path
10789 to the relevant file.
10790
10791 .vitem &$address_pipe$&
10792 .vindex "&$address_pipe$&"
10793 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10794 this variable holds the pipe command when the transport is running.
10795
10796 .vitem "&$auth1$& &-- &$auth3$&"
10797 .vindex "&$auth1$&, &$auth2$&, etc"
10798 These variables are used in SMTP authenticators (see chapters
10799 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10800
10801 .vitem &$authenticated_id$&
10802 .cindex "authentication" "id"
10803 .vindex "&$authenticated_id$&"
10804 When a server successfully authenticates a client it may be configured to
10805 preserve some of the authentication information in the variable
10806 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10807 user/password authenticator configuration might preserve the user name for use
10808 in the routers. Note that this is not the same information that is saved in
10809 &$sender_host_authenticated$&.
10810 When a message is submitted locally (that is, not over a TCP connection)
10811 the value of &$authenticated_id$& is normally the login name of the calling
10812 process. However, a trusted user can override this by means of the &%-oMai%&
10813 command line option.
10814
10815
10816
10817
10818 .vitem &$authenticated_sender$&
10819 .cindex "sender" "authenticated"
10820 .cindex "authentication" "sender"
10821 .cindex "AUTH" "on MAIL command"
10822 .vindex "&$authenticated_sender$&"
10823 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10824 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10825 described in section &<<SECTauthparamail>>&. Unless the data is the string
10826 &"<>"&, it is set as the authenticated sender of the message, and the value is
10827 available during delivery in the &$authenticated_sender$& variable. If the
10828 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10829
10830 .vindex "&$qualify_domain$&"
10831 When a message is submitted locally (that is, not over a TCP connection), the
10832 value of &$authenticated_sender$& is an address constructed from the login
10833 name of the calling process and &$qualify_domain$&, except that a trusted user
10834 can override this by means of the &%-oMas%& command line option.
10835
10836
10837 .vitem &$authentication_failed$&
10838 .cindex "authentication" "failure"
10839 .vindex "&$authentication_failed$&"
10840 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10841 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10842 possible to distinguish between &"did not try to authenticate"&
10843 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10844 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10845 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10846 negative response to an AUTH command, including (for example) an attempt to use
10847 an undefined mechanism.
10848
10849 .vitem &$av_failed$&
10850 .cindex "content scanning" "AV scanner failure"
10851 This variable is available when Exim is compiled with the content-scanning
10852 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10853 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10854 the ACL malware condition.
10855
10856 .vitem &$body_linecount$&
10857 .cindex "message body" "line count"
10858 .cindex "body of message" "line count"
10859 .vindex "&$body_linecount$&"
10860 When a message is being received or delivered, this variable contains the
10861 number of lines in the message's body. See also &$message_linecount$&.
10862
10863 .vitem &$body_zerocount$&
10864 .cindex "message body" "binary zero count"
10865 .cindex "body of message" "binary zero count"
10866 .cindex "binary zero" "in message body"
10867 .vindex "&$body_zerocount$&"
10868 When a message is being received or delivered, this variable contains the
10869 number of binary zero bytes (ASCII NULs) in the message's body.
10870
10871 .vitem &$bounce_recipient$&
10872 .vindex "&$bounce_recipient$&"
10873 This is set to the recipient address of a bounce message while Exim is creating
10874 it. It is useful if a customized bounce message text file is in use (see
10875 chapter &<<CHAPemsgcust>>&).
10876
10877 .vitem &$bounce_return_size_limit$&
10878 .vindex "&$bounce_return_size_limit$&"
10879 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10880 up to a multiple of 1000. It is useful when a customized error message text
10881 file is in use (see chapter &<<CHAPemsgcust>>&).
10882
10883 .vitem &$caller_gid$&
10884 .cindex "gid (group id)" "caller"
10885 .vindex "&$caller_gid$&"
10886 The real group id under which the process that called Exim was running. This is
10887 not the same as the group id of the originator of a message (see
10888 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10889 incarnation normally contains the Exim gid.
10890
10891 .vitem &$caller_uid$&
10892 .cindex "uid (user id)" "caller"
10893 .vindex "&$caller_uid$&"
10894 The real user id under which the process that called Exim was running. This is
10895 not the same as the user id of the originator of a message (see
10896 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10897 incarnation normally contains the Exim uid.
10898
10899 .vitem &$compile_date$&
10900 .vindex "&$compile_date$&"
10901 The date on which the Exim binary was compiled.
10902
10903 .vitem &$compile_number$&
10904 .vindex "&$compile_number$&"
10905 The building process for Exim keeps a count of the number
10906 of times it has been compiled. This serves to distinguish different
10907 compilations of the same version of the program.
10908
10909 .vitem &$demime_errorlevel$&
10910 .vindex "&$demime_errorlevel$&"
10911 This variable is available when Exim is compiled with
10912 the content-scanning extension and the obsolete &%demime%& condition. For
10913 details, see section &<<SECTdemimecond>>&.
10914
10915 .vitem &$demime_reason$&
10916 .vindex "&$demime_reason$&"
10917 This variable is available when Exim is compiled with the
10918 content-scanning extension and the obsolete &%demime%& condition. For details,
10919 see section &<<SECTdemimecond>>&.
10920
10921 .vitem &$dnslist_domain$& &&&
10922        &$dnslist_matched$& &&&
10923        &$dnslist_text$& &&&
10924        &$dnslist_value$&
10925 .vindex "&$dnslist_domain$&"
10926 .vindex "&$dnslist_matched$&"
10927 .vindex "&$dnslist_text$&"
10928 .vindex "&$dnslist_value$&"
10929 .cindex "black list (DNS)"
10930 When a DNS (black) list lookup succeeds, these variables are set to contain
10931 the following data from the lookup: the list's domain name, the key that was
10932 looked up, the contents of any associated TXT record, and the value from the
10933 main A record. See section &<<SECID204>>& for more details.
10934
10935 .vitem &$domain$&
10936 .vindex "&$domain$&"
10937 When an address is being routed, or delivered on its own, this variable
10938 contains the domain. Uppercase letters in the domain are converted into lower
10939 case for &$domain$&.
10940
10941 Global address rewriting happens when a message is received, so the value of
10942 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10943 is set during user filtering, but not during system filtering, because a
10944 message may have many recipients and the system filter is called just once.
10945
10946 When more than one address is being delivered at once (for example, several
10947 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10948 have the same domain. Transports can be restricted to handling only one domain
10949 at a time if the value of &$domain$& is required at transport time &-- this is
10950 the default for local transports. For further details of the environment in
10951 which local transports are run, see chapter &<<CHAPenvironment>>&.
10952
10953 .oindex "&%delay_warning_condition%&"
10954 At the end of a delivery, if all deferred addresses have the same domain, it is
10955 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10956
10957 The &$domain$& variable is also used in some other circumstances:
10958
10959 .ilist
10960 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10961 the recipient address. The domain of the &'sender'& address is in
10962 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10963 normally set during the running of the MAIL ACL. However, if the sender address
10964 is verified with a callout during the MAIL ACL, the sender domain is placed in
10965 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10966 the &(smtp)& transport.
10967
10968 .next
10969 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10970 &$domain$& contains the domain portion of the address that is being rewritten;
10971 it can be used in the expansion of the replacement address, for example, to
10972 rewrite domains by file lookup.
10973
10974 .next
10975 With one important exception, whenever a domain list is being scanned,
10976 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10977 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10978 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10979 that, in a RCPT ACL, the sender domain list can be dependent on the
10980 recipient domain (which is what is in &$domain$& at this time).
10981
10982 .next
10983 .cindex "ETRN" "value of &$domain$&"
10984 .oindex "&%smtp_etrn_command%&"
10985 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10986 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10987 .endlist
10988
10989
10990 .vitem &$domain_data$&
10991 .vindex "&$domain_data$&"
10992 When the &%domains%& option on a router matches a domain by
10993 means of a lookup, the data read by the lookup is available during the running
10994 of the router as &$domain_data$&. In addition, if the driver routes the
10995 address to a transport, the value is available in that transport. If the
10996 transport is handling multiple addresses, the value from the first address is
10997 used.
10998
10999 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11000 domain by means of a lookup. The data read by the lookup is available during
11001 the rest of the ACL statement. In all other situations, this variable expands
11002 to nothing.
11003
11004 .vitem &$exim_gid$&
11005 .vindex "&$exim_gid$&"
11006 This variable contains the numerical value of the Exim group id.
11007
11008 .vitem &$exim_path$&
11009 .vindex "&$exim_path$&"
11010 This variable contains the path to the Exim binary.
11011
11012 .vitem &$exim_uid$&
11013 .vindex "&$exim_uid$&"
11014 This variable contains the numerical value of the Exim user id.
11015
11016 .vitem &$found_extension$&
11017 .vindex "&$found_extension$&"
11018 This variable is available when Exim is compiled with the
11019 content-scanning extension and the obsolete &%demime%& condition. For details,
11020 see section &<<SECTdemimecond>>&.
11021
11022 .vitem &$header_$&<&'name'&>
11023 This is not strictly an expansion variable. It is expansion syntax for
11024 inserting the message header line with the given name. Note that the name must
11025 be terminated by colon or white space, because it may contain a wide variety of
11026 characters. Note also that braces must &'not'& be used.
11027
11028 .vitem &$home$&
11029 .vindex "&$home$&"
11030 When the &%check_local_user%& option is set for a router, the user's home
11031 directory is placed in &$home$& when the check succeeds. In particular, this
11032 means it is set during the running of users' filter files. A router may also
11033 explicitly set a home directory for use by a transport; this can be overridden
11034 by a setting on the transport itself.
11035
11036 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11037 of the environment variable HOME.
11038
11039 .vitem &$host$&
11040 .vindex "&$host$&"
11041 If a router assigns an address to a transport (any transport), and passes a
11042 list of hosts with the address, the value of &$host$& when the transport starts
11043 to run is the name of the first host on the list. Note that this applies both
11044 to local and remote transports.
11045
11046 .cindex "transport" "filter"
11047 .cindex "filter" "transport filter"
11048 For the &(smtp)& transport, if there is more than one host, the value of
11049 &$host$& changes as the transport works its way through the list. In
11050 particular, when the &(smtp)& transport is expanding its options for encryption
11051 using TLS, or for specifying a transport filter (see chapter
11052 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11053 is connected.
11054
11055 When used in the client part of an authenticator configuration (see chapter
11056 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11057 client is connected.
11058
11059
11060 .vitem &$host_address$&
11061 .vindex "&$host_address$&"
11062 This variable is set to the remote host's IP address whenever &$host$& is set
11063 for a remote connection. It is also set to the IP address that is being checked
11064 when the &%ignore_target_hosts%& option is being processed.
11065
11066 .vitem &$host_data$&
11067 .vindex "&$host_data$&"
11068 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11069 result of the lookup is made available in the &$host_data$& variable. This
11070 allows you, for example, to do things like this:
11071 .code
11072 deny  hosts = net-lsearch;/some/file
11073 message = $host_data
11074 .endd
11075 .vitem &$host_lookup_deferred$&
11076 .cindex "host name" "lookup, failure of"
11077 .vindex "&$host_lookup_deferred$&"
11078 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11079 message comes from a remote host and there is an attempt to look up the host's
11080 name from its IP address, and the attempt is not successful, one of these
11081 variables is set to &"1"&.
11082
11083 .ilist
11084 If the lookup receives a definite negative response (for example, a DNS lookup
11085 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11086
11087 .next
11088 If there is any kind of problem during the lookup, such that Exim cannot
11089 tell whether or not the host name is defined (for example, a timeout for a DNS
11090 lookup), &$host_lookup_deferred$& is set to &"1"&.
11091 .endlist ilist
11092
11093 Looking up a host's name from its IP address consists of more than just a
11094 single reverse lookup. Exim checks that a forward lookup of at least one of the
11095 names it receives from a reverse lookup yields the original IP address. If this
11096 is not the case, Exim does not accept the looked up name(s), and
11097 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11098 IP address (for example, the existence of a PTR record in the DNS) is not
11099 sufficient on its own for the success of a host name lookup. If the reverse
11100 lookup succeeds, but there is a lookup problem such as a timeout when checking
11101 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11102 &"1"&. See also &$sender_host_name$&.
11103
11104 .vitem &$host_lookup_failed$&
11105 .vindex "&$host_lookup_failed$&"
11106 See &$host_lookup_deferred$&.
11107
11108
11109 .vitem &$inode$&
11110 .vindex "&$inode$&"
11111 The only time this variable is set is while expanding the &%directory_file%&
11112 option in the &(appendfile)& transport. The variable contains the inode number
11113 of the temporary file which is about to be renamed. It can be used to construct
11114 a unique name for the file.
11115
11116 .vitem &$interface_address$&
11117 .vindex "&$interface_address$&"
11118 This is an obsolete name for &$received_ip_address$&.
11119
11120 .vitem &$interface_port$&
11121 .vindex "&$interface_port$&"
11122 This is an obsolete name for &$received_port$&.
11123
11124 .vitem &$item$&
11125 .vindex "&$item$&"
11126 This variable is used during the expansion of &*forall*& and &*forany*&
11127 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11128 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11129 empty.
11130
11131 .vitem &$ldap_dn$&
11132 .vindex "&$ldap_dn$&"
11133 This variable, which is available only when Exim is compiled with LDAP support,
11134 contains the DN from the last entry in the most recently successful LDAP
11135 lookup.
11136
11137 .vitem &$load_average$&
11138 .vindex "&$load_average$&"
11139 This variable contains the system load average, multiplied by 1000 so that it
11140 is an integer. For example, if the load average is 0.21, the value of the
11141 variable is 210. The value is recomputed every time the variable is referenced.
11142
11143 .vitem &$local_part$&
11144 .vindex "&$local_part$&"
11145 When an address is being routed, or delivered on its own, this
11146 variable contains the local part. When a number of addresses are being
11147 delivered together (for example, multiple RCPT commands in an SMTP
11148 session), &$local_part$& is not set.
11149
11150 Global address rewriting happens when a message is received, so the value of
11151 &$local_part$& during routing and delivery is the value after rewriting.
11152 &$local_part$& is set during user filtering, but not during system filtering,
11153 because a message may have many recipients and the system filter is called just
11154 once.
11155
11156 .vindex "&$local_part_prefix$&"
11157 .vindex "&$local_part_suffix$&"
11158 If a local part prefix or suffix has been recognized, it is not included in the
11159 value of &$local_part$& during routing and subsequent delivery. The values of
11160 any prefix or suffix are in &$local_part_prefix$& and
11161 &$local_part_suffix$&, respectively.
11162
11163 When a message is being delivered to a file, pipe, or autoreply transport as a
11164 result of aliasing or forwarding, &$local_part$& is set to the local part of
11165 the parent address, not to the file name or command (see &$address_file$& and
11166 &$address_pipe$&).
11167
11168 When an ACL is running for a RCPT command, &$local_part$& contains the
11169 local part of the recipient address.
11170
11171 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11172 &$local_part$& contains the local part of the address that is being rewritten;
11173 it can be used in the expansion of the replacement address, for example.
11174
11175 In all cases, all quoting is removed from the local part. For example, for both
11176 the addresses
11177 .code
11178 "abc:xyz"@test.example
11179 abc\:xyz@test.example
11180 .endd
11181 the value of &$local_part$& is
11182 .code
11183 abc:xyz
11184 .endd
11185 If you use &$local_part$& to create another address, you should always wrap it
11186 inside a quoting operator. For example, in a &(redirect)& router you could
11187 have:
11188 .code
11189 data = ${quote_local_part:$local_part}@new.domain.example
11190 .endd
11191 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11192 to process local parts in a case-dependent manner in a router, you can set the
11193 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11194
11195 .vitem &$local_part_data$&
11196 .vindex "&$local_part_data$&"
11197 When the &%local_parts%& option on a router matches a local part by means of a
11198 lookup, the data read by the lookup is available during the running of the
11199 router as &$local_part_data$&. In addition, if the driver routes the address
11200 to a transport, the value is available in that transport. If the transport is
11201 handling multiple addresses, the value from the first address is used.
11202
11203 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11204 matches a local part by means of a lookup. The data read by the lookup is
11205 available during the rest of the ACL statement. In all other situations, this
11206 variable expands to nothing.
11207
11208 .vitem &$local_part_prefix$&
11209 .vindex "&$local_part_prefix$&"
11210 When an address is being routed or delivered, and a
11211 specific prefix for the local part was recognized, it is available in this
11212 variable, having been removed from &$local_part$&.
11213
11214 .vitem &$local_part_suffix$&
11215 .vindex "&$local_part_suffix$&"
11216 When an address is being routed or delivered, and a
11217 specific suffix for the local part was recognized, it is available in this
11218 variable, having been removed from &$local_part$&.
11219
11220 .vitem &$local_scan_data$&
11221 .vindex "&$local_scan_data$&"
11222 This variable contains the text returned by the &[local_scan()]& function when
11223 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11224
11225 .vitem &$local_user_gid$&
11226 .vindex "&$local_user_gid$&"
11227 See &$local_user_uid$&.
11228
11229 .vitem &$local_user_uid$&
11230 .vindex "&$local_user_uid$&"
11231 This variable and &$local_user_gid$& are set to the uid and gid after the
11232 &%check_local_user%& router precondition succeeds. This means that their values
11233 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11234 and &%condition%&), for the &%address_data%& expansion, and for any
11235 router-specific expansions. At all other times, the values in these variables
11236 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11237
11238 .vitem &$localhost_number$&
11239 .vindex "&$localhost_number$&"
11240 This contains the expanded value of the
11241 &%localhost_number%& option. The expansion happens after the main options have
11242 been read.
11243
11244 .vitem &$log_inodes$&
11245 .vindex "&$log_inodes$&"
11246 The number of free inodes in the disk partition where Exim's
11247 log files are being written. The value is recalculated whenever the variable is
11248 referenced. If the relevant file system does not have the concept of inodes,
11249 the value of is -1. See also the &%check_log_inodes%& option.
11250
11251 .vitem &$log_space$&
11252 .vindex "&$log_space$&"
11253 The amount of free space (as a number of kilobytes) in the disk
11254 partition where Exim's log files are being written. The value is recalculated
11255 whenever the variable is referenced. If the operating system does not have the
11256 ability to find the amount of free space (only true for experimental systems),
11257 the space value is -1. See also the &%check_log_space%& option.
11258
11259
11260 .vitem &$mailstore_basename$&
11261 .vindex "&$mailstore_basename$&"
11262 This variable is set only when doing deliveries in &"mailstore"& format in the
11263 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11264 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11265 contains the basename of the files that are being written, that is, the name
11266 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11267 variable is empty.
11268
11269 .vitem &$malware_name$&
11270 .vindex "&$malware_name$&"
11271 This variable is available when Exim is compiled with the
11272 content-scanning extension. It is set to the name of the virus that was found
11273 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11274
11275 .vitem &$max_received_linelength$&
11276 .vindex "&$max_received_linelength$&"
11277 .cindex "maximum" "line length"
11278 .cindex "line length" "maximum"
11279 This variable contains the number of bytes in the longest line that was
11280 received as part of the message, not counting the line termination
11281 character(s).
11282
11283 .vitem &$message_age$&
11284 .cindex "message" "age of"
11285 .vindex "&$message_age$&"
11286 This variable is set at the start of a delivery attempt to contain the number
11287 of seconds since the message was received. It does not change during a single
11288 delivery attempt.
11289
11290 .vitem &$message_body$&
11291 .cindex "body of message" "expansion variable"
11292 .cindex "message body" "in expansion"
11293 .cindex "binary zero" "in message body"
11294 .vindex "&$message_body$&"
11295 .oindex "&%message_body_visible%&"
11296 This variable contains the initial portion of a message's body while it is
11297 being delivered, and is intended mainly for use in filter files. The maximum
11298 number of characters of the body that are put into the variable is set by the
11299 &%message_body_visible%& configuration option; the default is 500.
11300
11301 .oindex "&%message_body_newlines%&"
11302 By default, newlines are converted into spaces in &$message_body$&, to make it
11303 easier to search for phrases that might be split over a line break. However,
11304 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11305 zeros are always converted into spaces.
11306
11307 .vitem &$message_body_end$&
11308 .cindex "body of message" "expansion variable"
11309 .cindex "message body" "in expansion"
11310 .vindex "&$message_body_end$&"
11311 This variable contains the final portion of a message's
11312 body while it is being delivered. The format and maximum size are as for
11313 &$message_body$&.
11314
11315 .vitem &$message_body_size$&
11316 .cindex "body of message" "size"
11317 .cindex "message body" "size"
11318 .vindex "&$message_body_size$&"
11319 When a message is being delivered, this variable contains the size of the body
11320 in bytes. The count starts from the character after the blank line that
11321 separates the body from the header. Newlines are included in the count. See
11322 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11323
11324 .vitem &$message_exim_id$&
11325 .vindex "&$message_exim_id$&"
11326 When a message is being received or delivered, this variable contains the
11327 unique message id that is generated and used by Exim to identify the message.
11328 An id is not created for a message until after its header has been successfully
11329 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11330 line; it is the local id that Exim assigns to the message, for example:
11331 &`1BXTIK-0001yO-VA`&.
11332
11333 .vitem &$message_headers$&
11334 .vindex &$message_headers$&
11335 This variable contains a concatenation of all the header lines when a message
11336 is being processed, except for lines added by routers or transports. The header
11337 lines are separated by newline characters. Their contents are decoded in the
11338 same way as a header line that is inserted by &%bheader%&.
11339
11340 .vitem &$message_headers_raw$&
11341 .vindex &$message_headers_raw$&
11342 This variable is like &$message_headers$& except that no processing of the
11343 contents of header lines is done.
11344
11345 .vitem &$message_id$&
11346 This is an old name for &$message_exim_id$&, which is now deprecated.
11347
11348 .vitem &$message_linecount$&
11349 .vindex "&$message_linecount$&"
11350 This variable contains the total number of lines in the header and body of the
11351 message. Compare &$body_linecount$&, which is the count for the body only.
11352 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11353 number of lines received. Before delivery happens (that is, before filters,
11354 routers, and transports run) the count is increased to include the
11355 &'Received:'& header line that Exim standardly adds, and also any other header
11356 lines that are added by ACLs. The blank line that separates the message header
11357 from the body is not counted.
11358
11359 As with the special case of &$message_size$&, during the expansion of the
11360 appendfile transport's maildir_tag option in maildir format, the value of
11361 &$message_linecount$& is the precise size of the number of newlines in the
11362 file that has been written (minus one for the blank line between the
11363 header and the body).
11364
11365 Here is an example of the use of this variable in a DATA ACL:
11366 .code
11367 deny message   = Too many lines in message header
11368      condition = \
11369       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11370 .endd
11371 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11372 message has not yet been received.
11373
11374 .vitem &$message_size$&
11375 .cindex "size" "of message"
11376 .cindex "message" "size"
11377 .vindex "&$message_size$&"
11378 When a message is being processed, this variable contains its size in bytes. In
11379 most cases, the size includes those headers that were received with the
11380 message, but not those (such as &'Envelope-to:'&) that are added to individual
11381 deliveries as they are written. However, there is one special case: during the
11382 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11383 doing a delivery in maildir format, the value of &$message_size$& is the
11384 precise size of the file that has been written. See also
11385 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11386
11387 .cindex "RCPT" "value of &$message_size$&"
11388 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11389 contains the size supplied on the MAIL command, or -1 if no size was given. The
11390 value may not, of course, be truthful.
11391
11392 .vitem &$mime_$&&'xxx'&
11393 A number of variables whose names start with &$mime$& are
11394 available when Exim is compiled with the content-scanning extension. For
11395 details, see section &<<SECTscanmimepart>>&.
11396
11397 .vitem "&$n0$& &-- &$n9$&"
11398 These variables are counters that can be incremented by means
11399 of the &%add%& command in filter files.
11400
11401 .vitem &$original_domain$&
11402 .vindex "&$domain$&"
11403 .vindex "&$original_domain$&"
11404 When a top-level address is being processed for delivery, this contains the
11405 same value as &$domain$&. However, if a &"child"& address (for example,
11406 generated by an alias, forward, or filter file) is being processed, this
11407 variable contains the domain of the original address (lower cased). This
11408 differs from &$parent_domain$& only when there is more than one level of
11409 aliasing or forwarding. When more than one address is being delivered in a
11410 single transport run, &$original_domain$& is not set.
11411
11412 If a new address is created by means of a &%deliver%& command in a system
11413 filter, it is set up with an artificial &"parent"& address. This has the local
11414 part &'system-filter'& and the default qualify domain.
11415
11416 .vitem &$original_local_part$&
11417 .vindex "&$local_part$&"
11418 .vindex "&$original_local_part$&"
11419 When a top-level address is being processed for delivery, this contains the
11420 same value as &$local_part$&, unless a prefix or suffix was removed from the
11421 local part, because &$original_local_part$& always contains the full local
11422 part. When a &"child"& address (for example, generated by an alias, forward, or
11423 filter file) is being processed, this variable contains the full local part of
11424 the original address.
11425
11426 If the router that did the redirection processed the local part
11427 case-insensitively, the value in &$original_local_part$& is in lower case.
11428 This variable differs from &$parent_local_part$& only when there is more than
11429 one level of aliasing or forwarding. When more than one address is being
11430 delivered in a single transport run, &$original_local_part$& is not set.
11431
11432 If a new address is created by means of a &%deliver%& command in a system
11433 filter, it is set up with an artificial &"parent"& address. This has the local
11434 part &'system-filter'& and the default qualify domain.
11435
11436 .vitem &$originator_gid$&
11437 .cindex "gid (group id)" "of originating user"
11438 .cindex "sender" "gid"
11439 .vindex "&$caller_gid$&"
11440 .vindex "&$originator_gid$&"
11441 This variable contains the value of &$caller_gid$& that was set when the
11442 message was received. For messages received via the command line, this is the
11443 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11444 normally the gid of the Exim user.
11445
11446 .vitem &$originator_uid$&
11447 .cindex "uid (user id)" "of originating user"
11448 .cindex "sender" "uid"
11449 .vindex "&$caller_uid$&"
11450 .vindex "&$originaltor_uid$&"
11451 The value of &$caller_uid$& that was set when the message was received. For
11452 messages received via the command line, this is the uid of the sending user.
11453 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11454 user.
11455
11456 .vitem &$parent_domain$&
11457 .vindex "&$parent_domain$&"
11458 This variable is similar to &$original_domain$& (see
11459 above), except that it refers to the immediately preceding parent address.
11460
11461 .vitem &$parent_local_part$&
11462 .vindex "&$parent_local_part$&"
11463 This variable is similar to &$original_local_part$&
11464 (see above), except that it refers to the immediately preceding parent address.
11465
11466 .vitem &$pid$&
11467 .cindex "pid (process id)" "of current process"
11468 .vindex "&$pid$&"
11469 This variable contains the current process id.
11470
11471 .vitem &$pipe_addresses$&
11472 .cindex "filter" "transport filter"
11473 .cindex "transport" "filter"
11474 .vindex "&$pipe_addresses$&"
11475 This is not an expansion variable, but is mentioned here because the string
11476 &`$pipe_addresses`& is handled specially in the command specification for the
11477 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11478 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11479 It cannot be used in general expansion strings, and provokes an &"unknown
11480 variable"& error if encountered.
11481
11482 .vitem &$primary_hostname$&
11483 .vindex "&$primary_hostname$&"
11484 This variable contains the value set by &%primary_hostname%& in the
11485 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11486 a single-component name, Exim calls &[gethostbyname()]& (or
11487 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11488 qualified host name. See also &$smtp_active_hostname$&.
11489
11490
11491 .vitem &$prvscheck_address$&
11492 This variable is used in conjunction with the &%prvscheck%& expansion item,
11493 which is described in sections &<<SECTexpansionitems>>& and
11494 &<<SECTverifyPRVS>>&.
11495
11496 .vitem &$prvscheck_keynum$&
11497 This variable is used in conjunction with the &%prvscheck%& expansion item,
11498 which is described in sections &<<SECTexpansionitems>>& and
11499 &<<SECTverifyPRVS>>&.
11500
11501 .vitem &$prvscheck_result$&
11502 This variable is used in conjunction with the &%prvscheck%& expansion item,
11503 which is described in sections &<<SECTexpansionitems>>& and
11504 &<<SECTverifyPRVS>>&.
11505
11506 .vitem &$qualify_domain$&
11507 .vindex "&$qualify_domain$&"
11508 The value set for the &%qualify_domain%& option in the configuration file.
11509
11510 .vitem &$qualify_recipient$&
11511 .vindex "&$qualify_recipient$&"
11512 The value set for the &%qualify_recipient%& option in the configuration file,
11513 or if not set, the value of &$qualify_domain$&.
11514
11515 .vitem &$rcpt_count$&
11516 .vindex "&$rcpt_count$&"
11517 When a message is being received by SMTP, this variable contains the number of
11518 RCPT commands received for the current message. If this variable is used in a
11519 RCPT ACL, its value includes the current command.
11520
11521 .vitem &$rcpt_defer_count$&
11522 .vindex "&$rcpt_defer_count$&"
11523 .cindex "4&'xx'& responses" "count of"
11524 When a message is being received by SMTP, this variable contains the number of
11525 RCPT commands in the current message that have previously been rejected with a
11526 temporary (4&'xx'&) response.
11527
11528 .vitem &$rcpt_fail_count$&
11529 .vindex "&$rcpt_fail_count$&"
11530 When a message is being received by SMTP, this variable contains the number of
11531 RCPT commands in the current message that have previously been rejected with a
11532 permanent (5&'xx'&) response.
11533
11534 .vitem &$received_count$&
11535 .vindex "&$received_count$&"
11536 This variable contains the number of &'Received:'& header lines in the message,
11537 including the one added by Exim (so its value is always greater than zero). It
11538 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11539 delivering.
11540
11541 .vitem &$received_for$&
11542 .vindex "&$received_for$&"
11543 If there is only a single recipient address in an incoming message, this
11544 variable contains that address when the &'Received:'& header line is being
11545 built. The value is copied after recipient rewriting has happened, but before
11546 the &[local_scan()]& function is run.
11547
11548 .vitem &$received_ip_address$&
11549 .vindex "&$received_ip_address$&"
11550 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11551 variable is set to the address of the local IP interface, and &$received_port$&
11552 is set to the local port number. (The remote IP address and port are in
11553 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11554 the port value is -1 unless it has been set using the &%-oMi%& command line
11555 option.
11556
11557 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11558 could be used, for example, to make the file name for a TLS certificate depend
11559 on which interface and/or port is being used for the incoming connection. The
11560 values of &$received_ip_address$& and &$received_port$& are saved with any
11561 messages that are received, thus making these variables available at delivery
11562 time.
11563
11564 &*Note:*& There are no equivalent variables for outgoing connections, because
11565 the values are unknown (unless they are explicitly set by options of the
11566 &(smtp)& transport).
11567
11568 .vitem &$received_port$&
11569 .vindex "&$received_port$&"
11570 See &$received_ip_address$&.
11571
11572 .vitem &$received_protocol$&
11573 .vindex "&$received_protocol$&"
11574 When a message is being processed, this variable contains the name of the
11575 protocol by which it was received. Most of the names used by Exim are defined
11576 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11577 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11578 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11579 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11580 connection and the client was successfully authenticated.
11581
11582 Exim uses the protocol name &"smtps"& for the case when encryption is
11583 automatically set up on connection without the use of STARTTLS (see
11584 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11585 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11586 where the client initially uses EHLO, sets up an encrypted connection using
11587 STARTTLS, and then uses HELO afterwards.
11588
11589 The &%-oMr%& option provides a way of specifying a custom protocol name for
11590 messages that are injected locally by trusted callers. This is commonly used to
11591 identify messages that are being re-injected after some kind of scanning.
11592
11593 .vitem &$received_time$&
11594 .vindex "&$received_time$&"
11595 This variable contains the date and time when the current message was received,
11596 as a number of seconds since the start of the Unix epoch.
11597
11598 .vitem &$recipient_data$&
11599 .vindex "&$recipient_data$&"
11600 This variable is set after an indexing lookup success in an ACL &%recipients%&
11601 condition. It contains the data from the lookup, and the value remains set
11602 until the next &%recipients%& test. Thus, you can do things like this:
11603 .display
11604 &`require recipients  = cdb*@;/some/file`&
11605 &`deny    `&&'some further test involving'& &`$recipient_data`&
11606 .endd
11607 &*Warning*&: This variable is set only when a lookup is used as an indexing
11608 method in the address list, using the semicolon syntax as in the example above.
11609 The variable is not set for a lookup that is used as part of the string
11610 expansion that all such lists undergo before being interpreted.
11611
11612 .vitem &$recipient_verify_failure$&
11613 .vindex "&$recipient_verify_failure$&"
11614 In an ACL, when a recipient verification fails, this variable contains
11615 information about the failure. It is set to one of the following words:
11616
11617 .ilist
11618 &"qualify"&: The address was unqualified (no domain), and the message
11619 was neither local nor came from an exempted host.
11620
11621 .next
11622 &"route"&: Routing failed.
11623
11624 .next
11625 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11626 or before the MAIL command (that is, on initial connection, HELO, or
11627 MAIL).
11628
11629 .next
11630 &"recipient"&: The RCPT command in a callout was rejected.
11631 .next
11632
11633 &"postmaster"&: The postmaster check in a callout was rejected.
11634 .endlist
11635
11636 The main use of this variable is expected to be to distinguish between
11637 rejections of MAIL and rejections of RCPT.
11638
11639 .vitem &$recipients$&
11640 .vindex "&$recipients$&"
11641 This variable contains a list of envelope recipients for a message. A comma and
11642 a space separate the addresses in the replacement text. However, the variable
11643 is not generally available, to prevent exposure of Bcc recipients in
11644 unprivileged users' filter files. You can use &$recipients$& only in these
11645 cases:
11646
11647 .olist
11648 In a system filter file.
11649 .next
11650 In the ACLs associated with the DATA command and with non-SMTP messages, that
11651 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11652 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11653 &%acl_not_smtp_mime%&.
11654 .next
11655 From within a &[local_scan()]& function.
11656 .endlist
11657
11658
11659 .vitem &$recipients_count$&
11660 .vindex "&$recipients_count$&"
11661 When a message is being processed, this variable contains the number of
11662 envelope recipients that came with the message. Duplicates are not excluded
11663 from the count. While a message is being received over SMTP, the number
11664 increases for each accepted recipient. It can be referenced in an ACL.
11665
11666
11667 .vitem &$regex_match_string$&
11668 .vindex "&$regex_match_string$&"
11669 This variable is set to contain the matching regular expression after a
11670 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11671
11672
11673 .vitem &$reply_address$&
11674 .vindex "&$reply_address$&"
11675 When a message is being processed, this variable contains the contents of the
11676 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11677 contents of the &'From:'& header line. Apart from the removal of leading
11678 white space, the value is not processed in any way. In particular, no RFC 2047
11679 decoding or character code translation takes place.
11680
11681 .vitem &$return_path$&
11682 .vindex "&$return_path$&"
11683 When a message is being delivered, this variable contains the return path &--
11684 the sender field that will be sent as part of the envelope. It is not enclosed
11685 in <> characters. At the start of routing an address, &$return_path$& has the
11686 same value as &$sender_address$&, but if, for example, an incoming message to a
11687 mailing list has been expanded by a router which specifies a different address
11688 for bounce messages, &$return_path$& subsequently contains the new bounce
11689 address, whereas &$sender_address$& always contains the original sender address
11690 that was received with the message. In other words, &$sender_address$& contains
11691 the incoming envelope sender, and &$return_path$& contains the outgoing
11692 envelope sender.
11693
11694 .vitem &$return_size_limit$&
11695 .vindex "&$return_size_limit$&"
11696 This is an obsolete name for &$bounce_return_size_limit$&.
11697
11698 .vitem &$runrc$&
11699 .cindex "return code" "from &%run%& expansion"
11700 .vindex "&$runrc$&"
11701 This variable contains the return code from a command that is run by the
11702 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11703 assume the order in which option values are expanded, except for those
11704 preconditions whose order of testing is documented. Therefore, you cannot
11705 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11706 another.
11707
11708 .vitem &$self_hostname$&
11709 .oindex "&%self%&" "value of host name"
11710 .vindex "&$self_hostname$&"
11711 When an address is routed to a supposedly remote host that turns out to be the
11712 local host, what happens is controlled by the &%self%& generic router option.
11713 One of its values causes the address to be passed to another router. When this
11714 happens, &$self_hostname$& is set to the name of the local host that the
11715 original router encountered. In other circumstances its contents are null.
11716
11717 .vitem &$sender_address$&
11718 .vindex "&$sender_address$&"
11719 When a message is being processed, this variable contains the sender's address
11720 that was received in the message's envelope. The case of letters in the address
11721 is retained, in both the local part and the domain. For bounce messages, the
11722 value of this variable is the empty string. See also &$return_path$&.
11723
11724 .vitem &$sender_address_data$&
11725 .vindex "&$address_data$&"
11726 .vindex "&$sender_address_data$&"
11727 If &$address_data$& is set when the routers are called from an ACL to verify a
11728 sender address, the final value is preserved in &$sender_address_data$&, to
11729 distinguish it from data from a recipient address. The value does not persist
11730 after the end of the current ACL statement. If you want to preserve it for
11731 longer, you can save it in an ACL variable.
11732
11733 .vitem &$sender_address_domain$&
11734 .vindex "&$sender_address_domain$&"
11735 The domain portion of &$sender_address$&.
11736
11737 .vitem &$sender_address_local_part$&
11738 .vindex "&$sender_address_local_part$&"
11739 The local part portion of &$sender_address$&.
11740
11741 .vitem &$sender_data$&
11742 .vindex "&$sender_data$&"
11743 This variable is set after a lookup success in an ACL &%senders%& condition or
11744 in a router &%senders%& option. It contains the data from the lookup, and the
11745 value remains set until the next &%senders%& test. Thus, you can do things like
11746 this:
11747 .display
11748 &`require senders      = cdb*@;/some/file`&
11749 &`deny    `&&'some further test involving'& &`$sender_data`&
11750 .endd
11751 &*Warning*&: This variable is set only when a lookup is used as an indexing
11752 method in the address list, using the semicolon syntax as in the example above.
11753 The variable is not set for a lookup that is used as part of the string
11754 expansion that all such lists undergo before being interpreted.
11755
11756 .vitem &$sender_fullhost$&
11757 .vindex "&$sender_fullhost$&"
11758 When a message is received from a remote host, this variable contains the host
11759 name and IP address in a single string. It ends with the IP address in square
11760 brackets, followed by a colon and a port number if the logging of ports is
11761 enabled. The format of the rest of the string depends on whether the host
11762 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11763 looking up its IP address. (Looking up the IP address can be forced by the
11764 &%host_lookup%& option, independent of verification.) A plain host name at the
11765 start of the string is a verified host name; if this is not present,
11766 verification either failed or was not requested. A host name in parentheses is
11767 the argument of a HELO or EHLO command. This is omitted if it is identical to
11768 the verified host name or to the host's IP address in square brackets.
11769
11770 .vitem &$sender_helo_name$&
11771 .vindex "&$sender_helo_name$&"
11772 When a message is received from a remote host that has issued a HELO or EHLO
11773 command, the argument of that command is placed in this variable. It is also
11774 set if HELO or EHLO is used when a message is received using SMTP locally via
11775 the &%-bs%& or &%-bS%& options.
11776
11777 .vitem &$sender_host_address$&
11778 .vindex "&$sender_host_address$&"
11779 When a message is received from a remote host, this variable contains that
11780 host's IP address. For locally submitted messages, it is empty.
11781
11782 .vitem &$sender_host_authenticated$&
11783 .vindex "&$sender_host_authenticated$&"
11784 This variable contains the name (not the public name) of the authenticator
11785 driver that successfully authenticated the client from which the message was
11786 received. It is empty if there was no successful authentication. See also
11787 &$authenticated_id$&.
11788
11789 .new
11790 .vitem &$sender_host_dnssec$&
11791 .vindex "&$sender_host_dnssec$&"
11792 If &$sender_host_name$& has been populated (by reference, &%hosts_lookup%& or
11793 otherwise) then this boolean will have been set true if, and only if, the
11794 resolver library states that the reverse DNS was authenticated data.  At all
11795 other times, this variable is false.
11796
11797 It is likely that you will need to coerce DNSSEC support on in the resolver
11798 library, by setting:
11799 .code
11800 dns_use_dnssec = 1
11801 .endd
11802
11803 Exim does not perform DNSSEC validation itself, instead leaving that to a
11804 validating resolver (eg, unbound, or bind with suitable configuration).
11805
11806 Exim does not (currently) check to see if the forward DNS was also secured
11807 with DNSSEC, only the reverse DNS.
11808
11809 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
11810 mechanism in the list, then this variable will be false.
11811 .wen
11812
11813
11814 .vitem &$sender_host_name$&
11815 .vindex "&$sender_host_name$&"
11816 When a message is received from a remote host, this variable contains the
11817 host's name as obtained by looking up its IP address. For messages received by
11818 other means, this variable is empty.
11819
11820 .vindex "&$host_lookup_failed$&"
11821 If the host name has not previously been looked up, a reference to
11822 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11823 A looked up name is accepted only if it leads back to the original IP address
11824 via a forward lookup. If either the reverse or the forward lookup fails to find
11825 any data, or if the forward lookup does not yield the original IP address,
11826 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11827
11828 .vindex "&$host_lookup_deferred$&"
11829 However, if either of the lookups cannot be completed (for example, there is a
11830 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11831 &$host_lookup_failed$& remains set to &"0"&.
11832
11833 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11834 host name again if there is a subsequent reference to &$sender_host_name$&
11835 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11836 is set to &"1"&.
11837
11838 Exim does not automatically look up every calling host's name. If you want
11839 maximum efficiency, you should arrange your configuration so that it avoids
11840 these lookups altogether. The lookup happens only if one or more of the
11841 following are true:
11842
11843 .ilist
11844 A string containing &$sender_host_name$& is expanded.
11845 .next
11846 The calling host matches the list in &%host_lookup%&. In the default
11847 configuration, this option is set to *, so it must be changed if lookups are
11848 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11849 .next
11850 Exim needs the host name in order to test an item in a host list. The items
11851 that require this are described in sections &<<SECThoslispatnam>>& and
11852 &<<SECThoslispatnamsk>>&.
11853 .next
11854 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11855 In this case, the host name is required to compare with the name quoted in any
11856 EHLO or HELO commands that the client issues.
11857 .next
11858 The remote host issues a EHLO or HELO command that quotes one of the
11859 domains in &%helo_lookup_domains%&. The default value of this option is
11860 . ==== As this is a nested list, any displays it contains must be indented
11861 . ==== as otherwise they are too far to the left.
11862 .code
11863   helo_lookup_domains = @ : @[]
11864 .endd
11865 which causes a lookup if a remote host (incorrectly) gives the server's name or
11866 IP address in an EHLO or HELO command.
11867 .endlist
11868
11869
11870 .vitem &$sender_host_port$&
11871 .vindex "&$sender_host_port$&"
11872 When a message is received from a remote host, this variable contains the port
11873 number that was used on the remote host.
11874
11875 .vitem &$sender_ident$&
11876 .vindex "&$sender_ident$&"
11877 When a message is received from a remote host, this variable contains the
11878 identification received in response to an RFC 1413 request. When a message has
11879 been received locally, this variable contains the login name of the user that
11880 called Exim.
11881
11882 .vitem &$sender_rate_$&&'xxx'&
11883 A number of variables whose names begin &$sender_rate_$& are set as part of the
11884 &%ratelimit%& ACL condition. Details are given in section
11885 &<<SECTratelimiting>>&.
11886
11887 .vitem &$sender_rcvhost$&
11888 .cindex "DNS" "reverse lookup"
11889 .cindex "reverse DNS lookup"
11890 .vindex "&$sender_rcvhost$&"
11891 This is provided specifically for use in &'Received:'& headers. It starts with
11892 either the verified host name (as obtained from a reverse DNS lookup) or, if
11893 there is no verified host name, the IP address in square brackets. After that
11894 there may be text in parentheses. When the first item is a verified host name,
11895 the first thing in the parentheses is the IP address in square brackets,
11896 followed by a colon and a port number if port logging is enabled. When the
11897 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11898 the parentheses.
11899
11900 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11901 was used and its argument was not identical to the real host name or IP
11902 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11903 all three items are present in the parentheses, a newline and tab are inserted
11904 into the string, to improve the formatting of the &'Received:'& header.
11905
11906 .vitem &$sender_verify_failure$&
11907 .vindex "&$sender_verify_failure$&"
11908 In an ACL, when a sender verification fails, this variable contains information
11909 about the failure. The details are the same as for
11910 &$recipient_verify_failure$&.
11911
11912 .vitem &$sending_ip_address$&
11913 .vindex "&$sending_ip_address$&"
11914 This variable is set whenever an outgoing SMTP connection to another host has
11915 been set up. It contains the IP address of the local interface that is being
11916 used. This is useful if a host that has more than one IP address wants to take
11917 on different personalities depending on which one is being used. For incoming
11918 connections, see &$received_ip_address$&.
11919
11920 .vitem &$sending_port$&
11921 .vindex "&$sending_port$&"
11922 This variable is set whenever an outgoing SMTP connection to another host has
11923 been set up. It contains the local port that is being used. For incoming
11924 connections, see &$received_port$&.
11925
11926 .vitem &$smtp_active_hostname$&
11927 .vindex "&$smtp_active_hostname$&"
11928 During an incoming SMTP session, this variable contains the value of the active
11929 host name, as specified by the &%smtp_active_hostname%& option. The value of
11930 &$smtp_active_hostname$& is saved with any message that is received, so its
11931 value can be consulted during routing and delivery.
11932
11933 .vitem &$smtp_command$&
11934 .vindex "&$smtp_command$&"
11935 During the processing of an incoming SMTP command, this variable contains the
11936 entire command. This makes it possible to distinguish between HELO and EHLO in
11937 the HELO ACL, and also to distinguish between commands such as these:
11938 .code
11939 MAIL FROM:<>
11940 MAIL FROM: <>
11941 .endd
11942 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11943 command, the address in &$smtp_command$& is the original address before any
11944 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11945 the address after SMTP-time rewriting.
11946
11947 .vitem &$smtp_command_argument$&
11948 .cindex "SMTP" "command, argument for"
11949 .vindex "&$smtp_command_argument$&"
11950 While an ACL is running to check an SMTP command, this variable contains the
11951 argument, that is, the text that follows the command name, with leading white
11952 space removed. Following the introduction of &$smtp_command$&, this variable is
11953 somewhat redundant, but is retained for backwards compatibility.
11954
11955 .vitem &$smtp_count_at_connection_start$&
11956 .vindex "&$smtp_count_at_connection_start$&"
11957 This variable is set greater than zero only in processes spawned by the Exim
11958 daemon for handling incoming SMTP connections. The name is deliberately long,
11959 in order to emphasize what the contents are. When the daemon accepts a new
11960 connection, it increments this variable. A copy of the variable is passed to
11961 the child process that handles the connection, but its value is fixed, and
11962 never changes. It is only an approximation of how many incoming connections
11963 there actually are, because many other connections may come and go while a
11964 single connection is being processed. When a child process terminates, the
11965 daemon decrements its copy of the variable.
11966
11967 .vitem "&$sn0$& &-- &$sn9$&"
11968 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11969 that were current at the end of the system filter file. This allows a system
11970 filter file to set values that can be tested in users' filter files. For
11971 example, a system filter could set a value indicating how likely it is that a
11972 message is junk mail.
11973
11974 .vitem &$spam_$&&'xxx'&
11975 A number of variables whose names start with &$spam$& are available when Exim
11976 is compiled with the content-scanning extension. For details, see section
11977 &<<SECTscanspamass>>&.
11978
11979
11980 .vitem &$spool_directory$&
11981 .vindex "&$spool_directory$&"
11982 The name of Exim's spool directory.
11983
11984 .vitem &$spool_inodes$&
11985 .vindex "&$spool_inodes$&"
11986 The number of free inodes in the disk partition where Exim's spool files are
11987 being written. The value is recalculated whenever the variable is referenced.
11988 If the relevant file system does not have the concept of inodes, the value of
11989 is -1. See also the &%check_spool_inodes%& option.
11990
11991 .vitem &$spool_space$&
11992 .vindex "&$spool_space$&"
11993 The amount of free space (as a number of kilobytes) in the disk partition where
11994 Exim's spool files are being written. The value is recalculated whenever the
11995 variable is referenced. If the operating system does not have the ability to
11996 find the amount of free space (only true for experimental systems), the space
11997 value is -1. For example, to check in an ACL that there is at least 50
11998 megabytes free on the spool, you could write:
11999 .code
12000 condition = ${if > {$spool_space}{50000}}
12001 .endd
12002 See also the &%check_spool_space%& option.
12003
12004
12005 .vitem &$thisaddress$&
12006 .vindex "&$thisaddress$&"
12007 This variable is set only during the processing of the &%foranyaddress%&
12008 command in a filter file. Its use is explained in the description of that
12009 command, which can be found in the separate document entitled &'Exim's
12010 interfaces to mail filtering'&.
12011
12012 .vitem &$tls_in_bits$&
12013 .vindex "&$tls_in_bits$&"
12014 Contains an approximation of the TLS cipher's bit-strength
12015 on the inbound connection; the meaning of
12016 this depends upon the TLS implementation used.
12017 If TLS has not been negotiated, the value will be 0.
12018 The value of this is automatically fed into the Cyrus SASL authenticator
12019 when acting as a server, to specify the "external SSF" (a SASL term).
12020
12021 The deprecated &$tls_bits$& variable refers to the inbound side
12022 except when used in the context of an outbound SMTP delivery, when it refers to
12023 the outbound.
12024
12025 .vitem &$tls_out_bits$&
12026 .vindex "&$tls_out_bits$&"
12027 Contains an approximation of the TLS cipher's bit-strength
12028 on an outbound SMTP connection; the meaning of
12029 this depends upon the TLS implementation used.
12030 If TLS has not been negotiated, the value will be 0.
12031
12032 .vitem &$tls_in_certificate_verified$&
12033 .vindex "&$tls_in_certificate_verified$&"
12034 This variable is set to &"1"& if a TLS certificate was verified when the
12035 message was received, and &"0"& otherwise.
12036
12037 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12038 except when used in the context of an outbound SMTP delivery, when it refers to
12039 the outbound.
12040
12041 .vitem &$tls_out_certificate_verified$&
12042 .vindex "&$tls_out_certificate_verified$&"
12043 This variable is set to &"1"& if a TLS certificate was verified when an
12044 outbound SMTP connection was made,
12045 and &"0"& otherwise.
12046
12047 .vitem &$tls_in_cipher$&
12048 .vindex "&$tls_in_cipher$&"
12049 .vindex "&$tls_cipher$&"
12050 When a message is received from a remote host over an encrypted SMTP
12051 connection, this variable is set to the cipher suite that was negotiated, for
12052 example DES-CBC3-SHA. In other circumstances, in particular, for message
12053 received over unencrypted connections, the variable is empty. Testing
12054 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12055 non-encrypted connections during ACL processing.
12056
12057 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12058 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12059 becomes the same as &$tls_out_cipher$&.
12060
12061 .vitem &$tls_out_cipher$&
12062 .vindex "&$tls_out_cipher$&"
12063 This variable is
12064 cleared before any outgoing SMTP connection is made,
12065 and then set to the outgoing cipher suite if one is negotiated. See chapter
12066 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12067 details of the &(smtp)& transport.
12068
12069 .vitem &$tls_in_peerdn$&
12070 .vindex "&$tls_in_peerdn$&"
12071 .vindex "&$tls_peerdn$&"
12072 When a message is received from a remote host over an encrypted SMTP
12073 connection, and Exim is configured to request a certificate from the client,
12074 the value of the Distinguished Name of the certificate is made available in the
12075 &$tls_in_peerdn$& during subsequent processing.
12076
12077 The deprecated &$tls_peerdn$& variable refers to the inbound side
12078 except when used in the context of an outbound SMTP delivery, when it refers to
12079 the outbound.
12080
12081 .vitem &$tls_out_peerdn$&
12082 .vindex "&$tls_out_peerdn$&"
12083 When a message is being delivered to a remote host over an encrypted SMTP
12084 connection, and Exim is configured to request a certificate from the server,
12085 the value of the Distinguished Name of the certificate is made available in the
12086 &$tls_out_peerdn$& during subsequent processing.
12087
12088 .vitem &$tls_in_sni$&
12089 .vindex "&$tls_in_sni$&"
12090 .vindex "&$tls_sni$&"
12091 .cindex "TLS" "Server Name Indication"
12092 When a TLS session is being established, if the client sends the Server
12093 Name Indication extension, the value will be placed in this variable.
12094 If the variable appears in &%tls_certificate%& then this option and
12095 some others, described in &<<SECTtlssni>>&,
12096 will be re-expanded early in the TLS session, to permit
12097 a different certificate to be presented (and optionally a different key to be
12098 used) to the client, based upon the value of the SNI extension.
12099
12100 The deprecated &$tls_sni$& variable refers to the inbound side
12101 except when used in the context of an outbound SMTP delivery, when it refers to
12102 the outbound.
12103
12104 .vitem &$tls_out_sni$&
12105 .vindex "&$tls_out_sni$&"
12106 .cindex "TLS" "Server Name Indication"
12107 During outbound
12108 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12109 the transport.
12110
12111 .vitem &$tod_bsdinbox$&
12112 .vindex "&$tod_bsdinbox$&"
12113 The time of day and the date, in the format required for BSD-style mailbox
12114 files, for example: Thu Oct 17 17:14:09 1995.
12115
12116 .vitem &$tod_epoch$&
12117 .vindex "&$tod_epoch$&"
12118 The time and date as a number of seconds since the start of the Unix epoch.
12119
12120 .vitem &$tod_epoch_l$&
12121 .vindex "&$tod_epoch_l$&"
12122 The time and date as a number of microseconds since the start of the Unix epoch.
12123
12124 .vitem &$tod_full$&
12125 .vindex "&$tod_full$&"
12126 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12127 +0100. The timezone is always given as a numerical offset from UTC, with
12128 positive values used for timezones that are ahead (east) of UTC, and negative
12129 values for those that are behind (west).
12130
12131 .vitem &$tod_log$&
12132 .vindex "&$tod_log$&"
12133 The time and date in the format used for writing Exim's log files, for example:
12134 1995-10-12 15:32:29, but without a timezone.
12135
12136 .vitem &$tod_logfile$&
12137 .vindex "&$tod_logfile$&"
12138 This variable contains the date in the format yyyymmdd. This is the format that
12139 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12140 flag.
12141
12142 .vitem &$tod_zone$&
12143 .vindex "&$tod_zone$&"
12144 This variable contains the numerical value of the local timezone, for example:
12145 -0500.
12146
12147 .vitem &$tod_zulu$&
12148 .vindex "&$tod_zulu$&"
12149 This variable contains the UTC date and time in &"Zulu"& format, as specified
12150 by ISO 8601, for example: 20030221154023Z.
12151
12152 .vitem &$value$&
12153 .vindex "&$value$&"
12154 This variable contains the result of an expansion lookup, extraction operation,
12155 or external command, as described above. It is also used during a
12156 &*reduce*& expansion.
12157
12158 .vitem &$version_number$&
12159 .vindex "&$version_number$&"
12160 The version number of Exim.
12161
12162 .vitem &$warn_message_delay$&
12163 .vindex "&$warn_message_delay$&"
12164 This variable is set only during the creation of a message warning about a
12165 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12166
12167 .vitem &$warn_message_recipients$&
12168 .vindex "&$warn_message_recipients$&"
12169 This variable is set only during the creation of a message warning about a
12170 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12171 .endlist
12172 .ecindex IIDstrexp
12173
12174
12175
12176 . ////////////////////////////////////////////////////////////////////////////
12177 . ////////////////////////////////////////////////////////////////////////////
12178
12179 .chapter "Embedded Perl" "CHAPperl"
12180 .scindex IIDperl "Perl" "calling from Exim"
12181 Exim can be built to include an embedded Perl interpreter. When this is done,
12182 Perl subroutines can be called as part of the string expansion process. To make
12183 use of the Perl support, you need version 5.004 or later of Perl installed on
12184 your system. To include the embedded interpreter in the Exim binary, include
12185 the line
12186 .code
12187 EXIM_PERL = perl.o
12188 .endd
12189 in your &_Local/Makefile_& and then build Exim in the normal way.
12190
12191
12192 .section "Setting up so Perl can be used" "SECID85"
12193 .oindex "&%perl_startup%&"
12194 Access to Perl subroutines is via a global configuration option called
12195 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12196 no &%perl_startup%& option in the Exim configuration file then no Perl
12197 interpreter is started and there is almost no overhead for Exim (since none of
12198 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12199 option then the associated value is taken to be Perl code which is executed in
12200 a newly created Perl interpreter.
12201
12202 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12203 need backslashes before any characters to escape special meanings. The option
12204 should usually be something like
12205 .code
12206 perl_startup = do '/etc/exim.pl'
12207 .endd
12208 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12209 use from Exim. Exim can be configured either to start up a Perl interpreter as
12210 soon as it is entered, or to wait until the first time it is needed. Starting
12211 the interpreter at the beginning ensures that it is done while Exim still has
12212 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12213 fact used in a particular run. Also, note that this does not mean that Exim is
12214 necessarily running as root when Perl is called at a later time. By default,
12215 the interpreter is started only when it is needed, but this can be changed in
12216 two ways:
12217
12218 .ilist
12219 .oindex "&%perl_at_start%&"
12220 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12221 a startup when Exim is entered.
12222 .next
12223 The command line option &%-ps%& also requests a startup when Exim is entered,
12224 overriding the setting of &%perl_at_start%&.
12225 .endlist
12226
12227 There is also a command line option &%-pd%& (for delay) which suppresses the
12228 initial startup, even if &%perl_at_start%& is set.
12229
12230
12231 .section "Calling Perl subroutines" "SECID86"
12232 When the configuration file includes a &%perl_startup%& option you can make use
12233 of the string expansion item to call the Perl subroutines that are defined
12234 by the &%perl_startup%& code. The operator is used in any of the following
12235 forms:
12236 .code
12237 ${perl{foo}}
12238 ${perl{foo}{argument}}
12239 ${perl{foo}{argument1}{argument2} ... }
12240 .endd
12241 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12242 arguments may be passed. Passing more than this results in an expansion failure
12243 with an error message of the form
12244 .code
12245 Too many arguments passed to Perl subroutine "foo" (max is 8)
12246 .endd
12247 The return value of the Perl subroutine is evaluated in a scalar context before
12248 it is passed back to Exim to be inserted into the expanded string. If the
12249 return value is &'undef'&, the expansion is forced to fail in the same way as
12250 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12251 by obeying Perl's &%die%& function, the expansion fails with the error message
12252 that was passed to &%die%&.
12253
12254
12255 .section "Calling Exim functions from Perl" "SECID87"
12256 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12257 is available to call back into Exim's string expansion function. For example,
12258 the Perl code
12259 .code
12260 my $lp = Exim::expand_string('$local_part');
12261 .endd
12262 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12263 Note those are single quotes and not double quotes to protect against
12264 &$local_part$& being interpolated as a Perl variable.
12265
12266 If the string expansion is forced to fail by a &"fail"& item, the result of
12267 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12268 expansion string, the Perl call from the original expansion string fails with
12269 an appropriate error message, in the same way as if &%die%& were used.
12270
12271 .cindex "debugging" "from embedded Perl"
12272 .cindex "log" "writing from embedded Perl"
12273 Two other Exim functions are available for use from within Perl code.
12274 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12275 debugging is enabled. If you want a newline at the end, you must supply it.
12276 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12277 timestamp. In this case, you should not supply a terminating newline.
12278
12279
12280 .section "Use of standard output and error by Perl" "SECID88"
12281 .cindex "Perl" "standard output and error"
12282 You should not write to the standard error or output streams from within your
12283 Perl code, as it is not defined how these are set up. In versions of Exim
12284 before 4.50, it is possible for the standard output or error to refer to the
12285 SMTP connection during message reception via the daemon. Writing to this stream
12286 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12287 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12288 avoided, but the output is lost.
12289
12290 .cindex "Perl" "use of &%warn%&"
12291 The Perl &%warn%& statement writes to the standard error stream by default.
12292 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12293 you have no control. When Exim starts up the Perl interpreter, it arranges for
12294 output from the &%warn%& statement to be written to the Exim main log. You can
12295 change this by including appropriate Perl magic somewhere in your Perl code.
12296 For example, to discard &%warn%& output completely, you need this:
12297 .code
12298 $SIG{__WARN__} = sub { };
12299 .endd
12300 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12301 example, the code for the subroutine is empty, so it does nothing, but you can
12302 include any Perl code that you like. The text of the &%warn%& message is passed
12303 as the first subroutine argument.
12304 .ecindex IIDperl
12305
12306
12307 . ////////////////////////////////////////////////////////////////////////////
12308 . ////////////////////////////////////////////////////////////////////////////
12309
12310 .chapter "Starting the daemon and the use of network interfaces" &&&
12311          "CHAPinterfaces" &&&
12312          "Starting the daemon"
12313 .cindex "daemon" "starting"
12314 .cindex "interface" "listening"
12315 .cindex "network interface"
12316 .cindex "interface" "network"
12317 .cindex "IP address" "for listening"
12318 .cindex "daemon" "listening IP addresses"
12319 .cindex "TCP/IP" "setting listening interfaces"
12320 .cindex "TCP/IP" "setting listening ports"
12321 A host that is connected to a TCP/IP network may have one or more physical
12322 hardware network interfaces. Each of these interfaces may be configured as one
12323 or more &"logical"& interfaces, which are the entities that a program actually
12324 works with. Each of these logical interfaces is associated with an IP address.
12325 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12326 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12327 knowledge about the host's interfaces for use in three different circumstances:
12328
12329 .olist
12330 When a listening daemon is started, Exim needs to know which interfaces
12331 and ports to listen on.
12332 .next
12333 When Exim is routing an address, it needs to know which IP addresses
12334 are associated with local interfaces. This is required for the correct
12335 processing of MX lists by removing the local host and others with the
12336 same or higher priority values. Also, Exim needs to detect cases
12337 when an address is routed to an IP address that in fact belongs to the
12338 local host. Unless the &%self%& router option or the &%allow_localhost%&
12339 option of the smtp transport is set (as appropriate), this is treated
12340 as an error situation.
12341 .next
12342 When Exim connects to a remote host, it may need to know which interface to use
12343 for the outgoing connection.
12344 .endlist
12345
12346
12347 Exim's default behaviour is likely to be appropriate in the vast majority
12348 of cases. If your host has only one interface, and you want all its IP
12349 addresses to be treated in the same way, and you are using only the
12350 standard SMTP port, you should not need to take any special action. The
12351 rest of this chapter does not apply to you.
12352
12353 In a more complicated situation you may want to listen only on certain
12354 interfaces, or on different ports, and for this reason there are a number of
12355 options that can be used to influence Exim's behaviour. The rest of this
12356 chapter describes how they operate.
12357
12358 When a message is received over TCP/IP, the interface and port that were
12359 actually used are set in &$received_ip_address$& and &$received_port$&.
12360
12361
12362
12363 .section "Starting a listening daemon" "SECID89"
12364 When a listening daemon is started (by means of the &%-bd%& command line
12365 option), the interfaces and ports on which it listens are controlled by the
12366 following options:
12367
12368 .ilist
12369 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12370 compatibility, this option can also be specified in the singular.)
12371 .next
12372 &%local_interfaces%& contains list of interface IP addresses on which to
12373 listen. Each item may optionally also specify a port.
12374 .endlist
12375
12376 The default list separator in both cases is a colon, but this can be changed as
12377 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12378 it is usually best to change the separator to avoid having to double all the
12379 colons. For example:
12380 .code
12381 local_interfaces = <; 127.0.0.1 ; \
12382                       192.168.23.65 ; \
12383                       ::1 ; \
12384                       3ffe:ffff:836f::fe86:a061
12385 .endd
12386 There are two different formats for specifying a port along with an IP address
12387 in &%local_interfaces%&:
12388
12389 .olist
12390 The port is added onto the address with a dot separator. For example, to listen
12391 on port 1234 on two different IP addresses:
12392 .code
12393 local_interfaces = <; 192.168.23.65.1234 ; \
12394                       3ffe:ffff:836f::fe86:a061.1234
12395 .endd
12396 .next
12397 The IP address is enclosed in square brackets, and the port is added
12398 with a colon separator, for example:
12399 .code
12400 local_interfaces = <; [192.168.23.65]:1234 ; \
12401                       [3ffe:ffff:836f::fe86:a061]:1234
12402 .endd
12403 .endlist
12404
12405 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12406 default setting contains just one port:
12407 .code
12408 daemon_smtp_ports = smtp
12409 .endd
12410 If more than one port is listed, each interface that does not have its own port
12411 specified listens on all of them. Ports that are listed in
12412 &%daemon_smtp_ports%& can be identified either by name (defined in
12413 &_/etc/services_&) or by number. However, when ports are given with individual
12414 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12415
12416
12417
12418 .section "Special IP listening addresses" "SECID90"
12419 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12420 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12421 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12422 instead of setting up separate listening sockets for each interface. The
12423 default value of &%local_interfaces%& is
12424 .code
12425 local_interfaces = 0.0.0.0
12426 .endd
12427 when Exim is built without IPv6 support; otherwise it is:
12428 .code
12429 local_interfaces = <; ::0 ; 0.0.0.0
12430 .endd
12431 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12432
12433
12434
12435 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12436 The &%-oX%& command line option can be used to override the values of
12437 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12438 instance. Another way of doing this would be to use macros and the &%-D%&
12439 option. However, &%-oX%& can be used by any admin user, whereas modification of
12440 the runtime configuration by &%-D%& is allowed only when the caller is root or
12441 exim.
12442
12443 The value of &%-oX%& is a list of items. The default colon separator can be
12444 changed in the usual way if required. If there are any items that do not
12445 contain dots or colons (that is, are not IP addresses), the value of
12446 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12447 items that do contain dots or colons, the value of &%local_interfaces%& is
12448 replaced by those items. Thus, for example,
12449 .code
12450 -oX 1225
12451 .endd
12452 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12453 whereas
12454 .code
12455 -oX 192.168.34.5.1125
12456 .endd
12457 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12458 (However, since &%local_interfaces%& now contains no items without ports, the
12459 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12460
12461
12462
12463 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12464 .cindex "ssmtp protocol"
12465 .cindex "smtps protocol"
12466 .cindex "SMTP" "ssmtp protocol"
12467 .cindex "SMTP" "smtps protocol"
12468 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12469 before the STARTTLS command was standardized for SMTP. Some legacy clients
12470 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12471 list of port numbers, connections to those ports must use SSMTP. The most
12472 common use of this option is expected to be
12473 .code
12474 tls_on_connect_ports = 465
12475 .endd
12476 because 465 is the usual port number used by the legacy clients. There is also
12477 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12478 this way when a daemon is started.
12479
12480 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12481 daemon to listen on those ports. You must still specify them in
12482 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12483 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12484 connections via the daemon.)
12485
12486
12487
12488
12489 .section "IPv6 address scopes" "SECID92"
12490 .cindex "IPv6" "address scopes"
12491 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12492 can, in principle, have the same link-local IPv6 address on different
12493 interfaces. Thus, additional information is needed, over and above the IP
12494 address, to distinguish individual interfaces. A convention of using a
12495 percent sign followed by something (often the interface name) has been
12496 adopted in some cases, leading to addresses like this:
12497 .code
12498 fe80::202:b3ff:fe03:45c1%eth0
12499 .endd
12500 To accommodate this usage, a percent sign followed by an arbitrary string is
12501 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12502 to convert a textual IPv6 address for actual use. This function recognizes the
12503 percent convention in operating systems that support it, and it processes the
12504 address appropriately. Unfortunately, some older libraries have problems with
12505 &[getaddrinfo()]&. If
12506 .code
12507 IPV6_USE_INET_PTON=yes
12508 .endd
12509 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12510 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12511 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12512 function.) Of course, this means that the additional functionality of
12513 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12514
12515 .section "Disabling IPv6" "SECID93"
12516 .cindex "IPv6" "disabling"
12517 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12518 run on a host whose kernel does not support IPv6. The binary will fall back to
12519 using IPv4, but it may waste resources looking up AAAA records, and trying to
12520 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12521 .oindex "&%disable_ipv6%&"
12522 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12523 activities take place. AAAA records are never looked up, and any IPv6 addresses
12524 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12525 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12526 to handle IPv6 literal addresses.
12527
12528 On the other hand, when IPv6 is in use, there may be times when you want to
12529 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12530 option to globally suppress the lookup of AAAA records for specified domains,
12531 and you can use the &%ignore_target_hosts%& generic router option to ignore
12532 IPv6 addresses in an individual router.
12533
12534
12535
12536 .section "Examples of starting a listening daemon" "SECID94"
12537 The default case in an IPv6 environment is
12538 .code
12539 daemon_smtp_ports = smtp
12540 local_interfaces = <; ::0 ; 0.0.0.0
12541 .endd
12542 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12543 Either one or two sockets may be used, depending on the characteristics of
12544 the TCP/IP stack. (This is complicated and messy; for more information,
12545 read the comments in the &_daemon.c_& source file.)
12546
12547 To specify listening on ports 25 and 26 on all interfaces:
12548 .code
12549 daemon_smtp_ports = 25 : 26
12550 .endd
12551 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12552 .code
12553 local_interfaces = <; ::0.25     ; ::0.26 \
12554                       0.0.0.0.25 ; 0.0.0.0.26
12555 .endd
12556 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12557 IPv4 loopback address only:
12558 .code
12559 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12560 .endd
12561 To specify listening on the default port on specific interfaces only:
12562 .code
12563 local_interfaces = 192.168.34.67 : 192.168.34.67
12564 .endd
12565 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12566
12567
12568
12569 .section "Recognizing the local host" "SECTreclocipadd"
12570 The &%local_interfaces%& option is also used when Exim needs to determine
12571 whether or not an IP address refers to the local host. That is, the IP
12572 addresses of all the interfaces on which a daemon is listening are always
12573 treated as local.
12574
12575 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12576 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12577 available interfaces from the operating system, and extracts the relevant
12578 (that is, IPv4 or IPv6) addresses to use for checking.
12579
12580 Some systems set up large numbers of virtual interfaces in order to provide
12581 many virtual web servers. In this situation, you may want to listen for
12582 email on only a few of the available interfaces, but nevertheless treat all
12583 interfaces as local when routing. You can do this by setting
12584 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12585 &"all"& wildcard values. These addresses are recognized as local, but are not
12586 used for listening. Consider this example:
12587 .code
12588 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12589                       192.168.53.235 ; \
12590                       3ffe:2101:12:1:a00:20ff:fe86:a061
12591
12592 extra_local_interfaces = <; ::0 ; 0.0.0.0
12593 .endd
12594 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12595 address, but all available interface addresses are treated as local when
12596 Exim is routing.
12597
12598 In some environments the local host name may be in an MX list, but with an IP
12599 address that is not assigned to any local interface. In other cases it may be
12600 desirable to treat other host names as if they referred to the local host. Both
12601 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12602 This contains host names rather than IP addresses. When a host is referenced
12603 during routing, either via an MX record or directly, it is treated as the local
12604 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12605 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12606
12607
12608
12609 .section "Delivering to a remote host" "SECID95"
12610 Delivery to a remote host is handled by the smtp transport. By default, it
12611 allows the system's TCP/IP functions to choose which interface to use (if
12612 there is more than one) when connecting to a remote host. However, the
12613 &%interface%& option can be set to specify which interface is used. See the
12614 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12615 details.
12616
12617
12618
12619
12620 . ////////////////////////////////////////////////////////////////////////////
12621 . ////////////////////////////////////////////////////////////////////////////
12622
12623 .chapter "Main configuration" "CHAPmainconfig"
12624 .scindex IIDconfima "configuration file" "main section"
12625 .scindex IIDmaiconf "main configuration"
12626 The first part of the run time configuration file contains three types of item:
12627
12628 .ilist
12629 Macro definitions: These lines start with an upper case letter. See section
12630 &<<SECTmacrodefs>>& for details of macro processing.
12631 .next
12632 Named list definitions: These lines start with one of the words &"domainlist"&,
12633 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12634 section &<<SECTnamedlists>>&.
12635 .next
12636 Main configuration settings: Each setting occupies one line of the file
12637 (with possible continuations). If any setting is preceded by the word
12638 &"hide"&, the &%-bP%& command line option displays its value to admin users
12639 only. See section &<<SECTcos>>& for a description of the syntax of these option
12640 settings.
12641 .endlist
12642
12643 This chapter specifies all the main configuration options, along with their
12644 types and default values. For ease of finding a particular option, they appear
12645 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12646 are now so many options, they are first listed briefly in functional groups, as
12647 an aid to finding the name of the option you are looking for. Some options are
12648 listed in more than one group.
12649
12650 .section "Miscellaneous" "SECID96"
12651 .table2
12652 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12653 .row &%disable_ipv6%&                "do no IPv6 processing"
12654 .row &%keep_malformed%&              "for broken files &-- should not happen"
12655 .row &%localhost_number%&            "for unique message ids in clusters"
12656 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12657 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12658 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12659 .row &%print_topbitchars%&           "top-bit characters are printing"
12660 .row &%timezone%&                    "force time zone"
12661 .endtable
12662
12663
12664 .section "Exim parameters" "SECID97"
12665 .table2
12666 .row &%exim_group%&                  "override compiled-in value"
12667 .row &%exim_path%&                   "override compiled-in value"
12668 .row &%exim_user%&                   "override compiled-in value"
12669 .row &%primary_hostname%&            "default from &[uname()]&"
12670 .row &%split_spool_directory%&       "use multiple directories"
12671 .row &%spool_directory%&             "override compiled-in value"
12672 .endtable
12673
12674
12675
12676 .section "Privilege controls" "SECID98"
12677 .table2
12678 .row &%admin_groups%&                "groups that are Exim admin users"
12679 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12680 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12681 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12682 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12683 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12684 .row &%never_users%&                 "do not run deliveries as these"
12685 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12686 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12687 .row &%trusted_groups%&              "groups that are trusted"
12688 .row &%trusted_users%&               "users that are trusted"
12689 .endtable
12690
12691
12692
12693 .section "Logging" "SECID99"
12694 .table2
12695 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12696 .row &%log_file_path%&               "override compiled-in value"
12697 .row &%log_selector%&                "set/unset optional logging"
12698 .row &%log_timezone%&                "add timezone to log lines"
12699 .row &%message_logs%&                "create per-message logs"
12700 .row &%preserve_message_logs%&       "after message completion"
12701 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12702 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12703 .row &%syslog_facility%&             "set syslog &""facility""& field"
12704 .row &%syslog_processname%&          "set syslog &""ident""& field"
12705 .row &%syslog_timestamp%&            "timestamp syslog lines"
12706 .row &%write_rejectlog%&             "control use of message log"
12707 .endtable
12708
12709
12710
12711 .section "Frozen messages" "SECID100"
12712 .table2
12713 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12714 .row &%freeze_tell%&                 "send message when freezing"
12715 .row &%move_frozen_messages%&        "to another directory"
12716 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12717 .endtable
12718
12719
12720
12721 .section "Data lookups" "SECID101"
12722 .table2
12723 .row &%ibase_servers%&               "InterBase servers"
12724 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12725 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12726 .row &%ldap_cert_file%&              "client cert file for LDAP"
12727 .row &%ldap_cert_key%&               "client key file for LDAP"
12728 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12729 .row &%ldap_default_servers%&        "used if no server in query"
12730 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12731 .row &%ldap_start_tls%&              "require TLS within LDAP"
12732 .row &%ldap_version%&                "set protocol version"
12733 .row &%lookup_open_max%&             "lookup files held open"
12734 .row &%mysql_servers%&               "default MySQL servers"
12735 .row &%oracle_servers%&              "Oracle servers"
12736 .row &%pgsql_servers%&               "default PostgreSQL servers"
12737 .row &%sqlite_lock_timeout%&         "as it says"
12738 .endtable
12739
12740
12741
12742 .section "Message ids" "SECID102"
12743 .table2
12744 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12745 .row &%message_id_header_text%&      "ditto"
12746 .endtable
12747
12748
12749
12750 .section "Embedded Perl Startup" "SECID103"
12751 .table2
12752 .row &%perl_at_start%&               "always start the interpreter"
12753 .row &%perl_startup%&                "code to obey when starting Perl"
12754 .endtable
12755
12756
12757
12758 .section "Daemon" "SECID104"
12759 .table2
12760 .row &%daemon_smtp_ports%&           "default ports"
12761 .row &%daemon_startup_retries%&      "number of times to retry"
12762 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12763 .row &%extra_local_interfaces%&      "not necessarily listened on"
12764 .row &%local_interfaces%&            "on which to listen, with optional ports"
12765 .row &%pid_file_path%&               "override compiled-in value"
12766 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12767 .endtable
12768
12769
12770
12771 .section "Resource control" "SECID105"
12772 .table2
12773 .row &%check_log_inodes%&            "before accepting a message"
12774 .row &%check_log_space%&             "before accepting a message"
12775 .row &%check_spool_inodes%&          "before accepting a message"
12776 .row &%check_spool_space%&           "before accepting a message"
12777 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12778 .row &%queue_only_load%&             "queue incoming if load high"
12779 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12780 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12781 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12782 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12783 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12784 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12785 .row &%smtp_accept_max_per_connection%& "messages per connection"
12786 .row &%smtp_accept_max_per_host%&    "connections from one host"
12787 .row &%smtp_accept_queue%&           "queue mail if more connections"
12788 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12789                                            connection"
12790 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12791 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12792 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12793 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12794 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12795 .endtable
12796
12797
12798
12799 .section "Policy controls" "SECID106"
12800 .table2
12801 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12802 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12803 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12804 .row &%acl_smtp_auth%&               "ACL for AUTH"
12805 .row &%acl_smtp_connect%&            "ACL for connection"
12806 .row &%acl_smtp_data%&               "ACL for DATA"
12807 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12808 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12809 .row &%acl_smtp_expn%&               "ACL for EXPN"
12810 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12811 .row &%acl_smtp_mail%&               "ACL for MAIL"
12812 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12813 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12814 .row &%acl_smtp_predata%&            "ACL for start of data"
12815 .row &%acl_smtp_quit%&               "ACL for QUIT"
12816 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12817 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12818 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12819 .row &%av_scanner%&                  "specify virus scanner"
12820 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12821                                       words""&"
12822 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12823 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12824 .row &%header_maxsize%&              "total size of message header"
12825 .row &%header_line_maxsize%&         "individual header line limit"
12826 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12827 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12828 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12829 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12830 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12831 .row &%host_lookup%&                 "host name looked up for these hosts"
12832 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12833 .row &%host_reject_connection%&      "reject connection from these hosts"
12834 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12835 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12836 .row &%message_size_limit%&          "for all messages"
12837 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12838 .row &%spamd_address%&               "set interface to SpamAssassin"
12839 .row &%strict_acl_vars%&             "object to unset ACL variables"
12840 .endtable
12841
12842
12843
12844 .section "Callout cache" "SECID107"
12845 .table2
12846 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12847                                          item"
12848 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12849                                          item"
12850 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12851 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12852 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12853 .endtable
12854
12855
12856
12857 .section "TLS" "SECID108"
12858 .table2
12859 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12860 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12861 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12862 .row &%tls_certificate%&             "location of server certificate"
12863 .row &%tls_crl%&                     "certificate revocation list"
12864 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
12865 .row &%tls_dhparam%&                 "DH parameters for server"
12866 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12867 .row &%tls_privatekey%&              "location of server private key"
12868 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12869 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12870 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12871 .row &%tls_verify_certificates%&     "expected client certificates"
12872 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12873 .endtable
12874
12875
12876
12877 .section "Local user handling" "SECID109"
12878 .table2
12879 .row &%finduser_retries%&            "useful in NIS environments"
12880 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12881 .row &%gecos_pattern%&               "ditto"
12882 .row &%max_username_length%&         "for systems that truncate"
12883 .row &%unknown_login%&               "used when no login name found"
12884 .row &%unknown_username%&            "ditto"
12885 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12886 .row &%uucp_from_sender%&            "ditto"
12887 .endtable
12888
12889
12890
12891 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12892 .table2
12893 .row &%header_maxsize%&              "total size of message header"
12894 .row &%header_line_maxsize%&         "individual header line limit"
12895 .row &%message_size_limit%&          "applies to all messages"
12896 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12897 .row &%received_header_text%&        "expanded to make &'Received:'&"
12898 .row &%received_headers_max%&        "for mail loop detection"
12899 .row &%recipients_max%&              "limit per message"
12900 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12901 .endtable
12902
12903
12904
12905
12906 .section "Non-SMTP incoming messages" "SECID111"
12907 .table2
12908 .row &%receive_timeout%&             "for non-SMTP messages"
12909 .endtable
12910
12911
12912
12913
12914
12915 .section "Incoming SMTP messages" "SECID112"
12916 See also the &'Policy controls'& section above.
12917
12918 .table2
12919 .row &%host_lookup%&                 "host name looked up for these hosts"
12920 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12921 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12922 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12923 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12924 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12925 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12926 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12927 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12928 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12929 .row &%smtp_accept_max_per_connection%& "messages per connection"
12930 .row &%smtp_accept_max_per_host%&    "connections from one host"
12931 .row &%smtp_accept_queue%&           "queue mail if more connections"
12932 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12933                                            connection"
12934 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12935 .row &%smtp_active_hostname%&        "host name to use in messages"
12936 .row &%smtp_banner%&                 "text for welcome banner"
12937 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12938 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12939 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12940 .row &%smtp_etrn_command%&           "what to run for ETRN"
12941 .row &%smtp_etrn_serialize%&         "only one at once"
12942 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12943 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12944 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12945 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12946 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12947 .row &%smtp_receive_timeout%&        "per command or data line"
12948 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12949 .row &%smtp_return_error_details%&   "give detail on rejections"
12950 .endtable
12951
12952
12953
12954 .section "SMTP extensions" "SECID113"
12955 .table2
12956 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12957 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12958 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12959 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12960 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12961 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12962 .endtable
12963
12964
12965
12966 .section "Processing messages" "SECID114"
12967 .table2
12968 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12969 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12970 .row &%allow_utf8_domains%&          "in addresses"
12971 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12972                                       words""&"
12973 .row &%delivery_date_remove%&        "from incoming messages"
12974 .row &%envelope_to_remove%&          "from incoming messages"
12975 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12976 .row &%headers_charset%&             "default for translations"
12977 .row &%qualify_domain%&              "default for senders"
12978 .row &%qualify_recipient%&           "default for recipients"
12979 .row &%return_path_remove%&          "from incoming messages"
12980 .row &%strip_excess_angle_brackets%& "in addresses"
12981 .row &%strip_trailing_dot%&          "at end of addresses"
12982 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12983 .endtable
12984
12985
12986
12987 .section "System filter" "SECID115"
12988 .table2
12989 .row &%system_filter%&               "locate system filter"
12990 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12991                                             directory"
12992 .row &%system_filter_file_transport%& "transport for delivery to a file"
12993 .row &%system_filter_group%&         "group for filter running"
12994 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12995 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12996 .row &%system_filter_user%&          "user for filter running"
12997 .endtable
12998
12999
13000
13001 .section "Routing and delivery" "SECID116"
13002 .table2
13003 .row &%disable_ipv6%&                "do no IPv6 processing"
13004 .row &%dns_again_means_nonexist%&    "for broken domains"
13005 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13006 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13007 .row &%dns_retrans%&                 "parameter for resolver"
13008 .row &%dns_retry%&                   "parameter for resolver"
13009 .new
13010 .row &%dns_use_dnssec%&              "parameter for resolver"
13011 .wen
13012 .row &%dns_use_edns0%&               "parameter for resolver"
13013 .row &%hold_domains%&                "hold delivery for these domains"
13014 .row &%local_interfaces%&            "for routing checks"
13015 .row &%queue_domains%&               "no immediate delivery for these"
13016 .row &%queue_only%&                  "no immediate delivery at all"
13017 .row &%queue_only_file%&             "no immediate delivery if file exists"
13018 .row &%queue_only_load%&             "no immediate delivery if load is high"
13019 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13020 .row &%queue_only_override%&         "allow command line to override"
13021 .row &%queue_run_in_order%&          "order of arrival"
13022 .row &%queue_run_max%&               "of simultaneous queue runners"
13023 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13024 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13025 .row &%remote_sort_domains%&         "order of remote deliveries"
13026 .row &%retry_data_expire%&           "timeout for retry data"
13027 .row &%retry_interval_max%&          "safety net for retry rules"
13028 .endtable
13029
13030
13031
13032 .section "Bounce and warning messages" "SECID117"
13033 .table2
13034 .row &%bounce_message_file%&         "content of bounce"
13035 .row &%bounce_message_text%&         "content of bounce"
13036 .row &%bounce_return_body%&          "include body if returning message"
13037 .row &%bounce_return_message%&       "include original message in bounce"
13038 .row &%bounce_return_size_limit%&    "limit on returned message"
13039 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13040 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13041 .row &%errors_copy%&                 "copy bounce messages"
13042 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13043 .row &%delay_warning%&               "time schedule"
13044 .row &%delay_warning_condition%&     "condition for warning messages"
13045 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13046 .row &%smtp_return_error_details%&   "give detail on rejections"
13047 .row &%warn_message_file%&           "content of warning message"
13048 .endtable
13049
13050
13051
13052 .section "Alphabetical list of main options" "SECTalomo"
13053 Those options that undergo string expansion before use are marked with
13054 &dagger;.
13055
13056 .option accept_8bitmime main boolean true
13057 .cindex "8BITMIME"
13058 .cindex "8-bit characters"
13059 This option causes Exim to send 8BITMIME in its response to an SMTP
13060 EHLO command, and to accept the BODY= parameter on MAIL commands.
13061 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13062 takes no steps to do anything special with messages received by this route.
13063
13064 Historically Exim kept this option off by default, but the maintainers
13065 feel that in today's Internet, this causes more problems than it solves.
13066 It now defaults to true.
13067 A more detailed analysis of the issues is provided by Dan Bernstein:
13068 .display
13069 &url(http://cr.yp.to/smtp/8bitmime.html)
13070 .endd
13071
13072 .option acl_not_smtp main string&!! unset
13073 .cindex "&ACL;" "for non-SMTP messages"
13074 .cindex "non-SMTP messages" "ACLs for"
13075 This option defines the ACL that is run when a non-SMTP message has been
13076 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13077 further details.
13078
13079 .option acl_not_smtp_mime main string&!! unset
13080 This option defines the ACL that is run for individual MIME parts of non-SMTP
13081 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13082 SMTP messages.
13083
13084 .option acl_not_smtp_start main string&!! unset
13085 .cindex "&ACL;" "at start of non-SMTP message"
13086 .cindex "non-SMTP messages" "ACLs for"
13087 This option defines the ACL that is run before Exim starts reading a
13088 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13089
13090 .option acl_smtp_auth main string&!! unset
13091 .cindex "&ACL;" "setting up for SMTP commands"
13092 .cindex "AUTH" "ACL for"
13093 This option defines the ACL that is run when an SMTP AUTH command is
13094 received. See chapter &<<CHAPACL>>& for further details.
13095
13096 .option acl_smtp_connect main string&!! unset
13097 .cindex "&ACL;" "on SMTP connection"
13098 This option defines the ACL that is run when an SMTP connection is received.
13099 See chapter &<<CHAPACL>>& for further details.
13100
13101 .option acl_smtp_data main string&!! unset
13102 .cindex "DATA" "ACL for"
13103 This option defines the ACL that is run after an SMTP DATA command has been
13104 processed and the message itself has been received, but before the final
13105 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13106
13107 .option acl_smtp_etrn main string&!! unset
13108 .cindex "ETRN" "ACL for"
13109 This option defines the ACL that is run when an SMTP ETRN command is
13110 received. See chapter &<<CHAPACL>>& for further details.
13111
13112 .option acl_smtp_expn main string&!! unset
13113 .cindex "EXPN" "ACL for"
13114 This option defines the ACL that is run when an SMTP EXPN command is
13115 received. See chapter &<<CHAPACL>>& for further details.
13116
13117 .option acl_smtp_helo main string&!! unset
13118 .cindex "EHLO" "ACL for"
13119 .cindex "HELO" "ACL for"
13120 This option defines the ACL that is run when an SMTP EHLO or HELO
13121 command is received. See chapter &<<CHAPACL>>& for further details.
13122
13123
13124 .option acl_smtp_mail main string&!! unset
13125 .cindex "MAIL" "ACL for"
13126 This option defines the ACL that is run when an SMTP MAIL command is
13127 received. See chapter &<<CHAPACL>>& for further details.
13128
13129 .option acl_smtp_mailauth main string&!! unset
13130 .cindex "AUTH" "on MAIL command"
13131 This option defines the ACL that is run when there is an AUTH parameter on
13132 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13133 &<<CHAPSMTPAUTH>>& for details of authentication.
13134
13135 .option acl_smtp_mime main string&!! unset
13136 .cindex "MIME content scanning" "ACL for"
13137 This option is available when Exim is built with the content-scanning
13138 extension. It defines the ACL that is run for each MIME part in a message. See
13139 section &<<SECTscanmimepart>>& for details.
13140
13141 .option acl_smtp_predata main string&!! unset
13142 This option defines the ACL that is run when an SMTP DATA command is
13143 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13144 further details.
13145
13146 .option acl_smtp_quit main string&!! unset
13147 .cindex "QUIT, ACL for"
13148 This option defines the ACL that is run when an SMTP QUIT command is
13149 received. See chapter &<<CHAPACL>>& for further details.
13150
13151 .option acl_smtp_rcpt main string&!! unset
13152 .cindex "RCPT" "ACL for"
13153 This option defines the ACL that is run when an SMTP RCPT command is
13154 received. See chapter &<<CHAPACL>>& for further details.
13155
13156 .option acl_smtp_starttls main string&!! unset
13157 .cindex "STARTTLS, ACL for"
13158 This option defines the ACL that is run when an SMTP STARTTLS command is
13159 received. See chapter &<<CHAPACL>>& for further details.
13160
13161 .option acl_smtp_vrfy main string&!! unset
13162 .cindex "VRFY" "ACL for"
13163 This option defines the ACL that is run when an SMTP VRFY command is
13164 received. See chapter &<<CHAPACL>>& for further details.
13165
13166 .option admin_groups main "string list&!!" unset
13167 .cindex "admin user"
13168 This option is expanded just once, at the start of Exim's processing. If the
13169 current group or any of the supplementary groups of an Exim caller is in this
13170 colon-separated list, the caller has admin privileges. If all your system
13171 programmers are in a specific group, for example, you can give them all Exim
13172 admin privileges by putting that group in &%admin_groups%&. However, this does
13173 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13174 To permit this, you have to add individuals to the Exim group.
13175
13176 .option allow_domain_literals main boolean false
13177 .cindex "domain literal"
13178 If this option is set, the RFC 2822 domain literal format is permitted in
13179 email addresses. The option is not set by default, because the domain literal
13180 format is not normally required these days, and few people know about it. It
13181 has, however, been exploited by mail abusers.
13182
13183 Unfortunately, it seems that some DNS black list maintainers are using this
13184 format to report black listing to postmasters. If you want to accept messages
13185 addressed to your hosts by IP address, you need to set
13186 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13187 domains (defined in the named domain list &%local_domains%& in the default
13188 configuration). This &"magic string"& matches the domain literal form of all
13189 the local host's IP addresses.
13190
13191
13192 .option allow_mx_to_ip main boolean false
13193 .cindex "MX record" "pointing to IP address"
13194 It appears that more and more DNS zone administrators are breaking the rules
13195 and putting domain names that look like IP addresses on the right hand side of
13196 MX records. Exim follows the rules and rejects this, giving an error message
13197 that explains the mis-configuration. However, some other MTAs support this
13198 practice, so to avoid &"Why can't Exim do this?"& complaints,
13199 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13200 recommended, except when you have no other choice.
13201
13202 .option allow_utf8_domains main boolean false
13203 .cindex "domain" "UTF-8 characters in"
13204 .cindex "UTF-8" "in domain name"
13205 Lots of discussion is going on about internationalized domain names. One
13206 camp is strongly in favour of just using UTF-8 characters, and it seems
13207 that at least two other MTAs permit this. This option allows Exim users to
13208 experiment if they wish.
13209
13210 If it is set true, Exim's domain parsing function allows valid
13211 UTF-8 multicharacters to appear in domain name components, in addition to
13212 letters, digits, and hyphens. However, just setting this option is not
13213 enough; if you want to look up these domain names in the DNS, you must also
13214 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13215 suitable setting is:
13216 .code
13217 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13218   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13219 .endd
13220 Alternatively, you can just disable this feature by setting
13221 .code
13222 dns_check_names_pattern =
13223 .endd
13224 That is, set the option to an empty string so that no check is done.
13225
13226
13227 .option auth_advertise_hosts main "host list&!!" *
13228 .cindex "authentication" "advertising"
13229 .cindex "AUTH" "advertising"
13230 If any server authentication mechanisms are configured, Exim advertises them in
13231 response to an EHLO command only if the calling host matches this list.
13232 Otherwise, Exim does not advertise AUTH.
13233 Exim does not accept AUTH commands from clients to which it has not
13234 advertised the availability of AUTH. The advertising of individual
13235 authentication mechanisms can be controlled by the use of the
13236 &%server_advertise_condition%& generic authenticator option on the individual
13237 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13238
13239 Certain mail clients (for example, Netscape) require the user to provide a name
13240 and password for authentication if AUTH is advertised, even though it may
13241 not be needed (the host may accept messages from hosts on its local LAN without
13242 authentication, for example). The &%auth_advertise_hosts%& option can be used
13243 to make these clients more friendly by excluding them from the set of hosts to
13244 which Exim advertises AUTH.
13245
13246 .cindex "AUTH" "advertising when encrypted"
13247 If you want to advertise the availability of AUTH only when the connection
13248 is encrypted using TLS, you can make use of the fact that the value of this
13249 option is expanded, with a setting like this:
13250 .code
13251 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13252 .endd
13253 .vindex "&$tls_in_cipher$&"
13254 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13255 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13256 expansion is *, which matches all hosts.
13257
13258
13259 .option auto_thaw main time 0s
13260 .cindex "thawing messages"
13261 .cindex "unfreezing messages"
13262 If this option is set to a time greater than zero, a queue runner will try a
13263 new delivery attempt on any frozen message, other than a bounce message, if
13264 this much time has passed since it was frozen. This may result in the message
13265 being re-frozen if nothing has changed since the last attempt. It is a way of
13266 saying &"keep on trying, even though there are big problems"&.
13267
13268 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13269 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13270 thought to be very useful any more, and its use should probably be avoided.
13271
13272
13273 .option av_scanner main string "see below"
13274 This option is available if Exim is built with the content-scanning extension.
13275 It specifies which anti-virus scanner to use. The default value is:
13276 .code
13277 sophie:/var/run/sophie
13278 .endd
13279 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13280 before use. See section &<<SECTscanvirus>>& for further details.
13281
13282
13283 .option bi_command main string unset
13284 .oindex "&%-bi%&"
13285 This option supplies the name of a command that is run when Exim is called with
13286 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13287 just the command name, it is not a complete command line. If an argument is
13288 required, it must come from the &%-oA%& command line option.
13289
13290
13291 .option bounce_message_file main string unset
13292 .cindex "bounce message" "customizing"
13293 .cindex "customizing" "bounce message"
13294 This option defines a template file containing paragraphs of text to be used
13295 for constructing bounce messages.  Details of the file's contents are given in
13296 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13297
13298
13299 .option bounce_message_text main string unset
13300 When this option is set, its contents are included in the default bounce
13301 message immediately after &"This message was created automatically by mail
13302 delivery software."& It is not used if &%bounce_message_file%& is set.
13303
13304 .option bounce_return_body main boolean true
13305 .cindex "bounce message" "including body"
13306 This option controls whether the body of an incoming message is included in a
13307 bounce message when &%bounce_return_message%& is true. The default setting
13308 causes the entire message, both header and body, to be returned (subject to the
13309 value of &%bounce_return_size_limit%&). If this option is false, only the
13310 message header is included. In the case of a non-SMTP message containing an
13311 error that is detected during reception, only those header lines preceding the
13312 point at which the error was detected are returned.
13313 .cindex "bounce message" "including original"
13314
13315 .option bounce_return_message main boolean true
13316 If this option is set false, none of the original message is included in
13317 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13318 &%bounce_return_body%&.
13319
13320
13321 .option bounce_return_size_limit main integer 100K
13322 .cindex "size" "of bounce, limit"
13323 .cindex "bounce message" "size limit"
13324 .cindex "limit" "bounce message size"
13325 This option sets a limit in bytes on the size of messages that are returned to
13326 senders as part of bounce messages when &%bounce_return_message%& is true. The
13327 limit should be less than the value of the global &%message_size_limit%& and of
13328 any &%message_size_limit%& settings on transports, to allow for the bounce text
13329 that Exim generates. If this option is set to zero there is no limit.
13330
13331 When the body of any message that is to be included in a bounce message is
13332 greater than the limit, it is truncated, and a comment pointing this out is
13333 added at the top. The actual cutoff may be greater than the value given, owing
13334 to the use of buffering for transferring the message in chunks (typically 8K in
13335 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13336 messages.
13337
13338 .option bounce_sender_authentication main string unset
13339 .cindex "bounce message" "sender authentication"
13340 .cindex "authentication" "bounce message"
13341 .cindex "AUTH" "on bounce message"
13342 This option provides an authenticated sender address that is sent with any
13343 bounce messages generated by Exim that are sent over an authenticated SMTP
13344 connection. A typical setting might be:
13345 .code
13346 bounce_sender_authentication = mailer-daemon@my.domain.example
13347 .endd
13348 which would cause bounce messages to be sent using the SMTP command:
13349 .code
13350 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13351 .endd
13352 The value of &%bounce_sender_authentication%& must always be a complete email
13353 address.
13354
13355 .option callout_domain_negative_expire main time 3h
13356 .cindex "caching" "callout timeouts"
13357 .cindex "callout" "caching timeouts"
13358 This option specifies the expiry time for negative callout cache data for a
13359 domain. See section &<<SECTcallver>>& for details of callout verification, and
13360 section &<<SECTcallvercache>>& for details of the caching.
13361
13362
13363 .option callout_domain_positive_expire main time 7d
13364 This option specifies the expiry time for positive callout cache data for a
13365 domain. See section &<<SECTcallver>>& for details of callout verification, and
13366 section &<<SECTcallvercache>>& for details of the caching.
13367
13368
13369 .option callout_negative_expire main time 2h
13370 This option specifies the expiry time for negative callout cache data for an
13371 address. See section &<<SECTcallver>>& for details of callout verification, and
13372 section &<<SECTcallvercache>>& for details of the caching.
13373
13374
13375 .option callout_positive_expire main time 24h
13376 This option specifies the expiry time for positive callout cache data for an
13377 address. See section &<<SECTcallver>>& for details of callout verification, and
13378 section &<<SECTcallvercache>>& for details of the caching.
13379
13380
13381 .option callout_random_local_part main string&!! "see below"
13382 This option defines the &"random"& local part that can be used as part of
13383 callout verification. The default value is
13384 .code
13385 $primary_hostname-$tod_epoch-testing
13386 .endd
13387 See section &<<CALLaddparcall>>& for details of how this value is used.
13388
13389
13390 .option check_log_inodes main integer 0
13391 See &%check_spool_space%& below.
13392
13393
13394 .option check_log_space main integer 0
13395 See &%check_spool_space%& below.
13396
13397 .oindex "&%check_rfc2047_length%&"
13398 .cindex "RFC 2047" "disabling length check"
13399 .option check_rfc2047_length main boolean true
13400 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13401 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13402 word; strings to be encoded that exceed this length are supposed to use
13403 multiple encoded words. By default, Exim does not recognize encoded words that
13404 exceed the maximum length. However, it seems that some software, in violation
13405 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13406 set false, Exim recognizes encoded words of any length.
13407
13408
13409 .option check_spool_inodes main integer 0
13410 See &%check_spool_space%& below.
13411
13412
13413 .option check_spool_space main integer 0
13414 .cindex "checking disk space"
13415 .cindex "disk space, checking"
13416 .cindex "spool directory" "checking space"
13417 The four &%check_...%& options allow for checking of disk resources before a
13418 message is accepted.
13419
13420 .vindex "&$log_inodes$&"
13421 .vindex "&$log_space$&"
13422 .vindex "&$spool_inodes$&"
13423 .vindex "&$spool_space$&"
13424 When any of these options are set, they apply to all incoming messages. If you
13425 want to apply different checks to different kinds of message, you can do so by
13426 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13427 &$spool_space$& in an ACL with appropriate additional conditions.
13428
13429
13430 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13431 either value is greater than zero, for example:
13432 .code
13433 check_spool_space = 10M
13434 check_spool_inodes = 100
13435 .endd
13436 The spool partition is the one that contains the directory defined by
13437 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13438 transit.
13439
13440 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13441 files are written if either is greater than zero. These should be set only if
13442 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13443
13444 If there is less space or fewer inodes than requested, Exim refuses to accept
13445 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13446 error response to the MAIL command. If ESMTP is in use and there was a
13447 SIZE parameter on the MAIL command, its value is added to the
13448 &%check_spool_space%& value, and the check is performed even if
13449 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13450
13451 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13452 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13453
13454 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13455 failure a message is written to stderr and Exim exits with a non-zero code, as
13456 it obviously cannot send an error message of any kind.
13457
13458 .option daemon_smtp_ports main string &`smtp`&
13459 .cindex "port" "for daemon"
13460 .cindex "TCP/IP" "setting listening ports"
13461 This option specifies one or more default SMTP ports on which the Exim daemon
13462 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13463 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13464
13465 .option daemon_startup_retries main integer 9
13466 .cindex "daemon startup, retrying"
13467 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13468 the daemon at startup when it cannot immediately bind a listening socket
13469 (typically because the socket is already in use): &%daemon_startup_retries%&
13470 defines the number of retries after the first failure, and
13471 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13472
13473 .option daemon_startup_sleep main time 30s
13474 See &%daemon_startup_retries%&.
13475
13476 .option delay_warning main "time list" 24h
13477 .cindex "warning of delay"
13478 .cindex "delay warning, specifying"
13479 When a message is delayed, Exim sends a warning message to the sender at
13480 intervals specified by this option. The data is a colon-separated list of times
13481 after which to send warning messages. If the value of the option is an empty
13482 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13483 message has been on the queue for longer than the last time, the last interval
13484 between the times is used to compute subsequent warning times. For example,
13485 with
13486 .code
13487 delay_warning = 4h:8h:24h
13488 .endd
13489 the first message is sent after 4 hours, the second after 8 hours, and
13490 the third one after 24 hours. After that, messages are sent every 16 hours,
13491 because that is the interval between the last two times on the list. If you set
13492 just one time, it specifies the repeat interval. For example, with:
13493 .code
13494 delay_warning = 6h
13495 .endd
13496 messages are repeated every six hours. To stop warnings after a given time, set
13497 a very large time at the end of the list. For example:
13498 .code
13499 delay_warning = 2h:12h:99d
13500 .endd
13501
13502 .option delay_warning_condition main string&!! "see below"
13503 .vindex "&$domain$&"
13504 The string is expanded at the time a warning message might be sent. If all the
13505 deferred addresses have the same domain, it is set in &$domain$& during the
13506 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13507 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13508 &"false"& (the comparison being done caselessly) then the warning message is
13509 not sent. The default is:
13510 .code
13511 delay_warning_condition = ${if or {\
13512   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13513   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13514   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13515   } {no}{yes}}
13516 .endd
13517 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13518 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13519 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13520 &"auto-replied"& in an &'Auto-Submitted:'& header.
13521
13522 .option deliver_drop_privilege main boolean false
13523 .cindex "unprivileged delivery"
13524 .cindex "delivery" "unprivileged"
13525 If this option is set true, Exim drops its root privilege at the start of a
13526 delivery process, and runs as the Exim user throughout. This severely restricts
13527 the kinds of local delivery that are possible, but is viable in certain types
13528 of configuration. There is a discussion about the use of root privilege in
13529 chapter &<<CHAPsecurity>>&.
13530
13531 .option deliver_queue_load_max main fixed-point unset
13532 .cindex "load average"
13533 .cindex "queue runner" "abandoning"
13534 When this option is set, a queue run is abandoned if the system load average
13535 becomes greater than the value of the option. The option has no effect on
13536 ancient operating systems on which Exim cannot determine the load average.
13537 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13538
13539
13540 .option delivery_date_remove main boolean true
13541 .cindex "&'Delivery-date:'& header line"
13542 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13543 message when it is delivered, in exactly the same way as &'Return-path:'& is
13544 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13545 should not be present in incoming messages, and this option causes them to be
13546 removed at the time the message is received, to avoid any problems that might
13547 occur when a delivered message is subsequently sent on to some other recipient.
13548
13549 .option disable_fsync main boolean false
13550 .cindex "&[fsync()]&, disabling"
13551 This option is available only if Exim was built with the compile-time option
13552 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13553 a runtime configuration generates an &"unknown option"& error. You should not
13554 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13555 really, really, really understand what you are doing. &'No pre-compiled
13556 distributions of Exim should ever make this option available.'&
13557
13558 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13559 updated files' data to be written to disc before continuing. Unexpected events
13560 such as crashes and power outages may cause data to be lost or scrambled.
13561 Here be Dragons. &*Beware.*&
13562
13563
13564 .option disable_ipv6 main boolean false
13565 .cindex "IPv6" "disabling"
13566 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13567 activities take place. AAAA records are never looked up, and any IPv6 addresses
13568 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13569 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13570 to handle IPv6 literal addresses.
13571
13572
13573 .option dns_again_means_nonexist main "domain list&!!" unset
13574 .cindex "DNS" "&""try again""& response; overriding"
13575 DNS lookups give a &"try again"& response for the DNS errors
13576 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13577 keep trying to deliver a message, or to give repeated temporary errors to
13578 incoming mail. Sometimes the effect is caused by a badly set up name server and
13579 may persist for a long time. If a domain which exhibits this problem matches
13580 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13581 This option should be used with care. You can make it apply to reverse lookups
13582 by a setting such as this:
13583 .code
13584 dns_again_means_nonexist = *.in-addr.arpa
13585 .endd
13586 This option applies to all DNS lookups that Exim does. It also applies when the
13587 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13588 since these are most likely to be caused by DNS lookup problems. The
13589 &(dnslookup)& router has some options of its own for controlling what happens
13590 when lookups for MX or SRV records give temporary errors. These more specific
13591 options are applied after this global option.
13592
13593 .option dns_check_names_pattern main string "see below"
13594 .cindex "DNS" "pre-check of name syntax"
13595 When this option is set to a non-empty string, it causes Exim to check domain
13596 names for characters that are not allowed in host names before handing them to
13597 the DNS resolver, because some resolvers give temporary errors for names that
13598 contain unusual characters. If a domain name contains any unwanted characters,
13599 a &"not found"& result is forced, and the resolver is not called. The check is
13600 done by matching the domain name against a regular expression, which is the
13601 value of this option. The default pattern is
13602 .code
13603 dns_check_names_pattern = \
13604   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13605 .endd
13606 which permits only letters, digits, slashes, and hyphens in components, but
13607 they must start and end with a letter or digit. Slashes are not, in fact,
13608 permitted in host names, but they are found in certain NS records (which can be
13609 accessed in Exim by using a &%dnsdb%& lookup). If you set
13610 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13611 empty string.
13612
13613 .option dns_csa_search_limit main integer 5
13614 This option controls the depth of parental searching for CSA SRV records in the
13615 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13616
13617 .option dns_csa_use_reverse main boolean true
13618 This option controls whether or not an IP address, given as a CSA domain, is
13619 reversed and looked up in the reverse DNS, as described in more detail in
13620 section &<<SECTverifyCSA>>&.
13621
13622 .option dns_ipv4_lookup main "domain list&!!" unset
13623 .cindex "IPv6" "DNS lookup for AAAA records"
13624 .cindex "DNS" "IPv6 lookup for AAAA records"
13625 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13626 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13627 (A records) when trying to find IP addresses for hosts, unless the host's
13628 domain matches this list.
13629
13630 This is a fudge to help with name servers that give big delays or otherwise do
13631 not work for the AAAA record type. In due course, when the world's name
13632 servers have all been upgraded, there should be no need for this option.
13633
13634
13635 .option dns_retrans main time 0s
13636 .cindex "DNS" "resolver options"
13637 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13638 retransmission and retry parameters for DNS lookups. Values of zero (the
13639 defaults) leave the system default settings unchanged. The first value is the
13640 time between retries, and the second is the number of retries. It isn't
13641 totally clear exactly how these settings affect the total time a DNS lookup may
13642 take. I haven't found any documentation about timeouts on DNS lookups; these
13643 parameter values are available in the external resolver interface structure,
13644 but nowhere does it seem to describe how they are used or what you might want
13645 to set in them.
13646
13647
13648 .option dns_retry main integer 0
13649 See &%dns_retrans%& above.
13650
13651
13652 .new
13653 .option dns_use_dnssec main integer -1
13654 .cindex "DNS" "resolver options"
13655 .cindex "DNS" "DNSSEC"
13656 If this option is set to a non-negative number then Exim will initialise the
13657 DNS resolver library to either use or not use DNSSEC, overriding the system
13658 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
13659
13660 If the resolver library does not support DNSSEC then this option has no effect.
13661 .wen
13662
13663
13664 .option dns_use_edns0 main integer -1
13665 .cindex "DNS" "resolver options"
13666 .cindex "DNS" "EDNS0"
13667 If this option is set to a non-negative number then Exim will initialise the
13668 DNS resolver library to either use or not use EDNS0 extensions, overriding
13669 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13670 on.
13671
13672 If the resolver library does not support EDNS0 then this option has no effect.
13673
13674
13675 .option drop_cr main boolean false
13676 This is an obsolete option that is now a no-op. It used to affect the way Exim
13677 handled CR and LF characters in incoming messages. What happens now is
13678 described in section &<<SECTlineendings>>&.
13679
13680 .option dsn_from main "string&!!" "see below"
13681 .cindex "&'From:'& header line" "in bounces"
13682 .cindex "bounce messages" "&'From:'& line, specifying"
13683 This option can be used to vary the contents of &'From:'& header lines in
13684 bounces and other automatically generated messages (&"Delivery Status
13685 Notifications"& &-- hence the name of the option). The default setting is:
13686 .code
13687 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13688 .endd
13689 The value is expanded every time it is needed. If the expansion fails, a
13690 panic is logged, and the default value is used.
13691
13692 .option envelope_to_remove main boolean true
13693 .cindex "&'Envelope-to:'& header line"
13694 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13695 message when it is delivered, in exactly the same way as &'Return-path:'& is
13696 handled. &'Envelope-to:'& records the original recipient address from the
13697 messages's envelope that caused the delivery to happen. Such headers should not
13698 be present in incoming messages, and this option causes them to be removed at
13699 the time the message is received, to avoid any problems that might occur when a
13700 delivered message is subsequently sent on to some other recipient.
13701
13702
13703 .option errors_copy main "string list&!!" unset
13704 .cindex "bounce message" "copy to other address"
13705 .cindex "copy of bounce message"
13706 Setting this option causes Exim to send bcc copies of bounce messages that it
13707 generates to other addresses. &*Note*&: This does not apply to bounce messages
13708 coming from elsewhere. The value of the option is a colon-separated list of
13709 items. Each item consists of a pattern, terminated by white space, followed by
13710 a comma-separated list of email addresses. If a pattern contains spaces, it
13711 must be enclosed in double quotes.
13712
13713 Each pattern is processed in the same way as a single item in an address list
13714 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13715 the bounce message, the message is copied to the addresses on the list. The
13716 items are scanned in order, and once a matching one is found, no further items
13717 are examined. For example:
13718 .code
13719 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13720               rqps@mydomain   hostmaster@mydomain.example,\
13721                               postmaster@mydomain.example
13722 .endd
13723 .vindex "&$domain$&"
13724 .vindex "&$local_part$&"
13725 The address list is expanded before use. The expansion variables &$local_part$&
13726 and &$domain$& are set from the original recipient of the error message, and if
13727 there was any wildcard matching in the pattern, the expansion
13728 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13729 variables &$0$&, &$1$&, etc. are set in the normal way.
13730
13731
13732 .option errors_reply_to main string unset
13733 .cindex "bounce message" "&'Reply-to:'& in"
13734 By default, Exim's bounce and delivery warning messages contain the header line
13735 .display
13736 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13737 .endd
13738 .oindex &%quota_warn_message%&
13739 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13740 A warning message that is generated by the &%quota_warn_message%& option in an
13741 &(appendfile)& transport may contain its own &'From:'& header line that
13742 overrides the default.
13743
13744 Experience shows that people reply to bounce messages. If the
13745 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13746 and warning messages. For example:
13747 .code
13748 errors_reply_to = postmaster@my.domain.example
13749 .endd
13750 The value of the option is not expanded. It must specify a valid RFC 2822
13751 address. However, if a warning message that is generated by the
13752 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13753 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13754 not used.
13755
13756
13757 .option exim_group main string "compile-time configured"
13758 .cindex "gid (group id)" "Exim's own"
13759 .cindex "Exim group"
13760 This option changes the gid under which Exim runs when it gives up root
13761 privilege. The default value is compiled into the binary. The value of this
13762 option is used only when &%exim_user%& is also set. Unless it consists entirely
13763 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13764 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13765 security issues.
13766
13767
13768 .option exim_path main string "see below"
13769 .cindex "Exim binary, path name"
13770 This option specifies the path name of the Exim binary, which is used when Exim
13771 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13772 the directory configured at compile time by the BIN_DIRECTORY setting. It
13773 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13774 other place.
13775 &*Warning*&: Do not use a macro to define the value of this option, because
13776 you will break those Exim utilities that scan the configuration file to find
13777 where the binary is. (They then use the &%-bP%& option to extract option
13778 settings such as the value of &%spool_directory%&.)
13779
13780
13781 .option exim_user main string "compile-time configured"
13782 .cindex "uid (user id)" "Exim's own"
13783 .cindex "Exim user"
13784 This option changes the uid under which Exim runs when it gives up root
13785 privilege. The default value is compiled into the binary. Ownership of the run
13786 time configuration file and the use of the &%-C%& and &%-D%& command line
13787 options is checked against the values in the binary, not what is set here.
13788
13789 Unless it consists entirely of digits, the string is looked up using
13790 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13791 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13792 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13793
13794
13795 .option extra_local_interfaces main "string list" unset
13796 This option defines network interfaces that are to be considered local when
13797 routing, but which are not used for listening by the daemon. See section
13798 &<<SECTreclocipadd>>& for details.
13799
13800
13801 . Allow this long option name to split; give it unsplit as a fifth argument
13802 . for the automatic .oindex that is generated by .option.
13803
13804 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13805          extract_addresses_remove_arguments
13806 .oindex "&%-t%&"
13807 .cindex "command line" "addresses with &%-t%&"
13808 .cindex "Sendmail compatibility" "&%-t%& option"
13809 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13810 are present on the command line when the &%-t%& option is used to build an
13811 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13812 line addresses are removed from the recipients list. This is also how Smail
13813 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13814 command line addresses are added to those obtained from the header lines. When
13815 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13816 argument headers. If it is set false, Exim adds rather than removes argument
13817 addresses.
13818
13819
13820 .option finduser_retries main integer 0
13821 .cindex "NIS, retrying user lookups"
13822 On systems running NIS or other schemes in which user and group information is
13823 distributed from a remote system, there can be times when &[getpwnam()]& and
13824 related functions fail, even when given valid data, because things time out.
13825 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13826 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13827 many extra times to find a user or a group, waiting for one second between
13828 retries.
13829
13830 .cindex "&_/etc/passwd_&" "multiple reading of"
13831 You should not set this option greater than zero if your user information is in
13832 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13833 search the file multiple times for non-existent users, and also cause delay.
13834
13835
13836
13837 .option freeze_tell main "string list, comma separated" unset
13838 .cindex "freezing messages" "sending a message when freezing"
13839 On encountering certain errors, or when configured to do so in a system filter,
13840 ACL, or special router, Exim freezes a message. This means that no further
13841 delivery attempts take place until an administrator thaws the message, or the
13842 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13843 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13844 warning message whenever it freezes something, unless the message it is
13845 freezing is a locally-generated bounce message. (Without this exception there
13846 is the possibility of looping.) The warning message is sent to the addresses
13847 supplied as the comma-separated value of this option. If several of the
13848 message's addresses cause freezing, only a single message is sent. If the
13849 freezing was automatic, the reason(s) for freezing can be found in the message
13850 log. If you configure freezing in a filter or ACL, you must arrange for any
13851 logging that you require.
13852
13853
13854 .option gecos_name main string&!! unset
13855 .cindex "HP-UX"
13856 .cindex "&""gecos""& field, parsing"
13857 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13858 password file to hold other information in addition to users' real names. Exim
13859 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13860 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13861 of the field are used unchanged, except that, if an ampersand is encountered,
13862 it is replaced by the user's login name with the first character forced to
13863 upper case, since this is a convention that is observed on many systems.
13864
13865 When these options are set, &%gecos_pattern%& is treated as a regular
13866 expression that is to be applied to the field (again with && replaced by the
13867 login name), and if it matches, &%gecos_name%& is expanded and used as the
13868 user's name.
13869
13870 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13871 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13872 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13873 name terminates at the first comma, the following can be used:
13874 .code
13875 gecos_pattern = ([^,]*)
13876 gecos_name = $1
13877 .endd
13878
13879 .option gecos_pattern main string unset
13880 See &%gecos_name%& above.
13881
13882
13883 .option gnutls_compat_mode main boolean unset
13884 This option controls whether GnuTLS is used in compatibility mode in an Exim
13885 server. This reduces security slightly, but improves interworking with older
13886 implementations of TLS.
13887
13888 .option headers_charset main string "see below"
13889 This option sets a default character set for translating from encoded MIME
13890 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13891 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13892 ultimate default is ISO-8859-1. For more details see the description of header
13893 insertions in section &<<SECTexpansionitems>>&.
13894
13895
13896
13897 .option header_maxsize main integer "see below"
13898 .cindex "header section" "maximum size of"
13899 .cindex "limit" "size of message header section"
13900 This option controls the overall maximum size of a message's header
13901 section. The default is the value of HEADER_MAXSIZE in
13902 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13903 sections are rejected.
13904
13905
13906 .option header_line_maxsize main integer 0
13907 .cindex "header lines" "maximum size of"
13908 .cindex "limit" "size of one header line"
13909 This option limits the length of any individual header line in a message, after
13910 all the continuations have been joined together. Messages with individual
13911 header lines that are longer than the limit are rejected. The default value of
13912 zero means &"no limit"&.
13913
13914
13915
13916
13917 .option helo_accept_junk_hosts main "host list&!!" unset
13918 .cindex "HELO" "accepting junk data"
13919 .cindex "EHLO" "accepting junk data"
13920 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13921 mail, and gives an error response for invalid data. Unfortunately, there are
13922 some SMTP clients that send syntactic junk. They can be accommodated by setting
13923 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13924 if you want to do semantic checking.
13925 See also &%helo_allow_chars%& for a way of extending the permitted character
13926 set.
13927
13928
13929 .option helo_allow_chars main string unset
13930 .cindex "HELO" "underscores in"
13931 .cindex "EHLO" "underscores in"
13932 .cindex "underscore in EHLO/HELO"
13933 This option can be set to a string of rogue characters that are permitted in
13934 all EHLO and HELO names in addition to the standard letters, digits,
13935 hyphens, and dots. If you really must allow underscores, you can set
13936 .code
13937 helo_allow_chars = _
13938 .endd
13939 Note that the value is one string, not a list.
13940
13941
13942 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13943 .cindex "HELO" "forcing reverse lookup"
13944 .cindex "EHLO" "forcing reverse lookup"
13945 If the domain given by a client in a HELO or EHLO command matches this
13946 list, a reverse lookup is done in order to establish the host's true name. The
13947 default forces a lookup if the client host gives the server's name or any of
13948 its IP addresses (in brackets), something that broken clients have been seen to
13949 do.
13950
13951
13952 .option helo_try_verify_hosts main "host list&!!" unset
13953 .cindex "HELO verifying" "optional"
13954 .cindex "EHLO" "verifying, optional"
13955 By default, Exim just checks the syntax of HELO and EHLO commands (see
13956 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13957 to do more extensive checking of the data supplied by these commands. The ACL
13958 condition &`verify = helo`& is provided to make this possible.
13959 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13960 to force the check to occur. From release 4.53 onwards, this is no longer
13961 necessary. If the check has not been done before &`verify = helo`& is
13962 encountered, it is done at that time. Consequently, this option is obsolete.
13963 Its specification is retained here for backwards compatibility.
13964
13965 When an EHLO or HELO command is received, if the calling host matches
13966 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13967 EHLO command either:
13968
13969 .ilist
13970 is an IP literal matching the calling address of the host, or
13971 .next
13972 .cindex "DNS" "reverse lookup"
13973 .cindex "reverse DNS lookup"
13974 matches the host name that Exim obtains by doing a reverse lookup of the
13975 calling host address, or
13976 .next
13977 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13978 available) yields the calling host address.
13979 .endlist
13980
13981 However, the EHLO or HELO command is not rejected if any of the checks
13982 fail. Processing continues, but the result of the check is remembered, and can
13983 be detected later in an ACL by the &`verify = helo`& condition.
13984
13985 .option helo_verify_hosts main "host list&!!" unset
13986 .cindex "HELO verifying" "mandatory"
13987 .cindex "EHLO" "verifying, mandatory"
13988 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13989 backwards compatibility. For hosts that match this option, Exim checks the host
13990 name given in the HELO or EHLO in the same way as for
13991 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13992 rejected with a 550 error, and entries are written to the main and reject logs.
13993 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13994 error.
13995
13996 .option hold_domains main "domain list&!!" unset
13997 .cindex "domain" "delaying delivery"
13998 .cindex "delivery" "delaying certain domains"
13999 This option allows mail for particular domains to be held on the queue
14000 manually. The option is overridden if a message delivery is forced with the
14001 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14002 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14003 item in &%hold_domains%&, no routing or delivery for that address is done, and
14004 it is deferred every time the message is looked at.
14005
14006 This option is intended as a temporary operational measure for delaying the
14007 delivery of mail while some problem is being sorted out, or some new
14008 configuration tested. If you just want to delay the processing of some
14009 domains until a queue run occurs, you should use &%queue_domains%& or
14010 &%queue_smtp_domains%&, not &%hold_domains%&.
14011
14012 A setting of &%hold_domains%& does not override Exim's code for removing
14013 messages from the queue if they have been there longer than the longest retry
14014 time in any retry rule. If you want to hold messages for longer than the normal
14015 retry times, insert a dummy retry rule with a long retry time.
14016
14017
14018 .option host_lookup main "host list&!!" unset
14019 .cindex "host name" "lookup, forcing"
14020 Exim does not look up the name of a calling host from its IP address unless it
14021 is required to compare against some host list, or the host matches
14022 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14023 option (which normally contains IP addresses rather than host names). The
14024 default configuration file contains
14025 .code
14026 host_lookup = *
14027 .endd
14028 which causes a lookup to happen for all hosts. If the expense of these lookups
14029 is felt to be too great, the setting can be changed or removed.
14030
14031 After a successful reverse lookup, Exim does a forward lookup on the name it
14032 has obtained, to verify that it yields the IP address that it started with. If
14033 this check fails, Exim behaves as if the name lookup failed.
14034
14035 .vindex "&$host_lookup_failed$&"
14036 .vindex "&$sender_host_name$&"
14037 After any kind of failure, the host name (in &$sender_host_name$&) remains
14038 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14039 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14040 &`verify = reverse_host_lookup`& in ACLs.
14041
14042
14043 .option host_lookup_order main "string list" &`bydns:byaddr`&
14044 This option specifies the order of different lookup methods when Exim is trying
14045 to find a host name from an IP address. The default is to do a DNS lookup
14046 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14047 if that fails. You can change the order of these lookups, or omit one entirely,
14048 if you want.
14049
14050 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14051 multiple PTR records in the DNS and the IP address is not listed in
14052 &_/etc/hosts_&. Different operating systems give different results in this
14053 case. That is why the default tries a DNS lookup first.
14054
14055
14056
14057 .option host_reject_connection main "host list&!!" unset
14058 .cindex "host" "rejecting connections from"
14059 If this option is set, incoming SMTP calls from the hosts listed are rejected
14060 as soon as the connection is made.
14061 This option is obsolete, and retained only for backward compatibility, because
14062 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14063 connections immediately.
14064
14065 The ability to give an immediate rejection (either by this option or using an
14066 ACL) is provided for use in unusual cases. Many hosts will just try again,
14067 sometimes without much delay. Normally, it is better to use an ACL to reject
14068 incoming messages at a later stage, such as after RCPT commands. See
14069 chapter &<<CHAPACL>>&.
14070
14071
14072 .option hosts_connection_nolog main "host list&!!" unset
14073 .cindex "host" "not logging connections from"
14074 This option defines a list of hosts for which connection logging does not
14075 happen, even though the &%smtp_connection%& log selector is set. For example,
14076 you might want not to log SMTP connections from local processes, or from
14077 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14078 the daemon; you should therefore strive to restrict its value to a short inline
14079 list of IP addresses and networks. To disable logging SMTP connections from
14080 local processes, you must create a host list with an empty item. For example:
14081 .code
14082 hosts_connection_nolog = :
14083 .endd
14084 If the &%smtp_connection%& log selector is not set, this option has no effect.
14085
14086
14087
14088 .option hosts_treat_as_local main "domain list&!!" unset
14089 .cindex "local host" "domains treated as"
14090 .cindex "host" "treated as local"
14091 If this option is set, any host names that match the domain list are treated as
14092 if they were the local host when Exim is scanning host lists obtained from MX
14093 records
14094 or other sources. Note that the value of this option is a domain list, not a
14095 host list, because it is always used to check host names, not IP addresses.
14096
14097 This option also applies when Exim is matching the special items
14098 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14099 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14100 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14101 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14102 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14103 interfaces and recognizing the local host.
14104
14105
14106 .option ibase_servers main "string list" unset
14107 .cindex "InterBase" "server list"
14108 This option provides a list of InterBase servers and associated connection data,
14109 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14110 The option is available only if Exim has been built with InterBase support.
14111
14112
14113
14114 .option ignore_bounce_errors_after main time 10w
14115 .cindex "bounce message" "discarding"
14116 .cindex "discarding bounce message"
14117 This option affects the processing of bounce messages that cannot be delivered,
14118 that is, those that suffer a permanent delivery failure. (Bounce messages that
14119 suffer temporary delivery failures are of course retried in the usual way.)
14120
14121 After a permanent delivery failure, bounce messages are frozen,
14122 because there is no sender to whom they can be returned. When a frozen bounce
14123 message has been on the queue for more than the given time, it is unfrozen at
14124 the next queue run, and a further delivery is attempted. If delivery fails
14125 again, the bounce message is discarded. This makes it possible to keep failed
14126 bounce messages around for a shorter time than the normal maximum retry time
14127 for frozen messages. For example,
14128 .code
14129 ignore_bounce_errors_after = 12h
14130 .endd
14131 retries failed bounce message deliveries after 12 hours, discarding any further
14132 failures. If the value of this option is set to a zero time period, bounce
14133 failures are discarded immediately. Setting a very long time (as in the default
14134 value) has the effect of disabling this option. For ways of automatically
14135 dealing with other kinds of frozen message, see &%auto_thaw%& and
14136 &%timeout_frozen_after%&.
14137
14138
14139 .option ignore_fromline_hosts main "host list&!!" unset
14140 .cindex "&""From""& line"
14141 .cindex "UUCP" "&""From""& line"
14142 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14143 the headers of a message. By default this is treated as the start of the
14144 message's body, which means that any following headers are not recognized as
14145 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14146 match those hosts that insist on sending it. If the sender is actually a local
14147 process rather than a remote host, and is using &%-bs%& to inject the messages,
14148 &%ignore_fromline_local%& must be set to achieve this effect.
14149
14150
14151 .option ignore_fromline_local main boolean false
14152 See &%ignore_fromline_hosts%& above.
14153
14154
14155 .option keep_malformed main time 4d
14156 This option specifies the length of time to keep messages whose spool files
14157 have been corrupted in some way. This should, of course, never happen. At the
14158 next attempt to deliver such a message, it gets removed. The incident is
14159 logged.
14160
14161
14162 .option ldap_ca_cert_dir main string unset
14163 .cindex "LDAP", "TLS CA certificate directory"
14164 This option indicates which directory contains CA certificates for verifying
14165 a TLS certificate presented by an LDAP server.
14166 While Exim does not provide a default value, your SSL library may.
14167 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14168 and constrained to be a directory.
14169
14170
14171 .option ldap_ca_cert_file main string unset
14172 .cindex "LDAP", "TLS CA certificate file"
14173 This option indicates which file contains CA certificates for verifying
14174 a TLS certificate presented by an LDAP server.
14175 While Exim does not provide a default value, your SSL library may.
14176 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14177 and constrained to be a file.
14178
14179
14180 .option ldap_cert_file main string unset
14181 .cindex "LDAP" "TLS client certificate file"
14182 This option indicates which file contains an TLS client certificate which
14183 Exim should present to the LDAP server during TLS negotiation.
14184 Should be used together with &%ldap_cert_key%&.
14185
14186
14187 .option ldap_cert_key main string unset
14188 .cindex "LDAP" "TLS client key file"
14189 This option indicates which file contains the secret/private key to use
14190 to prove identity to the LDAP server during TLS negotiation.
14191 Should be used together with &%ldap_cert_file%&, which contains the
14192 identity to be proven.
14193
14194
14195 .option ldap_cipher_suite main string unset
14196 .cindex "LDAP" "TLS cipher suite"
14197 This controls the TLS cipher-suite negotiation during TLS negotiation with
14198 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14199 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14200
14201
14202 .option ldap_default_servers main "string list" unset
14203 .cindex "LDAP" "default servers"
14204 This option provides a list of LDAP servers which are tried in turn when an
14205 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14206 details of LDAP queries. This option is available only when Exim has been built
14207 with LDAP support.
14208
14209
14210 .option ldap_require_cert main string unset.
14211 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14212 This should be one of the values "hard", "demand", "allow", "try" or "never".
14213 A value other than one of these is interpreted as "never".
14214 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14215 Although Exim does not set a default, the LDAP library probably defaults
14216 to hard/demand.
14217
14218
14219 .option ldap_start_tls main boolean false
14220 .cindex "LDAP" "whether or not to negotiate TLS"
14221 If set, Exim will attempt to negotiate TLS with the LDAP server when
14222 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14223 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14224 of SSL-on-connect.
14225 In the event of failure to negotiate TLS, the action taken is controlled
14226 by &%ldap_require_cert%&.
14227
14228
14229 .option ldap_version main integer unset
14230 .cindex "LDAP" "protocol version, forcing"
14231 This option can be used to force Exim to set a specific protocol version for
14232 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14233 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14234 the LDAP headers; otherwise it is 2. This option is available only when Exim
14235 has been built with LDAP support.
14236
14237
14238
14239 .option local_from_check main boolean true
14240 .cindex "&'Sender:'& header line" "disabling addition of"
14241 .cindex "&'From:'& header line" "disabling checking of"
14242 When a message is submitted locally (that is, not over a TCP/IP connection) by
14243 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14244 checks that the &'From:'& header line matches the login of the calling user and
14245 the domain specified by &%qualify_domain%&.
14246
14247 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14248 locally submitted message is automatically qualified by Exim, unless the
14249 &%-bnq%& command line option is used.
14250
14251 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14252 on the local part. If the &'From:'& header line does not match, Exim adds a
14253 &'Sender:'& header with an address constructed from the calling user's login
14254 and the default qualify domain.
14255
14256 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14257 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14258 &'Sender:'& header lines supplied by untrusted users, you must also set
14259 &%local_sender_retain%& to be true.
14260
14261 .cindex "envelope sender"
14262 These options affect only the header lines in the message. The envelope sender
14263 is still forced to be the login id at the qualify domain unless
14264 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14265
14266 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14267 request similar header line checking. See section &<<SECTthesenhea>>&, which
14268 has more details about &'Sender:'& processing.
14269
14270
14271
14272
14273 .option local_from_prefix main string unset
14274 When Exim checks the &'From:'& header line of locally submitted messages for
14275 matching the login id (see &%local_from_check%& above), it can be configured to
14276 ignore certain prefixes and suffixes in the local part of the address. This is
14277 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14278 appropriate lists, in the same form as the &%local_part_prefix%& and
14279 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14280 example, if
14281 .code
14282 local_from_prefix = *-
14283 .endd
14284 is set, a &'From:'& line containing
14285 .code
14286 From: anything-user@your.domain.example
14287 .endd
14288 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14289 matches the actual sender address that is constructed from the login name and
14290 qualify domain.
14291
14292
14293 .option local_from_suffix main string unset
14294 See &%local_from_prefix%& above.
14295
14296
14297 .option local_interfaces main "string list" "see below"
14298 This option controls which network interfaces are used by the daemon for
14299 listening; they are also used to identify the local host when routing. Chapter
14300 &<<CHAPinterfaces>>& contains a full description of this option and the related
14301 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14302 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14303 &%local_interfaces%& is
14304 .code
14305 local_interfaces = 0.0.0.0
14306 .endd
14307 when Exim is built without IPv6 support; otherwise it is
14308 .code
14309 local_interfaces = <; ::0 ; 0.0.0.0
14310 .endd
14311
14312 .option local_scan_timeout main time 5m
14313 .cindex "timeout" "for &[local_scan()]& function"
14314 .cindex "&[local_scan()]& function" "timeout"
14315 This timeout applies to the &[local_scan()]& function (see chapter
14316 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14317 the incoming message is rejected with a temporary error if it is an SMTP
14318 message. For a non-SMTP message, the message is dropped and Exim ends with a
14319 non-zero code. The incident is logged on the main and reject logs.
14320
14321
14322
14323 .option local_sender_retain main boolean false
14324 .cindex "&'Sender:'& header line" "retaining from local submission"
14325 When a message is submitted locally (that is, not over a TCP/IP connection) by
14326 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14327 do not want this to happen, you must set &%local_sender_retain%&, and you must
14328 also set &%local_from_check%& to be false (Exim will complain if you do not).
14329 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14330 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14331
14332
14333
14334
14335 .option localhost_number main string&!! unset
14336 .cindex "host" "locally unique number for"
14337 .cindex "message ids" "with multiple hosts"
14338 .vindex "&$localhost_number$&"
14339 Exim's message ids are normally unique only within the local host. If
14340 uniqueness among a set of hosts is required, each host must set a different
14341 value for the &%localhost_number%& option. The string is expanded immediately
14342 after reading the configuration file (so that a number can be computed from the
14343 host name, for example) and the result of the expansion must be a number in the
14344 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14345 systems). This is available in subsequent string expansions via the variable
14346 &$localhost_number$&. When &%localhost_number is set%&, the final two
14347 characters of the message id, instead of just being a fractional part of the
14348 time, are computed from the time and the local host number as described in
14349 section &<<SECTmessiden>>&.
14350
14351
14352
14353 .option log_file_path main "string list&!!" "set at compile time"
14354 .cindex "log" "file path for"
14355 This option sets the path which is used to determine the names of Exim's log
14356 files, or indicates that logging is to be to syslog, or both. It is expanded
14357 when Exim is entered, so it can, for example, contain a reference to the host
14358 name. If no specific path is set for the log files at compile or run time, they
14359 are written in a sub-directory called &_log_& in Exim's spool directory.
14360 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14361 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14362 used. If this string is fixed at your installation (contains no expansion
14363 variables) it is recommended that you do not set this option in the
14364 configuration file, but instead supply the path using LOG_FILE_PATH in
14365 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14366 early on &-- in particular, failure to read the configuration file.
14367
14368
14369 .option log_selector main string unset
14370 .cindex "log" "selectors"
14371 This option can be used to reduce or increase the number of things that Exim
14372 writes to its log files. Its argument is made up of names preceded by plus or
14373 minus characters. For example:
14374 .code
14375 log_selector = +arguments -retry_defer
14376 .endd
14377 A list of possible names and what they control is given in the chapter on
14378 logging, in section &<<SECTlogselector>>&.
14379
14380
14381 .option log_timezone main boolean false
14382 .cindex "log" "timezone for entries"
14383 .vindex "&$tod_log$&"
14384 .vindex "&$tod_zone$&"
14385 By default, the timestamps on log lines are in local time without the
14386 timezone. This means that if your timezone changes twice a year, the timestamps
14387 in log lines are ambiguous for an hour when the clocks go back. One way of
14388 avoiding this problem is to set the timezone to UTC. An alternative is to set
14389 &%log_timezone%& true. This turns on the addition of the timezone offset to
14390 timestamps in log lines. Turning on this option can add quite a lot to the size
14391 of log files because each line is extended by 6 characters. Note that the
14392 &$tod_log$& variable contains the log timestamp without the zone, but there is
14393 another variable called &$tod_zone$& that contains just the timezone offset.
14394
14395
14396 .option lookup_open_max main integer 25
14397 .cindex "too many open files"
14398 .cindex "open files, too many"
14399 .cindex "file" "too many open"
14400 .cindex "lookup" "maximum open files"
14401 .cindex "limit" "open files for lookups"
14402 This option limits the number of simultaneously open files for single-key
14403 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14404 Exim normally keeps these files open during routing, because often the same
14405 file is required several times. If the limit is reached, Exim closes the least
14406 recently used file. Note that if you are using the &'ndbm'& library, it
14407 actually opens two files for each logical DBM database, though it still counts
14408 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14409 open files"& errors with NDBM, you need to reduce the value of
14410 &%lookup_open_max%&.
14411
14412
14413 .option max_username_length main integer 0
14414 .cindex "length of login name"
14415 .cindex "user name" "maximum length"
14416 .cindex "limit" "user name length"
14417 Some operating systems are broken in that they truncate long arguments to
14418 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14419 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14420 an argument that is longer behaves as if &[getpwnam()]& failed.
14421
14422
14423 .option message_body_newlines main bool false
14424 .cindex "message body" "newlines in variables"
14425 .cindex "newline" "in message body variables"
14426 .vindex "&$message_body$&"
14427 .vindex "&$message_body_end$&"
14428 By default, newlines in the message body are replaced by spaces when setting
14429 the &$message_body$& and &$message_body_end$& expansion variables. If this
14430 option is set true, this no longer happens.
14431
14432
14433 .option message_body_visible main integer 500
14434 .cindex "body of message" "visible size"
14435 .cindex "message body" "visible size"
14436 .vindex "&$message_body$&"
14437 .vindex "&$message_body_end$&"
14438 This option specifies how much of a message's body is to be included in the
14439 &$message_body$& and &$message_body_end$& expansion variables.
14440
14441
14442 .option message_id_header_domain main string&!! unset
14443 .cindex "&'Message-ID:'& header line"
14444 If this option is set, the string is expanded and used as the right hand side
14445 (domain) of the &'Message-ID:'& header that Exim creates if a
14446 locally-originated incoming message does not have one. &"Locally-originated"&
14447 means &"not received over TCP/IP."&
14448 Otherwise, the primary host name is used.
14449 Only letters, digits, dot and hyphen are accepted; any other characters are
14450 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14451 empty string, the option is ignored.
14452
14453
14454 .option message_id_header_text main string&!! unset
14455 If this variable is set, the string is expanded and used to augment the text of
14456 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14457 message does not have one. The text of this header is required by RFC 2822 to
14458 take the form of an address. By default, Exim uses its internal message id as
14459 the local part, and the primary host name as the domain. If this option is set,
14460 it is expanded, and provided the expansion is not forced to fail, and does not
14461 yield an empty string, the result is inserted into the header immediately
14462 before the @, separated from the internal message id by a dot. Any characters
14463 that are illegal in an address are automatically converted into hyphens. This
14464 means that variables such as &$tod_log$& can be used, because the spaces and
14465 colons will become hyphens.
14466
14467
14468 .option message_logs main boolean true
14469 .cindex "message logs" "disabling"
14470 .cindex "log" "message log; disabling"
14471 If this option is turned off, per-message log files are not created in the
14472 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14473 Exim, by reducing the number of files involved in handling a message from a
14474 minimum of four (header spool file, body spool file, delivery journal, and
14475 per-message log) to three. The other major I/O activity is Exim's main log,
14476 which is not affected by this option.
14477
14478
14479 .option message_size_limit main string&!! 50M
14480 .cindex "message" "size limit"
14481 .cindex "limit" "message size"
14482 .cindex "size" "of message, limit"
14483 This option limits the maximum size of message that Exim will process. The
14484 value is expanded for each incoming connection so, for example, it can be made
14485 to depend on the IP address of the remote host for messages arriving via
14486 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14487 optionally followed by K or M.
14488
14489 &*Note*&: This limit cannot be made to depend on a message's sender or any
14490 other properties of an individual message, because it has to be advertised in
14491 the server's response to EHLO. String expansion failure causes a temporary
14492 error. A value of zero means no limit, but its use is not recommended. See also
14493 &%bounce_return_size_limit%&.
14494
14495 Incoming SMTP messages are failed with a 552 error if the limit is
14496 exceeded; locally-generated messages either get a stderr message or a delivery
14497 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14498 an oversized message is logged in both the main and the reject logs. See also
14499 the generic transport option &%message_size_limit%&, which limits the size of
14500 message that an individual transport can process.
14501
14502 If you use a virus-scanner and set this option to to a value larger than the
14503 maximum size that your virus-scanner is configured to support, you may get
14504 failures triggered by large mails.  The right size to configure for the
14505 virus-scanner depends upon what data is passed and the options in use but it's
14506 probably safest to just set it to a little larger than this value.  Eg, with a
14507 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14508 some problems may result.
14509
14510 A value of 0 will disable size limit checking; Exim will still advertise the
14511 SIZE extension in an EHLO response, but without a limit, so as to permit
14512 SMTP clients to still indicate the message size along with the MAIL verb.
14513
14514
14515 .option move_frozen_messages main boolean false
14516 .cindex "frozen messages" "moving"
14517 This option, which is available only if Exim has been built with the setting
14518 .code
14519 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14520 .endd
14521 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14522 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14523 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14524 standard utilities for handling such moved messages, and they do not show up in
14525 lists generated by &%-bp%& or by the Exim monitor.
14526
14527
14528 .option mua_wrapper main boolean false
14529 Setting this option true causes Exim to run in a very restrictive mode in which
14530 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14531 contains a full description of this facility.
14532
14533
14534
14535 .option mysql_servers main "string list" unset
14536 .cindex "MySQL" "server list"
14537 This option provides a list of MySQL servers and associated connection data, to
14538 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14539 option is available only if Exim has been built with MySQL support.
14540
14541
14542 .option never_users main "string list&!!" unset
14543 This option is expanded just once, at the start of Exim's processing. Local
14544 message deliveries are normally run in processes that are setuid to the
14545 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14546 It is usually desirable to prevent any deliveries from running as root, as a
14547 safety precaution.
14548
14549 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14550 list of users that must not be used for local deliveries. This list is fixed in
14551 the binary and cannot be overridden by the configuration file. By default, it
14552 contains just the single user name &"root"&. The &%never_users%& runtime option
14553 can be used to add more users to the fixed list.
14554
14555 If a message is to be delivered as one of the users on the fixed list or the
14556 &%never_users%& list, an error occurs, and delivery is deferred. A common
14557 example is
14558 .code
14559 never_users = root:daemon:bin
14560 .endd
14561 Including root is redundant if it is also on the fixed list, but it does no
14562 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14563 transport driver.
14564
14565
14566 .option openssl_options main "string list" "+no_sslv2"
14567 .cindex "OpenSSL "compatibility options"
14568 This option allows an administrator to adjust the SSL options applied
14569 by OpenSSL to connections.  It is given as a space-separated list of items,
14570 each one to be +added or -subtracted from the current value.
14571
14572 This option is only available if Exim is built against OpenSSL.  The values
14573 available for this option vary according to the age of your OpenSSL install.
14574 The &"all"& value controls a subset of flags which are available, typically
14575 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14576 list the values known on your system and Exim should support all the
14577 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14578 names lose the leading &"SSL_OP_"& and are lower-cased.
14579
14580 Note that adjusting the options can have severe impact upon the security of
14581 SSL as used by Exim.  It is possible to disable safety checks and shoot
14582 yourself in the foot in various unpleasant ways.  This option should not be
14583 adjusted lightly.  An unrecognised item will be detected at startup, by
14584 invoking Exim with the &%-bV%& flag.
14585
14586 Historical note: prior to release 4.80, Exim defaulted this value to
14587 "+dont_insert_empty_fragments", which may still be needed for compatibility
14588 with some clients, but which lowers security by increasing exposure to
14589 some now infamous attacks.
14590
14591 An example:
14592 .code
14593 # Make both old MS and old Eudora happy:
14594 openssl_options = -all +microsoft_big_sslv3_buffer \
14595                        +dont_insert_empty_fragments
14596 .endd
14597
14598 Possible options may include:
14599 .ilist
14600 &`all`&
14601 .next
14602 &`allow_unsafe_legacy_renegotiation`&
14603 .next
14604 &`cipher_server_preference`&
14605 .next
14606 &`dont_insert_empty_fragments`&
14607 .next
14608 &`ephemeral_rsa`&
14609 .next
14610 &`legacy_server_connect`&
14611 .next
14612 &`microsoft_big_sslv3_buffer`&
14613 .next
14614 &`microsoft_sess_id_bug`&
14615 .next
14616 &`msie_sslv2_rsa_padding`&
14617 .next
14618 &`netscape_challenge_bug`&
14619 .next
14620 &`netscape_reuse_cipher_change_bug`&
14621 .next
14622 &`no_compression`&
14623 .next
14624 &`no_session_resumption_on_renegotiation`&
14625 .next
14626 &`no_sslv2`&
14627 .next
14628 &`no_sslv3`&
14629 .next
14630 &`no_ticket`&
14631 .next
14632 &`no_tlsv1`&
14633 .next
14634 &`no_tlsv1_1`&
14635 .next
14636 &`no_tlsv1_2`&
14637 .next
14638 &`single_dh_use`&
14639 .next
14640 &`single_ecdh_use`&
14641 .next
14642 &`ssleay_080_client_dh_bug`&
14643 .next
14644 &`sslref2_reuse_cert_type_bug`&
14645 .next
14646 &`tls_block_padding_bug`&
14647 .next
14648 &`tls_d5_bug`&
14649 .next
14650 &`tls_rollback_bug`&
14651 .endlist
14652
14653
14654 .option oracle_servers main "string list" unset
14655 .cindex "Oracle" "server list"
14656 This option provides a list of Oracle servers and associated connection data,
14657 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14658 The option is available only if Exim has been built with Oracle support.
14659
14660
14661 .option percent_hack_domains main "domain list&!!" unset
14662 .cindex "&""percent hack""&"
14663 .cindex "source routing" "in email address"
14664 .cindex "address" "source-routed"
14665 The &"percent hack"& is the convention whereby a local part containing a
14666 percent sign is re-interpreted as a new email address, with the percent
14667 replaced by @. This is sometimes called &"source routing"&, though that term is
14668 also applied to RFC 2822 addresses that begin with an @ character. If this
14669 option is set, Exim implements the percent facility for those domains listed,
14670 but no others. This happens before an incoming SMTP address is tested against
14671 an ACL.
14672
14673 &*Warning*&: The &"percent hack"& has often been abused by people who are
14674 trying to get round relaying restrictions. For this reason, it is best avoided
14675 if at all possible. Unfortunately, a number of less security-conscious MTAs
14676 implement it unconditionally. If you are running Exim on a gateway host, and
14677 routing mail through to internal MTAs without processing the local parts, it is
14678 a good idea to reject recipient addresses with percent characters in their
14679 local parts. Exim's default configuration does this.
14680
14681
14682 .option perl_at_start main boolean false
14683 This option is available only when Exim is built with an embedded Perl
14684 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14685
14686
14687 .option perl_startup main string unset
14688 This option is available only when Exim is built with an embedded Perl
14689 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14690
14691
14692 .option pgsql_servers main "string list" unset
14693 .cindex "PostgreSQL lookup type" "server list"
14694 This option provides a list of PostgreSQL servers and associated connection
14695 data, to be used in conjunction with &(pgsql)& lookups (see section
14696 &<<SECID72>>&). The option is available only if Exim has been built with
14697 PostgreSQL support.
14698
14699
14700 .option pid_file_path main string&!! "set at compile time"
14701 .cindex "daemon" "pid file path"
14702 .cindex "pid file, path for"
14703 This option sets the name of the file to which the Exim daemon writes its
14704 process id. The string is expanded, so it can contain, for example, references
14705 to the host name:
14706 .code
14707 pid_file_path = /var/log/$primary_hostname/exim.pid
14708 .endd
14709 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14710 spool directory.
14711 The value set by the option can be overridden by the &%-oP%& command line
14712 option. A pid file is not written if a &"non-standard"& daemon is run by means
14713 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14714
14715
14716 .option pipelining_advertise_hosts main "host list&!!" *
14717 .cindex "PIPELINING" "suppressing advertising"
14718 This option can be used to suppress the advertisement of the SMTP
14719 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14720 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14721 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14722 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14723 that clients will use it; &"out of order"& commands that are &"expected"& do
14724 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14725
14726
14727 .option preserve_message_logs main boolean false
14728 .cindex "message logs" "preserving"
14729 If this option is set, message log files are not deleted when messages are
14730 completed. Instead, they are moved to a sub-directory of the spool directory
14731 called &_msglog.OLD_&, where they remain available for statistical or debugging
14732 purposes. This is a dangerous option to set on systems with any appreciable
14733 volume of mail. Use with care!
14734
14735
14736 .option primary_hostname main string "see below"
14737 .cindex "name" "of local host"
14738 .cindex "host" "name of local"
14739 .cindex "local host" "name of"
14740 .vindex "&$primary_hostname$&"
14741 This specifies the name of the current host. It is used in the default EHLO or
14742 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14743 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14744 The value is also used by default in some SMTP response messages from an Exim
14745 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14746
14747 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14748 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14749 contains only one component, Exim passes it to &[gethostbyname()]& (or
14750 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14751 version. The variable &$primary_hostname$& contains the host name, whether set
14752 explicitly by this option, or defaulted.
14753
14754
14755 .option print_topbitchars main boolean false
14756 .cindex "printing characters"
14757 .cindex "8-bit characters"
14758 By default, Exim considers only those characters whose codes lie in the range
14759 32&--126 to be printing characters. In a number of circumstances (for example,
14760 when writing log entries) non-printing characters are converted into escape
14761 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14762 is set, code values of 128 and above are also considered to be printing
14763 characters.
14764
14765 This option also affects the header syntax checks performed by the
14766 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14767 the user's full name when constructing From: and Sender: addresses (as
14768 described in section &<<SECTconstr>>&). Setting this option can cause
14769 Exim to generate eight bit message headers that do not conform to the
14770 standards.
14771
14772
14773 .option process_log_path main string unset
14774 .cindex "process log path"
14775 .cindex "log" "process log"
14776 .cindex "&'exiwhat'&"
14777 This option sets the name of the file to which an Exim process writes its
14778 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14779 utility script. If this option is unset, the file called &_exim-process.info_&
14780 in Exim's spool directory is used. The ability to specify the name explicitly
14781 can be useful in environments where two different Exims are running, using
14782 different spool directories.
14783
14784
14785 .option prod_requires_admin main boolean true
14786 .oindex "&%-M%&"
14787 .oindex "&%-R%&"
14788 .oindex "&%-q%&"
14789 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14790 admin user unless &%prod_requires_admin%& is set false. See also
14791 &%queue_list_requires_admin%&.
14792
14793
14794 .option qualify_domain main string "see below"
14795 .cindex "domain" "for qualifying addresses"
14796 .cindex "address" "qualification"
14797 This option specifies the domain name that is added to any envelope sender
14798 addresses that do not have a domain qualification. It also applies to
14799 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14800 are accepted by default only for locally-generated messages. Qualification is
14801 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14802 locally-generated messages, unless the &%-bnq%& command line option is used.
14803
14804 Messages from external sources must always contain fully qualified addresses,
14805 unless the sending host matches &%sender_unqualified_hosts%& or
14806 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14807 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14808 necessary. Internally, Exim always works with fully qualified envelope
14809 addresses. If &%qualify_domain%& is not set, it defaults to the
14810 &%primary_hostname%& value.
14811
14812
14813 .option qualify_recipient main string "see below"
14814 This option allows you to specify a different domain for qualifying recipient
14815 addresses to the one that is used for senders. See &%qualify_domain%& above.
14816
14817
14818
14819 .option queue_domains main "domain list&!!" unset
14820 .cindex "domain" "specifying non-immediate delivery"
14821 .cindex "queueing incoming messages"
14822 .cindex "message" "queueing certain domains"
14823 This option lists domains for which immediate delivery is not required.
14824 A delivery process is started whenever a message is received, but only those
14825 domains that do not match are processed. All other deliveries wait until the
14826 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14827
14828
14829 .option queue_list_requires_admin main boolean true
14830 .oindex "&%-bp%&"
14831 The &%-bp%& command-line option, which lists the messages that are on the
14832 queue, requires the caller to be an admin user unless
14833 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14834
14835
14836 .option queue_only main boolean false
14837 .cindex "queueing incoming messages"
14838 .cindex "message" "queueing unconditionally"
14839 If &%queue_only%& is set, a delivery process is not automatically started
14840 whenever a message is received. Instead, the message waits on the queue for the
14841 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14842 delivered immediately when certain conditions (such as heavy load) occur.
14843
14844 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14845 and &%-odi%& command line options override &%queue_only%& unless
14846 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14847 &%queue_only_load%&, and &%smtp_accept_queue%&.
14848
14849
14850 .option queue_only_file main string unset
14851 .cindex "queueing incoming messages"
14852 .cindex "message" "queueing by file existence"
14853 This option can be set to a colon-separated list of absolute path names, each
14854 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14855 it tests for the existence of each listed path using a call to &[stat()]&. For
14856 each path that exists, the corresponding queueing option is set.
14857 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14858 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14859 .code
14860 queue_only_file = smtp/some/file
14861 .endd
14862 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14863 &_/some/file_& exists.
14864
14865
14866 .option queue_only_load main fixed-point unset
14867 .cindex "load average"
14868 .cindex "queueing incoming messages"
14869 .cindex "message" "queueing by load"
14870 If the system load average is higher than this value, incoming messages from
14871 all sources are queued, and no automatic deliveries are started. If this
14872 happens during local or remote SMTP input, all subsequent messages received on
14873 the same SMTP connection are queued by default, whatever happens to the load in
14874 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14875 false.
14876
14877 Deliveries will subsequently be performed by queue runner processes. This
14878 option has no effect on ancient operating systems on which Exim cannot
14879 determine the load average. See also &%deliver_queue_load_max%& and
14880 &%smtp_load_reserve%&.
14881
14882
14883 .option queue_only_load_latch main boolean true
14884 .cindex "load average" "re-evaluating per message"
14885 When this option is true (the default), once one message has been queued
14886 because the load average is higher than the value set by &%queue_only_load%&,
14887 all subsequent messages received on the same SMTP connection are also queued.
14888 This is a deliberate choice; even though the load average may fall below the
14889 threshold, it doesn't seem right to deliver later messages on the same
14890 connection when not delivering earlier ones. However, there are special
14891 circumstances such as very long-lived connections from scanning appliances
14892 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14893 should be set false. This causes the value of the load average to be
14894 re-evaluated for each message.
14895
14896
14897 .option queue_only_override main boolean true
14898 .cindex "queueing incoming messages"
14899 When this option is true, the &%-od%&&'x'& command line options override the
14900 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14901 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14902 to override; they are accepted, but ignored.
14903
14904
14905 .option queue_run_in_order main boolean false
14906 .cindex "queue runner" "processing messages in order"
14907 If this option is set, queue runs happen in order of message arrival instead of
14908 in an arbitrary order. For this to happen, a complete list of the entire queue
14909 must be set up before the deliveries start. When the queue is all held in a
14910 single directory (the default), a single list is created for both the ordered
14911 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14912 single list is not created when &%queue_run_in_order%& is false. In this case,
14913 the sub-directories are processed one at a time (in a random order), and this
14914 avoids setting up one huge list for the whole queue. Thus, setting
14915 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14916 when the queue is large, because of the extra work in setting up the single,
14917 large list. In most situations, &%queue_run_in_order%& should not be set.
14918
14919
14920
14921 .option queue_run_max main integer 5
14922 .cindex "queue runner" "maximum number of"
14923 This controls the maximum number of queue runner processes that an Exim daemon
14924 can run simultaneously. This does not mean that it starts them all at once,
14925 but rather that if the maximum number are still running when the time comes to
14926 start another one, it refrains from starting another one. This can happen with
14927 very large queues and/or very sluggish deliveries. This option does not,
14928 however, interlock with other processes, so additional queue runners can be
14929 started by other means, or by killing and restarting the daemon.
14930
14931 Setting this option to zero does not suppress queue runs; rather, it disables
14932 the limit, allowing any number of simultaneous queue runner processes to be
14933 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14934 the daemon's command line.
14935
14936 .option queue_smtp_domains main "domain list&!!" unset
14937 .cindex "queueing incoming messages"
14938 .cindex "message" "queueing remote deliveries"
14939 When this option is set, a delivery process is started whenever a message is
14940 received, routing is performed, and local deliveries take place.
14941 However, if any SMTP deliveries are required for domains that match
14942 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14943 message waits on the queue for the next queue run. Since routing of the message
14944 has taken place, Exim knows to which remote hosts it must be delivered, and so
14945 when the queue run happens, multiple messages for the same host are delivered
14946 over a single SMTP connection. The &%-odqs%& command line option causes all
14947 SMTP deliveries to be queued in this way, and is equivalent to setting
14948 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14949 &%queue_domains%&.
14950
14951
14952 .option receive_timeout main time 0s
14953 .cindex "timeout" "for non-SMTP input"
14954 This option sets the timeout for accepting a non-SMTP message, that is, the
14955 maximum time that Exim waits when reading a message on the standard input. If
14956 the value is zero, it will wait for ever. This setting is overridden by the
14957 &%-or%& command line option. The timeout for incoming SMTP messages is
14958 controlled by &%smtp_receive_timeout%&.
14959
14960 .option received_header_text main string&!! "see below"
14961 .cindex "customizing" "&'Received:'& header"
14962 .cindex "&'Received:'& header line" "customizing"
14963 This string defines the contents of the &'Received:'& message header that is
14964 added to each message, except for the timestamp, which is automatically added
14965 on at the end (preceded by a semicolon). The string is expanded each time it is
14966 used. If the expansion yields an empty string, no &'Received:'& header line is
14967 added to the message. Otherwise, the string should start with the text
14968 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14969 header lines. The default setting is:
14970
14971 .code
14972 received_header_text = Received: \
14973   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14974   {${if def:sender_ident \
14975   {from ${quote_local_part:$sender_ident} }}\
14976   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14977   by $primary_hostname \
14978   ${if def:received_protocol {with $received_protocol}} \
14979   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
14980   (Exim $version_number)\n\t\
14981   ${if def:sender_address \
14982   {(envelope-from <$sender_address>)\n\t}}\
14983   id $message_exim_id\
14984   ${if def:received_for {\n\tfor $received_for}}
14985 .endd
14986
14987 The reference to the TLS cipher is omitted when Exim is built without TLS
14988 support. The use of conditional expansions ensures that this works for both
14989 locally generated messages and messages received from remote hosts, giving
14990 header lines such as the following:
14991 .code
14992 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14993 by marley.carol.example with esmtp (Exim 4.00)
14994 (envelope-from <bob@carol.example>)
14995 id 16IOWa-00019l-00
14996 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14997 Received: by scrooge.carol.example with local (Exim 4.00)
14998 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14999 .endd
15000 Until the body of the message has been received, the timestamp is the time when
15001 the message started to be received. Once the body has arrived, and all policy
15002 checks have taken place, the timestamp is updated to the time at which the
15003 message was accepted.
15004
15005
15006 .option received_headers_max main integer 30
15007 .cindex "loop" "prevention"
15008 .cindex "mail loop prevention"
15009 .cindex "&'Received:'& header line" "counting"
15010 When a message is to be delivered, the number of &'Received:'& headers is
15011 counted, and if it is greater than this parameter, a mail loop is assumed to
15012 have occurred, the delivery is abandoned, and an error message is generated.
15013 This applies to both local and remote deliveries.
15014
15015
15016 .option recipient_unqualified_hosts main "host list&!!" unset
15017 .cindex "unqualified addresses"
15018 .cindex "host" "unqualified addresses from"
15019 This option lists those hosts from which Exim is prepared to accept unqualified
15020 recipient addresses in message envelopes. The addresses are made fully
15021 qualified by the addition of the &%qualify_recipient%& value. This option also
15022 affects message header lines. Exim does not reject unqualified recipient
15023 addresses in headers, but it qualifies them only if the message came from a
15024 host that matches &%recipient_unqualified_hosts%&,
15025 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15026 option was not set.
15027
15028
15029 .option recipients_max main integer 0
15030 .cindex "limit" "number of recipients"
15031 .cindex "recipient" "maximum number"
15032 If this option is set greater than zero, it specifies the maximum number of
15033 original recipients for any message. Additional recipients that are generated
15034 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15035 all recipients over the limit; earlier recipients are delivered as normal.
15036 Non-SMTP messages with too many recipients are failed, and no deliveries are
15037 done.
15038
15039 .cindex "RCPT" "maximum number of incoming"
15040 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15041 RCPT commands in a single message.
15042
15043
15044 .option recipients_max_reject main boolean false
15045 If this option is set true, Exim rejects SMTP messages containing too many
15046 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15047 error to the eventual DATA command. Otherwise (the default) it gives a 452
15048 error to the surplus RCPT commands and accepts the message on behalf of the
15049 initial set of recipients. The remote server should then re-send the message
15050 for the remaining recipients at a later time.
15051
15052
15053 .option remote_max_parallel main integer 2
15054 .cindex "delivery" "parallelism for remote"
15055 This option controls parallel delivery of one message to a number of remote
15056 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15057 does all the remote deliveries for a message one by one. Otherwise, if a single
15058 message has to be delivered to more than one remote host, or if several copies
15059 have to be sent to the same remote host, up to &%remote_max_parallel%&
15060 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15061 deliveries are required, the maximum number of processes are started, and as
15062 each one finishes, another is begun. The order of starting processes is the
15063 same as if sequential delivery were being done, and can be controlled by the
15064 &%remote_sort_domains%& option. If parallel delivery takes place while running
15065 with debugging turned on, the debugging output from each delivery process is
15066 tagged with its process id.
15067
15068 This option controls only the maximum number of parallel deliveries for one
15069 message in one Exim delivery process. Because Exim has no central queue
15070 manager, there is no way of controlling the total number of simultaneous
15071 deliveries if the configuration allows a delivery attempt as soon as a message
15072 is received.
15073
15074 .cindex "number of deliveries"
15075 .cindex "delivery" "maximum number of"
15076 If you want to control the total number of deliveries on the system, you
15077 need to set the &%queue_only%& option. This ensures that all incoming messages
15078 are added to the queue without starting a delivery process. Then set up an Exim
15079 daemon to start queue runner processes at appropriate intervals (probably
15080 fairly often, for example, every minute), and limit the total number of queue
15081 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15082 delivers only one message at a time, the maximum number of deliveries that can
15083 then take place at once is &%queue_run_max%& multiplied by
15084 &%remote_max_parallel%&.
15085
15086 If it is purely remote deliveries you want to control, use
15087 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15088 doing the SMTP routing before queueing, so that several messages for the same
15089 host will eventually get delivered down the same connection.
15090
15091
15092 .option remote_sort_domains main "domain list&!!" unset
15093 .cindex "sorting remote deliveries"
15094 .cindex "delivery" "sorting remote"
15095 When there are a number of remote deliveries for a message, they are sorted by
15096 domain into the order given by this list. For example,
15097 .code
15098 remote_sort_domains = *.cam.ac.uk:*.uk
15099 .endd
15100 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15101 then to those in the &%uk%& domain, then to any others.
15102
15103
15104 .option retry_data_expire main time 7d
15105 .cindex "hints database" "data expiry"
15106 This option sets a &"use before"& time on retry information in Exim's hints
15107 database. Any older retry data is ignored. This means that, for example, once a
15108 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15109 past failures.
15110
15111
15112 .option retry_interval_max main time 24h
15113 .cindex "retry" "limit on interval"
15114 .cindex "limit" "on retry interval"
15115 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15116 intervals between delivery attempts for messages that cannot be delivered
15117 straight away. This option sets an overall limit to the length of time between
15118 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15119 the default value.
15120
15121
15122 .option return_path_remove main boolean true
15123 .cindex "&'Return-path:'& header line" "removing"
15124 RFC 2821, section 4.4, states that an SMTP server must insert a
15125 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15126 The &'Return-path:'& header preserves the sender address as received in the
15127 MAIL command. This description implies that this header should not be present
15128 in an incoming message. If &%return_path_remove%& is true, any existing
15129 &'Return-path:'& headers are removed from messages at the time they are
15130 received. Exim's transports have options for adding &'Return-path:'& headers at
15131 the time of delivery. They are normally used only for final local deliveries.
15132
15133
15134 .option return_size_limit main integer 100K
15135 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15136
15137
15138 .option rfc1413_hosts main "host list&!!" *
15139 .cindex "RFC 1413"
15140 .cindex "host" "for RFC 1413 calls"
15141 RFC 1413 identification calls are made to any client host which matches an item
15142 in the list.
15143
15144 .option rfc1413_query_timeout main time 5s
15145 .cindex "RFC 1413" "query timeout"
15146 .cindex "timeout" "for RFC 1413 call"
15147 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15148 no RFC 1413 calls are ever made.
15149
15150
15151 .option sender_unqualified_hosts main "host list&!!" unset
15152 .cindex "unqualified addresses"
15153 .cindex "host" "unqualified addresses from"
15154 This option lists those hosts from which Exim is prepared to accept unqualified
15155 sender addresses. The addresses are made fully qualified by the addition of
15156 &%qualify_domain%&. This option also affects message header lines. Exim does
15157 not reject unqualified addresses in headers that contain sender addresses, but
15158 it qualifies them only if the message came from a host that matches
15159 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15160 using TCP/IP), and the &%-bnq%& option was not set.
15161
15162
15163 .option smtp_accept_keepalive main boolean true
15164 .cindex "keepalive" "on incoming connection"
15165 This option controls the setting of the SO_KEEPALIVE option on incoming
15166 TCP/IP socket connections. When set, it causes the kernel to probe idle
15167 connections periodically, by sending packets with &"old"& sequence numbers. The
15168 other end of the connection should send an acknowledgment if the connection is
15169 still okay or a reset if the connection has been aborted. The reason for doing
15170 this is that it has the beneficial effect of freeing up certain types of
15171 connection that can get stuck when the remote host is disconnected without
15172 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15173 hours to detect unreachable hosts.
15174
15175
15176
15177 .option smtp_accept_max main integer 20
15178 .cindex "limit" "incoming SMTP connections"
15179 .cindex "SMTP" "incoming connection count"
15180 .cindex "inetd"
15181 This option specifies the maximum number of simultaneous incoming SMTP calls
15182 that Exim will accept. It applies only to the listening daemon; there is no
15183 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15184 value is set to zero, no limit is applied. However, it is required to be
15185 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15186 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15187
15188 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15189 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15190 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15191 and &%smtp_load_reserve%& are then checked before accepting the connection.
15192
15193
15194 .option smtp_accept_max_nonmail main integer 10
15195 .cindex "limit" "non-mail SMTP commands"
15196 .cindex "SMTP" "limiting non-mail commands"
15197 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15198 the connection if there are too many. This option defines &"too many"&. The
15199 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15200 client looping sending EHLO, for example. The check is applied only if the
15201 client host matches &%smtp_accept_max_nonmail_hosts%&.
15202
15203 When a new message is expected, one occurrence of RSET is not counted. This
15204 allows a client to send one RSET between messages (this is not necessary,
15205 but some clients do it). Exim also allows one uncounted occurrence of HELO
15206 or EHLO, and one occurrence of STARTTLS between messages. After
15207 starting up a TLS session, another EHLO is expected, and so it too is not
15208 counted. The first occurrence of AUTH in a connection, or immediately
15209 following STARTTLS is not counted. Otherwise, all commands other than
15210 MAIL, RCPT, DATA, and QUIT are counted.
15211
15212
15213 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15214 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15215 check by setting this option. The default value makes it apply to all hosts. By
15216 changing the value, you can exclude any badly-behaved hosts that you have to
15217 live with.
15218
15219
15220 . Allow this long option name to split; give it unsplit as a fifth argument
15221 . for the automatic .oindex that is generated by .option.
15222
15223 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15224          smtp_accept_max_per_connection
15225 .cindex "SMTP" "limiting incoming message count"
15226 .cindex "limit" "messages per SMTP connection"
15227 The value of this option limits the number of MAIL commands that Exim is
15228 prepared to accept over a single SMTP connection, whether or not each command
15229 results in the transfer of a message. After the limit is reached, a 421
15230 response is given to subsequent MAIL commands. This limit is a safety
15231 precaution against a client that goes mad (incidents of this type have been
15232 seen).
15233
15234
15235 .option smtp_accept_max_per_host main string&!! unset
15236 .cindex "limit" "SMTP connections from one host"
15237 .cindex "host" "limiting SMTP connections from"
15238 This option restricts the number of simultaneous IP connections from a single
15239 host (strictly, from a single IP address) to the Exim daemon. The option is
15240 expanded, to enable different limits to be applied to different hosts by
15241 reference to &$sender_host_address$&. Once the limit is reached, additional
15242 connection attempts from the same host are rejected with error code 421. This
15243 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15244 of zero imposes no limit. If this option is set greater than zero, it is
15245 required that &%smtp_accept_max%& be non-zero.
15246
15247 &*Warning*&: When setting this option you should not use any expansion
15248 constructions that take an appreciable amount of time. The expansion and test
15249 happen in the main daemon loop, in order to reject additional connections
15250 without forking additional processes (otherwise a denial-of-service attack
15251 could cause a vast number or processes to be created). While the daemon is
15252 doing this processing, it cannot accept any other incoming connections.
15253
15254
15255
15256 .option smtp_accept_queue main integer 0
15257 .cindex "SMTP" "incoming connection count"
15258 .cindex "queueing incoming messages"
15259 .cindex "message" "queueing by SMTP connection count"
15260 If the number of simultaneous incoming SMTP connections being handled via the
15261 listening daemon exceeds this value, messages received by SMTP are just placed
15262 on the queue; no delivery processes are started automatically. The count is
15263 fixed at the start of an SMTP connection. It cannot be updated in the
15264 subprocess that receives messages, and so the queueing or not queueing applies
15265 to all messages received in the same connection.
15266
15267 A value of zero implies no limit, and clearly any non-zero value is useful only
15268 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15269 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15270 various &%-od%&&'x'& command line options.
15271
15272
15273 . Allow this long option name to split; give it unsplit as a fifth argument
15274 . for the automatic .oindex that is generated by .option.
15275
15276 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15277          smtp_accept_queue_per_connection
15278 .cindex "queueing incoming messages"
15279 .cindex "message" "queueing by message count"
15280 This option limits the number of delivery processes that Exim starts
15281 automatically when receiving messages via SMTP, whether via the daemon or by
15282 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15283 and the number of messages received in a single SMTP session exceeds this
15284 number, subsequent messages are placed on the queue, but no delivery processes
15285 are started. This helps to limit the number of Exim processes when a server
15286 restarts after downtime and there is a lot of mail waiting for it on other
15287 systems. On large systems, the default should probably be increased, and on
15288 dial-in client systems it should probably be set to zero (that is, disabled).
15289
15290
15291 .option smtp_accept_reserve main integer 0
15292 .cindex "SMTP" "incoming call count"
15293 .cindex "host" "reserved"
15294 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15295 number of SMTP connections that are reserved for connections from the hosts
15296 that are specified in &%smtp_reserve_hosts%&. The value set in
15297 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15298 restricted to this number of connections; the option specifies a minimum number
15299 of connection slots for them, not a maximum. It is a guarantee that this group
15300 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15301 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15302 individual host.
15303
15304 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15305 set to 5, once there are 45 active connections (from any hosts), new
15306 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15307 provided the other criteria for acceptance are met.
15308
15309
15310 .option smtp_active_hostname main string&!! unset
15311 .cindex "host" "name in SMTP responses"
15312 .cindex "SMTP" "host name in responses"
15313 .vindex "&$primary_hostname$&"
15314 This option is provided for multi-homed servers that want to masquerade as
15315 several different hosts. At the start of an incoming SMTP connection, its value
15316 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15317 responses. For example, it is used as domain name in the response to an
15318 incoming HELO or EHLO command.
15319
15320 .vindex "&$smtp_active_hostname$&"
15321 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15322 is saved with any messages that are received. It is therefore available for use
15323 in routers and transports when the message is later delivered.
15324
15325 If this option is unset, or if its expansion is forced to fail, or if the
15326 expansion results in an empty string, the value of &$primary_hostname$& is
15327 used. Other expansion failures cause a message to be written to the main and
15328 panic logs, and the SMTP command receives a temporary error. Typically, the
15329 value of &%smtp_active_hostname%& depends on the incoming interface address.
15330 For example:
15331 .code
15332 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15333   {cox.mydomain}{box.mydomain}}
15334 .endd
15335
15336 Although &$smtp_active_hostname$& is primarily concerned with incoming
15337 messages, it is also used as the default for HELO commands in callout
15338 verification if there is no remote transport from which to obtain a
15339 &%helo_data%& value.
15340
15341 .option smtp_banner main string&!! "see below"
15342 .cindex "SMTP" "welcome banner"
15343 .cindex "banner for SMTP"
15344 .cindex "welcome banner for SMTP"
15345 .cindex "customizing" "SMTP banner"
15346 This string, which is expanded every time it is used, is output as the initial
15347 positive response to an SMTP connection. The default setting is:
15348 .code
15349 smtp_banner = $smtp_active_hostname ESMTP Exim \
15350   $version_number $tod_full
15351 .endd
15352 Failure to expand the string causes a panic error. If you want to create a
15353 multiline response to the initial SMTP connection, use &"\n"& in the string at
15354 appropriate points, but not at the end. Note that the 220 code is not included
15355 in this string. Exim adds it automatically (several times in the case of a
15356 multiline response).
15357
15358
15359 .option smtp_check_spool_space main boolean true
15360 .cindex "checking disk space"
15361 .cindex "disk space, checking"
15362 .cindex "spool directory" "checking space"
15363 When this option is set, if an incoming SMTP session encounters the SIZE
15364 option on a MAIL command, it checks that there is enough space in the
15365 spool directory's partition to accept a message of that size, while still
15366 leaving free the amount specified by &%check_spool_space%& (even if that value
15367 is zero). If there isn't enough space, a temporary error code is returned.
15368
15369
15370 .option smtp_connect_backlog main integer 20
15371 .cindex "connection backlog"
15372 .cindex "SMTP" "connection backlog"
15373 .cindex "backlog of connections"
15374 This option specifies a maximum number of waiting SMTP connections. Exim passes
15375 this value to the TCP/IP system when it sets up its listener. Once this number
15376 of connections are waiting for the daemon's attention, subsequent connection
15377 attempts are refused at the TCP/IP level. At least, that is what the manuals
15378 say; in some circumstances such connection attempts have been observed to time
15379 out instead. For large systems it is probably a good idea to increase the
15380 value (to 50, say). It also gives some protection against denial-of-service
15381 attacks by SYN flooding.
15382
15383
15384 .option smtp_enforce_sync main boolean true
15385 .cindex "SMTP" "synchronization checking"
15386 .cindex "synchronization checking in SMTP"
15387 The SMTP protocol specification requires the client to wait for a response from
15388 the server at certain points in the dialogue. Without PIPELINING these
15389 synchronization points are after every command; with PIPELINING they are
15390 fewer, but they still exist.
15391
15392 Some spamming sites send out a complete set of SMTP commands without waiting
15393 for any response. Exim protects against this by rejecting a message if the
15394 client has sent further input when it should not have. The error response &"554
15395 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15396 for this error cannot be perfect because of transmission delays (unexpected
15397 input may be on its way but not yet received when Exim checks). However, it
15398 does detect many instances.
15399
15400 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15401 If you want to disable the check selectively (for example, only for certain
15402 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15403 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15404
15405
15406
15407 .option smtp_etrn_command main string&!! unset
15408 .cindex "ETRN" "command to be run"
15409 .vindex "&$domain$&"
15410 If this option is set, the given command is run whenever an SMTP ETRN
15411 command is received from a host that is permitted to issue such commands (see
15412 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15413 are independently expanded. The expansion variable &$domain$& is set to the
15414 argument of the ETRN command, and no syntax checking is done on it. For
15415 example:
15416 .code
15417 smtp_etrn_command = /etc/etrn_command $domain \
15418                     $sender_host_address
15419 .endd
15420 A new process is created to run the command, but Exim does not wait for it to
15421 complete. Consequently, its status cannot be checked. If the command cannot be
15422 run, a line is written to the panic log, but the ETRN caller still receives
15423 a 250 success response. Exim is normally running under its own uid when
15424 receiving SMTP, so it is not possible for it to change the uid before running
15425 the command.
15426
15427
15428 .option smtp_etrn_serialize main boolean true
15429 .cindex "ETRN" "serializing"
15430 When this option is set, it prevents the simultaneous execution of more than
15431 one identical command as a result of ETRN in an SMTP connection. See
15432 section &<<SECTETRN>>& for details.
15433
15434
15435 .option smtp_load_reserve main fixed-point unset
15436 .cindex "load average"
15437 If the system load average ever gets higher than this, incoming SMTP calls are
15438 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15439 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15440 the load is over the limit. The option has no effect on ancient operating
15441 systems on which Exim cannot determine the load average. See also
15442 &%deliver_queue_load_max%& and &%queue_only_load%&.
15443
15444
15445
15446 .option smtp_max_synprot_errors main integer 3
15447 .cindex "SMTP" "limiting syntax and protocol errors"
15448 .cindex "limit" "SMTP syntax and protocol errors"
15449 Exim rejects SMTP commands that contain syntax or protocol errors. In
15450 particular, a syntactically invalid email address, as in this command:
15451 .code
15452 RCPT TO:<abc xyz@a.b.c>
15453 .endd
15454 causes immediate rejection of the command, before any other tests are done.
15455 (The ACL cannot be run if there is no valid address to set up for it.) An
15456 example of a protocol error is receiving RCPT before MAIL. If there are
15457 too many syntax or protocol errors in one SMTP session, the connection is
15458 dropped. The limit is set by this option.
15459
15460 .cindex "PIPELINING" "expected errors"
15461 When the PIPELINING extension to SMTP is in use, some protocol errors are
15462 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15463 Exim assumes that PIPELINING will be used if it advertises it (see
15464 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15465 not count towards the limit.
15466
15467
15468
15469 .option smtp_max_unknown_commands main integer 3
15470 .cindex "SMTP" "limiting unknown commands"
15471 .cindex "limit" "unknown SMTP commands"
15472 If there are too many unrecognized commands in an incoming SMTP session, an
15473 Exim server drops the connection. This is a defence against some kinds of abuse
15474 that subvert web
15475 clients
15476 into making connections to SMTP ports; in these circumstances, a number of
15477 non-SMTP command lines are sent first.
15478
15479
15480
15481 .option smtp_ratelimit_hosts main "host list&!!" unset
15482 .cindex "SMTP" "rate limiting"
15483 .cindex "limit" "rate of message arrival"
15484 .cindex "RCPT" "rate limiting"
15485 Some sites find it helpful to be able to limit the rate at which certain hosts
15486 can send them messages, and the rate at which an individual message can specify
15487 recipients.
15488
15489 Exim has two rate-limiting facilities. This section describes the older
15490 facility, which can limit rates within a single connection. The newer
15491 &%ratelimit%& ACL condition can limit rates across all connections. See section
15492 &<<SECTratelimiting>>& for details of the newer facility.
15493
15494 When a host matches &%smtp_ratelimit_hosts%&, the values of
15495 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15496 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15497 respectively. Each option, if set, must contain a set of four comma-separated
15498 values:
15499
15500 .ilist
15501 A threshold, before which there is no rate limiting.
15502 .next
15503 An initial time delay. Unlike other times in Exim, numbers with decimal
15504 fractional parts are allowed here.
15505 .next
15506 A factor by which to increase the delay each time.
15507 .next
15508 A maximum value for the delay. This should normally be less than 5 minutes,
15509 because after that time, the client is liable to timeout the SMTP command.
15510 .endlist
15511
15512 For example, these settings have been used successfully at the site which
15513 first suggested this feature, for controlling mail from their customers:
15514 .code
15515 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15516 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15517 .endd
15518 The first setting specifies delays that are applied to MAIL commands after
15519 two have been received over a single connection. The initial delay is 0.5
15520 seconds, increasing by a factor of 1.05 each time. The second setting applies
15521 delays to RCPT commands when more than four occur in a single message.
15522
15523
15524 .option smtp_ratelimit_mail main string unset
15525 See &%smtp_ratelimit_hosts%& above.
15526
15527
15528 .option smtp_ratelimit_rcpt main string unset
15529 See &%smtp_ratelimit_hosts%& above.
15530
15531
15532 .option smtp_receive_timeout main time 5m
15533 .cindex "timeout" "for SMTP input"
15534 .cindex "SMTP" "input timeout"
15535 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15536 input, including batch SMTP. If a line of input (either an SMTP command or a
15537 data line) is not received within this time, the SMTP connection is dropped and
15538 the message is abandoned.
15539 A line is written to the log containing one of the following messages:
15540 .code
15541 SMTP command timeout on connection from...
15542 SMTP data timeout on connection from...
15543 .endd
15544 The former means that Exim was expecting to read an SMTP command; the latter
15545 means that it was in the DATA phase, reading the contents of a message.
15546
15547
15548 .oindex "&%-os%&"
15549 The value set by this option can be overridden by the
15550 &%-os%& command-line option. A setting of zero time disables the timeout, but
15551 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15552 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15553 timeout is controlled by &%receive_timeout%& and &%-or%&.
15554
15555
15556 .option smtp_reserve_hosts main "host list&!!" unset
15557 This option defines hosts for which SMTP connections are reserved; see
15558 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15559
15560
15561 .option smtp_return_error_details main boolean false
15562 .cindex "SMTP" "details policy failures"
15563 .cindex "policy control" "rejection, returning details"
15564 In the default state, Exim uses bland messages such as
15565 &"Administrative prohibition"& when it rejects SMTP commands for policy
15566 reasons. Many sysadmins like this because it gives away little information
15567 to spammers. However, some other sysadmins who are applying strict checking
15568 policies want to give out much fuller information about failures. Setting
15569 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15570 example, instead of &"Administrative prohibition"&, it might give:
15571 .code
15572 550-Rejected after DATA: '>' missing at end of address:
15573 550 failing address in "From" header is: <user@dom.ain
15574 .endd
15575
15576 .option spamd_address main string "see below"
15577 This option is available when Exim is compiled with the content-scanning
15578 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15579 The default value is
15580 .code
15581 127.0.0.1 783
15582 .endd
15583 See section &<<SECTscanspamass>>& for more details.
15584
15585
15586
15587 .option split_spool_directory main boolean false
15588 .cindex "multiple spool directories"
15589 .cindex "spool directory" "split"
15590 .cindex "directories, multiple"
15591 If this option is set, it causes Exim to split its input directory into 62
15592 subdirectories, each with a single alphanumeric character as its name. The
15593 sixth character of the message id is used to allocate messages to
15594 subdirectories; this is the least significant base-62 digit of the time of
15595 arrival of the message.
15596
15597 Splitting up the spool in this way may provide better performance on systems
15598 where there are long mail queues, by reducing the number of files in any one
15599 directory. The msglog directory is also split up in a similar way to the input
15600 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15601 are still placed in the single directory &_msglog.OLD_&.
15602
15603 It is not necessary to take any special action for existing messages when
15604 changing &%split_spool_directory%&. Exim notices messages that are in the
15605 &"wrong"& place, and continues to process them. If the option is turned off
15606 after a period of being on, the subdirectories will eventually empty and be
15607 automatically deleted.
15608
15609 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15610 changes. Instead of creating a list of all messages in the queue, and then
15611 trying to deliver each one in turn, it constructs a list of those in one
15612 sub-directory and tries to deliver them, before moving on to the next
15613 sub-directory. The sub-directories are processed in a random order. This
15614 spreads out the scanning of the input directories, and uses less memory. It is
15615 particularly beneficial when there are lots of messages on the queue. However,
15616 if &%queue_run_in_order%& is set, none of this new processing happens. The
15617 entire queue has to be scanned and sorted before any deliveries can start.
15618
15619
15620 .option spool_directory main string&!! "set at compile time"
15621 .cindex "spool directory" "path to"
15622 This defines the directory in which Exim keeps its spool, that is, the messages
15623 it is waiting to deliver. The default value is taken from the compile-time
15624 configuration setting, if there is one. If not, this option must be set. The
15625 string is expanded, so it can contain, for example, a reference to
15626 &$primary_hostname$&.
15627
15628 If the spool directory name is fixed on your installation, it is recommended
15629 that you set it at build time rather than from this option, particularly if the
15630 log files are being written to the spool directory (see &%log_file_path%&).
15631 Otherwise log files cannot be used for errors that are detected early on, such
15632 as failures in the configuration file.
15633
15634 By using this option to override the compiled-in path, it is possible to run
15635 tests of Exim without using the standard spool.
15636
15637 .option sqlite_lock_timeout main time 5s
15638 .cindex "sqlite lookup type" "lock timeout"
15639 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15640 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15641
15642 .option strict_acl_vars main boolean false
15643 .cindex "&ACL;" "variables, handling unset"
15644 This option controls what happens if a syntactically valid but undefined ACL
15645 variable is referenced. If it is false (the default), an empty string
15646 is substituted; if it is true, an error is generated. See section
15647 &<<SECTaclvariables>>& for details of ACL variables.
15648
15649 .option strip_excess_angle_brackets main boolean false
15650 .cindex "angle brackets, excess"
15651 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15652 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15653 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15654 passed on to another MTA, the excess angle brackets are not passed on. If this
15655 option is not set, multiple pairs of angle brackets cause a syntax error.
15656
15657
15658 .option strip_trailing_dot main boolean false
15659 .cindex "trailing dot on domain"
15660 .cindex "dot" "trailing on domain"
15661 If this option is set, a trailing dot at the end of a domain in an address is
15662 ignored. If this is in the envelope and the message is passed on to another
15663 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15664 domain causes a syntax error.
15665 However, addresses in header lines are checked only when an ACL requests header
15666 syntax checking.
15667
15668
15669 .option syslog_duplication main boolean true
15670 .cindex "syslog" "duplicate log lines; suppressing"
15671 When Exim is logging to syslog, it writes the log lines for its three
15672 separate logs at different syslog priorities so that they can in principle
15673 be separated on the logging hosts. Some installations do not require this
15674 separation, and in those cases, the duplication of certain log lines is a
15675 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15676 particular log line is written to syslog. For lines that normally go to
15677 both the main log and the reject log, the reject log version (possibly
15678 containing message header lines) is written, at LOG_NOTICE priority.
15679 Lines that normally go to both the main and the panic log are written at
15680 the LOG_ALERT priority.
15681
15682
15683 .option syslog_facility main string unset
15684 .cindex "syslog" "facility; setting"
15685 This option sets the syslog &"facility"& name, used when Exim is logging to
15686 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15687 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15688 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15689 details of Exim's logging.
15690
15691
15692
15693 .option syslog_processname main string &`exim`&
15694 .cindex "syslog" "process name; setting"
15695 This option sets the syslog &"ident"& name, used when Exim is logging to
15696 syslog. The value must be no longer than 32 characters. See chapter
15697 &<<CHAPlog>>& for details of Exim's logging.
15698
15699
15700
15701 .option syslog_timestamp main boolean true
15702 .cindex "syslog" "timestamps"
15703 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15704 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15705 details of Exim's logging.
15706
15707
15708 .option system_filter main string&!! unset
15709 .cindex "filter" "system filter"
15710 .cindex "system filter" "specifying"
15711 .cindex "Sieve filter" "not available for system filter"
15712 This option specifies an Exim filter file that is applied to all messages at
15713 the start of each delivery attempt, before any routing is done. System filters
15714 must be Exim filters; they cannot be Sieve filters. If the system filter
15715 generates any deliveries to files or pipes, or any new mail messages, the
15716 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15717 which transports are to be used. Details of this facility are given in chapter
15718 &<<CHAPsystemfilter>>&.
15719
15720
15721 .option system_filter_directory_transport main string&!! unset
15722 .vindex "&$address_file$&"
15723 This sets the name of the transport driver that is to be used when the
15724 &%save%& command in a system message filter specifies a path ending in &"/"&,
15725 implying delivery of each message into a separate file in some directory.
15726 During the delivery, the variable &$address_file$& contains the path name.
15727
15728
15729 .option system_filter_file_transport main string&!! unset
15730 .cindex "file" "transport for system filter"
15731 This sets the name of the transport driver that is to be used when the &%save%&
15732 command in a system message filter specifies a path not ending in &"/"&. During
15733 the delivery, the variable &$address_file$& contains the path name.
15734
15735 .option system_filter_group main string unset
15736 .cindex "gid (group id)" "system filter"
15737 This option is used only when &%system_filter_user%& is also set. It sets the
15738 gid under which the system filter is run, overriding any gid that is associated
15739 with the user. The value may be numerical or symbolic.
15740
15741 .option system_filter_pipe_transport main string&!! unset
15742 .cindex "&(pipe)& transport" "for system filter"
15743 .vindex "&$address_pipe$&"
15744 This specifies the transport driver that is to be used when a &%pipe%& command
15745 is used in a system filter. During the delivery, the variable &$address_pipe$&
15746 contains the pipe command.
15747
15748
15749 .option system_filter_reply_transport main string&!! unset
15750 .cindex "&(autoreply)& transport" "for system filter"
15751 This specifies the transport driver that is to be used when a &%mail%& command
15752 is used in a system filter.
15753
15754
15755 .option system_filter_user main string unset
15756 .cindex "uid (user id)" "system filter"
15757 If this option is set to root, the system filter is run in the main Exim
15758 delivery process, as root.  Otherwise, the system filter runs in a separate
15759 process, as the given user, defaulting to the Exim run-time user.
15760 Unless the string consists entirely of digits, it
15761 is looked up in the password data. Failure to find the named user causes a
15762 configuration error. The gid is either taken from the password data, or
15763 specified by &%system_filter_group%&. When the uid is specified numerically,
15764 &%system_filter_group%& is required to be set.
15765
15766 If the system filter generates any pipe, file, or reply deliveries, the uid
15767 under which the filter is run is used when transporting them, unless a
15768 transport option overrides.
15769
15770
15771 .option tcp_nodelay main boolean true
15772 .cindex "daemon" "TCP_NODELAY on sockets"
15773 .cindex "Nagle algorithm"
15774 .cindex "TCP_NODELAY on listening sockets"
15775 If this option is set false, it stops the Exim daemon setting the
15776 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15777 turns off the &"Nagle algorithm"&, which is a way of improving network
15778 performance in interactive (character-by-character) situations. Turning it off
15779 should improve Exim's performance a bit, so that is what happens by default.
15780 However, it appears that some broken clients cannot cope, and time out. Hence
15781 this option. It affects only those sockets that are set up for listening by the
15782 daemon. Sockets created by the smtp transport for delivering mail always set
15783 TCP_NODELAY.
15784
15785
15786 .option timeout_frozen_after main time 0s
15787 .cindex "frozen messages" "timing out"
15788 .cindex "timeout" "frozen messages"
15789 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15790 message of any kind that has been on the queue for longer than the given time
15791 is automatically cancelled at the next queue run. If the frozen message is a
15792 bounce message, it is just discarded; otherwise, a bounce is sent to the
15793 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15794 If you want to timeout frozen bounce messages earlier than other kinds of
15795 frozen message, see &%ignore_bounce_errors_after%&.
15796
15797 &*Note:*& the default value of zero means no timeouts; with this setting,
15798 frozen messages remain on the queue forever (except for any frozen bounce
15799 messages that are released by &%ignore_bounce_errors_after%&).
15800
15801
15802 .option timezone main string unset
15803 .cindex "timezone, setting"
15804 The value of &%timezone%& is used to set the environment variable TZ while
15805 running Exim (if it is different on entry). This ensures that all timestamps
15806 created by Exim are in the required timezone. If you want all your timestamps
15807 to be in UTC (aka GMT) you should set
15808 .code
15809 timezone = UTC
15810 .endd
15811 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15812 or, if that is not set, from the value of the TZ environment variable when Exim
15813 is built. If &%timezone%& is set to the empty string, either at build or run
15814 time, any existing TZ variable is removed from the environment when Exim
15815 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15816 unfortunately not all, operating systems.
15817
15818
15819 .option tls_advertise_hosts main "host list&!!" unset
15820 .cindex "TLS" "advertising"
15821 .cindex "encryption" "on SMTP connection"
15822 .cindex "SMTP" "encrypted connection"
15823 When Exim is built with support for TLS encrypted connections, the availability
15824 of the STARTTLS command to set up an encrypted session is advertised in
15825 response to EHLO only to those client hosts that match this option. See
15826 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15827
15828
15829 .option tls_certificate main string&!! unset
15830 .cindex "TLS" "server certificate; location of"
15831 .cindex "certificate" "server, location of"
15832 The value of this option is expanded, and must then be the absolute path to a
15833 file which contains the server's certificates. The server's private key is also
15834 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15835 &<<CHAPTLS>>& for further details.
15836
15837 &*Note*&: The certificates defined by this option are used only when Exim is
15838 receiving incoming messages as a server. If you want to supply certificates for
15839 use when sending messages as a client, you must set the &%tls_certificate%&
15840 option in the relevant &(smtp)& transport.
15841
15842 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
15843 if the OpenSSL build supports TLS extensions and the TLS client sends the
15844 Server Name Indication extension, then this option and others documented in
15845 &<<SECTtlssni>>& will be re-expanded.
15846
15847 .option tls_crl main string&!! unset
15848 .cindex "TLS" "server certificate revocation list"
15849 .cindex "certificate" "revocation list for server"
15850 This option specifies a certificate revocation list. The expanded value must
15851 be the name of a file that contains a CRL in PEM format.
15852
15853 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15854
15855
15856 .option tls_dh_max_bits main integer 2236
15857 .cindex "TLS" "D-H bit count"
15858 The number of bits used for Diffie-Hellman key-exchange may be suggested by
15859 the chosen TLS library.  That value might prove to be too high for
15860 interoperability.  This option provides a maximum clamp on the value
15861 suggested, trading off security for interoperability.
15862
15863 The value must be at least 1024.
15864
15865 The value 2236 was chosen because, at time of adding the option, it was the
15866 hard-coded maximum value supported by the NSS cryptographic library, as used
15867 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
15868
15869 If you prefer more security and are willing to break some clients, raise this
15870 number.
15871
15872 Note that the value passed to GnuTLS for *generating* a new prime may be a
15873 little less than this figure, because GnuTLS is inexact and may produce a
15874 larger prime than requested.
15875
15876
15877 .option tls_dhparam main string&!! unset
15878 .cindex "TLS" "D-H parameters for server"
15879 The value of this option is expanded and indicates the source of DH parameters
15880 to be used by Exim.
15881
15882 If it is a filename starting with a &`/`&, then it names a file from which DH
15883 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
15884 PKCS#3 representation of the DH prime.  If the file does not exist, for
15885 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
15886 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
15887 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
15888 and treated as though the &%tls_dhparam%& were set to "none".
15889
15890 If this option expands to the string "none", then no DH parameters will be
15891 loaded by Exim.
15892
15893 If this option expands to the string "historic" and Exim is using GnuTLS, then
15894 Exim will attempt to load a file from inside the spool directory.  If the file
15895 does not exist, Exim will attempt to create it.
15896 See section &<<SECTgnutlsparam>>& for further details.
15897
15898 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
15899 a default DH prime; the default is the 2048 bit prime described in section
15900 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
15901 in IKE is assigned number 23.
15902
15903 Otherwise, the option must expand to the name used by Exim for any of a number
15904 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
15905 "ike" followed by the number used by IKE, of "default" which corresponds to
15906 "ike23".
15907
15908 The available primes are:
15909 &`ike1`&, &`ike2`&, &`ike5`&,
15910 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
15911 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
15912
15913 Some of these will be too small to be accepted by clients.
15914 Some may be too large to be accepted by clients.
15915
15916
15917 .option tls_on_connect_ports main "string list" unset
15918 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15919 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15920 set up without waiting for the client to issue a STARTTLS command. For
15921 further details, see section &<<SECTsupobssmt>>&.
15922
15923
15924
15925 .option tls_privatekey main string&!! unset
15926 .cindex "TLS" "server private key; location of"
15927 The value of this option is expanded, and must then be the absolute path to a
15928 file which contains the server's private key. If this option is unset, or if
15929 the expansion is forced to fail, or the result is an empty string, the private
15930 key is assumed to be in the same file as the server's certificates. See chapter
15931 &<<CHAPTLS>>& for further details.
15932
15933 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15934
15935
15936 .option tls_remember_esmtp main boolean false
15937 .cindex "TLS" "esmtp state; remembering"
15938 .cindex "TLS" "broken clients"
15939 If this option is set true, Exim violates the RFCs by remembering that it is in
15940 &"esmtp"& state after successfully negotiating a TLS session. This provides
15941 support for broken clients that fail to send a new EHLO after starting a
15942 TLS session.
15943
15944
15945 .option tls_require_ciphers main string&!! unset
15946 .cindex "TLS" "requiring specific ciphers"
15947 .cindex "cipher" "requiring specific"
15948 This option controls which ciphers can be used for incoming TLS connections.
15949 The &(smtp)& transport has an option of the same name for controlling outgoing
15950 connections. This option is expanded for each connection, so can be varied for
15951 different clients if required. The value of this option must be a list of
15952 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15953 in somewhat different ways. If GnuTLS is being used, the client controls the
15954 preference order of the available ciphers. Details are given in sections
15955 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15956
15957
15958 .option tls_try_verify_hosts main "host list&!!" unset
15959 .cindex "TLS" "client certificate verification"
15960 .cindex "certificate" "verification of client"
15961 See &%tls_verify_hosts%& below.
15962
15963
15964 .option tls_verify_certificates main string&!! unset
15965 .cindex "TLS" "client certificate verification"
15966 .cindex "certificate" "verification of client"
15967 The value of this option is expanded, and must then be the absolute path to
15968 a file containing permitted certificates for clients that
15969 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15970 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15971 directory containing certificate files. This does not work with GnuTLS; the
15972 option must be set to the name of a single file if you are using GnuTLS.
15973
15974 These certificates should be for the certificate authorities trusted, rather
15975 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
15976 the value is a file then the certificates are sent by Exim as a server to
15977 connecting clients, defining the list of accepted certificate authorities.
15978 Thus the values defined should be considered public data.  To avoid this,
15979 use OpenSSL with a directory.
15980
15981 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15982
15983
15984 .option tls_verify_hosts main "host list&!!" unset
15985 .cindex "TLS" "client certificate verification"
15986 .cindex "certificate" "verification of client"
15987 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15988 certificates from clients. The expected certificates are defined by
15989 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15990 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15991 &%tls_verify_certificates%& is not set.
15992
15993 Any client that matches &%tls_verify_hosts%& is constrained by
15994 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15995 present one of the listed certificates. If it does not, the connection is
15996 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15997 the host to use TLS. It can still send SMTP commands through unencrypted
15998 connections. Forcing a client to use TLS has to be done separately using an
15999 ACL to reject inappropriate commands when the connection is not encrypted.
16000
16001 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16002 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16003 certificate and checks it against &%tls_verify_certificates%&, but does not
16004 abort the connection if there is no certificate or if it does not match. This
16005 state can be detected in an ACL, which makes it possible to implement policies
16006 such as &"accept for relay only if a verified certificate has been received,
16007 but accept for local delivery if encrypted, even without a verified
16008 certificate"&.
16009
16010 Client hosts that match neither of these lists are not asked to present
16011 certificates.
16012
16013
16014 .option trusted_groups main "string list&!!" unset
16015 .cindex "trusted groups"
16016 .cindex "groups" "trusted"
16017 This option is expanded just once, at the start of Exim's processing. If this
16018 option is set, any process that is running in one of the listed groups, or
16019 which has one of them as a supplementary group, is trusted. The groups can be
16020 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16021 details of what trusted callers are permitted to do. If neither
16022 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16023 are trusted.
16024
16025 .option trusted_users main "string list&!!" unset
16026 .cindex "trusted users"
16027 .cindex "user" "trusted"
16028 This option is expanded just once, at the start of Exim's processing. If this
16029 option is set, any process that is running as one of the listed users is
16030 trusted. The users can be specified numerically or by name. See section
16031 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16032 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16033 Exim user are trusted.
16034
16035 .option unknown_login main string&!! unset
16036 .cindex "uid (user id)" "unknown caller"
16037 .vindex "&$caller_uid$&"
16038 This is a specialized feature for use in unusual configurations. By default, if
16039 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16040 gives up. The &%unknown_login%& option can be used to set a login name to be
16041 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16042 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16043 is used for the user's real name (gecos field), unless this has been set by the
16044 &%-F%& option.
16045
16046 .option unknown_username main string unset
16047 See &%unknown_login%&.
16048
16049 .option untrusted_set_sender main "address list&!!" unset
16050 .cindex "trusted users"
16051 .cindex "sender" "setting by untrusted user"
16052 .cindex "untrusted user setting sender"
16053 .cindex "user" "untrusted setting sender"
16054 .cindex "envelope sender"
16055 When an untrusted user submits a message to Exim using the standard input, Exim
16056 normally creates an envelope sender address from the user's login and the
16057 default qualification domain. Data from the &%-f%& option (for setting envelope
16058 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16059 is used) is ignored.
16060
16061 However, untrusted users are permitted to set an empty envelope sender address,
16062 to declare that a message should never generate any bounces. For example:
16063 .code
16064 exim -f '<>' user@domain.example
16065 .endd
16066 .vindex "&$sender_ident$&"
16067 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16068 other envelope sender addresses in a controlled way. When it is set, untrusted
16069 users are allowed to set envelope sender addresses that match any of the
16070 patterns in the list. Like all address lists, the string is expanded. The
16071 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16072 users to setting senders that start with their login ids
16073 followed by a hyphen
16074 by a setting like this:
16075 .code
16076 untrusted_set_sender = ^$sender_ident-
16077 .endd
16078 If you want to allow untrusted users to set envelope sender addresses without
16079 restriction, you can use
16080 .code
16081 untrusted_set_sender = *
16082 .endd
16083 The &%untrusted_set_sender%& option applies to all forms of local input, but
16084 only to the setting of the envelope sender. It does not permit untrusted users
16085 to use the other options which trusted user can use to override message
16086 parameters. Furthermore, it does not stop Exim from removing an existing
16087 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16088 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16089 overriding these actions. The handling of the &'Sender:'& header is also
16090 described in section &<<SECTthesenhea>>&.
16091
16092 The log line for a message's arrival shows the envelope sender following
16093 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16094 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16095 envelope sender address, the user's login is shown in parentheses after the
16096 sender address.
16097
16098
16099 .option uucp_from_pattern main string "see below"
16100 .cindex "&""From""& line"
16101 .cindex "UUCP" "&""From""& line"
16102 Some applications that pass messages to an MTA via a command line interface use
16103 an initial line starting with &"From&~"& to pass the envelope sender. In
16104 particular, this is used by UUCP software. Exim recognizes such a line by means
16105 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16106 matches, the sender address is constructed by expanding the contents of
16107 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16108 default pattern recognizes lines in the following two forms:
16109 .code
16110 From ph10 Fri Jan  5 12:35 GMT 1996
16111 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16112 .endd
16113 The pattern can be seen by running
16114 .code
16115 exim -bP uucp_from_pattern
16116 .endd
16117 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16118 year in the second case. The first word after &"From&~"& is matched in the
16119 regular expression by a parenthesized subpattern. The default value for
16120 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16121 (&"ph10"& in the example above) as the message's sender. See also
16122 &%ignore_fromline_hosts%&.
16123
16124
16125 .option uucp_from_sender main string&!! &`$1`&
16126 See &%uucp_from_pattern%& above.
16127
16128
16129 .option warn_message_file main string unset
16130 .cindex "warning of delay" "customizing the message"
16131 .cindex "customizing" "warning message"
16132 This option defines a template file containing paragraphs of text to be used
16133 for constructing the warning message which is sent by Exim when a message has
16134 been on the queue for a specified amount of time, as specified by
16135 &%delay_warning%&. Details of the file's contents are given in chapter
16136 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16137
16138
16139 .option write_rejectlog main boolean true
16140 .cindex "reject log" "disabling"
16141 If this option is set false, Exim no longer writes anything to the reject log.
16142 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16143 .ecindex IIDconfima
16144 .ecindex IIDmaiconf
16145
16146
16147
16148
16149 . ////////////////////////////////////////////////////////////////////////////
16150 . ////////////////////////////////////////////////////////////////////////////
16151
16152 .chapter "Generic options for routers" "CHAProutergeneric"
16153 .scindex IIDgenoprou1 "options" "generic; for routers"
16154 .scindex IIDgenoprou2 "generic options" "router"
16155 This chapter describes the generic options that apply to all routers.
16156 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16157
16158 For a general description of how a router operates, see sections
16159 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16160 which the preconditions are tested. The order of expansion of the options that
16161 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16162 &%headers_remove%&, &%transport%&.
16163
16164
16165
16166 .option address_data routers string&!! unset
16167 .cindex "router" "data attached to address"
16168 The string is expanded just before the router is run, that is, after all the
16169 precondition tests have succeeded. If the expansion is forced to fail, the
16170 router declines, the value of &%address_data%& remains unchanged, and the
16171 &%more%& option controls what happens next. Other expansion failures cause
16172 delivery of the address to be deferred.
16173
16174 .vindex "&$address_data$&"
16175 When the expansion succeeds, the value is retained with the address, and can be
16176 accessed using the variable &$address_data$& in the current router, subsequent
16177 routers, and the eventual transport.
16178
16179 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16180 that runs a user's filter file, the contents of &$address_data$& are accessible
16181 in the filter. This is not normally a problem, because such data is usually
16182 either not confidential or it &"belongs"& to the current user, but if you do
16183 put confidential data into &$address_data$& you need to remember this point.
16184
16185 Even if the router declines or passes, the value of &$address_data$& remains
16186 with the address, though it can be changed by another &%address_data%& setting
16187 on a subsequent router. If a router generates child addresses, the value of
16188 &$address_data$& propagates to them. This also applies to the special kind of
16189 &"child"& that is generated by a router with the &%unseen%& option.
16190
16191 The idea of &%address_data%& is that you can use it to look up a lot of data
16192 for the address once, and then pick out parts of the data later. For example,
16193 you could use a single LDAP lookup to return a string of the form
16194 .code
16195 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16196 .endd
16197 In the transport you could pick out the mailbox by a setting such as
16198 .code
16199 file = ${extract{mailbox}{$address_data}}
16200 .endd
16201 This makes the configuration file less messy, and also reduces the number of
16202 lookups (though Exim does cache lookups).
16203
16204 .vindex "&$sender_address_data$&"
16205 .vindex "&$address_data$&"
16206 The &%address_data%& facility is also useful as a means of passing information
16207 from one router to another, and from a router to a transport. In addition, if
16208 &$address_data$& is set by a router when verifying a recipient address from an
16209 ACL, it remains available for use in the rest of the ACL statement. After
16210 verifying a sender, the value is transferred to &$sender_address_data$&.
16211
16212
16213
16214 .option address_test routers&!? boolean true
16215 .oindex "&%-bt%&"
16216 .cindex "router" "skipping when address testing"
16217 If this option is set false, the router is skipped when routing is being tested
16218 by means of the &%-bt%& command line option. This can be a convenience when
16219 your first router sends messages to an external scanner, because it saves you
16220 having to set the &"already scanned"& indicator when testing real address
16221 routing.
16222
16223
16224
16225 .option cannot_route_message routers string&!! unset
16226 .cindex "router" "customizing &""cannot route""& message"
16227 .cindex "customizing" "&""cannot route""& message"
16228 This option specifies a text message that is used when an address cannot be
16229 routed because Exim has run out of routers. The default message is
16230 &"Unrouteable address"&. This option is useful only on routers that have
16231 &%more%& set false, or on the very last router in a configuration, because the
16232 value that is used is taken from the last router that is considered. This
16233 includes a router that is skipped because its preconditions are not met, as
16234 well as a router that declines. For example, using the default configuration,
16235 you could put:
16236 .code
16237 cannot_route_message = Remote domain not found in DNS
16238 .endd
16239 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16240 and
16241 .code
16242 cannot_route_message = Unknown local user
16243 .endd
16244 on the final router that checks for local users. If string expansion fails for
16245 this option, the default message is used. Unless the expansion failure was
16246 explicitly forced, a message about the failure is written to the main and panic
16247 logs, in addition to the normal message about the routing failure.
16248
16249
16250 .option caseful_local_part routers boolean false
16251 .cindex "case of local parts"
16252 .cindex "router" "case of local parts"
16253 By default, routers handle the local parts of addresses in a case-insensitive
16254 manner, though the actual case is preserved for transmission with the message.
16255 If you want the case of letters to be significant in a router, you must set
16256 this option true. For individual router options that contain address or local
16257 part lists (for example, &%local_parts%&), case-sensitive matching can be
16258 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16259 more details.
16260
16261 .vindex "&$local_part$&"
16262 .vindex "&$original_local_part$&"
16263 .vindex "&$parent_local_part$&"
16264 The value of the &$local_part$& variable is forced to lower case while a
16265 router is running unless &%caseful_local_part%& is set. When a router assigns
16266 an address to a transport, the value of &$local_part$& when the transport runs
16267 is the same as it was in the router. Similarly, when a router generates child
16268 addresses by aliasing or forwarding, the values of &$original_local_part$&
16269 and &$parent_local_part$& are those that were used by the redirecting router.
16270
16271 This option applies to the processing of an address by a router. When a
16272 recipient address is being processed in an ACL, there is a separate &%control%&
16273 modifier that can be used to specify case-sensitive processing within the ACL
16274 (see section &<<SECTcontrols>>&).
16275
16276
16277
16278 .option check_local_user routers&!? boolean false
16279 .cindex "local user, checking in router"
16280 .cindex "router" "checking for local user"
16281 .cindex "&_/etc/passwd_&"
16282 .vindex "&$home$&"
16283 When this option is true, Exim checks that the local part of the recipient
16284 address (with affixes removed if relevant) is the name of an account on the
16285 local system. The check is done by calling the &[getpwnam()]& function rather
16286 than trying to read &_/etc/passwd_& directly. This means that other methods of
16287 holding password data (such as NIS) are supported. If the local part is a local
16288 user, &$home$& is set from the password data, and can be tested in other
16289 preconditions that are evaluated after this one (the order of evaluation is
16290 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16291 overridden by &%router_home_directory%&. If the local part is not a local user,
16292 the router is skipped.
16293
16294 If you want to check that the local part is either the name of a local user
16295 or matches something else, you cannot combine &%check_local_user%& with a
16296 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16297 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16298 setting to achieve this. For example:
16299 .code
16300 local_parts = passwd;$local_part : lsearch;/etc/other/users
16301 .endd
16302 Note, however, that the side effects of &%check_local_user%& (such as setting
16303 up a home directory) do not occur when a &(passwd)& lookup is used in a
16304 &%local_parts%& (or any other) precondition.
16305
16306
16307
16308 .option condition routers&!? string&!! unset
16309 .cindex "router" "customized precondition"
16310 This option specifies a general precondition test that has to succeed for the
16311 router to be called. The &%condition%& option is the last precondition to be
16312 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16313 result is a forced failure, or an empty string, or one of the strings &"0"& or
16314 &"no"& or &"false"& (checked without regard to the case of the letters), the
16315 router is skipped, and the address is offered to the next one.
16316
16317 If the result is any other value, the router is run (as this is the last
16318 precondition to be evaluated, all the other preconditions must be true).
16319
16320 This option is unique in that multiple &%condition%& options may be present.
16321 All &%condition%& options must succeed.
16322
16323 The &%condition%& option provides a means of applying custom conditions to the
16324 running of routers. Note that in the case of a simple conditional expansion,
16325 the default expansion values are exactly what is wanted. For example:
16326 .code
16327 condition = ${if >{$message_age}{600}}
16328 .endd
16329 Because of the default behaviour of the string expansion, this is equivalent to
16330 .code
16331 condition = ${if >{$message_age}{600}{true}{}}
16332 .endd
16333
16334 A multiple condition example, which succeeds:
16335 .code
16336 condition = ${if >{$message_age}{600}}
16337 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16338 condition = foobar
16339 .endd
16340
16341 If the expansion fails (other than forced failure) delivery is deferred. Some
16342 of the other precondition options are common special cases that could in fact
16343 be specified using &%condition%&.
16344
16345
16346 .option debug_print routers string&!! unset
16347 .cindex "testing" "variables in drivers"
16348 If this option is set and debugging is enabled (see the &%-d%& command line
16349 option), the string is expanded and included in the debugging output.
16350 If expansion of the string fails, the error message is written to the debugging
16351 output, and Exim carries on processing.
16352 This option is provided to help with checking out the values of variables and
16353 so on when debugging router configurations. For example, if a &%condition%&
16354 option appears not to be working, &%debug_print%& can be used to output the
16355 variables it references. The output happens after checks for &%domains%&,
16356 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16357 are tested. A newline is added to the text if it does not end with one.
16358
16359
16360
16361 .option disable_logging routers boolean false
16362 If this option is set true, nothing is logged for any routing errors
16363 or for any deliveries caused by this router. You should not set this option
16364 unless you really, really know what you are doing. See also the generic
16365 transport option of the same name.
16366
16367
16368 .option domains routers&!? "domain list&!!" unset
16369 .cindex "router" "restricting to specific domains"
16370 .vindex "&$domain_data$&"
16371 If this option is set, the router is skipped unless the current domain matches
16372 the list. If the match is achieved by means of a file lookup, the data that the
16373 lookup returned for the domain is placed in &$domain_data$& for use in string
16374 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16375 a list of the order in which preconditions are evaluated.
16376
16377
16378
16379 .option driver routers string unset
16380 This option must always be set. It specifies which of the available routers is
16381 to be used.
16382
16383
16384
16385 .option errors_to routers string&!! unset
16386 .cindex "envelope sender"
16387 .cindex "router" "changing address for errors"
16388 If a router successfully handles an address, it may assign the address to a
16389 transport for delivery or it may generate child addresses. In both cases, if
16390 there is a delivery problem during later processing, the resulting bounce
16391 message is sent to the address that results from expanding this string,
16392 provided that the address verifies successfully. The &%errors_to%& option is
16393 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16394
16395 The &%errors_to%& setting associated with an address can be overridden if it
16396 subsequently passes through other routers that have their own &%errors_to%&
16397 settings, or if the message is delivered by a transport with a &%return_path%&
16398 setting.
16399
16400 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16401 the expansion fails to verify, the errors address associated with the incoming
16402 address is used. At top level, this is the envelope sender. A non-forced
16403 expansion failure causes delivery to be deferred.
16404
16405 If an address for which &%errors_to%& has been set ends up being delivered over
16406 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16407 any bounces that are generated by other MTAs on the delivery route are also
16408 sent there. You can set &%errors_to%& to the empty string by either of these
16409 settings:
16410 .code
16411 errors_to =
16412 errors_to = ""
16413 .endd
16414 An expansion item that yields an empty string has the same effect. If you do
16415 this, a locally detected delivery error for addresses processed by this router
16416 no longer gives rise to a bounce message; the error is discarded. If the
16417 address is delivered to a remote host, the return path is set to &`<>`&, unless
16418 overridden by the &%return_path%& option on the transport.
16419
16420 .vindex "&$address_data$&"
16421 If for some reason you want to discard local errors, but use a non-empty
16422 MAIL command for remote delivery, you can preserve the original return
16423 path in &$address_data$& in the router, and reinstate it in the transport by
16424 setting &%return_path%&.
16425
16426 The most common use of &%errors_to%& is to direct mailing list bounces to the
16427 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16428 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16429
16430
16431
16432 .option expn routers&!? boolean true
16433 .cindex "address" "testing"
16434 .cindex "testing" "addresses"
16435 .cindex "EXPN" "router skipping"
16436 .cindex "router" "skipping for EXPN"
16437 If this option is turned off, the router is skipped when testing an address
16438 as a result of processing an SMTP EXPN command. You might, for example,
16439 want to turn it off on a router for users' &_.forward_& files, while leaving it
16440 on for the system alias file.
16441 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16442 are evaluated.
16443
16444 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16445 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16446 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16447
16448
16449
16450 .option fail_verify routers boolean false
16451 .cindex "router" "forcing verification failure"
16452 Setting this option has the effect of setting both &%fail_verify_sender%& and
16453 &%fail_verify_recipient%& to the same value.
16454
16455
16456
16457 .option fail_verify_recipient routers boolean false
16458 If this option is true and an address is accepted by this router when
16459 verifying a recipient, verification fails.
16460
16461
16462
16463 .option fail_verify_sender routers boolean false
16464 If this option is true and an address is accepted by this router when
16465 verifying a sender, verification fails.
16466
16467
16468
16469 .option fallback_hosts routers "string list" unset
16470 .cindex "router" "fallback hosts"
16471 .cindex "fallback" "hosts specified on router"
16472 String expansion is not applied to this option. The argument must be a
16473 colon-separated list of host names or IP addresses. The list separator can be
16474 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16475 each name or address. In fact, the format of each item is exactly the same as
16476 defined for the list of hosts in a &(manualroute)& router (see section
16477 &<<SECTformatonehostitem>>&).
16478
16479 If a router queues an address for a remote transport, this host list is
16480 associated with the address, and used instead of the transport's fallback host
16481 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16482 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16483 transport for further details.
16484
16485
16486 .option group routers string&!! "see below"
16487 .cindex "gid (group id)" "local delivery"
16488 .cindex "local transports" "uid and gid"
16489 .cindex "transport" "local"
16490 .cindex "router" "setting group"
16491 When a router queues an address for a transport, and the transport does not
16492 specify a group, the group given here is used when running the delivery
16493 process.
16494 The group may be specified numerically or by name. If expansion fails, the
16495 error is logged and delivery is deferred.
16496 The default is unset, unless &%check_local_user%& is set, when the default
16497 is taken from the password information. See also &%initgroups%& and &%user%&
16498 and the discussion in chapter &<<CHAPenvironment>>&.
16499
16500
16501
16502 .option headers_add routers string&!! unset
16503 .cindex "header lines" "adding"
16504 .cindex "router" "adding header lines"
16505 This option specifies a string of text that is expanded at routing time, and
16506 associated with any addresses that are accepted by the router. However, this
16507 option has no effect when an address is just being verified. The way in which
16508 the text is used to add header lines at transport time is described in section
16509 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16510 message is in the process of being transported. This means that references to
16511 header lines in string expansions in the transport's configuration do not
16512 &"see"& the added header lines.
16513
16514 The &%headers_add%& option is expanded after &%errors_to%&, but before
16515 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16516 the expansion is forced to fail, the option has no effect. Other expansion
16517 failures are treated as configuration errors.
16518
16519 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16520 router that has the &%one_time%& option set.
16521
16522 .cindex "duplicate addresses"
16523 .oindex "&%unseen%&"
16524 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16525 additions are deleted when the address is passed on to subsequent routers.
16526 For a &%redirect%& router, if a generated address is the same as the incoming
16527 address, this can lead to duplicate addresses with different header
16528 modifications. Exim does not do duplicate deliveries (except, in certain
16529 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16530 which of the duplicates is discarded, so this ambiguous situation should be
16531 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16532
16533
16534
16535 .option headers_remove routers string&!! unset
16536 .cindex "header lines" "removing"
16537 .cindex "router" "removing header lines"
16538 This option specifies a string of text that is expanded at routing time, and
16539 associated with any addresses that are accepted by the router. However, this
16540 option has no effect when an address is just being verified. The way in which
16541 the text is used to remove header lines at transport time is described in
16542 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16543 the message is in the process of being transported. This means that references
16544 to header lines in string expansions in the transport's configuration still
16545 &"see"& the original header lines.
16546
16547 The &%headers_remove%& option is expanded after &%errors_to%& and
16548 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16549 the option has no effect. Other expansion failures are treated as configuration
16550 errors.
16551
16552 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16553 router that has the &%one_time%& option set.
16554
16555 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16556 removal requests are deleted when the address is passed on to subsequent
16557 routers, and this can lead to problems with duplicates -- see the similar
16558 warning for &%headers_add%& above.
16559
16560
16561 .option ignore_target_hosts routers "host list&!!" unset
16562 .cindex "IP address" "discarding"
16563 .cindex "router" "discarding IP addresses"
16564 Although this option is a host list, it should normally contain IP address
16565 entries rather than names. If any host that is looked up by the router has an
16566 IP address that matches an item in this list, Exim behaves as if that IP
16567 address did not exist. This option allows you to cope with rogue DNS entries
16568 like
16569 .code
16570 remote.domain.example.  A  127.0.0.1
16571 .endd
16572 by setting
16573 .code
16574 ignore_target_hosts = 127.0.0.1
16575 .endd
16576 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16577 discarded in this way, the router declines. In a conventional configuration, an
16578 attempt to mail to such a domain would normally provoke the &"unrouteable
16579 domain"& error, and an attempt to verify an address in the domain would fail.
16580 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16581 router declines if presented with one of the listed addresses.
16582
16583 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16584 means of the first or the second of the following settings, respectively:
16585 .code
16586 ignore_target_hosts = 0.0.0.0/0
16587 ignore_target_hosts = <; 0::0/0
16588 .endd
16589 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16590 in the second line matches all IPv6 addresses.
16591
16592 This option may also be useful for ignoring link-local and site-local IPv6
16593 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16594 is expanded before use as a list, it is possible to make it dependent on the
16595 domain that is being routed.
16596
16597 .vindex "&$host_address$&"
16598 During its expansion, &$host_address$& is set to the IP address that is being
16599 checked.
16600
16601 .option initgroups routers boolean false
16602 .cindex "additional groups"
16603 .cindex "groups" "additional"
16604 .cindex "local transports" "uid and gid"
16605 .cindex "transport" "local"
16606 If the router queues an address for a transport, and this option is true, and
16607 the uid supplied by the router is not overridden by the transport, the
16608 &[initgroups()]& function is called when running the transport to ensure that
16609 any additional groups associated with the uid are set up. See also &%group%&
16610 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16611
16612
16613
16614 .option local_part_prefix routers&!? "string list" unset
16615 .cindex "router" "prefix for local part"
16616 .cindex "prefix" "for local part, used in router"
16617 If this option is set, the router is skipped unless the local part starts with
16618 one of the given strings, or &%local_part_prefix_optional%& is true. See
16619 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16620 evaluated.
16621
16622 The list is scanned from left to right, and the first prefix that matches is
16623 used. A limited form of wildcard is available; if the prefix begins with an
16624 asterisk, it matches the longest possible sequence of arbitrary characters at
16625 the start of the local part. An asterisk should therefore always be followed by
16626 some character that does not occur in normal local parts.
16627 .cindex "multiple mailboxes"
16628 .cindex "mailbox" "multiple"
16629 Wildcarding can be used to set up multiple user mailboxes, as described in
16630 section &<<SECTmulbox>>&.
16631
16632 .vindex "&$local_part$&"
16633 .vindex "&$local_part_prefix$&"
16634 During the testing of the &%local_parts%& option, and while the router is
16635 running, the prefix is removed from the local part, and is available in the
16636 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16637 the router accepts the address, this remains true during subsequent delivery by
16638 a transport. In particular, the local part that is transmitted in the RCPT
16639 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16640 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16641 the relevant transport.
16642
16643 When an address is being verified, &%local_part_prefix%& affects only the
16644 behaviour of the router. If the callout feature of verification is in use, this
16645 means that the full address, including the prefix, will be used during the
16646 callout.
16647
16648 The prefix facility is commonly used to handle local parts of the form
16649 &%owner-something%&. Another common use is to support local parts of the form
16650 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16651 to tell a user their forwarding is broken &-- by placing a router like this one
16652 immediately before the router that handles &_.forward_& files:
16653 .code
16654 real_localuser:
16655   driver = accept
16656   local_part_prefix = real-
16657   check_local_user
16658   transport = local_delivery
16659 .endd
16660 For security, it would probably be a good idea to restrict the use of this
16661 router to locally-generated messages, using a condition such as this:
16662 .code
16663   condition = ${if match {$sender_host_address}\
16664                          {\N^(|127\.0\.0\.1)$\N}}
16665 .endd
16666
16667 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16668 both conditions must be met if not optional. Care must be taken if wildcards
16669 are used in both a prefix and a suffix on the same router. Different
16670 separator characters must be used to avoid ambiguity.
16671
16672
16673 .option local_part_prefix_optional routers boolean false
16674 See &%local_part_prefix%& above.
16675
16676
16677
16678 .option local_part_suffix routers&!? "string list" unset
16679 .cindex "router" "suffix for local part"
16680 .cindex "suffix for local part" "used in router"
16681 This option operates in the same way as &%local_part_prefix%&, except that the
16682 local part must end (rather than start) with the given string, the
16683 &%local_part_suffix_optional%& option determines whether the suffix is
16684 mandatory, and the wildcard * character, if present, must be the last
16685 character of the suffix. This option facility is commonly used to handle local
16686 parts of the form &%something-request%& and multiple user mailboxes of the form
16687 &%username-foo%&.
16688
16689
16690 .option local_part_suffix_optional routers boolean false
16691 See &%local_part_suffix%& above.
16692
16693
16694
16695 .option local_parts routers&!? "local part list&!!" unset
16696 .cindex "router" "restricting to specific local parts"
16697 .cindex "local part" "checking in router"
16698 The router is run only if the local part of the address matches the list.
16699 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16700 are evaluated, and
16701 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16702 string is expanded, it is possible to make it depend on the domain, for
16703 example:
16704 .code
16705 local_parts = dbm;/usr/local/specials/$domain
16706 .endd
16707 .vindex "&$local_part_data$&"
16708 If the match is achieved by a lookup, the data that the lookup returned
16709 for the local part is placed in the variable &$local_part_data$& for use in
16710 expansions of the router's private options. You might use this option, for
16711 example, if you have a large number of local virtual domains, and you want to
16712 send all postmaster mail to the same place without having to set up an alias in
16713 each virtual domain:
16714 .code
16715 postmaster:
16716   driver = redirect
16717   local_parts = postmaster
16718   data = postmaster@real.domain.example
16719 .endd
16720
16721
16722 .option log_as_local routers boolean "see below"
16723 .cindex "log" "delivery line"
16724 .cindex "delivery" "log line format"
16725 Exim has two logging styles for delivery, the idea being to make local
16726 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16727 recipient address is given just as the local part, without a domain. The use of
16728 this style is controlled by this option. It defaults to true for the &(accept)&
16729 router, and false for all the others. This option applies only when a
16730 router assigns an address to a transport. It has no effect on routers that
16731 redirect addresses.
16732
16733
16734
16735 .option more routers boolean&!! true
16736 The result of string expansion for this option must be a valid boolean value,
16737 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16738 result causes an error, and delivery is deferred. If the expansion is forced to
16739 fail, the default value for the option (true) is used. Other failures cause
16740 delivery to be deferred.
16741
16742 If this option is set false, and the router declines to handle the address, no
16743 further routers are tried, routing fails, and the address is bounced.
16744 .oindex "&%self%&"
16745 However, if the router explicitly passes an address to the following router by
16746 means of the setting
16747 .code
16748 self = pass
16749 .endd
16750 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16751 does not affect the behaviour if one of the precondition tests fails. In that
16752 case, the address is always passed to the next router.
16753
16754 Note that &%address_data%& is not considered to be a precondition. If its
16755 expansion is forced to fail, the router declines, and the value of &%more%&
16756 controls what happens next.
16757
16758
16759 .option pass_on_timeout routers boolean false
16760 .cindex "timeout" "of router"
16761 .cindex "router" "timeout"
16762 If a router times out during a host lookup, it normally causes deferral of the
16763 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16764 router, overriding &%no_more%&. This may be helpful for systems that are
16765 intermittently connected to the Internet, or those that want to pass to a smart
16766 host any messages that cannot immediately be delivered.
16767
16768 There are occasional other temporary errors that can occur while doing DNS
16769 lookups. They are treated in the same way as a timeout, and this option
16770 applies to all of them.
16771
16772
16773
16774 .option pass_router routers string unset
16775 .cindex "router" "go to after &""pass""&"
16776 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16777 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16778 routing to continue, and overriding a false setting of &%more%&. When one of
16779 these routers returns &"pass"&, the address is normally handed on to the next
16780 router in sequence. This can be changed by setting &%pass_router%& to the name
16781 of another router. However (unlike &%redirect_router%&) the named router must
16782 be below the current router, to avoid loops. Note that this option applies only
16783 to the special case of &"pass"&. It does not apply when a router returns
16784 &"decline"& because it cannot handle an address.
16785
16786
16787
16788 .option redirect_router routers string unset
16789 .cindex "router" "start at after redirection"
16790 Sometimes an administrator knows that it is pointless to reprocess addresses
16791 generated from alias or forward files with the same router again. For
16792 example, if an alias file translates real names into login ids there is no
16793 point searching the alias file a second time, especially if it is a large file.
16794
16795 The &%redirect_router%& option can be set to the name of any router instance.
16796 It causes the routing of any generated addresses to start at the named router
16797 instead of at the first router. This option has no effect if the router in
16798 which it is set does not generate new addresses.
16799
16800
16801
16802 .option require_files routers&!? "string list&!!" unset
16803 .cindex "file" "requiring for router"
16804 .cindex "router" "requiring file existence"
16805 This option provides a general mechanism for predicating the running of a
16806 router on the existence or non-existence of certain files or directories.
16807 Before running a router, as one of its precondition tests, Exim works its way
16808 through the &%require_files%& list, expanding each item separately.
16809
16810 Because the list is split before expansion, any colons in expansion items must
16811 be doubled, or the facility for using a different list separator must be used.
16812 If any expansion is forced to fail, the item is ignored. Other expansion
16813 failures cause routing of the address to be deferred.
16814
16815 If any expanded string is empty, it is ignored. Otherwise, except as described
16816 below, each string must be a fully qualified file path, optionally preceded by
16817 &"!"&. The paths are passed to the &[stat()]& function to test for the
16818 existence of the files or directories. The router is skipped if any paths not
16819 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16820
16821 .cindex "NFS"
16822 If &[stat()]& cannot determine whether a file exists or not, delivery of
16823 the message is deferred. This can happen when NFS-mounted filesystems are
16824 unavailable.
16825
16826 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16827 options, so you cannot use it to check for the existence of a file in which to
16828 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16829 full list of the order in which preconditions are evaluated.) However, as
16830 these options are all expanded, you can use the &%exists%& expansion condition
16831 to make such tests. The &%require_files%& option is intended for checking files
16832 that the router may be going to use internally, or which are needed by a
16833 transport (for example &_.procmailrc_&).
16834
16835 During delivery, the &[stat()]& function is run as root, but there is a
16836 facility for some checking of the accessibility of a file by another user.
16837 This is not a proper permissions check, but just a &"rough"& check that
16838 operates as follows:
16839
16840 If an item in a &%require_files%& list does not contain any forward slash
16841 characters, it is taken to be the user (and optional group, separated by a
16842 comma) to be checked for subsequent files in the list. If no group is specified
16843 but the user is specified symbolically, the gid associated with the uid is
16844 used. For example:
16845 .code
16846 require_files = mail:/some/file
16847 require_files = $local_part:$home/.procmailrc
16848 .endd
16849 If a user or group name in a &%require_files%& list does not exist, the
16850 &%require_files%& condition fails.
16851
16852 Exim performs the check by scanning along the components of the file path, and
16853 checking the access for the given uid and gid. It checks for &"x"& access on
16854 directories, and &"r"& access on the final file. Note that this means that file
16855 access control lists, if the operating system has them, are ignored.
16856
16857 &*Warning 1*&: When the router is being run to verify addresses for an
16858 incoming SMTP message, Exim is not running as root, but under its own uid. This
16859 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16860 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16861 user is not permitted to read one of the directories on the file's path.
16862
16863 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16864 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16865 without root access. In this case, if a check for access by a particular user
16866 is requested, Exim creates a subprocess that runs as that user, and tries the
16867 check again in that process.
16868
16869 The default action for handling an unresolved EACCES is to consider it to
16870 be caused by a configuration error, and routing is deferred because the
16871 existence or non-existence of the file cannot be determined. However, in some
16872 circumstances it may be desirable to treat this condition as if the file did
16873 not exist. If the file name (or the exclamation mark that precedes the file
16874 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16875 as if the file did not exist. For example:
16876 .code
16877 require_files = +/some/file
16878 .endd
16879 If the router is not an essential part of verification (for example, it
16880 handles users' &_.forward_& files), another solution is to set the &%verify%&
16881 option false so that the router is skipped when verifying.
16882
16883
16884
16885 .option retry_use_local_part routers boolean "see below"
16886 .cindex "hints database" "retry keys"
16887 .cindex "local part" "in retry keys"
16888 When a delivery suffers a temporary routing failure, a retry record is created
16889 in Exim's hints database. For addresses whose routing depends only on the
16890 domain, the key for the retry record should not involve the local part, but for
16891 other addresses, both the domain and the local part should be included.
16892 Usually, remote routing is of the former kind, and local routing is of the
16893 latter kind.
16894
16895 This option controls whether the local part is used to form the key for retry
16896 hints for addresses that suffer temporary errors while being handled by this
16897 router. The default value is true for any router that has &%check_local_user%&
16898 set, and false otherwise. Note that this option does not apply to hints keys
16899 for transport delays; they are controlled by a generic transport option of the
16900 same name.
16901
16902 The setting of &%retry_use_local_part%& applies only to the router on which it
16903 appears. If the router generates child addresses, they are routed
16904 independently; this setting does not become attached to them.
16905
16906
16907
16908 .option router_home_directory routers string&!! unset
16909 .cindex "router" "home directory for"
16910 .cindex "home directory" "for router"
16911 .vindex "&$home$&"
16912 This option sets a home directory for use while the router is running. (Compare
16913 &%transport_home_directory%&, which sets a home directory for later
16914 transporting.) In particular, if used on a &(redirect)& router, this option
16915 sets a value for &$home$& while a filter is running. The value is expanded;
16916 forced expansion failure causes the option to be ignored &-- other failures
16917 cause the router to defer.
16918
16919 Expansion of &%router_home_directory%& happens immediately after the
16920 &%check_local_user%& test (if configured), before any further expansions take
16921 place.
16922 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16923 are evaluated.)
16924 While the router is running, &%router_home_directory%& overrides the value of
16925 &$home$& that came from &%check_local_user%&.
16926
16927 When a router accepts an address and assigns it to a local transport (including
16928 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16929 delivery), the home directory setting for the transport is taken from the first
16930 of these values that is set:
16931
16932 .ilist
16933 The &%home_directory%& option on the transport;
16934 .next
16935 The &%transport_home_directory%& option on the router;
16936 .next
16937 The password data if &%check_local_user%& is set on the router;
16938 .next
16939 The &%router_home_directory%& option on the router.
16940 .endlist
16941
16942 In other words, &%router_home_directory%& overrides the password data for the
16943 router, but not for the transport.
16944
16945
16946
16947 .option self routers string freeze
16948 .cindex "MX record" "pointing to local host"
16949 .cindex "local host" "MX pointing to"
16950 This option applies to those routers that use a recipient address to find a
16951 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16952 and &(manualroute)& routers.
16953 Certain configurations of the &(queryprogram)& router can also specify a list
16954 of remote hosts.
16955 Usually such routers are configured to send the message to a remote host via an
16956 &(smtp)& transport. The &%self%& option specifies what happens when the first
16957 host on the list turns out to be the local host.
16958 The way in which Exim checks for the local host is described in section
16959 &<<SECTreclocipadd>>&.
16960
16961 Normally this situation indicates either an error in Exim's configuration (for
16962 example, the router should be configured not to process this domain), or an
16963 error in the DNS (for example, the MX should not point to this host). For this
16964 reason, the default action is to log the incident, defer the address, and
16965 freeze the message. The following alternatives are provided for use in special
16966 cases:
16967
16968 .vlist
16969 .vitem &%defer%&
16970 Delivery of the message is tried again later, but the message is not frozen.
16971
16972 .vitem "&%reroute%&: <&'domain'&>"
16973 The domain is changed to the given domain, and the address is passed back to
16974 be reprocessed by the routers. No rewriting of headers takes place. This
16975 behaviour is essentially a redirection.
16976
16977 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16978 The domain is changed to the given domain, and the address is passed back to be
16979 reprocessed by the routers. Any headers that contain the original domain are
16980 rewritten.
16981
16982 .vitem &%pass%&
16983 .oindex "&%more%&"
16984 .vindex "&$self_hostname$&"
16985 The router passes the address to the next router, or to the router named in the
16986 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16987 subsequent routing and delivery, the variable &$self_hostname$& contains the
16988 name of the local host that the router encountered. This can be used to
16989 distinguish between different cases for hosts with multiple names. The
16990 combination
16991 .code
16992 self = pass
16993 no_more
16994 .endd
16995 ensures that only those addresses that routed to the local host are passed on.
16996 Without &%no_more%&, addresses that were declined for other reasons would also
16997 be passed to the next router.
16998
16999 .vitem &%fail%&
17000 Delivery fails and an error report is generated.
17001
17002 .vitem &%send%&
17003 .cindex "local host" "sending to"
17004 The anomaly is ignored and the address is queued for the transport. This
17005 setting should be used with extreme caution. For an &(smtp)& transport, it
17006 makes sense only in cases where the program that is listening on the SMTP port
17007 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17008 different configuration file that handles the domain in another way.
17009 .endlist
17010
17011
17012
17013 .option senders routers&!? "address list&!!" unset
17014 .cindex "router" "checking senders"
17015 If this option is set, the router is skipped unless the message's sender
17016 address matches something on the list.
17017 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17018 are evaluated.
17019
17020 There are issues concerning verification when the running of routers is
17021 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17022 setting, it sets the sender to the null string. When using the &%-bt%& option
17023 to check a configuration file, it is necessary also to use the &%-f%& option to
17024 set an appropriate sender. For incoming mail, the sender is unset when
17025 verifying the sender, but is available when verifying any recipients. If the
17026 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17027 matters.
17028
17029
17030 .option translate_ip_address routers string&!! unset
17031 .cindex "IP address" "translating"
17032 .cindex "packet radio"
17033 .cindex "router" "IP address translation"
17034 There exist some rare networking situations (for example, packet radio) where
17035 it is helpful to be able to translate IP addresses generated by normal routing
17036 mechanisms into other IP addresses, thus performing a kind of manual IP
17037 routing. This should be done only if the normal IP routing of the TCP/IP stack
17038 is inadequate or broken. Because this is an extremely uncommon requirement, the
17039 code to support this option is not included in the Exim binary unless
17040 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17041
17042 .vindex "&$host_address$&"
17043 The &%translate_ip_address%& string is expanded for every IP address generated
17044 by the router, with the generated address set in &$host_address$&. If the
17045 expansion is forced to fail, no action is taken.
17046 For any other expansion error, delivery of the message is deferred.
17047 If the result of the expansion is an IP address, that replaces the original
17048 address; otherwise the result is assumed to be a host name &-- this is looked
17049 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17050 produce one or more replacement IP addresses. For example, to subvert all IP
17051 addresses in some specific networks, this could be added to a router:
17052 .code
17053 translate_ip_address = \
17054   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17055     {$value}fail}}
17056 .endd
17057 The file would contain lines like
17058 .code
17059 10.2.3.128/26    some.host
17060 10.8.4.34/26     10.44.8.15
17061 .endd
17062 You should not make use of this facility unless you really understand what you
17063 are doing.
17064
17065
17066
17067 .option transport routers string&!! unset
17068 This option specifies the transport to be used when a router accepts an address
17069 and sets it up for delivery. A transport is never needed if a router is used
17070 only for verification. The value of the option is expanded at routing time,
17071 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17072 and result must be the name of one of the configured transports. If it is not,
17073 delivery is deferred.
17074
17075 The &%transport%& option is not used by the &(redirect)& router, but it does
17076 have some private options that set up transports for pipe and file deliveries
17077 (see chapter &<<CHAPredirect>>&).
17078
17079
17080
17081 .option transport_current_directory routers string&!! unset
17082 .cindex "current directory for local transport"
17083 This option associates a current directory with any address that is routed
17084 to a local transport. This can happen either because a transport is
17085 explicitly configured for the router, or because it generates a delivery to a
17086 file or a pipe. During the delivery process (that is, at transport time), this
17087 option string is expanded and is set as the current directory, unless
17088 overridden by a setting on the transport.
17089 If the expansion fails for any reason, including forced failure, an error is
17090 logged, and delivery is deferred.
17091 See chapter &<<CHAPenvironment>>& for details of the local delivery
17092 environment.
17093
17094
17095
17096
17097 .option transport_home_directory routers string&!! "see below"
17098 .cindex "home directory" "for local transport"
17099 This option associates a home directory with any address that is routed to a
17100 local transport. This can happen either because a transport is explicitly
17101 configured for the router, or because it generates a delivery to a file or a
17102 pipe. During the delivery process (that is, at transport time), the option
17103 string is expanded and is set as the home directory, unless overridden by a
17104 setting of &%home_directory%& on the transport.
17105 If the expansion fails for any reason, including forced failure, an error is
17106 logged, and delivery is deferred.
17107
17108 If the transport does not specify a home directory, and
17109 &%transport_home_directory%& is not set for the router, the home directory for
17110 the transport is taken from the password data if &%check_local_user%& is set for
17111 the router. Otherwise it is taken from &%router_home_directory%& if that option
17112 is set; if not, no home directory is set for the transport.
17113
17114 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17115 environment.
17116
17117
17118
17119
17120 .option unseen routers boolean&!! false
17121 .cindex "router" "carrying on after success"
17122 The result of string expansion for this option must be a valid boolean value,
17123 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17124 result causes an error, and delivery is deferred. If the expansion is forced to
17125 fail, the default value for the option (false) is used. Other failures cause
17126 delivery to be deferred.
17127
17128 When this option is set true, routing does not cease if the router accepts the
17129 address. Instead, a copy of the incoming address is passed to the next router,
17130 overriding a false setting of &%more%&. There is little point in setting
17131 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17132 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17133 sometimes true and sometimes false).
17134
17135 .cindex "copy of message (&%unseen%& option)"
17136 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17137 qualifier in filter files. It can be used to cause copies of messages to be
17138 delivered to some other destination, while also carrying out a normal delivery.
17139 In effect, the current address is made into a &"parent"& that has two children
17140 &-- one that is delivered as specified by this router, and a clone that goes on
17141 to be routed further. For this reason, &%unseen%& may not be combined with the
17142 &%one_time%& option in a &(redirect)& router.
17143
17144 &*Warning*&: Header lines added to the address (or specified for removal) by
17145 this router or by previous routers affect the &"unseen"& copy of the message
17146 only. The clone that continues to be processed by further routers starts with
17147 no added headers and none specified for removal. For a &%redirect%& router, if
17148 a generated address is the same as the incoming address, this can lead to
17149 duplicate addresses with different header modifications. Exim does not do
17150 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17151 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17152 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17153 &%redirect%& router may be of help.
17154
17155 Unlike the handling of header modifications, any data that was set by the
17156 &%address_data%& option in the current or previous routers &'is'& passed on to
17157 subsequent routers.
17158
17159
17160 .option user routers string&!! "see below"
17161 .cindex "uid (user id)" "local delivery"
17162 .cindex "local transports" "uid and gid"
17163 .cindex "transport" "local"
17164 .cindex "router" "user for filter processing"
17165 .cindex "filter" "user for processing"
17166 When a router queues an address for a transport, and the transport does not
17167 specify a user, the user given here is used when running the delivery process.
17168 The user may be specified numerically or by name. If expansion fails, the
17169 error is logged and delivery is deferred.
17170 This user is also used by the &(redirect)& router when running a filter file.
17171 The default is unset, except when &%check_local_user%& is set. In this case,
17172 the default is taken from the password information. If the user is specified as
17173 a name, and &%group%& is not set, the group associated with the user is used.
17174 See also &%initgroups%& and &%group%& and the discussion in chapter
17175 &<<CHAPenvironment>>&.
17176
17177
17178
17179 .option verify routers&!? boolean true
17180 Setting this option has the effect of setting &%verify_sender%& and
17181 &%verify_recipient%& to the same value.
17182
17183
17184 .option verify_only routers&!? boolean false
17185 .cindex "EXPN" "with &%verify_only%&"
17186 .oindex "&%-bv%&"
17187 .cindex "router" "used only when verifying"
17188 If this option is set, the router is used only when verifying an address or
17189 testing with the &%-bv%& option, not when actually doing a delivery, testing
17190 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17191 restricted to verifying only senders or recipients by means of
17192 &%verify_sender%& and &%verify_recipient%&.
17193
17194 &*Warning*&: When the router is being run to verify addresses for an incoming
17195 SMTP message, Exim is not running as root, but under its own uid. If the router
17196 accesses any files, you need to make sure that they are accessible to the Exim
17197 user or group.
17198
17199
17200 .option verify_recipient routers&!? boolean true
17201 If this option is false, the router is skipped when verifying recipient
17202 addresses
17203 or testing recipient verification using &%-bv%&.
17204 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17205 are evaluated.
17206
17207
17208 .option verify_sender routers&!? boolean true
17209 If this option is false, the router is skipped when verifying sender addresses
17210 or testing sender verification using &%-bvs%&.
17211 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17212 are evaluated.
17213 .ecindex IIDgenoprou1
17214 .ecindex IIDgenoprou2
17215
17216
17217
17218
17219
17220
17221 . ////////////////////////////////////////////////////////////////////////////
17222 . ////////////////////////////////////////////////////////////////////////////
17223
17224 .chapter "The accept router" "CHID4"
17225 .cindex "&(accept)& router"
17226 .cindex "routers" "&(accept)&"
17227 The &(accept)& router has no private options of its own. Unless it is being
17228 used purely for verification (see &%verify_only%&) a transport is required to
17229 be defined by the generic &%transport%& option. If the preconditions that are
17230 specified by generic options are met, the router accepts the address and queues
17231 it for the given transport. The most common use of this router is for setting
17232 up deliveries to local mailboxes. For example:
17233 .code
17234 localusers:
17235   driver = accept
17236   domains = mydomain.example
17237   check_local_user
17238   transport = local_delivery
17239 .endd
17240 The &%domains%& condition in this example checks the domain of the address, and
17241 &%check_local_user%& checks that the local part is the login of a local user.
17242 When both preconditions are met, the &(accept)& router runs, and queues the
17243 address for the &(local_delivery)& transport.
17244
17245
17246
17247
17248
17249
17250 . ////////////////////////////////////////////////////////////////////////////
17251 . ////////////////////////////////////////////////////////////////////////////
17252
17253 .chapter "The dnslookup router" "CHAPdnslookup"
17254 .scindex IIDdnsrou1 "&(dnslookup)& router"
17255 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17256 The &(dnslookup)& router looks up the hosts that handle mail for the
17257 recipient's domain in the DNS. A transport must always be set for this router,
17258 unless &%verify_only%& is set.
17259
17260 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17261 SRV records. If none are found, or if SRV support is not configured,
17262 MX records are looked up. If no MX records exist, address records are sought.
17263 However, &%mx_domains%& can be set to disable the direct use of address
17264 records.
17265
17266 MX records of equal priority are sorted by Exim into a random order. Exim then
17267 looks for address records for the host names obtained from MX or SRV records.
17268 When a host has more than one IP address, they are sorted into a random order,
17269 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17270 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17271 generic option, the router declines.
17272
17273 Unless they have the highest priority (lowest MX value), MX records that point
17274 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17275 are discarded, together with any other MX records of equal or lower priority.
17276
17277 .cindex "MX record" "pointing to local host"
17278 .cindex "local host" "MX pointing to"
17279 .oindex "&%self%&" "in &(dnslookup)& router"
17280 If the host pointed to by the highest priority MX record, or looked up as an
17281 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17282 happens is controlled by the generic &%self%& option.
17283
17284
17285 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17286 There have been problems with DNS servers when SRV records are looked up.
17287 Some mis-behaving servers return a DNS error or timeout when a non-existent
17288 SRV record is sought. Similar problems have in the past been reported for
17289 MX records. The global &%dns_again_means_nonexist%& option can help with this
17290 problem, but it is heavy-handed because it is a global option.
17291
17292 For this reason, there are two options, &%srv_fail_domains%& and
17293 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17294 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17295 an attempt to look up an SRV or MX record causes one of these results, and the
17296 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17297 such record"&. In the case of an SRV lookup, this means that the router
17298 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17299 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17300 case routing fails.
17301
17302
17303 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17304 .cindex "&(dnslookup)& router" "declines"
17305 There are a few cases where a &(dnslookup)& router will decline to accept
17306 an address; if such a router is expected to handle "all remaining non-local
17307 domains", then it is important to set &%no_more%&.
17308
17309 Reasons for a &(dnslookup)& router to decline currently include:
17310 .ilist
17311 The domain does not exist in DNS
17312 .next
17313 The domain exists but the MX record's host part is just "."; this is a common
17314 convention (borrowed from SRV) used to indicate that there is no such service
17315 for this domain and to not fall back to trying A/AAAA records.
17316 .next
17317 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17318 .next
17319 MX record points to a non-existent host.
17320 .next
17321 MX record points to an IP address and the main section option
17322 &%allow_mx_to_ip%& is not set.
17323 .next
17324 MX records exist and point to valid hosts, but all hosts resolve only to
17325 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17326 .next
17327 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17328 &%dns_check_names_pattern%& for handling one variant of this)
17329 .next
17330 &%check_secondary_mx%& is set on this router but the local host can
17331 not be found in the MX records (see below)
17332 .endlist
17333
17334
17335
17336
17337 .section "Private options for dnslookup" "SECID118"
17338 .cindex "options" "&(dnslookup)& router"
17339 The private options for the &(dnslookup)& router are as follows:
17340
17341 .option check_secondary_mx dnslookup boolean false
17342 .cindex "MX record" "checking for secondary"
17343 If this option is set, the router declines unless the local host is found in
17344 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17345 process domains for which the local host is a secondary mail exchanger
17346 differently to other domains. The way in which Exim decides whether a host is
17347 the local host is described in section &<<SECTreclocipadd>>&.
17348
17349
17350 .option check_srv dnslookup string&!! unset
17351 .cindex "SRV record" "enabling use of"
17352 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17353 addition to MX and address records. The support is disabled by default. To
17354 enable SRV support, set the &%check_srv%& option to the name of the service
17355 required. For example,
17356 .code
17357 check_srv = smtp
17358 .endd
17359 looks for SRV records that refer to the normal smtp service. The option is
17360 expanded, so the service name can vary from message to message or address
17361 to address. This might be helpful if SRV records are being used for a
17362 submission service. If the expansion is forced to fail, the &%check_srv%&
17363 option is ignored, and the router proceeds to look for MX records in the
17364 normal way.
17365
17366 When the expansion succeeds, the router searches first for SRV records for
17367 the given service (it assumes TCP protocol). A single SRV record with a
17368 host name that consists of just a single dot indicates &"no such service for
17369 this domain"&; if this is encountered, the router declines. If other kinds of
17370 SRV record are found, they are used to construct a host list for delivery
17371 according to the rules of RFC 2782. MX records are not sought in this case.
17372
17373 When no SRV records are found, MX records (and address records) are sought in
17374 the traditional way. In other words, SRV records take precedence over MX
17375 records, just as MX records take precedence over address records. Note that
17376 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17377 defined it. It is apparently believed that MX records are sufficient for email
17378 and that SRV records should not be used for this purpose. However, SRV records
17379 have an additional &"weight"& feature which some people might find useful when
17380 trying to split an SMTP load between hosts of different power.
17381
17382 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17383 when there is a DNS lookup error.
17384
17385
17386
17387 .option mx_domains dnslookup "domain list&!!" unset
17388 .cindex "MX record" "required to exist"
17389 .cindex "SRV record" "required to exist"
17390 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17391 record in order to be recognized. (The name of this option could be improved.)
17392 For example, if all the mail hosts in &'fict.example'& are known to have MX
17393 records, except for those in &'discworld.fict.example'&, you could use this
17394 setting:
17395 .code
17396 mx_domains = ! *.discworld.fict.example : *.fict.example
17397 .endd
17398 This specifies that messages addressed to a domain that matches the list but
17399 has no MX record should be bounced immediately instead of being routed using
17400 the address record.
17401
17402
17403 .option mx_fail_domains dnslookup "domain list&!!" unset
17404 If the DNS lookup for MX records for one of the domains in this list causes a
17405 DNS lookup error, Exim behaves as if no MX records were found. See section
17406 &<<SECTprowitdnsloo>>& for more discussion.
17407
17408
17409
17410
17411 .option qualify_single dnslookup boolean true
17412 .cindex "DNS" "resolver options"
17413 .cindex "DNS" "qualifying single-component names"
17414 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17415 lookups. Typically, but not standardly, this causes the resolver to qualify
17416 single-component names with the default domain. For example, on a machine
17417 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17418 &'thesaurus.ref.example'& inside the resolver. For details of what your
17419 resolver actually does, consult your man pages for &'resolver'& and
17420 &'resolv.conf'&.
17421
17422
17423
17424 .option rewrite_headers dnslookup boolean true
17425 .cindex "rewriting" "header lines"
17426 .cindex "header lines" "rewriting"
17427 If the domain name in the address that is being processed is not fully
17428 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17429 an address is specified as &'dormouse@teaparty'&, the domain might be
17430 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17431 occur as a result of setting the &%widen_domains%& option. If
17432 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17433 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17434 header lines of the message are rewritten with the full domain name.
17435
17436 This option should be turned off only when it is known that no message is
17437 ever going to be sent outside an environment where the abbreviation makes
17438 sense.
17439
17440 When an MX record is looked up in the DNS and matches a wildcard record, name
17441 servers normally return a record containing the name that has been looked up,
17442 making it impossible to detect whether a wildcard was present or not. However,
17443 some name servers have recently been seen to return the wildcard entry. If the
17444 name returned by a DNS lookup begins with an asterisk, it is not used for
17445 header rewriting.
17446
17447
17448 .option same_domain_copy_routing dnslookup boolean false
17449 .cindex "address" "copying routing"
17450 Addresses with the same domain are normally routed by the &(dnslookup)& router
17451 to the same list of hosts. However, this cannot be presumed, because the router
17452 options and preconditions may refer to the local part of the address. By
17453 default, therefore, Exim routes each address in a message independently. DNS
17454 servers run caches, so repeated DNS lookups are not normally expensive, and in
17455 any case, personal messages rarely have more than a few recipients.
17456
17457 If you are running mailing lists with large numbers of subscribers at the same
17458 domain, and you are using a &(dnslookup)& router which is independent of the
17459 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17460 lookups for identical domains in one message. In this case, when &(dnslookup)&
17461 routes an address to a remote transport, any other unrouted addresses in the
17462 message that have the same domain are automatically given the same routing
17463 without processing them independently,
17464 provided the following conditions are met:
17465
17466 .ilist
17467 No router that processed the address specified &%headers_add%& or
17468 &%headers_remove%&.
17469 .next
17470 The router did not change the address in any way, for example, by &"widening"&
17471 the domain.
17472 .endlist
17473
17474
17475
17476
17477 .option search_parents dnslookup boolean false
17478 .cindex "DNS" "resolver options"
17479 When this option is true, the resolver option RES_DNSRCH is set for DNS
17480 lookups. This is different from the &%qualify_single%& option in that it
17481 applies to domains containing dots. Typically, but not standardly, it causes
17482 the resolver to search for the name in the current domain and in parent
17483 domains. For example, on a machine in the &'fict.example'& domain, if looking
17484 up &'teaparty.wonderland'& failed, the resolver would try
17485 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17486 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17487
17488 Setting this option true can cause problems in domains that have a wildcard MX
17489 record, because any domain that does not have its own MX record matches the
17490 local wildcard.
17491
17492
17493
17494 .option srv_fail_domains dnslookup "domain list&!!" unset
17495 If the DNS lookup for SRV records for one of the domains in this list causes a
17496 DNS lookup error, Exim behaves as if no SRV records were found. See section
17497 &<<SECTprowitdnsloo>>& for more discussion.
17498
17499
17500
17501
17502 .option widen_domains dnslookup "string list" unset
17503 .cindex "domain" "partial; widening"
17504 If a DNS lookup fails and this option is set, each of its strings in turn is
17505 added onto the end of the domain, and the lookup is tried again. For example,
17506 if
17507 .code
17508 widen_domains = fict.example:ref.example
17509 .endd
17510 is set and a lookup of &'klingon.dictionary'& fails,
17511 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17512 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17513 and &%search_parents%& options can cause some widening to be undertaken inside
17514 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17515 when verifying, unless &%rewrite_headers%& is false (not the default).
17516
17517
17518 .section "Effect of qualify_single and search_parents" "SECID119"
17519 When a domain from an envelope recipient is changed by the resolver as a result
17520 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17521 corresponding address in the message's header lines unless &%rewrite_headers%&
17522 is set false. Exim then re-routes the address, using the full domain.
17523
17524 These two options affect only the DNS lookup that takes place inside the router
17525 for the domain of the address that is being routed. They do not affect lookups
17526 such as that implied by
17527 .code
17528 domains = @mx_any
17529 .endd
17530 that may happen while processing a router precondition before the router is
17531 entered. No widening ever takes place for these lookups.
17532 .ecindex IIDdnsrou1
17533 .ecindex IIDdnsrou2
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543 . ////////////////////////////////////////////////////////////////////////////
17544 . ////////////////////////////////////////////////////////////////////////////
17545
17546 .chapter "The ipliteral router" "CHID5"
17547 .cindex "&(ipliteral)& router"
17548 .cindex "domain literal" "routing"
17549 .cindex "routers" "&(ipliteral)&"
17550 This router has no private options. Unless it is being used purely for
17551 verification (see &%verify_only%&) a transport is required to be defined by the
17552 generic &%transport%& option. The router accepts the address if its domain part
17553 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17554 router handles the address
17555 .code
17556 root@[192.168.1.1]
17557 .endd
17558 by setting up delivery to the host with that IP address. IPv4 domain literals
17559 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17560 are similar, but the address is preceded by &`ipv6:`&. For example:
17561 .code
17562 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17563 .endd
17564 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17565 grounds that sooner or later somebody will try it.
17566
17567 .oindex "&%self%&" "in &(ipliteral)& router"
17568 If the IP address matches something in &%ignore_target_hosts%&, the router
17569 declines. If an IP literal turns out to refer to the local host, the generic
17570 &%self%& option determines what happens.
17571
17572 The RFCs require support for domain literals; however, their use is
17573 controversial in today's Internet. If you want to use this router, you must
17574 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17575 Exim will not recognize the domain literal syntax in addresses.
17576
17577
17578
17579 . ////////////////////////////////////////////////////////////////////////////
17580 . ////////////////////////////////////////////////////////////////////////////
17581
17582 .chapter "The iplookup router" "CHID6"
17583 .cindex "&(iplookup)& router"
17584 .cindex "routers" "&(iplookup)&"
17585 The &(iplookup)& router was written to fulfil a specific requirement in
17586 Cambridge University (which in fact no longer exists). For this reason, it is
17587 not included in the binary of Exim by default. If you want to include it, you
17588 must set
17589 .code
17590 ROUTER_IPLOOKUP=yes
17591 .endd
17592 in your &_Local/Makefile_& configuration file.
17593
17594 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17595 connection to one or more specific hosts. The host can then return the same or
17596 a different address &-- in effect rewriting the recipient address in the
17597 message's envelope. The new address is then passed on to subsequent routers. If
17598 this process fails, the address can be passed on to other routers, or delivery
17599 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17600 must not be specified for it.
17601
17602 .cindex "options" "&(iplookup)& router"
17603 .option hosts iplookup string unset
17604 This option must be supplied. Its value is a colon-separated list of host
17605 names. The hosts are looked up using &[gethostbyname()]&
17606 (or &[getipnodebyname()]& when available)
17607 and are tried in order until one responds to the query. If none respond, what
17608 happens is controlled by &%optional%&.
17609
17610
17611 .option optional iplookup boolean false
17612 If &%optional%& is true, if no response is obtained from any host, the address
17613 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17614 delivery to the address is deferred.
17615
17616
17617 .option port iplookup integer 0
17618 .cindex "port" "&(iplookup)& router"
17619 This option must be supplied. It specifies the port number for the TCP or UDP
17620 call.
17621
17622
17623 .option protocol iplookup string udp
17624 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17625 protocols is to be used.
17626
17627
17628 .option query iplookup string&!! "see below"
17629 This defines the content of the query that is sent to the remote hosts. The
17630 default value is:
17631 .code
17632 $local_part@$domain $local_part@$domain
17633 .endd
17634 The repetition serves as a way of checking that a response is to the correct
17635 query in the default case (see &%response_pattern%& below).
17636
17637
17638 .option reroute iplookup string&!! unset
17639 If this option is not set, the rerouted address is precisely the byte string
17640 returned by the remote host, up to the first white space, if any. If set, the
17641 string is expanded to form the rerouted address. It can include parts matched
17642 in the response by &%response_pattern%& by means of numeric variables such as
17643 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17644 whether or not a pattern is in use. In all cases, the rerouted address must end
17645 up in the form &'local_part@domain'&.
17646
17647
17648 .option response_pattern iplookup string unset
17649 This option can be set to a regular expression that is applied to the string
17650 returned from the remote host. If the pattern does not match the response, the
17651 router declines. If &%response_pattern%& is not set, no checking of the
17652 response is done, unless the query was defaulted, in which case there is a
17653 check that the text returned after the first white space is the original
17654 address. This checks that the answer that has been received is in response to
17655 the correct question. For example, if the response is just a new domain, the
17656 following could be used:
17657 .code
17658 response_pattern = ^([^@]+)$
17659 reroute = $local_part@$1
17660 .endd
17661
17662 .option timeout iplookup time 5s
17663 This specifies the amount of time to wait for a response from the remote
17664 machine. The same timeout is used for the &[connect()]& function for a TCP
17665 call. It does not apply to UDP.
17666
17667
17668
17669
17670 . ////////////////////////////////////////////////////////////////////////////
17671 . ////////////////////////////////////////////////////////////////////////////
17672
17673 .chapter "The manualroute router" "CHID7"
17674 .scindex IIDmanrou1 "&(manualroute)& router"
17675 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17676 .cindex "domain" "manually routing"
17677 The &(manualroute)& router is so-called because it provides a way of manually
17678 routing an address according to its domain. It is mainly used when you want to
17679 route addresses to remote hosts according to your own rules, bypassing the
17680 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17681 route to local transports, a facility that may be useful if you want to save
17682 messages for dial-in hosts in local files.
17683
17684 The &(manualroute)& router compares a list of domain patterns with the domain
17685 it is trying to route. If there is no match, the router declines. Each pattern
17686 has associated with it a list of hosts and some other optional data, which may
17687 include a transport. The combination of a pattern and its data is called a
17688 &"routing rule"&. For patterns that do not have an associated transport, the
17689 generic &%transport%& option must specify a transport, unless the router is
17690 being used purely for verification (see &%verify_only%&).
17691
17692 .vindex "&$host$&"
17693 In the case of verification, matching the domain pattern is sufficient for the
17694 router to accept the address. When actually routing an address for delivery,
17695 an address that matches a domain pattern is queued for the associated
17696 transport. If the transport is not a local one, a host list must be associated
17697 with the pattern; IP addresses are looked up for the hosts, and these are
17698 passed to the transport along with the mail address. For local transports, a
17699 host list is optional. If it is present, it is passed in &$host$& as a single
17700 text string.
17701
17702 The list of routing rules can be provided as an inline string in
17703 &%route_list%&, or the data can be obtained by looking up the domain in a file
17704 or database by setting &%route_data%&. Only one of these settings may appear in
17705 any one instance of &(manualroute)&. The format of routing rules is described
17706 below, following the list of private options.
17707
17708
17709 .section "Private options for manualroute" "SECTprioptman"
17710
17711 .cindex "options" "&(manualroute)& router"
17712 The private options for the &(manualroute)& router are as follows:
17713
17714 .option host_all_ignored manualroute string defer
17715 See &%host_find_failed%&.
17716
17717 .option host_find_failed manualroute string freeze
17718 This option controls what happens when &(manualroute)& tries to find an IP
17719 address for a host, and the host does not exist. The option can be set to one
17720 of the following values:
17721 .code
17722 decline
17723 defer
17724 fail
17725 freeze
17726 ignore
17727 pass
17728 .endd
17729 The default (&"freeze"&) assumes that this state is a serious configuration
17730 error. The difference between &"pass"& and &"decline"& is that the former
17731 forces the address to be passed to the next router (or the router defined by
17732 &%pass_router%&),
17733 .oindex "&%more%&"
17734 overriding &%no_more%&, whereas the latter passes the address to the next
17735 router only if &%more%& is true.
17736
17737 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17738 cannot be found. If all the hosts in the list are ignored, the behaviour is
17739 controlled by the &%host_all_ignored%& option. This takes the same values
17740 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17741
17742 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17743 state; if a host lookup gets a temporary error, delivery is deferred unless the
17744 generic &%pass_on_timeout%& option is set.
17745
17746
17747 .option hosts_randomize manualroute boolean false
17748 .cindex "randomized host list"
17749 .cindex "host" "list of; randomized"
17750 If this option is set, the order of the items in a host list in a routing rule
17751 is randomized each time the list is used, unless an option in the routing rule
17752 overrides (see below). Randomizing the order of a host list can be used to do
17753 crude load sharing. However, if more than one mail address is routed by the
17754 same router to the same host list, the host lists are considered to be the same
17755 (even though they may be randomized into different orders) for the purpose of
17756 deciding whether to batch the deliveries into a single SMTP transaction.
17757
17758 When &%hosts_randomize%& is true, a host list may be split
17759 into groups whose order is separately randomized. This makes it possible to
17760 set up MX-like behaviour. The boundaries between groups are indicated by an
17761 item that is just &`+`& in the host list. For example:
17762 .code
17763 route_list = * host1:host2:host3:+:host4:host5
17764 .endd
17765 The order of the first three hosts and the order of the last two hosts is
17766 randomized for each use, but the first three always end up before the last two.
17767 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17768 randomized host list is passed to an &(smtp)& transport that also has
17769 &%hosts_randomize set%&, the list is not re-randomized.
17770
17771
17772 .option route_data manualroute string&!! unset
17773 If this option is set, it must expand to yield the data part of a routing rule.
17774 Typically, the expansion string includes a lookup based on the domain. For
17775 example:
17776 .code
17777 route_data = ${lookup{$domain}dbm{/etc/routes}}
17778 .endd
17779 If the expansion is forced to fail, or the result is an empty string, the
17780 router declines. Other kinds of expansion failure cause delivery to be
17781 deferred.
17782
17783
17784 .option route_list manualroute "string list" unset
17785 This string is a list of routing rules, in the form defined below. Note that,
17786 unlike most string lists, the items are separated by semicolons. This is so
17787 that they may contain colon-separated host lists.
17788
17789
17790 .option same_domain_copy_routing manualroute boolean false
17791 .cindex "address" "copying routing"
17792 Addresses with the same domain are normally routed by the &(manualroute)&
17793 router to the same list of hosts. However, this cannot be presumed, because the
17794 router options and preconditions may refer to the local part of the address. By
17795 default, therefore, Exim routes each address in a message independently. DNS
17796 servers run caches, so repeated DNS lookups are not normally expensive, and in
17797 any case, personal messages rarely have more than a few recipients.
17798
17799 If you are running mailing lists with large numbers of subscribers at the same
17800 domain, and you are using a &(manualroute)& router which is independent of the
17801 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17802 lookups for identical domains in one message. In this case, when
17803 &(manualroute)& routes an address to a remote transport, any other unrouted
17804 addresses in the message that have the same domain are automatically given the
17805 same routing without processing them independently. However, this is only done
17806 if &%headers_add%& and &%headers_remove%& are unset.
17807
17808
17809
17810
17811 .section "Routing rules in route_list" "SECID120"
17812 The value of &%route_list%& is a string consisting of a sequence of routing
17813 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17814 entered as two semicolons. Alternatively, the list separator can be changed as
17815 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17816 Empty rules are ignored. The format of each rule is
17817 .display
17818 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17819 .endd
17820 The following example contains two rules, each with a simple domain pattern and
17821 no options:
17822 .code
17823 route_list = \
17824   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17825   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17826 .endd
17827 The three parts of a rule are separated by white space. The pattern and the
17828 list of hosts can be enclosed in quotes if necessary, and if they are, the
17829 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17830 single domain pattern, which is the only mandatory item in the rule. The
17831 pattern is in the same format as one item in a domain list (see section
17832 &<<SECTdomainlist>>&),
17833 except that it may not be the name of an interpolated file.
17834 That is, it may be wildcarded, or a regular expression, or a file or database
17835 lookup (with semicolons doubled, because of the use of semicolon as a separator
17836 in a &%route_list%&).
17837
17838 The rules in &%route_list%& are searched in order until one of the patterns
17839 matches the domain that is being routed. The list of hosts and then options are
17840 then used as described below. If there is no match, the router declines. When
17841 &%route_list%& is set, &%route_data%& must not be set.
17842
17843
17844
17845 .section "Routing rules in route_data" "SECID121"
17846 The use of &%route_list%& is convenient when there are only a small number of
17847 routing rules. For larger numbers, it is easier to use a file or database to
17848 hold the routing information, and use the &%route_data%& option instead.
17849 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17850 Most commonly, &%route_data%& is set as a string that contains an
17851 expansion lookup. For example, suppose we place two routing rules in a file
17852 like this:
17853 .code
17854 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17855 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17856 .endd
17857 This data can be accessed by setting
17858 .code
17859 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17860 .endd
17861 Failure of the lookup results in an empty string, causing the router to
17862 decline. However, you do not have to use a lookup in &%route_data%&. The only
17863 requirement is that the result of expanding the string is a list of hosts,
17864 possibly followed by options, separated by white space. The list of hosts must
17865 be enclosed in quotes if it contains white space.
17866
17867
17868
17869
17870 .section "Format of the list of hosts" "SECID122"
17871 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17872 always separately expanded before use. If the expansion fails, the router
17873 declines. The result of the expansion must be a colon-separated list of names
17874 and/or IP addresses, optionally also including ports. The format of each item
17875 in the list is described in the next section. The list separator can be changed
17876 as described in section &<<SECTlistconstruct>>&.
17877
17878 If the list of hosts was obtained from a &%route_list%& item, the following
17879 variables are set during its expansion:
17880
17881 .ilist
17882 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17883 If the domain was matched against a regular expression, the numeric variables
17884 &$1$&, &$2$&, etc. may be set. For example:
17885 .code
17886 route_list = ^domain(\d+)   host-$1.text.example
17887 .endd
17888 .next
17889 &$0$& is always set to the entire domain.
17890 .next
17891 &$1$& is also set when partial matching is done in a file lookup.
17892
17893 .next
17894 .vindex "&$value$&"
17895 If the pattern that matched the domain was a lookup item, the data that was
17896 looked up is available in the expansion variable &$value$&. For example:
17897 .code
17898 route_list = lsearch;;/some/file.routes  $value
17899 .endd
17900 .endlist
17901
17902 Note the doubling of the semicolon in the pattern that is necessary because
17903 semicolon is the default route list separator.
17904
17905
17906
17907 .section "Format of one host item" "SECTformatonehostitem"
17908 Each item in the list of hosts is either a host name or an IP address,
17909 optionally with an attached port number. When no port is given, an IP address
17910 is not enclosed in brackets. When a port is specified, it overrides the port
17911 specification on the transport. The port is separated from the name or address
17912 by a colon. This leads to some complications:
17913
17914 .ilist
17915 Because colon is the default separator for the list of hosts, either
17916 the colon that specifies a port must be doubled, or the list separator must
17917 be changed. The following two examples have the same effect:
17918 .code
17919 route_list = * "host1.tld::1225 : host2.tld::1226"
17920 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17921 .endd
17922 .next
17923 When IPv6 addresses are involved, it gets worse, because they contain
17924 colons of their own. To make this case easier, it is permitted to
17925 enclose an IP address (either v4 or v6) in square brackets if a port
17926 number follows. For example:
17927 .code
17928 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17929 .endd
17930 .endlist
17931
17932 .section "How the list of hosts is used" "SECThostshowused"
17933 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17934 the hosts is tried, in the order specified, when carrying out the SMTP
17935 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17936 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17937 transport.
17938
17939 Hosts may be listed by name or by IP address. An unadorned name in the list of
17940 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17941 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17942 records in the DNS. For example:
17943 .code
17944 route_list = *  x.y.z:p.q.r/MX:e.f.g
17945 .endd
17946 If this feature is used with a port specifier, the port must come last. For
17947 example:
17948 .code
17949 route_list = *  dom1.tld/mx::1225
17950 .endd
17951 If the &%hosts_randomize%& option is set, the order of the items in the list is
17952 randomized before any lookups are done. Exim then scans the list; for any name
17953 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17954 be an interface on the local host and the item is not the first in the list,
17955 Exim discards it and any subsequent items. If it is the first item, what
17956 happens is controlled by the
17957 .oindex "&%self%&" "in &(manualroute)& router"
17958 &%self%& option of the router.
17959
17960 A name on the list that is followed by &`/MX`& is replaced with the list of
17961 hosts obtained by looking up MX records for the name. This is always a DNS
17962 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17963 below) are not relevant here. The order of these hosts is determined by the
17964 preference values in the MX records, according to the usual rules. Because
17965 randomizing happens before the MX lookup, it does not affect the order that is
17966 defined by MX preferences.
17967
17968 If the local host is present in the sublist obtained from MX records, but is
17969 not the most preferred host in that list, it and any equally or less
17970 preferred hosts are removed before the sublist is inserted into the main list.
17971
17972 If the local host is the most preferred host in the MX list, what happens
17973 depends on where in the original list of hosts the &`/MX`& item appears. If it
17974 is not the first item (that is, there are previous hosts in the main list),
17975 Exim discards this name and any subsequent items in the main list.
17976
17977 If the MX item is first in the list of hosts, and the local host is the
17978 most preferred host, what happens is controlled by the &%self%& option of the
17979 router.
17980
17981 DNS failures when lookup up the MX records are treated in the same way as DNS
17982 failures when looking up IP addresses: &%pass_on_timeout%& and
17983 &%host_find_failed%& are used when relevant.
17984
17985 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17986 whether obtained from an MX lookup or not.
17987
17988
17989
17990 .section "How the options are used" "SECThowoptused"
17991 The options are a sequence of words; in practice no more than three are ever
17992 present. One of the words can be the name of a transport; this overrides the
17993 &%transport%& option on the router for this particular routing rule only. The
17994 other words (if present) control randomization of the list of hosts on a
17995 per-rule basis, and how the IP addresses of the hosts are to be found when
17996 routing to a remote transport. These options are as follows:
17997
17998 .ilist
17999 &%randomize%&: randomize the order of the hosts in this list, overriding the
18000 setting of &%hosts_randomize%& for this routing rule only.
18001 .next
18002 &%no_randomize%&: do not randomize the order of the hosts in this list,
18003 overriding the setting of &%hosts_randomize%& for this routing rule only.
18004 .next
18005 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18006 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18007 also look in &_/etc/hosts_& or other sources of information.
18008 .next
18009 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18010 no address records are found. If there is a temporary DNS error (such as a
18011 timeout), delivery is deferred.
18012 .endlist
18013
18014 For example:
18015 .code
18016 route_list = domain1  host1:host2:host3  randomize bydns;\
18017              domain2  host4:host5
18018 .endd
18019 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18020 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18021 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18022 or &[gethostbyname()]&, and the result of the lookup is the result of that
18023 call.
18024
18025 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18026 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18027 instead of TRY_AGAIN. That is why the default action is to try a DNS
18028 lookup first. Only if that gives a definite &"no such host"& is the local
18029 function called.
18030
18031
18032
18033 If no IP address for a host can be found, what happens is controlled by the
18034 &%host_find_failed%& option.
18035
18036 .vindex "&$host$&"
18037 When an address is routed to a local transport, IP addresses are not looked up.
18038 The host list is passed to the transport in the &$host$& variable.
18039
18040
18041
18042 .section "Manualroute examples" "SECID123"
18043 In some of the examples that follow, the presence of the &%remote_smtp%&
18044 transport, as defined in the default configuration file, is assumed:
18045
18046 .ilist
18047 .cindex "smart host" "example router"
18048 The &(manualroute)& router can be used to forward all external mail to a
18049 &'smart host'&. If you have set up, in the main part of the configuration, a
18050 named domain list that contains your local domains, for example:
18051 .code
18052 domainlist local_domains = my.domain.example
18053 .endd
18054 You can arrange for all other domains to be routed to a smart host by making
18055 your first router something like this:
18056 .code
18057 smart_route:
18058   driver = manualroute
18059   domains = !+local_domains
18060   transport = remote_smtp
18061   route_list = * smarthost.ref.example
18062 .endd
18063 This causes all non-local addresses to be sent to the single host
18064 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18065 they are tried in order
18066 (but you can use &%hosts_randomize%& to vary the order each time).
18067 Another way of configuring the same thing is this:
18068 .code
18069 smart_route:
18070   driver = manualroute
18071   transport = remote_smtp
18072   route_list = !+local_domains  smarthost.ref.example
18073 .endd
18074 There is no difference in behaviour between these two routers as they stand.
18075 However, they behave differently if &%no_more%& is added to them. In the first
18076 example, the router is skipped if the domain does not match the &%domains%&
18077 precondition; the following router is always tried. If the router runs, it
18078 always matches the domain and so can never decline. Therefore, &%no_more%&
18079 would have no effect. In the second case, the router is never skipped; it
18080 always runs. However, if it doesn't match the domain, it declines. In this case
18081 &%no_more%& would prevent subsequent routers from running.
18082
18083 .next
18084 .cindex "mail hub example"
18085 A &'mail hub'& is a host which receives mail for a number of domains via MX
18086 records in the DNS and delivers it via its own private routing mechanism. Often
18087 the final destinations are behind a firewall, with the mail hub being the one
18088 machine that can connect to machines both inside and outside the firewall. The
18089 &(manualroute)& router is usually used on a mail hub to route incoming messages
18090 to the correct hosts. For a small number of domains, the routing can be inline,
18091 using the &%route_list%& option, but for a larger number a file or database
18092 lookup is easier to manage.
18093
18094 If the domain names are in fact the names of the machines to which the mail is
18095 to be sent by the mail hub, the configuration can be quite simple. For
18096 example:
18097 .code
18098 hub_route:
18099   driver = manualroute
18100   transport = remote_smtp
18101   route_list = *.rhodes.tvs.example  $domain
18102 .endd
18103 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18104 whose names are the same as the mail domains. A similar approach can be taken
18105 if the host name can be obtained from the domain name by a string manipulation
18106 that the expansion facilities can handle. Otherwise, a lookup based on the
18107 domain can be used to find the host:
18108 .code
18109 through_firewall:
18110   driver = manualroute
18111   transport = remote_smtp
18112   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18113 .endd
18114 The result of the lookup must be the name or IP address of the host (or
18115 hosts) to which the address is to be routed. If the lookup fails, the route
18116 data is empty, causing the router to decline. The address then passes to the
18117 next router.
18118
18119 .next
18120 .cindex "batched SMTP output example"
18121 .cindex "SMTP" "batched outgoing; example"
18122 You can use &(manualroute)& to deliver messages to pipes or files in batched
18123 SMTP format for onward transportation by some other means. This is one way of
18124 storing mail for a dial-up host when it is not connected. The route list entry
18125 can be as simple as a single domain name in a configuration like this:
18126 .code
18127 save_in_file:
18128   driver = manualroute
18129   transport = batchsmtp_appendfile
18130   route_list = saved.domain.example
18131 .endd
18132 though often a pattern is used to pick up more than one domain. If there are
18133 several domains or groups of domains with different transport requirements,
18134 different transports can be listed in the routing information:
18135 .code
18136 save_in_file:
18137   driver = manualroute
18138   route_list = \
18139     *.saved.domain1.example  $domain  batch_appendfile; \
18140     *.saved.domain2.example  \
18141       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18142       batch_pipe
18143 .endd
18144 .vindex "&$domain$&"
18145 .vindex "&$host$&"
18146 The first of these just passes the domain in the &$host$& variable, which
18147 doesn't achieve much (since it is also in &$domain$&), but the second does a
18148 file lookup to find a value to pass, causing the router to decline to handle
18149 the address if the lookup fails.
18150
18151 .next
18152 .cindex "UUCP" "example of router for"
18153 Routing mail directly to UUCP software is a specific case of the use of
18154 &(manualroute)& in a gateway to another mail environment. This is an example of
18155 one way it can be done:
18156 .code
18157 # Transport
18158 uucp:
18159   driver = pipe
18160   user = nobody
18161   command = /usr/local/bin/uux -r - \
18162     ${substr_-5:$host}!rmail ${local_part}
18163   return_fail_output = true
18164
18165 # Router
18166 uucphost:
18167   transport = uucp
18168   driver = manualroute
18169   route_data = \
18170     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18171 .endd
18172 The file &_/usr/local/exim/uucphosts_& contains entries like
18173 .code
18174 darksite.ethereal.example:           darksite.UUCP
18175 .endd
18176 It can be set up more simply without adding and removing &".UUCP"& but this way
18177 makes clear the distinction between the domain name
18178 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18179 .endlist
18180 .ecindex IIDmanrou1
18181 .ecindex IIDmanrou2
18182
18183
18184
18185
18186
18187
18188
18189
18190 . ////////////////////////////////////////////////////////////////////////////
18191 . ////////////////////////////////////////////////////////////////////////////
18192
18193 .chapter "The queryprogram router" "CHAPdriverlast"
18194 .scindex IIDquerou1 "&(queryprogram)& router"
18195 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18196 .cindex "routing" "by external program"
18197 The &(queryprogram)& router routes an address by running an external command
18198 and acting on its output. This is an expensive way to route, and is intended
18199 mainly for use in lightly-loaded systems, or for performing experiments.
18200 However, if it is possible to use the precondition options (&%domains%&,
18201 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18202 be used in special cases, even on a busy host. There are the following private
18203 options:
18204 .cindex "options" "&(queryprogram)& router"
18205
18206 .option command queryprogram string&!! unset
18207 This option must be set. It specifies the command that is to be run. The
18208 command is split up into a command name and arguments, and then each is
18209 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18210 &<<CHAPpipetransport>>&).
18211
18212
18213 .option command_group queryprogram string unset
18214 .cindex "gid (group id)" "in &(queryprogram)& router"
18215 This option specifies a gid to be set when running the command while routing an
18216 address for deliver. It must be set if &%command_user%& specifies a numerical
18217 uid. If it begins with a digit, it is interpreted as the numerical value of the
18218 gid. Otherwise it is looked up using &[getgrnam()]&.
18219
18220
18221 .option command_user queryprogram string unset
18222 .cindex "uid (user id)" "for &(queryprogram)&"
18223 This option must be set. It specifies the uid which is set when running the
18224 command while routing an address for delivery. If the value begins with a digit,
18225 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18226 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18227 not set, a value for the gid also.
18228
18229 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18230 root, which it does during a normal delivery in a conventional configuration.
18231 However, when an address is being verified during message reception, Exim is
18232 usually running as the Exim user, not as root. If the &(queryprogram)& router
18233 is called from a non-root process, Exim cannot change uid or gid before running
18234 the command. In this circumstance the command runs under the current uid and
18235 gid.
18236
18237
18238 .option current_directory queryprogram string /
18239 This option specifies an absolute path which is made the current directory
18240 before running the command.
18241
18242
18243 .option timeout queryprogram time 1h
18244 If the command does not complete within the timeout period, its process group
18245 is killed and the message is frozen. A value of zero time specifies no
18246 timeout.
18247
18248
18249 The standard output of the command is connected to a pipe, which is read when
18250 the command terminates. It should consist of a single line of output,
18251 containing up to five fields, separated by white space. The maximum length of
18252 the line is 1023 characters. Longer lines are silently truncated. The first
18253 field is one of the following words (case-insensitive):
18254
18255 .ilist
18256 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18257 below).
18258 .next
18259 &'Decline'&: the router declines; pass the address to the next router, unless
18260 &%no_more%& is set.
18261 .next
18262 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18263 subsequent text on the line is an error message. If the router is run as part
18264 of address verification during an incoming SMTP message, the message is
18265 included in the SMTP response.
18266 .next
18267 &'Defer'&: routing could not be completed at this time; try again later. Any
18268 subsequent text on the line is an error message which is logged. It is not
18269 included in any SMTP response.
18270 .next
18271 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18272 .next
18273 &'Pass'&: pass the address to the next router (or the router specified by
18274 &%pass_router%&), overriding &%no_more%&.
18275 .next
18276 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18277 new addresses, which are routed independently, starting with the first router,
18278 or the router specified by &%redirect_router%&, if set.
18279 .endlist
18280
18281 When the first word is &'accept'&, the remainder of the line consists of a
18282 number of keyed data values, as follows (split into two lines here, to fit on
18283 the page):
18284 .code
18285 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18286 LOOKUP=byname|bydns DATA=<text>
18287 .endd
18288 The data items can be given in any order, and all are optional. If no transport
18289 is included, the transport specified by the generic &%transport%& option is
18290 used. The list of hosts and the lookup type are needed only if the transport is
18291 an &(smtp)& transport that does not itself supply a list of hosts.
18292
18293 The format of the list of hosts is the same as for the &(manualroute)& router.
18294 As well as host names and IP addresses with optional port numbers, as described
18295 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18296 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18297 (see section &<<SECThostshowused>>&).
18298
18299 If the lookup type is not specified, Exim behaves as follows when trying to
18300 find an IP address for each host: First, a DNS lookup is done. If this yields
18301 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18302 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18303 result of the lookup is the result of that call.
18304
18305 .vindex "&$address_data$&"
18306 If the DATA field is set, its value is placed in the &$address_data$&
18307 variable. For example, this return line
18308 .code
18309 accept hosts=x1.y.example:x2.y.example data="rule1"
18310 .endd
18311 routes the address to the default transport, passing a list of two hosts. When
18312 the transport runs, the string &"rule1"& is in &$address_data$&.
18313 .ecindex IIDquerou1
18314 .ecindex IIDquerou2
18315
18316
18317
18318
18319 . ////////////////////////////////////////////////////////////////////////////
18320 . ////////////////////////////////////////////////////////////////////////////
18321
18322 .chapter "The redirect router" "CHAPredirect"
18323 .scindex IIDredrou1 "&(redirect)& router"
18324 .scindex IIDredrou2 "routers" "&(redirect)&"
18325 .cindex "alias file" "in a &(redirect)& router"
18326 .cindex "address redirection" "&(redirect)& router"
18327 The &(redirect)& router handles several kinds of address redirection. Its most
18328 common uses are for resolving local part aliases from a central alias file
18329 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18330 files, but it has many other potential uses. The incoming address can be
18331 redirected in several different ways:
18332
18333 .ilist
18334 It can be replaced by one or more new addresses which are themselves routed
18335 independently.
18336 .next
18337 It can be routed to be delivered to a given file or directory.
18338 .next
18339 It can be routed to be delivered to a specified pipe command.
18340 .next
18341 It can cause an automatic reply to be generated.
18342 .next
18343 It can be forced to fail, optionally with a custom error message.
18344 .next
18345 It can be temporarily deferred, optionally with a custom message.
18346 .next
18347 It can be discarded.
18348 .endlist
18349
18350 The generic &%transport%& option must not be set for &(redirect)& routers.
18351 However, there are some private options which define transports for delivery to
18352 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18353 &%pipe_transport%& and &%reply_transport%& descriptions below.
18354
18355
18356
18357 .section "Redirection data" "SECID124"
18358 The router operates by interpreting a text string which it obtains either by
18359 expanding the contents of the &%data%& option, or by reading the entire
18360 contents of a file whose name is given in the &%file%& option. These two
18361 options are mutually exclusive. The first is commonly used for handling system
18362 aliases, in a configuration like this:
18363 .code
18364 system_aliases:
18365   driver = redirect
18366   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18367 .endd
18368 If the lookup fails, the expanded string in this example is empty. When the
18369 expansion of &%data%& results in an empty string, the router declines. A forced
18370 expansion failure also causes the router to decline; other expansion failures
18371 cause delivery to be deferred.
18372
18373 A configuration using &%file%& is commonly used for handling users'
18374 &_.forward_& files, like this:
18375 .code
18376 userforward:
18377   driver = redirect
18378   check_local_user
18379   file = $home/.forward
18380   no_verify
18381 .endd
18382 If the file does not exist, or causes no action to be taken (for example, it is
18383 empty or consists only of comments), the router declines. &*Warning*&: This
18384 is not the case when the file contains syntactically valid items that happen to
18385 yield empty addresses, for example, items containing only RFC 2822 address
18386 comments.
18387
18388
18389
18390 .section "Forward files and address verification" "SECID125"
18391 .cindex "address redirection" "while verifying"
18392 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18393 &_.forward_& files, as in the example above. There are two reasons for this:
18394
18395 .ilist
18396 When Exim is receiving an incoming SMTP message from a remote host, it is
18397 running under the Exim uid, not as root. Exim is unable to change uid to read
18398 the file as the user, and it may not be able to read it as the Exim user. So in
18399 practice the router may not be able to operate.
18400 .next
18401 However, even when the router can operate, the existence of a &_.forward_& file
18402 is unimportant when verifying an address. What should be checked is whether the
18403 local part is a valid user name or not. Cutting out the redirection processing
18404 saves some resources.
18405 .endlist
18406
18407
18408
18409
18410
18411
18412 .section "Interpreting redirection data" "SECID126"
18413 .cindex "Sieve filter" "specifying in redirection data"
18414 .cindex "filter" "specifying in redirection data"
18415 The contents of the data string, whether obtained from &%data%& or &%file%&,
18416 can be interpreted in two different ways:
18417
18418 .ilist
18419 If the &%allow_filter%& option is set true, and the data begins with the text
18420 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18421 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18422 respectively. Details of the syntax and semantics of filter files are described
18423 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18424 document is intended for use by end users.
18425 .next
18426 Otherwise, the data must be a comma-separated list of redirection items, as
18427 described in the next section.
18428 .endlist
18429
18430 When a message is redirected to a file (a &"mail folder"&), the file name given
18431 in a non-filter redirection list must always be an absolute path. A filter may
18432 generate a relative path &-- how this is handled depends on the transport's
18433 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18434 for the &(appendfile)& transport.
18435
18436
18437
18438 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18439 .cindex "address redirection" "non-filter list items"
18440 When the redirection data is not an Exim or Sieve filter, for example, if it
18441 comes from a conventional alias or forward file, it consists of a list of
18442 addresses, file names, pipe commands, or certain special items (see section
18443 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18444 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18445 depending on their default values. The items in the list are separated by
18446 commas or newlines.
18447 If a comma is required in an item, the entire item must be enclosed in double
18448 quotes.
18449
18450 Lines starting with a # character are comments, and are ignored, and # may
18451 also appear following a comma, in which case everything between the # and the
18452 next newline character is ignored.
18453
18454 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18455 double quotes are retained because some forms of mail address require their use
18456 (but never to enclose the entire address). In the following description,
18457 &"item"& refers to what remains after any surrounding double quotes have been
18458 removed.
18459
18460 .vindex "&$local_part$&"
18461 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18462 and the expansion contains a reference to &$local_part$&, you should make use
18463 of the &%quote_local_part%& expansion operator, in case the local part contains
18464 special characters. For example, to redirect all mail for the domain
18465 &'obsolete.example'&, retaining the existing local part, you could use this
18466 setting:
18467 .code
18468 data = ${quote_local_part:$local_part}@newdomain.example
18469 .endd
18470
18471
18472 .section "Redirecting to a local mailbox" "SECTredlocmai"
18473 .cindex "routing" "loops in"
18474 .cindex "loop" "while routing, avoidance of"
18475 .cindex "address redirection" "to local mailbox"
18476 A redirection item may safely be the same as the address currently under
18477 consideration. This does not cause a routing loop, because a router is
18478 automatically skipped if any ancestor of the address that is being processed
18479 is the same as the current address and was processed by the current router.
18480 Such an address is therefore passed to the following routers, so it is handled
18481 as if there were no redirection. When making this loop-avoidance test, the
18482 complete local part, including any prefix or suffix, is used.
18483
18484 .cindex "address redirection" "local part without domain"
18485 Specifying the same local part without a domain is a common usage in personal
18486 filter files when the user wants to have messages delivered to the local
18487 mailbox and also forwarded elsewhere. For example, the user whose login is
18488 &'cleo'& might have a &_.forward_& file containing this:
18489 .code
18490 cleo, cleopatra@egypt.example
18491 .endd
18492 .cindex "backslash in alias file"
18493 .cindex "alias file" "backslash in"
18494 For compatibility with other MTAs, such unqualified local parts may be
18495 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18496 it does make a difference if more than one domain is being handled
18497 synonymously.
18498
18499 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18500 2822 address that does not include a domain, the item is qualified using the
18501 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18502 addresses are qualified using the value in &%qualify_recipient%&, but you can
18503 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18504
18505 Care must be taken if there are alias names for local users.
18506 Consider an MTA handling a single local domain where the system alias file
18507 contains:
18508 .code
18509 Sam.Reman: spqr
18510 .endd
18511 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18512 messages in the local mailbox, and also forward copies elsewhere. He creates
18513 this forward file:
18514 .code
18515 Sam.Reman, spqr@reme.elsewhere.example
18516 .endd
18517 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18518 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18519 second time round, because it has previously routed it,
18520 and the following routers presumably cannot handle the alias. The forward file
18521 should really contain
18522 .code
18523 spqr, spqr@reme.elsewhere.example
18524 .endd
18525 but because this is such a common error, the &%check_ancestor%& option (see
18526 below) exists to provide a way to get round it. This is normally set on a
18527 &(redirect)& router that is handling users' &_.forward_& files.
18528
18529
18530
18531 .section "Special items in redirection lists" "SECTspecitredli"
18532 In addition to addresses, the following types of item may appear in redirection
18533 lists (that is, in non-filter redirection data):
18534
18535 .ilist
18536 .cindex "pipe" "in redirection list"
18537 .cindex "address redirection" "to pipe"
18538 An item is treated as a pipe command if it begins with &"|"& and does not parse
18539 as a valid RFC 2822 address that includes a domain. A transport for running the
18540 command must be specified by the &%pipe_transport%& option.
18541 Normally, either the router or the transport specifies a user and a group under
18542 which to run the delivery. The default is to use the Exim user and group.
18543
18544 Single or double quotes can be used for enclosing the individual arguments of
18545 the pipe command; no interpretation of escapes is done for single quotes. If
18546 the command contains a comma character, it is necessary to put the whole item
18547 in double quotes, for example:
18548 .code
18549 "|/some/command ready,steady,go"
18550 .endd
18551 since items in redirection lists are terminated by commas. Do not, however,
18552 quote just the command. An item such as
18553 .code
18554 |"/some/command ready,steady,go"
18555 .endd
18556 is interpreted as a pipe with a rather strange command name, and no arguments.
18557
18558 .new
18559 Note that the above example assumes that the text comes from a lookup source
18560 of some sort, so that the quotes are part of the data.  If composing a
18561 redirect router with a &%data%& option directly specifying this command, the
18562 quotes will be used by the configuration parser to define the extent of one
18563 string, but will not be passed down into the redirect router itself.  There
18564 are two main approaches to get around this: escape quotes to be part of the
18565 data itself, or avoid using this mechanism and instead create a custom
18566 transport with the &%command%& option set and reference that transport from
18567 an &%accept%& router.
18568 .wen
18569
18570 .next
18571 .cindex "file" "in redirection list"
18572 .cindex "address redirection" "to file"
18573 An item is interpreted as a path name if it begins with &"/"& and does not
18574 parse as a valid RFC 2822 address that includes a domain. For example,
18575 .code
18576 /home/world/minbari
18577 .endd
18578 is treated as a file name, but
18579 .code
18580 /s=molari/o=babylon/@x400gate.way
18581 .endd
18582 is treated as an address. For a file name, a transport must be specified using
18583 the &%file_transport%& option. However, if the generated path name ends with a
18584 forward slash character, it is interpreted as a directory name rather than a
18585 file name, and &%directory_transport%& is used instead.
18586
18587 Normally, either the router or the transport specifies a user and a group under
18588 which to run the delivery. The default is to use the Exim user and group.
18589
18590 .cindex "&_/dev/null_&"
18591 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18592 bypassed at a high level, and the log entry shows &"**bypassed**"&
18593 instead of a transport name. In this case the user and group are not used.
18594
18595 .next
18596 .cindex "included address list"
18597 .cindex "address redirection" "included external list"
18598 If an item is of the form
18599 .code
18600 :include:<path name>
18601 .endd
18602 a list of further items is taken from the given file and included at that
18603 point. &*Note*&: Such a file can not be a filter file; it is just an
18604 out-of-line addition to the list. The items in the included list are separated
18605 by commas or newlines and are not subject to expansion. If this is the first
18606 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18607 the alias name. This example is incorrect:
18608 .code
18609 list1    :include:/opt/lists/list1
18610 .endd
18611 It must be given as
18612 .code
18613 list1:   :include:/opt/lists/list1
18614 .endd
18615 .next
18616 .cindex "address redirection" "to black hole"
18617 Sometimes you want to throw away mail to a particular local part. Making the
18618 &%data%& option expand to an empty string does not work, because that causes
18619 the router to decline. Instead, the alias item
18620 .cindex "black hole"
18621 .cindex "abandoning mail"
18622 &':blackhole:'& can be used. It does what its name implies. No delivery is
18623 done, and no error message is generated. This has the same effect as specifing
18624 &_/dev/null_& as a destination, but it can be independently disabled.
18625
18626 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18627 delivery is done for the original local part, even if other redirection items
18628 are present. If you are generating a multi-item list (for example, by reading a
18629 database) and need the ability to provide a no-op item, you must use
18630 &_/dev/null_&.
18631
18632 .next
18633 .cindex "delivery" "forcing failure"
18634 .cindex "delivery" "forcing deferral"
18635 .cindex "failing delivery" "forcing"
18636 .cindex "deferred delivery, forcing"
18637 .cindex "customizing" "failure message"
18638 An attempt to deliver a particular address can be deferred or forced to fail by
18639 redirection items of the form
18640 .code
18641 :defer:
18642 :fail:
18643 .endd
18644 respectively. When a redirection list contains such an item, it applies
18645 to the entire redirection; any other items in the list are ignored. Any
18646 text following &':fail:'& or &':defer:'& is placed in the error text
18647 associated with the failure. For example, an alias file might contain:
18648 .code
18649 X.Employee:  :fail: Gone away, no forwarding address
18650 .endd
18651 In the case of an address that is being verified from an ACL or as the subject
18652 of a
18653 .cindex "VRFY" "error text, display of"
18654 VRFY command, the text is included in the SMTP error response by
18655 default.
18656 .cindex "EXPN" "error text, display of"
18657 The text is not included in the response to an EXPN command. In non-SMTP cases
18658 the text is included in the error message that Exim generates.
18659
18660 .cindex "SMTP" "error codes"
18661 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18662 &':fail:'&. However, if the message starts with three digits followed by a
18663 space, optionally followed by an extended code of the form &'n.n.n'&, also
18664 followed by a space, and the very first digit is the same as the default error
18665 code, the code from the message is used instead. If the very first digit is
18666 incorrect, a panic error is logged, and the default code is used. You can
18667 suppress the use of the supplied code in a redirect router by setting the
18668 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18669 ignored.
18670
18671 .vindex "&$acl_verify_message$&"
18672 In an ACL, an explicitly provided message overrides the default, but the
18673 default message is available in the variable &$acl_verify_message$& and can
18674 therefore be included in a custom message if this is desired.
18675
18676 Normally the error text is the rest of the redirection list &-- a comma does
18677 not terminate it &-- but a newline does act as a terminator. Newlines are not
18678 normally present in alias expansions. In &(lsearch)& lookups they are removed
18679 as part of the continuation process, but they may exist in other kinds of
18680 lookup and in &':include:'& files.
18681
18682 During routing for message delivery (as opposed to verification), a redirection
18683 containing &':fail:'& causes an immediate failure of the incoming address,
18684 whereas &':defer:'& causes the message to remain on the queue so that a
18685 subsequent delivery attempt can happen at a later time. If an address is
18686 deferred for too long, it will ultimately fail, because the normal retry
18687 rules still apply.
18688
18689 .next
18690 .cindex "alias file" "exception to default"
18691 Sometimes it is useful to use a single-key search type with a default (see
18692 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18693 for exceptions to the default. These can be handled by aliasing them to
18694 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18695 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18696 results in an empty redirection list has the same effect.
18697 .endlist
18698
18699
18700 .section "Duplicate addresses" "SECTdupaddr"
18701 .cindex "duplicate addresses"
18702 .cindex "address duplicate, discarding"
18703 .cindex "pipe" "duplicated"
18704 Exim removes duplicate addresses from the list to which it is delivering, so as
18705 to deliver just one copy to each address. This does not apply to deliveries
18706 routed to pipes by different immediate parent addresses, but an indirect
18707 aliasing scheme of the type
18708 .code
18709 pipe:       |/some/command $local_part
18710 localpart1: pipe
18711 localpart2: pipe
18712 .endd
18713 does not work with a message that is addressed to both local parts, because
18714 when the second is aliased to the intermediate local part &"pipe"& it gets
18715 discarded as being the same as a previously handled address. However, a scheme
18716 such as
18717 .code
18718 localpart1: |/some/command $local_part
18719 localpart2: |/some/command $local_part
18720 .endd
18721 does result in two different pipe deliveries, because the immediate parents of
18722 the pipes are distinct.
18723
18724
18725
18726 .section "Repeated redirection expansion" "SECID128"
18727 .cindex "repeated redirection expansion"
18728 .cindex "address redirection" "repeated for each delivery attempt"
18729 When a message cannot be delivered to all of its recipients immediately,
18730 leading to two or more delivery attempts, redirection expansion is carried out
18731 afresh each time for those addresses whose children were not all previously
18732 delivered. If redirection is being used as a mailing list, this can lead to new
18733 members of the list receiving copies of old messages. The &%one_time%& option
18734 can be used to avoid this.
18735
18736
18737 .section "Errors in redirection lists" "SECID129"
18738 .cindex "address redirection" "errors"
18739 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18740 error is skipped, and an entry is written to the main log. This may be useful
18741 for mailing lists that are automatically managed. Otherwise, if an error is
18742 detected while generating the list of new addresses, the original address is
18743 deferred. See also &%syntax_errors_to%&.
18744
18745
18746
18747 .section "Private options for the redirect router" "SECID130"
18748
18749 .cindex "options" "&(redirect)& router"
18750 The private options for the &(redirect)& router are as follows:
18751
18752
18753 .option allow_defer redirect boolean false
18754 Setting this option allows the use of &':defer:'& in non-filter redirection
18755 data, or the &%defer%& command in an Exim filter file.
18756
18757
18758 .option allow_fail redirect boolean false
18759 .cindex "failing delivery" "from filter"
18760 If this option is true, the &':fail:'& item can be used in a redirection list,
18761 and the &%fail%& command may be used in an Exim filter file.
18762
18763
18764 .option allow_filter redirect boolean false
18765 .cindex "filter" "enabling use of"
18766 .cindex "Sieve filter" "enabling use of"
18767 Setting this option allows Exim to interpret redirection data that starts with
18768 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18769 are some features of Exim filter files that some administrators may wish to
18770 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18771
18772 It is also possible to lock out Exim filters or Sieve filters while allowing
18773 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18774
18775
18776 The filter is run using the uid and gid set by the generic &%user%& and
18777 &%group%& options. These take their defaults from the password data if
18778 &%check_local_user%& is set, so in the normal case of users' personal filter
18779 files, the filter is run as the relevant user. When &%allow_filter%& is set
18780 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18781
18782
18783
18784 .option allow_freeze redirect boolean false
18785 .cindex "freezing messages" "allowing in filter"
18786 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18787 This command is more normally encountered in system filters, and is disabled by
18788 default for redirection filters because it isn't something you usually want to
18789 let ordinary users do.
18790
18791
18792
18793 .option check_ancestor redirect boolean false
18794 This option is concerned with handling generated addresses that are the same
18795 as some address in the list of redirection ancestors of the current address.
18796 Although it is turned off by default in the code, it is set in the default
18797 configuration file for handling users' &_.forward_& files. It is recommended
18798 for this use of the &(redirect)& router.
18799
18800 When &%check_ancestor%& is set, if a generated address (including the domain)
18801 is the same as any ancestor of the current address, it is replaced by a copy of
18802 the current address. This helps in the case where local part A is aliased to B,
18803 and B has a &_.forward_& file pointing back to A. For example, within a single
18804 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18805 &_&~jb/.forward_& contains:
18806 .code
18807 \Joe.Bloggs, <other item(s)>
18808 .endd
18809 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18810 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18811 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18812 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18813 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18814 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18815 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18816 original address. See also the &%repeat_use%& option below.
18817
18818
18819 .option check_group redirect boolean "see below"
18820 When the &%file%& option is used, the group owner of the file is checked only
18821 when this option is set. The permitted groups are those listed in the
18822 &%owngroups%& option, together with the user's default group if
18823 &%check_local_user%& is set. If the file has the wrong group, routing is
18824 deferred. The default setting for this option is true if &%check_local_user%&
18825 is set and the &%modemask%& option permits the group write bit, or if the
18826 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18827
18828
18829
18830 .option check_owner redirect boolean "see below"
18831 When the &%file%& option is used, the owner of the file is checked only when
18832 this option is set. If &%check_local_user%& is set, the local user is
18833 permitted; otherwise the owner must be one of those listed in the &%owners%&
18834 option. The default value for this option is true if &%check_local_user%& or
18835 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18836
18837
18838 .option data redirect string&!! unset
18839 This option is mutually exclusive with &%file%&. One or other of them must be
18840 set, but not both. The contents of &%data%& are expanded, and then used as the
18841 list of forwarding items, or as a set of filtering instructions. If the
18842 expansion is forced to fail, or the result is an empty string or a string that
18843 has no effect (consists entirely of comments), the router declines.
18844
18845 When filtering instructions are used, the string must begin with &"#Exim
18846 filter"&, and all comments in the string, including this initial one, must be
18847 terminated with newline characters. For example:
18848 .code
18849 data = #Exim filter\n\
18850        if $h_to: contains Exim then save $home/mail/exim endif
18851 .endd
18852 If you are reading the data from a database where newlines cannot be included,
18853 you can use the &${sg}$& expansion item to turn the escape string of your
18854 choice into a newline.
18855
18856
18857 .option directory_transport redirect string&!! unset
18858 A &(redirect)& router sets up a direct delivery to a directory when a path name
18859 ending with a slash is specified as a new &"address"&. The transport used is
18860 specified by this option, which, after expansion, must be the name of a
18861 configured transport. This should normally be an &(appendfile)& transport.
18862
18863
18864 .option file redirect string&!! unset
18865 This option specifies the name of a file that contains the redirection data. It
18866 is mutually exclusive with the &%data%& option. The string is expanded before
18867 use; if the expansion is forced to fail, the router declines. Other expansion
18868 failures cause delivery to be deferred. The result of a successful expansion
18869 must be an absolute path. The entire file is read and used as the redirection
18870 data. If the data is an empty string or a string that has no effect (consists
18871 entirely of comments), the router declines.
18872
18873 .cindex "NFS" "checking for file existence"
18874 If the attempt to open the file fails with a &"does not exist"& error, Exim
18875 runs a check on the containing directory,
18876 unless &%ignore_enotdir%& is true (see below).
18877 If the directory does not appear to exist, delivery is deferred. This can
18878 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18879 is a mount problem. If the containing directory does exist, but the file does
18880 not, the router declines.
18881
18882
18883 .option file_transport redirect string&!! unset
18884 .vindex "&$address_file$&"
18885 A &(redirect)& router sets up a direct delivery to a file when a path name not
18886 ending in a slash is specified as a new &"address"&. The transport used is
18887 specified by this option, which, after expansion, must be the name of a
18888 configured transport. This should normally be an &(appendfile)& transport. When
18889 it is running, the file name is in &$address_file$&.
18890
18891
18892 .option filter_prepend_home redirect boolean true
18893 When this option is true, if a &(save)& command in an Exim filter specifies a
18894 relative path, and &$home$& is defined, it is automatically prepended to the
18895 relative path. If this option is set false, this action does not happen. The
18896 relative path is then passed to the transport unmodified.
18897
18898
18899 .option forbid_blackhole redirect boolean false
18900 If this option is true, the &':blackhole:'& item may not appear in a
18901 redirection list.
18902
18903
18904 .option forbid_exim_filter redirect boolean false
18905 If this option is set true, only Sieve filters are permitted when
18906 &%allow_filter%& is true.
18907
18908
18909
18910
18911 .option forbid_file redirect boolean false
18912 .cindex "delivery" "to file; forbidding"
18913 .cindex "Sieve filter" "forbidding delivery to a file"
18914 .cindex "Sieve filter" "&""keep""& facility; disabling"
18915 If this option is true, this router may not generate a new address that
18916 specifies delivery to a local file or directory, either from a filter or from a
18917 conventional forward file. This option is forced to be true if &%one_time%& is
18918 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18919 locks out the Sieve's &"keep"& facility.
18920
18921
18922 .option forbid_filter_dlfunc redirect boolean false
18923 .cindex "filter" "locking out certain features"
18924 If this option is true, string expansions in Exim filters are not allowed to
18925 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18926 functions.
18927
18928 .option forbid_filter_existstest redirect boolean false
18929 .cindex "expansion" "statting a file"
18930 If this option is true, string expansions in Exim filters are not allowed to
18931 make use of the &%exists%& condition or the &%stat%& expansion item.
18932
18933 .option forbid_filter_logwrite redirect boolean false
18934 If this option is true, use of the logging facility in Exim filters is not
18935 permitted. Logging is in any case available only if the filter is being run
18936 under some unprivileged uid (which is normally the case for ordinary users'
18937 &_.forward_& files).
18938
18939
18940 .option forbid_filter_lookup redirect boolean false
18941 If this option is true, string expansions in Exim filter files are not allowed
18942 to make use of &%lookup%& items.
18943
18944
18945 .option forbid_filter_perl redirect boolean false
18946 This option has an effect only if Exim is built with embedded Perl support. If
18947 it is true, string expansions in Exim filter files are not allowed to make use
18948 of the embedded Perl support.
18949
18950
18951 .option forbid_filter_readfile redirect boolean false
18952 If this option is true, string expansions in Exim filter files are not allowed
18953 to make use of &%readfile%& items.
18954
18955
18956 .option forbid_filter_readsocket redirect boolean false
18957 If this option is true, string expansions in Exim filter files are not allowed
18958 to make use of &%readsocket%& items.
18959
18960
18961 .option forbid_filter_reply redirect boolean false
18962 If this option is true, this router may not generate an automatic reply
18963 message. Automatic replies can be generated only from Exim or Sieve filter
18964 files, not from traditional forward files. This option is forced to be true if
18965 &%one_time%& is set.
18966
18967
18968 .option forbid_filter_run redirect boolean false
18969 If this option is true, string expansions in Exim filter files are not allowed
18970 to make use of &%run%& items.
18971
18972
18973 .option forbid_include redirect boolean false
18974 If this option is true, items of the form
18975 .code
18976 :include:<path name>
18977 .endd
18978 are not permitted in non-filter redirection lists.
18979
18980
18981 .option forbid_pipe redirect boolean false
18982 .cindex "delivery" "to pipe; forbidding"
18983 If this option is true, this router may not generate a new address which
18984 specifies delivery to a pipe, either from an Exim filter or from a conventional
18985 forward file. This option is forced to be true if &%one_time%& is set.
18986
18987
18988 .option forbid_sieve_filter redirect boolean false
18989 If this option is set true, only Exim filters are permitted when
18990 &%allow_filter%& is true.
18991
18992
18993 .cindex "SMTP" "error codes"
18994 .option forbid_smtp_code redirect boolean false
18995 If this option is set true, any SMTP error codes that are present at the start
18996 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18997 the default codes (451 and 550, respectively) are always used.
18998
18999
19000
19001
19002 .option hide_child_in_errmsg redirect boolean false
19003 .cindex "bounce message" "redirection details; suppressing"
19004 If this option is true, it prevents Exim from quoting a child address if it
19005 generates a bounce or delay message for it. Instead it says &"an address
19006 generated from <&'the top level address'&>"&. Of course, this applies only to
19007 bounces generated locally. If a message is forwarded to another host, &'its'&
19008 bounce may well quote the generated address.
19009
19010
19011 .option ignore_eacces redirect boolean false
19012 .cindex "EACCES"
19013 If this option is set and an attempt to open a redirection file yields the
19014 EACCES error (permission denied), the &(redirect)& router behaves as if the
19015 file did not exist.
19016
19017
19018 .option ignore_enotdir redirect boolean false
19019 .cindex "ENOTDIR"
19020 If this option is set and an attempt to open a redirection file yields the
19021 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19022 router behaves as if the file did not exist.
19023
19024 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19025 router that has the &%file%& option set discovers that the file does not exist
19026 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19027 against unmounted NFS directories. If the parent can not be statted, delivery
19028 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19029 is set, because that option tells Exim to ignore &"something on the path is not
19030 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19031 that some operating systems give ENOENT where others give ENOTDIR.
19032
19033
19034
19035 .option include_directory redirect string unset
19036 If this option is set, the path names of any &':include:'& items in a
19037 redirection list must start with this directory.
19038
19039
19040 .option modemask redirect "octal integer" 022
19041 This specifies mode bits which must not be set for a file specified by the
19042 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19043
19044
19045 .option one_time redirect boolean false
19046 .cindex "one-time aliasing/forwarding expansion"
19047 .cindex "alias file" "one-time expansion"
19048 .cindex "forward file" "one-time expansion"
19049 .cindex "mailing lists" "one-time expansion"
19050 .cindex "address redirection" "one-time expansion"
19051 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19052 files each time it tries to deliver a message causes a problem when one or more
19053 of the generated addresses fails be delivered at the first attempt. The problem
19054 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19055 but of what happens when the redirection list changes during the time that the
19056 message is on Exim's queue. This is particularly true in the case of mailing
19057 lists, where new subscribers might receive copies of messages that were posted
19058 before they subscribed.
19059
19060 If &%one_time%& is set and any addresses generated by the router fail to
19061 deliver at the first attempt, the failing addresses are added to the message as
19062 &"top level"& addresses, and the parent address that generated them is marked
19063 &"delivered"&. Thus, redirection does not happen again at the next delivery
19064 attempt.
19065
19066 &*Warning 1*&: Any header line addition or removal that is specified by this
19067 router would be lost if delivery did not succeed at the first attempt. For this
19068 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19069 permitted when &%one_time%& is set.
19070
19071 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19072 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19073 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19074
19075 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19076 &%one_time%&.
19077
19078 The original top-level address is remembered with each of the generated
19079 addresses, and is output in any log messages. However, any intermediate parent
19080 addresses are not recorded. This makes a difference to the log only if
19081 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19082 typically be used for mailing lists, where there is normally just one level of
19083 expansion.
19084
19085
19086 .option owners redirect "string list" unset
19087 .cindex "ownership" "alias file"
19088 .cindex "ownership" "forward file"
19089 .cindex "alias file" "ownership"
19090 .cindex "forward file" "ownership"
19091 This specifies a list of permitted owners for the file specified by &%file%&.
19092 This list is in addition to the local user when &%check_local_user%& is set.
19093 See &%check_owner%& above.
19094
19095
19096 .option owngroups redirect "string list" unset
19097 This specifies a list of permitted groups for the file specified by &%file%&.
19098 The list is in addition to the local user's primary group when
19099 &%check_local_user%& is set. See &%check_group%& above.
19100
19101
19102 .option pipe_transport redirect string&!! unset
19103 .vindex "&$address_pipe$&"
19104 A &(redirect)& router sets up a direct delivery to a pipe when a string
19105 starting with a vertical bar character is specified as a new &"address"&. The
19106 transport used is specified by this option, which, after expansion, must be the
19107 name of a configured transport. This should normally be a &(pipe)& transport.
19108 When the transport is run, the pipe command is in &$address_pipe$&.
19109
19110
19111 .option qualify_domain redirect string&!! unset
19112 .vindex "&$qualify_recipient$&"
19113 If this option is set, and an unqualified address (one without a domain) is
19114 generated, and that address would normally be qualified by the global setting
19115 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19116 expanding this string. If the expansion fails, the router declines. If you want
19117 to revert to the default, you can have the expansion generate
19118 &$qualify_recipient$&.
19119
19120 This option applies to all unqualified addresses generated by Exim filters,
19121 but for traditional &_.forward_& files, it applies only to addresses that are
19122 not preceded by a backslash. Sieve filters cannot generate unqualified
19123 addresses.
19124
19125 .option qualify_preserve_domain redirect boolean false
19126 .cindex "domain" "in redirection; preserving"
19127 .cindex "preserving domain in redirection"
19128 .cindex "address redirection" "domain; preserving"
19129 If this option is set, the router's local &%qualify_domain%& option must not be
19130 set (a configuration error occurs if it is). If an unqualified address (one
19131 without a domain) is generated, it is qualified with the domain of the parent
19132 address (the immediately preceding ancestor) instead of the global
19133 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19134 this applies whether or not the address is preceded by a backslash.
19135
19136
19137 .option repeat_use redirect boolean true
19138 If this option is set false, the router is skipped for a child address that has
19139 any ancestor that was routed by this router. This test happens before any of
19140 the other preconditions are tested. Exim's default anti-looping rules skip
19141 only when the ancestor is the same as the current address. See also
19142 &%check_ancestor%& above and the generic &%redirect_router%& option.
19143
19144
19145 .option reply_transport redirect string&!! unset
19146 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19147 &%vacation%& command is used in a filter file. The transport used is specified
19148 by this option, which, after expansion, must be the name of a configured
19149 transport. This should normally be an &(autoreply)& transport. Other transports
19150 are unlikely to do anything sensible or useful.
19151
19152
19153 .option rewrite redirect boolean true
19154 .cindex "address redirection" "disabling rewriting"
19155 If this option is set false, addresses generated by the router are not
19156 subject to address rewriting. Otherwise, they are treated like new addresses
19157 and are rewritten according to the global rewriting rules.
19158
19159
19160 .option sieve_subaddress redirect string&!! unset
19161 The value of this option is passed to a Sieve filter to specify the
19162 :subaddress part of an address.
19163
19164 .option sieve_useraddress redirect string&!! unset
19165 The value of this option is passed to a Sieve filter to specify the :user part
19166 of an address. However, if it is unset, the entire original local part
19167 (including any prefix or suffix) is used for :user.
19168
19169
19170 .option sieve_vacation_directory redirect string&!! unset
19171 .cindex "Sieve filter" "vacation directory"
19172 To enable the &"vacation"& extension for Sieve filters, you must set
19173 &%sieve_vacation_directory%& to the directory where vacation databases are held
19174 (do not put anything else in that directory), and ensure that the
19175 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19176 needs their own directory; Exim will create it if necessary.
19177
19178
19179
19180 .option skip_syntax_errors redirect boolean false
19181 .cindex "forward file" "broken"
19182 .cindex "address redirection" "broken files"
19183 .cindex "alias file" "broken"
19184 .cindex "broken alias or forward files"
19185 .cindex "ignoring faulty addresses"
19186 .cindex "skipping faulty addresses"
19187 .cindex "error" "skipping bad syntax"
19188 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19189 non-filter redirection data are skipped, and each failing address is logged. If
19190 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19191 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19192 are expanded and placed at the head of the error message generated by
19193 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19194 be the same address as the generic &%errors_to%& option. The
19195 &%skip_syntax_errors%& option is often used when handling mailing lists.
19196
19197 If all the addresses in a redirection list are skipped because of syntax
19198 errors, the router declines to handle the original address, and it is passed to
19199 the following routers.
19200
19201 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19202 error in the filter causes filtering to be abandoned without any action being
19203 taken. The incident is logged, and the router declines to handle the address,
19204 so it is passed to the following routers.
19205
19206 .cindex "Sieve filter" "syntax errors in"
19207 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19208 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19209 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19210
19211 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19212 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19213 option, used with an address that does not get redirected, can be used to
19214 notify users of these errors, by means of a router like this:
19215 .code
19216 userforward:
19217   driver = redirect
19218   allow_filter
19219   check_local_user
19220   file = $home/.forward
19221   file_transport = address_file
19222   pipe_transport = address_pipe
19223   reply_transport = address_reply
19224   no_verify
19225   skip_syntax_errors
19226   syntax_errors_to = real-$local_part@$domain
19227   syntax_errors_text = \
19228    This is an automatically generated message. An error has\n\
19229    been found in your .forward file. Details of the error are\n\
19230    reported below. While this error persists, you will receive\n\
19231    a copy of this message for every message that is addressed\n\
19232    to you. If your .forward file is a filter file, or if it is\n\
19233    a non-filter file containing no valid forwarding addresses,\n\
19234    a copy of each incoming message will be put in your normal\n\
19235    mailbox. If a non-filter file contains at least one valid\n\
19236    forwarding address, forwarding to the valid addresses will\n\
19237    happen, and those will be the only deliveries that occur.
19238 .endd
19239 You also need a router to ensure that local addresses that are prefixed by
19240 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19241 put this immediately before the &(userforward)& router:
19242 .code
19243 real_localuser:
19244   driver = accept
19245   check_local_user
19246   local_part_prefix = real-
19247   transport = local_delivery
19248 .endd
19249 For security, it would probably be a good idea to restrict the use of this
19250 router to locally-generated messages, using a condition such as this:
19251 .code
19252   condition = ${if match {$sender_host_address}\
19253                          {\N^(|127\.0\.0\.1)$\N}}
19254 .endd
19255
19256
19257 .option syntax_errors_text redirect string&!! unset
19258 See &%skip_syntax_errors%& above.
19259
19260
19261 .option syntax_errors_to redirect string unset
19262 See &%skip_syntax_errors%& above.
19263 .ecindex IIDredrou1
19264 .ecindex IIDredrou2
19265
19266
19267
19268
19269
19270
19271 . ////////////////////////////////////////////////////////////////////////////
19272 . ////////////////////////////////////////////////////////////////////////////
19273
19274 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19275          "Environment for local transports"
19276 .scindex IIDenvlotra1 "local transports" "environment for"
19277 .scindex IIDenvlotra2 "environment for local transports"
19278 .scindex IIDenvlotra3 "transport" "local; environment for"
19279 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19280 transport can be thought of as similar to a pipe.) Exim always runs transports
19281 in subprocesses, under specified uids and gids. Typical deliveries to local
19282 mailboxes run under the uid and gid of the local user.
19283
19284 Exim also sets a specific current directory while running the transport; for
19285 some transports a home directory setting is also relevant. The &(pipe)&
19286 transport is the only one that sets up environment variables; see section
19287 &<<SECTpipeenv>>& for details.
19288
19289 The values used for the uid, gid, and the directories may come from several
19290 different places. In many cases, the router that handles the address associates
19291 settings with that address as a result of its &%check_local_user%&, &%group%&,
19292 or &%user%& options. However, values may also be given in the transport's own
19293 configuration, and these override anything that comes from the router.
19294
19295
19296
19297 .section "Concurrent deliveries" "SECID131"
19298 .cindex "concurrent deliveries"
19299 .cindex "simultaneous deliveries"
19300 If two different messages for the same local recipient arrive more or less
19301 simultaneously, the two delivery processes are likely to run concurrently. When
19302 the &(appendfile)& transport is used to write to a file, Exim applies locking
19303 rules to stop concurrent processes from writing to the same file at the same
19304 time.
19305
19306 However, when you use a &(pipe)& transport, it is up to you to arrange any
19307 locking that is needed. Here is a silly example:
19308 .code
19309 my_transport:
19310   driver = pipe
19311   command = /bin/sh -c 'cat >>/some/file'
19312 .endd
19313 This is supposed to write the message at the end of the file. However, if two
19314 messages arrive at the same time, the file will be scrambled. You can use the
19315 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19316 file using the same algorithm that Exim itself uses.
19317
19318
19319
19320
19321 .section "Uids and gids" "SECTenvuidgid"
19322 .cindex "local transports" "uid and gid"
19323 .cindex "transport" "local; uid and gid"
19324 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19325 overrides any group that the router set in the address, even if &%user%& is not
19326 set for the transport. This makes it possible, for example, to run local mail
19327 delivery under the uid of the recipient (set by the router), but in a special
19328 group (set by the transport). For example:
19329 .code
19330 # Routers ...
19331 # User/group are set by check_local_user in this router
19332 local_users:
19333   driver = accept
19334   check_local_user
19335   transport = group_delivery
19336
19337 # Transports ...
19338 # This transport overrides the group
19339 group_delivery:
19340   driver = appendfile
19341   file = /var/spool/mail/$local_part
19342   group = mail
19343 .endd
19344 If &%user%& is set for a transport, its value overrides what is set in the
19345 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19346 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19347 set.
19348
19349 .oindex "&%initgroups%&"
19350 When the uid is taken from the transport's configuration, the &[initgroups()]&
19351 function is called for the groups associated with that uid if the
19352 &%initgroups%& option is set for the transport. When the uid is not specified
19353 by the transport, but is associated with the address by a router, the option
19354 for calling &[initgroups()]& is taken from the router configuration.
19355
19356 .cindex "&(pipe)& transport" "uid for"
19357 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19358 is set and &%user%& is not set, the uid of the process that called Exim to
19359 receive the message is used, and if &%group%& is not set, the corresponding
19360 original gid is also used.
19361
19362 This is the detailed preference order for obtaining a gid; the first of the
19363 following that is set is used:
19364
19365 .ilist
19366 A &%group%& setting of the transport;
19367 .next
19368 A &%group%& setting of the router;
19369 .next
19370 A gid associated with a user setting of the router, either as a result of
19371 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19372 .next
19373 The group associated with a non-numeric &%user%& setting of the transport;
19374 .next
19375 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19376 the uid is the creator's uid;
19377 .next
19378 The Exim gid if the Exim uid is being used as a default.
19379 .endlist
19380
19381 If, for example, the user is specified numerically on the router and there are
19382 no group settings, no gid is available. In this situation, an error occurs.
19383 This is different for the uid, for which there always is an ultimate default.
19384 The first of the following that is set is used:
19385
19386 .ilist
19387 A &%user%& setting of the transport;
19388 .next
19389 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19390 .next
19391 A &%user%& setting of the router;
19392 .next
19393 A &%check_local_user%& setting of the router;
19394 .next
19395 The Exim uid.
19396 .endlist
19397
19398 Of course, an error will still occur if the uid that is chosen is on the
19399 &%never_users%& list.
19400
19401
19402
19403
19404
19405 .section "Current and home directories" "SECID132"
19406 .cindex "current directory for local transport"
19407 .cindex "home directory" "for local transport"
19408 .cindex "transport" "local; home directory for"
19409 .cindex "transport" "local; current directory for"
19410 Routers may set current and home directories for local transports by means of
19411 the &%transport_current_directory%& and &%transport_home_directory%& options.
19412 However, if the transport's &%current_directory%& or &%home_directory%& options
19413 are set, they override the router's values. In detail, the home directory
19414 for a local transport is taken from the first of these values that is set:
19415
19416 .ilist
19417 The &%home_directory%& option on the transport;
19418 .next
19419 The &%transport_home_directory%& option on the router;
19420 .next
19421 The password data if &%check_local_user%& is set on the router;
19422 .next
19423 The &%router_home_directory%& option on the router.
19424 .endlist
19425
19426 The current directory is taken from the first of these values that is set:
19427
19428 .ilist
19429 The &%current_directory%& option on the transport;
19430 .next
19431 The &%transport_current_directory%& option on the router.
19432 .endlist
19433
19434
19435 If neither the router nor the transport sets a current directory, Exim uses the
19436 value of the home directory, if it is set. Otherwise it sets the current
19437 directory to &_/_& before running a local transport.
19438
19439
19440
19441 .section "Expansion variables derived from the address" "SECID133"
19442 .vindex "&$domain$&"
19443 .vindex "&$local_part$&"
19444 .vindex "&$original_domain$&"
19445 Normally a local delivery is handling a single address, and in that case the
19446 variables such as &$domain$& and &$local_part$& are set during local
19447 deliveries. However, in some circumstances more than one address may be handled
19448 at once (for example, while writing batch SMTP for onward transmission by some
19449 other means). In this case, the variables associated with the local part are
19450 never set, &$domain$& is set only if all the addresses have the same domain,
19451 and &$original_domain$& is never set.
19452 .ecindex IIDenvlotra1
19453 .ecindex IIDenvlotra2
19454 .ecindex IIDenvlotra3
19455
19456
19457
19458
19459
19460
19461
19462 . ////////////////////////////////////////////////////////////////////////////
19463 . ////////////////////////////////////////////////////////////////////////////
19464
19465 .chapter "Generic options for transports" "CHAPtransportgeneric"
19466 .scindex IIDgenoptra1 "generic options" "transport"
19467 .scindex IIDgenoptra2 "options" "generic; for transports"
19468 .scindex IIDgenoptra3 "transport" "generic options for"
19469 The following generic options apply to all transports:
19470
19471
19472 .option body_only transports boolean false
19473 .cindex "transport" "body only"
19474 .cindex "message" "transporting body only"
19475 .cindex "body of message" "transporting"
19476 If this option is set, the message's headers are not transported. It is
19477 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19478 or &(pipe)& transports, the settings of &%message_prefix%& and
19479 &%message_suffix%& should be checked, because this option does not
19480 automatically suppress them.
19481
19482
19483 .option current_directory transports string&!! unset
19484 .cindex "transport" "current directory for"
19485 This specifies the current directory that is to be set while running the
19486 transport, overriding any value that may have been set by the router.
19487 If the expansion fails for any reason, including forced failure, an error is
19488 logged, and delivery is deferred.
19489
19490
19491 .option disable_logging transports boolean false
19492 If this option is set true, nothing is logged for any
19493 deliveries by the transport or for any
19494 transport errors. You should not set this option unless you really, really know
19495 what you are doing.
19496
19497
19498 .option debug_print transports string&!! unset
19499 .cindex "testing" "variables in drivers"
19500 If this option is set and debugging is enabled (see the &%-d%& command line
19501 option), the string is expanded and included in the debugging output when the
19502 transport is run.
19503 If expansion of the string fails, the error message is written to the debugging
19504 output, and Exim carries on processing.
19505 This facility is provided to help with checking out the values of variables and
19506 so on when debugging driver configurations. For example, if a &%headers_add%&
19507 option is not working properly, &%debug_print%& could be used to output the
19508 variables it references. A newline is added to the text if it does not end with
19509 one.
19510
19511
19512 .option delivery_date_add transports boolean false
19513 .cindex "&'Delivery-date:'& header line"
19514 If this option is true, a &'Delivery-date:'& header is added to the message.
19515 This gives the actual time the delivery was made. As this is not a standard
19516 header, Exim has a configuration option (&%delivery_date_remove%&) which
19517 requests its removal from incoming messages, so that delivered messages can
19518 safely be resent to other recipients.
19519
19520
19521 .option driver transports string unset
19522 This specifies which of the available transport drivers is to be used.
19523 There is no default, and this option must be set for every transport.
19524
19525
19526 .option envelope_to_add transports boolean false
19527 .cindex "&'Envelope-to:'& header line"
19528 If this option is true, an &'Envelope-to:'& header is added to the message.
19529 This gives the original address(es) in the incoming envelope that caused this
19530 delivery to happen. More than one address may be present if the transport is
19531 configured to handle several addresses at once, or if more than one original
19532 address was redirected to the same final address. As this is not a standard
19533 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19534 its removal from incoming messages, so that delivered messages can safely be
19535 resent to other recipients.
19536
19537
19538 .option group transports string&!! "Exim group"
19539 .cindex "transport" "group; specifying"
19540 This option specifies a gid for running the transport process, overriding any
19541 value that the router supplies, and also overriding any value associated with
19542 &%user%& (see below).
19543
19544
19545 .option headers_add transports string&!! unset
19546 .cindex "header lines" "adding in transport"
19547 .cindex "transport" "header lines; adding"
19548 This option specifies a string of text that is expanded and added to the header
19549 portion of a message as it is transported, as described in section
19550 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19551 routers. If the result of the expansion is an empty string, or if the expansion
19552 is forced to fail, no action is taken. Other expansion failures are treated as
19553 errors and cause the delivery to be deferred.
19554
19555
19556
19557 .option headers_only transports boolean false
19558 .cindex "transport" "header lines only"
19559 .cindex "message" "transporting headers only"
19560 .cindex "header lines" "transporting"
19561 If this option is set, the message's body is not transported. It is mutually
19562 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19563 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19564 checked, since this option does not automatically suppress them.
19565
19566
19567 .option headers_remove transports string&!! unset
19568 .cindex "header lines" "removing"
19569 .cindex "transport" "header lines; removing"
19570 This option specifies a string that is expanded into a list of header names;
19571 these headers are omitted from the message as it is transported, as described
19572 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19573 routers. If the result of the expansion is an empty string, or if the expansion
19574 is forced to fail, no action is taken. Other expansion failures are treated as
19575 errors and cause the delivery to be deferred.
19576
19577
19578
19579 .option headers_rewrite transports string unset
19580 .cindex "transport" "header lines; rewriting"
19581 .cindex "rewriting" "at transport time"
19582 This option allows addresses in header lines to be rewritten at transport time,
19583 that is, as the message is being copied to its destination. The contents of the
19584 option are a colon-separated list of rewriting rules. Each rule is in exactly
19585 the same form as one of the general rewriting rules that are applied when a
19586 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19587 example,
19588 .code
19589 headers_rewrite = a@b c@d f : \
19590                   x@y w@z
19591 .endd
19592 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19593 &'w@z'& in all address-bearing header lines. The rules are applied to the
19594 header lines just before they are written out at transport time, so they affect
19595 only those copies of the message that pass through the transport. However, only
19596 the message's original header lines, and any that were added by a system
19597 filter, are rewritten. If a router or transport adds header lines, they are not
19598 affected by this option. These rewriting rules are &'not'& applied to the
19599 envelope. You can change the return path using &%return_path%&, but you cannot
19600 change envelope recipients at this time.
19601
19602
19603 .option home_directory transports string&!! unset
19604 .cindex "transport" "home directory for"
19605 .vindex "&$home$&"
19606 This option specifies a home directory setting for a local transport,
19607 overriding any value that may be set by the router. The home directory is
19608 placed in &$home$& while expanding the transport's private options. It is also
19609 used as the current directory if no current directory is set by the
19610 &%current_directory%& option on the transport or the
19611 &%transport_current_directory%& option on the router. If the expansion fails
19612 for any reason, including forced failure, an error is logged, and delivery is
19613 deferred.
19614
19615
19616 .option initgroups transports boolean false
19617 .cindex "additional groups"
19618 .cindex "groups" "additional"
19619 .cindex "transport" "group; additional"
19620 If this option is true and the uid for the delivery process is provided by the
19621 transport, the &[initgroups()]& function is called when running the transport
19622 to ensure that any additional groups associated with the uid are set up.
19623
19624
19625 .option message_size_limit transports string&!! 0
19626 .cindex "limit" "message size per transport"
19627 .cindex "size" "of message, limit"
19628 .cindex "transport" "message size; limiting"
19629 This option controls the size of messages passed through the transport. It is
19630 expanded before use; the result of the expansion must be a sequence of decimal
19631 digits, optionally followed by K or M. If the expansion fails for any reason,
19632 including forced failure, or if the result is not of the required form,
19633 delivery is deferred. If the value is greater than zero and the size of a
19634 message exceeds this limit, the address is failed. If there is any chance that
19635 the resulting bounce message could be routed to the same transport, you should
19636 ensure that &%return_size_limit%& is less than the transport's
19637 &%message_size_limit%&, as otherwise the bounce message will fail to get
19638 delivered.
19639
19640
19641
19642 .option rcpt_include_affixes transports boolean false
19643 .cindex "prefix" "for local part, including in envelope"
19644 .cindex "suffix for local part" "including in envelope"
19645 .cindex "local part" "prefix"
19646 .cindex "local part" "suffix"
19647 When this option is false (the default), and an address that has had any
19648 affixes (prefixes or suffixes) removed from the local part is delivered by any
19649 form of SMTP or LMTP, the affixes are not included. For example, if a router
19650 that contains
19651 .code
19652 local_part_prefix = *-
19653 .endd
19654 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19655 is delivered with
19656 .code
19657 RCPT TO:<xyz@some.domain>
19658 .endd
19659 This is also the case when an ACL-time callout is being used to verify a
19660 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19661 whole local part is included in the RCPT command. This option applies to BSMTP
19662 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19663 &(lmtp)& and &(smtp)& transports.
19664
19665
19666 .option retry_use_local_part transports boolean "see below"
19667 .cindex "hints database" "retry keys"
19668 When a delivery suffers a temporary failure, a retry record is created
19669 in Exim's hints database. For remote deliveries, the key for the retry record
19670 is based on the name and/or IP address of the failing remote host. For local
19671 deliveries, the key is normally the entire address, including both the local
19672 part and the domain. This is suitable for most common cases of local delivery
19673 temporary failure &-- for example, exceeding a mailbox quota should delay only
19674 deliveries to that mailbox, not to the whole domain.
19675
19676 However, in some special cases you may want to treat a temporary local delivery
19677 as a failure associated with the domain, and not with a particular local part.
19678 (For example, if you are storing all mail for some domain in files.) You can do
19679 this by setting &%retry_use_local_part%& false.
19680
19681 For all the local transports, its default value is true. For remote transports,
19682 the default value is false for tidiness, but changing the value has no effect
19683 on a remote transport in the current implementation.
19684
19685
19686 .option return_path transports string&!! unset
19687 .cindex "envelope sender"
19688 .cindex "transport" "return path; changing"
19689 .cindex "return path" "changing in transport"
19690 If this option is set, the string is expanded at transport time and replaces
19691 the existing return path (envelope sender) value in the copy of the message
19692 that is being delivered. An empty return path is permitted. This feature is
19693 designed for remote deliveries, where the value of this option is used in the
19694 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19695 only effect is to change the address that is placed in the &'Return-path:'&
19696 header line, if one is added to the message (see the next option).
19697
19698 &*Note:*& A changed return path is not logged unless you add
19699 &%return_path_on_delivery%& to the log selector.
19700
19701 .vindex "&$return_path$&"
19702 The expansion can refer to the existing value via &$return_path$&. This is
19703 either the message's envelope sender, or an address set by the
19704 &%errors_to%& option on a router. If the expansion is forced to fail, no
19705 replacement occurs; if it fails for another reason, delivery is deferred. This
19706 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19707 section &<<SECTverp>>&.
19708
19709 &*Note*&: If a delivery error is detected locally, including the case when a
19710 remote server rejects a message at SMTP time, the bounce message is not sent to
19711 the value of this option. It is sent to the previously set errors address.
19712 This defaults to the incoming sender address, but can be changed by setting
19713 &%errors_to%& in a router.
19714
19715
19716
19717 .option return_path_add transports boolean false
19718 .cindex "&'Return-path:'& header line"
19719 If this option is true, a &'Return-path:'& header is added to the message.
19720 Although the return path is normally available in the prefix line of BSD
19721 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19722 have easy access to it.
19723
19724 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19725 the delivery SMTP server makes the final delivery"&. This implies that this
19726 header should not be present in incoming messages. Exim has a configuration
19727 option, &%return_path_remove%&, which requests removal of this header from
19728 incoming messages, so that delivered messages can safely be resent to other
19729 recipients.
19730
19731
19732 .option shadow_condition transports string&!! unset
19733 See &%shadow_transport%& below.
19734
19735
19736 .option shadow_transport transports string unset
19737 .cindex "shadow transport"
19738 .cindex "transport" "shadow"
19739 A local transport may set the &%shadow_transport%& option to the name of
19740 another local transport. Shadow remote transports are not supported.
19741
19742 Whenever a delivery to the main transport succeeds, and either
19743 &%shadow_condition%& is unset, or its expansion does not result in the empty
19744 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19745 passed to the shadow transport, with the same delivery address or addresses. If
19746 expansion fails, no action is taken except that non-forced expansion failures
19747 cause a log line to be written.
19748
19749 The result of the shadow transport is discarded and does not affect the
19750 subsequent processing of the message. Only a single level of shadowing is
19751 provided; the &%shadow_transport%& option is ignored on any transport when it
19752 is running as a shadow. Options concerned with output from pipes are also
19753 ignored. The log line for the successful delivery has an item added on the end,
19754 of the form
19755 .code
19756 ST=<shadow transport name>
19757 .endd
19758 If the shadow transport did not succeed, the error message is put in
19759 parentheses afterwards. Shadow transports can be used for a number of different
19760 purposes, including keeping more detailed log information than Exim normally
19761 provides, and implementing automatic acknowledgment policies based on message
19762 headers that some sites insist on.
19763
19764
19765 .option transport_filter transports string&!! unset
19766 .cindex "transport" "filter"
19767 .cindex "filter" "transport filter"
19768 This option sets up a filtering (in the Unix shell sense) process for messages
19769 at transport time. It should not be confused with mail filtering as set up by
19770 individual users or via a system filter.
19771
19772 When the message is about to be written out, the command specified by
19773 &%transport_filter%& is started up in a separate, parallel process, and
19774 the entire message, including the header lines, is passed to it on its standard
19775 input (this in fact is done from a third process, to avoid deadlock). The
19776 command must be specified as an absolute path.
19777
19778 The lines of the message that are written to the transport filter are
19779 terminated by newline (&"\n"&). The message is passed to the filter before any
19780 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19781 lines beginning with a dot, and also before any processing implied by the
19782 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19783 &(pipe)& transports.
19784
19785 The standard error for the filter process is set to the same destination as its
19786 standard output; this is read and written to the message's ultimate
19787 destination. The process that writes the message to the filter, the
19788 filter itself, and the original process that reads the result and delivers it
19789 are all run in parallel, like a shell pipeline.
19790
19791 The filter can perform any transformations it likes, but of course should take
19792 care not to break RFC 2822 syntax. Exim does not check the result, except to
19793 test for a final newline when SMTP is in use. All messages transmitted over
19794 SMTP must end with a newline, so Exim supplies one if it is missing.
19795
19796 .cindex "content scanning" "per user"
19797 A transport filter can be used to provide content-scanning on a per-user basis
19798 at delivery time if the only required effect of the scan is to modify the
19799 message. For example, a content scan could insert a new header line containing
19800 a spam score. This could be interpreted by a filter in the user's MUA. It is
19801 not possible to discard a message at this stage.
19802
19803 .cindex "SMTP" "SIZE"
19804 A problem might arise if the filter increases the size of a message that is
19805 being sent down an SMTP connection. If the receiving SMTP server has indicated
19806 support for the SIZE parameter, Exim will have sent the size of the message
19807 at the start of the SMTP session. If what is actually sent is substantially
19808 more, the server might reject the message. This can be worked round by setting
19809 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19810 additions to the message, or to disable the use of SIZE altogether.
19811
19812 .vindex "&$pipe_addresses$&"
19813 The value of the &%transport_filter%& option is the command string for starting
19814 the filter, which is run directly from Exim, not under a shell. The string is
19815 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19816 Exim breaks it up into arguments and then expands each argument separately (see
19817 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19818 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19819 of arguments, one for each address that applies to this delivery. (This isn't
19820 an ideal name for this feature here, but as it was already implemented for the
19821 &(pipe)& transport, it seemed sensible not to change it.)
19822
19823 .vindex "&$host$&"
19824 .vindex "&$host_address$&"
19825 The expansion variables &$host$& and &$host_address$& are available when the
19826 transport is a remote one. They contain the name and IP address of the host to
19827 which the message is being sent. For example:
19828 .code
19829 transport_filter = /some/directory/transport-filter.pl \
19830   $host $host_address $sender_address $pipe_addresses
19831 .endd
19832
19833 Two problems arise if you want to use more complicated expansion items to
19834 generate transport filter commands, both of which due to the fact that the
19835 command is split up &'before'& expansion.
19836 .ilist
19837 If an expansion item contains white space, you must quote it, so that it is all
19838 part of the same command item. If the entire option setting is one such
19839 expansion item, you have to take care what kind of quoting you use. For
19840 example:
19841 .code
19842 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19843 .endd
19844 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19845 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19846 stripped by Exim when it read the option's value. When the value is used, if
19847 the single quotes were missing, the line would be split into two items,
19848 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19849 Exim tried to expand the first one.
19850 .next
19851 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19852 expansion cannot generate multiple arguments, or a command name followed by
19853 arguments. Consider this example:
19854 .code
19855 transport_filter = ${lookup{$host}lsearch{/a/file}\
19856                     {$value}{/bin/cat}}
19857 .endd
19858 The result of the lookup is interpreted as the name of the command, even
19859 if it contains white space. The simplest way round this is to use a shell:
19860 .code
19861 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19862                                {$value}{/bin/cat}}
19863 .endd
19864 .endlist
19865
19866 The filter process is run under the same uid and gid as the normal delivery.
19867 For remote deliveries this is the Exim uid/gid by default. The command should
19868 normally yield a zero return code. Transport filters are not supposed to fail.
19869 A non-zero code is taken to mean that the transport filter encountered some
19870 serious problem. Delivery of the message is deferred; the message remains on
19871 the queue and is tried again later. It is not possible to cause a message to be
19872 bounced from a transport filter.
19873
19874 If a transport filter is set on an autoreply transport, the original message is
19875 passed through the filter as it is being copied into the newly generated
19876 message, which happens if the &%return_message%& option is set.
19877
19878
19879 .option transport_filter_timeout transports time 5m
19880 .cindex "transport" "filter, timeout"
19881 When Exim is reading the output of a transport filter, it a applies a timeout
19882 that can be set by this option. Exceeding the timeout is normally treated as a
19883 temporary delivery failure. However, if a transport filter is used with a
19884 &(pipe)& transport, a timeout in the transport filter is treated in the same
19885 way as a timeout in the pipe command itself. By default, a timeout is a hard
19886 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19887 becomes a temporary error.
19888
19889
19890 .option user transports string&!! "Exim user"
19891 .cindex "uid (user id)" "local delivery"
19892 .cindex "transport" "user, specifying"
19893 This option specifies the user under whose uid the delivery process is to be
19894 run, overriding any uid that may have been set by the router. If the user is
19895 given as a name, the uid is looked up from the password data, and the
19896 associated group is taken as the value of the gid to be used if the &%group%&
19897 option is not set.
19898
19899 For deliveries that use local transports, a user and group are normally
19900 specified explicitly or implicitly (for example, as a result of
19901 &%check_local_user%&) by the router or transport.
19902
19903 .cindex "hints database" "access by remote transport"
19904 For remote transports, you should leave this option unset unless you really are
19905 sure you know what you are doing. When a remote transport is running, it needs
19906 to be able to access Exim's hints databases, because each host may have its own
19907 retry data.
19908 .ecindex IIDgenoptra1
19909 .ecindex IIDgenoptra2
19910 .ecindex IIDgenoptra3
19911
19912
19913
19914
19915
19916
19917 . ////////////////////////////////////////////////////////////////////////////
19918 . ////////////////////////////////////////////////////////////////////////////
19919
19920 .chapter "Address batching in local transports" "CHAPbatching" &&&
19921          "Address batching"
19922 .cindex "transport" "local; address batching in"
19923 The only remote transport (&(smtp)&) is normally configured to handle more than
19924 one address at a time, so that when several addresses are routed to the same
19925 remote host, just one copy of the message is sent. Local transports, however,
19926 normally handle one address at a time. That is, a separate instance of the
19927 transport is run for each address that is routed to the transport. A separate
19928 copy of the message is delivered each time.
19929
19930 .cindex "batched local delivery"
19931 .oindex "&%batch_max%&"
19932 .oindex "&%batch_id%&"
19933 In special cases, it may be desirable to handle several addresses at once in a
19934 local transport, for example:
19935
19936 .ilist
19937 In an &(appendfile)& transport, when storing messages in files for later
19938 delivery by some other means, a single copy of the message with multiple
19939 recipients saves space.
19940 .next
19941 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19942 a single copy saves time, and is the normal way LMTP is expected to work.
19943 .next
19944 In a &(pipe)& transport, when passing the message
19945 to a scanner program or
19946 to some other delivery mechanism such as UUCP, multiple recipients may be
19947 acceptable.
19948 .endlist
19949
19950 These three local transports all have the same options for controlling multiple
19951 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19952 repeating the information for each transport, these options are described here.
19953
19954 The &%batch_max%& option specifies the maximum number of addresses that can be
19955 delivered together in a single run of the transport. Its default value is one
19956 (no batching). When more than one address is routed to a transport that has a
19957 &%batch_max%& value greater than one, the addresses are delivered in a batch
19958 (that is, in a single run of the transport with multiple recipients), subject
19959 to certain conditions:
19960
19961 .ilist
19962 .vindex "&$local_part$&"
19963 If any of the transport's options contain a reference to &$local_part$&, no
19964 batching is possible.
19965 .next
19966 .vindex "&$domain$&"
19967 If any of the transport's options contain a reference to &$domain$&, only
19968 addresses with the same domain are batched.
19969 .next
19970 .cindex "customizing" "batching condition"
19971 If &%batch_id%& is set, it is expanded for each address, and only those
19972 addresses with the same expanded value are batched. This allows you to specify
19973 customized batching conditions. Failure of the expansion for any reason,
19974 including forced failure, disables batching, but it does not stop the delivery
19975 from taking place.
19976 .next
19977 Batched addresses must also have the same errors address (where to send
19978 delivery errors), the same header additions and removals, the same user and
19979 group for the transport, and if a host list is present, the first host must
19980 be the same.
19981 .endlist
19982
19983 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19984 both when the file or pipe command is specified in the transport, and when it
19985 is specified by a &(redirect)& router, but all the batched addresses must of
19986 course be routed to the same file or pipe command. These two transports have an
19987 option called &%use_bsmtp%&, which causes them to deliver the message in
19988 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19989 &%check_string%& and &%escape_string%& options are forced to the values
19990 .code
19991 check_string = "."
19992 escape_string = ".."
19993 .endd
19994 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19995 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19996 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19997
19998 .cindex "&'Envelope-to:'& header line"
19999 If the generic &%envelope_to_add%& option is set for a batching transport, the
20000 &'Envelope-to:'& header that is added to the message contains all the addresses
20001 that are being processed together. If you are using a batching &(appendfile)&
20002 transport without &%use_bsmtp%&, the only way to preserve the recipient
20003 addresses is to set the &%envelope_to_add%& option.
20004
20005 .cindex "&(pipe)& transport" "with multiple addresses"
20006 .vindex "&$pipe_addresses$&"
20007 If you are using a &(pipe)& transport without BSMTP, and setting the
20008 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20009 the command. This is not a true variable; it is a bit of magic that causes each
20010 of the recipient addresses to be inserted into the command as a separate
20011 argument. This provides a way of accessing all the addresses that are being
20012 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20013 are specified by a &(redirect)& router.
20014
20015
20016
20017
20018 . ////////////////////////////////////////////////////////////////////////////
20019 . ////////////////////////////////////////////////////////////////////////////
20020
20021 .chapter "The appendfile transport" "CHAPappendfile"
20022 .scindex IIDapptra1 "&(appendfile)& transport"
20023 .scindex IIDapptra2 "transports" "&(appendfile)&"
20024 .cindex "directory creation"
20025 .cindex "creating directories"
20026 The &(appendfile)& transport delivers a message by appending it to an existing
20027 file, or by creating an entirely new file in a specified directory. Single
20028 files to which messages are appended can be in the traditional Unix mailbox
20029 format, or optionally in the MBX format supported by the Pine MUA and
20030 University of Washington IMAP daemon, &'inter alia'&. When each message is
20031 being delivered as a separate file, &"maildir"& format can optionally be used
20032 to give added protection against failures that happen part-way through the
20033 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20034 supported. For all file formats, Exim attempts to create as many levels of
20035 directory as necessary, provided that &%create_directory%& is set.
20036
20037 The code for the optional formats is not included in the Exim binary by
20038 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20039 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20040 included.
20041
20042 .cindex "quota" "system"
20043 Exim recognizes system quota errors, and generates an appropriate message. Exim
20044 also supports its own quota control within the transport, for use when the
20045 system facility is unavailable or cannot be used for some reason.
20046
20047 If there is an error while appending to a file (for example, quota exceeded or
20048 partition filled), Exim attempts to reset the file's length and last
20049 modification time back to what they were before. If there is an error while
20050 creating an entirely new file, the new file is removed.
20051
20052 Before appending to a file, a number of security checks are made, and the
20053 file is locked. A detailed description is given below, after the list of
20054 private options.
20055
20056 The &(appendfile)& transport is most commonly used for local deliveries to
20057 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20058 putting messages into files for remote delivery by some means other than Exim.
20059 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20060 option).
20061
20062
20063
20064 .section "The file and directory options" "SECTfildiropt"
20065 The &%file%& option specifies a single file, to which the message is appended;
20066 the &%directory%& option specifies a directory, in which a new file containing
20067 the message is created. Only one of these two options can be set, and for
20068 normal deliveries to mailboxes, one of them &'must'& be set.
20069
20070 .vindex "&$address_file$&"
20071 .vindex "&$local_part$&"
20072 However, &(appendfile)& is also used for delivering messages to files or
20073 directories whose names (or parts of names) are obtained from alias,
20074 forwarding, or filtering operations (for example, a &%save%& command in a
20075 user's Exim filter). When such a transport is running, &$local_part$& contains
20076 the local part that was aliased or forwarded, and &$address_file$& contains the
20077 name (or partial name) of the file or directory generated by the redirection
20078 operation. There are two cases:
20079
20080 .ilist
20081 If neither &%file%& nor &%directory%& is set, the redirection operation
20082 must specify an absolute path (one that begins with &`/`&). This is the most
20083 common case when users with local accounts use filtering to sort mail into
20084 different folders. See for example, the &(address_file)& transport in the
20085 default configuration. If the path ends with a slash, it is assumed to be the
20086 name of a directory. A delivery to a directory can also be forced by setting
20087 &%maildir_format%& or &%mailstore_format%&.
20088 .next
20089 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20090 used to determine the file or directory name for the delivery. Normally, the
20091 contents of &$address_file$& are used in some way in the string expansion.
20092 .endlist
20093
20094
20095 .cindex "Sieve filter" "configuring &(appendfile)&"
20096 .cindex "Sieve filter" "relative mailbox path handling"
20097 As an example of the second case, consider an environment where users do not
20098 have home directories. They may be permitted to use Exim filter commands of the
20099 form:
20100 .code
20101 save folder23
20102 .endd
20103 or Sieve filter commands of the form:
20104 .code
20105 require "fileinto";
20106 fileinto "folder23";
20107 .endd
20108 In this situation, the expansion of &%file%& or &%directory%& in the transport
20109 must transform the relative path into an appropriate absolute file name. In the
20110 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20111 is used as a result of a &"keep"& action in the filter. This example shows one
20112 way of handling this requirement:
20113 .code
20114 file = ${if eq{$address_file}{inbox} \
20115             {/var/mail/$local_part} \
20116             {${if eq{${substr_0_1:$address_file}}{/} \
20117                   {$address_file} \
20118                   {$home/mail/$address_file} \
20119             }} \
20120        }
20121 .endd
20122 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20123 location, absolute paths are used without change, and other folders are in the
20124 &_mail_& directory within the home directory.
20125
20126 &*Note 1*&: While processing an Exim filter, a relative path such as
20127 &_folder23_& is turned into an absolute path if a home directory is known to
20128 the router. In particular, this is the case if &%check_local_user%& is set. If
20129 you want to prevent this happening at routing time, you can set
20130 &%router_home_directory%& empty. This forces the router to pass the relative
20131 path to the transport.
20132
20133 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20134 the &%file%& or &%directory%& option is still used if it is set.
20135
20136
20137
20138
20139 .section "Private options for appendfile" "SECID134"
20140 .cindex "options" "&(appendfile)& transport"
20141
20142
20143
20144 .option allow_fifo appendfile boolean false
20145 .cindex "fifo (named pipe)"
20146 .cindex "named pipe (fifo)"
20147 .cindex "pipe" "named (fifo)"
20148 Setting this option permits delivery to named pipes (FIFOs) as well as to
20149 regular files. If no process is reading the named pipe at delivery time, the
20150 delivery is deferred.
20151
20152
20153 .option allow_symlink appendfile boolean false
20154 .cindex "symbolic link" "to mailbox"
20155 .cindex "mailbox" "symbolic link"
20156 By default, &(appendfile)& will not deliver if the path name for the file is
20157 that of a symbolic link. Setting this option relaxes that constraint, but there
20158 are security issues involved in the use of symbolic links. Be sure you know
20159 what you are doing if you set this. Details of exactly what this option affects
20160 are included in the discussion which follows this list of options.
20161
20162
20163 .option batch_id appendfile string&!! unset
20164 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20165 However, batching is automatically disabled for &(appendfile)& deliveries that
20166 happen as a result of forwarding or aliasing or other redirection directly to a
20167 file.
20168
20169
20170 .option batch_max appendfile integer 1
20171 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20172
20173
20174 .option check_group appendfile boolean false
20175 When this option is set, the group owner of the file defined by the &%file%&
20176 option is checked to see that it is the same as the group under which the
20177 delivery process is running. The default setting is false because the default
20178 file mode is 0600, which means that the group is irrelevant.
20179
20180
20181 .option check_owner appendfile boolean true
20182 When this option is set, the owner of the file defined by the &%file%& option
20183 is checked to ensure that it is the same as the user under which the delivery
20184 process is running.
20185
20186
20187 .option check_string appendfile string "see below"
20188 .cindex "&""From""& line"
20189 As &(appendfile)& writes the message, the start of each line is tested for
20190 matching &%check_string%&, and if it does, the initial matching characters are
20191 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20192 a literal string, not a regular expression, and the case of any letters it
20193 contains is significant.
20194
20195 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20196 are forced to &"."& and &".."& respectively, and any settings in the
20197 configuration are ignored. Otherwise, they default to &"From&~"& and
20198 &">From&~"& when the &%file%& option is set, and unset when any of the
20199 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20200
20201 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20202 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20203 &"From&~"& indicates the start of a new message. All four options need changing
20204 if another format is used. For example, to deliver to mailboxes in MMDF format:
20205 .cindex "MMDF format mailbox"
20206 .cindex "mailbox" "MMDF format"
20207 .code
20208 check_string = "\1\1\1\1\n"
20209 escape_string = "\1\1\1\1 \n"
20210 message_prefix = "\1\1\1\1\n"
20211 message_suffix = "\1\1\1\1\n"
20212 .endd
20213 .option create_directory appendfile boolean true
20214 .cindex "directory creation"
20215 When this option is true, Exim attempts to create any missing superior
20216 directories for the file that it is about to write. A created directory's mode
20217 is given by the &%directory_mode%& option.
20218
20219 The group ownership of a newly created directory is highly dependent on the
20220 operating system (and possibly the file system) that is being used. For
20221 example, in Solaris, if the parent directory has the setgid bit set, its group
20222 is propagated to the child; if not, the currently set group is used. However,
20223 in FreeBSD, the parent's group is always used.
20224
20225
20226
20227 .option create_file appendfile string anywhere
20228 This option constrains the location of files and directories that are created
20229 by this transport. It applies to files defined by the &%file%& option and
20230 directories defined by the &%directory%& option. In the case of maildir
20231 delivery, it applies to the top level directory, not the maildir directories
20232 beneath.
20233
20234 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20235 &"belowhome"&. In the second and third cases, a home directory must have been
20236 set for the transport. This option is not useful when an explicit file name is
20237 given for normal mailbox deliveries. It is intended for the case when file
20238 names are generated from users' &_.forward_& files. These are usually handled
20239 by an &(appendfile)& transport called &%address_file%&. See also
20240 &%file_must_exist%&.
20241
20242
20243 .option directory appendfile string&!! unset
20244 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20245 or &%directory%& must be set, unless the delivery is the direct result of a
20246 redirection (see section &<<SECTfildiropt>>&).
20247
20248 When &%directory%& is set, the string is expanded, and the message is delivered
20249 into a new file or files in or below the given directory, instead of being
20250 appended to a single mailbox file. A number of different formats are provided
20251 (see &%maildir_format%& and &%mailstore_format%&), and see section
20252 &<<SECTopdir>>& for further details of this form of delivery.
20253
20254
20255 .option directory_file appendfile string&!! "see below"
20256 .cindex "base62"
20257 .vindex "&$inode$&"
20258 When &%directory%& is set, but neither &%maildir_format%& nor
20259 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20260 whose name is obtained by expanding this string. The default value is:
20261 .code
20262 q${base62:$tod_epoch}-$inode
20263 .endd
20264 This generates a unique name from the current time, in base 62 form, and the
20265 inode of the file. The variable &$inode$& is available only when expanding this
20266 option.
20267
20268
20269 .option directory_mode appendfile "octal integer" 0700
20270 If &(appendfile)& creates any directories as a result of the
20271 &%create_directory%& option, their mode is specified by this option.
20272
20273
20274 .option escape_string appendfile string "see description"
20275 See &%check_string%& above.
20276
20277
20278 .option file appendfile string&!! unset
20279 This option is mutually exclusive with the &%directory%& option, but one of
20280 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20281 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20282 specifies a single file, to which the message is appended. One or more of
20283 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20284 &%file%&.
20285
20286 .cindex "NFS" "lock file"
20287 .cindex "locking files"
20288 .cindex "lock files"
20289 If you are using more than one host to deliver over NFS into the same
20290 mailboxes, you should always use lock files.
20291
20292 The string value is expanded for each delivery, and must yield an absolute
20293 path. The most common settings of this option are variations on one of these
20294 examples:
20295 .code
20296 file = /var/spool/mail/$local_part
20297 file = /home/$local_part/inbox
20298 file = $home/inbox
20299 .endd
20300 .cindex "&""sticky""& bit"
20301 In the first example, all deliveries are done into the same directory. If Exim
20302 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20303 create a file in the directory, so the &"sticky"& bit must be turned on for
20304 deliveries to be possible, or alternatively the &%group%& option can be used to
20305 run the delivery under a group id which has write access to the directory.
20306
20307
20308
20309 .option file_format appendfile string unset
20310 .cindex "file" "mailbox; checking existing format"
20311 This option requests the transport to check the format of an existing file
20312 before adding to it. The check consists of matching a specific string at the
20313 start of the file. The value of the option consists of an even number of
20314 colon-separated strings. The first of each pair is the test string, and the
20315 second is the name of a transport. If the transport associated with a matched
20316 string is not the current transport, control is passed over to the other
20317 transport. For example, suppose the standard &(local_delivery)& transport has
20318 this added to it:
20319 .code
20320 file_format = "From       : local_delivery :\
20321                \1\1\1\1\n : local_mmdf_delivery"
20322 .endd
20323 Mailboxes that begin with &"From"& are still handled by this transport, but if
20324 a mailbox begins with four binary ones followed by a newline, control is passed
20325 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20326 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20327 is assumed to match the current transport. If the start of a mailbox doesn't
20328 match any string, or if the transport named for a given string is not defined,
20329 delivery is deferred.
20330
20331
20332 .option file_must_exist appendfile boolean false
20333 If this option is true, the file specified by the &%file%& option must exist.
20334 A temporary error occurs if it does not, causing delivery to be deferred.
20335 If this option is false, the file is created if it does not exist.
20336
20337
20338 .option lock_fcntl_timeout appendfile time 0s
20339 .cindex "timeout" "mailbox locking"
20340 .cindex "mailbox" "locking, blocking and non-blocking"
20341 .cindex "locking files"
20342 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20343 when locking an open mailbox file. If the call fails, the delivery process
20344 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20345 Non-blocking calls are used so that the file is not kept open during the wait
20346 for the lock; the reason for this is to make it as safe as possible for
20347 deliveries over NFS in the case when processes might be accessing an NFS
20348 mailbox without using a lock file. This should not be done, but
20349 misunderstandings and hence misconfigurations are not unknown.
20350
20351 On a busy system, however, the performance of a non-blocking lock approach is
20352 not as good as using a blocking lock with a timeout. In this case, the waiting
20353 is done inside the system call, and Exim's delivery process acquires the lock
20354 and can proceed as soon as the previous lock holder releases it.
20355
20356 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20357 timeout, are used. There may still be some retrying: the maximum number of
20358 retries is
20359 .code
20360 (lock_retries * lock_interval) / lock_fcntl_timeout
20361 .endd
20362 rounded up to the next whole number. In other words, the total time during
20363 which &(appendfile)& is trying to get a lock is roughly the same, unless
20364 &%lock_fcntl_timeout%& is set very large.
20365
20366 You should consider setting this option if you are getting a lot of delayed
20367 local deliveries because of errors of the form
20368 .code
20369 failed to lock mailbox /some/file (fcntl)
20370 .endd
20371
20372 .option lock_flock_timeout appendfile time 0s
20373 This timeout applies to file locking when using &[flock()]& (see
20374 &%use_flock%&); the timeout operates in a similar manner to
20375 &%lock_fcntl_timeout%&.
20376
20377
20378 .option lock_interval appendfile time 3s
20379 This specifies the time to wait between attempts to lock the file. See below
20380 for details of locking.
20381
20382
20383 .option lock_retries appendfile integer 10
20384 This specifies the maximum number of attempts to lock the file. A value of zero
20385 is treated as 1. See below for details of locking.
20386
20387
20388 .option lockfile_mode appendfile "octal integer" 0600
20389 This specifies the mode of the created lock file, when a lock file is being
20390 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20391
20392
20393 .option lockfile_timeout appendfile time 30m
20394 .cindex "timeout" "mailbox locking"
20395 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20396 exists and is older than this value, it is assumed to have been left behind by
20397 accident, and Exim attempts to remove it.
20398
20399
20400 .option mailbox_filecount appendfile string&!! unset
20401 .cindex "mailbox" "specifying size of"
20402 .cindex "size" "of mailbox"
20403 If this option is set, it is expanded, and the result is taken as the current
20404 number of files in the mailbox. It must be a decimal number, optionally
20405 followed by K or M. This provides a way of obtaining this information from an
20406 external source that maintains the data.
20407
20408
20409 .option mailbox_size appendfile string&!! unset
20410 .cindex "mailbox" "specifying size of"
20411 .cindex "size" "of mailbox"
20412 If this option is set, it is expanded, and the result is taken as the current
20413 size the mailbox. It must be a decimal number, optionally followed by K or M.
20414 This provides a way of obtaining this information from an external source that
20415 maintains the data. This is likely to be helpful for maildir deliveries where
20416 it is computationally expensive to compute the size of a mailbox.
20417
20418
20419
20420 .option maildir_format appendfile boolean false
20421 .cindex "maildir format" "specifying"
20422 If this option is set with the &%directory%& option, the delivery is into a new
20423 file, in the &"maildir"& format that is used by other mail software. When the
20424 transport is activated directly from a &(redirect)& router (for example, the
20425 &(address_file)& transport in the default configuration), setting
20426 &%maildir_format%& causes the path received from the router to be treated as a
20427 directory, whether or not it ends with &`/`&. This option is available only if
20428 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20429 &<<SECTmaildirdelivery>>& below for further details.
20430
20431
20432 .option maildir_quota_directory_regex appendfile string "See below"
20433 .cindex "maildir format" "quota; directories included in"
20434 .cindex "quota" "maildir; directories included in"
20435 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20436 a regular expression for specifying directories, relative to the quota
20437 directory (see &%quota_directory%&), that should be included in the quota
20438 calculation. The default value is:
20439 .code
20440 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20441 .endd
20442 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20443 (directories whose names begin with a dot). If you want to exclude the
20444 &_Trash_&
20445 folder from the count (as some sites do), you need to change this setting to
20446 .code
20447 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20448 .endd
20449 This uses a negative lookahead in the regular expression to exclude the
20450 directory whose name is &_.Trash_&. When a directory is excluded from quota
20451 calculations, quota processing is bypassed for any messages that are delivered
20452 directly into that directory.
20453
20454
20455 .option maildir_retries appendfile integer 10
20456 This option specifies the number of times to retry when writing a file in
20457 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20458
20459
20460 .option maildir_tag appendfile string&!! unset
20461 This option applies only to deliveries in maildir format, and is described in
20462 section &<<SECTmaildirdelivery>>& below.
20463
20464
20465 .option maildir_use_size_file appendfile&!! boolean false
20466 .cindex "maildir format" "&_maildirsize_& file"
20467 The result of string expansion for this option must be a valid boolean value.
20468 If it is true, it enables support for &_maildirsize_& files. Exim
20469 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20470 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20471 value is zero. See &%maildir_quota_directory_regex%& above and section
20472 &<<SECTmaildirdelivery>>& below for further details.
20473
20474 .option maildirfolder_create_regex appendfile string unset
20475 .cindex "maildir format" "&_maildirfolder_& file"
20476 .cindex "&_maildirfolder_&, creating"
20477 The value of this option is a regular expression. If it is unset, it has no
20478 effect. Otherwise, before a maildir delivery takes place, the pattern is
20479 matched against the name of the maildir directory, that is, the directory
20480 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20481 delivery. If there is a match, Exim checks for the existence of a file called
20482 &_maildirfolder_& in the directory, and creates it if it does not exist.
20483 See section &<<SECTmaildirdelivery>>& for more details.
20484
20485
20486 .option mailstore_format appendfile boolean false
20487 .cindex "mailstore format" "specifying"
20488 If this option is set with the &%directory%& option, the delivery is into two
20489 new files in  &"mailstore"& format. The option is available only if
20490 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20491 below for further details.
20492
20493
20494 .option mailstore_prefix appendfile string&!! unset
20495 This option applies only to deliveries in mailstore format, and is described in
20496 section &<<SECTopdir>>& below.
20497
20498
20499 .option mailstore_suffix appendfile string&!! unset
20500 This option applies only to deliveries in mailstore format, and is described in
20501 section &<<SECTopdir>>& below.
20502
20503
20504 .option mbx_format appendfile boolean false
20505 .cindex "locking files"
20506 .cindex "file" "locking"
20507 .cindex "file" "MBX format"
20508 .cindex "MBX format, specifying"
20509 This option is available only if Exim has been compiled with SUPPORT_MBX
20510 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20511 the message is appended to the mailbox file in MBX format instead of
20512 traditional Unix format. This format is supported by Pine4 and its associated
20513 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20514
20515 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20516 automatically changed by the use of &%mbx_format%&. They should normally be set
20517 empty when using MBX format, so this option almost always appears in this
20518 combination:
20519 .code
20520 mbx_format = true
20521 message_prefix =
20522 message_suffix =
20523 .endd
20524 If none of the locking options are mentioned in the configuration,
20525 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20526 is possible to specify the other kinds of locking with &%mbx_format%&, but
20527 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20528 interworks with &'c-client'&, providing for shared access to the mailbox. It
20529 should not be used if any program that does not use this form of locking is
20530 going to access the mailbox, nor should it be used if the mailbox file is NFS
20531 mounted, because it works only when the mailbox is accessed from a single host.
20532
20533 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20534 the standard version of &'c-client'&, because as long as it has a mailbox open
20535 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20536 append messages to it.
20537
20538
20539 .option message_prefix appendfile string&!! "see below"
20540 .cindex "&""From""& line"
20541 The string specified here is expanded and output at the start of every message.
20542 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20543 in which case it is:
20544 .code
20545 message_prefix = "From ${if def:return_path{$return_path}\
20546   {MAILER-DAEMON}} $tod_bsdinbox\n"
20547 .endd
20548 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20549 &`\n`& to &`\r\n`& in &%message_prefix%&.
20550
20551 .option message_suffix appendfile string&!! "see below"
20552 The string specified here is expanded and output at the end of every message.
20553 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20554 in which case it is a single newline character. The suffix can be suppressed by
20555 setting
20556 .code
20557 message_suffix =
20558 .endd
20559 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20560 &`\n`& to &`\r\n`& in &%message_suffix%&.
20561
20562 .option mode appendfile "octal integer" 0600
20563 If the output file is created, it is given this mode. If it already exists and
20564 has wider permissions, they are reduced to this mode. If it has narrower
20565 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20566 if the delivery is the result of a &%save%& command in a filter file specifying
20567 a particular mode, the mode of the output file is always forced to take that
20568 value, and this option is ignored.
20569
20570
20571 .option mode_fail_narrower appendfile boolean true
20572 This option applies in the case when an existing mailbox file has a narrower
20573 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20574 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20575 continues with the delivery attempt, using the existing mode of the file.
20576
20577
20578 .option notify_comsat appendfile boolean false
20579 If this option is true, the &'comsat'& daemon is notified after every
20580 successful delivery to a user mailbox. This is the daemon that notifies logged
20581 on users about incoming mail.
20582
20583
20584 .option quota appendfile string&!! unset
20585 .cindex "quota" "imposed by Exim"
20586 This option imposes a limit on the size of the file to which Exim is appending,
20587 or to the total space used in the directory tree when the &%directory%& option
20588 is set. In the latter case, computation of the space used is expensive, because
20589 all the files in the directory (and any sub-directories) have to be
20590 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20591 &%maildir_use_size_file%& for ways to avoid this in environments where users
20592 have no shell access to their mailboxes).
20593
20594 As there is no interlock against two simultaneous deliveries into a
20595 multi-file mailbox, it is possible for the quota to be overrun in this case.
20596 For single-file mailboxes, of course, an interlock is a necessity.
20597
20598 A file's size is taken as its &'used'& value. Because of blocking effects, this
20599 may be a lot less than the actual amount of disk space allocated to the file.
20600 If the sizes of a number of files are being added up, the rounding effect can
20601 become quite noticeable, especially on systems that have large block sizes.
20602 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20603 the obvious value which users understand most easily.
20604
20605 The value of the option is expanded, and must then be a numerical value
20606 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20607 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20608 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20609 be handled.
20610
20611 &*Note*&: A value of zero is interpreted as &"no quota"&.
20612
20613 The expansion happens while Exim is running as root, before it changes uid for
20614 the delivery. This means that files that are inaccessible to the end user can
20615 be used to hold quota values that are looked up in the expansion. When delivery
20616 fails because this quota is exceeded, the handling of the error is as for
20617 system quota failures.
20618
20619 By default, Exim's quota checking mimics system quotas, and restricts the
20620 mailbox to the specified maximum size, though the value is not accurate to the
20621 last byte, owing to separator lines and additional headers that may get added
20622 during message delivery. When a mailbox is nearly full, large messages may get
20623 refused even though small ones are accepted, because the size of the current
20624 message is added to the quota when the check is made. This behaviour can be
20625 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20626 for exceeding the quota does not include the current message. Thus, deliveries
20627 continue until the quota has been exceeded; thereafter, no further messages are
20628 delivered. See also &%quota_warn_threshold%&.
20629
20630
20631 .option quota_directory appendfile string&!! unset
20632 This option defines the directory to check for quota purposes when delivering
20633 into individual files. The default is the delivery directory, or, if a file
20634 called &_maildirfolder_& exists in a maildir directory, the parent of the
20635 delivery directory.
20636
20637
20638 .option quota_filecount appendfile string&!! 0
20639 This option applies when the &%directory%& option is set. It limits the total
20640 number of files in the directory (compare the inode limit in system quotas). It
20641 can only be used if &%quota%& is also set. The value is expanded; an expansion
20642 failure causes delivery to be deferred. A value of zero is interpreted as
20643 &"no quota"&.
20644
20645
20646 .option quota_is_inclusive appendfile boolean true
20647 See &%quota%& above.
20648
20649
20650 .option quota_size_regex appendfile string unset
20651 This option applies when one of the delivery modes that writes a separate file
20652 for each message is being used. When Exim wants to find the size of one of
20653 these files in order to test the quota, it first checks &%quota_size_regex%&.
20654 If this is set to a regular expression that matches the file name, and it
20655 captures one string, that string is interpreted as a representation of the
20656 file's size. The value of &%quota_size_regex%& is not expanded.
20657
20658 This feature is useful only when users have no shell access to their mailboxes
20659 &-- otherwise they could defeat the quota simply by renaming the files. This
20660 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20661 the file length to the file name. For example:
20662 .code
20663 maildir_tag = ,S=$message_size
20664 quota_size_regex = ,S=(\d+)
20665 .endd
20666 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20667 number of lines in the message.
20668
20669 The regular expression should not assume that the length is at the end of the
20670 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20671 sometimes add other information onto the ends of message file names.
20672
20673 Section &<<SECID136>>& contains further information.
20674
20675
20676 .option quota_warn_message appendfile string&!! "see below"
20677 See below for the use of this option. If it is not set when
20678 &%quota_warn_threshold%& is set, it defaults to
20679 .code
20680 quota_warn_message = "\
20681   To: $local_part@$domain\n\
20682   Subject: Your mailbox\n\n\
20683   This message is automatically created \
20684   by mail delivery software.\n\n\
20685   The size of your mailbox has exceeded \
20686   a warning threshold that is\n\
20687   set by the system administrator.\n"
20688 .endd
20689
20690
20691 .option quota_warn_threshold appendfile string&!! 0
20692 .cindex "quota" "warning threshold"
20693 .cindex "mailbox" "size warning"
20694 .cindex "size" "of mailbox"
20695 This option is expanded in the same way as &%quota%& (see above). If the
20696 resulting value is greater than zero, and delivery of the message causes the
20697 size of the file or total space in the directory tree to cross the given
20698 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20699 may be specified as a percentage of it by following the value with a percent
20700 sign. For example:
20701 .code
20702 quota = 10M
20703 quota_warn_threshold = 75%
20704 .endd
20705 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20706 percent sign is ignored.
20707
20708 The warning message itself is specified by the &%quota_warn_message%& option,
20709 and it must start with a &'To:'& header line containing the recipient(s) of the
20710 warning message. These do not necessarily have to include the recipient(s) of
20711 the original message. A &'Subject:'& line should also normally be supplied. You
20712 can include any other header lines that you want. If you do not include a
20713 &'From:'& line, the default is:
20714 .code
20715 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20716 .endd
20717 .oindex &%errors_reply_to%&
20718 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20719 option.
20720
20721 The &%quota%& option does not have to be set in order to use this option; they
20722 are independent of one another except when the threshold is specified as a
20723 percentage.
20724
20725
20726 .option use_bsmtp appendfile boolean false
20727 .cindex "envelope sender"
20728 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20729 format, with the envelope sender and recipient(s) included as SMTP commands. If
20730 you want to include a leading HELO command with such messages, you can do
20731 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20732 for details of batch SMTP.
20733
20734
20735 .option use_crlf appendfile boolean false
20736 .cindex "carriage return"
20737 .cindex "linefeed"
20738 This option causes lines to be terminated with the two-character CRLF sequence
20739 (carriage return, linefeed) instead of just a linefeed character. In the case
20740 of batched SMTP, the byte sequence written to the file is then an exact image
20741 of what would be sent down a real SMTP connection.
20742
20743 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20744 (which are used to supply the traditional &"From&~"& and blank line separators
20745 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20746 carriage return characters if these are needed. In cases where these options
20747 have non-empty defaults, the values end with a single linefeed, so they must be
20748 changed to end with &`\r\n`& if &%use_crlf%& is set.
20749
20750
20751 .option use_fcntl_lock appendfile boolean "see below"
20752 This option controls the use of the &[fcntl()]& function to lock a file for
20753 exclusive use when a message is being appended. It is set by default unless
20754 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20755 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20756 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20757
20758
20759 .option use_flock_lock appendfile boolean false
20760 This option is provided to support the use of &[flock()]& for file locking, for
20761 the few situations where it is needed. Most modern operating systems support
20762 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20763 each other. Exim uses &[fcntl()]& locking by default.
20764
20765 This option is required only if you are using an operating system where
20766 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20767 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20768 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20769
20770 .cindex "Solaris" "&[flock()]& support"
20771 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20772 have it (and some, I think, provide a not quite right version built on top of
20773 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20774 the ability to use it, and any attempt to do so will cause a configuration
20775 error.
20776
20777 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20778 is just being mapped onto &[fcntl()]& by the OS).
20779
20780
20781 .option use_lockfile appendfile boolean "see below"
20782 If this option is turned off, Exim does not attempt to create a lock file when
20783 appending to a mailbox file. In this situation, the only locking is by
20784 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20785 sure that every MUA that is ever going to look at your users' mailboxes uses
20786 &[fcntl()]& rather than a lock file, and even then only when you are not
20787 delivering over NFS from more than one host.
20788
20789 .cindex "NFS" "lock file"
20790 In order to append to an NFS file safely from more than one host, it is
20791 necessary to take out a lock &'before'& opening the file, and the lock file
20792 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20793 file corruption.
20794
20795 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20796 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20797 except when &%mbx_format%& is set.
20798
20799
20800 .option use_mbx_lock appendfile boolean "see below"
20801 This option is available only if Exim has been compiled with SUPPORT_MBX
20802 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20803 locking rules be used. It is set by default if &%mbx_format%& is set and none
20804 of the locking options are mentioned in the configuration. The locking rules
20805 are the same as are used by the &'c-client'& library that underlies Pine and
20806 the IMAP4 and POP daemons that come with it (see the discussion below). The
20807 rules allow for shared access to the mailbox. However, this kind of locking
20808 does not work when the mailbox is NFS mounted.
20809
20810 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20811 &%use_flock_lock%& to control what kind of locking is used in implementing the
20812 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20813 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20814
20815
20816
20817
20818 .section "Operational details for appending" "SECTopappend"
20819 .cindex "appending to a file"
20820 .cindex "file" "appending"
20821 Before appending to a file, the following preparations are made:
20822
20823 .ilist
20824 If the name of the file is &_/dev/null_&, no action is taken, and a success
20825 return is given.
20826
20827 .next
20828 .cindex "directory creation"
20829 If any directories on the file's path are missing, Exim creates them if the
20830 &%create_directory%& option is set. A created directory's mode is given by the
20831 &%directory_mode%& option.
20832
20833 .next
20834 If &%file_format%& is set, the format of an existing file is checked. If this
20835 indicates that a different transport should be used, control is passed to that
20836 transport.
20837
20838 .next
20839 .cindex "file" "locking"
20840 .cindex "locking files"
20841 .cindex "NFS" "lock file"
20842 If &%use_lockfile%& is set, a lock file is built in a way that will work
20843 reliably over NFS, as follows:
20844
20845 .olist
20846 Create a &"hitching post"& file whose name is that of the lock file with the
20847 current time, primary host name, and process id added, by opening for writing
20848 as a new file. If this fails with an access error, delivery is deferred.
20849 .next
20850 Close the hitching post file, and hard link it to the lock file name.
20851 .next
20852 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20853 Unlink the hitching post name.
20854 .next
20855 Otherwise, use &[stat()]& to get information about the hitching post file, and
20856 then unlink hitching post name. If the number of links is exactly two, creation
20857 of the lock file succeeded but something (for example, an NFS server crash and
20858 restart) caused this fact not to be communicated to the &[link()]& call.
20859 .next
20860 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20861 up to &%lock_retries%& times. However, since any program that writes to a
20862 mailbox should complete its task very quickly, it is reasonable to time out old
20863 lock files that are normally the result of user agent and system crashes. If an
20864 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20865 it before trying again.
20866 .endlist olist
20867
20868 .next
20869 A call is made to &[lstat()]& to discover whether the main file exists, and if
20870 so, what its characteristics are. If &[lstat()]& fails for any reason other
20871 than non-existence, delivery is deferred.
20872
20873 .next
20874 .cindex "symbolic link" "to mailbox"
20875 .cindex "mailbox" "symbolic link"
20876 If the file does exist and is a symbolic link, delivery is deferred, unless the
20877 &%allow_symlink%& option is set, in which case the ownership of the link is
20878 checked, and then &[stat()]& is called to find out about the real file, which
20879 is then subjected to the checks below. The check on the top-level link
20880 ownership prevents one user creating a link for another's mailbox in a sticky
20881 directory, though allowing symbolic links in this case is definitely not a good
20882 idea. If there is a chain of symbolic links, the intermediate ones are not
20883 checked.
20884
20885 .next
20886 If the file already exists but is not a regular file, or if the file's owner
20887 and group (if the group is being checked &-- see &%check_group%& above) are
20888 different from the user and group under which the delivery is running,
20889 delivery is deferred.
20890
20891 .next
20892 If the file's permissions are more generous than specified, they are reduced.
20893 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20894 is set false, in which case the delivery is tried using the existing
20895 permissions.
20896
20897 .next
20898 The file's inode number is saved, and the file is then opened for appending.
20899 If this fails because the file has vanished, &(appendfile)& behaves as if it
20900 hadn't existed (see below). For any other failures, delivery is deferred.
20901
20902 .next
20903 If the file is opened successfully, check that the inode number hasn't
20904 changed, that it is still a regular file, and that the owner and permissions
20905 have not changed. If anything is wrong, defer delivery and freeze the message.
20906
20907 .next
20908 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20909 option is set. Otherwise, check that the file is being created in a permitted
20910 directory if the &%create_file%& option is set (deferring on failure), and then
20911 open for writing as a new file, with the O_EXCL and O_CREAT options,
20912 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20913 set). In this case, which can happen if the link points to a non-existent file,
20914 the file is opened for writing using O_CREAT but not O_EXCL, because
20915 that prevents link following.
20916
20917 .next
20918 .cindex "loop" "while file testing"
20919 If opening fails because the file exists, obey the tests given above for
20920 existing files. However, to avoid looping in a situation where the file is
20921 being continuously created and destroyed, the exists/not-exists loop is broken
20922 after 10 repetitions, and the message is then frozen.
20923
20924 .next
20925 If opening fails with any other error, defer delivery.
20926
20927 .next
20928 .cindex "file" "locking"
20929 .cindex "locking files"
20930 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20931 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20932 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20933 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20934 file, and an exclusive lock on the file whose name is
20935 .code
20936 /tmp/.<device-number>.<inode-number>
20937 .endd
20938 using the device and inode numbers of the open mailbox file, in accordance with
20939 the MBX locking rules. This file is created with a mode that is specified by
20940 the &%lockfile_mode%& option.
20941
20942 If Exim fails to lock the file, there are two possible courses of action,
20943 depending on the value of the locking timeout. This is obtained from
20944 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20945
20946 If the timeout value is zero, the file is closed, Exim waits for
20947 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20948 to lock it again. This happens up to &%lock_retries%& times, after which the
20949 delivery is deferred.
20950
20951 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20952 &[flock()]& are used (with the given timeout), so there has already been some
20953 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20954 immediately. It retries up to
20955 .code
20956 (lock_retries * lock_interval) / <timeout>
20957 .endd
20958 times (rounded up).
20959 .endlist
20960
20961 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20962 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20963
20964
20965 .section "Operational details for delivery to a new file" "SECTopdir"
20966 .cindex "delivery" "to single file"
20967 .cindex "&""From""& line"
20968 When the &%directory%& option is set instead of &%file%&, each message is
20969 delivered into a newly-created file or set of files. When &(appendfile)& is
20970 activated directly from a &(redirect)& router, neither &%file%& nor
20971 &%directory%& is normally set, because the path for delivery is supplied by the
20972 router. (See for example, the &(address_file)& transport in the default
20973 configuration.) In this case, delivery is to a new file if either the path name
20974 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20975
20976 No locking is required while writing the message to a new file, so the various
20977 locking options of the transport are ignored. The &"From"& line that by default
20978 separates messages in a single file is not normally needed, nor is the escaping
20979 of message lines that start with &"From"&, and there is no need to ensure a
20980 newline at the end of each message. Consequently, the default values for
20981 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20982 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20983
20984 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20985 the files in the delivery directory by default. However, you can specify a
20986 different directory by setting &%quota_directory%&. Also, for maildir
20987 deliveries (see below) the &_maildirfolder_& convention is honoured.
20988
20989
20990 .cindex "maildir format"
20991 .cindex "mailstore format"
20992 There are three different ways in which delivery to individual files can be
20993 done, controlled by the settings of the &%maildir_format%& and
20994 &%mailstore_format%& options. Note that code to support maildir or mailstore
20995 formats is not included in the binary unless SUPPORT_MAILDIR or
20996 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20997
20998 .cindex "directory creation"
20999 In all three cases an attempt is made to create the directory and any necessary
21000 sub-directories if they do not exist, provided that the &%create_directory%&
21001 option is set (the default). The location of a created directory can be
21002 constrained by setting &%create_file%&. A created directory's mode is given by
21003 the &%directory_mode%& option. If creation fails, or if the
21004 &%create_directory%& option is not set when creation is required, delivery is
21005 deferred.
21006
21007
21008
21009 .section "Maildir delivery" "SECTmaildirdelivery"
21010 .cindex "maildir format" "description of"
21011 If the &%maildir_format%& option is true, Exim delivers each message by writing
21012 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21013 directory that is defined by the &%directory%& option (the &"delivery
21014 directory"&). If the delivery is successful, the file is renamed into the
21015 &_new_& subdirectory.
21016
21017 In the file name, <&'stime'&> is the current time of day in seconds, and
21018 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21019 Exim checks that the time-of-day clock has moved on by at least one microsecond
21020 before terminating the delivery process. This guarantees uniqueness for the
21021 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21022 opening it. If any response other than ENOENT (does not exist) is given,
21023 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21024
21025 Before Exim carries out a maildir delivery, it ensures that subdirectories
21026 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21027 do not exist, Exim tries to create them and any superior directories in their
21028 path, subject to the &%create_directory%& and &%create_file%& options. If the
21029 &%maildirfolder_create_regex%& option is set, and the regular expression it
21030 contains matches the delivery directory, Exim also ensures that a file called
21031 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21032 &_maildirfolder_& file cannot be created, delivery is deferred.
21033
21034 These features make it possible to use Exim to create all the necessary files
21035 and directories in a maildir mailbox, including subdirectories for maildir++
21036 folders. Consider this example:
21037 .code
21038 maildir_format = true
21039 directory = /var/mail/$local_part\
21040            ${if eq{$local_part_suffix}{}{}\
21041            {/.${substr_1:$local_part_suffix}}}
21042 maildirfolder_create_regex = /\.[^/]+$
21043 .endd
21044 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21045 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21046 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21047 not match this name, so Exim will not look for or create the file
21048 &_/var/mail/pimbo/maildirfolder_&, though it will create
21049 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21050
21051 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21052 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21053 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21054 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21055 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21056
21057 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21058 not inadvertently match the toplevel maildir directory, because a
21059 &_maildirfolder_& file at top level would completely break quota calculations.
21060
21061 .cindex "quota" "in maildir delivery"
21062 .cindex "maildir++"
21063 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21064 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21065 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21066 Exim assumes the directory is a maildir++ folder directory, which is one level
21067 down from the user's top level mailbox directory. This causes it to start at
21068 the parent directory instead of the current directory when calculating the
21069 amount of space used.
21070
21071 One problem with delivering into a multi-file mailbox is that it is
21072 computationally expensive to compute the size of the mailbox for quota
21073 checking. Various approaches have been taken to reduce the amount of work
21074 needed. The next two sections describe two of them. A third alternative is to
21075 use some external process for maintaining the size data, and use the expansion
21076 of the &%mailbox_size%& option as a way of importing it into Exim.
21077
21078
21079
21080
21081 .section "Using tags to record message sizes" "SECID135"
21082 If &%maildir_tag%& is set, the string is expanded for each delivery.
21083 When the maildir file is renamed into the &_new_& sub-directory, the
21084 tag is added to its name. However, if adding the tag takes the length of the
21085 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21086 the tag is dropped and the maildir file is created with no tag.
21087
21088
21089 .vindex "&$message_size$&"
21090 Tags can be used to encode the size of files in their names; see
21091 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21092 happens after the message has been written. The value of the &$message_size$&
21093 variable is set to the number of bytes actually written. If the expansion is
21094 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21095 be deferred. The expanded tag may contain any printing characters except &"/"&.
21096 Non-printing characters in the string are ignored; if the resulting string is
21097 empty, it is ignored. If it starts with an alphanumeric character, a leading
21098 colon is inserted; this default has not proven to be the path that popular
21099 maildir implementations have chosen (but changing it in Exim would break
21100 backwards compatibility).
21101
21102 For one common implementation, you might set:
21103 .code
21104 maildir_tag = ,S=${message_size}
21105 .endd
21106 but you should check the documentation of the other software to be sure.
21107
21108 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21109 as this allows Exim to extract the size from your tag, instead of having to
21110 &[stat()]& each message file.
21111
21112
21113 .section "Using a maildirsize file" "SECID136"
21114 .cindex "quota" "in maildir delivery"
21115 .cindex "maildir format" "&_maildirsize_& file"
21116 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21117 storing quota and message size information in a file called &_maildirsize_&
21118 within the toplevel maildir directory. If this file does not exist, Exim
21119 creates it, setting the quota from the &%quota%& option of the transport. If
21120 the maildir directory itself does not exist, it is created before any attempt
21121 to write a &_maildirsize_& file.
21122
21123 The &_maildirsize_& file is used to hold information about the sizes of
21124 messages in the maildir, thus speeding up quota calculations. The quota value
21125 in the file is just a cache; if the quota is changed in the transport, the new
21126 value overrides the cached value when the next message is delivered. The cache
21127 is maintained for the benefit of other programs that access the maildir and
21128 need to know the quota.
21129
21130 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21131 file is maintained (with a zero quota setting), but no quota is imposed.
21132
21133 A regular expression is available for controlling which directories in the
21134 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21135 See the description of the &%maildir_quota_directory_regex%& option above for
21136 details.
21137
21138
21139 .section "Mailstore delivery" "SECID137"
21140 .cindex "mailstore format" "description of"
21141 If the &%mailstore_format%& option is true, each message is written as two
21142 files in the given directory. A unique base name is constructed from the
21143 message id and the current delivery process, and the files that are written use
21144 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21145 contains the message's envelope, and the &_.msg_& file contains the message
21146 itself. The base name is placed in the variable &$mailstore_basename$&.
21147
21148 During delivery, the envelope is first written to a file with the suffix
21149 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21150 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21151 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21152 file before accessing either of them. An alternative approach is to wait for
21153 the absence of a &_.tmp_& file.
21154
21155 The envelope file starts with any text defined by the &%mailstore_prefix%&
21156 option, expanded and terminated by a newline if there isn't one. Then follows
21157 the sender address on one line, then all the recipient addresses, one per line.
21158 There can be more than one recipient only if the &%batch_max%& option is set
21159 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21160 appended to the file, followed by a newline if it does not end with one.
21161
21162 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21163 failure, it is ignored. Other expansion errors are treated as serious
21164 configuration errors, and delivery is deferred. The variable
21165 &$mailstore_basename$& is available for use during these expansions.
21166
21167
21168 .section "Non-special new file delivery" "SECID138"
21169 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21170 file is created directly in the named directory. For example, when delivering
21171 messages into files in batched SMTP format for later delivery to some host (see
21172 section &<<SECTbatchSMTP>>&), a setting such as
21173 .code
21174 directory = /var/bsmtp/$host
21175 .endd
21176 might be used. A message is written to a file with a temporary name, which is
21177 then renamed when the delivery is complete. The final name is obtained by
21178 expanding the contents of the &%directory_file%& option.
21179 .ecindex IIDapptra1
21180 .ecindex IIDapptra2
21181
21182
21183
21184
21185
21186
21187 . ////////////////////////////////////////////////////////////////////////////
21188 . ////////////////////////////////////////////////////////////////////////////
21189
21190 .chapter "The autoreply transport" "CHID8"
21191 .scindex IIDauttra1 "transports" "&(autoreply)&"
21192 .scindex IIDauttra2 "&(autoreply)& transport"
21193 The &(autoreply)& transport is not a true transport in that it does not cause
21194 the message to be transmitted. Instead, it generates a new mail message as an
21195 automatic reply to the incoming message. &'References:'& and
21196 &'Auto-Submitted:'& header lines are included. These are constructed according
21197 to the rules in RFCs 2822 and 3834, respectively.
21198
21199 If the router that passes the message to this transport does not have the
21200 &%unseen%& option set, the original message (for the current recipient) is not
21201 delivered anywhere. However, when the &%unseen%& option is set on the router
21202 that passes the message to this transport, routing of the address continues, so
21203 another router can set up a normal message delivery.
21204
21205
21206 The &(autoreply)& transport is usually run as the result of mail filtering, a
21207 &"vacation"& message being the standard example. However, it can also be run
21208 directly from a router like any other transport. To reduce the possibility of
21209 message cascades, messages created by the &(autoreply)& transport always have
21210 empty envelope sender addresses, like bounce messages.
21211
21212 The parameters of the message to be sent can be specified in the configuration
21213 by options described below. However, these are used only when the address
21214 passed to the transport does not contain its own reply information. When the
21215 transport is run as a consequence of a
21216 &%mail%&
21217 or &%vacation%& command in a filter file, the parameters of the message are
21218 supplied by the filter, and passed with the address. The transport's options
21219 that define the message are then ignored (so they are not usually set in this
21220 case). The message is specified entirely by the filter or by the transport; it
21221 is never built from a mixture of options. However, the &%file_optional%&,
21222 &%mode%&, and &%return_message%& options apply in all cases.
21223
21224 &(Autoreply)& is implemented as a local transport. When used as a result of a
21225 command in a user's filter file, &(autoreply)& normally runs under the uid and
21226 gid of the user, and with appropriate current and home directories (see chapter
21227 &<<CHAPenvironment>>&).
21228
21229 There is a subtle difference between routing a message to a &(pipe)& transport
21230 that generates some text to be returned to the sender, and routing it to an
21231 &(autoreply)& transport. This difference is noticeable only if more than one
21232 address from the same message is so handled. In the case of a pipe, the
21233 separate outputs from the different addresses are gathered up and returned to
21234 the sender in a single message, whereas if &(autoreply)& is used, a separate
21235 message is generated for each address that is passed to it.
21236
21237 Non-printing characters are not permitted in the header lines generated for the
21238 message that &(autoreply)& creates, with the exception of newlines that are
21239 immediately followed by white space. If any non-printing characters are found,
21240 the transport defers.
21241 Whether characters with the top bit set count as printing characters or not is
21242 controlled by the &%print_topbitchars%& global option.
21243
21244 If any of the generic options for manipulating headers (for example,
21245 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21246 of the original message that is included in the generated message when
21247 &%return_message%& is set. They do not apply to the generated message itself.
21248
21249 .vindex "&$sender_address$&"
21250 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21251 the message, indicating that there were no recipients, it does not treat this
21252 as an error. This means that autoreplies sent to &$sender_address$& when this
21253 is empty (because the incoming message is a bounce message) do not cause
21254 problems. They are just discarded.
21255
21256
21257
21258 .section "Private options for autoreply" "SECID139"
21259 .cindex "options" "&(autoreply)& transport"
21260
21261 .option bcc autoreply string&!! unset
21262 This specifies the addresses that are to receive &"blind carbon copies"& of the
21263 message when the message is specified by the transport.
21264
21265
21266 .option cc autoreply string&!! unset
21267 This specifies recipients of the message and the contents of the &'Cc:'& header
21268 when the message is specified by the transport.
21269
21270
21271 .option file autoreply string&!! unset
21272 The contents of the file are sent as the body of the message when the message
21273 is specified by the transport. If both &%file%& and &%text%& are set, the text
21274 string comes first.
21275
21276
21277 .option file_expand autoreply boolean false
21278 If this is set, the contents of the file named by the &%file%& option are
21279 subjected to string expansion as they are added to the message.
21280
21281
21282 .option file_optional autoreply boolean false
21283 If this option is true, no error is generated if the file named by the &%file%&
21284 option or passed with the address does not exist or cannot be read.
21285
21286
21287 .option from autoreply string&!! unset
21288 This specifies the contents of the &'From:'& header when the message is
21289 specified by the transport.
21290
21291
21292 .option headers autoreply string&!! unset
21293 This specifies additional RFC 2822 headers that are to be added to the message
21294 when the message is specified by the transport. Several can be given by using
21295 &"\n"& to separate them. There is no check on the format.
21296
21297
21298 .option log autoreply string&!! unset
21299 This option names a file in which a record of every message sent is logged when
21300 the message is specified by the transport.
21301
21302
21303 .option mode autoreply "octal integer" 0600
21304 If either the log file or the &"once"& file has to be created, this mode is
21305 used.
21306
21307
21308 .option never_mail autoreply "address list&!!" unset
21309 If any run of the transport creates a message with a recipient that matches any
21310 item in the list, that recipient is quietly discarded. If all recipients are
21311 discarded, no message is created. This applies both when the recipients are
21312 generated by a filter and when they are specified in the transport.
21313
21314
21315
21316 .option once autoreply string&!! unset
21317 This option names a file or DBM database in which a record of each &'To:'&
21318 recipient is kept when the message is specified by the transport. &*Note*&:
21319 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21320
21321 If &%once%& is unset, or is set to an empty string, the message is always sent.
21322 By default, if &%once%& is set to a non-empty file name, the message
21323 is not sent if a potential recipient is already listed in the database.
21324 However, if the &%once_repeat%& option specifies a time greater than zero, the
21325 message is sent if that much time has elapsed since a message was last sent to
21326 this recipient. A setting of zero time for &%once_repeat%& (the default)
21327 prevents a message from being sent a second time &-- in this case, zero means
21328 infinity.
21329
21330 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21331 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21332 greater than zero, it changes the way Exim implements the &%once%& option.
21333 Instead of using a DBM file to record every recipient it sends to, it uses a
21334 regular file, whose size will never get larger than the given value.
21335
21336 In the file, Exim keeps a linear list of recipient addresses and the times at
21337 which they were sent messages. If the file is full when a new address needs to
21338 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21339 means that a given recipient may receive multiple messages, but at
21340 unpredictable intervals that depend on the rate of turnover of addresses in the
21341 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21342
21343
21344 .option once_file_size autoreply integer 0
21345 See &%once%& above.
21346
21347
21348 .option once_repeat autoreply time&!! 0s
21349 See &%once%& above.
21350 After expansion, the value of this option must be a valid time value.
21351
21352
21353 .option reply_to autoreply string&!! unset
21354 This specifies the contents of the &'Reply-To:'& header when the message is
21355 specified by the transport.
21356
21357
21358 .option return_message autoreply boolean false
21359 If this is set, a copy of the original message is returned with the new
21360 message, subject to the maximum size set in the &%return_size_limit%& global
21361 configuration option.
21362
21363
21364 .option subject autoreply string&!! unset
21365 This specifies the contents of the &'Subject:'& header when the message is
21366 specified by the transport. It is tempting to quote the original subject in
21367 automatic responses. For example:
21368 .code
21369 subject = Re: $h_subject:
21370 .endd
21371 There is a danger in doing this, however. It may allow a third party to
21372 subscribe your users to an opt-in mailing list, provided that the list accepts
21373 bounce messages as subscription confirmations. Well-managed lists require a
21374 non-bounce message to confirm a subscription, so the danger is relatively
21375 small.
21376
21377
21378
21379 .option text autoreply string&!! unset
21380 This specifies a single string to be used as the body of the message when the
21381 message is specified by the transport. If both &%text%& and &%file%& are set,
21382 the text comes first.
21383
21384
21385 .option to autoreply string&!! unset
21386 This specifies recipients of the message and the contents of the &'To:'& header
21387 when the message is specified by the transport.
21388 .ecindex IIDauttra1
21389 .ecindex IIDauttra2
21390
21391
21392
21393
21394 . ////////////////////////////////////////////////////////////////////////////
21395 . ////////////////////////////////////////////////////////////////////////////
21396
21397 .chapter "The lmtp transport" "CHAPLMTP"
21398 .cindex "transports" "&(lmtp)&"
21399 .cindex "&(lmtp)& transport"
21400 .cindex "LMTP" "over a pipe"
21401 .cindex "LMTP" "over a socket"
21402 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21403 specified command
21404 or by interacting with a Unix domain socket.
21405 This transport is something of a cross between the &(pipe)& and &(smtp)&
21406 transports. Exim also has support for using LMTP over TCP/IP; this is
21407 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21408 to be of minority interest, the default build-time configure in &_src/EDITME_&
21409 has it commented out. You need to ensure that
21410 .code
21411 TRANSPORT_LMTP=yes
21412 .endd
21413 .cindex "options" "&(lmtp)& transport"
21414 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21415 included in the Exim binary. The private options of the &(lmtp)& transport are
21416 as follows:
21417
21418 .option batch_id lmtp string&!! unset
21419 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21420
21421
21422 .option batch_max lmtp integer 1
21423 This limits the number of addresses that can be handled in a single delivery.
21424 Most LMTP servers can handle several addresses at once, so it is normally a
21425 good idea to increase this value. See the description of local delivery
21426 batching in chapter &<<CHAPbatching>>&.
21427
21428
21429 .option command lmtp string&!! unset
21430 This option must be set if &%socket%& is not set. The string is a command which
21431 is run in a separate process. It is split up into a command name and list of
21432 arguments, each of which is separately expanded (so expansion cannot change the
21433 number of arguments). The command is run directly, not via a shell. The message
21434 is passed to the new process using the standard input and output to operate the
21435 LMTP protocol.
21436
21437 .option ignore_quota lmtp boolean false
21438 .cindex "LMTP" "ignoring quota errors"
21439 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21440 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21441 in its response to the LHLO command.
21442
21443 .option socket lmtp string&!! unset
21444 This option must be set if &%command%& is not set. The result of expansion must
21445 be the name of a Unix domain socket. The transport connects to the socket and
21446 delivers the message to it using the LMTP protocol.
21447
21448
21449 .option timeout lmtp time 5m
21450 The transport is aborted if the created process or Unix domain socket does not
21451 respond to LMTP commands or message input within this timeout. Delivery
21452 is deferred, and will be tried again later. Here is an example of a typical
21453 LMTP transport:
21454 .code
21455 lmtp:
21456   driver = lmtp
21457   command = /some/local/lmtp/delivery/program
21458   batch_max = 20
21459   user = exim
21460 .endd
21461 This delivers up to 20 addresses at a time, in a mixture of domains if
21462 necessary, running as the user &'exim'&.
21463
21464
21465
21466 . ////////////////////////////////////////////////////////////////////////////
21467 . ////////////////////////////////////////////////////////////////////////////
21468
21469 .chapter "The pipe transport" "CHAPpipetransport"
21470 .scindex IIDpiptra1 "transports" "&(pipe)&"
21471 .scindex IIDpiptra2 "&(pipe)& transport"
21472 The &(pipe)& transport is used to deliver messages via a pipe to a command
21473 running in another process. One example is the use of &(pipe)& as a
21474 pseudo-remote transport for passing messages to some other delivery mechanism
21475 (such as UUCP). Another is the use by individual users to automatically process
21476 their incoming messages. The &(pipe)& transport can be used in one of the
21477 following ways:
21478
21479 .ilist
21480 .vindex "&$local_part$&"
21481 A router routes one address to a transport in the normal way, and the
21482 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21483 contains the local part of the address (as usual), and the command that is run
21484 is specified by the &%command%& option on the transport.
21485 .next
21486 .vindex "&$pipe_addresses$&"
21487 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21488 transport can handle more than one address in a single run. In this case, when
21489 more than one address is routed to the transport, &$local_part$& is not set
21490 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21491 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21492 that are routed to the transport.
21493 .next
21494 .vindex "&$address_pipe$&"
21495 A router redirects an address directly to a pipe command (for example, from an
21496 alias or forward file). In this case, &$address_pipe$& contains the text of the
21497 pipe command, and the &%command%& option on the transport is ignored. If only
21498 one address is being transported (&%batch_max%& is not greater than one, or
21499 only one address was redirected to this pipe command), &$local_part$& contains
21500 the local part that was redirected.
21501 .endlist
21502
21503
21504 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21505 deliver messages over pipes using the LMTP interactive protocol. This is
21506 implemented by the &(lmtp)& transport.
21507
21508 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21509 &_.forward_& file, the command runs under the uid and gid of that user. In
21510 other cases, the uid and gid have to be specified explicitly, either on the
21511 transport or on the router that handles the address. Current and &"home"&
21512 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21513 details of the local delivery environment and chapter &<<CHAPbatching>>&
21514 for a discussion of local delivery batching.
21515
21516
21517 .section "Concurrent delivery" "SECID140"
21518 If two messages arrive at almost the same time, and both are routed to a pipe
21519 delivery, the two pipe transports may be run concurrently. You must ensure that
21520 any pipe commands you set up are robust against this happening. If the commands
21521 write to a file, the &%exim_lock%& utility might be of use.
21522
21523
21524
21525
21526 .section "Returned status and data" "SECID141"
21527 .cindex "&(pipe)& transport" "returned data"
21528 If the command exits with a non-zero return code, the delivery is deemed to
21529 have failed, unless either the &%ignore_status%& option is set (in which case
21530 the return code is treated as zero), or the return code is one of those listed
21531 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21532 later"&. In this case, delivery is deferred. Details of a permanent failure are
21533 logged, but are not included in the bounce message, which merely contains
21534 &"local delivery failed"&.
21535
21536 If the command exits on a signal and the &%freeze_signal%& option is set then
21537 the message will be frozen in the queue. If that option is not set, a bounce
21538 will be sent as normal.
21539
21540 If the return code is greater than 128 and the command being run is a shell
21541 script, it normally means that the script was terminated by a signal whose
21542 value is the return code minus 128. The &%freeze_signal%& option does not
21543 apply in this case.
21544
21545 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21546 return code is set to 127. This is the value that a shell returns if it is
21547 asked to run a non-existent command. The wording for the log line suggests that
21548 a non-existent command may be the problem.
21549
21550 The &%return_output%& option can affect the result of a pipe delivery. If it is
21551 set and the command produces any output on its standard output or standard
21552 error streams, the command is considered to have failed, even if it gave a zero
21553 return code or if &%ignore_status%& is set. The output from the command is
21554 included as part of the bounce message. The &%return_fail_output%& option is
21555 similar, except that output is returned only when the command exits with a
21556 failure return code, that is, a value other than zero or a code that matches
21557 &%temp_errors%&.
21558
21559
21560
21561 .section "How the command is run" "SECThowcommandrun"
21562 .cindex "&(pipe)& transport" "path for command"
21563 The command line is (by default) broken down into a command name and arguments
21564 by the &(pipe)& transport itself. The &%allow_commands%& and
21565 &%restrict_to_path%& options can be used to restrict the commands that may be
21566 run.
21567
21568 .cindex "quoting" "in pipe command"
21569 Unquoted arguments are delimited by white space. If an argument appears in
21570 double quotes, backslash is interpreted as an escape character in the usual
21571 way. If an argument appears in single quotes, no escaping is done.
21572
21573 String expansion is applied to the command line except when it comes from a
21574 traditional &_.forward_& file (commands from a filter file are expanded). The
21575 expansion is applied to each argument in turn rather than to the whole line.
21576 For this reason, any string expansion item that contains white space must be
21577 quoted so as to be contained within a single argument. A setting such as
21578 .code
21579 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21580 .endd
21581 will not work, because the expansion item gets split between several
21582 arguments. You have to write
21583 .code
21584 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21585 .endd
21586 to ensure that it is all in one argument. The expansion is done in this way,
21587 argument by argument, so that the number of arguments cannot be changed as a
21588 result of expansion, and quotes or backslashes in inserted variables do not
21589 interact with external quoting. However, this leads to problems if you want to
21590 generate multiple arguments (or the command name plus arguments) from a single
21591 expansion. In this situation, the simplest solution is to use a shell. For
21592 example:
21593 .code
21594 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21595 .endd
21596
21597 .cindex "transport" "filter"
21598 .cindex "filter" "transport filter"
21599 .vindex "&$pipe_addresses$&"
21600 Special handling takes place when an argument consists of precisely the text
21601 &`$pipe_addresses`&. This is not a general expansion variable; the only
21602 place this string is recognized is when it appears as an argument for a pipe or
21603 transport filter command. It causes each address that is being handled to be
21604 inserted in the argument list at that point &'as a separate argument'&. This
21605 avoids any problems with spaces or shell metacharacters, and is of use when a
21606 &(pipe)& transport is handling groups of addresses in a batch.
21607
21608 After splitting up into arguments and expansion, the resulting command is run
21609 in a subprocess directly from the transport, &'not'& under a shell. The
21610 message that is being delivered is supplied on the standard input, and the
21611 standard output and standard error are both connected to a single pipe that is
21612 read by Exim. The &%max_output%& option controls how much output the command
21613 may produce, and the &%return_output%& and &%return_fail_output%& options
21614 control what is done with it.
21615
21616 Not running the command under a shell (by default) lessens the security risks
21617 in cases when a command from a user's filter file is built out of data that was
21618 taken from an incoming message. If a shell is required, it can of course be
21619 explicitly specified as the command to be run. However, there are circumstances
21620 where existing commands (for example, in &_.forward_& files) expect to be run
21621 under a shell and cannot easily be modified. To allow for these cases, there is
21622 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21623 works. Instead of breaking up the command line as just described, it expands it
21624 as a single string and passes the result to &_/bin/sh_&. The
21625 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21626 with &%use_shell%&, and the whole mechanism is inherently less secure.
21627
21628
21629
21630 .section "Environment variables" "SECTpipeenv"
21631 .cindex "&(pipe)& transport" "environment for command"
21632 .cindex "environment for pipe transport"
21633 The environment variables listed below are set up when the command is invoked.
21634 This list is a compromise for maximum compatibility with other MTAs. Note that
21635 the &%environment%& option can be used to add additional variables to this
21636 environment.
21637 .display
21638 &`DOMAIN            `&   the domain of the address
21639 &`HOME              `&   the home directory, if set
21640 &`HOST              `&   the host name when called from a router (see below)
21641 &`LOCAL_PART        `&   see below
21642 &`LOCAL_PART_PREFIX `&   see below
21643 &`LOCAL_PART_SUFFIX `&   see below
21644 &`LOGNAME           `&   see below
21645 &`MESSAGE_ID        `&   Exim's local ID for the message
21646 &`PATH              `&   as specified by the &%path%& option below
21647 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21648 &`RECIPIENT         `&   the complete recipient address
21649 &`SENDER            `&   the sender of the message (empty if a bounce)
21650 &`SHELL             `&   &`/bin/sh`&
21651 &`TZ                `&   the value of the &%timezone%& option, if set
21652 &`USER              `&   see below
21653 .endd
21654 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21655 router, LOCAL_PART is set to the local part of the address. When it is
21656 called as a result of a forward or alias expansion, LOCAL_PART is set to
21657 the local part of the address that was expanded. In both cases, any affixes are
21658 removed from the local part, and made available in LOCAL_PART_PREFIX and
21659 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21660 same value as LOCAL_PART for compatibility with other MTAs.
21661
21662 .cindex "HOST"
21663 HOST is set only when a &(pipe)& transport is called from a router that
21664 associates hosts with an address, typically when using &(pipe)& as a
21665 pseudo-remote transport. HOST is set to the first host name specified by
21666 the router.
21667
21668 .cindex "HOME"
21669 If the transport's generic &%home_directory%& option is set, its value is used
21670 for the HOME environment variable. Otherwise, a home directory may be set
21671 by the router's &%transport_home_directory%& option, which defaults to the
21672 user's home directory if &%check_local_user%& is set.
21673
21674
21675 .section "Private options for pipe" "SECID142"
21676 .cindex "options" "&(pipe)& transport"
21677
21678
21679
21680 .option allow_commands pipe "string list&!!" unset
21681 .cindex "&(pipe)& transport" "permitted commands"
21682 The string is expanded, and is then interpreted as a colon-separated list of
21683 permitted commands. If &%restrict_to_path%& is not set, the only commands
21684 permitted are those in the &%allow_commands%& list. They need not be absolute
21685 paths; the &%path%& option is still used for relative paths. If
21686 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21687 in the &%allow_commands%& list, or a name without any slashes that is found on
21688 the path. In other words, if neither &%allow_commands%& nor
21689 &%restrict_to_path%& is set, there is no restriction on the command, but
21690 otherwise only commands that are permitted by one or the other are allowed. For
21691 example, if
21692 .code
21693 allow_commands = /usr/bin/vacation
21694 .endd
21695 and &%restrict_to_path%& is not set, the only permitted command is
21696 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21697 &%use_shell%& is set.
21698
21699
21700 .option batch_id pipe string&!! unset
21701 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21702
21703
21704 .option batch_max pipe integer 1
21705 This limits the number of addresses that can be handled in a single delivery.
21706 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21707
21708
21709 .option check_string pipe string unset
21710 As &(pipe)& writes the message, the start of each line is tested for matching
21711 &%check_string%&, and if it does, the initial matching characters are replaced
21712 by the contents of &%escape_string%&, provided both are set. The value of
21713 &%check_string%& is a literal string, not a regular expression, and the case of
21714 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21715 of &%check_string%& and &%escape_string%& are forced to values that implement
21716 the SMTP escaping protocol. Any settings made in the configuration file are
21717 ignored.
21718
21719
21720 .option command pipe string&!! unset
21721 This option need not be set when &(pipe)& is being used to deliver to pipes
21722 obtained directly from address redirections. In other cases, the option must be
21723 set, to provide a command to be run. It need not yield an absolute path (see
21724 the &%path%& option below). The command is split up into separate arguments by
21725 Exim, and each argument is separately expanded, as described in section
21726 &<<SECThowcommandrun>>& above.
21727
21728
21729 .option environment pipe string&!! unset
21730 .cindex "&(pipe)& transport" "environment for command"
21731 .cindex "environment for &(pipe)& transport"
21732 This option is used to add additional variables to the environment in which the
21733 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21734 a string which is expanded, and then interpreted as a colon-separated list of
21735 environment settings of the form <&'name'&>=<&'value'&>.
21736
21737
21738 .option escape_string pipe string unset
21739 See &%check_string%& above.
21740
21741
21742 .option freeze_exec_fail pipe boolean false
21743 .cindex "exec failure"
21744 .cindex "failure of exec"
21745 .cindex "&(pipe)& transport" "failure of exec"
21746 Failure to exec the command in a pipe transport is by default treated like
21747 any other failure while running the command. However, if &%freeze_exec_fail%&
21748 is set, failure to exec is treated specially, and causes the message to be
21749 frozen, whatever the setting of &%ignore_status%&.
21750
21751
21752 .option freeze_signal pipe boolean false
21753 .cindex "signal exit"
21754 .cindex "&(pipe)& transport", "signal exit"
21755 Normally if the process run by a command in a pipe transport exits on a signal,
21756 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21757 frozen in Exim's queue instead.
21758
21759
21760 .option ignore_status pipe boolean false
21761 If this option is true, the status returned by the subprocess that is set up to
21762 run the command is ignored, and Exim behaves as if zero had been returned.
21763 Otherwise, a non-zero status or termination by signal causes an error return
21764 from the transport unless the status value is one of those listed in
21765 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21766
21767 &*Note*&: This option does not apply to timeouts, which do not return a status.
21768 See the &%timeout_defer%& option for how timeouts are handled.
21769
21770 .option log_defer_output pipe boolean false
21771 .cindex "&(pipe)& transport" "logging output"
21772 If this option is set, and the status returned by the command is
21773 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21774 and any output was produced, the first line of it is written to the main log.
21775
21776
21777 .option log_fail_output pipe boolean false
21778 If this option is set, and the command returns any output, and also ends with a
21779 return code that is neither zero nor one of the return codes listed in
21780 &%temp_errors%& (that is, the delivery failed), the first line of output is
21781 written to the main log. This option and &%log_output%& are mutually exclusive.
21782 Only one of them may be set.
21783
21784
21785
21786 .option log_output pipe boolean false
21787 If this option is set and the command returns any output, the first line of
21788 output is written to the main log, whatever the return code. This option and
21789 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21790
21791
21792
21793 .option max_output pipe integer 20K
21794 This specifies the maximum amount of output that the command may produce on its
21795 standard output and standard error file combined. If the limit is exceeded, the
21796 process running the command is killed. This is intended as a safety measure to
21797 catch runaway processes. The limit is applied independently of the settings of
21798 the options that control what is done with such output (for example,
21799 &%return_output%&). Because of buffering effects, the amount of output may
21800 exceed the limit by a small amount before Exim notices.
21801
21802
21803 .option message_prefix pipe string&!! "see below"
21804 The string specified here is expanded and output at the start of every message.
21805 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21806 .code
21807 message_prefix = \
21808   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21809   ${tod_bsdinbox}\n
21810 .endd
21811 .cindex "Cyrus"
21812 .cindex "&%tmail%&"
21813 .cindex "&""From""& line"
21814 This is required by the commonly used &_/usr/bin/vacation_& program.
21815 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21816 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21817 setting
21818 .code
21819 message_prefix =
21820 .endd
21821 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21822 &`\n`& to &`\r\n`& in &%message_prefix%&.
21823
21824
21825 .option message_suffix pipe string&!! "see below"
21826 The string specified here is expanded and output at the end of every message.
21827 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21828 The suffix can be suppressed by setting
21829 .code
21830 message_suffix =
21831 .endd
21832 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21833 &`\n`& to &`\r\n`& in &%message_suffix%&.
21834
21835
21836 .option path pipe string "see below"
21837 This option specifies the string that is set up in the PATH environment
21838 variable of the subprocess. The default is:
21839 .code
21840 /bin:/usr/bin
21841 .endd
21842 If the &%command%& option does not yield an absolute path name, the command is
21843 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21844 apply to a command specified as a transport filter.
21845
21846
21847 .option permit_coredump pipe boolean false
21848 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21849 a core-dump of a pipe command, enable this command.  This enables core-dumps
21850 during delivery and affects both the Exim binary and the pipe command run.
21851 It is recommended that this option remain off unless and until you have a need
21852 for it and that this only be enabled when needed, as the risk of excessive
21853 resource consumption can be quite high.  Note also that Exim is typically
21854 installed as a setuid binary and most operating systems will inhibit coredumps
21855 of these by default, so further OS-specific action may be required.
21856
21857
21858 .option pipe_as_creator pipe boolean false
21859 .cindex "uid (user id)" "local delivery"
21860 If the generic &%user%& option is not set and this option is true, the delivery
21861 process is run under the uid that was in force when Exim was originally called
21862 to accept the message. If the group id is not otherwise set (via the generic
21863 &%group%& option), the gid that was in force when Exim was originally called to
21864 accept the message is used.
21865
21866
21867 .option restrict_to_path pipe boolean false
21868 When this option is set, any command name not listed in &%allow_commands%& must
21869 contain no slashes. The command is searched for only in the directories listed
21870 in the &%path%& option. This option is intended for use in the case when a pipe
21871 command has been generated from a user's &_.forward_& file. This is usually
21872 handled by a &(pipe)& transport called &%address_pipe%&.
21873
21874
21875 .option return_fail_output pipe boolean false
21876 If this option is true, and the command produced any output and ended with a
21877 return code other than zero or one of the codes listed in &%temp_errors%& (that
21878 is, the delivery failed), the output is returned in the bounce message.
21879 However, if the message has a null sender (that is, it is itself a bounce
21880 message), output from the command is discarded. This option and
21881 &%return_output%& are mutually exclusive. Only one of them may be set.
21882
21883
21884
21885 .option return_output pipe boolean false
21886 If this option is true, and the command produced any output, the delivery is
21887 deemed to have failed whatever the return code from the command, and the output
21888 is returned in the bounce message. Otherwise, the output is just discarded.
21889 However, if the message has a null sender (that is, it is a bounce message),
21890 output from the command is always discarded, whatever the setting of this
21891 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21892 of them may be set.
21893
21894
21895
21896 .option temp_errors pipe "string list" "see below"
21897 .cindex "&(pipe)& transport" "temporary failure"
21898 This option contains either a colon-separated list of numbers, or a single
21899 asterisk. If &%ignore_status%& is false
21900 and &%return_output%& is not set,
21901 and the command exits with a non-zero return code, the failure is treated as
21902 temporary and the delivery is deferred if the return code matches one of the
21903 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21904 codes are treated as permanent errors. The default setting contains the codes
21905 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21906 compiled on a system that does not define these macros, it assumes values of 75
21907 and 73, respectively.
21908
21909
21910 .option timeout pipe time 1h
21911 If the command fails to complete within this time, it is killed. This normally
21912 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21913 specifies no timeout. In order to ensure that any subprocesses created by the
21914 command are also killed, Exim makes the initial process a process group leader,
21915 and kills the whole process group on a timeout. However, this can be defeated
21916 if one of the processes starts a new process group.
21917
21918 .option timeout_defer pipe boolean false
21919 A timeout in a &(pipe)& transport, either in the command that the transport
21920 runs, or in a transport filter that is associated with it, is by default
21921 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21922 is set true, both kinds of timeout become temporary errors, causing the
21923 delivery to be deferred.
21924
21925 .option umask pipe "octal integer" 022
21926 This specifies the umask setting for the subprocess that runs the command.
21927
21928
21929 .option use_bsmtp pipe boolean false
21930 .cindex "envelope sender"
21931 If this option is set true, the &(pipe)& transport writes messages in &"batch
21932 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21933 commands. If you want to include a leading HELO command with such messages,
21934 you can do so by setting the &%message_prefix%& option. See section
21935 &<<SECTbatchSMTP>>& for details of batch SMTP.
21936
21937 .option use_classresources pipe boolean false
21938 .cindex "class resources (BSD)"
21939 This option is available only when Exim is running on FreeBSD, NetBSD, or
21940 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21941 resource limits when a &(pipe)& transport is run to perform a delivery. The
21942 limits for the uid under which the pipe is to run are obtained from the login
21943 class database.
21944
21945
21946 .option use_crlf pipe boolean false
21947 .cindex "carriage return"
21948 .cindex "linefeed"
21949 This option causes lines to be terminated with the two-character CRLF sequence
21950 (carriage return, linefeed) instead of just a linefeed character. In the case
21951 of batched SMTP, the byte sequence written to the pipe is then an exact image
21952 of what would be sent down a real SMTP connection.
21953
21954 The contents of the &%message_prefix%& and &%message_suffix%& options are
21955 written verbatim, so must contain their own carriage return characters if these
21956 are needed. When &%use_bsmtp%& is not set, the default values for both
21957 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21958 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21959
21960
21961 .option use_shell pipe boolean false
21962 .vindex "&$pipe_addresses$&"
21963 If this option is set, it causes the command to be passed to &_/bin/sh_&
21964 instead of being run directly from the transport, as described in section
21965 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21966 where the command is expected to be run under a shell and cannot easily be
21967 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21968 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21969 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21970 its &%-c%& option.
21971
21972
21973
21974 .section "Using an external local delivery agent" "SECID143"
21975 .cindex "local delivery" "using an external agent"
21976 .cindex "&'procmail'&"
21977 .cindex "external local delivery"
21978 .cindex "delivery" "&'procmail'&"
21979 .cindex "delivery" "by external agent"
21980 The &(pipe)& transport can be used to pass all messages that require local
21981 delivery to a separate local delivery agent such as &%procmail%&. When doing
21982 this, care must be taken to ensure that the pipe is run under an appropriate
21983 uid and gid. In some configurations one wants this to be a uid that is trusted
21984 by the delivery agent to supply the correct sender of the message. It may be
21985 necessary to recompile or reconfigure the delivery agent so that it trusts an
21986 appropriate user. The following is an example transport and router
21987 configuration for &%procmail%&:
21988 .code
21989 # transport
21990 procmail_pipe:
21991   driver = pipe
21992   command = /usr/local/bin/procmail -d $local_part
21993   return_path_add
21994   delivery_date_add
21995   envelope_to_add
21996   check_string = "From "
21997   escape_string = ">From "
21998   umask = 077
21999   user = $local_part
22000   group = mail
22001
22002 # router
22003 procmail:
22004   driver = accept
22005   check_local_user
22006   transport = procmail_pipe
22007 .endd
22008 In this example, the pipe is run as the local user, but with the group set to
22009 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22010 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22011 user to supply a correct sender address. If you do not specify either a
22012 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22013 home directory is the user's home directory by default.
22014
22015 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22016 .code
22017 IFS=" "
22018 .endd
22019 as shown in some &%procmail%& documentation, because Exim does not by default
22020 use a shell to run pipe commands.
22021
22022 .cindex "Cyrus"
22023 The next example shows a transport and a router for a system where local
22024 deliveries are handled by the Cyrus IMAP server.
22025 .code
22026 # transport
22027 local_delivery_cyrus:
22028   driver = pipe
22029   command = /usr/cyrus/bin/deliver \
22030             -m ${substr_1:$local_part_suffix} -- $local_part
22031   user = cyrus
22032   group = mail
22033   return_output
22034   log_output
22035   message_prefix =
22036   message_suffix =
22037
22038 # router
22039 local_user_cyrus:
22040   driver = accept
22041   check_local_user
22042   local_part_suffix = .*
22043   transport = local_delivery_cyrus
22044 .endd
22045 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22046 &%return_output%& to cause any text written by Cyrus to be returned to the
22047 sender.
22048 .ecindex IIDpiptra1
22049 .ecindex IIDpiptra2
22050
22051
22052 . ////////////////////////////////////////////////////////////////////////////
22053 . ////////////////////////////////////////////////////////////////////////////
22054
22055 .chapter "The smtp transport" "CHAPsmtptrans"
22056 .scindex IIDsmttra1 "transports" "&(smtp)&"
22057 .scindex IIDsmttra2 "&(smtp)& transport"
22058 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22059 or LMTP protocol. The list of hosts to try can either be taken from the address
22060 that is being processed (having been set up by the router), or specified
22061 explicitly for the transport. Timeout and retry processing (see chapter
22062 &<<CHAPretry>>&) is applied to each IP address independently.
22063
22064
22065 .section "Multiple messages on a single connection" "SECID144"
22066 The sending of multiple messages over a single TCP/IP connection can arise in
22067 two ways:
22068
22069 .ilist
22070 If a message contains more than &%max_rcpt%& (see below) addresses that are
22071 routed to the same host, more than one copy of the message has to be sent to
22072 that host. In this situation, multiple copies may be sent in a single run of
22073 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22074 does when it has too many addresses to send in one message also depends on the
22075 value of the global &%remote_max_parallel%& option. Details are given in
22076 section &<<SECToutSMTPTCP>>&.)
22077 .next
22078 .cindex "hints database" "remembering routing"
22079 When a message has been successfully delivered over a TCP/IP connection, Exim
22080 looks in its hints database to see if there are any other messages awaiting a
22081 connection to the same host. If there are, a new delivery process is started
22082 for one of them, and the current TCP/IP connection is passed on to it. The new
22083 process may in turn send multiple copies and possibly create yet another
22084 process.
22085 .endlist
22086
22087
22088 For each copy sent over the same TCP/IP connection, a sequence counter is
22089 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22090 no further messages are sent over that connection.
22091
22092
22093
22094 .section "Use of the $host and $host_address variables" "SECID145"
22095 .vindex "&$host$&"
22096 .vindex "&$host_address$&"
22097 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22098 &$host_address$& are the name and IP address of the first host on the host list
22099 passed by the router. However, when the transport is about to connect to a
22100 specific host, and while it is connected to that host, &$host$& and
22101 &$host_address$& are set to the values for that host. These are the values
22102 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22103 &%serialize_hosts%&, and the various TLS options are expanded.
22104
22105
22106 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22107 .vindex &$tls_bits$&
22108 .vindex &$tls_cipher$&
22109 .vindex &$tls_peerdn$&
22110 .vindex &$tls_sni$&
22111 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22112 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22113 are the values that were set when the message was received.
22114 These are the values that are used for options that are expanded before any
22115 SMTP connections are made. Just before each connection is made, these four
22116 variables are emptied. If TLS is subsequently started, they are set to the
22117 appropriate values for the outgoing connection, and these are the values that
22118 are in force when any authenticators are run and when the
22119 &%authenticated_sender%& option is expanded.
22120
22121 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22122 and will be removed in a future release.
22123
22124
22125 .section "Private options for smtp" "SECID146"
22126 .cindex "options" "&(smtp)& transport"
22127 The private options of the &(smtp)& transport are as follows:
22128
22129
22130 .option address_retry_include_sender smtp boolean true
22131 .cindex "4&'xx'& responses" "retrying after"
22132 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22133 is the combination of sender and recipient that is delayed in subsequent queue
22134 runs until the retry time is reached. You can delay the recipient without
22135 reference to the sender (which is what earlier versions of Exim did), by
22136 setting &%address_retry_include_sender%& false. However, this can lead to
22137 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22138
22139 .option allow_localhost smtp boolean false
22140 .cindex "local host" "sending to"
22141 .cindex "fallback" "hosts specified on transport"
22142 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22143 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22144 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22145 the delivery anyway. This should be used only in special cases when the
22146 configuration ensures that no looping will result (for example, a differently
22147 configured Exim is listening on the port to which the message is sent).
22148
22149
22150 .option authenticated_sender smtp string&!! unset
22151 .cindex "Cyrus"
22152 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22153 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22154 overriding any existing authenticated sender value. If the string expansion is
22155 forced to fail, the option is ignored. Other expansion failures cause delivery
22156 to be deferred. If the result of expansion is an empty string, that is also
22157 ignored.
22158
22159 The expansion happens after the outgoing connection has been made and TLS
22160 started, if required. This means that the &$host$&, &$host_address$&,
22161 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22162 particular connection.
22163
22164 If the SMTP session is not authenticated, the expansion of
22165 &%authenticated_sender%& still happens (and can cause the delivery to be
22166 deferred if it fails), but no AUTH= item is added to MAIL commands
22167 unless &%authenticated_sender_force%& is true.
22168
22169 This option allows you to use the &(smtp)& transport in LMTP mode to
22170 deliver mail to Cyrus IMAP and provide the proper local part as the
22171 &"authenticated sender"&, via a setting such as:
22172 .code
22173 authenticated_sender = $local_part
22174 .endd
22175 This removes the need for IMAP subfolders to be assigned special ACLs to
22176 allow direct delivery to those subfolders.
22177
22178 Because of expected uses such as that just described for Cyrus (when no
22179 domain is involved), there is no checking on the syntax of the provided
22180 value.
22181
22182
22183 .option authenticated_sender_force smtp boolean false
22184 If this option is set true, the &%authenticated_sender%& option's value
22185 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22186 authenticated as a client.
22187
22188
22189 .option command_timeout smtp time 5m
22190 This sets a timeout for receiving a response to an SMTP command that has been
22191 sent out. It is also used when waiting for the initial banner line from the
22192 remote host. Its value must not be zero.
22193
22194
22195 .option connect_timeout smtp time 5m
22196 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22197 to a remote host. A setting of zero allows the system timeout (typically
22198 several minutes) to act. To have any effect, the value of this option must be
22199 less than the system timeout. However, it has been observed that on some
22200 systems there is no system timeout, which is why the default value for this
22201 option is 5 minutes, a value recommended by RFC 1123.
22202
22203
22204 .option connection_max_messages smtp integer 500
22205 .cindex "SMTP" "passed connection"
22206 .cindex "SMTP" "multiple deliveries"
22207 .cindex "multiple SMTP deliveries"
22208 This controls the maximum number of separate message deliveries that are sent
22209 over a single TCP/IP connection. If the value is zero, there is no limit.
22210 For testing purposes, this value can be overridden by the &%-oB%& command line
22211 option.
22212
22213
22214 .option data_timeout smtp time 5m
22215 This sets a timeout for the transmission of each block in the data portion of
22216 the message. As a result, the overall timeout for a message depends on the size
22217 of the message. Its value must not be zero. See also &%final_timeout%&.
22218
22219
22220 .option delay_after_cutoff smtp boolean true
22221 This option controls what happens when all remote IP addresses for a given
22222 domain have been inaccessible for so long that they have passed their retry
22223 cutoff times.
22224
22225 In the default state, if the next retry time has not been reached for any of
22226 them, the address is bounced without trying any deliveries. In other words,
22227 Exim delays retrying an IP address after the final cutoff time until a new
22228 retry time is reached, and can therefore bounce an address without ever trying
22229 a delivery, when machines have been down for a long time. Some people are
22230 unhappy at this prospect, so...
22231
22232 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22233 addresses are past their final cutoff time, Exim tries to deliver to those
22234 IP addresses that have not been tried since the message arrived. If there are
22235 none, of if they all fail, the address is bounced. In other words, it does not
22236 delay when a new message arrives, but immediately tries those expired IP
22237 addresses that haven't been tried since the message arrived. If there is a
22238 continuous stream of messages for the dead hosts, unsetting
22239 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22240 to them.
22241
22242
22243 .option dns_qualify_single smtp boolean true
22244 If the &%hosts%& or &%fallback_hosts%& option is being used,
22245 and the &%gethostbyname%& option is false,
22246 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22247 in chapter &<<CHAPdnslookup>>& for more details.
22248
22249
22250 .option dns_search_parents smtp boolean false
22251 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22252 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22253 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22254 details.
22255
22256
22257 .new
22258 .option dscp smtp string&!! unset
22259 .cindex "DCSP" "outbound"
22260 This option causes the DSCP value associated with a socket to be set to one
22261 of a number of fixed strings or to numeric value.
22262 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22263 Common values include &`throughput`&, &`mincost`&, and on newer systems
22264 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22265
22266 The outbound packets from Exim will be marked with this value in the header
22267 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22268 that these values will have any effect, not be stripped by networking
22269 equipment, or do much of anything without cooperation with your Network
22270 Engineer and those of all network operators between the source and destination.
22271 .wen
22272
22273
22274 .option fallback_hosts smtp "string list" unset
22275 .cindex "fallback" "hosts specified on transport"
22276 String expansion is not applied to this option. The argument must be a
22277 colon-separated list of host names or IP addresses, optionally also including
22278 port numbers, though the separator can be changed, as described in section
22279 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22280 item in a &%route_list%& setting for the &(manualroute)& router, as described
22281 in section &<<SECTformatonehostitem>>&.
22282
22283 Fallback hosts can also be specified on routers, which associate them with the
22284 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22285 &%fallback_hosts%& specified on the transport is used only if the address does
22286 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22287 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22288 However, &%hosts_randomize%& does apply to fallback host lists.
22289
22290 If Exim is unable to deliver to any of the hosts for a particular address, and
22291 the errors are not permanent rejections, the address is put on a separate
22292 transport queue with its host list replaced by the fallback hosts, unless the
22293 address was routed via MX records and the current host was in the original MX
22294 list. In that situation, the fallback host list is not used.
22295
22296 Once normal deliveries are complete, the fallback queue is delivered by
22297 re-running the same transports with the new host lists. If several failing
22298 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22299 copy of the message is sent.
22300
22301 The resolution of the host names on the fallback list is controlled by the
22302 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22303 both to cases when the host list comes with the address and when it is taken
22304 from &%hosts%&. This option provides a &"use a smart host only if delivery
22305 fails"& facility.
22306
22307
22308 .option final_timeout smtp time 10m
22309 This is the timeout that applies while waiting for the response to the final
22310 line containing just &"."& that terminates a message. Its value must not be
22311 zero.
22312
22313 .option gethostbyname smtp boolean false
22314 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22315 being used, names are looked up using &[gethostbyname()]&
22316 (or &[getipnodebyname()]& when available)
22317 instead of using the DNS. Of course, that function may in fact use the DNS, but
22318 it may also consult other sources of information such as &_/etc/hosts_&.
22319
22320 .option gnutls_compat_mode smtp boolean unset
22321 This option controls whether GnuTLS is used in compatibility mode in an Exim
22322 server. This reduces security slightly, but improves interworking with older
22323 implementations of TLS.
22324
22325 .option helo_data smtp string&!! "see below"
22326 .cindex "HELO" "argument, setting"
22327 .cindex "EHLO" "argument, setting"
22328 .cindex "LHLO argument setting"
22329 The value of this option is expanded after a connection to a another host has
22330 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22331 command that starts the outgoing SMTP or LMTP session. The default value of the
22332 option is:
22333 .code
22334 $primary_hostname
22335 .endd
22336 During the expansion, the variables &$host$& and &$host_address$& are set to
22337 the identity of the remote host, and the variables &$sending_ip_address$& and
22338 &$sending_port$& are set to the local IP address and port number that are being
22339 used. These variables can be used to generate different values for different
22340 servers or different local IP addresses. For example, if you want the string
22341 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22342 interface address, you could use this:
22343 .code
22344 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22345   {$primary_hostname}}
22346 .endd
22347 The use of &%helo_data%& applies both to sending messages and when doing
22348 callouts.
22349
22350 .option hosts smtp "string list&!!" unset
22351 Hosts are associated with an address by a router such as &(dnslookup)&, which
22352 finds the hosts by looking up the address domain in the DNS, or by
22353 &(manualroute)&, which has lists of hosts in its configuration. However,
22354 email addresses can be passed to the &(smtp)& transport by any router, and not
22355 all of them can provide an associated list of hosts.
22356
22357 The &%hosts%& option specifies a list of hosts to be used if the address being
22358 processed does not have any hosts associated with it. The hosts specified by
22359 &%hosts%& are also used, whether or not the address has its own hosts, if
22360 &%hosts_override%& is set.
22361
22362 The string is first expanded, before being interpreted as a colon-separated
22363 list of host names or IP addresses, possibly including port numbers. The
22364 separator may be changed to something other than colon, as described in section
22365 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22366 item in a &%route_list%& setting for the &(manualroute)& router, as described
22367 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22368 of the &(manualroute)& router is not available here.
22369
22370 If the expansion fails, delivery is deferred. Unless the failure was caused by
22371 the inability to complete a lookup, the error is logged to the panic log as
22372 well as the main log. Host names are looked up either by searching directly for
22373 address records in the DNS or by calling &[gethostbyname()]& (or
22374 &[getipnodebyname()]& when available), depending on the setting of the
22375 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22376 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22377 address are used.
22378
22379 During delivery, the hosts are tried in order, subject to their retry status,
22380 unless &%hosts_randomize%& is set.
22381
22382
22383 .option hosts_avoid_esmtp smtp "host list&!!" unset
22384 .cindex "ESMTP, avoiding use of"
22385 .cindex "HELO" "forcing use of"
22386 .cindex "EHLO" "avoiding use of"
22387 .cindex "PIPELINING" "avoiding the use of"
22388 This option is for use with broken hosts that announce ESMTP facilities (for
22389 example, PIPELINING) and then fail to implement them properly. When a host
22390 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22391 start of the SMTP session. This means that it cannot use any of the ESMTP
22392 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22393
22394
22395 .option hosts_avoid_pipelining smtp "host list&!!" unset
22396 .cindex "PIPELINING" "avoiding the use of"
22397 Exim will not use the SMTP PIPELINING extension when delivering to any host
22398 that matches this list, even if the server host advertises PIPELINING support.
22399
22400
22401 .option hosts_avoid_tls smtp "host list&!!" unset
22402 .cindex "TLS" "avoiding for certain hosts"
22403 Exim will not try to start a TLS session when delivering to any host that
22404 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22405
22406 .option hosts_verify_avoid_tls smtp "host list&!!" *
22407 .cindex "TLS" "avoiding for certain hosts"
22408 Exim will not try to start a TLS session for a verify callout,
22409 or when delivering in cutthrough mode,
22410 to any host that matches this list.
22411 Note that the default is to not use TLS.
22412
22413
22414 .option hosts_max_try smtp integer 5
22415 .cindex "host" "maximum number to try"
22416 .cindex "limit" "number of hosts tried"
22417 .cindex "limit" "number of MX tried"
22418 .cindex "MX record" "maximum tried"
22419 This option limits the number of IP addresses that are tried for any one
22420 delivery in cases where there are temporary delivery errors. Section
22421 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22422
22423
22424 .option hosts_max_try_hardlimit smtp integer 50
22425 This is an additional check on the maximum number of IP addresses that Exim
22426 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22427 why it exists.
22428
22429
22430
22431 .option hosts_nopass_tls smtp "host list&!!" unset
22432 .cindex "TLS" "passing connection"
22433 .cindex "multiple SMTP deliveries"
22434 .cindex "TLS" "multiple message deliveries"
22435 For any host that matches this list, a connection on which a TLS session has
22436 been started will not be passed to a new delivery process for sending another
22437 message on the same connection. See section &<<SECTmulmessam>>& for an
22438 explanation of when this might be needed.
22439
22440
22441 .option hosts_override smtp boolean false
22442 If this option is set and the &%hosts%& option is also set, any hosts that are
22443 attached to the address are ignored, and instead the hosts specified by the
22444 &%hosts%& option are always used. This option does not apply to
22445 &%fallback_hosts%&.
22446
22447
22448 .option hosts_randomize smtp boolean false
22449 .cindex "randomized host list"
22450 .cindex "host" "list of; randomized"
22451 .cindex "fallback" "randomized hosts"
22452 If this option is set, and either the list of hosts is taken from the
22453 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22454 were not obtained from MX records (this includes fallback hosts from the
22455 router), and were not randomized by the router, the order of trying the hosts
22456 is randomized each time the transport runs. Randomizing the order of a host
22457 list can be used to do crude load sharing.
22458
22459 When &%hosts_randomize%& is true, a host list may be split into groups whose
22460 order is separately randomized. This makes it possible to set up MX-like
22461 behaviour. The boundaries between groups are indicated by an item that is just
22462 &`+`& in the host list. For example:
22463 .code
22464 hosts = host1:host2:host3:+:host4:host5
22465 .endd
22466 The order of the first three hosts and the order of the last two hosts is
22467 randomized for each use, but the first three always end up before the last two.
22468 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22469
22470 .option hosts_require_auth smtp "host list&!!" unset
22471 .cindex "authentication" "required by client"
22472 This option provides a list of servers for which authentication must succeed
22473 before Exim will try to transfer a message. If authentication fails for
22474 servers which are not in this list, Exim tries to send unauthenticated. If
22475 authentication fails for one of these servers, delivery is deferred. This
22476 temporary error is detectable in the retry rules, so it can be turned into a
22477 hard failure if required. See also &%hosts_try_auth%&, and chapter
22478 &<<CHAPSMTPAUTH>>& for details of authentication.
22479
22480
22481 .option hosts_require_tls smtp "host list&!!" unset
22482 .cindex "TLS" "requiring for certain servers"
22483 Exim will insist on using a TLS session when delivering to any host that
22484 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22485 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22486 incoming messages, use an appropriate ACL.
22487
22488 .option hosts_try_auth smtp "host list&!!" unset
22489 .cindex "authentication" "optional in client"
22490 This option provides a list of servers to which, provided they announce
22491 authentication support, Exim will attempt to authenticate as a client when it
22492 connects. If authentication fails, Exim will try to transfer the message
22493 unauthenticated. See also &%hosts_require_auth%&, and chapter
22494 &<<CHAPSMTPAUTH>>& for details of authentication.
22495
22496 .option interface smtp "string list&!!" unset
22497 .cindex "bind IP address"
22498 .cindex "IP address" "binding"
22499 .vindex "&$host$&"
22500 .vindex "&$host_address$&"
22501 This option specifies which interface to bind to when making an outgoing SMTP
22502 call. The value is an IP address, not an interface name such as
22503 &`eth0`&. Do not confuse this with the interface address that was used when a
22504 message was received, which is in &$received_ip_address$&, formerly known as
22505 &$interface_address$&. The name was changed to minimize confusion with the
22506 outgoing interface address. There is no variable that contains an outgoing
22507 interface address because, unless it is set by this option, its value is
22508 unknown.
22509
22510 During the expansion of the &%interface%& option the variables &$host$& and
22511 &$host_address$& refer to the host to which a connection is about to be made
22512 during the expansion of the string. Forced expansion failure, or an empty
22513 string result causes the option to be ignored. Otherwise, after expansion, the
22514 string must be a list of IP addresses, colon-separated by default, but the
22515 separator can be changed in the usual way. For example:
22516 .code
22517 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22518 .endd
22519 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22520 connection. If none of them are the correct type, the option is ignored. If
22521 &%interface%& is not set, or is ignored, the system's IP functions choose which
22522 interface to use if the host has more than one.
22523
22524
22525 .option keepalive smtp boolean true
22526 .cindex "keepalive" "on outgoing connection"
22527 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22528 connections. When set, it causes the kernel to probe idle connections
22529 periodically, by sending packets with &"old"& sequence numbers. The other end
22530 of the connection should send a acknowledgment if the connection is still okay
22531 or a reset if the connection has been aborted. The reason for doing this is
22532 that it has the beneficial effect of freeing up certain types of connection
22533 that can get stuck when the remote host is disconnected without tidying up the
22534 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22535 unreachable hosts.
22536
22537
22538 .option lmtp_ignore_quota smtp boolean false
22539 .cindex "LMTP" "ignoring quota errors"
22540 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22541 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22542 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22543
22544 .option max_rcpt smtp integer 100
22545 .cindex "RCPT" "maximum number of outgoing"
22546 This option limits the number of RCPT commands that are sent in a single
22547 SMTP message transaction. Each set of addresses is treated independently, and
22548 so can cause parallel connections to the same host if &%remote_max_parallel%&
22549 permits this.
22550
22551
22552 .option multi_domain smtp boolean true
22553 .vindex "&$domain$&"
22554 When this option is set, the &(smtp)& transport can handle a number of
22555 addresses containing a mixture of different domains provided they all resolve
22556 to the same list of hosts. Turning the option off restricts the transport to
22557 handling only one domain at a time. This is useful if you want to use
22558 &$domain$& in an expansion for the transport, because it is set only when there
22559 is a single domain involved in a remote delivery.
22560
22561
22562 .option port smtp string&!! "see below"
22563 .cindex "port" "sending TCP/IP"
22564 .cindex "TCP/IP" "setting outgoing port"
22565 This option specifies the TCP/IP port on the server to which Exim connects.
22566 &*Note:*& Do not confuse this with the port that was used when a message was
22567 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22568 The name was changed to minimize confusion with the outgoing port. There is no
22569 variable that contains an outgoing port.
22570
22571 If the value of this option begins with a digit it is taken as a port number;
22572 otherwise it is looked up using &[getservbyname()]&. The default value is
22573 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22574 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22575 is deferred.
22576
22577
22578
22579 .option protocol smtp string smtp
22580 .cindex "LMTP" "over TCP/IP"
22581 .cindex "ssmtp protocol" "outbound"
22582 .cindex "TLS" "SSL-on-connect outbound"
22583 .vindex "&$port$&"
22584 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22585 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22586 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22587 deliveries into closed message stores. Exim also has support for running LMTP
22588 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22589
22590 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22591 changes to &"smtps"&, and the transport initiates TLS immediately after
22592 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22593 The Internet standards bodies strongly discourage use of this mode.
22594
22595
22596 .option retry_include_ip_address smtp boolean true
22597 Exim normally includes both the host name and the IP address in the key it
22598 constructs for indexing retry data after a temporary delivery failure. This
22599 means that when one of several IP addresses for a host is failing, it gets
22600 tried periodically (controlled by the retry rules), but use of the other IP
22601 addresses is not affected.
22602
22603 However, in some dialup environments hosts are assigned a different IP address
22604 each time they connect. In this situation the use of the IP address as part of
22605 the retry key leads to undesirable behaviour. Setting this option false causes
22606 Exim to use only the host name. This should normally be done on a separate
22607 instance of the &(smtp)& transport, set up specially to handle the dialup
22608 hosts.
22609
22610
22611 .option serialize_hosts smtp "host list&!!" unset
22612 .cindex "serializing connections"
22613 .cindex "host" "serializing connections"
22614 Because Exim operates in a distributed manner, if several messages for the same
22615 host arrive at around the same time, more than one simultaneous connection to
22616 the remote host can occur. This is not usually a problem except when there is a
22617 slow link between the hosts. In that situation it may be helpful to restrict
22618 Exim to one connection at a time. This can be done by setting
22619 &%serialize_hosts%& to match the relevant hosts.
22620
22621 .cindex "hints database" "serializing deliveries to a host"
22622 Exim implements serialization by means of a hints database in which a record is
22623 written whenever a process connects to one of the restricted hosts. The record
22624 is deleted when the connection is completed. Obviously there is scope for
22625 records to get left lying around if there is a system or program crash. To
22626 guard against this, Exim ignores any records that are more than six hours old.
22627
22628 If you set up this kind of serialization, you should also arrange to delete the
22629 relevant hints database whenever your system reboots. The names of the files
22630 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22631 may be one or two files, depending on the type of DBM in use. The same files
22632 are used for ETRN serialization.
22633
22634
22635 .option size_addition smtp integer 1024
22636 .cindex "SMTP" "SIZE"
22637 .cindex "message" "size issue for transport filter"
22638 .cindex "size" "of message"
22639 .cindex "transport" "filter"
22640 .cindex "filter" "transport filter"
22641 If a remote SMTP server indicates that it supports the SIZE option of the
22642 MAIL command, Exim uses this to pass over the message size at the start of
22643 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22644 sends, to allow for headers and other text that may be added during delivery by
22645 configuration options or in a transport filter. It may be necessary to increase
22646 this if a lot of text is added to messages.
22647
22648 Alternatively, if the value of &%size_addition%& is set negative, it disables
22649 the use of the SIZE option altogether.
22650
22651
22652 .option tls_certificate smtp string&!! unset
22653 .cindex "TLS" "client certificate, location of"
22654 .cindex "certificate" "client, location of"
22655 .vindex "&$host$&"
22656 .vindex "&$host_address$&"
22657 The value of this option must be the absolute path to a file which contains the
22658 client's certificate, for possible use when sending a message over an encrypted
22659 connection. The values of &$host$& and &$host_address$& are set to the name and
22660 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22661 details of TLS.
22662
22663 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22664 certificate when sending messages as a client. The global option of the same
22665 name specifies the certificate for Exim as a server; it is not automatically
22666 assumed that the same certificate should be used when Exim is operating as a
22667 client.
22668
22669
22670 .option tls_crl smtp string&!! unset
22671 .cindex "TLS" "client certificate revocation list"
22672 .cindex "certificate" "revocation list for client"
22673 This option specifies a certificate revocation list. The expanded value must
22674 be the name of a file that contains a CRL in PEM format.
22675
22676
22677 .new
22678 .option tls_dh_min_bits smtp integer 1024
22679 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
22680 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
22681 key agreement is negotiated, the server will provide a large prime number
22682 for use.  This option establishes the minimum acceptable size of that number.
22683 If the parameter offered by the server is too small, then the TLS handshake
22684 will fail.
22685
22686 Only supported when using GnuTLS.
22687 .wen
22688
22689
22690 .option tls_privatekey smtp string&!! unset
22691 .cindex "TLS" "client private key, location of"
22692 .vindex "&$host$&"
22693 .vindex "&$host_address$&"
22694 The value of this option must be the absolute path to a file which contains the
22695 client's private key. This is used when sending a message over an encrypted
22696 connection using a client certificate. The values of &$host$& and
22697 &$host_address$& are set to the name and address of the server during the
22698 expansion. If this option is unset, or the expansion is forced to fail, or the
22699 result is an empty string, the private key is assumed to be in the same file as
22700 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22701
22702
22703 .option tls_require_ciphers smtp string&!! unset
22704 .cindex "TLS" "requiring specific ciphers"
22705 .cindex "cipher" "requiring specific"
22706 .vindex "&$host$&"
22707 .vindex "&$host_address$&"
22708 The value of this option must be a list of permitted cipher suites, for use
22709 when setting up an outgoing encrypted connection. (There is a global option of
22710 the same name for controlling incoming connections.) The values of &$host$& and
22711 &$host_address$& are set to the name and address of the server during the
22712 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22713 is used in different ways by OpenSSL and GnuTLS (see sections
22714 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22715 ciphers is a preference order.
22716
22717
22718
22719 .option tls_sni smtp string&!! unset
22720 .cindex "TLS" "Server Name Indication"
22721 .vindex "&$tls_sni$&"
22722 If this option is set then it sets the $tls_out_sni variable and causes any
22723 TLS session to pass this value as the Server Name Indication extension to
22724 the remote side, which can be used by the remote side to select an appropriate
22725 certificate and private key for the session.
22726
22727 See &<<SECTtlssni>>& for more information.
22728
22729 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
22730 TLS extensions.
22731
22732
22733
22734
22735 .option tls_tempfail_tryclear smtp boolean true
22736 .cindex "4&'xx'& responses" "to STARTTLS"
22737 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22738 setting up a TLS session, this option determines whether or not Exim should try
22739 to deliver the message unencrypted. If it is set false, delivery to the
22740 current host is deferred; if there are other hosts, they are tried. If this
22741 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22742 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22743 TLS negotiation fails, Exim closes the current connection (because it is in an
22744 unknown state), opens a new one to the same host, and then tries the delivery
22745 in clear.
22746
22747
22748 .option tls_verify_certificates smtp string&!! unset
22749 .cindex "TLS" "server certificate verification"
22750 .cindex "certificate" "verification of server"
22751 .vindex "&$host$&"
22752 .vindex "&$host_address$&"
22753 The value of this option must be the absolute path to a file containing
22754 permitted server certificates, for use when setting up an encrypted connection.
22755 Alternatively, if you are using OpenSSL, you can set
22756 &%tls_verify_certificates%& to the name of a directory containing certificate
22757 files. This does not work with GnuTLS; the option must be set to the name of a
22758 single file if you are using GnuTLS. The values of &$host$& and
22759 &$host_address$& are set to the name and address of the server during the
22760 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22761
22762
22763
22764
22765 .section "How the limits for the number of hosts to try are used" &&&
22766          "SECTvalhosmax"
22767 .cindex "host" "maximum number to try"
22768 .cindex "limit" "hosts; maximum number tried"
22769 There are two options that are concerned with the number of hosts that are
22770 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22771 &%hosts_max_try_hardlimit%&.
22772
22773
22774 The &%hosts_max_try%& option limits the number of hosts that are tried
22775 for a single delivery. However, despite the term &"host"& in its name, the
22776 option actually applies to each IP address independently. In other words, a
22777 multihomed host is treated as several independent hosts, just as it is for
22778 retrying.
22779
22780 Many of the larger ISPs have multiple MX records which often point to
22781 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22782 created as a result of routing one of these domains.
22783
22784 Trying every single IP address on such a long list does not seem sensible; if
22785 several at the top of the list fail, it is reasonable to assume there is some
22786 problem that is likely to affect all of them. Roughly speaking, the value of
22787 &%hosts_max_try%& is the maximum number that are tried before deferring the
22788 delivery. However, the logic cannot be quite that simple.
22789
22790 Firstly, IP addresses that are skipped because their retry times have not
22791 arrived do not count, and in addition, addresses that are past their retry
22792 limits are also not counted, even when they are tried. This means that when
22793 some IP addresses are past their retry limits, more than the value of
22794 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22795 that all IP addresses are considered before timing out an email address (but
22796 see below for an exception).
22797
22798 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22799 list to see if there is a subsequent host with a different (higher valued) MX.
22800 If there is, that host is considered next, and the current IP address is used
22801 but not counted. This behaviour helps in the case of a domain with a retry rule
22802 that hardly ever delays any hosts, as is now explained:
22803
22804 Consider the case of a long list of hosts with one MX value, and a few with a
22805 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22806 hosts at the top of the list are tried at first. With the default retry rule,
22807 which specifies increasing retry times, the higher MX hosts are eventually
22808 tried when those at the top of the list are skipped because they have not
22809 reached their retry times.
22810
22811 However, it is common practice to put a fixed short retry time on domains for
22812 large ISPs, on the grounds that their servers are rarely down for very long.
22813 Unfortunately, these are exactly the domains that tend to resolve to long lists
22814 of hosts. The short retry time means that the lowest MX hosts are tried every
22815 time. The attempts may be in a different order because of random sorting, but
22816 without the special MX check, the higher MX hosts would never be tried until
22817 all the lower MX hosts had timed out (which might be several days), because
22818 there are always some lower MX hosts that have reached their retry times. With
22819 the special check, Exim considers at least one IP address from each MX value at
22820 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22821 reached.
22822
22823 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22824 particular, Exim normally eventually tries all the IP addresses before timing
22825 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22826 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22827 been set up with hundreds of IP addresses for some domains. It can
22828 take a very long time indeed for an address to time out in these cases.
22829
22830 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22831 Exim never tries more than this number of IP addresses; if it hits this limit
22832 and they are all timed out, the email address is bounced, even though not all
22833 possible IP addresses have been tried.
22834 .ecindex IIDsmttra1
22835 .ecindex IIDsmttra2
22836
22837
22838
22839
22840
22841 . ////////////////////////////////////////////////////////////////////////////
22842 . ////////////////////////////////////////////////////////////////////////////
22843
22844 .chapter "Address rewriting" "CHAPrewrite"
22845 .scindex IIDaddrew "rewriting" "addresses"
22846 There are some circumstances in which Exim automatically rewrites domains in
22847 addresses. The two most common are when an address is given without a domain
22848 (referred to as an &"unqualified address"&) or when an address contains an
22849 abbreviated domain that is expanded by DNS lookup.
22850
22851 Unqualified envelope addresses are accepted only for locally submitted
22852 messages, or for messages that are received from hosts matching
22853 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22854 appropriate. Unqualified addresses in header lines are qualified if they are in
22855 locally submitted messages, or messages from hosts that are permitted to send
22856 unqualified envelope addresses. Otherwise, unqualified addresses in header
22857 lines are neither qualified nor rewritten.
22858
22859 One situation in which Exim does &'not'& automatically rewrite a domain is
22860 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22861 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22862 do this. The new RFCs do not contain this suggestion.
22863
22864
22865 .section "Explicitly configured address rewriting" "SECID147"
22866 This chapter describes the rewriting rules that can be used in the
22867 main rewrite section of the configuration file, and also in the generic
22868 &%headers_rewrite%& option that can be set on any transport.
22869
22870 Some people believe that configured address rewriting is a Mortal Sin.
22871 Others believe that life is not possible without it. Exim provides the
22872 facility; you do not have to use it.
22873
22874 The main rewriting rules that appear in the &"rewrite"& section of the
22875 configuration file are applied to addresses in incoming messages, both envelope
22876 addresses and addresses in header lines. Each rule specifies the types of
22877 address to which it applies.
22878
22879 Whether or not addresses in header lines are rewritten depends on the origin of
22880 the headers and the type of rewriting. Global rewriting, that is, rewriting
22881 rules from the rewrite section of the configuration file, is applied only to
22882 those headers that were received with the message. Header lines that are added
22883 by ACLs or by a system filter or by individual routers or transports (which
22884 are specific to individual recipient addresses) are not rewritten by the global
22885 rules.
22886
22887 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22888 applies all headers except those added by routers and transports. That is, as
22889 well as the headers that were received with the message, it also applies to
22890 headers that were added by an ACL or a system filter.
22891
22892
22893 In general, rewriting addresses from your own system or domain has some
22894 legitimacy. Rewriting other addresses should be done only with great care and
22895 in special circumstances. The author of Exim believes that rewriting should be
22896 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22897 Although it can sometimes be used as a routing tool, this is very strongly
22898 discouraged.
22899
22900 There are two commonly encountered circumstances where rewriting is used, as
22901 illustrated by these examples:
22902
22903 .ilist
22904 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22905 exchange mail with each other behind a firewall, but there is only a single
22906 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22907 &'hitch.fict.example'& when sending mail off-site.
22908 .next
22909 A host rewrites the local parts of its own users so that, for example,
22910 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22911 .endlist
22912
22913
22914
22915 .section "When does rewriting happen?" "SECID148"
22916 .cindex "rewriting" "timing of"
22917 .cindex "&ACL;" "rewriting addresses in"
22918 Configured address rewriting can take place at several different stages of a
22919 message's processing.
22920
22921 .vindex "&$sender_address$&"
22922 At the start of an ACL for MAIL, the sender address may have been rewritten
22923 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22924 ordinary rewrite rules have yet been applied. If, however, the sender address
22925 is verified in the ACL, it is rewritten before verification, and remains
22926 rewritten thereafter. The subsequent value of &$sender_address$& is the
22927 rewritten address. This also applies if sender verification happens in a
22928 RCPT ACL. Otherwise, when the sender address is not verified, it is
22929 rewritten as soon as a message's header lines have been received.
22930
22931 .vindex "&$domain$&"
22932 .vindex "&$local_part$&"
22933 Similarly, at the start of an ACL for RCPT, the current recipient's address
22934 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22935 rewrite rules have yet been applied to it. However, the behaviour is different
22936 from the sender address when a recipient is verified. The address is rewritten
22937 for the verification, but the rewriting is not remembered at this stage. The
22938 value of &$local_part$& and &$domain$& after verification are always the same
22939 as they were before (that is, they contain the unrewritten &-- except for
22940 SMTP-time rewriting &-- address).
22941
22942 As soon as a message's header lines have been received, all the envelope
22943 recipient addresses are permanently rewritten, and rewriting is also applied to
22944 the addresses in the header lines (if configured). This happens before adding
22945 any header lines that were specified in MAIL or RCPT ACLs, and
22946 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22947 before the DATA ACL and &[local_scan()]& functions are run.
22948
22949 When an address is being routed, either for delivery or for verification,
22950 rewriting is applied immediately to child addresses that are generated by
22951 redirection, unless &%no_rewrite%& is set on the router.
22952
22953 .cindex "envelope sender" "rewriting at transport time"
22954 .cindex "rewriting" "at transport time"
22955 .cindex "header lines" "rewriting at transport time"
22956 At transport time, additional rewriting of addresses in header lines can be
22957 specified by setting the generic &%headers_rewrite%& option on a transport.
22958 This option contains rules that are identical in form to those in the rewrite
22959 section of the configuration file. They are applied to the original message
22960 header lines and any that were added by ACLs or a system filter. They are not
22961 applied to header lines that are added by routers or the transport.
22962
22963 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22964 transport option. However, it is not possible to rewrite envelope recipients at
22965 transport time.
22966
22967
22968
22969
22970 .section "Testing the rewriting rules that apply on input" "SECID149"
22971 .cindex "rewriting" "testing"
22972 .cindex "testing" "rewriting"
22973 Exim's input rewriting configuration appears in a part of the run time
22974 configuration file headed by &"begin rewrite"&. It can be tested by the
22975 &%-brw%& command line option. This takes an address (which can be a full RFC
22976 2822 address) as its argument. The output is a list of how the address would be
22977 transformed by the rewriting rules for each of the different places it might
22978 appear in an incoming message, that is, for each different header and for the
22979 envelope sender and recipient fields. For example,
22980 .code
22981 exim -brw ph10@exim.workshop.example
22982 .endd
22983 might produce the output
22984 .code
22985 sender: Philip.Hazel@exim.workshop.example
22986 from: Philip.Hazel@exim.workshop.example
22987 to: ph10@exim.workshop.example
22988 cc: ph10@exim.workshop.example
22989 bcc: ph10@exim.workshop.example
22990 reply-to: Philip.Hazel@exim.workshop.example
22991 env-from: Philip.Hazel@exim.workshop.example
22992 env-to: ph10@exim.workshop.example
22993 .endd
22994 which shows that rewriting has been set up for that address when used in any of
22995 the source fields, but not when it appears as a recipient address. At the
22996 present time, there is no equivalent way of testing rewriting rules that are
22997 set for a particular transport.
22998
22999
23000 .section "Rewriting rules" "SECID150"
23001 .cindex "rewriting" "rules"
23002 The rewrite section of the configuration file consists of lines of rewriting
23003 rules in the form
23004 .display
23005 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23006 .endd
23007 Rewriting rules that are specified for the &%headers_rewrite%& generic
23008 transport option are given as a colon-separated list. Each item in the list
23009 takes the same form as a line in the main rewriting configuration (except that
23010 any colons must be doubled, of course).
23011
23012 The formats of source patterns and replacement strings are described below.
23013 Each is terminated by white space, unless enclosed in double quotes, in which
23014 case normal quoting conventions apply inside the quotes. The flags are single
23015 characters which may appear in any order. Spaces and tabs between them are
23016 ignored.
23017
23018 For each address that could potentially be rewritten, the rules are scanned in
23019 order, and replacements for the address from earlier rules can themselves be
23020 replaced by later rules (but see the &"q"& and &"R"& flags).
23021
23022 The order in which addresses are rewritten is undefined, may change between
23023 releases, and must not be relied on, with one exception: when a message is
23024 received, the envelope sender is always rewritten first, before any header
23025 lines are rewritten. For example, the replacement string for a rewrite of an
23026 address in &'To:'& must not assume that the message's address in &'From:'& has
23027 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23028 that the envelope sender has already been rewritten.
23029
23030 .vindex "&$domain$&"
23031 .vindex "&$local_part$&"
23032 The variables &$local_part$& and &$domain$& can be used in the replacement
23033 string to refer to the address that is being rewritten. Note that lookup-driven
23034 rewriting can be done by a rule of the form
23035 .code
23036 *@*   ${lookup ...
23037 .endd
23038 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23039 refer to the address that is being rewritten.
23040
23041
23042 .section "Rewriting patterns" "SECID151"
23043 .cindex "rewriting" "patterns"
23044 .cindex "address list" "in a rewriting pattern"
23045 The source pattern in a rewriting rule is any item which may appear in an
23046 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23047 single-item address list, which means that it is expanded before being tested
23048 against the address. As always, if you use a regular expression as a pattern,
23049 you must take care to escape dollar and backslash characters, or use the &`\N`&
23050 facility to suppress string expansion within the regular expression.
23051
23052 Domains in patterns should be given in lower case. Local parts in patterns are
23053 case-sensitive. If you want to do case-insensitive matching of local parts, you
23054 can use a regular expression that starts with &`^(?i)`&.
23055
23056 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23057 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23058 depending on the type of match which occurred. These can be used in the
23059 replacement string to insert portions of the incoming address. &$0$& always
23060 refers to the complete incoming address. When a regular expression is used, the
23061 numerical variables are set from its capturing subexpressions. For other types
23062 of pattern they are set as follows:
23063
23064 .ilist
23065 If a local part or domain starts with an asterisk, the numerical variables
23066 refer to the character strings matched by asterisks, with &$1$& associated with
23067 the first asterisk, and &$2$& with the second, if present. For example, if the
23068 pattern
23069 .code
23070 *queen@*.fict.example
23071 .endd
23072 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23073 .code
23074 $0 = hearts-queen@wonderland.fict.example
23075 $1 = hearts-
23076 $2 = wonderland
23077 .endd
23078 Note that if the local part does not start with an asterisk, but the domain
23079 does, it is &$1$& that contains the wild part of the domain.
23080
23081 .next
23082 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23083 of the domain are placed in the next available numerical variables. Suppose,
23084 for example, that the address &'foo@bar.baz.example'& is processed by a
23085 rewriting rule of the form
23086 .display
23087 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23088 .endd
23089 and the key in the file that matches the domain is &`*.baz.example`&. Then
23090 .code
23091 $1 = foo
23092 $2 = bar
23093 $3 = baz.example
23094 .endd
23095 If the address &'foo@baz.example'& is looked up, this matches the same
23096 wildcard file entry, and in this case &$2$& is set to the empty string, but
23097 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23098 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23099 whole domain. For non-partial domain lookups, no numerical variables are set.
23100 .endlist
23101
23102
23103 .section "Rewriting replacements" "SECID152"
23104 .cindex "rewriting" "replacements"
23105 If the replacement string for a rule is a single asterisk, addresses that
23106 match the pattern and the flags are &'not'& rewritten, and no subsequent
23107 rewriting rules are scanned. For example,
23108 .code
23109 hatta@lookingglass.fict.example  *  f
23110 .endd
23111 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23112 &'From:'& headers.
23113
23114 .vindex "&$domain$&"
23115 .vindex "&$local_part$&"
23116 If the replacement string is not a single asterisk, it is expanded, and must
23117 yield a fully qualified address. Within the expansion, the variables
23118 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23119 Any letters they contain retain their original case &-- they are not lower
23120 cased. The numerical variables are set up according to the type of pattern that
23121 matched the address, as described above. If the expansion is forced to fail by
23122 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23123 current rule is abandoned, but subsequent rules may take effect. Any other
23124 expansion failure causes the entire rewriting operation to be abandoned, and an
23125 entry written to the panic log.
23126
23127
23128
23129 .section "Rewriting flags" "SECID153"
23130 There are three different kinds of flag that may appear on rewriting rules:
23131
23132 .ilist
23133 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23134 c, f, h, r, s, t.
23135 .next
23136 A flag that specifies rewriting at SMTP time: S.
23137 .next
23138 Flags that control the rewriting process: Q, q, R, w.
23139 .endlist
23140
23141 For rules that are part of the &%headers_rewrite%& generic transport option,
23142 E, F, T, and S are not permitted.
23143
23144
23145
23146 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23147          "SECID154"
23148 .cindex "rewriting" "flags"
23149 If none of the following flag letters, nor the &"S"& flag (see section
23150 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23151 and to both the sender and recipient fields of the envelope, whereas a
23152 transport-time rewriting rule just applies to all headers. Otherwise, the
23153 rewriting rule is skipped unless the relevant addresses are being processed.
23154 .display
23155 &`E`&       rewrite all envelope fields
23156 &`F`&       rewrite the envelope From field
23157 &`T`&       rewrite the envelope To field
23158 &`b`&       rewrite the &'Bcc:'& header
23159 &`c`&       rewrite the &'Cc:'& header
23160 &`f`&       rewrite the &'From:'& header
23161 &`h`&       rewrite all headers
23162 &`r`&       rewrite the &'Reply-To:'& header
23163 &`s`&       rewrite the &'Sender:'& header
23164 &`t`&       rewrite the &'To:'& header
23165 .endd
23166 "All headers" means all of the headers listed above that can be selected
23167 individually, plus their &'Resent-'& versions. It does not include
23168 other headers such as &'Subject:'& etc.
23169
23170 You should be particularly careful about rewriting &'Sender:'& headers, and
23171 restrict this to special known cases in your own domains.
23172
23173
23174 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23175 .cindex "SMTP" "rewriting malformed addresses"
23176 .cindex "RCPT" "rewriting argument of"
23177 .cindex "MAIL" "rewriting argument of"
23178 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23179 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23180 before any other processing; even before syntax checking. The pattern is
23181 required to be a regular expression, and it is matched against the whole of the
23182 data for the command, including any surrounding angle brackets.
23183
23184 .vindex "&$domain$&"
23185 .vindex "&$local_part$&"
23186 This form of rewrite rule allows for the handling of addresses that are not
23187 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23188 input). Because the input is not required to be a syntactically valid address,
23189 the variables &$local_part$& and &$domain$& are not available during the
23190 expansion of the replacement string. The result of rewriting replaces the
23191 original address in the MAIL or RCPT command.
23192
23193
23194 .section "Flags controlling the rewriting process" "SECID155"
23195 There are four flags which control the way the rewriting process works. These
23196 take effect only when a rule is invoked, that is, when the address is of the
23197 correct type (matches the flags) and matches the pattern:
23198
23199 .ilist
23200 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23201 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23202 absence of &"Q"& the rewritten address must always include a domain.
23203 .next
23204 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23205 even if no rewriting actually takes place because of a &"fail"& in the
23206 expansion. The &"q"& flag is not effective if the address is of the wrong type
23207 (does not match the flags) or does not match the pattern.
23208 .next
23209 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23210 address, up to ten times. It can be combined with the &"q"& flag, to stop
23211 rewriting once it fails to match (after at least one successful rewrite).
23212 .next
23213 .cindex "rewriting" "whole addresses"
23214 When an address in a header is rewritten, the rewriting normally applies only
23215 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23216 left unchanged. For example, rewriting might change
23217 .code
23218 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23219 .endd
23220 into
23221 .code
23222 From: Ford Prefect <prefectf@hitch.fict.example>
23223 .endd
23224 .cindex "RFC 2047"
23225 Sometimes there is a need to replace the whole address item, and this can be
23226 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23227 causes an address in a header line to be rewritten, the entire address is
23228 replaced, not just the working part. The replacement must be a complete RFC
23229 2822 address, including the angle brackets if necessary. If text outside angle
23230 brackets contains a character whose value is greater than 126 or less than 32
23231 (except for tab), the text is encoded according to RFC 2047. The character set
23232 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23233
23234 When the &"w"& flag is set on a rule that causes an envelope address to be
23235 rewritten, all but the working part of the replacement address is discarded.
23236 .endlist
23237
23238
23239 .section "Rewriting examples" "SECID156"
23240 Here is an example of the two common rewriting paradigms:
23241 .code
23242 *@*.hitch.fict.example  $1@hitch.fict.example
23243 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23244                      {$value}fail}@hitch.fict.example bctfrF
23245 .endd
23246 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23247 the string expansion to fail if the lookup does not succeed. In this context it
23248 has the effect of leaving the original address unchanged, but Exim goes on to
23249 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23250 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23251 explicitly, which would cause the rewritten address to be the same as before,
23252 at the cost of a small bit of processing. Not supplying either of these is an
23253 error, since the rewritten address would then contain no local part.
23254
23255 The first example above replaces the domain with a superior, more general
23256 domain. This may not be desirable for certain local parts. If the rule
23257 .code
23258 root@*.hitch.fict.example  *
23259 .endd
23260 were inserted before the first rule, rewriting would be suppressed for the
23261 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23262
23263 Rewriting can be made conditional on a number of tests, by making use of
23264 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23265 messages that originate outside the local host:
23266 .code
23267 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23268                          {$1@hitch.fict.example}fail}"
23269 .endd
23270 The replacement string is quoted in this example because it contains white
23271 space.
23272
23273 .cindex "rewriting" "bang paths"
23274 .cindex "bang paths" "rewriting"
23275 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23276 an address it treats it as an unqualified local part which it qualifies with
23277 the local qualification domain (if the source of the message is local or if the
23278 remote host is permitted to send unqualified addresses). Rewriting can
23279 sometimes be used to handle simple bang paths with a fixed number of
23280 components. For example, the rule
23281 .code
23282 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23283 .endd
23284 rewrites a two-component bang path &'host.name!user'& as the domain address
23285 &'user@host.name'&. However, there is a security implication in using this as
23286 a global rewriting rule for envelope addresses. It can provide a backdoor
23287 method for using your system as a relay, because the incoming addresses appear
23288 to be local. If the bang path addresses are received via SMTP, it is safer to
23289 use the &"S"& flag to rewrite them as they are received, so that relay checking
23290 can be done on the rewritten addresses.
23291 .ecindex IIDaddrew
23292
23293
23294
23295
23296
23297 . ////////////////////////////////////////////////////////////////////////////
23298 . ////////////////////////////////////////////////////////////////////////////
23299
23300 .chapter "Retry configuration" "CHAPretry"
23301 .scindex IIDretconf1 "retry" "configuration, description of"
23302 .scindex IIDregconf2 "configuration file" "retry section"
23303 The &"retry"& section of the runtime configuration file contains a list of
23304 retry rules that control how often Exim tries to deliver messages that cannot
23305 be delivered at the first attempt. If there are no retry rules (the section is
23306 empty or not present), there are no retries. In this situation, temporary
23307 errors are treated as permanent. The default configuration contains a single,
23308 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23309 line option can be used to test which retry rule will be used for a given
23310 address, domain and error.
23311
23312 The most common cause of retries is temporary failure to deliver to a remote
23313 host because the host is down, or inaccessible because of a network problem.
23314 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23315 address) basis, not on a per-message basis. Thus, if one message has recently
23316 been delayed, delivery of a new message to the same host is not immediately
23317 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23318 log selector is set, the message
23319 .cindex "retry" "time not reached"
23320 &"retry time not reached"& is written to the main log whenever a delivery is
23321 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23322 the handling of errors during remote deliveries.
23323
23324 Retry processing applies to routing as well as to delivering, except as covered
23325 in the next paragraph. The retry rules do not distinguish between these
23326 actions. It is not possible, for example, to specify different behaviour for
23327 failures to route the domain &'snark.fict.example'& and failures to deliver to
23328 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23329 added complication, so did not implement it. However, although they share the
23330 same retry rule, the actual retry times for routing and transporting a given
23331 domain are maintained independently.
23332
23333 When a delivery is not part of a queue run (typically an immediate delivery on
23334 receipt of a message), the routers are always run, and local deliveries are
23335 always attempted, even if retry times are set for them. This makes for better
23336 behaviour if one particular message is causing problems (for example, causing
23337 quota overflow, or provoking an error in a filter file). If such a delivery
23338 suffers a temporary failure, the retry data is updated as normal, and
23339 subsequent delivery attempts from queue runs occur only when the retry time for
23340 the local address is reached.
23341
23342 .section "Changing retry rules" "SECID157"
23343 If you change the retry rules in your configuration, you should consider
23344 whether or not to delete the retry data that is stored in Exim's spool area in
23345 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23346 always safe; that is why they are called &"hints"&.
23347
23348 The hints retry data contains suggested retry times based on the previous
23349 rules. In the case of a long-running problem with a remote host, it might
23350 record the fact that the host has timed out. If your new rules increase the
23351 timeout time for such a host, you should definitely remove the old retry data
23352 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23353 messages that it should now be retaining.
23354
23355
23356
23357 .section "Format of retry rules" "SECID158"
23358 .cindex "retry" "rules"
23359 Each retry rule occupies one line and consists of three or four parts,
23360 separated by white space: a pattern, an error name, an optional list of sender
23361 addresses, and a list of retry parameters. The pattern and sender lists must be
23362 enclosed in double quotes if they contain white space. The rules are searched
23363 in order until one is found where the pattern, error name, and sender list (if
23364 present) match the failing host or address, the error that occurred, and the
23365 message's sender, respectively.
23366
23367
23368 The pattern is any single item that may appear in an address list (see section
23369 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23370 which means that it is expanded before being tested against the address that
23371 has been delayed. A negated address list item is permitted. Address
23372 list processing treats a plain domain name as if it were preceded by &"*@"&,
23373 which makes it possible for many retry rules to start with just a domain. For
23374 example,
23375 .code
23376 lookingglass.fict.example        *  F,24h,30m;
23377 .endd
23378 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23379 whereas
23380 .code
23381 alice@lookingglass.fict.example  *  F,24h,30m;
23382 .endd
23383 applies only to temporary failures involving the local part &%alice%&.
23384 In practice, almost all rules start with a domain name pattern without a local
23385 part.
23386
23387 .cindex "regular expressions" "in retry rules"
23388 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23389 must match a complete address, not just a domain, because that is how regular
23390 expressions work in address lists.
23391 .display
23392 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23393 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23394 .endd
23395
23396
23397 .section "Choosing which retry rule to use for address errors" "SECID159"
23398 When Exim is looking for a retry rule after a routing attempt has failed (for
23399 example, after a DNS timeout), each line in the retry configuration is tested
23400 against the complete address only if &%retry_use_local_part%& is set for the
23401 router. Otherwise, only the domain is used, except when matching against a
23402 regular expression, when the local part of the address is replaced with &"*"&.
23403 A domain on its own can match a domain pattern, or a pattern that starts with
23404 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23405 &%check_local_user%& is true, and false for other routers.
23406
23407 Similarly, when Exim is looking for a retry rule after a local delivery has
23408 failed (for example, after a mailbox full error), each line in the retry
23409 configuration is tested against the complete address only if
23410 &%retry_use_local_part%& is set for the transport (it defaults true for all
23411 local transports).
23412
23413 .cindex "4&'xx'& responses" "retry rules for"
23414 However, when Exim is looking for a retry rule after a remote delivery attempt
23415 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23416 whole address is always used as the key when searching the retry rules. The
23417 rule that is found is used to create a retry time for the combination of the
23418 failing address and the message's sender. It is the combination of sender and
23419 recipient that is delayed in subsequent queue runs until its retry time is
23420 reached. You can delay the recipient without regard to the sender by setting
23421 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23422 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23423 commands.
23424
23425
23426
23427 .section "Choosing which retry rule to use for host and message errors" &&&
23428          "SECID160"
23429 For a temporary error that is not related to an individual address (for
23430 example, a connection timeout), each line in the retry configuration is checked
23431 twice. First, the name of the remote host is used as a domain name (preceded by
23432 &"*@"& when matching a regular expression). If this does not match the line,
23433 the domain from the email address is tried in a similar fashion. For example,
23434 suppose the MX records for &'a.b.c.example'& are
23435 .code
23436 a.b.c.example  MX  5  x.y.z.example
23437                MX  6  p.q.r.example
23438                MX  7  m.n.o.example
23439 .endd
23440 and the retry rules are
23441 .code
23442 p.q.r.example    *      F,24h,30m;
23443 a.b.c.example    *      F,4d,45m;
23444 .endd
23445 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23446 first rule matches neither the host nor the domain, so Exim looks at the second
23447 rule. This does not match the host, but it does match the domain, so it is used
23448 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23449 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23450 first retry rule is used, because it matches the host.
23451
23452 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23453 first rule to determine retry times, but for all the other hosts for the domain
23454 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23455 routing to &'a.b.c.example'& suffers a temporary failure.
23456
23457 &*Note*&: The host name is used when matching the patterns, not its IP address.
23458 However, if a message is routed directly to an IP address without the use of a
23459 host name, for example, if a &(manualroute)& router contains a setting such as:
23460 .code
23461 route_list = *.a.example  192.168.34.23
23462 .endd
23463 then the &"host name"& that is used when searching for a retry rule is the
23464 textual form of the IP address.
23465
23466 .section "Retry rules for specific errors" "SECID161"
23467 .cindex "retry" "specific errors; specifying"
23468 The second field in a retry rule is the name of a particular error, or an
23469 asterisk, which matches any error. The errors that can be tested for are:
23470
23471 .vlist
23472 .vitem &%auth_failed%&
23473 Authentication failed when trying to send to a host in the
23474 &%hosts_require_auth%& list in an &(smtp)& transport.
23475
23476 .vitem &%data_4xx%&
23477 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23478 after the command, or after sending the message's data.
23479
23480 .vitem &%mail_4xx%&
23481 A 4&'xx'& error was received for an outgoing MAIL command.
23482
23483 .vitem &%rcpt_4xx%&
23484 A 4&'xx'& error was received for an outgoing RCPT command.
23485 .endlist
23486
23487 For the three 4&'xx'& errors, either the first or both of the x's can be given
23488 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23489 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23490 and have retries every ten minutes with a one-hour timeout, you could set up a
23491 retry rule of this form:
23492 .code
23493 the.domain.name  rcpt_452   F,1h,10m
23494 .endd
23495 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23496 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23497
23498 .vlist
23499 .vitem &%lost_connection%&
23500 A server unexpectedly closed the SMTP connection. There may, of course,
23501 legitimate reasons for this (host died, network died), but if it repeats a lot
23502 for the same host, it indicates something odd.
23503
23504 .vitem &%refused_MX%&
23505 A connection to a host obtained from an MX record was refused.
23506
23507 .vitem &%refused_A%&
23508 A connection to a host not obtained from an MX record was refused.
23509
23510 .vitem &%refused%&
23511 A connection was refused.
23512
23513 .vitem &%timeout_connect_MX%&
23514 A connection attempt to a host obtained from an MX record timed out.
23515
23516 .vitem &%timeout_connect_A%&
23517 A connection attempt to a host not obtained from an MX record timed out.
23518
23519 .vitem &%timeout_connect%&
23520 A connection attempt timed out.
23521
23522 .vitem &%timeout_MX%&
23523 There was a timeout while connecting or during an SMTP session with a host
23524 obtained from an MX record.
23525
23526 .vitem &%timeout_A%&
23527 There was a timeout while connecting or during an SMTP session with a host not
23528 obtained from an MX record.
23529
23530 .vitem &%timeout%&
23531 There was a timeout while connecting or during an SMTP session.
23532
23533 .vitem &%tls_required%&
23534 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23535 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23536 to STARTTLS, or there was a problem setting up the TLS connection.
23537
23538 .vitem &%quota%&
23539 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23540 transport.
23541
23542 .vitem &%quota_%&<&'time'&>
23543 .cindex "quota" "error testing in retry rule"
23544 .cindex "retry" "quota error testing"
23545 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23546 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23547 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23548 for four days.
23549 .endlist
23550
23551 .cindex "mailbox" "time of last read"
23552 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23553 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23554 it should be based on the last time that the user accessed the mailbox.
23555 However, it is not always possible to determine this. Exim uses the following
23556 heuristic rules:
23557
23558 .ilist
23559 If the mailbox is a single file, the time of last access (the &"atime"&) is
23560 used. As no new messages are being delivered (because the mailbox is over
23561 quota), Exim does not access the file, so this is the time of last user access.
23562 .next
23563 .cindex "maildir format" "time of last read"
23564 For a maildir delivery, the time of last modification of the &_new_&
23565 subdirectory is used. As the mailbox is over quota, no new files are created in
23566 the &_new_& subdirectory, because no new messages are being delivered. Any
23567 change to the &_new_& subdirectory is therefore assumed to be the result of an
23568 MUA moving a new message to the &_cur_& directory when it is first read. The
23569 time that is used is therefore the last time that the user read a new message.
23570 .next
23571 For other kinds of multi-file mailbox, the time of last access cannot be
23572 obtained, so a retry rule that uses this type of error field is never matched.
23573 .endlist
23574
23575 The quota errors apply both to system-enforced quotas and to Exim's own quota
23576 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23577 when a local delivery is deferred because a partition is full (the ENOSPC
23578 error).
23579
23580
23581
23582 .section "Retry rules for specified senders" "SECID162"
23583 .cindex "retry" "rules; sender-specific"
23584 You can specify retry rules that apply only when the failing message has a
23585 specific sender. In particular, this can be used to define retry rules that
23586 apply only to bounce messages. The third item in a retry rule can be of this
23587 form:
23588 .display
23589 &`senders=`&<&'address list'&>
23590 .endd
23591 The retry timings themselves are then the fourth item. For example:
23592 .code
23593 *   rcpt_4xx   senders=:   F,1h,30m
23594 .endd
23595 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23596 host. If the address list contains white space, it must be enclosed in quotes.
23597 For example:
23598 .code
23599 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23600 .endd
23601 &*Warning*&: This facility can be unhelpful if it is used for host errors
23602 (which do not depend on the recipient). The reason is that the sender is used
23603 only to match the retry rule. Once the rule has been found for a host error,
23604 its contents are used to set a retry time for the host, and this will apply to
23605 all messages, not just those with specific senders.
23606
23607 When testing retry rules using &%-brt%&, you can supply a sender using the
23608 &%-f%& command line option, like this:
23609 .code
23610 exim -f "" -brt user@dom.ain
23611 .endd
23612 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23613 list is never matched.
23614
23615
23616
23617
23618
23619 .section "Retry parameters" "SECID163"
23620 .cindex "retry" "parameters in rules"
23621 The third (or fourth, if a senders list is present) field in a retry rule is a
23622 sequence of retry parameter sets, separated by semicolons. Each set consists of
23623 .display
23624 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23625 .endd
23626 The letter identifies the algorithm for computing a new retry time; the cutoff
23627 time is the time beyond which this algorithm no longer applies, and the
23628 arguments vary the algorithm's action. The cutoff time is measured from the
23629 time that the first failure for the domain (combined with the local part if
23630 relevant) was detected, not from the time the message was received.
23631
23632 .cindex "retry" "algorithms"
23633 .cindex "retry" "fixed intervals"
23634 .cindex "retry" "increasing intervals"
23635 .cindex "retry" "random intervals"
23636 The available algorithms are:
23637
23638 .ilist
23639 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23640 the interval.
23641 .next
23642 &'G'&: retry at geometrically increasing intervals. The first argument
23643 specifies a starting value for the interval, and the second a multiplier, which
23644 is used to increase the size of the interval at each retry.
23645 .next
23646 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23647 retry, the previous interval is multiplied by the factor in order to get a
23648 maximum for the next interval. The minimum interval is the first argument of
23649 the parameter, and an actual interval is chosen randomly between them. Such a
23650 rule has been found to be helpful in cluster configurations when all the
23651 members of the cluster restart at once, and may therefore synchronize their
23652 queue processing times.
23653 .endlist
23654
23655 When computing the next retry time, the algorithm definitions are scanned in
23656 order until one whose cutoff time has not yet passed is reached. This is then
23657 used to compute a new retry time that is later than the current time. In the
23658 case of fixed interval retries, this simply means adding the interval to the
23659 current time. For geometrically increasing intervals, retry intervals are
23660 computed from the rule's parameters until one that is greater than the previous
23661 interval is found. The main configuration variable
23662 .cindex "limit" "retry interval"
23663 .cindex "retry" "interval, maximum"
23664 .oindex "&%retry_interval_max%&"
23665 &%retry_interval_max%& limits the maximum interval between retries. It
23666 cannot be set greater than &`24h`&, which is its default value.
23667
23668 A single remote domain may have a number of hosts associated with it, and each
23669 host may have more than one IP address. Retry algorithms are selected on the
23670 basis of the domain name, but are applied to each IP address independently. If,
23671 for example, a host has two IP addresses and one is unusable, Exim will
23672 generate retry times for it and will not try to use it until its next retry
23673 time comes. Thus the good IP address is likely to be tried first most of the
23674 time.
23675
23676 .cindex "hints database" "use for retrying"
23677 Retry times are hints rather than promises. Exim does not make any attempt to
23678 run deliveries exactly at the computed times. Instead, a queue runner process
23679 starts delivery processes for delayed messages periodically, and these attempt
23680 new deliveries only for those addresses that have passed their next retry time.
23681 If a new message arrives for a deferred address, an immediate delivery attempt
23682 occurs only if the address has passed its retry time. In the absence of new
23683 messages, the minimum time between retries is the interval between queue runner
23684 processes. There is not much point in setting retry times of five minutes if
23685 your queue runners happen only once an hour, unless there are a significant
23686 number of incoming messages (which might be the case on a system that is
23687 sending everything to a smart host, for example).
23688
23689 The data in the retry hints database can be inspected by using the
23690 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23691 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23692 &'exinext'& utility script can be used to find out what the next retry times
23693 are for the hosts associated with a particular mail domain, and also for local
23694 deliveries that have been deferred.
23695
23696
23697 .section "Retry rule examples" "SECID164"
23698 Here are some example retry rules:
23699 .code
23700 alice@wonderland.fict.example quota_5d  F,7d,3h
23701 wonderland.fict.example       quota_5d
23702 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23703 lookingglass.fict.example     *         F,24h,30m;
23704 *                 refused_A   F,2h,20m;
23705 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23706 .endd
23707 The first rule sets up special handling for mail to
23708 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23709 mailbox has not been read for at least 5 days. Retries continue every three
23710 hours for 7 days. The second rule handles over-quota errors for all other local
23711 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23712 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23713 fail are bounced immediately if the mailbox has not been read for at least 5
23714 days.
23715
23716 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23717 happen every 15 minutes for an hour, then with geometrically increasing
23718 intervals until two days have passed since a delivery first failed. After the
23719 first hour there is a delay of one hour, then two hours, then four hours, and
23720 so on (this is a rather extreme example).
23721
23722 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23723 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23724 all other domains, with special action for connection refusal from hosts that
23725 were not obtained from an MX record.
23726
23727 The final rule in a retry configuration should always have asterisks in the
23728 first two fields so as to provide a general catch-all for any addresses that do
23729 not have their own special handling. This example tries every 15 minutes for 2
23730 hours, then with intervals starting at one hour and increasing by a factor of
23731 1.5 up to 16 hours, then every 8 hours up to 5 days.
23732
23733
23734
23735 .section "Timeout of retry data" "SECID165"
23736 .cindex "timeout" "of retry data"
23737 .oindex "&%retry_data_expire%&"
23738 .cindex "hints database" "data expiry"
23739 .cindex "retry" "timeout of data"
23740 Exim timestamps the data that it writes to its retry hints database. When it
23741 consults the data during a delivery it ignores any that is older than the value
23742 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23743 been tried for 7 days, Exim will try to deliver to it immediately a message
23744 arrives, and if that fails, it will calculate a retry time as if it were
23745 failing for the first time.
23746
23747 This improves the behaviour for messages routed to rarely-used hosts such as MX
23748 backups. If such a host was down at one time, and happens to be down again when
23749 Exim tries a month later, using the old retry data would imply that it had been
23750 down all the time, which is not a justified assumption.
23751
23752 If a host really is permanently dead, this behaviour causes a burst of retries
23753 every now and again, but only if messages routed to it are rare. If there is a
23754 message at least once every 7 days the retry data never expires.
23755
23756
23757
23758
23759 .section "Long-term failures" "SECID166"
23760 .cindex "delivery failure, long-term"
23761 .cindex "retry" "after long-term failure"
23762 Special processing happens when an email address has been failing for so long
23763 that the cutoff time for the last algorithm is reached. For example, using the
23764 default retry rule:
23765 .code
23766 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23767 .endd
23768 the cutoff time is four days. Reaching the retry cutoff is independent of how
23769 long any specific message has been failing; it is the length of continuous
23770 failure for the recipient address that counts.
23771
23772 When the cutoff time is reached for a local delivery, or for all the IP
23773 addresses associated with a remote delivery, a subsequent delivery failure
23774 causes Exim to give up on the address, and a bounce message is generated.
23775 In order to cater for new messages that use the failing address, a next retry
23776 time is still computed from the final algorithm, and is used as follows:
23777
23778 For local deliveries, one delivery attempt is always made for any subsequent
23779 messages. If this delivery fails, the address fails immediately. The
23780 post-cutoff retry time is not used.
23781
23782 If the delivery is remote, there are two possibilities, controlled by the
23783 .oindex "&%delay_after_cutoff%&"
23784 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23785 default. Until the post-cutoff retry time for one of the IP addresses is
23786 reached, the failing email address is bounced immediately, without a delivery
23787 attempt taking place. After that time, one new delivery attempt is made to
23788 those IP addresses that are past their retry times, and if that still fails,
23789 the address is bounced and new retry times are computed.
23790
23791 In other words, when all the hosts for a given email address have been failing
23792 for a long time, Exim bounces rather then defers until one of the hosts' retry
23793 times is reached. Then it tries once, and bounces if that attempt fails. This
23794 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23795 to a broken destination, but if the host does recover, Exim will eventually
23796 notice.
23797
23798 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23799 addresses are past their final cutoff time, Exim tries to deliver to those IP
23800 addresses that have not been tried since the message arrived. If there are
23801 no suitable IP addresses, or if they all fail, the address is bounced. In other
23802 words, it does not delay when a new message arrives, but tries the expired
23803 addresses immediately, unless they have been tried since the message arrived.
23804 If there is a continuous stream of messages for the failing domains, setting
23805 &%delay_after_cutoff%& false means that there will be many more attempts to
23806 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23807 true.
23808
23809 .section "Deliveries that work intermittently" "SECID167"
23810 .cindex "retry" "intermittently working deliveries"
23811 Some additional logic is needed to cope with cases where a host is
23812 intermittently available, or when a message has some attribute that prevents
23813 its delivery when others to the same address get through. In this situation,
23814 because some messages are successfully delivered, the &"retry clock"& for the
23815 host or address keeps getting reset by the successful deliveries, and so
23816 failing messages remain on the queue for ever because the cutoff time is never
23817 reached.
23818
23819 Two exceptional actions are applied to prevent this happening. The first
23820 applies to errors that are related to a message rather than a remote host.
23821 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23822 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23823 commands, and quota failures. For this type of error, if a message's arrival
23824 time is earlier than the &"first failed"& time for the error, the earlier time
23825 is used when scanning the retry rules to decide when to try next and when to
23826 time out the address.
23827
23828 The exceptional second action applies in all cases. If a message has been on
23829 the queue for longer than the cutoff time of any applicable retry rule for a
23830 given address, a delivery is attempted for that address, even if it is not yet
23831 time, and if this delivery fails, the address is timed out. A new retry time is
23832 not computed in this case, so that other messages for the same address are
23833 considered immediately.
23834 .ecindex IIDretconf1
23835 .ecindex IIDregconf2
23836
23837
23838
23839
23840
23841
23842 . ////////////////////////////////////////////////////////////////////////////
23843 . ////////////////////////////////////////////////////////////////////////////
23844
23845 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23846 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23847 .scindex IIDauthconf2 "authentication"
23848 The &"authenticators"& section of Exim's run time configuration is concerned
23849 with SMTP authentication. This facility is an extension to the SMTP protocol,
23850 described in RFC 2554, which allows a client SMTP host to authenticate itself
23851 to a server. This is a common way for a server to recognize clients that are
23852 permitted to use it as a relay. SMTP authentication is not of relevance to the
23853 transfer of mail between servers that have no managerial connection with each
23854 other.
23855
23856 .cindex "AUTH" "description of"
23857 Very briefly, the way SMTP authentication works is as follows:
23858
23859 .ilist
23860 The server advertises a number of authentication &'mechanisms'& in response to
23861 the client's EHLO command.
23862 .next
23863 The client issues an AUTH command, naming a specific mechanism. The command
23864 may, optionally, contain some authentication data.
23865 .next
23866 The server may issue one or more &'challenges'&, to which the client must send
23867 appropriate responses. In simple authentication mechanisms, the challenges are
23868 just prompts for user names and passwords. The server does not have to issue
23869 any challenges &-- in some mechanisms the relevant data may all be transmitted
23870 with the AUTH command.
23871 .next
23872 The server either accepts or denies authentication.
23873 .next
23874 If authentication succeeds, the client may optionally make use of the AUTH
23875 option on the MAIL command to pass an authenticated sender in subsequent
23876 mail transactions. Authentication lasts for the remainder of the SMTP
23877 connection.
23878 .next
23879 If authentication fails, the client may give up, or it may try a different
23880 authentication mechanism, or it may try transferring mail over the
23881 unauthenticated connection.
23882 .endlist
23883
23884 If you are setting up a client, and want to know which authentication
23885 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23886 SMTP port) on the server, and issue an EHLO command. The response to this
23887 includes the list of supported mechanisms. For example:
23888 .display
23889 &`$ `&&*&`telnet server.example 25`&*&
23890 &`Trying 192.168.34.25...`&
23891 &`Connected to server.example.`&
23892 &`Escape character is &#x0027;^]&#x0027;.`&
23893 &`220 server.example ESMTP Exim 4.20 ...`&
23894 &*&`ehlo client.example`&*&
23895 &`250-server.example Hello client.example [10.8.4.5]`&
23896 &`250-SIZE 52428800`&
23897 &`250-PIPELINING`&
23898 &`250-AUTH PLAIN`&
23899 &`250 HELP`&
23900 .endd
23901 The second-last line of this example output shows that the server supports
23902 authentication using the PLAIN mechanism. In Exim, the different authentication
23903 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23904 routers and transports, which authenticators are included in the binary is
23905 controlled by build-time definitions. The following are currently available,
23906 included by setting
23907 .code
23908 AUTH_CRAM_MD5=yes
23909 AUTH_CYRUS_SASL=yes
23910 AUTH_DOVECOT=yes
23911 AUTH_GSASL=yes
23912 AUTH_HEIMDAL_GSSAPI=yes
23913 AUTH_PLAINTEXT=yes
23914 AUTH_SPA=yes
23915 .endd
23916 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23917 authentication mechanism (RFC 2195), and the second provides an interface to
23918 the Cyrus SASL authentication library.
23919 The third is an interface to Dovecot's authentication system, delegating the
23920 work via a socket interface.
23921 The fourth provides an interface to the GNU SASL authentication library, which
23922 provides mechanisms but typically not data sources.
23923 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
23924 supporting setting a server keytab.
23925 The sixth can be configured to support
23926 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23927 not formally documented, but used by several MUAs. The seventh authenticator
23928 supports Microsoft's &'Secure Password Authentication'& mechanism.
23929
23930 The authenticators are configured using the same syntax as other drivers (see
23931 section &<<SECTfordricon>>&). If no authenticators are required, no
23932 authentication section need be present in the configuration file. Each
23933 authenticator can in principle have both server and client functions. When Exim
23934 is receiving SMTP mail, it is acting as a server; when it is sending out
23935 messages over SMTP, it is acting as a client. Authenticator configuration
23936 options are provided for use in both these circumstances.
23937
23938 To make it clear which options apply to which situation, the prefixes
23939 &%server_%& and &%client_%& are used on option names that are specific to
23940 either the server or the client function, respectively. Server and client
23941 functions are disabled if none of their options are set. If an authenticator is
23942 to be used for both server and client functions, a single definition, using
23943 both sets of options, is required. For example:
23944 .code
23945 cram:
23946   driver = cram_md5
23947   public_name = CRAM-MD5
23948   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23949   client_name = ph10
23950   client_secret = secret2
23951 .endd
23952 The &%server_%& option is used when Exim is acting as a server, and the
23953 &%client_%& options when it is acting as a client.
23954
23955 Descriptions of the individual authenticators are given in subsequent chapters.
23956 The remainder of this chapter covers the generic options for the
23957 authenticators, followed by general discussion of the way authentication works
23958 in Exim.
23959
23960 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
23961 per-mechanism basis.  Please read carefully to determine which variables hold
23962 account labels such as usercodes and which hold passwords or other
23963 authenticating data.
23964
23965 Note that some mechanisms support two different identifiers for accounts: the
23966 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
23967 and &'authz'& are commonly encountered.  The American spelling is standard here.
23968 Conceptually, authentication data such as passwords are tied to the identifier
23969 used to authenticate; servers may have rules to permit one user to act as a
23970 second user, so that after login the session is treated as though that second
23971 user had logged in.  That second user is the &'authorization id'&.  A robust
23972 configuration might confirm that the &'authz'& field is empty or matches the
23973 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
23974 as verified data, the &'authz'& as an unverified request which the server might
23975 choose to honour.
23976
23977 A &'realm'& is a text string, typically a domain name, presented by a server
23978 to a client to help it select an account and credentials to use.  In some
23979 mechanisms, the client and server provably agree on the realm, but clients
23980 typically can not treat the realm as secure data to be blindly trusted.
23981
23982
23983
23984 .section "Generic options for authenticators" "SECID168"
23985 .cindex "authentication" "generic options"
23986 .cindex "options" "generic; for authenticators"
23987
23988 .option client_condition authenticators string&!! unset
23989 When Exim is authenticating as a client, it skips any authenticator whose
23990 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23991 used, for example, to skip plain text authenticators when the connection is not
23992 encrypted by a setting such as:
23993 .code
23994 client_condition = ${if !eq{$tls_out_cipher}{}}
23995 .endd
23996
23997
23998 .option driver authenticators string unset
23999 This option must always be set. It specifies which of the available
24000 authenticators is to be used.
24001
24002
24003 .option public_name authenticators string unset
24004 This option specifies the name of the authentication mechanism that the driver
24005 implements, and by which it is known to the outside world. These names should
24006 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24007 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24008 defaults to the driver's instance name.
24009
24010
24011 .option server_advertise_condition authenticators string&!! unset
24012 When a server is about to advertise an authentication mechanism, the condition
24013 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24014 mechanism is not advertised.
24015 If the expansion fails, the mechanism is not advertised. If the failure was not
24016 forced, and was not caused by a lookup defer, the incident is logged.
24017 See section &<<SECTauthexiser>>& below for further discussion.
24018
24019
24020 .option server_condition authenticators string&!! unset
24021 This option must be set for a &%plaintext%& server authenticator, where it
24022 is used directly to control authentication. See section &<<SECTplainserver>>&
24023 for details.
24024
24025 For the &(gsasl)& authenticator, this option is required for various
24026 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24027
24028 For the other authenticators, &%server_condition%& can be used as an additional
24029 authentication or authorization mechanism that is applied after the other
24030 authenticator conditions succeed. If it is set, it is expanded when the
24031 authenticator would otherwise return a success code. If the expansion is forced
24032 to fail, authentication fails. Any other expansion failure causes a temporary
24033 error code to be returned. If the result of a successful expansion is an empty
24034 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24035 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24036 other result, a temporary error code is returned, with the expanded string as
24037 the error text.
24038
24039
24040 .option server_debug_print authenticators string&!! unset
24041 If this option is set and authentication debugging is enabled (see the &%-d%&
24042 command line option), the string is expanded and included in the debugging
24043 output when the authenticator is run as a server. This can help with checking
24044 out the values of variables.
24045 If expansion of the string fails, the error message is written to the debugging
24046 output, and Exim carries on processing.
24047
24048
24049 .option server_set_id authenticators string&!! unset
24050 .vindex "&$authenticated_id$&"
24051 When an Exim server successfully authenticates a client, this string is
24052 expanded using data from the authentication, and preserved for any incoming
24053 messages in the variable &$authenticated_id$&. It is also included in the log
24054 lines for incoming messages. For example, a user/password authenticator
24055 configuration might preserve the user name that was used to authenticate, and
24056 refer to it subsequently during delivery of the message.
24057 If expansion fails, the option is ignored.
24058
24059
24060 .option server_mail_auth_condition authenticators string&!! unset
24061 This option allows a server to discard authenticated sender addresses supplied
24062 as part of MAIL commands in SMTP connections that are authenticated by the
24063 driver on which &%server_mail_auth_condition%& is set. The option is not used
24064 as part of the authentication process; instead its (unexpanded) value is
24065 remembered for later use.
24066 How it is used is described in the following section.
24067
24068
24069
24070
24071
24072 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24073 .cindex "authentication" "sender; authenticated"
24074 .cindex "AUTH" "on MAIL command"
24075 When a client supplied an AUTH= item on a MAIL command, Exim applies
24076 the following checks before accepting it as the authenticated sender of the
24077 message:
24078
24079 .ilist
24080 If the connection is not using extended SMTP (that is, HELO was used rather
24081 than EHLO), the use of AUTH= is a syntax error.
24082 .next
24083 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24084 .next
24085 .vindex "&$authenticated_sender$&"
24086 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24087 running, the value of &$authenticated_sender$& is set to the value obtained
24088 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24089 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24090 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24091 given for the MAIL command.
24092 .next
24093 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24094 is accepted and placed in &$authenticated_sender$& only if the client has
24095 authenticated.
24096 .next
24097 If the AUTH= value was accepted by either of the two previous rules, and
24098 the client has authenticated, and the authenticator has a setting for the
24099 &%server_mail_auth_condition%&, the condition is checked at this point. The
24100 valued that was saved from the authenticator is expanded. If the expansion
24101 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24102 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24103 the value of &$authenticated_sender$& is retained and passed on with the
24104 message.
24105 .endlist
24106
24107
24108 When &$authenticated_sender$& is set for a message, it is passed on to other
24109 hosts to which Exim authenticates as a client. Do not confuse this value with
24110 &$authenticated_id$&, which is a string obtained from the authentication
24111 process, and which is not usually a complete email address.
24112
24113 .vindex "&$sender_address$&"
24114 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24115 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24116 therefore make use of &$authenticated_sender$&. The converse is not true: the
24117 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24118 ACL is run.
24119
24120
24121
24122 .section "Authentication on an Exim server" "SECTauthexiser"
24123 .cindex "authentication" "on an Exim server"
24124 When Exim receives an EHLO command, it advertises the public names of those
24125 authenticators that are configured as servers, subject to the following
24126 conditions:
24127
24128 .ilist
24129 The client host must match &%auth_advertise_hosts%& (default *).
24130 .next
24131 It the &%server_advertise_condition%& option is set, its expansion must not
24132 yield the empty string, &"0"&, &"no"&, or &"false"&.
24133 .endlist
24134
24135 The order in which the authenticators are defined controls the order in which
24136 the mechanisms are advertised.
24137
24138 Some mail clients (for example, some versions of Netscape) require the user to
24139 provide a name and password for authentication whenever AUTH is advertised,
24140 even though authentication may not in fact be needed (for example, Exim may be
24141 set up to allow unconditional relaying from the client by an IP address check).
24142 You can make such clients more friendly by not advertising AUTH to them.
24143 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24144 that runs for RCPT) to relay without authentication, you should set
24145 .code
24146 auth_advertise_hosts = ! 10.9.8.0/24
24147 .endd
24148 so that no authentication mechanisms are advertised to them.
24149
24150 The &%server_advertise_condition%& controls the advertisement of individual
24151 authentication mechanisms. For example, it can be used to restrict the
24152 advertisement of a particular mechanism to encrypted connections, by a setting
24153 such as:
24154 .code
24155 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24156 .endd
24157 .vindex "&$tls_in_cipher$&"
24158 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24159 yields &"yes"&, which allows the advertisement to happen.
24160
24161 When an Exim server receives an AUTH command from a client, it rejects it
24162 immediately if AUTH was not advertised in response to an earlier EHLO
24163 command. This is the case if
24164
24165 .ilist
24166 The client host does not match &%auth_advertise_hosts%&; or
24167 .next
24168 No authenticators are configured with server options; or
24169 .next
24170 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24171 server authenticators.
24172 .endlist
24173
24174
24175 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24176 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24177 AUTH is accepted from any client host.
24178
24179 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24180 server authentication mechanism that was advertised in response to EHLO and
24181 that matches the one named in the AUTH command. If it finds one, it runs
24182 the appropriate authentication protocol, and authentication either succeeds or
24183 fails. If there is no matching advertised mechanism, the AUTH command is
24184 rejected with a 504 error.
24185
24186 .vindex "&$received_protocol$&"
24187 .vindex "&$sender_host_authenticated$&"
24188 When a message is received from an authenticated host, the value of
24189 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24190 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24191 public name) of the authenticator driver that successfully authenticated the
24192 client from which the message was received. This variable is empty if there was
24193 no successful authentication.
24194
24195
24196
24197
24198 .section "Testing server authentication" "SECID169"
24199 .cindex "authentication" "testing a server"
24200 .cindex "AUTH" "testing a server"
24201 .cindex "base64 encoding" "creating authentication test data"
24202 Exim's &%-bh%& option can be useful for testing server authentication
24203 configurations. The data for the AUTH command has to be sent using base64
24204 encoding. A quick way to produce such data for testing is the following Perl
24205 script:
24206 .code
24207 use MIME::Base64;
24208 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24209 .endd
24210 .cindex "binary zero" "in authentication data"
24211 This interprets its argument as a Perl string, and then encodes it. The
24212 interpretation as a Perl string allows binary zeros, which are required for
24213 some kinds of authentication, to be included in the data. For example, a
24214 command line to run this script on such data might be
24215 .code
24216 encode '\0user\0password'
24217 .endd
24218 Note the use of single quotes to prevent the shell interpreting the
24219 backslashes, so that they can be interpreted by Perl to specify characters
24220 whose code value is zero.
24221
24222 &*Warning 1*&: If either of the user or password strings starts with an octal
24223 digit, you must use three zeros instead of one after the leading backslash. If
24224 you do not, the octal digit that starts your string will be incorrectly
24225 interpreted as part of the code for the first character.
24226
24227 &*Warning 2*&: If there are characters in the strings that Perl interprets
24228 specially, you must use a Perl escape to prevent them being misinterpreted. For
24229 example, a command such as
24230 .code
24231 encode '\0user@domain.com\0pas$$word'
24232 .endd
24233 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24234
24235 If you have the &%mimencode%& command installed, another way to do produce
24236 base64-encoded strings is to run the command
24237 .code
24238 echo -e -n `\0user\0password' | mimencode
24239 .endd
24240 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24241 in the argument, and the &%-n%& option specifies no newline at the end of its
24242 output. However, not all versions of &%echo%& recognize these options, so you
24243 should check your version before relying on this suggestion.
24244
24245
24246
24247 .section "Authentication by an Exim client" "SECID170"
24248 .cindex "authentication" "on an Exim client"
24249 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24250 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24251 announces support for authentication, and the host matches an entry in either
24252 of these options, Exim (as a client) tries to authenticate as follows:
24253
24254 .ilist
24255 For each authenticator that is configured as a client, in the order in which
24256 they are defined in the configuration, it searches the authentication
24257 mechanisms announced by the server for one whose name matches the public name
24258 of the authenticator.
24259 .next
24260 .vindex "&$host$&"
24261 .vindex "&$host_address$&"
24262 When it finds one that matches, it runs the authenticator's client code. The
24263 variables &$host$& and &$host_address$& are available for any string expansions
24264 that the client might do. They are set to the server's name and IP address. If
24265 any expansion is forced to fail, the authentication attempt is abandoned, and
24266 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24267 delivery to be deferred.
24268 .next
24269 If the result of the authentication attempt is a temporary error or a timeout,
24270 Exim abandons trying to send the message to the host for the moment. It will
24271 try again later. If there are any backup hosts available, they are tried in the
24272 usual way.
24273 .next
24274 If the response to authentication is a permanent error (5&'xx'& code), Exim
24275 carries on searching the list of authenticators and tries another one if
24276 possible. If all authentication attempts give permanent errors, or if there are
24277 no attempts because no mechanisms match (or option expansions force failure),
24278 what happens depends on whether the host matches &%hosts_require_auth%& or
24279 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24280 delivery is deferred. The error can be detected in the retry rules, and thereby
24281 turned into a permanent error if you wish. In the second case, Exim tries to
24282 deliver the message unauthenticated.
24283 .endlist
24284
24285 .cindex "AUTH" "on MAIL command"
24286 When Exim has authenticated itself to a remote server, it adds the AUTH
24287 parameter to the MAIL commands it sends, if it has an authenticated sender for
24288 the message. If the message came from a remote host, the authenticated sender
24289 is the one that was receiving on an incoming MAIL command, provided that the
24290 incoming connection was authenticated and the &%server_mail_auth%& condition
24291 allowed the authenticated sender to be retained. If a local process calls Exim
24292 to send a message, the sender address that is built from the login name and
24293 &%qualify_domain%& is treated as authenticated. However, if the
24294 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24295 the authenticated sender that was received with the message.
24296 .ecindex IIDauthconf1
24297 .ecindex IIDauthconf2
24298
24299
24300
24301
24302
24303
24304 . ////////////////////////////////////////////////////////////////////////////
24305 . ////////////////////////////////////////////////////////////////////////////
24306
24307 .chapter "The plaintext authenticator" "CHAPplaintext"
24308 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24309 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24310 The &(plaintext)& authenticator can be configured to support the PLAIN and
24311 LOGIN authentication mechanisms, both of which transfer authentication data as
24312 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24313 security risk; you are strongly advised to insist on the use of SMTP encryption
24314 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24315 use unencrypted plain text, you should not use the same passwords for SMTP
24316 connections as you do for login accounts.
24317
24318 .section "Plaintext options" "SECID171"
24319 .cindex "options" "&(plaintext)& authenticator (server)"
24320 When configured as a server, &(plaintext)& uses the following options:
24321
24322 .option server_condition authenticators string&!! unset
24323 This is actually a global authentication option, but it must be set in order to
24324 configure the &(plaintext)& driver as a server. Its use is described below.
24325
24326 .option server_prompts plaintext string&!! unset
24327 The contents of this option, after expansion, must be a colon-separated list of
24328 prompt strings. If expansion fails, a temporary authentication rejection is
24329 given.
24330
24331 .section "Using plaintext in a server" "SECTplainserver"
24332 .cindex "AUTH" "in &(plaintext)& authenticator"
24333 .cindex "binary zero" "in &(plaintext)& authenticator"
24334 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24335         "in &(plaintext)& authenticator"
24336 .vindex "&$auth1$&, &$auth2$&, etc"
24337 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24338
24339 When running as a server, &(plaintext)& performs the authentication test by
24340 expanding a string. The data sent by the client with the AUTH command, or in
24341 response to subsequent prompts, is base64 encoded, and so may contain any byte
24342 values when decoded. If any data is supplied with the command, it is treated as
24343 a list of strings, separated by NULs (binary zeros), the first three of which
24344 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24345 (neither LOGIN nor PLAIN uses more than three strings).
24346
24347 For compatibility with previous releases of Exim, the values are also placed in
24348 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24349 variables for this purpose is now deprecated, as it can lead to confusion in
24350 string expansions that also use them for other things.
24351
24352 If there are more strings in &%server_prompts%& than the number of strings
24353 supplied with the AUTH command, the remaining prompts are used to obtain more
24354 data. Each response from the client may be a list of NUL-separated strings.
24355
24356 .vindex "&$authenticated_id$&"
24357 Once a sufficient number of data strings have been received,
24358 &%server_condition%& is expanded. If the expansion is forced to fail,
24359 authentication fails. Any other expansion failure causes a temporary error code
24360 to be returned. If the result of a successful expansion is an empty string,
24361 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24362 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24363 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24364 For any other result, a temporary error code is returned, with the expanded
24365 string as the error text.
24366
24367 &*Warning*&: If you use a lookup in the expansion to find the user's
24368 password, be sure to make the authentication fail if the user is unknown.
24369 There are good and bad examples at the end of the next section.
24370
24371
24372
24373 .section "The PLAIN authentication mechanism" "SECID172"
24374 .cindex "PLAIN authentication mechanism"
24375 .cindex "authentication" "PLAIN mechanism"
24376 .cindex "binary zero" "in &(plaintext)& authenticator"
24377 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24378 sent as one item of data (that is, one combined string containing two NUL
24379 separators). The data is sent either as part of the AUTH command, or
24380 subsequently in response to an empty prompt from the server.
24381
24382 The second and third strings are a user name and a corresponding password.
24383 Using a single fixed user name and password as an example, this could be
24384 configured as follows:
24385 .code
24386 fixed_plain:
24387   driver = plaintext
24388   public_name = PLAIN
24389   server_prompts = :
24390   server_condition = \
24391     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24392   server_set_id = $auth2
24393 .endd
24394 Note that the default result strings from &%if%& (&"true"& or an empty string)
24395 are exactly what we want here, so they need not be specified. Obviously, if the
24396 password contains expansion-significant characters such as dollar, backslash,
24397 or closing brace, they have to be escaped.
24398
24399 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24400 the end of a string list are ignored). If all the data comes as part of the
24401 AUTH command, as is commonly the case, the prompt is not used. This
24402 authenticator is advertised in the response to EHLO as
24403 .code
24404 250-AUTH PLAIN
24405 .endd
24406 and a client host can authenticate itself by sending the command
24407 .code
24408 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24409 .endd
24410 As this contains three strings (more than the number of prompts), no further
24411 data is required from the client. Alternatively, the client may just send
24412 .code
24413 AUTH PLAIN
24414 .endd
24415 to initiate authentication, in which case the server replies with an empty
24416 prompt. The client must respond with the combined data string.
24417
24418 The data string is base64 encoded, as required by the RFC. This example,
24419 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24420 represents a zero byte. This is split up into three strings, the first of which
24421 is empty. The &%server_condition%& option in the authenticator checks that the
24422 second two are &`username`& and &`mysecret`& respectively.
24423
24424 Having just one fixed user name and password, as in this example, is not very
24425 realistic, though for a small organization with only a handful of
24426 authenticating clients it could make sense.
24427
24428 A more sophisticated instance of this authenticator could use the user name in
24429 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24430 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24431 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24432 This is an incorrect example:
24433 .code
24434 server_condition = \
24435   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24436 .endd
24437 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24438 which it then compares to the supplied password (&$auth3$&). Why is this example
24439 incorrect? It works fine for existing users, but consider what happens if a
24440 non-existent user name is given. The lookup fails, but as no success/failure
24441 strings are given for the lookup, it yields an empty string. Thus, to defeat
24442 the authentication, all a client has to do is to supply a non-existent user
24443 name and an empty password. The correct way of writing this test is:
24444 .code
24445 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24446   {${if eq{$value}{$auth3}}} {false}}
24447 .endd
24448 In this case, if the lookup succeeds, the result is checked; if the lookup
24449 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24450 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24451 always fails if its second argument is empty. However, the second way of
24452 writing the test makes the logic clearer.
24453
24454
24455 .section "The LOGIN authentication mechanism" "SECID173"
24456 .cindex "LOGIN authentication mechanism"
24457 .cindex "authentication" "LOGIN mechanism"
24458 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24459 in a number of programs. No data is sent with the AUTH command. Instead, a
24460 user name and password are supplied separately, in response to prompts. The
24461 plaintext authenticator can be configured to support this as in this example:
24462 .code
24463 fixed_login:
24464   driver = plaintext
24465   public_name = LOGIN
24466   server_prompts = User Name : Password
24467   server_condition = \
24468     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24469   server_set_id = $auth1
24470 .endd
24471 Because of the way plaintext operates, this authenticator accepts data supplied
24472 with the AUTH command (in contravention of the specification of LOGIN), but
24473 if the client does not supply it (as is the case for LOGIN clients), the prompt
24474 strings are used to obtain two data items.
24475
24476 Some clients are very particular about the precise text of the prompts. For
24477 example, Outlook Express is reported to recognize only &"Username:"& and
24478 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24479 strings. It uses the &%ldapauth%& expansion condition to check the user
24480 name and password by binding to an LDAP server:
24481 .code
24482 login:
24483   driver = plaintext
24484   public_name = LOGIN
24485   server_prompts = Username:: : Password::
24486   server_condition = ${if and{{ \
24487     !eq{}{$auth1} }{ \
24488     ldapauth{\
24489       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24490       pass=${quote:$auth2} \
24491       ldap://ldap.example.org/} }} }
24492   server_set_id = uid=$auth1,ou=people,o=example.org
24493 .endd
24494 We have to check that the username is not empty before using it, because LDAP
24495 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24496 operator to correctly quote the DN for authentication. However, the basic
24497 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24498 correct one to use for the password, because quoting is needed only to make
24499 the password conform to the Exim syntax. At the LDAP level, the password is an
24500 uninterpreted string.
24501
24502
24503 .section "Support for different kinds of authentication" "SECID174"
24504 A number of string expansion features are provided for the purpose of
24505 interfacing to different ways of user authentication. These include checking
24506 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24507 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24508 &<<SECTexpcond>>&.
24509
24510
24511
24512
24513 .section "Using plaintext in a client" "SECID175"
24514 .cindex "options" "&(plaintext)& authenticator (client)"
24515 The &(plaintext)& authenticator has two client options:
24516
24517 .option client_ignore_invalid_base64 plaintext boolean false
24518 If the client receives a server prompt that is not a valid base64 string,
24519 authentication is abandoned by default. However, if this option is set true,
24520 the error in the challenge is ignored and the client sends the response as
24521 usual.
24522
24523 .option client_send plaintext string&!! unset
24524 The string is a colon-separated list of authentication data strings. Each
24525 string is independently expanded before being sent to the server. The first
24526 string is sent with the AUTH command; any more strings are sent in response
24527 to prompts from the server. Before each string is expanded, the value of the
24528 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24529 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24530 way. Thus, the prompt that is received in response to sending the first string
24531 (with the AUTH command) can be used in the expansion of the second string, and
24532 so on. If an invalid base64 string is received when
24533 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24534 &$auth$&<&'n'&> variable.
24535
24536 &*Note*&: You cannot use expansion to create multiple strings, because
24537 splitting takes priority and happens first.
24538
24539 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24540 the data, further processing is applied to each string before it is sent. If
24541 there are any single circumflex characters in the string, they are converted to
24542 NULs. Should an actual circumflex be required as data, it must be doubled in
24543 the string.
24544
24545 This is an example of a client configuration that implements the PLAIN
24546 authentication mechanism with a fixed user name and password:
24547 .code
24548 fixed_plain:
24549   driver = plaintext
24550   public_name = PLAIN
24551   client_send = ^username^mysecret
24552 .endd
24553 The lack of colons means that the entire text is sent with the AUTH
24554 command, with the circumflex characters converted to NULs. A similar example
24555 that uses the LOGIN mechanism is:
24556 .code
24557 fixed_login:
24558   driver = plaintext
24559   public_name = LOGIN
24560   client_send = : username : mysecret
24561 .endd
24562 The initial colon means that the first string is empty, so no data is sent with
24563 the AUTH command itself. The remaining strings are sent in response to
24564 prompts.
24565 .ecindex IIDplaiauth1
24566 .ecindex IIDplaiauth2
24567
24568
24569
24570
24571 . ////////////////////////////////////////////////////////////////////////////
24572 . ////////////////////////////////////////////////////////////////////////////
24573
24574 .chapter "The cram_md5 authenticator" "CHID9"
24575 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24576 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24577 .cindex "CRAM-MD5 authentication mechanism"
24578 .cindex "authentication" "CRAM-MD5 mechanism"
24579 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24580 sends a challenge string to the client, and the response consists of a user
24581 name and the CRAM-MD5 digest of the challenge string combined with a secret
24582 string (password) which is known to both server and client. Thus, the secret
24583 is not sent over the network as plain text, which makes this authenticator more
24584 secure than &(plaintext)&. However, the downside is that the secret has to be
24585 available in plain text at either end.
24586
24587
24588 .section "Using cram_md5 as a server" "SECID176"
24589 .cindex "options" "&(cram_md5)& authenticator (server)"
24590 This authenticator has one server option, which must be set to configure the
24591 authenticator as a server:
24592
24593 .option server_secret cram_md5 string&!! unset
24594 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24595 When the server receives the client's response, the user name is placed in
24596 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24597 obtain the password for that user. The server then computes the CRAM-MD5 digest
24598 that the client should have sent, and checks that it received the correct
24599 string. If the expansion of &%server_secret%& is forced to fail, authentication
24600 fails. If the expansion fails for some other reason, a temporary error code is
24601 returned to the client.
24602
24603 For compatibility with previous releases of Exim, the user name is also placed
24604 in &$1$&. However, the use of this variables for this purpose is now
24605 deprecated, as it can lead to confusion in string expansions that also use
24606 numeric variables for other things.
24607
24608 For example, the following authenticator checks that the user name given by the
24609 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24610 user name, authentication fails.
24611 .code
24612 fixed_cram:
24613   driver = cram_md5
24614   public_name = CRAM-MD5
24615   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24616   server_set_id = $auth1
24617 .endd
24618 .vindex "&$authenticated_id$&"
24619 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24620 name in &$authenticated_id$&. A more typical configuration might look up the
24621 secret string in a file, using the user name as the key. For example:
24622 .code
24623 lookup_cram:
24624   driver = cram_md5
24625   public_name = CRAM-MD5
24626   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24627                   {$value}fail}
24628   server_set_id = $auth1
24629 .endd
24630 Note that this expansion explicitly forces failure if the lookup fails
24631 because &$auth1$& contains an unknown user name.
24632
24633 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24634 using the relevant libraries, you need to know the realm to specify in the
24635 lookup and then ask for the &"userPassword"& attribute for that user in that
24636 realm, with:
24637 .code
24638 cyrusless_crammd5:
24639   driver = cram_md5
24640   public_name = CRAM-MD5
24641   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24642                   dbmjz{/etc/sasldb2}}
24643   server_set_id = $auth1
24644 .endd
24645
24646 .section "Using cram_md5 as a client" "SECID177"
24647 .cindex "options" "&(cram_md5)& authenticator (client)"
24648 When used as a client, the &(cram_md5)& authenticator has two options:
24649
24650
24651
24652 .option client_name cram_md5 string&!! "the primary host name"
24653 This string is expanded, and the result used as the user name data when
24654 computing the response to the server's challenge.
24655
24656
24657 .option client_secret cram_md5 string&!! unset
24658 This option must be set for the authenticator to work as a client. Its value is
24659 expanded and the result used as the secret string when computing the response.
24660
24661
24662 .vindex "&$host$&"
24663 .vindex "&$host_address$&"
24664 Different user names and secrets can be used for different servers by referring
24665 to &$host$& or &$host_address$& in the options. Forced failure of either
24666 expansion string is treated as an indication that this authenticator is not
24667 prepared to handle this case. Exim moves on to the next configured client
24668 authenticator. Any other expansion failure causes Exim to give up trying to
24669 send the message to the current server.
24670
24671 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24672 strings, is:
24673 .code
24674 fixed_cram:
24675   driver = cram_md5
24676   public_name = CRAM-MD5
24677   client_name = ph10
24678   client_secret = secret
24679 .endd
24680 .ecindex IIDcramauth1
24681 .ecindex IIDcramauth2
24682
24683
24684
24685 . ////////////////////////////////////////////////////////////////////////////
24686 . ////////////////////////////////////////////////////////////////////////////
24687
24688 .chapter "The cyrus_sasl authenticator" "CHID10"
24689 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24690 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24691 .cindex "Cyrus" "SASL library"
24692 .cindex "Kerberos"
24693 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24694 Digital Ltd (&url(http://www.aldigital.co.uk)).
24695
24696 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24697 library implementation of the RFC 2222 (&"Simple Authentication and Security
24698 Layer"&). This library supports a number of authentication mechanisms,
24699 including PLAIN and LOGIN, but also several others that Exim does not support
24700 directly. In particular, there is support for Kerberos authentication.
24701
24702 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24703 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24704 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24705 name of the driver to determine which mechanism to support.
24706
24707 Where access to some kind of secret file is required, for example in GSSAPI
24708 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24709 user, and that the Cyrus SASL library has no way of escalating privileges
24710 by default. You may also find you need to set environment variables,
24711 depending on the driver you are using.
24712
24713 The application name provided by Exim is &"exim"&, so various SASL options may
24714 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24715 Kerberos, note that because of limitations in the GSSAPI interface,
24716 changing the server keytab might need to be communicated down to the Kerberos
24717 layer independently. The mechanism for doing so is dependent upon the Kerberos
24718 implementation.
24719
24720 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24721 may be set to point to an alternative keytab file. Exim will pass this
24722 variable through from its own inherited environment when started as root or the
24723 Exim user. The keytab file needs to be readable by the Exim user.
24724 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24725 environment variable.  In practice, for those releases, the Cyrus authenticator
24726 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24727 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24728
24729
24730 .section "Using cyrus_sasl as a server" "SECID178"
24731 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24732 (on a successful authentication) into &$auth1$&. For compatibility with
24733 previous releases of Exim, the username is also placed in &$1$&. However, the
24734 use of this variable for this purpose is now deprecated, as it can lead to
24735 confusion in string expansions that also use numeric variables for other
24736 things.
24737
24738
24739 .option server_hostname cyrus_sasl string&!! "see below"
24740 This option selects the hostname that is used when communicating with the
24741 library. The default value is &`$primary_hostname`&. It is up to the underlying
24742 SASL plug-in what it does with this data.
24743
24744
24745 .option server_mech cyrus_sasl string "see below"
24746 This option selects the authentication mechanism this driver should use. The
24747 default is the value of the generic &%public_name%& option. This option allows
24748 you to use a different underlying mechanism from the advertised name. For
24749 example:
24750 .code
24751 sasl:
24752   driver = cyrus_sasl
24753   public_name = X-ANYTHING
24754   server_mech = CRAM-MD5
24755   server_set_id = $auth1
24756 .endd
24757
24758 .option server_realm cyrus_sasl string&!! unset
24759 This specifies the SASL realm that the server claims to be in.
24760
24761
24762 .option server_service cyrus_sasl string &`smtp`&
24763 This is the SASL service that the server claims to implement.
24764
24765
24766 For straightforward cases, you do not need to set any of the authenticator's
24767 private options. All you need to do is to specify an appropriate mechanism as
24768 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24769 PLAIN, you could have two authenticators as follows:
24770 .code
24771 sasl_cram_md5:
24772   driver = cyrus_sasl
24773   public_name = CRAM-MD5
24774   server_set_id = $auth1
24775
24776 sasl_plain:
24777   driver = cyrus_sasl
24778   public_name = PLAIN
24779   server_set_id = $auth2
24780 .endd
24781 Cyrus SASL does implement the LOGIN authentication method, even though it is
24782 not a standard method. It is disabled by default in the source distribution,
24783 but it is present in many binary distributions.
24784 .ecindex IIDcyrauth1
24785 .ecindex IIDcyrauth2
24786
24787
24788
24789
24790 . ////////////////////////////////////////////////////////////////////////////
24791 . ////////////////////////////////////////////////////////////////////////////
24792 .chapter "The dovecot authenticator" "CHAPdovecot"
24793 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24794 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24795 This authenticator is an interface to the authentication facility of the
24796 Dovecot POP/IMAP server, which can support a number of authentication methods.
24797 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24798 to use the same mechanisms for SMTP authentication. This is a server
24799 authenticator only. There is only one option:
24800
24801 .option server_socket dovecot string unset
24802
24803 This option must specify the socket that is the interface to Dovecot
24804 authentication. The &%public_name%& option must specify an authentication
24805 mechanism that Dovecot is configured to support. You can have several
24806 authenticators for different mechanisms. For example:
24807 .code
24808 dovecot_plain:
24809   driver = dovecot
24810   public_name = PLAIN
24811   server_socket = /var/run/dovecot/auth-client
24812   server_set_id = $auth2
24813
24814 dovecot_ntlm:
24815   driver = dovecot
24816   public_name = NTLM
24817   server_socket = /var/run/dovecot/auth-client
24818   server_set_id = $auth1
24819 .endd
24820 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24821 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24822 option is passed in the Dovecot authentication command. If, for a TLS
24823 connection, a client certificate has been verified, the &"valid-client-cert"&
24824 option is passed. When authentication succeeds, the identity of the user
24825 who authenticated is placed in &$auth1$&.
24826 .ecindex IIDdcotauth1
24827 .ecindex IIDdcotauth2
24828
24829
24830 . ////////////////////////////////////////////////////////////////////////////
24831 . ////////////////////////////////////////////////////////////////////////////
24832 .chapter "The gsasl authenticator" "CHAPgsasl"
24833 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
24834 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
24835 .cindex "authentication" "GNU SASL"
24836 .cindex "authentication" "SASL"
24837 .cindex "authentication" "EXTERNAL"
24838 .cindex "authentication" "ANONYMOUS"
24839 .cindex "authentication" "PLAIN"
24840 .cindex "authentication" "LOGIN"
24841 .cindex "authentication" "DIGEST-MD5"
24842 .cindex "authentication" "CRAM-MD5"
24843 .cindex "authentication" "SCRAM-SHA-1"
24844 The &(gsasl)& authenticator provides server integration for the GNU SASL
24845 library and the mechanisms it provides.  This is new as of the 4.80 release
24846 and there are a few areas where the library does not let Exim smoothly
24847 scale to handle future authentication mechanisms, so no guarantee can be
24848 made that any particular new authentication mechanism will be supported
24849 without code changes in Exim.
24850
24851
24852 .option server_channelbinding gsasl boolean false
24853 Some authentication mechanisms are able to use external context at both ends
24854 of the session to bind the authentication to that context, and fail the
24855 authentication process if that context differs.  Specifically, some TLS
24856 ciphersuites can provide identifying information about the cryptographic
24857 context.
24858
24859 This means that certificate identity and verification becomes a non-issue,
24860 as a man-in-the-middle attack will cause the correct client and server to
24861 see different identifiers and authentication will fail.
24862
24863 This is currently only supported when using the GnuTLS library.  This is
24864 only usable by mechanisms which support "channel binding"; at time of
24865 writing, that's the SCRAM family.
24866
24867 This defaults off to ensure smooth upgrade across Exim releases, in case
24868 this option causes some clients to start failing.  Some future release
24869 of Exim may switch the default to be true.
24870
24871
24872 .option server_hostname gsasl string&!! "see below"
24873 This option selects the hostname that is used when communicating with the
24874 library. The default value is &`$primary_hostname`&.
24875 Some mechanisms will use this data.
24876
24877
24878 .option server_mech gsasl string "see below"
24879 This option selects the authentication mechanism this driver should use. The
24880 default is the value of the generic &%public_name%& option. This option allows
24881 you to use a different underlying mechanism from the advertised name. For
24882 example:
24883 .code
24884 sasl:
24885   driver = gsasl
24886   public_name = X-ANYTHING
24887   server_mech = CRAM-MD5
24888   server_set_id = $auth1
24889 .endd
24890
24891
24892 .option server_password gsasl string&!! unset
24893 Various mechanisms need access to the cleartext password on the server, so
24894 that proof-of-possession can be demonstrated on the wire, without sending
24895 the password itself.
24896
24897 The data available for lookup varies per mechanism.
24898 In all cases, &$auth1$& is set to the &'authentication id'&.
24899 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
24900 if available, else the empty string.
24901 The &$auth3$& variable will always be the &'realm'& if available,
24902 else the empty string.
24903
24904 A forced failure will cause authentication to defer.
24905
24906 If using this option, it may make sense to set the &%server_condition%&
24907 option to be simply "true".
24908
24909
24910 .option server_realm gsasl string&!! unset
24911 This specifies the SASL realm that the server claims to be in.
24912 Some mechanisms will use this data.
24913
24914
24915 .option server_scram_iter gsasl string&!! unset
24916 This option provides data for the SCRAM family of mechanisms.
24917 &$auth1$& is not available at evaluation time.
24918 (This may change, as we receive feedback on use)
24919
24920
24921 .option server_scram_salt gsasl string&!! unset
24922 This option provides data for the SCRAM family of mechanisms.
24923 &$auth1$& is not available at evaluation time.
24924 (This may change, as we receive feedback on use)
24925
24926
24927 .option server_service gsasl string &`smtp`&
24928 This is the SASL service that the server claims to implement.
24929 Some mechanisms will use this data.
24930
24931
24932 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
24933 .vindex "&$auth1$&, &$auth2$&, etc"
24934 These may be set when evaluating specific options, as detailed above.
24935 They will also be set when evaluating &%server_condition%&.
24936
24937 Unless otherwise stated below, the &(gsasl)& integration will use the following
24938 meanings for these variables:
24939
24940 .ilist
24941 .vindex "&$auth1$&"
24942 &$auth1$&: the &'authentication id'&
24943 .next
24944 .vindex "&$auth2$&"
24945 &$auth2$&: the &'authorization id'&
24946 .next
24947 .vindex "&$auth3$&"
24948 &$auth3$&: the &'realm'&
24949 .endlist
24950
24951 On a per-mechanism basis:
24952
24953 .ilist
24954 .cindex "authentication" "EXTERNAL"
24955 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
24956 the &%server_condition%& option must be present.
24957 .next
24958 .cindex "authentication" "ANONYMOUS"
24959 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
24960 the &%server_condition%& option must be present.
24961 .next
24962 .cindex "authentication" "GSSAPI"
24963 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
24964 &$auth2$& will be set to the &'authorization id'&,
24965 the &%server_condition%& option must be present.
24966 .endlist
24967
24968 An &'anonymous token'& is something passed along as an unauthenticated
24969 identifier; this is analogous to FTP anonymous authentication passing an
24970 email address, or software-identifier@, as the "password".
24971
24972
24973 An example showing the password having the realm specified in the callback
24974 and demonstrating a Cyrus SASL to GSASL migration approach is:
24975 .code
24976 gsasl_cyrusless_crammd5:
24977   driver = gsasl
24978   public_name = CRAM-MD5
24979   server_realm = imap.example.org
24980   server_password = ${lookup{$auth1:$auth3:userPassword}\
24981                     dbmjz{/etc/sasldb2}{$value}fail}
24982   server_set_id = ${quote:$auth1}
24983   server_condition = yes
24984 .endd
24985
24986
24987 . ////////////////////////////////////////////////////////////////////////////
24988 . ////////////////////////////////////////////////////////////////////////////
24989
24990 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
24991 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
24992 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
24993 .cindex "authentication" "GSSAPI"
24994 .cindex "authentication" "Kerberos"
24995 The &(heimdal_gssapi)& authenticator provides server integration for the
24996 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
24997 reliably.
24998
24999 .option server_hostname heimdal_gssapi string&!! "see below"
25000 This option selects the hostname that is used, with &%server_service%&,
25001 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25002 identifier.  The default value is &`$primary_hostname`&.
25003
25004 .option server_keytab heimdal_gssapi string&!! unset
25005 If set, then Heimdal will not use the system default keytab (typically
25006 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25007 The value should be a pathname, with no &"file:"& prefix.
25008
25009 .option server_service heimdal_gssapi string&!! "smtp"
25010 This option specifies the service identifier used, in conjunction with
25011 &%server_hostname%&, for building the identifer for finding credentials
25012 from the keytab.
25013
25014
25015 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25016 Beware that these variables will typically include a realm, thus will appear
25017 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25018 not verified, so a malicious client can set it to anything.
25019
25020 The &$auth1$& field should be safely trustable as a value from the Key
25021 Distribution Center.  Note that these are not quite email addresses.
25022 Each identifier is for a role, and so the left-hand-side may include a
25023 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25024
25025 .vindex "&$auth1$&, &$auth2$&, etc"
25026 .ilist
25027 .vindex "&$auth1$&"
25028 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25029 .next
25030 .vindex "&$auth2$&"
25031 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25032 authentication.  If that was empty, this will also be set to the
25033 GSS Display Name.
25034 .endlist
25035
25036
25037 . ////////////////////////////////////////////////////////////////////////////
25038 . ////////////////////////////////////////////////////////////////////////////
25039
25040 .chapter "The spa authenticator" "CHAPspa"
25041 .scindex IIDspaauth1 "&(spa)& authenticator"
25042 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25043 .cindex "authentication" "Microsoft Secure Password"
25044 .cindex "authentication" "NTLM"
25045 .cindex "Microsoft Secure Password Authentication"
25046 .cindex "NTLM authentication"
25047 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25048 Password Authentication'& mechanism,
25049 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25050 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25051 taken from the Samba project (&url(http://www.samba.org)). The code for the
25052 server side was subsequently contributed by Tom Kistner. The mechanism works as
25053 follows:
25054
25055 .ilist
25056 After the AUTH command has been accepted, the client sends an SPA
25057 authentication request based on the user name and optional domain.
25058 .next
25059 The server sends back a challenge.
25060 .next
25061 The client builds a challenge response which makes use of the user's password
25062 and sends it to the server, which then accepts or rejects it.
25063 .endlist
25064
25065 Encryption is used to protect the password in transit.
25066
25067
25068
25069 .section "Using spa as a server" "SECID179"
25070 .cindex "options" "&(spa)& authenticator (server)"
25071 The &(spa)& authenticator has just one server option:
25072
25073 .option server_password spa string&!! unset
25074 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25075 This option is expanded, and the result must be the cleartext password for the
25076 authenticating user, whose name is at this point in &$auth1$&. For
25077 compatibility with previous releases of Exim, the user name is also placed in
25078 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25079 it can lead to confusion in string expansions that also use numeric variables
25080 for other things. For example:
25081 .code
25082 spa:
25083   driver = spa
25084   public_name = NTLM
25085   server_password = \
25086     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25087 .endd
25088 If the expansion is forced to fail, authentication fails. Any other expansion
25089 failure causes a temporary error code to be returned.
25090
25091
25092
25093
25094
25095 .section "Using spa as a client" "SECID180"
25096 .cindex "options" "&(spa)& authenticator (client)"
25097 The &(spa)& authenticator has the following client options:
25098
25099
25100
25101 .option client_domain spa string&!! unset
25102 This option specifies an optional domain for the authentication.
25103
25104
25105 .option client_password spa string&!! unset
25106 This option specifies the user's password, and must be set.
25107
25108
25109 .option client_username spa string&!! unset
25110 This option specifies the user name, and must be set. Here is an example of a
25111 configuration of this authenticator for use with the mail servers at
25112 &'msn.com'&:
25113 .code
25114 msn:
25115   driver = spa
25116   public_name = MSN
25117   client_username = msn/msn_username
25118   client_password = msn_plaintext_password
25119   client_domain = DOMAIN_OR_UNSET
25120 .endd
25121 .ecindex IIDspaauth1
25122 .ecindex IIDspaauth2
25123
25124
25125
25126
25127
25128 . ////////////////////////////////////////////////////////////////////////////
25129 . ////////////////////////////////////////////////////////////////////////////
25130
25131 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25132          "Encrypted SMTP connections"
25133 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25134 .scindex IIDencsmtp2 "SMTP" "encryption"
25135 .cindex "TLS" "on SMTP connection"
25136 .cindex "OpenSSL"
25137 .cindex "GnuTLS"
25138 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25139 Sockets Layer), is implemented by making use of the OpenSSL library or the
25140 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25141 cryptographic code in the Exim distribution itself for implementing TLS. In
25142 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25143 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25144 You also need to understand the basic concepts of encryption at a managerial
25145 level, and in particular, the way that public keys, private keys, and
25146 certificates are used.
25147
25148 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25149 connection is established, the client issues a STARTTLS command. If the
25150 server accepts this, the client and the server negotiate an encryption
25151 mechanism. If the negotiation succeeds, the data that subsequently passes
25152 between them is encrypted.
25153
25154 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25155 and if so, what cipher suite is in use, whether the client supplied a
25156 certificate, and whether or not that certificate was verified. This makes it
25157 possible for an Exim server to deny or accept certain commands based on the
25158 encryption state.
25159
25160 &*Warning*&: Certain types of firewall and certain anti-virus products can
25161 disrupt TLS connections. You need to turn off SMTP scanning for these products
25162 in order to get TLS to work.
25163
25164
25165
25166 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25167          "SECID284"
25168 .cindex "ssmtp protocol"
25169 .cindex "smtps protocol"
25170 .cindex "SMTP" "ssmtp protocol"
25171 .cindex "SMTP" "smtps protocol"
25172 Early implementations of encrypted SMTP used a different TCP port from normal
25173 SMTP, and expected an encryption negotiation to start immediately, instead of
25174 waiting for a STARTTLS command from the client using the standard SMTP
25175 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25176 allocated for this purpose.
25177
25178 This approach was abandoned when encrypted SMTP was standardized, but there are
25179 still some legacy clients that use it. Exim supports these clients by means of
25180 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25181 numbers; the most common use is expected to be:
25182 .code
25183 tls_on_connect_ports = 465
25184 .endd
25185 The port numbers specified by this option apply to all SMTP connections, both
25186 via the daemon and via &'inetd'&. You still need to specify all the ports that
25187 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25188 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25189 an extra port &-- rather, it specifies different behaviour on a port that is
25190 defined elsewhere.
25191
25192 There is also a &%-tls-on-connect%& command line option. This overrides
25193 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25194
25195
25196
25197
25198
25199
25200 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25201 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25202 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25203 followed later, when the first versions of GnuTLS were released. To build Exim
25204 to use GnuTLS, you need to set
25205 .code
25206 USE_GNUTLS=yes
25207 .endd
25208 in Local/Makefile, in addition to
25209 .code
25210 SUPPORT_TLS=yes
25211 .endd
25212 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25213 include files and libraries for GnuTLS can be found.
25214
25215 There are some differences in usage when using GnuTLS instead of OpenSSL:
25216
25217 .ilist
25218 The &%tls_verify_certificates%& option must contain the name of a file, not the
25219 name of a directory (for OpenSSL it can be either).
25220 .next
25221 The default value for &%tls_dhparam%& differs for historical reasons.
25222 .next
25223 .vindex "&$tls_in_peerdn$&"
25224 .vindex "&$tls_out_peerdn$&"
25225 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25226 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25227 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25228 .next
25229 OpenSSL identifies cipher suites using hyphens as separators, for example:
25230 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25231 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25232 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25233 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25234 to handle its own older variants) when processing lists of cipher suites in the
25235 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25236 option).
25237 .next
25238 The &%tls_require_ciphers%& options operate differently, as described in the
25239 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25240 .next
25241 .new
25242 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25243 When using OpenSSL, this option is ignored.
25244 (If an API is found to let OpenSSL be configured in this way,
25245 let the Exim Maintainers know and we'll likely use it).
25246 .wen
25247 .next
25248 Some other recently added features may only be available in one or the other.
25249 This should be documented with the feature.  If the documentation does not
25250 explicitly state that the feature is infeasible in the other TLS
25251 implementation, then patches are welcome.
25252 .endlist
25253
25254
25255 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25256 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25257 an explicit path; if the latter, then the text about generation still applies,
25258 but not the chosen filename.
25259 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25260 See the documentation of &%tls_dhparam%& for more information.
25261
25262 GnuTLS uses D-H parameters that may take a substantial amount of time
25263 to compute. It is unreasonable to re-compute them for every TLS session.
25264 Therefore, Exim keeps this data in a file in its spool directory, called
25265 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25266 of bits requested.
25267 The file is owned by the Exim user and is readable only by
25268 its owner. Every Exim process that start up GnuTLS reads the D-H
25269 parameters from this file. If the file does not exist, the first Exim process
25270 that needs it computes the data and writes it to a temporary file which is
25271 renamed once it is complete. It does not matter if several Exim processes do
25272 this simultaneously (apart from wasting a few resources). Once a file is in
25273 place, new Exim processes immediately start using it.
25274
25275 For maximum security, the parameters that are stored in this file should be
25276 recalculated periodically, the frequency depending on your paranoia level.
25277 If you are avoiding using the fixed D-H primes published in RFCs, then you
25278 are concerned about some advanced attacks and will wish to do this; if you do
25279 not regenerate then you might as well stick to the standard primes.
25280
25281 Arranging this is easy in principle; just delete the file when you want new
25282 values to be computed. However, there may be a problem. The calculation of new
25283 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25284 If the system is not very active, &_/dev/random_& may delay returning data
25285 until enough randomness (entropy) is available. This may cause Exim to hang for
25286 a substantial amount of time, causing timeouts on incoming connections.
25287
25288 The solution is to generate the parameters externally to Exim. They are stored
25289 in &_gnutls-params-N_& in PEM format, which means that they can be
25290 generated externally using the &(certtool)& command that is part of GnuTLS.
25291
25292 To replace the parameters with new ones, instead of deleting the file
25293 and letting Exim re-create it, you can generate new parameters using
25294 &(certtool)& and, when this has been done, replace Exim's cache file by
25295 renaming. The relevant commands are something like this:
25296 .code
25297 # ls
25298 [ look for file; assume gnutls-params-2236 is the most recent ]
25299 # rm -f new-params
25300 # touch new-params
25301 # chown exim:exim new-params
25302 # chmod 0600 new-params
25303 # certtool --generate-dh-params --bits 2236 >>new-params
25304 # openssl dhparam -noout -text -in new-params | head
25305 [ check the first line, make sure it's not more than 2236;
25306   if it is, then go back to the start ("rm") and repeat
25307   until the size generated is at most the size requested ]
25308 # chmod 0400 new-params
25309 # mv new-params gnutls-params-2236
25310 .endd
25311 If Exim never has to generate the parameters itself, the possibility of
25312 stalling is removed.
25313
25314 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25315 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25316 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25317 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25318 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25319 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25320 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25321 which applies to all D-H usage, client or server.  If the value returned by
25322 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25323 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25324 limit, which is still much higher than Exim historically used.
25325
25326 The filename and bits used will change as the GnuTLS maintainers change the
25327 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25328 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25329 2432 bits, while NSS is limited to 2236 bits.
25330
25331 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25332 increase the chance of the generated prime actually being within acceptable
25333 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25334 procedure above.  There is no sane procedure available to Exim to double-check
25335 the size of the generated prime, so it might still be too large.
25336
25337
25338 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25339 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25340 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25341 There is a function in the OpenSSL library that can be passed a list of cipher
25342 suites before the cipher negotiation takes place. This specifies which ciphers
25343 are acceptable. The list is colon separated and may contain names like
25344 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25345 directly to this function call.
25346 Many systems will install the OpenSSL manual-pages, so you may have
25347 &'ciphers(1)'& available to you.
25348 The following quotation from the OpenSSL
25349 documentation specifies what forms of item are allowed in the cipher string:
25350
25351 .ilist
25352 It can consist of a single cipher suite such as RC4-SHA.
25353 .next
25354 It can represent a list of cipher suites containing a certain algorithm,
25355 or cipher suites of a certain type. For example SHA1 represents all
25356 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25357 SSL v3 algorithms.
25358 .next
25359 Lists of cipher suites can be combined in a single cipher string using
25360 the + character. This is used as a logical and operation. For example
25361 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25362 algorithms.
25363 .endlist
25364
25365 Each cipher string can be optionally preceded by one of the characters &`!`&,
25366 &`-`& or &`+`&.
25367 .ilist
25368 If &`!`& is used, the ciphers are permanently deleted from the list. The
25369 ciphers deleted can never reappear in the list even if they are explicitly
25370 stated.
25371 .next
25372 If &`-`& is used, the ciphers are deleted from the list, but some or all
25373 of the ciphers can be added again by later options.
25374 .next
25375 If &`+`& is used, the ciphers are moved to the end of the list. This
25376 option does not add any new ciphers; it just moves matching existing ones.
25377 .endlist
25378
25379 If none of these characters is present, the string is interpreted as
25380 a list of ciphers to be appended to the current preference list. If the list
25381 includes any ciphers already present they will be ignored: that is, they will
25382 not be moved to the end of the list.
25383 .endlist
25384
25385 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25386 string:
25387 .code
25388 # note single-quotes to get ! past any shell history expansion
25389 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25390 .endd
25391
25392 This example will let the library defaults be permitted on the MX port, where
25393 there's probably no identity verification anyway, but ups the ante on the
25394 submission ports where the administrator might have some influence on the
25395 choice of clients used:
25396 .code
25397 # OpenSSL variant; see man ciphers(1)
25398 tls_require_ciphers = ${if =={$received_port}{25}\
25399                            {DEFAULT}\
25400                            {HIGH:!MD5:!SHA1}}
25401 .endd
25402
25403
25404
25405 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25406          "SECTreqciphgnu"
25407 .cindex "GnuTLS" "specifying parameters for"
25408 .cindex "TLS" "specifying ciphers (GnuTLS)"
25409 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25410 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25411 .cindex "TLS" "specifying protocols (GnuTLS)"
25412 .cindex "TLS" "specifying priority string (GnuTLS)"
25413 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25414 The GnuTLS library allows the caller to provide a "priority string", documented
25415 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25416 ciphersuite specification in OpenSSL.
25417
25418 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25419
25420 The &%tls_require_ciphers%& option is available both as an global option,
25421 controlling how Exim behaves as a server, and also as an option of the
25422 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25423 the value is string expanded.  The resulting string is not an Exim list and
25424 the string is given to the GnuTLS library, so that Exim does not need to be
25425 aware of future feature enhancements of GnuTLS.
25426
25427 Documentation of the strings accepted may be found in the GnuTLS manual, under
25428 "Priority strings".  This is online as
25429 &url(http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html),
25430 but beware that this relates to GnuTLS 3, which may be newer than the version
25431 installed on your system.  If you are using GnuTLS 3,
25432 &url(http://www.gnu.org/software/gnutls/manual/html_node/Listing-the-ciphersuites-in-a-priority-string.html, then the example code)
25433 on that site can be used to test a given string.
25434
25435 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25436 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25437 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25438
25439 This example will let the library defaults be permitted on the MX port, where
25440 there's probably no identity verification anyway, and lowers security further
25441 by increasing compatibility; but this ups the ante on the submission ports
25442 where the administrator might have some influence on the choice of clients
25443 used:
25444 .code
25445 # GnuTLS variant
25446 tls_require_ciphers = ${if =={$received_port}{25}\
25447                            {NORMAL:%COMPAT}\
25448                            {SECURE128}}
25449 .endd
25450
25451
25452 .section "Configuring an Exim server to use TLS" "SECID182"
25453 .cindex "TLS" "configuring an Exim server"
25454 When Exim has been built with TLS support, it advertises the availability of
25455 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25456 but not to any others. The default value of this option is unset, which means
25457 that STARTTLS is not advertised at all. This default is chosen because you
25458 need to set some other options in order to make TLS available, and also it is
25459 sensible for systems that want to use TLS only as a client.
25460
25461 If a client issues a STARTTLS command and there is some configuration
25462 problem in the server, the command is rejected with a 454 error. If the client
25463 persists in trying to issue SMTP commands, all except QUIT are rejected
25464 with the error
25465 .code
25466 554 Security failure
25467 .endd
25468 If a STARTTLS command is issued within an existing TLS session, it is
25469 rejected with a 554 error code.
25470
25471 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25472 match some hosts. You can, of course, set it to * to match all hosts.
25473 However, this is not all you need to do. TLS sessions to a server won't work
25474 without some further configuration at the server end.
25475
25476 It is rumoured that all existing clients that support TLS/SSL use RSA
25477 encryption. To make this work you need to set, in the server,
25478 .code
25479 tls_certificate = /some/file/name
25480 tls_privatekey = /some/file/name
25481 .endd
25482 These options are, in fact, expanded strings, so you can make them depend on
25483 the identity of the client that is connected if you wish. The first file
25484 contains the server's X509 certificate, and the second contains the private key
25485 that goes with it. These files need to be readable by the Exim user, and must
25486 always be given as full path names. They can be the same file if both the
25487 certificate and the key are contained within it. If &%tls_privatekey%& is not
25488 set, or if its expansion is forced to fail or results in an empty string, this
25489 is assumed to be the case. The certificate file may also contain intermediate
25490 certificates that need to be sent to the client to enable it to authenticate
25491 the server's certificate.
25492
25493 If you do not understand about certificates and keys, please try to find a
25494 source of this background information, which is not Exim-specific. (There are a
25495 few comments below in section &<<SECTcerandall>>&.)
25496
25497 &*Note*&: These options do not apply when Exim is operating as a client &--
25498 they apply only in the case of a server. If you need to use a certificate in an
25499 Exim client, you must set the options of the same names in an &(smtp)&
25500 transport.
25501
25502 With just these options, an Exim server will be able to use TLS. It does not
25503 require the client to have a certificate (but see below for how to insist on
25504 this). There is one other option that may be needed in other situations. If
25505 .code
25506 tls_dhparam = /some/file/name
25507 .endd
25508 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25509 with the parameters contained in the file.
25510 Set this to &`none`& to disable use of DH entirely, by making no prime
25511 available:
25512 .code
25513 tls_dhparam = none
25514 .endd
25515 This may also be set to a string identifying a standard prime to be used for
25516 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25517 used is &`ike23`&.  There are a few standard primes available, see the
25518 documetnation for &%tls_dhparam%& for the complete list.
25519
25520 See the command
25521 .code
25522 openssl dhparam
25523 .endd
25524 for a way of generating file data.
25525
25526 The strings supplied for these three options are expanded every time a client
25527 host connects. It is therefore possible to use different certificates and keys
25528 for different hosts, if you so wish, by making use of the client's IP address
25529 in &$sender_host_address$& to control the expansion. If a string expansion is
25530 forced to fail, Exim behaves as if the option is not set.
25531
25532 .cindex "cipher" "logging"
25533 .cindex "log" "TLS cipher"
25534 .vindex "&$tls_in_cipher$&"
25535 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
25536 an incoming TLS connection. It is included in the &'Received:'& header of an
25537 incoming message (by default &-- you can, of course, change this), and it is
25538 also included in the log line that records a message's arrival, keyed by
25539 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25540 condition can be used to test for specific cipher suites in ACLs.
25541
25542 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25543 can check the name of the cipher suite and vary their actions accordingly. The
25544 cipher suite names vary, depending on which TLS library is being used. For
25545 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25546 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25547 documentation for more details.
25548
25549 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
25550 (again depending on the &%tls_cipher%& log selector).
25551
25552
25553 .section "Requesting and verifying client certificates" "SECID183"
25554 .cindex "certificate" "verification of client"
25555 .cindex "TLS" "client certificate verification"
25556 If you want an Exim server to request a certificate when negotiating a TLS
25557 session with a client, you must set either &%tls_verify_hosts%& or
25558 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25559 apply to all TLS connections. For any host that matches one of these options,
25560 Exim requests a certificate as part of the setup of the TLS session. The
25561 contents of the certificate are verified by comparing it with a list of
25562 expected certificates. These must be available in a file or,
25563 for OpenSSL only (not GnuTLS), a directory, identified by
25564 &%tls_verify_certificates%&.
25565
25566 A file can contain multiple certificates, concatenated end to end. If a
25567 directory is used
25568 (OpenSSL only),
25569 each certificate must be in a separate file, with a name (or a symbolic link)
25570 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25571 certificate. You can compute the relevant hash by running the command
25572 .code
25573 openssl x509 -hash -noout -in /cert/file
25574 .endd
25575 where &_/cert/file_& contains a single certificate.
25576
25577 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25578 what happens if the client does not supply a certificate, or if the certificate
25579 does not match any of the certificates in the collection named by
25580 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25581 attempt to set up a TLS session is aborted, and the incoming connection is
25582 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25583 session continues. ACLs that run for subsequent SMTP commands can detect the
25584 fact that no certificate was verified, and vary their actions accordingly. For
25585 example, you can insist on a certificate before accepting a message for
25586 relaying, but not when the message is destined for local delivery.
25587
25588 .vindex "&$tls_in_peerdn$&"
25589 When a client supplies a certificate (whether it verifies or not), the value of
25590 the Distinguished Name of the certificate is made available in the variable
25591 &$tls_in_peerdn$& during subsequent processing of the message.
25592
25593 .cindex "log" "distinguished name"
25594 Because it is often a long text string, it is not included in the log line or
25595 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25596 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25597 &%received_header_text%& to change the &'Received:'& header. When no
25598 certificate is supplied, &$tls_in_peerdn$& is empty.
25599
25600
25601 .section "Revoked certificates" "SECID184"
25602 .cindex "TLS" "revoked certificates"
25603 .cindex "revocation list"
25604 .cindex "certificate" "revocation list"
25605 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25606 certificates are revoked. If you have such a list, you can pass it to an Exim
25607 server using the global option called &%tls_crl%& and to an Exim client using
25608 an identically named option for the &(smtp)& transport. In each case, the value
25609 of the option is expanded and must then be the name of a file that contains a
25610 CRL in PEM format.
25611
25612
25613 .section "Configuring an Exim client to use TLS" "SECID185"
25614 .cindex "cipher" "logging"
25615 .cindex "log" "TLS cipher"
25616 .cindex "log" "distinguished name"
25617 .cindex "TLS" "configuring an Exim client"
25618 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25619 deliveries as well as to incoming, the latter one causing logging of the
25620 server certificate's DN. The remaining client configuration for TLS is all
25621 within the &(smtp)& transport.
25622
25623 It is not necessary to set any options to have TLS work in the &(smtp)&
25624 transport. If Exim is built with TLS support, and TLS is advertised by a
25625 server, the &(smtp)& transport always tries to start a TLS session. However,
25626 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25627 transport) to a list of server hosts for which TLS should not be used.
25628
25629 If you do not want Exim to attempt to send messages unencrypted when an attempt
25630 to set up an encrypted connection fails in any way, you can set
25631 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25632 those hosts, delivery is always deferred if an encrypted connection cannot be
25633 set up. If there are any other hosts for the address, they are tried in the
25634 usual way.
25635
25636 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25637 the message unencrypted. It always does this if the response to STARTTLS is
25638 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25639 session after a success response code, what happens is controlled by the
25640 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25641 delivery to this host is deferred, and other hosts (if available) are tried. If
25642 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25643 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25644 negotiation fails, Exim closes the current connection (because it is in an
25645 unknown state), opens a new one to the same host, and then tries the delivery
25646 unencrypted.
25647
25648 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25649 transport provide the client with a certificate, which is passed to the server
25650 if it requests it. If the server is Exim, it will request a certificate only if
25651 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25652
25653 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25654 must name a file or,
25655 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25656 expected server certificates. The client verifies the server's certificate
25657 against this collection, taking into account any revoked certificates that are
25658 in the list defined by &%tls_crl%&.
25659
25660 If
25661 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25662 list of permitted cipher suites. If either of these checks fails, delivery to
25663 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25664 alternative hosts, if any.
25665
25666  &*Note*&:
25667 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25668 is operating as a client. Exim does not assume that a server certificate (set
25669 by the global options of the same name) should also be used when operating as a
25670 client.
25671
25672 .vindex "&$host$&"
25673 .vindex "&$host_address$&"
25674 All the TLS options in the &(smtp)& transport are expanded before use, with
25675 &$host$& and &$host_address$& containing the name and address of the server to
25676 which the client is connected. Forced failure of an expansion causes Exim to
25677 behave as if the relevant option were unset.
25678
25679 .vindex &$tls_out_bits$&
25680 .vindex &$tls_out_cipher$&
25681 .vindex &$tls_out_peerdn$&
25682 .vindex &$tls_out_sni$&
25683 Before an SMTP connection is established, the
25684 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
25685 variables are emptied. (Until the first connection, they contain the values
25686 that were set when the message was received.) If STARTTLS is subsequently
25687 successfully obeyed, these variables are set to the relevant values for the
25688 outgoing connection.
25689
25690
25691
25692 .section "Use of TLS Server Name Indication" "SECTtlssni"
25693 .cindex "TLS" "Server Name Indication"
25694 .vindex "&$tls_in_sni$&"
25695 .oindex "&%tls_in_sni%&"
25696 With TLS1.0 or above, there is an extension mechanism by which extra
25697 information can be included at various points in the protocol.  One of these
25698 extensions, documented in RFC 6066 (and before that RFC 4366) is
25699 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25700 client in the initial handshake, so that the server can examine the servername
25701 within and possibly choose to use different certificates and keys (and more)
25702 for this session.
25703
25704 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25705 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25706 address.
25707
25708 With SMTP to MX, there are the same problems here as in choosing the identity
25709 against which to validate a certificate: you can't rely on insecure DNS to
25710 provide the identity which you then cryptographically verify.  So this will
25711 be of limited use in that environment.
25712
25713 With SMTP to Submission, there is a well-defined hostname which clients are
25714 connecting to and can validate certificates against.  Thus clients &*can*&
25715 choose to include this information in the TLS negotiation.  If this becomes
25716 wide-spread, then hosters can choose to present different certificates to
25717 different clients.  Or even negotiate different cipher suites.
25718
25719 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25720 if not empty, will be sent on a TLS session as part of the handshake.  There's
25721 nothing more to it.  Choosing a sensible value not derived insecurely is the
25722 only point of caution.  The &$tls_out_sni$& variable will be set to this string
25723 for the lifetime of the client connection (including during authentication).
25724
25725 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
25726 received from a client.
25727 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25728
25729 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
25730 option (prior to expansion) then the following options will be re-expanded
25731 during TLS session handshake, to permit alternative values to be chosen:
25732
25733 .ilist
25734 .vindex "&%tls_certificate%&"
25735 &%tls_certificate%&
25736 .next
25737 .vindex "&%tls_crl%&"
25738 &%tls_crl%&
25739 .next
25740 .vindex "&%tls_privatekey%&"
25741 &%tls_privatekey%&
25742 .next
25743 .vindex "&%tls_verify_certificates%&"
25744 &%tls_verify_certificates%&
25745 .endlist
25746
25747 Great care should be taken to deal with matters of case, various injection
25748 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25749 can always be referenced; it is important to remember that &$tls_sni$& is
25750 arbitrary unverified data provided prior to authentication.
25751
25752 The Exim developers are proceeding cautiously and so far no other TLS options
25753 are re-expanded.
25754
25755 When Exim is built againt OpenSSL, OpenSSL must have been built with support
25756 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
25757 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
25758 see &`-servername`& in the output, then OpenSSL has support.
25759
25760 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
25761 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
25762 built, then you have SNI support).
25763
25764
25765
25766 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25767          "SECTmulmessam"
25768 .cindex "multiple SMTP deliveries with TLS"
25769 .cindex "TLS" "multiple message deliveries"
25770 Exim sends multiple messages down the same TCP/IP connection by starting up
25771 an entirely new delivery process for each message, passing the socket from
25772 one process to the next. This implementation does not fit well with the use
25773 of TLS, because there is quite a lot of state information associated with a TLS
25774 connection, not just a socket identification. Passing all the state information
25775 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25776 session before passing the socket to a new process. The new process may then
25777 try to start a new TLS session, and if successful, may try to re-authenticate
25778 if AUTH is in use, before sending the next message.
25779
25780 The RFC is not clear as to whether or not an SMTP session continues in clear
25781 after TLS has been shut down, or whether TLS may be restarted again later, as
25782 just described. However, if the server is Exim, this shutdown and
25783 reinitialization works. It is not known which (if any) other servers operate
25784 successfully if the client closes a TLS session and continues with unencrypted
25785 SMTP, but there are certainly some that do not work. For such servers, Exim
25786 should not pass the socket to another process, because the failure of the
25787 subsequent attempt to use it would cause Exim to record a temporary host error,
25788 and delay other deliveries to that host.
25789
25790 To test for this case, Exim sends an EHLO command to the server after
25791 closing down the TLS session. If this fails in any way, the connection is
25792 closed instead of being passed to a new delivery process, but no retry
25793 information is recorded.
25794
25795 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25796 &(smtp)& transport to match those hosts for which Exim should not pass
25797 connections to new processes if TLS has been used.
25798
25799
25800
25801
25802 .section "Certificates and all that" "SECTcerandall"
25803 .cindex "certificate" "references to discussion"
25804 In order to understand fully how TLS works, you need to know about
25805 certificates, certificate signing, and certificate authorities. This is not the
25806 place to give a tutorial, especially as I do not know very much about it
25807 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25808 to Apache, currently at
25809 .display
25810 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25811 .endd
25812 Other parts of the &'modssl'& documentation are also helpful, and have
25813 links to further files.
25814 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25815 0-201-61598-3), contains both introductory and more in-depth descriptions.
25816 Some sample programs taken from the book are available from
25817 .display
25818 &url(http://www.rtfm.com/openssl-examples/)
25819 .endd
25820
25821
25822 .section "Certificate chains" "SECID186"
25823 The file named by &%tls_certificate%& may contain more than one
25824 certificate. This is useful in the case where the certificate that is being
25825 sent is validated by an intermediate certificate which the other end does
25826 not have. Multiple certificates must be in the correct order in the file.
25827 First the host's certificate itself, then the first intermediate
25828 certificate to validate the issuer of the host certificate, then the next
25829 intermediate certificate to validate the issuer of the first intermediate
25830 certificate, and so on, until finally (optionally) the root certificate.
25831 The root certificate must already be trusted by the recipient for
25832 validation to succeed, of course, but if it's not preinstalled, sending the
25833 root certificate along with the rest makes it available for the user to
25834 install if the receiving end is a client MUA that can interact with a user.
25835
25836
25837 .section "Self-signed certificates" "SECID187"
25838 .cindex "certificate" "self-signed"
25839 You can create a self-signed certificate using the &'req'& command provided
25840 with OpenSSL, like this:
25841 .code
25842 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
25843             -days 9999 -nodes
25844 .endd
25845 &_file1_& and &_file2_& can be the same file; the key and the certificate are
25846 delimited and so can be identified independently. The &%-days%& option
25847 specifies a period for which the certificate is valid. The &%-nodes%& option is
25848 important: if you do not set it, the key is encrypted with a passphrase
25849 that you are prompted for, and any use that is made of the key causes more
25850 prompting for the passphrase. This is not helpful if you are going to use
25851 this certificate and key in an MTA, where prompting is not possible.
25852
25853 A self-signed certificate made in this way is sufficient for testing, and
25854 may be adequate for all your requirements if you are mainly interested in
25855 encrypting transfers, and not in secure identification.
25856
25857 However, many clients require that the certificate presented by the server be a
25858 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
25859 certificate. In this situation, the self-signed certificate described above
25860 must be installed on the client host as a trusted root &'certification
25861 authority'& (CA), and the certificate used by Exim must be a user certificate
25862 signed with that self-signed certificate.
25863
25864 For information on creating self-signed CA certificates and using them to sign
25865 user certificates, see the &'General implementation overview'& chapter of the
25866 Open-source PKI book, available online at
25867 &url(http://ospkibook.sourceforge.net/).
25868 .ecindex IIDencsmtp1
25869 .ecindex IIDencsmtp2
25870
25871
25872
25873 . ////////////////////////////////////////////////////////////////////////////
25874 . ////////////////////////////////////////////////////////////////////////////
25875
25876 .chapter "Access control lists" "CHAPACL"
25877 .scindex IIDacl "&ACL;" "description"
25878 .cindex "control of incoming mail"
25879 .cindex "message" "controlling incoming"
25880 .cindex "policy control" "access control lists"
25881 Access Control Lists (ACLs) are defined in a separate section of the run time
25882 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
25883 name, terminated by a colon. Here is a complete ACL section that contains just
25884 one very small ACL:
25885 .code
25886 begin acl
25887 small_acl:
25888   accept   hosts = one.host.only
25889 .endd
25890 You can have as many lists as you like in the ACL section, and the order in
25891 which they appear does not matter. The lists are self-terminating.
25892
25893 The majority of ACLs are used to control Exim's behaviour when it receives
25894 certain SMTP commands. This applies both to incoming TCP/IP connections, and
25895 when a local process submits a message using SMTP by specifying the &%-bs%&
25896 option. The most common use is for controlling which recipients are accepted
25897 in incoming messages. In addition, you can define an ACL that is used to check
25898 local non-SMTP messages. The default configuration file contains an example of
25899 a realistic ACL for checking RCPT commands. This is discussed in chapter
25900 &<<CHAPdefconfil>>&.
25901
25902
25903 .section "Testing ACLs" "SECID188"
25904 The &%-bh%& command line option provides a way of testing your ACL
25905 configuration locally by running a fake SMTP session with which you interact.
25906 The host &'relay-test.mail-abuse.org'& provides a service for checking your
25907 relaying configuration (see section &<<SECTcheralcon>>& for more details).
25908
25909
25910
25911 .section "Specifying when ACLs are used" "SECID189"
25912 .cindex "&ACL;" "options for specifying"
25913 In order to cause an ACL to be used, you have to name it in one of the relevant
25914 options in the main part of the configuration. These options are:
25915 .cindex "AUTH" "ACL for"
25916 .cindex "DATA" "ACLs for"
25917 .cindex "ETRN" "ACL for"
25918 .cindex "EXPN" "ACL for"
25919 .cindex "HELO" "ACL for"
25920 .cindex "EHLO" "ACL for"
25921 .cindex "MAIL" "ACL for"
25922 .cindex "QUIT, ACL for"
25923 .cindex "RCPT" "ACL for"
25924 .cindex "STARTTLS, ACL for"
25925 .cindex "VRFY" "ACL for"
25926 .cindex "SMTP" "connection, ACL for"
25927 .cindex "non-SMTP messages" "ACLs for"
25928 .cindex "MIME content scanning" "ACL for"
25929
25930 .table2 140pt
25931 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
25932 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25933 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25934 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25935 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
25936 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
25937 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
25938 .irow &%acl_smtp_expn%&        "ACL for EXPN"
25939 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
25940 .irow &%acl_smtp_mail%&        "ACL for MAIL"
25941 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
25942 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
25943 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
25944 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
25945 .irow &%acl_smtp_quit%&        "ACL for QUIT"
25946 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
25947 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
25948 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
25949 .endtable
25950
25951 For example, if you set
25952 .code
25953 acl_smtp_rcpt = small_acl
25954 .endd
25955 the little ACL defined above is used whenever Exim receives a RCPT command
25956 in an SMTP dialogue. The majority of policy tests on incoming messages can be
25957 done when RCPT commands arrive. A rejection of RCPT should cause the
25958 sending MTA to give up on the recipient address contained in the RCPT
25959 command, whereas rejection at other times may cause the client MTA to keep on
25960 trying to deliver the message. It is therefore recommended that you do as much
25961 testing as possible at RCPT time.
25962
25963
25964 .section "The non-SMTP ACLs" "SECID190"
25965 .cindex "non-SMTP messages" "ACLs for"
25966 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
25967 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
25968 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
25969 the state of the SMTP connection such as encryption and authentication) are not
25970 relevant and are forbidden in these ACLs. However, the sender and recipients
25971 are known, so the &%senders%& and &%sender_domains%& conditions and the
25972 &$sender_address$& and &$recipients$& variables can be used. Variables such as
25973 &$authenticated_sender$& are also available. You can specify added header lines
25974 in any of these ACLs.
25975
25976 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
25977 non-SMTP message, before any of the message has been read. (This is the
25978 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
25979 batched SMTP input, it runs after the DATA command has been reached. The
25980 result of this ACL is ignored; it cannot be used to reject a message. If you
25981 really need to, you could set a value in an ACL variable here and reject based
25982 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
25983 controls, and in particular, it can be used to set
25984 .code
25985 control = suppress_local_fixups
25986 .endd
25987 This cannot be used in the other non-SMTP ACLs because by the time they are
25988 run, it is too late.
25989
25990 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
25991 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25992
25993 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
25994 kind of rejection is treated as permanent, because there is no way of sending a
25995 temporary error for these kinds of message.
25996
25997
25998 .section "The SMTP connect ACL" "SECID191"
25999 .cindex "SMTP" "connection, ACL for"
26000 .oindex &%smtp_banner%&
26001 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26002 session, after the test specified by &%host_reject_connection%& (which is now
26003 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26004 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26005 the message override the banner message that is otherwise specified by the
26006 &%smtp_banner%& option.
26007
26008
26009 .section "The EHLO/HELO ACL" "SECID192"
26010 .cindex "EHLO" "ACL for"
26011 .cindex "HELO" "ACL for"
26012 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26013 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26014 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26015 Note that a client may issue more than one EHLO or HELO command in an SMTP
26016 session, and indeed is required to issue a new EHLO or HELO after successfully
26017 setting up encryption following a STARTTLS command.
26018
26019 If the command is accepted by an &%accept%& verb that has a &%message%&
26020 modifier, the message may not contain more than one line (it will be truncated
26021 at the first newline and a panic logged if it does). Such a message cannot
26022 affect the EHLO options that are listed on the second and subsequent lines of
26023 an EHLO response.
26024
26025
26026 .section "The DATA ACLs" "SECID193"
26027 .cindex "DATA" "ACLs for"
26028 Two ACLs are associated with the DATA command, because it is two-stage
26029 command, with two responses being sent to the client.
26030 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26031 is obeyed. This gives you control after all the RCPT commands, but before
26032 the message itself is received. It offers the opportunity to give a negative
26033 response to the DATA command before the data is transmitted. Header lines
26034 added by MAIL or RCPT ACLs are not visible at this time, but any that
26035 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26036
26037 You cannot test the contents of the message, for example, to verify addresses
26038 in the headers, at RCPT time or when the DATA command is received. Such
26039 tests have to appear in the ACL that is run after the message itself has been
26040 received, before the final response to the DATA command is sent. This is
26041 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26042 associated with the DATA command.
26043
26044 For both of these ACLs, it is not possible to reject individual recipients. An
26045 error response rejects the entire message. Unfortunately, it is known that some
26046 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26047 before or after the data) correctly &-- they keep the message on their queues
26048 and try again later, but that is their problem, though it does waste some of
26049 your resources.
26050
26051
26052 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26053 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26054 enabled (which is the default).
26055
26056 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26057 received, and is executed for each DKIM signature found in a message.  If not
26058 otherwise specified, the default action is to accept.
26059
26060 For details on the operation of DKIM, see chapter &<<CHID12>>&.
26061
26062
26063 .section "The SMTP MIME ACL" "SECID194"
26064 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26065 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26066
26067
26068 .section "The QUIT ACL" "SECTQUITACL"
26069 .cindex "QUIT, ACL for"
26070 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26071 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26072 does not in fact control any access. For this reason, the only verbs that are
26073 permitted are &%accept%& and &%warn%&.
26074
26075 This ACL can be used for tasks such as custom logging at the end of an SMTP
26076 session. For example, you can use ACL variables in other ACLs to count
26077 messages, recipients, etc., and log the totals at QUIT time using one or
26078 more &%logwrite%& modifiers on a &%warn%& verb.
26079
26080 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26081 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26082
26083 You do not need to have a final &%accept%&, but if you do, you can use a
26084 &%message%& modifier to specify custom text that is sent as part of the 221
26085 response to QUIT.
26086
26087 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26088 failure (for example, failure to open a log file, or when Exim is bombing out
26089 because it has detected an unrecoverable error), all SMTP commands from the
26090 client are given temporary error responses until QUIT is received or the
26091 connection is closed. In these special cases, the QUIT ACL does not run.
26092
26093
26094 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26095 .vindex &$acl_smtp_notquit$&
26096 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26097 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
26098 trouble, such as being unable to write to its log files, this ACL is not run,
26099 because it might try to do things (such as write to log files) that make the
26100 situation even worse.
26101
26102 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26103 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26104 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26105 and &%warn%&.
26106
26107 .vindex &$smtp_notquit_reason$&
26108 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26109 to a string that indicates the reason for the termination of the SMTP
26110 connection. The possible values are:
26111 .table2
26112 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26113 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26114 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26115 .irow &`connection-lost`&          "The SMTP connection has been lost"
26116 .irow &`data-timeout`&             "Timeout while reading message data"
26117 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26118 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26119 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26120 .irow &`synchronization-error`&    "SMTP synchronization error"
26121 .irow &`tls-failed`&               "TLS failed to start"
26122 .endtable
26123 In most cases when an SMTP connection is closed without having received QUIT,
26124 Exim sends an SMTP response message before actually closing the connection.
26125 With the exception of the &`acl-drop`& case, the default message can be
26126 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26127 &%drop%& verb in another ACL, it is the message from the other ACL that is
26128 used.
26129
26130
26131 .section "Finding an ACL to use" "SECID195"
26132 .cindex "&ACL;" "finding which to use"
26133 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26134 you can use different ACLs in different circumstances. For example,
26135 .code
26136 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26137                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26138 .endd
26139 In the default configuration file there are some example settings for
26140 providing an RFC 4409 message submission service on port 587 and a
26141 non-standard &"smtps"& service on port 465. You can use a string
26142 expansion like this to choose an ACL for MUAs on these ports which is
26143 more appropriate for this purpose than the default ACL on port 25.
26144
26145 The expanded string does not have to be the name of an ACL in the
26146 configuration file; there are other possibilities. Having expanded the
26147 string, Exim searches for an ACL as follows:
26148
26149 .ilist
26150 If the string begins with a slash, Exim uses it as a file name, and reads its
26151 contents as an ACL. The lines are processed in the same way as lines in the
26152 Exim configuration file. In particular, continuation lines are supported, blank
26153 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26154 If the file does not exist or cannot be read, an error occurs (typically
26155 causing a temporary failure of whatever caused the ACL to be run). For example:
26156 .code
26157 acl_smtp_data = /etc/acls/\
26158   ${lookup{$sender_host_address}lsearch\
26159   {/etc/acllist}{$value}{default}}
26160 .endd
26161 This looks up an ACL file to use on the basis of the host's IP address, falling
26162 back to a default if the lookup fails. If an ACL is successfully read from a
26163 file, it is retained in memory for the duration of the Exim process, so that it
26164 can be re-used without having to re-read the file.
26165 .next
26166 If the string does not start with a slash, and does not contain any spaces,
26167 Exim searches the ACL section of the configuration for an ACL whose name
26168 matches the string.
26169 .next
26170 If no named ACL is found, or if the string contains spaces, Exim parses
26171 the string as an inline ACL. This can save typing in cases where you just
26172 want to have something like
26173 .code
26174 acl_smtp_vrfy = accept
26175 .endd
26176 in order to allow free use of the VRFY command. Such a string may contain
26177 newlines; it is processed in the same way as an ACL that is read from a file.
26178 .endlist
26179
26180
26181
26182
26183 .section "ACL return codes" "SECID196"
26184 .cindex "&ACL;" "return codes"
26185 Except for the QUIT ACL, which does not affect the SMTP return code (see
26186 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26187 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26188 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26189 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
26190 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
26191 This also causes a 4&'xx'& return code.
26192
26193 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
26194 &"deny"&, because there is no mechanism for passing temporary errors to the
26195 submitters of non-SMTP messages.
26196
26197
26198 ACLs that are relevant to message reception may also return &"discard"&. This
26199 has the effect of &"accept"&, but causes either the entire message or an
26200 individual recipient address to be discarded. In other words, it is a
26201 blackholing facility. Use it with care.
26202
26203 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
26204 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
26205 RCPT ACL is to discard just the one recipient address. If there are no
26206 recipients left when the message's data is received, the DATA ACL is not
26207 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
26208 remaining recipients. The &"discard"& return is not permitted for the
26209 &%acl_smtp_predata%& ACL.
26210
26211
26212 .cindex "&[local_scan()]& function" "when all recipients discarded"
26213 The &[local_scan()]& function is always run, even if there are no remaining
26214 recipients; it may create new recipients.
26215
26216
26217
26218 .section "Unset ACL options" "SECID197"
26219 .cindex "&ACL;" "unset options"
26220 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
26221 all the same. &*Note*&: These defaults apply only when the relevant ACL is
26222 not defined at all. For any defined ACL, the default action when control
26223 reaches the end of the ACL statements is &"deny"&.
26224
26225 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
26226 these two are ACLs that are used only for their side effects. They cannot be
26227 used to accept or reject anything.
26228
26229 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
26230 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
26231 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
26232 when the ACL is not defined is &"accept"&.
26233
26234 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
26235 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
26236 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
26237 messages over an SMTP connection. For an example, see the ACL in the default
26238 configuration file.
26239
26240
26241
26242
26243 .section "Data for message ACLs" "SECID198"
26244 .cindex "&ACL;" "data for message ACL"
26245 .vindex &$domain$&
26246 .vindex &$local_part$&
26247 .vindex &$sender_address$&
26248 .vindex &$sender_host_address$&
26249 .vindex &$smtp_command$&
26250 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
26251 that contain information about the host and the message's sender (for example,
26252 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
26253 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
26254 &$local_part$& are set from the argument address. The entire SMTP command
26255 is available in &$smtp_command$&.
26256
26257 When an ACL for the AUTH parameter of MAIL is running, the variables that
26258 contain information about the host are set, but &$sender_address$& is not yet
26259 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
26260 how it is used.
26261
26262 .vindex "&$message_size$&"
26263 The &$message_size$& variable is set to the value of the SIZE parameter on
26264 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
26265 that parameter is not given. The value is updated to the true message size by
26266 the time the final DATA ACL is run (after the message data has been
26267 received).
26268
26269 .vindex "&$rcpt_count$&"
26270 .vindex "&$recipients_count$&"
26271 The &$rcpt_count$& variable increases by one for each RCPT command received.
26272 The &$recipients_count$& variable increases by one each time a RCPT command is
26273 accepted, so while an ACL for RCPT is being processed, it contains the number
26274 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26275 &$rcpt_count$& contains the total number of RCPT commands, and
26276 &$recipients_count$& contains the total number of accepted recipients.
26277
26278
26279
26280
26281
26282 .section "Data for non-message ACLs" "SECTdatfornon"
26283 .cindex "&ACL;" "data for non-message ACL"
26284 .vindex &$smtp_command_argument$&
26285 .vindex &$smtp_command$&
26286 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26287 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26288 and the entire SMTP command is available in &$smtp_command$&.
26289 These variables can be tested using a &%condition%& condition. For example,
26290 here is an ACL for use with AUTH, which insists that either the session is
26291 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26292 does not permit authentication methods that use cleartext passwords on
26293 unencrypted connections.
26294 .code
26295 acl_check_auth:
26296   accept encrypted = *
26297   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26298                      {CRAM-MD5}}
26299   deny   message   = TLS encryption or CRAM-MD5 required
26300 .endd
26301 (Another way of applying this restriction is to arrange for the authenticators
26302 that use cleartext passwords not to be advertised when the connection is not
26303 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26304 option to do this.)
26305
26306
26307
26308 .section "Format of an ACL" "SECID199"
26309 .cindex "&ACL;" "format of"
26310 .cindex "&ACL;" "verbs, definition of"
26311 An individual ACL consists of a number of statements. Each statement starts
26312 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26313 Modifiers can change the way the verb operates, define error and log messages,
26314 set variables, insert delays, and vary the processing of accepted messages.
26315
26316 If all the conditions are met, the verb is obeyed. The same condition may be
26317 used (with different arguments) more than once in the same statement. This
26318 provides a means of specifying an &"and"& conjunction between conditions. For
26319 example:
26320 .code
26321 deny  dnslists = list1.example
26322 dnslists = list2.example
26323 .endd
26324 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26325 the conditions and modifiers when it reaches a condition that fails. What
26326 happens then depends on the verb (and in one case, on a special modifier). Not
26327 all the conditions make sense at every testing point. For example, you cannot
26328 test a sender address in the ACL that is run for a VRFY command.
26329
26330
26331 .section "ACL verbs" "SECID200"
26332 The ACL verbs are as follows:
26333
26334 .ilist
26335 .cindex "&%accept%& ACL verb"
26336 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26337 of the conditions are not met, what happens depends on whether &%endpass%&
26338 appears among the conditions (for syntax see below). If the failing condition
26339 is before &%endpass%&, control is passed to the next ACL statement; if it is
26340 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26341 check a RCPT command:
26342 .code
26343 accept domains = +local_domains
26344 endpass
26345 verify = recipient
26346 .endd
26347 If the recipient domain does not match the &%domains%& condition, control
26348 passes to the next statement. If it does match, the recipient is verified, and
26349 the command is accepted if verification succeeds. However, if verification
26350 fails, the ACL yields &"deny"&, because the failing condition is after
26351 &%endpass%&.
26352
26353 The &%endpass%& feature has turned out to be confusing to many people, so its
26354 use is not recommended nowadays. It is always possible to rewrite an ACL so
26355 that &%endpass%& is not needed, and it is no longer used in the default
26356 configuration.
26357
26358 .cindex "&%message%& ACL modifier" "with &%accept%&"
26359 If a &%message%& modifier appears on an &%accept%& statement, its action
26360 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26361 (when an &%accept%& verb either accepts or passes control to the next
26362 statement), &%message%& can be used to vary the message that is sent when an
26363 SMTP command is accepted. For example, in a RCPT ACL you could have:
26364 .display
26365 &`accept  `&<&'some conditions'&>
26366 &`        message = OK, I will allow you through today`&
26367 .endd
26368 You can specify an SMTP response code, optionally followed by an &"extended
26369 response code"& at the start of the message, but the first digit must be the
26370 same as would be sent by default, which is 2 for an &%accept%& verb.
26371
26372 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26373 an error message that is used when access is denied. This behaviour is retained
26374 for backward compatibility, but current &"best practice"& is to avoid the use
26375 of &%endpass%&.
26376
26377
26378 .next
26379 .cindex "&%defer%& ACL verb"
26380 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26381 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26382 &%defer%& is the same as &%deny%&, because there is no way of sending a
26383 temporary error. For a RCPT command, &%defer%& is much the same as using a
26384 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26385 be used in any ACL, and even for a recipient it might be a simpler approach.
26386
26387
26388 .next
26389 .cindex "&%deny%& ACL verb"
26390 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26391 the conditions are not met, control is passed to the next ACL statement. For
26392 example,
26393 .code
26394 deny dnslists = blackholes.mail-abuse.org
26395 .endd
26396 rejects commands from hosts that are on a DNS black list.
26397
26398
26399 .next
26400 .cindex "&%discard%& ACL verb"
26401 &%discard%&: This verb behaves like &%accept%&, except that it returns
26402 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26403 that are concerned with receiving messages. When all the conditions are true,
26404 the sending entity receives a &"success"& response. However, &%discard%& causes
26405 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26406 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26407 message's recipients are discarded. Recipients that are discarded before DATA
26408 do not appear in the log line when the &%received_recipients%& log selector is set.
26409
26410 If the &%log_message%& modifier is set when &%discard%& operates,
26411 its contents are added to the line that is automatically written to the log.
26412 The &%message%& modifier operates exactly as it does for &%accept%&.
26413
26414
26415 .next
26416 .cindex "&%drop%& ACL verb"
26417 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26418 forcibly closed after the 5&'xx'& error message has been sent. For example:
26419 .code
26420 drop   message   = I don't take more than 20 RCPTs
26421        condition = ${if > {$rcpt_count}{20}}
26422 .endd
26423 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26424 The connection is always dropped after sending a 550 response.
26425
26426 .next
26427 .cindex "&%require%& ACL verb"
26428 &%require%&: If all the conditions are met, control is passed to the next ACL
26429 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26430 example, when checking a RCPT command,
26431 .code
26432 require message = Sender did not verify
26433         verify  = sender
26434 .endd
26435 passes control to subsequent statements only if the message's sender can be
26436 verified. Otherwise, it rejects the command. Note the positioning of the
26437 &%message%& modifier, before the &%verify%& condition. The reason for this is
26438 discussed in section &<<SECTcondmodproc>>&.
26439
26440 .next
26441 .cindex "&%warn%& ACL verb"
26442 &%warn%&: If all the conditions are true, a line specified by the
26443 &%log_message%& modifier is written to Exim's main log. Control always passes
26444 to the next ACL statement. If any condition is false, the log line is not
26445 written. If an identical log line is requested several times in the same
26446 message, only one copy is actually written to the log. If you want to force
26447 duplicates to be written, use the &%logwrite%& modifier instead.
26448
26449 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26450 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26451 &%logwrite%&, and &%add_header%&) that appear before the first failing
26452 condition. There is more about adding header lines in section
26453 &<<SECTaddheadacl>>&.
26454
26455 If any condition on a &%warn%& statement cannot be completed (that is, there is
26456 some sort of defer), the log line specified by &%log_message%& is not written.
26457 This does not include the case of a forced failure from a lookup, which
26458 is considered to be a successful completion. After a defer, no further
26459 conditions or modifiers in the &%warn%& statement are processed. The incident
26460 is logged, and the ACL continues to be processed, from the next statement
26461 onwards.
26462
26463
26464 .vindex "&$acl_verify_message$&"
26465 When one of the &%warn%& conditions is an address verification that fails, the
26466 text of the verification failure message is in &$acl_verify_message$&. If you
26467 want this logged, you must set it up explicitly. For example:
26468 .code
26469 warn   !verify = sender
26470        log_message = sender verify failed: $acl_verify_message
26471 .endd
26472 .endlist
26473
26474 At the end of each ACL there is an implicit unconditional &%deny%&.
26475
26476 As you can see from the examples above, the conditions and modifiers are
26477 written one to a line, with the first one on the same line as the verb, and
26478 subsequent ones on following lines. If you have a very long condition, you can
26479 continue it onto several physical lines by the usual backslash continuation
26480 mechanism. It is conventional to align the conditions vertically.
26481
26482
26483
26484 .section "ACL variables" "SECTaclvariables"
26485 .cindex "&ACL;" "variables"
26486 There are some special variables that can be set during ACL processing. They
26487 can be used to pass information between different ACLs, different invocations
26488 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26489 transports, and filters that are used to deliver a message. The names of these
26490 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26491 an underscore, but the remainder of the name can be any sequence of
26492 alphanumeric characters and underscores that you choose. There is no limit on
26493 the number of ACL variables. The two sets act as follows:
26494 .ilist
26495 The values of those variables whose names begin with &$acl_c$& persist
26496 throughout an SMTP connection. They are never reset. Thus, a value that is set
26497 while receiving one message is still available when receiving the next message
26498 on the same SMTP connection.
26499 .next
26500 The values of those variables whose names begin with &$acl_m$& persist only
26501 while a message is being received. They are reset afterwards. They are also
26502 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26503 .endlist
26504
26505 When a message is accepted, the current values of all the ACL variables are
26506 preserved with the message and are subsequently made available at delivery
26507 time. The ACL variables are set by a modifier called &%set%&. For example:
26508 .code
26509 accept hosts = whatever
26510        set acl_m4 = some value
26511 accept authenticated = *
26512        set acl_c_auth = yes
26513 .endd
26514 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26515 be set. If you want to set a variable without taking any action, you can use a
26516 &%warn%& verb without any other modifiers or conditions.
26517
26518 .oindex &%strict_acl_vars%&
26519 What happens if a syntactically valid but undefined ACL variable is
26520 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26521 false (the default), an empty string is substituted; if it is true, an
26522 error is generated.
26523
26524 Versions of Exim before 4.64 have a limited set of numbered variables, but
26525 their names are compatible, so there is no problem with upgrading.
26526
26527
26528 .section "Condition and modifier processing" "SECTcondmodproc"
26529 .cindex "&ACL;" "conditions; processing"
26530 .cindex "&ACL;" "modifiers; processing"
26531 An exclamation mark preceding a condition negates its result. For example:
26532 .code
26533 deny   domains = *.dom.example
26534       !verify  = recipient
26535 .endd
26536 causes the ACL to return &"deny"& if the recipient domain ends in
26537 &'dom.example'& and the recipient address cannot be verified. Sometimes
26538 negation can be used on the right-hand side of a condition. For example, these
26539 two statements are equivalent:
26540 .code
26541 deny  hosts = !192.168.3.4
26542 deny !hosts =  192.168.3.4
26543 .endd
26544 However, for many conditions (&%verify%& being a good example), only left-hand
26545 side negation of the whole condition is possible.
26546
26547 The arguments of conditions and modifiers are expanded. A forced failure
26548 of an expansion causes a condition to be ignored, that is, it behaves as if the
26549 condition is true. Consider these two statements:
26550 .code
26551 accept  senders = ${lookup{$host_name}lsearch\
26552                   {/some/file}{$value}fail}
26553 accept  senders = ${lookup{$host_name}lsearch\
26554                   {/some/file}{$value}{}}
26555 .endd
26556 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26557 the returned list is searched, but if the lookup fails the behaviour is
26558 different in the two cases. The &%fail%& in the first statement causes the
26559 condition to be ignored, leaving no further conditions. The &%accept%& verb
26560 therefore succeeds. The second statement, however, generates an empty list when
26561 the lookup fails. No sender can match an empty list, so the condition fails,
26562 and therefore the &%accept%& also fails.
26563
26564 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26565 specify actions that are taken as the conditions for a statement are checked;
26566 others specify text for messages that are used when access is denied or a
26567 warning is generated. The &%control%& modifier affects the way an incoming
26568 message is handled.
26569
26570 The positioning of the modifiers in an ACL statement important, because the
26571 processing of a verb ceases as soon as its outcome is known. Only those
26572 modifiers that have already been encountered will take effect. For example,
26573 consider this use of the &%message%& modifier:
26574 .code
26575 require message = Can't verify sender
26576         verify  = sender
26577         message = Can't verify recipient
26578         verify  = recipient
26579         message = This message cannot be used
26580 .endd
26581 If sender verification fails, Exim knows that the result of the statement is
26582 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26583 so its text is used as the error message. If sender verification succeeds, but
26584 recipient verification fails, the second message is used. If recipient
26585 verification succeeds, the third message becomes &"current"&, but is never used
26586 because there are no more conditions to cause failure.
26587
26588 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26589 modifier that is used, because all the conditions must be true for rejection to
26590 happen. Specifying more than one &%message%& modifier does not make sense, and
26591 the message can even be specified after all the conditions. For example:
26592 .code
26593 deny   hosts = ...
26594       !senders = *@my.domain.example
26595        message = Invalid sender from client host
26596 .endd
26597 The &"deny"& result does not happen until the end of the statement is reached,
26598 by which time Exim has set up the message.
26599
26600
26601
26602 .section "ACL modifiers" "SECTACLmodi"
26603 .cindex "&ACL;" "modifiers; list of"
26604 The ACL modifiers are as follows:
26605
26606 .vlist
26607 .vitem &*add_header*&&~=&~<&'text'&>
26608 This modifier specifies one or more header lines that are to be added to an
26609 incoming message, assuming, of course, that the message is ultimately
26610 accepted. For details, see section &<<SECTaddheadacl>>&.
26611
26612 .vitem &*continue*&&~=&~<&'text'&>
26613 .cindex "&%continue%& ACL modifier"
26614 .cindex "database" "updating in ACL"
26615 This modifier does nothing of itself, and processing of the ACL always
26616 continues with the next condition or modifier. The value of &%continue%& is in
26617 the side effects of expanding its argument. Typically this could be used to
26618 update a database. It is really just a syntactic tidiness, to avoid having to
26619 write rather ugly lines like this:
26620 .display
26621 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26622 .endd
26623 Instead, all you need is
26624 .display
26625 &`continue = `&<&'some expansion'&>
26626 .endd
26627
26628 .vitem &*control*&&~=&~<&'text'&>
26629 .cindex "&%control%& ACL modifier"
26630 This modifier affects the subsequent processing of the SMTP connection or of an
26631 incoming message that is accepted. The effect of the first type of control
26632 lasts for the duration of the connection, whereas the effect of the second type
26633 lasts only until the current message has been received. The message-specific
26634 controls always apply to the whole message, not to individual recipients,
26635 even if the &%control%& modifier appears in a RCPT ACL.
26636
26637 As there are now quite a few controls that can be applied, they are described
26638 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26639 in several different ways. For example:
26640
26641 . ==== As this is a nested list, any displays it contains must be indented
26642 . ==== as otherwise they are too far to the left. That comment applies only
26643 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26644 . ==== way.
26645
26646 .ilist
26647 It can be at the end of an &%accept%& statement:
26648 .code
26649     accept  ...some conditions
26650             control = queue_only
26651 .endd
26652 In this case, the control is applied when this statement yields &"accept"&, in
26653 other words, when the conditions are all true.
26654
26655 .next
26656 It can be in the middle of an &%accept%& statement:
26657 .code
26658     accept  ...some conditions...
26659             control = queue_only
26660             ...some more conditions...
26661 .endd
26662 If the first set of conditions are true, the control is applied, even if the
26663 statement does not accept because one of the second set of conditions is false.
26664 In this case, some subsequent statement must yield &"accept"& for the control
26665 to be relevant.
26666
26667 .next
26668 It can be used with &%warn%& to apply the control, leaving the
26669 decision about accepting or denying to a subsequent verb. For
26670 example:
26671 .code
26672     warn    ...some conditions...
26673             control = freeze
26674     accept  ...
26675 .endd
26676 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26677 &%logwrite%&, so it does not add anything to the message and does not write a
26678 log entry.
26679
26680 .next
26681 If you want to apply a control unconditionally, you can use it with a
26682 &%require%& verb. For example:
26683 .code
26684     require  control = no_multiline_responses
26685 .endd
26686 .endlist
26687
26688 .vitem &*delay*&&~=&~<&'time'&>
26689 .cindex "&%delay%& ACL modifier"
26690 .oindex "&%-bh%&"
26691 This modifier may appear in any ACL. It causes Exim to wait for the time
26692 interval before proceeding. However, when testing Exim using the &%-bh%&
26693 option, the delay is not actually imposed (an appropriate message is output
26694 instead). The time is given in the usual Exim notation, and the delay happens
26695 as soon as the modifier is processed. In an SMTP session, pending output is
26696 flushed before the delay is imposed.
26697
26698 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26699 example:
26700 .code
26701 deny    ...some conditions...
26702         delay = 30s
26703 .endd
26704 The delay happens if all the conditions are true, before the statement returns
26705 &"deny"&. Compare this with:
26706 .code
26707 deny    delay = 30s
26708         ...some conditions...
26709 .endd
26710 which waits for 30s before processing the conditions. The &%delay%& modifier
26711 can also be used with &%warn%& and together with &%control%&:
26712 .code
26713 warn    ...some conditions...
26714         delay = 2m
26715         control = freeze
26716 accept  ...
26717 .endd
26718
26719 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26720 responses to several commands are no longer buffered and sent in one packet (as
26721 they would normally be) because all output is flushed before imposing the
26722 delay. This optimization is disabled so that a number of small delays do not
26723 appear to the client as one large aggregated delay that might provoke an
26724 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26725 using a &%control%& modifier to set &%no_delay_flush%&.
26726
26727
26728 .vitem &*endpass*&
26729 .cindex "&%endpass%& ACL modifier"
26730 This modifier, which has no argument, is recognized only in &%accept%& and
26731 &%discard%& statements. It marks the boundary between the conditions whose
26732 failure causes control to pass to the next statement, and the conditions whose
26733 failure causes the ACL to return &"deny"&. This concept has proved to be
26734 confusing to some people, so the use of &%endpass%& is no longer recommended as
26735 &"best practice"&. See the description of &%accept%& above for more details.
26736
26737
26738 .vitem &*log_message*&&~=&~<&'text'&>
26739 .cindex "&%log_message%& ACL modifier"
26740 This modifier sets up a message that is used as part of the log message if the
26741 ACL denies access or a &%warn%& statement's conditions are true. For example:
26742 .code
26743 require log_message = wrong cipher suite $tls_in_cipher
26744         encrypted   = DES-CBC3-SHA
26745 .endd
26746 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26747 example:
26748 .display
26749 &`discard `&<&'some conditions'&>
26750 &`        log_message = Discarded $local_part@$domain because...`&
26751 .endd
26752 When access is denied, &%log_message%& adds to any underlying error message
26753 that may exist because of a condition failure. For example, while verifying a
26754 recipient address, a &':fail:'& redirection might have already set up a
26755 message.
26756
26757 The message may be defined before the conditions to which it applies, because
26758 the string expansion does not happen until Exim decides that access is to be
26759 denied. This means that any variables that are set by the condition are
26760 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26761 variables are set after a DNS black list lookup succeeds. If the expansion of
26762 &%log_message%& fails, or if the result is an empty string, the modifier is
26763 ignored.
26764
26765 .vindex "&$acl_verify_message$&"
26766 If you want to use a &%warn%& statement to log the result of an address
26767 verification, you can use &$acl_verify_message$& to include the verification
26768 error message.
26769
26770 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26771 the start of the logged message. If the same warning log message is requested
26772 more than once while receiving  a single email message, only one copy is
26773 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26774 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26775 is logged for a successful &%warn%& statement.
26776
26777 If &%log_message%& is not present and there is no underlying error message (for
26778 example, from the failure of address verification), but &%message%& is present,
26779 the &%message%& text is used for logging rejections. However, if any text for
26780 logging contains newlines, only the first line is logged. In the absence of
26781 both &%log_message%& and &%message%&, a default built-in message is used for
26782 logging rejections.
26783
26784
26785 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26786 .cindex "&%log_reject_target%& ACL modifier"
26787 .cindex "logging in ACL" "specifying which log"
26788 This modifier makes it possible to specify which logs are used for messages
26789 about ACL rejections. Its argument is a colon-separated list of words that can
26790 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26791 may be empty, in which case a rejection is not logged at all. For example, this
26792 ACL fragment writes no logging information when access is denied:
26793 .display
26794 &`deny `&<&'some conditions'&>
26795 &`     log_reject_target =`&
26796 .endd
26797 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26798 permanent and temporary rejections. Its effect lasts for the rest of the
26799 current ACL.
26800
26801
26802 .vitem &*logwrite*&&~=&~<&'text'&>
26803 .cindex "&%logwrite%& ACL modifier"
26804 .cindex "logging in ACL" "immediate"
26805 This modifier writes a message to a log file as soon as it is encountered when
26806 processing an ACL. (Compare &%log_message%&, which, except in the case of
26807 &%warn%& and &%discard%&, is used only if the ACL statement denies
26808 access.) The &%logwrite%& modifier can be used to log special incidents in
26809 ACLs. For example:
26810 .display
26811 &`accept `&<&'some special conditions'&>
26812 &`       control  = freeze`&
26813 &`       logwrite = froze message because ...`&
26814 .endd
26815 By default, the message is written to the main log. However, it may begin
26816 with a colon, followed by a comma-separated list of log names, and then
26817 another colon, to specify exactly which logs are to be written. For
26818 example:
26819 .code
26820 logwrite = :main,reject: text for main and reject logs
26821 logwrite = :panic: text for panic log only
26822 .endd
26823
26824
26825 .vitem &*message*&&~=&~<&'text'&>
26826 .cindex "&%message%& ACL modifier"
26827 This modifier sets up a text string that is expanded and used as a response
26828 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
26829 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
26830 there is some complication if &%endpass%& is involved; see the description of
26831 &%accept%& for details.)
26832
26833 The expansion of the message happens at the time Exim decides that the ACL is
26834 to end, not at the time it processes &%message%&. If the expansion fails, or
26835 generates an empty string, the modifier is ignored. Here is an example where
26836 &%message%& must be specified first, because the ACL ends with a rejection if
26837 the &%hosts%& condition fails:
26838 .code
26839 require  message = Host not recognized
26840          hosts = 10.0.0.0/8
26841 .endd
26842 (Once a condition has failed, no further conditions or modifiers are
26843 processed.)
26844
26845 .cindex "SMTP" "error codes"
26846 .oindex "&%smtp_banner%&
26847 For ACLs that are triggered by SMTP commands, the message is returned as part
26848 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
26849 is meaningful only for SMTP, as no message is returned when a non-SMTP message
26850 is accepted. In the case of the connect ACL, accepting with a message modifier
26851 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
26852 accept message may not contain more than one line (otherwise it will be
26853 truncated at the first newline and a panic logged), and it cannot affect the
26854 EHLO options.
26855
26856 When SMTP is involved, the message may begin with an overriding response code,
26857 consisting of three digits optionally followed by an &"extended response code"&
26858 of the form &'n.n.n'&, each code being followed by a space. For example:
26859 .code
26860 deny  message = 599 1.2.3 Host not welcome
26861       hosts = 192.168.34.0/24
26862 .endd
26863 The first digit of the supplied response code must be the same as would be sent
26864 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
26865 access, but for the predata ACL, note that the default success code is 354, not
26866 2&'xx'&.
26867
26868 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
26869 the message modifier cannot override the 221 response code.
26870
26871 The text in a &%message%& modifier is literal; any quotes are taken as
26872 literals, but because the string is expanded, backslash escapes are processed
26873 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
26874 response.
26875
26876 .vindex "&$acl_verify_message$&"
26877 If &%message%& is used on a statement that verifies an address, the message
26878 specified overrides any message that is generated by the verification process.
26879 However, the original message is available in the variable
26880 &$acl_verify_message$&, so you can incorporate it into your message if you
26881 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
26882 routers to be passed back as part of the SMTP response, you should either not
26883 use a &%message%& modifier, or make use of &$acl_verify_message$&.
26884
26885 For compatibility with previous releases of Exim, a &%message%& modifier that
26886 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
26887 modifier, but this usage is now deprecated. However, &%message%& acts only when
26888 all the conditions are true, wherever it appears in an ACL command, whereas
26889 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
26890 &%warn%& in an ACL that is not concerned with receiving a message, it has no
26891 effect.
26892
26893
26894 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
26895 .cindex "&%set%& ACL modifier"
26896 This modifier puts a value into one of the ACL variables (see section
26897 &<<SECTaclvariables>>&).
26898 .endlist
26899
26900
26901
26902
26903
26904 .section "Use of the control modifier" "SECTcontrols"
26905 .cindex "&%control%& ACL modifier"
26906 The &%control%& modifier supports the following settings:
26907
26908 .vlist
26909 .vitem &*control&~=&~allow_auth_unadvertised*&
26910 This modifier allows a client host to use the SMTP AUTH command even when it
26911 has not been advertised in response to EHLO. Furthermore, because there are
26912 apparently some really broken clients that do this, Exim will accept AUTH after
26913 HELO (rather than EHLO) when this control is set. It should be used only if you
26914 really need it, and you should limit its use to those broken clients that do
26915 not work without it. For example:
26916 .code
26917 warn hosts   = 192.168.34.25
26918      control = allow_auth_unadvertised
26919 .endd
26920 Normally, when an Exim server receives an AUTH command, it checks the name of
26921 the authentication mechanism that is given in the command to ensure that it
26922 matches an advertised mechanism. When this control is set, the check that a
26923 mechanism has been advertised is bypassed. Any configured mechanism can be used
26924 by the client. This control is permitted only in the connection and HELO ACLs.
26925
26926
26927 .vitem &*control&~=&~caseful_local_part*& &&&
26928        &*control&~=&~caselower_local_part*&
26929 .cindex "&ACL;" "case of local part in"
26930 .cindex "case of local parts"
26931 .vindex "&$local_part$&"
26932 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
26933 (that is, during RCPT processing). By default, the contents of &$local_part$&
26934 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
26935 any uppercase letters in the original local part are restored in &$local_part$&
26936 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
26937 is encountered.
26938
26939 These controls affect only the current recipient. Moreover, they apply only to
26940 local part handling that takes place directly in the ACL (for example, as a key
26941 in lookups). If a test to verify the recipient is obeyed, the case-related
26942 handling of the local part during the verification is controlled by the router
26943 configuration (see the &%caseful_local_part%& generic router option).
26944
26945 This facility could be used, for example, to add a spam score to local parts
26946 containing upper case letters. For example, using &$acl_m4$& to accumulate the
26947 spam score:
26948 .code
26949 warn  control = caseful_local_part
26950       set acl_m4 = ${eval:\
26951                      $acl_m4 + \
26952                      ${if match{$local_part}{[A-Z]}{1}{0}}\
26953                     }
26954       control = caselower_local_part
26955 .endd
26956 Notice that we put back the lower cased version afterwards, assuming that
26957 is what is wanted for subsequent tests.
26958
26959
26960 .new
26961 .vitem &*control&~=&~cutthrough_delivery*&
26962 .cindex "&ACL;" "cutthrough routing"
26963 This option requests delivery be attempted while the item is being received.
26964 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
26965 from one SMTP connection to another.  If a recipient-verify callout connection is
26966 requested in the same ACL it is held open and used for the data, otherwise one is made
26967 after the ACL completes.
26968
26969 Should the ultimate destination system positively accept or reject the mail,
26970 a corresponding indication is given to the source system and nothing is queued.
26971 If there is a temporary error the item is queued for later delivery in the
26972 usual fashion. If the item is successfully delivered in cutthrough mode the log line
26973 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
26974 line.
26975
26976 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
26977 sender when the destination system is doing content-scan based rejection.
26978 .wen
26979
26980
26981 .new
26982 .vitem &*control&~=&~dscp/*&<&'value'&>
26983 .cindex "&ACL;" "setting DSCP value"
26984 .cindex "DSCP" "inbound"
26985 This option causes the DSCP value associated with the socket for the inbound
26986 connection to be adjusted to a given value, given as one of a number of fixed
26987 strings or to numeric value.
26988 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
26989 Common values include &`throughput`&, &`mincost`&, and on newer systems
26990 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
26991
26992 The outbound packets from Exim will be marked with this value in the header
26993 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
26994 that these values will have any effect, not be stripped by networking
26995 equipment, or do much of anything without cooperation with your Network
26996 Engineer and those of all network operators between the source and destination.
26997 .wen
26998
26999
27000 .vitem &*control&~=&~debug/*&<&'options'&>
27001 .cindex "&ACL;" "enabling debug logging"
27002 .cindex "debugging" "enabling from an ACL"
27003 This control turns on debug logging, almost as though Exim had been invoked
27004 with &`-d`&, with the output going to a new logfile, by default called
27005 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27006 may access any variables already defined.  The logging may be adjusted with
27007 the &'opts'& option, which takes the same values as the &`-d`& command-line
27008 option.  Some examples (which depend on variables that don't exist in all
27009 contexts):
27010 .code
27011       control = debug
27012       control = debug/tag=.$sender_host_address
27013       control = debug/opts=+expand+acl
27014       control = debug/tag=.$message_exim_id/opts=+expand
27015 .endd
27016
27017
27018 .vitem &*control&~=&~enforce_sync*& &&&
27019        &*control&~=&~no_enforce_sync*&
27020 .cindex "SMTP" "synchronization checking"
27021 .cindex "synchronization checking in SMTP"
27022 These controls make it possible to be selective about when SMTP synchronization
27023 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27024 state of the switch (it is true by default). See the description of this option
27025 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27026
27027 The effect of these two controls lasts for the remainder of the SMTP
27028 connection. They can appear in any ACL except the one for the non-SMTP
27029 messages. The most straightforward place to put them is in the ACL defined by
27030 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27031 before the first synchronization check. The expected use is to turn off the
27032 synchronization checks for badly-behaved hosts that you nevertheless need to
27033 work with.
27034
27035
27036 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27037 .cindex "fake defer"
27038 .cindex "defer, fake"
27039 This control works in exactly the same way as &%fakereject%& (described below)
27040 except that it causes an SMTP 450 response after the message data instead of a
27041 550 response. You must take care when using &%fakedefer%& because it causes the
27042 messages to be duplicated when the sender retries. Therefore, you should not
27043 use &%fakedefer%& if the message is to be delivered normally.
27044
27045 .vitem &*control&~=&~fakereject/*&<&'message'&>
27046 .cindex "fake rejection"
27047 .cindex "rejection, fake"
27048 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27049 words, only when an SMTP message is being received. If Exim accepts the
27050 message, instead the final 250 response, a 550 rejection message is sent.
27051 However, Exim proceeds to deliver the message as normal. The control applies
27052 only to the current message, not to any subsequent ones that may be received in
27053 the same SMTP connection.
27054
27055 The text for the 550 response is taken from the &%control%& modifier. If no
27056 message is supplied, the following is used:
27057 .code
27058 550-Your message has been rejected but is being
27059 550-kept for evaluation.
27060 550-If it was a legitimate message, it may still be
27061 550 delivered to the target recipient(s).
27062 .endd
27063 This facility should be used with extreme caution.
27064
27065 .vitem &*control&~=&~freeze*&
27066 .cindex "frozen messages" "forcing in ACL"
27067 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27068 other words, only when a message is being received. If the message is accepted,
27069 it is placed on Exim's queue and frozen. The control applies only to the
27070 current message, not to any subsequent ones that may be received in the same
27071 SMTP connection.
27072
27073 This modifier can optionally be followed by &`/no_tell`&. If the global option
27074 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27075 is told about the freezing), provided all the &*control=freeze*& modifiers that
27076 are obeyed for the current message have the &`/no_tell`& option.
27077
27078 .vitem &*control&~=&~no_delay_flush*&
27079 .cindex "SMTP" "output flushing, disabling for delay"
27080 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27081 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27082 use. This control, as long as it is encountered before the &%delay%& modifier,
27083 disables such output flushing.
27084
27085 .vitem &*control&~=&~no_callout_flush*&
27086 .cindex "SMTP" "output flushing, disabling for callout"
27087 Exim normally flushes SMTP output before performing a callout in an ACL, to
27088 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27089 use. This control, as long as it is encountered before the &%verify%& condition
27090 that causes the callout, disables such output flushing.
27091
27092 .vitem &*control&~=&~no_mbox_unspool*&
27093 This control is available when Exim is compiled with the content scanning
27094 extension. Content scanning may require a copy of the current message, or parts
27095 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27096 or spam scanner. Normally, such copies are deleted when they are no longer
27097 needed. If this control is set, the copies are not deleted. The control applies
27098 only to the current message, not to any subsequent ones that may be received in
27099 the same SMTP connection. It is provided for debugging purposes and is unlikely
27100 to be useful in production.
27101
27102 .vitem &*control&~=&~no_multiline_responses*&
27103 .cindex "multiline responses, suppressing"
27104 This control is permitted for any ACL except the one for non-SMTP messages.
27105 It seems that there are broken clients in use that cannot handle multiline
27106 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27107
27108 If this control is set, multiline SMTP responses from ACL rejections are
27109 suppressed. One way of doing this would have been to put out these responses as
27110 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27111 (&"use multiline responses for more"& it says &-- ha!), and some of the
27112 responses might get close to that. So this facility, which is after all only a
27113 sop to broken clients, is implemented by doing two very easy things:
27114
27115 .ilist
27116 Extra information that is normally output as part of a rejection caused by
27117 sender verification failure is omitted. Only the final line (typically &"sender
27118 verification failed"&) is sent.
27119 .next
27120 If a &%message%& modifier supplies a multiline response, only the first
27121 line is output.
27122 .endlist
27123
27124 The setting of the switch can, of course, be made conditional on the
27125 calling host. Its effect lasts until the end of the SMTP connection.
27126
27127 .vitem &*control&~=&~no_pipelining*&
27128 .cindex "PIPELINING" "suppressing advertising"
27129 This control turns off the advertising of the PIPELINING extension to SMTP in
27130 the current session. To be useful, it must be obeyed before Exim sends its
27131 response to an EHLO command. Therefore, it should normally appear in an ACL
27132 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27133 &%pipelining_advertise_hosts%&.
27134
27135 .vitem &*control&~=&~queue_only*&
27136 .oindex "&%queue_only%&"
27137 .cindex "queueing incoming messages"
27138 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27139 other words, only when a message is being received. If the message is accepted,
27140 it is placed on Exim's queue and left there for delivery by a subsequent queue
27141 runner. No immediate delivery process is started. In other words, it has the
27142 effect as the &%queue_only%& global option. However, the control applies only
27143 to the current message, not to any subsequent ones that may be received in the
27144 same SMTP connection.
27145
27146 .vitem &*control&~=&~submission/*&<&'options'&>
27147 .cindex "message" "submission"
27148 .cindex "submission mode"
27149 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27150 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
27151 the current message is a submission from a local MUA. In this case, Exim
27152 operates in &"submission mode"&, and applies certain fixups to the message if
27153 necessary. For example, it adds a &'Date:'& header line if one is not present.
27154 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
27155 late (the message has already been created).
27156
27157 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
27158 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
27159 submission mode; the available options for this control are described there.
27160 The control applies only to the current message, not to any subsequent ones
27161 that may be received in the same SMTP connection.
27162
27163 .vitem &*control&~=&~suppress_local_fixups*&
27164 .cindex "submission fixups, suppressing"
27165 This control applies to locally submitted (non TCP/IP) messages, and is the
27166 complement of &`control = submission`&. It disables the fixups that are
27167 normally applied to locally-submitted messages. Specifically:
27168
27169 .ilist
27170 Any &'Sender:'& header line is left alone (in this respect, it is a
27171 dynamic version of &%local_sender_retain%&).
27172 .next
27173 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
27174 .next
27175 There is no check that &'From:'& corresponds to the actual sender.
27176 .endlist ilist
27177
27178 This control may be useful when a remotely-originated message is accepted,
27179 passed to some scanning program, and then re-submitted for delivery. It can be
27180 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27181 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
27182 data is read.
27183
27184 &*Note:*& This control applies only to the current message, not to any others
27185 that are being submitted at the same time using &%-bs%& or &%-bS%&.
27186 .endlist vlist
27187
27188
27189 .section "Summary of message fixup control" "SECTsummesfix"
27190 All four possibilities for message fixups can be specified:
27191
27192 .ilist
27193 Locally submitted, fixups applied: the default.
27194 .next
27195 Locally submitted, no fixups applied: use
27196 &`control = suppress_local_fixups`&.
27197 .next
27198 Remotely submitted, no fixups applied: the default.
27199 .next
27200 Remotely submitted, fixups applied: use &`control = submission`&.
27201 .endlist
27202
27203
27204
27205 .section "Adding header lines in ACLs" "SECTaddheadacl"
27206 .cindex "header lines" "adding in an ACL"
27207 .cindex "header lines" "position of added lines"
27208 .cindex "&%message%& ACL modifier"
27209 The &%add_header%& modifier can be used to add one or more extra header lines
27210 to an incoming message, as in this example:
27211 .code
27212 warn dnslists = sbl.spamhaus.org : \
27213                 dialup.mail-abuse.org
27214      add_header = X-blacklisted-at: $dnslist_domain
27215 .endd
27216 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27217 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27218 receiving a message). The message must ultimately be accepted for
27219 &%add_header%& to have any significant effect. You can use &%add_header%& with
27220 any ACL verb, including &%deny%& (though this is potentially useful only in a
27221 RCPT ACL).
27222
27223 If the data for the &%add_header%& modifier contains one or more newlines that
27224 are not followed by a space or a tab, it is assumed to contain multiple header
27225 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
27226 front of any line that is not a valid header line.
27227
27228 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27229 They are added to the message before processing the DATA and MIME ACLs.
27230 However, if an identical header line is requested more than once, only one copy
27231 is actually added to the message. Further header lines may be accumulated
27232 during the DATA and MIME ACLs, after which they are added to the message, again
27233 with duplicates suppressed. Thus, it is possible to add two identical header
27234 lines to an SMTP message, but only if one is added before DATA and one after.
27235 In the case of non-SMTP messages, new headers are accumulated during the
27236 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
27237 message is rejected after DATA or by the non-SMTP ACL, all added header lines
27238 are included in the entry that is written to the reject log.
27239
27240 .cindex "header lines" "added; visibility of"
27241 Header lines are not visible in string expansions until they are added to the
27242 message. It follows that header lines defined in the MAIL, RCPT, and predata
27243 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
27244 header lines that are added by the DATA or MIME ACLs are not visible in those
27245 ACLs. Because of this restriction, you cannot use header lines as a way of
27246 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
27247 this, you can use ACL variables, as described in section
27248 &<<SECTaclvariables>>&.
27249
27250 The &%add_header%& modifier acts immediately it is encountered during the
27251 processing of an ACL. Notice the difference between these two cases:
27252 .display
27253 &`accept add_header = ADDED: some text`&
27254 &`       `&<&'some condition'&>
27255
27256 &`accept `&<&'some condition'&>
27257 &`       add_header = ADDED: some text`&
27258 .endd
27259 In the first case, the header line is always added, whether or not the
27260 condition is true. In the second case, the header line is added only if the
27261 condition is true. Multiple occurrences of &%add_header%& may occur in the same
27262 ACL statement. All those that are encountered before a condition fails are
27263 honoured.
27264
27265 .cindex "&%warn%& ACL verb"
27266 For compatibility with previous versions of Exim, a &%message%& modifier for a
27267 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
27268 effect only if all the conditions are true, even if it appears before some of
27269 them. Furthermore, only the last occurrence of &%message%& is honoured. This
27270 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
27271 are present on a &%warn%& verb, both are processed according to their
27272 specifications.
27273
27274 By default, new header lines are added to a message at the end of the existing
27275 header lines. However, you can specify that any particular header line should
27276 be added right at the start (before all the &'Received:'& lines), immediately
27277 after the first block of &'Received:'& lines, or immediately before any line
27278 that is not a &'Received:'& or &'Resent-something:'& header.
27279
27280 This is done by specifying &":at_start:"&, &":after_received:"&, or
27281 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
27282 header line, respectively. (Header text cannot start with a colon, as there has
27283 to be a header name first.) For example:
27284 .code
27285 warn add_header = \
27286        :after_received:X-My-Header: something or other...
27287 .endd
27288 If more than one header line is supplied in a single &%add_header%& modifier,
27289 each one is treated independently and can therefore be placed differently. If
27290 you add more than one line at the start, or after the Received: block, they end
27291 up in reverse order.
27292
27293 &*Warning*&: This facility currently applies only to header lines that are
27294 added in an ACL. It does NOT work for header lines that are added in a
27295 system filter or in a router or transport.
27296
27297
27298
27299
27300 .section "ACL conditions" "SECTaclconditions"
27301 .cindex "&ACL;" "conditions; list of"
27302 Some of conditions listed in this section are available only when Exim is
27303 compiled with the content-scanning extension. They are included here briefly
27304 for completeness. More detailed descriptions can be found in the discussion on
27305 content scanning in chapter &<<CHAPexiscan>>&.
27306
27307 Not all conditions are relevant in all circumstances. For example, testing
27308 senders and recipients does not make sense in an ACL that is being run as the
27309 result of the arrival of an ETRN command, and checks on message headers can be
27310 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27311 can use the same condition (with different parameters) more than once in the
27312 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27313 The conditions are as follows:
27314
27315
27316 .vlist
27317 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27318 .cindex "&ACL;" "nested"
27319 .cindex "&ACL;" "indirect"
27320 .cindex "&ACL;" "arguments"
27321 .cindex "&%acl%& ACL condition"
27322 The possible values of the argument are the same as for the
27323 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27324 &"accept"& the condition is true; if it returns &"deny"& the condition is
27325 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27326 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27327 condition false. This means that further processing of the &%warn%& verb
27328 ceases, but processing of the ACL continues.
27329
27330 If the argument is a named ACL, up to nine space-separated optional values
27331 can be appended; they appear in $acl_arg1 to $acl_arg9, and $acl_narg is set
27332 to the count of values.  The name and values are expanded separately.
27333
27334 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27335 the connection is dropped. If it returns &"discard"&, the verb must be
27336 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27337 conditions are tested.
27338
27339 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27340 loops. This condition allows you to use different ACLs in different
27341 circumstances. For example, different ACLs can be used to handle RCPT commands
27342 for different local users or different local domains.
27343
27344 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27345 .cindex "&%authenticated%& ACL condition"
27346 .cindex "authentication" "ACL checking"
27347 .cindex "&ACL;" "testing for authentication"
27348 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27349 the name of the authenticator is tested against the list. To test for
27350 authentication by any authenticator, you can set
27351 .code
27352 authenticated = *
27353 .endd
27354
27355 .vitem &*condition&~=&~*&<&'string'&>
27356 .cindex "&%condition%& ACL condition"
27357 .cindex "customizing" "ACL condition"
27358 .cindex "&ACL;" "customized test"
27359 .cindex "&ACL;" "testing, customized"
27360 This feature allows you to make up custom conditions. If the result of
27361 expanding the string is an empty string, the number zero, or one of the strings
27362 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27363 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27364 any other value, some error is assumed to have occurred, and the ACL returns
27365 &"defer"&. However, if the expansion is forced to fail, the condition is
27366 ignored. The effect is to treat it as true, whether it is positive or
27367 negative.
27368
27369 .vitem &*decode&~=&~*&<&'location'&>
27370 .cindex "&%decode%& ACL condition"
27371 This condition is available only when Exim is compiled with the
27372 content-scanning extension, and it is allowed only in the ACL defined by
27373 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27374 If all goes well, the condition is true. It is false only if there are
27375 problems such as a syntax error or a memory shortage. For more details, see
27376 chapter &<<CHAPexiscan>>&.
27377
27378 .vitem &*demime&~=&~*&<&'extension&~list'&>
27379 .cindex "&%demime%& ACL condition"
27380 This condition is available only when Exim is compiled with the
27381 content-scanning extension. Its use is described in section
27382 &<<SECTdemimecond>>&.
27383
27384 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27385 .cindex "&%dnslists%& ACL condition"
27386 .cindex "DNS list" "in ACL"
27387 .cindex "black list (DNS)"
27388 .cindex "&ACL;" "testing a DNS list"
27389 This condition checks for entries in DNS black lists. These are also known as
27390 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27391 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27392 different variants of this condition to describe briefly here. See sections
27393 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27394
27395 .vitem &*domains&~=&~*&<&'domain&~list'&>
27396 .cindex "&%domains%& ACL condition"
27397 .cindex "domain" "ACL checking"
27398 .cindex "&ACL;" "testing a recipient domain"
27399 .vindex "&$domain_data$&"
27400 This condition is relevant only after a RCPT command. It checks that the domain
27401 of the recipient address is in the domain list. If percent-hack processing is
27402 enabled, it is done before this test is done. If the check succeeds with a
27403 lookup, the result of the lookup is placed in &$domain_data$& until the next
27404 &%domains%& test.
27405
27406 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27407 use &%domains%& in a DATA ACL.
27408
27409
27410 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27411 .cindex "&%encrypted%& ACL condition"
27412 .cindex "encryption" "checking in an ACL"
27413 .cindex "&ACL;" "testing for encryption"
27414 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27415 name of the cipher suite in use is tested against the list. To test for
27416 encryption without testing for any specific cipher suite(s), set
27417 .code
27418 encrypted = *
27419 .endd
27420
27421
27422 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
27423 .cindex "&%hosts%& ACL condition"
27424 .cindex "host" "ACL checking"
27425 .cindex "&ACL;" "testing the client host"
27426 This condition tests that the calling host matches the host list. If you have
27427 name lookups or wildcarded host names and IP addresses in the same host list,
27428 you should normally put the IP addresses first. For example, you could have:
27429 .code
27430 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27431 .endd
27432 The lookup in this example uses the host name for its key. This is implied by
27433 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27434 and it wouldn't matter which way round you had these two items.)
27435
27436 The reason for the problem with host names lies in the left-to-right way that
27437 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27438 but when it reaches an item that requires a host name, it fails if it cannot
27439 find a host name to compare with the pattern. If the above list is given in the
27440 opposite order, the &%accept%& statement fails for a host whose name cannot be
27441 found, even if its IP address is 10.9.8.7.
27442
27443 If you really do want to do the name check first, and still recognize the IP
27444 address even if the name lookup fails, you can rewrite the ACL like this:
27445 .code
27446 accept hosts = dbm;/etc/friendly/hosts
27447 accept hosts = 10.9.8.7
27448 .endd
27449 The default action on failing to find the host name is to assume that the host
27450 is not in the list, so the first &%accept%& statement fails. The second
27451 statement can then check the IP address.
27452
27453 .vindex "&$host_data$&"
27454 If a &%hosts%& condition is satisfied by means of a lookup, the result
27455 of the lookup is made available in the &$host_data$& variable. This
27456 allows you, for example, to set up a statement like this:
27457 .code
27458 deny  hosts = net-lsearch;/some/file
27459 message = $host_data
27460 .endd
27461 which gives a custom error message for each denied host.
27462
27463 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27464 .cindex "&%local_parts%& ACL condition"
27465 .cindex "local part" "ACL checking"
27466 .cindex "&ACL;" "testing a local part"
27467 .vindex "&$local_part_data$&"
27468 This condition is relevant only after a RCPT command. It checks that the local
27469 part of the recipient address is in the list. If percent-hack processing is
27470 enabled, it is done before this test. If the check succeeds with a lookup, the
27471 result of the lookup is placed in &$local_part_data$&, which remains set until
27472 the next &%local_parts%& test.
27473
27474 .vitem &*malware&~=&~*&<&'option'&>
27475 .cindex "&%malware%& ACL condition"
27476 .cindex "&ACL;" "virus scanning"
27477 .cindex "&ACL;" "scanning for viruses"
27478 This condition is available only when Exim is compiled with the
27479 content-scanning extension. It causes the incoming message to be scanned for
27480 viruses. For details, see chapter &<<CHAPexiscan>>&.
27481
27482 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27483 .cindex "&%mime_regex%& ACL condition"
27484 .cindex "&ACL;" "testing by regex matching"
27485 This condition is available only when Exim is compiled with the
27486 content-scanning extension, and it is allowed only in the ACL defined by
27487 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27488 with any of the regular expressions. For details, see chapter
27489 &<<CHAPexiscan>>&.
27490
27491 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27492 .cindex "rate limiting"
27493 This condition can be used to limit the rate at which a user or host submits
27494 messages. Details are given in section &<<SECTratelimiting>>&.
27495
27496 .vitem &*recipients&~=&~*&<&'address&~list'&>
27497 .cindex "&%recipients%& ACL condition"
27498 .cindex "recipient" "ACL checking"
27499 .cindex "&ACL;" "testing a recipient"
27500 This condition is relevant only after a RCPT command. It checks the entire
27501 recipient address against a list of recipients.
27502
27503 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27504 .cindex "&%regex%& ACL condition"
27505 .cindex "&ACL;" "testing by regex matching"
27506 This condition is available only when Exim is compiled with the
27507 content-scanning extension, and is available only in the DATA, MIME, and
27508 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27509 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27510
27511 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27512 .cindex "&%sender_domains%& ACL condition"
27513 .cindex "sender" "ACL checking"
27514 .cindex "&ACL;" "testing a sender domain"
27515 .vindex "&$domain$&"
27516 .vindex "&$sender_address_domain$&"
27517 This condition tests the domain of the sender of the message against the given
27518 domain list. &*Note*&: The domain of the sender address is in
27519 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27520 of this condition. This is an exception to the general rule for testing domain
27521 lists. It is done this way so that, if this condition is used in an ACL for a
27522 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27523 influence the sender checking.
27524
27525 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27526 relaying, because sender addresses are easily, and commonly, forged.
27527
27528 .vitem &*senders&~=&~*&<&'address&~list'&>
27529 .cindex "&%senders%& ACL condition"
27530 .cindex "sender" "ACL checking"
27531 .cindex "&ACL;" "testing a sender"
27532 This condition tests the sender of the message against the given list. To test
27533 for a bounce message, which has an empty sender, set
27534 .code
27535 senders = :
27536 .endd
27537 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27538 relaying, because sender addresses are easily, and commonly, forged.
27539
27540 .vitem &*spam&~=&~*&<&'username'&>
27541 .cindex "&%spam%& ACL condition"
27542 .cindex "&ACL;" "scanning for spam"
27543 This condition is available only when Exim is compiled with the
27544 content-scanning extension. It causes the incoming message to be scanned by
27545 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27546
27547 .vitem &*verify&~=&~certificate*&
27548 .cindex "&%verify%& ACL condition"
27549 .cindex "TLS" "client certificate verification"
27550 .cindex "certificate" "verification of client"
27551 .cindex "&ACL;" "certificate verification"
27552 .cindex "&ACL;" "testing a TLS certificate"
27553 This condition is true in an SMTP session if the session is encrypted, and a
27554 certificate was received from the client, and the certificate was verified. The
27555 server requests a certificate only if the client matches &%tls_verify_hosts%&
27556 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27557
27558 .vitem &*verify&~=&~csa*&
27559 .cindex "CSA verification"
27560 This condition checks whether the sending host (the client) is authorized to
27561 send email. Details of how this works are given in section
27562 &<<SECTverifyCSA>>&.
27563
27564 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27565 .cindex "&%verify%& ACL condition"
27566 .cindex "&ACL;" "verifying sender in the header"
27567 .cindex "header lines" "verifying the sender in"
27568 .cindex "sender" "verifying in header"
27569 .cindex "verifying" "sender in header"
27570 This condition is relevant only in an ACL that is run after a message has been
27571 received, that is, in an ACL specified by &%acl_smtp_data%& or
27572 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27573 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27574 is loosely thought of as a &"sender"& address (hence the name of the test).
27575 However, an address that appears in one of these headers need not be an address
27576 that accepts bounce messages; only sender addresses in envelopes are required
27577 to accept bounces. Therefore, if you use the callout option on this check, you
27578 might want to arrange for a non-empty address in the MAIL command.
27579
27580 Details of address verification and the options are given later, starting at
27581 section &<<SECTaddressverification>>& (callouts are described in section
27582 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27583 condition to restrict it to bounce messages only:
27584 .code
27585 deny    senders = :
27586         message = A valid sender header is required for bounces
27587        !verify  = header_sender
27588 .endd
27589
27590 .vitem &*verify&~=&~header_syntax*&
27591 .cindex "&%verify%& ACL condition"
27592 .cindex "&ACL;" "verifying header syntax"
27593 .cindex "header lines" "verifying syntax"
27594 .cindex "verifying" "header syntax"
27595 This condition is relevant only in an ACL that is run after a message has been
27596 received, that is, in an ACL specified by &%acl_smtp_data%& or
27597 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27598 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27599 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27600 permitted only in locally generated messages and from hosts that match
27601 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27602 appropriate.
27603
27604 Note that this condition is a syntax check only. However, a common spamming
27605 ploy used to be to send syntactically invalid headers such as
27606 .code
27607 To: @
27608 .endd
27609 and this condition can be used to reject such messages, though they are not as
27610 common as they used to be.
27611
27612 .vitem &*verify&~=&~helo*&
27613 .cindex "&%verify%& ACL condition"
27614 .cindex "&ACL;" "verifying HELO/EHLO"
27615 .cindex "HELO" "verifying"
27616 .cindex "EHLO" "verifying"
27617 .cindex "verifying" "EHLO"
27618 .cindex "verifying" "HELO"
27619 This condition is true if a HELO or EHLO command has been received from the
27620 client host, and its contents have been verified. If there has been no previous
27621 attempt to verify the HELO/EHLO contents, it is carried out when this
27622 condition is encountered. See the description of the &%helo_verify_hosts%& and
27623 &%helo_try_verify_hosts%& options for details of how to request verification
27624 independently of this condition.
27625
27626 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27627 option), this condition is always true.
27628
27629
27630 .vitem &*verify&~=&~not_blind*&
27631 .cindex "verifying" "not blind"
27632 .cindex "bcc recipients, verifying none"
27633 This condition checks that there are no blind (bcc) recipients in the message.
27634 Every envelope recipient must appear either in a &'To:'& header line or in a
27635 &'Cc:'& header line for this condition to be true. Local parts are checked
27636 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27637 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27638 used only in a DATA or non-SMTP ACL.
27639
27640 There are, of course, many legitimate messages that make use of blind (bcc)
27641 recipients. This check should not be used on its own for blocking messages.
27642
27643
27644 .vitem &*verify&~=&~recipient/*&<&'options'&>
27645 .cindex "&%verify%& ACL condition"
27646 .cindex "&ACL;" "verifying recipient"
27647 .cindex "recipient" "verifying"
27648 .cindex "verifying" "recipient"
27649 .vindex "&$address_data$&"
27650 This condition is relevant only after a RCPT command. It verifies the current
27651 recipient. Details of address verification are given later, starting at section
27652 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27653 of &$address_data$& is the last value that was set while routing the address.
27654 This applies even if the verification fails. When an address that is being
27655 verified is redirected to a single address, verification continues with the new
27656 address, and in that case, the subsequent value of &$address_data$& is the
27657 value for the child address.
27658
27659 .vitem &*verify&~=&~reverse_host_lookup*&
27660 .cindex "&%verify%& ACL condition"
27661 .cindex "&ACL;" "verifying host reverse lookup"
27662 .cindex "host" "verifying reverse lookup"
27663 This condition ensures that a verified host name has been looked up from the IP
27664 address of the client host. (This may have happened already if the host name
27665 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27666 Verification ensures that the host name obtained from a reverse DNS lookup, or
27667 one of its aliases, does, when it is itself looked up in the DNS, yield the
27668 original IP address.
27669
27670 If this condition is used for a locally generated message (that is, when there
27671 is no client host involved), it always succeeds.
27672
27673 .vitem &*verify&~=&~sender/*&<&'options'&>
27674 .cindex "&%verify%& ACL condition"
27675 .cindex "&ACL;" "verifying sender"
27676 .cindex "sender" "verifying"
27677 .cindex "verifying" "sender"
27678 This condition is relevant only after a MAIL or RCPT command, or after a
27679 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27680 the message's sender is empty (that is, this is a bounce message), the
27681 condition is true. Otherwise, the sender address is verified.
27682
27683 .vindex "&$address_data$&"
27684 .vindex "&$sender_address_data$&"
27685 If there is data in the &$address_data$& variable at the end of routing, its
27686 value is placed in &$sender_address_data$& at the end of verification. This
27687 value can be used in subsequent conditions and modifiers in the same ACL
27688 statement. It does not persist after the end of the current statement. If you
27689 want to preserve the value for longer, you can save it in an ACL variable.
27690
27691 Details of verification are given later, starting at section
27692 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
27693 to avoid doing it more than once per message.
27694
27695 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
27696 .cindex "&%verify%& ACL condition"
27697 This is a variation of the previous option, in which a modified address is
27698 verified as a sender.
27699 .endlist
27700
27701
27702
27703 .section "Using DNS lists" "SECTmorednslists"
27704 .cindex "DNS list" "in ACL"
27705 .cindex "black list (DNS)"
27706 .cindex "&ACL;" "testing a DNS list"
27707 In its simplest form, the &%dnslists%& condition tests whether the calling host
27708 is on at least one of a number of DNS lists by looking up the inverted IP
27709 address in one or more DNS domains. (Note that DNS list domains are not mail
27710 domains, so the &`+`& syntax for named lists doesn't work - it is used for
27711 special options instead.) For example, if the calling host's IP
27712 address is 192.168.62.43, and the ACL statement is
27713 .code
27714 deny dnslists = blackholes.mail-abuse.org : \
27715                 dialups.mail-abuse.org
27716 .endd
27717 the following records are looked up:
27718 .code
27719 43.62.168.192.blackholes.mail-abuse.org
27720 43.62.168.192.dialups.mail-abuse.org
27721 .endd
27722 As soon as Exim finds an existing DNS record, processing of the list stops.
27723 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
27724 to test that a host is on more than one list (an &"and"& conjunction), you can
27725 use two separate conditions:
27726 .code
27727 deny dnslists = blackholes.mail-abuse.org
27728      dnslists = dialups.mail-abuse.org
27729 .endd
27730 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
27731 behaves as if the host does not match the list item, that is, as if the DNS
27732 record does not exist. If there are further items in the DNS list, they are
27733 processed.
27734
27735 This is usually the required action when &%dnslists%& is used with &%deny%&
27736 (which is the most common usage), because it prevents a DNS failure from
27737 blocking mail. However, you can change this behaviour by putting one of the
27738 following special items in the list:
27739 .display
27740 &`+include_unknown `&   behave as if the item is on the list
27741 &`+exclude_unknown `&   behave as if the item is not on the list (default)
27742 &`+defer_unknown   `&   give a temporary error
27743 .endd
27744 .cindex "&`+include_unknown`&"
27745 .cindex "&`+exclude_unknown`&"
27746 .cindex "&`+defer_unknown`&"
27747 Each of these applies to any subsequent items on the list. For example:
27748 .code
27749 deny dnslists = +defer_unknown : foo.bar.example
27750 .endd
27751 Testing the list of domains stops as soon as a match is found. If you want to
27752 warn for one list and block for another, you can use two different statements:
27753 .code
27754 deny  dnslists = blackholes.mail-abuse.org
27755 warn  message  = X-Warn: sending host is on dialups list
27756       dnslists = dialups.mail-abuse.org
27757 .endd
27758 DNS list lookups are cached by Exim for the duration of the SMTP session,
27759 so a lookup based on the IP address is done at most once for any incoming
27760 connection. Exim does not share information between multiple incoming
27761 connections (but your local name server cache should be active).
27762
27763
27764
27765 .section "Specifying the IP address for a DNS list lookup" "SECID201"
27766 .cindex "DNS list" "keyed by explicit IP address"
27767 By default, the IP address that is used in a DNS list lookup is the IP address
27768 of the calling host. However, you can specify another IP address by listing it
27769 after the domain name, introduced by a slash. For example:
27770 .code
27771 deny dnslists = black.list.tld/192.168.1.2
27772 .endd
27773 This feature is not very helpful with explicit IP addresses; it is intended for
27774 use with IP addresses that are looked up, for example, the IP addresses of the
27775 MX hosts or nameservers of an email sender address. For an example, see section
27776 &<<SECTmulkeyfor>>& below.
27777
27778
27779
27780
27781 .section "DNS lists keyed on domain names" "SECID202"
27782 .cindex "DNS list" "keyed by domain name"
27783 There are some lists that are keyed on domain names rather than inverted IP
27784 addresses (see for example the &'domain based zones'& link at
27785 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
27786 with these lists. You can change the name that is looked up in a DNS list by
27787 listing it after the domain name, introduced by a slash. For example,
27788 .code
27789 deny  message  = Sender's domain is listed at $dnslist_domain
27790       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
27791 .endd
27792 This particular example is useful only in ACLs that are obeyed after the
27793 RCPT or DATA commands, when a sender address is available. If (for
27794 example) the message's sender is &'user@tld.example'& the name that is looked
27795 up by this example is
27796 .code
27797 tld.example.dsn.rfc-ignorant.org
27798 .endd
27799 A single &%dnslists%& condition can contain entries for both names and IP
27800 addresses. For example:
27801 .code
27802 deny dnslists = sbl.spamhaus.org : \
27803                 dsn.rfc-ignorant.org/$sender_address_domain
27804 .endd
27805 The first item checks the sending host's IP address; the second checks a domain
27806 name. The whole condition is true if either of the DNS lookups succeeds.
27807
27808
27809
27810
27811 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
27812 .cindex "DNS list" "multiple keys for"
27813 The syntax described above for looking up explicitly-defined values (either
27814 names or IP addresses) in a DNS blacklist is a simplification. After the domain
27815 name for the DNS list, what follows the slash can in fact be a list of items.
27816 As with all lists in Exim, the default separator is a colon. However, because
27817 this is a sublist within the list of DNS blacklist domains, it is necessary
27818 either to double the separators like this:
27819 .code
27820 dnslists = black.list.tld/name.1::name.2
27821 .endd
27822 or to change the separator character, like this:
27823 .code
27824 dnslists = black.list.tld/<;name.1;name.2
27825 .endd
27826 If an item in the list is an IP address, it is inverted before the DNS
27827 blacklist domain is appended. If it is not an IP address, no inversion
27828 occurs. Consider this condition:
27829 .code
27830 dnslists = black.list.tld/<;192.168.1.2;a.domain
27831 .endd
27832 The DNS lookups that occur are:
27833 .code
27834 2.1.168.192.black.list.tld
27835 a.domain.black.list.tld
27836 .endd
27837 Once a DNS record has been found (that matches a specific IP return
27838 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
27839 are done. If there is a temporary DNS error, the rest of the sublist of domains
27840 or IP addresses is tried. A temporary error for the whole dnslists item occurs
27841 only if no other DNS lookup in this sublist succeeds. In other words, a
27842 successful lookup for any of the items in the sublist overrides a temporary
27843 error for a previous item.
27844
27845 The ability to supply a list of items after the slash is in some sense just a
27846 syntactic convenience. These two examples have the same effect:
27847 .code
27848 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
27849 dnslists = black.list.tld/a.domain::b.domain
27850 .endd
27851 However, when the data for the list is obtained from a lookup, the second form
27852 is usually much more convenient. Consider this example:
27853 .code
27854 deny message  = The mail servers for the domain \
27855                 $sender_address_domain \
27856                 are listed at $dnslist_domain ($dnslist_value); \
27857                 see $dnslist_text.
27858      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
27859                                    ${lookup dnsdb {>|mxh=\
27860                                    $sender_address_domain} }} }
27861 .endd
27862 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
27863 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
27864 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
27865 of expanding the condition might be something like this:
27866 .code
27867 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
27868 .endd
27869 Thus, this example checks whether or not the IP addresses of the sender
27870 domain's mail servers are on the Spamhaus black list.
27871
27872 The key that was used for a successful DNS list lookup is put into the variable
27873 &$dnslist_matched$& (see section &<<SECID204>>&).
27874
27875
27876
27877
27878 .section "Data returned by DNS lists" "SECID203"
27879 .cindex "DNS list" "data returned from"
27880 DNS lists are constructed using address records in the DNS. The original RBL
27881 just used the address 127.0.0.1 on the right hand side of each record, but the
27882 RBL+ list and some other lists use a number of values with different meanings.
27883 The values used on the RBL+ list are:
27884 .display
27885 127.1.0.1  RBL
27886 127.1.0.2  DUL
27887 127.1.0.3  DUL and RBL
27888 127.1.0.4  RSS
27889 127.1.0.5  RSS and RBL
27890 127.1.0.6  RSS and DUL
27891 127.1.0.7  RSS and DUL and RBL
27892 .endd
27893 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
27894 different values. Some DNS lists may return more than one address record;
27895 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
27896
27897
27898 .section "Variables set from DNS lists" "SECID204"
27899 .cindex "expansion" "variables, set from DNS list"
27900 .cindex "DNS list" "variables set from"
27901 .vindex "&$dnslist_domain$&"
27902 .vindex "&$dnslist_matched$&"
27903 .vindex "&$dnslist_text$&"
27904 .vindex "&$dnslist_value$&"
27905 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
27906 the name of the overall domain that matched (for example,
27907 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
27908 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
27909 the DNS record. When the key is an IP address, it is not reversed in
27910 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
27911 cases, for example:
27912 .code
27913 deny dnslists = spamhaus.example
27914 .endd
27915 the key is also available in another variable (in this case,
27916 &$sender_host_address$&). In more complicated cases, however, this is not true.
27917 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
27918 might generate a dnslists lookup like this:
27919 .code
27920 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
27921 .endd
27922 If this condition succeeds, the value in &$dnslist_matched$& might be
27923 &`192.168.6.7`& (for example).
27924
27925 If more than one address record is returned by the DNS lookup, all the IP
27926 addresses are included in &$dnslist_value$&, separated by commas and spaces.
27927 The variable &$dnslist_text$& contains the contents of any associated TXT
27928 record. For lists such as RBL+ the TXT record for a merged entry is often not
27929 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
27930 information.
27931
27932 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
27933 &-- although these appear before the condition in the ACL, they are not
27934 expanded until after it has failed. For example:
27935 .code
27936 deny    hosts = !+local_networks
27937         message = $sender_host_address is listed \
27938                   at $dnslist_domain
27939         dnslists = rbl-plus.mail-abuse.example
27940 .endd
27941
27942
27943
27944 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
27945 .cindex "DNS list" "matching specific returned data"
27946 You can add an equals sign and an IP address after a &%dnslists%& domain name
27947 in order to restrict its action to DNS records with a matching right hand side.
27948 For example,
27949 .code
27950 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
27951 .endd
27952 rejects only those hosts that yield 127.0.0.2. Without this additional data,
27953 any address record is considered to be a match. For the moment, we assume
27954 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
27955 describes how multiple records are handled.
27956
27957 More than one IP address may be given for checking, using a comma as a
27958 separator. These are alternatives &-- if any one of them matches, the
27959 &%dnslists%& condition is true. For example:
27960 .code
27961 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27962 .endd
27963 If you want to specify a constraining address list and also specify names or IP
27964 addresses to be looked up, the constraining address list must be specified
27965 first. For example:
27966 .code
27967 deny dnslists = dsn.rfc-ignorant.org\
27968                 =127.0.0.2/$sender_address_domain
27969 .endd
27970
27971 If the character &`&&`& is used instead of &`=`&, the comparison for each
27972 listed IP address is done by a bitwise &"and"& instead of by an equality test.
27973 In other words, the listed addresses are used as bit masks. The comparison is
27974 true if all the bits in the mask are present in the address that is being
27975 tested. For example:
27976 .code
27977 dnslists = a.b.c&0.0.0.3
27978 .endd
27979 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
27980 want to test whether one bit or another bit is present (as opposed to both
27981 being present), you must use multiple values. For example:
27982 .code
27983 dnslists = a.b.c&0.0.0.1,0.0.0.2
27984 .endd
27985 matches if the final component of the address is an odd number or two times
27986 an odd number.
27987
27988
27989
27990 .section "Negated DNS matching conditions" "SECID205"
27991 You can supply a negative list of IP addresses as part of a &%dnslists%&
27992 condition. Whereas
27993 .code
27994 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27995 .endd
27996 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27997 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
27998 .code
27999 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28000 .endd
28001 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28002 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28003 words, the result of the test is inverted if an exclamation mark appears before
28004 the &`=`& (or the &`&&`&) sign.
28005
28006 &*Note*&: This kind of negation is not the same as negation in a domain,
28007 host, or address list (which is why the syntax is different).
28008
28009 If you are using just one list, the negation syntax does not gain you much. The
28010 previous example is precisely equivalent to
28011 .code
28012 deny  dnslists = a.b.c
28013      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28014 .endd
28015 However, if you are using multiple lists, the negation syntax is clearer.
28016 Consider this example:
28017 .code
28018 deny  dnslists = sbl.spamhaus.org : \
28019                  list.dsbl.org : \
28020                  dnsbl.njabl.org!=127.0.0.3 : \
28021                  relays.ordb.org
28022 .endd
28023 Using only positive lists, this would have to be:
28024 .code
28025 deny  dnslists = sbl.spamhaus.org : \
28026                  list.dsbl.org
28027 deny  dnslists = dnsbl.njabl.org
28028      !dnslists = dnsbl.njabl.org=127.0.0.3
28029 deny  dnslists = relays.ordb.org
28030 .endd
28031 which is less clear, and harder to maintain.
28032
28033
28034
28035
28036 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28037 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28038 thereby providing more than one IP address. When an item in a &%dnslists%& list
28039 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28040 the match to specific results from the DNS lookup, there are two ways in which
28041 the checking can be handled. For example, consider the condition:
28042 .code
28043 dnslists = a.b.c=127.0.0.1
28044 .endd
28045 What happens if the DNS lookup for the incoming IP address yields both
28046 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28047 condition true because at least one given value was found, or is it false
28048 because at least one of the found values was not listed? And how does this
28049 affect negated conditions? Both possibilities are provided for with the help of
28050 additional separators &`==`& and &`=&&`&.
28051
28052 .ilist
28053 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
28054 IP addresses matches one of the listed addresses. For the example above, the
28055 condition is true because 127.0.0.1 matches.
28056 .next
28057 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
28058 looked up IP addresses matches one of the listed addresses. If the condition is
28059 changed to:
28060 .code
28061 dnslists = a.b.c==127.0.0.1
28062 .endd
28063 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28064 false because 127.0.0.2 is not listed. You would need to have:
28065 .code
28066 dnslists = a.b.c==127.0.0.1,127.0.0.2
28067 .endd
28068 for the condition to be true.
28069 .endlist
28070
28071 When &`!`& is used to negate IP address matching, it inverts the result, giving
28072 the precise opposite of the behaviour above. Thus:
28073 .ilist
28074 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
28075 addresses matches one of the listed addresses. Consider:
28076 .code
28077 dnslists = a.b.c!&0.0.0.1
28078 .endd
28079 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28080 false because 127.0.0.1 matches.
28081 .next
28082 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
28083 looked up IP address that does not match. Consider:
28084 .code
28085 dnslists = a.b.c!=&0.0.0.1
28086 .endd
28087 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28088 true, because 127.0.0.2 does not match. You would need to have:
28089 .code
28090 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
28091 .endd
28092 for the condition to be false.
28093 .endlist
28094 When the DNS lookup yields only a single IP address, there is no difference
28095 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
28096
28097
28098
28099
28100 .section "Detailed information from merged DNS lists" "SECTmordetinf"
28101 .cindex "DNS list" "information from merged"
28102 When the facility for restricting the matching IP values in a DNS list is used,
28103 the text from the TXT record that is set in &$dnslist_text$& may not reflect
28104 the true reason for rejection. This happens when lists are merged and the IP
28105 address in the A record is used to distinguish them; unfortunately there is
28106 only one TXT record. One way round this is not to use merged lists, but that
28107 can be inefficient because it requires multiple DNS lookups where one would do
28108 in the vast majority of cases when the host of interest is not on any of the
28109 lists.
28110
28111 A less inefficient way of solving this problem is available. If
28112 two domain names, comma-separated, are given, the second is used first to
28113 do an initial check, making use of any IP value restrictions that are set.
28114 If there is a match, the first domain is used, without any IP value
28115 restrictions, to get the TXT record. As a byproduct of this, there is also
28116 a check that the IP being tested is indeed on the first list. The first
28117 domain is the one that is put in &$dnslist_domain$&. For example:
28118 .code
28119 reject message  = \
28120          rejected because $sender_host_address is blacklisted \
28121          at $dnslist_domain\n$dnslist_text
28122        dnslists = \
28123          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
28124          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28125 .endd
28126 For the first blacklist item, this starts by doing a lookup in
28127 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
28128 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
28129 value, and as long as something is found, it looks for the corresponding TXT
28130 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
28131 The second blacklist item is processed similarly.
28132
28133 If you are interested in more than one merged list, the same list must be
28134 given several times, but because the results of the DNS lookups are cached,
28135 the DNS calls themselves are not repeated. For example:
28136 .code
28137 reject dnslists = \
28138          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
28139          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
28140          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
28141          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28142 .endd
28143 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
28144 values matches (or if no record is found), this is the only lookup that is
28145 done. Only if there is a match is one of the more specific lists consulted.
28146
28147
28148
28149 .section "DNS lists and IPv6" "SECTmorednslistslast"
28150 .cindex "IPv6" "DNS black lists"
28151 .cindex "DNS list" "IPv6 usage"
28152 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
28153 nibble by nibble. For example, if the calling host's IP address is
28154 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
28155 .code
28156 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
28157   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
28158 .endd
28159 (split over two lines here to fit on the page). Unfortunately, some of the DNS
28160 lists contain wildcard records, intended for IPv4, that interact badly with
28161 IPv6. For example, the DNS entry
28162 .code
28163 *.3.some.list.example.    A    127.0.0.1
28164 .endd
28165 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
28166 Unfortunately, it also matches the entire 3::/4 IPv6 network.
28167
28168 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
28169 &%condition%& condition, as in this example:
28170 .code
28171 deny   condition = ${if isip4{$sender_host_address}}
28172        dnslists  = some.list.example
28173 .endd
28174
28175 .section "Rate limiting incoming messages" "SECTratelimiting"
28176 .cindex "rate limiting" "client sending"
28177 .cindex "limiting client sending rates"
28178 .oindex "&%smtp_ratelimit_*%&"
28179 The &%ratelimit%& ACL condition can be used to measure and control the rate at
28180 which clients can send email. This is more powerful than the
28181 &%smtp_ratelimit_*%& options, because those options control the rate of
28182 commands in a single SMTP session only, whereas the &%ratelimit%& condition
28183 works across all connections (concurrent and sequential) from the same client
28184 host. The syntax of the &%ratelimit%& condition is:
28185 .display
28186 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
28187 .endd
28188 If the average client sending rate is less than &'m'& messages per time
28189 period &'p'& then the condition is false; otherwise it is true.
28190
28191 As a side-effect, the &%ratelimit%& condition sets the expansion variable
28192 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
28193 configured value of &'m'&, and &$sender_rate_period$& to the configured value
28194 of &'p'&.
28195
28196 The parameter &'p'& is the smoothing time constant, in the form of an Exim
28197 time interval, for example, &`8h`& for eight hours. A larger time constant
28198 means that it takes Exim longer to forget a client's past behaviour. The
28199 parameter &'m'& is the maximum number of messages that a client is permitted to
28200 send in each time interval. It also specifies the number of messages permitted
28201 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
28202 constant, you can allow a client to send more messages in a burst without
28203 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
28204 both small, messages must be sent at an even rate.
28205
28206 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
28207 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
28208 when deploying the &%ratelimit%& ACL condition. The script prints usage
28209 instructions when it is run with no arguments.
28210
28211 The key is used to look up the data for calculating the client's average
28212 sending rate. This data is stored in Exim's spool directory, alongside the
28213 retry and other hints databases. The default key is &$sender_host_address$&,
28214 which means Exim computes the sending rate of each client host IP address.
28215 By changing the key you can change how Exim identifies clients for the purpose
28216 of ratelimiting. For example, to limit the sending rate of each authenticated
28217 user, independent of the computer they are sending from, set the key to
28218 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
28219 example, &$authenticated_id$& is only meaningful if the client has
28220 authenticated (which you can check with the &%authenticated%& ACL condition).
28221
28222 The lookup key does not have to identify clients: If you want to limit the
28223 rate at which a recipient receives messages, you can use the key
28224 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
28225 ACL.
28226
28227 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
28228 specifies what Exim measures the rate of, for example messages or recipients
28229 or bytes. You can adjust the measurement using the &%unique=%& and/or
28230 &%count=%& options. You can also control when Exim updates the recorded rate
28231 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
28232 separated by a slash, like the other parameters. They may appear in any order.
28233
28234 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
28235 any options that alter the meaning of the stored data. The limit &'m'& is not
28236 stored, so you can alter the configured maximum rate and Exim will still
28237 remember clients' past behaviour. If you change the &%per_*%& mode or add or
28238 remove the &%unique=%& option, the lookup key changes so Exim will forget past
28239 behaviour. The lookup key is not affected by changes to the update mode and
28240 the &%count=%& option.
28241
28242
28243 .section "Ratelimit options for what is being measured" "ratoptmea"
28244 .cindex "rate limiting" "per_* options"
28245 The &%per_conn%& option limits the client's connection rate. It is not
28246 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
28247 &%acl_not_smtp_start%& ACLs.
28248
28249 The &%per_mail%& option limits the client's rate of sending messages. This is
28250 the default if none of the &%per_*%& options is specified. It can be used in
28251 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
28252 &%acl_smtp_data%&, or &%acl_not_smtp%&.
28253
28254 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
28255 the same ACLs as the &%per_mail%& option, though it is best to use this option
28256 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
28257 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
28258 in its MAIL command, which may be inaccurate or completely missing. You can
28259 follow the limit &'m'& in the configuration with K, M, or G to specify limits
28260 in kilobytes, megabytes, or gigabytes, respectively.
28261
28262 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
28263 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28264 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
28265 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
28266 ACLs the rate is updated with the total recipient count in one go. Note that
28267 in either case the rate limiting engine will see a message with many
28268 recipients as a large high-speed burst.
28269
28270 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
28271 number of different recipients that the client has sent messages to in the
28272 last time period. That is, if the client repeatedly sends messages to the same
28273 recipient, its measured rate is not increased. This option can only be used in
28274 &%acl_smtp_rcpt%&.
28275
28276 The &%per_cmd%& option causes Exim to recompute the rate every time the
28277 condition is processed. This can be used to limit the rate of any SMTP
28278 command. If it is used in multiple ACLs it can limit the aggregate rate of
28279 multiple different commands.
28280
28281 The &%count=%& option can be used to alter how much Exim adds to the client's
28282 measured rate. For example, the &%per_byte%& option is equivalent to
28283 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
28284 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
28285 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
28286
28287 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
28288
28289
28290 .section "Ratelimit update modes" "ratoptupd"
28291 .cindex "rate limiting" "reading data without updating"
28292 You can specify one of three options with the &%ratelimit%& condition to
28293 control when its database is updated. This section describes the &%readonly%&
28294 mode, and the next section describes the &%strict%& and &%leaky%& modes.
28295
28296 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
28297 previously-computed rate to check against the limit.
28298
28299 For example, you can test the client's sending rate and deny it access (when
28300 it is too fast) in the connect ACL. If the client passes this check then it
28301 can go on to send a message, in which case its recorded rate will be updated
28302 in the MAIL ACL. Subsequent connections from the same client will check this
28303 new rate.
28304 .code
28305 acl_check_connect:
28306  deny ratelimit = 100 / 5m / readonly
28307     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
28308                   (max $sender_rate_limit)
28309 # ...
28310 acl_check_mail:
28311  warn ratelimit = 100 / 5m / strict
28312     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
28313                   (max $sender_rate_limit)
28314 .endd
28315
28316 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28317 processing a message then it may increase the client's measured rate more than
28318 it should. For example, this will happen if you check the &%per_rcpt%& option
28319 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28320 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28321 multiple update problems by using the &%readonly%& option on later ratelimit
28322 checks.
28323
28324 The &%per_*%& options described above do not make sense in some ACLs. If you
28325 use a &%per_*%& option in an ACL where it is not normally permitted then the
28326 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28327 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28328 next section) so you must specify the &%readonly%& option explicitly.
28329
28330
28331 .section "Ratelimit options for handling fast clients" "ratoptfast"
28332 .cindex "rate limiting" "strict and leaky modes"
28333 If a client's average rate is greater than the maximum, the rate limiting
28334 engine can react in two possible ways, depending on the presence of the
28335 &%strict%& or &%leaky%& update modes. This is independent of the other
28336 counter-measures (such as rejecting the message) that may be specified by the
28337 rest of the ACL.
28338
28339 The &%leaky%& (default) option means that the client's recorded rate is not
28340 updated if it is above the limit. The effect of this is that Exim measures the
28341 client's average rate of successfully sent email, which cannot be greater than
28342 the maximum allowed. If the client is over the limit it may suffer some
28343 counter-measures (as specified in the ACL), but it will still be able to send
28344 email at the configured maximum rate, whatever the rate of its attempts. This
28345 is generally the better choice if you have clients that retry automatically.
28346 For example, it does not prevent a sender with an over-aggressive retry rate
28347 from getting any email through.
28348
28349 The &%strict%& option means that the client's recorded rate is always
28350 updated. The effect of this is that Exim measures the client's average rate
28351 of attempts to send email, which can be much higher than the maximum it is
28352 actually allowed. If the client is over the limit it may be subjected to
28353 counter-measures by the ACL. It must slow down and allow sufficient time to
28354 pass that its computed rate falls below the maximum before it can send email
28355 again. The time (the number of smoothing periods) it must wait and not
28356 attempt to send mail can be calculated with this formula:
28357 .code
28358         ln(peakrate/maxrate)
28359 .endd
28360
28361
28362 .section "Limiting the rate of different events" "ratoptuniq"
28363 .cindex "rate limiting" "counting unique events"
28364 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28365 rate of different events. For example, the &%per_addr%& option uses this
28366 mechanism to count the number of different recipients that the client has
28367 sent messages to in the last time period; it is equivalent to
28368 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28369 measure the rate that a client uses different sender addresses with the
28370 options &`per_mail/unique=$sender_address`&.
28371
28372 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28373 has seen for that key. The whole set is thrown away when it is older than the
28374 rate smoothing period &'p'&, so each different event is counted at most once
28375 per period. In the &%leaky%& update mode, an event that causes the client to
28376 go over the limit is not added to the set, in the same way that the client's
28377 recorded rate is not updated in the same situation.
28378
28379 When you combine the &%unique=%& and &%readonly%& options, the specific
28380 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28381 rate.
28382
28383 The &%unique=%& mechanism needs more space in the ratelimit database than the
28384 other &%ratelimit%& options in order to store the event set. The number of
28385 unique values is potentially as large as the rate limit, so the extra space
28386 required increases with larger limits.
28387
28388 The uniqueification is not perfect: there is a small probability that Exim
28389 will think a new event has happened before. If the sender's rate is less than
28390 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28391 the measured rate can go above the limit, in which case Exim may under-count
28392 events by a significant margin. Fortunately, if the rate is high enough (2.7
28393 times the limit) that the false positive rate goes above 9%, then Exim will
28394 throw away the over-full event set before the measured rate falls below the
28395 limit. Therefore the only harm should be that exceptionally high sending rates
28396 are logged incorrectly; any countermeasures you configure will be as effective
28397 as intended.
28398
28399
28400 .section "Using rate limiting" "useratlim"
28401 Exim's other ACL facilities are used to define what counter-measures are taken
28402 when the rate limit is exceeded. This might be anything from logging a warning
28403 (for example, while measuring existing sending rates in order to define
28404 policy), through time delays to slow down fast senders, up to rejecting the
28405 message. For example:
28406 .code
28407 # Log all senders' rates
28408 warn ratelimit = 0 / 1h / strict
28409      log_message = Sender rate $sender_rate / $sender_rate_period
28410
28411 # Slow down fast senders; note the need to truncate $sender_rate
28412 # at the decimal point.
28413 warn ratelimit = 100 / 1h / per_rcpt / strict
28414      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28415                    $sender_rate_limit }s
28416
28417 # Keep authenticated users under control
28418 deny authenticated = *
28419      ratelimit = 100 / 1d / strict / $authenticated_id
28420
28421 # System-wide rate limit
28422 defer message = Sorry, too busy. Try again later.
28423      ratelimit = 10 / 1s / $primary_hostname
28424
28425 # Restrict incoming rate from each host, with a default
28426 # set using a macro and special cases looked up in a table.
28427 defer message = Sender rate exceeds $sender_rate_limit \
28428                messages per $sender_rate_period
28429      ratelimit = ${lookup {$sender_host_address} \
28430                    cdb {DB/ratelimits.cdb} \
28431                    {$value} {RATELIMIT} }
28432 .endd
28433 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28434 especially with the &%per_rcpt%& option, you may suffer from a performance
28435 bottleneck caused by locking on the ratelimit hints database. Apart from
28436 making your ACLs less complicated, you can reduce the problem by using a
28437 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28438 this means that Exim will lose its hints data after a reboot (including retry
28439 hints, the callout cache, and ratelimit data).
28440
28441
28442
28443 .section "Address verification" "SECTaddressverification"
28444 .cindex "verifying address" "options for"
28445 .cindex "policy control" "address verification"
28446 Several of the &%verify%& conditions described in section
28447 &<<SECTaclconditions>>& cause addresses to be verified. Section
28448 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28449 The verification conditions can be followed by options that modify the
28450 verification process. The options are separated from the keyword and from each
28451 other by slashes, and some of them contain parameters. For example:
28452 .code
28453 verify = sender/callout
28454 verify = recipient/defer_ok/callout=10s,defer_ok
28455 .endd
28456 The first stage of address verification, which always happens, is to run the
28457 address through the routers, in &"verify mode"&. Routers can detect the
28458 difference between verification and routing for delivery, and their actions can
28459 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28460 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28461 The available options are as follows:
28462
28463 .ilist
28464 If the &%callout%& option is specified, successful routing to one or more
28465 remote hosts is followed by a &"callout"& to those hosts as an additional
28466 check. Callouts and their sub-options are discussed in the next section.
28467 .next
28468 If there is a defer error while doing verification routing, the ACL
28469 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28470 options, the condition is forced to be true instead. Note that this is a main
28471 verification option as well as a suboption for callouts.
28472 .next
28473 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28474 discusses the reporting of sender address verification failures.
28475 .next
28476 The &%success_on_redirect%& option causes verification always to succeed
28477 immediately after a successful redirection. By default, if a redirection
28478 generates just one address, that address is also verified. See further
28479 discussion in section &<<SECTredirwhilveri>>&.
28480 .endlist
28481
28482 .cindex "verifying address" "differentiating failures"
28483 .vindex "&$recipient_verify_failure$&"
28484 .vindex "&$sender_verify_failure$&"
28485 .vindex "&$acl_verify_message$&"
28486 After an address verification failure, &$acl_verify_message$& contains the
28487 error message that is associated with the failure. It can be preserved by
28488 coding like this:
28489 .code
28490 warn  !verify = sender
28491        set acl_m0 = $acl_verify_message
28492 .endd
28493 If you are writing your own custom rejection message or log message when
28494 denying access, you can use this variable to include information about the
28495 verification failure.
28496
28497 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28498 appropriate) contains one of the following words:
28499
28500 .ilist
28501 &%qualify%&: The address was unqualified (no domain), and the message
28502 was neither local nor came from an exempted host.
28503 .next
28504 &%route%&: Routing failed.
28505 .next
28506 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28507 occurred at or before the MAIL command (that is, on initial
28508 connection, HELO, or MAIL).
28509 .next
28510 &%recipient%&: The RCPT command in a callout was rejected.
28511 .next
28512 &%postmaster%&: The postmaster check in a callout was rejected.
28513 .endlist
28514
28515 The main use of these variables is expected to be to distinguish between
28516 rejections of MAIL and rejections of RCPT in callouts.
28517
28518
28519
28520
28521 .section "Callout verification" "SECTcallver"
28522 .cindex "verifying address" "by callout"
28523 .cindex "callout" "verification"
28524 .cindex "SMTP" "callout verification"
28525 For non-local addresses, routing verifies the domain, but is unable to do any
28526 checking of the local part. There are situations where some means of verifying
28527 the local part is desirable. One way this can be done is to make an SMTP
28528 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28529 a subsequent host for a recipient address, to see if the host accepts the
28530 address. We use the term &'callout'& to cover both cases. Note that for a
28531 sender address, the callback is not to the client host that is trying to
28532 deliver the message, but to one of the hosts that accepts incoming mail for the
28533 sender's domain.
28534
28535 Exim does not do callouts by default. If you want them to happen, you must
28536 request them by setting appropriate options on the &%verify%& condition, as
28537 described below. This facility should be used with care, because it can add a
28538 lot of resource usage to the cost of verifying an address. However, Exim does
28539 cache the results of callouts, which helps to reduce the cost. Details of
28540 caching are in section &<<SECTcallvercache>>&.
28541
28542 Recipient callouts are usually used only between hosts that are controlled by
28543 the same administration. For example, a corporate gateway host could use
28544 callouts to check for valid recipients on an internal mailserver. A successful
28545 callout does not guarantee that a real delivery to the address would succeed;
28546 on the other hand, a failing callout does guarantee that a delivery would fail.
28547
28548 If the &%callout%& option is present on a condition that verifies an address, a
28549 second stage of verification occurs if the address is successfully routed to
28550 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28551 &(manualroute)& router, where the router specifies the hosts. However, if a
28552 router that does not set up hosts routes to an &(smtp)& transport with a
28553 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28554 &%hosts_override%& set, its hosts are always used, whether or not the router
28555 supplies a host list.
28556
28557 The port that is used is taken from the transport, if it is specified and is a
28558 remote transport. (For routers that do verification only, no transport need be
28559 specified.) Otherwise, the default SMTP port is used. If a remote transport
28560 specifies an outgoing interface, this is used; otherwise the interface is not
28561 specified. Likewise, the text that is used for the HELO command is taken from
28562 the transport's &%helo_data%& option; if there is no transport, the value of
28563 &$smtp_active_hostname$& is used.
28564
28565 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28566 test whether a bounce message could be delivered to the sender address. The
28567 following SMTP commands are sent:
28568 .display
28569 &`HELO `&<&'local host name'&>
28570 &`MAIL FROM:<>`&
28571 &`RCPT TO:`&<&'the address to be tested'&>
28572 &`QUIT`&
28573 .endd
28574 LHLO is used instead of HELO if the transport's &%protocol%& option is
28575 set to &"lmtp"&.
28576
28577 A recipient callout check is similar. By default, it also uses an empty address
28578 for the sender. This default is chosen because most hosts do not make use of
28579 the sender address when verifying a recipient. Using the same address means
28580 that a single cache entry can be used for each recipient. Some sites, however,
28581 do make use of the sender address when verifying. These are catered for by the
28582 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28583
28584 If the response to the RCPT command is a 2&'xx'& code, the verification
28585 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28586 Exim tries the next host, if any. If there is a problem with all the remote
28587 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28588 &%callout%& option is given, in which case the condition is forced to succeed.
28589
28590 .cindex "SMTP" "output flushing, disabling for callout"
28591 A callout may take a little time. For this reason, Exim normally flushes SMTP
28592 output before performing a callout in an ACL, to avoid unexpected timeouts in
28593 clients when the SMTP PIPELINING extension is in use. The flushing can be
28594 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28595
28596
28597
28598
28599 .section "Additional parameters for callouts" "CALLaddparcall"
28600 .cindex "callout" "additional parameters for"
28601 The &%callout%& option can be followed by an equals sign and a number of
28602 optional parameters, separated by commas. For example:
28603 .code
28604 verify = recipient/callout=10s,defer_ok
28605 .endd
28606 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28607 separate verify options, is retained for backwards compatibility, but is now
28608 deprecated. The additional parameters for &%callout%& are as follows:
28609
28610
28611 .vlist
28612 .vitem <&'a&~time&~interval'&>
28613 .cindex "callout" "timeout, specifying"
28614 This specifies the timeout that applies for the callout attempt to each host.
28615 For example:
28616 .code
28617 verify = sender/callout=5s
28618 .endd
28619 The default is 30 seconds. The timeout is used for each response from the
28620 remote host. It is also used for the initial connection, unless overridden by
28621 the &%connect%& parameter.
28622
28623
28624 .vitem &*connect&~=&~*&<&'time&~interval'&>
28625 .cindex "callout" "connection timeout, specifying"
28626 This parameter makes it possible to set a different (usually smaller) timeout
28627 for making the SMTP connection. For example:
28628 .code
28629 verify = sender/callout=5s,connect=1s
28630 .endd
28631 If not specified, this timeout defaults to the general timeout value.
28632
28633 .vitem &*defer_ok*&
28634 .cindex "callout" "defer, action on"
28635 When this parameter is present, failure to contact any host, or any other kind
28636 of temporary error, is treated as success by the ACL. However, the cache is not
28637 updated in this circumstance.
28638
28639 .vitem &*fullpostmaster*&
28640 .cindex "callout" "full postmaster check"
28641 This operates like the &%postmaster%& option (see below), but if the check for
28642 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28643 accordance with the specification in RFC 2821. The RFC states that the
28644 unqualified address &'postmaster'& should be accepted.
28645
28646
28647 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28648 .cindex "callout" "sender when verifying header"
28649 When verifying addresses in header lines using the &%header_sender%&
28650 verification option, Exim behaves by default as if the addresses are envelope
28651 sender addresses from a message. Callout verification therefore tests to see
28652 whether a bounce message could be delivered, by using an empty address in the
28653 MAIL command. However, it is arguable that these addresses might never be used
28654 as envelope senders, and could therefore justifiably reject bounce messages
28655 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28656 address to use in the MAIL command. For example:
28657 .code
28658 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28659 .endd
28660 This parameter is available only for the &%header_sender%& verification option.
28661
28662
28663 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28664 .cindex "callout" "overall timeout, specifying"
28665 This parameter sets an overall timeout for performing a callout verification.
28666 For example:
28667 .code
28668 verify = sender/callout=5s,maxwait=30s
28669 .endd
28670 This timeout defaults to four times the callout timeout for individual SMTP
28671 commands. The overall timeout applies when there is more than one host that can
28672 be tried. The timeout is checked before trying the next host. This prevents
28673 very long delays if there are a large number of hosts and all are timing out
28674 (for example, when network connections are timing out).
28675
28676
28677 .vitem &*no_cache*&
28678 .cindex "callout" "cache, suppressing"
28679 .cindex "caching callout, suppressing"
28680 When this parameter is given, the callout cache is neither read nor updated.
28681
28682 .vitem &*postmaster*&
28683 .cindex "callout" "postmaster; checking"
28684 When this parameter is set, a successful callout check is followed by a similar
28685 check for the local part &'postmaster'& at the same domain. If this address is
28686 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28687 the postmaster check is recorded in a cache record; if it is a failure, this is
28688 used to fail subsequent callouts for the domain without a connection being
28689 made, until the cache record expires.
28690
28691 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
28692 The postmaster check uses an empty sender in the MAIL command by default.
28693 You can use this parameter to do a postmaster check using a different address.
28694 For example:
28695 .code
28696 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
28697 .endd
28698 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
28699 one overrides. The &%postmaster%& parameter is equivalent to this example:
28700 .code
28701 require  verify = sender/callout=postmaster_mailfrom=
28702 .endd
28703 &*Warning*&: The caching arrangements for postmaster checking do not take
28704 account of the sender address. It is assumed that either the empty address or
28705 a fixed non-empty address will be used. All that Exim remembers is that the
28706 postmaster check for the domain succeeded or failed.
28707
28708
28709 .vitem &*random*&
28710 .cindex "callout" "&""random""& check"
28711 When this parameter is set, before doing the normal callout check, Exim does a
28712 check for a &"random"& local part at the same domain. The local part is not
28713 really random &-- it is defined by the expansion of the option
28714 &%callout_random_local_part%&, which defaults to
28715 .code
28716 $primary_hostname-$tod_epoch-testing
28717 .endd
28718 The idea here is to try to determine whether the remote host accepts all local
28719 parts without checking. If it does, there is no point in doing callouts for
28720 specific local parts. If the &"random"& check succeeds, the result is saved in
28721 a cache record, and used to force the current and subsequent callout checks to
28722 succeed without a connection being made, until the cache record expires.
28723
28724 .vitem &*use_postmaster*&
28725 .cindex "callout" "sender for recipient check"
28726 This parameter applies to recipient callouts only. For example:
28727 .code
28728 deny  !verify = recipient/callout=use_postmaster
28729 .endd
28730 .vindex "&$qualify_domain$&"
28731 It causes a non-empty postmaster address to be used in the MAIL command when
28732 performing the callout for the recipient, and also for a &"random"& check if
28733 that is configured. The local part of the address is &`postmaster`& and the
28734 domain is the contents of &$qualify_domain$&.
28735
28736 .vitem &*use_sender*&
28737 This option applies to recipient callouts only. For example:
28738 .code
28739 require  verify = recipient/callout=use_sender
28740 .endd
28741 It causes the message's actual sender address to be used in the MAIL
28742 command when performing the callout, instead of an empty address. There is no
28743 need to use this option unless you know that the called hosts make use of the
28744 sender when checking recipients. If used indiscriminately, it reduces the
28745 usefulness of callout caching.
28746 .endlist
28747
28748 If you use any of the parameters that set a non-empty sender for the MAIL
28749 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
28750 &%use_sender%&), you should think about possible loops. Recipient checking is
28751 usually done between two hosts that are under the same management, and the host
28752 that receives the callouts is not normally configured to do callouts itself.
28753 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
28754 these circumstances.
28755
28756 However, if you use a non-empty sender address for a callout to an arbitrary
28757 host, there is the likelihood that the remote host will itself initiate a
28758 callout check back to your host. As it is checking what appears to be a message
28759 sender, it is likely to use an empty address in MAIL, thus avoiding a
28760 callout loop. However, to be on the safe side it would be best to set up your
28761 own ACLs so that they do not do sender verification checks when the recipient
28762 is the address you use for header sender or postmaster callout checking.
28763
28764 Another issue to think about when using non-empty senders for callouts is
28765 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
28766 by the sender/recipient combination; thus, for any given recipient, many more
28767 actual callouts are performed than when an empty sender or postmaster is used.
28768
28769
28770
28771
28772 .section "Callout caching" "SECTcallvercache"
28773 .cindex "hints database" "callout cache"
28774 .cindex "callout" "cache, description of"
28775 .cindex "caching" "callout"
28776 Exim caches the results of callouts in order to reduce the amount of resources
28777 used, unless you specify the &%no_cache%& parameter with the &%callout%&
28778 option. A hints database called &"callout"& is used for the cache. Two
28779 different record types are used: one records the result of a callout check for
28780 a specific address, and the other records information that applies to the
28781 entire domain (for example, that it accepts the local part &'postmaster'&).
28782
28783 When an original callout fails, a detailed SMTP error message is given about
28784 the failure. However, for subsequent failures use the cache data, this message
28785 is not available.
28786
28787 The expiry times for negative and positive address cache records are
28788 independent, and can be set by the global options &%callout_negative_expire%&
28789 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
28790
28791 If a host gives a negative response to an SMTP connection, or rejects any
28792 commands up to and including
28793 .code
28794 MAIL FROM:<>
28795 .endd
28796 (but not including the MAIL command with a non-empty address),
28797 any callout attempt is bound to fail. Exim remembers such failures in a
28798 domain cache record, which it uses to fail callouts for the domain without
28799 making new connections, until the domain record times out. There are two
28800 separate expiry times for domain cache records:
28801 &%callout_domain_negative_expire%& (default 3h) and
28802 &%callout_domain_positive_expire%& (default 7d).
28803
28804 Domain records expire when the negative expiry time is reached if callouts
28805 cannot be made for the domain, or if the postmaster check failed.
28806 Otherwise, they expire when the positive expiry time is reached. This
28807 ensures that, for example, a host that stops accepting &"random"& local parts
28808 will eventually be noticed.
28809
28810 The callout caching mechanism is based on the domain of the address that is
28811 being tested. If the domain routes to several hosts, it is assumed that their
28812 behaviour will be the same.
28813
28814
28815
28816 .section "Sender address verification reporting" "SECTsenaddver"
28817 .cindex "verifying" "suppressing error details"
28818 See section &<<SECTaddressverification>>& for a general discussion of
28819 verification. When sender verification fails in an ACL, the details of the
28820 failure are given as additional output lines before the 550 response to the
28821 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
28822 you might see:
28823 .code
28824 MAIL FROM:<xyz@abc.example>
28825 250 OK
28826 RCPT TO:<pqr@def.example>
28827 550-Verification failed for <xyz@abc.example>
28828 550-Called:   192.168.34.43
28829 550-Sent:     RCPT TO:<xyz@abc.example>
28830 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
28831 550 Sender verification failed
28832 .endd
28833 If more than one RCPT command fails in the same way, the details are given
28834 only for the first of them. However, some administrators do not want to send
28835 out this much information. You can suppress the details by adding
28836 &`/no_details`& to the ACL statement that requests sender verification. For
28837 example:
28838 .code
28839 verify = sender/no_details
28840 .endd
28841
28842 .section "Redirection while verifying" "SECTredirwhilveri"
28843 .cindex "verifying" "redirection while"
28844 .cindex "address redirection" "while verifying"
28845 A dilemma arises when a local address is redirected by aliasing or forwarding
28846 during verification: should the generated addresses themselves be verified,
28847 or should the successful expansion of the original address be enough to verify
28848 it? By default, Exim takes the following pragmatic approach:
28849
28850 .ilist
28851 When an incoming address is redirected to just one child address, verification
28852 continues with the child address, and if that fails to verify, the original
28853 verification also fails.
28854 .next
28855 When an incoming address is redirected to more than one child address,
28856 verification does not continue. A success result is returned.
28857 .endlist
28858
28859 This seems the most reasonable behaviour for the common use of aliasing as a
28860 way of redirecting different local parts to the same mailbox. It means, for
28861 example, that a pair of alias entries of the form
28862 .code
28863 A.Wol:   aw123
28864 aw123:   :fail: Gone away, no forwarding address
28865 .endd
28866 work as expected, with both local parts causing verification failure. When a
28867 redirection generates more than one address, the behaviour is more like a
28868 mailing list, where the existence of the alias itself is sufficient for
28869 verification to succeed.
28870
28871 It is possible, however, to change the default behaviour so that all successful
28872 redirections count as successful verifications, however many new addresses are
28873 generated. This is specified by the &%success_on_redirect%& verification
28874 option. For example:
28875 .code
28876 require verify = recipient/success_on_redirect/callout=10s
28877 .endd
28878 In this example, verification succeeds if a router generates a new address, and
28879 the callout does not occur, because no address was routed to a remote host.
28880
28881 When verification is being tested via the &%-bv%& option, the treatment of
28882 redirections is as just described, unless the &%-v%& or any debugging option is
28883 also specified. In that case, full verification is done for every generated
28884 address and a report is output for each of them.
28885
28886
28887
28888 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
28889 .cindex "CSA" "verifying"
28890 Client SMTP Authorization is a system that allows a site to advertise
28891 which machines are and are not permitted to send email. This is done by placing
28892 special SRV records in the DNS; these are looked up using the client's HELO
28893 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
28894 Authorization checks in Exim are performed by the ACL condition:
28895 .code
28896 verify = csa
28897 .endd
28898 This fails if the client is not authorized. If there is a DNS problem, or if no
28899 valid CSA SRV record is found, or if the client is authorized, the condition
28900 succeeds. These three cases can be distinguished using the expansion variable
28901 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
28902 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
28903 be likely to cause problems for legitimate email.
28904
28905 The error messages produced by the CSA code include slightly more
28906 detail. If &$csa_status$& is &"defer"&, this may be because of problems
28907 looking up the CSA SRV record, or problems looking up the CSA target
28908 address record. There are four reasons for &$csa_status$& being &"fail"&:
28909
28910 .ilist
28911 The client's host name is explicitly not authorized.
28912 .next
28913 The client's IP address does not match any of the CSA target IP addresses.
28914 .next
28915 The client's host name is authorized but it has no valid target IP addresses
28916 (for example, the target's addresses are IPv6 and the client is using IPv4).
28917 .next
28918 The client's host name has no CSA SRV record but a parent domain has asserted
28919 that all subdomains must be explicitly authorized.
28920 .endlist
28921
28922 The &%csa%& verification condition can take an argument which is the domain to
28923 use for the DNS query. The default is:
28924 .code
28925 verify = csa/$sender_helo_name
28926 .endd
28927 This implementation includes an extension to CSA. If the query domain
28928 is an address literal such as [192.0.2.95], or if it is a bare IP
28929 address, Exim searches for CSA SRV records in the reverse DNS as if
28930 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
28931 meaningful to say:
28932 .code
28933 verify = csa/$sender_host_address
28934 .endd
28935 In fact, this is the check that Exim performs if the client does not say HELO.
28936 This extension can be turned off by setting the main configuration option
28937 &%dns_csa_use_reverse%& to be false.
28938
28939 If a CSA SRV record is not found for the domain itself, a search
28940 is performed through its parent domains for a record which might be
28941 making assertions about subdomains. The maximum depth of this search is limited
28942 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
28943 default. Exim does not look for CSA SRV records in a top level domain, so the
28944 default settings handle HELO domains as long as seven
28945 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
28946 of legitimate HELO domains.
28947
28948 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
28949 direct SRV lookups, this is not sufficient because of the extra parent domain
28950 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
28951 addresses into lookups in the reverse DNS space. The result of a successful
28952 lookup such as:
28953 .code
28954 ${lookup dnsdb {csa=$sender_helo_name}}
28955 .endd
28956 has two space-separated fields: an authorization code and a target host name.
28957 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
28958 authorization required but absent, or &"?"& for unknown.
28959
28960
28961
28962
28963 .section "Bounce address tag validation" "SECTverifyPRVS"
28964 .cindex "BATV, verifying"
28965 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
28966 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
28967 Genuine incoming bounce messages should therefore always be addressed to
28968 recipients that have a valid tag. This scheme is a way of detecting unwanted
28969 bounce messages caused by sender address forgeries (often called &"collateral
28970 spam"&), because the recipients of such messages do not include valid tags.
28971
28972 There are two expansion items to help with the implementation of the BATV
28973 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
28974 the original envelope sender address by using a simple key to add a hash of the
28975 address and some time-based randomizing information. The &%prvs%& expansion
28976 item creates a signed address, and the &%prvscheck%& expansion item checks one.
28977 The syntax of these expansion items is described in section
28978 &<<SECTexpansionitems>>&.
28979
28980 As an example, suppose the secret per-address keys are stored in an MySQL
28981 database. A query to look up the key for an address could be defined as a macro
28982 like this:
28983 .code
28984 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
28985                 WHERE sender='${quote_mysql:$prvscheck_address}'\
28986                 }{$value}}
28987 .endd
28988 Suppose also that the senders who make use of BATV are defined by an address
28989 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
28990 use this:
28991 .code
28992 # Bounces: drop unsigned addresses for BATV senders
28993 deny message = This address does not send an unsigned reverse path
28994      senders = :
28995      recipients = +batv_senders
28996
28997 # Bounces: In case of prvs-signed address, check signature.
28998 deny message = Invalid reverse path signature.
28999      senders = :
29000      condition  = ${prvscheck {$local_part@$domain}\
29001                   {PRVSCHECK_SQL}{1}}
29002      !condition = $prvscheck_result
29003 .endd
29004 The first statement rejects recipients for bounce messages that are addressed
29005 to plain BATV sender addresses, because it is known that BATV senders do not
29006 send out messages with plain sender addresses. The second statement rejects
29007 recipients that are prvs-signed, but with invalid signatures (either because
29008 the key is wrong, or the signature has timed out).
29009
29010 A non-prvs-signed address is not rejected by the second statement, because the
29011 &%prvscheck%& expansion yields an empty string if its first argument is not a
29012 prvs-signed address, thus causing the &%condition%& condition to be false. If
29013 the first argument is a syntactically valid prvs-signed address, the yield is
29014 the third string (in this case &"1"&), whether or not the cryptographic and
29015 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29016 of the checks (empty for failure, &"1"& for success).
29017
29018 There is one more issue you must consider when implementing prvs-signing:
29019 you have to ensure that the routers accept prvs-signed addresses and
29020 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29021 router to remove the signature with a configuration along these lines:
29022 .code
29023 batv_redirect:
29024   driver = redirect
29025   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29026 .endd
29027 This works because, if the third argument of &%prvscheck%& is empty, the result
29028 of the expansion of a prvs-signed address is the decoded value of the original
29029 address. This router should probably be the first of your routers that handles
29030 local addresses.
29031
29032 To create BATV-signed addresses in the first place, a transport of this form
29033 can be used:
29034 .code
29035 external_smtp_batv:
29036   driver = smtp
29037   return_path = ${prvs {$return_path} \
29038                        {${lookup mysql{SELECT \
29039                        secret FROM batv_prvs WHERE \
29040                        sender='${quote_mysql:$sender_address}'} \
29041                        {$value}fail}}}
29042 .endd
29043 If no key can be found for the existing return path, no signing takes place.
29044
29045
29046
29047 .section "Using an ACL to control relaying" "SECTrelaycontrol"
29048 .cindex "&ACL;" "relay control"
29049 .cindex "relaying" "control by ACL"
29050 .cindex "policy control" "relay control"
29051 An MTA is said to &'relay'& a message if it receives it from some host and
29052 delivers it directly to another host as a result of a remote address contained
29053 within it. Redirecting a local address via an alias or forward file and then
29054 passing the message on to another host is not relaying,
29055 .cindex "&""percent hack""&"
29056 but a redirection as a result of the &"percent hack"& is.
29057
29058 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
29059 A host which is acting as a gateway or an MX backup is concerned with incoming
29060 relaying from arbitrary hosts to a specific set of domains. On the other hand,
29061 a host which is acting as a smart host for a number of clients is concerned
29062 with outgoing relaying from those clients to the Internet at large. Often the
29063 same host is fulfilling both functions,
29064 . ///
29065 . as illustrated in the diagram below,
29066 . ///
29067 but in principle these two kinds of relaying are entirely independent. What is
29068 not wanted is the transmission of mail from arbitrary remote hosts through your
29069 system to arbitrary domains.
29070
29071
29072 You can implement relay control by means of suitable statements in the ACL that
29073 runs for each RCPT command. For convenience, it is often easiest to use
29074 Exim's named list facility to define the domains and hosts involved. For
29075 example, suppose you want to do the following:
29076
29077 .ilist
29078 Deliver a number of domains to mailboxes on the local host (or process them
29079 locally in some other way). Let's say these are &'my.dom1.example'& and
29080 &'my.dom2.example'&.
29081 .next
29082 Relay mail for a number of other domains for which you are the secondary MX.
29083 These might be &'friend1.example'& and &'friend2.example'&.
29084 .next
29085 Relay mail from the hosts on your local LAN, to whatever domains are involved.
29086 Suppose your LAN is 192.168.45.0/24.
29087 .endlist
29088
29089
29090 In the main part of the configuration, you put the following definitions:
29091 .code
29092 domainlist local_domains    = my.dom1.example : my.dom2.example
29093 domainlist relay_to_domains = friend1.example : friend2.example
29094 hostlist   relay_from_hosts = 192.168.45.0/24
29095 .endd
29096 Now you can use these definitions in the ACL that is run for every RCPT
29097 command:
29098 .code
29099 acl_check_rcpt:
29100   accept domains = +local_domains : +relay_to_domains
29101   accept hosts   = +relay_from_hosts
29102 .endd
29103 The first statement accepts any RCPT command that contains an address in
29104 the local or relay domains. For any other domain, control passes to the second
29105 statement, which accepts the command only if it comes from one of the relay
29106 hosts. In practice, you will probably want to make your ACL more sophisticated
29107 than this, for example, by including sender and recipient verification. The
29108 default configuration includes a more comprehensive example, which is described
29109 in chapter &<<CHAPdefconfil>>&.
29110
29111
29112
29113 .section "Checking a relay configuration" "SECTcheralcon"
29114 .cindex "relaying" "checking control of"
29115 You can check the relay characteristics of your configuration in the same way
29116 that you can test any ACL behaviour for an incoming SMTP connection, by using
29117 the &%-bh%& option to run a fake SMTP session with which you interact.
29118
29119 For specifically testing for unwanted relaying, the host
29120 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
29121 host from the host on which Exim is running, using the normal telnet port, you
29122 will see a normal telnet connection message and then quite a long delay. Be
29123 patient. The remote host is making an SMTP connection back to your host, and
29124 trying a number of common probes to test for open relay vulnerability. The
29125 results of the tests will eventually appear on your terminal.
29126 .ecindex IIDacl
29127
29128
29129
29130 . ////////////////////////////////////////////////////////////////////////////
29131 . ////////////////////////////////////////////////////////////////////////////
29132
29133 .chapter "Content scanning at ACL time" "CHAPexiscan"
29134 .scindex IIDcosca "content scanning" "at ACL time"
29135 The extension of Exim to include content scanning at ACL time, formerly known
29136 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
29137 was integrated into the main source for Exim release 4.50, and Tom continues to
29138 maintain it. Most of the wording of this chapter is taken from Tom's
29139 specification.
29140
29141 It is also possible to scan the content of messages at other times. The
29142 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
29143 scanning after all the ACLs have run. A transport filter can be used to scan
29144 messages at delivery time (see the &%transport_filter%& option, described in
29145 chapter &<<CHAPtransportgeneric>>&).
29146
29147 If you want to include the ACL-time content-scanning features when you compile
29148 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
29149 &_Local/Makefile_&. When you do that, the Exim binary is built with:
29150
29151 .ilist
29152 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
29153 for all MIME parts for SMTP and non-SMTP messages, respectively.
29154 .next
29155 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
29156 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
29157 run at the end of message reception (the &%acl_smtp_data%& ACL).
29158 .next
29159 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
29160 of messages, or parts of messages, for debugging purposes.
29161 .next
29162 Additional expansion variables that are set in the new ACL and by the new
29163 conditions.
29164 .next
29165 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
29166 .endlist
29167
29168 There is another content-scanning configuration option for &_Local/Makefile_&,
29169 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
29170 condition is compiled, in addition to all the other content-scanning features.
29171
29172 Content-scanning is continually evolving, and new features are still being
29173 added. While such features are still unstable and liable to incompatible
29174 changes, they are made available in Exim by setting options whose names begin
29175 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
29176 this manual. You can find out about them by reading the file called
29177 &_doc/experimental.txt_&.
29178
29179 All the content-scanning facilities work on a MBOX copy of the message that is
29180 temporarily created in a file called:
29181 .display
29182 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
29183 .endd
29184 The &_.eml_& extension is a friendly hint to virus scanners that they can
29185 expect an MBOX-like structure inside that file. The file is created when the
29186 first content scanning facility is called. Subsequent calls to content
29187 scanning conditions open the same file again. The directory is recursively
29188 removed when the &%acl_smtp_data%& ACL has finished running, unless
29189 .code
29190 control = no_mbox_unspool
29191 .endd
29192 has been encountered. When the MIME ACL decodes files, they are put into the
29193 same directory by default.
29194
29195
29196
29197 .section "Scanning for viruses" "SECTscanvirus"
29198 .cindex "virus scanning"
29199 .cindex "content scanning" "for viruses"
29200 .cindex "content scanning" "the &%malware%& condition"
29201 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
29202 It supports a &"generic"& interface to scanners called via the shell, and
29203 specialized interfaces for &"daemon"& type virus scanners, which are resident
29204 in memory and thus are much faster.
29205
29206
29207 .oindex "&%av_scanner%&"
29208 You can set the &%av_scanner%& option in first part of the Exim configuration
29209 file to specify which scanner to use, together with any additional options that
29210 are needed. The basic syntax is as follows:
29211 .display
29212 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
29213 .endd
29214 If you do not set &%av_scanner%&, it defaults to
29215 .code
29216 av_scanner = sophie:/var/run/sophie
29217 .endd
29218 If the value of &%av_scanner%& starts with a dollar character, it is expanded
29219 before use. The following scanner types are supported in this release:
29220
29221 .vlist
29222 .vitem &%aveserver%&
29223 .cindex "virus scanners" "Kaspersky"
29224 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
29225 at &url(http://www.kaspersky.com). This scanner type takes one option,
29226 which is the path to the daemon's UNIX socket. The default is shown in this
29227 example:
29228 .code
29229 av_scanner = aveserver:/var/run/aveserver
29230 .endd
29231
29232
29233 .vitem &%clamd%&
29234 .cindex "virus scanners" "clamd"
29235 This daemon-type scanner is GPL and free. You can get it at
29236 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
29237 unpack MIME containers, so it used to be recommended to unpack MIME attachments
29238 in the MIME ACL. This no longer believed to be necessary. One option is
29239 required: either the path and name of a UNIX socket file, or a hostname or IP
29240 number, and a port, separated by space, as in the second of these examples:
29241 .code
29242 av_scanner = clamd:/opt/clamd/socket
29243 av_scanner = clamd:192.0.2.3 1234
29244 av_scanner = clamd:192.0.2.3 1234:local
29245 .endd
29246 If the value of av_scanner points to a UNIX socket file or contains the local
29247 keyword, then the ClamAV interface will pass a filename containing the data
29248 to be scanned, which will should normally result in less I/O happening and be
29249 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
29250 Exim does not assume that there is a common filesystem with the remote host.
29251 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
29252 you be running a version of ClamAV prior to 0.95.
29253 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
29254 contributing the code for this scanner.
29255
29256 .vitem &%cmdline%&
29257 .cindex "virus scanners" "command line interface"
29258 This is the keyword for the generic command line scanner interface. It can be
29259 used to attach virus scanners that are invoked from the shell. This scanner
29260 type takes 3 mandatory options:
29261
29262 .olist
29263 The full path and name of the scanner binary, with all command line options,
29264 and a placeholder (&`%s`&) for the directory to scan.
29265
29266 .next
29267 A regular expression to match against the STDOUT and STDERR output of the
29268 virus scanner. If the expression matches, a virus was found. You must make
29269 absolutely sure that this expression matches on &"virus found"&. This is called
29270 the &"trigger"& expression.
29271
29272 .next
29273 Another regular expression, containing exactly one pair of parentheses, to
29274 match the name of the virus found in the scanners output. This is called the
29275 &"name"& expression.
29276 .endlist olist
29277
29278 For example, Sophos Sweep reports a virus on a line like this:
29279 .code
29280 Virus 'W32/Magistr-B' found in file ./those.bat
29281 .endd
29282 For the trigger expression, we can match the phrase &"found in file"&. For the
29283 name expression, we want to extract the W32/Magistr-B string, so we can match
29284 for the single quotes left and right of it. Altogether, this makes the
29285 configuration setting:
29286 .code
29287 av_scanner = cmdline:\
29288              /path/to/sweep -ss -all -rec -archive %s:\
29289              found in file:'(.+)'
29290 .endd
29291 .vitem &%drweb%&
29292 .cindex "virus scanners" "DrWeb"
29293 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
29294 argument, either a full path to a UNIX socket, or an IP address and port
29295 separated by white space, as in these examples:
29296 .code
29297 av_scanner = drweb:/var/run/drwebd.sock
29298 av_scanner = drweb:192.168.2.20 31337
29299 .endd
29300 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
29301 is used. Thanks to Alex Miller for contributing the code for this scanner.
29302
29303 .vitem &%fsecure%&
29304 .cindex "virus scanners" "F-Secure"
29305 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
29306 argument which is the path to a UNIX socket. For example:
29307 .code
29308 av_scanner = fsecure:/path/to/.fsav
29309 .endd
29310 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
29311 Thelmen for contributing the code for this scanner.
29312
29313 .vitem &%kavdaemon%&
29314 .cindex "virus scanners" "Kaspersky"
29315 This is the scanner daemon of Kaspersky Version 4. This version of the
29316 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29317 scanner type takes one option, which is the path to the daemon's UNIX socket.
29318 For example:
29319 .code
29320 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29321 .endd
29322 The default path is &_/var/run/AvpCtl_&.
29323
29324 .vitem &%mksd%&
29325 .cindex "virus scanners" "mksd"
29326 This is a daemon type scanner that is aimed mainly at Polish users, though some
29327 parts of documentation are now available in English. You can get it at
29328 &url(http://linux.mks.com.pl/). The only option for this scanner type is
29329 the maximum number of processes used simultaneously to scan the attachments,
29330 provided that the demime facility is employed and also provided that mksd has
29331 been run with at least the same number of child processes. For example:
29332 .code
29333 av_scanner = mksd:2
29334 .endd
29335 You can safely omit this option (the default value is 1).
29336
29337 .vitem &%sophie%&
29338 .cindex "virus scanners" "Sophos and Sophie"
29339 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
29340 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
29341 for this scanner type is the path to the UNIX socket that Sophie uses for
29342 client communication. For example:
29343 .code
29344 av_scanner = sophie:/tmp/sophie
29345 .endd
29346 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
29347 the option.
29348 .endlist
29349
29350 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29351 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29352 ACL.
29353
29354 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29355 makes it possible to use different scanners. See further below for an example.
29356 The &%malware%& condition caches its results, so when you use it multiple times
29357 for the same message, the actual scanning process is only carried out once.
29358 However, using expandable items in &%av_scanner%& disables this caching, in
29359 which case each use of the &%malware%& condition causes a new scan of the
29360 message.
29361
29362 The &%malware%& condition takes a right-hand argument that is expanded before
29363 use. It can then be one of
29364
29365 .ilist
29366 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29367 The condition succeeds if a virus was found, and fail otherwise. This is the
29368 recommended usage.
29369 .next
29370 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29371 the condition fails immediately.
29372 .next
29373 A regular expression, in which case the message is scanned for viruses. The
29374 condition succeeds if a virus is found and its name matches the regular
29375 expression. This allows you to take special actions on certain types of virus.
29376 .endlist
29377
29378 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29379 even if there is a problem with the virus scanner. Otherwise, such a problem
29380 causes the ACL to defer.
29381
29382 .vindex "&$malware_name$&"
29383 When a virus is found, the condition sets up an expansion variable called
29384 &$malware_name$& that contains the name of the virus. You can use it in a
29385 &%message%& modifier that specifies the error returned to the sender, and/or in
29386 logging data.
29387
29388 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29389 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29390 &%malware%& condition.
29391
29392 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29393 imposed by your anti-virus scanner.
29394
29395 Here is a very simple scanning example:
29396 .code
29397 deny message = This message contains malware ($malware_name)
29398      demime = *
29399      malware = *
29400 .endd
29401 The next example accepts messages when there is a problem with the scanner:
29402 .code
29403 deny message = This message contains malware ($malware_name)
29404      demime = *
29405      malware = */defer_ok
29406 .endd
29407 The next example shows how to use an ACL variable to scan with both sophie and
29408 aveserver. It assumes you have set:
29409 .code
29410 av_scanner = $acl_m0
29411 .endd
29412 in the main Exim configuration.
29413 .code
29414 deny message = This message contains malware ($malware_name)
29415      set acl_m0 = sophie
29416      malware = *
29417
29418 deny message = This message contains malware ($malware_name)
29419      set acl_m0 = aveserver
29420      malware = *
29421 .endd
29422
29423
29424 .section "Scanning with SpamAssassin" "SECTscanspamass"
29425 .cindex "content scanning" "for spam"
29426 .cindex "spam scanning"
29427 .cindex "SpamAssassin"
29428 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29429 score and a report for the message. You can get SpamAssassin at
29430 &url(http://www.spamassassin.org), or, if you have a working Perl
29431 installation, you can use CPAN by running:
29432 .code
29433 perl -MCPAN -e 'install Mail::SpamAssassin'
29434 .endd
29435 SpamAssassin has its own set of configuration files. Please review its
29436 documentation to see how you can tweak it. The default installation should work
29437 nicely, however.
29438
29439 .oindex "&%spamd_address%&"
29440 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29441 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29442 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29443 part of the Exim configuration as follows (example):
29444 .code
29445 spamd_address = 192.168.99.45 387
29446 .endd
29447 You do not need to set this option if you use the default. As of version 2.60,
29448 &%spamd%& also supports communication over UNIX sockets. If you want to use
29449 these, supply &%spamd_address%& with an absolute file name instead of a
29450 address/port pair:
29451 .code
29452 spamd_address = /var/run/spamd_socket
29453 .endd
29454 You can have multiple &%spamd%& servers to improve scalability. These can
29455 reside on other hardware reachable over the network. To specify multiple
29456 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29457 option, separated with colons:
29458 .code
29459 spamd_address = 192.168.2.10 783 : \
29460                 192.168.2.11 783 : \
29461                 192.168.2.12 783
29462 .endd
29463 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29464 fashion. When a server fails to respond to the connection attempt, all other
29465 servers are tried until one succeeds. If no server responds, the &%spam%&
29466 condition defers.
29467
29468 &*Warning*&: It is not possible to use the UNIX socket connection method with
29469 multiple &%spamd%& servers.
29470
29471 The &%spamd_address%& variable is expanded before use if it starts with
29472 a dollar sign. In this case, the expansion may return a string that is
29473 used as the list so that multiple spamd servers can be the result of an
29474 expansion.
29475
29476 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29477 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29478 .code
29479 deny message = This message was classified as SPAM
29480      spam = joe
29481 .endd
29482 The right-hand side of the &%spam%& condition specifies a name. This is
29483 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29484 to scan using a specific profile, but rather use the SpamAssassin system-wide
29485 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29486 However, you must put something on the right-hand side.
29487
29488 The name allows you to use per-domain or per-user antispam profiles in
29489 principle, but this is not straightforward in practice, because a message may
29490 have multiple recipients, not necessarily all in the same domain. Because the
29491 &%spam%& condition has to be called from a DATA ACL in order to be able to
29492 read the contents of the message, the variables &$local_part$& and &$domain$&
29493 are not set.
29494
29495 The right-hand side of the &%spam%& condition is expanded before being used, so
29496 you can put lookups or conditions there. When the right-hand side evaluates to
29497 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29498
29499
29500 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29501 large ones may cause significant performance degradation. As most spam messages
29502 are quite small, it is recommended that you do not scan the big ones. For
29503 example:
29504 .code
29505 deny message = This message was classified as SPAM
29506      condition = ${if < {$message_size}{10K}}
29507      spam = nobody
29508 .endd
29509
29510 The &%spam%& condition returns true if the threshold specified in the user's
29511 SpamAssassin profile has been matched or exceeded. If you want to use the
29512 &%spam%& condition for its side effects (see the variables below), you can make
29513 it always return &"true"& by appending &`:true`& to the username.
29514
29515 .cindex "spam scanning" "returned variables"
29516 When the &%spam%& condition is run, it sets up a number of expansion
29517 variables. These variables are saved with the received message, thus they are
29518 available for use at delivery time.
29519
29520 .vlist
29521 .vitem &$spam_score$&
29522 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29523 for inclusion in log or reject messages.
29524
29525 .vitem &$spam_score_int$&
29526 The spam score of the message, multiplied by ten, as an integer value. For
29527 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29528 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29529 The integer value is useful for numeric comparisons in conditions.
29530
29531 .vitem &$spam_bar$&
29532 A string consisting of a number of &"+"& or &"-"& characters, representing the
29533 integer part of the spam score value. A spam score of 4.4 would have a
29534 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29535 headers, since MUAs can match on such strings.
29536
29537 .vitem &$spam_report$&
29538 A multiline text table, containing the full SpamAssassin report for the
29539 message. Useful for inclusion in headers or reject messages.
29540 .endlist
29541
29542 The &%spam%& condition caches its results unless expansion in
29543 spamd_address was used. If you call it again with the same user name, it
29544 does not scan again, but rather returns the same values as before.
29545
29546 The &%spam%& condition returns DEFER if there is any error while running
29547 the message through SpamAssassin or if the expansion of spamd_address
29548 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29549 statement block), append &`/defer_ok`& to the right-hand side of the
29550 spam condition, like this:
29551 .code
29552 deny message = This message was classified as SPAM
29553      spam    = joe/defer_ok
29554 .endd
29555 This causes messages to be accepted even if there is a problem with &%spamd%&.
29556
29557 Here is a longer, commented example of the use of the &%spam%&
29558 condition:
29559 .code
29560 # put headers in all messages (no matter if spam or not)
29561 warn  spam = nobody:true
29562       add_header = X-Spam-Score: $spam_score ($spam_bar)
29563       add_header = X-Spam-Report: $spam_report
29564
29565 # add second subject line with *SPAM* marker when message
29566 # is over threshold
29567 warn  spam = nobody
29568       add_header = Subject: *SPAM* $h_Subject:
29569
29570 # reject spam at high scores (> 12)
29571 deny  message = This message scored $spam_score spam points.
29572       spam = nobody:true
29573       condition = ${if >{$spam_score_int}{120}{1}{0}}
29574 .endd
29575
29576
29577
29578 .section "Scanning MIME parts" "SECTscanmimepart"
29579 .cindex "content scanning" "MIME parts"
29580 .cindex "MIME content scanning"
29581 .oindex "&%acl_smtp_mime%&"
29582 .oindex "&%acl_not_smtp_mime%&"
29583 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29584 each MIME part of an SMTP message, including multipart types, in the sequence
29585 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29586 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29587 options may both refer to the same ACL if you want the same processing in both
29588 cases.
29589
29590 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29591 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29592 the case of a non-SMTP message. However, a MIME ACL is called only if the
29593 message contains a &'Content-Type:'& header line. When a call to a MIME
29594 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29595 result code is sent to the client. In the case of an SMTP message, the
29596 &%acl_smtp_data%& ACL is not called when this happens.
29597
29598 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29599 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29600 condition to match against the raw MIME part. You can also use the
29601 &%mime_regex%& condition to match against the decoded MIME part (see section
29602 &<<SECTscanregex>>&).
29603
29604 At the start of a MIME ACL, a number of variables are set from the header
29605 information for the relevant MIME part. These are described below. The contents
29606 of the MIME part are not by default decoded into a disk file except for MIME
29607 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29608 part into a disk file, you can use the &%decode%& condition. The general
29609 syntax is:
29610 .display
29611 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29612 .endd
29613 The right hand side is expanded before use. After expansion,
29614 the value can be:
29615
29616 .olist
29617 &"0"& or &"false"&, in which case no decoding is done.
29618 .next
29619 The string &"default"&. In that case, the file is put in the temporary
29620 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29621 a sequential file name consisting of the message id and a sequence number. The
29622 full path and name is available in &$mime_decoded_filename$& after decoding.
29623 .next
29624 A full path name starting with a slash. If the full name is an existing
29625 directory, it is used as a replacement for the default directory. The filename
29626 is then sequentially assigned. If the path does not exist, it is used as
29627 the full path and file name.
29628 .next
29629 If the string does not start with a slash, it is used as the
29630 filename, and the default path is then used.
29631 .endlist
29632 The &%decode%& condition normally succeeds. It is only false for syntax
29633 errors or unusual circumstances such as memory shortages. You can easily decode
29634 a file with its original, proposed filename using
29635 .code
29636 decode = $mime_filename
29637 .endd
29638 However, you should keep in mind that &$mime_filename$& might contain
29639 anything. If you place files outside of the default path, they are not
29640 automatically unlinked.
29641
29642 For RFC822 attachments (these are messages attached to messages, with a
29643 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29644 as for the primary message, only that the &$mime_is_rfc822$& expansion
29645 variable is set (see below). Attached messages are always decoded to disk
29646 before being checked, and the files are unlinked once the check is done.
29647
29648 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29649 used to match regular expressions against raw and decoded MIME parts,
29650 respectively. They are described in section &<<SECTscanregex>>&.
29651
29652 .cindex "MIME content scanning" "returned variables"
29653 The following list describes all expansion variables that are
29654 available in the MIME ACL:
29655
29656 .vlist
29657 .vitem &$mime_boundary$&
29658 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29659 have a boundary string, which is stored in this variable. If the current part
29660 has no boundary parameter in the &'Content-Type:'& header, this variable
29661 contains the empty string.
29662
29663 .vitem &$mime_charset$&
29664 This variable contains the character set identifier, if one was found in the
29665 &'Content-Type:'& header. Examples for charset identifiers are:
29666 .code
29667 us-ascii
29668 gb2312 (Chinese)
29669 iso-8859-1
29670 .endd
29671 Please note that this value is not normalized, so you should do matches
29672 case-insensitively.
29673
29674 .vitem &$mime_content_description$&
29675 This variable contains the normalized content of the &'Content-Description:'&
29676 header. It can contain a human-readable description of the parts content. Some
29677 implementations repeat the filename for attachments here, but they are usually
29678 only used for display purposes.
29679
29680 .vitem &$mime_content_disposition$&
29681 This variable contains the normalized content of the &'Content-Disposition:'&
29682 header. You can expect strings like &"attachment"& or &"inline"& here.
29683
29684 .vitem &$mime_content_id$&
29685 This variable contains the normalized content of the &'Content-ID:'& header.
29686 This is a unique ID that can be used to reference a part from another part.
29687
29688 .vitem &$mime_content_size$&
29689 This variable is set only after the &%decode%& modifier (see above) has been
29690 successfully run. It contains the size of the decoded part in kilobytes. The
29691 size is always rounded up to full kilobytes, so only a completely empty part
29692 has a &$mime_content_size$& of zero.
29693
29694 .vitem &$mime_content_transfer_encoding$&
29695 This variable contains the normalized content of the
29696 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
29697 type. Typical values are &"base64"& and &"quoted-printable"&.
29698
29699 .vitem &$mime_content_type$&
29700 If the MIME part has a &'Content-Type:'& header, this variable contains its
29701 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
29702 are some examples of popular MIME types, as they may appear in this variable:
29703 .code
29704 text/plain
29705 text/html
29706 application/octet-stream
29707 image/jpeg
29708 audio/midi
29709 .endd
29710 If the MIME part has no &'Content-Type:'& header, this variable contains the
29711 empty string.
29712
29713 .vitem &$mime_decoded_filename$&
29714 This variable is set only after the &%decode%& modifier (see above) has been
29715 successfully run. It contains the full path and file name of the file
29716 containing the decoded data.
29717 .endlist
29718
29719 .cindex "RFC 2047"
29720 .vlist
29721 .vitem &$mime_filename$&
29722 This is perhaps the most important of the MIME variables. It contains a
29723 proposed filename for an attachment, if one was found in either the
29724 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
29725 RFC2047 decoded, but no additional sanity checks are done. If no filename was
29726 found, this variable contains the empty string.
29727
29728 .vitem &$mime_is_coverletter$&
29729 This variable attempts to differentiate the &"cover letter"& of an e-mail from
29730 attached data. It can be used to clamp down on flashy or unnecessarily encoded
29731 content in the cover letter, while not restricting attachments at all.
29732
29733 The variable contains 1 (true) for a MIME part believed to be part of the
29734 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
29735 follows:
29736
29737 .olist
29738 The outermost MIME part of a message is always a cover letter.
29739
29740 .next
29741 If a multipart/alternative or multipart/related MIME part is a cover letter,
29742 so are all MIME subparts within that multipart.
29743
29744 .next
29745 If any other multipart is a cover letter, the first subpart is a cover letter,
29746 and the rest are attachments.
29747
29748 .next
29749 All parts contained within an attachment multipart are attachments.
29750 .endlist olist
29751
29752 As an example, the following will ban &"HTML mail"& (including that sent with
29753 alternative plain text), while allowing HTML files to be attached. HTML
29754 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
29755 .code
29756 deny message = HTML mail is not accepted here
29757 !condition = $mime_is_rfc822
29758 condition = $mime_is_coverletter
29759 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
29760 .endd
29761 .vitem &$mime_is_multipart$&
29762 This variable has the value 1 (true) when the current part has the main type
29763 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
29764 Since multipart entities only serve as containers for other parts, you may not
29765 want to carry out specific actions on them.
29766
29767 .vitem &$mime_is_rfc822$&
29768 This variable has the value 1 (true) if the current part is not a part of the
29769 checked message itself, but part of an attached message. Attached message
29770 decoding is fully recursive.
29771
29772 .vitem &$mime_part_count$&
29773 This variable is a counter that is raised for each processed MIME part. It
29774 starts at zero for the very first part (which is usually a multipart). The
29775 counter is per-message, so it is reset when processing RFC822 attachments (see
29776 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
29777 complete, so you can use it in the DATA ACL to determine the number of MIME
29778 parts of a message. For non-MIME messages, this variable contains the value -1.
29779 .endlist
29780
29781
29782
29783 .section "Scanning with regular expressions" "SECTscanregex"
29784 .cindex "content scanning" "with regular expressions"
29785 .cindex "regular expressions" "content scanning with"
29786 You can specify your own custom regular expression matches on the full body of
29787 the message, or on individual MIME parts.
29788
29789 The &%regex%& condition takes one or more regular expressions as arguments and
29790 matches them against the full message (when called in the DATA ACL) or a raw
29791 MIME part (when called in the MIME ACL). The &%regex%& condition matches
29792 linewise, with a maximum line length of 32K characters. That means you cannot
29793 have multiline matches with the &%regex%& condition.
29794
29795 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
29796 to 32K of decoded content (the whole content at once, not linewise). If the
29797 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
29798 is decoded automatically when &%mime_regex%& is executed (using default path
29799 and filename values). If the decoded data is larger than  32K, only the first
29800 32K characters are checked.
29801
29802 The regular expressions are passed as a colon-separated list. To include a
29803 literal colon, you must double it. Since the whole right-hand side string is
29804 expanded before being used, you must also escape dollar signs and backslashes
29805 with more backslashes, or use the &`\N`& facility to disable expansion.
29806 Here is a simple example that contains two regular expressions:
29807 .code
29808 deny message = contains blacklisted regex ($regex_match_string)
29809      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
29810 .endd
29811 The conditions returns true if any one of the regular expressions matches. The
29812 &$regex_match_string$& expansion variable is then set up and contains the
29813 matching regular expression.
29814
29815 &*Warning*&: With large messages, these conditions can be fairly
29816 CPU-intensive.
29817
29818
29819
29820
29821 .section "The demime condition" "SECTdemimecond"
29822 .cindex "content scanning" "MIME checking"
29823 .cindex "MIME content scanning"
29824 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
29825 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
29826 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
29827 ACL functionality, but provides no additional facilities. Please note that this
29828 condition is deprecated and kept only for backward compatibility. You must set
29829 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
29830 use the &%demime%& condition.
29831
29832 The &%demime%& condition unpacks MIME containers in the message. It detects
29833 errors in MIME containers and can match file extensions found in the message
29834 against a list. Using this facility produces files containing the unpacked MIME
29835 parts of the message in the temporary scan directory. If you do antivirus
29836 scanning, it is recommended that you use the &%demime%& condition before the
29837 antivirus (&%malware%&) condition.
29838
29839 On the right-hand side of the &%demime%& condition you can pass a
29840 colon-separated list of file extensions that it should match against. For
29841 example:
29842 .code
29843 deny message = Found blacklisted file attachment
29844      demime  = vbs:com:bat:pif:prf:lnk
29845 .endd
29846 If one of the file extensions is found, the condition is true, otherwise it is
29847 false. If there is a temporary error while demimeing (for example, &"disk
29848 full"&), the condition defers, and the message is temporarily rejected (unless
29849 the condition is on a &%warn%& verb).
29850
29851 The right-hand side is expanded before being treated as a list, so you can have
29852 conditions and lookups there. If it expands to an empty string, &"false"&, or
29853 zero (&"0"&), no demimeing is done and the condition is false.
29854
29855 The &%demime%& condition set the following variables:
29856
29857 .vlist
29858 .vitem &$demime_errorlevel$&
29859 .vindex "&$demime_errorlevel$&"
29860 When an error is detected in a MIME container, this variable contains the
29861 severity of the error, as an integer number. The higher the value, the more
29862 severe the error (the current maximum value is 3). If this variable is unset or
29863 zero, no error occurred.
29864
29865 .vitem &$demime_reason$&
29866 .vindex "&$demime_reason$&"
29867 When &$demime_errorlevel$& is greater than zero, this variable contains a
29868 human-readable text string describing the MIME error that occurred.
29869 .endlist
29870
29871 .vlist
29872 .vitem &$found_extension$&
29873 .vindex "&$found_extension$&"
29874 When the &%demime%& condition is true, this variable contains the file
29875 extension it found.
29876 .endlist
29877
29878 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
29879 the &%demime%& condition, and are not changed on subsequent calls.
29880
29881 If you do not want to check for file extensions, but rather use the &%demime%&
29882 condition for unpacking or error checking purposes, pass &"*"& as the
29883 right-hand side value. Here is a more elaborate example of how to use this
29884 facility:
29885 .code
29886 # Reject messages with serious MIME container errors
29887 deny  message = Found MIME error ($demime_reason).
29888       demime = *
29889       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
29890
29891 # Reject known virus spreading file extensions.
29892 # Accepting these is pretty much braindead.
29893 deny  message = contains $found_extension file (blacklisted).
29894       demime  = com:vbs:bat:pif:scr
29895
29896 # Freeze .exe and .doc files. Postmaster can
29897 # examine them and eventually thaw them.
29898 deny  log_message = Another $found_extension file.
29899       demime = exe:doc
29900       control = freeze
29901 .endd
29902 .ecindex IIDcosca
29903
29904
29905
29906
29907 . ////////////////////////////////////////////////////////////////////////////
29908 . ////////////////////////////////////////////////////////////////////////////
29909
29910 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
29911          "Local scan function"
29912 .scindex IIDlosca "&[local_scan()]& function" "description of"
29913 .cindex "customizing" "input scan using C function"
29914 .cindex "policy control" "by local scan function"
29915 In these days of email worms, viruses, and ever-increasing spam, some sites
29916 want to apply a lot of checking to messages before accepting them.
29917
29918 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
29919 passing messages to external virus and spam scanning software. You can also do
29920 a certain amount in Exim itself through string expansions and the &%condition%&
29921 condition in the ACL that runs after the SMTP DATA command or the ACL for
29922 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
29923
29924 To allow for further customization to a site's own requirements, there is the
29925 possibility of linking Exim with a private message scanning function, written
29926 in C. If you want to run code that is written in something other than C, you
29927 can of course use a little C stub to call it.
29928
29929 The local scan function is run once for every incoming message, at the point
29930 when Exim is just about to accept the message.
29931 It can therefore be used to control non-SMTP messages from local processes as
29932 well as messages arriving via SMTP.
29933
29934 Exim applies a timeout to calls of the local scan function, and there is an
29935 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
29936 Zero means &"no timeout"&.
29937 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
29938 before calling the local scan function, so that the most common types of crash
29939 are caught. If the timeout is exceeded or one of those signals is caught, the
29940 incoming message is rejected with a temporary error if it is an SMTP message.
29941 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
29942 code. The incident is logged on the main and reject logs.
29943
29944
29945
29946 .section "Building Exim to use a local scan function" "SECID207"
29947 .cindex "&[local_scan()]& function" "building Exim to use"
29948 To make use of the local scan function feature, you must tell Exim where your
29949 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
29950 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
29951 directory, so you might set
29952 .code
29953 LOCAL_SCAN_SOURCE=Local/local_scan.c
29954 .endd
29955 for example. The function must be called &[local_scan()]&. It is called by
29956 Exim after it has received a message, when the success return code is about to
29957 be sent. This is after all the ACLs have been run. The return code from your
29958 function controls whether the message is actually accepted or not. There is a
29959 commented template function (that just accepts the message) in the file
29960 _src/local_scan.c_.
29961
29962 If you want to make use of Exim's run time configuration file to set options
29963 for your &[local_scan()]& function, you must also set
29964 .code
29965 LOCAL_SCAN_HAS_OPTIONS=yes
29966 .endd
29967 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
29968
29969
29970
29971
29972 .section "API for local_scan()" "SECTapiforloc"
29973 .cindex "&[local_scan()]& function" "API description"
29974 You must include this line near the start of your code:
29975 .code
29976 #include "local_scan.h"
29977 .endd
29978 This header file defines a number of variables and other values, and the
29979 prototype for the function itself. Exim is coded to use unsigned char values
29980 almost exclusively, and one of the things this header defines is a shorthand
29981 for &`unsigned char`& called &`uschar`&.
29982 It also contains the following macro definitions, to simplify casting character
29983 strings and pointers to character strings:
29984 .code
29985 #define CS   (char *)
29986 #define CCS  (const char *)
29987 #define CSS  (char **)
29988 #define US   (unsigned char *)
29989 #define CUS  (const unsigned char *)
29990 #define USS  (unsigned char **)
29991 .endd
29992 The function prototype for &[local_scan()]& is:
29993 .code
29994 extern int local_scan(int fd, uschar **return_text);
29995 .endd
29996 The arguments are as follows:
29997
29998 .ilist
29999 &%fd%& is a file descriptor for the file that contains the body of the message
30000 (the -D file). The file is open for reading and writing, but updating it is not
30001 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30002
30003 The descriptor is positioned at character 19 of the file, which is the first
30004 character of the body itself, because the first 19 characters are the message
30005 id followed by &`-D`& and a newline. If you rewind the file, you should use the
30006 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
30007 case this changes in some future version.
30008 .next
30009 &%return_text%& is an address which you can use to return a pointer to a text
30010 string at the end of the function. The value it points to on entry is NULL.
30011 .endlist
30012
30013 The function must return an &%int%& value which is one of the following macros:
30014
30015 .vlist
30016 .vitem &`LOCAL_SCAN_ACCEPT`&
30017 .vindex "&$local_scan_data$&"
30018 The message is accepted. If you pass back a string of text, it is saved with
30019 the message, and made available in the variable &$local_scan_data$&. No
30020 newlines are permitted (if there are any, they are turned into spaces) and the
30021 maximum length of text is 1000 characters.
30022
30023 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
30024 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30025 queued without immediate delivery, and is frozen.
30026
30027 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
30028 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30029 queued without immediate delivery.
30030
30031 .vitem &`LOCAL_SCAN_REJECT`&
30032 The message is rejected; the returned text is used as an error message which is
30033 passed back to the sender and which is also logged. Newlines are permitted &--
30034 they cause a multiline response for SMTP rejections, but are converted to
30035 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
30036 used.
30037
30038 .vitem &`LOCAL_SCAN_TEMPREJECT`&
30039 The message is temporarily rejected; the returned text is used as an error
30040 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
30041 problem"& is used.
30042
30043 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
30044 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
30045 message is not written to the reject log. It has the effect of unsetting the
30046 &%rejected_header%& log selector for just this rejection. If
30047 &%rejected_header%& is already unset (see the discussion of the
30048 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
30049 same as LOCAL_SCAN_REJECT.
30050
30051 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
30052 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
30053 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
30054 .endlist
30055
30056 If the message is not being received by interactive SMTP, rejections are
30057 reported by writing to &%stderr%& or by sending an email, as configured by the
30058 &%-oe%& command line options.
30059
30060
30061
30062 .section "Configuration options for local_scan()" "SECTconoptloc"
30063 .cindex "&[local_scan()]& function" "configuration options"
30064 It is possible to have option settings in the main configuration file
30065 that set values in static variables in the &[local_scan()]& module. If you
30066 want to do this, you must have the line
30067 .code
30068 LOCAL_SCAN_HAS_OPTIONS=yes
30069 .endd
30070 in your &_Local/Makefile_& when you build Exim. (This line is in
30071 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
30072 file, you must define static variables to hold the option values, and a table
30073 to define them.
30074
30075 The table must be a vector called &%local_scan_options%&, of type
30076 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
30077 and a pointer to the variable that holds the value. The entries must appear in
30078 alphabetical order. Following &%local_scan_options%& you must also define a
30079 variable called &%local_scan_options_count%& that contains the number of
30080 entries in the table. Here is a short example, showing two kinds of option:
30081 .code
30082 static int my_integer_option = 42;
30083 static uschar *my_string_option = US"a default string";
30084
30085 optionlist local_scan_options[] = {
30086   { "my_integer", opt_int,       &my_integer_option },
30087   { "my_string",  opt_stringptr, &my_string_option }
30088 };
30089
30090 int local_scan_options_count =
30091   sizeof(local_scan_options)/sizeof(optionlist);
30092 .endd
30093 The values of the variables can now be changed from Exim's runtime
30094 configuration file by including a local scan section as in this example:
30095 .code
30096 begin local_scan
30097 my_integer = 99
30098 my_string = some string of text...
30099 .endd
30100 The available types of option data are as follows:
30101
30102 .vlist
30103 .vitem &*opt_bool*&
30104 This specifies a boolean (true/false) option. The address should point to a
30105 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
30106 that are defined as &"1"& and &"0"&, respectively. If you want to detect
30107 whether such a variable has been set at all, you can initialize it to
30108 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
30109 values.)
30110
30111 .vitem &*opt_fixed*&
30112 This specifies a fixed point number, such as is used for load averages.
30113 The address should point to a variable of type &`int`&. The value is stored
30114 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
30115
30116 .vitem &*opt_int*&
30117 This specifies an integer; the address should point to a variable of type
30118 &`int`&. The value may be specified in any of the integer formats accepted by
30119 Exim.
30120
30121 .vitem &*opt_mkint*&
30122 This is the same as &%opt_int%&, except that when such a value is output in a
30123 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
30124 printed with the suffix K or M.
30125
30126 .vitem &*opt_octint*&
30127 This also specifies an integer, but the value is always interpreted as an
30128 octal integer, whether or not it starts with the digit zero, and it is
30129 always output in octal.
30130
30131 .vitem &*opt_stringptr*&
30132 This specifies a string value; the address must be a pointer to a
30133 variable that points to a string (for example, of type &`uschar *`&).
30134
30135 .vitem &*opt_time*&
30136 This specifies a time interval value. The address must point to a variable of
30137 type &`int`&. The value that is placed there is a number of seconds.
30138 .endlist
30139
30140 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
30141 out the values of all the &[local_scan()]& options.
30142
30143
30144
30145 .section "Available Exim variables" "SECID208"
30146 .cindex "&[local_scan()]& function" "available Exim variables"
30147 The header &_local_scan.h_& gives you access to a number of C variables. These
30148 are the only ones that are guaranteed to be maintained from release to release.
30149 Note, however, that you can obtain the value of any Exim expansion variable,
30150 including &$recipients$&, by calling &'expand_string()'&. The exported
30151 C variables are as follows:
30152
30153 .vlist
30154 .vitem &*int&~body_linecount*&
30155 This variable contains the number of lines in the message's body.
30156
30157 .vitem &*int&~body_zerocount*&
30158 This variable contains the number of binary zero bytes in the message's body.
30159
30160 .vitem &*unsigned&~int&~debug_selector*&
30161 This variable is set to zero when no debugging is taking place. Otherwise, it
30162 is a bitmap of debugging selectors. Two bits are identified for use in
30163 &[local_scan()]&; they are defined as macros:
30164
30165 .ilist
30166 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
30167 testing option that is not privileged &-- any caller may set it. All the
30168 other selector bits can be set only by admin users.
30169
30170 .next
30171 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
30172 by the &`+local_scan`& debug selector. It is not included in the default set
30173 of debugging bits.
30174 .endlist ilist
30175
30176 Thus, to write to the debugging output only when &`+local_scan`& has been
30177 selected, you should use code like this:
30178 .code
30179 if ((debug_selector & D_local_scan) != 0)
30180   debug_printf("xxx", ...);
30181 .endd
30182 .vitem &*uschar&~*expand_string_message*&
30183 After a failing call to &'expand_string()'& (returned value NULL), the
30184 variable &%expand_string_message%& contains the error message, zero-terminated.
30185
30186 .vitem &*header_line&~*header_list*&
30187 A pointer to a chain of header lines. The &%header_line%& structure is
30188 discussed below.
30189
30190 .vitem &*header_line&~*header_last*&
30191 A pointer to the last of the header lines.
30192
30193 .vitem &*uschar&~*headers_charset*&
30194 The value of the &%headers_charset%& configuration option.
30195
30196 .vitem &*BOOL&~host_checking*&
30197 This variable is TRUE during a host checking session that is initiated by the
30198 &%-bh%& command line option.
30199
30200 .vitem &*uschar&~*interface_address*&
30201 The IP address of the interface that received the message, as a string. This
30202 is NULL for locally submitted messages.
30203
30204 .vitem &*int&~interface_port*&
30205 The port on which this message was received. When testing with the &%-bh%&
30206 command line option, the value of this variable is -1 unless a port has been
30207 specified via the &%-oMi%& option.
30208
30209 .vitem &*uschar&~*message_id*&
30210 This variable contains Exim's message id for the incoming message (the value of
30211 &$message_exim_id$&) as a zero-terminated string.
30212
30213 .vitem &*uschar&~*received_protocol*&
30214 The name of the protocol by which the message was received.
30215
30216 .vitem &*int&~recipients_count*&
30217 The number of accepted recipients.
30218
30219 .vitem &*recipient_item&~*recipients_list*&
30220 .cindex "recipient" "adding in local scan"
30221 .cindex "recipient" "removing in local scan"
30222 The list of accepted recipients, held in a vector of length
30223 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
30224 can add additional recipients by calling &'receive_add_recipient()'& (see
30225 below). You can delete recipients by removing them from the vector and
30226 adjusting the value in &%recipients_count%&. In particular, by setting
30227 &%recipients_count%& to zero you remove all recipients. If you then return the
30228 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
30229 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
30230 and then call &'receive_add_recipient()'& as often as needed.
30231
30232 .vitem &*uschar&~*sender_address*&
30233 The envelope sender address. For bounce messages this is the empty string.
30234
30235 .vitem &*uschar&~*sender_host_address*&
30236 The IP address of the sending host, as a string. This is NULL for
30237 locally-submitted messages.
30238
30239 .vitem &*uschar&~*sender_host_authenticated*&
30240 The name of the authentication mechanism that was used, or NULL if the message
30241 was not received over an authenticated SMTP connection.
30242
30243 .vitem &*uschar&~*sender_host_name*&
30244 The name of the sending host, if known.
30245
30246 .vitem &*int&~sender_host_port*&
30247 The port on the sending host.
30248
30249 .vitem &*BOOL&~smtp_input*&
30250 This variable is TRUE for all SMTP input, including BSMTP.
30251
30252 .vitem &*BOOL&~smtp_batched_input*&
30253 This variable is TRUE for BSMTP input.
30254
30255 .vitem &*int&~store_pool*&
30256 The contents of this variable control which pool of memory is used for new
30257 requests. See section &<<SECTmemhanloc>>& for details.
30258 .endlist
30259
30260
30261 .section "Structure of header lines" "SECID209"
30262 The &%header_line%& structure contains the members listed below.
30263 You can add additional header lines by calling the &'header_add()'& function
30264 (see below). You can cause header lines to be ignored (deleted) by setting
30265 their type to *.
30266
30267
30268 .vlist
30269 .vitem &*struct&~header_line&~*next*&
30270 A pointer to the next header line, or NULL for the last line.
30271
30272 .vitem &*int&~type*&
30273 A code identifying certain headers that Exim recognizes. The codes are printing
30274 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
30275 Notice in particular that any header line whose type is * is not transmitted
30276 with the message. This flagging is used for header lines that have been
30277 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
30278 lines.) Effectively, * means &"deleted"&.
30279
30280 .vitem &*int&~slen*&
30281 The number of characters in the header line, including the terminating and any
30282 internal newlines.
30283
30284 .vitem &*uschar&~*text*&
30285 A pointer to the text of the header. It always ends with a newline, followed by
30286 a zero byte. Internal newlines are preserved.
30287 .endlist
30288
30289
30290
30291 .section "Structure of recipient items" "SECID210"
30292 The &%recipient_item%& structure contains these members:
30293
30294 .vlist
30295 .vitem &*uschar&~*address*&
30296 This is a pointer to the recipient address as it was received.
30297
30298 .vitem &*int&~pno*&
30299 This is used in later Exim processing when top level addresses are created by
30300 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
30301 and must always contain -1 at this stage.
30302
30303 .vitem &*uschar&~*errors_to*&
30304 If this value is not NULL, bounce messages caused by failing to deliver to the
30305 recipient are sent to the address it contains. In other words, it overrides the
30306 envelope sender for this one recipient. (Compare the &%errors_to%& generic
30307 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
30308 an unqualified address, Exim qualifies it using the domain from
30309 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
30310 is NULL for all recipients.
30311 .endlist
30312
30313
30314
30315 .section "Available Exim functions" "SECID211"
30316 .cindex "&[local_scan()]& function" "available Exim functions"
30317 The header &_local_scan.h_& gives you access to a number of Exim functions.
30318 These are the only ones that are guaranteed to be maintained from release to
30319 release:
30320
30321 .vlist
30322 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
30323        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
30324
30325 This function creates a child process that runs the command specified by
30326 &%argv%&. The environment for the process is specified by &%envp%&, which can
30327 be NULL if no environment variables are to be passed. A new umask is supplied
30328 for the process in &%newumask%&.
30329
30330 Pipes to the standard input and output of the new process are set up
30331 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
30332 standard error is cloned to the standard output. If there are any file
30333 descriptors &"in the way"& in the new process, they are closed. If the final
30334 argument is TRUE, the new process is made into a process group leader.
30335
30336 The function returns the pid of the new process, or -1 if things go wrong.
30337
30338 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
30339 This function waits for a child process to terminate, or for a timeout (in
30340 seconds) to expire. A timeout value of zero means wait as long as it takes. The
30341 return value is as follows:
30342
30343 .ilist
30344 >= 0
30345
30346 The process terminated by a normal exit and the value is the process
30347 ending status.
30348
30349 .next
30350 < 0 and > &--256
30351
30352 The process was terminated by a signal and the value is the negation of the
30353 signal number.
30354
30355 .next
30356 &--256
30357
30358 The process timed out.
30359 .next
30360 &--257
30361
30362 The was some other error in wait(); &%errno%& is still set.
30363 .endlist
30364
30365 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30366 This function provide you with a means of submitting a new message to
30367 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30368 want, but this packages it all up for you.) The function creates a pipe,
30369 forks a subprocess that is running
30370 .code
30371 exim -t -oem -oi -f <>
30372 .endd
30373 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30374 that is connected to the standard input. The yield of the function is the PID
30375 of the subprocess. You can then write a message to the file descriptor, with
30376 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30377
30378 When you have finished, call &'child_close()'& to wait for the process to
30379 finish and to collect its ending status. A timeout value of zero is usually
30380 fine in this circumstance. Unless you have made a mistake with the recipient
30381 addresses, you should get a return code of zero.
30382
30383
30384 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30385        *sender_authentication)*&
30386 This function is a more sophisticated version of &'child_open()'&. The command
30387 that it runs is:
30388 .display
30389 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30390 .endd
30391 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30392
30393
30394 .vitem &*void&~debug_printf(char&~*,&~...)*&
30395 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30396 output is written to the standard error stream. If no debugging is selected,
30397 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30398 conditional on the &`local_scan`& debug selector by coding like this:
30399 .code
30400 if ((debug_selector & D_local_scan) != 0)
30401   debug_printf("xxx", ...);
30402 .endd
30403
30404 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30405 This is an interface to Exim's string expansion code. The return value is the
30406 expanded string, or NULL if there was an expansion failure.
30407 The C variable &%expand_string_message%& contains an error message after an
30408 expansion failure. If expansion does not change the string, the return value is
30409 the pointer to the input string. Otherwise, the return value points to a new
30410 block of memory that was obtained by a call to &'store_get()'&. See section
30411 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30412
30413 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30414 This function allows you to an add additional header line at the end of the
30415 existing ones. The first argument is the type, and should normally be a space
30416 character. The second argument is a format string and any number of
30417 substitution arguments as for &[sprintf()]&. You may include internal newlines
30418 if you want, and you must ensure that the string ends with a newline.
30419
30420 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30421         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30422 This function adds a new header line at a specified point in the header
30423 chain. The header itself is specified as for &'header_add()'&.
30424
30425 If &%name%& is NULL, the new header is added at the end of the chain if
30426 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30427 NULL, the header lines are searched for the first non-deleted header that
30428 matches the name. If one is found, the new header is added before it if
30429 &%after%& is false. If &%after%& is true, the new header is added after the
30430 found header and any adjacent subsequent ones with the same name (even if
30431 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30432 option controls where the header is added. If it is true, addition is at the
30433 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30434 headers, or at the top if there are no &'Received:'& headers, you could use
30435 .code
30436 header_add_at_position(TRUE, US"Received", TRUE,
30437   ' ', "X-xxx: ...");
30438 .endd
30439 Normally, there is always at least one non-deleted &'Received:'& header, but
30440 there may not be if &%received_header_text%& expands to an empty string.
30441
30442
30443 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30444 This function removes header lines. If &%occurrence%& is zero or negative, all
30445 occurrences of the header are removed. If occurrence is greater than zero, that
30446 particular instance of the header is removed. If no header(s) can be found that
30447 match the specification, the function does nothing.
30448
30449
30450 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30451         int&~length,&~BOOL&~notdel)*&"
30452 This function tests whether the given header has the given name. It is not just
30453 a string comparison, because white space is permitted between the name and the
30454 colon. If the &%notdel%& argument is true, a false return is forced for all
30455 &"deleted"& headers; otherwise they are not treated specially. For example:
30456 .code
30457 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30458 .endd
30459 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30460 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30461 This function base64-encodes a string, which is passed by address and length.
30462 The text may contain bytes of any value, including zero. The result is passed
30463 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30464 zero-terminated.
30465
30466 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30467 This function decodes a base64-encoded string. Its arguments are a
30468 zero-terminated base64-encoded string and the address of a variable that is set
30469 to point to the result, which is in dynamic memory. The length of the decoded
30470 string is the yield of the function. If the input is invalid base64 data, the
30471 yield is -1. A zero byte is added to the end of the output string to make it
30472 easy to interpret as a C string (assuming it contains no zeros of its own). The
30473 added zero byte is not included in the returned count.
30474
30475 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30476 This function checks for a match in a domain list. Domains are always
30477 matched caselessly. The return value is one of the following:
30478 .display
30479 &`OK     `& match succeeded
30480 &`FAIL   `& match failed
30481 &`DEFER  `& match deferred
30482 .endd
30483 DEFER is usually caused by some kind of lookup defer, such as the
30484 inability to contact a database.
30485
30486 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30487         BOOL&~caseless)*&"
30488 This function checks for a match in a local part list. The third argument
30489 controls case-sensitivity. The return values are as for
30490 &'lss_match_domain()'&.
30491
30492 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30493         BOOL&~caseless)*&"
30494 This function checks for a match in an address list. The third argument
30495 controls the case-sensitivity of the local part match. The domain is always
30496 matched caselessly. The return values are as for &'lss_match_domain()'&.
30497
30498 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30499         uschar&~*list)*&"
30500 This function checks for a match in a host list. The most common usage is
30501 expected to be
30502 .code
30503 lss_match_host(sender_host_name, sender_host_address, ...)
30504 .endd
30505 .vindex "&$sender_host_address$&"
30506 An empty address field matches an empty item in the host list. If the host name
30507 is NULL, the name corresponding to &$sender_host_address$& is automatically
30508 looked up if a host name is required to match an item in the list. The return
30509 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30510 returns ERROR in the case when it had to look up a host name, but the lookup
30511 failed.
30512
30513 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30514         *format,&~...)*&"
30515 This function writes to Exim's log files. The first argument should be zero (it
30516 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30517 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30518 them. It specifies to which log or logs the message is written. The remaining
30519 arguments are a format and relevant insertion arguments. The string should not
30520 contain any newlines, not even at the end.
30521
30522
30523 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30524 This function adds an additional recipient to the message. The first argument
30525 is the recipient address. If it is unqualified (has no domain), it is qualified
30526 with the &%qualify_recipient%& domain. The second argument must always be -1.
30527
30528 This function does not allow you to specify a private &%errors_to%& address (as
30529 described with the structure of &%recipient_item%& above), because it pre-dates
30530 the addition of that field to the structure. However, it is easy to add such a
30531 value afterwards. For example:
30532 .code
30533  receive_add_recipient(US"monitor@mydom.example", -1);
30534  recipients_list[recipients_count-1].errors_to =
30535    US"postmaster@mydom.example";
30536 .endd
30537
30538 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30539 This is a convenience function to remove a named recipient from the list of
30540 recipients. It returns true if a recipient was removed, and false if no
30541 matching recipient could be found. The argument must be a complete email
30542 address.
30543 .endlist
30544
30545
30546 .cindex "RFC 2047"
30547 .vlist
30548 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30549   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30550 This function decodes strings that are encoded according to RFC 2047. Typically
30551 these are the contents of header lines. First, each &"encoded word"& is decoded
30552 from the Q or B encoding into a byte-string. Then, if provided with the name of
30553 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30554 made  to translate the result to the named character set. If this fails, the
30555 binary string is returned with an error message.
30556
30557 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30558 maximum MIME word length is enforced. The third argument is the target
30559 encoding, or NULL if no translation is wanted.
30560
30561 .cindex "binary zero" "in RFC 2047 decoding"
30562 .cindex "RFC 2047" "binary zero in"
30563 If a binary zero is encountered in the decoded string, it is replaced by the
30564 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30565 not be 0 because header lines are handled as zero-terminated strings.
30566
30567 The function returns the result of processing the string, zero-terminated; if
30568 &%lenptr%& is not NULL, the length of the result is set in the variable to
30569 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30570
30571 If an error is encountered, the function returns NULL and uses the &%error%&
30572 argument to return an error message. The variable pointed to by &%error%& is
30573 set to NULL if there is no error; it may be set non-NULL even when the function
30574 returns a non-NULL value if decoding was successful, but there was a problem
30575 with translation.
30576
30577
30578 .vitem &*int&~smtp_fflush(void)*&
30579 This function is used in conjunction with &'smtp_printf()'&, as described
30580 below.
30581
30582 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30583 The arguments of this function are like &[printf()]&; it writes to the SMTP
30584 output stream. You should use this function only when there is an SMTP output
30585 stream, that is, when the incoming message is being received via interactive
30586 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30587 is FALSE. If you want to test for an incoming message from another host (as
30588 opposed to a local process that used the &%-bs%& command line option), you can
30589 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30590 is involved.
30591
30592 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30593 output function, so it can be used for all forms of SMTP connection.
30594
30595 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30596 must start with an appropriate response code: 550 if you are going to return
30597 LOCAL_SCAN_REJECT, 451 if you are going to return
30598 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30599 initial lines of a multi-line response, the code must be followed by a hyphen
30600 to indicate that the line is not the final response line. You must also ensure
30601 that the lines you write terminate with CRLF. For example:
30602 .code
30603 smtp_printf("550-this is some extra info\r\n");
30604 return LOCAL_SCAN_REJECT;
30605 .endd
30606 Note that you can also create multi-line responses by including newlines in
30607 the data returned via the &%return_text%& argument. The added value of using
30608 &'smtp_printf()'& is that, for instance, you could introduce delays between
30609 multiple output lines.
30610
30611 The &'smtp_printf()'& function does not return any error indication, because it
30612 does not automatically flush pending output, and therefore does not test
30613 the state of the stream. (In the main code of Exim, flushing and error
30614 detection is done when Exim is ready for the next SMTP input command.) If
30615 you want to flush the output and check for an error (for example, the
30616 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30617 arguments. It flushes the output stream, and returns a non-zero value if there
30618 is an error.
30619
30620 .vitem &*void&~*store_get(int)*&
30621 This function accesses Exim's internal store (memory) manager. It gets a new
30622 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30623 runs out of memory. See the next section for a discussion of memory handling.
30624
30625 .vitem &*void&~*store_get_perm(int)*&
30626 This function is like &'store_get()'&, but it always gets memory from the
30627 permanent pool. See the next section for a discussion of memory handling.
30628
30629 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30630 See below.
30631
30632 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30633 See below.
30634
30635 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30636 These three functions create strings using Exim's dynamic memory facilities.
30637 The first makes a copy of an entire string. The second copies up to a maximum
30638 number of characters, indicated by the second argument. The third uses a format
30639 and insertion arguments to create a new string. In each case, the result is a
30640 pointer to a new string in the current memory pool. See the next section for
30641 more discussion.
30642 .endlist
30643
30644
30645
30646 .section "More about Exim's memory handling" "SECTmemhanloc"
30647 .cindex "&[local_scan()]& function" "memory handling"
30648 No function is provided for freeing memory, because that is never needed.
30649 The dynamic memory that Exim uses when receiving a message is automatically
30650 recycled if another message is received by the same process (this applies only
30651 to incoming SMTP connections &-- other input methods can supply only one
30652 message at a time). After receiving the last message, a reception process
30653 terminates.
30654
30655 Because it is recycled, the normal dynamic memory cannot be used for holding
30656 data that must be preserved over a number of incoming messages on the same SMTP
30657 connection. However, Exim in fact uses two pools of dynamic memory; the second
30658 one is not recycled, and can be used for this purpose.
30659
30660 If you want to allocate memory that remains available for subsequent messages
30661 in the same SMTP connection, you should set
30662 .code
30663 store_pool = POOL_PERM
30664 .endd
30665 before calling the function that does the allocation. There is no need to
30666 restore the value if you do not need to; however, if you do want to revert to
30667 the normal pool, you can either restore the previous value of &%store_pool%& or
30668 set it explicitly to POOL_MAIN.
30669
30670 The pool setting applies to all functions that get dynamic memory, including
30671 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30672 There is also a convenience function called &'store_get_perm()'& that gets a
30673 block of memory from the permanent pool while preserving the value of
30674 &%store_pool%&.
30675 .ecindex IIDlosca
30676
30677
30678
30679
30680 . ////////////////////////////////////////////////////////////////////////////
30681 . ////////////////////////////////////////////////////////////////////////////
30682
30683 .chapter "System-wide message filtering" "CHAPsystemfilter"
30684 .scindex IIDsysfil1 "filter" "system filter"
30685 .scindex IIDsysfil2 "filtering all mail"
30686 .scindex IIDsysfil3 "system filter"
30687 The previous chapters (on ACLs and the local scan function) describe checks
30688 that can be applied to messages before they are accepted by a host. There is
30689 also a mechanism for checking messages once they have been received, but before
30690 they are delivered. This is called the &'system filter'&.
30691
30692 The system filter operates in a similar manner to users' filter files, but it
30693 is run just once per message (however many recipients the message has).
30694 It should not normally be used as a substitute for routing, because &%deliver%&
30695 commands in a system router provide new envelope recipient addresses.
30696 The system filter must be an Exim filter. It cannot be a Sieve filter.
30697
30698 The system filter is run at the start of a delivery attempt, before any routing
30699 is done. If a message fails to be completely delivered at the first attempt,
30700 the system filter is run again at the start of every retry.
30701 If you want your filter to do something only once per message, you can make use
30702 of the &%first_delivery%& condition in an &%if%& command in the filter to
30703 prevent it happening on retries.
30704
30705 .vindex "&$domain$&"
30706 .vindex "&$local_part$&"
30707 &*Warning*&: Because the system filter runs just once, variables that are
30708 specific to individual recipient addresses, such as &$local_part$& and
30709 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
30710 you want to run a centrally-specified filter for each recipient address
30711 independently, you can do so by setting up a suitable &(redirect)& router, as
30712 described in section &<<SECTperaddfil>>& below.
30713
30714
30715 .section "Specifying a system filter" "SECID212"
30716 .cindex "uid (user id)" "system filter"
30717 .cindex "gid (group id)" "system filter"
30718 The name of the file that contains the system filter must be specified by
30719 setting &%system_filter%&. If you want the filter to run under a uid and gid
30720 other than root, you must also set &%system_filter_user%& and
30721 &%system_filter_group%& as appropriate. For example:
30722 .code
30723 system_filter = /etc/mail/exim.filter
30724 system_filter_user = exim
30725 .endd
30726 If a system filter generates any deliveries directly to files or pipes (via the
30727 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
30728 specified by setting &%system_filter_file_transport%& and
30729 &%system_filter_pipe_transport%&, respectively. Similarly,
30730 &%system_filter_reply_transport%& must be set to handle any messages generated
30731 by the &%reply%& command.
30732
30733
30734 .section "Testing a system filter" "SECID213"
30735 You can run simple tests of a system filter in the same way as for a user
30736 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
30737 are permitted only in system filters are recognized.
30738
30739 If you want to test the combined effect of a system filter and a user filter,
30740 you can use both &%-bF%& and &%-bf%& on the same command line.
30741
30742
30743
30744 .section "Contents of a system filter" "SECID214"
30745 The language used to specify system filters is the same as for users' filter
30746 files. It is described in the separate end-user document &'Exim's interface to
30747 mail filtering'&. However, there are some additional features that are
30748 available only in system filters; these are described in subsequent sections.
30749 If they are encountered in a user's filter file or when testing with &%-bf%&,
30750 they cause errors.
30751
30752 .cindex "frozen messages" "manual thaw; testing in filter"
30753 There are two special conditions which, though available in users' filter
30754 files, are designed for use in system filters. The condition &%first_delivery%&
30755 is true only for the first attempt at delivering a message, and
30756 &%manually_thawed%& is true only if the message has been frozen, and
30757 subsequently thawed by an admin user. An explicit forced delivery counts as a
30758 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
30759
30760 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
30761 specify an &"unseen"& (non-significant) delivery, and that delivery does not
30762 succeed, it will not be tried again.
30763 If you want Exim to retry an unseen delivery until it succeeds, you should
30764 arrange to set it up every time the filter runs.
30765
30766 When a system filter finishes running, the values of the variables &$n0$& &--
30767 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
30768 users' filter files. Thus a system filter can, for example, set up &"scores"&
30769 to which users' filter files can refer.
30770
30771
30772
30773 .section "Additional variable for system filters" "SECID215"
30774 .vindex "&$recipients$&"
30775 The expansion variable &$recipients$&, containing a list of all the recipients
30776 of the message (separated by commas and white space), is available in system
30777 filters. It is not available in users' filters for privacy reasons.
30778
30779
30780
30781 .section "Defer, freeze, and fail commands for system filters" "SECID216"
30782 .cindex "freezing messages"
30783 .cindex "message" "freezing"
30784 .cindex "message" "forced failure"
30785 .cindex "&%fail%&" "in system filter"
30786 .cindex "&%freeze%& in system filter"
30787 .cindex "&%defer%& in system filter"
30788 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
30789 always available in system filters, but are not normally enabled in users'
30790 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
30791 for the &(redirect)& router.) These commands can optionally be followed by the
30792 word &%text%& and a string containing an error message, for example:
30793 .code
30794 fail text "this message looks like spam to me"
30795 .endd
30796 The keyword &%text%& is optional if the next character is a double quote.
30797
30798 The &%defer%& command defers delivery of the original recipients of the
30799 message. The &%fail%& command causes all the original recipients to be failed,
30800 and a bounce message to be created. The &%freeze%& command suspends all
30801 delivery attempts for the original recipients. In all cases, any new deliveries
30802 that are specified by the filter are attempted as normal after the filter has
30803 run.
30804
30805 The &%freeze%& command is ignored if the message has been manually unfrozen and
30806 not manually frozen since. This means that automatic freezing by a system
30807 filter can be used as a way of checking out suspicious messages. If a message
30808 is found to be all right, manually unfreezing it allows it to be delivered.
30809
30810 .cindex "log" "&%fail%& command log line"
30811 .cindex "&%fail%&" "log line; reducing"
30812 The text given with a fail command is used as part of the bounce message as
30813 well as being written to the log. If the message is quite long, this can fill
30814 up a lot of log space when such failures are common. To reduce the size of the
30815 log message, Exim interprets the text in a special way if it starts with the
30816 two characters &`<<`& and contains &`>>`& later. The text between these two
30817 strings is written to the log, and the rest of the text is used in the bounce
30818 message. For example:
30819 .code
30820 fail "<<filter test 1>>Your message is rejected \
30821      because it contains attachments that we are \
30822      not prepared to receive."
30823 .endd
30824
30825 .cindex "loop" "caused by &%fail%&"
30826 Take great care with the &%fail%& command when basing the decision to fail on
30827 the contents of the message, because the bounce message will of course include
30828 the contents of the original message and will therefore trigger the &%fail%&
30829 command again (causing a mail loop) unless steps are taken to prevent this.
30830 Testing the &%error_message%& condition is one way to prevent this. You could
30831 use, for example
30832 .code
30833 if $message_body contains "this is spam" and not error_message
30834 then fail text "spam is not wanted here" endif
30835 .endd
30836 though of course that might let through unwanted bounce messages. The
30837 alternative is clever checking of the body and/or headers to detect bounces
30838 generated by the filter.
30839
30840 The interpretation of a system filter file ceases after a
30841 &%defer%&,
30842 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
30843 set up earlier in the filter file are honoured, so you can use a sequence such
30844 as
30845 .code
30846 mail ...
30847 freeze
30848 .endd
30849 to send a specified message when the system filter is freezing (or deferring or
30850 failing) a message. The normal deliveries for the message do not, of course,
30851 take place.
30852
30853
30854
30855 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
30856 .cindex "header lines" "adding; in system filter"
30857 .cindex "header lines" "removing; in system filter"
30858 .cindex "filter" "header lines; adding/removing"
30859 Two filter commands that are available only in system filters are:
30860 .code
30861 headers add <string>
30862 headers remove <string>
30863 .endd
30864 The argument for the &%headers add%& is a string that is expanded and then
30865 added to the end of the message's headers. It is the responsibility of the
30866 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
30867 space is ignored, and if the string is otherwise empty, or if the expansion is
30868 forced to fail, the command has no effect.
30869
30870 You can use &"\n"& within the string, followed by white space, to specify
30871 continued header lines. More than one header may be added in one command by
30872 including &"\n"& within the string without any following white space. For
30873 example:
30874 .code
30875 headers add "X-header-1: ....\n  \
30876              continuation of X-header-1 ...\n\
30877              X-header-2: ...."
30878 .endd
30879 Note that the header line continuation white space after the first newline must
30880 be placed before the backslash that continues the input string, because white
30881 space after input continuations is ignored.
30882
30883 The argument for &%headers remove%& is a colon-separated list of header names.
30884 This command applies only to those headers that are stored with the message;
30885 those that are added at delivery time (such as &'Envelope-To:'& and
30886 &'Return-Path:'&) cannot be removed by this means. If there is more than one
30887 header with the same name, they are all removed.
30888
30889 The &%headers%& command in a system filter makes an immediate change to the set
30890 of header lines that was received with the message (with possible additions
30891 from ACL processing). Subsequent commands in the system filter operate on the
30892 modified set, which also forms the basis for subsequent message delivery.
30893 Unless further modified during routing or transporting, this set of headers is
30894 used for all recipients of the message.
30895
30896 During routing and transporting, the variables that refer to the contents of
30897 header lines refer only to those lines that are in this set. Thus, header lines
30898 that are added by a system filter are visible to users' filter files and to all
30899 routers and transports. This contrasts with the manipulation of header lines by
30900 routers and transports, which is not immediate, but which instead is saved up
30901 until the message is actually being written (see section
30902 &<<SECTheadersaddrem>>&).
30903
30904 If the message is not delivered at the first attempt, header lines that were
30905 added by the system filter are stored with the message, and so are still
30906 present at the next delivery attempt. Header lines that were removed are still
30907 present, but marked &"deleted"& so that they are not transported with the
30908 message. For this reason, it is usual to make the &%headers%& command
30909 conditional on &%first_delivery%& so that the set of header lines is not
30910 modified more than once.
30911
30912 Because header modification in a system filter acts immediately, you have to
30913 use an indirect approach if you want to modify the contents of a header line.
30914 For example:
30915 .code
30916 headers add "Old-Subject: $h_subject:"
30917 headers remove "Subject"
30918 headers add "Subject: new subject (was: $h_old-subject:)"
30919 headers remove "Old-Subject"
30920 .endd
30921
30922
30923
30924 .section "Setting an errors address in a system filter" "SECID217"
30925 .cindex "envelope sender"
30926 In a system filter, if a &%deliver%& command is followed by
30927 .code
30928 errors_to <some address>
30929 .endd
30930 in order to change the envelope sender (and hence the error reporting) for that
30931 delivery, any address may be specified. (In a user filter, only the current
30932 user's address can be set.) For example, if some mail is being monitored, you
30933 might use
30934 .code
30935 unseen deliver monitor@spying.example errors_to root@local.example
30936 .endd
30937 to take a copy which would not be sent back to the normal error reporting
30938 address if its delivery failed.
30939
30940
30941
30942 .section "Per-address filtering" "SECTperaddfil"
30943 .vindex "&$domain$&"
30944 .vindex "&$local_part$&"
30945 In contrast to the system filter, which is run just once per message for each
30946 delivery attempt, it is also possible to set up a system-wide filtering
30947 operation that runs once for each recipient address. In this case, variables
30948 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
30949 filter file could be made dependent on them. This is an example of a router
30950 which implements such a filter:
30951 .code
30952 central_filter:
30953   check_local_user
30954   driver = redirect
30955   domains = +local_domains
30956   file = /central/filters/$local_part
30957   no_verify
30958   allow_filter
30959   allow_freeze
30960 .endd
30961 The filter is run in a separate process under its own uid. Therefore, either
30962 &%check_local_user%& must be set (as above), in which case the filter is run as
30963 the local user, or the &%user%& option must be used to specify which user to
30964 use. If both are set, &%user%& overrides.
30965
30966 Care should be taken to ensure that none of the commands in the filter file
30967 specify a significant delivery if the message is to go on to be delivered to
30968 its intended recipient. The router will not then claim to have dealt with the
30969 address, so it will be passed on to subsequent routers to be delivered in the
30970 normal way.
30971 .ecindex IIDsysfil1
30972 .ecindex IIDsysfil2
30973 .ecindex IIDsysfil3
30974
30975
30976
30977
30978
30979
30980 . ////////////////////////////////////////////////////////////////////////////
30981 . ////////////////////////////////////////////////////////////////////////////
30982
30983 .chapter "Message processing" "CHAPmsgproc"
30984 .scindex IIDmesproc "message" "general processing"
30985 Exim performs various transformations on the sender and recipient addresses of
30986 all messages that it handles, and also on the messages' header lines. Some of
30987 these are optional and configurable, while others always take place. All of
30988 this processing, except rewriting as a result of routing, and the addition or
30989 removal of header lines while delivering, happens when a message is received,
30990 before it is placed on Exim's queue.
30991
30992 Some of the automatic processing takes place by default only for
30993 &"locally-originated"& messages. This adjective is used to describe messages
30994 that are not received over TCP/IP, but instead are passed to an Exim process on
30995 its standard input. This includes the interactive &"local SMTP"& case that is
30996 set up by the &%-bs%& command line option.
30997
30998 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
30999 or ::1) are not considered to be locally-originated. Exim does not treat the
31000 loopback interface specially in any way.
31001
31002 If you want the loopback interface to be treated specially, you must ensure
31003 that there are appropriate entries in your ACLs.
31004
31005
31006
31007
31008 .section "Submission mode for non-local messages" "SECTsubmodnon"
31009 .cindex "message" "submission"
31010 .cindex "submission mode"
31011 Processing that happens automatically for locally-originated messages (unless
31012 &%suppress_local_fixups%& is set) can also be requested for messages that are
31013 received over TCP/IP. The term &"submission mode"& is used to describe this
31014 state. Submission mode is set by the modifier
31015 .code
31016 control = submission
31017 .endd
31018 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
31019 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
31020 a local submission, and is normally used when the source of the message is
31021 known to be an MUA running on a client host (as opposed to an MTA). For
31022 example, to set submission mode for messages originating on the IPv4 loopback
31023 interface, you could include the following in the MAIL ACL:
31024 .code
31025 warn  hosts = 127.0.0.1
31026       control = submission
31027 .endd
31028 .cindex "&%sender_retain%& submission option"
31029 There are some options that can be used when setting submission mode. A slash
31030 is used to separate options. For example:
31031 .code
31032 control = submission/sender_retain
31033 .endd
31034 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
31035 true and &%local_from_check%& false for the current incoming message. The first
31036 of these allows an existing &'Sender:'& header in the message to remain, and
31037 the second suppresses the check to ensure that &'From:'& matches the
31038 authenticated sender. With this setting, Exim still fixes up messages by adding
31039 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
31040 attempt to check sender authenticity in header lines.
31041
31042 When &%sender_retain%& is not set, a submission mode setting may specify a
31043 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
31044 example:
31045 .code
31046 control = submission/domain=some.domain
31047 .endd
31048 The domain may be empty. How this value is used is described in sections
31049 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
31050 that allows you to specify the user's full name for inclusion in a created
31051 &'Sender:'& or &'From:'& header line. For example:
31052 .code
31053 accept authenticated = *
31054        control = submission/domain=wonderland.example/\
31055                             name=${lookup {$authenticated_id} \
31056                                    lsearch {/etc/exim/namelist}}
31057 .endd
31058 Because the name may contain any characters, including slashes, the &%name%&
31059 option must be given last. The remainder of the string is used as the name. For
31060 the example above, if &_/etc/exim/namelist_& contains:
31061 .code
31062 bigegg:  Humpty Dumpty
31063 .endd
31064 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
31065 line would be:
31066 .code
31067 Sender: Humpty Dumpty <bigegg@wonderland.example>
31068 .endd
31069 .cindex "return path" "in submission mode"
31070 By default, submission mode forces the return path to the same address as is
31071 used to create the &'Sender:'& header. However, if &%sender_retain%& is
31072 specified, the return path is also left unchanged.
31073
31074 &*Note*&: The changes caused by submission mode take effect after the predata
31075 ACL. This means that any sender checks performed before the fix-ups use the
31076 untrusted sender address specified by the user, not the trusted sender address
31077 specified by submission mode. Although this might be slightly unexpected, it
31078 does mean that you can configure ACL checks to spot that a user is trying to
31079 spoof another's address.
31080
31081 .section "Line endings" "SECTlineendings"
31082 .cindex "line endings"
31083 .cindex "carriage return"
31084 .cindex "linefeed"
31085 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
31086 linefeed) is the line ending for messages transmitted over the Internet using
31087 SMTP over TCP/IP. However, within individual operating systems, different
31088 conventions are used. For example, Unix-like systems use just LF, but others
31089 use CRLF or just CR.
31090
31091 Exim was designed for Unix-like systems, and internally, it stores messages
31092 using the system's convention of a single LF as a line terminator. When
31093 receiving a message, all line endings are translated to this standard format.
31094 Originally, it was thought that programs that passed messages directly to an
31095 MTA within an operating system would use that system's convention. Experience
31096 has shown that this is not the case; for example, there are Unix applications
31097 that use CRLF in this circumstance. For this reason, and for compatibility with
31098 other MTAs, the way Exim handles line endings for all messages is now as
31099 follows:
31100
31101 .ilist
31102 LF not preceded by CR is treated as a line ending.
31103 .next
31104 CR is treated as a line ending; if it is immediately followed by LF, the LF
31105 is ignored.
31106 .next
31107 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
31108 nor a local message in the state where a line containing only a dot is a
31109 terminator.
31110 .next
31111 If a bare CR is encountered within a header line, an extra space is added after
31112 the line terminator so as not to end the header line. The reasoning behind this
31113 is that bare CRs in header lines are most likely either to be mistakes, or
31114 people trying to play silly games.
31115 .next
31116 If the first header line received in a message ends with CRLF, a subsequent
31117 bare LF in a header line is treated in the same way as a bare CR in a header
31118 line.
31119 .endlist
31120
31121
31122
31123
31124
31125 .section "Unqualified addresses" "SECID218"
31126 .cindex "unqualified addresses"
31127 .cindex "address" "qualification"
31128 By default, Exim expects every envelope address it receives from an external
31129 host to be fully qualified. Unqualified addresses cause negative responses to
31130 SMTP commands. However, because SMTP is used as a means of transporting
31131 messages from MUAs running on personal workstations, there is sometimes a
31132 requirement to accept unqualified addresses from specific hosts or IP networks.
31133
31134 Exim has two options that separately control which hosts may send unqualified
31135 sender or recipient addresses in SMTP commands, namely
31136 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
31137 cases, if an unqualified address is accepted, it is qualified by adding the
31138 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
31139
31140 .oindex "&%qualify_domain%&"
31141 .oindex "&%qualify_recipient%&"
31142 Unqualified addresses in header lines are automatically qualified for messages
31143 that are locally originated, unless the &%-bnq%& option is given on the command
31144 line. For messages received over SMTP, unqualified addresses in header lines
31145 are qualified only if unqualified addresses are permitted in SMTP commands. In
31146 other words, such qualification is also controlled by
31147 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
31148
31149
31150
31151
31152 .section "The UUCP From line" "SECID219"
31153 .cindex "&""From""& line"
31154 .cindex "UUCP" "&""From""& line"
31155 .cindex "sender" "address"
31156 .oindex "&%uucp_from_pattern%&"
31157 .oindex "&%uucp_from_sender%&"
31158 .cindex "envelope sender"
31159 .cindex "Sendmail compatibility" "&""From""& line"
31160 Messages that have come from UUCP (and some other applications) often begin
31161 with a line containing the envelope sender and a timestamp, following the word
31162 &"From"&. Examples of two common formats are:
31163 .code
31164 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
31165 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
31166 .endd
31167 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
31168 Exim recognizes such lines at the start of messages that are submitted to it
31169 via the command line (that is, on the standard input). It does not recognize
31170 such lines in incoming SMTP messages, unless the sending host matches
31171 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
31172 and &%ignore_fromline_local%& is set. The recognition is controlled by a
31173 regular expression that is defined by the &%uucp_from_pattern%& option, whose
31174 default value matches the two common cases shown above and puts the address
31175 that follows &"From"& into &$1$&.
31176
31177 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
31178 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
31179 a trusted user, the message's sender address is constructed by expanding the
31180 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
31181 then parsed as an RFC 2822 address. If there is no domain, the local part is
31182 qualified with &%qualify_domain%& unless it is the empty string. However, if
31183 the command line &%-f%& option is used, it overrides the &"From"& line.
31184
31185 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
31186 sender address is not changed. This is also the case for incoming SMTP messages
31187 that are permitted to contain &"From"& lines.
31188
31189 Only one &"From"& line is recognized. If there is more than one, the second is
31190 treated as a data line that starts the body of the message, as it is not valid
31191 as a header line. This also happens if a &"From"& line is present in an
31192 incoming SMTP message from a source that is not permitted to send them.
31193
31194
31195
31196 .section "Resent- header lines" "SECID220"
31197 .cindex "&%Resent-%& header lines"
31198 RFC 2822 makes provision for sets of header lines starting with the string
31199 &`Resent-`& to be added to a message when it is resent by the original
31200 recipient to somebody else. These headers are &'Resent-Date:'&,
31201 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
31202 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
31203
31204 .blockquote
31205 &'Resent fields are strictly informational. They MUST NOT be used in the normal
31206 processing of replies or other such automatic actions on messages.'&
31207 .endblockquote
31208
31209 This leaves things a bit vague as far as other processing actions such as
31210 address rewriting are concerned. Exim treats &%Resent-%& header lines as
31211 follows:
31212
31213 .ilist
31214 A &'Resent-From:'& line that just contains the login id of the submitting user
31215 is automatically rewritten in the same way as &'From:'& (see below).
31216 .next
31217 If there's a rewriting rule for a particular header line, it is also applied to
31218 &%Resent-%& header lines of the same type. For example, a rule that rewrites
31219 &'From:'& also rewrites &'Resent-From:'&.
31220 .next
31221 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
31222 also removed.
31223 .next
31224 For a locally-submitted message,
31225 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
31226 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
31227 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
31228 included in log lines in this case.
31229 .next
31230 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
31231 &%Resent-%& header lines are present.
31232 .endlist
31233
31234
31235
31236
31237 .section "The Auto-Submitted: header line" "SECID221"
31238 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
31239 includes the header line:
31240 .code
31241 Auto-Submitted: auto-replied
31242 .endd
31243
31244 .section "The Bcc: header line" "SECID222"
31245 .cindex "&'Bcc:'& header line"
31246 If Exim is called with the &%-t%& option, to take recipient addresses from a
31247 message's header, it removes any &'Bcc:'& header line that may exist (after
31248 extracting its addresses). If &%-t%& is not present on the command line, any
31249 existing &'Bcc:'& is not removed.
31250
31251
31252 .section "The Date: header line" "SECID223"
31253 .cindex "&'Date:'& header line"
31254 If a locally-generated or submission-mode message has no &'Date:'& header line,
31255 Exim adds one, using the current date and time, unless the
31256 &%suppress_local_fixups%& control has been specified.
31257
31258 .section "The Delivery-date: header line" "SECID224"
31259 .cindex "&'Delivery-date:'& header line"
31260 .oindex "&%delivery_date_remove%&"
31261 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
31262 set. Exim can be configured to add them to the final delivery of messages. (See
31263 the generic &%delivery_date_add%& transport option.) They should not be present
31264 in messages in transit. If the &%delivery_date_remove%& configuration option is
31265 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
31266 messages.
31267
31268
31269 .section "The Envelope-to: header line" "SECID225"
31270 .cindex "&'Envelope-to:'& header line"
31271 .oindex "&%envelope_to_remove%&"
31272 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
31273 Exim can be configured to add them to the final delivery of messages. (See the
31274 generic &%envelope_to_add%& transport option.) They should not be present in
31275 messages in transit. If the &%envelope_to_remove%& configuration option is set
31276 (the default), Exim removes &'Envelope-to:'& header lines from incoming
31277 messages.
31278
31279
31280 .section "The From: header line" "SECTthefrohea"
31281 .cindex "&'From:'& header line"
31282 .cindex "Sendmail compatibility" "&""From""& line"
31283 .cindex "message" "submission"
31284 .cindex "submission mode"
31285 If a submission-mode message does not contain a &'From:'& header line, Exim
31286 adds one if either of the following conditions is true:
31287
31288 .ilist
31289 The envelope sender address is not empty (that is, this is not a bounce
31290 message). The added header line copies the envelope sender address.
31291 .next
31292 .vindex "&$authenticated_id$&"
31293 The SMTP session is authenticated and &$authenticated_id$& is not empty.
31294 .olist
31295 .vindex "&$qualify_domain$&"
31296 If no domain is specified by the submission control, the local part is
31297 &$authenticated_id$& and the domain is &$qualify_domain$&.
31298 .next
31299 If a non-empty domain is specified by the submission control, the local
31300 part is &$authenticated_id$&, and the domain is the specified domain.
31301 .next
31302 If an empty domain is specified by the submission control,
31303 &$authenticated_id$& is assumed to be the complete address.
31304 .endlist
31305 .endlist
31306
31307 A non-empty envelope sender takes precedence.
31308
31309 If a locally-generated incoming message does not contain a &'From:'& header
31310 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
31311 containing the sender's address. The calling user's login name and full name
31312 are used to construct the address, as described in section &<<SECTconstr>>&.
31313 They are obtained from the password data by calling &[getpwuid()]& (but see the
31314 &%unknown_login%& configuration option). The address is qualified with
31315 &%qualify_domain%&.
31316
31317 For compatibility with Sendmail, if an incoming, non-SMTP message has a
31318 &'From:'& header line containing just the unqualified login name of the calling
31319 user, this is replaced by an address containing the user's login name and full
31320 name as described in section &<<SECTconstr>>&.
31321
31322
31323 .section "The Message-ID: header line" "SECID226"
31324 .cindex "&'Message-ID:'& header line"
31325 .cindex "message" "submission"
31326 .oindex "&%message_id_header_text%&"
31327 If a locally-generated or submission-mode incoming message does not contain a
31328 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
31329 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
31330 to the message. If there are any &'Resent-:'& headers in the message, it
31331 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
31332 message id, preceded by the letter E to ensure it starts with a letter, and
31333 followed by @ and the primary host name. Additional information can be included
31334 in this header line by setting the &%message_id_header_text%& and/or
31335 &%message_id_header_domain%& options.
31336
31337
31338 .section "The Received: header line" "SECID227"
31339 .cindex "&'Received:'& header line"
31340 A &'Received:'& header line is added at the start of every message. The
31341 contents are defined by the &%received_header_text%& configuration option, and
31342 Exim automatically adds a semicolon and a timestamp to the configured string.
31343
31344 The &'Received:'& header is generated as soon as the message's header lines
31345 have been received. At this stage, the timestamp in the &'Received:'& header
31346 line is the time that the message started to be received. This is the value
31347 that is seen by the DATA ACL and by the &[local_scan()]& function.
31348
31349 Once a message is accepted, the timestamp in the &'Received:'& header line is
31350 changed to the time of acceptance, which is (apart from a small delay while the
31351 -H spool file is written) the earliest time at which delivery could start.
31352
31353
31354 .section "The References: header line" "SECID228"
31355 .cindex "&'References:'& header line"
31356 Messages created by the &(autoreply)& transport include a &'References:'&
31357 header line. This is constructed according to the rules that are described in
31358 section 3.64 of RFC 2822 (which states that replies should contain such a
31359 header line), and section 3.14 of RFC 3834 (which states that automatic
31360 responses are not different in this respect). However, because some mail
31361 processing software does not cope well with very long header lines, no more
31362 than 12 message IDs are copied from the &'References:'& header line in the
31363 incoming message. If there are more than 12, the first one and then the final
31364 11 are copied, before adding the message ID of the incoming message.
31365
31366
31367
31368 .section "The Return-path: header line" "SECID229"
31369 .cindex "&'Return-path:'& header line"
31370 .oindex "&%return_path_remove%&"
31371 &'Return-path:'& header lines are defined as something an MTA may insert when
31372 it does the final delivery of messages. (See the generic &%return_path_add%&
31373 transport option.) Therefore, they should not be present in messages in
31374 transit. If the &%return_path_remove%& configuration option is set (the
31375 default), Exim removes &'Return-path:'& header lines from incoming messages.
31376
31377
31378
31379 .section "The Sender: header line" "SECTthesenhea"
31380 .cindex "&'Sender:'& header line"
31381 .cindex "message" "submission"
31382 For a locally-originated message from an untrusted user, Exim may remove an
31383 existing &'Sender:'& header line, and it may add a new one. You can modify
31384 these actions by setting the &%local_sender_retain%& option true, the
31385 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31386 control setting.
31387
31388 When a local message is received from an untrusted user and
31389 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31390 control has not been set, a check is made to see if the address given in the
31391 &'From:'& header line is the correct (local) sender of the message. The address
31392 that is expected has the login name as the local part and the value of
31393 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31394 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31395 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31396 line is added to the message.
31397
31398 If you set &%local_from_check%& false, this checking does not occur. However,
31399 the removal of an existing &'Sender:'& line still happens, unless you also set
31400 &%local_sender_retain%& to be true. It is not possible to set both of these
31401 options true at the same time.
31402
31403 .cindex "submission mode"
31404 By default, no processing of &'Sender:'& header lines is done for messages
31405 received over TCP/IP or for messages submitted by trusted users. However, when
31406 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31407 not specified on the submission control, the following processing takes place:
31408
31409 .vindex "&$authenticated_id$&"
31410 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31411 authenticated, and &$authenticated_id$& is not empty, a sender address is
31412 created as follows:
31413
31414 .ilist
31415 .vindex "&$qualify_domain$&"
31416 If no domain is specified by the submission control, the local part is
31417 &$authenticated_id$& and the domain is &$qualify_domain$&.
31418 .next
31419 If a non-empty domain is specified by the submission control, the local part
31420 is &$authenticated_id$&, and the domain is the specified domain.
31421 .next
31422 If an empty domain is specified by the submission control,
31423 &$authenticated_id$& is assumed to be the complete address.
31424 .endlist
31425
31426 This address is compared with the address in the &'From:'& header line. If they
31427 are different, a &'Sender:'& header line containing the created address is
31428 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31429 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31430
31431 .cindex "return path" "created from &'Sender:'&"
31432 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31433 the message (the envelope sender address) is changed to be the same address,
31434 except in the case of submission mode when &%sender_retain%& is specified.
31435
31436
31437
31438 .section "Adding and removing header lines in routers and transports" &&&
31439          "SECTheadersaddrem"
31440 .cindex "header lines" "adding; in router or transport"
31441 .cindex "header lines" "removing; in router or transport"
31442 When a message is delivered, the addition and removal of header lines can be
31443 specified in a system filter, or on any of the routers and transports that
31444 process the message. Section &<<SECTaddremheasys>>& contains details about
31445 modifying headers in a system filter. Header lines can also be added in an ACL
31446 as a message is received (see section &<<SECTaddheadacl>>&).
31447
31448 In contrast to what happens in a system filter, header modifications that are
31449 specified on routers and transports apply only to the particular recipient
31450 addresses that are being processed by those routers and transports. These
31451 changes do not actually take place until a copy of the message is being
31452 transported. Therefore, they do not affect the basic set of header lines, and
31453 they do not affect the values of the variables that refer to header lines.
31454
31455 &*Note*&: In particular, this means that any expansions in the configuration of
31456 the transport cannot refer to the modified header lines, because such
31457 expansions all occur before the message is actually transported.
31458
31459 For both routers and transports, the result of expanding a &%headers_add%&
31460 option must be in the form of one or more RFC 2822 header lines, separated by
31461 newlines (coded as &"\n"&). For example:
31462 .code
31463 headers_add = X-added-header: added by $primary_hostname\n\
31464               X-added-second: another added header line
31465 .endd
31466 Exim does not check the syntax of these added header lines.
31467
31468 The result of expanding &%headers_remove%& must consist of a colon-separated
31469 list of header names. This is confusing, because header names themselves are
31470 often terminated by colons. In this case, the colons are the list separators,
31471 not part of the names. For example:
31472 .code
31473 headers_remove = return-receipt-to:acknowledge-to
31474 .endd
31475 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31476 is expanded at routing time, and then associated with all addresses that are
31477 accepted by that router, and also with any new addresses that it generates. If
31478 an address passes through several routers as a result of aliasing or
31479 forwarding, the changes are cumulative.
31480
31481 .oindex "&%unseen%&"
31482 However, this does not apply to multiple routers that result from the use of
31483 the &%unseen%& option. Any header modifications that were specified by the
31484 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31485
31486 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31487 settings cannot be delivered together in a batch, so a transport is always
31488 dealing with a set of addresses that have the same header-processing
31489 requirements.
31490
31491 The transport starts by writing the original set of header lines that arrived
31492 with the message, possibly modified by the system filter. As it writes out
31493 these lines, it consults the list of header names that were attached to the
31494 recipient address(es) by &%headers_remove%& options in routers, and it also
31495 consults the transport's own &%headers_remove%& option. Header lines whose
31496 names are on either of these lists are not written out. If there are multiple
31497 instances of any listed header, they are all skipped.
31498
31499 After the remaining original header lines have been written, new header
31500 lines that were specified by routers' &%headers_add%& options are written, in
31501 the order in which they were attached to the address. These are followed by any
31502 header lines specified by the transport's &%headers_add%& option.
31503
31504 This way of handling header line modifications in routers and transports has
31505 the following consequences:
31506
31507 .ilist
31508 The original set of header lines, possibly modified by the system filter,
31509 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31510 to it, at all times.
31511 .next
31512 Header lines that are added by a router's
31513 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31514 expansion syntax in subsequent routers or the transport.
31515 .next
31516 Conversely, header lines that are specified for removal by &%headers_remove%&
31517 in a router remain visible to subsequent routers and the transport.
31518 .next
31519 Headers added to an address by &%headers_add%& in a router cannot be removed by
31520 a later router or by a transport.
31521 .next
31522 An added header can refer to the contents of an original header that is to be
31523 removed, even it has the same name as the added header. For example:
31524 .code
31525 headers_remove = subject
31526 headers_add = Subject: new subject (was: $h_subject:)
31527 .endd
31528 .endlist
31529
31530 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31531 for a &(redirect)& router that has the &%one_time%& option set.
31532
31533
31534
31535
31536
31537 .section "Constructed addresses" "SECTconstr"
31538 .cindex "address" "constructed"
31539 .cindex "constructed address"
31540 When Exim constructs a sender address for a locally-generated message, it uses
31541 the form
31542 .display
31543 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31544 .endd
31545 For example:
31546 .code
31547 Zaphod Beeblebrox <zaphod@end.univ.example>
31548 .endd
31549 The user name is obtained from the &%-F%& command line option if set, or
31550 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31551 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31552 ampersand character, this is replaced by the login name with the first letter
31553 upper cased, as is conventional in a number of operating systems. See the
31554 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31555 The &%unknown_username%& option can be used to specify user names in cases when
31556 there is no password file entry.
31557
31558 .cindex "RFC 2047"
31559 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31560 parts of it if necessary. In addition, if it contains any non-printing
31561 characters, it is encoded as described in RFC 2047, which defines a way of
31562 including non-ASCII characters in header lines. The value of the
31563 &%headers_charset%& option specifies the name of the encoding that is used (the
31564 characters are assumed to be in this encoding). The setting of
31565 &%print_topbitchars%& controls whether characters with the top bit set (that
31566 is, with codes greater than 127) count as printing characters or not.
31567
31568
31569
31570 .section "Case of local parts" "SECID230"
31571 .cindex "case of local parts"
31572 .cindex "local part" "case of"
31573 RFC 2822 states that the case of letters in the local parts of addresses cannot
31574 be assumed to be non-significant. Exim preserves the case of local parts of
31575 addresses, but by default it uses a lower-cased form when it is routing,
31576 because on most Unix systems, usernames are in lower case and case-insensitive
31577 routing is required. However, any particular router can be made to use the
31578 original case for local parts by setting the &%caseful_local_part%& generic
31579 router option.
31580
31581 .cindex "mixed-case login names"
31582 If you must have mixed-case user names on your system, the best way to proceed,
31583 assuming you want case-independent handling of incoming email, is to set up
31584 your first router to convert incoming local parts in your domains to the
31585 correct case by means of a file lookup. For example:
31586 .code
31587 correct_case:
31588   driver = redirect
31589   domains = +local_domains
31590   data = ${lookup{$local_part}cdb\
31591               {/etc/usercased.cdb}{$value}fail}\
31592               @$domain
31593 .endd
31594 For this router, the local part is forced to lower case by the default action
31595 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31596 up a new local part in the correct case. If you then set &%caseful_local_part%&
31597 on any subsequent routers which process your domains, they will operate on
31598 local parts with the correct case in a case-sensitive manner.
31599
31600
31601
31602 .section "Dots in local parts" "SECID231"
31603 .cindex "dot" "in local part"
31604 .cindex "local part" "dots in"
31605 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31606 part may not begin or end with a dot, nor have two consecutive dots in the
31607 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31608 empty components for compatibility.
31609
31610
31611
31612 .section "Rewriting addresses" "SECID232"
31613 .cindex "rewriting" "addresses"
31614 Rewriting of sender and recipient addresses, and addresses in headers, can
31615 happen automatically, or as the result of configuration options, as described
31616 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31617 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31618
31619 Automatic rewriting includes qualification, as mentioned above. The other case
31620 in which it can happen is when an incomplete non-local domain is given. The
31621 routing process may cause this to be expanded into the full domain name. For
31622 example, a header such as
31623 .code
31624 To: hare@teaparty
31625 .endd
31626 might get rewritten as
31627 .code
31628 To: hare@teaparty.wonderland.fict.example
31629 .endd
31630 Rewriting as a result of routing is the one kind of message processing that
31631 does not happen at input time, as it cannot be done until the address has
31632 been routed.
31633
31634 Strictly, one should not do &'any'& deliveries of a message until all its
31635 addresses have been routed, in case any of the headers get changed as a
31636 result of routing. However, doing this in practice would hold up many
31637 deliveries for unreasonable amounts of time, just because one address could not
31638 immediately be routed. Exim therefore does not delay other deliveries when
31639 routing of one or more addresses is deferred.
31640 .ecindex IIDmesproc
31641
31642
31643
31644 . ////////////////////////////////////////////////////////////////////////////
31645 . ////////////////////////////////////////////////////////////////////////////
31646
31647 .chapter "SMTP processing" "CHAPSMTP"
31648 .scindex IIDsmtpproc1 "SMTP" "processing details"
31649 .scindex IIDsmtpproc2 "LMTP" "processing details"
31650 Exim supports a number of different ways of using the SMTP protocol, and its
31651 LMTP variant, which is an interactive protocol for transferring messages into a
31652 closed mail store application. This chapter contains details of how SMTP is
31653 processed. For incoming mail, the following are available:
31654
31655 .ilist
31656 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31657 .next
31658 SMTP over the standard input and output (the &%-bs%& option);
31659 .next
31660 Batched SMTP on the standard input (the &%-bS%& option).
31661 .endlist
31662
31663 For mail delivery, the following are available:
31664
31665 .ilist
31666 SMTP over TCP/IP (the &(smtp)& transport);
31667 .next
31668 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31669 &"lmtp"&);
31670 .next
31671 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31672 transport);
31673 .next
31674 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31675 the &%use_bsmtp%& option set).
31676 .endlist
31677
31678 &'Batched SMTP'& is the name for a process in which batches of messages are
31679 stored in or read from files (or pipes), in a format in which SMTP commands are
31680 used to contain the envelope information.
31681
31682
31683
31684 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
31685 .cindex "SMTP" "outgoing over TCP/IP"
31686 .cindex "outgoing SMTP over TCP/IP"
31687 .cindex "LMTP" "over TCP/IP"
31688 .cindex "outgoing LMTP over TCP/IP"
31689 .cindex "EHLO"
31690 .cindex "HELO"
31691 .cindex "SIZE option on MAIL command"
31692 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
31693 The &%protocol%& option selects which protocol is to be used, but the actual
31694 processing is the same in both cases.
31695
31696 If, in response to its EHLO command, Exim is told that the SIZE
31697 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
31698 command. The value of <&'n'&> is the message size plus the value of the
31699 &%size_addition%& option (default 1024) to allow for additions to the message
31700 such as per-transport header lines, or changes made in a
31701 .cindex "transport" "filter"
31702 .cindex "filter" "transport filter"
31703 transport filter. If &%size_addition%& is set negative, the use of SIZE is
31704 suppressed.
31705
31706 If the remote server advertises support for PIPELINING, Exim uses the
31707 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
31708 required for the transaction.
31709
31710 If the remote server advertises support for the STARTTLS command, and Exim
31711 was built to support TLS encryption, it tries to start a TLS session unless the
31712 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
31713 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
31714 is called for verification.
31715
31716 If the remote server advertises support for the AUTH command, Exim scans
31717 the authenticators configuration for any suitable client settings, as described
31718 in chapter &<<CHAPSMTPAUTH>>&.
31719
31720 .cindex "carriage return"
31721 .cindex "linefeed"
31722 Responses from the remote host are supposed to be terminated by CR followed by
31723 LF. However, there are known to be hosts that do not send CR characters, so in
31724 order to be able to interwork with such hosts, Exim treats LF on its own as a
31725 line terminator.
31726
31727 If a message contains a number of different addresses, all those with the same
31728 characteristics (for example, the same envelope sender) that resolve to the
31729 same set of hosts, in the same order, are sent in a single SMTP transaction,
31730 even if they are for different domains, unless there are more than the setting
31731 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
31732 they are split into groups containing no more than &%max_rcpt%&s addresses
31733 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
31734 in parallel sessions. The order of hosts with identical MX values is not
31735 significant when checking whether addresses can be batched in this way.
31736
31737 When the &(smtp)& transport suffers a temporary failure that is not
31738 message-related, Exim updates its transport-specific database, which contains
31739 records indexed by host name that remember which messages are waiting for each
31740 particular host. It also updates the retry database with new retry times.
31741
31742 .cindex "hints database" "retry keys"
31743 Exim's retry hints are based on host name plus IP address, so if one address of
31744 a multi-homed host is broken, it will soon be skipped most of the time.
31745 See the next section for more detail about error handling.
31746
31747 .cindex "SMTP" "passed connection"
31748 .cindex "SMTP" "batching over TCP/IP"
31749 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
31750 looks in the hints database for the transport to see if there are any queued
31751 messages waiting for the host to which it is connected. If it finds one, it
31752 creates a new Exim process using the &%-MC%& option (which can only be used by
31753 a process running as root or the Exim user) and passes the TCP/IP socket to it
31754 so that it can deliver another message using the same socket. The new process
31755 does only those deliveries that are routed to the connected host, and may in
31756 turn pass the socket on to a third process, and so on.
31757
31758 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
31759 limit the number of messages sent down a single TCP/IP connection.
31760
31761 .cindex "asterisk" "after IP address"
31762 The second and subsequent messages delivered down an existing connection are
31763 identified in the main log by the addition of an asterisk after the closing
31764 square bracket of the IP address.
31765
31766
31767
31768
31769 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
31770 .cindex "error" "in outgoing SMTP"
31771 .cindex "SMTP" "errors in outgoing"
31772 .cindex "host" "error"
31773 Three different kinds of error are recognized for outgoing SMTP: host errors,
31774 message errors, and recipient errors.
31775
31776 .vlist
31777 .vitem "&*Host errors*&"
31778 A host error is not associated with a particular message or with a
31779 particular recipient of a message. The host errors are:
31780
31781 .ilist
31782 Connection refused or timed out,
31783 .next
31784 Any error response code on connection,
31785 .next
31786 Any error response code to EHLO or HELO,
31787 .next
31788 Loss of connection at any time, except after &"."&,
31789 .next
31790 I/O errors at any time,
31791 .next
31792 Timeouts during the session, other than in response to MAIL, RCPT or
31793 the &"."& at the end of the data.
31794 .endlist ilist
31795
31796 For a host error, a permanent error response on connection, or in response to
31797 EHLO, causes all addresses routed to the host to be failed. Any other host
31798 error causes all addresses to be deferred, and retry data to be created for the
31799 host. It is not tried again, for any message, until its retry time arrives. If
31800 the current set of addresses are not all delivered in this run (to some
31801 alternative host), the message is added to the list of those waiting for this
31802 host, so if it is still undelivered when a subsequent successful delivery is
31803 made to the host, it will be sent down the same SMTP connection.
31804
31805 .vitem "&*Message errors*&"
31806 .cindex "message" "error"
31807 A message error is associated with a particular message when sent to a
31808 particular host, but not with a particular recipient of the message. The
31809 message errors are:
31810
31811 .ilist
31812 Any error response code to MAIL, DATA, or the &"."& that terminates
31813 the data,
31814 .next
31815 Timeout after MAIL,
31816 .next
31817 Timeout or loss of connection after the &"."& that terminates the data. A
31818 timeout after the DATA command itself is treated as a host error, as is loss of
31819 connection at any other time.
31820 .endlist ilist
31821
31822 For a message error, a permanent error response (5&'xx'&) causes all addresses
31823 to be failed, and a delivery error report to be returned to the sender. A
31824 temporary error response (4&'xx'&), or one of the timeouts, causes all
31825 addresses to be deferred. Retry data is not created for the host, but instead,
31826 a retry record for the combination of host plus message id is created. The
31827 message is not added to the list of those waiting for this host. This ensures
31828 that the failing message will not be sent to this host again until the retry
31829 time arrives. However, other messages that are routed to the host are not
31830 affected, so if it is some property of the message that is causing the error,
31831 it will not stop the delivery of other mail.
31832
31833 If the remote host specified support for the SIZE parameter in its response
31834 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
31835 over-large message will cause a message error because the error arrives as a
31836 response to MAIL.
31837
31838 .vitem "&*Recipient errors*&"
31839 .cindex "recipient" "error"
31840 A recipient error is associated with a particular recipient of a message. The
31841 recipient errors are:
31842
31843 .ilist
31844 Any error response to RCPT,
31845 .next
31846 Timeout after RCPT.
31847 .endlist
31848
31849 For a recipient error, a permanent error response (5&'xx'&) causes the
31850 recipient address to be failed, and a bounce message to be returned to the
31851 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
31852 address to be deferred, and routing retry data to be created for it. This is
31853 used to delay processing of the address in subsequent queue runs, until its
31854 routing retry time arrives. This applies to all messages, but because it
31855 operates only in queue runs, one attempt will be made to deliver a new message
31856 to the failing address before the delay starts to operate. This ensures that,
31857 if the failure is really related to the message rather than the recipient
31858 (&"message too big for this recipient"& is a possible example), other messages
31859 have a chance of getting delivered. If a delivery to the address does succeed,
31860 the retry information gets cleared, so all stuck messages get tried again, and
31861 the retry clock is reset.
31862
31863 The message is not added to the list of those waiting for this host. Use of the
31864 host for other messages is unaffected, and except in the case of a timeout,
31865 other recipients are processed independently, and may be successfully delivered
31866 in the current SMTP session. After a timeout it is of course impossible to
31867 proceed with the session, so all addresses get deferred. However, those other
31868 than the one that failed do not suffer any subsequent retry delays. Therefore,
31869 if one recipient is causing trouble, the others have a chance of getting
31870 through when a subsequent delivery attempt occurs before the failing
31871 recipient's retry time.
31872 .endlist
31873
31874 In all cases, if there are other hosts (or IP addresses) available for the
31875 current set of addresses (for example, from multiple MX records), they are
31876 tried in this run for any undelivered addresses, subject of course to their
31877 own retry data. In other words, recipient error retry data does not take effect
31878 until the next delivery attempt.
31879
31880 Some hosts have been observed to give temporary error responses to every
31881 MAIL command at certain times (&"insufficient space"& has been seen). It
31882 would be nice if such circumstances could be recognized, and defer data for the
31883 host itself created, but this is not possible within the current Exim design.
31884 What actually happens is that retry data for every (host, message) combination
31885 is created.
31886
31887 The reason that timeouts after MAIL and RCPT are treated specially is that
31888 these can sometimes arise as a result of the remote host's verification
31889 procedures. Exim makes this assumption, and treats them as if a temporary error
31890 response had been received. A timeout after &"."& is treated specially because
31891 it is known that some broken implementations fail to recognize the end of the
31892 message if the last character of the last line is a binary zero. Thus, it is
31893 helpful to treat this case as a message error.
31894
31895 Timeouts at other times are treated as host errors, assuming a problem with the
31896 host, or the connection to it. If a timeout after MAIL, RCPT,
31897 or &"."& is really a connection problem, the assumption is that at the next try
31898 the timeout is likely to occur at some other point in the dialogue, causing it
31899 then to be treated as a host error.
31900
31901 There is experimental evidence that some MTAs drop the connection after the
31902 terminating &"."& if they do not like the contents of the message for some
31903 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
31904 should be given. That is why Exim treats this case as a message rather than a
31905 host error, in order not to delay other messages to the same host.
31906
31907
31908
31909
31910 .section "Incoming SMTP messages over TCP/IP" "SECID233"
31911 .cindex "SMTP" "incoming over TCP/IP"
31912 .cindex "incoming SMTP over TCP/IP"
31913 .cindex "inetd"
31914 .cindex "daemon"
31915 Incoming SMTP messages can be accepted in one of two ways: by running a
31916 listening daemon, or by using &'inetd'&. In the latter case, the entry in
31917 &_/etc/inetd.conf_& should be like this:
31918 .code
31919 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
31920 .endd
31921 Exim distinguishes between this case and the case of a locally running user
31922 agent using the &%-bs%& option by checking whether or not the standard input is
31923 a socket. When it is, either the port must be privileged (less than 1024), or
31924 the caller must be root or the Exim user. If any other user passes a socket
31925 with an unprivileged port number, Exim prints a message on the standard error
31926 stream and exits with an error code.
31927
31928 By default, Exim does not make a log entry when a remote host connects or
31929 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
31930 unexpected. It can be made to write such log entries by setting the
31931 &%smtp_connection%& log selector.
31932
31933 .cindex "carriage return"
31934 .cindex "linefeed"
31935 Commands from the remote host are supposed to be terminated by CR followed by
31936 LF. However, there are known to be hosts that do not send CR characters. In
31937 order to be able to interwork with such hosts, Exim treats LF on its own as a
31938 line terminator.
31939 Furthermore, because common code is used for receiving messages from all
31940 sources, a CR on its own is also interpreted as a line terminator. However, the
31941 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
31942
31943 .cindex "EHLO" "invalid data"
31944 .cindex "HELO" "invalid data"
31945 One area that sometimes gives rise to problems concerns the EHLO or
31946 HELO commands. Some clients send syntactically invalid versions of these
31947 commands, which Exim rejects by default. (This is nothing to do with verifying
31948 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
31949 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
31950 match the broken hosts that send invalid commands.
31951
31952 .cindex "SIZE option on MAIL command"
31953 .cindex "MAIL" "SIZE option"
31954 The amount of disk space available is checked whenever SIZE is received on
31955 a MAIL command, independently of whether &%message_size_limit%& or
31956 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
31957 false. A temporary error is given if there is not enough space. If
31958 &%check_spool_space%& is set, the check is for that amount of space plus the
31959 value given with SIZE, that is, it checks that the addition of the incoming
31960 message will not reduce the space below the threshold.
31961
31962 When a message is successfully received, Exim includes the local message id in
31963 its response to the final &"."& that terminates the data. If the remote host
31964 logs this text it can help with tracing what has happened to a message.
31965
31966 The Exim daemon can limit the number of simultaneous incoming connections it is
31967 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
31968 number of simultaneous incoming connections from a single remote host (see the
31969 &%smtp_accept_max_per_host%& option). Additional connection attempts are
31970 rejected using the SMTP temporary error code 421.
31971
31972 The Exim daemon does not rely on the SIGCHLD signal to detect when a
31973 subprocess has finished, as this can get lost at busy times. Instead, it looks
31974 for completed subprocesses every time it wakes up. Provided there are other
31975 things happening (new incoming calls, starts of queue runs), completed
31976 processes will be noticed and tidied away. On very quiet systems you may
31977 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
31978 it will be noticed when the daemon next wakes up.
31979
31980 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
31981 and can also be set up to reject SMTP calls from non-reserved hosts at times of
31982 high system load &-- for details see the &%smtp_accept_reserve%&,
31983 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
31984 applies in both the daemon and &'inetd'& cases.
31985
31986 Exim normally starts a delivery process for each message received, though this
31987 can be varied by means of the &%-odq%& command line option and the
31988 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
31989 number of simultaneously running delivery processes started in this way from
31990 SMTP input can be limited by the &%smtp_accept_queue%& and
31991 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
31992 subsequently received messages are just put on the input queue without starting
31993 a delivery process.
31994
31995 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
31996 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
31997 started up from the &'inetd'& daemon, because in that case each connection is
31998 handled by an entirely independent Exim process. Control by load average is,
31999 however, available with &'inetd'&.
32000
32001 Exim can be configured to verify addresses in incoming SMTP commands as they
32002 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
32003 to rewrite addresses at this time &-- before any syntax checking is done. See
32004 section &<<SECTrewriteS>>&.
32005
32006 Exim can also be configured to limit the rate at which a client host submits
32007 MAIL and RCPT commands in a single SMTP session. See the
32008 &%smtp_ratelimit_hosts%& option.
32009
32010
32011
32012 .section "Unrecognized SMTP commands" "SECID234"
32013 .cindex "SMTP" "unrecognized commands"
32014 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
32015 commands during a single SMTP connection, it drops the connection after sending
32016 the error response to the last command. The default value for
32017 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
32018 abuse that subvert web servers into making connections to SMTP ports; in these
32019 circumstances, a number of non-SMTP lines are sent first.
32020
32021
32022 .section "Syntax and protocol errors in SMTP commands" "SECID235"
32023 .cindex "SMTP" "syntax errors"
32024 .cindex "SMTP" "protocol errors"
32025 A syntax error is detected if an SMTP command is recognized, but there is
32026 something syntactically wrong with its data, for example, a malformed email
32027 address in a RCPT command. Protocol errors include invalid command
32028 sequencing such as RCPT before MAIL. If Exim receives more than
32029 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
32030 drops the connection after sending the error response to the last command. The
32031 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
32032 broken clients that loop sending bad commands (yes, it has been seen).
32033
32034
32035
32036 .section "Use of non-mail SMTP commands" "SECID236"
32037 .cindex "SMTP" "non-mail commands"
32038 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
32039 DATA. Exim counts such commands, and drops the connection if there are too
32040 many of them in a single SMTP session. This action catches some
32041 denial-of-service attempts and things like repeated failing AUTHs, or a mad
32042 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
32043 defines what &"too many"& means. Its default value is 10.
32044
32045 When a new message is expected, one occurrence of RSET is not counted. This
32046 allows a client to send one RSET between messages (this is not necessary,
32047 but some clients do it). Exim also allows one uncounted occurrence of HELO
32048 or EHLO, and one occurrence of STARTTLS between messages. After
32049 starting up a TLS session, another EHLO is expected, and so it too is not
32050 counted.
32051
32052 The first occurrence of AUTH in a connection, or immediately following
32053 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
32054 RCPT, DATA, and QUIT are counted.
32055
32056 You can control which hosts are subject to the limit set by
32057 &%smtp_accept_max_nonmail%& by setting
32058 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
32059 the limit apply to all hosts. This option means that you can exclude any
32060 specific badly-behaved hosts that you have to live with.
32061
32062
32063
32064
32065 .section "The VRFY and EXPN commands" "SECID237"
32066 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
32067 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
32068 appropriate) in order to decide whether the command should be accepted or not.
32069 If no ACL is defined, the command is rejected.
32070
32071 .cindex "VRFY" "processing"
32072 When VRFY is accepted, it runs exactly the same code as when Exim is
32073 called with the &%-bv%& option.
32074
32075 .cindex "EXPN" "processing"
32076 When EXPN is accepted, a single-level expansion of the address is done.
32077 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
32078 than a verification (the &%-bv%& option). If an unqualified local part is given
32079 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
32080 of VRFY and EXPN commands are logged on the main and reject logs, and
32081 VRFY verification failures are logged on the main log for consistency with
32082 RCPT failures.
32083
32084
32085
32086 .section "The ETRN command" "SECTETRN"
32087 .cindex "ETRN" "processing"
32088 RFC 1985 describes an SMTP command called ETRN that is designed to
32089 overcome the security problems of the TURN command (which has fallen into
32090 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
32091 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
32092 should be accepted or not. If no ACL is defined, the command is rejected.
32093
32094 The ETRN command is concerned with &"releasing"& messages that are awaiting
32095 delivery to certain hosts. As Exim does not organize its message queue by host,
32096 the only form of ETRN that is supported by default is the one where the
32097 text starts with the &"#"& prefix, in which case the remainder of the text is
32098 specific to the SMTP server. A valid ETRN command causes a run of Exim with
32099 the &%-R%& option to happen, with the remainder of the ETRN text as its
32100 argument. For example,
32101 .code
32102 ETRN #brigadoon
32103 .endd
32104 runs the command
32105 .code
32106 exim -R brigadoon
32107 .endd
32108 which causes a delivery attempt on all messages with undelivered addresses
32109 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
32110 default), Exim prevents the simultaneous execution of more than one queue run
32111 for the same argument string as a result of an ETRN command. This stops
32112 a misbehaving client from starting more than one queue runner at once.
32113
32114 .cindex "hints database" "ETRN serialization"
32115 Exim implements the serialization by means of a hints database in which a
32116 record is written whenever a process is started by ETRN, and deleted when
32117 the process completes. However, Exim does not keep the SMTP session waiting for
32118 the ETRN process to complete. Once ETRN is accepted, the client is sent
32119 a &"success"& return code. Obviously there is scope for hints records to get
32120 left lying around if there is a system or program crash. To guard against this,
32121 Exim ignores any records that are more than six hours old.
32122
32123 .oindex "&%smtp_etrn_command%&"
32124 For more control over what ETRN does, the &%smtp_etrn_command%& option can
32125 used. This specifies a command that is run whenever ETRN is received,
32126 whatever the form of its argument. For
32127 example:
32128 .code
32129 smtp_etrn_command = /etc/etrn_command $domain \
32130                     $sender_host_address
32131 .endd
32132 .vindex "&$domain$&"
32133 The string is split up into arguments which are independently expanded. The
32134 expansion variable &$domain$& is set to the argument of the ETRN command,
32135 and no syntax checking is done on the contents of this argument. Exim does not
32136 wait for the command to complete, so its status code is not checked. Exim runs
32137 under its own uid and gid when receiving incoming SMTP, so it is not possible
32138 for it to change them before running the command.
32139
32140
32141
32142 .section "Incoming local SMTP" "SECID238"
32143 .cindex "SMTP" "local incoming"
32144 Some user agents use SMTP to pass messages to their local MTA using the
32145 standard input and output, as opposed to passing the envelope on the command
32146 line and writing the message to the standard input. This is supported by the
32147 &%-bs%& option. This form of SMTP is handled in the same way as incoming
32148 messages over TCP/IP (including the use of ACLs), except that the envelope
32149 sender given in a MAIL command is ignored unless the caller is trusted. In
32150 an ACL you can detect this form of SMTP input by testing for an empty host
32151 identification. It is common to have this as the first line in the ACL that
32152 runs for RCPT commands:
32153 .code
32154 accept hosts = :
32155 .endd
32156 This accepts SMTP messages from local processes without doing any other tests.
32157
32158
32159
32160 .section "Outgoing batched SMTP" "SECTbatchSMTP"
32161 .cindex "SMTP" "batched outgoing"
32162 .cindex "batched SMTP output"
32163 Both the &(appendfile)& and &(pipe)& transports can be used for handling
32164 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
32165 be output in BSMTP format. No SMTP responses are possible for this form of
32166 delivery. All it is doing is using SMTP commands as a way of transmitting the
32167 envelope along with the message.
32168
32169 The message is written to the file or pipe preceded by the SMTP commands
32170 MAIL and RCPT, and followed by a line containing a single dot. Lines in
32171 the message that start with a dot have an extra dot added. The SMTP command
32172 HELO is not normally used. If it is required, the &%message_prefix%& option
32173 can be used to specify it.
32174
32175 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
32176 one recipient address at a time by default. However, you can arrange for them
32177 to handle several addresses at once by setting the &%batch_max%& option. When
32178 this is done for BSMTP, messages may contain multiple RCPT commands. See
32179 chapter &<<CHAPbatching>>& for more details.
32180
32181 .vindex "&$host$&"
32182 When one or more addresses are routed to a BSMTP transport by a router that
32183 sets up a host list, the name of the first host on the list is available to the
32184 transport in the variable &$host$&. Here is an example of such a transport and
32185 router:
32186 .code
32187 begin routers
32188 route_append:
32189   driver = manualroute
32190   transport = smtp_appendfile
32191   route_list = domain.example  batch.host.example
32192
32193 begin transports
32194 smtp_appendfile:
32195   driver = appendfile
32196   directory = /var/bsmtp/$host
32197   batch_max = 1000
32198   use_bsmtp
32199   user = exim
32200 .endd
32201 This causes messages addressed to &'domain.example'& to be written in BSMTP
32202 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
32203 message (unless there are more than 1000 recipients).
32204
32205
32206
32207 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
32208 .cindex "SMTP" "batched incoming"
32209 .cindex "batched SMTP input"
32210 The &%-bS%& command line option causes Exim to accept one or more messages by
32211 reading SMTP on the standard input, but to generate no responses. If the caller
32212 is trusted, the senders in the MAIL commands are believed; otherwise the
32213 sender is always the caller of Exim. Unqualified senders and receivers are not
32214 rejected (there seems little point) but instead just get qualified. HELO
32215 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
32216 as NOOP; QUIT quits.
32217
32218 Minimal policy checking is done for BSMTP input. Only the non-SMTP
32219 ACL is run in the same way as for non-SMTP local input.
32220
32221 If an error is detected while reading a message, including a missing &"."& at
32222 the end, Exim gives up immediately. It writes details of the error to the
32223 standard output in a stylized way that the calling program should be able to
32224 make some use of automatically, for example:
32225 .code
32226 554 Unexpected end of file
32227 Transaction started in line 10
32228 Error detected in line 14
32229 .endd
32230 It writes a more verbose version, for human consumption, to the standard error
32231 file, for example:
32232 .code
32233 An error was detected while processing a file of BSMTP input.
32234 The error message was:
32235
32236 501 '>' missing at end of address
32237
32238 The SMTP transaction started in line 10.
32239 The error was detected in line 12.
32240 The SMTP command at fault was:
32241
32242 rcpt to:<malformed@in.com.plete
32243
32244 1 previous message was successfully processed.
32245 The rest of the batch was abandoned.
32246 .endd
32247 The return code from Exim is zero only if there were no errors. It is 1 if some
32248 messages were accepted before an error was detected, and 2 if no messages were
32249 accepted.
32250 .ecindex IIDsmtpproc1
32251 .ecindex IIDsmtpproc2
32252
32253
32254
32255 . ////////////////////////////////////////////////////////////////////////////
32256 . ////////////////////////////////////////////////////////////////////////////
32257
32258 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
32259          "Customizing messages"
32260 When a message fails to be delivered, or remains on the queue for more than a
32261 configured amount of time, Exim sends a message to the original sender, or
32262 to an alternative configured address. The text of these messages is built into
32263 the code of Exim, but it is possible to change it, either by adding a single
32264 string, or by replacing each of the paragraphs by text supplied in a file.
32265
32266 The &'From:'& and &'To:'& header lines are automatically generated; you can
32267 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
32268 option. Exim also adds the line
32269 .code
32270 Auto-Submitted: auto-generated
32271 .endd
32272 to all warning and bounce messages,
32273
32274
32275 .section "Customizing bounce messages" "SECID239"
32276 .cindex "customizing" "bounce message"
32277 .cindex "bounce message" "customizing"
32278 If &%bounce_message_text%& is set, its contents are included in the default
32279 message immediately after &"This message was created automatically by mail
32280 delivery software."& The string is not expanded. It is not used if
32281 &%bounce_message_file%& is set.
32282
32283 When &%bounce_message_file%& is set, it must point to a template file for
32284 constructing error messages. The file consists of a series of text items,
32285 separated by lines consisting of exactly four asterisks. If the file cannot be
32286 opened, default text is used and a message is written to the main and panic
32287 logs. If any text item in the file is empty, default text is used for that
32288 item.
32289
32290 .vindex "&$bounce_recipient$&"
32291 .vindex "&$bounce_return_size_limit$&"
32292 Each item of text that is read from the file is expanded, and there are two
32293 expansion variables which can be of use here: &$bounce_recipient$& is set to
32294 the recipient of an error message while it is being created, and
32295 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
32296 option, rounded to a whole number.
32297
32298 The items must appear in the file in the following order:
32299
32300 .ilist
32301 The first item is included in the headers, and should include at least a
32302 &'Subject:'& header. Exim does not check the syntax of these headers.
32303 .next
32304 The second item forms the start of the error message. After it, Exim lists the
32305 failing addresses with their error messages.
32306 .next
32307 The third item is used to introduce any text from pipe transports that is to be
32308 returned to the sender. It is omitted if there is no such text.
32309 .next
32310 The fourth item is used to introduce the copy of the message that is returned
32311 as part of the error report.
32312 .next
32313 The fifth item is added after the fourth one if the returned message is
32314 truncated because it is bigger than &%return_size_limit%&.
32315 .next
32316 The sixth item is added after the copy of the original message.
32317 .endlist
32318
32319 The default state (&%bounce_message_file%& unset) is equivalent to the
32320 following file, in which the sixth item is empty. The &'Subject:'& and some
32321 other lines have been split in order to fit them on the page:
32322 .code
32323 Subject: Mail delivery failed
32324   ${if eq{$sender_address}{$bounce_recipient}
32325   {: returning message to sender}}
32326 ****
32327 This message was created automatically by mail delivery software.
32328
32329 A message ${if eq{$sender_address}{$bounce_recipient}
32330   {that you sent }{sent by
32331
32332 <$sender_address>
32333
32334 }}could not be delivered to all of its recipients.
32335 This is a permanent error. The following address(es) failed:
32336 ****
32337 The following text was generated during the delivery attempt(s):
32338 ****
32339 ------ This is a copy of the message, including all the headers.
32340   ------
32341 ****
32342 ------ The body of the message is $message_size characters long;
32343   only the first
32344 ------ $bounce_return_size_limit or so are included here.
32345 ****
32346 .endd
32347 .section "Customizing warning messages" "SECTcustwarn"
32348 .cindex "customizing" "warning message"
32349 .cindex "warning of delay" "customizing the message"
32350 The option &%warn_message_file%& can be pointed at a template file for use when
32351 warnings about message delays are created. In this case there are only three
32352 text sections:
32353
32354 .ilist
32355 The first item is included in the headers, and should include at least a
32356 &'Subject:'& header. Exim does not check the syntax of these headers.
32357 .next
32358 The second item forms the start of the warning message. After it, Exim lists
32359 the delayed addresses.
32360 .next
32361 The third item then ends the message.
32362 .endlist
32363
32364 The default state is equivalent to the following file, except that some lines
32365 have been split here, in order to fit them on the page:
32366 .code
32367 Subject: Warning: message $message_exim_id delayed
32368   $warn_message_delay
32369 ****
32370 This message was created automatically by mail delivery software.
32371
32372 A message ${if eq{$sender_address}{$warn_message_recipients}
32373 {that you sent }{sent by
32374
32375 <$sender_address>
32376
32377 }}has not been delivered to all of its recipients after
32378 more than $warn_message_delay on the queue on $primary_hostname.
32379
32380 The message identifier is:     $message_exim_id
32381 The subject of the message is: $h_subject
32382 The date of the message is:    $h_date
32383
32384 The following address(es) have not yet been delivered:
32385 ****
32386 No action is required on your part. Delivery attempts will
32387 continue for some time, and this warning may be repeated at
32388 intervals if the message remains undelivered. Eventually the
32389 mail delivery software will give up, and when that happens,
32390 the message will be returned to you.
32391 .endd
32392 .vindex "&$warn_message_delay$&"
32393 .vindex "&$warn_message_recipients$&"
32394 However, in the default state the subject and date lines are omitted if no
32395 appropriate headers exist. During the expansion of this file,
32396 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32397 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32398 of recipients for the warning message. There may be more than one if there are
32399 multiple addresses with different &%errors_to%& settings on the routers that
32400 handled them.
32401
32402
32403
32404
32405 . ////////////////////////////////////////////////////////////////////////////
32406 . ////////////////////////////////////////////////////////////////////////////
32407
32408 .chapter "Some common configuration settings" "CHAPcomconreq"
32409 This chapter discusses some configuration settings that seem to be fairly
32410 common. More examples and discussion can be found in the Exim book.
32411
32412
32413
32414 .section "Sending mail to a smart host" "SECID240"
32415 .cindex "smart host" "example router"
32416 If you want to send all mail for non-local domains to a &"smart host"&, you
32417 should replace the default &(dnslookup)& router with a router which does the
32418 routing explicitly:
32419 .code
32420 send_to_smart_host:
32421   driver = manualroute
32422   route_list = !+local_domains smart.host.name
32423   transport = remote_smtp
32424 .endd
32425 You can use the smart host's IP address instead of the name if you wish.
32426 If you are using Exim only to submit messages to a smart host, and not for
32427 receiving incoming messages, you can arrange for it to do the submission
32428 synchronously by setting the &%mua_wrapper%& option (see chapter
32429 &<<CHAPnonqueueing>>&).
32430
32431
32432
32433
32434 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32435 .cindex "mailing lists"
32436 Exim can be used to run simple mailing lists, but for large and/or complicated
32437 requirements, the use of additional specialized mailing list software such as
32438 Majordomo or Mailman is recommended.
32439
32440 The &(redirect)& router can be used to handle mailing lists where each list
32441 is maintained in a separate file, which can therefore be managed by an
32442 independent manager. The &%domains%& router option can be used to run these
32443 lists in a separate domain from normal mail. For example:
32444 .code
32445 lists:
32446   driver = redirect
32447   domains = lists.example
32448   file = /usr/lists/$local_part
32449   forbid_pipe
32450   forbid_file
32451   errors_to = $local_part-request@lists.example
32452   no_more
32453 .endd
32454 This router is skipped for domains other than &'lists.example'&. For addresses
32455 in that domain, it looks for a file that matches the local part. If there is no
32456 such file, the router declines, but because &%no_more%& is set, no subsequent
32457 routers are tried, and so the whole delivery fails.
32458
32459 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32460 expanded into a file name or a pipe delivery, which is usually inappropriate in
32461 a mailing list.
32462
32463 .oindex "&%errors_to%&"
32464 The &%errors_to%& option specifies that any delivery errors caused by addresses
32465 taken from a mailing list are to be sent to the given address rather than the
32466 original sender of the message. However, before acting on this, Exim verifies
32467 the error address, and ignores it if verification fails.
32468
32469 For example, using the configuration above, mail sent to
32470 &'dicts@lists.example'& is passed on to those addresses contained in
32471 &_/usr/lists/dicts_&, with error reports directed to
32472 &'dicts-request@lists.example'&, provided that this address can be verified.
32473 There could be a file called &_/usr/lists/dicts-request_& containing
32474 the address(es) of this particular list's manager(s), but other approaches,
32475 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32476 or &%local_part_suffix%& options) to handle addresses of the form
32477 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32478
32479
32480
32481 .section "Syntax errors in mailing lists" "SECID241"
32482 .cindex "mailing lists" "syntax errors in"
32483 If an entry in redirection data contains a syntax error, Exim normally defers
32484 delivery of the original address. That means that a syntax error in a mailing
32485 list holds up all deliveries to the list. This may not be appropriate when a
32486 list is being maintained automatically from data supplied by users, and the
32487 addresses are not rigorously checked.
32488
32489 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32490 entries that fail to parse, noting the incident in the log. If in addition
32491 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32492 whenever a broken address is skipped. It is usually appropriate to set
32493 &%syntax_errors_to%& to the same address as &%errors_to%&.
32494
32495
32496
32497 .section "Re-expansion of mailing lists" "SECID242"
32498 .cindex "mailing lists" "re-expansion of"
32499 Exim remembers every individual address to which a message has been delivered,
32500 in order to avoid duplication, but it normally stores only the original
32501 recipient addresses with a message. If all the deliveries to a mailing list
32502 cannot be done at the first attempt, the mailing list is re-expanded when the
32503 delivery is next tried. This means that alterations to the list are taken into
32504 account at each delivery attempt, so addresses that have been added to
32505 the list since the message arrived will therefore receive a copy of the
32506 message, even though it pre-dates their subscription.
32507
32508 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32509 on the &(redirect)& router. If this is done, any addresses generated by the
32510 router that fail to deliver at the first attempt are added to the message as
32511 &"top level"& addresses, and the parent address that generated them is marked
32512 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32513 subsequent delivery attempts. The disadvantage of this is that if any of the
32514 failing addresses are incorrect, correcting them in the file has no effect on
32515 pre-existing messages.
32516
32517 The original top-level address is remembered with each of the generated
32518 addresses, and is output in any log messages. However, any intermediate parent
32519 addresses are not recorded. This makes a difference to the log only if the
32520 &%all_parents%& selector is set, but for mailing lists there is normally only
32521 one level of expansion anyway.
32522
32523
32524
32525 .section "Closed mailing lists" "SECID243"
32526 .cindex "mailing lists" "closed"
32527 The examples so far have assumed open mailing lists, to which anybody may
32528 send mail. It is also possible to set up closed lists, where mail is accepted
32529 from specified senders only. This is done by making use of the generic
32530 &%senders%& option to restrict the router that handles the list.
32531
32532 The following example uses the same file as a list of recipients and as a list
32533 of permitted senders. It requires three routers:
32534 .code
32535 lists_request:
32536   driver = redirect
32537   domains = lists.example
32538   local_part_suffix = -request
32539   file = /usr/lists/$local_part$local_part_suffix
32540   no_more
32541
32542 lists_post:
32543   driver = redirect
32544   domains = lists.example
32545   senders = ${if exists {/usr/lists/$local_part}\
32546              {lsearch;/usr/lists/$local_part}{*}}
32547   file = /usr/lists/$local_part
32548   forbid_pipe
32549   forbid_file
32550   errors_to = $local_part-request@lists.example
32551   no_more
32552
32553 lists_closed:
32554   driver = redirect
32555   domains = lists.example
32556   allow_fail
32557   data = :fail: $local_part@lists.example is a closed mailing list
32558 .endd
32559 All three routers have the same &%domains%& setting, so for any other domains,
32560 they are all skipped. The first router runs only if the local part ends in
32561 &%-request%&. It handles messages to the list manager(s) by means of an open
32562 mailing list.
32563
32564 The second router runs only if the &%senders%& precondition is satisfied. It
32565 checks for the existence of a list that corresponds to the local part, and then
32566 checks that the sender is on the list by means of a linear search. It is
32567 necessary to check for the existence of the file before trying to search it,
32568 because otherwise Exim thinks there is a configuration error. If the file does
32569 not exist, the expansion of &%senders%& is *, which matches all senders. This
32570 means that the router runs, but because there is no list, declines, and
32571 &%no_more%& ensures that no further routers are run. The address fails with an
32572 &"unrouteable address"& error.
32573
32574 The third router runs only if the second router is skipped, which happens when
32575 a mailing list exists, but the sender is not on it. This router forcibly fails
32576 the address, giving a suitable error message.
32577
32578
32579
32580
32581 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32582 .cindex "VERP"
32583 .cindex "Variable Envelope Return Paths"
32584 .cindex "envelope sender"
32585 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32586 are a way of helping mailing list administrators discover which subscription
32587 address is the cause of a particular delivery failure. The idea is to encode
32588 the original recipient address in the outgoing envelope sender address, so that
32589 if the message is forwarded by another host and then subsequently bounces, the
32590 original recipient can be extracted from the recipient address of the bounce.
32591
32592 .oindex &%errors_to%&
32593 .oindex &%return_path%&
32594 Envelope sender addresses can be modified by Exim using two different
32595 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32596 list examples), or the &%return_path%& option on a transport. The second of
32597 these is effective only if the message is successfully delivered to another
32598 host; it is not used for errors detected on the local host (see the description
32599 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32600 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32601 .code
32602 verp_smtp:
32603   driver = smtp
32604   max_rcpt = 1
32605   return_path = \
32606     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32607       {$1-request+$local_part=$domain@your.dom.example}fail}
32608 .endd
32609 This has the effect of rewriting the return path (envelope sender) on outgoing
32610 SMTP messages, if the local part of the original return path ends in
32611 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32612 local part and domain of the recipient into the return path. Suppose, for
32613 example, that a message whose return path has been set to
32614 &'somelist-request@your.dom.example'& is sent to
32615 &'subscriber@other.dom.example'&. In the transport, the return path is
32616 rewritten as
32617 .code
32618 somelist-request+subscriber=other.dom.example@your.dom.example
32619 .endd
32620 .vindex "&$local_part$&"
32621 For this to work, you must tell Exim to send multiple copies of messages that
32622 have more than one recipient, so that each copy has just one recipient. This is
32623 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32624 might be sent to several different recipients in the same domain, in which case
32625 &$local_part$& is not available in the transport, because it is not unique.
32626
32627 Unless your host is doing nothing but mailing list deliveries, you should
32628 probably use a separate transport for the VERP deliveries, so as not to use
32629 extra resources in making one-per-recipient copies for other deliveries. This
32630 can easily be done by expanding the &%transport%& option in the router:
32631 .code
32632 dnslookup:
32633   driver = dnslookup
32634   domains = ! +local_domains
32635   transport = \
32636     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32637       {verp_smtp}{remote_smtp}}
32638   no_more
32639 .endd
32640 If you want to change the return path using &%errors_to%& in a router instead
32641 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32642 routers that handle mailing list addresses. This will ensure that all delivery
32643 errors, including those detected on the local host, are sent to the VERP
32644 address.
32645
32646 On a host that does no local deliveries and has no manual routing, only the
32647 &(dnslookup)& router needs to be changed. A special transport is not needed for
32648 SMTP deliveries. Every mailing list recipient has its own return path value,
32649 and so Exim must hand them to the transport one at a time. Here is an example
32650 of a &(dnslookup)& router that implements VERP:
32651 .code
32652 verp_dnslookup:
32653   driver = dnslookup
32654   domains = ! +local_domains
32655   transport = remote_smtp
32656   errors_to = \
32657     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32658      {$1-request+$local_part=$domain@your.dom.example}fail}
32659   no_more
32660 .endd
32661 Before you start sending out messages with VERPed return paths, you must also
32662 configure Exim to accept the bounce messages that come back to those paths.
32663 Typically this is done by setting a &%local_part_suffix%& option for a
32664 router, and using this to route the messages to wherever you want to handle
32665 them.
32666
32667 The overhead incurred in using VERP depends very much on the size of the
32668 message, the number of recipient addresses that resolve to the same remote
32669 host, and the speed of the connection over which the message is being sent. If
32670 a lot of addresses resolve to the same host and the connection is slow, sending
32671 a separate copy of the message for each address may take substantially longer
32672 than sending a single copy with many recipients (for which VERP cannot be
32673 used).
32674
32675
32676
32677
32678
32679
32680 .section "Virtual domains" "SECTvirtualdomains"
32681 .cindex "virtual domains"
32682 .cindex "domain" "virtual"
32683 The phrase &'virtual domain'& is unfortunately used with two rather different
32684 meanings:
32685
32686 .ilist
32687 A domain for which there are no real mailboxes; all valid local parts are
32688 aliases for other email addresses. Common examples are organizational
32689 top-level domains and &"vanity"& domains.
32690 .next
32691 One of a number of independent domains that are all handled by the same host,
32692 with mailboxes on that host, but where the mailbox owners do not necessarily
32693 have login accounts on that host.
32694 .endlist
32695
32696 The first usage is probably more common, and does seem more &"virtual"& than
32697 the second. This kind of domain can be handled in Exim with a straightforward
32698 aliasing router. One approach is to create a separate alias file for each
32699 virtual domain. Exim can test for the existence of the alias file to determine
32700 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
32701 to a router of this form:
32702 .code
32703 virtual:
32704   driver = redirect
32705   domains = dsearch;/etc/mail/virtual
32706   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
32707   no_more
32708 .endd
32709 The &%domains%& option specifies that the router is to be skipped, unless there
32710 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
32711 domain that is being processed. When the router runs, it looks up the local
32712 part in the file to find a new address (or list of addresses). The &%no_more%&
32713 setting ensures that if the lookup fails (leading to &%data%& being an empty
32714 string), Exim gives up on the address without trying any subsequent routers.
32715
32716 This one router can handle all the virtual domains because the alias file names
32717 follow a fixed pattern. Permissions can be arranged so that appropriate people
32718 can edit the different alias files. A successful aliasing operation results in
32719 a new envelope recipient address, which is then routed from scratch.
32720
32721 The other kind of &"virtual"& domain can also be handled in a straightforward
32722 way. One approach is to create a file for each domain containing a list of
32723 valid local parts, and use it in a router like this:
32724 .code
32725 my_domains:
32726   driver = accept
32727   domains = dsearch;/etc/mail/domains
32728   local_parts = lsearch;/etc/mail/domains/$domain
32729   transport = my_mailboxes
32730 .endd
32731 The address is accepted if there is a file for the domain, and the local part
32732 can be found in the file. The &%domains%& option is used to check for the
32733 file's existence because &%domains%& is tested before the &%local_parts%&
32734 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
32735 because that option is tested after &%local_parts%&. The transport is as
32736 follows:
32737 .code
32738 my_mailboxes:
32739   driver = appendfile
32740   file = /var/mail/$domain/$local_part
32741   user = mail
32742 .endd
32743 This uses a directory of mailboxes for each domain. The &%user%& setting is
32744 required, to specify which uid is to be used for writing to the mailboxes.
32745
32746 The configuration shown here is just one example of how you might support this
32747 requirement. There are many other ways this kind of configuration can be set
32748 up, for example, by using a database instead of separate files to hold all the
32749 information about the domains.
32750
32751
32752
32753 .section "Multiple user mailboxes" "SECTmulbox"
32754 .cindex "multiple mailboxes"
32755 .cindex "mailbox" "multiple"
32756 .cindex "local part" "prefix"
32757 .cindex "local part" "suffix"
32758 Heavy email users often want to operate with multiple mailboxes, into which
32759 incoming mail is automatically sorted. A popular way of handling this is to
32760 allow users to use multiple sender addresses, so that replies can easily be
32761 identified. Users are permitted to add prefixes or suffixes to their local
32762 parts for this purpose. The wildcard facility of the generic router options
32763 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
32764 example, consider this router:
32765 .code
32766 userforward:
32767   driver = redirect
32768   check_local_user
32769   file = $home/.forward
32770   local_part_suffix = -*
32771   local_part_suffix_optional
32772   allow_filter
32773 .endd
32774 .vindex "&$local_part_suffix$&"
32775 It runs a user's &_.forward_& file for all local parts of the form
32776 &'username-*'&. Within the filter file the user can distinguish different
32777 cases by testing the variable &$local_part_suffix$&. For example:
32778 .code
32779 if $local_part_suffix contains -special then
32780 save /home/$local_part/Mail/special
32781 endif
32782 .endd
32783 If the filter file does not exist, or does not deal with such addresses, they
32784 fall through to subsequent routers, and, assuming no subsequent use of the
32785 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
32786 control over which suffixes are valid.
32787
32788 Alternatively, a suffix can be used to trigger the use of a different
32789 &_.forward_& file &-- which is the way a similar facility is implemented in
32790 another MTA:
32791 .code
32792 userforward:
32793   driver = redirect
32794   check_local_user
32795   file = $home/.forward$local_part_suffix
32796   local_part_suffix = -*
32797   local_part_suffix_optional
32798   allow_filter
32799 .endd
32800 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
32801 example, &_.forward-special_& is used. Once again, if the appropriate file
32802 does not exist, or does not deal with the address, it is passed on to
32803 subsequent routers, which could, if required, look for an unqualified
32804 &_.forward_& file to use as a default.
32805
32806
32807
32808 .section "Simplified vacation processing" "SECID244"
32809 .cindex "vacation processing"
32810 The traditional way of running the &'vacation'& program is for a user to set up
32811 a pipe command in a &_.forward_& file
32812 (see section &<<SECTspecitredli>>& for syntax details).
32813 This is prone to error by inexperienced users. There are two features of Exim
32814 that can be used to make this process simpler for users:
32815
32816 .ilist
32817 A local part prefix such as &"vacation-"& can be specified on a router which
32818 can cause the message to be delivered directly to the &'vacation'& program, or
32819 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
32820 &_.forward_& file are then much simpler. For example:
32821 .code
32822 spqr, vacation-spqr
32823 .endd
32824 .next
32825 The &%require_files%& generic router option can be used to trigger a
32826 vacation delivery by checking for the existence of a certain file in the
32827 user's home directory. The &%unseen%& generic option should also be used, to
32828 ensure that the original delivery also proceeds. In this case, all the user has
32829 to do is to create a file called, say, &_.vacation_&, containing a vacation
32830 message.
32831 .endlist
32832
32833 Another advantage of both these methods is that they both work even when the
32834 use of arbitrary pipes by users is locked out.
32835
32836
32837
32838 .section "Taking copies of mail" "SECID245"
32839 .cindex "message" "copying every"
32840 Some installations have policies that require archive copies of all messages to
32841 be made. A single copy of each message can easily be taken by an appropriate
32842 command in a system filter, which could, for example, use a different file for
32843 each day's messages.
32844
32845 There is also a shadow transport mechanism that can be used to take copies of
32846 messages that are successfully delivered by local transports, one copy per
32847 delivery. This could be used, &'inter alia'&, to implement automatic
32848 notification of delivery by sites that insist on doing such things.
32849
32850
32851
32852 .section "Intermittently connected hosts" "SECID246"
32853 .cindex "intermittently connected hosts"
32854 It has become quite common (because it is cheaper) for hosts to connect to the
32855 Internet periodically rather than remain connected all the time. The normal
32856 arrangement is that mail for such hosts accumulates on a system that is
32857 permanently connected.
32858
32859 Exim was designed for use on permanently connected hosts, and so it is not
32860 particularly well-suited to use in an intermittently connected environment.
32861 Nevertheless there are some features that can be used.
32862
32863
32864 .section "Exim on the upstream server host" "SECID247"
32865 It is tempting to arrange for incoming mail for the intermittently connected
32866 host to remain on Exim's queue until the client connects. However, this
32867 approach does not scale very well. Two different kinds of waiting message are
32868 being mixed up in the same queue &-- those that cannot be delivered because of
32869 some temporary problem, and those that are waiting for their destination host
32870 to connect. This makes it hard to manage the queue, as well as wasting
32871 resources, because each queue runner scans the entire queue.
32872
32873 A better approach is to separate off those messages that are waiting for an
32874 intermittently connected host. This can be done by delivering these messages
32875 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
32876 format, from where they are transmitted by other software when their
32877 destination connects. This makes it easy to collect all the mail for one host
32878 in a single directory, and to apply local timeout rules on a per-message basis
32879 if required.
32880
32881 On a very small scale, leaving the mail on Exim's queue can be made to work. If
32882 you are doing this, you should configure Exim with a long retry period for the
32883 intermittent host. For example:
32884 .code
32885 cheshire.wonderland.fict.example    *   F,5d,24h
32886 .endd
32887 This stops a lot of failed delivery attempts from occurring, but Exim remembers
32888 which messages it has queued up for that host. Once the intermittent host comes
32889 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
32890 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
32891 causes all the queued up messages to be delivered, often down a single SMTP
32892 connection. While the host remains connected, any new messages get delivered
32893 immediately.
32894
32895 If the connecting hosts do not have fixed IP addresses, that is, if a host is
32896 issued with a different IP address each time it connects, Exim's retry
32897 mechanisms on the holding host get confused, because the IP address is normally
32898 used as part of the key string for holding retry information. This can be
32899 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
32900 Since this has disadvantages for permanently connected hosts, it is best to
32901 arrange a separate transport for the intermittently connected ones.
32902
32903
32904
32905 .section "Exim on the intermittently connected client host" "SECID248"
32906 The value of &%smtp_accept_queue_per_connection%& should probably be
32907 increased, or even set to zero (that is, disabled) on the intermittently
32908 connected host, so that all incoming messages down a single connection get
32909 delivered immediately.
32910
32911 .cindex "SMTP" "passed connection"
32912 .cindex "SMTP" "multiple deliveries"
32913 .cindex "multiple SMTP deliveries"
32914 Mail waiting to be sent from an intermittently connected host will probably
32915 not have been routed, because without a connection DNS lookups are not
32916 possible. This means that if a normal queue run is done at connection time,
32917 each message is likely to be sent in a separate SMTP session. This can be
32918 avoided by starting the queue run with a command line option beginning with
32919 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
32920 first pass, routing is done but no deliveries take place. The second pass is a
32921 normal queue run; since all the messages have been previously routed, those
32922 destined for the same host are likely to get sent as multiple deliveries in a
32923 single SMTP connection.
32924
32925
32926
32927 . ////////////////////////////////////////////////////////////////////////////
32928 . ////////////////////////////////////////////////////////////////////////////
32929
32930 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
32931          "Exim as a non-queueing client"
32932 .cindex "client, non-queueing"
32933 .cindex "smart host" "suppressing queueing"
32934 On a personal computer, it is a common requirement for all
32935 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
32936 configured to operate that way, for all the popular operating systems.
32937 However, there are some MUAs for Unix-like systems that cannot be so
32938 configured: they submit messages using the command line interface of
32939 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
32940 messages this way.
32941
32942 If the personal computer runs continuously, there is no problem, because it can
32943 run a conventional MTA that handles delivery to the smart host, and deal with
32944 any delays via its queueing mechanism. However, if the computer does not run
32945 continuously or runs different operating systems at different times, queueing
32946 email is not desirable.
32947
32948 There is therefore a requirement for something that can provide the
32949 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
32950 any queueing or retrying facilities. Furthermore, the delivery to the smart
32951 host should be synchronous, so that if it fails, the sending MUA is immediately
32952 informed. In other words, we want something that extends an MUA that submits
32953 to a local MTA via the command line so that it behaves like one that submits
32954 to a remote smart host using TCP/SMTP.
32955
32956 There are a number of applications (for example, there is one called &'ssmtp'&)
32957 that do this job. However, people have found them to be lacking in various
32958 ways. For instance, you might want to allow aliasing and forwarding to be done
32959 before sending a message to the smart host.
32960
32961 Exim already had the necessary infrastructure for doing this job. Just a few
32962 tweaks were needed to make it behave as required, though it is somewhat of an
32963 overkill to use a fully-featured MTA for this purpose.
32964
32965 .oindex "&%mua_wrapper%&"
32966 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
32967 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
32968 assumes that it is being used to &"wrap"& a command-line MUA in the manner
32969 just described. As well as setting &%mua_wrapper%&, you also need to provide a
32970 compatible router and transport configuration. Typically there will be just one
32971 router and one transport, sending everything to a smart host.
32972
32973 When run in MUA wrapping mode, the behaviour of Exim changes in the
32974 following ways:
32975
32976 .ilist
32977 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
32978 In other words, the only way to submit messages is via the command line.
32979 .next
32980 Each message is synchronously delivered as soon as it is received (&%-odi%& is
32981 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
32982 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
32983 does not finish until the delivery attempt is complete. If the delivery is
32984 successful, a zero return code is given.
32985 .next
32986 Address redirection is permitted, but the final routing for all addresses must
32987 be to the same remote transport, and to the same list of hosts. Furthermore,
32988 the return address (envelope sender) must be the same for all recipients, as
32989 must any added or deleted header lines. In other words, it must be possible to
32990 deliver the message in a single SMTP transaction, however many recipients there
32991 are.
32992 .next
32993 If these conditions are not met, or if routing any address results in a
32994 failure or defer status, or if Exim is unable to deliver all the recipients
32995 successfully to one of the smart hosts, delivery of the entire message fails.
32996 .next
32997 Because no queueing is allowed, all failures are treated as permanent; there
32998 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
32999 smart host. Furthermore, because only a single yes/no response can be given to
33000 the caller, it is not possible to deliver to some recipients and not others. If
33001 there is an error (temporary or permanent) for any recipient, all are failed.
33002 .next
33003 If more than one smart host is listed, Exim will try another host after a
33004 connection failure or a timeout, in the normal way. However, if this kind of
33005 failure happens for all the hosts, the delivery fails.
33006 .next
33007 When delivery fails, an error message is written to the standard error stream
33008 (as well as to Exim's log), and Exim exits to the caller with a return code
33009 value 1. The message is expunged from Exim's spool files. No bounce messages
33010 are ever generated.
33011 .next
33012 No retry data is maintained, and any retry rules are ignored.
33013 .next
33014 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
33015 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
33016 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
33017 .endlist
33018
33019 The overall effect is that Exim makes a single synchronous attempt to deliver
33020 the message, failing if there is any kind of problem. Because no local
33021 deliveries are done and no daemon can be run, Exim does not need root
33022 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
33023 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
33024 the advantages and disadvantages of running without root privilege.
33025
33026
33027
33028
33029 . ////////////////////////////////////////////////////////////////////////////
33030 . ////////////////////////////////////////////////////////////////////////////
33031
33032 .chapter "Log files" "CHAPlog"
33033 .scindex IIDloggen "log" "general description"
33034 .cindex "log" "types of"
33035 Exim writes three different logs, referred to as the main log, the reject log,
33036 and the panic log:
33037
33038 .ilist
33039 .cindex "main log"
33040 The main log records the arrival of each message and each delivery in a single
33041 line in each case. The format is as compact as possible, in an attempt to keep
33042 down the size of log files. Two-character flag sequences make it easy to pick
33043 out these lines. A number of other events are recorded in the main log. Some of
33044 them are optional, in which case the &%log_selector%& option controls whether
33045 they are included or not. A Perl script called &'eximstats'&, which does simple
33046 analysis of main log files, is provided in the Exim distribution (see section
33047 &<<SECTmailstat>>&).
33048 .next
33049 .cindex "reject log"
33050 The reject log records information from messages that are rejected as a result
33051 of a configuration option (that is, for policy reasons).
33052 The first line of each rejection is a copy of the line that is also written to
33053 the main log. Then, if the message's header has been read at the time the log
33054 is written, its contents are written to this log. Only the original header
33055 lines are available; header lines added by ACLs are not logged. You can use the
33056 reject log to check that your policy controls are working correctly; on a busy
33057 host this may be easier than scanning the main log for rejection messages. You
33058 can suppress the writing of the reject log by setting &%write_rejectlog%&
33059 false.
33060 .next
33061 .cindex "panic log"
33062 .cindex "system log"
33063 When certain serious errors occur, Exim writes entries to its panic log. If the
33064 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
33065 are usually written to the main log as well, but can get lost amid the mass of
33066 other entries. The panic log should be empty under normal circumstances. It is
33067 therefore a good idea to check it (or to have a &'cron'& script check it)
33068 regularly, in order to become aware of any problems. When Exim cannot open its
33069 panic log, it tries as a last resort to write to the system log (syslog). This
33070 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
33071 message itself is written at priority LOG_CRIT.
33072 .endlist
33073
33074 Every log line starts with a timestamp, in the format shown in the following
33075 example. Note that many of the examples shown in this chapter are line-wrapped.
33076 In the log file, this would be all on one line:
33077 .code
33078 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
33079   by QUIT
33080 .endd
33081 By default, the timestamps are in the local timezone. There are two
33082 ways of changing this:
33083
33084 .ilist
33085 You can set the &%timezone%& option to a different time zone; in particular, if
33086 you set
33087 .code
33088 timezone = UTC
33089 .endd
33090 the timestamps will be in UTC (aka GMT).
33091 .next
33092 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
33093 example:
33094 .code
33095 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
33096 .endd
33097 .endlist
33098
33099 .cindex "log" "process ids in"
33100 .cindex "pid (process id)" "in log lines"
33101 Exim does not include its process id in log lines by default, but you can
33102 request that it does so by specifying the &`pid`& log selector (see section
33103 &<<SECTlogselector>>&). When this is set, the process id is output, in square
33104 brackets, immediately after the time and date.
33105
33106
33107
33108
33109 .section "Where the logs are written" "SECTwhelogwri"
33110 .cindex "log" "destination"
33111 .cindex "log" "to file"
33112 .cindex "log" "to syslog"
33113 .cindex "syslog"
33114 The logs may be written to local files, or to syslog, or both. However, it
33115 should be noted that many syslog implementations use UDP as a transport, and
33116 are therefore unreliable in the sense that messages are not guaranteed to
33117 arrive at the loghost, nor is the ordering of messages necessarily maintained.
33118 It has also been reported that on large log files (tens of megabytes) you may
33119 need to tweak syslog to prevent it syncing the file with each write &-- on
33120 Linux this has been seen to make syslog take 90% plus of CPU time.
33121
33122 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
33123 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
33124 configuration. This latter string is expanded, so it can contain, for example,
33125 references to the host name:
33126 .code
33127 log_file_path = /var/log/$primary_hostname/exim_%slog
33128 .endd
33129 It is generally advisable, however, to set the string in &_Local/Makefile_&
33130 rather than at run time, because then the setting is available right from the
33131 start of Exim's execution. Otherwise, if there's something it wants to log
33132 before it has read the configuration file (for example, an error in the
33133 configuration file) it will not use the path you want, and may not be able to
33134 log at all.
33135
33136 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
33137 list, currently limited to at most two items. This is one option where the
33138 facility for changing a list separator may not be used. The list must always be
33139 colon-separated. If an item in the list is &"syslog"& then syslog is used;
33140 otherwise the item must either be an absolute path, containing &`%s`& at the
33141 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
33142 implying the use of a default path.
33143
33144 When Exim encounters an empty item in the list, it searches the list defined by
33145 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
33146 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
33147 mean &"use the path specified at build time"&. It no such item exists, log
33148 files are written in the &_log_& subdirectory of the spool directory. This is
33149 equivalent to the setting:
33150 .code
33151 log_file_path = $spool_directory/log/%slog
33152 .endd
33153 If you do not specify anything at build time or run time, that is where the
33154 logs are written.
33155
33156 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
33157 are in use &-- see section &<<SECTdatlogfil>>& below.
33158
33159 Here are some examples of possible settings:
33160 .display
33161 &`LOG_FILE_PATH=syslog                    `& syslog only
33162 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
33163 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
33164 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
33165 .endd
33166 If there are more than two paths in the list, the first is used and a panic
33167 error is logged.
33168
33169
33170
33171 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
33172 .cindex "log" "cycling local files"
33173 .cindex "cycling logs"
33174 .cindex "&'exicyclog'&"
33175 .cindex "log" "local files; writing to"
33176 Some operating systems provide centralized and standardized methods for cycling
33177 log files. For those that do not, a utility script called &'exicyclog'& is
33178 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
33179 main and reject logs each time it is called. The maximum number of old logs to
33180 keep can be set. It is suggested this script is run as a daily &'cron'& job.
33181
33182 An Exim delivery process opens the main log when it first needs to write to it,
33183 and it keeps the file open in case subsequent entries are required &-- for
33184 example, if a number of different deliveries are being done for the same
33185 message. However, remote SMTP deliveries can take a long time, and this means
33186 that the file may be kept open long after it is renamed if &'exicyclog'& or
33187 something similar is being used to rename log files on a regular basis. To
33188 ensure that a switch of log files is noticed as soon as possible, Exim calls
33189 &[stat()]& on the main log's name before reusing an open file, and if the file
33190 does not exist, or its inode has changed, the old file is closed and Exim
33191 tries to open the main log from scratch. Thus, an old log file may remain open
33192 for quite some time, but no Exim processes should write to it once it has been
33193 renamed.
33194
33195
33196
33197 .section "Datestamped log files" "SECTdatlogfil"
33198 .cindex "log" "datestamped files"
33199 Instead of cycling the main and reject log files by renaming them
33200 periodically, some sites like to use files whose names contain a datestamp,
33201 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
33202 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
33203 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
33204 point where the datestamp is required. For example:
33205 .code
33206 log_file_path = /var/spool/exim/log/%slog-%D
33207 log_file_path = /var/log/exim-%s-%D.log
33208 log_file_path = /var/spool/exim/log/%D-%slog
33209 log_file_path = /var/log/exim/%s.%M
33210 .endd
33211 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
33212 examples of names generated by the above examples:
33213 .code
33214 /var/spool/exim/log/mainlog-20021225
33215 /var/log/exim-reject-20021225.log
33216 /var/spool/exim/log/20021225-mainlog
33217 /var/log/exim/main.200212
33218 .endd
33219 When this form of log file is specified, Exim automatically switches to new
33220 files at midnight. It does not make any attempt to compress old logs; you
33221 will need to write your own script if you require this. You should not
33222 run &'exicyclog'& with this form of logging.
33223
33224 The location of the panic log is also determined by &%log_file_path%&, but it
33225 is not datestamped, because rotation of the panic log does not make sense.
33226 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
33227 the string. In addition, if it immediately follows a slash, a following
33228 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
33229 character is removed. Thus, the four examples above would give these panic
33230 log names:
33231 .code
33232 /var/spool/exim/log/paniclog
33233 /var/log/exim-panic.log
33234 /var/spool/exim/log/paniclog
33235 /var/log/exim/panic
33236 .endd
33237
33238
33239 .section "Logging to syslog" "SECID249"
33240 .cindex "log" "syslog; writing to"
33241 The use of syslog does not change what Exim logs or the format of its messages,
33242 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
33243 Exim's log lines are omitted when these lines are sent to syslog. Apart from
33244 that, the same strings are written to syslog as to log files. The syslog
33245 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
33246 by default, but you can change these by setting the &%syslog_facility%& and
33247 &%syslog_processname%& options, respectively. If Exim was compiled with
33248 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
33249 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
33250 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
33251 the time and host name to each line.
33252 The three log streams are mapped onto syslog priorities as follows:
33253
33254 .ilist
33255 &'mainlog'& is mapped to LOG_INFO
33256 .next
33257 &'rejectlog'& is mapped to LOG_NOTICE
33258 .next
33259 &'paniclog'& is mapped to LOG_ALERT
33260 .endlist
33261
33262 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
33263 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
33264 these are routed by syslog to the same place. You can suppress this duplication
33265 by setting &%syslog_duplication%& false.
33266
33267 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
33268 entries contain multiple lines when headers are included. To cope with both
33269 these cases, entries written to syslog are split into separate &[syslog()]&
33270 calls at each internal newline, and also after a maximum of
33271 870 data characters. (This allows for a total syslog line length of 1024, when
33272 additions such as timestamps are added.) If you are running a syslog
33273 replacement that can handle lines longer than the 1024 characters allowed by
33274 RFC 3164, you should set
33275 .code
33276 SYSLOG_LONG_LINES=yes
33277 .endd
33278 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
33279 lines, but it still splits at internal newlines in &'reject'& log entries.
33280
33281 To make it easy to re-assemble split lines later, each component of a split
33282 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
33283 where <&'n'&> is the component number and <&'m'&> is the total number of
33284 components in the entry. The / delimiter is used when the line was split
33285 because it was too long; if it was split because of an internal newline, the \
33286 delimiter is used. For example, supposing the length limit to be 50 instead of
33287 870, the following would be the result of a typical rejection message to
33288 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
33289 name, and pid as added by syslog:
33290 .code
33291 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
33292 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
33293 [3/5]  when scanning for sender: missing or malformed lo
33294 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
33295 [5/5] mple>)
33296 .endd
33297 The same error might cause the following lines to be written to &"rejectlog"&
33298 (LOG_NOTICE):
33299 .code
33300 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
33301 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
33302 [3/18] er when scanning for sender: missing or malformed
33303 [4/18]  local part in "<>" (envelope sender is <ph10@cam
33304 [5\18] .example>)
33305 [6\18] Recipients: ph10@some.domain.cam.example
33306 [7\18] P Received: from [127.0.0.1] (ident=ph10)
33307 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
33308 [9\18]        id 16RdAL-0006pc-00
33309 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
33310 [11\18] 09:43 +0100
33311 [12\18] F From: <>
33312 [13\18]   Subject: this is a test header
33313 [18\18]   X-something: this is another header
33314 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
33315 [16\18] le>
33316 [17\18] B Bcc:
33317 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
33318 .endd
33319 Log lines that are neither too long nor contain newlines are written to syslog
33320 without modification.
33321
33322 If only syslog is being used, the Exim monitor is unable to provide a log tail
33323 display, unless syslog is routing &'mainlog'& to a file on the local host and
33324 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
33325 where it is.
33326
33327
33328
33329 .section "Log line flags" "SECID250"
33330 One line is written to the main log for each message received, and for each
33331 successful, unsuccessful, and delayed delivery. These lines can readily be
33332 picked out by the distinctive two-character flags that immediately follow the
33333 timestamp. The flags are:
33334 .display
33335 &`<=`&     message arrival
33336 &`=>`&     normal message delivery
33337 &`->`&     additional address in same delivery
33338 &`*>`&     delivery suppressed by &%-N%&
33339 &`**`&     delivery failed; address bounced
33340 &`==`&     delivery deferred; temporary problem
33341 .endd
33342
33343
33344 .section "Logging message reception" "SECID251"
33345 .cindex "log" "reception line"
33346 The format of the single-line entry in the main log that is written for every
33347 message received is shown in the basic example below, which is split over
33348 several lines in order to fit it on the page:
33349 .code
33350 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
33351   H=mailer.fict.example [192.168.123.123] U=exim
33352   P=smtp S=5678 id=<incoming message id>
33353 .endd
33354 The address immediately following &"<="& is the envelope sender address. A
33355 bounce message is shown with the sender address &"<>"&, and if it is locally
33356 generated, this is followed by an item of the form
33357 .code
33358 R=<message id>
33359 .endd
33360 which is a reference to the message that caused the bounce to be sent.
33361
33362 .cindex "HELO"
33363 .cindex "EHLO"
33364 For messages from other hosts, the H and U fields identify the remote host and
33365 record the RFC 1413 identity of the user that sent the message, if one was
33366 received. The number given in square brackets is the IP address of the sending
33367 host. If there is a single, unparenthesized  host name in the H field, as
33368 above, it has been verified to correspond to the IP address (see the
33369 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33370 by the remote host in the SMTP HELO or EHLO command, and has not been
33371 verified. If verification yields a different name to that given for HELO or
33372 EHLO, the verified name appears first, followed by the HELO or EHLO
33373 name in parentheses.
33374
33375 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33376 without brackets, in the HELO or EHLO command, leading to entries in
33377 the log containing text like these examples:
33378 .code
33379 H=(10.21.32.43) [192.168.8.34]
33380 H=([10.21.32.43]) [192.168.8.34]
33381 .endd
33382 This can be confusing. Only the final address in square brackets can be relied
33383 on.
33384
33385 For locally generated messages (that is, messages not received over TCP/IP),
33386 the H field is omitted, and the U field contains the login name of the caller
33387 of Exim.
33388
33389 .cindex "authentication" "logging"
33390 .cindex "AUTH" "logging"
33391 For all messages, the P field specifies the protocol used to receive the
33392 message. This is the value that is stored in &$received_protocol$&. In the case
33393 of incoming SMTP messages, the value indicates whether or not any SMTP
33394 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33395 session was encrypted, there is an additional X field that records the cipher
33396 suite that was used.
33397
33398 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33399 hosts that have authenticated themselves using the SMTP AUTH command. The first
33400 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33401 there is an additional item A= followed by the name of the authenticator that
33402 was used. If an authenticated identification was set up by the authenticator's
33403 &%server_set_id%& option, this is logged too, separated by a colon from the
33404 authenticator name.
33405
33406 .cindex "size" "of message"
33407 The id field records the existing message id, if present. The size of the
33408 received message is given by the S field. When the message is delivered,
33409 headers may be removed or added, so that the size of delivered copies of the
33410 message may not correspond with this value (and indeed may be different to each
33411 other).
33412
33413 The &%log_selector%& option can be used to request the logging of additional
33414 data when a message is received. See section &<<SECTlogselector>>& below.
33415
33416
33417
33418 .section "Logging deliveries" "SECID252"
33419 .cindex "log" "delivery line"
33420 The format of the single-line entry in the main log that is written for every
33421 delivery is shown in one of the examples below, for local and remote
33422 deliveries, respectively. Each example has been split into two lines in order
33423 to fit it on the page:
33424 .code
33425 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33426   <marv@hitch.fict.example> R=localuser T=local_delivery
33427 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33428   monk@holistic.fict.example R=dnslookup T=remote_smtp
33429   H=holistic.fict.example [192.168.234.234]
33430 .endd
33431 For ordinary local deliveries, the original address is given in angle brackets
33432 after the final delivery address, which might be a pipe or a file. If
33433 intermediate address(es) exist between the original and the final address, the
33434 last of these is given in parentheses after the final address. The R and T
33435 fields record the router and transport that were used to process the address.
33436
33437 If a shadow transport was run after a successful local delivery, the log line
33438 for the successful delivery has an item added on the end, of the form
33439 .display
33440 &`ST=<`&&'shadow transport name'&&`>`&
33441 .endd
33442 If the shadow transport did not succeed, the error message is put in
33443 parentheses afterwards.
33444
33445 .cindex "asterisk" "after IP address"
33446 When more than one address is included in a single delivery (for example, two
33447 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33448 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33449 down a single SMTP connection, an asterisk follows the IP address in the log
33450 lines for the second and subsequent messages.
33451
33452 The generation of a reply message by a filter file gets logged as a
33453 &"delivery"& to the addressee, preceded by &">"&.
33454
33455 The &%log_selector%& option can be used to request the logging of additional
33456 data when a message is delivered. See section &<<SECTlogselector>>& below.
33457
33458
33459 .section "Discarded deliveries" "SECID253"
33460 .cindex "discarded messages"
33461 .cindex "message" "discarded"
33462 .cindex "delivery" "discarded; logging"
33463 When a message is discarded as a result of the command &"seen finish"& being
33464 obeyed in a filter file which generates no deliveries, a log entry of the form
33465 .code
33466 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33467   <low.club@bridge.example> R=userforward
33468 .endd
33469 is written, to record why no deliveries are logged. When a message is discarded
33470 because it is aliased to &":blackhole:"& the log line is like this:
33471 .code
33472 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33473   <hole@nowhere.example> R=blackhole_router
33474 .endd
33475
33476
33477 .section "Deferred deliveries" "SECID254"
33478 When a delivery is deferred, a line of the following form is logged:
33479 .code
33480 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33481   R=dnslookup T=smtp defer (146): Connection refused
33482 .endd
33483 In the case of remote deliveries, the error is the one that was given for the
33484 last IP address that was tried. Details of individual SMTP failures are also
33485 written to the log, so the above line would be preceded by something like
33486 .code
33487 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33488   mail1.endrest.example [192.168.239.239]: Connection refused
33489 .endd
33490 When a deferred address is skipped because its retry time has not been reached,
33491 a message is written to the log, but this can be suppressed by setting an
33492 appropriate value in &%log_selector%&.
33493
33494
33495
33496 .section "Delivery failures" "SECID255"
33497 .cindex "delivery" "failure; logging"
33498 If a delivery fails because an address cannot be routed, a line of the
33499 following form is logged:
33500 .code
33501 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33502   <jim@trek99.example>: unknown mail domain
33503 .endd
33504 If a delivery fails at transport time, the router and transport are shown, and
33505 the response from the remote host is included, as in this example:
33506 .code
33507 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33508   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33509   after pipelined RCPT TO:<ace400@pb.example>: host
33510   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33511   <ace400@pb.example>...Addressee unknown
33512 .endd
33513 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33514 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33515 disabling PIPELINING. The log lines for all forms of delivery failure are
33516 flagged with &`**`&.
33517
33518
33519
33520 .section "Fake deliveries" "SECID256"
33521 .cindex "delivery" "fake; logging"
33522 If a delivery does not actually take place because the &%-N%& option has been
33523 used to suppress it, a normal delivery line is written to the log, except that
33524 &"=>"& is replaced by &"*>"&.
33525
33526
33527
33528 .section "Completion" "SECID257"
33529 A line of the form
33530 .code
33531 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33532 .endd
33533 is written to the main log when a message is about to be removed from the spool
33534 at the end of its processing.
33535
33536
33537
33538
33539 .section "Summary of Fields in Log Lines" "SECID258"
33540 .cindex "log" "summary of fields"
33541 A summary of the field identifiers that are used in log lines is shown in
33542 the following table:
33543 .display
33544 &`A   `&        authenticator name (and optional id)
33545 &`C   `&        SMTP confirmation on delivery
33546 &`    `&        command list for &"no mail in SMTP session"&
33547 &`CV  `&        certificate verification status
33548 &`D   `&        duration of &"no mail in SMTP session"&
33549 &`DN  `&        distinguished name from peer certificate
33550 &`DT  `&        on &`=>`& lines: time taken for a delivery
33551 &`F   `&        sender address (on delivery lines)
33552 &`H   `&        host name and IP address
33553 &`I   `&        local interface used
33554 &`id  `&        message id for incoming message
33555 &`P   `&        on &`<=`& lines: protocol used
33556 &`    `&        on &`=>`& and &`**`& lines: return path
33557 &`QT  `&        on &`=>`& lines: time spent on queue so far
33558 &`    `&        on &"Completed"& lines: time spent on queue
33559 &`R   `&        on &`<=`& lines: reference for local bounce
33560 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33561 &`S   `&        size of message
33562 &`ST  `&        shadow transport name
33563 &`T   `&        on &`<=`& lines: message subject (topic)
33564 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33565 &`U   `&        local user or RFC 1413 identity
33566 &`X   `&        TLS cipher suite
33567 .endd
33568
33569
33570 .section "Other log entries" "SECID259"
33571 Various other types of log entry are written from time to time. Most should be
33572 self-explanatory. Among the more common are:
33573
33574 .ilist
33575 .cindex "retry" "time not reached"
33576 &'retry time not reached'&&~&~An address previously suffered a temporary error
33577 during routing or local delivery, and the time to retry has not yet arrived.
33578 This message is not written to an individual message log file unless it happens
33579 during the first delivery attempt.
33580 .next
33581 &'retry time not reached for any host'&&~&~An address previously suffered
33582 temporary errors during remote delivery, and the retry time has not yet arrived
33583 for any of the hosts to which it is routed.
33584 .next
33585 .cindex "spool directory" "file locked"
33586 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33587 some other Exim process is already working on the message. This can be quite
33588 common if queue running processes are started at frequent intervals. The
33589 &'exiwhat'& utility script can be used to find out what Exim processes are
33590 doing.
33591 .next
33592 .cindex "error" "ignored"
33593 &'error ignored'&&~&~There are several circumstances that give rise to this
33594 message:
33595 .olist
33596 Exim failed to deliver a bounce message whose age was greater than
33597 &%ignore_bounce_errors_after%&. The bounce was discarded.
33598 .next
33599 A filter file set up a delivery using the &"noerror"& option, and the delivery
33600 failed. The delivery was discarded.
33601 .next
33602 A delivery set up by a router configured with
33603 . ==== As this is a nested list, any displays it contains must be indented
33604 . ==== as otherwise they are too far to the left.
33605 .code
33606     errors_to = <>
33607 .endd
33608 failed. The delivery was discarded.
33609 .endlist olist
33610 .endlist ilist
33611
33612
33613
33614
33615
33616 .section "Reducing or increasing what is logged" "SECTlogselector"
33617 .cindex "log" "selectors"
33618 By setting the &%log_selector%& global option, you can disable some of Exim's
33619 default logging, or you can request additional logging. The value of
33620 &%log_selector%& is made up of names preceded by plus or minus characters. For
33621 example:
33622 .code
33623 log_selector = +arguments -retry_defer
33624 .endd
33625 The list of optional log items is in the following table, with the default
33626 selection marked by asterisks:
33627 .display
33628 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33629 &` address_rewrite            `&  address rewriting
33630 &` all_parents                `&  all parents in => lines
33631 &` arguments                  `&  command line arguments
33632 &`*connection_reject          `&  connection rejections
33633 &`*delay_delivery             `&  immediate delivery delayed
33634 &` deliver_time               `&  time taken to perform delivery
33635 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33636 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33637 &`*etrn                       `&  ETRN commands
33638 &`*host_lookup_failed         `&  as it says
33639 &` ident_timeout              `&  timeout for ident connection
33640 &` incoming_interface         `&  incoming interface on <= lines
33641 &` incoming_port              `&  incoming port on <= lines
33642 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33643 &` outgoing_port              `&  add remote port to => lines
33644 &`*queue_run                  `&  start and end queue runs
33645 &` queue_time                 `&  time on queue for one recipient
33646 &` queue_time_overall         `&  time on queue for whole message
33647 &` pid                        `&  Exim process id
33648 &` received_recipients        `&  recipients on <= lines
33649 &` received_sender            `&  sender on <= lines
33650 &`*rejected_header            `&  header contents on reject log
33651 &`*retry_defer                `&  &"retry time not reached"&
33652 &` return_path_on_delivery    `&  put return path on => and ** lines
33653 &` sender_on_delivery         `&  add sender to => lines
33654 &`*sender_verify_fail         `&  sender verification failures
33655 &`*size_reject                `&  rejection because too big
33656 &`*skip_delivery              `&  delivery skipped in a queue run
33657 &` smtp_confirmation          `&  SMTP confirmation on => lines
33658 &` smtp_connection            `&  SMTP connections
33659 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33660 &` smtp_no_mail               `&  session with no MAIL commands
33661 &` smtp_protocol_error        `&  SMTP protocol errors
33662 &` smtp_syntax_error          `&  SMTP syntax errors
33663 &` subject                    `&  contents of &'Subject:'& on <= lines
33664 &` tls_certificate_verified   `&  certificate verification status
33665 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
33666 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
33667 &` tls_sni                    `&  TLS SNI on <= lines
33668 &` unknown_in_list            `&  DNS lookup failed in list match
33669
33670 &` all                        `&  all of the above
33671 .endd
33672 More details on each of these items follows:
33673
33674 .ilist
33675 .cindex "&%warn%& ACL verb" "log when skipping"
33676 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
33677 its conditions cannot be evaluated, a log line to this effect is written if
33678 this log selector is set.
33679 .next
33680 .cindex "log" "rewriting"
33681 .cindex "rewriting" "logging"
33682 &%address_rewrite%&: This applies both to global rewrites and per-transport
33683 rewrites, but not to rewrites in filters run as an unprivileged user (because
33684 such users cannot access the log).
33685 .next
33686 .cindex "log" "full parentage"
33687 &%all_parents%&: Normally only the original and final addresses are logged on
33688 delivery lines; with this selector, intermediate parents are given in
33689 parentheses between them.
33690 .next
33691 .cindex "log" "Exim arguments"
33692 .cindex "Exim arguments, logging"
33693 &%arguments%&: This causes Exim to write the arguments with which it was called
33694 to the main log, preceded by the current working directory. This is a debugging
33695 feature, added to make it easier to find out how certain MUAs call
33696 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
33697 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
33698 that are empty or that contain white space are quoted. Non-printing characters
33699 are shown as escape sequences. This facility cannot log unrecognized arguments,
33700 because the arguments are checked before the configuration file is read. The
33701 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
33702 between the caller and Exim.
33703 .next
33704 .cindex "log" "connection rejections"
33705 &%connection_reject%&: A log entry is written whenever an incoming SMTP
33706 connection is rejected, for whatever reason.
33707 .next
33708 .cindex "log" "delayed delivery"
33709 .cindex "delayed delivery, logging"
33710 &%delay_delivery%&: A log entry is written whenever a delivery process is not
33711 started for an incoming message because the load is too high or too many
33712 messages were received on one connection. Logging does not occur if no delivery
33713 process is started because &%queue_only%& is set or &%-odq%& was used.
33714 .next
33715 .cindex "log" "delivery duration"
33716 &%deliver_time%&: For each delivery, the amount of real time it has taken to
33717 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
33718 .next
33719 .cindex "log" "message size on delivery"
33720 .cindex "size" "of message"
33721 &%delivery_size%&: For each delivery, the size of message delivered is added to
33722 the &"=>"& line, tagged with S=.
33723 .next
33724 .cindex "log" "dnslist defer"
33725 .cindex "DNS list" "logging defer"
33726 .cindex "black list (DNS)"
33727 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
33728 DNS black list suffers a temporary error.
33729 .next
33730 .cindex "log" "ETRN commands"
33731 .cindex "ETRN" "logging"
33732 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
33733 is run to determine whether or not it is actually accepted. An invalid ETRN
33734 command, or one received within a message transaction is not logged by this
33735 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
33736 .next
33737 .cindex "log" "host lookup failure"
33738 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
33739 any addresses, or when a lookup of an IP address fails to find a host name, a
33740 log line is written. This logging does not apply to direct DNS lookups when
33741 routing email addresses, but it does apply to &"byname"& lookups.
33742 .next
33743 .cindex "log" "ident timeout"
33744 .cindex "RFC 1413" "logging timeout"
33745 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
33746 client's ident port times out.
33747 .next
33748 .cindex "log" "incoming interface"
33749 .cindex "interface" "logging"
33750 &%incoming_interface%&: The interface on which a message was received is added
33751 to the &"<="& line as an IP address in square brackets, tagged by I= and
33752 followed by a colon and the port number. The local interface and port are also
33753 added to other SMTP log lines, for example &"SMTP connection from"&, and to
33754 rejection lines.
33755 .next
33756 .cindex "log" "incoming remote port"
33757 .cindex "port" "logging remote"
33758 .cindex "TCP/IP" "logging incoming remote port"
33759 .vindex "&$sender_fullhost$&"
33760 .vindex "&$sender_rcvhost$&"
33761 &%incoming_port%&: The remote port number from which a message was received is
33762 added to log entries and &'Received:'& header lines, following the IP address
33763 in square brackets, and separated from it by a colon. This is implemented by
33764 changing the value that is put in the &$sender_fullhost$& and
33765 &$sender_rcvhost$& variables. Recording the remote port number has become more
33766 important with the widening use of NAT (see RFC 2505).
33767 .next
33768 .cindex "log" "dropped connection"
33769 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
33770 connection is unexpectedly dropped.
33771 .next
33772 .cindex "log" "outgoing remote port"
33773 .cindex "port" "logging outgoint remote"
33774 .cindex "TCP/IP" "logging ougtoing remote port"
33775 &%outgoing_port%&: The remote port number is added to delivery log lines (those
33776 containing => tags) following the IP address. This option is not included in
33777 the default setting, because for most ordinary configurations, the remote port
33778 number is always 25 (the SMTP port).
33779 .next
33780 .cindex "log" "process ids in"
33781 .cindex "pid (process id)" "in log lines"
33782 &%pid%&: The current process id is added to every log line, in square brackets,
33783 immediately after the time and date.
33784 .next
33785 .cindex "log" "queue run"
33786 .cindex "queue runner" "logging"
33787 &%queue_run%&: The start and end of every queue run are logged.
33788 .next
33789 .cindex "log" "queue time"
33790 &%queue_time%&: The amount of time the message has been in the queue on the
33791 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
33792 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
33793 includes reception time as well as the delivery time for the current address.
33794 This means that it may be longer than the difference between the arrival and
33795 delivery log line times, because the arrival log line is not written until the
33796 message has been successfully received.
33797 .next
33798 &%queue_time_overall%&: The amount of time the message has been in the queue on
33799 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
33800 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
33801 message, so it includes reception time as well as the total delivery time.
33802 .next
33803 .cindex "log" "recipients"
33804 &%received_recipients%&: The recipients of a message are listed in the main log
33805 as soon as the message is received. The list appears at the end of the log line
33806 that is written when a message is received, preceded by the word &"for"&. The
33807 addresses are listed after they have been qualified, but before any rewriting
33808 has taken place.
33809 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
33810 in the list.
33811 .next
33812 .cindex "log" "sender reception"
33813 &%received_sender%&: The unrewritten original sender of a message is added to
33814 the end of the log line that records the message's arrival, after the word
33815 &"from"& (before the recipients if &%received_recipients%& is also set).
33816 .next
33817 .cindex "log" "header lines for rejection"
33818 &%rejected_header%&: If a message's header has been received at the time a
33819 rejection is written to the reject log, the complete header is added to the
33820 log. Header logging can be turned off individually for messages that are
33821 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
33822 .next
33823 .cindex "log" "retry defer"
33824 &%retry_defer%&: A log line is written if a delivery is deferred because a
33825 retry time has not yet been reached. However, this &"retry time not reached"&
33826 message is always omitted from individual message logs after the first delivery
33827 attempt.
33828 .next
33829 .cindex "log" "return path"
33830 &%return_path_on_delivery%&: The return path that is being transmitted with
33831 the message is included in delivery and bounce lines, using the tag P=.
33832 This is omitted if no delivery actually happens, for example, if routing fails,
33833 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
33834 .next
33835 .cindex "log" "sender on delivery"
33836 &%sender_on_delivery%&: The message's sender address is added to every delivery
33837 and bounce line, tagged by F= (for &"from"&).
33838 This is the original sender that was received with the message; it is not
33839 necessarily the same as the outgoing return path.
33840 .next
33841 .cindex "log" "sender verify failure"
33842 &%sender_verify_fail%&: If this selector is unset, the separate log line that
33843 gives details of a sender verification failure is not written. Log lines for
33844 the rejection of SMTP commands contain just &"sender verify failed"&, so some
33845 detail is lost.
33846 .next
33847 .cindex "log" "size rejection"
33848 &%size_reject%&: A log line is written whenever a message is rejected because
33849 it is too big.
33850 .next
33851 .cindex "log" "frozen messages; skipped"
33852 .cindex "frozen messages" "logging skipping"
33853 &%skip_delivery%&: A log line is written whenever a message is skipped during a
33854 queue run because it is frozen or because another process is already delivering
33855 it.
33856 .cindex "&""spool file is locked""&"
33857 The message that is written is &"spool file is locked"&.
33858 .next
33859 .cindex "log" "smtp confirmation"
33860 .cindex "SMTP" "logging confirmation"
33861 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
33862 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
33863 A number of MTAs (including Exim) return an identifying string in this
33864 response.
33865 .next
33866 .cindex "log" "SMTP connections"
33867 .cindex "SMTP" "logging connections"
33868 &%smtp_connection%&: A log line is written whenever an SMTP connection is
33869 established or closed, unless the connection is from a host that matches
33870 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
33871 only when the closure is unexpected.) This applies to connections from local
33872 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
33873 dropped in the middle of a message, a log line is always written, whether or
33874 not this selector is set, but otherwise nothing is written at the start and end
33875 of connections unless this selector is enabled.
33876
33877 For TCP/IP connections to an Exim daemon, the current number of connections is
33878 included in the log message for each new connection, but note that the count is
33879 reset if the daemon is restarted.
33880 Also, because connections are closed (and the closure is logged) in
33881 subprocesses, the count may not include connections that have been closed but
33882 whose termination the daemon has not yet noticed. Thus, while it is possible to
33883 match up the opening and closing of connections in the log, the value of the
33884 logged counts may not be entirely accurate.
33885 .next
33886 .cindex "log" "SMTP transaction; incomplete"
33887 .cindex "SMTP" "logging incomplete transactions"
33888 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
33889 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
33890 and the message sender plus any accepted recipients are included in the log
33891 line. This can provide evidence of dictionary attacks.
33892 .next
33893 .cindex "log" "non-MAIL SMTP sessions"
33894 .cindex "MAIL" "logging session without"
33895 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
33896 connection terminates without having issued a MAIL command. This includes both
33897 the case when the connection is dropped, and the case when QUIT is used. It
33898 does not include cases where the connection is rejected right at the start (by
33899 an ACL, or because there are too many connections, or whatever). These cases
33900 already have their own log lines.
33901
33902 The log line that is written contains the identity of the client in the usual
33903 way, followed by D= and a time, which records the duration of the connection.
33904 If the connection was authenticated, this fact is logged exactly as it is for
33905 an incoming message, with an A= item. If the connection was encrypted, CV=,
33906 DN=, and X= items may appear as they do for an incoming message, controlled by
33907 the same logging options.
33908
33909 Finally, if any SMTP commands were issued during the connection, a C= item
33910 is added to the line, listing the commands that were used. For example,
33911 .code
33912 C=EHLO,QUIT
33913 .endd
33914 shows that the client issued QUIT straight after EHLO. If there were fewer
33915 than 20 commands, they are all listed. If there were more than 20 commands,
33916 the last 20 are listed, preceded by &"..."&. However, with the default
33917 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
33918 have been aborted before 20 non-mail commands are processed.
33919 .next
33920 .cindex "log" "SMTP protocol error"
33921 .cindex "SMTP" "logging protocol error"
33922 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
33923 encountered. Exim does not have perfect detection of all protocol errors
33924 because of transmission delays and the use of pipelining. If PIPELINING has
33925 been advertised to a client, an Exim server assumes that the client will use
33926 it, and therefore it does not count &"expected"& errors (for example, RCPT
33927 received after rejecting MAIL) as protocol errors.
33928 .next
33929 .cindex "SMTP" "logging syntax errors"
33930 .cindex "SMTP" "syntax errors; logging"
33931 .cindex "SMTP" "unknown command; logging"
33932 .cindex "log" "unknown SMTP command"
33933 .cindex "log" "SMTP syntax error"
33934 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
33935 encountered. An unrecognized command is treated as a syntax error. For an
33936 external connection, the host identity is given; for an internal connection
33937 using &%-bs%& the sender identification (normally the calling user) is given.
33938 .next
33939 .cindex "log" "subject"
33940 .cindex "subject, logging"
33941 &%subject%&: The subject of the message is added to the arrival log line,
33942 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
33943 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
33944 specifies whether characters with values greater than 127 should be logged
33945 unchanged, or whether they should be rendered as escape sequences.
33946 .next
33947 .cindex "log" "certificate verification"
33948 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
33949 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
33950 verified, and &`CV=no`& if not.
33951 .next
33952 .cindex "log" "TLS cipher"
33953 .cindex "TLS" "logging cipher"
33954 &%tls_cipher%&: When a message is sent or received over an encrypted
33955 connection, the cipher suite used is added to the log line, preceded by X=.
33956 .next
33957 .cindex "log" "TLS peer DN"
33958 .cindex "TLS" "logging peer DN"
33959 &%tls_peerdn%&: When a message is sent or received over an encrypted
33960 connection, and a certificate is supplied by the remote host, the peer DN is
33961 added to the log line, preceded by DN=.
33962 .next
33963 .cindex "log" "TLS SNI"
33964 .cindex "TLS" "logging SNI"
33965 &%tls_sni%&: When a message is received over an encrypted connection, and
33966 the remote host provided the Server Name Indication extension, the SNI is
33967 added to the log line, preceded by SNI=.
33968 .next
33969 .cindex "log" "DNS failure in list"
33970 &%unknown_in_list%&: This setting causes a log entry to be written when the
33971 result of a list match is failure because a DNS lookup failed.
33972 .endlist
33973
33974
33975 .section "Message log" "SECID260"
33976 .cindex "message" "log file for"
33977 .cindex "log" "message log; description of"
33978 .cindex "&_msglog_& directory"
33979 .oindex "&%preserve_message_logs%&"
33980 In addition to the general log files, Exim writes a log file for each message
33981 that it handles. The names of these per-message logs are the message ids, and
33982 they are kept in the &_msglog_& sub-directory of the spool directory. Each
33983 message log contains copies of the log lines that apply to the message. This
33984 makes it easier to inspect the status of an individual message without having
33985 to search the main log. A message log is deleted when processing of the message
33986 is complete, unless &%preserve_message_logs%& is set, but this should be used
33987 only with great care because they can fill up your disk very quickly.
33988
33989 On a heavily loaded system, it may be desirable to disable the use of
33990 per-message logs, in order to reduce disk I/O. This can be done by setting the
33991 &%message_logs%& option false.
33992 .ecindex IIDloggen
33993
33994
33995
33996
33997 . ////////////////////////////////////////////////////////////////////////////
33998 . ////////////////////////////////////////////////////////////////////////////
33999
34000 .chapter "Exim utilities" "CHAPutils"
34001 .scindex IIDutils "utilities"
34002 A number of utility scripts and programs are supplied with Exim and are
34003 described in this chapter. There is also the Exim Monitor, which is covered in
34004 the next chapter. The utilities described here are:
34005
34006 .itable none 0 0 3  7* left  15* left  40* left
34007 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
34008   "list what Exim processes are doing"
34009 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
34010 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
34011 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
34012 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
34013                                                 various criteria"
34014 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
34015 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
34016   "extract statistics from the log"
34017 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
34018   "check address acceptance from given IP"
34019 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
34020 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
34021 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
34022 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
34023 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
34024 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
34025 .endtable
34026
34027 Another utility that might be of use to sites with many MTAs is Tom Kistner's
34028 &'exilog'&. It provides log visualizations across multiple Exim servers. See
34029 &url(http://duncanthrax.net/exilog/) for details.
34030
34031
34032
34033
34034 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
34035 .cindex "&'exiwhat'&"
34036 .cindex "process, querying"
34037 .cindex "SIGUSR1"
34038 On operating systems that can restart a system call after receiving a signal
34039 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
34040 a line describing what it is doing to the file &_exim-process.info_& in the
34041 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
34042 processes it can find, having first emptied the file. It then waits for one
34043 second to allow the Exim processes to react before displaying the results. In
34044 order to run &'exiwhat'& successfully you have to have sufficient privilege to
34045 send the signal to the Exim processes, so it is normally run as root.
34046
34047 &*Warning*&: This is not an efficient process. It is intended for occasional
34048 use by system administrators. It is not sensible, for example, to set up a
34049 script that sends SIGUSR1 signals to Exim processes at short intervals.
34050
34051
34052 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
34053 varies in different operating systems. Not only are different options used,
34054 but the format of the output is different. For this reason, there are some
34055 system configuration options that configure exactly how &'exiwhat'& works. If
34056 it doesn't seem to be working for you, check the following compile-time
34057 options:
34058 .display
34059 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
34060 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
34061 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
34062 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
34063 .endd
34064 An example of typical output from &'exiwhat'& is
34065 .code
34066 164 daemon: -q1h, listening on port 25
34067 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
34068 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
34069   [10.19.42.42] (editor@ref.example)
34070 10592 handling incoming call from [192.168.243.242]
34071 10628 accepting a local non-SMTP message
34072 .endd
34073 The first number in the output line is the process number. The third line has
34074 been split here, in order to fit it on the page.
34075
34076
34077
34078 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
34079 .cindex "&'exiqgrep'&"
34080 .cindex "queue" "grepping"
34081 This utility is a Perl script contributed by Matt Hubbard. It runs
34082 .code
34083 exim -bpu
34084 .endd
34085 to obtain a queue listing with undelivered recipients only, and then greps the
34086 output to select messages that match given criteria. The following selection
34087 options are available:
34088
34089 .vlist
34090 .vitem &*-f*&&~<&'regex'&>
34091 Match the sender address. The field that is tested is enclosed in angle
34092 brackets, so you can test for bounce messages with
34093 .code
34094 exiqgrep -f '^<>$'
34095 .endd
34096 .vitem &*-r*&&~<&'regex'&>
34097 Match a recipient address. The field that is tested is not enclosed in angle
34098 brackets.
34099
34100 .vitem &*-s*&&~<&'regex'&>
34101 Match against the size field.
34102
34103 .vitem &*-y*&&~<&'seconds'&>
34104 Match messages that are younger than the given time.
34105
34106 .vitem &*-o*&&~<&'seconds'&>
34107 Match messages that are older than the given time.
34108
34109 .vitem &*-z*&
34110 Match only frozen messages.
34111
34112 .vitem &*-x*&
34113 Match only non-frozen messages.
34114 .endlist
34115
34116 The following options control the format of the output:
34117
34118 .vlist
34119 .vitem &*-c*&
34120 Display only the count of matching messages.
34121
34122 .vitem &*-l*&
34123 Long format &-- display the full message information as output by Exim. This is
34124 the default.
34125
34126 .vitem &*-i*&
34127 Display message ids only.
34128
34129 .vitem &*-b*&
34130 Brief format &-- one line per message.
34131
34132 .vitem &*-R*&
34133 Display messages in reverse order.
34134 .endlist
34135
34136 There is one more option, &%-h%&, which outputs a list of options.
34137
34138
34139
34140 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
34141 .cindex "&'exiqsumm'&"
34142 .cindex "queue" "summary"
34143 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
34144 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
34145 running a command such as
34146 .code
34147 exim -bp | exiqsumm
34148 .endd
34149 The output consists of one line for each domain that has messages waiting for
34150 it, as in the following example:
34151 .code
34152 3   2322   74m   66m  msn.com.example
34153 .endd
34154 Each line lists the number of pending deliveries for a domain, their total
34155 volume, and the length of time that the oldest and the newest messages have
34156 been waiting. Note that the number of pending deliveries is greater than the
34157 number of messages when messages have more than one recipient.
34158
34159 A summary line is output at the end. By default the output is sorted on the
34160 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
34161 the output to be sorted by oldest message and by count of messages,
34162 respectively. There are also three options that split the messages for each
34163 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
34164 separates frozen messages, and &%-s%& separates messages according to their
34165 sender.
34166
34167 The output of &'exim -bp'& contains the original addresses in the message, so
34168 this also applies to the output from &'exiqsumm'&. No domains from addresses
34169 generated by aliasing or forwarding are included (unless the &%one_time%&
34170 option of the &(redirect)& router has been used to convert them into &"top
34171 level"& addresses).
34172
34173
34174
34175
34176 .section "Extracting specific information from the log (exigrep)" &&&
34177          "SECTextspeinf"
34178 .cindex "&'exigrep'&"
34179 .cindex "log" "extracts; grepping for"
34180 The &'exigrep'& utility is a Perl script that searches one or more main log
34181 files for entries that match a given pattern. When it finds a match, it
34182 extracts all the log entries for the relevant message, not just those that
34183 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
34184 given message, or all mail for a given user, or for a given host, for example.
34185 The input files can be in Exim log format or syslog format.
34186 If a matching log line is not associated with a specific message, it is
34187 included in &'exigrep'&'s output without any additional lines. The usage is:
34188 .display
34189 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
34190 .endd
34191 If no log file names are given on the command line, the standard input is read.
34192
34193 The &%-t%& argument specifies a number of seconds. It adds an additional
34194 condition for message selection. Messages that are complete are shown only if
34195 they spent more than <&'n'&> seconds on the queue.
34196
34197 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
34198 makes it case-sensitive. This may give a performance improvement when searching
34199 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
34200 option; with &%-I%& they do not. In both cases it is possible to change the
34201 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
34202
34203 The &%-l%& option means &"literal"&, that is, treat all characters in the
34204 pattern as standing for themselves. Otherwise the pattern must be a Perl
34205 regular expression.
34206
34207 The &%-v%& option inverts the matching condition. That is, a line is selected
34208 if it does &'not'& match the pattern.
34209
34210 If the location of a &'zcat'& command is known from the definition of
34211 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
34212 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
34213
34214
34215 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
34216 .cindex "&'exipick'&"
34217 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
34218 lists messages from the queue according to a variety of criteria. For details
34219 of &'exipick'&'s facilities, visit the web page at
34220 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
34221 the &%--help%& option.
34222
34223
34224 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
34225 .cindex "log" "cycling local files"
34226 .cindex "cycling logs"
34227 .cindex "&'exicyclog'&"
34228 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
34229 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
34230 you are using log files with datestamps in their names (see section
34231 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
34232 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
34233 There are two command line options for &'exicyclog'&:
34234 .ilist
34235 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
34236 default that is set when Exim is built. The default default is 10.
34237 .next
34238 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
34239 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
34240 overriding the script's default, which is to find the setting from Exim's
34241 configuration.
34242 .endlist
34243
34244 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
34245 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
34246 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
34247 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
34248 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
34249 logs are handled similarly.
34250
34251 If the limit is greater than 99, the script uses 3-digit numbers such as
34252 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
34253 to one that is greater, or &'vice versa'&, you will have to fix the names of
34254 any existing log files.
34255
34256 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
34257 the end are deleted. All files with numbers greater than 01 are compressed,
34258 using a compression command which is configured by the COMPRESS_COMMAND
34259 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
34260 root &%crontab%& entry of the form
34261 .code
34262 1 0 * * * su exim -c /usr/exim/bin/exicyclog
34263 .endd
34264 assuming you have used the name &"exim"& for the Exim user. You can run
34265 &'exicyclog'& as root if you wish, but there is no need.
34266
34267
34268
34269 .section "Mail statistics (eximstats)" "SECTmailstat"
34270 .cindex "statistics"
34271 .cindex "&'eximstats'&"
34272 A Perl script called &'eximstats'& is provided for extracting statistical
34273 information from log files. The output is either plain text, or HTML.
34274 Exim log files are also supported by the &'Lire'& system produced by the
34275 LogReport Foundation &url(http://www.logreport.org).
34276
34277 The &'eximstats'& script has been hacked about quite a bit over time. The
34278 latest version is the result of some extensive revision by Steve Campbell. A
34279 lot of information is given by default, but there are options for suppressing
34280 various parts of it. Following any options, the arguments to the script are a
34281 list of files, which should be main log files. For example:
34282 .code
34283 eximstats -nr /var/spool/exim/log/mainlog.01
34284 .endd
34285 By default, &'eximstats'& extracts information about the number and volume of
34286 messages received from or delivered to various hosts. The information is sorted
34287 both by message count and by volume, and the top fifty hosts in each category
34288 are listed on the standard output. Similar information, based on email
34289 addresses or domains instead of hosts can be requested by means of various
34290 options. For messages delivered and received locally, similar statistics are
34291 also produced per user.
34292
34293 The output also includes total counts and statistics about delivery errors, and
34294 histograms showing the number of messages received and deliveries made in each
34295 hour of the day. A delivery with more than one address in its envelope (for
34296 example, an SMTP transaction with more than one RCPT command) is counted
34297 as a single delivery by &'eximstats'&.
34298
34299 Though normally more deliveries than receipts are reported (as messages may
34300 have multiple recipients), it is possible for &'eximstats'& to report more
34301 messages received than delivered, even though the queue is empty at the start
34302 and end of the period in question. If an incoming message contains no valid
34303 recipients, no deliveries are recorded for it. A bounce message is handled as
34304 an entirely separate message.
34305
34306 &'eximstats'& always outputs a grand total summary giving the volume and number
34307 of messages received and deliveries made, and the number of hosts involved in
34308 each case. It also outputs the number of messages that were delayed (that is,
34309 not completely delivered at the first attempt), and the number that had at
34310 least one address that failed.
34311
34312 The remainder of the output is in sections that can be independently disabled
34313 or modified by various options. It consists of a summary of deliveries by
34314 transport, histograms of messages received and delivered per time interval
34315 (default per hour), information about the time messages spent on the queue,
34316 a list of relayed messages, lists of the top fifty sending hosts, local
34317 senders, destination hosts, and destination local users by count and by volume,
34318 and a list of delivery errors that occurred.
34319
34320 The relay information lists messages that were actually relayed, that is, they
34321 came from a remote host and were directly delivered to some other remote host,
34322 without being processed (for example, for aliasing or forwarding) locally.
34323
34324 There are quite a few options for &'eximstats'& to control exactly what it
34325 outputs. These are documented in the Perl script itself, and can be extracted
34326 by running the command &(perldoc)& on the script. For example:
34327 .code
34328 perldoc /usr/exim/bin/eximstats
34329 .endd
34330
34331 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
34332 .cindex "&'exim_checkaccess'&"
34333 .cindex "policy control" "checking access"
34334 .cindex "checking access"
34335 The &%-bh%& command line argument allows you to run a fake SMTP session with
34336 debugging output, in order to check what Exim is doing when it is applying
34337 policy controls to incoming SMTP mail. However, not everybody is sufficiently
34338 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
34339 sometimes you just want to answer the question &"Does this address have
34340 access?"& without bothering with any further details.
34341
34342 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
34343 two arguments, an IP address and an email address:
34344 .code
34345 exim_checkaccess 10.9.8.7 A.User@a.domain.example
34346 .endd
34347 The utility runs a call to Exim with the &%-bh%& option, to test whether the
34348 given email address would be accepted in a RCPT command in a TCP/IP
34349 connection from the host with the given IP address. The output of the utility
34350 is either the word &"accepted"&, or the SMTP error response, for example:
34351 .code
34352 Rejected:
34353 550 Relay not permitted
34354 .endd
34355 When running this test, the utility uses &`<>`& as the envelope sender address
34356 for the MAIL command, but you can change this by providing additional
34357 options. These are passed directly to the Exim command. For example, to specify
34358 that the test is to be run with the sender address &'himself@there.example'&
34359 you can use:
34360 .code
34361 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34362                  -f himself@there.example
34363 .endd
34364 Note that these additional Exim command line items must be given after the two
34365 mandatory arguments.
34366
34367 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34368 while running its checks. You can run checks that include callouts by using
34369 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34370
34371
34372
34373 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34374 .cindex "DBM" "building dbm files"
34375 .cindex "building DBM files"
34376 .cindex "&'exim_dbmbuild'&"
34377 .cindex "lower casing"
34378 .cindex "binary zero" "in lookup key"
34379 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34380 the format used by the &(lsearch)& lookup (see section
34381 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34382 names as keys and the remainder of the information as data. The lower-casing
34383 can be prevented by calling the program with the &%-nolc%& option.
34384
34385 A terminating zero is included as part of the key string. This is expected by
34386 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34387 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34388 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34389 files.
34390
34391 The program requires two arguments: the name of the input file (which can be a
34392 single hyphen to indicate the standard input), and the name of the output file.
34393 It creates the output under a temporary name, and then renames it if all went
34394 well.
34395
34396 .cindex "USE_DB"
34397 If the native DB interface is in use (USE_DB is set in a compile-time
34398 configuration file &-- this is common in free versions of Unix) the two file
34399 names must be different, because in this mode the Berkeley DB functions create
34400 a single output file using exactly the name given. For example,
34401 .code
34402 exim_dbmbuild /etc/aliases /etc/aliases.db
34403 .endd
34404 reads the system alias file and creates a DBM version of it in
34405 &_/etc/aliases.db_&.
34406
34407 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34408 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34409 environment, the suffixes are added to the second argument of
34410 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34411 when the Berkeley functions are used in compatibility mode (though this is not
34412 recommended), because in that case it adds a &_.db_& suffix to the file name.
34413
34414 If a duplicate key is encountered, the program outputs a warning, and when it
34415 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34416 option is used. By default, only the first of a set of duplicates is used &--
34417 this makes it compatible with &(lsearch)& lookups. There is an option
34418 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34419 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34420 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34421 return code is 2.
34422
34423
34424
34425
34426 .section "Finding individual retry times (exinext)" "SECTfinindret"
34427 .cindex "retry" "times"
34428 .cindex "&'exinext'&"
34429 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34430 fish specific information out of the retry database. Given a mail domain (or a
34431 complete address), it looks up the hosts for that domain, and outputs any retry
34432 information for the hosts or for the domain. At present, the retry information
34433 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34434 output. For example:
34435 .code
34436 $ exinext piglet@milne.fict.example
34437 kanga.milne.example:192.168.8.1 error 146: Connection refused
34438   first failed: 21-Feb-1996 14:57:34
34439   last tried:   21-Feb-1996 14:57:34
34440   next try at:  21-Feb-1996 15:02:34
34441 roo.milne.example:192.168.8.3 error 146: Connection refused
34442   first failed: 20-Jan-1996 13:12:08
34443   last tried:   21-Feb-1996 11:42:03
34444   next try at:  21-Feb-1996 19:42:03
34445   past final cutoff time
34446 .endd
34447 You can also give &'exinext'& a local part, without a domain, and it
34448 will give any retry information for that local part in your default domain.
34449 A message id can be used to obtain retry information pertaining to a specific
34450 message. This exists only when an attempt to deliver a message to a remote host
34451 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34452 &'exinext'& is not particularly efficient, but then it is not expected to be
34453 run very often.
34454
34455 The &'exinext'& utility calls Exim to find out information such as the location
34456 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34457 passed on to the &'exim'& commands. The first specifies an alternate Exim
34458 configuration file, and the second sets macros for use within the configuration
34459 file. These features are mainly to help in testing, but might also be useful in
34460 environments where more than one configuration file is in use.
34461
34462
34463
34464 .section "Hints database maintenance" "SECThindatmai"
34465 .cindex "hints database" "maintenance"
34466 .cindex "maintaining Exim's hints database"
34467 Three utility programs are provided for maintaining the DBM files that Exim
34468 uses to contain its delivery hint information. Each program requires two
34469 arguments. The first specifies the name of Exim's spool directory, and the
34470 second is the name of the database it is to operate on. These are as follows:
34471
34472 .ilist
34473 &'retry'&: the database of retry information
34474 .next
34475 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34476 for remote hosts
34477 .next
34478 &'callout'&: the callout cache
34479 .next
34480 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34481 .next
34482 &'misc'&: other hints data
34483 .endlist
34484
34485 The &'misc'& database is used for
34486
34487 .ilist
34488 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34489 .next
34490 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34491 &(smtp)& transport)
34492 .endlist
34493
34494
34495
34496 .section "exim_dumpdb" "SECID261"
34497 .cindex "&'exim_dumpdb'&"
34498 The entire contents of a database are written to the standard output by the
34499 &'exim_dumpdb'& program, which has no options or arguments other than the
34500 spool and database names. For example, to dump the retry database:
34501 .code
34502 exim_dumpdb /var/spool/exim retry
34503 .endd
34504 Two lines of output are produced for each entry:
34505 .code
34506 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34507 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34508 .endd
34509 The first item on the first line is the key of the record. It starts with one
34510 of the letters R, or T, depending on whether it refers to a routing or
34511 transport retry. For a local delivery, the next part is the local address; for
34512 a remote delivery it is the name of the remote host, followed by its failing IP
34513 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34514 transport). If the remote port is not the standard one (port 25), it is added
34515 to the IP address. Then there follows an error code, an additional error code,
34516 and a textual description of the error.
34517
34518 The three times on the second line are the time of first failure, the time of
34519 the last delivery attempt, and the computed time for the next attempt. The line
34520 ends with an asterisk if the cutoff time for the last retry rule has been
34521 exceeded.
34522
34523 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34524 consists of a host name followed by a list of ids for messages that are or were
34525 waiting to be delivered to that host. If there are a very large number for any
34526 one host, continuation records, with a sequence number added to the host name,
34527 may be seen. The data in these records is often out of date, because a message
34528 may be routed to several alternative hosts, and Exim makes no effort to keep
34529 cross-references.
34530
34531
34532
34533 .section "exim_tidydb" "SECID262"
34534 .cindex "&'exim_tidydb'&"
34535 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34536 database. If run with no options, it removes all records that are more than 30
34537 days old. The age is calculated from the date and time that the record was last
34538 updated. Note that, in the case of the retry database, it is &'not'& the time
34539 since the first delivery failure. Information about a host that has been down
34540 for more than 30 days will remain in the database, provided that the record is
34541 updated sufficiently often.
34542
34543 The cutoff date can be altered by means of the &%-t%& option, which must be
34544 followed by a time. For example, to remove all records older than a week from
34545 the retry database:
34546 .code
34547 exim_tidydb -t 7d /var/spool/exim retry
34548 .endd
34549 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34550 message ids. In the former these appear as data in records keyed by host &--
34551 they were messages that were waiting for that host &-- and in the latter they
34552 are the keys for retry information for messages that have suffered certain
34553 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34554 message ids in database records are those of messages that are still on the
34555 queue. Message ids for messages that no longer exist are removed from
34556 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34557 For the &'retry'& database, records whose keys are non-existent message ids are
34558 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34559 whenever it removes information from the database.
34560
34561 Certain records are automatically removed by Exim when they are no longer
34562 needed, but others are not. For example, if all the MX hosts for a domain are
34563 down, a retry record is created for each one. If the primary MX host comes back
34564 first, its record is removed when Exim successfully delivers to it, but the
34565 records for the others remain because Exim has not tried to use those hosts.
34566
34567 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34568 hints databases. You should do this at a quiet time of day, because it requires
34569 a database to be locked (and therefore inaccessible to Exim) while it does its
34570 work. Removing records from a DBM file does not normally make the file smaller,
34571 but all the common DBM libraries are able to re-use the space that is released.
34572 After an initial phase of increasing in size, the databases normally reach a
34573 point at which they no longer get any bigger, as long as they are regularly
34574 tidied.
34575
34576 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34577 databases is likely to keep on increasing.
34578
34579
34580
34581
34582 .section "exim_fixdb" "SECID263"
34583 .cindex "&'exim_fixdb'&"
34584 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34585 Its main use is for testing Exim, but it might also be occasionally useful for
34586 getting round problems in a live system. It has no options, and its interface
34587 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34588 key of a database record can then be entered, and the data for that record is
34589 displayed.
34590
34591 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34592 except the &'retry'& database, that is the only operation that can be carried
34593 out. For the &'retry'& database, each field is output preceded by a number, and
34594 data for individual fields can be changed by typing the field number followed
34595 by new data, for example:
34596 .code
34597 > 4 951102:1000
34598 .endd
34599 resets the time of the next delivery attempt. Time values are given as a
34600 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34601 used as optional separators.
34602
34603
34604
34605
34606 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34607 .cindex "mailbox" "maintenance"
34608 .cindex "&'exim_lock'&"
34609 .cindex "locking mailboxes"
34610 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34611 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34612 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34613 a user agent while investigating a problem. The utility requires the name of
34614 the file as its first argument. If the locking is successful, the second
34615 argument is run as a command (using C's &[system()]& function); if there is no
34616 second argument, the value of the SHELL environment variable is used; if this
34617 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34618 is unlocked and the utility ends. The following options are available:
34619
34620 .vlist
34621 .vitem &%-fcntl%&
34622 Use &[fcntl()]& locking on the open mailbox.
34623
34624 .vitem &%-flock%&
34625 Use &[flock()]& locking on the open mailbox, provided the operating system
34626 supports it.
34627
34628 .vitem &%-interval%&
34629 This must be followed by a number, which is a number of seconds; it sets the
34630 interval to sleep between retries (default 3).
34631
34632 .vitem &%-lockfile%&
34633 Create a lock file before opening the mailbox.
34634
34635 .vitem &%-mbx%&
34636 Lock the mailbox using MBX rules.
34637
34638 .vitem &%-q%&
34639 Suppress verification output.
34640
34641 .vitem &%-retries%&
34642 This must be followed by a number; it sets the number of times to try to get
34643 the lock (default 10).
34644
34645 .vitem &%-restore_time%&
34646 This option causes &%exim_lock%& to restore the modified and read times to the
34647 locked file before exiting. This allows you to access a locked mailbox (for
34648 example, to take a backup copy) without disturbing the times that the user
34649 subsequently sees.
34650
34651 .vitem &%-timeout%&
34652 This must be followed by a number, which is a number of seconds; it sets a
34653 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
34654 default), a non-blocking call is used.
34655
34656 .vitem &%-v%&
34657 Generate verbose output.
34658 .endlist
34659
34660 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
34661 default is to create a lock file and also to use &[fcntl()]& locking on the
34662 mailbox, which is the same as Exim's default. The use of &%-flock%& or
34663 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
34664 requires that the directory containing the file be writeable. Locking by lock
34665 file does not last for ever; Exim assumes that a lock file is expired if it is
34666 more than 30 minutes old.
34667
34668 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
34669 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
34670 to be taken out on the open mailbox, and an exclusive lock on the file
34671 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
34672 number of the mailbox file. When the locking is released, if an exclusive lock
34673 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
34674
34675 The default output contains verification of the locking that takes place. The
34676 &%-v%& option causes some additional information to be given. The &%-q%& option
34677 suppresses all output except error messages.
34678
34679 A command such as
34680 .code
34681 exim_lock /var/spool/mail/spqr
34682 .endd
34683 runs an interactive shell while the file is locked, whereas
34684 .display
34685 &`exim_lock -q /var/spool/mail/spqr <<End`&
34686 <&'some commands'&>
34687 &`End`&
34688 .endd
34689 runs a specific non-interactive sequence of commands while the file is locked,
34690 suppressing all verification output. A single command can be run by a command
34691 such as
34692 .code
34693 exim_lock -q /var/spool/mail/spqr \
34694   "cp /var/spool/mail/spqr /some/where"
34695 .endd
34696 Note that if a command is supplied, it must be entirely contained within the
34697 second argument &-- hence the quotes.
34698 .ecindex IIDutils
34699
34700
34701 . ////////////////////////////////////////////////////////////////////////////
34702 . ////////////////////////////////////////////////////////////////////////////
34703
34704 .chapter "The Exim monitor" "CHAPeximon"
34705 .scindex IIDeximon "Exim monitor" "description"
34706 .cindex "X-windows"
34707 .cindex "&'eximon'&"
34708 .cindex "Local/eximon.conf"
34709 .cindex "&_exim_monitor/EDITME_&"
34710 The Exim monitor is an application which displays in an X window information
34711 about the state of Exim's queue and what Exim is doing. An admin user can
34712 perform certain operations on messages from this GUI interface; however all
34713 such facilities are also available from the command line, and indeed, the
34714 monitor itself makes use of the command line to perform any actions requested.
34715
34716
34717
34718 .section "Running the monitor" "SECID264"
34719 The monitor is started by running the script called &'eximon'&. This is a shell
34720 script that sets up a number of environment variables, and then runs the
34721 binary called &_eximon.bin_&. The default appearance of the monitor window can
34722 be changed by editing the &_Local/eximon.conf_& file created by editing
34723 &_exim_monitor/EDITME_&. Comments in that file describe what the various
34724 parameters are for.
34725
34726 The parameters that get built into the &'eximon'& script can be overridden for
34727 a particular invocation by setting up environment variables of the same names,
34728 preceded by &`EXIMON_`&. For example, a shell command such as
34729 .code
34730 EXIMON_LOG_DEPTH=400 eximon
34731 .endd
34732 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
34733 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
34734 overrides the Exim log file configuration. This makes it possible to have
34735 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
34736 syslog messages are routed to a file on the local host.
34737
34738 X resources can be used to change the appearance of the window in the normal
34739 way. For example, a resource setting of the form
34740 .code
34741 Eximon*background: gray94
34742 .endd
34743 changes the colour of the background to light grey rather than white. The
34744 stripcharts are drawn with both the data lines and the reference lines in
34745 black. This means that the reference lines are not visible when on top of the
34746 data. However, their colour can be changed by setting a resource called
34747 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
34748 For example, if your X server is running Unix, you could set up lighter
34749 reference lines in the stripcharts by obeying
34750 .code
34751 xrdb -merge <<End
34752 Eximon*highlight: gray
34753 End
34754 .endd
34755 .cindex "admin user"
34756 In order to see the contents of messages on the queue, and to operate on them,
34757 &'eximon'& must either be run as root or by an admin user.
34758
34759 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
34760 contain X11 resource parameters interpreted by the X11 library.  In addition,
34761 if the first parameter starts with the string "gdb" then it is removed and the
34762 binary is invoked under gdb (the parameter is used as the gdb command-name, so
34763 versioned variants of gdb can be invoked).
34764
34765 The monitor's window is divided into three parts. The first contains one or
34766 more stripcharts and two action buttons, the second contains a &"tail"& of the
34767 main log file, and the third is a display of the queue of messages awaiting
34768 delivery, with two more action buttons. The following sections describe these
34769 different parts of the display.
34770
34771
34772
34773
34774 .section "The stripcharts" "SECID265"
34775 .cindex "stripchart"
34776 The first stripchart is always a count of messages on the queue. Its name can
34777 be configured by setting QUEUE_STRIPCHART_NAME in the
34778 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
34779 configuration script by regular expression matches on log file entries, making
34780 it possible to display, for example, counts of messages delivered to certain
34781 hosts or using certain transports. The supplied defaults display counts of
34782 received and delivered messages, and of local and SMTP deliveries. The default
34783 period between stripchart updates is one minute; this can be adjusted by a
34784 parameter in the &_Local/eximon.conf_& file.
34785
34786 The stripchart displays rescale themselves automatically as the value they are
34787 displaying changes. There are always 10 horizontal lines in each chart; the
34788 title string indicates the value of each division when it is greater than one.
34789 For example, &"x2"& means that each division represents a value of 2.
34790
34791 It is also possible to have a stripchart which shows the percentage fullness of
34792 a particular disk partition, which is useful when local deliveries are confined
34793 to a single partition.
34794
34795 .cindex "&%statvfs%& function"
34796 This relies on the availability of the &[statvfs()]& function or equivalent in
34797 the operating system. Most, but not all versions of Unix that support Exim have
34798 this. For this particular stripchart, the top of the chart always represents
34799 100%, and the scale is given as &"x10%"&. This chart is configured by setting
34800 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
34801 &_Local/eximon.conf_& file.
34802
34803
34804
34805
34806 .section "Main action buttons" "SECID266"
34807 .cindex "size" "of monitor window"
34808 .cindex "Exim monitor" "window size"
34809 .cindex "window size"
34810 Below the stripcharts there is an action button for quitting the monitor. Next
34811 to this is another button marked &"Size"&. They are placed here so that
34812 shrinking the window to its default minimum size leaves just the queue count
34813 stripchart and these two buttons visible. Pressing the &"Size"& button causes
34814 the window to expand to its maximum size, unless it is already at the maximum,
34815 in which case it is reduced to its minimum.
34816
34817 When expanding to the maximum, if the window cannot be fully seen where it
34818 currently is, it is moved back to where it was the last time it was at full
34819 size. When it is expanding from its minimum size, the old position is
34820 remembered, and next time it is reduced to the minimum it is moved back there.
34821
34822 The idea is that you can keep a reduced window just showing one or two
34823 stripcharts at a convenient place on your screen, easily expand it to show
34824 the full window when required, and just as easily put it back to what it was.
34825 The idea is copied from what the &'twm'& window manager does for its
34826 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
34827 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
34828
34829 Normally, the monitor starts up with the window at its full size, but it can be
34830 built so that it starts up with the window at its smallest size, by setting
34831 START_SMALL=yes in &_Local/eximon.conf_&.
34832
34833
34834
34835 .section "The log display" "SECID267"
34836 .cindex "log" "tail of; in monitor"
34837 The second section of the window is an area in which a display of the tail of
34838 the main log is maintained.
34839 To save space on the screen, the timestamp on each log line is shortened by
34840 removing the date and, if &%log_timezone%& is set, the timezone.
34841 The log tail is not available when the only destination for logging data is
34842 syslog, unless the syslog lines are routed to a local file whose name is passed
34843 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
34844
34845 The log sub-window has a scroll bar at its lefthand side which can be used to
34846 move back to look at earlier text, and the up and down arrow keys also have a
34847 scrolling effect. The amount of log that is kept depends on the setting of
34848 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
34849 to use. When this is full, the earlier 50% of data is discarded &-- this is
34850 much more efficient than throwing it away line by line. The sub-window also has
34851 a horizontal scroll bar for accessing the ends of long log lines. This is the
34852 only means of horizontal scrolling; the right and left arrow keys are not
34853 available. Text can be cut from this part of the window using the mouse in the
34854 normal way. The size of this subwindow is controlled by parameters in the
34855 configuration file &_Local/eximon.conf_&.
34856
34857 Searches of the text in the log window can be carried out by means of the ^R
34858 and ^S keystrokes, which default to a reverse and a forward search,
34859 respectively. The search covers only the text that is displayed in the window.
34860 It cannot go further back up the log.
34861
34862 The point from which the search starts is indicated by a caret marker. This is
34863 normally at the end of the text in the window, but can be positioned explicitly
34864 by pointing and clicking with the left mouse button, and is moved automatically
34865 by a successful search. If new text arrives in the window when it is scrolled
34866 back, the caret remains where it is, but if the window is not scrolled back,
34867 the caret is moved to the end of the new text.
34868
34869 Pressing ^R or ^S pops up a window into which the search text can be typed.
34870 There are buttons for selecting forward or reverse searching, for carrying out
34871 the search, and for cancelling. If the &"Search"& button is pressed, the search
34872 happens and the window remains so that further searches can be done. If the
34873 &"Return"& key is pressed, a single search is done and the window is closed. If
34874 ^C is typed the search is cancelled.
34875
34876 The searching facility is implemented using the facilities of the Athena text
34877 widget. By default this pops up a window containing both &"search"& and
34878 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
34879 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
34880 However, the linkers in BSDI and HP-UX seem unable to handle an externally
34881 provided version of &%TextPop%& when the remaining parts of the text widget
34882 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
34883 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
34884 on these systems, at the expense of having unwanted items in the search popup
34885 window.
34886
34887
34888
34889 .section "The queue display" "SECID268"
34890 .cindex "queue" "display in monitor"
34891 The bottom section of the monitor window contains a list of all messages that
34892 are on the queue, which includes those currently being received or delivered,
34893 as well as those awaiting delivery. The size of this subwindow is controlled by
34894 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
34895 at which it is updated is controlled by another parameter in the same file &--
34896 the default is 5 minutes, since queue scans can be quite expensive. However,
34897 there is an &"Update"& action button just above the display which can be used
34898 to force an update of the queue display at any time.
34899
34900 When a host is down for some time, a lot of pending mail can build up for it,
34901 and this can make it hard to deal with other messages on the queue. To help
34902 with this situation there is a button next to &"Update"& called &"Hide"&. If
34903 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
34904 type anything in here and press &"Return"&, the text is added to a chain of
34905 such texts, and if every undelivered address in a message matches at least one
34906 of the texts, the message is not displayed.
34907
34908 If there is an address that does not match any of the texts, all the addresses
34909 are displayed as normal. The matching happens on the ends of addresses so, for
34910 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
34911 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
34912 has been set up, a button called &"Unhide"& is displayed. If pressed, it
34913 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
34914 a hide request is automatically cancelled after one hour.
34915
34916 While the dialogue box is displayed, you can't press any buttons or do anything
34917 else to the monitor window. For this reason, if you want to cut text from the
34918 queue display to use in the dialogue box, you have to do the cutting before
34919 pressing the &"Hide"& button.
34920
34921 The queue display contains, for each unhidden queued message, the length of
34922 time it has been on the queue, the size of the message, the message id, the
34923 message sender, and the first undelivered recipient, all on one line. If it is
34924 a bounce message, the sender is shown as &"<>"&. If there is more than one
34925 recipient to which the message has not yet been delivered, subsequent ones are
34926 listed on additional lines, up to a maximum configured number, following which
34927 an ellipsis is displayed. Recipients that have already received the message are
34928 not shown.
34929
34930 .cindex "frozen messages" "display"
34931 If a message is frozen, an asterisk is displayed at the left-hand side.
34932
34933 The queue display has a vertical scroll bar, and can also be scrolled by means
34934 of the arrow keys. Text can be cut from it using the mouse in the normal way.
34935 The text searching facilities, as described above for the log window, are also
34936 available, but the caret is always moved to the end of the text when the queue
34937 display is updated.
34938
34939
34940
34941 .section "The queue menu" "SECID269"
34942 .cindex "queue" "menu in monitor"
34943 If the &%shift%& key is held down and the left button is clicked when the mouse
34944 pointer is over the text for any message, an action menu pops up, and the first
34945 line of the queue display for the message is highlighted. This does not affect
34946 any selected text.
34947
34948 If you want to use some other event for popping up the menu, you can set the
34949 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
34950 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
34951 value set in this parameter is a standard X event description. For example, to
34952 run eximon using &%ctrl%& rather than &%shift%& you could use
34953 .code
34954 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
34955 .endd
34956 The title of the menu is the message id, and it contains entries which act as
34957 follows:
34958
34959 .ilist
34960 &'message log'&: The contents of the message log for the message are displayed
34961 in a new text window.
34962 .next
34963 &'headers'&: Information from the spool file that contains the envelope
34964 information and headers is displayed in a new text window. See chapter
34965 &<<CHAPspool>>& for a description of the format of spool files.
34966 .next
34967 &'body'&: The contents of the spool file containing the body of the message are
34968 displayed in a new text window. There is a default limit of 20,000 bytes to the
34969 amount of data displayed. This can be changed by setting the BODY_MAX
34970 option at compile time, or the EXIMON_BODY_MAX option at run time.
34971 .next
34972 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
34973 delivery of the message. This causes an automatic thaw if the message is
34974 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
34975 a new text window. The delivery is run in a separate process, to avoid holding
34976 up the monitor while the delivery proceeds.
34977 .next
34978 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
34979 that the message be frozen.
34980 .next
34981 .cindex "thawing messages"
34982 .cindex "unfreezing messages"
34983 .cindex "frozen messages" "thawing"
34984 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
34985 that the message be thawed.
34986 .next
34987 .cindex "delivery" "forcing failure"
34988 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
34989 that Exim gives up trying to deliver the message. A bounce message is generated
34990 for any remaining undelivered addresses.
34991 .next
34992 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
34993 that the message be deleted from the system without generating a bounce
34994 message.
34995 .next
34996 &'add recipient'&: A dialog box is displayed into which a recipient address can
34997 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34998 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34999 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35000 causes a call to Exim to be made using the &%-Mar%& option to request that an
35001 additional recipient be added to the message, unless the entry box is empty, in
35002 which case no action is taken.
35003 .next
35004 &'mark delivered'&: A dialog box is displayed into which a recipient address
35005 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35006 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35007 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35008 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
35009 recipient address as already delivered, unless the entry box is empty, in which
35010 case no action is taken.
35011 .next
35012 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
35013 mark all recipient addresses as already delivered.
35014 .next
35015 &'edit sender'&: A dialog box is displayed initialized with the current
35016 sender's address. Pressing RETURN causes a call to Exim to be made using the
35017 &%-Mes%& option to replace the sender address, unless the entry box is empty,
35018 in which case no action is taken. If you want to set an empty sender (as in
35019 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
35020 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
35021 the address is qualified with that domain.
35022 .endlist
35023
35024 When a delivery is forced, a window showing the &%-v%& output is displayed. In
35025 other cases when a call to Exim is made, if there is any output from Exim (in
35026 particular, if the command fails) a window containing the command and the
35027 output is displayed. Otherwise, the results of the action are normally apparent
35028 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
35029 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
35030 if no output is generated.
35031
35032 The queue display is automatically updated for actions such as freezing and
35033 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
35034 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
35035 force an update of the display after one of these actions.
35036
35037 In any text window that is displayed as result of a menu action, the normal
35038 cut-and-paste facility is available, and searching can be carried out using ^R
35039 and ^S, as described above for the log tail window.
35040 .ecindex IIDeximon
35041
35042
35043
35044
35045
35046 . ////////////////////////////////////////////////////////////////////////////
35047 . ////////////////////////////////////////////////////////////////////////////
35048
35049 .chapter "Security considerations" "CHAPsecurity"
35050 .scindex IIDsecurcon "security" "discussion of"
35051 This chapter discusses a number of issues concerned with security, some of
35052 which are also covered in other parts of this manual.
35053
35054 For reasons that this author does not understand, some people have promoted
35055 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
35056 existence of this chapter in the documentation. However, the intent of the
35057 chapter is simply to describe the way Exim works in relation to certain
35058 security concerns, not to make any specific claims about the effectiveness of
35059 its security as compared with other MTAs.
35060
35061 What follows is a description of the way Exim is supposed to be. Best efforts
35062 have been made to try to ensure that the code agrees with the theory, but an
35063 absence of bugs can never be guaranteed. Any that are reported will get fixed
35064 as soon as possible.
35065
35066
35067 .section "Building a more &""hardened""& Exim" "SECID286"
35068 .cindex "security" "build-time features"
35069 There are a number of build-time options that can be set in &_Local/Makefile_&
35070 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
35071 Exim administrator who does not have the root password, or by someone who has
35072 penetrated the Exim (but not the root) account. These options are as follows:
35073
35074 .ilist
35075 ALT_CONFIG_PREFIX can be set to a string that is required to match the
35076 start of any file names used with the &%-C%& option. When it is set, these file
35077 names are also not allowed to contain the sequence &"/../"&. (However, if the
35078 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
35079 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
35080 default setting for &%ALT_CONFIG_PREFIX%&.
35081
35082 If the permitted configuration files are confined to a directory to
35083 which only root has access, this guards against someone who has broken
35084 into the Exim account from running a privileged Exim with an arbitrary
35085 configuration file, and using it to break into other accounts.
35086 .next
35087
35088 If a non-trusted configuration file (i.e. not the default configuration file
35089 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
35090 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
35091 the next item), then root privilege is retained only if the caller of Exim is
35092 root. This locks out the possibility of testing a configuration using &%-C%&
35093 right through message reception and delivery, even if the caller is root. The
35094 reception works, but by that time, Exim is running as the Exim user, so when
35095 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
35096 privilege to be lost. However, root can test reception and delivery using two
35097 separate commands.
35098
35099 .next
35100 The WHITELIST_D_MACROS build option declares some macros to be safe to override
35101 with &%-D%& if the real uid is one of root, the Exim run-time user or the
35102 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
35103 requiring the run-time value supplied to &%-D%& to match a regex that errs on
35104 the restrictive side.  Requiring build-time selection of safe macros is onerous
35105 but this option is intended solely as a transition mechanism to permit
35106 previously-working configurations to continue to work after release 4.73.
35107 .next
35108 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
35109 is disabled.
35110 .next
35111 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
35112 never to be used for any deliveries. This is like the &%never_users%& runtime
35113 option, but it cannot be overridden; the runtime option adds additional users
35114 to the list. The default setting is &"root"&; this prevents a non-root user who
35115 is permitted to modify the runtime file from using Exim as a way to get root.
35116 .endlist
35117
35118
35119
35120 .section "Root privilege" "SECID270"
35121 .cindex "setuid"
35122 .cindex "root privilege"
35123 The Exim binary is normally setuid to root, which means that it gains root
35124 privilege (runs as root) when it starts execution. In some special cases (for
35125 example, when the daemon is not in use and there are no local deliveries), it
35126 may be possible to run Exim setuid to some user other than root. This is
35127 discussed in the next section. However, in most installations, root privilege
35128 is required for two things:
35129
35130 .ilist
35131 To set up a socket connected to the standard SMTP port (25) when initialising
35132 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
35133 not required.
35134 .next
35135 To be able to change uid and gid in order to read users' &_.forward_& files and
35136 perform local deliveries as the receiving user or as specified in the
35137 configuration.
35138 .endlist
35139
35140 It is not necessary to be root to do any of the other things Exim does, such as
35141 receiving messages and delivering them externally over SMTP, and it is
35142 obviously more secure if Exim does not run as root except when necessary.
35143 For this reason, a user and group for Exim to use must be defined in
35144 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
35145 group"&. Their values can be changed by the run time configuration, though this
35146 is not recommended. Often a user called &'exim'& is used, but some sites use
35147 &'mail'& or another user name altogether.
35148
35149 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
35150 abdication; the process cannot regain root afterwards. Prior to release 4.00,
35151 &[seteuid()]& was used in some circumstances, but this is no longer the case.
35152
35153 After a new Exim process has interpreted its command line options, it changes
35154 uid and gid in the following cases:
35155
35156 .ilist
35157 .oindex "&%-C%&"
35158 .oindex "&%-D%&"
35159 If the &%-C%& option is used to specify an alternate configuration file, or if
35160 the &%-D%& option is used to define macro values for the configuration, and the
35161 calling process is not running as root, the uid and gid are changed to those of
35162 the calling process.
35163 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
35164 option may not be used at all.
35165 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
35166 can be supplied if the calling process is running as root, the Exim run-time
35167 user or CONFIGURE_OWNER, if defined.
35168 .next
35169 .oindex "&%-be%&"
35170 .oindex "&%-bf%&"
35171 .oindex "&%-bF%&"
35172 If the expansion test option (&%-be%&) or one of the filter testing options
35173 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
35174 calling process.
35175 .next
35176 If the process is not a daemon process or a queue runner process or a delivery
35177 process or a process for testing address routing (started with &%-bt%&), the
35178 uid and gid are changed to the Exim user and group. This means that Exim always
35179 runs under its own uid and gid when receiving messages. This also applies when
35180 testing address verification
35181 .oindex "&%-bv%&"
35182 .oindex "&%-bh%&"
35183 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
35184 option).
35185 .next
35186 For a daemon, queue runner, delivery, or address testing process, the uid
35187 remains as root at this stage, but the gid is changed to the Exim group.
35188 .endlist
35189
35190 The processes that initially retain root privilege behave as follows:
35191
35192 .ilist
35193 A daemon process changes the gid to the Exim group and the uid to the Exim
35194 user after setting up one or more listening sockets. The &[initgroups()]&
35195 function is called, so that if the Exim user is in any additional groups, they
35196 will be used during message reception.
35197 .next
35198 A queue runner process retains root privilege throughout its execution. Its
35199 job is to fork a controlled sequence of delivery processes.
35200 .next
35201 A delivery process retains root privilege throughout most of its execution,
35202 but any actual deliveries (that is, the transports themselves) are run in
35203 subprocesses which always change to a non-root uid and gid. For local
35204 deliveries this is typically the uid and gid of the owner of the mailbox; for
35205 remote deliveries, the Exim uid and gid are used. Once all the delivery
35206 subprocesses have been run, a delivery process changes to the Exim uid and gid
35207 while doing post-delivery tidying up such as updating the retry database and
35208 generating bounce and warning messages.
35209
35210 While the recipient addresses in a message are being routed, the delivery
35211 process runs as root. However, if a user's filter file has to be processed,
35212 this is done in a subprocess that runs under the individual user's uid and
35213 gid. A system filter is run as root unless &%system_filter_user%& is set.
35214 .next
35215 A process that is testing addresses (the &%-bt%& option) runs as root so that
35216 the routing is done in the same environment as a message delivery.
35217 .endlist
35218
35219
35220
35221
35222 .section "Running Exim without privilege" "SECTrunexiwitpri"
35223 .cindex "privilege, running without"
35224 .cindex "unprivileged running"
35225 .cindex "root privilege" "running without"
35226 Some installations like to run Exim in an unprivileged state for more of its
35227 operation, for added security. Support for this mode of operation is provided
35228 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
35229 gid are changed to the Exim user and group at the start of a delivery process
35230 (and also queue runner and address testing processes). This means that address
35231 routing is no longer run as root, and the deliveries themselves cannot change
35232 to any other uid.
35233
35234 .cindex SIGHUP
35235 .cindex "daemon" "restarting"
35236 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
35237 that the daemon can still be started in the usual way, and it can respond
35238 correctly to SIGHUP because the re-invocation regains root privilege.
35239
35240 An alternative approach is to make Exim setuid to the Exim user and also setgid
35241 to the Exim group. If you do this, the daemon must be started from a root
35242 process. (Calling Exim from a root process makes it behave in the way it does
35243 when it is setuid root.) However, the daemon cannot restart itself after a
35244 SIGHUP signal because it cannot regain privilege.
35245
35246 It is still useful to set &%deliver_drop_privilege%& in this case, because it
35247 stops Exim from trying to re-invoke itself to do a delivery after a message has
35248 been received. Such a re-invocation is a waste of resources because it has no
35249 effect.
35250
35251 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
35252 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
35253 to the Exim user seems a clean approach, but there is one complication:
35254
35255 In this style of operation, Exim is running with the real uid and gid set to
35256 those of the calling process, and the effective uid/gid set to Exim's values.
35257 Ideally, any association with the calling process' uid/gid should be dropped,
35258 that is, the real uid/gid should be reset to the effective values so as to
35259 discard any privileges that the caller may have. While some operating systems
35260 have a function that permits this action for a non-root effective uid, quite a
35261 number of them do not. Because of this lack of standardization, Exim does not
35262 address this problem at this time.
35263
35264 For this reason, the recommended approach for &"mostly unprivileged"& running
35265 is to keep the Exim binary setuid to root, and to set
35266 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
35267 be used in the most straightforward way.
35268
35269 If you configure Exim not to run delivery processes as root, there are a
35270 number of restrictions on what you can do:
35271
35272 .ilist
35273 You can deliver only as the Exim user/group. You should  explicitly use the
35274 &%user%& and &%group%& options to override routers or local transports that
35275 normally deliver as the recipient. This makes sure that configurations that
35276 work in this mode function the same way in normal mode. Any implicit or
35277 explicit specification of another user causes an error.
35278 .next
35279 Use of &_.forward_& files is severely restricted, such that it is usually
35280 not worthwhile to include them in the configuration.
35281 .next
35282 Users who wish to use &_.forward_& would have to make their home directory and
35283 the file itself accessible to the Exim user. Pipe and append-to-file entries,
35284 and their equivalents in Exim filters, cannot be used. While they could be
35285 enabled in the Exim user's name, that would be insecure and not very useful.
35286 .next
35287 Unless the local user mailboxes are all owned by the Exim user (possible in
35288 some POP3 or IMAP-only environments):
35289
35290 .olist
35291 They must be owned by the Exim group and be writeable by that group. This
35292 implies you must set &%mode%& in the appendfile configuration, as well as the
35293 mode of the mailbox files themselves.
35294 .next
35295 You must set &%no_check_owner%&, since most or all of the files will not be
35296 owned by the Exim user.
35297 .next
35298 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
35299 on a newly created mailbox when unprivileged. This also implies that new
35300 mailboxes need to be created manually.
35301 .endlist olist
35302 .endlist ilist
35303
35304
35305 These restrictions severely restrict what can be done in local deliveries.
35306 However, there are no restrictions on remote deliveries. If you are running a
35307 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
35308 gives more security at essentially no cost.
35309
35310 If you are using the &%mua_wrapper%& facility (see chapter
35311 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
35312
35313
35314
35315
35316 .section "Delivering to local files" "SECID271"
35317 Full details of the checks applied by &(appendfile)& before it writes to a file
35318 are given in chapter &<<CHAPappendfile>>&.
35319
35320
35321
35322 .section "IPv4 source routing" "SECID272"
35323 .cindex "source routing" "in IP packets"
35324 .cindex "IP source routing"
35325 Many operating systems suppress IP source-routed packets in the kernel, but
35326 some cannot be made to do this, so Exim does its own check. It logs incoming
35327 IPv4 source-routed TCP calls, and then drops them. Things are all different in
35328 IPv6. No special checking is currently done.
35329
35330
35331
35332 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
35333 Support for these SMTP commands is disabled by default. If required, they can
35334 be enabled by defining suitable ACLs.
35335
35336
35337
35338
35339 .section "Privileged users" "SECID274"
35340 .cindex "trusted users"
35341 .cindex "admin user"
35342 .cindex "privileged user"
35343 .cindex "user" "trusted"
35344 .cindex "user" "admin"
35345 Exim recognizes two sets of users with special privileges. Trusted users are
35346 able to submit new messages to Exim locally, but supply their own sender
35347 addresses and information about a sending host. For other users submitting
35348 local messages, Exim sets up the sender address from the uid, and doesn't
35349 permit a remote host to be specified.
35350
35351 .oindex "&%-f%&"
35352 However, an untrusted user is permitted to use the &%-f%& command line option
35353 in the special form &%-f <>%& to indicate that a delivery failure for the
35354 message should not cause an error report. This affects the message's envelope,
35355 but it does not affect the &'Sender:'& header. Untrusted users may also be
35356 permitted to use specific forms of address with the &%-f%& option by setting
35357 the &%untrusted_set_sender%& option.
35358
35359 Trusted users are used to run processes that receive mail messages from some
35360 other mail domain and pass them on to Exim for delivery either locally, or over
35361 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35362 as any user listed in the &%trusted_users%& configuration option, or under any
35363 group listed in the &%trusted_groups%& option.
35364
35365 Admin users are permitted to do things to the messages on Exim's queue. They
35366 can freeze or thaw messages, cause them to be returned to their senders, remove
35367 them entirely, or modify them in various ways. In addition, admin users can run
35368 the Exim monitor and see all the information it is capable of providing, which
35369 includes the contents of files on the spool.
35370
35371 .oindex "&%-M%&"
35372 .oindex "&%-q%&"
35373 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35374 delivery of messages on its queue is restricted to admin users. This
35375 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35376 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35377 queue is also restricted to admin users. This restriction can be relaxed by
35378 setting &%no_queue_list_requires_admin%&.
35379
35380 Exim recognizes an admin user if the calling process is running as root or as
35381 the Exim user or if any of the groups associated with the calling process is
35382 the Exim group. It is not necessary actually to be running under the Exim
35383 group. However, if admin users who are not root or the Exim user are to access
35384 the contents of files on the spool via the Exim monitor (which runs
35385 unprivileged), Exim must be built to allow group read access to its spool
35386 files.
35387
35388
35389
35390 .section "Spool files" "SECID275"
35391 .cindex "spool directory" "files"
35392 Exim's spool directory and everything it contains is owned by the Exim user and
35393 set to the Exim group. The mode for spool files is defined in the
35394 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35395 any user who is a member of the Exim group can access these files.
35396
35397
35398
35399 .section "Use of argv[0]" "SECID276"
35400 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35401 of specific strings, Exim assumes certain options. For example, calling Exim
35402 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35403 to calling it with the option &%-bS%&. There are no security implications in
35404 this.
35405
35406
35407
35408 .section "Use of %f formatting" "SECID277"
35409 The only use made of &"%f"& by Exim is in formatting load average values. These
35410 are actually stored in integer variables as 1000 times the load average.
35411 Consequently, their range is limited and so therefore is the length of the
35412 converted output.
35413
35414
35415
35416 .section "Embedded Exim path" "SECID278"
35417 Exim uses its own path name, which is embedded in the code, only when it needs
35418 to re-exec in order to regain root privilege. Therefore, it is not root when it
35419 does so. If some bug allowed the path to get overwritten, it would lead to an
35420 arbitrary program's being run as exim, not as root.
35421
35422
35423
35424 .section "Dynamic module directory" "SECTdynmoddir"
35425 Any dynamically loadable modules must be installed into the directory
35426 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35427 loading it.
35428
35429
35430 .section "Use of sprintf()" "SECID279"
35431 .cindex "&[sprintf()]&"
35432 A large number of occurrences of &"sprintf"& in the code are actually calls to
35433 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35434 The intermediate formatting is done into a large fixed buffer by a function
35435 that runs through the format string itself, and checks the length of each
35436 conversion before performing it, thus preventing buffer overruns.
35437
35438 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35439 the output buffer is known to be sufficiently long to contain the converted
35440 string.
35441
35442
35443
35444 .section "Use of debug_printf() and log_write()" "SECID280"
35445 Arbitrary strings are passed to both these functions, but they do their
35446 formatting by calling the function &'string_vformat()'&, which runs through
35447 the format string itself, and checks the length of each conversion.
35448
35449
35450
35451 .section "Use of strcat() and strcpy()" "SECID281"
35452 These are used only in cases where the output buffer is known to be large
35453 enough to hold the result.
35454 .ecindex IIDsecurcon
35455
35456
35457
35458
35459 . ////////////////////////////////////////////////////////////////////////////
35460 . ////////////////////////////////////////////////////////////////////////////
35461
35462 .chapter "Format of spool files" "CHAPspool"
35463 .scindex IIDforspo1 "format" "spool files"
35464 .scindex IIDforspo2 "spool directory" "format of files"
35465 .scindex IIDforspo3 "spool files" "format of"
35466 .cindex "spool files" "editing"
35467 A message on Exim's queue consists of two files, whose names are the message id
35468 followed by -D and -H, respectively. The data portion of the message is kept in
35469 the -D file on its own. The message's envelope, status, and headers are all
35470 kept in the -H file, whose format is described in this chapter. Each of these
35471 two files contains the final component of its own name as its first line. This
35472 is insurance against disk crashes where the directory is lost but the files
35473 themselves are recoverable.
35474
35475 Some people are tempted into editing -D files in order to modify messages. You
35476 need to be extremely careful if you do this; it is not recommended and you are
35477 on your own if you do it. Here are some of the pitfalls:
35478
35479 .ilist
35480 You must ensure that Exim does not try to deliver the message while you are
35481 fiddling with it. The safest way is to take out a write lock on the -D file,
35482 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35483 place, the lock will be retained. If you write a new file and rename it, the
35484 lock will be lost at the instant of rename.
35485 .next
35486 .vindex "&$body_linecount$&"
35487 If you change the number of lines in the file, the value of
35488 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35489 present, this value is not used by Exim, but there is no guarantee that this
35490 will always be the case.
35491 .next
35492 If the message is in MIME format, you must take care not to break it.
35493 .next
35494 If the message is cryptographically signed, any change will invalidate the
35495 signature.
35496 .endlist
35497 All in all, modifying -D files is fraught with danger.
35498
35499 Files whose names end with -J may also be seen in the &_input_& directory (or
35500 its subdirectories when &%split_spool_directory%& is set). These are journal
35501 files, used to record addresses to which the message has been delivered during
35502 the course of a delivery attempt. If there are still undelivered recipients at
35503 the end, the -H file is updated, and the -J file is deleted. If, however, there
35504 is some kind of crash (for example, a power outage) before this happens, the -J
35505 file remains in existence. When Exim next processes the message, it notices the
35506 -J file and uses it to update the -H file before starting the next delivery
35507 attempt.
35508
35509 .section "Format of the -H file" "SECID282"
35510 .cindex "uid (user id)" "in spool file"
35511 .cindex "gid (group id)" "in spool file"
35512 The second line of the -H file contains the login name for the uid of the
35513 process that called Exim to read the message, followed by the numerical uid and
35514 gid. For a locally generated message, this is normally the user who sent the
35515 message. For a message received over TCP/IP via the daemon, it is
35516 normally the Exim user.
35517
35518 The third line of the file contains the address of the message's sender as
35519 transmitted in the envelope, contained in angle brackets. The sender address is
35520 empty for bounce messages. For incoming SMTP mail, the sender address is given
35521 in the MAIL command. For locally generated mail, the sender address is
35522 created by Exim from the login name of the current user and the configured
35523 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35524 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35525 &"<>"& or an address that matches &%untrusted_set_senders%&.
35526
35527 The fourth line contains two numbers. The first is the time that the message
35528 was received, in the conventional Unix form &-- the number of seconds since the
35529 start of the epoch. The second number is a count of the number of messages
35530 warning of delayed delivery that have been sent to the sender.
35531
35532 There follow a number of lines starting with a hyphen. These can appear in any
35533 order, and are omitted when not relevant:
35534
35535 .vlist
35536 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35537 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35538 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35539 recognized, to provide backward compatibility. In the old format, a line of
35540 this form is present for every ACL variable that is not empty. The number
35541 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35542 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35543 the data string for the variable. The string itself starts at the beginning of
35544 the next line, and is followed by a newline character. It may contain internal
35545 newlines.
35546
35547 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35548 A line of this form is present for every ACL connection variable that is
35549 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35550 The length is the length of the data string for the variable. The string itself
35551 starts at the beginning of the next line, and is followed by a newline
35552 character. It may contain internal newlines.
35553
35554 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35555 A line of this form is present for every ACL message variable that is defined.
35556 Note that there is a space between &%-aclm%& and the rest of the name. The
35557 length is the length of the data string for the variable. The string itself
35558 starts at the beginning of the next line, and is followed by a newline
35559 character. It may contain internal newlines.
35560
35561 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35562 This is present if, when the message was received over SMTP, the value of
35563 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35564
35565 .vitem &%-allow_unqualified_recipient%&
35566 This is present if unqualified recipient addresses are permitted in header
35567 lines (to stop such addresses from being qualified if rewriting occurs at
35568 transport time). Local messages that were input using &%-bnq%& and remote
35569 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35570
35571 .vitem &%-allow_unqualified_sender%&
35572 This is present if unqualified sender addresses are permitted in header lines
35573 (to stop such addresses from being qualified if rewriting occurs at transport
35574 time). Local messages that were input using &%-bnq%& and remote messages from
35575 hosts that match &%sender_unqualified_hosts%& set this flag.
35576
35577 .vitem "&%-auth_id%&&~<&'text'&>"
35578 The id information for a message received on an authenticated SMTP connection
35579 &-- the value of the &$authenticated_id$& variable.
35580
35581 .vitem "&%-auth_sender%&&~<&'address'&>"
35582 The address of an authenticated sender &-- the value of the
35583 &$authenticated_sender$& variable.
35584
35585 .vitem "&%-body_linecount%&&~<&'number'&>"
35586 This records the number of lines in the body of the message, and is always
35587 present.
35588
35589 .vitem "&%-body_zerocount%&&~<&'number'&>"
35590 This records the number of binary zero bytes in the body of the message, and is
35591 present if the number is greater than zero.
35592
35593 .vitem &%-deliver_firsttime%&
35594 This is written when a new message is first added to the spool. When the spool
35595 file is updated after a deferral, it is omitted.
35596
35597 .vitem "&%-frozen%&&~<&'time'&>"
35598 .cindex "frozen messages" "spool data"
35599 The message is frozen, and the freezing happened at <&'time'&>.
35600
35601 .vitem "&%-helo_name%&&~<&'text'&>"
35602 This records the host name as specified by a remote host in a HELO or EHLO
35603 command.
35604
35605 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35606 This records the IP address of the host from which the message was received and
35607 the remote port number that was used. It is omitted for locally generated
35608 messages.
35609
35610 .vitem "&%-host_auth%&&~<&'text'&>"
35611 If the message was received on an authenticated SMTP connection, this records
35612 the name of the authenticator &-- the value of the
35613 &$sender_host_authenticated$& variable.
35614
35615 .vitem &%-host_lookup_failed%&
35616 This is present if an attempt to look up the sending host's name from its IP
35617 address failed. It corresponds to the &$host_lookup_failed$& variable.
35618
35619 .vitem "&%-host_name%&&~<&'text'&>"
35620 .cindex "reverse DNS lookup"
35621 .cindex "DNS" "reverse lookup"
35622 This records the name of the remote host from which the message was received,
35623 if the host name was looked up from the IP address when the message was being
35624 received. It is not present if no reverse lookup was done.
35625
35626 .vitem "&%-ident%&&~<&'text'&>"
35627 For locally submitted messages, this records the login of the originating user,
35628 unless it was a trusted user and the &%-oMt%& option was used to specify an
35629 ident value. For messages received over TCP/IP, this records the ident string
35630 supplied by the remote host, if any.
35631
35632 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
35633 This records the IP address of the local interface and the port number through
35634 which a message was received from a remote host. It is omitted for locally
35635 generated messages.
35636
35637 .vitem &%-local%&
35638 The message is from a local sender.
35639
35640 .vitem &%-localerror%&
35641 The message is a locally-generated bounce message.
35642
35643 .vitem "&%-local_scan%&&~<&'string'&>"
35644 This records the data string that was returned by the &[local_scan()]& function
35645 when the message was received &-- the value of the &$local_scan_data$&
35646 variable. It is omitted if no data was returned.
35647
35648 .vitem &%-manual_thaw%&
35649 The message was frozen but has been thawed manually, that is, by an explicit
35650 Exim command rather than via the auto-thaw process.
35651
35652 .vitem &%-N%&
35653 A testing delivery process was started using the &%-N%& option to suppress any
35654 actual deliveries, but delivery was deferred. At any further delivery attempts,
35655 &%-N%& is assumed.
35656
35657 .vitem &%-received_protocol%&
35658 This records the value of the &$received_protocol$& variable, which contains
35659 the name of the protocol by which the message was received.
35660
35661 .vitem &%-sender_set_untrusted%&
35662 The envelope sender of this message was set by an untrusted local caller (used
35663 to ensure that the caller is displayed in queue listings).
35664
35665 .vitem "&%-spam_score_int%&&~<&'number'&>"
35666 If a message was scanned by SpamAssassin, this is present. It records the value
35667 of &$spam_score_int$&.
35668
35669 .vitem &%-tls_certificate_verified%&
35670 A TLS certificate was received from the client that sent this message, and the
35671 certificate was verified by the server.
35672
35673 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
35674 When the message was received over an encrypted connection, this records the
35675 name of the cipher suite that was used.
35676
35677 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
35678 When the message was received over an encrypted connection, and a certificate
35679 was received from the client, this records the Distinguished Name from that
35680 certificate.
35681 .endlist
35682
35683 Following the options there is a list of those addresses to which the message
35684 is not to be delivered. This set of addresses is initialized from the command
35685 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
35686 is set; otherwise it starts out empty. Whenever a successful delivery is made,
35687 the address is added to this set. The addresses are kept internally as a
35688 balanced binary tree, and it is a representation of that tree which is written
35689 to the spool file. If an address is expanded via an alias or forward file, the
35690 original address is added to the tree when deliveries to all its child
35691 addresses are complete.
35692
35693 If the tree is empty, there is a single line in the spool file containing just
35694 the text &"XX"&. Otherwise, each line consists of two letters, which are either
35695 Y or N, followed by an address. The address is the value for the node of the
35696 tree, and the letters indicate whether the node has a left branch and/or a
35697 right branch attached to it, respectively. If branches exist, they immediately
35698 follow. Here is an example of a three-node tree:
35699 .code
35700 YY darcy@austen.fict.example
35701 NN alice@wonderland.fict.example
35702 NN editor@thesaurus.ref.example
35703 .endd
35704 After the non-recipients tree, there is a list of the message's recipients.
35705 This is a simple list, preceded by a count. It includes all the original
35706 recipients of the message, including those to whom the message has already been
35707 delivered. In the simplest case, the list contains one address per line. For
35708 example:
35709 .code
35710 4
35711 editor@thesaurus.ref.example
35712 darcy@austen.fict.example
35713 rdo@foundation
35714 alice@wonderland.fict.example
35715 .endd
35716 However, when a child address has been added to the top-level addresses as a
35717 result of the use of the &%one_time%& option on a &(redirect)& router, each
35718 line is of the following form:
35719 .display
35720 <&'top-level address'&> <&'errors_to address'&> &&&
35721   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
35722 .endd
35723 The 01 flag bit indicates the presence of the three other fields that follow
35724 the top-level address. Other bits may be used in future to support additional
35725 fields. The <&'parent number'&> is the offset in the recipients list of the
35726 original parent of the &"one time"& address. The first two fields are the
35727 envelope sender that is associated with this address and its length. If the
35728 length is zero, there is no special envelope sender (there are then two space
35729 characters in the line). A non-empty field can arise from a &(redirect)& router
35730 that has an &%errors_to%& setting.
35731
35732
35733 A blank line separates the envelope and status information from the headers
35734 which follow. A header may occupy several lines of the file, and to save effort
35735 when reading it in, each header is preceded by a number and an identifying
35736 character. The number is the number of characters in the header, including any
35737 embedded newlines and the terminating newline. The character is one of the
35738 following:
35739
35740 .table2 50pt
35741 .row <&'blank'&>         "header in which Exim has no special interest"
35742 .row &`B`&               "&'Bcc:'& header"
35743 .row &`C`&               "&'Cc:'& header"
35744 .row &`F`&               "&'From:'& header"
35745 .row &`I`&               "&'Message-id:'& header"
35746 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
35747 .row &`R`&               "&'Reply-To:'& header"
35748 .row &`S`&               "&'Sender:'& header"
35749 .row &`T`&               "&'To:'& header"
35750 .row &`*`&               "replaced or deleted header"
35751 .endtable
35752
35753 Deleted or replaced (rewritten) headers remain in the spool file for debugging
35754 purposes. They are not transmitted when the message is delivered. Here is a
35755 typical set of headers:
35756 .code
35757 111P Received: by hobbit.fict.example with local (Exim 4.00)
35758 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
35759 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
35760 038* X-rewrote-sender: bb@hobbit.fict.example
35761 042* From: Bilbo Baggins <bb@hobbit.fict.example>
35762 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
35763 099* To: alice@wonderland.fict.example, rdo@foundation,
35764 darcy@austen.fict.example, editor@thesaurus.ref.example
35765 104T To: alice@wonderland.fict.example, rdo@foundation.example,
35766 darcy@austen.fict.example, editor@thesaurus.ref.example
35767 038  Date: Fri, 11 May 2001 10:28:59 +0100
35768 .endd
35769 The asterisked headers indicate that the envelope sender, &'From:'& header, and
35770 &'To:'& header have been rewritten, the last one because routing expanded the
35771 unqualified domain &'foundation'&.
35772 .ecindex IIDforspo1
35773 .ecindex IIDforspo2
35774 .ecindex IIDforspo3
35775
35776 . ////////////////////////////////////////////////////////////////////////////
35777 . ////////////////////////////////////////////////////////////////////////////
35778
35779 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHID12" &&&
35780          "DKIM Support"
35781 .cindex "DKIM"
35782
35783 DKIM is a mechanism by which messages sent by some entity can be provably
35784 linked to a domain which that entity controls.  It permits reputation to
35785 be tracked on a per-domain basis, rather than merely upon source IP address.
35786 DKIM is documented in RFC 4871.
35787
35788 Since version 4.70, DKIM support is compiled into Exim by default. It can be
35789 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
35790
35791 Exim's DKIM implementation allows to
35792 .olist
35793 Sign outgoing messages: This function is implemented in the SMTP transport.
35794 It can co-exist with all other Exim features, including transport filters.
35795 .next
35796 Verify signatures in incoming messages: This is implemented by an additional
35797 ACL (acl_smtp_dkim), which can be called several times per message, with
35798 different signature contexts.
35799 .endlist
35800
35801 In typical Exim style, the verification implementation does not include any
35802 default "policy". Instead it enables you to build your own policy using
35803 Exim's standard controls.
35804
35805 Please note that verification of DKIM signatures in incoming mail is turned
35806 on by default for logging purposes. For each signature in incoming email,
35807 exim will log a line displaying the most important signature details, and the
35808 signature status. Here is an example (with line-breaks added for clarity):
35809 .code
35810 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
35811     d=facebookmail.com s=q1-2009b
35812     c=relaxed/relaxed a=rsa-sha1
35813     i=@facebookmail.com t=1252484542 [verification succeeded]
35814 .endd
35815 You might want to turn off DKIM verification processing entirely for internal
35816 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
35817 control modifier. This should typically be done in the RCPT ACL, at points
35818 where you accept mail from relay sources (internal hosts or authenticated
35819 senders).
35820
35821
35822 .section "Signing outgoing messages" "SECID513"
35823 .cindex "DKIM" "signing"
35824
35825 Signing is implemented by setting private options on the SMTP transport.
35826 These options take (expandable) strings as arguments.
35827
35828 .option dkim_domain smtp string&!! unset
35829 MANDATORY:
35830 The domain you want to sign with. The result of this expanded
35831 option is put into the &%$dkim_domain%& expansion variable.
35832
35833 .option dkim_selector smtp string&!! unset
35834 MANDATORY:
35835 This sets the key selector string. You can use the &%$dkim_domain%& expansion
35836 variable to look up a matching selector. The result is put in the expansion
35837 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
35838 option along with &%$dkim_domain%&.
35839
35840 .option dkim_private_key smtp string&!! unset
35841 MANDATORY:
35842 This sets the private key to use. You can use the &%$dkim_domain%& and
35843 &%$dkim_selector%& expansion variables to determine the private key to use.
35844 The result can either
35845 .ilist
35846 be a valid RSA private key in ASCII armor, including line breaks.
35847 .next
35848 start with a slash, in which case it is treated as a file that contains
35849 the private key.
35850 .next
35851 be "0", "false" or the empty string, in which case the message will not
35852 be signed. This case will not result in an error, even if &%dkim_strict%&
35853 is set.
35854 .endlist
35855
35856 .option dkim_canon smtp string&!! unset
35857 OPTIONAL:
35858 This option sets the canonicalization method used when signing a message.
35859 The DKIM RFC currently supports two methods: "simple" and "relaxed".
35860 The option defaults to "relaxed" when unset. Note: the current implementation
35861 only supports using the same canonicalization method for both headers and body.
35862
35863 .option dkim_strict smtp string&!! unset
35864 OPTIONAL:
35865 This  option  defines  how  Exim  behaves  when  signing a message that
35866 should be signed fails for some reason.  When the expansion evaluates to
35867 either "1" or "true", Exim will defer. Otherwise Exim will send the message
35868 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
35869 variables here.
35870
35871 .option dkim_sign_headers smtp string&!! unset
35872 OPTIONAL:
35873 When set, this option must expand to (or be specified as) a colon-separated
35874 list of header names. Headers with these names will be included in the message
35875 signature. When unspecified, the header names recommended in RFC4871 will be
35876 used.
35877
35878
35879 .section "Verifying DKIM signatures in incoming mail" "SECID514"
35880 .cindex "DKIM" "verification"
35881
35882 Verification of DKIM signatures in incoming email is implemented via the
35883 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
35884 syntactically(!) correct signature in the incoming message.
35885
35886 To evaluate the signature in the ACL a large number of expansion variables
35887 containing the signature status and its details are set up during the
35888 runtime of the ACL.
35889
35890 Calling the ACL only for existing signatures is not sufficient to build
35891 more advanced policies. For that reason, the global option
35892 &%dkim_verify_signers%&, and a global expansion variable
35893 &%$dkim_signers%& exist.
35894
35895 The global option &%dkim_verify_signers%& can be set to a colon-separated
35896 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
35897 called. It is expanded when the message has been received. At this point,
35898 the expansion variable &%$dkim_signers%& already contains a colon-separated
35899 list of signer domains and identities for the message. When
35900 &%dkim_verify_signers%& is not specified in the main configuration,
35901 it defaults as:
35902 .code
35903 dkim_verify_signers = $dkim_signers
35904 .endd
35905 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
35906 DKIM signature in the message. Current DKIM verifiers may want to explicitly
35907 call the ACL for known domains or identities. This would be achieved as follows:
35908 .code
35909 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
35910 .endd
35911 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
35912 and "ebay.com", plus all domains and identities that have signatures in the message.
35913 You can also be more creative in constructing your policy. For example:
35914 .code
35915 dkim_verify_signers = $sender_address_domain:$dkim_signers
35916 .endd
35917
35918 If a domain or identity is listed several times in the (expanded) value of
35919 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
35920
35921
35922 Inside the &%acl_smtp_dkim%&, the following expansion variables are
35923 available (from most to least important):
35924
35925
35926 .vlist
35927 .vitem &%$dkim_cur_signer%&
35928 The signer that is being evaluated in this ACL run. This can be a domain or
35929 an identity. This is one of the list items from the expanded main option
35930 &%dkim_verify_signers%& (see above).
35931 .vitem &%$dkim_verify_status%&
35932 A string describing the general status of the signature. One of
35933 .ilist
35934 &%none%&: There is no signature in the message for the current domain or
35935 identity (as reflected by &%$dkim_cur_signer%&).
35936 .next
35937 &%invalid%&: The signature could not be verified due to a processing error.
35938 More detail is available in &%$dkim_verify_reason%&.
35939 .next
35940 &%fail%&: Verification of the signature failed.  More detail is
35941 available in &%$dkim_verify_reason%&.
35942 .next
35943 &%pass%&: The signature passed verification. It is valid.
35944 .endlist
35945 .vitem &%$dkim_verify_reason%&
35946 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
35947 "fail" or "invalid". One of
35948 .ilist
35949 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
35950 key for the domain could not be retrieved. This may be a temporary problem.
35951 .next
35952 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
35953 record for the domain is syntactically invalid.
35954 .next
35955 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
35956 body hash does not match the one specified in the signature header. This
35957 means that the message body was modified in transit.
35958 .next
35959 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
35960 could not be verified. This may mean that headers were modified,
35961 re-written or otherwise changed in a way which is incompatible with
35962 DKIM verification. It may of course also mean that the signature is forged.
35963 .endlist
35964 .vitem &%$dkim_domain%&
35965 The signing domain. IMPORTANT: This variable is only populated if there is
35966 an actual signature in the message for the current domain or identity (as
35967 reflected by &%$dkim_cur_signer%&).
35968 .vitem &%$dkim_identity%&
35969 The signing identity, if present. IMPORTANT: This variable is only populated
35970 if there is an actual signature in the message for the current domain or
35971 identity (as reflected by &%$dkim_cur_signer%&).
35972 .vitem &%$dkim_selector%&
35973 The key record selector string.
35974 .vitem &%$dkim_algo%&
35975 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
35976 .vitem &%$dkim_canon_body%&
35977 The body canonicalization method. One of 'relaxed' or 'simple'.
35978 .vitem &%dkim_canon_headers%&
35979 The header canonicalization method. One of 'relaxed' or 'simple'.
35980 .vitem &%$dkim_copiedheaders%&
35981 A transcript of headers and their values which are included in the signature
35982 (copied from the 'z=' tag of the signature).
35983 .vitem &%$dkim_bodylength%&
35984 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
35985 limit was set by the signer, "9999999999999" is returned. This makes sure
35986 that this variable always expands to an integer value.
35987 .vitem &%$dkim_created%&
35988 UNIX timestamp reflecting the date and time when the signature was created.
35989 When this was not specified by the signer, "0" is returned.
35990 .vitem &%$dkim_expires%&
35991 UNIX timestamp reflecting the date and time when the signer wants the
35992 signature to be treated as "expired". When this was not specified by the
35993 signer, "9999999999999" is returned. This makes it possible to do useful
35994 integer size comparisons against this value.
35995 .vitem &%$dkim_headernames%&
35996 A colon-separated list of names of headers included in the signature.
35997 .vitem &%$dkim_key_testing%&
35998 "1" if the key record has the "testing" flag set, "0" if not.
35999 .vitem &%$nosubdomains%&
36000 "1" if the key record forbids subdomaining, "0" otherwise.
36001 .vitem &%$dkim_key_srvtype%&
36002 Service type (tag s=) from the key record. Defaults to "*" if not specified
36003 in the key record.
36004 .vitem &%$dkim_key_granularity%&
36005 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
36006 in the key record.
36007 .vitem &%$dkim_key_notes%&
36008 Notes from the key record (tag n=).
36009 .endlist
36010
36011 In addition, two ACL conditions are provided:
36012
36013 .vlist
36014 .vitem &%dkim_signers%&
36015 ACL condition that checks a colon-separated list of domains or identities
36016 for a match against the domain or identity that the ACL is currently verifying
36017 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
36018 verb to a group of domains or identities. For example:
36019
36020 .code
36021 # Warn when Mail purportedly from GMail has no signature at all
36022 warn log_message = GMail sender without DKIM signature
36023      sender_domains = gmail.com
36024      dkim_signers = gmail.com
36025      dkim_status = none
36026 .endd
36027
36028 .vitem &%dkim_status%&
36029 ACL condition that checks a colon-separated list of possible DKIM verification
36030 results agains the actual result of verification. This is typically used
36031 to restrict an ACL verb to a list of verification outcomes, for example:
36032
36033 .code
36034 deny message = Mail from Paypal with invalid/missing signature
36035      sender_domains = paypal.com:paypal.de
36036      dkim_signers = paypal.com:paypal.de
36037      dkim_status = none:invalid:fail
36038 .endd
36039
36040 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
36041 see the documentation of the &%$dkim_verify_status%& expansion variable above
36042 for more information of what they mean.
36043 .endlist
36044
36045 . ////////////////////////////////////////////////////////////////////////////
36046 . ////////////////////////////////////////////////////////////////////////////
36047
36048 .chapter "Adding new drivers or lookup types" "CHID13" &&&
36049          "Adding drivers or lookups"
36050 .cindex "adding drivers"
36051 .cindex "new drivers, adding"
36052 .cindex "drivers" "adding new"
36053 The following actions have to be taken in order to add a new router, transport,
36054 authenticator, or lookup type to Exim:
36055
36056 .olist
36057 Choose a name for the driver or lookup type that does not conflict with any
36058 existing name; I will use &"newdriver"& in what follows.
36059 .next
36060 Add to &_src/EDITME_& the line:
36061 .display
36062 <&'type'&>&`_NEWDRIVER=yes`&
36063 .endd
36064 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
36065 code is not to be included in the binary by default, comment this line out. You
36066 should also add any relevant comments about the driver or lookup type.
36067 .next
36068 Add to &_src/config.h.defaults_& the line:
36069 .code
36070 #define <type>_NEWDRIVER
36071 .endd
36072 .next
36073 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
36074 and create a table entry as is done for all the other drivers and lookup types.
36075 .next
36076 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
36077 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
36078 driver or lookup type and add it to the definition of OBJ.
36079 .next
36080 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
36081 &_src_&.
36082 .next
36083 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
36084 as for other drivers and lookups.
36085 .endlist
36086
36087 Then all you need to do is write the code! A good way to start is to make a
36088 proforma by copying an existing module of the same type, globally changing all
36089 occurrences of the name, and cutting out most of the code. Note that any
36090 options you create must be listed in alphabetical order, because the tables are
36091 searched using a binary chop procedure.
36092
36093 There is a &_README_& file in each of the sub-directories of &_src_& describing
36094 the interface that is expected.
36095
36096
36097
36098
36099 . ////////////////////////////////////////////////////////////////////////////
36100 . ////////////////////////////////////////////////////////////////////////////
36101
36102 . /////////////////////////////////////////////////////////////////////////////
36103 . These lines are processing instructions for the Simple DocBook Processor that
36104 . Philip Hazel has developed as a less cumbersome way of making PostScript and
36105 . PDFs than using xmlto and fop. They will be ignored by all other XML
36106 . processors.
36107 . /////////////////////////////////////////////////////////////////////////////
36108
36109 .literal xml
36110 <?sdop
36111   format="newpage"
36112   foot_right_recto="&chaptertitle;"
36113   foot_right_verso="&chaptertitle;"
36114 ?>
36115 .literal off
36116
36117 .makeindex "Options index"   "option"
36118 .makeindex "Variables index" "variable"
36119 .makeindex "Concept index"   "concept"
36120
36121
36122 . /////////////////////////////////////////////////////////////////////////////
36123 . /////////////////////////////////////////////////////////////////////////////