0815c0e4d087d9278a54815fc17906f974323ffe
[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.75"
49 .set version "4.77"
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>06 May 2011</date>
174 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
175 <authorinitials>EM</authorinitials>
176 <revhistory><revision>
177   <revnumber>4.77</revnumber>
178   <date>10 Oct 2011</date>
179   <authorinitials>EM</authorinitials>
180 </revision></revhistory>
181 <copyright><year>2011</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 .new
1651 .section "PCRE library" "SECTpcre"
1652 .cindex "PCRE library"
1653 Exim no longer has an embedded PCRE library as the vast majority of
1654 modern systems include PCRE as a system library, although you may need
1655 to install the PCRE or PCRE development package for your operating
1656 system. If your system has a normal PCRE installation the Exim build
1657 process will need no further configuration. If the library or the
1658 headers are in an unusual location you will need to either set the PCRE_LIBS
1659 and INCLUDE directives appropriately,
1660 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1661 If your operating system has no
1662 PCRE support then you will need to obtain and build the current PCRE
1663 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1664 More information on PCRE is available at &url(http://www.pcre.org/).
1665 .wen
1666
1667 .section "DBM libraries" "SECTdb"
1668 .cindex "DBM libraries" "discussion of"
1669 .cindex "hints database" "DBM files used for"
1670 Even if you do not use any DBM files in your configuration, Exim still needs a
1671 DBM library in order to operate, because it uses indexed files for its hints
1672 databases. Unfortunately, there are a number of DBM libraries in existence, and
1673 different operating systems often have different ones installed.
1674
1675 .cindex "Solaris" "DBM library for"
1676 .cindex "IRIX, DBM library for"
1677 .cindex "BSD, DBM library for"
1678 .cindex "Linux, DBM library for"
1679 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1680 Linux distribution, the DBM configuration should happen automatically, and you
1681 may be able to ignore this section. Otherwise, you may have to learn more than
1682 you would like about DBM libraries from what follows.
1683
1684 .cindex "&'ndbm'& DBM library"
1685 Licensed versions of Unix normally contain a library of DBM functions operating
1686 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1687 versions of Unix seem to vary in what they contain as standard. In particular,
1688 some early versions of Linux have no default DBM library, and different
1689 distributors have chosen to bundle different libraries with their packaged
1690 versions. However, the more recent releases seem to have standardized on the
1691 Berkeley DB library.
1692
1693 Different DBM libraries have different conventions for naming the files they
1694 use. When a program opens a file called &_dbmfile_&, there are several
1695 possibilities:
1696
1697 .olist
1698 A traditional &'ndbm'& implementation, such as that supplied as part of
1699 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1700 .next
1701 .cindex "&'gdbm'& DBM library"
1702 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1703 compatibility interface it makes two different hard links to it with names
1704 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1705 file name is used unmodified.
1706 .next
1707 .cindex "Berkeley DB library"
1708 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1709 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1710 programmer exactly the same as the traditional &'ndbm'& implementation.
1711 .next
1712 If the Berkeley package is used in its native mode, it operates on a single
1713 file called &_dbmfile_&; the programmer's interface is somewhat different to
1714 the traditional &'ndbm'& interface.
1715 .next
1716 To complicate things further, there are several very different versions of the
1717 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1718 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1719 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1720 versions of Berkeley DB can be obtained from
1721 &url(http://www.sleepycat.com/).
1722 .next
1723 .cindex "&'tdb'& DBM library"
1724 Yet another DBM library, called &'tdb'&, is available from
1725 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1726 operates on a single file.
1727 .endlist
1728
1729 .cindex "USE_DB"
1730 .cindex "DBM libraries" "configuration for building"
1731 Exim and its utilities can be compiled to use any of these interfaces. In order
1732 to use any version of the Berkeley DB package in native mode, you must set
1733 USE_DB in an appropriate configuration file (typically
1734 &_Local/Makefile_&). For example:
1735 .code
1736 USE_DB=yes
1737 .endd
1738 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1739 error is diagnosed if you set more than one of these.
1740
1741 At the lowest level, the build-time configuration sets none of these options,
1742 thereby assuming an interface of type (1). However, some operating system
1743 configuration files (for example, those for the BSD operating systems and
1744 Linux) assume type (4) by setting USE_DB as their default, and the
1745 configuration files for Cygwin set USE_GDBM. Anything you set in
1746 &_Local/Makefile_&, however, overrides these system defaults.
1747
1748 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1749 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1750 in one of these lines:
1751 .code
1752 DBMLIB = -ldb
1753 DBMLIB = -ltdb
1754 .endd
1755 Settings like that will work if the DBM library is installed in the standard
1756 place. Sometimes it is not, and the library's header file may also not be in
1757 the default path. You may need to set INCLUDE to specify where the header
1758 file is, and to specify the path to the library more fully in DBMLIB, as in
1759 this example:
1760 .code
1761 INCLUDE=-I/usr/local/include/db-4.1
1762 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1763 .endd
1764 There is further detailed discussion about the various DBM libraries in the
1765 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1766
1767
1768
1769 .section "Pre-building configuration" "SECID25"
1770 .cindex "building Exim" "pre-building configuration"
1771 .cindex "configuration for building Exim"
1772 .cindex "&_Local/Makefile_&"
1773 .cindex "&_src/EDITME_&"
1774 Before building Exim, a local configuration file that specifies options
1775 independent of any operating system has to be created with the name
1776 &_Local/Makefile_&. A template for this file is supplied as the file
1777 &_src/EDITME_&, and it contains full descriptions of all the option settings
1778 therein. These descriptions are therefore not repeated here. If you are
1779 building Exim for the first time, the simplest thing to do is to copy
1780 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1781
1782 There are three settings that you must supply, because Exim will not build
1783 without them. They are the location of the run time configuration file
1784 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1785 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1786 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1787 a colon-separated list of file names; Exim uses the first of them that exists.
1788
1789 There are a few other parameters that can be specified either at build time or
1790 at run time, to enable the same binary to be used on a number of different
1791 machines. However, if the locations of Exim's spool directory and log file
1792 directory (if not within the spool directory) are fixed, it is recommended that
1793 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1794 detected early in Exim's execution (such as a malformed configuration file) can
1795 be logged.
1796
1797 .cindex "content scanning" "specifying at build time"
1798 Exim's interfaces for calling virus and spam scanning software directly from
1799 access control lists are not compiled by default. If you want to include these
1800 facilities, you need to set
1801 .code
1802 WITH_CONTENT_SCAN=yes
1803 .endd
1804 in your &_Local/Makefile_&. For details of the facilities themselves, see
1805 chapter &<<CHAPexiscan>>&.
1806
1807
1808 .cindex "&_Local/eximon.conf_&"
1809 .cindex "&_exim_monitor/EDITME_&"
1810 If you are going to build the Exim monitor, a similar configuration process is
1811 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1812 your installation and saved under the name &_Local/eximon.conf_&. If you are
1813 happy with the default settings described in &_exim_monitor/EDITME_&,
1814 &_Local/eximon.conf_& can be empty, but it must exist.
1815
1816 This is all the configuration that is needed in straightforward cases for known
1817 operating systems. However, the building process is set up so that it is easy
1818 to override options that are set by default or by operating-system-specific
1819 configuration files, for example to change the name of the C compiler, which
1820 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1821 do this.
1822
1823
1824
1825 .section "Support for iconv()" "SECID26"
1826 .cindex "&[iconv()]& support"
1827 .cindex "RFC 2047"
1828 The contents of header lines in messages may be encoded according to the rules
1829 described RFC 2047. This makes it possible to transmit characters that are not
1830 in the ASCII character set, and to label them as being in a particular
1831 character set. When Exim is inspecting header lines by means of the &%$h_%&
1832 mechanism, it decodes them, and translates them into a specified character set
1833 (default ISO-8859-1). The translation is possible only if the operating system
1834 supports the &[iconv()]& function.
1835
1836 However, some of the operating systems that supply &[iconv()]& do not support
1837 very many conversions. The GNU &%libiconv%& library (available from
1838 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1839 systems to remedy this deficiency, as well as on systems that do not supply
1840 &[iconv()]& at all. After installing &%libiconv%&, you should add
1841 .code
1842 HAVE_ICONV=yes
1843 .endd
1844 to your &_Local/Makefile_& and rebuild Exim.
1845
1846
1847
1848 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1849 .cindex "TLS" "including support for TLS"
1850 .cindex "encryption" "including support for"
1851 .cindex "SUPPORT_TLS"
1852 .cindex "OpenSSL" "building Exim with"
1853 .cindex "GnuTLS" "building Exim with"
1854 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1855 command as per RFC 2487. It can also support legacy clients that expect to
1856 start a TLS session immediately on connection to a non-standard port (see the
1857 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1858 line option).
1859
1860 If you want to build Exim with TLS support, you must first install either the
1861 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1862 implementing SSL.
1863
1864 If OpenSSL is installed, you should set
1865 .code
1866 SUPPORT_TLS=yes
1867 TLS_LIBS=-lssl -lcrypto
1868 .endd
1869 in &_Local/Makefile_&. You may also need to specify the locations of the
1870 OpenSSL library and include files. For example:
1871 .code
1872 SUPPORT_TLS=yes
1873 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1874 TLS_INCLUDE=-I/usr/local/openssl/include/
1875 .endd
1876 .new
1877 .cindex "pkg-config" "OpenSSL"
1878 If you have &'pkg-config'& available, then instead you can just use:
1879 .code
1880 SUPPORT_TLS=yes
1881 USE_OPENSSL_PC=openssl
1882 .endd
1883 .wen
1884 .cindex "USE_GNUTLS"
1885 If GnuTLS is installed, you should set
1886 .code
1887 SUPPORT_TLS=yes
1888 USE_GNUTLS=yes
1889 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1890 .endd
1891 in &_Local/Makefile_&, and again you may need to specify the locations of the
1892 library and include files. For example:
1893 .code
1894 SUPPORT_TLS=yes
1895 USE_GNUTLS=yes
1896 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1897 TLS_INCLUDE=-I/usr/gnu/include
1898 .endd
1899 .new
1900 .cindex "pkg-config" "GnuTLS"
1901 If you have &'pkg-config'& available, then instead you can just use:
1902 .code
1903 SUPPORT_TLS=yes
1904 USE_GNUTLS=yes
1905 USE_GNUTLS_PC=gnutls
1906 .endd
1907 .wen
1908
1909 You do not need to set TLS_INCLUDE if the relevant directory is already
1910 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1911 given in chapter &<<CHAPTLS>>&.
1912
1913
1914
1915
1916 .section "Use of tcpwrappers" "SECID27"
1917
1918 .cindex "tcpwrappers, building Exim to support"
1919 .cindex "USE_TCP_WRAPPERS"
1920 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1921 .cindex "tcp_wrappers_daemon_name"
1922 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1923 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1924 alternative to Exim's own checking facilities for installations that are
1925 already making use of &'tcpwrappers'& for other purposes. To do this, you
1926 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1927 &_tcpd.h_& to be available at compile time, and also ensure that the library
1928 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1929 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1930 you might have
1931 .code
1932 USE_TCP_WRAPPERS=yes
1933 CFLAGS=-O -I/usr/local/include
1934 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1935 .endd
1936 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1937 files is &"exim"&. For example, the line
1938 .code
1939 exim : LOCAL  192.168.1.  .friendly.domain.example
1940 .endd
1941 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1942 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1943 All other connections are denied. The daemon name used by &'tcpwrappers'&
1944 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1945 in &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1946 configure file. Consult the &'tcpwrappers'& documentation for
1947 further details.
1948
1949
1950 .section "Including support for IPv6" "SECID28"
1951 .cindex "IPv6" "including support for"
1952 Exim contains code for use on systems that have IPv6 support. Setting
1953 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1954 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1955 where the IPv6 support is not fully integrated into the normal include and
1956 library files.
1957
1958 Two different types of DNS record for handling IPv6 addresses have been
1959 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1960 currently seen as the mainstream. Another record type called A6 was proposed
1961 as better than AAAA because it had more flexibility. However, it was felt to be
1962 over-complex, and its status was reduced to &"experimental"&. It is not known
1963 if anyone is actually using A6 records. Exim has support for A6 records, but
1964 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1965 support has not been tested for some time.
1966
1967
1968
1969 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1970 .cindex "lookup modules"
1971 .cindex "dynamic modules"
1972 .cindex ".so building"
1973 On some platforms, Exim supports not compiling all lookup types directly into
1974 the main binary, instead putting some into external modules which can be loaded
1975 on demand.
1976 This permits packagers to build Exim with support for lookups with extensive
1977 library dependencies without requiring all users to install all of those
1978 dependencies.
1979 Most, but not all, lookup types can be built this way.
1980
1981 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1982 installed; Exim will only load modules from that directory, as a security
1983 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1984 for your OS; see &_OS/Makefile-Linux_& for an example.
1985 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1986 see &_src/EDITME_& for details.
1987
1988 Then, for each module to be loaded dynamically, define the relevant
1989 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1990 For example, this will build in lsearch but load sqlite and mysql support
1991 on demand:
1992 .code
1993 LOOKUP_LSEARCH=yes
1994 LOOKUP_SQLITE=2
1995 LOOKUP_MYSQL=2
1996 .endd
1997
1998
1999 .section "The building process" "SECID29"
2000 .cindex "build directory"
2001 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2002 created, run &'make'& at the top level. It determines the architecture and
2003 operating system types, and creates a build directory if one does not exist.
2004 For example, on a Sun system running Solaris 8, the directory
2005 &_build-SunOS5-5.8-sparc_& is created.
2006 .cindex "symbolic link" "to source files"
2007 Symbolic links to relevant source files are installed in the build directory.
2008
2009 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2010 building process fails if it is set.
2011
2012 If this is the first time &'make'& has been run, it calls a script that builds
2013 a make file inside the build directory, using the configuration files from the
2014 &_Local_& directory. The new make file is then passed to another instance of
2015 &'make'&. This does the real work, building a number of utility scripts, and
2016 then compiling and linking the binaries for the Exim monitor (if configured), a
2017 number of utility programs, and finally Exim itself. The command &`make
2018 makefile`& can be used to force a rebuild of the make file in the build
2019 directory, should this ever be necessary.
2020
2021 If you have problems building Exim, check for any comments there may be in the
2022 &_README_& file concerning your operating system, and also take a look at the
2023 FAQ, where some common problems are covered.
2024
2025
2026
2027 .section 'Output from &"make"&' "SECID283"
2028 The output produced by the &'make'& process for compile lines is often very
2029 unreadable, because these lines can be very long. For this reason, the normal
2030 output is suppressed by default, and instead output similar to that which
2031 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2032 each module that is being compiled or linked. However, it is still possible to
2033 get the full output, by calling &'make'& like this:
2034 .code
2035 FULLECHO='' make -e
2036 .endd
2037 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2038 command reflection in &'make'&. When you ask for the full output, it is
2039 given in addition to the short output.
2040
2041
2042
2043 .section "Overriding build-time options for Exim" "SECToverride"
2044 .cindex "build-time options, overriding"
2045 The main make file that is created at the beginning of the building process
2046 consists of the concatenation of a number of files which set configuration
2047 values, followed by a fixed set of &'make'& instructions. If a value is set
2048 more than once, the last setting overrides any previous ones. This provides a
2049 convenient way of overriding defaults. The files that are concatenated are, in
2050 order:
2051 .display
2052 &_OS/Makefile-Default_&
2053 &_OS/Makefile-_&<&'ostype'&>
2054 &_Local/Makefile_&
2055 &_Local/Makefile-_&<&'ostype'&>
2056 &_Local/Makefile-_&<&'archtype'&>
2057 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2058 &_OS/Makefile-Base_&
2059 .endd
2060 .cindex "&_Local/Makefile_&"
2061 .cindex "building Exim" "operating system type"
2062 .cindex "building Exim" "architecture type"
2063 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2064 architecture type. &_Local/Makefile_& is required to exist, and the building
2065 process fails if it is absent. The other three &_Local_& files are optional,
2066 and are often not needed.
2067
2068 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2069 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2070 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2071 values are used, thereby providing a means of forcing particular settings.
2072 Otherwise, the scripts try to get values from the &%uname%& command. If this
2073 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2074 of &'ad hoc'& transformations are then applied, to produce the standard names
2075 that Exim expects. You can run these scripts directly from the shell in order
2076 to find out what values are being used on your system.
2077
2078
2079 &_OS/Makefile-Default_& contains comments about the variables that are set
2080 therein. Some (but not all) are mentioned below. If there is something that
2081 needs changing, review the contents of this file and the contents of the make
2082 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2083 default values are.
2084
2085
2086 .cindex "building Exim" "overriding default settings"
2087 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2088 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2089 need to change the original files. Instead, you should make the changes by
2090 putting the new values in an appropriate &_Local_& file. For example,
2091 .cindex "Tru64-Unix build-time settings"
2092 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2093 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2094 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2095 called with the option &%-std1%&, to make it recognize some of the features of
2096 Standard C that Exim uses. (Most other compilers recognize Standard C by
2097 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2098 containing the lines
2099 .code
2100 CC=cc
2101 CFLAGS=-std1
2102 .endd
2103 If you are compiling for just one operating system, it may be easier to put
2104 these lines directly into &_Local/Makefile_&.
2105
2106 Keeping all your local configuration settings separate from the distributed
2107 files makes it easy to transfer them to new versions of Exim simply by copying
2108 the contents of the &_Local_& directory.
2109
2110
2111 .cindex "NIS lookup type" "including support for"
2112 .cindex "NIS+ lookup type" "including support for"
2113 .cindex "LDAP" "including support for"
2114 .cindex "lookup" "inclusion in binary"
2115 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2116 lookup, but not all systems have these components installed, so the default is
2117 not to include the relevant code in the binary. All the different kinds of file
2118 and database lookup that Exim supports are implemented as separate code modules
2119 which are included only if the relevant compile-time options are set. In the
2120 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2121 .code
2122 LOOKUP_LDAP=yes
2123 LOOKUP_NIS=yes
2124 LOOKUP_NISPLUS=yes
2125 .endd
2126 and similar settings apply to the other lookup types. They are all listed in
2127 &_src/EDITME_&. In many cases the relevant include files and interface
2128 libraries need to be installed before compiling Exim.
2129 .cindex "cdb" "including support for"
2130 However, there are some optional lookup types (such as cdb) for which
2131 the code is entirely contained within Exim, and no external include
2132 files or libraries are required. When a lookup type is not included in the
2133 binary, attempts to configure Exim to use it cause run time configuration
2134 errors.
2135
2136 .new
2137 .cindex "pkg-config" "lookups"
2138 .cindex "pkg-config" "authenticators"
2139 Many systems now use a tool called &'pkg-config'& to encapsulate information
2140 about how to compile against a library; Exim has some initial support for
2141 being able to use pkg-config for lookups and authenticators.  For any given
2142 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2143 variable with the &`_PC`& suffix in the name and assign as the value the
2144 name of the package to be queried.  The results of querying via the
2145 &'pkg-config'& command will be added to the appropriate Makefile variables
2146 with &`+=`& directives, so your version of &'make'& will need to support that
2147 syntax.  For instance:
2148 .code
2149 LOOKUP_SQLITE=yes
2150 LOOKUP_SQLITE_PC=sqlite3
2151 AUTH_GSASL=yes
2152 AUTH_GSASL_PC=libgsasl
2153 AUTH_HEIMDAL_GSSAPI=yes
2154 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2155 .endd
2156 .wen
2157
2158 .cindex "Perl" "including support for"
2159 Exim can be linked with an embedded Perl interpreter, allowing Perl
2160 subroutines to be called during string expansion. To enable this facility,
2161 .code
2162 EXIM_PERL=perl.o
2163 .endd
2164 must be defined in &_Local/Makefile_&. Details of this facility are given in
2165 chapter &<<CHAPperl>>&.
2166
2167 .cindex "X11 libraries, location of"
2168 The location of the X11 libraries is something that varies a lot between
2169 operating systems, and there may be different versions of X11 to cope
2170 with. Exim itself makes no use of X11, but if you are compiling the Exim
2171 monitor, the X11 libraries must be available.
2172 The following three variables are set in &_OS/Makefile-Default_&:
2173 .code
2174 X11=/usr/X11R6
2175 XINCLUDE=-I$(X11)/include
2176 XLFLAGS=-L$(X11)/lib
2177 .endd
2178 These are overridden in some of the operating-system configuration files. For
2179 example, in &_OS/Makefile-SunOS5_& there is
2180 .code
2181 X11=/usr/openwin
2182 XINCLUDE=-I$(X11)/include
2183 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2184 .endd
2185 If you need to override the default setting for your operating system, place a
2186 definition of all three of these variables into your
2187 &_Local/Makefile-<ostype>_& file.
2188
2189 .cindex "EXTRALIBS"
2190 If you need to add any extra libraries to the link steps, these can be put in a
2191 variable called EXTRALIBS, which appears in all the link commands, but by
2192 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2193 command for linking the main Exim binary, and not for any associated utilities.
2194
2195 .cindex "DBM libraries" "configuration for building"
2196 There is also DBMLIB, which appears in the link commands for binaries that
2197 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2198 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2199 binary, and which can be used, for example, to include additional X11
2200 libraries.
2201
2202 .cindex "configuration file" "editing"
2203 The make file copes with rebuilding Exim correctly if any of the configuration
2204 files are edited. However, if an optional configuration file is deleted, it is
2205 necessary to touch the associated non-optional file (that is,
2206 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2207
2208
2209 .section "OS-specific header files" "SECID30"
2210 .cindex "&_os.h_&"
2211 .cindex "building Exim" "OS-specific C header files"
2212 The &_OS_& directory contains a number of files with names of the form
2213 &_os.h-<ostype>_&. These are system-specific C header files that should not
2214 normally need to be changed. There is a list of macro settings that are
2215 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2216 are porting Exim to a new operating system.
2217
2218
2219
2220 .section "Overriding build-time options for the monitor" "SECID31"
2221 .cindex "building Eximon"
2222 A similar process is used for overriding things when building the Exim monitor,
2223 where the files that are involved are
2224 .display
2225 &_OS/eximon.conf-Default_&
2226 &_OS/eximon.conf-_&<&'ostype'&>
2227 &_Local/eximon.conf_&
2228 &_Local/eximon.conf-_&<&'ostype'&>
2229 &_Local/eximon.conf-_&<&'archtype'&>
2230 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2231 .endd
2232 .cindex "&_Local/eximon.conf_&"
2233 As with Exim itself, the final three files need not exist, and in this case the
2234 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2235 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2236 variables of the same name, preceded by EXIMON_. For example, setting
2237 EXIMON_LOG_DEPTH in the environment overrides the value of
2238 LOG_DEPTH at run time.
2239 .ecindex IIDbuex
2240
2241
2242 .section "Installing Exim binaries and scripts" "SECID32"
2243 .cindex "installing Exim"
2244 .cindex "BIN_DIRECTORY"
2245 The command &`make install`& runs the &(exim_install)& script with no
2246 arguments. The script copies binaries and utility scripts into the directory
2247 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2248 .cindex "setuid" "installing Exim with"
2249 The install script copies files only if they are newer than the files they are
2250 going to replace. The Exim binary is required to be owned by root and have the
2251 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2252 install`& as root so that it can set up the Exim binary in this way. However, in
2253 some special situations (for example, if a host is doing no local deliveries)
2254 it may be possible to run Exim without making the binary setuid root (see
2255 chapter &<<CHAPsecurity>>& for details).
2256
2257 .cindex "CONFIGURE_FILE"
2258 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2259 in &_Local/Makefile_&. If this names a single file, and the file does not
2260 exist, the default configuration file &_src/configure.default_& is copied there
2261 by the installation script. If a run time configuration file already exists, it
2262 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2263 alternative files, no default is installed.
2264
2265 .cindex "system aliases file"
2266 .cindex "&_/etc/aliases_&"
2267 One change is made to the default configuration file when it is installed: the
2268 default configuration contains a router that references a system aliases file.
2269 The path to this file is set to the value specified by
2270 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2271 If the system aliases file does not exist, the installation script creates it,
2272 and outputs a comment to the user.
2273
2274 The created file contains no aliases, but it does contain comments about the
2275 aliases a site should normally have. Mail aliases have traditionally been
2276 kept in &_/etc/aliases_&. However, some operating systems are now using
2277 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2278 Exim's configuration if necessary.
2279
2280 The default configuration uses the local host's name as the only local domain,
2281 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2282 running as the local user. System aliases and &_.forward_& files in users' home
2283 directories are supported, but no NIS or NIS+ support is configured. Domains
2284 other than the name of the local host are routed using the DNS, with delivery
2285 over SMTP.
2286
2287 It is possible to install Exim for special purposes (such as building a binary
2288 distribution) in a private part of the file system. You can do this by a
2289 command such as
2290 .code
2291 make DESTDIR=/some/directory/ install
2292 .endd
2293 This has the effect of pre-pending the specified directory to all the file
2294 paths, except the name of the system aliases file that appears in the default
2295 configuration. (If a default alias file is created, its name &'is'& modified.)
2296 For backwards compatibility, ROOT is used if DESTDIR is not set,
2297 but this usage is deprecated.
2298
2299 .cindex "installing Exim" "what is not installed"
2300 Running &'make install'& does not copy the Exim 4 conversion script
2301 &'convert4r4'&. You will probably run this only once if you are
2302 upgrading from Exim 3. None of the documentation files in the &_doc_&
2303 directory are copied, except for the info files when you have set
2304 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2305
2306 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2307 to their names. The Exim binary itself, however, is handled differently. It is
2308 installed under a name that includes the version number and the compile number,
2309 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2310 called &_exim_& to point to the binary. If you are updating a previous version
2311 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2312 from the directory (as seen by other processes).
2313
2314 .cindex "installing Exim" "testing the script"
2315 If you want to see what the &'make install'& will do before running it for
2316 real, you can pass the &%-n%& option to the installation script by this
2317 command:
2318 .code
2319 make INSTALL_ARG=-n install
2320 .endd
2321 The contents of the variable INSTALL_ARG are passed to the installation
2322 script. You do not need to be root to run this test. Alternatively, you can run
2323 the installation script directly, but this must be from within the build
2324 directory. For example, from the top-level Exim directory you could use this
2325 command:
2326 .code
2327 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2328 .endd
2329 .cindex "installing Exim" "install script options"
2330 There are two other options that can be supplied to the installation script.
2331
2332 .ilist
2333 &%-no_chown%& bypasses the call to change the owner of the installed binary
2334 to root, and the call to make it a setuid binary.
2335 .next
2336 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2337 installed binary.
2338 .endlist
2339
2340 INSTALL_ARG can be used to pass these options to the script. For example:
2341 .code
2342 make INSTALL_ARG=-no_symlink install
2343 .endd
2344 The installation script can also be given arguments specifying which files are
2345 to be copied. For example, to install just the Exim binary, and nothing else,
2346 without creating the symbolic link, you could use:
2347 .code
2348 make INSTALL_ARG='-no_symlink exim' install
2349 .endd
2350
2351
2352
2353 .section "Installing info documentation" "SECTinsinfdoc"
2354 .cindex "installing Exim" "&'info'& documentation"
2355 Not all systems use the GNU &'info'& system for documentation, and for this
2356 reason, the Texinfo source of Exim's documentation is not included in the main
2357 distribution. Instead it is available separately from the ftp site (see section
2358 &<<SECTavail>>&).
2359
2360 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2361 source of the documentation is found in the source tree, running &`make
2362 install`& automatically builds the info files and installs them.
2363
2364
2365
2366 .section "Setting up the spool directory" "SECID33"
2367 .cindex "spool directory" "creating"
2368 When it starts up, Exim tries to create its spool directory if it does not
2369 exist. The Exim uid and gid are used for the owner and group of the spool
2370 directory. Sub-directories are automatically created in the spool directory as
2371 necessary.
2372
2373
2374
2375
2376 .section "Testing" "SECID34"
2377 .cindex "testing" "installation"
2378 Having installed Exim, you can check that the run time configuration file is
2379 syntactically valid by running the following command, which assumes that the
2380 Exim binary directory is within your PATH environment variable:
2381 .code
2382 exim -bV
2383 .endd
2384 If there are any errors in the configuration file, Exim outputs error messages.
2385 Otherwise it outputs the version number and build date,
2386 the DBM library that is being used, and information about which drivers and
2387 other optional code modules are included in the binary.
2388 Some simple routing tests can be done by using the address testing option. For
2389 example,
2390 .display
2391 &`exim -bt`& <&'local username'&>
2392 .endd
2393 should verify that it recognizes a local mailbox, and
2394 .display
2395 &`exim -bt`& <&'remote address'&>
2396 .endd
2397 a remote one. Then try getting it to deliver mail, both locally and remotely.
2398 This can be done by passing messages directly to Exim, without going through a
2399 user agent. For example:
2400 .code
2401 exim -v postmaster@your.domain.example
2402 From: user@your.domain.example
2403 To: postmaster@your.domain.example
2404 Subject: Testing Exim
2405
2406 This is a test message.
2407 ^D
2408 .endd
2409 The &%-v%& option causes Exim to output some verification of what it is doing.
2410 In this case you should see copies of three log lines, one for the message's
2411 arrival, one for its delivery, and one containing &"Completed"&.
2412
2413 .cindex "delivery" "problems with"
2414 If you encounter problems, look at Exim's log files (&'mainlog'& and
2415 &'paniclog'&) to see if there is any relevant information there. Another source
2416 of information is running Exim with debugging turned on, by specifying the
2417 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2418 with debugging turned on by a command of the form
2419 .display
2420 &`exim -d -M`& <&'exim-message-id'&>
2421 .endd
2422 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2423 produces rather a lot of output, but you can cut this down to specific areas.
2424 For example, if you use &%-d-all+route%& only the debugging information
2425 relevant to routing is included. (See the &%-d%& option in chapter
2426 &<<CHAPcommandline>>& for more details.)
2427
2428 .cindex '&"sticky"& bit'
2429 .cindex "lock files"
2430 One specific problem that has shown up on some sites is the inability to do
2431 local deliveries into a shared mailbox directory, because it does not have the
2432 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2433 writing to a mailbox file, and if it cannot create the lock file, the delivery
2434 is deferred. You can get round this either by setting the &"sticky bit"& on the
2435 directory, or by setting a specific group for local deliveries and allowing
2436 that group to create files in the directory (see the comments above the
2437 &(local_delivery)& transport in the default configuration file). Another
2438 approach is to configure Exim not to use lock files, but just to rely on
2439 &[fcntl()]& locking instead. However, you should do this only if all user
2440 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2441 see chapter &<<CHAPappendfile>>&.
2442
2443 One thing that cannot be tested on a system that is already running an MTA is
2444 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2445 &%-oX%& option can be used to run an Exim daemon that listens on some other
2446 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2447 &'exim_checkaccess'& utility can be used to check out policy controls on
2448 incoming SMTP mail.
2449
2450 Testing a new version on a system that is already running Exim can most easily
2451 be done by building a binary with a different CONFIGURE_FILE setting. From
2452 within the run time configuration, all other file and directory names
2453 that Exim uses can be altered, in order to keep it entirely clear of the
2454 production version.
2455
2456
2457 .section "Replacing another MTA with Exim" "SECID35"
2458 .cindex "replacing another MTA"
2459 Building and installing Exim for the first time does not of itself put it in
2460 general use. The name by which the system's MTA is called by mail user agents
2461 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2462 operating system), and it is necessary to make this name point to the &'exim'&
2463 binary in order to get the user agents to pass messages to Exim. This is
2464 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2465 or &_/usr/lib/sendmail_&
2466 .cindex "symbolic link" "to &'exim'& binary"
2467 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2468 privilege and executable status from the old MTA. It is then necessary to stop
2469 and restart the mailer daemon, if one is running.
2470
2471 .cindex "FreeBSD, MTA indirection"
2472 .cindex "&_/etc/mail/mailer.conf_&"
2473 Some operating systems have introduced alternative ways of switching MTAs. For
2474 example, if you are running FreeBSD, you need to edit the file
2475 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2476 described. A typical example of the contents of this file for running Exim is
2477 as follows:
2478 .code
2479 sendmail            /usr/exim/bin/exim
2480 send-mail           /usr/exim/bin/exim
2481 mailq               /usr/exim/bin/exim -bp
2482 newaliases          /usr/bin/true
2483 .endd
2484 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2485 your Exim installation is &"live"&. Check it by sending a message from your
2486 favourite user agent.
2487
2488 You should consider what to tell your users about the change of MTA. Exim may
2489 have different capabilities to what was previously running, and there are
2490 various operational differences such as the text of messages produced by
2491 command line options and in bounce messages. If you allow your users to make
2492 use of Exim's filtering capabilities, you should make the document entitled
2493 &'Exim's interface to mail filtering'& available to them.
2494
2495
2496
2497 .section "Upgrading Exim" "SECID36"
2498 .cindex "upgrading Exim"
2499 If you are already running Exim on your host, building and installing a new
2500 version automatically makes it available to MUAs, or any other programs that
2501 call the MTA directly. However, if you are running an Exim daemon, you do need
2502 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2503 new binary. You do not need to stop processing mail in order to install a new
2504 version of Exim. The install script does not modify an existing runtime
2505 configuration file.
2506
2507
2508
2509
2510 .section "Stopping the Exim daemon on Solaris" "SECID37"
2511 .cindex "Solaris" "stopping Exim on"
2512 The standard command for stopping the mailer daemon on Solaris is
2513 .code
2514 /etc/init.d/sendmail stop
2515 .endd
2516 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2517 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2518 for the text &"sendmail"&; this is not present because the actual program name
2519 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2520 solution is to replace the line that finds the process id with something like
2521 .code
2522 pid=`cat /var/spool/exim/exim-daemon.pid`
2523 .endd
2524 to obtain the daemon's pid directly from the file that Exim saves it in.
2525
2526 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2527 still be received from local processes, and if automatic delivery is configured
2528 (the normal case), deliveries will still occur.
2529
2530
2531
2532
2533 . ////////////////////////////////////////////////////////////////////////////
2534 . ////////////////////////////////////////////////////////////////////////////
2535
2536 .chapter "The Exim command line" "CHAPcommandline"
2537 .scindex IIDclo1 "command line" "options"
2538 .scindex IIDclo2 "options" "command line"
2539 Exim's command line takes the standard Unix form of a sequence of options,
2540 each starting with a hyphen character, followed by a number of arguments. The
2541 options are compatible with the main options of Sendmail, and there are also
2542 some additional options, some of which are compatible with Smail 3. Certain
2543 combinations of options do not make sense, and provoke an error if used.
2544 The form of the arguments depends on which options are set.
2545
2546
2547 .section "Setting options by program name" "SECID38"
2548 .cindex "&'mailq'&"
2549 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2550 were present before any other options.
2551 The &%-bp%& option requests a listing of the contents of the mail queue on the
2552 standard output.
2553 This feature is for compatibility with some systems that contain a command of
2554 that name in one of the standard libraries, symbolically linked to
2555 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2556
2557 .cindex "&'rsmtp'&"
2558 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2559 were present before any other options, for compatibility with Smail. The
2560 &%-bS%& option is used for reading in a number of messages in batched SMTP
2561 format.
2562
2563 .cindex "&'rmail'&"
2564 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2565 &%-oee%& options were present before any other options, for compatibility with
2566 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2567
2568 .cindex "&'runq'&"
2569 .cindex "queue runner"
2570 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2571 were present before any other options, for compatibility with Smail. The &%-q%&
2572 option causes a single queue runner process to be started.
2573
2574 .cindex "&'newaliases'&"
2575 .cindex "alias file" "building"
2576 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2577 If Exim is called under the name &'newaliases'& it behaves as if the option
2578 &%-bi%& were present before any other options, for compatibility with Sendmail.
2579 This option is used for rebuilding Sendmail's alias file. Exim does not have
2580 the concept of a single alias file, but can be configured to run a given
2581 command if called with the &%-bi%& option.
2582
2583
2584 .section "Trusted and admin users" "SECTtrustedadmin"
2585 Some Exim options are available only to &'trusted users'& and others are
2586 available only to &'admin users'&. In the description below, the phrases &"Exim
2587 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2588 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2589 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2590
2591 .ilist
2592 .cindex "trusted users" "definition of"
2593 .cindex "user" "trusted definition of"
2594 The trusted users are root, the Exim user, any user listed in the
2595 &%trusted_users%& configuration option, and any user whose current group or any
2596 supplementary group is one of those listed in the &%trusted_groups%&
2597 configuration option. Note that the Exim group is not automatically trusted.
2598
2599 .cindex '&"From"& line'
2600 .cindex "envelope sender"
2601 Trusted users are always permitted to use the &%-f%& option or a leading
2602 &"From&~"& line to specify the envelope sender of a message that is passed to
2603 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2604 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2605 users to set envelope senders.
2606
2607 .cindex "&'From:'& header line"
2608 .cindex "&'Sender:'& header line"
2609 For a trusted user, there is never any check on the contents of the &'From:'&
2610 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2611 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2612
2613 Trusted users may also specify a host name, host address, interface address,
2614 protocol name, ident value, and authentication data when submitting a message
2615 locally. Thus, they are able to insert messages into Exim's queue locally that
2616 have the characteristics of messages received from a remote host. Untrusted
2617 users may in some circumstances use &%-f%&, but can never set the other values
2618 that are available to trusted users.
2619 .next
2620 .cindex "user" "admin definition of"
2621 .cindex "admin user" "definition of"
2622 The admin users are root, the Exim user, and any user that is a member of the
2623 Exim group or of any group listed in the &%admin_groups%& configuration option.
2624 The current group does not have to be one of these groups.
2625
2626 Admin users are permitted to list the queue, and to carry out certain
2627 operations on messages, for example, to force delivery failures. It is also
2628 necessary to be an admin user in order to see the full information provided by
2629 the Exim monitor, and full debugging output.
2630
2631 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2632 Exim to attempt delivery of messages on its queue is restricted to admin users.
2633 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2634 option false (that is, specifying &%no_prod_requires_admin%&).
2635
2636 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2637 is restricted to admin users unless &%queue_list_requires_admin%& is set
2638 false.
2639 .endlist
2640
2641
2642 &*Warning*&: If you configure your system so that admin users are able to
2643 edit Exim's configuration file, you are giving those users an easy way of
2644 getting root. There is further discussion of this issue at the start of chapter
2645 &<<CHAPconf>>&.
2646
2647
2648
2649
2650 .section "Command line options" "SECID39"
2651 Exim's command line options are described in alphabetical order below. If none
2652 of the options that specifies a specific action (such as starting the daemon or
2653 a queue runner, or testing an address, or receiving a message in a specific
2654 format, or listing the queue) are present, and there is at least one argument
2655 on the command line, &%-bm%& (accept a local message on the standard input,
2656 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2657 outputs a brief message about itself and exits.
2658
2659 . ////////////////////////////////////////////////////////////////////////////
2660 . Insert a stylized XML comment here, to identify the start of the command line
2661 . options. This is for the benefit of the Perl script that automatically
2662 . creates a man page for the options.
2663 . ////////////////////////////////////////////////////////////////////////////
2664
2665 .literal xml
2666 <!-- === Start of command line options === -->
2667 .literal off
2668
2669
2670 .vlist
2671 .vitem &%--%&
2672 .oindex "--"
2673 .cindex "options" "command line; terminating"
2674 This is a pseudo-option whose only purpose is to terminate the options and
2675 therefore to cause subsequent command line items to be treated as arguments
2676 rather than options, even if they begin with hyphens.
2677
2678 .vitem &%--help%&
2679 .oindex "&%--help%&"
2680 This option causes Exim to output a few sentences stating what it is.
2681 The same output is generated if the Exim binary is called with no options and
2682 no arguments.
2683
2684 .vitem &%--version%&
2685 .oindex "&%--version%&"
2686 This option is an alias for &%-bV%& and causes version information to be
2687 displayed.
2688
2689 .vitem &%-B%&<&'type'&>
2690 .oindex "&%-B%&"
2691 .cindex "8-bit characters"
2692 .cindex "Sendmail compatibility" "8-bit characters"
2693 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2694 clean; it ignores this option.
2695
2696 .vitem &%-bd%&
2697 .oindex "&%-bd%&"
2698 .cindex "daemon"
2699 .cindex "SMTP" "listener"
2700 .cindex "queue runner"
2701 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2702 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2703 that the daemon should also initiate periodic queue runs.
2704
2705 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2706 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2707 disconnect from the controlling terminal. When running this way, it can be
2708 stopped by pressing ctrl-C.
2709
2710 By default, Exim listens for incoming connections to the standard SMTP port on
2711 all the host's running interfaces. However, it is possible to listen on other
2712 ports, on multiple ports, and only on specific interfaces. Chapter
2713 &<<CHAPinterfaces>>& contains a description of the options that control this.
2714
2715 When a listening daemon
2716 .cindex "daemon" "process id (pid)"
2717 .cindex "pid (process id)" "of daemon"
2718 is started without the use of &%-oX%& (that is, without overriding the normal
2719 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2720 in Exim's spool directory. This location can be overridden by setting
2721 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2722 running as root.
2723
2724 When &%-oX%& is used on the command line to start a listening daemon, the
2725 process id is not written to the normal pid file path. However, &%-oP%& can be
2726 used to specify a path on the command line if a pid file is required.
2727
2728 The SIGHUP signal
2729 .cindex "SIGHUP"
2730 .cindex "daemon" "restarting"
2731 can be used to cause the daemon to re-execute itself. This should be done
2732 whenever Exim's configuration file, or any file that is incorporated into it by
2733 means of the &%.include%& facility, is changed, and also whenever a new version
2734 of Exim is installed. It is not necessary to do this when other files that are
2735 referenced from the configuration (for example, alias files) are changed,
2736 because these are reread each time they are used.
2737
2738 .vitem &%-bdf%&
2739 .oindex "&%-bdf%&"
2740 This option has the same effect as &%-bd%& except that it never disconnects
2741 from the controlling terminal, even when no debugging is specified.
2742
2743 .vitem &%-be%&
2744 .oindex "&%-be%&"
2745 .cindex "testing" "string expansion"
2746 .cindex "expansion" "testing"
2747 Run Exim in expansion testing mode. Exim discards its root privilege, to
2748 prevent ordinary users from using this mode to read otherwise inaccessible
2749 files. If no arguments are given, Exim runs interactively, prompting for lines
2750 of data. Otherwise, it processes each argument in turn.
2751
2752 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2753 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2754 used without command line arguments. If successful, it uses the &[readline()]&
2755 function, which provides extensive line-editing facilities, for reading the
2756 test data. A line history is supported.
2757
2758 Long expansion expressions can be split over several lines by using backslash
2759 continuations. As in Exim's run time configuration, white space at the start of
2760 continuation lines is ignored. Each argument or data line is passed through the
2761 string expansion mechanism, and the result is output. Variable values from the
2762 configuration file (for example, &$qualify_domain$&) are available, but no
2763 message-specific values (such as &$sender_domain$&) are set, because no message
2764 is being processed (but see &%-bem%& and &%-Mset%&).
2765
2766 &*Note*&: If you use this mechanism to test lookups, and you change the data
2767 files or databases you are using, you must exit and restart Exim before trying
2768 the same lookup again. Otherwise, because each Exim process caches the results
2769 of lookups, you will just get the same result as before.
2770
2771 .vitem &%-bem%&&~<&'filename'&>
2772 .oindex "&%-bem%&"
2773 .cindex "testing" "string expansion"
2774 .cindex "expansion" "testing"
2775 This option operates like &%-be%& except that it must be followed by the name
2776 of a file. For example:
2777 .code
2778 exim -bem /tmp/testmessage
2779 .endd
2780 The file is read as a message (as if receiving a locally-submitted non-SMTP
2781 message) before any of the test expansions are done. Thus, message-specific
2782 variables such as &$message_size$& and &$header_from:$& are available. However,
2783 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2784 recipients are read from the headers in the normal way, and are shown in the
2785 &$recipients$& variable. Note that recipients cannot be given on the command
2786 line, because further arguments are taken as strings to expand (just like
2787 &%-be%&).
2788
2789 .vitem &%-bF%&&~<&'filename'&>
2790 .oindex "&%-bF%&"
2791 .cindex "system filter" "testing"
2792 .cindex "testing" "system filter"
2793 This option is the same as &%-bf%& except that it assumes that the filter being
2794 tested is a system filter. The additional commands that are available only in
2795 system filters are recognized.
2796
2797 .vitem &%-bf%&&~<&'filename'&>
2798 .oindex "&%-bf%&"
2799 .cindex "filter" "testing"
2800 .cindex "testing" "filter file"
2801 .cindex "forward file" "testing"
2802 .cindex "testing" "forward file"
2803 .cindex "Sieve filter" "testing"
2804 This option runs Exim in user filter testing mode; the file is the filter file
2805 to be tested, and a test message must be supplied on the standard input. If
2806 there are no message-dependent tests in the filter, an empty file can be
2807 supplied.
2808
2809 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2810 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2811 filter and a user filter in the same run. For example:
2812 .code
2813 exim -bF /system/filter -bf /user/filter </test/message
2814 .endd
2815 This is helpful when the system filter adds header lines or sets filter
2816 variables that are used by the user filter.
2817
2818 If the test filter file does not begin with one of the special lines
2819 .code
2820 # Exim filter
2821 # Sieve filter
2822 .endd
2823 it is taken to be a normal &_.forward_& file, and is tested for validity under
2824 that interpretation. See sections &<<SECTitenonfilred>>& to
2825 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2826 redirection lists.
2827
2828 The result of an Exim command that uses &%-bf%&, provided no errors are
2829 detected, is a list of the actions that Exim would try to take if presented
2830 with the message for real. More details of filter testing are given in the
2831 separate document entitled &'Exim's interfaces to mail filtering'&.
2832
2833 When testing a filter file,
2834 .cindex "&""From""& line"
2835 .cindex "envelope sender"
2836 .oindex "&%-f%&" "for filter testing"
2837 the envelope sender can be set by the &%-f%& option,
2838 or by a &"From&~"& line at the start of the test message. Various parameters
2839 that would normally be taken from the envelope recipient address of the message
2840 can be set by means of additional command line options (see the next four
2841 options).
2842
2843 .vitem &%-bfd%&&~<&'domain'&>
2844 .oindex "&%-bfd%&"
2845 .vindex "&$qualify_domain$&"
2846 This sets the domain of the recipient address when a filter file is being
2847 tested by means of the &%-bf%& option. The default is the value of
2848 &$qualify_domain$&.
2849
2850 .vitem &%-bfl%&&~<&'local&~part'&>
2851 .oindex "&%-bfl%&"
2852 This sets the local part of the recipient address when a filter file is being
2853 tested by means of the &%-bf%& option. The default is the username of the
2854 process that calls Exim. A local part should be specified with any prefix or
2855 suffix stripped, because that is how it appears to the filter when a message is
2856 actually being delivered.
2857
2858 .vitem &%-bfp%&&~<&'prefix'&>
2859 .oindex "&%-bfp%&"
2860 This sets the prefix of the local part of the recipient address when a filter
2861 file is being tested by means of the &%-bf%& option. The default is an empty
2862 prefix.
2863
2864 .vitem &%-bfs%&&~<&'suffix'&>
2865 .oindex "&%-bfs%&"
2866 This sets the suffix of the local part of the recipient address when a filter
2867 file is being tested by means of the &%-bf%& option. The default is an empty
2868 suffix.
2869
2870 .vitem &%-bh%&&~<&'IP&~address'&>
2871 .oindex "&%-bh%&"
2872 .cindex "testing" "incoming SMTP"
2873 .cindex "SMTP" "testing incoming"
2874 .cindex "testing" "relay control"
2875 .cindex "relaying" "testing configuration"
2876 .cindex "policy control" "testing"
2877 .cindex "debugging" "&%-bh%& option"
2878 This option runs a fake SMTP session as if from the given IP address, using the
2879 standard input and output. The IP address may include a port number at the end,
2880 after a full stop. For example:
2881 .code
2882 exim -bh 10.9.8.7.1234
2883 exim -bh fe80::a00:20ff:fe86:a061.5678
2884 .endd
2885 When an IPv6 address is given, it is converted into canonical form. In the case
2886 of the second example above, the value of &$sender_host_address$& after
2887 conversion to the canonical form is
2888 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2889
2890 Comments as to what is going on are written to the standard error file. These
2891 include lines beginning with &"LOG"& for anything that would have been logged.
2892 This facility is provided for testing configuration options for incoming
2893 messages, to make sure they implement the required policy. For example, you can
2894 test your relay controls using &%-bh%&.
2895
2896 &*Warning 1*&:
2897 .cindex "RFC 1413"
2898 You can test features of the configuration that rely on ident (RFC 1413)
2899 information by using the &%-oMt%& option. However, Exim cannot actually perform
2900 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2901 connection.
2902
2903 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2904 are also skipped when testing using &%-bh%&. If you want these callouts to
2905 occur, use &%-bhc%& instead.
2906
2907 Messages supplied during the testing session are discarded, and nothing is
2908 written to any of the real log files. There may be pauses when DNS (and other)
2909 lookups are taking place, and of course these may time out. The &%-oMi%& option
2910 can be used to specify a specific IP interface and port if this is important,
2911 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2912 session were authenticated.
2913
2914 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2915 output just states whether a given recipient address from a given host is
2916 acceptable or not. See section &<<SECTcheckaccess>>&.
2917
2918 Features such as authentication and encryption, where the client input is not
2919 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2920 specialized SMTP test program such as
2921 &url(http://jetmore.org/john/code/#swaks,swaks).
2922
2923 .vitem &%-bhc%&&~<&'IP&~address'&>
2924 .oindex "&%-bhc%&"
2925 This option operates in the same way as &%-bh%&, except that address
2926 verification callouts are performed if required. This includes consulting and
2927 updating the callout cache database.
2928
2929 .vitem &%-bi%&
2930 .oindex "&%-bi%&"
2931 .cindex "alias file" "building"
2932 .cindex "building alias file"
2933 .cindex "Sendmail compatibility" "&%-bi%& option"
2934 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2935 Exim does not have the concept of a single alias file, and so it cannot mimic
2936 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2937 tend to appear in various scripts such as NIS make files, so the option must be
2938 recognized.
2939
2940 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2941 configuration option is run, under the uid and gid of the caller of Exim. If
2942 the &%-oA%& option is used, its value is passed to the command as an argument.
2943 The command set by &%bi_command%& may not contain arguments. The command can
2944 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2945 if this is required. If the &%bi_command%& option is not set, calling Exim with
2946 &%-bi%& is a no-op.
2947
2948 .vitem &%-bm%&
2949 .oindex "&%-bm%&"
2950 .cindex "local message reception"
2951 This option runs an Exim receiving process that accepts an incoming,
2952 locally-generated message on the current input. The recipients are given as the
2953 command arguments (except when &%-t%& is also present &-- see below). Each
2954 argument can be a comma-separated list of RFC 2822 addresses. This is the
2955 default option for selecting the overall action of an Exim call; it is assumed
2956 if no other conflicting option is present.
2957
2958 If any addresses in the message are unqualified (have no domain), they are
2959 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2960 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2961 suppressing this for special cases.
2962
2963 Policy checks on the contents of local messages can be enforced by means of
2964 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2965
2966 .cindex "return code" "for &%-bm%&"
2967 The return code is zero if the message is successfully accepted. Otherwise, the
2968 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2969
2970 The format
2971 .cindex "message" "format"
2972 .cindex "format" "message"
2973 .cindex "&""From""& line"
2974 .cindex "UUCP" "&""From""& line"
2975 .cindex "Sendmail compatibility" "&""From""& line"
2976 of the message must be as defined in RFC 2822, except that, for
2977 compatibility with Sendmail and Smail, a line in one of the forms
2978 .code
2979 From sender Fri Jan  5 12:55 GMT 1997
2980 From sender Fri, 5 Jan 97 12:55:01
2981 .endd
2982 (with the weekday optional, and possibly with additional text after the date)
2983 is permitted to appear at the start of the message. There appears to be no
2984 authoritative specification of the format of this line. Exim recognizes it by
2985 matching against the regular expression defined by the &%uucp_from_pattern%&
2986 option, which can be changed if necessary.
2987
2988 .oindex "&%-f%&" "overriding &""From""& line"
2989 The specified sender is treated as if it were given as the argument to the
2990 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2991 preference to the address taken from the message. The caller of Exim must be a
2992 trusted user for the sender of a message to be set in this way.
2993
2994 .vitem &%-bnq%&
2995 .oindex "&%-bnq%&"
2996 .cindex "address qualification, suppressing"
2997 By default, Exim automatically qualifies unqualified addresses (those
2998 without domains) that appear in messages that are submitted locally (that
2999 is, not over TCP/IP). This qualification applies both to addresses in
3000 envelopes, and addresses in header lines. Sender addresses are qualified using
3001 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3002 defaults to the value of &%qualify_domain%&).
3003
3004 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3005 being used to re-submit messages that originally came from remote hosts after
3006 content scanning, you probably do not want to qualify unqualified addresses in
3007 header lines. (Such lines will be present only if you have not enabled a header
3008 syntax check in the appropriate ACL.)
3009
3010 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3011 messages that originate on the local host. When this is used, unqualified
3012 addresses in the envelope provoke errors (causing message rejection) and
3013 unqualified addresses in header lines are left alone.
3014
3015
3016 .vitem &%-bP%&
3017 .oindex "&%-bP%&"
3018 .cindex "configuration options" "extracting"
3019 .cindex "options" "configuration &-- extracting"
3020 If this option is given with no arguments, it causes the values of all Exim's
3021 main configuration options to be written to the standard output. The values
3022 of one or more specific options can be requested by giving their names as
3023 arguments, for example:
3024 .code
3025 exim -bP qualify_domain hold_domains
3026 .endd
3027 .cindex "hiding configuration option values"
3028 .cindex "configuration options" "hiding value of"
3029 .cindex "options" "hiding value of"
3030 However, any option setting that is preceded by the word &"hide"& in the
3031 configuration file is not shown in full, except to an admin user. For other
3032 users, the output is as in this example:
3033 .code
3034 mysql_servers = <value not displayable>
3035 .endd
3036 If &%configure_file%& is given as an argument, the name of the run time
3037 configuration file is output.
3038 If a list of configuration files was supplied, the value that is output here
3039 is the name of the file that was actually used.
3040
3041 .cindex "daemon" "process id (pid)"
3042 .cindex "pid (process id)" "of daemon"
3043 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3044 directories where log files and daemon pid files are written are output,
3045 respectively. If these values are unset, log files are written in a
3046 sub-directory of the spool directory called &%log%&, and the pid file is
3047 written directly into the spool directory.
3048
3049 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3050 .code
3051 exim -bP +local_domains
3052 .endd
3053 it searches for a matching named list of any type (domain, host, address, or
3054 local part) and outputs what it finds.
3055
3056 .cindex "options" "router &-- extracting"
3057 .cindex "options" "transport &-- extracting"
3058 .cindex "options" "authenticator &-- extracting"
3059 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3060 followed by the name of an appropriate driver instance, the option settings for
3061 that driver are output. For example:
3062 .code
3063 exim -bP transport local_delivery
3064 .endd
3065 The generic driver options are output first, followed by the driver's private
3066 options. A list of the names of drivers of a particular type can be obtained by
3067 using one of the words &%router_list%&, &%transport_list%&, or
3068 &%authenticator_list%&, and a complete list of all drivers with their option
3069 settings can be obtained by using &%routers%&, &%transports%&, or
3070 &%authenticators%&.
3071
3072 .cindex "options" "macro &-- extracting"
3073 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3074 are available, similarly to the drivers.  Because macros are sometimes used
3075 for storing passwords, this option is restricted.
3076 The output format is one item per line.
3077
3078 .vitem &%-bp%&
3079 .oindex "&%-bp%&"
3080 .cindex "queue" "listing messages on"
3081 .cindex "listing" "messages on the queue"
3082 This option requests a listing of the contents of the mail queue on the
3083 standard output. If the &%-bp%& option is followed by a list of message ids,
3084 just those messages are listed. By default, this option can be used only by an
3085 admin user. However, the &%queue_list_requires_admin%& option can be set false
3086 to allow any user to see the queue.
3087
3088 Each message on the queue is displayed as in the following example:
3089 .code
3090 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3091           red.king@looking-glass.fict.example
3092           <other addresses>
3093 .endd
3094 .cindex "message" "size in queue listing"
3095 .cindex "size" "of message"
3096 The first line contains the length of time the message has been on the queue
3097 (in this case 25 minutes), the size of the message (2.9K), the unique local
3098 identifier for the message, and the message sender, as contained in the
3099 envelope. For bounce messages, the sender address is empty, and appears as
3100 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3101 the default sender address, the user's login name is shown in parentheses
3102 before the sender address.
3103
3104 .cindex "frozen messages" "in queue listing"
3105 If the message is frozen (attempts to deliver it are suspended) then the text
3106 &"*** frozen ***"& is displayed at the end of this line.
3107
3108 The recipients of the message (taken from the envelope, not the headers) are
3109 displayed on subsequent lines. Those addresses to which the message has already
3110 been delivered are marked with the letter D. If an original address gets
3111 expanded into several addresses via an alias or forward file, the original is
3112 displayed with a D only when deliveries for all of its child addresses are
3113 complete.
3114
3115
3116 .vitem &%-bpa%&
3117 .oindex "&%-bpa%&"
3118 This option operates like &%-bp%&, but in addition it shows delivered addresses
3119 that were generated from the original top level address(es) in each message by
3120 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3121 of just &"D"&.
3122
3123
3124 .vitem &%-bpc%&
3125 .oindex "&%-bpc%&"
3126 .cindex "queue" "count of messages on"
3127 This option counts the number of messages on the queue, and writes the total
3128 to the standard output. It is restricted to admin users, unless
3129 &%queue_list_requires_admin%& is set false.
3130
3131
3132 .vitem &%-bpr%&
3133 .oindex "&%-bpr%&"
3134 This option operates like &%-bp%&, but the output is not sorted into
3135 chronological order of message arrival. This can speed it up when there are
3136 lots of messages on the queue, and is particularly useful if the output is
3137 going to be post-processed in a way that doesn't need the sorting.
3138
3139 .vitem &%-bpra%&
3140 .oindex "&%-bpra%&"
3141 This option is a combination of &%-bpr%& and &%-bpa%&.
3142
3143 .vitem &%-bpru%&
3144 .oindex "&%-bpru%&"
3145 This option is a combination of &%-bpr%& and &%-bpu%&.
3146
3147
3148 .vitem &%-bpu%&
3149 .oindex "&%-bpu%&"
3150 This option operates like &%-bp%& but shows only undelivered top-level
3151 addresses for each message displayed. Addresses generated by aliasing or
3152 forwarding are not shown, unless the message was deferred after processing by a
3153 router with the &%one_time%& option set.
3154
3155
3156 .vitem &%-brt%&
3157 .oindex "&%-brt%&"
3158 .cindex "testing" "retry configuration"
3159 .cindex "retry" "configuration testing"
3160 This option is for testing retry rules, and it must be followed by up to three
3161 arguments. It causes Exim to look for a retry rule that matches the values
3162 and to write it to the standard output. For example:
3163 .code
3164 exim -brt bach.comp.mus.example
3165 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3166 .endd
3167 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3168 argument, which is required, can be a complete address in the form
3169 &'local_part@domain'&, or it can be just a domain name. If the second argument
3170 contains a dot, it is interpreted as an optional second domain name; if no
3171 retry rule is found for the first argument, the second is tried. This ties in
3172 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3173 rule is found that matches the host, one that matches the mail domain is
3174 sought. Finally, an argument that is the name of a specific delivery error, as
3175 used in setting up retry rules, can be given. For example:
3176 .code
3177 exim -brt haydn.comp.mus.example quota_3d
3178 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3179 .endd
3180
3181 .vitem &%-brw%&
3182 .oindex "&%-brw%&"
3183 .cindex "testing" "rewriting"
3184 .cindex "rewriting" "testing"
3185 This option is for testing address rewriting rules, and it must be followed by
3186 a single argument, consisting of either a local part without a domain, or a
3187 complete address with a fully qualified domain. Exim outputs how this address
3188 would be rewritten for each possible place it might appear. See chapter
3189 &<<CHAPrewrite>>& for further details.
3190
3191 .vitem &%-bS%&
3192 .oindex "&%-bS%&"
3193 .cindex "SMTP" "batched incoming"
3194 .cindex "batched SMTP input"
3195 This option is used for batched SMTP input, which is an alternative interface
3196 for non-interactive local message submission. A number of messages can be
3197 submitted in a single run. However, despite its name, this is not really SMTP
3198 input. Exim reads each message's envelope from SMTP commands on the standard
3199 input, but generates no responses. If the caller is trusted, or
3200 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3201 believed; otherwise the sender is always the caller of Exim.
3202
3203 The message itself is read from the standard input, in SMTP format (leading
3204 dots doubled), terminated by a line containing just a single dot. An error is
3205 provoked if the terminating dot is missing. A further message may then follow.
3206
3207 As for other local message submissions, the contents of incoming batch SMTP
3208 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3209 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3210 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3211
3212 Some other SMTP commands are recognized in the input. HELO and EHLO act
3213 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3214 QUIT quits, ignoring the rest of the standard input.
3215
3216 .cindex "return code" "for &%-bS%&"
3217 If any error is encountered, reports are written to the standard output and
3218 error streams, and Exim gives up immediately. The return code is 0 if no error
3219 was detected; it is 1 if one or more messages were accepted before the error
3220 was detected; otherwise it is 2.
3221
3222 More details of input using batched SMTP are given in section
3223 &<<SECTincomingbatchedSMTP>>&.
3224
3225 .vitem &%-bs%&
3226 .oindex "&%-bs%&"
3227 .cindex "SMTP" "local input"
3228 .cindex "local SMTP input"
3229 This option causes Exim to accept one or more messages by reading SMTP commands
3230 on the standard input, and producing SMTP replies on the standard output. SMTP
3231 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3232 Some user agents use this interface as a way of passing locally-generated
3233 messages to the MTA.
3234
3235 In
3236 .cindex "sender" "source of"
3237 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3238 set, the senders of messages are taken from the SMTP MAIL commands.
3239 Otherwise the content of these commands is ignored and the sender is set up as
3240 the calling user. Unqualified addresses are automatically qualified using
3241 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3242 &%-bnq%& option is used.
3243
3244 .cindex "inetd"
3245 The
3246 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3247 using a listening daemon. Exim can distinguish the two cases by checking
3248 whether the standard input is a TCP/IP socket. When Exim is called from
3249 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3250 above concerning senders and qualification do not apply. In this situation,
3251 Exim behaves in exactly the same way as it does when receiving a message via
3252 the listening daemon.
3253
3254 .vitem &%-bmalware%&&~<&'filename'&>
3255 .oindex "&%-bmalware%&"
3256 .cindex "testing", "malware"
3257 .cindex "malware scan test"
3258 This debugging option causes Exim to scan the given file,
3259 using the malware scanning framework.  The option of &%av_scanner%& influences
3260 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3261 the expansion should have defaults which apply to this invocation.  ACLs are
3262 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3263 will never be populated and &%-bmalware%& will fail.
3264
3265 Exim will have changed working directory before resolving the filename, so
3266 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3267 user when it tries to open the file, rather than as the invoking user.
3268 This option requires admin privileges.
3269
3270 The &%-bmalware%& option will not be extended to be more generally useful,
3271 there are better tools for file-scanning.  This option exists to help
3272 administrators verify their Exim and AV scanner configuration.
3273
3274 .vitem &%-bt%&
3275 .oindex "&%-bt%&"
3276 .cindex "testing" "addresses"
3277 .cindex "address" "testing"
3278 This option runs Exim in address testing mode, in which each argument is taken
3279 as a recipient address to be tested for deliverability. The results are
3280 written to the standard output. If a test fails, and the caller is not an admin
3281 user, no details of the failure are output, because these might contain
3282 sensitive information such as usernames and passwords for database lookups.
3283
3284 If no arguments are given, Exim runs in an interactive manner, prompting with a
3285 right angle bracket for addresses to be tested.
3286
3287 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3288 &[readline()]& function, because it is running as &'root'& and there are
3289 security issues.
3290
3291 Each address is handled as if it were the recipient address of a message
3292 (compare the &%-bv%& option). It is passed to the routers and the result is
3293 written to the standard output. However, any router that has
3294 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3295 genuine routing tests if your first router passes everything to a scanner
3296 program.
3297
3298 .cindex "return code" "for &%-bt%&"
3299 The return code is 2 if any address failed outright; it is 1 if no address
3300 failed outright but at least one could not be resolved for some reason. Return
3301 code 0 is given only when all addresses succeed.
3302
3303 .cindex "duplicate addresses"
3304 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3305 addresses after routing is complete, so that only one delivery takes place.
3306 This does not happen when testing with &%-bt%&; the full results of routing are
3307 always shown.
3308
3309 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3310 routers in the configuration makes any tests on the sender address of a
3311 message,
3312 .oindex "&%-f%&" "for address testing"
3313 you can use the &%-f%& option to set an appropriate sender when running
3314 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3315 default qualifying domain. However, if you have set up (for example) routers
3316 whose behaviour depends on the contents of an incoming message, you cannot test
3317 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3318 doing such tests.
3319
3320 .vitem &%-bV%&
3321 .oindex "&%-bV%&"
3322 .cindex "version number of Exim"
3323 This option causes Exim to write the current version number, compilation
3324 number, and compilation date of the &'exim'& binary to the standard output.
3325 It also lists the DBM library that is being used, the optional modules (such as
3326 specific lookup types), the drivers that are included in the binary, and the
3327 name of the run time configuration file that is in use.
3328
3329 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3330 configuration file. However, this is a static check only. It cannot check
3331 values that are to be expanded. For example, although a misspelt ACL verb is
3332 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3333 alone to discover (for example) all the typos in the configuration; some
3334 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3335 dynamic testing facilities.
3336
3337 .vitem &%-bv%&
3338 .oindex "&%-bv%&"
3339 .cindex "verifying address" "using &%-bv%&"
3340 .cindex "address" "verification"
3341 This option runs Exim in address verification mode, in which each argument is
3342 taken as a recipient address to be verified by the routers. (This does
3343 not involve any verification callouts). During normal operation, verification
3344 happens mostly as a consequence processing a &%verify%& condition in an ACL
3345 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3346 including callouts, see the &%-bh%& and &%-bhc%& options.
3347
3348 If verification fails, and the caller is not an admin user, no details of the
3349 failure are output, because these might contain sensitive information such as
3350 usernames and passwords for database lookups.
3351
3352 If no arguments are given, Exim runs in an interactive manner, prompting with a
3353 right angle bracket for addresses to be verified.
3354
3355 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3356 &[readline()]& function, because it is running as &'exim'& and there are
3357 security issues.
3358
3359 Verification differs from address testing (the &%-bt%& option) in that routers
3360 that have &%no_verify%& set are skipped, and if the address is accepted by a
3361 router that has &%fail_verify%& set, verification fails. The address is
3362 verified as a recipient if &%-bv%& is used; to test verification for a sender
3363 address, &%-bvs%& should be used.
3364
3365 If the &%-v%& option is not set, the output consists of a single line for each
3366 address, stating whether it was verified or not, and giving a reason in the
3367 latter case. Without &%-v%&, generating more than one address by redirection
3368 causes verification to end successfully, without considering the generated
3369 addresses. However, if just one address is generated, processing continues,
3370 and the generated address must verify successfully for the overall verification
3371 to succeed.
3372
3373 When &%-v%& is set, more details are given of how the address has been handled,
3374 and in the case of address redirection, all the generated addresses are also
3375 considered. Verification may succeed for some and fail for others.
3376
3377 The
3378 .cindex "return code" "for &%-bv%&"
3379 return code is 2 if any address failed outright; it is 1 if no address
3380 failed outright but at least one could not be resolved for some reason. Return
3381 code 0 is given only when all addresses succeed.
3382
3383 If any of the routers in the configuration makes any tests on the sender
3384 address of a message, you should use the &%-f%& option to set an appropriate
3385 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3386 calling user at the default qualifying domain.
3387
3388 .vitem &%-bvs%&
3389 .oindex "&%-bvs%&"
3390 This option acts like &%-bv%&, but verifies the address as a sender rather
3391 than a recipient address. This affects any rewriting and qualification that
3392 might happen.
3393
3394 .vitem &%-bw%&
3395 .oindex "&%-bw%&"
3396 .cindex "daemon"
3397 .cindex "inetd"
3398 .cindex "inetd" "wait mode"
3399 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3400 similarly to the &%-bd%& option.  All port specifications on the command-line
3401 and in the configuration file are ignored.  Queue-running may not be specified.
3402
3403 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3404 listening for connections.  This permits the system to start up and have
3405 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3406 each port only when the first connection is received.
3407
3408 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3409 which the daemon will exit, which should cause inetd to listen once more.
3410
3411 .vitem &%-C%&&~<&'filelist'&>
3412 .oindex "&%-C%&"
3413 .cindex "configuration file" "alternate"
3414 .cindex "CONFIGURE_FILE"
3415 .cindex "alternate configuration file"
3416 This option causes Exim to find the run time configuration file from the given
3417 list instead of from the list specified by the CONFIGURE_FILE
3418 compile-time setting. Usually, the list will consist of just a single file
3419 name, but it can be a colon-separated list of names. In this case, the first
3420 file that exists is used. Failure to open an existing file stops Exim from
3421 proceeding any further along the list, and an error is generated.
3422
3423 When this option is used by a caller other than root, and the list is different
3424 from the compiled-in list, Exim gives up its root privilege immediately, and
3425 runs with the real and effective uid and gid set to those of the caller.
3426 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3427 file contains a list of full pathnames, one per line, for configuration files
3428 which are trusted. Root privilege is retained for any configuration file so
3429 listed, as long as the caller is the Exim user (or the user specified in the
3430 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3431 not writeable by inappropriate users or groups.
3432
3433 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3434 configuration using &%-C%& right through message reception and delivery,
3435 even if the caller is root. The reception works, but by that time, Exim is
3436 running as the Exim user, so when it re-executes to regain privilege for the
3437 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3438 test reception and delivery using two separate commands (one to put a message
3439 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3440
3441 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3442 prefix string with which any file named in a &%-C%& command line option
3443 must start. In addition, the file name must not contain the sequence &`/../`&.
3444 However, if the value of the &%-C%& option is identical to the value of
3445 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3446 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3447 unset, any file name can be used with &%-C%&.
3448
3449 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3450 to a directory to which only root has access. This prevents someone who has
3451 broken into the Exim account from running a privileged Exim with an arbitrary
3452 configuration file.
3453
3454 The &%-C%& facility is useful for ensuring that configuration files are
3455 syntactically correct, but cannot be used for test deliveries, unless the
3456 caller is privileged, or unless it is an exotic configuration that does not
3457 require privilege. No check is made on the owner or group of the files
3458 specified by this option.
3459
3460
3461 .vitem &%-D%&<&'macro'&>=<&'value'&>
3462 .oindex "&%-D%&"
3463 .cindex "macro" "setting on command line"
3464 This option can be used to override macro definitions in the configuration file
3465 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3466 unprivileged caller, it causes Exim to give up its root privilege.
3467 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3468 completely disabled, and its use causes an immediate error exit.
3469
3470 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3471 colon-separated list of macros which are considered safe and, if &%-D%& only
3472 supplies macros from this list, and the values are acceptable, then Exim will
3473 not give up root privilege if the caller is root, the Exim run-time user, or
3474 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3475 to be removed in the future.  Acceptable values for the macros satisfy the
3476 regexp: &`^[A-Za-z0-9_/.-]*$`&
3477
3478 The entire option (including equals sign if present) must all be within one
3479 command line item. &%-D%& can be used to set the value of a macro to the empty
3480 string, in which case the equals sign is optional. These two commands are
3481 synonymous:
3482 .code
3483 exim -DABC  ...
3484 exim -DABC= ...
3485 .endd
3486 To include spaces in a macro definition item, quotes must be used. If you use
3487 quotes, spaces are permitted around the macro name and the equals sign. For
3488 example:
3489 .code
3490 exim '-D ABC = something' ...
3491 .endd
3492 &%-D%& may be repeated up to 10 times on a command line.
3493
3494
3495 .vitem &%-d%&<&'debug&~options'&>
3496 .oindex "&%-d%&"
3497 .cindex "debugging" "list of selectors"
3498 .cindex "debugging" "&%-d%& option"
3499 This option causes debugging information to be written to the standard
3500 error stream. It is restricted to admin users because debugging output may show
3501 database queries that contain password information. Also, the details of users'
3502 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3503 writes an error message to the standard error stream and exits with a non-zero
3504 return code.
3505
3506 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3507 standard debugging data is output. This can be reduced, or increased to include
3508 some more rarely needed information, by directly following &%-d%& with a string
3509 made up of names preceded by plus or minus characters. These add or remove sets
3510 of debugging data, respectively. For example, &%-d+filter%& adds filter
3511 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3512 no spaces are allowed in the debug setting. The available debugging categories
3513 are:
3514 .display
3515 &`acl            `& ACL interpretation
3516 &`auth           `& authenticators
3517 &`deliver        `& general delivery logic
3518 &`dns            `& DNS lookups (see also resolver)
3519 &`dnsbl          `& DNS black list (aka RBL) code
3520 &`exec           `& arguments for &[execv()]& calls
3521 &`expand         `& detailed debugging for string expansions
3522 &`filter         `& filter handling
3523 &`hints_lookup   `& hints data lookups
3524 &`host_lookup    `& all types of name-to-IP address handling
3525 &`ident          `& ident lookup
3526 &`interface      `& lists of local interfaces
3527 &`lists          `& matching things in lists
3528 &`load           `& system load checks
3529 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3530                     &<<CHAPlocalscan>>&)
3531 &`lookup         `& general lookup code and all lookups
3532 &`memory         `& memory handling
3533 &`pid            `& add pid to debug output lines
3534 &`process_info   `& setting info for the process log
3535 &`queue_run      `& queue runs
3536 &`receive        `& general message reception logic
3537 &`resolver       `& turn on the DNS resolver's debugging output
3538 &`retry          `& retry handling
3539 &`rewrite        `& address rewriting
3540 &`route          `& address routing
3541 &`timestamp      `& add timestamp to debug output lines
3542 &`tls            `& TLS logic
3543 &`transport      `& transports
3544 &`uid            `& changes of uid/gid and looking up uid/gid
3545 &`verify         `& address verification logic
3546 &`all            `& almost all of the above (see below), and also &%-v%&
3547 .endd
3548 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3549 for &`-all`&. The reason for this is that &`+all`& is something that people
3550 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3551 is included, an awful lot of output that is very rarely of interest is
3552 generated, so it now has to be explicitly requested. However, &`-all`& does
3553 turn everything off.
3554
3555 .cindex "resolver, debugging output"
3556 .cindex "DNS resolver, debugging output"
3557 The &`resolver`& option produces output only if the DNS resolver was compiled
3558 with DEBUG enabled. This is not the case in some operating systems. Also,
3559 unfortunately, debugging output from the DNS resolver is written to stdout
3560 rather than stderr.
3561
3562 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3563 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3564 However, the &`pid`& selector is forced when debugging is turned on for a
3565 daemon, which then passes it on to any re-executed Exims. Exim also
3566 automatically adds the pid to debug lines when several remote deliveries are
3567 run in parallel.
3568
3569 The &`timestamp`& selector causes the current time to be inserted at the start
3570 of all debug output lines. This can be useful when trying to track down delays
3571 in processing.
3572
3573 If the &%debug_print%& option is set in any driver, it produces output whenever
3574 any debugging is selected, or if &%-v%& is used.
3575
3576 .vitem &%-dd%&<&'debug&~options'&>
3577 .oindex "&%-dd%&"
3578 This option behaves exactly like &%-d%& except when used on a command that
3579 starts a daemon process. In that case, debugging is turned off for the
3580 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3581 behaviour of the daemon without creating as much output as full debugging does.
3582
3583 .vitem &%-dropcr%&
3584 .oindex "&%-dropcr%&"
3585 This is an obsolete option that is now a no-op. It used to affect the way Exim
3586 handled CR and LF characters in incoming messages. What happens now is
3587 described in section &<<SECTlineendings>>&.
3588
3589 .vitem &%-E%&
3590 .oindex "&%-E%&"
3591 .cindex "bounce message" "generating"
3592 This option specifies that an incoming message is a locally-generated delivery
3593 failure report. It is used internally by Exim when handling delivery failures
3594 and is not intended for external use. Its only effect is to stop Exim
3595 generating certain messages to the postmaster, as otherwise message cascades
3596 could occur in some situations. As part of the same option, a message id may
3597 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3598 new message contains the id, following &"R="&, as a cross-reference.
3599
3600 .vitem &%-e%&&'x'&
3601 .oindex "&%-e%&&'x'&"
3602 There are a number of Sendmail options starting with &%-oe%& which seem to be
3603 called by various programs without the leading &%o%& in the option. For
3604 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3605 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3606
3607 .vitem &%-F%&&~<&'string'&>
3608 .oindex "&%-F%&"
3609 .cindex "sender" "name"
3610 .cindex "name" "of sender"
3611 This option sets the sender's full name for use when a locally-generated
3612 message is being accepted. In the absence of this option, the user's &'gecos'&
3613 entry from the password data is used. As users are generally permitted to alter
3614 their &'gecos'& entries, no security considerations are involved. White space
3615 between &%-F%& and the <&'string'&> is optional.
3616
3617 .vitem &%-f%&&~<&'address'&>
3618 .oindex "&%-f%&"
3619 .cindex "sender" "address"
3620 .cindex "address" "sender"
3621 .cindex "trusted users"
3622 .cindex "envelope sender"
3623 .cindex "user" "trusted"
3624 This option sets the address of the envelope sender of a locally-generated
3625 message (also known as the return path). The option can normally be used only
3626 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3627 users to use it.
3628
3629 Processes running as root or the Exim user are always trusted. Other
3630 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3631 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3632 of a local message is set to the caller's login name at the default qualify
3633 domain.
3634
3635 There is one exception to the restriction on the use of &%-f%&: an empty sender
3636 can be specified by any user, trusted or not, to create a message that can
3637 never provoke a bounce. An empty sender can be specified either as an empty
3638 string, or as a pair of angle brackets with nothing between them, as in these
3639 examples of shell commands:
3640 .code
3641 exim -f '<>' user@domain
3642 exim -f "" user@domain
3643 .endd
3644 In addition, the use of &%-f%& is not restricted when testing a filter file
3645 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3646 &%-bv%& options.
3647
3648 Allowing untrusted users to change the sender address does not of itself make
3649 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3650 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3651 though this can be overridden by setting &%no_local_from_check%&.
3652
3653 White
3654 .cindex "&""From""& line"
3655 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3656 given as two arguments or one combined argument). The sender of a
3657 locally-generated message can also be set (when permitted) by an initial
3658 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3659 if &%-f%& is also present, it overrides &"From&~"&.
3660
3661 .vitem &%-G%&
3662 .oindex "&%-G%&"
3663 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3664 This is a Sendmail option which is ignored by Exim.
3665
3666 .vitem &%-h%&&~<&'number'&>
3667 .oindex "&%-h%&"
3668 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3669 This option is accepted for compatibility with Sendmail, but has no effect. (In
3670 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3671 headers.)
3672
3673 .vitem &%-i%&
3674 .oindex "&%-i%&"
3675 .cindex "Solaris" "&'mail'& command"
3676 .cindex "dot" "in incoming non-SMTP message"
3677 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3678 line by itself should not terminate an incoming, non-SMTP message. I can find
3679 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3680 command in Solaris 2.4 uses it. See also &%-ti%&.
3681
3682 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3683 .oindex "&%-M%&"
3684 .cindex "forcing delivery"
3685 .cindex "delivery" "forcing attempt"
3686 .cindex "frozen messages" "forcing delivery"
3687 This option requests Exim to run a delivery attempt on each message in turn. If
3688 any of the messages are frozen, they are automatically thawed before the
3689 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3690 and &%hold_domains%& are ignored.
3691
3692 Retry
3693 .cindex "hints database" "overriding retry hints"
3694 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3695 the normal retry time has not yet been reached. This option requires the caller
3696 to be an admin user. However, there is an option called &%prod_requires_admin%&
3697 which can be set false to relax this restriction (and also the same requirement
3698 for the &%-q%&, &%-R%&, and &%-S%& options).
3699
3700 The deliveries happen synchronously, that is, the original Exim process does
3701 not terminate until all the delivery attempts have finished. No output is
3702 produced unless there is a serious error. If you want to see what is happening,
3703 use the &%-v%& option as well, or inspect Exim's main log.
3704
3705 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3706 .oindex "&%-Mar%&"
3707 .cindex "message" "adding recipients"
3708 .cindex "recipient" "adding"
3709 This option requests Exim to add the addresses to the list of recipients of the
3710 message (&"ar"& for &"add recipients"&). The first argument must be a message
3711 id, and the remaining ones must be email addresses. However, if the message is
3712 active (in the middle of a delivery attempt), it is not altered. This option
3713 can be used only by an admin user.
3714
3715 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3716         &~<&'message&~id'&>"
3717 .oindex "&%-MC%&"
3718 .cindex "SMTP" "passed connection"
3719 .cindex "SMTP" "multiple deliveries"
3720 .cindex "multiple SMTP deliveries"
3721 This option is not intended for use by external callers. It is used internally
3722 by Exim to invoke another instance of itself to deliver a waiting message using
3723 an existing SMTP connection, which is passed as the standard input. Details are
3724 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3725 must be root or the Exim user in order to use it.
3726
3727 .vitem &%-MCA%&
3728 .oindex "&%-MCA%&"
3729 This option is not intended for use by external callers. It is used internally
3730 by Exim in conjunction with the &%-MC%& option. It signifies that the
3731 connection to the remote host has been authenticated.
3732
3733 .vitem &%-MCP%&
3734 .oindex "&%-MCP%&"
3735 This option is not intended for use by external callers. It is used internally
3736 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3737 which Exim is connected supports pipelining.
3738
3739 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3740 .oindex "&%-MCQ%&"
3741 This option is not intended for use by external callers. It is used internally
3742 by Exim in conjunction with the &%-MC%& option when the original delivery was
3743 started by a queue runner. It passes on the process id of the queue runner,
3744 together with the file descriptor number of an open pipe. Closure of the pipe
3745 signals the final completion of the sequence of processes that are passing
3746 messages through the same SMTP connection.
3747
3748 .vitem &%-MCS%&
3749 .oindex "&%-MCS%&"
3750 This option is not intended for use by external callers. It is used internally
3751 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3752 SMTP SIZE option should be used on messages delivered down the existing
3753 connection.
3754
3755 .vitem &%-MCT%&
3756 .oindex "&%-MCT%&"
3757 This option is not intended for use by external callers. It is used internally
3758 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3759 host to which Exim is connected supports TLS encryption.
3760
3761 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3762 .oindex "&%-Mc%&"
3763 .cindex "hints database" "not overridden by &%-Mc%&"
3764 .cindex "delivery" "manually started &-- not forced"
3765 This option requests Exim to run a delivery attempt on each message in turn,
3766 but unlike the &%-M%& option, it does check for retry hints, and respects any
3767 that are found. This option is not very useful to external callers. It is
3768 provided mainly for internal use by Exim when it needs to re-invoke itself in
3769 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3770 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3771 respects retry times and other options such as &%hold_domains%& that are
3772 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3773 If you want to run a specific delivery as if in a queue run, you should use
3774 &%-q%& with a message id argument. A distinction between queue run deliveries
3775 and other deliveries is made in one or two places.
3776
3777 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3778 .oindex "&%-Mes%&"
3779 .cindex "message" "changing sender"
3780 .cindex "sender" "changing"
3781 This option requests Exim to change the sender address in the message to the
3782 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3783 &"edit sender"&). There must be exactly two arguments. The first argument must
3784 be a message id, and the second one an email address. However, if the message
3785 is active (in the middle of a delivery attempt), its status is not altered.
3786 This option can be used only by an admin user.
3787
3788 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3789 .oindex "&%-Mf%&"
3790 .cindex "freezing messages"
3791 .cindex "message" "manually freezing"
3792 This option requests Exim to mark each listed message as &"frozen"&. This
3793 prevents any delivery attempts taking place until the message is &"thawed"&,
3794 either manually or as a result of the &%auto_thaw%& configuration option.
3795 However, if any of the messages are active (in the middle of a delivery
3796 attempt), their status is not altered. This option can be used only by an admin
3797 user.
3798
3799 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3800 .oindex "&%-Mg%&"
3801 .cindex "giving up on messages"
3802 .cindex "message" "abandoning delivery attempts"
3803 .cindex "delivery" "abandoning further attempts"
3804 This option requests Exim to give up trying to deliver the listed messages,
3805 including any that are frozen. However, if any of the messages are active,
3806 their status is not altered. For non-bounce messages, a delivery error message
3807 is sent to the sender, containing the text &"cancelled by administrator"&.
3808 Bounce messages are just discarded. This option can be used only by an admin
3809 user.
3810
3811 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3812 .oindex "&%-Mmad%&"
3813 .cindex "delivery" "cancelling all"
3814 This option requests Exim to mark all the recipient addresses in the messages
3815 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3816 message is active (in the middle of a delivery attempt), its status is not
3817 altered. This option can be used only by an admin user.
3818
3819 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3820 .oindex "&%-Mmd%&"
3821 .cindex "delivery" "cancelling by address"
3822 .cindex "recipient" "removing"
3823 .cindex "removing recipients"
3824 This option requests Exim to mark the given addresses as already delivered
3825 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3826 the remaining ones must be email addresses. These are matched to recipient
3827 addresses in the message in a case-sensitive manner. If the message is active
3828 (in the middle of a delivery attempt), its status is not altered. This option
3829 can be used only by an admin user.
3830
3831 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3832 .oindex "&%-Mrm%&"
3833 .cindex "removing messages"
3834 .cindex "abandoning mail"
3835 .cindex "message" "manually discarding"
3836 This option requests Exim to remove the given messages from the queue. No
3837 bounce messages are sent; each message is simply forgotten. However, if any of
3838 the messages are active, their status is not altered. This option can be used
3839 only by an admin user or by the user who originally caused the message to be
3840 placed on the queue.
3841
3842 .vitem &%-Mset%&&~<&'message&~id'&>
3843 .oindex "&%-Mset%&
3844 .cindex "testing" "string expansion"
3845 .cindex "expansion" "testing"
3846 This option is useful only in conjunction with &%-be%& (that is, when testing
3847 string expansions). Exim loads the given message from its spool before doing
3848 the test expansions, thus setting message-specific variables such as
3849 &$message_size$& and the header variables. The &$recipients$& variable is made
3850 available. This feature is provided to make it easier to test expansions that
3851 make use of these variables. However, this option can be used only by an admin
3852 user. See also &%-bem%&.
3853
3854 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3855 .oindex "&%-Mt%&"
3856 .cindex "thawing messages"
3857 .cindex "unfreezing messages"
3858 .cindex "frozen messages" "thawing"
3859 .cindex "message" "thawing frozen"
3860 This option requests Exim to &"thaw"& any of the listed messages that are
3861 &"frozen"&, so that delivery attempts can resume. However, if any of the
3862 messages are active, their status is not altered. This option can be used only
3863 by an admin user.
3864
3865 .vitem &%-Mvb%&&~<&'message&~id'&>
3866 .oindex "&%-Mvb%&"
3867 .cindex "listing" "message body"
3868 .cindex "message" "listing body of"
3869 This option causes the contents of the message body (-D) spool file to be
3870 written to the standard output. This option can be used only by an admin user.
3871
3872 .vitem &%-Mvc%&&~<&'message&~id'&>
3873 .oindex "&%-Mvc%&"
3874 .cindex "message" "listing in RFC 2822 format"
3875 .cindex "listing" "message in RFC 2822 format"
3876 This option causes a copy of the complete message (header lines plus body) to
3877 be written to the standard output in RFC 2822 format. This option can be used
3878 only by an admin user.
3879
3880 .vitem &%-Mvh%&&~<&'message&~id'&>
3881 .oindex "&%-Mvh%&"
3882 .cindex "listing" "message headers"
3883 .cindex "header lines" "listing"
3884 .cindex "message" "listing header lines"
3885 This option causes the contents of the message headers (-H) spool file to be
3886 written to the standard output. This option can be used only by an admin user.
3887
3888 .vitem &%-Mvl%&&~<&'message&~id'&>
3889 .oindex "&%-Mvl%&"
3890 .cindex "listing" "message log"
3891 .cindex "message" "listing message log"
3892 This option causes the contents of the message log spool file to be written to
3893 the standard output. This option can be used only by an admin user.
3894
3895 .vitem &%-m%&
3896 .oindex "&%-m%&"
3897 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3898 treats it that way too.
3899
3900 .vitem &%-N%&
3901 .oindex "&%-N%&"
3902 .cindex "debugging" "&%-N%& option"
3903 .cindex "debugging" "suppressing delivery"
3904 This is a debugging option that inhibits delivery of a message at the transport
3905 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3906 it just doesn't actually transport the message, but instead behaves as if it
3907 had successfully done so. However, it does not make any updates to the retry
3908 database, and the log entries for deliveries are flagged with &"*>"& rather
3909 than &"=>"&.
3910
3911 Because &%-N%& discards any message to which it applies, only root or the Exim
3912 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3913 words, an ordinary user can use it only when supplying an incoming message to
3914 which it will apply. Although transportation never fails when &%-N%& is set, an
3915 address may be deferred because of a configuration problem on a transport, or a
3916 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3917 the message, and applies to any subsequent delivery attempts that may happen
3918 for that message.
3919
3920 .vitem &%-n%&
3921 .oindex "&%-n%&"
3922 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3923 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3924 by Exim.
3925
3926 .vitem &%-O%&&~<&'data'&>
3927 .oindex "&%-O%&"
3928 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3929 Exim.
3930
3931 .vitem &%-oA%&&~<&'file&~name'&>
3932 .oindex "&%-oA%&"
3933 .cindex "Sendmail compatibility" "&%-oA%& option"
3934 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3935 alternative alias file name. Exim handles &%-bi%& differently; see the
3936 description above.
3937
3938 .vitem &%-oB%&&~<&'n'&>
3939 .oindex "&%-oB%&"
3940 .cindex "SMTP" "passed connection"
3941 .cindex "SMTP" "multiple deliveries"
3942 .cindex "multiple SMTP deliveries"
3943 This is a debugging option which limits the maximum number of messages that can
3944 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3945 transport. If <&'n'&> is omitted, the limit is set to 1.
3946
3947 .vitem &%-odb%&
3948 .oindex "&%-odb%&"
3949 .cindex "background delivery"
3950 .cindex "delivery" "in the background"
3951 This option applies to all modes in which Exim accepts incoming messages,
3952 including the listening daemon. It requests &"background"& delivery of such
3953 messages, which means that the accepting process automatically starts a
3954 delivery process for each message received, but does not wait for the delivery
3955 processes to finish.
3956
3957 When all the messages have been received, the reception process exits,
3958 leaving the delivery processes to finish in their own time. The standard output
3959 and error streams are closed at the start of each delivery process.
3960 This is the default action if none of the &%-od%& options are present.
3961
3962 If one of the queueing options in the configuration file
3963 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3964 overrides it if &%queue_only_override%& is set true, which is the default
3965 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3966
3967 .vitem &%-odf%&
3968 .oindex "&%-odf%&"
3969 .cindex "foreground delivery"
3970 .cindex "delivery" "in the foreground"
3971 This option requests &"foreground"& (synchronous) delivery when Exim has
3972 accepted a locally-generated message. (For the daemon it is exactly the same as
3973 &%-odb%&.) A delivery process is automatically started to deliver the message,
3974 and Exim waits for it to complete before proceeding.
3975
3976 The original Exim reception process does not finish until the delivery
3977 process for the final message has ended. The standard error stream is left open
3978 during deliveries.
3979
3980 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3981 false and one of the queueing options in the configuration file is in effect.
3982
3983 If there is a temporary delivery error during foreground delivery, the
3984 message is left on the queue for later delivery, and the original reception
3985 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3986 restricted configuration that never queues messages.
3987
3988
3989 .vitem &%-odi%&
3990 .oindex "&%-odi%&"
3991 This option is synonymous with &%-odf%&. It is provided for compatibility with
3992 Sendmail.
3993
3994 .vitem &%-odq%&
3995 .oindex "&%-odq%&"
3996 .cindex "non-immediate delivery"
3997 .cindex "delivery" "suppressing immediate"
3998 .cindex "queueing incoming messages"
3999 This option applies to all modes in which Exim accepts incoming messages,
4000 including the listening daemon. It specifies that the accepting process should
4001 not automatically start a delivery process for each message received. Messages
4002 are placed on the queue, and remain there until a subsequent queue runner
4003 process encounters them. There are several configuration options (such as
4004 &%queue_only%&) that can be used to queue incoming messages under certain
4005 conditions. This option overrides all of them and also &%-odqs%&. It always
4006 forces queueing.
4007
4008 .vitem &%-odqs%&
4009 .oindex "&%-odqs%&"
4010 .cindex "SMTP" "delaying delivery"
4011 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4012 However, like &%-odb%& and &%-odi%&, this option has no effect if
4013 &%queue_only_override%& is false and one of the queueing options in the
4014 configuration file is in effect.
4015
4016 When &%-odqs%& does operate, a delivery process is started for each incoming
4017 message, in the background by default, but in the foreground if &%-odi%& is
4018 also present. The recipient addresses are routed, and local deliveries are done
4019 in the normal way. However, if any SMTP deliveries are required, they are not
4020 done at this time, so the message remains on the queue until a subsequent queue
4021 runner process encounters it. Because routing was done, Exim knows which
4022 messages are waiting for which hosts, and so a number of messages for the same
4023 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4024 configuration option has the same effect for specific domains. See also the
4025 &%-qq%& option.
4026
4027 .vitem &%-oee%&
4028 .oindex "&%-oee%&"
4029 .cindex "error" "reporting"
4030 If an error is detected while a non-SMTP message is being received (for
4031 example, a malformed address), the error is reported to the sender in a mail
4032 message.
4033
4034 .cindex "return code" "for &%-oee%&"
4035 Provided
4036 this error message is successfully sent, the Exim receiving process
4037 exits with a return code of zero. If not, the return code is 2 if the problem
4038 is that the original message has no recipients, or 1 any other error. This is
4039 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4040
4041 .vitem &%-oem%&
4042 .oindex "&%-oem%&"
4043 .cindex "error" "reporting"
4044 .cindex "return code" "for &%-oem%&"
4045 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4046 return code, whether or not the error message was successfully sent.
4047 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4048
4049 .vitem &%-oep%&
4050 .oindex "&%-oep%&"
4051 .cindex "error" "reporting"
4052 If an error is detected while a non-SMTP message is being received, the
4053 error is reported by writing a message to the standard error file (stderr).
4054 .cindex "return code" "for &%-oep%&"
4055 The return code is 1 for all errors.
4056
4057 .vitem &%-oeq%&
4058 .oindex "&%-oeq%&"
4059 .cindex "error" "reporting"
4060 This option is supported for compatibility with Sendmail, but has the same
4061 effect as &%-oep%&.
4062
4063 .vitem &%-oew%&
4064 .oindex "&%-oew%&"
4065 .cindex "error" "reporting"
4066 This option is supported for compatibility with Sendmail, but has the same
4067 effect as &%-oem%&.
4068
4069 .vitem &%-oi%&
4070 .oindex "&%-oi%&"
4071 .cindex "dot" "in incoming non-SMTP message"
4072 This option, which has the same effect as &%-i%&, specifies that a dot on a
4073 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4074 single dot does terminate, though Exim does no special processing for other
4075 lines that start with a dot. This option is set by default if Exim is called as
4076 &'rmail'&. See also &%-ti%&.
4077
4078 .vitem &%-oitrue%&
4079 .oindex "&%-oitrue%&"
4080 This option is treated as synonymous with &%-oi%&.
4081
4082 .vitem &%-oMa%&&~<&'host&~address'&>
4083 .oindex "&%-oMa%&"
4084 .cindex "sender" "host address, specifying for local message"
4085 A number of options starting with &%-oM%& can be used to set values associated
4086 with remote hosts on locally-submitted messages (that is, messages not received
4087 over TCP/IP). These options can be used by any caller in conjunction with the
4088 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4089 other circumstances, they are ignored unless the caller is trusted.
4090
4091 The &%-oMa%& option sets the sender host address. This may include a port
4092 number at the end, after a full stop (period). For example:
4093 .code
4094 exim -bs -oMa 10.9.8.7.1234
4095 .endd
4096 An alternative syntax is to enclose the IP address in square brackets,
4097 followed by a colon and the port number:
4098 .code
4099 exim -bs -oMa [10.9.8.7]:1234
4100 .endd
4101 The IP address is placed in the &$sender_host_address$& variable, and the
4102 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4103 are present on the command line, the sender host IP address is taken from
4104 whichever one is last.
4105
4106 .vitem &%-oMaa%&&~<&'name'&>
4107 .oindex "&%-oMaa%&"
4108 .cindex "authentication" "name, specifying for local message"
4109 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4110 option sets the value of &$sender_host_authenticated$& (the authenticator
4111 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4112 This option can be used with &%-bh%& and &%-bs%& to set up an
4113 authenticated SMTP session without actually using the SMTP AUTH command.
4114
4115 .vitem &%-oMai%&&~<&'string'&>
4116 .oindex "&%-oMai%&"
4117 .cindex "authentication" "id, specifying for local message"
4118 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4119 option sets the value of &$authenticated_id$& (the id that was authenticated).
4120 This overrides the default value (the caller's login id, except with &%-bh%&,
4121 where there is no default) for messages from local sources. See chapter
4122 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4123
4124 .vitem &%-oMas%&&~<&'address'&>
4125 .oindex "&%-oMas%&"
4126 .cindex "authentication" "sender, specifying for local message"
4127 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4128 option sets the authenticated sender value in &$authenticated_sender$&. It
4129 overrides the sender address that is created from the caller's login id for
4130 messages from local sources, except when &%-bh%& is used, when there is no
4131 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4132 specified on a MAIL command overrides this value. See chapter
4133 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4134
4135 .vitem &%-oMi%&&~<&'interface&~address'&>
4136 .oindex "&%-oMi%&"
4137 .cindex "interface" "address, specifying for local message"
4138 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4139 option sets the IP interface address value. A port number may be included,
4140 using the same syntax as for &%-oMa%&. The interface address is placed in
4141 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4142
4143 .vitem &%-oMr%&&~<&'protocol&~name'&>
4144 .oindex "&%-oMr%&"
4145 .cindex "protocol, specifying for local message"
4146 .vindex "&$received_protocol$&"
4147 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4148 option sets the received protocol value that is stored in
4149 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4150 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4151 SMTP protocol names (see the description of &$received_protocol$& in section
4152 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4153 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4154 be set by &%-oMr%&.
4155
4156 .vitem &%-oMs%&&~<&'host&~name'&>
4157 .oindex "&%-oMs%&"
4158 .cindex "sender" "host name, specifying for local message"
4159 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4160 option sets the sender host name in &$sender_host_name$&. When this option is
4161 present, Exim does not attempt to look up a host name from an IP address; it
4162 uses the name it is given.
4163
4164 .vitem &%-oMt%&&~<&'ident&~string'&>
4165 .oindex "&%-oMt%&"
4166 .cindex "sender" "ident string, specifying for local message"
4167 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4168 option sets the sender ident value in &$sender_ident$&. The default setting for
4169 local callers is the login id of the calling process, except when &%-bh%& is
4170 used, when there is no default.
4171
4172 .vitem &%-om%&
4173 .oindex "&%-om%&"
4174 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4175 In Sendmail, this option means &"me too"&, indicating that the sender of a
4176 message should receive a copy of the message if the sender appears in an alias
4177 expansion. Exim always does this, so the option does nothing.
4178
4179 .vitem &%-oo%&
4180 .oindex "&%-oo%&"
4181 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4182 This option is ignored. In Sendmail it specifies &"old style headers"&,
4183 whatever that means.
4184
4185 .vitem &%-oP%&&~<&'path'&>
4186 .oindex "&%-oP%&"
4187 .cindex "pid (process id)" "of daemon"
4188 .cindex "daemon" "process id (pid)"
4189 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4190 value. The option specifies the file to which the process id of the daemon is
4191 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4192 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4193 because in those cases, the normal pid file is not used.
4194
4195 .vitem &%-or%&&~<&'time'&>
4196 .oindex "&%-or%&"
4197 .cindex "timeout" "for non-SMTP input"
4198 This option sets a timeout value for incoming non-SMTP messages. If it is not
4199 set, Exim will wait forever for the standard input. The value can also be set
4200 by the &%receive_timeout%& option. The format used for specifying times is
4201 described in section &<<SECTtimeformat>>&.
4202
4203 .vitem &%-os%&&~<&'time'&>
4204 .oindex "&%-os%&"
4205 .cindex "timeout" "for SMTP input"
4206 .cindex "SMTP" "input timeout"
4207 This option sets a timeout value for incoming SMTP messages. The timeout
4208 applies to each SMTP command and block of data. The value can also be set by
4209 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4210 for specifying times is described in section &<<SECTtimeformat>>&.
4211
4212 .vitem &%-ov%&
4213 .oindex "&%-ov%&"
4214 This option has exactly the same effect as &%-v%&.
4215
4216 .vitem &%-oX%&&~<&'number&~or&~string'&>
4217 .oindex "&%-oX%&"
4218 .cindex "TCP/IP" "setting listening ports"
4219 .cindex "TCP/IP" "setting listening interfaces"
4220 .cindex "port" "receiving TCP/IP"
4221 This option is relevant only when the &%-bd%& (start listening daemon) option
4222 is also given. It controls which ports and interfaces the daemon uses. Details
4223 of the syntax, and how it interacts with configuration file options, are given
4224 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4225 file is written unless &%-oP%& is also present to specify a pid file name.
4226
4227 .vitem &%-pd%&
4228 .oindex "&%-pd%&"
4229 .cindex "Perl" "starting the interpreter"
4230 This option applies when an embedded Perl interpreter is linked with Exim (see
4231 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4232 option, forcing the starting of the interpreter to be delayed until it is
4233 needed.
4234
4235 .vitem &%-ps%&
4236 .oindex "&%-ps%&"
4237 .cindex "Perl" "starting the interpreter"
4238 This option applies when an embedded Perl interpreter is linked with Exim (see
4239 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4240 option, forcing the starting of the interpreter to occur as soon as Exim is
4241 started.
4242
4243 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4244 .oindex "&%-p%&"
4245 For compatibility with Sendmail, this option is equivalent to
4246 .display
4247 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4248 .endd
4249 It sets the incoming protocol and host name (for trusted callers). The
4250 host name and its colon can be omitted when only the protocol is to be set.
4251 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4252 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4253 or &`s`& using this option (but that does not seem a real limitation).
4254
4255 .vitem &%-q%&
4256 .oindex "&%-q%&"
4257 .cindex "queue runner" "starting manually"
4258 This option is normally restricted to admin users. However, there is a
4259 configuration option called &%prod_requires_admin%& which can be set false to
4260 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4261 and &%-S%& options).
4262
4263 .cindex "queue runner" "description of operation"
4264 The &%-q%& option starts one queue runner process. This scans the queue of
4265 waiting messages, and runs a delivery process for each one in turn. It waits
4266 for each delivery process to finish before starting the next one. A delivery
4267 process may not actually do any deliveries if the retry times for the addresses
4268 have not been reached. Use &%-qf%& (see below) if you want to override this.
4269
4270 If
4271 .cindex "SMTP" "passed connection"
4272 .cindex "SMTP" "multiple deliveries"
4273 .cindex "multiple SMTP deliveries"
4274 the delivery process spawns other processes to deliver other messages down
4275 passed SMTP connections, the queue runner waits for these to finish before
4276 proceeding.
4277
4278 When all the queued messages have been considered, the original queue runner
4279 process terminates. In other words, a single pass is made over the waiting
4280 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4281 this to be repeated periodically.
4282
4283 Exim processes the waiting messages in an unpredictable order. It isn't very
4284 random, but it is likely to be different each time, which is all that matters.
4285 If one particular message screws up a remote MTA, other messages to the same
4286 MTA have a chance of getting through if they get tried first.
4287
4288 It is possible to cause the messages to be processed in lexical message id
4289 order, which is essentially the order in which they arrived, by setting the
4290 &%queue_run_in_order%& option, but this is not recommended for normal use.
4291
4292 .vitem &%-q%&<&'qflags'&>
4293 The &%-q%& option may be followed by one or more flag letters that change its
4294 behaviour. They are all optional, but if more than one is present, they must
4295 appear in the correct order. Each flag is described in a separate item below.
4296
4297 .vitem &%-qq...%&
4298 .oindex "&%-qq%&"
4299 .cindex "queue" "double scanning"
4300 .cindex "queue" "routing"
4301 .cindex "routing" "whole queue before delivery"
4302 An option starting with &%-qq%& requests a two-stage queue run. In the first
4303 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4304 every domain. Addresses are routed, local deliveries happen, but no remote
4305 transports are run.
4306
4307 .cindex "hints database" "remembering routing"
4308 The hints database that remembers which messages are waiting for specific hosts
4309 is updated, as if delivery to those hosts had been deferred. After this is
4310 complete, a second, normal queue scan happens, with routing and delivery taking
4311 place as normal. Messages that are routed to the same host should mostly be
4312 delivered down a single SMTP
4313 .cindex "SMTP" "passed connection"
4314 .cindex "SMTP" "multiple deliveries"
4315 .cindex "multiple SMTP deliveries"
4316 connection because of the hints that were set up during the first queue scan.
4317 This option may be useful for hosts that are connected to the Internet
4318 intermittently.
4319
4320 .vitem &%-q[q]i...%&
4321 .oindex "&%-qi%&"
4322 .cindex "queue" "initial delivery"
4323 If the &'i'& flag is present, the queue runner runs delivery processes only for
4324 those messages that haven't previously been tried. (&'i'& stands for &"initial
4325 delivery"&.) This can be helpful if you are putting messages on the queue using
4326 &%-odq%& and want a queue runner just to process the new messages.
4327
4328 .vitem &%-q[q][i]f...%&
4329 .oindex "&%-qf%&"
4330 .cindex "queue" "forcing delivery"
4331 .cindex "delivery" "forcing in queue run"
4332 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4333 message, whereas without &'f'& only those non-frozen addresses that have passed
4334 their retry times are tried.
4335
4336 .vitem &%-q[q][i]ff...%&
4337 .oindex "&%-qff%&"
4338 .cindex "frozen messages" "forcing delivery"
4339 If &'ff'& is present, a delivery attempt is forced for every message, whether
4340 frozen or not.
4341
4342 .vitem &%-q[q][i][f[f]]l%&
4343 .oindex "&%-ql%&"
4344 .cindex "queue" "local deliveries only"
4345 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4346 be done. If a message requires any remote deliveries, it remains on the queue
4347 for later delivery.
4348
4349 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4350 .cindex "queue" "delivering specific messages"
4351 When scanning the queue, Exim can be made to skip over messages whose ids are
4352 lexically less than a given value by following the &%-q%& option with a
4353 starting message id. For example:
4354 .code
4355 exim -q 0t5C6f-0000c8-00
4356 .endd
4357 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4358 second message id is given, messages whose ids are lexically greater than it
4359 are also skipped. If the same id is given twice, for example,
4360 .code
4361 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4362 .endd
4363 just one delivery process is started, for that message. This differs from
4364 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4365 that it counts as a delivery from a queue run. Note that the selection
4366 mechanism does not affect the order in which the messages are scanned. There
4367 are also other ways of selecting specific sets of messages for delivery in a
4368 queue run &-- see &%-R%& and &%-S%&.
4369
4370 .vitem &%-q%&<&'qflags'&><&'time'&>
4371 .cindex "queue runner" "starting periodically"
4372 .cindex "periodic queue running"
4373 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4374 starting a queue runner process at intervals specified by the given time value
4375 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4376 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4377 single daemon process handles both functions. A common way of starting up a
4378 combined daemon at system boot time is to use a command such as
4379 .code
4380 /usr/exim/bin/exim -bd -q30m
4381 .endd
4382 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4383 process every 30 minutes.
4384
4385 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4386 pid file is written unless one is explicitly requested by the &%-oP%& option.
4387
4388 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4389 .oindex "&%-qR%&"
4390 This option is synonymous with &%-R%&. It is provided for Sendmail
4391 compatibility.
4392
4393 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4394 .oindex "&%-qS%&"
4395 This option is synonymous with &%-S%&.
4396
4397 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4398 .oindex "&%-R%&"
4399 .cindex "queue runner" "for specific recipients"
4400 .cindex "delivery" "to given domain"
4401 .cindex "domain" "delivery to"
4402 The <&'rsflags'&> may be empty, in which case the white space before the string
4403 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4404 which are the possible values for <&'rsflags'&>. White space is required if
4405 <&'rsflags'&> is not empty.
4406
4407 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4408 perform a single queue run, except that, when scanning the messages on the
4409 queue, Exim processes only those that have at least one undelivered recipient
4410 address containing the given string, which is checked in a case-independent
4411 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4412 regular expression; otherwise it is a literal string.
4413
4414 If you want to do periodic queue runs for messages with specific recipients,
4415 you can combine &%-R%& with &%-q%& and a time value. For example:
4416 .code
4417 exim -q25m -R @special.domain.example
4418 .endd
4419 This example does a queue run for messages with recipients in the given domain
4420 every 25 minutes. Any additional flags that are specified with &%-q%& are
4421 applied to each queue run.
4422
4423 Once a message is selected for delivery by this mechanism, all its addresses
4424 are processed. For the first selected message, Exim overrides any retry
4425 information and forces a delivery attempt for each undelivered address. This
4426 means that if delivery of any address in the first message is successful, any
4427 existing retry information is deleted, and so delivery attempts for that
4428 address in subsequently selected messages (which are processed without forcing)
4429 will run. However, if delivery of any address does not succeed, the retry
4430 information is updated, and in subsequently selected messages, the failing
4431 address will be skipped.
4432
4433 .cindex "frozen messages" "forcing delivery"
4434 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4435 all selected messages, not just the first; frozen messages are included when
4436 &'ff'& is present.
4437
4438 The &%-R%& option makes it straightforward to initiate delivery of all messages
4439 to a given domain after a host has been down for some time. When the SMTP
4440 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4441 effect is to run Exim with the &%-R%& option, but it can be configured to run
4442 an arbitrary command instead.
4443
4444 .vitem &%-r%&
4445 .oindex "&%-r%&"
4446 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4447
4448 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4449 .oindex "&%-S%&"
4450 .cindex "delivery" "from given sender"
4451 .cindex "queue runner" "for specific senders"
4452 This option acts like &%-R%& except that it checks the string against each
4453 message's sender instead of against the recipients. If &%-R%& is also set, both
4454 conditions must be met for a message to be selected. If either of the options
4455 has &'f'& or &'ff'& in its flags, the associated action is taken.
4456
4457 .vitem &%-Tqt%&&~<&'times'&>
4458 .oindex "&%-Tqt%&"
4459 This an option that is exclusively for use by the Exim testing suite. It is not
4460 recognized when Exim is run normally. It allows for the setting up of explicit
4461 &"queue times"& so that various warning/retry features can be tested.
4462
4463 .vitem &%-t%&
4464 .oindex "&%-t%&"
4465 .cindex "recipient" "extracting from header lines"
4466 .cindex "&'Bcc:'& header line"
4467 .cindex "&'Cc:'& header line"
4468 .cindex "&'To:'& header line"
4469 When Exim is receiving a locally-generated, non-SMTP message on its standard
4470 input, the &%-t%& option causes the recipients of the message to be obtained
4471 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4472 from the command arguments. The addresses are extracted before any rewriting
4473 takes place and the &'Bcc:'& header line, if present, is then removed.
4474
4475 .cindex "Sendmail compatibility" "&%-t%& option"
4476 If the command has any arguments, they specify addresses to which the message
4477 is &'not'& to be delivered. That is, the argument addresses are removed from
4478 the recipients list obtained from the headers. This is compatible with Smail 3
4479 and in accordance with the documented behaviour of several versions of
4480 Sendmail, as described in man pages on a number of operating systems (e.g.
4481 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4482 argument addresses to those obtained from the headers, and the O'Reilly
4483 Sendmail book documents it that way. Exim can be made to add argument addresses
4484 instead of subtracting them by setting the option
4485 &%extract_addresses_remove_arguments%& false.
4486
4487 .cindex "&%Resent-%& header lines" "with &%-t%&"
4488 If there are any &%Resent-%& header lines in the message, Exim extracts
4489 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4490 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4491 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4492 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4493
4494 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4495 message is resent several times). The RFC also specifies that they should be
4496 added at the front of the message, and separated by &'Received:'& lines. It is
4497 not at all clear how &%-t%& should operate in the present of multiple sets,
4498 nor indeed exactly what constitutes a &"set"&.
4499 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4500 are often added at the end of the header, and if a message is resent more than
4501 once, it is common for the original set of &%Resent-%& headers to be renamed as
4502 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4503
4504 .vitem &%-ti%&
4505 .oindex "&%-ti%&"
4506 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4507 compatibility with Sendmail.
4508
4509 .vitem &%-tls-on-connect%&
4510 .oindex "&%-tls-on-connect%&"
4511 .cindex "TLS" "use without STARTTLS"
4512 .cindex "TLS" "automatic start"
4513 This option is available when Exim is compiled with TLS support. It forces all
4514 incoming SMTP connections to behave as if the incoming port is listed in the
4515 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4516 &<<CHAPTLS>>& for further details.
4517
4518
4519 .vitem &%-U%&
4520 .oindex "&%-U%&"
4521 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4522 Sendmail uses this option for &"initial message submission"&, and its
4523 documentation states that in future releases, it may complain about
4524 syntactically invalid messages rather than fixing them when this flag is not
4525 set. Exim ignores this option.
4526
4527 .vitem &%-v%&
4528 .oindex "&%-v%&"
4529 This option causes Exim to write information to the standard error stream,
4530 describing what it is doing. In particular, it shows the log lines for
4531 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4532 dialogue is shown. Some of the log lines shown may not actually be written to
4533 the log if the setting of &%log_selector%& discards them. Any relevant
4534 selectors are shown with each log line. If none are shown, the logging is
4535 unconditional.
4536
4537 .vitem &%-x%&
4538 .oindex "&%-x%&"
4539 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4540 National Language Support extended characters in the body of the mail item"&).
4541 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4542 this option.
4543 .endlist
4544
4545 .ecindex IIDclo1
4546 .ecindex IIDclo2
4547
4548
4549 . ////////////////////////////////////////////////////////////////////////////
4550 . Insert a stylized DocBook comment here, to identify the end of the command
4551 . line options. This is for the benefit of the Perl script that automatically
4552 . creates a man page for the options.
4553 . ////////////////////////////////////////////////////////////////////////////
4554
4555 .literal xml
4556 <!-- === End of command line options === -->
4557 .literal off
4558
4559
4560
4561
4562
4563 . ////////////////////////////////////////////////////////////////////////////
4564 . ////////////////////////////////////////////////////////////////////////////
4565
4566
4567 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4568          "The runtime configuration file"
4569
4570 .cindex "run time configuration"
4571 .cindex "configuration file" "general description"
4572 .cindex "CONFIGURE_FILE"
4573 .cindex "configuration file" "errors in"
4574 .cindex "error" "in configuration file"
4575 .cindex "return code" "for bad configuration"
4576 Exim uses a single run time configuration file that is read whenever an Exim
4577 binary is executed. Note that in normal operation, this happens frequently,
4578 because Exim is designed to operate in a distributed manner, without central
4579 control.
4580
4581 If a syntax error is detected while reading the configuration file, Exim
4582 writes a message on the standard error, and exits with a non-zero return code.
4583 The message is also written to the panic log. &*Note*&: Only simple syntax
4584 errors can be detected at this time. The values of any expanded options are
4585 not checked until the expansion happens, even when the expansion does not
4586 actually alter the string.
4587
4588 The name of the configuration file is compiled into the binary for security
4589 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4590 most configurations, this specifies a single file. However, it is permitted to
4591 give a colon-separated list of file names, in which case Exim uses the first
4592 existing file in the list.
4593
4594 .cindex "EXIM_USER"
4595 .cindex "EXIM_GROUP"
4596 .cindex "CONFIGURE_OWNER"
4597 .cindex "CONFIGURE_GROUP"
4598 .cindex "configuration file" "ownership"
4599 .cindex "ownership" "configuration file"
4600 The run time configuration file must be owned by root or by the user that is
4601 specified at compile time by the CONFIGURE_OWNER option (if set). The
4602 configuration file must not be world-writeable, or group-writeable unless its
4603 group is the root group or the one specified at compile time by the
4604 CONFIGURE_GROUP option.
4605
4606 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4607 to root, anybody who is able to edit the run time configuration file has an
4608 easy way to run commands as root. If you specify a user or group in the
4609 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4610 who are members of that group will trivially be able to obtain root privileges.
4611
4612 Up to Exim version 4.72, the run time configuration file was also permitted to
4613 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4614 since it offered a simple privilege escalation for any attacker who managed to
4615 compromise the Exim user account.
4616
4617 A default configuration file, which will work correctly in simple situations,
4618 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4619 defines just one file name, the installation process copies the default
4620 configuration to a new file of that name if it did not previously exist. If
4621 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4622 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4623 configuration.
4624
4625
4626
4627 .section "Using a different configuration file" "SECID40"
4628 .cindex "configuration file" "alternate"
4629 A one-off alternate configuration can be specified by the &%-C%& command line
4630 option, which may specify a single file or a list of files. However, when
4631 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4632 unless the argument for &%-C%& is identical to the built-in value from
4633 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4634 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4635 is useful mainly for checking the syntax of configuration files before
4636 installing them. No owner or group checks are done on a configuration file
4637 specified by &%-C%&, if root privilege has been dropped.
4638
4639 Even the Exim user is not trusted to specify an arbitrary configuration file
4640 with the &%-C%& option to be used with root privileges, unless that file is
4641 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4642 testing a configuration using &%-C%& right through message reception and
4643 delivery, even if the caller is root. The reception works, but by that time,
4644 Exim is running as the Exim user, so when it re-execs to regain privilege for
4645 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4646 can test reception and delivery using two separate commands (one to put a
4647 message on the queue, using &%-odq%&, and another to do the delivery, using
4648 &%-M%&).
4649
4650 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4651 prefix string with which any file named in a &%-C%& command line option must
4652 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4653 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4654 name can be used with &%-C%&.
4655
4656 One-off changes to a configuration can be specified by the &%-D%& command line
4657 option, which defines and overrides values for macros used inside the
4658 configuration file. However, like &%-C%&, the use of this option by a
4659 non-privileged user causes Exim to discard its root privilege.
4660 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4661 completely disabled, and its use causes an immediate error exit.
4662
4663 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4664 to declare certain macro names trusted, such that root privilege will not
4665 necessarily be discarded.
4666 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4667 considered safe and, if &%-D%& only supplies macros from this list, and the
4668 values are acceptable, then Exim will not give up root privilege if the caller
4669 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4670 transition mechanism and is expected to be removed in the future.  Acceptable
4671 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4672
4673 Some sites may wish to use the same Exim binary on different machines that
4674 share a file system, but to use different configuration files on each machine.
4675 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4676 looks for a file whose name is the configuration file name followed by a dot
4677 and the machine's node name, as obtained from the &[uname()]& function. If this
4678 file does not exist, the standard name is tried. This processing occurs for
4679 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4680
4681 In some esoteric situations different versions of Exim may be run under
4682 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4683 help with this. See the comments in &_src/EDITME_& for details.
4684
4685
4686
4687 .section "Configuration file format" "SECTconffilfor"
4688 .cindex "configuration file" "format of"
4689 .cindex "format" "configuration file"
4690 Exim's configuration file is divided into a number of different parts. General
4691 option settings must always appear at the start of the file. The other parts
4692 are all optional, and may appear in any order. Each part other than the first
4693 is introduced by the word &"begin"& followed by the name of the part. The
4694 optional parts are:
4695
4696 .ilist
4697 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4698 &<<CHAPACL>>&).
4699 .next
4700 .cindex "AUTH" "configuration"
4701 &'authenticators'&: Configuration settings for the authenticator drivers. These
4702 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4703 .next
4704 &'routers'&: Configuration settings for the router drivers. Routers process
4705 addresses and determine how the message is to be delivered (see chapters
4706 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4707 .next
4708 &'transports'&: Configuration settings for the transport drivers. Transports
4709 define mechanisms for copying messages to destinations (see chapters
4710 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4711 .next
4712 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4713 If there is no retry section, or if it is empty (that is, no retry rules are
4714 defined), Exim will not retry deliveries. In this situation, temporary errors
4715 are treated the same as permanent errors. Retry rules are discussed in chapter
4716 &<<CHAPretry>>&.
4717 .next
4718 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4719 when new addresses are generated during delivery. Rewriting is discussed in
4720 chapter &<<CHAPrewrite>>&.
4721 .next
4722 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4723 want to use this feature, you must set
4724 .code
4725 LOCAL_SCAN_HAS_OPTIONS=yes
4726 .endd
4727 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4728 facility are given in chapter &<<CHAPlocalscan>>&.
4729 .endlist
4730
4731 .cindex "configuration file" "leading white space in"
4732 .cindex "configuration file" "trailing white space in"
4733 .cindex "white space" "in configuration file"
4734 Leading and trailing white space in configuration lines is always ignored.
4735
4736 Blank lines in the file, and lines starting with a # character (ignoring
4737 leading white space) are treated as comments and are ignored. &*Note*&: A
4738 # character other than at the beginning of a line is not treated specially,
4739 and does not introduce a comment.
4740
4741 Any non-comment line can be continued by ending it with a backslash. Note that
4742 the general rule for white space means that trailing white space after the
4743 backslash and leading white space at the start of continuation
4744 lines is ignored. Comment lines beginning with # (but not empty lines) may
4745 appear in the middle of a sequence of continuation lines.
4746
4747 A convenient way to create a configuration file is to start from the
4748 default, which is supplied in &_src/configure.default_&, and add, delete, or
4749 change settings as required.
4750
4751 The ACLs, retry rules, and rewriting rules have their own syntax which is
4752 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4753 respectively. The other parts of the configuration file have some syntactic
4754 items in common, and these are described below, from section &<<SECTcos>>&
4755 onwards. Before that, the inclusion, macro, and conditional facilities are
4756 described.
4757
4758
4759
4760 .section "File inclusions in the configuration file" "SECID41"
4761 .cindex "inclusions in configuration file"
4762 .cindex "configuration file" "including other files"
4763 .cindex "&`.include`& in configuration file"
4764 .cindex "&`.include_if_exists`& in configuration file"
4765 You can include other files inside Exim's run time configuration file by
4766 using this syntax:
4767 .display
4768 &`.include`& <&'file name'&>
4769 &`.include_if_exists`& <&'file name'&>
4770 .endd
4771 on a line by itself. Double quotes round the file name are optional. If you use
4772 the first form, a configuration error occurs if the file does not exist; the
4773 second form does nothing for non-existent files. In all cases, an absolute file
4774 name is required.
4775
4776 Includes may be nested to any depth, but remember that Exim reads its
4777 configuration file often, so it is a good idea to keep them to a minimum.
4778 If you change the contents of an included file, you must HUP the daemon,
4779 because an included file is read only when the configuration itself is read.
4780
4781 The processing of inclusions happens early, at a physical line level, so, like
4782 comment lines, an inclusion can be used in the middle of an option setting,
4783 for example:
4784 .code
4785 hosts_lookup = a.b.c \
4786                .include /some/file
4787 .endd
4788 Include processing happens after macro processing (see below). Its effect is to
4789 process the lines of the included file as if they occurred inline where the
4790 inclusion appears.
4791
4792
4793
4794 .section "Macros in the configuration file" "SECTmacrodefs"
4795 .cindex "macro" "description of"
4796 .cindex "configuration file" "macros"
4797 If a line in the main part of the configuration (that is, before the first
4798 &"begin"& line) begins with an upper case letter, it is taken as a macro
4799 definition, and must be of the form
4800 .display
4801 <&'name'&> = <&'rest of line'&>
4802 .endd
4803 The name must consist of letters, digits, and underscores, and need not all be
4804 in upper case, though that is recommended. The rest of the line, including any
4805 continuations, is the replacement text, and has leading and trailing white
4806 space removed. Quotes are not removed. The replacement text can never end with
4807 a backslash character, but this doesn't seem to be a serious limitation.
4808
4809 Macros may also be defined between router, transport, authenticator, or ACL
4810 definitions. They may not, however, be defined within an individual driver or
4811 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4812
4813 .section "Macro substitution" "SECID42"
4814 Once a macro is defined, all subsequent lines in the file (and any included
4815 files) are scanned for the macro name; if there are several macros, the line is
4816 scanned for each in turn, in the order in which the macros are defined. The
4817 replacement text is not re-scanned for the current macro, though it is scanned
4818 for subsequently defined macros. For this reason, a macro name may not contain
4819 the name of a previously defined macro as a substring. You could, for example,
4820 define
4821 .display
4822 &`ABCD_XYZ = `&<&'something'&>
4823 &`ABCD = `&<&'something else'&>
4824 .endd
4825 but putting the definitions in the opposite order would provoke a configuration
4826 error. Macro expansion is applied to individual physical lines from the file,
4827 before checking for line continuation or file inclusion (see above). If a line
4828 consists solely of a macro name, and the expansion of the macro is empty, the
4829 line is ignored. A macro at the start of a line may turn the line into a
4830 comment line or a &`.include`& line.
4831
4832
4833 .section "Redefining macros" "SECID43"
4834 Once defined, the value of a macro can be redefined later in the configuration
4835 (or in an included file). Redefinition is specified by using &'=='& instead of
4836 &'='&. For example:
4837 .code
4838 MAC =  initial value
4839 ...
4840 MAC == updated value
4841 .endd
4842 Redefinition does not alter the order in which the macros are applied to the
4843 subsequent lines of the configuration file. It is still the same order in which
4844 the macros were originally defined. All that changes is the macro's value.
4845 Redefinition makes it possible to accumulate values. For example:
4846 .code
4847 MAC =  initial value
4848 ...
4849 MAC == MAC and something added
4850 .endd
4851 This can be helpful in situations where the configuration file is built
4852 from a number of other files.
4853
4854 .section "Overriding macro values" "SECID44"
4855 The values set for macros in the configuration file can be overridden by the
4856 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4857 used, unless called by root or the Exim user. A definition on the command line
4858 using the &%-D%& option causes all definitions and redefinitions within the
4859 file to be ignored.
4860
4861
4862
4863 .section "Example of macro usage" "SECID45"
4864 As an example of macro usage, consider a configuration where aliases are looked
4865 up in a MySQL database. It helps to keep the file less cluttered if long
4866 strings such as SQL statements are defined separately as macros, for example:
4867 .code
4868 ALIAS_QUERY = select mailbox from user where \
4869               login='${quote_mysql:$local_part}';
4870 .endd
4871 This can then be used in a &(redirect)& router setting like this:
4872 .code
4873 data = ${lookup mysql{ALIAS_QUERY}}
4874 .endd
4875 In earlier versions of Exim macros were sometimes used for domain, host, or
4876 address lists. In Exim 4 these are handled better by named lists &-- see
4877 section &<<SECTnamedlists>>&.
4878
4879
4880 .section "Conditional skips in the configuration file" "SECID46"
4881 .cindex "configuration file" "conditional skips"
4882 .cindex "&`.ifdef`&"
4883 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4884 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4885 portions of the configuration file. The processing happens whenever the file is
4886 read (that is, when an Exim binary starts to run).
4887
4888 The implementation is very simple. Instances of the first four directives must
4889 be followed by text that includes the names of one or macros. The condition
4890 that is tested is whether or not any macro substitution has taken place in the
4891 line. Thus:
4892 .code
4893 .ifdef AAA
4894 message_size_limit = 50M
4895 .else
4896 message_size_limit = 100M
4897 .endif
4898 .endd
4899 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4900 otherwise. If there is more than one macro named on the line, the condition
4901 is true if any of them are defined. That is, it is an &"or"& condition. To
4902 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4903
4904 Although you can use a macro expansion to generate one of these directives,
4905 it is not very useful, because the condition &"there was a macro substitution
4906 in this line"& will always be true.
4907
4908 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4909 to clarify complicated nestings.
4910
4911
4912
4913 .section "Common option syntax" "SECTcos"
4914 .cindex "common option syntax"
4915 .cindex "syntax of common options"
4916 .cindex "configuration file" "common option syntax"
4917 For the main set of options, driver options, and &[local_scan()]& options,
4918 each setting is on a line by itself, and starts with a name consisting of
4919 lower-case letters and underscores. Many options require a data value, and in
4920 these cases the name must be followed by an equals sign (with optional white
4921 space) and then the value. For example:
4922 .code
4923 qualify_domain = mydomain.example.com
4924 .endd
4925 .cindex "hiding configuration option values"
4926 .cindex "configuration options" "hiding value of"
4927 .cindex "options" "hiding value of"
4928 Some option settings may contain sensitive data, for example, passwords for
4929 accessing databases. To stop non-admin users from using the &%-bP%& command
4930 line option to read these values, you can precede the option settings with the
4931 word &"hide"&. For example:
4932 .code
4933 hide mysql_servers = localhost/users/admin/secret-password
4934 .endd
4935 For non-admin users, such options are displayed like this:
4936 .code
4937 mysql_servers = <value not displayable>
4938 .endd
4939 If &"hide"& is used on a driver option, it hides the value of that option on
4940 all instances of the same driver.
4941
4942 The following sections describe the syntax used for the different data types
4943 that are found in option settings.
4944
4945
4946 .section "Boolean options" "SECID47"
4947 .cindex "format" "boolean"
4948 .cindex "boolean configuration values"
4949 .oindex "&%no_%&&'xxx'&"
4950 .oindex "&%not_%&&'xxx'&"
4951 Options whose type is given as boolean are on/off switches. There are two
4952 different ways of specifying such options: with and without a data value. If
4953 the option name is specified on its own without data, the switch is turned on;
4954 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4955 boolean options may be followed by an equals sign and one of the words
4956 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4957 the following two settings have exactly the same effect:
4958 .code
4959 queue_only
4960 queue_only = true
4961 .endd
4962 The following two lines also have the same (opposite) effect:
4963 .code
4964 no_queue_only
4965 queue_only = false
4966 .endd
4967 You can use whichever syntax you prefer.
4968
4969
4970
4971
4972 .section "Integer values" "SECID48"
4973 .cindex "integer configuration values"
4974 .cindex "format" "integer"
4975 If an option's type is given as &"integer"&, the value can be given in decimal,
4976 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4977 number is assumed. Otherwise, it is treated as an octal number unless it starts
4978 with the characters &"0x"&, in which case the remainder is interpreted as a
4979 hexadecimal number.
4980
4981 If an integer value is followed by the letter K, it is multiplied by 1024; if
4982 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4983 of integer option settings are output, values which are an exact multiple of
4984 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4985 and M. The printing style is independent of the actual input format that was
4986 used.
4987
4988
4989 .section "Octal integer values" "SECID49"
4990 .cindex "integer format"
4991 .cindex "format" "octal integer"
4992 If an option's type is given as &"octal integer"&, its value is always
4993 interpreted as an octal number, whether or not it starts with the digit zero.
4994 Such options are always output in octal.
4995
4996
4997 .section "Fixed point numbers" "SECID50"
4998 .cindex "fixed point configuration values"
4999 .cindex "format" "fixed point"
5000 If an option's type is given as &"fixed-point"&, its value must be a decimal
5001 integer, optionally followed by a decimal point and up to three further digits.
5002
5003
5004
5005 .section "Time intervals" "SECTtimeformat"
5006 .cindex "time interval" "specifying in configuration"
5007 .cindex "format" "time interval"
5008 A time interval is specified as a sequence of numbers, each followed by one of
5009 the following letters, with no intervening white space:
5010
5011 .table2 30pt
5012 .irow &%s%& seconds
5013 .irow &%m%& minutes
5014 .irow &%h%& hours
5015 .irow &%d%& days
5016 .irow &%w%& weeks
5017 .endtable
5018
5019 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5020 intervals are output in the same format. Exim does not restrict the values; it
5021 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5022
5023
5024
5025 .section "String values" "SECTstrings"
5026 .cindex "string" "format of configuration values"
5027 .cindex "format" "string"
5028 If an option's type is specified as &"string"&, the value can be specified with
5029 or without double-quotes. If it does not start with a double-quote, the value
5030 consists of the remainder of the line plus any continuation lines, starting at
5031 the first character after any leading white space, with trailing white space
5032 removed, and with no interpretation of the characters in the string. Because
5033 Exim removes comment lines (those beginning with #) at an early stage, they can
5034 appear in the middle of a multi-line string. The following two settings are
5035 therefore equivalent:
5036 .code
5037 trusted_users = uucp:mail
5038 trusted_users = uucp:\
5039                 # This comment line is ignored
5040                 mail
5041 .endd
5042 .cindex "string" "quoted"
5043 .cindex "escape characters in quoted strings"
5044 If a string does start with a double-quote, it must end with a closing
5045 double-quote, and any backslash characters other than those used for line
5046 continuation are interpreted as escape characters, as follows:
5047
5048 .table2 100pt
5049 .irow &`\\`&                     "single backslash"
5050 .irow &`\n`&                     "newline"
5051 .irow &`\r`&                     "carriage return"
5052 .irow &`\t`&                     "tab"
5053 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5054 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5055                                    character"
5056 .endtable
5057
5058 If a backslash is followed by some other character, including a double-quote
5059 character, that character replaces the pair.
5060
5061 Quoting is necessary only if you want to make use of the backslash escapes to
5062 insert special characters, or if you need to specify a value with leading or
5063 trailing spaces. These cases are rare, so quoting is almost never needed in
5064 current versions of Exim. In versions of Exim before 3.14, quoting was required
5065 in order to continue lines, so you may come across older configuration files
5066 and examples that apparently quote unnecessarily.
5067
5068
5069 .section "Expanded strings" "SECID51"
5070 .cindex "expansion" "definition of"
5071 Some strings in the configuration file are subjected to &'string expansion'&,
5072 by which means various parts of the string may be changed according to the
5073 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5074 is as just described; in particular, the handling of backslashes in quoted
5075 strings is done as part of the input process, before expansion takes place.
5076 However, backslash is also an escape character for the expander, so any
5077 backslashes that are required for that reason must be doubled if they are
5078 within a quoted configuration string.
5079
5080
5081 .section "User and group names" "SECID52"
5082 .cindex "user name" "format of"
5083 .cindex "format" "user name"
5084 .cindex "groups" "name format"
5085 .cindex "format" "group name"
5086 User and group names are specified as strings, using the syntax described
5087 above, but the strings are interpreted specially. A user or group name must
5088 either consist entirely of digits, or be a name that can be looked up using the
5089 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5090
5091
5092 .section "List construction" "SECTlistconstruct"
5093 .cindex "list" "syntax of in configuration"
5094 .cindex "format" "list item in configuration"
5095 .cindex "string" "list, definition of"
5096 The data for some configuration options is a list of items, with colon as the
5097 default separator. Many of these options are shown with type &"string list"& in
5098 the descriptions later in this document. Others are listed as &"domain list"&,
5099 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5100 are all the same; however, those other than &"string list"& are subject to
5101 particular kinds of interpretation, as described in chapter
5102 &<<CHAPdomhosaddlists>>&.
5103
5104 In all these cases, the entire list is treated as a single string as far as the
5105 input syntax is concerned. The &%trusted_users%& setting in section
5106 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5107 in a list, it must be entered as two colons. Leading and trailing white space
5108 on each item in a list is ignored. This makes it possible to include items that
5109 start with a colon, and in particular, certain forms of IPv6 address. For
5110 example, the list
5111 .code
5112 local_interfaces = 127.0.0.1 : ::::1
5113 .endd
5114 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5115
5116 &*Note*&: Although leading and trailing white space is ignored in individual
5117 list items, it is not ignored when parsing the list. The space after the first
5118 colon in the example above is necessary. If it were not there, the list would
5119 be interpreted as the two items 127.0.0.1:: and 1.
5120
5121 .section "Changing list separators" "SECID53"
5122 .cindex "list separator" "changing"
5123 .cindex "IPv6" "addresses in lists"
5124 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5125 introduced to allow the separator character to be changed. If a list begins
5126 with a left angle bracket, followed by any punctuation character, that
5127 character is used instead of colon as the list separator. For example, the list
5128 above can be rewritten to use a semicolon separator like this:
5129 .code
5130 local_interfaces = <; 127.0.0.1 ; ::1
5131 .endd
5132 This facility applies to all lists, with the exception of the list in
5133 &%log_file_path%&. It is recommended that the use of non-colon separators be
5134 confined to circumstances where they really are needed.
5135
5136 .cindex "list separator" "newline as"
5137 .cindex "newline" "as list separator"
5138 It is also possible to use newline and other control characters (those with
5139 code values less than 32, plus DEL) as separators in lists. Such separators
5140 must be provided literally at the time the list is processed. For options that
5141 are string-expanded, you can write the separator using a normal escape
5142 sequence. This will be processed by the expander before the string is
5143 interpreted as a list. For example, if a newline-separated list of domains is
5144 generated by a lookup, you can process it directly by a line such as this:
5145 .code
5146 domains = <\n ${lookup mysql{.....}}
5147 .endd
5148 This avoids having to change the list separator in such data. You are unlikely
5149 to want to use a control character as a separator in an option that is not
5150 expanded, because the value is literal text. However, it can be done by giving
5151 the value in quotes. For example:
5152 .code
5153 local_interfaces = "<\n 127.0.0.1 \n ::1"
5154 .endd
5155 Unlike printing character separators, which can be included in list items by
5156 doubling, it is not possible to include a control character as data when it is
5157 set as the separator. Two such characters in succession are interpreted as
5158 enclosing an empty list item.
5159
5160
5161
5162 .section "Empty items in lists" "SECTempitelis"
5163 .cindex "list" "empty item in"
5164 An empty item at the end of a list is always ignored. In other words, trailing
5165 separator characters are ignored. Thus, the list in
5166 .code
5167 senders = user@domain :
5168 .endd
5169 contains only a single item. If you want to include an empty string as one item
5170 in a list, it must not be the last item. For example, this list contains three
5171 items, the second of which is empty:
5172 .code
5173 senders = user1@domain : : user2@domain
5174 .endd
5175 &*Note*&: There must be white space between the two colons, as otherwise they
5176 are interpreted as representing a single colon data character (and the list
5177 would then contain just one item). If you want to specify a list that contains
5178 just one, empty item, you can do it as in this example:
5179 .code
5180 senders = :
5181 .endd
5182 In this case, the first item is empty, and the second is discarded because it
5183 is at the end of the list.
5184
5185
5186
5187
5188 .section "Format of driver configurations" "SECTfordricon"
5189 .cindex "drivers" "configuration format"
5190 There are separate parts in the configuration for defining routers, transports,
5191 and authenticators. In each part, you are defining a number of driver
5192 instances, each with its own set of options. Each driver instance is defined by
5193 a sequence of lines like this:
5194 .display
5195 <&'instance name'&>:
5196   <&'option'&>
5197   ...
5198   <&'option'&>
5199 .endd
5200 In the following example, the instance name is &(localuser)&, and it is
5201 followed by three options settings:
5202 .code
5203 localuser:
5204   driver = accept
5205   check_local_user
5206   transport = local_delivery
5207 .endd
5208 For each driver instance, you specify which Exim code module it uses &-- by the
5209 setting of the &%driver%& option &-- and (optionally) some configuration
5210 settings. For example, in the case of transports, if you want a transport to
5211 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5212 a local file you would use the &(appendfile)& driver. Each of the drivers is
5213 described in detail in its own separate chapter later in this manual.
5214
5215 You can have several routers, transports, or authenticators that are based on
5216 the same underlying driver (each must have a different instance name).
5217
5218 The order in which routers are defined is important, because addresses are
5219 passed to individual routers one by one, in order. The order in which
5220 transports are defined does not matter at all. The order in which
5221 authenticators are defined is used only when Exim, as a client, is searching
5222 them to find one that matches an authentication mechanism offered by the
5223 server.
5224
5225 .cindex "generic options"
5226 .cindex "options" "generic &-- definition of"
5227 Within a driver instance definition, there are two kinds of option: &'generic'&
5228 and &'private'&. The generic options are those that apply to all drivers of the
5229 same type (that is, all routers, all transports or all authenticators). The
5230 &%driver%& option is a generic option that must appear in every definition.
5231 .cindex "private options"
5232 The private options are special for each driver, and none need appear, because
5233 they all have default values.
5234
5235 The options may appear in any order, except that the &%driver%& option must
5236 precede any private options, since these depend on the particular driver. For
5237 this reason, it is recommended that &%driver%& always be the first option.
5238
5239 Driver instance names, which are used for reference in log entries and
5240 elsewhere, can be any sequence of letters, digits, and underscores (starting
5241 with a letter) and must be unique among drivers of the same type. A router and
5242 a transport (for example) can each have the same name, but no two router
5243 instances can have the same name. The name of a driver instance should not be
5244 confused with the name of the underlying driver module. For example, the
5245 configuration lines:
5246 .code
5247 remote_smtp:
5248   driver = smtp
5249 .endd
5250 create an instance of the &(smtp)& transport driver whose name is
5251 &(remote_smtp)&. The same driver code can be used more than once, with
5252 different instance names and different option settings each time. A second
5253 instance of the &(smtp)& transport, with different options, might be defined
5254 thus:
5255 .code
5256 special_smtp:
5257   driver = smtp
5258   port = 1234
5259   command_timeout = 10s
5260 .endd
5261 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5262 these transport instances from routers, and these names would appear in log
5263 lines.
5264
5265 Comment lines may be present in the middle of driver specifications. The full
5266 list of option settings for any particular driver instance, including all the
5267 defaulted values, can be extracted by making use of the &%-bP%& command line
5268 option.
5269
5270
5271
5272
5273
5274
5275 . ////////////////////////////////////////////////////////////////////////////
5276 . ////////////////////////////////////////////////////////////////////////////
5277
5278 .chapter "The default configuration file" "CHAPdefconfil"
5279 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5280 .cindex "default" "configuration file &""walk through""&"
5281 The default configuration file supplied with Exim as &_src/configure.default_&
5282 is sufficient for a host with simple mail requirements. As an introduction to
5283 the way Exim is configured, this chapter &"walks through"& the default
5284 configuration, giving brief explanations of the settings. Detailed descriptions
5285 of the options are given in subsequent chapters. The default configuration file
5286 itself contains extensive comments about ways you might want to modify the
5287 initial settings. However, note that there are many options that are not
5288 mentioned at all in the default configuration.
5289
5290
5291
5292 .section "Main configuration settings" "SECTdefconfmain"
5293 The main (global) configuration option settings must always come first in the
5294 file. The first thing you'll see in the file, after some initial comments, is
5295 the line
5296 .code
5297 # primary_hostname =
5298 .endd
5299 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5300 to know the official, fully qualified name of your host, and this is where you
5301 can specify it. However, in most cases you do not need to set this option. When
5302 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5303
5304 The first three non-comment configuration lines are as follows:
5305 .code
5306 domainlist local_domains = @
5307 domainlist relay_to_domains =
5308 hostlist   relay_from_hosts = 127.0.0.1
5309 .endd
5310 These are not, in fact, option settings. They are definitions of two named
5311 domain lists and one named host list. Exim allows you to give names to lists of
5312 domains, hosts, and email addresses, in order to make it easier to manage the
5313 configuration file (see section &<<SECTnamedlists>>&).
5314
5315 The first line defines a domain list called &'local_domains'&; this is used
5316 later in the configuration to identify domains that are to be delivered
5317 on the local host.
5318
5319 .cindex "@ in a domain list"
5320 There is just one item in this list, the string &"@"&. This is a special form
5321 of entry which means &"the name of the local host"&. Thus, if the local host is
5322 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5323 be delivered locally. Because the local host's name is referenced indirectly,
5324 the same configuration file can be used on different hosts.
5325
5326 The second line defines a domain list called &'relay_to_domains'&, but the
5327 list itself is empty. Later in the configuration we will come to the part that
5328 controls mail relaying through the local host; it allows relaying to any
5329 domains in this list. By default, therefore, no relaying on the basis of a mail
5330 domain is permitted.
5331
5332 The third line defines a host list called &'relay_from_hosts'&. This list is
5333 used later in the configuration to permit relaying from any host or IP address
5334 that matches the list. The default contains just the IP address of the IPv4
5335 loopback interface, which means that processes on the local host are able to
5336 submit mail for relaying by sending it over TCP/IP to that interface. No other
5337 hosts are permitted to submit messages for relaying.
5338
5339 Just to be sure there's no misunderstanding: at this point in the configuration
5340 we aren't actually setting up any controls. We are just defining some domains
5341 and hosts that will be used in the controls that are specified later.
5342
5343 The next two configuration lines are genuine option settings:
5344 .code
5345 acl_smtp_rcpt = acl_check_rcpt
5346 acl_smtp_data = acl_check_data
5347 .endd
5348 These options specify &'Access Control Lists'& (ACLs) that are to be used
5349 during an incoming SMTP session for every recipient of a message (every RCPT
5350 command), and after the contents of the message have been received,
5351 respectively. The names of the lists are &'acl_check_rcpt'& and
5352 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5353 section of the configuration. The RCPT ACL controls which recipients are
5354 accepted for an incoming message &-- if a configuration does not provide an ACL
5355 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5356 contents of a message to be checked.
5357
5358 Two commented-out option settings are next:
5359 .code
5360 # av_scanner = clamd:/tmp/clamd
5361 # spamd_address = 127.0.0.1 783
5362 .endd
5363 These are example settings that can be used when Exim is compiled with the
5364 content-scanning extension. The first specifies the interface to the virus
5365 scanner, and the second specifies the interface to SpamAssassin. Further
5366 details are given in chapter &<<CHAPexiscan>>&.
5367
5368 Three more commented-out option settings follow:
5369 .code
5370 # tls_advertise_hosts = *
5371 # tls_certificate = /etc/ssl/exim.crt
5372 # tls_privatekey = /etc/ssl/exim.pem
5373 .endd
5374 These are example settings that can be used when Exim is compiled with
5375 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5376 first one specifies the list of clients that are allowed to use TLS when
5377 connecting to this server; in this case the wildcard means all clients. The
5378 other options specify where Exim should find its TLS certificate and private
5379 key, which together prove the server's identity to any clients that connect.
5380 More details are given in chapter &<<CHAPTLS>>&.
5381
5382 Another two commented-out option settings follow:
5383 .code
5384 # daemon_smtp_ports = 25 : 465 : 587
5385 # tls_on_connect_ports = 465
5386 .endd
5387 .cindex "port" "465 and 587"
5388 .cindex "port" "for message submission"
5389 .cindex "message" "submission, ports for"
5390 .cindex "ssmtp protocol"
5391 .cindex "smtps protocol"
5392 .cindex "SMTP" "ssmtp protocol"
5393 .cindex "SMTP" "smtps protocol"
5394 These options provide better support for roaming users who wish to use this
5395 server for message submission. They are not much use unless you have turned on
5396 TLS (as described in the previous paragraph) and authentication (about which
5397 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5398 on end-user networks, so RFC 4409 specifies that message submission should use
5399 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5400 configured to use port 587 correctly, so these settings also enable the
5401 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5402 &<<SECTsupobssmt>>&).
5403
5404 Two more commented-out options settings follow:
5405 .code
5406 # qualify_domain =
5407 # qualify_recipient =
5408 .endd
5409 The first of these specifies a domain that Exim uses when it constructs a
5410 complete email address from a local login name. This is often needed when Exim
5411 receives a message from a local process. If you do not set &%qualify_domain%&,
5412 the value of &%primary_hostname%& is used. If you set both of these options,
5413 you can have different qualification domains for sender and recipient
5414 addresses. If you set only the first one, its value is used in both cases.
5415
5416 .cindex "domain literal" "recognizing format"
5417 The following line must be uncommented if you want Exim to recognize
5418 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5419 (an IP address within square brackets) instead of a named domain.
5420 .code
5421 # allow_domain_literals
5422 .endd
5423 The RFCs still require this form, but many people think that in the modern
5424 Internet it makes little sense to permit mail to be sent to specific hosts by
5425 quoting their IP addresses. This ancient format has been used by people who
5426 try to abuse hosts by using them for unwanted relaying. However, some
5427 people believe there are circumstances (for example, messages addressed to
5428 &'postmaster'&) where domain literals are still useful.
5429
5430 The next configuration line is a kind of trigger guard:
5431 .code
5432 never_users = root
5433 .endd
5434 It specifies that no delivery must ever be run as the root user. The normal
5435 convention is to set up &'root'& as an alias for the system administrator. This
5436 setting is a guard against slips in the configuration.
5437 The list of users specified by &%never_users%& is not, however, the complete
5438 list; the build-time configuration in &_Local/Makefile_& has an option called
5439 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5440 contents of &%never_users%& are added to this list. By default
5441 FIXED_NEVER_USERS also specifies root.
5442
5443 When a remote host connects to Exim in order to send mail, the only information
5444 Exim has about the host's identity is its IP address. The next configuration
5445 line,
5446 .code
5447 host_lookup = *
5448 .endd
5449 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5450 in order to get a host name. This improves the quality of the logging
5451 information, but if you feel it is too expensive, you can remove it entirely,
5452 or restrict the lookup to hosts on &"nearby"& networks.
5453 Note that it is not always possible to find a host name from an IP address,
5454 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5455 unreachable.
5456
5457 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5458 1413 (hence their names):
5459 .code
5460 rfc1413_hosts = *
5461 rfc1413_query_timeout = 5s
5462 .endd
5463 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5464 You can limit the hosts to which these calls are made, or change the timeout
5465 that is used. If you set the timeout to zero, all ident calls are disabled.
5466 Although they are cheap and can provide useful information for tracing problem
5467 messages, some hosts and firewalls have problems with ident calls. This can
5468 result in a timeout instead of an immediate refused connection, leading to
5469 delays on starting up an incoming SMTP session.
5470
5471 When Exim receives messages over SMTP connections, it expects all addresses to
5472 be fully qualified with a domain, as required by the SMTP definition. However,
5473 if you are running a server to which simple clients submit messages, you may
5474 find that they send unqualified addresses. The two commented-out options:
5475 .code
5476 # sender_unqualified_hosts =
5477 # recipient_unqualified_hosts =
5478 .endd
5479 show how you can specify hosts that are permitted to send unqualified sender
5480 and recipient addresses, respectively.
5481
5482 The &%percent_hack_domains%& option is also commented out:
5483 .code
5484 # percent_hack_domains =
5485 .endd
5486 It provides a list of domains for which the &"percent hack"& is to operate.
5487 This is an almost obsolete form of explicit email routing. If you do not know
5488 anything about it, you can safely ignore this topic.
5489
5490 The last two settings in the main part of the default configuration are
5491 concerned with messages that have been &"frozen"& on Exim's queue. When a
5492 message is frozen, Exim no longer continues to try to deliver it. Freezing
5493 occurs when a bounce message encounters a permanent failure because the sender
5494 address of the original message that caused the bounce is invalid, so the
5495 bounce cannot be delivered. This is probably the most common case, but there
5496 are also other conditions that cause freezing, and frozen messages are not
5497 always bounce messages.
5498 .code
5499 ignore_bounce_errors_after = 2d
5500 timeout_frozen_after = 7d
5501 .endd
5502 The first of these options specifies that failing bounce messages are to be
5503 discarded after 2 days on the queue. The second specifies that any frozen
5504 message (whether a bounce message or not) is to be timed out (and discarded)
5505 after a week. In this configuration, the first setting ensures that no failing
5506 bounce message ever lasts a week.
5507
5508
5509
5510 .section "ACL configuration" "SECID54"
5511 .cindex "default" "ACLs"
5512 .cindex "&ACL;" "default configuration"
5513 In the default configuration, the ACL section follows the main configuration.
5514 It starts with the line
5515 .code
5516 begin acl
5517 .endd
5518 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5519 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5520 and &%acl_smtp_data%& above.
5521
5522 .cindex "RCPT" "ACL for"
5523 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5524 RCPT command specifies one of the message's recipients. The ACL statements
5525 are considered in order, until the recipient address is either accepted or
5526 rejected. The RCPT command is then accepted or rejected, according to the
5527 result of the ACL processing.
5528 .code
5529 acl_check_rcpt:
5530 .endd
5531 This line, consisting of a name terminated by a colon, marks the start of the
5532 ACL, and names it.
5533 .code
5534 accept  hosts = :
5535 .endd
5536 This ACL statement accepts the recipient if the sending host matches the list.
5537 But what does that strange list mean? It doesn't actually contain any host
5538 names or IP addresses. The presence of the colon puts an empty item in the
5539 list; Exim matches this only if the incoming message did not come from a remote
5540 host, because in that case, the remote hostname is empty. The colon is
5541 important. Without it, the list itself is empty, and can never match anything.
5542
5543 What this statement is doing is to accept unconditionally all recipients in
5544 messages that are submitted by SMTP from local processes using the standard
5545 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5546 manner.
5547 .code
5548 deny    message       = Restricted characters in address
5549         domains       = +local_domains
5550         local_parts   = ^[.] : ^.*[@%!/|]
5551
5552 deny    message       = Restricted characters in address
5553         domains       = !+local_domains
5554         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5555 .endd
5556 These statements are concerned with local parts that contain any of the
5557 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5558 Although these characters are entirely legal in local parts (in the case of
5559 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5560 in Internet mail addresses.
5561
5562 The first three have in the past been associated with explicitly routed
5563 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5564 option). Addresses containing these characters are regularly tried by spammers
5565 in an attempt to bypass relaying restrictions, and also by open relay testing
5566 programs. Unless you really need them it is safest to reject these characters
5567 at this early stage. This configuration is heavy-handed in rejecting these
5568 characters for all messages it accepts from remote hosts. This is a deliberate
5569 policy of being as safe as possible.
5570
5571 The first rule above is stricter, and is applied to messages that are addressed
5572 to one of the local domains handled by this host. This is implemented by the
5573 first condition, which restricts it to domains that are listed in the
5574 &'local_domains'& domain list. The &"+"& character is used to indicate a
5575 reference to a named list. In this configuration, there is just one domain in
5576 &'local_domains'&, but in general there may be many.
5577
5578 The second condition on the first statement uses two regular expressions to
5579 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5580 or &"|"&. If you have local accounts that include these characters, you will
5581 have to modify this rule.
5582
5583 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5584 allows them because they have been encountered in practice. (Consider the
5585 common convention of local parts constructed as
5586 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5587 the author of Exim, who has no second initial.) However, a local part starting
5588 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5589 file name (for example, for a mailing list). This is also true for local parts
5590 that contain slashes. A pipe symbol can also be troublesome if the local part
5591 is incorporated unthinkingly into a shell command line.
5592
5593 The second rule above applies to all other domains, and is less strict. This
5594 allows your own users to send outgoing messages to sites that use slashes
5595 and vertical bars in their local parts. It blocks local parts that begin
5596 with a dot, slash, or vertical bar, but allows these characters within the
5597 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5598 and &"!"& is blocked, as before. The motivation here is to prevent your users
5599 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5600 .code
5601 accept  local_parts   = postmaster
5602         domains       = +local_domains
5603 .endd
5604 This statement, which has two conditions, accepts an incoming address if the
5605 local part is &'postmaster'& and the domain is one of those listed in the
5606 &'local_domains'& domain list. The &"+"& character is used to indicate a
5607 reference to a named list. In this configuration, there is just one domain in
5608 &'local_domains'&, but in general there may be many.
5609
5610 The presence of this statement means that mail to postmaster is never blocked
5611 by any of the subsequent tests. This can be helpful while sorting out problems
5612 in cases where the subsequent tests are incorrectly denying access.
5613 .code
5614 require verify        = sender
5615 .endd
5616 This statement requires the sender address to be verified before any subsequent
5617 ACL statement can be used. If verification fails, the incoming recipient
5618 address is refused. Verification consists of trying to route the address, to
5619 see if a bounce message could be delivered to it. In the case of remote
5620 addresses, basic verification checks only the domain, but &'callouts'& can be
5621 used for more verification if required. Section &<<SECTaddressverification>>&
5622 discusses the details of address verification.
5623 .code
5624 accept  hosts         = +relay_from_hosts
5625         control       = submission
5626 .endd
5627 This statement accepts the address if the message is coming from one of the
5628 hosts that are defined as being allowed to relay through this host. Recipient
5629 verification is omitted here, because in many cases the clients are dumb MUAs
5630 that do not cope well with SMTP error responses. For the same reason, the
5631 second line specifies &"submission mode"& for messages that are accepted. This
5632 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5633 messages that are deficient in some way, for example, because they lack a
5634 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5635 probably add recipient verification here, and disable submission mode.
5636 .code
5637 accept  authenticated = *
5638         control       = submission
5639 .endd
5640 This statement accepts the address if the client host has authenticated itself.
5641 Submission mode is again specified, on the grounds that such messages are most
5642 likely to come from MUAs. The default configuration does not define any
5643 authenticators, though it does include some nearly complete commented-out
5644 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5645 fact authenticate until you complete the authenticator definitions.
5646 .code
5647 require message = relay not permitted
5648         domains = +local_domains : +relay_domains
5649 .endd
5650 This statement rejects the address if its domain is neither a local domain nor
5651 one of the domains for which this host is a relay.
5652 .code
5653 require verify = recipient
5654 .endd
5655 This statement requires the recipient address to be verified; if verification
5656 fails, the address is rejected.
5657 .code
5658 # deny    message     = rejected because $sender_host_address \
5659 #                       is in a black list at $dnslist_domain\n\
5660 #                       $dnslist_text
5661 #         dnslists    = black.list.example
5662 #
5663 # warn    dnslists    = black.list.example
5664 #         add_header  = X-Warning: $sender_host_address is in \
5665 #                       a black list at $dnslist_domain
5666 #         log_message = found in $dnslist_domain
5667 .endd
5668 These commented-out lines are examples of how you could configure Exim to check
5669 sending hosts against a DNS black list. The first statement rejects messages
5670 from blacklisted hosts, whereas the second just inserts a warning header
5671 line.
5672 .code
5673 # require verify = csa
5674 .endd
5675 This commented-out line is an example of how you could turn on client SMTP
5676 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5677 records.
5678 .code
5679 accept
5680 .endd
5681 The final statement in the first ACL unconditionally accepts any recipient
5682 address that has successfully passed all the previous tests.
5683 .code
5684 acl_check_data:
5685 .endd
5686 This line marks the start of the second ACL, and names it. Most of the contents
5687 of this ACL are commented out:
5688 .code
5689 # deny    malware   = *
5690 #         message   = This message contains a virus \
5691 #                     ($malware_name).
5692 .endd
5693 These lines are examples of how to arrange for messages to be scanned for
5694 viruses when Exim has been compiled with the content-scanning extension, and a
5695 suitable virus scanner is installed. If the message is found to contain a
5696 virus, it is rejected with the given custom error message.
5697 .code
5698 # warn    spam      = nobody
5699 #         message   = X-Spam_score: $spam_score\n\
5700 #                     X-Spam_score_int: $spam_score_int\n\
5701 #                     X-Spam_bar: $spam_bar\n\
5702 #                     X-Spam_report: $spam_report
5703 .endd
5704 These lines are an example of how to arrange for messages to be scanned by
5705 SpamAssassin when Exim has been compiled with the content-scanning extension,
5706 and SpamAssassin has been installed. The SpamAssassin check is run with
5707 &`nobody`& as its user parameter, and the results are added to the message as a
5708 series of extra header line. In this case, the message is not rejected,
5709 whatever the spam score.
5710 .code
5711 accept
5712 .endd
5713 This final line in the DATA ACL accepts the message unconditionally.
5714
5715
5716 .section "Router configuration" "SECID55"
5717 .cindex "default" "routers"
5718 .cindex "routers" "default"
5719 The router configuration comes next in the default configuration, introduced
5720 by the line
5721 .code
5722 begin routers
5723 .endd
5724 Routers are the modules in Exim that make decisions about where to send
5725 messages. An address is passed to each router in turn, until it is either
5726 accepted, or failed. This means that the order in which you define the routers
5727 matters. Each router is fully described in its own chapter later in this
5728 manual. Here we give only brief overviews.
5729 .code
5730 # domain_literal:
5731 #   driver = ipliteral
5732 #   domains = !+local_domains
5733 #   transport = remote_smtp
5734 .endd
5735 .cindex "domain literal" "default router"
5736 This router is commented out because the majority of sites do not want to
5737 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5738 you uncomment this router, you also need to uncomment the setting of
5739 &%allow_domain_literals%& in the main part of the configuration.
5740 .code
5741 dnslookup:
5742   driver = dnslookup
5743   domains = ! +local_domains
5744   transport = remote_smtp
5745   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5746   no_more
5747 .endd
5748 The first uncommented router handles addresses that do not involve any local
5749 domains. This is specified by the line
5750 .code
5751 domains = ! +local_domains
5752 .endd
5753 The &%domains%& option lists the domains to which this router applies, but the
5754 exclamation mark is a negation sign, so the router is used only for domains
5755 that are not in the domain list called &'local_domains'& (which was defined at
5756 the start of the configuration). The plus sign before &'local_domains'&
5757 indicates that it is referring to a named list. Addresses in other domains are
5758 passed on to the following routers.
5759
5760 The name of the router driver is &(dnslookup)&,
5761 and is specified by the &%driver%& option. Do not be confused by the fact that
5762 the name of this router instance is the same as the name of the driver. The
5763 instance name is arbitrary, but the name set in the &%driver%& option must be
5764 one of the driver modules that is in the Exim binary.
5765
5766 The &(dnslookup)& router routes addresses by looking up their domains in the
5767 DNS in order to obtain a list of hosts to which the address is routed. If the
5768 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5769 specified by the &%transport%& option. If the router does not find the domain
5770 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5771 the address fails and is bounced.
5772
5773 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5774 be entirely ignored. This option is present because a number of cases have been
5775 encountered where MX records in the DNS point to host names
5776 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5777 Completely ignoring these IP addresses causes Exim to fail to route the
5778 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5779 continue to try to deliver the message periodically until the address timed
5780 out.
5781 .code
5782 system_aliases:
5783   driver = redirect
5784   allow_fail
5785   allow_defer
5786   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5787 # user = exim
5788   file_transport = address_file
5789   pipe_transport = address_pipe
5790 .endd
5791 Control reaches this and subsequent routers only for addresses in the local
5792 domains. This router checks to see whether the local part is defined as an
5793 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5794 data that it looks up from that file. If no data is found for the local part,
5795 the value of the &%data%& option is empty, causing the address to be passed to
5796 the next router.
5797
5798 &_/etc/aliases_& is a conventional name for the system aliases file that is
5799 often used. That is why it is referenced by from the default configuration
5800 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5801 &_Local/Makefile_& before building Exim.
5802 .code
5803 userforward:
5804   driver = redirect
5805   check_local_user
5806 # local_part_suffix = +* : -*
5807 # local_part_suffix_optional
5808   file = $home/.forward
5809 # allow_filter
5810   no_verify
5811   no_expn
5812   check_ancestor
5813   file_transport = address_file
5814   pipe_transport = address_pipe
5815   reply_transport = address_reply
5816 .endd
5817 This is the most complicated router in the default configuration. It is another
5818 redirection router, but this time it is looking for forwarding data set up by
5819 individual users. The &%check_local_user%& setting specifies a check that the
5820 local part of the address is the login name of a local user. If it is not, the
5821 router is skipped. The two commented options that follow &%check_local_user%&,
5822 namely:
5823 .code
5824 # local_part_suffix = +* : -*
5825 # local_part_suffix_optional
5826 .endd
5827 .vindex "&$local_part_suffix$&"
5828 show how you can specify the recognition of local part suffixes. If the first
5829 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5830 by any sequence of characters, is removed from the local part and placed in the
5831 variable &$local_part_suffix$&. The second suffix option specifies that the
5832 presence of a suffix in the local part is optional. When a suffix is present,
5833 the check for a local login uses the local part with the suffix removed.
5834
5835 When a local user account is found, the file called &_.forward_& in the user's
5836 home directory is consulted. If it does not exist, or is empty, the router
5837 declines. Otherwise, the contents of &_.forward_& are interpreted as
5838 redirection data (see chapter &<<CHAPredirect>>& for more details).
5839
5840 .cindex "Sieve filter" "enabling in default router"
5841 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5842 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5843 is commented out by default), the contents of the file are interpreted as a set
5844 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5845 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5846 separate document entitled &'Exim's interfaces to mail filtering'&.
5847
5848 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5849 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5850 There are two reasons for doing this:
5851
5852 .olist
5853 Whether or not a local user has a &_.forward_& file is not really relevant when
5854 checking an address for validity; it makes sense not to waste resources doing
5855 unnecessary work.
5856 .next
5857 More importantly, when Exim is verifying addresses or handling an EXPN
5858 command during an SMTP session, it is running as the Exim user, not as root.
5859 The group is the Exim group, and no additional groups are set up.
5860 It may therefore not be possible for Exim to read users' &_.forward_& files at
5861 this time.
5862 .endlist
5863
5864 The setting of &%check_ancestor%& prevents the router from generating a new
5865 address that is the same as any previous address that was redirected. (This
5866 works round a problem concerning a bad interaction between aliasing and
5867 forwarding &-- see section &<<SECTredlocmai>>&).
5868
5869 The final three option settings specify the transports that are to be used when
5870 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5871 auto-reply, respectively. For example, if a &_.forward_& file contains
5872 .code
5873 a.nother@elsewhere.example, /home/spqr/archive
5874 .endd
5875 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5876 transport.
5877 .code
5878 localuser:
5879   driver = accept
5880   check_local_user
5881 # local_part_suffix = +* : -*
5882 # local_part_suffix_optional
5883   transport = local_delivery
5884 .endd
5885 The final router sets up delivery into local mailboxes, provided that the local
5886 part is the name of a local login, by accepting the address and assigning it to
5887 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5888 routers, so the address is bounced. The commented suffix settings fulfil the
5889 same purpose as they do for the &(userforward)& router.
5890
5891
5892 .section "Transport configuration" "SECID56"
5893 .cindex "default" "transports"
5894 .cindex "transports" "default"
5895 Transports define mechanisms for actually delivering messages. They operate
5896 only when referenced from routers, so the order in which they are defined does
5897 not matter. The transports section of the configuration starts with
5898 .code
5899 begin transports
5900 .endd
5901 One remote transport and four local transports are defined.
5902 .code
5903 remote_smtp:
5904   driver = smtp
5905 .endd
5906 This transport is used for delivering messages over SMTP connections. All its
5907 options are defaulted. The list of remote hosts comes from the router.
5908 .code
5909 local_delivery:
5910   driver = appendfile
5911   file = /var/mail/$local_part
5912   delivery_date_add
5913   envelope_to_add
5914   return_path_add
5915 # group = mail
5916 # mode = 0660
5917 .endd
5918 This &(appendfile)& transport is used for local delivery to user mailboxes in
5919 traditional BSD mailbox format. By default it runs under the uid and gid of the
5920 local user, which requires the sticky bit to be set on the &_/var/mail_&
5921 directory. Some systems use the alternative approach of running mail deliveries
5922 under a particular group instead of using the sticky bit. The commented options
5923 show how this can be done.
5924
5925 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5926 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5927 similarly-named options above.
5928 .code
5929 address_pipe:
5930   driver = pipe
5931   return_output
5932 .endd
5933 This transport is used for handling deliveries to pipes that are generated by
5934 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5935 option specifies that any output generated by the pipe is to be returned to the
5936 sender.
5937 .code
5938 address_file:
5939   driver = appendfile
5940   delivery_date_add
5941   envelope_to_add
5942   return_path_add
5943 .endd
5944 This transport is used for handling deliveries to files that are generated by
5945 redirection. The name of the file is not specified in this instance of
5946 &(appendfile)&, because it comes from the &(redirect)& router.
5947 .code
5948 address_reply:
5949   driver = autoreply
5950 .endd
5951 This transport is used for handling automatic replies generated by users'
5952 filter files.
5953
5954
5955
5956 .section "Default retry rule" "SECID57"
5957 .cindex "retry" "default rule"
5958 .cindex "default" "retry rule"
5959 The retry section of the configuration file contains rules which affect the way
5960 Exim retries deliveries that cannot be completed at the first attempt. It is
5961 introduced by the line
5962 .code
5963 begin retry
5964 .endd
5965 In the default configuration, there is just one rule, which applies to all
5966 errors:
5967 .code
5968 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5969 .endd
5970 This causes any temporarily failing address to be retried every 15 minutes for
5971 2 hours, then at intervals starting at one hour and increasing by a factor of
5972 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5973 is not delivered after 4 days of temporary failure, it is bounced.
5974
5975 If the retry section is removed from the configuration, or is empty (that is,
5976 if no retry rules are defined), Exim will not retry deliveries. This turns
5977 temporary errors into permanent errors.
5978
5979
5980 .section "Rewriting configuration" "SECID58"
5981 The rewriting section of the configuration, introduced by
5982 .code
5983 begin rewrite
5984 .endd
5985 contains rules for rewriting addresses in messages as they arrive. There are no
5986 rewriting rules in the default configuration file.
5987
5988
5989
5990 .section "Authenticators configuration" "SECTdefconfauth"
5991 .cindex "AUTH" "configuration"
5992 The authenticators section of the configuration, introduced by
5993 .code
5994 begin authenticators
5995 .endd
5996 defines mechanisms for the use of the SMTP AUTH command. The default
5997 configuration file contains two commented-out example authenticators
5998 which support plaintext username/password authentication using the
5999 standard PLAIN mechanism and the traditional but non-standard LOGIN
6000 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6001 to support most MUA software.
6002
6003 The example PLAIN authenticator looks like this:
6004 .code
6005 #PLAIN:
6006 #  driver                  = plaintext
6007 #  server_set_id           = $auth2
6008 #  server_prompts          = :
6009 #  server_condition        = Authentication is not yet configured
6010 #  server_advertise_condition = ${if def:tls_cipher }
6011 .endd
6012 And the example LOGIN authenticator looks like this:
6013 .code
6014 #LOGIN:
6015 #  driver                  = plaintext
6016 #  server_set_id           = $auth1
6017 #  server_prompts          = <| Username: | Password:
6018 #  server_condition        = Authentication is not yet configured
6019 #  server_advertise_condition = ${if def:tls_cipher }
6020 .endd
6021
6022 The &%server_set_id%& option makes Exim remember the authenticated username
6023 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6024 &%server_prompts%& option configures the &(plaintext)& authenticator so
6025 that it implements the details of the specific authentication mechanism,
6026 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6027 when Exim offers authentication to clients; in the examples, this is only
6028 when TLS or SSL has been started, so to enable the authenticators you also
6029 need to add support for TLS as described in &<<SECTdefconfmain>>&.
6030
6031 The &%server_condition%& setting defines how to verify that the username and
6032 password are correct. In the examples it just produces an error message.
6033 To make the authenticators work, you can use a string expansion
6034 expression like one of the examples in &<<CHAPplaintext>>&.
6035
6036 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6037 usercode and password are in different positions.  &<<CHAPplaintext>>&
6038 covers both.
6039
6040 .ecindex IIDconfiwal
6041
6042
6043
6044 . ////////////////////////////////////////////////////////////////////////////
6045 . ////////////////////////////////////////////////////////////////////////////
6046
6047 .chapter "Regular expressions" "CHAPregexp"
6048
6049 .cindex "regular expressions" "library"
6050 .cindex "PCRE"
6051 Exim supports the use of regular expressions in many of its options. It
6052 uses the PCRE regular expression library; this provides regular expression
6053 matching that is compatible with Perl 5. The syntax and semantics of
6054 regular expressions is discussed in many Perl reference books, and also in
6055 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6056 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6057
6058 The documentation for the syntax and semantics of the regular expressions that
6059 are supported by PCRE is included in the PCRE distribution, and no further
6060 description is included here. The PCRE functions are called from Exim using
6061 the default option settings (that is, with no PCRE options set), except that
6062 the PCRE_CASELESS option is set when the matching is required to be
6063 case-insensitive.
6064
6065 In most cases, when a regular expression is required in an Exim configuration,
6066 it has to start with a circumflex, in order to distinguish it from plain text
6067 or an &"ends with"& wildcard. In this example of a configuration setting, the
6068 second item in the colon-separated list is a regular expression.
6069 .code
6070 domains = a.b.c : ^\\d{3} : *.y.z : ...
6071 .endd
6072 The doubling of the backslash is required because of string expansion that
6073 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6074 of this issue, and a way of avoiding the need for doubling backslashes. The
6075 regular expression that is eventually used in this example contains just one
6076 backslash. The circumflex is included in the regular expression, and has the
6077 normal effect of &"anchoring"& it to the start of the string that is being
6078 matched.
6079
6080 There are, however, two cases where a circumflex is not required for the
6081 recognition of a regular expression: these are the &%match%& condition in a
6082 string expansion, and the &%matches%& condition in an Exim filter file. In
6083 these cases, the relevant string is always treated as a regular expression; if
6084 it does not start with a circumflex, the expression is not anchored, and can
6085 match anywhere in the subject string.
6086
6087 In all cases, if you want a regular expression to match at the end of a string,
6088 you must code the $ metacharacter to indicate this. For example:
6089 .code
6090 domains = ^\\d{3}\\.example
6091 .endd
6092 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6093 You need to use:
6094 .code
6095 domains = ^\\d{3}\\.example\$
6096 .endd
6097 if you want &'example'& to be the top-level domain. The backslash before the
6098 $ is needed because string expansion also interprets dollar characters.
6099
6100
6101
6102 . ////////////////////////////////////////////////////////////////////////////
6103 . ////////////////////////////////////////////////////////////////////////////
6104
6105 .chapter "File and database lookups" "CHAPfdlookup"
6106 .scindex IIDfidalo1 "file" "lookups"
6107 .scindex IIDfidalo2 "database" "lookups"
6108 .cindex "lookup" "description of"
6109 Exim can be configured to look up data in files or databases as it processes
6110 messages. Two different kinds of syntax are used:
6111
6112 .olist
6113 A string that is to be expanded may contain explicit lookup requests. These
6114 cause parts of the string to be replaced by data that is obtained from the
6115 lookup. Lookups of this type are conditional expansion items. Different results
6116 can be defined for the cases of lookup success and failure. See chapter
6117 &<<CHAPexpand>>&, where string expansions are described in detail.
6118 .next
6119 Lists of domains, hosts, and email addresses can contain lookup requests as a
6120 way of avoiding excessively long linear lists. In this case, the data that is
6121 returned by the lookup is often (but not always) discarded; whether the lookup
6122 succeeds or fails is what really counts. These kinds of list are described in
6123 chapter &<<CHAPdomhosaddlists>>&.
6124 .endlist
6125
6126 String expansions, lists, and lookups interact with each other in such a way
6127 that there is no order in which to describe any one of them that does not
6128 involve references to the others. Each of these three chapters makes more sense
6129 if you have read the other two first. If you are reading this for the first
6130 time, be aware that some of it will make a lot more sense after you have read
6131 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6132
6133 .section "Examples of different lookup syntax" "SECID60"
6134 It is easy to confuse the two different kinds of lookup, especially as the
6135 lists that may contain the second kind are always expanded before being
6136 processed as lists. Therefore, they may also contain lookups of the first kind.
6137 Be careful to distinguish between the following two examples:
6138 .code
6139 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6140 domains = lsearch;/some/file
6141 .endd
6142 The first uses a string expansion, the result of which must be a domain list.
6143 No strings have been specified for a successful or a failing lookup; the
6144 defaults in this case are the looked-up data and an empty string, respectively.
6145 The expansion takes place before the string is processed as a list, and the
6146 file that is searched could contain lines like this:
6147 .code
6148 192.168.3.4: domain1:domain2:...
6149 192.168.1.9: domain3:domain4:...
6150 .endd
6151 When the lookup succeeds, the result of the expansion is a list of domains (and
6152 possibly other types of item that are allowed in domain lists).
6153
6154 In the second example, the lookup is a single item in a domain list. It causes
6155 Exim to use a lookup to see if the domain that is being processed can be found
6156 in the file. The file could contains lines like this:
6157 .code
6158 domain1:
6159 domain2:
6160 .endd
6161 Any data that follows the keys is not relevant when checking that the domain
6162 matches the list item.
6163
6164 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6165 Consider a file containing lines like this:
6166 .code
6167 192.168.5.6: lsearch;/another/file
6168 .endd
6169 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6170 first &%domains%& setting above generates the second setting, which therefore
6171 causes a second lookup to occur.
6172
6173 The rest of this chapter describes the different lookup types that are
6174 available. Any of them can be used in any part of the configuration where a
6175 lookup is permitted.
6176
6177
6178 .section "Lookup types" "SECID61"
6179 .cindex "lookup" "types of"
6180 .cindex "single-key lookup" "definition of"
6181 Two different types of data lookup are implemented:
6182
6183 .ilist
6184 The &'single-key'& type requires the specification of a file in which to look,
6185 and a single key to search for. The key must be a non-empty string for the
6186 lookup to succeed. The lookup type determines how the file is searched.
6187 .next
6188 .cindex "query-style lookup" "definition of"
6189 The &'query-style'& type accepts a generalized database query. No particular
6190 key value is assumed by Exim for query-style lookups. You can use whichever
6191 Exim variables you need to construct the database query.
6192 .endlist
6193
6194 The code for each lookup type is in a separate source file that is included in
6195 the binary of Exim only if the corresponding compile-time option is set. The
6196 default settings in &_src/EDITME_& are:
6197 .code
6198 LOOKUP_DBM=yes
6199 LOOKUP_LSEARCH=yes
6200 .endd
6201 which means that only linear searching and DBM lookups are included by default.
6202 For some types of lookup (e.g. SQL databases), you need to install appropriate
6203 libraries and header files before building Exim.
6204
6205
6206
6207
6208 .section "Single-key lookup types" "SECTsinglekeylookups"
6209 .cindex "lookup" "single-key types"
6210 .cindex "single-key lookup" "list of types"
6211 The following single-key lookup types are implemented:
6212
6213 .ilist
6214 .cindex "cdb" "description of"
6215 .cindex "lookup" "cdb"
6216 .cindex "binary zero" "in lookup key"
6217 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6218 string without a terminating binary zero. The cdb format is designed for
6219 indexed files that are read frequently and never updated, except by total
6220 re-creation. As such, it is particularly suitable for large files containing
6221 aliases or other indexed data referenced by an MTA. Information about cdb can
6222 be found in several places:
6223 .display
6224 &url(http://www.pobox.com/~djb/cdb.html)
6225 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6226 &url(http://packages.debian.org/stable/utils/freecdb.html)
6227 .endd
6228 A cdb distribution is not needed in order to build Exim with cdb support,
6229 because the code for reading cdb files is included directly in Exim itself.
6230 However, no means of building or testing cdb files is provided with Exim, so
6231 you need to obtain a cdb distribution in order to do this.
6232 .next
6233 .cindex "DBM" "lookup type"
6234 .cindex "lookup" "dbm"
6235 .cindex "binary zero" "in lookup key"
6236 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6237 DBM file by looking up the record with the given key. A terminating binary
6238 zero is included in the key that is passed to the DBM library. See section
6239 &<<SECTdb>>& for a discussion of DBM libraries.
6240
6241 .cindex "Berkeley DB library" "file format"
6242 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6243 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6244 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6245 the DB_UNKNOWN option. This enables it to handle any of the types of database
6246 that the library supports, and can be useful for accessing DBM files created by
6247 other applications. (For earlier DB versions, DB_HASH is always used.)
6248 .new
6249 .next
6250 .cindex "lookup" "dbmjz"
6251 .cindex "lookup" "dbm &-- embedded NULs"
6252 .cindex "sasldb2"
6253 .cindex "dbmjz lookup type"
6254 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6255 interpreted as an Exim list; the elements of the list are joined together with
6256 ASCII NUL characters to form the lookup key.  An example usage would be to
6257 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6258 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6259 &(cram_md5)& authenticator.
6260 .wen
6261 .next
6262 .cindex "lookup" "dbmnz"
6263 .cindex "lookup" "dbm &-- terminating zero"
6264 .cindex "binary zero" "in lookup key"
6265 .cindex "Courier"
6266 .cindex "&_/etc/userdbshadow.dat_&"
6267 .cindex "dbmnz lookup type"
6268 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6269 is not included in the key that is passed to the DBM library. You may need this
6270 if you want to look up data in files that are created by or shared with some
6271 other application that does not use terminating zeros. For example, you need to
6272 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6273 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6274 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6275 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6276 .next
6277 .cindex "lookup" "dsearch"
6278 .cindex "dsearch lookup type"
6279 &(dsearch)&: The given file must be a directory; this is searched for an entry
6280 whose name is the key by calling the &[lstat()]& function. The key may not
6281 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6282 the lookup is the name of the entry, which may be a file, directory,
6283 symbolic link, or any other kind of directory entry. An example of how this
6284 lookup can be used to support virtual domains is given in section
6285 &<<SECTvirtualdomains>>&.
6286 .next
6287 .cindex "lookup" "iplsearch"
6288 .cindex "iplsearch lookup type"
6289 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6290 terminated by a colon or white space or the end of the line. The keys in the
6291 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6292 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6293 being interpreted as a key terminator. For example:
6294 .code
6295 1.2.3.4:           data for 1.2.3.4
6296 192.168.0.0/16:    data for 192.168.0.0/16
6297 "abcd::cdab":      data for abcd::cdab
6298 "abcd:abcd::/32"   data for abcd:abcd::/32
6299 .endd
6300 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6301 file is searched linearly, using the CIDR masks where present, until a matching
6302 key is found. The first key that matches is used; there is no attempt to find a
6303 &"best"& match. Apart from the way the keys are matched, the processing for
6304 &(iplsearch)& is the same as for &(lsearch)&.
6305
6306 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6307 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6308 lookup types support only literal keys.
6309
6310 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6311 the implicit key is the host's IP address rather than its name (see section
6312 &<<SECThoslispatsikey>>&).
6313 .next
6314 .cindex "linear search"
6315 .cindex "lookup" "lsearch"
6316 .cindex "lsearch lookup type"
6317 .cindex "case sensitivity" "in lsearch lookup"
6318 &(lsearch)&: The given file is a text file that is searched linearly for a
6319 line beginning with the search key, terminated by a colon or white space or the
6320 end of the line. The search is case-insensitive; that is, upper and lower case
6321 letters are treated as the same. The first occurrence of the key that is found
6322 in the file is used.
6323
6324 White space between the key and the colon is permitted. The remainder of the
6325 line, with leading and trailing white space removed, is the data. This can be
6326 continued onto subsequent lines by starting them with any amount of white
6327 space, but only a single space character is included in the data at such a
6328 junction. If the data begins with a colon, the key must be terminated by a
6329 colon, for example:
6330 .code
6331 baduser:  :fail:
6332 .endd
6333 Empty lines and lines beginning with # are ignored, even if they occur in the
6334 middle of an item. This is the traditional textual format of alias files. Note
6335 that the keys in an &(lsearch)& file are literal strings. There is no
6336 wildcarding of any kind.
6337
6338 .cindex "lookup" "lsearch &-- colons in keys"
6339 .cindex "white space" "in lsearch key"
6340 In most &(lsearch)& files, keys are not required to contain colons or #
6341 characters, or white space. However, if you need this feature, it is available.
6342 If a key begins with a doublequote character, it is terminated only by a
6343 matching quote (or end of line), and the normal escaping rules apply to its
6344 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6345 quoted keys (exactly as for unquoted keys). There is no special handling of
6346 quotes for the data part of an &(lsearch)& line.
6347
6348 .next
6349 .cindex "NIS lookup type"
6350 .cindex "lookup" "NIS"
6351 .cindex "binary zero" "in lookup key"
6352 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6353 the given key, without a terminating binary zero. There is a variant called
6354 &(nis0)& which does include the terminating binary zero in the key. This is
6355 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6356 aliases; the full map names must be used.
6357
6358 .next
6359 .cindex "wildlsearch lookup type"
6360 .cindex "lookup" "wildlsearch"
6361 .cindex "nwildlsearch lookup type"
6362 .cindex "lookup" "nwildlsearch"
6363 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6364 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6365 the file may be wildcarded. The difference between these two lookup types is
6366 that for &(wildlsearch)&, each key in the file is string-expanded before being
6367 used, whereas for &(nwildlsearch)&, no expansion takes place.
6368
6369 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6370 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6371 file that are regular expressions can be made case-sensitive by the use of
6372 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6373
6374 . ==== As this is a nested list, any displays it contains must be indented
6375 . ==== as otherwise they are too far to the left.
6376
6377 .olist
6378 The string may begin with an asterisk to mean &"ends with"&. For example:
6379 .code
6380     *.a.b.c       data for anything.a.b.c
6381     *fish         data for anythingfish
6382 .endd
6383 .next
6384 The string may begin with a circumflex to indicate a regular expression. For
6385 example, for &(wildlsearch)&:
6386 .code
6387     ^\N\d+\.a\.b\N    data for <digits>.a.b
6388 .endd
6389 Note the use of &`\N`& to disable expansion of the contents of the regular
6390 expression. If you are using &(nwildlsearch)&, where the keys are not
6391 string-expanded, the equivalent entry is:
6392 .code
6393     ^\d+\.a\.b        data for <digits>.a.b
6394 .endd
6395 The case-insensitive flag is set at the start of compiling the regular
6396 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6397 For example, to make the entire pattern case-sensitive:
6398 .code
6399     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6400 .endd
6401
6402 If the regular expression contains white space or colon characters, you must
6403 either quote it (see &(lsearch)& above), or represent these characters in other
6404 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6405 colon. This may be easier than quoting, because if you quote, you have to
6406 escape all the backslashes inside the quotes.
6407
6408 &*Note*&: It is not possible to capture substrings in a regular expression
6409 match for later use, because the results of all lookups are cached. If a lookup
6410 is repeated, the result is taken from the cache, and no actual pattern matching
6411 takes place. The values of all the numeric variables are unset after a
6412 &((n)wildlsearch)& match.
6413
6414 .next
6415 Although I cannot see it being of much use, the general matching function that
6416 is used to implement &((n)wildlsearch)& means that the string may begin with a
6417 lookup name terminated by a semicolon, and followed by lookup data. For
6418 example:
6419 .code
6420     cdb;/some/file  data for keys that match the file
6421 .endd
6422 The data that is obtained from the nested lookup is discarded.
6423 .endlist olist
6424
6425 Keys that do not match any of these patterns are interpreted literally. The
6426 continuation rules for the data are the same as for &(lsearch)&, and keys may
6427 be followed by optional colons.
6428
6429 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6430 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6431 lookup types support only literal keys.
6432 .endlist ilist
6433
6434
6435 .section "Query-style lookup types" "SECID62"
6436 .cindex "lookup" "query-style types"
6437 .cindex "query-style lookup" "list of types"
6438 The supported query-style lookup types are listed below. Further details about
6439 many of them are given in later sections.
6440
6441 .ilist
6442 .cindex "DNS" "as a lookup type"
6443 .cindex "lookup" "DNS"
6444 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6445 are given in the supplied query. The resulting data is the contents of the
6446 records. See section &<<SECTdnsdb>>&.
6447 .next
6448 .cindex "InterBase lookup type"
6449 .cindex "lookup" "InterBase"
6450 &(ibase)&: This does a lookup in an InterBase database.
6451 .next
6452 .cindex "LDAP" "lookup type"
6453 .cindex "lookup" "LDAP"
6454 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6455 returns attributes from a single entry. There is a variant called &(ldapm)&
6456 that permits values from multiple entries to be returned. A third variant
6457 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6458 any attribute values. See section &<<SECTldap>>&.
6459 .next
6460 .cindex "MySQL" "lookup type"
6461 .cindex "lookup" "MySQL"
6462 &(mysql)&: The format of the query is an SQL statement that is passed to a
6463 MySQL database. See section &<<SECTsql>>&.
6464 .next
6465 .cindex "NIS+ lookup type"
6466 .cindex "lookup" "NIS+"
6467 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6468 the field to be returned. See section &<<SECTnisplus>>&.
6469 .next
6470 .cindex "Oracle" "lookup type"
6471 .cindex "lookup" "Oracle"
6472 &(oracle)&: The format of the query is an SQL statement that is passed to an
6473 Oracle database. See section &<<SECTsql>>&.
6474 .next
6475 .cindex "lookup" "passwd"
6476 .cindex "passwd lookup type"
6477 .cindex "&_/etc/passwd_&"
6478 &(passwd)& is a query-style lookup with queries that are just user names. The
6479 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6480 success, the result string is the same as you would get from an &(lsearch)&
6481 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6482 password value. For example:
6483 .code
6484 *:42:42:King Rat:/home/kr:/bin/bash
6485 .endd
6486 .next
6487 .cindex "PostgreSQL lookup type"
6488 .cindex "lookup" "PostgreSQL"
6489 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6490 PostgreSQL database. See section &<<SECTsql>>&.
6491
6492 .next
6493 .cindex "sqlite lookup type"
6494 .cindex "lookup" "sqlite"
6495 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6496 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6497
6498 .next
6499 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6500 not likely to be useful in normal operation.
6501 .next
6502 .cindex "whoson lookup type"
6503 .cindex "lookup" "whoson"
6504 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6505 allows a server to check whether a particular (dynamically allocated) IP
6506 address is currently allocated to a known (trusted) user and, optionally, to
6507 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6508 at one time for &"POP before SMTP"& authentication, but that approach has been
6509 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6510 &"POP before SMTP"& checking using ACL statements such as
6511 .code
6512 require condition = \
6513   ${lookup whoson {$sender_host_address}{yes}{no}}
6514 .endd
6515 The query consists of a single IP address. The value returned is the name of
6516 the authenticated user, which is stored in the variable &$value$&. However, in
6517 this example, the data in &$value$& is not used; the result of the lookup is
6518 one of the fixed strings &"yes"& or &"no"&.
6519 .endlist
6520
6521
6522
6523 .section "Temporary errors in lookups" "SECID63"
6524 .cindex "lookup" "temporary error in"
6525 Lookup functions can return temporary error codes if the lookup cannot be
6526 completed. For example, an SQL or LDAP database might be unavailable. For this
6527 reason, it is not advisable to use a lookup that might do this for critical
6528 options such as a list of local domains.
6529
6530 When a lookup cannot be completed in a router or transport, delivery
6531 of the message (to the relevant address) is deferred, as for any other
6532 temporary error. In other circumstances Exim may assume the lookup has failed,
6533 or may give up altogether.
6534
6535
6536
6537 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6538 .cindex "wildcard lookups"
6539 .cindex "lookup" "default values"
6540 .cindex "lookup" "wildcard"
6541 .cindex "lookup" "* added to type"
6542 .cindex "default" "in single-key lookups"
6543 In this context, a &"default value"& is a value specified by the administrator
6544 that is to be used if a lookup fails.
6545
6546 &*Note:*& This section applies only to single-key lookups. For query-style
6547 lookups, the facilities of the query language must be used. An attempt to
6548 specify a default for a query-style lookup provokes an error.
6549
6550 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6551 and the initial lookup fails, the key &"*"& is looked up in the file to
6552 provide a default value. See also the section on partial matching below.
6553
6554 .cindex "*@ with single-key lookup"
6555 .cindex "lookup" "*@ added to type"
6556 .cindex "alias file" "per-domain default"
6557 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6558 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6559 character, a second lookup is done with everything before the last @ replaced
6560 by *. This makes it possible to provide per-domain defaults in alias files
6561 that include the domains in the keys. If the second lookup fails (or doesn't
6562 take place because there is no @ in the key), &"*"& is looked up.
6563 For example, a &(redirect)& router might contain:
6564 .code
6565 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6566 .endd
6567 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6568 looks up these keys, in this order:
6569 .code
6570 jane@eyre.example
6571 *@eyre.example
6572 *
6573 .endd
6574 The data is taken from whichever key it finds first. &*Note*&: In an
6575 &(lsearch)& file, this does not mean the first of these keys in the file. A
6576 complete scan is done for each key, and only if it is not found at all does
6577 Exim move on to try the next key.
6578
6579
6580
6581 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6582 .cindex "partial matching"
6583 .cindex "wildcard lookups"
6584 .cindex "lookup" "partial matching"
6585 .cindex "lookup" "wildcard"
6586 .cindex "asterisk" "in search type"
6587 The normal operation of a single-key lookup is to search the file for an exact
6588 match with the given key. However, in a number of situations where domains are
6589 being looked up, it is useful to be able to do partial matching. In this case,
6590 information in the file that has a key starting with &"*."& is matched by any
6591 domain that ends with the components that follow the full stop. For example, if
6592 a key in a DBM file is
6593 .code
6594 *.dates.fict.example
6595 .endd
6596 then when partial matching is enabled this is matched by (amongst others)
6597 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6598 by &'dates.fict.example'&, if that does not appear as a separate key in the
6599 file.
6600
6601 &*Note*&: Partial matching is not available for query-style lookups. It is
6602 also not available for any lookup items in address lists (see section
6603 &<<SECTaddresslist>>&).
6604
6605 Partial matching is implemented by doing a series of separate lookups using
6606 keys constructed by modifying the original subject key. This means that it can
6607 be used with any of the single-key lookup types, provided that
6608 partial matching keys
6609 beginning with a special prefix (default &"*."&) are included in the data file.
6610 Keys in the file that do not begin with the prefix are matched only by
6611 unmodified subject keys when partial matching is in use.
6612
6613 Partial matching is requested by adding the string &"partial-"& to the front of
6614 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6615 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6616 is added at the start of the subject key, and it is looked up again. If that
6617 fails, further lookups are tried with dot-separated components removed from the
6618 start of the subject key, one-by-one, and &"*."& added on the front of what
6619 remains.
6620
6621 A minimum number of two non-* components are required. This can be adjusted
6622 by including a number before the hyphen in the search type. For example,
6623 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6624 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6625 subject key is &'2250.dates.fict.example'& then the following keys are looked
6626 up when the minimum number of non-* components is two:
6627 .code
6628 2250.dates.fict.example
6629 *.2250.dates.fict.example
6630 *.dates.fict.example
6631 *.fict.example
6632 .endd
6633 As soon as one key in the sequence is successfully looked up, the lookup
6634 finishes.
6635
6636 .cindex "lookup" "partial matching &-- changing prefix"
6637 .cindex "prefix" "for partial matching"
6638 The use of &"*."& as the partial matching prefix is a default that can be
6639 changed. The motivation for this feature is to allow Exim to operate with file
6640 formats that are used by other MTAs. A different prefix can be supplied in
6641 parentheses instead of the hyphen after &"partial"&. For example:
6642 .code
6643 domains = partial(.)lsearch;/some/file
6644 .endd
6645 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6646 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6647 components is unchanged). The prefix may consist of any punctuation characters
6648 other than a closing parenthesis. It may be empty, for example:
6649 .code
6650 domains = partial1()cdb;/some/file
6651 .endd
6652 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6653 &`a.b.c`&, &`b.c`&, and &`c`&.
6654
6655 If &"partial0"& is specified, what happens at the end (when the lookup with
6656 just one non-wild component has failed, and the original key is shortened right
6657 down to the null string) depends on the prefix:
6658
6659 .ilist
6660 If the prefix has zero length, the whole lookup fails.
6661 .next
6662 If the prefix has length 1, a lookup for just the prefix is done. For
6663 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6664 .next
6665 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6666 remainder is looked up. With the default prefix, therefore, the final lookup is
6667 for &"*"& on its own.
6668 .next
6669 Otherwise, the whole prefix is looked up.
6670 .endlist
6671
6672
6673 If the search type ends in &"*"& or &"*@"& (see section
6674 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6675 this implies happens after all partial lookups have failed. If &"partial0"& is
6676 specified, adding &"*"& to the search type has no effect with the default
6677 prefix, because the &"*"& key is already included in the sequence of partial
6678 lookups. However, there might be a use for lookup types such as
6679 &"partial0(.)lsearch*"&.
6680
6681 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6682 in domain lists and the like. Partial matching works only in terms of
6683 dot-separated components; a key such as &`*fict.example`&
6684 in a database file is useless, because the asterisk in a partial matching
6685 subject key is always followed by a dot.
6686
6687
6688
6689
6690 .section "Lookup caching" "SECID64"
6691 .cindex "lookup" "caching"
6692 .cindex "caching" "lookup data"
6693 Exim caches all lookup results in order to avoid needless repetition of
6694 lookups. However, because (apart from the daemon) Exim operates as a collection
6695 of independent, short-lived processes, this caching applies only within a
6696 single Exim process. There is no inter-process lookup caching facility.
6697
6698 For single-key lookups, Exim keeps the relevant files open in case there is
6699 another lookup that needs them. In some types of configuration this can lead to
6700 many files being kept open for messages with many recipients. To avoid hitting
6701 the operating system limit on the number of simultaneously open files, Exim
6702 closes the least recently used file when it needs to open more files than its
6703 own internal limit, which can be changed via the &%lookup_open_max%& option.
6704
6705 The single-key lookup files are closed and the lookup caches are flushed at
6706 strategic points during delivery &-- for example, after all routing is
6707 complete.
6708
6709
6710
6711
6712 .section "Quoting lookup data" "SECID65"
6713 .cindex "lookup" "quoting"
6714 .cindex "quoting" "in lookups"
6715 When data from an incoming message is included in a query-style lookup, there
6716 is the possibility of special characters in the data messing up the syntax of
6717 the query. For example, a NIS+ query that contains
6718 .code
6719 [name=$local_part]
6720 .endd
6721 will be broken if the local part happens to contain a closing square bracket.
6722 For NIS+, data can be enclosed in double quotes like this:
6723 .code
6724 [name="$local_part"]
6725 .endd
6726 but this still leaves the problem of a double quote in the data. The rule for
6727 NIS+ is that double quotes must be doubled. Other lookup types have different
6728 rules, and to cope with the differing requirements, an expansion operator
6729 of the following form is provided:
6730 .code
6731 ${quote_<lookup-type>:<string>}
6732 .endd
6733 For example, the safest way to write the NIS+ query is
6734 .code
6735 [name="${quote_nisplus:$local_part}"]
6736 .endd
6737 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6738 operator can be used for all lookup types, but has no effect for single-key
6739 lookups, since no quoting is ever needed in their key strings.
6740
6741
6742
6743
6744 .section "More about dnsdb" "SECTdnsdb"
6745 .cindex "dnsdb lookup"
6746 .cindex "lookup" "dnsdb"
6747 .cindex "DNS" "as a lookup type"
6748 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6749 of a record type and a domain name, separated by an equals sign. For example,
6750 an expansion string could contain:
6751 .code
6752 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6753 .endd
6754 If the lookup succeeds, the result is placed in &$value$&, which in this case
6755 is used on its own as the result. If the lookup does not succeed, the
6756 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6757 &<<SECTforexpfai>>& for an explanation of what this means.
6758
6759 The supported DNS record types are A, CNAME, MX, NS, PTR, SRV, and TXT, and,
6760 when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6761 configured). If no type is given, TXT is assumed. When the type is PTR,
6762 the data can be an IP address, written as normal; inversion and the addition of
6763 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6764 .code
6765 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6766 .endd
6767 If the data for a PTR record is not a syntactically valid IP address, it is not
6768 altered and nothing is added.
6769
6770 .cindex "MX record" "in &(dnsdb)& lookup"
6771 .cindex "SRV record" "in &(dnsdb)& lookup"
6772 For an MX lookup, both the preference value and the host name are returned for
6773 each record, separated by a space. For an SRV lookup, the priority, weight,
6774 port, and host name are returned for each record, separated by spaces.
6775
6776 For any record type, if multiple records are found (or, for A6 lookups, if a
6777 single record leads to multiple addresses), the data is returned as a
6778 concatenation, with newline as the default separator. The order, of course,
6779 depends on the DNS resolver. You can specify a different separator character
6780 between multiple records by putting a right angle-bracket followed immediately
6781 by the new separator at the start of the query. For example:
6782 .code
6783 ${lookup dnsdb{>: a=host1.example}}
6784 .endd
6785 It is permitted to specify a space as the separator character. Further
6786 white space is ignored.
6787
6788 .cindex "TXT record" "in &(dnsdb)& lookup"
6789 For TXT records with multiple items of data, only the first item is returned,
6790 unless a separator for them is specified using a comma after the separator
6791 character followed immediately by the TXT record item separator. To concatenate
6792 items without a separator, use a semicolon instead.
6793 .code
6794 ${lookup dnsdb{>\n,: txt=a.b.example}}
6795 ${lookup dnsdb{>\n; txt=a.b.example}}
6796 .endd
6797 It is permitted to specify a space as the separator character. Further
6798 white space is ignored.
6799
6800 .section "Pseudo dnsdb record types" "SECID66"
6801 .cindex "MX record" "in &(dnsdb)& lookup"
6802 By default, both the preference value and the host name are returned for
6803 each MX record, separated by a space. If you want only host names, you can use
6804 the pseudo-type MXH:
6805 .code
6806 ${lookup dnsdb{mxh=a.b.example}}
6807 .endd
6808 In this case, the preference values are omitted, and just the host names are
6809 returned.
6810
6811 .cindex "name server for enclosing domain"
6812 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6813 records on the given domain, but if none are found, it removes the first
6814 component of the domain name, and tries again. This process continues until NS
6815 records are found or there are no more components left (or there is a DNS
6816 error). In other words, it may return the name servers for a top-level domain,
6817 but it never returns the root name servers. If there are no NS records for the
6818 top-level domain, the lookup fails. Consider these examples:
6819 .code
6820 ${lookup dnsdb{zns=xxx.quercite.com}}
6821 ${lookup dnsdb{zns=xxx.edu}}
6822 .endd
6823 Assuming that in each case there are no NS records for the full domain name,
6824 the first returns the name servers for &%quercite.com%&, and the second returns
6825 the name servers for &%edu%&.
6826
6827 You should be careful about how you use this lookup because, unless the
6828 top-level domain does not exist, the lookup always returns some host names. The
6829 sort of use to which this might be put is for seeing if the name servers for a
6830 given domain are on a blacklist. You can probably assume that the name servers
6831 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6832 such a list.
6833
6834 .cindex "CSA" "in &(dnsdb)& lookup"
6835 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6836 records according to the CSA rules, which are described in section
6837 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6838 not sufficient because of the extra parent domain search behaviour of CSA. The
6839 result of a successful lookup such as:
6840 .code
6841 ${lookup dnsdb {csa=$sender_helo_name}}
6842 .endd
6843 has two space-separated fields: an authorization code and a target host name.
6844 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6845 authorization required but absent, or &"?"& for unknown.
6846
6847
6848 .section "Multiple dnsdb lookups" "SECID67"
6849 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6850 However, you can specify a list of domains or IP addresses in a single
6851 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6852 the default separator, but with the ability to change this. For example:
6853 .code
6854 ${lookup dnsdb{one.domain.com:two.domain.com}}
6855 ${lookup dnsdb{a=one.host.com:two.host.com}}
6856 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6857 .endd
6858 In order to retain backwards compatibility, there is one special case: if
6859 the lookup type is PTR and no change of separator is specified, Exim looks
6860 to see if the rest of the string is precisely one IPv6 address. In this
6861 case, it does not treat it as a list.
6862
6863 The data from each lookup is concatenated, with newline separators by default,
6864 in the same way that multiple DNS records for a single item are handled. A
6865 different separator can be specified, as described above.
6866
6867 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6868 temporary DNS error for any of them, the behaviour is controlled by
6869 an optional keyword followed by a comma that may appear before the record
6870 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6871 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6872 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6873 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6874 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6875 error causes the whole lookup to defer only if none of the other lookups
6876 succeed. The default is &"lax"&, so the following lookups are equivalent:
6877 .code
6878 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6879 ${lookup dnsdb{a=one.host.com:two.host.com}}
6880 .endd
6881 Thus, in the default case, as long as at least one of the DNS lookups
6882 yields some data, the lookup succeeds.
6883
6884
6885
6886
6887 .section "More about LDAP" "SECTldap"
6888 .cindex "LDAP" "lookup, more about"
6889 .cindex "lookup" "LDAP"
6890 .cindex "Solaris" "LDAP"
6891 The original LDAP implementation came from the University of Michigan; this has
6892 become &"Open LDAP"&, and there are now two different releases. Another
6893 implementation comes from Netscape, and Solaris 7 and subsequent releases
6894 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6895 the lookup function level, their error handling is different. For this reason
6896 it is necessary to set a compile-time variable when building Exim with LDAP, to
6897 indicate which LDAP library is in use. One of the following should appear in
6898 your &_Local/Makefile_&:
6899 .code
6900 LDAP_LIB_TYPE=UMICHIGAN
6901 LDAP_LIB_TYPE=OPENLDAP1
6902 LDAP_LIB_TYPE=OPENLDAP2
6903 LDAP_LIB_TYPE=NETSCAPE
6904 LDAP_LIB_TYPE=SOLARIS
6905 .endd
6906 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6907 same interface as the University of Michigan version.
6908
6909 There are three LDAP lookup types in Exim. These behave slightly differently in
6910 the way they handle the results of a query:
6911
6912 .ilist
6913 &(ldap)& requires the result to contain just one entry; if there are more, it
6914 gives an error.
6915 .next
6916 &(ldapdn)& also requires the result to contain just one entry, but it is the
6917 Distinguished Name that is returned rather than any attribute values.
6918 .next
6919 &(ldapm)& permits the result to contain more than one entry; the attributes
6920 from all of them are returned.
6921 .endlist
6922
6923
6924 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6925 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6926 the data returned by a successful lookup is described in the next section.
6927 First we explain how LDAP queries are coded.
6928
6929
6930 .section "Format of LDAP queries" "SECTforldaque"
6931 .cindex "LDAP" "query format"
6932 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6933 the configuration of a &(redirect)& router one might have this setting:
6934 .code
6935 data = ${lookup ldap \
6936   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6937   c=UK?mailbox?base?}}
6938 .endd
6939 .cindex "LDAP" "with TLS"
6940 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6941 secure (encrypted) LDAP connections. The second of these ensures that an
6942 encrypted TLS connection is used.
6943
6944 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
6945 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
6946 See the &%ldap_start_tls%& option.
6947
6948
6949 .section "LDAP quoting" "SECID68"
6950 .cindex "LDAP" "quoting"
6951 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6952 and the second because the LDAP query is represented as a URL. Furthermore,
6953 within an LDAP query, two different kinds of quoting are required. For this
6954 reason, there are two different LDAP-specific quoting operators.
6955
6956 The &%quote_ldap%& operator is designed for use on strings that are part of
6957 filter specifications. Conceptually, it first does the following conversions on
6958 the string:
6959 .code
6960 *   =>   \2A
6961 (   =>   \28
6962 )   =>   \29
6963 \   =>   \5C
6964 .endd
6965 in accordance with RFC 2254. The resulting string is then quoted according
6966 to the rules for URLs, that is, all non-alphanumeric characters except
6967 .code
6968 ! $ ' - . _ ( ) * +
6969 .endd
6970 are converted to their hex values, preceded by a percent sign. For example:
6971 .code
6972 ${quote_ldap: a(bc)*, a<yz>; }
6973 .endd
6974 yields
6975 .code
6976 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6977 .endd
6978 Removing the URL quoting, this is (with a leading and a trailing space):
6979 .code
6980 a\28bc\29\2A, a<yz>;
6981 .endd
6982 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6983 base DN specifications in queries. Conceptually, it first converts the string
6984 by inserting a backslash in front of any of the following characters:
6985 .code
6986 , + " \ < > ;
6987 .endd
6988 It also inserts a backslash before any leading spaces or # characters, and
6989 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6990 is then quoted according to the rules for URLs. For example:
6991 .code
6992 ${quote_ldap_dn: a(bc)*, a<yz>; }
6993 .endd
6994 yields
6995 .code
6996 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
6997 .endd
6998 Removing the URL quoting, this is (with a trailing space):
6999 .code
7000 \ a(bc)*\, a\<yz\>\;\
7001 .endd
7002 There are some further comments about quoting in the section on LDAP
7003 authentication below.
7004
7005
7006 .section "LDAP connections" "SECID69"
7007 .cindex "LDAP" "connections"
7008 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7009 is in use, via a Unix domain socket. The example given above does not specify
7010 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7011 by starting it with
7012 .code
7013 ldap://<hostname>:<port>/...
7014 .endd
7015 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7016 used. When no server is specified in a query, a list of default servers is
7017 taken from the &%ldap_default_servers%& configuration option. This supplies a
7018 colon-separated list of servers which are tried in turn until one successfully
7019 handles a query, or there is a serious error. Successful handling either
7020 returns the requested data, or indicates that it does not exist. Serious errors
7021 are syntactical, or multiple values when only a single value is expected.
7022 Errors which cause the next server to be tried are connection failures, bind
7023 failures, and timeouts.
7024
7025 For each server name in the list, a port number can be given. The standard way
7026 of specifying a host and port is to use a colon separator (RFC 1738). Because
7027 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7028 doubled. For example
7029 .code
7030 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7031 .endd
7032 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7033 to the LDAP library with no server name, and the library's default (normally
7034 the local host) is used.
7035
7036 If you are using the OpenLDAP library, you can connect to an LDAP server using
7037 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7038 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7039 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7040 not available.
7041
7042 For this type of connection, instead of a host name for the server, a pathname
7043 for the socket is required, and the port number is not relevant. The pathname
7044 can be specified either as an item in &%ldap_default_servers%&, or inline in
7045 the query. In the former case, you can have settings such as
7046 .code
7047 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7048 .endd
7049 When the pathname is given in the query, you have to escape the slashes as
7050 &`%2F`& to fit in with the LDAP URL syntax. For example:
7051 .code
7052 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7053 .endd
7054 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7055 a pathname, it uses the Unix domain socket code, even if the query actually
7056 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7057 socket connection. This behaviour means that you can use a setting of
7058 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7059 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7060 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7061 backup host.
7062
7063 If an explicit &`ldapi`& type is given in a query when a host name is
7064 specified, an error is diagnosed. However, if there are more items in
7065 &%ldap_default_servers%&, they are tried. In other words:
7066
7067 .ilist
7068 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7069 interface.
7070 .next
7071 Using &`ldapi`& with a host name causes an error.
7072 .endlist
7073
7074
7075 Using &`ldapi`& with no host or path in the query, and no setting of
7076 &%ldap_default_servers%&, does whatever the library does by default.
7077
7078
7079
7080 .section "LDAP authentication and control information" "SECID70"
7081 .cindex "LDAP" "authentication"
7082 The LDAP URL syntax provides no way of passing authentication and other control
7083 information to the server. To make this possible, the URL in an LDAP query may
7084 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7085 spaces. If a value contains spaces it must be enclosed in double quotes, and
7086 when double quotes are used, backslash is interpreted in the usual way inside
7087 them. The following names are recognized:
7088 .display
7089 &`DEREFERENCE`&  set the dereferencing parameter
7090 &`NETTIME    `&  set a timeout for a network operation
7091 &`USER       `&  set the DN, for authenticating the LDAP bind
7092 &`PASS       `&  set the password, likewise
7093 &`REFERRALS  `&  set the referrals parameter
7094 &`SIZE       `&  set the limit for the number of entries returned
7095 &`TIME       `&  set the maximum waiting time for a query
7096 .endd
7097 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7098 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7099 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7100 library from trying to follow referrals issued by the LDAP server.
7101
7102 The name CONNECT is an obsolete name for NETTIME, retained for
7103 backwards compatibility. This timeout (specified as a number of seconds) is
7104 enforced from the client end for operations that can be carried out over a
7105 network. Specifically, it applies to network connections and calls to the
7106 &'ldap_result()'& function. If the value is greater than zero, it is used if
7107 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7108 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7109 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7110 Netscape SDK; for OpenLDAP no action is taken.
7111
7112 The TIME parameter (also a number of seconds) is passed to the server to
7113 set a server-side limit on the time taken to complete a search.
7114
7115
7116 Here is an example of an LDAP query in an Exim lookup that uses some of these
7117 values. This is a single line, folded to fit on the page:
7118 .code
7119 ${lookup ldap
7120   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7121   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7122   {$value}fail}
7123 .endd
7124 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7125 any of the auxiliary data. Exim configuration settings that include lookups
7126 which contain password information should be preceded by &"hide"& to prevent
7127 non-admin users from using the &%-bP%& option to see their values.
7128
7129 The auxiliary data items may be given in any order. The default is no
7130 connection timeout (the system timeout is used), no user or password, no limit
7131 on the number of entries returned, and no time limit on queries.
7132
7133 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7134 removes any URL quoting that it may contain before passing it LDAP. Apparently
7135 some libraries do this for themselves, but some do not. Removing the URL
7136 quoting has two advantages:
7137
7138 .ilist
7139 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7140 DNs as with DNs inside actual queries.
7141 .next
7142 It permits spaces inside USER= DNs.
7143 .endlist
7144
7145 For example, a setting such as
7146 .code
7147 USER=cn=${quote_ldap_dn:$1}
7148 .endd
7149 should work even if &$1$& contains spaces.
7150
7151 Expanded data for the PASS= value should be quoted using the &%quote%&
7152 expansion operator, rather than the LDAP quote operators. The only reason this
7153 field needs quoting is to ensure that it conforms to the Exim syntax, which
7154 does not allow unquoted spaces. For example:
7155 .code
7156 PASS=${quote:$3}
7157 .endd
7158 The LDAP authentication mechanism can be used to check passwords as part of
7159 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7160 &<<CHAPexpand>>&.
7161
7162
7163
7164 .section "Format of data returned by LDAP" "SECID71"
7165 .cindex "LDAP" "returned data formats"
7166 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7167 as a sequence of values, for example
7168 .code
7169 cn=manager, o=University of Cambridge, c=UK
7170 .endd
7171 The &(ldap)& lookup type generates an error if more than one entry matches the
7172 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7173 the result between the data from different entries. It is possible for multiple
7174 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7175 you know that whatever values are returned all came from a single entry in the
7176 directory.
7177
7178 In the common case where you specify a single attribute in your LDAP query, the
7179 result is not quoted, and does not contain the attribute name. If the attribute
7180 has multiple values, they are separated by commas.
7181
7182 If you specify multiple attributes, the result contains space-separated, quoted
7183 strings, each preceded by the attribute name and an equals sign. Within the
7184 quotes, the quote character, backslash, and newline are escaped with
7185 backslashes, and commas are used to separate multiple values for the attribute.
7186 Apart from the escaping, the string within quotes takes the same form as the
7187 output when a single attribute is requested. Specifying no attributes is the
7188 same as specifying all of an entry's attributes.
7189
7190 Here are some examples of the output format. The first line of each pair is an
7191 LDAP query, and the second is the data that is returned. The attribute called
7192 &%attr1%& has two values, whereas &%attr2%& has only one value:
7193 .code
7194 ldap:///o=base?attr1?sub?(uid=fred)
7195 value1.1, value1.2
7196
7197 ldap:///o=base?attr2?sub?(uid=fred)
7198 value two
7199
7200 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7201 attr1="value1.1, value1.2" attr2="value two"
7202
7203 ldap:///o=base??sub?(uid=fred)
7204 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7205 .endd
7206 The &%extract%& operator in string expansions can be used to pick out
7207 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7208 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7209 results of LDAP lookups.
7210
7211
7212
7213
7214 .section "More about NIS+" "SECTnisplus"
7215 .cindex "NIS+ lookup type"
7216 .cindex "lookup" "NIS+"
7217 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7218 and field name. If this is given, the result of a successful query is the
7219 contents of the named field; otherwise the result consists of a concatenation
7220 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7221 values containing spaces are quoted. For example, the query
7222 .code
7223 [name=mg1456],passwd.org_dir
7224 .endd
7225 might return the string
7226 .code
7227 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7228 home=/home/mg1456 shell=/bin/bash shadow=""
7229 .endd
7230 (split over two lines here to fit on the page), whereas
7231 .code
7232 [name=mg1456],passwd.org_dir:gcos
7233 .endd
7234 would just return
7235 .code
7236 Martin Guerre
7237 .endd
7238 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7239 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7240 operator is to double any quote characters within the text.
7241
7242
7243
7244 .section "SQL lookups" "SECTsql"
7245 .cindex "SQL lookup types"
7246 .cindex "MySQL" "lookup type"
7247 .cindex "PostgreSQL lookup type"
7248 .cindex "lookup" "MySQL"
7249 .cindex "lookup" "PostgreSQL"
7250 .cindex "Oracle" "lookup type"
7251 .cindex "lookup" "Oracle"
7252 .cindex "InterBase lookup type"
7253 .cindex "lookup" "InterBase"
7254 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7255 databases. Queries for these databases contain SQL statements, so an example
7256 might be
7257 .code
7258 ${lookup mysql{select mailbox from users where id='userx'}\
7259   {$value}fail}
7260 .endd
7261 If the result of the query contains more than one field, the data for each
7262 field in the row is returned, preceded by its name, so the result of
7263 .code
7264 ${lookup pgsql{select home,name from users where id='userx'}\
7265   {$value}}
7266 .endd
7267 might be
7268 .code
7269 home=/home/userx name="Mister X"
7270 .endd
7271 Empty values and values containing spaces are double quoted, with embedded
7272 quotes escaped by a backslash. If the result of the query contains just one
7273 field, the value is passed back verbatim, without a field name, for example:
7274 .code
7275 Mister X
7276 .endd
7277 If the result of the query yields more than one row, it is all concatenated,
7278 with a newline between the data for each row.
7279
7280
7281 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7282 .cindex "MySQL" "lookup type"
7283 .cindex "PostgreSQL lookup type"
7284 .cindex "lookup" "MySQL"
7285 .cindex "lookup" "PostgreSQL"
7286 .cindex "Oracle" "lookup type"
7287 .cindex "lookup" "Oracle"
7288 .cindex "InterBase lookup type"
7289 .cindex "lookup" "InterBase"
7290 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7291 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7292 option (as appropriate) must be set to a colon-separated list of server
7293 information.
7294 (For MySQL and PostgreSQL only, the global option need not be set if all
7295 queries contain their own server information &-- see section
7296 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7297 items: host name, database name, user name, and password. In the case of
7298 Oracle, the host name field is used for the &"service name"&, and the database
7299 name field is not used and should be empty. For example:
7300 .code
7301 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7302 .endd
7303 Because password data is sensitive, you should always precede the setting with
7304 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7305 option. Here is an example where two MySQL servers are listed:
7306 .code
7307 hide mysql_servers = localhost/users/root/secret:\
7308                      otherhost/users/root/othersecret
7309 .endd
7310 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7311 because this is a colon-separated list, the colon has to be doubled. For each
7312 query, these parameter groups are tried in order until a connection is made and
7313 a query is successfully processed. The result of a query may be that no data is
7314 found, but that is still a successful query. In other words, the list of
7315 servers provides a backup facility, not a list of different places to look.
7316
7317 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7318 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7319 respectively, and the characters single-quote, double-quote, and backslash
7320 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7321 addition, escapes the percent and underscore characters. This cannot be done
7322 for MySQL because these escapes are not recognized in contexts where these
7323 characters are not special.
7324
7325 .section "Specifying the server in the query" "SECTspeserque"
7326 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7327 it is possible to specify a list of servers with an individual query. This is
7328 done by starting the query with
7329 .display
7330 &`servers=`&&'server1:server2:server3:...'&&`;`&
7331 .endd
7332 Each item in the list may take one of two forms:
7333 .olist
7334 If it contains no slashes it is assumed to be just a host name. The appropriate
7335 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7336 of the same name, and the remaining parameters (database, user, password) are
7337 taken from there.
7338 .next
7339 If it contains any slashes, it is taken as a complete parameter set.
7340 .endlist
7341 The list of servers is used in exactly the same way as the global list.
7342 Once a connection to a server has happened and a query has been
7343 successfully executed, processing of the lookup ceases.
7344
7345 This feature is intended for use in master/slave situations where updates
7346 are occurring and you want to update the master rather than a slave. If the
7347 master is in the list as a backup for reading, you might have a global setting
7348 like this:
7349 .code
7350 mysql_servers = slave1/db/name/pw:\
7351                 slave2/db/name/pw:\
7352                 master/db/name/pw
7353 .endd
7354 In an updating lookup, you could then write:
7355 .code
7356 ${lookup mysql{servers=master; UPDATE ...} }
7357 .endd
7358 That query would then be sent only to the master server. If, on the other hand,
7359 the master is not to be used for reading, and so is not present in the global
7360 option, you can still update it by a query of this form:
7361 .code
7362 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7363 .endd
7364
7365
7366 .section "Special MySQL features" "SECID73"
7367 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7368 causes a connection to the server on the local host by means of a Unix domain
7369 socket. An alternate socket can be specified in parentheses. The full syntax of
7370 each item in &%mysql_servers%& is:
7371 .display
7372 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7373   <&'user'&>/<&'password'&>
7374 .endd
7375 Any of the three sub-parts of the first field can be omitted. For normal use on
7376 the local host it can be left blank or set to just &"localhost"&.
7377
7378 No database need be supplied &-- but if it is absent here, it must be given in
7379 the queries.
7380
7381 If a MySQL query is issued that does not request any data (an insert, update,
7382 or delete command), the result of the lookup is the number of rows affected.
7383
7384 &*Warning*&: This can be misleading. If an update does not actually change
7385 anything (for example, setting a field to the value it already has), the result
7386 is zero because no rows are affected.
7387
7388
7389 .section "Special PostgreSQL features" "SECID74"
7390 PostgreSQL lookups can also use Unix domain socket connections to the database.
7391 This is usually faster and costs less CPU time than a TCP/IP connection.
7392 However it can be used only if the mail server runs on the same machine as the
7393 database server. A configuration line for PostgreSQL via Unix domain sockets
7394 looks like this:
7395 .code
7396 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7397 .endd
7398 In other words, instead of supplying a host name, a path to the socket is
7399 given. The path name is enclosed in parentheses so that its slashes aren't
7400 visually confused with the delimiters for the other server parameters.
7401
7402 If a PostgreSQL query is issued that does not request any data (an insert,
7403 update, or delete command), the result of the lookup is the number of rows
7404 affected.
7405
7406 .section "More about SQLite" "SECTsqlite"
7407 .cindex "lookup" "SQLite"
7408 .cindex "sqlite lookup type"
7409 SQLite is different to the other SQL lookups because a file name is required in
7410 addition to the SQL query. An SQLite database is a single file, and there is no
7411 daemon as in the other SQL databases. The interface to Exim requires the name
7412 of the file, as an absolute path, to be given at the start of the query. It is
7413 separated from the query by white space. This means that the path name cannot
7414 contain white space. Here is a lookup expansion example:
7415 .code
7416 ${lookup sqlite {/some/thing/sqlitedb \
7417   select name from aliases where id='userx';}}
7418 .endd
7419 In a list, the syntax is similar. For example:
7420 .code
7421 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7422    select * from relays where ip='$sender_host_address';
7423 .endd
7424 The only character affected by the &%quote_sqlite%& operator is a single
7425 quote, which it doubles.
7426
7427 The SQLite library handles multiple simultaneous accesses to the database
7428 internally. Multiple readers are permitted, but only one process can
7429 update at once. Attempts to access the database while it is being updated
7430 are rejected after a timeout period, during which the SQLite library
7431 waits for the lock to be released. In Exim, the default timeout is set
7432 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7433 option.
7434 .ecindex IIDfidalo1
7435 .ecindex IIDfidalo2
7436
7437
7438 . ////////////////////////////////////////////////////////////////////////////
7439 . ////////////////////////////////////////////////////////////////////////////
7440
7441 .chapter "Domain, host, address, and local part lists" &&&
7442          "CHAPdomhosaddlists" &&&
7443          "Domain, host, and address lists"
7444 .scindex IIDdohoadli "lists of domains; hosts; etc."
7445 A number of Exim configuration options contain lists of domains, hosts,
7446 email addresses, or local parts. For example, the &%hold_domains%& option
7447 contains a list of domains whose delivery is currently suspended. These lists
7448 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7449 arguments to expansion conditions such as &%match_domain%&.
7450
7451 Each item in one of these lists is a pattern to be matched against a domain,
7452 host, email address, or local part, respectively. In the sections below, the
7453 different types of pattern for each case are described, but first we cover some
7454 general facilities that apply to all four kinds of list.
7455
7456
7457
7458 .section "Expansion of lists" "SECID75"
7459 .cindex "expansion" "of lists"
7460 Each list is expanded as a single string before it is used. The result of
7461 expansion must be a list, possibly containing empty items, which is split up
7462 into separate items for matching. By default, colon is the separator character,
7463 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7464 &<<SECTempitelis>>& for details of the list syntax; the second of these
7465 discusses the way to specify empty list items.
7466
7467
7468 If the string expansion is forced to fail, Exim behaves as if the item it is
7469 testing (domain, host, address, or local part) is not in the list. Other
7470 expansion failures cause temporary errors.
7471
7472 If an item in a list is a regular expression, backslashes, dollars and possibly
7473 other special characters in the expression must be protected against
7474 misinterpretation by the string expander. The easiest way to do this is to use
7475 the &`\N`& expansion feature to indicate that the contents of the regular
7476 expression should not be expanded. For example, in an ACL you might have:
7477 .code
7478 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7479                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7480 .endd
7481 The first item is a regular expression that is protected from expansion by
7482 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7483 senders based on the receiving domain.
7484
7485
7486
7487
7488 .section "Negated items in lists" "SECID76"
7489 .cindex "list" "negation"
7490 .cindex "negation" "in lists"
7491 Items in a list may be positive or negative. Negative items are indicated by a
7492 leading exclamation mark, which may be followed by optional white space. A list
7493 defines a set of items (domains, etc). When Exim processes one of these lists,
7494 it is trying to find out whether a domain, host, address, or local part
7495 (respectively) is in the set that is defined by the list. It works like this:
7496
7497 The list is scanned from left to right. If a positive item is matched, the
7498 subject that is being checked is in the set; if a negative item is matched, the
7499 subject is not in the set. If the end of the list is reached without the
7500 subject having matched any of the patterns, it is in the set if the last item
7501 was a negative one, but not if it was a positive one. For example, the list in
7502 .code
7503 domainlist relay_domains = !a.b.c : *.b.c
7504 .endd
7505 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7506 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7507 list is positive. However, if the setting were
7508 .code
7509 domainlist relay_domains = !a.b.c
7510 .endd
7511 then all domains other than &'a.b.c'& would match because the last item in the
7512 list is negative. In other words, a list that ends with a negative item behaves
7513 as if it had an extra item &`:*`& on the end.
7514
7515 Another way of thinking about positive and negative items in lists is to read
7516 the connector as &"or"& after a positive item and as &"and"& after a negative
7517 item.
7518
7519
7520
7521 .section "File names in lists" "SECTfilnamlis"
7522 .cindex "list" "file name in"
7523 If an item in a domain, host, address, or local part list is an absolute file
7524 name (beginning with a slash character), each line of the file is read and
7525 processed as if it were an independent item in the list, except that further
7526 file names are not allowed,
7527 and no expansion of the data from the file takes place.
7528 Empty lines in the file are ignored, and the file may also contain comment
7529 lines:
7530
7531 .ilist
7532 For domain and host lists, if a # character appears anywhere in a line of the
7533 file, it and all following characters are ignored.
7534 .next
7535 Because local parts may legitimately contain # characters, a comment in an
7536 address list or local part list file is recognized only if # is preceded by
7537 white space or the start of the line. For example:
7538 .code
7539 not#comment@x.y.z   # but this is a comment
7540 .endd
7541 .endlist
7542
7543 Putting a file name in a list has the same effect as inserting each line of the
7544 file as an item in the list (blank lines and comments excepted). However, there
7545 is one important difference: the file is read each time the list is processed,
7546 so if its contents vary over time, Exim's behaviour changes.
7547
7548 If a file name is preceded by an exclamation mark, the sense of any match
7549 within the file is inverted. For example, if
7550 .code
7551 hold_domains = !/etc/nohold-domains
7552 .endd
7553 and the file contains the lines
7554 .code
7555 !a.b.c
7556 *.b.c
7557 .endd
7558 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7559 any domain matching &`*.b.c`& is not.
7560
7561
7562
7563 .section "An lsearch file is not an out-of-line list" "SECID77"
7564 As will be described in the sections that follow, lookups can be used in lists
7565 to provide indexed methods of checking list membership. There has been some
7566 confusion about the way &(lsearch)& lookups work in lists. Because
7567 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7568 sometimes thought that it is allowed to contain wild cards and other kinds of
7569 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7570 always fixed strings, just as for any other single-key lookup type.
7571
7572 If you want to use a file to contain wild-card patterns that form part of a
7573 list, just give the file name on its own, without a search type, as described
7574 in the previous section. You could also use the &(wildlsearch)& or
7575 &(nwildlsearch)&, but there is no advantage in doing this.
7576
7577
7578
7579
7580 .section "Named lists" "SECTnamedlists"
7581 .cindex "named lists"
7582 .cindex "list" "named"
7583 A list of domains, hosts, email addresses, or local parts can be given a name
7584 which is then used to refer to the list elsewhere in the configuration. This is
7585 particularly convenient if the same list is required in several different
7586 places. It also allows lists to be given meaningful names, which can improve
7587 the readability of the configuration. For example, it is conventional to define
7588 a domain list called &'local_domains'& for all the domains that are handled
7589 locally on a host, using a configuration line such as
7590 .code
7591 domainlist local_domains = localhost:my.dom.example
7592 .endd
7593 Named lists are referenced by giving their name preceded by a plus sign, so,
7594 for example, a router that is intended to handle local domains would be
7595 configured with the line
7596 .code
7597 domains = +local_domains
7598 .endd
7599 The first router in a configuration is often one that handles all domains
7600 except the local ones, using a configuration with a negated item like this:
7601 .code
7602 dnslookup:
7603   driver = dnslookup
7604   domains = ! +local_domains
7605   transport = remote_smtp
7606   no_more
7607 .endd
7608 The four kinds of named list are created by configuration lines starting with
7609 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7610 respectively. Then there follows the name that you are defining, followed by an
7611 equals sign and the list itself. For example:
7612 .code
7613 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7614 addresslist bad_senders = cdb;/etc/badsenders
7615 .endd
7616 A named list may refer to other named lists:
7617 .code
7618 domainlist  dom1 = first.example : second.example
7619 domainlist  dom2 = +dom1 : third.example
7620 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7621 .endd
7622 &*Warning*&: If the last item in a referenced list is a negative one, the
7623 effect may not be what you intended, because the negation does not propagate
7624 out to the higher level. For example, consider:
7625 .code
7626 domainlist  dom1 = !a.b
7627 domainlist  dom2 = +dom1 : *.b
7628 .endd
7629 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7630 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7631 means it matches the second list as well. The effect is not the same as
7632 .code
7633 domainlist  dom2 = !a.b : *.b
7634 .endd
7635 where &'x.y'& does not match. It's best to avoid negation altogether in
7636 referenced lists if you can.
7637
7638 Named lists may have a performance advantage. When Exim is routing an
7639 address or checking an incoming message, it caches the result of tests on named
7640 lists. So, if you have a setting such as
7641 .code
7642 domains = +local_domains
7643 .endd
7644 on several of your routers
7645 or in several ACL statements,
7646 the actual test is done only for the first one. However, the caching works only
7647 if there are no expansions within the list itself or any sublists that it
7648 references. In other words, caching happens only for lists that are known to be
7649 the same each time they are referenced.
7650
7651 By default, there may be up to 16 named lists of each type. This limit can be
7652 extended by changing a compile-time variable. The use of domain and host lists
7653 is recommended for concepts such as local domains, relay domains, and relay
7654 hosts. The default configuration is set up like this.
7655
7656
7657
7658 .section "Named lists compared with macros" "SECID78"
7659 .cindex "list" "named compared with macro"
7660 .cindex "macro" "compared with named list"
7661 At first sight, named lists might seem to be no different from macros in the
7662 configuration file. However, macros are just textual substitutions. If you
7663 write
7664 .code
7665 ALIST = host1 : host2
7666 auth_advertise_hosts = !ALIST
7667 .endd
7668 it probably won't do what you want, because that is exactly the same as
7669 .code
7670 auth_advertise_hosts = !host1 : host2
7671 .endd
7672 Notice that the second host name is not negated. However, if you use a host
7673 list, and write
7674 .code
7675 hostlist alist = host1 : host2
7676 auth_advertise_hosts = ! +alist
7677 .endd
7678 the negation applies to the whole list, and so that is equivalent to
7679 .code
7680 auth_advertise_hosts = !host1 : !host2
7681 .endd
7682
7683
7684 .section "Named list caching" "SECID79"
7685 .cindex "list" "caching of named"
7686 .cindex "caching" "named lists"
7687 While processing a message, Exim caches the result of checking a named list if
7688 it is sure that the list is the same each time. In practice, this means that
7689 the cache operates only if the list contains no $ characters, which guarantees
7690 that it will not change when it is expanded. Sometimes, however, you may have
7691 an expanded list that you know will be the same each time within a given
7692 message. For example:
7693 .code
7694 domainlist special_domains = \
7695            ${lookup{$sender_host_address}cdb{/some/file}}
7696 .endd
7697 This provides a list of domains that depends only on the sending host's IP
7698 address. If this domain list is referenced a number of times (for example,
7699 in several ACL lines, or in several routers) the result of the check is not
7700 cached by default, because Exim does not know that it is going to be the
7701 same list each time.
7702
7703 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7704 cache the result anyway. For example:
7705 .code
7706 domainlist_cache special_domains = ${lookup{...
7707 .endd
7708 If you do this, you should be absolutely sure that caching is going to do
7709 the right thing in all cases. When in doubt, leave it out.
7710
7711
7712
7713 .section "Domain lists" "SECTdomainlist"
7714 .cindex "domain list" "patterns for"
7715 .cindex "list" "domain list"
7716 Domain lists contain patterns that are to be matched against a mail domain.
7717 The following types of item may appear in domain lists:
7718
7719 .ilist
7720 .cindex "primary host name"
7721 .cindex "host name" "matched in domain list"
7722 .oindex "&%primary_hostname%&"
7723 .cindex "domain list" "matching primary host name"
7724 .cindex "@ in a domain list"
7725 If a pattern consists of a single @ character, it matches the local host name,
7726 as set by the &%primary_hostname%& option (or defaulted). This makes it
7727 possible to use the same configuration file on several different hosts that
7728 differ only in their names.
7729 .next
7730 .cindex "@[] in a domain list"
7731 .cindex "domain list" "matching local IP interfaces"
7732 .cindex "domain literal"
7733 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7734 in square brackets (as in an email address that contains a domain literal), but
7735 only if that IP address is recognized as local for email routing purposes. The
7736 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7737 control which of a host's several IP addresses are treated as local.
7738 In today's Internet, the use of domain literals is controversial.
7739 .next
7740 .cindex "@mx_any"
7741 .cindex "@mx_primary"
7742 .cindex "@mx_secondary"
7743 .cindex "domain list" "matching MX pointers to local host"
7744 If a pattern consists of the string &`@mx_any`& it matches any domain that
7745 has an MX record pointing to the local host or to any host that is listed in
7746 .oindex "&%hosts_treat_as_local%&"
7747 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7748 are similar, except that the first matches only when a primary MX target is the
7749 local host, and the second only when no primary MX target is the local host,
7750 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7751 preference value &-- there may of course be more than one of them.
7752
7753 The MX lookup that takes place when matching a pattern of this type is
7754 performed with the resolver options for widening names turned off. Thus, for
7755 example, a single-component domain will &'not'& be expanded by adding the
7756 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7757 options of the &(dnslookup)& router for a discussion of domain widening.
7758
7759 Sometimes you may want to ignore certain IP addresses when using one of these
7760 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7761 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7762 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7763 on a router). For example:
7764 .code
7765 domains = @mx_any/ignore=127.0.0.1
7766 .endd
7767 This example matches any domain that has an MX record pointing to one of
7768 the local host's IP addresses other than 127.0.0.1.
7769
7770 The list of IP addresses is in fact processed by the same code that processes
7771 host lists, so it may contain CIDR-coded network specifications and it may also
7772 contain negative items.
7773
7774 Because the list of IP addresses is a sublist within a domain list, you have to
7775 be careful about delimiters if there is more than one address. Like any other
7776 list, the default delimiter can be changed. Thus, you might have:
7777 .code
7778 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7779           an.other.domain : ...
7780 .endd
7781 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7782 involved, it is easiest to change the delimiter for the main list as well:
7783 .code
7784 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7785           an.other.domain ? ...
7786 .endd
7787 .next
7788 .cindex "asterisk" "in domain list"
7789 .cindex "domain list" "asterisk in"
7790 .cindex "domain list" "matching &""ends with""&"
7791 If a pattern starts with an asterisk, the remaining characters of the pattern
7792 are compared with the terminating characters of the domain. The use of &"*"& in
7793 domain lists differs from its use in partial matching lookups. In a domain
7794 list, the character following the asterisk need not be a dot, whereas partial
7795 matching works only in terms of dot-separated components. For example, a domain
7796 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7797 &'cipher.key.ex'&.
7798
7799 .next
7800 .cindex "regular expressions" "in domain list"
7801 .cindex "domain list" "matching regular expression"
7802 If a pattern starts with a circumflex character, it is treated as a regular
7803 expression, and matched against the domain using a regular expression matching
7804 function. The circumflex is treated as part of the regular expression.
7805 Email domains are case-independent, so this regular expression match is by
7806 default case-independent, but you can make it case-dependent by starting it
7807 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7808 are given in chapter &<<CHAPregexp>>&.
7809
7810 &*Warning*&: Because domain lists are expanded before being processed, you
7811 must escape any backslash and dollar characters in the regular expression, or
7812 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7813 it is not to be expanded (unless you really do want to build a regular
7814 expression by expansion, of course).
7815 .next
7816 .cindex "lookup" "in domain list"
7817 .cindex "domain list" "matching by lookup"
7818 If a pattern starts with the name of a single-key lookup type followed by a
7819 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7820 must be a file name in a suitable format for the lookup type. For example, for
7821 &"cdb;"& it must be an absolute path:
7822 .code
7823 domains = cdb;/etc/mail/local_domains.cdb
7824 .endd
7825 The appropriate type of lookup is done on the file using the domain name as the
7826 key. In most cases, the data that is looked up is not used; Exim is interested
7827 only in whether or not the key is present in the file. However, when a lookup
7828 is used for the &%domains%& option on a router
7829 or a &%domains%& condition in an ACL statement, the data is preserved in the
7830 &$domain_data$& variable and can be referred to in other router options or
7831 other statements in the same ACL.
7832
7833 .next
7834 Any of the single-key lookup type names may be preceded by
7835 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7836 .code
7837 domains = partial-dbm;/partial/domains
7838 .endd
7839 This causes partial matching logic to be invoked; a description of how this
7840 works is given in section &<<SECTpartiallookup>>&.
7841
7842 .next
7843 .cindex "asterisk" "in lookup type"
7844 Any of the single-key lookup types may be followed by an asterisk. This causes
7845 a default lookup for a key consisting of a single asterisk to be done if the
7846 original lookup fails. This is not a useful feature when using a domain list to
7847 select particular domains (because any domain would match), but it might have
7848 value if the result of the lookup is being used via the &$domain_data$&
7849 expansion variable.
7850 .next
7851 If the pattern starts with the name of a query-style lookup type followed by a
7852 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7853 pattern must be an appropriate query for the lookup type, as described in
7854 chapter &<<CHAPfdlookup>>&. For example:
7855 .code
7856 hold_domains = mysql;select domain from holdlist \
7857   where domain = '${quote_mysql:$domain}';
7858 .endd
7859 In most cases, the data that is looked up is not used (so for an SQL query, for
7860 example, it doesn't matter what field you select). Exim is interested only in
7861 whether or not the query succeeds. However, when a lookup is used for the
7862 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7863 variable and can be referred to in other options.
7864 .next
7865 .cindex "domain list" "matching literal domain name"
7866 If none of the above cases apply, a caseless textual comparison is made
7867 between the pattern and the domain.
7868 .endlist
7869
7870 Here is an example that uses several different kinds of pattern:
7871 .code
7872 domainlist funny_domains = \
7873   @ : \
7874   lib.unseen.edu : \
7875   *.foundation.fict.example : \
7876   \N^[1-2]\d{3}\.fict\.example$\N : \
7877   partial-dbm;/opt/data/penguin/book : \
7878   nis;domains.byname : \
7879   nisplus;[name=$domain,status=local],domains.org_dir
7880 .endd
7881 There are obvious processing trade-offs among the various matching modes. Using
7882 an asterisk is faster than a regular expression, and listing a few names
7883 explicitly probably is too. The use of a file or database lookup is expensive,
7884 but may be the only option if hundreds of names are required. Because the
7885 patterns are tested in order, it makes sense to put the most commonly matched
7886 patterns earlier.
7887
7888
7889
7890 .section "Host lists" "SECThostlist"
7891 .cindex "host list" "patterns in"
7892 .cindex "list" "host list"
7893 Host lists are used to control what remote hosts are allowed to do. For
7894 example, some hosts may be allowed to use the local host as a relay, and some
7895 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7896 two different ways, by name or by IP address. In a host list, some types of
7897 pattern are matched to a host name, and some are matched to an IP address.
7898 You need to be particularly careful with this when single-key lookups are
7899 involved, to ensure that the right value is being used as the key.
7900
7901
7902 .section "Special host list patterns" "SECID80"
7903 .cindex "empty item in hosts list"
7904 .cindex "host list" "empty string in"
7905 If a host list item is the empty string, it matches only when no remote host is
7906 involved. This is the case when a message is being received from a local
7907 process using SMTP on the standard input, that is, when a TCP/IP connection is
7908 not used.
7909
7910 .cindex "asterisk" "in host list"
7911 The special pattern &"*"& in a host list matches any host or no host. Neither
7912 the IP address nor the name is actually inspected.
7913
7914
7915
7916 .section "Host list patterns that match by IP address" "SECThoslispatip"
7917 .cindex "host list" "matching IP addresses"
7918 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7919 the incoming address actually appears in the IPv6 host as
7920 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7921 list, it is converted into a traditional IPv4 address first. (Not all operating
7922 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7923 concerns.)
7924
7925 The following types of pattern in a host list check the remote host by
7926 inspecting its IP address:
7927
7928 .ilist
7929 If the pattern is a plain domain name (not a regular expression, not starting
7930 with *, not a lookup of any kind), Exim calls the operating system function
7931 to find the associated IP address(es). Exim uses the newer
7932 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7933 This typically causes a forward DNS lookup of the name. The result is compared
7934 with the IP address of the subject host.
7935
7936 If there is a temporary problem (such as a DNS timeout) with the host name
7937 lookup, a temporary error occurs. For example, if the list is being used in an
7938 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7939 temporary SMTP error code. If no IP address can be found for the host name,
7940 what happens is described in section &<<SECTbehipnot>>& below.
7941
7942 .next
7943 .cindex "@ in a host list"
7944 If the pattern is &"@"&, the primary host name is substituted and used as a
7945 domain name, as just described.
7946
7947 .next
7948 If the pattern is an IP address, it is matched against the IP address of the
7949 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7950 IPv6 addresses can be given in colon-separated format, but the colons have to
7951 be doubled so as not to be taken as item separators when the default list
7952 separator is used. IPv6 addresses are recognized even when Exim is compiled
7953 without IPv6 support. This means that if they appear in a host list on an
7954 IPv4-only host, Exim will not treat them as host names. They are just addresses
7955 that can never match a client host.
7956
7957 .next
7958 .cindex "@[] in a host list"
7959 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7960 the local host. For example, if the local host is an IPv4 host with one
7961 interface address 10.45.23.56, these two ACL statements have the same effect:
7962 .code
7963 accept hosts = 127.0.0.1 : 10.45.23.56
7964 accept hosts = @[]
7965 .endd
7966 .next
7967 .cindex "CIDR notation"
7968 If the pattern is an IP address followed by a slash and a mask length (for
7969 example 10.11.42.0/24), it is matched against the IP address of the subject
7970 host under the given mask. This allows, an entire network of hosts to be
7971 included (or excluded) by a single item. The mask uses CIDR notation; it
7972 specifies the number of address bits that must match, starting from the most
7973 significant end of the address.
7974
7975 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7976 of a range of addresses. It is the number of bits in the network portion of the
7977 address. The above example specifies a 24-bit netmask, so it matches all 256
7978 addresses in the 10.11.42.0 network. An item such as
7979 .code
7980 192.168.23.236/31
7981 .endd
7982 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7983 32 for an IPv4 address is the same as no mask at all; just a single address
7984 matches.
7985
7986 Here is another example which shows an IPv4 and an IPv6 network:
7987 .code
7988 recipient_unqualified_hosts = 192.168.0.0/16: \
7989                               3ffe::ffff::836f::::/48
7990 .endd
7991 The doubling of list separator characters applies only when these items
7992 appear inline in a host list. It is not required when indirecting via a file.
7993 For example:
7994 .code
7995 recipient_unqualified_hosts = /opt/exim/unqualnets
7996 .endd
7997 could make use of a file containing
7998 .code
7999 172.16.0.0/12
8000 3ffe:ffff:836f::/48
8001 .endd
8002 to have exactly the same effect as the previous example. When listing IPv6
8003 addresses inline, it is usually more convenient to use the facility for
8004 changing separator characters. This list contains the same two networks:
8005 .code
8006 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8007                                  3ffe:ffff:836f::/48
8008 .endd
8009 The separator is changed to semicolon by the leading &"<;"& at the start of the
8010 list.
8011 .endlist
8012
8013
8014
8015 .section "Host list patterns for single-key lookups by host address" &&&
8016          "SECThoslispatsikey"
8017 .cindex "host list" "lookup of IP address"
8018 When a host is to be identified by a single-key lookup of its complete IP
8019 address, the pattern takes this form:
8020 .display
8021 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8022 .endd
8023 For example:
8024 .code
8025 hosts_lookup = net-cdb;/hosts-by-ip.db
8026 .endd
8027 The text form of the IP address of the subject host is used as the lookup key.
8028 IPv6 addresses are converted to an unabbreviated form, using lower case
8029 letters, with dots as separators because colon is the key terminator in
8030 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8031 quoting the keys, but this is a facility that was added later.] The data
8032 returned by the lookup is not used.
8033
8034 .cindex "IP address" "masking"
8035 .cindex "host list" "masked IP address"
8036 Single-key lookups can also be performed using masked IP addresses, using
8037 patterns of this form:
8038 .display
8039 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8040 .endd
8041 For example:
8042 .code
8043 net24-dbm;/networks.db
8044 .endd
8045 The IP address of the subject host is masked using <&'number'&> as the mask
8046 length. A textual string is constructed from the masked value, followed by the
8047 mask, and this is used as the lookup key. For example, if the host's IP address
8048 is 192.168.34.6, the key that is looked up for the above example is
8049 &"192.168.34.0/24"&.
8050
8051 When an IPv6 address is converted to a string, dots are normally used instead
8052 of colons, so that keys in &(lsearch)& files need not contain colons (which
8053 terminate &(lsearch)& keys). This was implemented some time before the ability
8054 to quote keys was made available in &(lsearch)& files. However, the more
8055 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8056 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8057 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8058 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8059 addresses are always used.
8060
8061 Ideally, it would be nice to tidy up this anomalous situation by changing to
8062 colons in all cases, given that quoting is now available for &(lsearch)&.
8063 However, this would be an incompatible change that might break some existing
8064 configurations.
8065
8066 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8067 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8068 the former case the key strings include the mask value, whereas in the latter
8069 case the IP address is used on its own.
8070
8071
8072
8073 .section "Host list patterns that match by host name" "SECThoslispatnam"
8074 .cindex "host" "lookup failures"
8075 .cindex "unknown host name"
8076 .cindex "host list" "matching host name"
8077 There are several types of pattern that require Exim to know the name of the
8078 remote host. These are either wildcard patterns or lookups by name. (If a
8079 complete hostname is given without any wildcarding, it is used to find an IP
8080 address to match against, as described in the section &<<SECThoslispatip>>&
8081 above.)
8082
8083 If the remote host name is not already known when Exim encounters one of these
8084 patterns, it has to be found from the IP address.
8085 Although many sites on the Internet are conscientious about maintaining reverse
8086 DNS data for their hosts, there are also many that do not do this.
8087 Consequently, a name cannot always be found, and this may lead to unwanted
8088 effects. Take care when configuring host lists with wildcarded name patterns.
8089 Consider what will happen if a name cannot be found.
8090
8091 Because of the problems of determining host names from IP addresses, matching
8092 against host names is not as common as matching against IP addresses.
8093
8094 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8095 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8096 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8097 are done can be changed by setting the &%host_lookup_order%& option. For
8098 security, once Exim has found one or more names, it looks up the IP addresses
8099 for these names and compares them with the IP address that it started with.
8100 Only those names whose IP addresses match are accepted. Any other names are
8101 discarded. If no names are left, Exim behaves as if the host name cannot be
8102 found. In the most common case there is only one name and one IP address.
8103
8104 There are some options that control what happens if a host name cannot be
8105 found. These are described in section &<<SECTbehipnot>>& below.
8106
8107 .cindex "host" "alias for"
8108 .cindex "alias for host"
8109 As a result of aliasing, hosts may have more than one name. When processing any
8110 of the following types of pattern, all the host's names are checked:
8111
8112 .ilist
8113 .cindex "asterisk" "in host list"
8114 If a pattern starts with &"*"& the remainder of the item must match the end of
8115 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8116 &'.b.c'&. This special simple form is provided because this is a very common
8117 requirement. Other kinds of wildcarding require the use of a regular
8118 expression.
8119 .next
8120 .cindex "regular expressions" "in host list"
8121 .cindex "host list" "regular expression in"
8122 If the item starts with &"^"& it is taken to be a regular expression which is
8123 matched against the host name. Host names are case-independent, so this regular
8124 expression match is by default case-independent, but you can make it
8125 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8126 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8127 example,
8128 .code
8129 ^(a|b)\.c\.d$
8130 .endd
8131 is a regular expression that matches either of the two hosts &'a.c.d'& or
8132 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8133 that backslash and dollar characters are not misinterpreted as part of the
8134 string expansion. The simplest way to do this is to use &`\N`& to mark that
8135 part of the string as non-expandable. For example:
8136 .code
8137 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8138 .endd
8139 &*Warning*&: If you want to match a complete host name, you must include the
8140 &`$`& terminating metacharacter in the regular expression, as in the above
8141 example. Without it, a match at the start of the host name is all that is
8142 required.
8143 .endlist
8144
8145
8146
8147
8148 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8149 .cindex "host" "lookup failures, permanent"
8150 While processing a host list, Exim may need to look up an IP address from a
8151 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8152 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8153 behaviour when it fails to find the information it is seeking is the same.
8154
8155 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8156 apply to temporary DNS errors, whose handling is described in the next section.
8157
8158 .cindex "&`+include_unknown`&"
8159 .cindex "&`+ignore_unknown`&"
8160 By default, Exim behaves as if the host does not match the list. This may not
8161 always be what you want to happen. To change Exim's behaviour, the special
8162 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8163 top level &-- they are not recognized in an indirected file).
8164
8165 .ilist
8166 If any item that follows &`+include_unknown`& requires information that
8167 cannot found, Exim behaves as if the host does match the list. For example,
8168 .code
8169 host_reject_connection = +include_unknown:*.enemy.ex
8170 .endd
8171 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8172 any hosts whose name it cannot find.
8173
8174 .next
8175 If any item that follows &`+ignore_unknown`& requires information that cannot
8176 be found, Exim ignores that item and proceeds to the rest of the list. For
8177 example:
8178 .code
8179 accept hosts = +ignore_unknown : friend.example : \
8180                192.168.4.5
8181 .endd
8182 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8183 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8184 name can be found for 192.168.4.5, it is rejected.
8185 .endlist
8186
8187 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8188 list. The effect of each one lasts until the next, or until the end of the
8189 list.
8190
8191
8192 .section "Temporary DNS errors when looking up host information" &&&
8193          "SECTtemdnserr"
8194 .cindex "host" "lookup failures, temporary"
8195 .cindex "&`+include_defer`&"
8196 .cindex "&`+ignore_defer`&"
8197 A temporary DNS lookup failure normally causes a defer action (except when
8198 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8199 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8200 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8201 section. These options should be used with care, probably only in non-critical
8202 host lists such as whitelists.
8203
8204
8205
8206 .section "Host list patterns for single-key lookups by host name" &&&
8207          "SECThoslispatnamsk"
8208 .cindex "unknown host name"
8209 .cindex "host list" "matching host name"
8210 If a pattern is of the form
8211 .display
8212 <&'single-key-search-type'&>;<&'search-data'&>
8213 .endd
8214 for example
8215 .code
8216 dbm;/host/accept/list
8217 .endd
8218 a single-key lookup is performed, using the host name as its key. If the
8219 lookup succeeds, the host matches the item. The actual data that is looked up
8220 is not used.
8221
8222 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8223 keys in the file, not IP addresses. If you want to do lookups based on IP
8224 addresses, you must precede the search type with &"net-"& (see section
8225 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8226 two items in the same list, one doing an address lookup and one doing a name
8227 lookup, both using the same file.
8228
8229
8230
8231 .section "Host list patterns for query-style lookups" "SECID81"
8232 If a pattern is of the form
8233 .display
8234 <&'query-style-search-type'&>;<&'query'&>
8235 .endd
8236 the query is obeyed, and if it succeeds, the host matches the item. The actual
8237 data that is looked up is not used. The variables &$sender_host_address$& and
8238 &$sender_host_name$& can be used in the query. For example:
8239 .code
8240 hosts_lookup = pgsql;\
8241   select ip from hostlist where ip='$sender_host_address'
8242 .endd
8243 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8244 can use the &%sg%& expansion item to change this if you need to. If you want to
8245 use masked IP addresses in database queries, you can use the &%mask%& expansion
8246 operator.
8247
8248 If the query contains a reference to &$sender_host_name$&, Exim automatically
8249 looks up the host name if has not already done so. (See section
8250 &<<SECThoslispatnam>>& for comments on finding host names.)
8251
8252 Historical note: prior to release 4.30, Exim would always attempt to find a
8253 host name before running the query, unless the search type was preceded by
8254 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8255 still recognized for query-style lookups, but its presence or absence has no
8256 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8257 See section &<<SECThoslispatsikey>>&.)
8258
8259
8260
8261 .section "Mixing wildcarded host names and addresses in host lists" &&&
8262          "SECTmixwilhos"
8263 .cindex "host list" "mixing names and addresses in"
8264 If you have name lookups or wildcarded host names and IP addresses in the same
8265 host list, you should normally put the IP addresses first. For example, in an
8266 ACL you could have:
8267 .code
8268 accept hosts = 10.9.8.7 : *.friend.example
8269 .endd
8270 The reason for this lies in the left-to-right way that Exim processes lists.
8271 It can test IP addresses without doing any DNS lookups, but when it reaches an
8272 item that requires a host name, it fails if it cannot find a host name to
8273 compare with the pattern. If the above list is given in the opposite order, the
8274 &%accept%& statement fails for a host whose name cannot be found, even if its
8275 IP address is 10.9.8.7.
8276
8277 If you really do want to do the name check first, and still recognize the IP
8278 address, you can rewrite the ACL like this:
8279 .code
8280 accept hosts = *.friend.example
8281 accept hosts = 10.9.8.7
8282 .endd
8283 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8284 &<<CHAPACL>>& for details of ACLs.
8285
8286
8287
8288
8289
8290 .section "Address lists" "SECTaddresslist"
8291 .cindex "list" "address list"
8292 .cindex "address list" "empty item"
8293 .cindex "address list" "patterns"
8294 Address lists contain patterns that are matched against mail addresses. There
8295 is one special case to be considered: the sender address of a bounce message is
8296 always empty. You can test for this by providing an empty item in an address
8297 list. For example, you can set up a router to process bounce messages by
8298 using this option setting:
8299 .code
8300 senders = :
8301 .endd
8302 The presence of the colon creates an empty item. If you do not provide any
8303 data, the list is empty and matches nothing. The empty sender can also be
8304 detected by a regular expression that matches an empty string,
8305 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8306
8307 Non-empty items in an address list can be straightforward email addresses. For
8308 example:
8309 .code
8310 senders = jbc@askone.example : hs@anacreon.example
8311 .endd
8312 A certain amount of wildcarding is permitted. If a pattern contains an @
8313 character, but is not a regular expression and does not begin with a
8314 semicolon-terminated lookup type (described below), the local part of the
8315 subject address is compared with the local part of the pattern, which may start
8316 with an asterisk. If the local parts match, the domain is checked in exactly
8317 the same way as for a pattern in a domain list. For example, the domain can be
8318 wildcarded, refer to a named list, or be a lookup:
8319 .code
8320 deny senders = *@*.spamming.site:\
8321                *@+hostile_domains:\
8322                bozo@partial-lsearch;/list/of/dodgy/sites:\
8323                *@dbm;/bad/domains.db
8324 .endd
8325 .cindex "local part" "starting with !"
8326 .cindex "address list" "local part starting with !"
8327 If a local part that begins with an exclamation mark is required, it has to be
8328 specified using a regular expression, because otherwise the exclamation mark is
8329 treated as a sign of negation, as is standard in lists.
8330
8331 If a non-empty pattern that is not a regular expression or a lookup does not
8332 contain an @ character, it is matched against the domain part of the subject
8333 address. The only two formats that are recognized this way are a literal
8334 domain, or a domain pattern that starts with *. In both these cases, the effect
8335 is the same as if &`*@`& preceded the pattern. For example:
8336 .code
8337 deny senders = enemy.domain : *.enemy.domain
8338 .endd
8339
8340 The following kinds of more complicated address list pattern can match any
8341 address, including the empty address that is characteristic of bounce message
8342 senders:
8343
8344 .ilist
8345 .cindex "regular expressions" "in address list"
8346 .cindex "address list" "regular expression in"
8347 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8348 done against the complete address, with the pattern as the regular expression.
8349 You must take care that backslash and dollar characters are not misinterpreted
8350 as part of the string expansion. The simplest way to do this is to use &`\N`&
8351 to mark that part of the string as non-expandable. For example:
8352 .code
8353 deny senders = \N^.*this.*@example\.com$\N : \
8354                \N^\d{8}.+@spamhaus.example$\N : ...
8355 .endd
8356 The &`\N`& sequences are removed by the expansion, so these items do indeed
8357 start with &"^"& by the time they are being interpreted as address patterns.
8358
8359 .next
8360 .cindex "address list" "lookup for complete address"
8361 Complete addresses can be looked up by using a pattern that starts with a
8362 lookup type terminated by a semicolon, followed by the data for the lookup. For
8363 example:
8364 .code
8365 deny senders = cdb;/etc/blocked.senders : \
8366   mysql;select address from blocked where \
8367   address='${quote_mysql:$sender_address}'
8368 .endd
8369 Both query-style and single-key lookup types can be used. For a single-key
8370 lookup type, Exim uses the complete address as the key. However, empty keys are
8371 not supported for single-key lookups, so a match against the empty address
8372 always fails. This restriction does not apply to query-style lookups.
8373
8374 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8375 cannot be used, and is ignored if specified, with an entry being written to the
8376 panic log.
8377 .cindex "*@ with single-key lookup"
8378 However, you can configure lookup defaults, as described in section
8379 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8380 default. For example, with this lookup:
8381 .code
8382 accept senders = lsearch*@;/some/file
8383 .endd
8384 the file could contains lines like this:
8385 .code
8386 user1@domain1.example
8387 *@domain2.example
8388 .endd
8389 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8390 that are tried is:
8391 .code
8392 nimrod@jaeger.example
8393 *@jaeger.example
8394 *
8395 .endd
8396 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8397 would mean that every address matches, thus rendering the test useless.
8398
8399 &*Warning 2*&: Do not confuse these two kinds of item:
8400 .code
8401 deny recipients = dbm*@;/some/file
8402 deny recipients = *@dbm;/some/file
8403 .endd
8404 The first does a whole address lookup, with defaulting, as just described,
8405 because it starts with a lookup type. The second matches the local part and
8406 domain independently, as described in a bullet point below.
8407 .endlist
8408
8409
8410 The following kinds of address list pattern can match only non-empty addresses.
8411 If the subject address is empty, a match against any of these pattern types
8412 always fails.
8413
8414
8415 .ilist
8416 .cindex "@@ with single-key lookup"
8417 .cindex "address list" "@@ lookup type"
8418 .cindex "address list" "split local part and domain"
8419 If a pattern starts with &"@@"& followed by a single-key lookup item
8420 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8421 split into a local part and a domain. The domain is looked up in the file. If
8422 it is not found, there is no match. If it is found, the data that is looked up
8423 from the file is treated as a colon-separated list of local part patterns, each
8424 of which is matched against the subject local part in turn.
8425
8426 .cindex "asterisk" "in address list"
8427 The lookup may be a partial one, and/or one involving a search for a default
8428 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8429 patterns that are looked up can be regular expressions or begin with &"*"&, or
8430 even be further lookups. They may also be independently negated. For example,
8431 with
8432 .code
8433 deny senders = @@dbm;/etc/reject-by-domain
8434 .endd
8435 the data from which the DBM file is built could contain lines like
8436 .code
8437 baddomain.com:  !postmaster : *
8438 .endd
8439 to reject all senders except &%postmaster%& from that domain.
8440
8441 .cindex "local part" "starting with !"
8442 If a local part that actually begins with an exclamation mark is required, it
8443 has to be specified using a regular expression. In &(lsearch)& files, an entry
8444 may be split over several lines by indenting the second and subsequent lines,
8445 but the separating colon must still be included at line breaks. White space
8446 surrounding the colons is ignored. For example:
8447 .code
8448 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8449 spammer3 : spammer4
8450 .endd
8451 As in all colon-separated lists in Exim, a colon can be included in an item by
8452 doubling.
8453
8454 If the last item in the list starts with a right angle-bracket, the remainder
8455 of the item is taken as a new key to look up in order to obtain a continuation
8456 list of local parts. The new key can be any sequence of characters. Thus one
8457 might have entries like
8458 .code
8459 aol.com: spammer1 : spammer 2 : >*
8460 xyz.com: spammer3 : >*
8461 *:       ^\d{8}$
8462 .endd
8463 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8464 local parts for all domains, in addition to the specific local parts listed for
8465 each domain. Of course, using this feature costs another lookup each time a
8466 chain is followed, but the effort needed to maintain the data is reduced.
8467
8468 .cindex "loop" "in lookups"
8469 It is possible to construct loops using this facility, and in order to catch
8470 them, the chains may be no more than fifty items long.
8471
8472 .next
8473 The @@<&'lookup'&> style of item can also be used with a query-style
8474 lookup, but in this case, the chaining facility is not available. The lookup
8475 can only return a single list of local parts.
8476 .endlist
8477
8478 &*Warning*&: There is an important difference between the address list items
8479 in these two examples:
8480 .code
8481 senders = +my_list
8482 senders = *@+my_list
8483 .endd
8484 In the first one, &`my_list`& is a named address list, whereas in the second
8485 example it is a named domain list.
8486
8487
8488
8489
8490 .section "Case of letters in address lists" "SECTcasletadd"
8491 .cindex "case of local parts"
8492 .cindex "address list" "case forcing"
8493 .cindex "case forcing in address lists"
8494 Domains in email addresses are always handled caselessly, but for local parts
8495 case may be significant on some systems (see &%caseful_local_part%& for how
8496 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8497 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8498 blocking lists should be done in a case-independent manner. Since most address
8499 lists in Exim are used for this kind of control, Exim attempts to do this by
8500 default.
8501
8502 The domain portion of an address is always lowercased before matching it to an
8503 address list. The local part is lowercased by default, and any string
8504 comparisons that take place are done caselessly. This means that the data in
8505 the address list itself, in files included as plain file names, and in any file
8506 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8507 keys in files that are looked up by a search type other than &(lsearch)& (which
8508 works caselessly) must be in lower case, because these lookups are not
8509 case-independent.
8510
8511 .cindex "&`+caseful`&"
8512 To allow for the possibility of caseful address list matching, if an item in
8513 an address list is the string &"+caseful"&, the original case of the local
8514 part is restored for any comparisons that follow, and string comparisons are no
8515 longer case-independent. This does not affect the domain, which remains in
8516 lower case. However, although independent matches on the domain alone are still
8517 performed caselessly, regular expressions that match against an entire address
8518 become case-sensitive after &"+caseful"& has been seen.
8519
8520
8521
8522 .section "Local part lists" "SECTlocparlis"
8523 .cindex "list" "local part list"
8524 .cindex "local part" "list"
8525 Case-sensitivity in local part lists is handled in the same way as for address
8526 lists, as just described. The &"+caseful"& item can be used if required. In a
8527 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8528 set false, the subject is lowercased and the matching is initially
8529 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8530 matching in the local part list, but not elsewhere in the router. If
8531 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8532 option is case-sensitive from the start.
8533
8534 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8535 comments are handled in the same way as address lists &-- they are recognized
8536 only if the # is preceded by white space or the start of the line.
8537 Otherwise, local part lists are matched in the same way as domain lists, except
8538 that the special items that refer to the local host (&`@`&, &`@[]`&,
8539 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8540 Refer to section &<<SECTdomainlist>>& for details of the other available item
8541 types.
8542 .ecindex IIDdohoadli
8543
8544
8545
8546
8547 . ////////////////////////////////////////////////////////////////////////////
8548 . ////////////////////////////////////////////////////////////////////////////
8549
8550 .chapter "String expansions" "CHAPexpand"
8551 .scindex IIDstrexp "expansion" "of strings"
8552 Many strings in Exim's run time configuration are expanded before use. Some of
8553 them are expanded every time they are used; others are expanded only once.
8554
8555 When a string is being expanded it is copied verbatim from left to right except
8556 when a dollar or backslash character is encountered. A dollar specifies the
8557 start of a portion of the string that is interpreted and replaced as described
8558 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8559 escape character, as described in the following section.
8560
8561 Whether a string is expanded depends upon the context.  Usually this is solely
8562 dependent upon the option for which a value is sought; in this documentation,
8563 options for which string expansion is performed are marked with &dagger; after
8564 the data type.  ACL rules always expand strings.  A couple of expansion
8565 conditions do not expand some of the brace-delimited branches, for security
8566 reasons.
8567
8568
8569
8570 .section "Literal text in expanded strings" "SECTlittext"
8571 .cindex "expansion" "including literal text"
8572 An uninterpreted dollar can be included in an expanded string by putting a
8573 backslash in front of it. A backslash can be used to prevent any special
8574 character being treated specially in an expansion, including backslash itself.
8575 If the string appears in quotes in the configuration file, two backslashes are
8576 required because the quotes themselves cause interpretation of backslashes when
8577 the string is read in (see section &<<SECTstrings>>&).
8578
8579 .cindex "expansion" "non-expandable substrings"
8580 A portion of the string can specified as non-expandable by placing it between
8581 two occurrences of &`\N`&. This is particularly useful for protecting regular
8582 expressions, which often contain backslashes and dollar signs. For example:
8583 .code
8584 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8585 .endd
8586 On encountering the first &`\N`&, the expander copies subsequent characters
8587 without interpretation until it reaches the next &`\N`& or the end of the
8588 string.
8589
8590
8591
8592 .section "Character escape sequences in expanded strings" "SECID82"
8593 .cindex "expansion" "escape sequences"
8594 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8595 expanded string is recognized as an escape sequence for the character newline,
8596 carriage return, or tab, respectively. A backslash followed by up to three
8597 octal digits is recognized as an octal encoding for a single character, and a
8598 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8599 encoding.
8600
8601 These escape sequences are also recognized in quoted strings when they are read
8602 in. Their interpretation in expansions as well is useful for unquoted strings,
8603 and for other cases such as looked-up strings that are then expanded.
8604
8605
8606 .section "Testing string expansions" "SECID83"
8607 .cindex "expansion" "testing"
8608 .cindex "testing" "string expansion"
8609 .oindex "&%-be%&"
8610 Many expansions can be tested by calling Exim with the &%-be%& option. This
8611 takes the command arguments, or lines from the standard input if there are no
8612 arguments, runs them through the string expansion code, and writes the results
8613 to the standard output. Variables based on configuration values are set up, but
8614 since no message is being processed, variables such as &$local_part$& have no
8615 value. Nevertheless the &%-be%& option can be useful for checking out file and
8616 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8617 and &%nhash%&.
8618
8619 Exim gives up its root privilege when it is called with the &%-be%& option, and
8620 instead runs under the uid and gid it was called with, to prevent users from
8621 using &%-be%& for reading files to which they do not have access.
8622
8623 .oindex "&%-bem%&"
8624 If you want to test expansions that include variables whose values are taken
8625 from a message, there are two other options that can be used. The &%-bem%&
8626 option is like &%-be%& except that it is followed by a file name. The file is
8627 read as a message before doing the test expansions. For example:
8628 .code
8629 exim -bem /tmp/test.message '$h_subject:'
8630 .endd
8631 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8632 Exim message identifier. For example:
8633 .code
8634 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8635 .endd
8636 This loads the message from Exim's spool before doing the test expansions, and
8637 is therefore restricted to admin users.
8638
8639
8640 .section "Forced expansion failure" "SECTforexpfai"
8641 .cindex "expansion" "forced failure"
8642 A number of expansions that are described in the following section have
8643 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8644 (which are sometimes called &"curly brackets"&). Which of the two strings is
8645 used depends on some condition that is evaluated as part of the expansion. If,
8646 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8647 the entire string expansion fails in a way that can be detected by the code
8648 that requested the expansion. This is called &"forced expansion failure"&, and
8649 its consequences depend on the circumstances. In some cases it is no different
8650 from any other expansion failure, but in others a different action may be
8651 taken. Such variations are mentioned in the documentation of the option that is
8652 being expanded.
8653
8654
8655
8656
8657 .section "Expansion items" "SECTexpansionitems"
8658 The following items are recognized in expanded strings. White space may be used
8659 between sub-items that are keywords or substrings enclosed in braces inside an
8660 outer set of braces, to improve readability. &*Warning*&: Within braces,
8661 white space is significant.
8662
8663 .vlist
8664 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8665 .cindex "expansion" "variables"
8666 Substitute the contents of the named variable, for example:
8667 .code
8668 $local_part
8669 ${domain}
8670 .endd
8671 The second form can be used to separate the name from subsequent alphanumeric
8672 characters. This form (using braces) is available only for variables; it does
8673 &'not'& apply to message headers. The names of the variables are given in
8674 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8675 given, the expansion fails.
8676
8677 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8678 .cindex "expansion" "operators"
8679 The string is first itself expanded, and then the operation specified by
8680 <&'op'&> is applied to it. For example:
8681 .code
8682 ${lc:$local_part}
8683 .endd
8684 The string starts with the first character after the colon, which may be
8685 leading white space. A list of operators is given in section &<<SECTexpop>>&
8686 below. The operator notation is used for simple expansion items that have just
8687 one argument, because it reduces the number of braces and therefore makes the
8688 string easier to understand.
8689
8690 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8691 This item inserts &"basic"& header lines. It is described with the &%header%&
8692 expansion item below.
8693
8694 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8695        {*&<&'arg'&>&*}...}*&"
8696 .cindex &%dlfunc%&
8697 This expansion dynamically loads and then calls a locally-written C function.
8698 This functionality is available only if Exim is compiled with
8699 .code
8700 EXPAND_DLFUNC=yes
8701 .endd
8702 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8703 object so that it doesn't reload the same object file in the same Exim process
8704 (but of course Exim does start new processes frequently).
8705
8706 There may be from zero to eight arguments to the function. When compiling
8707 a local function that is to be called in this way, &_local_scan.h_& should be
8708 included. The Exim variables and functions that are defined by that API
8709 are also available for dynamically loaded functions. The function itself
8710 must have the following type:
8711 .code
8712 int dlfunction(uschar **yield, int argc, uschar *argv[])
8713 .endd
8714 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8715 function should return one of the following values:
8716
8717 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8718 into the expanded string that is being built.
8719
8720 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8721 from &'yield'&, if it is set.
8722
8723 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8724 taken from &'yield'& if it is set.
8725
8726 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8727
8728 When compiling a function that is to be used in this way with gcc,
8729 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8730 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8731
8732 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8733        {*&<&'string3'&>&*}}*&"
8734 .cindex "expansion" "extracting substrings by key"
8735 .cindex "&%extract%&" "substrings by key"
8736 The key and <&'string1'&> are first expanded separately. Leading and trailing
8737 white space is removed from the key (but not from any of the strings). The key
8738 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8739 form:
8740 .display
8741 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8742 .endd
8743 .vindex "&$value$&"
8744 where the equals signs and spaces (but not both) are optional. If any of the
8745 values contain white space, they must be enclosed in double quotes, and any
8746 values that are enclosed in double quotes are subject to escape processing as
8747 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8748 for the value that corresponds to the key. The search is case-insensitive. If
8749 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8750 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8751 variable &$value$& contains the value that has been extracted. Afterwards, it
8752 is restored to any previous value it might have had.
8753
8754 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8755 key is not found. If {<&'string2'&>} is also omitted, the value that was
8756 extracted is used. Thus, for example, these two expansions are identical, and
8757 yield &"2001"&:
8758 .code
8759 ${extract{gid}{uid=1984 gid=2001}}
8760 ${extract{gid}{uid=1984 gid=2001}{$value}}
8761 .endd
8762 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8763 appear, for example:
8764 .code
8765 ${extract{Z}{A=... B=...}{$value} fail }
8766 .endd
8767 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8768 {<&'string2'&>} must be present for &"fail"& to be recognized.
8769
8770
8771 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8772         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8773 .cindex "expansion" "extracting substrings by number"
8774 .cindex "&%extract%&" "substrings by number"
8775 The <&'number'&> argument must consist entirely of decimal digits,
8776 apart from leading and trailing white space, which is ignored.
8777 This is what distinguishes this form of &%extract%& from the previous kind. It
8778 behaves in the same way, except that, instead of extracting a named field, it
8779 extracts from <&'string1'&> the field whose number is given as the first
8780 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8781 <&'string3'&> as before.
8782
8783 The fields in the string are separated by any one of the characters in the
8784 separator string. These may include space or tab characters.
8785 The first field is numbered one. If the number is negative, the fields are
8786 counted from the end of the string, with the rightmost one numbered -1. If the
8787 number given is zero, the entire string is returned. If the modulus of the
8788 number is greater than the number of fields in the string, the result is the
8789 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8790 provided. For example:
8791 .code
8792 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8793 .endd
8794 yields &"42"&, and
8795 .code
8796 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8797 .endd
8798 yields &"99"&. Two successive separators mean that the field between them is
8799 empty (for example, the fifth field above).
8800
8801
8802 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8803 .cindex "list" "selecting by condition"
8804 .cindex "expansion" "selecting from list by condition"
8805 .vindex "&$item$&"
8806 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8807 default, but the separator can be changed in the usual way. For each item
8808 in this list, its value is place in &$item$&, and then the condition is
8809 evaluated. If the condition is true, &$item$& is added to the output as an
8810 item in a new list; if the condition is false, the item is discarded. The
8811 separator used for the output list is the same as the one used for the
8812 input, but a separator setting is not included in the output. For example:
8813 .code
8814 ${filter{a:b:c}{!eq{$item}{b}}
8815 .endd
8816 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8817 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8818
8819
8820 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8821 .cindex "hash function" "textual"
8822 .cindex "expansion" "textual hash"
8823 This is a textual hashing function, and was the first to be implemented in
8824 early versions of Exim. In current releases, there are other hashing functions
8825 (numeric, MD5, and SHA-1), which are described below.
8826
8827 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8828 <&'n'&>. If you are using fixed values for these numbers, that is, if
8829 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8830 use the simpler operator notation that avoids some of the braces:
8831 .code
8832 ${hash_<n>_<m>:<string>}
8833 .endd
8834 The second number is optional (in both notations). If <&'n'&> is greater than
8835 or equal to the length of the string, the expansion item returns the string.
8836 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8837 function to the string. The new string consists of characters taken from the
8838 first <&'m'&> characters of the string
8839 .code
8840 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8841 .endd
8842 If <&'m'&> is not present the value 26 is used, so that only lower case
8843 letters appear. For example:
8844 .display
8845 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8846 &`$hash{5}{monty}}           `&   yields  &`monty`&
8847 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8848 .endd
8849
8850 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8851         &*$h_*&<&'header&~name'&>&*:*&" &&&
8852        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8853         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8854        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8855         &*$rh_*&<&'header&~name'&>&*:*&"
8856 .cindex "expansion" "header insertion"
8857 .vindex "&$header_$&"
8858 .vindex "&$bheader_$&"
8859 .vindex "&$rheader_$&"
8860 .cindex "header lines" "in expansion strings"
8861 .cindex "header lines" "character sets"
8862 .cindex "header lines" "decoding"
8863 Substitute the contents of the named message header line, for example
8864 .code
8865 $header_reply-to:
8866 .endd
8867 The newline that terminates a header line is not included in the expansion, but
8868 internal newlines (caused by splitting the header line over several physical
8869 lines) may be present.
8870
8871 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8872 the data in the header line is interpreted.
8873
8874 .ilist
8875 .cindex "white space" "in header lines"
8876 &%rheader%& gives the original &"raw"& content of the header line, with no
8877 processing at all, and without the removal of leading and trailing white space.
8878
8879 .next
8880 .cindex "base64 encoding" "in header lines"
8881 &%bheader%& removes leading and trailing white space, and then decodes base64
8882 or quoted-printable MIME &"words"& within the header text, but does no
8883 character set translation. If decoding of what looks superficially like a MIME
8884 &"word"& fails, the raw string is returned. If decoding
8885 .cindex "binary zero" "in header line"
8886 produces a binary zero character, it is replaced by a question mark &-- this is
8887 what Exim does for binary zeros that are actually received in header lines.
8888
8889 .next
8890 &%header%& tries to translate the string as decoded by &%bheader%& to a
8891 standard character set. This is an attempt to produce the same string as would
8892 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8893 returned. Translation is attempted only on operating systems that support the
8894 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8895 a system Makefile or in &_Local/Makefile_&.
8896 .endlist ilist
8897
8898 In a filter file, the target character set for &%header%& can be specified by a
8899 command of the following form:
8900 .code
8901 headers charset "UTF-8"
8902 .endd
8903 This command affects all references to &$h_$& (or &$header_$&) expansions in
8904 subsequently obeyed filter commands. In the absence of this command, the target
8905 character set in a filter is taken from the setting of the &%headers_charset%&
8906 option in the runtime configuration. The value of this option defaults to the
8907 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8908 ISO-8859-1.
8909
8910 Header names follow the syntax of RFC 2822, which states that they may contain
8911 any printing characters except space and colon. Consequently, curly brackets
8912 &'do not'& terminate header names, and should not be used to enclose them as
8913 if they were variables. Attempting to do so causes a syntax error.
8914
8915 Only header lines that are common to all copies of a message are visible to
8916 this mechanism. These are the original header lines that are received with the
8917 message, and any that are added by an ACL statement or by a system
8918 filter. Header lines that are added to a particular copy of a message by a
8919 router or transport are not accessible.
8920
8921 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8922 before the DATA ACL, because the header structure is not set up until the
8923 message is received. Header lines that are added in a RCPT ACL (for example)
8924 are saved until the message's incoming header lines are available, at which
8925 point they are added. When a DATA ACL is running, however, header lines added
8926 by earlier ACLs are visible.
8927
8928 Upper case and lower case letters are synonymous in header names. If the
8929 following character is white space, the terminating colon may be omitted, but
8930 this is not recommended, because you may then forget it when it is needed. When
8931 white space terminates the header name, it is included in the expanded string.
8932 If the message does not contain the given header, the expansion item is
8933 replaced by an empty string. (See the &%def%& condition in section
8934 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8935
8936 If there is more than one header with the same name, they are all concatenated
8937 to form the substitution string, up to a maximum length of 64K. Unless
8938 &%rheader%& is being used, leading and trailing white space is removed from
8939 each header before concatenation, and a completely empty header is ignored. A
8940 newline character is then inserted between non-empty headers, but there is no
8941 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8942 those headers that contain lists of addresses, a comma is also inserted at the
8943 junctions between headers. This does not happen for the &%rheader%& expansion.
8944
8945
8946 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8947 .cindex "expansion" "hmac hashing"
8948 .cindex &%hmac%&
8949 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8950 shared secret and some text into a message authentication code, as specified in
8951 RFC 2104. This differs from &`${md5:secret_text...}`& or
8952 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8953 cryptographic hash, allowing for authentication that is not possible with MD5
8954 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8955 present. For example:
8956 .code
8957 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8958 .endd
8959 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8960 produces:
8961 .code
8962 dd97e3ba5d1a61b5006108f8c8252953
8963 .endd
8964 As an example of how this might be used, you might put in the main part of
8965 an Exim configuration:
8966 .code
8967 SPAMSCAN_SECRET=cohgheeLei2thahw
8968 .endd
8969 In a router or a transport you could then have:
8970 .code
8971 headers_add = \
8972   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8973   ${hmac{md5}{SPAMSCAN_SECRET}\
8974   {${primary_hostname},${message_exim_id},$h_message-id:}}
8975 .endd
8976 Then given a message, you can check where it was scanned by looking at the
8977 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8978 this header line is authentic by recomputing the authentication code from the
8979 host name, message ID and the &'Message-id:'& header line. This can be done
8980 using Exim's &%-be%& option, or by other means, for example by using the
8981 &'hmac_md5_hex()'& function in Perl.
8982
8983
8984 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8985 .cindex "expansion" "conditional"
8986 .cindex "&%if%&, expansion item"
8987 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8988 item; otherwise <&'string2'&> is used. The available conditions are described
8989 in section &<<SECTexpcond>>& below. For example:
8990 .code
8991 ${if eq {$local_part}{postmaster} {yes}{no} }
8992 .endd
8993 The second string need not be present; if it is not and the condition is not
8994 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
8995 be present instead of the second string (without any curly brackets). In this
8996 case, the expansion is forced to fail if the condition is not true (see section
8997 &<<SECTforexpfai>>&).
8998
8999 If both strings are omitted, the result is the string &`true`& if the condition
9000 is true, and the empty string if the condition is false. This makes it less
9001 cumbersome to write custom ACL and router conditions. For example, instead of
9002 .code
9003 condition = ${if >{$acl_m4}{3}{true}{false}}
9004 .endd
9005 you can use
9006 .code
9007 condition = ${if >{$acl_m4}{3}}
9008 .endd
9009
9010 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9011 .cindex "expansion" "string truncation"
9012 .cindex "&%length%& expansion item"
9013 The &%length%& item is used to extract the initial portion of a string. Both
9014 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9015 you are using a fixed value for the number, that is, if <&'string1'&> does not
9016 change when expanded, you can use the simpler operator notation that avoids
9017 some of the braces:
9018 .code
9019 ${length_<n>:<string>}
9020 .endd
9021 The result of this item is either the first <&'n'&> characters or the whole
9022 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9023 &%strlen%&, which gives the length of a string.
9024
9025
9026 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9027         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9028 This is the first of one of two different types of lookup item, which are both
9029 described in the next item.
9030
9031 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9032         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9033 .cindex "expansion" "lookup in"
9034 .cindex "file" "lookups"
9035 .cindex "lookup" "in expanded string"
9036 The two forms of lookup item specify data lookups in files and databases, as
9037 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9038 lookups, and the second is used for query-style lookups. The <&'key'&>,
9039 <&'file'&>, and <&'query'&> strings are expanded before use.
9040
9041 If there is any white space in a lookup item which is part of a filter command,
9042 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9043 other place where white space is significant, the lookup item must be enclosed
9044 in double quotes. The use of data lookups in users' filter files may be locked
9045 out by the system administrator.
9046
9047 .vindex "&$value$&"
9048 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9049 During its expansion, the variable &$value$& contains the data returned by the
9050 lookup. Afterwards it reverts to the value it had previously (at the outer
9051 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9052 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9053 string on failure. If <&'string2'&> is provided, it can itself be a nested
9054 lookup, thus providing a mechanism for looking up a default value when the
9055 original lookup fails.
9056
9057 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9058 data for the outer lookup while the parameters of the second lookup are
9059 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9060 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9061 appear, and in this case, if the lookup fails, the entire expansion is forced
9062 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9063 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9064 successful lookup, and nothing in the case of failure.
9065
9066 For single-key lookups, the string &"partial"& is permitted to precede the
9067 search type in order to do partial matching, and * or *@ may follow a search
9068 type to request default lookups if the key does not match (see sections
9069 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9070
9071 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9072 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9073 and non-wild parts of the key during the expansion of the replacement text.
9074 They return to their previous values at the end of the lookup item.
9075
9076 This example looks up the postmaster alias in the conventional alias file:
9077 .code
9078 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9079 .endd
9080 This example uses NIS+ to look up the full name of the user corresponding to
9081 the local part of an address, forcing the expansion to fail if it is not found:
9082 .code
9083 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9084   {$value}fail}
9085 .endd
9086
9087
9088 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9089 .cindex "expansion" "list creation"
9090 .vindex "&$item$&"
9091 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9092 default, but the separator can be changed in the usual way. For each item
9093 in this list, its value is place in &$item$&, and then <&'string2'&> is
9094 expanded and added to the output as an item in a new list. The separator used
9095 for the output list is the same as the one used for the input, but a separator
9096 setting is not included in the output. For example:
9097 .code
9098 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9099 .endd
9100 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9101 value of &$item$& is restored to what it was before. See also the &*filter*&
9102 and &*reduce*& expansion items.
9103
9104 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9105 .cindex "expansion" "numeric hash"
9106 .cindex "hash function" "numeric"
9107 The three strings are expanded; the first two must yield numbers. Call them
9108 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9109 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9110 can use the simpler operator notation that avoids some of the braces:
9111 .code
9112 ${nhash_<n>_<m>:<string>}
9113 .endd
9114 The second number is optional (in both notations). If there is only one number,
9115 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9116 processed by a div/mod hash function that returns two numbers, separated by a
9117 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9118 example,
9119 .code
9120 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9121 .endd
9122 returns the string &"6/33"&.
9123
9124
9125
9126 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9127 .cindex "Perl" "use in expanded string"
9128 .cindex "expansion" "calling Perl from"
9129 This item is available only if Exim has been built to include an embedded Perl
9130 interpreter. The subroutine name and the arguments are first separately
9131 expanded, and then the Perl subroutine is called with those arguments. No
9132 additional arguments need be given; the maximum number permitted, including the
9133 name of the subroutine, is nine.
9134
9135 The return value of the subroutine is inserted into the expanded string, unless
9136 the return value is &%undef%&. In that case, the expansion fails in the same
9137 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9138 Whatever you return is evaluated in a scalar context. For example, if you
9139 return the name of a Perl vector, the return value is the size of the vector,
9140 not its contents.
9141
9142 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9143 with the error message that was passed to &%die%&. More details of the embedded
9144 Perl facility are given in chapter &<<CHAPperl>>&.
9145
9146 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9147 out the use of this expansion item in filter files.
9148
9149
9150 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9151 .cindex "&%prvs%& expansion item"
9152 The first argument is a complete email address and the second is secret
9153 keystring. The third argument, specifying a key number, is optional. If absent,
9154 it defaults to 0. The result of the expansion is a prvs-signed email address,
9155 to be typically used with the &%return_path%& option on an &(smtp)& transport
9156 as part of a bounce address tag validation (BATV) scheme. For more discussion
9157 and an example, see section &<<SECTverifyPRVS>>&.
9158
9159 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9160         {*&<&'string'&>&*}}*&"
9161 .cindex "&%prvscheck%& expansion item"
9162 This expansion item is the complement of the &%prvs%& item. It is used for
9163 checking prvs-signed addresses. If the expansion of the first argument does not
9164 yield a syntactically valid prvs-signed address, the whole item expands to the
9165 empty string. When the first argument does expand to a syntactically valid
9166 prvs-signed address, the second argument is expanded, with the prvs-decoded
9167 version of the address and the key number extracted from the address in the
9168 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9169
9170 These two variables can be used in the expansion of the second argument to
9171 retrieve the secret. The validity of the prvs-signed address is then checked
9172 against the secret. The result is stored in the variable &$prvscheck_result$&,
9173 which is empty for failure or &"1"& for success.
9174
9175 The third argument is optional; if it is missing, it defaults to an empty
9176 string. This argument is now expanded. If the result is an empty string, the
9177 result of the expansion is the decoded version of the address. This is the case
9178 whether or not the signature was valid. Otherwise, the result of the expansion
9179 is the expansion of the third argument.
9180
9181 All three variables can be used in the expansion of the third argument.
9182 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9183 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9184
9185 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9186 .cindex "expansion" "inserting an entire file"
9187 .cindex "file" "inserting into expansion"
9188 .cindex "&%readfile%& expansion item"
9189 The file name and end-of-line string are first expanded separately. The file is
9190 then read, and its contents replace the entire item. All newline characters in
9191 the file are replaced by the end-of-line string if it is present. Otherwise,
9192 newlines are left in the string.
9193 String expansion is not applied to the contents of the file. If you want this,
9194 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9195 the string expansion fails.
9196
9197 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9198 locks out the use of this expansion item in filter files.
9199
9200
9201
9202 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9203         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9204 .cindex "expansion" "inserting from a socket"
9205 .cindex "socket, use of in expansion"
9206 .cindex "&%readsocket%& expansion item"
9207 This item inserts data from a Unix domain or Internet socket into the expanded
9208 string. The minimal way of using it uses just two arguments, as in these
9209 examples:
9210 .code
9211 ${readsocket{/socket/name}{request string}}
9212 ${readsocket{inet:some.host:1234}{request string}}
9213 .endd
9214 For a Unix domain socket, the first substring must be the path to the socket.
9215 For an Internet socket, the first substring must contain &`inet:`& followed by
9216 a host name or IP address, followed by a colon and a port, which can be a
9217 number or the name of a TCP port in &_/etc/services_&. An IP address may
9218 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9219 example:
9220 .code
9221 ${readsocket{inet:[::1]:1234}{request string}}
9222 .endd
9223 Only a single host name may be given, but if looking it up yields more than
9224 one IP address, they are each tried in turn until a connection is made. For
9225 both kinds of socket, Exim makes a connection, writes the request string
9226 (unless it is an empty string) and reads from the socket until an end-of-file
9227 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9228 extend what can be done. Firstly, you can vary the timeout. For example:
9229 .code
9230 ${readsocket{/socket/name}{request string}{3s}}
9231 .endd
9232 A fourth argument allows you to change any newlines that are in the data
9233 that is read, in the same way as for &%readfile%& (see above). This example
9234 turns them into spaces:
9235 .code
9236 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9237 .endd
9238 As with all expansions, the substrings are expanded before the processing
9239 happens. Errors in these sub-expansions cause the expansion to fail. In
9240 addition, the following errors can occur:
9241
9242 .ilist
9243 Failure to create a socket file descriptor;
9244 .next
9245 Failure to connect the socket;
9246 .next
9247 Failure to write the request string;
9248 .next
9249 Timeout on reading from the socket.
9250 .endlist
9251
9252 By default, any of these errors causes the expansion to fail. However, if
9253 you supply a fifth substring, it is expanded and used when any of the above
9254 errors occurs. For example:
9255 .code
9256 ${readsocket{/socket/name}{request string}{3s}{\n}\
9257   {socket failure}}
9258 .endd
9259 You can test for the existence of a Unix domain socket by wrapping this
9260 expansion in &`${if exists`&, but there is a race condition between that test
9261 and the actual opening of the socket, so it is safer to use the fifth argument
9262 if you want to be absolutely sure of avoiding an expansion error for a
9263 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9264
9265 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9266 locks out the use of this expansion item in filter files.
9267
9268
9269 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9270 .cindex "expansion" "reducing a list to a scalar"
9271 .cindex "list" "reducing to a scalar"
9272 .vindex "&$value$&"
9273 .vindex "&$item$&"
9274 This operation reduces a list to a single, scalar string. After expansion,
9275 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9276 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9277 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9278 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9279 them. The result of that expansion is assigned to &$value$& before the next
9280 iteration. When the end of the list is reached, the final value of &$value$& is
9281 added to the expansion output. The &*reduce*& expansion item can be used in a
9282 number of ways. For example, to add up a list of numbers:
9283 .code
9284 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9285 .endd
9286 The result of that expansion would be &`6`&. The maximum of a list of numbers
9287 can be found:
9288 .code
9289 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9290 .endd
9291 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9292 restored to what they were before. See also the &*filter*& and &*map*&
9293 expansion items.
9294
9295 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9296 This item inserts &"raw"& header lines. It is described with the &%header%&
9297 expansion item above.
9298
9299 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9300         {*&<&'string2'&>&*}}*&"
9301 .cindex "expansion" "running a command"
9302 .cindex "&%run%& expansion item"
9303 The command and its arguments are first expanded separately, and then the
9304 command is run in a separate process, but under the same uid and gid. As in
9305 other command executions from Exim, a shell is not used by default. If you want
9306 a shell, you must explicitly code it.
9307
9308 The standard input for the command exists, but is empty. The standard output
9309 and standard error are set to the same file descriptor.
9310 .cindex "return code" "from &%run%& expansion"
9311 .vindex "&$value$&"
9312 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9313 and replaces the entire item; during this expansion, the standard output/error
9314 from the command is in the variable &$value$&. If the command fails,
9315 <&'string2'&>, if present, is expanded and used. Once again, during the
9316 expansion, the standard output/error from the command is in the variable
9317 &$value$&.
9318
9319 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9320 can be the word &"fail"& (not in braces) to force expansion failure if the
9321 command does not succeed. If both strings are omitted, the result is contents
9322 of the standard output/error on success, and nothing on failure.
9323
9324 .vindex "&$runrc$&"
9325 The return code from the command is put in the variable &$runrc$&, and this
9326 remains set afterwards, so in a filter file you can do things like this:
9327 .code
9328 if "${run{x y z}{}}$runrc" is 1 then ...
9329   elif $runrc is 2 then ...
9330   ...
9331 endif
9332 .endd
9333 If execution of the command fails (for example, the command does not exist),
9334 the return code is 127 &-- the same code that shells use for non-existent
9335 commands.
9336
9337 &*Warning*&: In a router or transport, you cannot assume the order in which
9338 option values are expanded, except for those preconditions whose order of
9339 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9340 by the expansion of one option, and use it in another.
9341
9342 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9343 out the use of this expansion item in filter files.
9344
9345
9346 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9347 .cindex "expansion" "string substitution"
9348 .cindex "&%sg%& expansion item"
9349 This item works like Perl's substitution operator (s) with the global (/g)
9350 option; hence its name. However, unlike the Perl equivalent, Exim does not
9351 modify the subject string; instead it returns the modified string for insertion
9352 into the overall expansion. The item takes three arguments: the subject string,
9353 a regular expression, and a substitution string. For example:
9354 .code
9355 ${sg{abcdefabcdef}{abc}{xyz}}
9356 .endd
9357 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9358 if any $ or \ characters are required in the regular expression or in the
9359 substitution string, they have to be escaped. For example:
9360 .code
9361 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9362 .endd
9363 yields &"defabc"&, and
9364 .code
9365 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9366 .endd
9367 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9368 the regular expression from string expansion.
9369
9370
9371
9372 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9373 .cindex "&%substr%& expansion item"
9374 .cindex "substring extraction"
9375 .cindex "expansion" "substring extraction"
9376 The three strings are expanded; the first two must yield numbers. Call them
9377 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9378 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9379 can use the simpler operator notation that avoids some of the braces:
9380 .code
9381 ${substr_<n>_<m>:<string>}
9382 .endd
9383 The second number is optional (in both notations).
9384 If it is absent in the simpler format, the preceding underscore must also be
9385 omitted.
9386
9387 The &%substr%& item can be used to extract more general substrings than
9388 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9389 length required. For example
9390 .code
9391 ${substr{3}{2}{$local_part}}
9392 .endd
9393 If the starting offset is greater than the string length the result is the
9394 null string; if the length plus starting offset is greater than the string
9395 length, the result is the right-hand part of the string, starting from the
9396 given offset. The first character in the string has offset zero.
9397
9398 The &%substr%& expansion item can take negative offset values to count
9399 from the right-hand end of its operand. The last character is offset -1, the
9400 second-last is offset -2, and so on. Thus, for example,
9401 .code
9402 ${substr{-5}{2}{1234567}}
9403 .endd
9404 yields &"34"&. If the absolute value of a negative offset is greater than the
9405 length of the string, the substring starts at the beginning of the string, and
9406 the length is reduced by the amount of overshoot. Thus, for example,
9407 .code
9408 ${substr{-5}{2}{12}}
9409 .endd
9410 yields an empty string, but
9411 .code
9412 ${substr{-3}{2}{12}}
9413 .endd
9414 yields &"1"&.
9415
9416 When the second number is omitted from &%substr%&, the remainder of the string
9417 is taken if the offset is positive. If it is negative, all characters in the
9418 string preceding the offset point are taken. For example, an offset of -1 and
9419 no length, as in these semantically identical examples:
9420 .code
9421 ${substr_-1:abcde}
9422 ${substr{-1}{abcde}}
9423 .endd
9424 yields all but the last character of the string, that is, &"abcd"&.
9425
9426
9427
9428 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9429         {*&<&'replacements'&>&*}}*&"
9430 .cindex "expansion" "character translation"
9431 .cindex "&%tr%& expansion item"
9432 This item does single-character translation on its subject string. The second
9433 argument is a list of characters to be translated in the subject string. Each
9434 matching character is replaced by the corresponding character from the
9435 replacement list. For example
9436 .code
9437 ${tr{abcdea}{ac}{13}}
9438 .endd
9439 yields &`1b3de1`&. If there are duplicates in the second character string, the
9440 last occurrence is used. If the third string is shorter than the second, its
9441 last character is replicated. However, if it is empty, no translation takes
9442 place.
9443 .endlist
9444
9445
9446
9447 .section "Expansion operators" "SECTexpop"
9448 .cindex "expansion" "operators"
9449 For expansion items that perform transformations on a single argument string,
9450 the &"operator"& notation is used because it is simpler and uses fewer braces.
9451 The substring is first expanded before the operation is applied to it. The
9452 following operations can be performed:
9453
9454 .vlist
9455 .vitem &*${address:*&<&'string'&>&*}*&
9456 .cindex "expansion" "RFC 2822 address handling"
9457 .cindex "&%address%& expansion item"
9458 The string is interpreted as an RFC 2822 address, as it might appear in a
9459 header line, and the effective address is extracted from it. If the string does
9460 not parse successfully, the result is empty.
9461
9462
9463 .vitem &*${addresses:*&<&'string'&>&*}*&
9464 .cindex "expansion" "RFC 2822 address handling"
9465 .cindex "&%addresses%& expansion item"
9466 The string (after expansion) is interpreted as a list of addresses in RFC
9467 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9468 operative address (&'local-part@domain'&) is extracted from each item, and the
9469 result of the expansion is a colon-separated list, with appropriate
9470 doubling of colons should any happen to be present in the email addresses.
9471 Syntactically invalid RFC2822 address items are omitted from the output.
9472
9473 It is possible to specify a character other than colon for the output
9474 separator by starting the string with > followed by the new separator
9475 character. For example:
9476 .code
9477 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9478 .endd
9479 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9480 expansion item, which extracts the working address from a single RFC2822
9481 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9482 processing lists.
9483
9484
9485 .vitem &*${base62:*&<&'digits'&>&*}*&
9486 .cindex "&%base62%& expansion item"
9487 .cindex "expansion" "conversion to base 62"
9488 The string must consist entirely of decimal digits. The number is converted to
9489 base 62 and output as a string of six characters, including leading zeros. In
9490 the few operating environments where Exim uses base 36 instead of base 62 for
9491 its message identifiers (because those systems do not have case-sensitive file
9492 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9493 be absolutely clear: this is &'not'& base64 encoding.
9494
9495 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9496 .cindex "&%base62d%& expansion item"
9497 .cindex "expansion" "conversion to base 62"
9498 The string must consist entirely of base-62 digits, or, in operating
9499 environments where Exim uses base 36 instead of base 62 for its message
9500 identifiers, base-36 digits. The number is converted to decimal and output as a
9501 string.
9502
9503 .vitem &*${domain:*&<&'string'&>&*}*&
9504 .cindex "domain" "extraction"
9505 .cindex "expansion" "domain extraction"
9506 The string is interpreted as an RFC 2822 address and the domain is extracted
9507 from it. If the string does not parse successfully, the result is empty.
9508
9509
9510 .vitem &*${escape:*&<&'string'&>&*}*&
9511 .cindex "expansion" "escaping non-printing characters"
9512 .cindex "&%escape%& expansion item"
9513 If the string contains any non-printing characters, they are converted to
9514 escape sequences starting with a backslash. Whether characters with the most
9515 significant bit set (so-called &"8-bit characters"&) count as printing or not
9516 is controlled by the &%print_topbitchars%& option.
9517
9518
9519 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9520 .cindex "expansion" "expression evaluation"
9521 .cindex "expansion" "arithmetic expression"
9522 .cindex "&%eval%& expansion item"
9523 These items supports simple arithmetic and bitwise logical operations in
9524 expansion strings. The string (after expansion) must be a conventional
9525 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9526 logical operators, and parentheses. All operations are carried out using
9527 integer arithmetic. The operator priorities are as follows (the same as in the
9528 C programming language):
9529 .table2 70pt 300pt
9530 .irow &'highest:'& "not (~), negate (-)"
9531 .irow ""   "multiply (*), divide (/), remainder (%)"
9532 .irow ""   "plus (+), minus (-)"
9533 .irow ""   "shift-left (<<), shift-right (>>)"
9534 .irow ""   "and (&&)"
9535 .irow ""   "xor (^)"
9536 .irow &'lowest:'&  "or (|)"
9537 .endtable
9538 Binary operators with the same priority are evaluated from left to right. White
9539 space is permitted before or after operators.
9540
9541 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9542 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9543 decimal, even if they start with a leading zero; hexadecimal numbers are not
9544 permitted. This can be useful when processing numbers extracted from dates or
9545 times, which often do have leading zeros.
9546
9547 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9548 or 1024*1024*1024,
9549 respectively. Negative numbers are supported. The result of the computation is
9550 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9551
9552 .display
9553 &`${eval:1+1}            `&  yields 2
9554 &`${eval:1+2*3}          `&  yields 7
9555 &`${eval:(1+2)*3}        `&  yields 9
9556 &`${eval:2+42%5}         `&  yields 4
9557 &`${eval:0xc&amp;5}          `&  yields 4
9558 &`${eval:0xc|5}          `&  yields 13
9559 &`${eval:0xc^5}          `&  yields 9
9560 &`${eval:0xc>>1}         `&  yields 6
9561 &`${eval:0xc<<1}         `&  yields 24
9562 &`${eval:~255&amp;0x1234}    `&  yields 4608
9563 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9564 .endd
9565
9566 As a more realistic example, in an ACL you might have
9567 .code
9568 deny   message = Too many bad recipients
9569        condition =                    \
9570          ${if and {                   \
9571            {>{$rcpt_count}{10}}       \
9572            {                          \
9573            <                          \
9574              {$recipients_count}      \
9575              {${eval:$rcpt_count/2}}  \
9576            }                          \
9577          }{yes}{no}}
9578 .endd
9579 The condition is true if there have been more than 10 RCPT commands and
9580 fewer than half of them have resulted in a valid recipient.
9581
9582
9583 .vitem &*${expand:*&<&'string'&>&*}*&
9584 .cindex "expansion" "re-expansion of substring"
9585 The &%expand%& operator causes a string to be expanded for a second time. For
9586 example,
9587 .code
9588 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9589 .endd
9590 first looks up a string in a file while expanding the operand for &%expand%&,
9591 and then re-expands what it has found.
9592
9593
9594 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9595 .cindex "Unicode"
9596 .cindex "UTF-8" "conversion from"
9597 .cindex "expansion" "UTF-8 conversion"
9598 .cindex "&%from_utf8%& expansion item"
9599 The world is slowly moving towards Unicode, although there are no standards for
9600 email yet. However, other applications (including some databases) are starting
9601 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9602 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9603 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9604 the result is an undefined sequence of bytes.
9605
9606 Unicode code points with values less than 256 are compatible with ASCII and
9607 ISO-8859-1 (also known as Latin-1).
9608 For example, character 169 is the copyright symbol in both cases, though the
9609 way it is encoded is different. In UTF-8, more than one byte is needed for
9610 characters with code values greater than 127, whereas ISO-8859-1 is a
9611 single-byte encoding (but thereby limited to 256 characters). This makes
9612 translation from UTF-8 to ISO-8859-1 straightforward.
9613
9614
9615 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9616 .cindex "hash function" "textual"
9617 .cindex "expansion" "textual hash"
9618 The &%hash%& operator is a simpler interface to the hashing function that can
9619 be used when the two parameters are fixed numbers (as opposed to strings that
9620 change when expanded). The effect is the same as
9621 .code
9622 ${hash{<n>}{<m>}{<string>}}
9623 .endd
9624 See the description of the general &%hash%& item above for details. The
9625 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9626
9627
9628
9629 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9630 .cindex "base64 encoding" "conversion from hex"
9631 .cindex "expansion" "hex to base64"
9632 .cindex "&%hex2b64%& expansion item"
9633 This operator converts a hex string into one that is base64 encoded. This can
9634 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9635
9636
9637 .vitem &*${lc:*&<&'string'&>&*}*&
9638 .cindex "case forcing in strings"
9639 .cindex "string" "case forcing"
9640 .cindex "lower casing"
9641 .cindex "expansion" "case forcing"
9642 .cindex "&%lc%& expansion item"
9643 This forces the letters in the string into lower-case, for example:
9644 .code
9645 ${lc:$local_part}
9646 .endd
9647
9648 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9649 .cindex "expansion" "string truncation"
9650 .cindex "&%length%& expansion item"
9651 The &%length%& operator is a simpler interface to the &%length%& function that
9652 can be used when the parameter is a fixed number (as opposed to a string that
9653 changes when expanded). The effect is the same as
9654 .code
9655 ${length{<number>}{<string>}}
9656 .endd
9657 See the description of the general &%length%& item above for details. Note that
9658 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9659 when &%length%& is used as an operator.
9660
9661
9662 .vitem &*${local_part:*&<&'string'&>&*}*&
9663 .cindex "expansion" "local part extraction"
9664 .cindex "&%local_part%& expansion item"
9665 The string is interpreted as an RFC 2822 address and the local part is
9666 extracted from it. If the string does not parse successfully, the result is
9667 empty.
9668
9669
9670 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9671 .cindex "masked IP address"
9672 .cindex "IP address" "masking"
9673 .cindex "CIDR notation"
9674 .cindex "expansion" "IP address masking"
9675 .cindex "&%mask%& expansion item"
9676 If the form of the string to be operated on is not an IP address followed by a
9677 slash and an integer (that is, a network address in CIDR notation), the
9678 expansion fails. Otherwise, this operator converts the IP address to binary,
9679 masks off the least significant bits according to the bit count, and converts
9680 the result back to text, with mask appended. For example,
9681 .code
9682 ${mask:10.111.131.206/28}
9683 .endd
9684 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9685 be mostly used for looking up masked addresses in files, the result for an IPv6
9686 address uses dots to separate components instead of colons, because colon
9687 terminates a key string in lsearch files. So, for example,
9688 .code
9689 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9690 .endd
9691 returns the string
9692 .code
9693 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9694 .endd
9695 Letters in IPv6 addresses are always output in lower case.
9696
9697
9698 .vitem &*${md5:*&<&'string'&>&*}*&
9699 .cindex "MD5 hash"
9700 .cindex "expansion" "MD5 hash"
9701 .cindex "&%md5%& expansion item"
9702 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9703 as a 32-digit hexadecimal number, in which any letters are in lower case.
9704
9705
9706 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9707 .cindex "expansion" "numeric hash"
9708 .cindex "hash function" "numeric"
9709 The &%nhash%& operator is a simpler interface to the numeric hashing function
9710 that can be used when the two parameters are fixed numbers (as opposed to
9711 strings that change when expanded). The effect is the same as
9712 .code
9713 ${nhash{<n>}{<m>}{<string>}}
9714 .endd
9715 See the description of the general &%nhash%& item above for details.
9716
9717
9718 .vitem &*${quote:*&<&'string'&>&*}*&
9719 .cindex "quoting" "in string expansions"
9720 .cindex "expansion" "quoting"
9721 .cindex "&%quote%& expansion item"
9722 The &%quote%& operator puts its argument into double quotes if it
9723 is an empty string or
9724 contains anything other than letters, digits, underscores, dots, and hyphens.
9725 Any occurrences of double quotes and backslashes are escaped with a backslash.
9726 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9727 respectively For example,
9728 .code
9729 ${quote:ab"*"cd}
9730 .endd
9731 becomes
9732 .code
9733 "ab\"*\"cd"
9734 .endd
9735 The place where this is useful is when the argument is a substitution from a
9736 variable or a message header.
9737
9738 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9739 .cindex "&%quote_local_part%& expansion item"
9740 This operator is like &%quote%&, except that it quotes the string only if
9741 required to do so by the rules of RFC 2822 for quoting local parts. For
9742 example, a plus sign would not cause quoting (but it would for &%quote%&).
9743 If you are creating a new email address from the contents of &$local_part$&
9744 (or any other unknown data), you should always use this operator.
9745
9746
9747 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9748 .cindex "quoting" "lookup-specific"
9749 This operator applies lookup-specific quoting rules to the string. Each
9750 query-style lookup type has its own quoting rules which are described with
9751 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9752 .code
9753 ${quote_ldap:two * two}
9754 .endd
9755 returns
9756 .code
9757 two%20%5C2A%20two
9758 .endd
9759 For single-key lookup types, no quoting is ever necessary and this operator
9760 yields an unchanged string.
9761
9762
9763 .vitem &*${randint:*&<&'n'&>&*}*&
9764 .cindex "random number"
9765 This operator returns a somewhat random number which is less than the
9766 supplied number and is at least 0.  The quality of this randomness depends
9767 on how Exim was built; the values are not suitable for keying material.
9768 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9769 Otherwise, the implementation may be arc4random(), random() seeded by
9770 srandomdev() or srandom(), or a custom implementation even weaker than
9771 random().
9772
9773
9774 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9775 .cindex "expansion" "IP address"
9776 This operator reverses an IP address; for IPv4 addresses, the result is in
9777 dotted-quad decimal form, while for IPv6 addreses the result is in
9778 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9779 for DNS.  For example,
9780 .code
9781 ${reverse_ip:192.0.2.4}
9782 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9783 .endd
9784 returns
9785 .code
9786 4.2.0.192
9787 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
9788 .endd
9789
9790
9791 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9792 .cindex "expansion" "RFC 2047"
9793 .cindex "RFC 2047" "expansion operator"
9794 .cindex "&%rfc2047%& expansion item"
9795 This operator encodes text according to the rules of RFC 2047. This is an
9796 encoding that is used in header lines to encode non-ASCII characters. It is
9797 assumed that the input string is in the encoding specified by the
9798 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9799 contains only characters in the range 33&--126, and no instances of the
9800 characters
9801 .code
9802 ? = ( ) < > @ , ; : \ " . [ ] _
9803 .endd
9804 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9805 string, using as many &"encoded words"& as necessary to encode all the
9806 characters.
9807
9808
9809 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9810 .cindex "expansion" "RFC 2047"
9811 .cindex "RFC 2047" "decoding"
9812 .cindex "&%rfc2047d%& expansion item"
9813 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9814 bytes are replaced by question marks. Characters are converted into the
9815 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9816 not recognized unless &%check_rfc2047_length%& is set false.
9817
9818 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9819 access a header line, RFC 2047 decoding is done automatically. You do not need
9820 to use this operator as well.
9821
9822
9823
9824 .vitem &*${rxquote:*&<&'string'&>&*}*&
9825 .cindex "quoting" "in regular expressions"
9826 .cindex "regular expressions" "quoting"
9827 .cindex "&%rxquote%& expansion item"
9828 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9829 characters in its argument. This is useful when substituting the values of
9830 variables or headers inside regular expressions.
9831
9832
9833 .vitem &*${sha1:*&<&'string'&>&*}*&
9834 .cindex "SHA-1 hash"
9835 .cindex "expansion" "SHA-1 hashing"
9836 .cindex "&%sha2%& expansion item"
9837 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9838 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9839
9840
9841 .vitem &*${stat:*&<&'string'&>&*}*&
9842 .cindex "expansion" "statting a file"
9843 .cindex "file" "extracting characteristics"
9844 .cindex "&%stat%& expansion item"
9845 The string, after expansion, must be a file path. A call to the &[stat()]&
9846 function is made for this path. If &[stat()]& fails, an error occurs and the
9847 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9848 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9849 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9850 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9851 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9852 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9853 can extract individual fields using the &%extract%& expansion item.
9854
9855 The use of the &%stat%& expansion in users' filter files can be locked out by
9856 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9857 systems for files larger than 2GB.
9858
9859 .vitem &*${str2b64:*&<&'string'&>&*}*&
9860 .cindex "expansion" "base64 encoding"
9861 .cindex "base64 encoding" "in string expansion"
9862 .cindex "&%str2b64%& expansion item"
9863 This operator converts a string into one that is base64 encoded.
9864
9865
9866
9867 .vitem &*${strlen:*&<&'string'&>&*}*&
9868 .cindex "expansion" "string length"
9869 .cindex "string" "length in expansion"
9870 .cindex "&%strlen%& expansion item"
9871 The item is replace by the length of the expanded string, expressed as a
9872 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9873
9874
9875 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9876 .cindex "&%substr%& expansion item"
9877 .cindex "substring extraction"
9878 .cindex "expansion" "substring expansion"
9879 The &%substr%& operator is a simpler interface to the &%substr%& function that
9880 can be used when the two parameters are fixed numbers (as opposed to strings
9881 that change when expanded). The effect is the same as
9882 .code
9883 ${substr{<start>}{<length>}{<string>}}
9884 .endd
9885 See the description of the general &%substr%& item above for details. The
9886 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9887
9888 .vitem &*${time_eval:*&<&'string'&>&*}*&
9889 .cindex "&%time_eval%& expansion item"
9890 .cindex "time interval" "decoding"
9891 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9892 seconds.
9893
9894 .vitem &*${time_interval:*&<&'string'&>&*}*&
9895 .cindex "&%time_interval%& expansion item"
9896 .cindex "time interval" "formatting"
9897 The argument (after sub-expansion) must be a sequence of decimal digits that
9898 represents an interval of time as a number of seconds. It is converted into a
9899 number of larger units and output in Exim's normal time format, for example,
9900 &`1w3d4h2m6s`&.
9901
9902 .vitem &*${uc:*&<&'string'&>&*}*&
9903 .cindex "case forcing in strings"
9904 .cindex "string" "case forcing"
9905 .cindex "upper casing"
9906 .cindex "expansion" "case forcing"
9907 .cindex "&%uc%& expansion item"
9908 This forces the letters in the string into upper-case.
9909 .endlist
9910
9911
9912
9913
9914
9915
9916 .section "Expansion conditions" "SECTexpcond"
9917 .scindex IIDexpcond "expansion" "conditions"
9918 The following conditions are available for testing by the &%${if%& construct
9919 while expanding strings:
9920
9921 .vlist
9922 .vitem &*!*&<&'condition'&>
9923 .cindex "expansion" "negating a condition"
9924 .cindex "negation" "in expansion condition"
9925 Preceding any condition with an exclamation mark negates the result of the
9926 condition.
9927
9928 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9929 .cindex "numeric comparison"
9930 .cindex "expansion" "numeric comparison"
9931 There are a number of symbolic operators for doing numeric comparisons. They
9932 are:
9933 .display
9934 &`=   `&   equal
9935 &`==  `&   equal
9936 &`>   `&   greater
9937 &`>=  `&   greater or equal
9938 &`<   `&   less
9939 &`<=  `&   less or equal
9940 .endd
9941 For example:
9942 .code
9943 ${if >{$message_size}{10M} ...
9944 .endd
9945 Note that the general negation operator provides for inequality testing. The
9946 two strings must take the form of optionally signed decimal integers,
9947 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9948 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9949 As a special case, the numerical value of an empty string is taken as
9950 zero.
9951
9952 In all cases, a relative comparator OP is testing if <&'string1'&> OP
9953 <&'string2'&>; the above example is checking if &$message_size$& is larger than
9954 10M, not if 10M is larger than &$message_size$&.
9955
9956
9957 .vitem &*bool&~{*&<&'string'&>&*}*&
9958 .cindex "expansion" "boolean parsing"
9959 .cindex "&%bool%& expansion condition"
9960 This condition turns a string holding a true or false representation into
9961 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9962 (case-insensitively); also positive integer numbers map to true if non-zero,
9963 false if zero.
9964 An empty string is treated as false.
9965 Leading and trailing whitespace is ignored;
9966 thus a string consisting only of whitespace is false.
9967 All other string values will result in expansion failure.
9968
9969 When combined with ACL variables, this expansion condition will let you
9970 make decisions in one place and act on those decisions in another place.
9971 For example:
9972 .code
9973 ${if bool{$acl_m_privileged_sender} ...
9974 .endd
9975
9976
9977 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9978 .cindex "expansion" "boolean parsing"
9979 .cindex "&%bool_lax%& expansion condition"
9980 Like &%bool%&, this condition turns a string into a boolean state.  But
9981 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9982 loose definition that the Router &%condition%& option uses.  The empty string
9983 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9984 true.  Leading and trailing whitespace is ignored.
9985
9986 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9987
9988 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9989 .cindex "expansion" "encrypted comparison"
9990 .cindex "encrypted strings, comparing"
9991 .cindex "&%crypteq%& expansion condition"
9992 This condition is included in the Exim binary if it is built to support any
9993 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9994 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9995 included in the binary.
9996
9997 The &%crypteq%& condition has two arguments. The first is encrypted and
9998 compared against the second, which is already encrypted. The second string may
9999 be in the LDAP form for storing encrypted strings, which starts with the
10000 encryption type in curly brackets, followed by the data. If the second string
10001 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10002 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10003 Typically this will be a field from a password file. An example of an encrypted
10004 string in LDAP form is:
10005 .code
10006 {md5}CY9rzUYh03PK3k6DJie09g==
10007 .endd
10008 If such a string appears directly in an expansion, the curly brackets have to
10009 be quoted, because they are part of the expansion syntax. For example:
10010 .code
10011 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10012 .endd
10013 The following encryption types (whose names are matched case-independently) are
10014 supported:
10015
10016 .ilist
10017 .cindex "MD5 hash"
10018 .cindex "base64 encoding" "in encrypted password"
10019 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10020 printable characters to compare with the remainder of the second string. If the
10021 length of the comparison string is 24, Exim assumes that it is base64 encoded
10022 (as in the above example). If the length is 32, Exim assumes that it is a
10023 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10024 comparison fails.
10025
10026 .next
10027 .cindex "SHA-1 hash"
10028 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10029 printable characters to compare with the remainder of the second string. If the
10030 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10031 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10032 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10033
10034 .next
10035 .cindex "&[crypt()]&"
10036 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10037 only the first eight characters of the password. However, in modern operating
10038 systems this is no longer true, and in many cases the entire password is used,
10039 whatever its length.
10040
10041 .next
10042 .cindex "&[crypt16()]&"
10043 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10044 use up to 16 characters of the password in some operating systems. Again, in
10045 modern operating systems, more characters may be used.
10046 .endlist
10047 Exim has its own version of &[crypt16()]&, which is just a double call to
10048 &[crypt()]&. For operating systems that have their own version, setting
10049 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10050 operating system version instead of its own. This option is set by default in
10051 the OS-dependent &_Makefile_& for those operating systems that are known to
10052 support &[crypt16()]&.
10053
10054 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10055 it was not using the same algorithm as some operating systems' versions. It
10056 turns out that as well as &[crypt16()]& there is a function called
10057 &[bigcrypt()]& in some operating systems. This may or may not use the same
10058 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10059
10060 However, since there is now a move away from the traditional &[crypt()]&
10061 functions towards using SHA1 and other algorithms, tidying up this area of
10062 Exim is seen as very low priority.
10063
10064 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10065 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10066 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10067 default is &`{crypt}`&. Whatever the default, you can always use either
10068 function by specifying it explicitly in curly brackets.
10069
10070 .vitem &*def:*&<&'variable&~name'&>
10071 .cindex "expansion" "checking for empty variable"
10072 .cindex "&%def%& expansion condition"
10073 The &%def%& condition must be followed by the name of one of the expansion
10074 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10075 variable does not contain the empty string. For example:
10076 .code
10077 ${if def:sender_ident {from $sender_ident}}
10078 .endd
10079 Note that the variable name is given without a leading &%$%& character. If the
10080 variable does not exist, the expansion fails.
10081
10082 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10083         &~&*def:h_*&<&'header&~name'&>&*:*&"
10084 .cindex "expansion" "checking header line existence"
10085 This condition is true if a message is being processed and the named header
10086 exists in the message. For example,
10087 .code
10088 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10089 .endd
10090 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10091 the header name must be terminated by a colon if white space does not follow.
10092
10093 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10094        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10095 .cindex "string" "comparison"
10096 .cindex "expansion" "string comparison"
10097 .cindex "&%eq%& expansion condition"
10098 .cindex "&%eqi%& expansion condition"
10099 The two substrings are first expanded. The condition is true if the two
10100 resulting strings are identical. For &%eq%& the comparison includes the case of
10101 letters, whereas for &%eqi%& the comparison is case-independent.
10102
10103 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10104 .cindex "expansion" "file existence test"
10105 .cindex "file" "existence test"
10106 .cindex "&%exists%&, expansion condition"
10107 The substring is first expanded and then interpreted as an absolute path. The
10108 condition is true if the named file (or directory) exists. The existence test
10109 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10110 users' filter files may be locked out by the system administrator.
10111
10112 .vitem &*first_delivery*&
10113 .cindex "delivery" "first"
10114 .cindex "first delivery"
10115 .cindex "expansion" "first delivery test"
10116 .cindex "&%first_delivery%& expansion condition"
10117 This condition, which has no data, is true during a message's first delivery
10118 attempt. It is false during any subsequent delivery attempts.
10119
10120
10121 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10122        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10123 .cindex "list" "iterative conditions"
10124 .cindex "expansion" "&*forall*& condition"
10125 .cindex "expansion" "&*forany*& condition"
10126 .vindex "&$item$&"
10127 These conditions iterate over a list. The first argument is expanded to form
10128 the list. By default, the list separator is a colon, but it can be changed by
10129 the normal method. The second argument is interpreted as a condition that is to
10130 be applied to each item in the list in turn. During the interpretation of the
10131 condition, the current list item is placed in a variable called &$item$&.
10132 .ilist
10133 For &*forany*&, interpretation stops if the condition is true for any item, and
10134 the result of the whole condition is true. If the condition is false for all
10135 items in the list, the overall condition is false.
10136 .next
10137 For &*forall*&, interpretation stops if the condition is false for any item,
10138 and the result of the whole condition is false. If the condition is true for
10139 all items in the list, the overall condition is true.
10140 .endlist
10141 Note that negation of &*forany*& means that the condition must be false for all
10142 items for the overall condition to succeed, and negation of &*forall*& means
10143 that the condition must be false for at least one item. In this example, the
10144 list separator is changed to a comma:
10145 .code
10146 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10147 .endd
10148 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10149 being processed, to enable these expansion items to be nested.
10150
10151
10152 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10153        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10154 .cindex "string" "comparison"
10155 .cindex "expansion" "string comparison"
10156 .cindex "&%ge%& expansion condition"
10157 .cindex "&%gei%& expansion condition"
10158 The two substrings are first expanded. The condition is true if the first
10159 string is lexically greater than or equal to the second string. For &%ge%& the
10160 comparison includes the case of letters, whereas for &%gei%& the comparison is
10161 case-independent.
10162
10163 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10164        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10165 .cindex "string" "comparison"
10166 .cindex "expansion" "string comparison"
10167 .cindex "&%gt%& expansion condition"
10168 .cindex "&%gti%& expansion condition"
10169 The two substrings are first expanded. The condition is true if the first
10170 string is lexically greater than the second string. For &%gt%& the comparison
10171 includes the case of letters, whereas for &%gti%& the comparison is
10172 case-independent.
10173
10174 .new
10175 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10176        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10177 .cindex "string" "comparison"
10178 .cindex "list" "iterative conditions"
10179 Both strings are expanded; the second string is treated as a list of simple
10180 strings; if the first string is a member of the second, then the condition
10181 is true.
10182
10183 These are simpler to use versions of the more powerful &*forany*& condition.
10184 Examples, and the &*forany*& equivalents:
10185 .code
10186 ${if inlist{needle}{foo:needle:bar}}
10187   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10188 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10189   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10190 .endd
10191 .wen
10192
10193 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10194        &*isip4&~{*&<&'string'&>&*}*& &&&
10195        &*isip6&~{*&<&'string'&>&*}*&
10196 .cindex "IP address" "testing string format"
10197 .cindex "string" "testing for IP address"
10198 .cindex "&%isip%& expansion condition"
10199 .cindex "&%isip4%& expansion condition"
10200 .cindex "&%isip6%& expansion condition"
10201 The substring is first expanded, and then tested to see if it has the form of
10202 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10203 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10204
10205 For an IPv4 address, the test is for four dot-separated components, each of
10206 which consists of from one to three digits. For an IPv6 address, up to eight
10207 colon-separated components are permitted, each containing from one to four
10208 hexadecimal digits. There may be fewer than eight components if an empty
10209 component (adjacent colons) is present. Only one empty component is permitted.
10210
10211 &*Note*&: The checks are just on the form of the address; actual numerical
10212 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10213 check. The main use of these tests is to distinguish between IP addresses and
10214 host names, or between IPv4 and IPv6 addresses. For example, you could use
10215 .code
10216 ${if isip4{$sender_host_address}...
10217 .endd
10218 to test which IP version an incoming SMTP connection is using.
10219
10220 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10221 .cindex "LDAP" "use for authentication"
10222 .cindex "expansion" "LDAP authentication test"
10223 .cindex "&%ldapauth%& expansion condition"
10224 This condition supports user authentication using LDAP. See section
10225 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10226 queries. For this use, the query must contain a user name and password. The
10227 query itself is not used, and can be empty. The condition is true if the
10228 password is not empty, and the user name and password are accepted by the LDAP
10229 server. An empty password is rejected without calling LDAP because LDAP binds
10230 with an empty password are considered anonymous regardless of the username, and
10231 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10232 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10233 this can be used.
10234
10235
10236 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10237        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10238 .cindex "string" "comparison"
10239 .cindex "expansion" "string comparison"
10240 .cindex "&%le%& expansion condition"
10241 .cindex "&%lei%& expansion condition"
10242 The two substrings are first expanded. The condition is true if the first
10243 string is lexically less than or equal to the second string. For &%le%& the
10244 comparison includes the case of letters, whereas for &%lei%& the comparison is
10245 case-independent.
10246
10247 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10248        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10249 .cindex "string" "comparison"
10250 .cindex "expansion" "string comparison"
10251 .cindex "&%lt%& expansion condition"
10252 .cindex "&%lti%& expansion condition"
10253 The two substrings are first expanded. The condition is true if the first
10254 string is lexically less than the second string. For &%lt%& the comparison
10255 includes the case of letters, whereas for &%lti%& the comparison is
10256 case-independent.
10257
10258
10259 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10260 .cindex "expansion" "regular expression comparison"
10261 .cindex "regular expressions" "match in expanded string"
10262 .cindex "&%match%& expansion condition"
10263 The two substrings are first expanded. The second is then treated as a regular
10264 expression and applied to the first. Because of the pre-expansion, if the
10265 regular expression contains dollar, or backslash characters, they must be
10266 escaped. Care must also be taken if the regular expression contains braces
10267 (curly brackets). A closing brace must be escaped so that it is not taken as a
10268 premature termination of <&'string2'&>. The easiest approach is to use the
10269 &`\N`& feature to disable expansion of the regular expression.
10270 For example,
10271 .code
10272 ${if match {$local_part}{\N^\d{3}\N} ...
10273 .endd
10274 If the whole expansion string is in double quotes, further escaping of
10275 backslashes is also required.
10276
10277 The condition is true if the regular expression match succeeds.
10278 The regular expression is not required to begin with a circumflex
10279 metacharacter, but if there is no circumflex, the expression is not anchored,
10280 and it may match anywhere in the subject, not just at the start. If you want
10281 the pattern to match at the end of the subject, you must include the &`$`&
10282 metacharacter at an appropriate point.
10283
10284 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10285 At the start of an &%if%& expansion the values of the numeric variable
10286 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10287 succeeds causes them to be reset to the substrings of that condition and they
10288 will have these values during the expansion of the success string. At the end
10289 of the &%if%& expansion, the previous values are restored. After testing a
10290 combination of conditions using &%or%&, the subsequent values of the numeric
10291 variables are those of the condition that succeeded.
10292
10293 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10294 .cindex "&%match_address%& expansion condition"
10295 See &*match_local_part*&.
10296
10297 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10298 .cindex "&%match_domain%& expansion condition"
10299 See &*match_local_part*&.
10300
10301 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10302 .cindex "&%match_ip%& expansion condition"
10303 .new
10304 This condition matches an IP address to a list of IP address patterns. It must
10305 be followed by two argument strings. The first (after expansion) must be an IP
10306 address or an empty string. The second (not expanded) is a restricted host
10307 list that can match only an IP address, not a host name. For example:
10308 .wen
10309 .code
10310 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10311 .endd
10312 The specific types of host list item that are permitted in the list are:
10313
10314 .ilist
10315 An IP address, optionally with a CIDR mask.
10316 .next
10317 A single asterisk, which matches any IP address.
10318 .next
10319 An empty item, which matches only if the IP address is empty. This could be
10320 useful for testing for a locally submitted message or one from specific hosts
10321 in a single test such as
10322 . ==== As this is a nested list, any displays it contains must be indented
10323 . ==== as otherwise they are too far to the left. This comment applies to
10324 . ==== the use of xmlto plus fop. There's no problem when formatting with
10325 . ==== sdop, with or without the extra indent.
10326 .code
10327   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10328 .endd
10329 where the first item in the list is the empty string.
10330 .next
10331 The item @[] matches any of the local host's interface addresses.
10332 .next
10333 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10334 even if &`net-`& is not specified. There is never any attempt to turn the IP
10335 address into a host name. The most common type of linear search for
10336 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10337 masks. For example:
10338 .code
10339   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10340 .endd
10341 It is of course possible to use other kinds of lookup, and in such a case, you
10342 do need to specify the &`net-`& prefix if you want to specify a specific
10343 address mask, for example:
10344 .code
10345   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10346 .endd
10347 However, unless you are combining a &%match_ip%& condition with others, it is
10348 just as easy to use the fact that a lookup is itself a condition, and write:
10349 .code
10350   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10351 .endd
10352 .endlist ilist
10353
10354 .new
10355 Note that <&'string2'&> is not itself subject to string expansion, unless
10356 Exim was built with the EXPAND_LISTMATCH_RHS option.
10357 .wen
10358
10359 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10360
10361 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10362 .cindex "domain list" "in expansion condition"
10363 .cindex "address list" "in expansion condition"
10364 .cindex "local part" "list, in expansion condition"
10365 .cindex "&%match_local_part%& expansion condition"
10366 This condition, together with &%match_address%& and &%match_domain%&, make it
10367 possible to test domain, address, and local part lists within expansions. Each
10368 condition requires two arguments: an item and a list to match. A trivial
10369 example is:
10370 .code
10371 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10372 .endd
10373 In each case, the second argument may contain any of the allowable items for a
10374 list of the appropriate type. Also, because the second argument (after
10375 expansion) is a standard form of list, it is possible to refer to a named list.
10376 Thus, you can use conditions like this:
10377 .code
10378 ${if match_domain{$domain}{+local_domains}{...
10379 .endd
10380 .cindex "&`+caseful`&"
10381 For address lists, the matching starts off caselessly, but the &`+caseful`&
10382 item can be used, as in all address lists, to cause subsequent items to
10383 have their local parts matched casefully. Domains are always matched
10384 caselessly.
10385
10386 .new
10387 Note that <&'string2'&> is not itself subject to string expansion, unless
10388 Exim was built with the EXPAND_LISTMATCH_RHS option.
10389 .wen
10390
10391 &*Note*&: Host lists are &'not'& supported in this way. This is because
10392 hosts have two identities: a name and an IP address, and it is not clear
10393 how to specify cleanly how such a test would work. However, IP addresses can be
10394 matched using &%match_ip%&.
10395
10396 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10397 .cindex "PAM authentication"
10398 .cindex "AUTH" "with PAM"
10399 .cindex "Solaris" "PAM support"
10400 .cindex "expansion" "PAM authentication test"
10401 .cindex "&%pam%& expansion condition"
10402 &'Pluggable Authentication Modules'&
10403 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10404 available in the latest releases of Solaris and in some GNU/Linux
10405 distributions. The Exim support, which is intended for use in conjunction with
10406 the SMTP AUTH command, is available only if Exim is compiled with
10407 .code
10408 SUPPORT_PAM=yes
10409 .endd
10410 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10411 in some releases of GNU/Linux &%-ldl%& is also needed.
10412
10413 The argument string is first expanded, and the result must be a
10414 colon-separated list of strings. Leading and trailing white space is ignored.
10415 The PAM module is initialized with the service name &"exim"& and the user name
10416 taken from the first item in the colon-separated data string (<&'string1'&>).
10417 The remaining items in the data string are passed over in response to requests
10418 from the authentication function. In the simple case there will only be one
10419 request, for a password, so the data consists of just two strings.
10420
10421 There can be problems if any of the strings are permitted to contain colon
10422 characters. In the usual way, these have to be doubled to avoid being taken as
10423 separators. If the data is being inserted from a variable, the &%sg%& expansion
10424 item can be used to double any existing colons. For example, the configuration
10425 of a LOGIN authenticator might contain this setting:
10426 .code
10427 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10428 .endd
10429 For a PLAIN authenticator you could use:
10430 .code
10431 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10432 .endd
10433 In some operating systems, PAM authentication can be done only from a process
10434 running as root. Since Exim is running as the Exim user when receiving
10435 messages, this means that PAM cannot be used directly in those systems.
10436 A patched version of the &'pam_unix'& module that comes with the
10437 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10438 The patched module allows one special uid/gid combination, in addition to root,
10439 to authenticate. If you build the patched module to allow the Exim user and
10440 group, PAM can then be used from an Exim authenticator.
10441
10442
10443 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10444 .cindex "&'pwcheck'& daemon"
10445 .cindex "Cyrus"
10446 .cindex "expansion" "&'pwcheck'& authentication test"
10447 .cindex "&%pwcheck%& expansion condition"
10448 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10449 This is one way of making it possible for passwords to be checked by a process
10450 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10451 deprecated. Its replacement is &'saslauthd'& (see below).
10452
10453 The pwcheck support is not included in Exim by default. You need to specify
10454 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10455 building Exim. For example:
10456 .code
10457 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10458 .endd
10459 You do not need to install the full Cyrus software suite in order to use
10460 the pwcheck daemon. You can compile and install just the daemon alone
10461 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10462 access to the &_/var/pwcheck_& directory.
10463
10464 The &%pwcheck%& condition takes one argument, which must be the user name and
10465 password, separated by a colon. For example, in a LOGIN authenticator
10466 configuration, you might have this:
10467 .code
10468 server_condition = ${if pwcheck{$auth1:$auth2}}
10469 .endd
10470 Again, for a PLAIN authenticator configuration, this would be:
10471 .code
10472 server_condition = ${if pwcheck{$auth2:$auth3}}
10473 .endd
10474 .vitem &*queue_running*&
10475 .cindex "queue runner" "detecting when delivering from"
10476 .cindex "expansion" "queue runner test"
10477 .cindex "&%queue_running%& expansion condition"
10478 This condition, which has no data, is true during delivery attempts that are
10479 initiated by queue runner processes, and false otherwise.
10480
10481
10482 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10483 .cindex "Radius"
10484 .cindex "expansion" "Radius authentication"
10485 .cindex "&%radius%& expansion condition"
10486 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10487 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10488 the Radius client configuration file in order to build Exim with Radius
10489 support.
10490
10491 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10492 library, using the original API. If you are using release 0.4.0 or later of
10493 this library, you need to set
10494 .code
10495 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10496 .endd
10497 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10498 &%libradius%& library that comes with FreeBSD. To do this, set
10499 .code
10500 RADIUS_LIB_TYPE=RADLIB
10501 .endd
10502 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10503 You may also have to supply a suitable setting in EXTRALIBS so that the
10504 Radius library can be found when Exim is linked.
10505
10506 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10507 Radius client library, which calls the Radius server. The condition is true if
10508 the authentication is successful. For example:
10509 .code
10510 server_condition = ${if radius{<arguments>}}
10511 .endd
10512
10513
10514 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10515         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10516 .cindex "&'saslauthd'& daemon"
10517 .cindex "Cyrus"
10518 .cindex "expansion" "&'saslauthd'& authentication test"
10519 .cindex "&%saslauthd%& expansion condition"
10520 This condition supports user authentication using the Cyrus &'saslauthd'&
10521 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10522 Using this daemon is one way of making it possible for passwords to be checked
10523 by a process that is not running as root.
10524
10525 The saslauthd support is not included in Exim by default. You need to specify
10526 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10527 building Exim. For example:
10528 .code
10529 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10530 .endd
10531 You do not need to install the full Cyrus software suite in order to use
10532 the saslauthd daemon. You can compile and install just the daemon alone
10533 from the Cyrus SASL library.
10534
10535 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10536 two are mandatory. For example:
10537 .code
10538 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10539 .endd
10540 The service and the realm are optional (which is why the arguments are enclosed
10541 in their own set of braces). For details of the meaning of the service and
10542 realm, and how to run the daemon, consult the Cyrus documentation.
10543 .endlist vlist
10544
10545
10546
10547 .section "Combining expansion conditions" "SECID84"
10548 .cindex "expansion" "combining conditions"
10549 Several conditions can be tested at once by combining them using the &%and%&
10550 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10551 conditions on their own, and precede their lists of sub-conditions. Each
10552 sub-condition must be enclosed in braces within the overall braces that contain
10553 the list. No repetition of &%if%& is used.
10554
10555
10556 .vlist
10557 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10558 .cindex "&""or""& expansion condition"
10559 .cindex "expansion" "&""or""& of conditions"
10560 The sub-conditions are evaluated from left to right. The condition is true if
10561 any one of the sub-conditions is true.
10562 For example,
10563 .code
10564 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10565 .endd
10566 When a true sub-condition is found, the following ones are parsed but not
10567 evaluated. If there are several &"match"& sub-conditions the values of the
10568 numeric variables afterwards are taken from the first one that succeeds.
10569
10570 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10571 .cindex "&""and""& expansion condition"
10572 .cindex "expansion" "&""and""& of conditions"
10573 The sub-conditions are evaluated from left to right. The condition is true if
10574 all of the sub-conditions are true. If there are several &"match"&
10575 sub-conditions, the values of the numeric variables afterwards are taken from
10576 the last one. When a false sub-condition is found, the following ones are
10577 parsed but not evaluated.
10578 .endlist
10579 .ecindex IIDexpcond
10580
10581
10582
10583
10584 .section "Expansion variables" "SECTexpvar"
10585 .cindex "expansion" "variables, list of"
10586 This section contains an alphabetical list of all the expansion variables. Some
10587 of them are available only when Exim is compiled with specific options such as
10588 support for TLS or the content scanning extension.
10589
10590 .vlist
10591 .vitem "&$0$&, &$1$&, etc"
10592 .cindex "numerical variables (&$1$& &$2$& etc)"
10593 When a &%match%& expansion condition succeeds, these variables contain the
10594 captured substrings identified by the regular expression during subsequent
10595 processing of the success string of the containing &%if%& expansion item.
10596 However, they do not retain their values afterwards; in fact, their previous
10597 values are restored at the end of processing an &%if%& item. The numerical
10598 variables may also be set externally by some other matching process which
10599 precedes the expansion of the string. For example, the commands available in
10600 Exim filter files include an &%if%& command with its own regular expression
10601 matching condition.
10602
10603 .vitem "&$acl_c...$&"
10604 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10605 can be given any name that starts with &$acl_c$& and is at least six characters
10606 long, but the sixth character must be either a digit or an underscore. For
10607 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10608 variables persist throughout the lifetime of an SMTP connection. They can be
10609 used to pass information between ACLs and between different invocations of the
10610 same ACL. When a message is received, the values of these variables are saved
10611 with the message, and can be accessed by filters, routers, and transports
10612 during subsequent delivery.
10613
10614 .vitem "&$acl_m...$&"
10615 These variables are like the &$acl_c...$& variables, except that their values
10616 are reset after a message has been received. Thus, if several messages are
10617 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10618 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10619 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10620 message is received, the values of these variables are saved with the message,
10621 and can be accessed by filters, routers, and transports during subsequent
10622 delivery.
10623
10624 .vitem &$acl_verify_message$&
10625 .vindex "&$acl_verify_message$&"
10626 After an address verification has failed, this variable contains the failure
10627 message. It retains its value for use in subsequent modifiers. The message can
10628 be preserved by coding like this:
10629 .code
10630 warn !verify = sender
10631      set acl_m0 = $acl_verify_message
10632 .endd
10633 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10634 &%log_message%& modifiers, to include information about the verification
10635 failure.
10636
10637 .vitem &$address_data$&
10638 .vindex "&$address_data$&"
10639 This variable is set by means of the &%address_data%& option in routers. The
10640 value then remains with the address while it is processed by subsequent routers
10641 and eventually a transport. If the transport is handling multiple addresses,
10642 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10643 for more details. &*Note*&: The contents of &$address_data$& are visible in
10644 user filter files.
10645
10646 If &$address_data$& is set when the routers are called from an ACL to verify
10647 a recipient address, the final value is still in the variable for subsequent
10648 conditions and modifiers of the ACL statement. If routing the address caused it
10649 to be redirected to just one address, the child address is also routed as part
10650 of the verification, and in this case the final value of &$address_data$& is
10651 from the child's routing.
10652
10653 If &$address_data$& is set when the routers are called from an ACL to verify a
10654 sender address, the final value is also preserved, but this time in
10655 &$sender_address_data$&, to distinguish it from data from a recipient
10656 address.
10657
10658 In both cases (recipient and sender verification), the value does not persist
10659 after the end of the current ACL statement. If you want to preserve
10660 these values for longer, you can save them in ACL variables.
10661
10662 .vitem &$address_file$&
10663 .vindex "&$address_file$&"
10664 When, as a result of aliasing, forwarding, or filtering, a message is directed
10665 to a specific file, this variable holds the name of the file when the transport
10666 is running. At other times, the variable is empty. For example, using the
10667 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10668 .code
10669 /home/r2d2/savemail
10670 .endd
10671 then when the &(address_file)& transport is running, &$address_file$&
10672 contains the text string &`/home/r2d2/savemail`&.
10673 .cindex "Sieve filter" "value of &$address_file$&"
10674 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10675 then up to the transport configuration to generate an appropriate absolute path
10676 to the relevant file.
10677
10678 .vitem &$address_pipe$&
10679 .vindex "&$address_pipe$&"
10680 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10681 this variable holds the pipe command when the transport is running.
10682
10683 .vitem "&$auth1$& &-- &$auth3$&"
10684 .vindex "&$auth1$&, &$auth2$&, etc"
10685 These variables are used in SMTP authenticators (see chapters
10686 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10687
10688 .vitem &$authenticated_id$&
10689 .cindex "authentication" "id"
10690 .vindex "&$authenticated_id$&"
10691 When a server successfully authenticates a client it may be configured to
10692 preserve some of the authentication information in the variable
10693 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10694 user/password authenticator configuration might preserve the user name for use
10695 in the routers. Note that this is not the same information that is saved in
10696 &$sender_host_authenticated$&.
10697 When a message is submitted locally (that is, not over a TCP connection)
10698 the value of &$authenticated_id$& is normally the login name of the calling
10699 process. However, a trusted user can override this by means of the &%-oMai%&
10700 command line option.
10701
10702
10703
10704
10705 .vitem &$authenticated_sender$&
10706 .cindex "sender" "authenticated"
10707 .cindex "authentication" "sender"
10708 .cindex "AUTH" "on MAIL command"
10709 .vindex "&$authenticated_sender$&"
10710 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10711 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10712 described in section &<<SECTauthparamail>>&. Unless the data is the string
10713 &"<>"&, it is set as the authenticated sender of the message, and the value is
10714 available during delivery in the &$authenticated_sender$& variable. If the
10715 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10716
10717 .vindex "&$qualify_domain$&"
10718 When a message is submitted locally (that is, not over a TCP connection), the
10719 value of &$authenticated_sender$& is an address constructed from the login
10720 name of the calling process and &$qualify_domain$&, except that a trusted user
10721 can override this by means of the &%-oMas%& command line option.
10722
10723
10724 .vitem &$authentication_failed$&
10725 .cindex "authentication" "failure"
10726 .vindex "&$authentication_failed$&"
10727 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10728 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10729 possible to distinguish between &"did not try to authenticate"&
10730 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10731 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10732 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10733 negative response to an AUTH command, including (for example) an attempt to use
10734 an undefined mechanism.
10735
10736 .new
10737 .vitem &$av_failed$&
10738 .cindex "content scanning" "AV scanner failure"
10739 This variable is available when Exim is compiled with the content-scanning
10740 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10741 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10742 the ACL malware condition.
10743 .wen
10744
10745 .vitem &$body_linecount$&
10746 .cindex "message body" "line count"
10747 .cindex "body of message" "line count"
10748 .vindex "&$body_linecount$&"
10749 When a message is being received or delivered, this variable contains the
10750 number of lines in the message's body. See also &$message_linecount$&.
10751
10752 .vitem &$body_zerocount$&
10753 .cindex "message body" "binary zero count"
10754 .cindex "body of message" "binary zero count"
10755 .cindex "binary zero" "in message body"
10756 .vindex "&$body_zerocount$&"
10757 When a message is being received or delivered, this variable contains the
10758 number of binary zero bytes (ASCII NULs) in the message's body.
10759
10760 .vitem &$bounce_recipient$&
10761 .vindex "&$bounce_recipient$&"
10762 This is set to the recipient address of a bounce message while Exim is creating
10763 it. It is useful if a customized bounce message text file is in use (see
10764 chapter &<<CHAPemsgcust>>&).
10765
10766 .vitem &$bounce_return_size_limit$&
10767 .vindex "&$bounce_return_size_limit$&"
10768 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10769 up to a multiple of 1000. It is useful when a customized error message text
10770 file is in use (see chapter &<<CHAPemsgcust>>&).
10771
10772 .vitem &$caller_gid$&
10773 .cindex "gid (group id)" "caller"
10774 .vindex "&$caller_gid$&"
10775 The real group id under which the process that called Exim was running. This is
10776 not the same as the group id of the originator of a message (see
10777 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10778 incarnation normally contains the Exim gid.
10779
10780 .vitem &$caller_uid$&
10781 .cindex "uid (user id)" "caller"
10782 .vindex "&$caller_uid$&"
10783 The real user id under which the process that called Exim was running. This is
10784 not the same as the user id of the originator of a message (see
10785 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10786 incarnation normally contains the Exim uid.
10787
10788 .vitem &$compile_date$&
10789 .vindex "&$compile_date$&"
10790 The date on which the Exim binary was compiled.
10791
10792 .vitem &$compile_number$&
10793 .vindex "&$compile_number$&"
10794 The building process for Exim keeps a count of the number
10795 of times it has been compiled. This serves to distinguish different
10796 compilations of the same version of the program.
10797
10798 .vitem &$demime_errorlevel$&
10799 .vindex "&$demime_errorlevel$&"
10800 This variable is available when Exim is compiled with
10801 the content-scanning extension and the obsolete &%demime%& condition. For
10802 details, see section &<<SECTdemimecond>>&.
10803
10804 .vitem &$demime_reason$&
10805 .vindex "&$demime_reason$&"
10806 This variable is available when Exim is compiled with the
10807 content-scanning extension and the obsolete &%demime%& condition. For details,
10808 see section &<<SECTdemimecond>>&.
10809
10810 .vitem &$dnslist_domain$& &&&
10811        &$dnslist_matched$& &&&
10812        &$dnslist_text$& &&&
10813        &$dnslist_value$&
10814 .vindex "&$dnslist_domain$&"
10815 .vindex "&$dnslist_matched$&"
10816 .vindex "&$dnslist_text$&"
10817 .vindex "&$dnslist_value$&"
10818 .cindex "black list (DNS)"
10819 When a DNS (black) list lookup succeeds, these variables are set to contain
10820 the following data from the lookup: the list's domain name, the key that was
10821 looked up, the contents of any associated TXT record, and the value from the
10822 main A record. See section &<<SECID204>>& for more details.
10823
10824 .vitem &$domain$&
10825 .vindex "&$domain$&"
10826 When an address is being routed, or delivered on its own, this variable
10827 contains the domain. Uppercase letters in the domain are converted into lower
10828 case for &$domain$&.
10829
10830 Global address rewriting happens when a message is received, so the value of
10831 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10832 is set during user filtering, but not during system filtering, because a
10833 message may have many recipients and the system filter is called just once.
10834
10835 When more than one address is being delivered at once (for example, several
10836 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10837 have the same domain. Transports can be restricted to handling only one domain
10838 at a time if the value of &$domain$& is required at transport time &-- this is
10839 the default for local transports. For further details of the environment in
10840 which local transports are run, see chapter &<<CHAPenvironment>>&.
10841
10842 .oindex "&%delay_warning_condition%&"
10843 At the end of a delivery, if all deferred addresses have the same domain, it is
10844 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10845
10846 The &$domain$& variable is also used in some other circumstances:
10847
10848 .ilist
10849 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10850 the recipient address. The domain of the &'sender'& address is in
10851 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10852 normally set during the running of the MAIL ACL. However, if the sender address
10853 is verified with a callout during the MAIL ACL, the sender domain is placed in
10854 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10855 the &(smtp)& transport.
10856
10857 .next
10858 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10859 &$domain$& contains the domain portion of the address that is being rewritten;
10860 it can be used in the expansion of the replacement address, for example, to
10861 rewrite domains by file lookup.
10862
10863 .next
10864 With one important exception, whenever a domain list is being scanned,
10865 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10866 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10867 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10868 that, in a RCPT ACL, the sender domain list can be dependent on the
10869 recipient domain (which is what is in &$domain$& at this time).
10870
10871 .next
10872 .cindex "ETRN" "value of &$domain$&"
10873 .oindex "&%smtp_etrn_command%&"
10874 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10875 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10876 .endlist
10877
10878
10879 .vitem &$domain_data$&
10880 .vindex "&$domain_data$&"
10881 When the &%domains%& option on a router matches a domain by
10882 means of a lookup, the data read by the lookup is available during the running
10883 of the router as &$domain_data$&. In addition, if the driver routes the
10884 address to a transport, the value is available in that transport. If the
10885 transport is handling multiple addresses, the value from the first address is
10886 used.
10887
10888 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10889 domain by means of a lookup. The data read by the lookup is available during
10890 the rest of the ACL statement. In all other situations, this variable expands
10891 to nothing.
10892
10893 .vitem &$exim_gid$&
10894 .vindex "&$exim_gid$&"
10895 This variable contains the numerical value of the Exim group id.
10896
10897 .vitem &$exim_path$&
10898 .vindex "&$exim_path$&"
10899 This variable contains the path to the Exim binary.
10900
10901 .vitem &$exim_uid$&
10902 .vindex "&$exim_uid$&"
10903 This variable contains the numerical value of the Exim user id.
10904
10905 .vitem &$found_extension$&
10906 .vindex "&$found_extension$&"
10907 This variable is available when Exim is compiled with the
10908 content-scanning extension and the obsolete &%demime%& condition. For details,
10909 see section &<<SECTdemimecond>>&.
10910
10911 .vitem &$header_$&<&'name'&>
10912 This is not strictly an expansion variable. It is expansion syntax for
10913 inserting the message header line with the given name. Note that the name must
10914 be terminated by colon or white space, because it may contain a wide variety of
10915 characters. Note also that braces must &'not'& be used.
10916
10917 .vitem &$home$&
10918 .vindex "&$home$&"
10919 When the &%check_local_user%& option is set for a router, the user's home
10920 directory is placed in &$home$& when the check succeeds. In particular, this
10921 means it is set during the running of users' filter files. A router may also
10922 explicitly set a home directory for use by a transport; this can be overridden
10923 by a setting on the transport itself.
10924
10925 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10926 of the environment variable HOME.
10927
10928 .vitem &$host$&
10929 .vindex "&$host$&"
10930 If a router assigns an address to a transport (any transport), and passes a
10931 list of hosts with the address, the value of &$host$& when the transport starts
10932 to run is the name of the first host on the list. Note that this applies both
10933 to local and remote transports.
10934
10935 .cindex "transport" "filter"
10936 .cindex "filter" "transport filter"
10937 For the &(smtp)& transport, if there is more than one host, the value of
10938 &$host$& changes as the transport works its way through the list. In
10939 particular, when the &(smtp)& transport is expanding its options for encryption
10940 using TLS, or for specifying a transport filter (see chapter
10941 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10942 is connected.
10943
10944 When used in the client part of an authenticator configuration (see chapter
10945 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10946 client is connected.
10947
10948
10949 .vitem &$host_address$&
10950 .vindex "&$host_address$&"
10951 This variable is set to the remote host's IP address whenever &$host$& is set
10952 for a remote connection. It is also set to the IP address that is being checked
10953 when the &%ignore_target_hosts%& option is being processed.
10954
10955 .vitem &$host_data$&
10956 .vindex "&$host_data$&"
10957 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10958 result of the lookup is made available in the &$host_data$& variable. This
10959 allows you, for example, to do things like this:
10960 .code
10961 deny  hosts = net-lsearch;/some/file
10962 message = $host_data
10963 .endd
10964 .vitem &$host_lookup_deferred$&
10965 .cindex "host name" "lookup, failure of"
10966 .vindex "&$host_lookup_deferred$&"
10967 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10968 message comes from a remote host and there is an attempt to look up the host's
10969 name from its IP address, and the attempt is not successful, one of these
10970 variables is set to &"1"&.
10971
10972 .ilist
10973 If the lookup receives a definite negative response (for example, a DNS lookup
10974 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10975
10976 .next
10977 If there is any kind of problem during the lookup, such that Exim cannot
10978 tell whether or not the host name is defined (for example, a timeout for a DNS
10979 lookup), &$host_lookup_deferred$& is set to &"1"&.
10980 .endlist ilist
10981
10982 Looking up a host's name from its IP address consists of more than just a
10983 single reverse lookup. Exim checks that a forward lookup of at least one of the
10984 names it receives from a reverse lookup yields the original IP address. If this
10985 is not the case, Exim does not accept the looked up name(s), and
10986 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10987 IP address (for example, the existence of a PTR record in the DNS) is not
10988 sufficient on its own for the success of a host name lookup. If the reverse
10989 lookup succeeds, but there is a lookup problem such as a timeout when checking
10990 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10991 &"1"&. See also &$sender_host_name$&.
10992
10993 .vitem &$host_lookup_failed$&
10994 .vindex "&$host_lookup_failed$&"
10995 See &$host_lookup_deferred$&.
10996
10997
10998 .vitem &$inode$&
10999 .vindex "&$inode$&"
11000 The only time this variable is set is while expanding the &%directory_file%&
11001 option in the &(appendfile)& transport. The variable contains the inode number
11002 of the temporary file which is about to be renamed. It can be used to construct
11003 a unique name for the file.
11004
11005 .vitem &$interface_address$&
11006 .vindex "&$interface_address$&"
11007 This is an obsolete name for &$received_ip_address$&.
11008
11009 .vitem &$interface_port$&
11010 .vindex "&$interface_port$&"
11011 This is an obsolete name for &$received_port$&.
11012
11013 .vitem &$item$&
11014 .vindex "&$item$&"
11015 This variable is used during the expansion of &*forall*& and &*forany*&
11016 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11017 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11018 empty.
11019
11020 .vitem &$ldap_dn$&
11021 .vindex "&$ldap_dn$&"
11022 This variable, which is available only when Exim is compiled with LDAP support,
11023 contains the DN from the last entry in the most recently successful LDAP
11024 lookup.
11025
11026 .vitem &$load_average$&
11027 .vindex "&$load_average$&"
11028 This variable contains the system load average, multiplied by 1000 so that it
11029 is an integer. For example, if the load average is 0.21, the value of the
11030 variable is 210. The value is recomputed every time the variable is referenced.
11031
11032 .vitem &$local_part$&
11033 .vindex "&$local_part$&"
11034 When an address is being routed, or delivered on its own, this
11035 variable contains the local part. When a number of addresses are being
11036 delivered together (for example, multiple RCPT commands in an SMTP
11037 session), &$local_part$& is not set.
11038
11039 Global address rewriting happens when a message is received, so the value of
11040 &$local_part$& during routing and delivery is the value after rewriting.
11041 &$local_part$& is set during user filtering, but not during system filtering,
11042 because a message may have many recipients and the system filter is called just
11043 once.
11044
11045 .vindex "&$local_part_prefix$&"
11046 .vindex "&$local_part_suffix$&"
11047 If a local part prefix or suffix has been recognized, it is not included in the
11048 value of &$local_part$& during routing and subsequent delivery. The values of
11049 any prefix or suffix are in &$local_part_prefix$& and
11050 &$local_part_suffix$&, respectively.
11051
11052 When a message is being delivered to a file, pipe, or autoreply transport as a
11053 result of aliasing or forwarding, &$local_part$& is set to the local part of
11054 the parent address, not to the file name or command (see &$address_file$& and
11055 &$address_pipe$&).
11056
11057 When an ACL is running for a RCPT command, &$local_part$& contains the
11058 local part of the recipient address.
11059
11060 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11061 &$local_part$& contains the local part of the address that is being rewritten;
11062 it can be used in the expansion of the replacement address, for example.
11063
11064 In all cases, all quoting is removed from the local part. For example, for both
11065 the addresses
11066 .code
11067 "abc:xyz"@test.example
11068 abc\:xyz@test.example
11069 .endd
11070 the value of &$local_part$& is
11071 .code
11072 abc:xyz
11073 .endd
11074 If you use &$local_part$& to create another address, you should always wrap it
11075 inside a quoting operator. For example, in a &(redirect)& router you could
11076 have:
11077 .code
11078 data = ${quote_local_part:$local_part}@new.domain.example
11079 .endd
11080 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11081 to process local parts in a case-dependent manner in a router, you can set the
11082 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11083
11084 .vitem &$local_part_data$&
11085 .vindex "&$local_part_data$&"
11086 When the &%local_parts%& option on a router matches a local part by means of a
11087 lookup, the data read by the lookup is available during the running of the
11088 router as &$local_part_data$&. In addition, if the driver routes the address
11089 to a transport, the value is available in that transport. If the transport is
11090 handling multiple addresses, the value from the first address is used.
11091
11092 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11093 matches a local part by means of a lookup. The data read by the lookup is
11094 available during the rest of the ACL statement. In all other situations, this
11095 variable expands to nothing.
11096
11097 .vitem &$local_part_prefix$&
11098 .vindex "&$local_part_prefix$&"
11099 When an address is being routed or delivered, and a
11100 specific prefix for the local part was recognized, it is available in this
11101 variable, having been removed from &$local_part$&.
11102
11103 .vitem &$local_part_suffix$&
11104 .vindex "&$local_part_suffix$&"
11105 When an address is being routed or delivered, and a
11106 specific suffix for the local part was recognized, it is available in this
11107 variable, having been removed from &$local_part$&.
11108
11109 .vitem &$local_scan_data$&
11110 .vindex "&$local_scan_data$&"
11111 This variable contains the text returned by the &[local_scan()]& function when
11112 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11113
11114 .vitem &$local_user_gid$&
11115 .vindex "&$local_user_gid$&"
11116 See &$local_user_uid$&.
11117
11118 .vitem &$local_user_uid$&
11119 .vindex "&$local_user_uid$&"
11120 This variable and &$local_user_gid$& are set to the uid and gid after the
11121 &%check_local_user%& router precondition succeeds. This means that their values
11122 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11123 and &%condition%&), for the &%address_data%& expansion, and for any
11124 router-specific expansions. At all other times, the values in these variables
11125 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11126
11127 .vitem &$localhost_number$&
11128 .vindex "&$localhost_number$&"
11129 This contains the expanded value of the
11130 &%localhost_number%& option. The expansion happens after the main options have
11131 been read.
11132
11133 .vitem &$log_inodes$&
11134 .vindex "&$log_inodes$&"
11135 The number of free inodes in the disk partition where Exim's
11136 log files are being written. The value is recalculated whenever the variable is
11137 referenced. If the relevant file system does not have the concept of inodes,
11138 the value of is -1. See also the &%check_log_inodes%& option.
11139
11140 .vitem &$log_space$&
11141 .vindex "&$log_space$&"
11142 The amount of free space (as a number of kilobytes) in the disk
11143 partition where Exim's log files are being written. The value is recalculated
11144 whenever the variable is referenced. If the operating system does not have the
11145 ability to find the amount of free space (only true for experimental systems),
11146 the space value is -1. See also the &%check_log_space%& option.
11147
11148
11149 .vitem &$mailstore_basename$&
11150 .vindex "&$mailstore_basename$&"
11151 This variable is set only when doing deliveries in &"mailstore"& format in the
11152 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11153 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11154 contains the basename of the files that are being written, that is, the name
11155 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11156 variable is empty.
11157
11158 .vitem &$malware_name$&
11159 .vindex "&$malware_name$&"
11160 This variable is available when Exim is compiled with the
11161 content-scanning extension. It is set to the name of the virus that was found
11162 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11163
11164 .vitem &$max_received_linelength$&
11165 .vindex "&$max_received_linelength$&"
11166 .cindex "maximum" "line length"
11167 .cindex "line length" "maximum"
11168 This variable contains the number of bytes in the longest line that was
11169 received as part of the message, not counting the line termination
11170 character(s).
11171
11172 .vitem &$message_age$&
11173 .cindex "message" "age of"
11174 .vindex "&$message_age$&"
11175 This variable is set at the start of a delivery attempt to contain the number
11176 of seconds since the message was received. It does not change during a single
11177 delivery attempt.
11178
11179 .vitem &$message_body$&
11180 .cindex "body of message" "expansion variable"
11181 .cindex "message body" "in expansion"
11182 .cindex "binary zero" "in message body"
11183 .vindex "&$message_body$&"
11184 .oindex "&%message_body_visible%&"
11185 This variable contains the initial portion of a message's body while it is
11186 being delivered, and is intended mainly for use in filter files. The maximum
11187 number of characters of the body that are put into the variable is set by the
11188 &%message_body_visible%& configuration option; the default is 500.
11189
11190 .oindex "&%message_body_newlines%&"
11191 By default, newlines are converted into spaces in &$message_body$&, to make it
11192 easier to search for phrases that might be split over a line break. However,
11193 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11194 zeros are always converted into spaces.
11195
11196 .vitem &$message_body_end$&
11197 .cindex "body of message" "expansion variable"
11198 .cindex "message body" "in expansion"
11199 .vindex "&$message_body_end$&"
11200 This variable contains the final portion of a message's
11201 body while it is being delivered. The format and maximum size are as for
11202 &$message_body$&.
11203
11204 .vitem &$message_body_size$&
11205 .cindex "body of message" "size"
11206 .cindex "message body" "size"
11207 .vindex "&$message_body_size$&"
11208 When a message is being delivered, this variable contains the size of the body
11209 in bytes. The count starts from the character after the blank line that
11210 separates the body from the header. Newlines are included in the count. See
11211 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11212
11213 .vitem &$message_exim_id$&
11214 .vindex "&$message_exim_id$&"
11215 When a message is being received or delivered, this variable contains the
11216 unique message id that is generated and used by Exim to identify the message.
11217 An id is not created for a message until after its header has been successfully
11218 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11219 line; it is the local id that Exim assigns to the message, for example:
11220 &`1BXTIK-0001yO-VA`&.
11221
11222 .vitem &$message_headers$&
11223 .vindex &$message_headers$&
11224 This variable contains a concatenation of all the header lines when a message
11225 is being processed, except for lines added by routers or transports. The header
11226 lines are separated by newline characters. Their contents are decoded in the
11227 same way as a header line that is inserted by &%bheader%&.
11228
11229 .vitem &$message_headers_raw$&
11230 .vindex &$message_headers_raw$&
11231 This variable is like &$message_headers$& except that no processing of the
11232 contents of header lines is done.
11233
11234 .vitem &$message_id$&
11235 This is an old name for &$message_exim_id$&, which is now deprecated.
11236
11237 .vitem &$message_linecount$&
11238 .vindex "&$message_linecount$&"
11239 This variable contains the total number of lines in the header and body of the
11240 message. Compare &$body_linecount$&, which is the count for the body only.
11241 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11242 number of lines received. Before delivery happens (that is, before filters,
11243 routers, and transports run) the count is increased to include the
11244 &'Received:'& header line that Exim standardly adds, and also any other header
11245 lines that are added by ACLs. The blank line that separates the message header
11246 from the body is not counted.
11247
11248 As with the special case of &$message_size$&, during the expansion of the
11249 appendfile transport's maildir_tag option in maildir format, the value of
11250 &$message_linecount$& is the precise size of the number of newlines in the
11251 file that has been written (minus one for the blank line between the
11252 header and the body).
11253
11254 Here is an example of the use of this variable in a DATA ACL:
11255 .code
11256 deny message   = Too many lines in message header
11257      condition = \
11258       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11259 .endd
11260 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11261 message has not yet been received.
11262
11263 .vitem &$message_size$&
11264 .cindex "size" "of message"
11265 .cindex "message" "size"
11266 .vindex "&$message_size$&"
11267 When a message is being processed, this variable contains its size in bytes. In
11268 most cases, the size includes those headers that were received with the
11269 message, but not those (such as &'Envelope-to:'&) that are added to individual
11270 deliveries as they are written. However, there is one special case: during the
11271 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11272 doing a delivery in maildir format, the value of &$message_size$& is the
11273 precise size of the file that has been written. See also
11274 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11275
11276 .cindex "RCPT" "value of &$message_size$&"
11277 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11278 contains the size supplied on the MAIL command, or -1 if no size was given. The
11279 value may not, of course, be truthful.
11280
11281 .vitem &$mime_$&&'xxx'&
11282 A number of variables whose names start with &$mime$& are
11283 available when Exim is compiled with the content-scanning extension. For
11284 details, see section &<<SECTscanmimepart>>&.
11285
11286 .vitem "&$n0$& &-- &$n9$&"
11287 These variables are counters that can be incremented by means
11288 of the &%add%& command in filter files.
11289
11290 .vitem &$original_domain$&
11291 .vindex "&$domain$&"
11292 .vindex "&$original_domain$&"
11293 When a top-level address is being processed for delivery, this contains the
11294 same value as &$domain$&. However, if a &"child"& address (for example,
11295 generated by an alias, forward, or filter file) is being processed, this
11296 variable contains the domain of the original address (lower cased). This
11297 differs from &$parent_domain$& only when there is more than one level of
11298 aliasing or forwarding. When more than one address is being delivered in a
11299 single transport run, &$original_domain$& is not set.
11300
11301 If a new address is created by means of a &%deliver%& command in a system
11302 filter, it is set up with an artificial &"parent"& address. This has the local
11303 part &'system-filter'& and the default qualify domain.
11304
11305 .vitem &$original_local_part$&
11306 .vindex "&$local_part$&"
11307 .vindex "&$original_local_part$&"
11308 When a top-level address is being processed for delivery, this contains the
11309 same value as &$local_part$&, unless a prefix or suffix was removed from the
11310 local part, because &$original_local_part$& always contains the full local
11311 part. When a &"child"& address (for example, generated by an alias, forward, or
11312 filter file) is being processed, this variable contains the full local part of
11313 the original address.
11314
11315 If the router that did the redirection processed the local part
11316 case-insensitively, the value in &$original_local_part$& is in lower case.
11317 This variable differs from &$parent_local_part$& only when there is more than
11318 one level of aliasing or forwarding. When more than one address is being
11319 delivered in a single transport run, &$original_local_part$& is not set.
11320
11321 If a new address is created by means of a &%deliver%& command in a system
11322 filter, it is set up with an artificial &"parent"& address. This has the local
11323 part &'system-filter'& and the default qualify domain.
11324
11325 .vitem &$originator_gid$&
11326 .cindex "gid (group id)" "of originating user"
11327 .cindex "sender" "gid"
11328 .vindex "&$caller_gid$&"
11329 .vindex "&$originator_gid$&"
11330 This variable contains the value of &$caller_gid$& that was set when the
11331 message was received. For messages received via the command line, this is the
11332 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11333 normally the gid of the Exim user.
11334
11335 .vitem &$originator_uid$&
11336 .cindex "uid (user id)" "of originating user"
11337 .cindex "sender" "uid"
11338 .vindex "&$caller_uid$&"
11339 .vindex "&$originaltor_uid$&"
11340 The value of &$caller_uid$& that was set when the message was received. For
11341 messages received via the command line, this is the uid of the sending user.
11342 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11343 user.
11344
11345 .vitem &$parent_domain$&
11346 .vindex "&$parent_domain$&"
11347 This variable is similar to &$original_domain$& (see
11348 above), except that it refers to the immediately preceding parent address.
11349
11350 .vitem &$parent_local_part$&
11351 .vindex "&$parent_local_part$&"
11352 This variable is similar to &$original_local_part$&
11353 (see above), except that it refers to the immediately preceding parent address.
11354
11355 .vitem &$pid$&
11356 .cindex "pid (process id)" "of current process"
11357 .vindex "&$pid$&"
11358 This variable contains the current process id.
11359
11360 .vitem &$pipe_addresses$&
11361 .cindex "filter" "transport filter"
11362 .cindex "transport" "filter"
11363 .vindex "&$pipe_addresses$&"
11364 This is not an expansion variable, but is mentioned here because the string
11365 &`$pipe_addresses`& is handled specially in the command specification for the
11366 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11367 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11368 It cannot be used in general expansion strings, and provokes an &"unknown
11369 variable"& error if encountered.
11370
11371 .vitem &$primary_hostname$&
11372 .vindex "&$primary_hostname$&"
11373 This variable contains the value set by &%primary_hostname%& in the
11374 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11375 a single-component name, Exim calls &[gethostbyname()]& (or
11376 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11377 qualified host name. See also &$smtp_active_hostname$&.
11378
11379
11380 .vitem &$prvscheck_address$&
11381 This variable is used in conjunction with the &%prvscheck%& expansion item,
11382 which is described in sections &<<SECTexpansionitems>>& and
11383 &<<SECTverifyPRVS>>&.
11384
11385 .vitem &$prvscheck_keynum$&
11386 This variable is used in conjunction with the &%prvscheck%& expansion item,
11387 which is described in sections &<<SECTexpansionitems>>& and
11388 &<<SECTverifyPRVS>>&.
11389
11390 .vitem &$prvscheck_result$&
11391 This variable is used in conjunction with the &%prvscheck%& expansion item,
11392 which is described in sections &<<SECTexpansionitems>>& and
11393 &<<SECTverifyPRVS>>&.
11394
11395 .vitem &$qualify_domain$&
11396 .vindex "&$qualify_domain$&"
11397 The value set for the &%qualify_domain%& option in the configuration file.
11398
11399 .vitem &$qualify_recipient$&
11400 .vindex "&$qualify_recipient$&"
11401 The value set for the &%qualify_recipient%& option in the configuration file,
11402 or if not set, the value of &$qualify_domain$&.
11403
11404 .vitem &$rcpt_count$&
11405 .vindex "&$rcpt_count$&"
11406 When a message is being received by SMTP, this variable contains the number of
11407 RCPT commands received for the current message. If this variable is used in a
11408 RCPT ACL, its value includes the current command.
11409
11410 .vitem &$rcpt_defer_count$&
11411 .vindex "&$rcpt_defer_count$&"
11412 .cindex "4&'xx'& responses" "count of"
11413 When a message is being received by SMTP, this variable contains the number of
11414 RCPT commands in the current message that have previously been rejected with a
11415 temporary (4&'xx'&) response.
11416
11417 .vitem &$rcpt_fail_count$&
11418 .vindex "&$rcpt_fail_count$&"
11419 When a message is being received by SMTP, this variable contains the number of
11420 RCPT commands in the current message that have previously been rejected with a
11421 permanent (5&'xx'&) response.
11422
11423 .vitem &$received_count$&
11424 .vindex "&$received_count$&"
11425 This variable contains the number of &'Received:'& header lines in the message,
11426 including the one added by Exim (so its value is always greater than zero). It
11427 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11428 delivering.
11429
11430 .vitem &$received_for$&
11431 .vindex "&$received_for$&"
11432 If there is only a single recipient address in an incoming message, this
11433 variable contains that address when the &'Received:'& header line is being
11434 built. The value is copied after recipient rewriting has happened, but before
11435 the &[local_scan()]& function is run.
11436
11437 .vitem &$received_ip_address$&
11438 .vindex "&$received_ip_address$&"
11439 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11440 variable is set to the address of the local IP interface, and &$received_port$&
11441 is set to the local port number. (The remote IP address and port are in
11442 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11443 the port value is -1 unless it has been set using the &%-oMi%& command line
11444 option.
11445
11446 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11447 could be used, for example, to make the file name for a TLS certificate depend
11448 on which interface and/or port is being used for the incoming connection. The
11449 values of &$received_ip_address$& and &$received_port$& are saved with any
11450 messages that are received, thus making these variables available at delivery
11451 time.
11452
11453 &*Note:*& There are no equivalent variables for outgoing connections, because
11454 the values are unknown (unless they are explicitly set by options of the
11455 &(smtp)& transport).
11456
11457 .vitem &$received_port$&
11458 .vindex "&$received_port$&"
11459 See &$received_ip_address$&.
11460
11461 .vitem &$received_protocol$&
11462 .vindex "&$received_protocol$&"
11463 When a message is being processed, this variable contains the name of the
11464 protocol by which it was received. Most of the names used by Exim are defined
11465 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11466 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11467 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11468 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11469 connection and the client was successfully authenticated.
11470
11471 Exim uses the protocol name &"smtps"& for the case when encryption is
11472 automatically set up on connection without the use of STARTTLS (see
11473 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11474 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11475 where the client initially uses EHLO, sets up an encrypted connection using
11476 STARTTLS, and then uses HELO afterwards.
11477
11478 The &%-oMr%& option provides a way of specifying a custom protocol name for
11479 messages that are injected locally by trusted callers. This is commonly used to
11480 identify messages that are being re-injected after some kind of scanning.
11481
11482 .vitem &$received_time$&
11483 .vindex "&$received_time$&"
11484 This variable contains the date and time when the current message was received,
11485 as a number of seconds since the start of the Unix epoch.
11486
11487 .vitem &$recipient_data$&
11488 .vindex "&$recipient_data$&"
11489 This variable is set after an indexing lookup success in an ACL &%recipients%&
11490 condition. It contains the data from the lookup, and the value remains set
11491 until the next &%recipients%& test. Thus, you can do things like this:
11492 .display
11493 &`require recipients  = cdb*@;/some/file`&
11494 &`deny    `&&'some further test involving'& &`$recipient_data`&
11495 .endd
11496 &*Warning*&: This variable is set only when a lookup is used as an indexing
11497 method in the address list, using the semicolon syntax as in the example above.
11498 The variable is not set for a lookup that is used as part of the string
11499 expansion that all such lists undergo before being interpreted.
11500
11501 .vitem &$recipient_verify_failure$&
11502 .vindex "&$recipient_verify_failure$&"
11503 In an ACL, when a recipient verification fails, this variable contains
11504 information about the failure. It is set to one of the following words:
11505
11506 .ilist
11507 &"qualify"&: The address was unqualified (no domain), and the message
11508 was neither local nor came from an exempted host.
11509
11510 .next
11511 &"route"&: Routing failed.
11512
11513 .next
11514 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11515 or before the MAIL command (that is, on initial connection, HELO, or
11516 MAIL).
11517
11518 .next
11519 &"recipient"&: The RCPT command in a callout was rejected.
11520 .next
11521
11522 &"postmaster"&: The postmaster check in a callout was rejected.
11523 .endlist
11524
11525 The main use of this variable is expected to be to distinguish between
11526 rejections of MAIL and rejections of RCPT.
11527
11528 .vitem &$recipients$&
11529 .vindex "&$recipients$&"
11530 This variable contains a list of envelope recipients for a message. A comma and
11531 a space separate the addresses in the replacement text. However, the variable
11532 is not generally available, to prevent exposure of Bcc recipients in
11533 unprivileged users' filter files. You can use &$recipients$& only in these
11534 cases:
11535
11536 .olist
11537 In a system filter file.
11538 .next
11539 In the ACLs associated with the DATA command and with non-SMTP messages, that
11540 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11541 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11542 &%acl_not_smtp_mime%&.
11543 .next
11544 From within a &[local_scan()]& function.
11545 .endlist
11546
11547
11548 .vitem &$recipients_count$&
11549 .vindex "&$recipients_count$&"
11550 When a message is being processed, this variable contains the number of
11551 envelope recipients that came with the message. Duplicates are not excluded
11552 from the count. While a message is being received over SMTP, the number
11553 increases for each accepted recipient. It can be referenced in an ACL.
11554
11555
11556 .vitem &$regex_match_string$&
11557 .vindex "&$regex_match_string$&"
11558 This variable is set to contain the matching regular expression after a
11559 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11560
11561
11562 .vitem &$reply_address$&
11563 .vindex "&$reply_address$&"
11564 When a message is being processed, this variable contains the contents of the
11565 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11566 contents of the &'From:'& header line. Apart from the removal of leading
11567 white space, the value is not processed in any way. In particular, no RFC 2047
11568 decoding or character code translation takes place.
11569
11570 .vitem &$return_path$&
11571 .vindex "&$return_path$&"
11572 When a message is being delivered, this variable contains the return path &--
11573 the sender field that will be sent as part of the envelope. It is not enclosed
11574 in <> characters. At the start of routing an address, &$return_path$& has the
11575 same value as &$sender_address$&, but if, for example, an incoming message to a
11576 mailing list has been expanded by a router which specifies a different address
11577 for bounce messages, &$return_path$& subsequently contains the new bounce
11578 address, whereas &$sender_address$& always contains the original sender address
11579 that was received with the message. In other words, &$sender_address$& contains
11580 the incoming envelope sender, and &$return_path$& contains the outgoing
11581 envelope sender.
11582
11583 .vitem &$return_size_limit$&
11584 .vindex "&$return_size_limit$&"
11585 This is an obsolete name for &$bounce_return_size_limit$&.
11586
11587 .vitem &$runrc$&
11588 .cindex "return code" "from &%run%& expansion"
11589 .vindex "&$runrc$&"
11590 This variable contains the return code from a command that is run by the
11591 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11592 assume the order in which option values are expanded, except for those
11593 preconditions whose order of testing is documented. Therefore, you cannot
11594 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11595 another.
11596
11597 .vitem &$self_hostname$&
11598 .oindex "&%self%&" "value of host name"
11599 .vindex "&$self_hostname$&"
11600 When an address is routed to a supposedly remote host that turns out to be the
11601 local host, what happens is controlled by the &%self%& generic router option.
11602 One of its values causes the address to be passed to another router. When this
11603 happens, &$self_hostname$& is set to the name of the local host that the
11604 original router encountered. In other circumstances its contents are null.
11605
11606 .vitem &$sender_address$&
11607 .vindex "&$sender_address$&"
11608 When a message is being processed, this variable contains the sender's address
11609 that was received in the message's envelope. The case of letters in the address
11610 is retained, in both the local part and the domain. For bounce messages, the
11611 value of this variable is the empty string. See also &$return_path$&.
11612
11613 .vitem &$sender_address_data$&
11614 .vindex "&$address_data$&"
11615 .vindex "&$sender_address_data$&"
11616 If &$address_data$& is set when the routers are called from an ACL to verify a
11617 sender address, the final value is preserved in &$sender_address_data$&, to
11618 distinguish it from data from a recipient address. The value does not persist
11619 after the end of the current ACL statement. If you want to preserve it for
11620 longer, you can save it in an ACL variable.
11621
11622 .vitem &$sender_address_domain$&
11623 .vindex "&$sender_address_domain$&"
11624 The domain portion of &$sender_address$&.
11625
11626 .vitem &$sender_address_local_part$&
11627 .vindex "&$sender_address_local_part$&"
11628 The local part portion of &$sender_address$&.
11629
11630 .vitem &$sender_data$&
11631 .vindex "&$sender_data$&"
11632 This variable is set after a lookup success in an ACL &%senders%& condition or
11633 in a router &%senders%& option. It contains the data from the lookup, and the
11634 value remains set until the next &%senders%& test. Thus, you can do things like
11635 this:
11636 .display
11637 &`require senders      = cdb*@;/some/file`&
11638 &`deny    `&&'some further test involving'& &`$sender_data`&
11639 .endd
11640 &*Warning*&: This variable is set only when a lookup is used as an indexing
11641 method in the address list, using the semicolon syntax as in the example above.
11642 The variable is not set for a lookup that is used as part of the string
11643 expansion that all such lists undergo before being interpreted.
11644
11645 .vitem &$sender_fullhost$&
11646 .vindex "&$sender_fullhost$&"
11647 When a message is received from a remote host, this variable contains the host
11648 name and IP address in a single string. It ends with the IP address in square
11649 brackets, followed by a colon and a port number if the logging of ports is
11650 enabled. The format of the rest of the string depends on whether the host
11651 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11652 looking up its IP address. (Looking up the IP address can be forced by the
11653 &%host_lookup%& option, independent of verification.) A plain host name at the
11654 start of the string is a verified host name; if this is not present,
11655 verification either failed or was not requested. A host name in parentheses is
11656 the argument of a HELO or EHLO command. This is omitted if it is identical to
11657 the verified host name or to the host's IP address in square brackets.
11658
11659 .vitem &$sender_helo_name$&
11660 .vindex "&$sender_helo_name$&"
11661 When a message is received from a remote host that has issued a HELO or EHLO
11662 command, the argument of that command is placed in this variable. It is also
11663 set if HELO or EHLO is used when a message is received using SMTP locally via
11664 the &%-bs%& or &%-bS%& options.
11665
11666 .vitem &$sender_host_address$&
11667 .vindex "&$sender_host_address$&"
11668 When a message is received from a remote host, this variable contains that
11669 host's IP address. For locally submitted messages, it is empty.
11670
11671 .vitem &$sender_host_authenticated$&
11672 .vindex "&$sender_host_authenticated$&"
11673 This variable contains the name (not the public name) of the authenticator
11674 driver that successfully authenticated the client from which the message was
11675 received. It is empty if there was no successful authentication. See also
11676 &$authenticated_id$&.
11677
11678 .vitem &$sender_host_name$&
11679 .vindex "&$sender_host_name$&"
11680 When a message is received from a remote host, this variable contains the
11681 host's name as obtained by looking up its IP address. For messages received by
11682 other means, this variable is empty.
11683
11684 .vindex "&$host_lookup_failed$&"
11685 If the host name has not previously been looked up, a reference to
11686 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11687 A looked up name is accepted only if it leads back to the original IP address
11688 via a forward lookup. If either the reverse or the forward lookup fails to find
11689 any data, or if the forward lookup does not yield the original IP address,
11690 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11691
11692 .vindex "&$host_lookup_deferred$&"
11693 However, if either of the lookups cannot be completed (for example, there is a
11694 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11695 &$host_lookup_failed$& remains set to &"0"&.
11696
11697 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11698 host name again if there is a subsequent reference to &$sender_host_name$&
11699 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11700 is set to &"1"&.
11701
11702 Exim does not automatically look up every calling host's name. If you want
11703 maximum efficiency, you should arrange your configuration so that it avoids
11704 these lookups altogether. The lookup happens only if one or more of the
11705 following are true:
11706
11707 .ilist
11708 A string containing &$sender_host_name$& is expanded.
11709 .next
11710 The calling host matches the list in &%host_lookup%&. In the default
11711 configuration, this option is set to *, so it must be changed if lookups are
11712 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11713 .next
11714 Exim needs the host name in order to test an item in a host list. The items
11715 that require this are described in sections &<<SECThoslispatnam>>& and
11716 &<<SECThoslispatnamsk>>&.
11717 .next
11718 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11719 In this case, the host name is required to compare with the name quoted in any
11720 EHLO or HELO commands that the client issues.
11721 .next
11722 The remote host issues a EHLO or HELO command that quotes one of the
11723 domains in &%helo_lookup_domains%&. The default value of this option is
11724 . ==== As this is a nested list, any displays it contains must be indented
11725 . ==== as otherwise they are too far to the left.
11726 .code
11727   helo_lookup_domains = @ : @[]
11728 .endd
11729 which causes a lookup if a remote host (incorrectly) gives the server's name or
11730 IP address in an EHLO or HELO command.
11731 .endlist
11732
11733
11734 .vitem &$sender_host_port$&
11735 .vindex "&$sender_host_port$&"
11736 When a message is received from a remote host, this variable contains the port
11737 number that was used on the remote host.
11738
11739 .vitem &$sender_ident$&
11740 .vindex "&$sender_ident$&"
11741 When a message is received from a remote host, this variable contains the
11742 identification received in response to an RFC 1413 request. When a message has
11743 been received locally, this variable contains the login name of the user that
11744 called Exim.
11745
11746 .vitem &$sender_rate_$&&'xxx'&
11747 A number of variables whose names begin &$sender_rate_$& are set as part of the
11748 &%ratelimit%& ACL condition. Details are given in section
11749 &<<SECTratelimiting>>&.
11750
11751 .vitem &$sender_rcvhost$&
11752 .cindex "DNS" "reverse lookup"
11753 .cindex "reverse DNS lookup"
11754 .vindex "&$sender_rcvhost$&"
11755 This is provided specifically for use in &'Received:'& headers. It starts with
11756 either the verified host name (as obtained from a reverse DNS lookup) or, if
11757 there is no verified host name, the IP address in square brackets. After that
11758 there may be text in parentheses. When the first item is a verified host name,
11759 the first thing in the parentheses is the IP address in square brackets,
11760 followed by a colon and a port number if port logging is enabled. When the
11761 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11762 the parentheses.
11763
11764 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11765 was used and its argument was not identical to the real host name or IP
11766 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11767 all three items are present in the parentheses, a newline and tab are inserted
11768 into the string, to improve the formatting of the &'Received:'& header.
11769
11770 .vitem &$sender_verify_failure$&
11771 .vindex "&$sender_verify_failure$&"
11772 In an ACL, when a sender verification fails, this variable contains information
11773 about the failure. The details are the same as for
11774 &$recipient_verify_failure$&.
11775
11776 .vitem &$sending_ip_address$&
11777 .vindex "&$sending_ip_address$&"
11778 This variable is set whenever an outgoing SMTP connection to another host has
11779 been set up. It contains the IP address of the local interface that is being
11780 used. This is useful if a host that has more than one IP address wants to take
11781 on different personalities depending on which one is being used. For incoming
11782 connections, see &$received_ip_address$&.
11783
11784 .vitem &$sending_port$&
11785 .vindex "&$sending_port$&"
11786 This variable is set whenever an outgoing SMTP connection to another host has
11787 been set up. It contains the local port that is being used. For incoming
11788 connections, see &$received_port$&.
11789
11790 .vitem &$smtp_active_hostname$&
11791 .vindex "&$smtp_active_hostname$&"
11792 During an incoming SMTP session, this variable contains the value of the active
11793 host name, as specified by the &%smtp_active_hostname%& option. The value of
11794 &$smtp_active_hostname$& is saved with any message that is received, so its
11795 value can be consulted during routing and delivery.
11796
11797 .vitem &$smtp_command$&
11798 .vindex "&$smtp_command$&"
11799 During the processing of an incoming SMTP command, this variable contains the
11800 entire command. This makes it possible to distinguish between HELO and EHLO in
11801 the HELO ACL, and also to distinguish between commands such as these:
11802 .code
11803 MAIL FROM:<>
11804 MAIL FROM: <>
11805 .endd
11806 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11807 command, the address in &$smtp_command$& is the original address before any
11808 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11809 the address after SMTP-time rewriting.
11810
11811 .vitem &$smtp_command_argument$&
11812 .cindex "SMTP" "command, argument for"
11813 .vindex "&$smtp_command_argument$&"
11814 While an ACL is running to check an SMTP command, this variable contains the
11815 argument, that is, the text that follows the command name, with leading white
11816 space removed. Following the introduction of &$smtp_command$&, this variable is
11817 somewhat redundant, but is retained for backwards compatibility.
11818
11819 .vitem &$smtp_count_at_connection_start$&
11820 .vindex "&$smtp_count_at_connection_start$&"
11821 This variable is set greater than zero only in processes spawned by the Exim
11822 daemon for handling incoming SMTP connections. The name is deliberately long,
11823 in order to emphasize what the contents are. When the daemon accepts a new
11824 connection, it increments this variable. A copy of the variable is passed to
11825 the child process that handles the connection, but its value is fixed, and
11826 never changes. It is only an approximation of how many incoming connections
11827 there actually are, because many other connections may come and go while a
11828 single connection is being processed. When a child process terminates, the
11829 daemon decrements its copy of the variable.
11830
11831 .vitem "&$sn0$& &-- &$sn9$&"
11832 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11833 that were current at the end of the system filter file. This allows a system
11834 filter file to set values that can be tested in users' filter files. For
11835 example, a system filter could set a value indicating how likely it is that a
11836 message is junk mail.
11837
11838 .vitem &$spam_$&&'xxx'&
11839 A number of variables whose names start with &$spam$& are available when Exim
11840 is compiled with the content-scanning extension. For details, see section
11841 &<<SECTscanspamass>>&.
11842
11843
11844 .vitem &$spool_directory$&
11845 .vindex "&$spool_directory$&"
11846 The name of Exim's spool directory.
11847
11848 .vitem &$spool_inodes$&
11849 .vindex "&$spool_inodes$&"
11850 The number of free inodes in the disk partition where Exim's spool files are
11851 being written. The value is recalculated whenever the variable is referenced.
11852 If the relevant file system does not have the concept of inodes, the value of
11853 is -1. See also the &%check_spool_inodes%& option.
11854
11855 .vitem &$spool_space$&
11856 .vindex "&$spool_space$&"
11857 The amount of free space (as a number of kilobytes) in the disk partition where
11858 Exim's spool files are being written. The value is recalculated whenever the
11859 variable is referenced. If the operating system does not have the ability to
11860 find the amount of free space (only true for experimental systems), the space
11861 value is -1. For example, to check in an ACL that there is at least 50
11862 megabytes free on the spool, you could write:
11863 .code
11864 condition = ${if > {$spool_space}{50000}}
11865 .endd
11866 See also the &%check_spool_space%& option.
11867
11868
11869 .vitem &$thisaddress$&
11870 .vindex "&$thisaddress$&"
11871 This variable is set only during the processing of the &%foranyaddress%&
11872 command in a filter file. Its use is explained in the description of that
11873 command, which can be found in the separate document entitled &'Exim's
11874 interfaces to mail filtering'&.
11875
11876 .new
11877 .vitem &$tls_bits$&
11878 .vindex "&$tls_bits$&"
11879 Contains an approximation of the TLS cipher's bit-strength; the meaning of
11880 this depends upon the TLS implementation used.
11881 If TLS has not been negotiated, the value will be 0.
11882 The value of this is automatically fed into the Cyrus SASL authenticator
11883 when acting as a server, to specify the "external SSF" (a SASL term).
11884 .wen
11885
11886 .vitem &$tls_certificate_verified$&
11887 .vindex "&$tls_certificate_verified$&"
11888 This variable is set to &"1"& if a TLS certificate was verified when the
11889 message was received, and &"0"& otherwise.
11890
11891 .vitem &$tls_cipher$&
11892 .vindex "&$tls_cipher$&"
11893 When a message is received from a remote host over an encrypted SMTP
11894 connection, this variable is set to the cipher suite that was negotiated, for
11895 example DES-CBC3-SHA. In other circumstances, in particular, for message
11896 received over unencrypted connections, the variable is empty. Testing
11897 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11898 non-encrypted connections during ACL processing.
11899
11900 The &$tls_cipher$& variable retains its value during message delivery, except
11901 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11902 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11903 and then set to the outgoing cipher suite if one is negotiated. See chapter
11904 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11905 details of the &(smtp)& transport.
11906
11907 .vitem &$tls_peerdn$&
11908 .vindex "&$tls_peerdn$&"
11909 When a message is received from a remote host over an encrypted SMTP
11910 connection, and Exim is configured to request a certificate from the client,
11911 the value of the Distinguished Name of the certificate is made available in the
11912 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11913 value is retained during message delivery, except during outbound SMTP
11914 deliveries.
11915
11916 .new
11917 .vitem &$tls_sni$&
11918 .vindex "&$tls_sni$&"
11919 .cindex "TLS" "Server Name Indication"
11920 When a TLS session is being established, if the client sends the Server
11921 Name Indication extension, the value will be placed in this variable.
11922 If the variable appears in &%tls_certificate%& then this option and
11923 some others, described in &<<SECTtlssni>>&,
11924 will be re-expanded early in the TLS session, to permit
11925 a different certificate to be presented (and optionally a different key to be
11926 used) to the client, based upon the value of the SNI extension.
11927
11928 The value will be retained for the lifetime of the message.  During outbound
11929 SMTP deliveries, it reflects the value of the &%tls_sni%& option on
11930 the transport.
11931
11932 This is currently only available when using OpenSSL, built with support for
11933 SNI.
11934 .wen
11935
11936 .vitem &$tod_bsdinbox$&
11937 .vindex "&$tod_bsdinbox$&"
11938 The time of day and the date, in the format required for BSD-style mailbox
11939 files, for example: Thu Oct 17 17:14:09 1995.
11940
11941 .vitem &$tod_epoch$&
11942 .vindex "&$tod_epoch$&"
11943 The time and date as a number of seconds since the start of the Unix epoch.
11944
11945 .vitem &$tod_full$&
11946 .vindex "&$tod_full$&"
11947 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11948 +0100. The timezone is always given as a numerical offset from UTC, with
11949 positive values used for timezones that are ahead (east) of UTC, and negative
11950 values for those that are behind (west).
11951
11952 .vitem &$tod_log$&
11953 .vindex "&$tod_log$&"
11954 The time and date in the format used for writing Exim's log files, for example:
11955 1995-10-12 15:32:29, but without a timezone.
11956
11957 .vitem &$tod_logfile$&
11958 .vindex "&$tod_logfile$&"
11959 This variable contains the date in the format yyyymmdd. This is the format that
11960 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11961 flag.
11962
11963 .vitem &$tod_zone$&
11964 .vindex "&$tod_zone$&"
11965 This variable contains the numerical value of the local timezone, for example:
11966 -0500.
11967
11968 .vitem &$tod_zulu$&
11969 .vindex "&$tod_zulu$&"
11970 This variable contains the UTC date and time in &"Zulu"& format, as specified
11971 by ISO 8601, for example: 20030221154023Z.
11972
11973 .vitem &$value$&
11974 .vindex "&$value$&"
11975 This variable contains the result of an expansion lookup, extraction operation,
11976 or external command, as described above. It is also used during a
11977 &*reduce*& expansion.
11978
11979 .vitem &$version_number$&
11980 .vindex "&$version_number$&"
11981 The version number of Exim.
11982
11983 .vitem &$warn_message_delay$&
11984 .vindex "&$warn_message_delay$&"
11985 This variable is set only during the creation of a message warning about a
11986 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11987
11988 .vitem &$warn_message_recipients$&
11989 .vindex "&$warn_message_recipients$&"
11990 This variable is set only during the creation of a message warning about a
11991 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11992 .endlist
11993 .ecindex IIDstrexp
11994
11995
11996
11997 . ////////////////////////////////////////////////////////////////////////////
11998 . ////////////////////////////////////////////////////////////////////////////
11999
12000 .chapter "Embedded Perl" "CHAPperl"
12001 .scindex IIDperl "Perl" "calling from Exim"
12002 Exim can be built to include an embedded Perl interpreter. When this is done,
12003 Perl subroutines can be called as part of the string expansion process. To make
12004 use of the Perl support, you need version 5.004 or later of Perl installed on
12005 your system. To include the embedded interpreter in the Exim binary, include
12006 the line
12007 .code
12008 EXIM_PERL = perl.o
12009 .endd
12010 in your &_Local/Makefile_& and then build Exim in the normal way.
12011
12012
12013 .section "Setting up so Perl can be used" "SECID85"
12014 .oindex "&%perl_startup%&"
12015 Access to Perl subroutines is via a global configuration option called
12016 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12017 no &%perl_startup%& option in the Exim configuration file then no Perl
12018 interpreter is started and there is almost no overhead for Exim (since none of
12019 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12020 option then the associated value is taken to be Perl code which is executed in
12021 a newly created Perl interpreter.
12022
12023 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12024 need backslashes before any characters to escape special meanings. The option
12025 should usually be something like
12026 .code
12027 perl_startup = do '/etc/exim.pl'
12028 .endd
12029 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12030 use from Exim. Exim can be configured either to start up a Perl interpreter as
12031 soon as it is entered, or to wait until the first time it is needed. Starting
12032 the interpreter at the beginning ensures that it is done while Exim still has
12033 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12034 fact used in a particular run. Also, note that this does not mean that Exim is
12035 necessarily running as root when Perl is called at a later time. By default,
12036 the interpreter is started only when it is needed, but this can be changed in
12037 two ways:
12038
12039 .ilist
12040 .oindex "&%perl_at_start%&"
12041 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12042 a startup when Exim is entered.
12043 .next
12044 The command line option &%-ps%& also requests a startup when Exim is entered,
12045 overriding the setting of &%perl_at_start%&.
12046 .endlist
12047
12048 There is also a command line option &%-pd%& (for delay) which suppresses the
12049 initial startup, even if &%perl_at_start%& is set.
12050
12051
12052 .section "Calling Perl subroutines" "SECID86"
12053 When the configuration file includes a &%perl_startup%& option you can make use
12054 of the string expansion item to call the Perl subroutines that are defined
12055 by the &%perl_startup%& code. The operator is used in any of the following
12056 forms:
12057 .code
12058 ${perl{foo}}
12059 ${perl{foo}{argument}}
12060 ${perl{foo}{argument1}{argument2} ... }
12061 .endd
12062 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12063 arguments may be passed. Passing more than this results in an expansion failure
12064 with an error message of the form
12065 .code
12066 Too many arguments passed to Perl subroutine "foo" (max is 8)
12067 .endd
12068 The return value of the Perl subroutine is evaluated in a scalar context before
12069 it is passed back to Exim to be inserted into the expanded string. If the
12070 return value is &'undef'&, the expansion is forced to fail in the same way as
12071 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12072 by obeying Perl's &%die%& function, the expansion fails with the error message
12073 that was passed to &%die%&.
12074
12075
12076 .section "Calling Exim functions from Perl" "SECID87"
12077 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12078 is available to call back into Exim's string expansion function. For example,
12079 the Perl code
12080 .code
12081 my $lp = Exim::expand_string('$local_part');
12082 .endd
12083 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12084 Note those are single quotes and not double quotes to protect against
12085 &$local_part$& being interpolated as a Perl variable.
12086
12087 If the string expansion is forced to fail by a &"fail"& item, the result of
12088 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12089 expansion string, the Perl call from the original expansion string fails with
12090 an appropriate error message, in the same way as if &%die%& were used.
12091
12092 .cindex "debugging" "from embedded Perl"
12093 .cindex "log" "writing from embedded Perl"
12094 Two other Exim functions are available for use from within Perl code.
12095 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12096 debugging is enabled. If you want a newline at the end, you must supply it.
12097 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12098 timestamp. In this case, you should not supply a terminating newline.
12099
12100
12101 .section "Use of standard output and error by Perl" "SECID88"
12102 .cindex "Perl" "standard output and error"
12103 You should not write to the standard error or output streams from within your
12104 Perl code, as it is not defined how these are set up. In versions of Exim
12105 before 4.50, it is possible for the standard output or error to refer to the
12106 SMTP connection during message reception via the daemon. Writing to this stream
12107 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12108 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12109 avoided, but the output is lost.
12110
12111 .cindex "Perl" "use of &%warn%&"
12112 The Perl &%warn%& statement writes to the standard error stream by default.
12113 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12114 you have no control. When Exim starts up the Perl interpreter, it arranges for
12115 output from the &%warn%& statement to be written to the Exim main log. You can
12116 change this by including appropriate Perl magic somewhere in your Perl code.
12117 For example, to discard &%warn%& output completely, you need this:
12118 .code
12119 $SIG{__WARN__} = sub { };
12120 .endd
12121 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12122 example, the code for the subroutine is empty, so it does nothing, but you can
12123 include any Perl code that you like. The text of the &%warn%& message is passed
12124 as the first subroutine argument.
12125 .ecindex IIDperl
12126
12127
12128 . ////////////////////////////////////////////////////////////////////////////
12129 . ////////////////////////////////////////////////////////////////////////////
12130
12131 .chapter "Starting the daemon and the use of network interfaces" &&&
12132          "CHAPinterfaces" &&&
12133          "Starting the daemon"
12134 .cindex "daemon" "starting"
12135 .cindex "interface" "listening"
12136 .cindex "network interface"
12137 .cindex "interface" "network"
12138 .cindex "IP address" "for listening"
12139 .cindex "daemon" "listening IP addresses"
12140 .cindex "TCP/IP" "setting listening interfaces"
12141 .cindex "TCP/IP" "setting listening ports"
12142 A host that is connected to a TCP/IP network may have one or more physical
12143 hardware network interfaces. Each of these interfaces may be configured as one
12144 or more &"logical"& interfaces, which are the entities that a program actually
12145 works with. Each of these logical interfaces is associated with an IP address.
12146 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12147 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12148 knowledge about the host's interfaces for use in three different circumstances:
12149
12150 .olist
12151 When a listening daemon is started, Exim needs to know which interfaces
12152 and ports to listen on.
12153 .next
12154 When Exim is routing an address, it needs to know which IP addresses
12155 are associated with local interfaces. This is required for the correct
12156 processing of MX lists by removing the local host and others with the
12157 same or higher priority values. Also, Exim needs to detect cases
12158 when an address is routed to an IP address that in fact belongs to the
12159 local host. Unless the &%self%& router option or the &%allow_localhost%&
12160 option of the smtp transport is set (as appropriate), this is treated
12161 as an error situation.
12162 .next
12163 When Exim connects to a remote host, it may need to know which interface to use
12164 for the outgoing connection.
12165 .endlist
12166
12167
12168 Exim's default behaviour is likely to be appropriate in the vast majority
12169 of cases. If your host has only one interface, and you want all its IP
12170 addresses to be treated in the same way, and you are using only the
12171 standard SMTP port, you should not need to take any special action. The
12172 rest of this chapter does not apply to you.
12173
12174 In a more complicated situation you may want to listen only on certain
12175 interfaces, or on different ports, and for this reason there are a number of
12176 options that can be used to influence Exim's behaviour. The rest of this
12177 chapter describes how they operate.
12178
12179 When a message is received over TCP/IP, the interface and port that were
12180 actually used are set in &$received_ip_address$& and &$received_port$&.
12181
12182
12183
12184 .section "Starting a listening daemon" "SECID89"
12185 When a listening daemon is started (by means of the &%-bd%& command line
12186 option), the interfaces and ports on which it listens are controlled by the
12187 following options:
12188
12189 .ilist
12190 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12191 compatibility, this option can also be specified in the singular.)
12192 .next
12193 &%local_interfaces%& contains list of interface IP addresses on which to
12194 listen. Each item may optionally also specify a port.
12195 .endlist
12196
12197 The default list separator in both cases is a colon, but this can be changed as
12198 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12199 it is usually best to change the separator to avoid having to double all the
12200 colons. For example:
12201 .code
12202 local_interfaces = <; 127.0.0.1 ; \
12203                       192.168.23.65 ; \
12204                       ::1 ; \
12205                       3ffe:ffff:836f::fe86:a061
12206 .endd
12207 There are two different formats for specifying a port along with an IP address
12208 in &%local_interfaces%&:
12209
12210 .olist
12211 The port is added onto the address with a dot separator. For example, to listen
12212 on port 1234 on two different IP addresses:
12213 .code
12214 local_interfaces = <; 192.168.23.65.1234 ; \
12215                       3ffe:ffff:836f::fe86:a061.1234
12216 .endd
12217 .next
12218 The IP address is enclosed in square brackets, and the port is added
12219 with a colon separator, for example:
12220 .code
12221 local_interfaces = <; [192.168.23.65]:1234 ; \
12222                       [3ffe:ffff:836f::fe86:a061]:1234
12223 .endd
12224 .endlist
12225
12226 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12227 default setting contains just one port:
12228 .code
12229 daemon_smtp_ports = smtp
12230 .endd
12231 If more than one port is listed, each interface that does not have its own port
12232 specified listens on all of them. Ports that are listed in
12233 &%daemon_smtp_ports%& can be identified either by name (defined in
12234 &_/etc/services_&) or by number. However, when ports are given with individual
12235 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12236
12237
12238
12239 .section "Special IP listening addresses" "SECID90"
12240 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12241 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12242 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12243 instead of setting up separate listening sockets for each interface. The
12244 default value of &%local_interfaces%& is
12245 .code
12246 local_interfaces = 0.0.0.0
12247 .endd
12248 when Exim is built without IPv6 support; otherwise it is:
12249 .code
12250 local_interfaces = <; ::0 ; 0.0.0.0
12251 .endd
12252 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12253
12254
12255
12256 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12257 The &%-oX%& command line option can be used to override the values of
12258 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12259 instance. Another way of doing this would be to use macros and the &%-D%&
12260 option. However, &%-oX%& can be used by any admin user, whereas modification of
12261 the runtime configuration by &%-D%& is allowed only when the caller is root or
12262 exim.
12263
12264 The value of &%-oX%& is a list of items. The default colon separator can be
12265 changed in the usual way if required. If there are any items that do not
12266 contain dots or colons (that is, are not IP addresses), the value of
12267 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12268 items that do contain dots or colons, the value of &%local_interfaces%& is
12269 replaced by those items. Thus, for example,
12270 .code
12271 -oX 1225
12272 .endd
12273 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12274 whereas
12275 .code
12276 -oX 192.168.34.5.1125
12277 .endd
12278 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12279 (However, since &%local_interfaces%& now contains no items without ports, the
12280 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12281
12282
12283
12284 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12285 .cindex "ssmtp protocol"
12286 .cindex "smtps protocol"
12287 .cindex "SMTP" "ssmtp protocol"
12288 .cindex "SMTP" "smtps protocol"
12289 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12290 before the STARTTLS command was standardized for SMTP. Some legacy clients
12291 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12292 list of port numbers, connections to those ports must use SSMTP. The most
12293 common use of this option is expected to be
12294 .code
12295 tls_on_connect_ports = 465
12296 .endd
12297 because 465 is the usual port number used by the legacy clients. There is also
12298 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12299 this way when a daemon is started.
12300
12301 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12302 daemon to listen on those ports. You must still specify them in
12303 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12304 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12305 connections via the daemon.)
12306
12307
12308
12309
12310 .section "IPv6 address scopes" "SECID92"
12311 .cindex "IPv6" "address scopes"
12312 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12313 can, in principle, have the same link-local IPv6 address on different
12314 interfaces. Thus, additional information is needed, over and above the IP
12315 address, to distinguish individual interfaces. A convention of using a
12316 percent sign followed by something (often the interface name) has been
12317 adopted in some cases, leading to addresses like this:
12318 .code
12319 fe80::202:b3ff:fe03:45c1%eth0
12320 .endd
12321 To accommodate this usage, a percent sign followed by an arbitrary string is
12322 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12323 to convert a textual IPv6 address for actual use. This function recognizes the
12324 percent convention in operating systems that support it, and it processes the
12325 address appropriately. Unfortunately, some older libraries have problems with
12326 &[getaddrinfo()]&. If
12327 .code
12328 IPV6_USE_INET_PTON=yes
12329 .endd
12330 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12331 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12332 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12333 function.) Of course, this means that the additional functionality of
12334 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12335
12336 .section "Disabling IPv6" "SECID93"
12337 .cindex "IPv6" "disabling"
12338 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12339 run on a host whose kernel does not support IPv6. The binary will fall back to
12340 using IPv4, but it may waste resources looking up AAAA records, and trying to
12341 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12342 .oindex "&%disable_ipv6%&"
12343 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12344 activities take place. AAAA records are never looked up, and any IPv6 addresses
12345 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12346 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12347 to handle IPv6 literal addresses.
12348
12349 On the other hand, when IPv6 is in use, there may be times when you want to
12350 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12351 option to globally suppress the lookup of AAAA records for specified domains,
12352 and you can use the &%ignore_target_hosts%& generic router option to ignore
12353 IPv6 addresses in an individual router.
12354
12355
12356
12357 .section "Examples of starting a listening daemon" "SECID94"
12358 The default case in an IPv6 environment is
12359 .code
12360 daemon_smtp_ports = smtp
12361 local_interfaces = <; ::0 ; 0.0.0.0
12362 .endd
12363 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12364 Either one or two sockets may be used, depending on the characteristics of
12365 the TCP/IP stack. (This is complicated and messy; for more information,
12366 read the comments in the &_daemon.c_& source file.)
12367
12368 To specify listening on ports 25 and 26 on all interfaces:
12369 .code
12370 daemon_smtp_ports = 25 : 26
12371 .endd
12372 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12373 .code
12374 local_interfaces = <; ::0.25     ; ::0.26 \
12375                       0.0.0.0.25 ; 0.0.0.0.26
12376 .endd
12377 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12378 IPv4 loopback address only:
12379 .code
12380 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12381 .endd
12382 To specify listening on the default port on specific interfaces only:
12383 .code
12384 local_interfaces = 192.168.34.67 : 192.168.34.67
12385 .endd
12386 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12387
12388
12389
12390 .section "Recognizing the local host" "SECTreclocipadd"
12391 The &%local_interfaces%& option is also used when Exim needs to determine
12392 whether or not an IP address refers to the local host. That is, the IP
12393 addresses of all the interfaces on which a daemon is listening are always
12394 treated as local.
12395
12396 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12397 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12398 available interfaces from the operating system, and extracts the relevant
12399 (that is, IPv4 or IPv6) addresses to use for checking.
12400
12401 Some systems set up large numbers of virtual interfaces in order to provide
12402 many virtual web servers. In this situation, you may want to listen for
12403 email on only a few of the available interfaces, but nevertheless treat all
12404 interfaces as local when routing. You can do this by setting
12405 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12406 &"all"& wildcard values. These addresses are recognized as local, but are not
12407 used for listening. Consider this example:
12408 .code
12409 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12410                       192.168.53.235 ; \
12411                       3ffe:2101:12:1:a00:20ff:fe86:a061
12412
12413 extra_local_interfaces = <; ::0 ; 0.0.0.0
12414 .endd
12415 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12416 address, but all available interface addresses are treated as local when
12417 Exim is routing.
12418
12419 In some environments the local host name may be in an MX list, but with an IP
12420 address that is not assigned to any local interface. In other cases it may be
12421 desirable to treat other host names as if they referred to the local host. Both
12422 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12423 This contains host names rather than IP addresses. When a host is referenced
12424 during routing, either via an MX record or directly, it is treated as the local
12425 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12426 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12427
12428
12429
12430 .section "Delivering to a remote host" "SECID95"
12431 Delivery to a remote host is handled by the smtp transport. By default, it
12432 allows the system's TCP/IP functions to choose which interface to use (if
12433 there is more than one) when connecting to a remote host. However, the
12434 &%interface%& option can be set to specify which interface is used. See the
12435 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12436 details.
12437
12438
12439
12440
12441 . ////////////////////////////////////////////////////////////////////////////
12442 . ////////////////////////////////////////////////////////////////////////////
12443
12444 .chapter "Main configuration" "CHAPmainconfig"
12445 .scindex IIDconfima "configuration file" "main section"
12446 .scindex IIDmaiconf "main configuration"
12447 The first part of the run time configuration file contains three types of item:
12448
12449 .ilist
12450 Macro definitions: These lines start with an upper case letter. See section
12451 &<<SECTmacrodefs>>& for details of macro processing.
12452 .next
12453 Named list definitions: These lines start with one of the words &"domainlist"&,
12454 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12455 section &<<SECTnamedlists>>&.
12456 .next
12457 Main configuration settings: Each setting occupies one line of the file
12458 (with possible continuations). If any setting is preceded by the word
12459 &"hide"&, the &%-bP%& command line option displays its value to admin users
12460 only. See section &<<SECTcos>>& for a description of the syntax of these option
12461 settings.
12462 .endlist
12463
12464 This chapter specifies all the main configuration options, along with their
12465 types and default values. For ease of finding a particular option, they appear
12466 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12467 are now so many options, they are first listed briefly in functional groups, as
12468 an aid to finding the name of the option you are looking for. Some options are
12469 listed in more than one group.
12470
12471 .section "Miscellaneous" "SECID96"
12472 .table2
12473 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12474 .row &%disable_ipv6%&                "do no IPv6 processing"
12475 .row &%keep_malformed%&              "for broken files &-- should not happen"
12476 .row &%localhost_number%&            "for unique message ids in clusters"
12477 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12478 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12479 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12480 .row &%print_topbitchars%&           "top-bit characters are printing"
12481 .row &%timezone%&                    "force time zone"
12482 .endtable
12483
12484
12485 .section "Exim parameters" "SECID97"
12486 .table2
12487 .row &%exim_group%&                  "override compiled-in value"
12488 .row &%exim_path%&                   "override compiled-in value"
12489 .row &%exim_user%&                   "override compiled-in value"
12490 .row &%primary_hostname%&            "default from &[uname()]&"
12491 .row &%split_spool_directory%&       "use multiple directories"
12492 .row &%spool_directory%&             "override compiled-in value"
12493 .endtable
12494
12495
12496
12497 .section "Privilege controls" "SECID98"
12498 .table2
12499 .row &%admin_groups%&                "groups that are Exim admin users"
12500 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12501 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12502 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12503 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12504 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12505 .row &%never_users%&                 "do not run deliveries as these"
12506 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12507 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12508 .row &%trusted_groups%&              "groups that are trusted"
12509 .row &%trusted_users%&               "users that are trusted"
12510 .endtable
12511
12512
12513
12514 .section "Logging" "SECID99"
12515 .table2
12516 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12517 .row &%log_file_path%&               "override compiled-in value"
12518 .row &%log_selector%&                "set/unset optional logging"
12519 .row &%log_timezone%&                "add timezone to log lines"
12520 .row &%message_logs%&                "create per-message logs"
12521 .row &%preserve_message_logs%&       "after message completion"
12522 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12523 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12524 .row &%syslog_facility%&             "set syslog &""facility""& field"
12525 .row &%syslog_processname%&          "set syslog &""ident""& field"
12526 .row &%syslog_timestamp%&            "timestamp syslog lines"
12527 .row &%write_rejectlog%&             "control use of message log"
12528 .endtable
12529
12530
12531
12532 .section "Frozen messages" "SECID100"
12533 .table2
12534 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12535 .row &%freeze_tell%&                 "send message when freezing"
12536 .row &%move_frozen_messages%&        "to another directory"
12537 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12538 .endtable
12539
12540
12541
12542 .section "Data lookups" "SECID101"
12543 .table2
12544 .row &%ibase_servers%&               "InterBase servers"
12545 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12546 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12547 .row &%ldap_cert_file%&              "client cert file for LDAP"
12548 .row &%ldap_cert_key%&               "client key file for LDAP"
12549 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12550 .row &%ldap_default_servers%&        "used if no server in query"
12551 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12552 .row &%ldap_start_tls%&              "require TLS within LDAP"
12553 .row &%ldap_version%&                "set protocol version"
12554 .row &%lookup_open_max%&             "lookup files held open"
12555 .row &%mysql_servers%&               "default MySQL servers"
12556 .row &%oracle_servers%&              "Oracle servers"
12557 .row &%pgsql_servers%&               "default PostgreSQL servers"
12558 .row &%sqlite_lock_timeout%&         "as it says"
12559 .endtable
12560
12561
12562
12563 .section "Message ids" "SECID102"
12564 .table2
12565 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12566 .row &%message_id_header_text%&      "ditto"
12567 .endtable
12568
12569
12570
12571 .section "Embedded Perl Startup" "SECID103"
12572 .table2
12573 .row &%perl_at_start%&               "always start the interpreter"
12574 .row &%perl_startup%&                "code to obey when starting Perl"
12575 .endtable
12576
12577
12578
12579 .section "Daemon" "SECID104"
12580 .table2
12581 .row &%daemon_smtp_ports%&           "default ports"
12582 .row &%daemon_startup_retries%&      "number of times to retry"
12583 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12584 .row &%extra_local_interfaces%&      "not necessarily listened on"
12585 .row &%local_interfaces%&            "on which to listen, with optional ports"
12586 .row &%pid_file_path%&               "override compiled-in value"
12587 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12588 .endtable
12589
12590
12591
12592 .section "Resource control" "SECID105"
12593 .table2
12594 .row &%check_log_inodes%&            "before accepting a message"
12595 .row &%check_log_space%&             "before accepting a message"
12596 .row &%check_spool_inodes%&          "before accepting a message"
12597 .row &%check_spool_space%&           "before accepting a message"
12598 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12599 .row &%queue_only_load%&             "queue incoming if load high"
12600 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12601 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12602 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12603 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12604 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12605 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12606 .row &%smtp_accept_max_per_connection%& "messages per connection"
12607 .row &%smtp_accept_max_per_host%&    "connections from one host"
12608 .row &%smtp_accept_queue%&           "queue mail if more connections"
12609 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12610                                            connection"
12611 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12612 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12613 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12614 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12615 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12616 .endtable
12617
12618
12619
12620 .section "Policy controls" "SECID106"
12621 .table2
12622 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12623 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12624 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12625 .row &%acl_smtp_auth%&               "ACL for AUTH"
12626 .row &%acl_smtp_connect%&            "ACL for connection"
12627 .row &%acl_smtp_data%&               "ACL for DATA"
12628 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12629 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12630 .row &%acl_smtp_expn%&               "ACL for EXPN"
12631 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12632 .row &%acl_smtp_mail%&               "ACL for MAIL"
12633 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12634 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12635 .row &%acl_smtp_predata%&            "ACL for start of data"
12636 .row &%acl_smtp_quit%&               "ACL for QUIT"
12637 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12638 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12639 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12640 .row &%av_scanner%&                  "specify virus scanner"
12641 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12642                                       words""&"
12643 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12644 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12645 .row &%header_maxsize%&              "total size of message header"
12646 .row &%header_line_maxsize%&         "individual header line limit"
12647 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12648 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12649 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12650 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12651 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12652 .row &%host_lookup%&                 "host name looked up for these hosts"
12653 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12654 .row &%host_reject_connection%&      "reject connection from these hosts"
12655 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12656 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12657 .row &%message_size_limit%&          "for all messages"
12658 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12659 .row &%spamd_address%&               "set interface to SpamAssassin"
12660 .row &%strict_acl_vars%&             "object to unset ACL variables"
12661 .endtable
12662
12663
12664
12665 .section "Callout cache" "SECID107"
12666 .table2
12667 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12668                                          item"
12669 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12670                                          item"
12671 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12672 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12673 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12674 .endtable
12675
12676
12677
12678 .section "TLS" "SECID108"
12679 .table2
12680 .row &%gnutls_require_kx%&           "control GnuTLS key exchanges"
12681 .row &%gnutls_require_mac%&          "control GnuTLS MAC algorithms"
12682 .row &%gnutls_require_protocols%&    "control GnuTLS protocols"
12683 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12684 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12685 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12686 .row &%tls_certificate%&             "location of server certificate"
12687 .row &%tls_crl%&                     "certificate revocation list"
12688 .row &%tls_dhparam%&                 "DH parameters for server"
12689 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12690 .row &%tls_privatekey%&              "location of server private key"
12691 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12692 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12693 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12694 .row &%tls_verify_certificates%&     "expected client certificates"
12695 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12696 .endtable
12697
12698
12699
12700 .section "Local user handling" "SECID109"
12701 .table2
12702 .row &%finduser_retries%&            "useful in NIS environments"
12703 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12704 .row &%gecos_pattern%&               "ditto"
12705 .row &%max_username_length%&         "for systems that truncate"
12706 .row &%unknown_login%&               "used when no login name found"
12707 .row &%unknown_username%&            "ditto"
12708 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12709 .row &%uucp_from_sender%&            "ditto"
12710 .endtable
12711
12712
12713
12714 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12715 .table2
12716 .row &%header_maxsize%&              "total size of message header"
12717 .row &%header_line_maxsize%&         "individual header line limit"
12718 .row &%message_size_limit%&          "applies to all messages"
12719 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12720 .row &%received_header_text%&        "expanded to make &'Received:'&"
12721 .row &%received_headers_max%&        "for mail loop detection"
12722 .row &%recipients_max%&              "limit per message"
12723 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12724 .endtable
12725
12726
12727
12728
12729 .section "Non-SMTP incoming messages" "SECID111"
12730 .table2
12731 .row &%receive_timeout%&             "for non-SMTP messages"
12732 .endtable
12733
12734
12735
12736
12737
12738 .section "Incoming SMTP messages" "SECID112"
12739 See also the &'Policy controls'& section above.
12740
12741 .table2
12742 .row &%host_lookup%&                 "host name looked up for these hosts"
12743 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12744 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12745 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12746 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12747 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12748 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12749 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12750 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12751 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12752 .row &%smtp_accept_max_per_connection%& "messages per connection"
12753 .row &%smtp_accept_max_per_host%&    "connections from one host"
12754 .row &%smtp_accept_queue%&           "queue mail if more connections"
12755 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12756                                            connection"
12757 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12758 .row &%smtp_active_hostname%&        "host name to use in messages"
12759 .row &%smtp_banner%&                 "text for welcome banner"
12760 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12761 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12762 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12763 .row &%smtp_etrn_command%&           "what to run for ETRN"
12764 .row &%smtp_etrn_serialize%&         "only one at once"
12765 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12766 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12767 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12768 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12769 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12770 .row &%smtp_receive_timeout%&        "per command or data line"
12771 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12772 .row &%smtp_return_error_details%&   "give detail on rejections"
12773 .endtable
12774
12775
12776
12777 .section "SMTP extensions" "SECID113"
12778 .table2
12779 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12780 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12781 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12782 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12783 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12784 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12785 .endtable
12786
12787
12788
12789 .section "Processing messages" "SECID114"
12790 .table2
12791 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12792 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12793 .row &%allow_utf8_domains%&          "in addresses"
12794 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12795                                       words""&"
12796 .row &%delivery_date_remove%&        "from incoming messages"
12797 .row &%envelope_to_remove%&          "from incoming messages"
12798 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12799 .row &%headers_charset%&             "default for translations"
12800 .row &%qualify_domain%&              "default for senders"
12801 .row &%qualify_recipient%&           "default for recipients"
12802 .row &%return_path_remove%&          "from incoming messages"
12803 .row &%strip_excess_angle_brackets%& "in addresses"
12804 .row &%strip_trailing_dot%&          "at end of addresses"
12805 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12806 .endtable
12807
12808
12809
12810 .section "System filter" "SECID115"
12811 .table2
12812 .row &%system_filter%&               "locate system filter"
12813 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12814                                             directory"
12815 .row &%system_filter_file_transport%& "transport for delivery to a file"
12816 .row &%system_filter_group%&         "group for filter running"
12817 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12818 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12819 .row &%system_filter_user%&          "user for filter running"
12820 .endtable
12821
12822
12823
12824 .section "Routing and delivery" "SECID116"
12825 .table2
12826 .row &%disable_ipv6%&                "do no IPv6 processing"
12827 .row &%dns_again_means_nonexist%&    "for broken domains"
12828 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12829 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12830 .row &%dns_retrans%&                 "parameter for resolver"
12831 .row &%dns_retry%&                   "parameter for resolver"
12832 .row &%dns_use_edns0%&               "parameter for resolver"
12833 .row &%hold_domains%&                "hold delivery for these domains"
12834 .row &%local_interfaces%&            "for routing checks"
12835 .row &%queue_domains%&               "no immediate delivery for these"
12836 .row &%queue_only%&                  "no immediate delivery at all"
12837 .row &%queue_only_file%&             "no immediate delivery if file exists"
12838 .row &%queue_only_load%&             "no immediate delivery if load is high"
12839 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12840 .row &%queue_only_override%&         "allow command line to override"
12841 .row &%queue_run_in_order%&          "order of arrival"
12842 .row &%queue_run_max%&               "of simultaneous queue runners"
12843 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12844 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12845 .row &%remote_sort_domains%&         "order of remote deliveries"
12846 .row &%retry_data_expire%&           "timeout for retry data"
12847 .row &%retry_interval_max%&          "safety net for retry rules"
12848 .endtable
12849
12850
12851
12852 .section "Bounce and warning messages" "SECID117"
12853 .table2
12854 .row &%bounce_message_file%&         "content of bounce"
12855 .row &%bounce_message_text%&         "content of bounce"
12856 .row &%bounce_return_body%&          "include body if returning message"
12857 .row &%bounce_return_message%&       "include original message in bounce"
12858 .row &%bounce_return_size_limit%&    "limit on returned message"
12859 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12860 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12861 .row &%errors_copy%&                 "copy bounce messages"
12862 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12863 .row &%delay_warning%&               "time schedule"
12864 .row &%delay_warning_condition%&     "condition for warning messages"
12865 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12866 .row &%smtp_return_error_details%&   "give detail on rejections"
12867 .row &%warn_message_file%&           "content of warning message"
12868 .endtable
12869
12870
12871
12872 .section "Alphabetical list of main options" "SECTalomo"
12873 Those options that undergo string expansion before use are marked with
12874 &dagger;.
12875
12876 .new
12877 .option accept_8bitmime main boolean true
12878 .cindex "8BITMIME"
12879 .cindex "8-bit characters"
12880 This option causes Exim to send 8BITMIME in its response to an SMTP
12881 EHLO command, and to accept the BODY= parameter on MAIL commands.
12882 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12883 takes no steps to do anything special with messages received by this route.
12884
12885 Historically Exim kept this option off by default, but the maintainers
12886 feel that in today's Internet, this causes more problems than it solves.
12887 It now defaults to true.
12888 A more detailed analysis of the issues is provided by Dan Bernstein:
12889 .display
12890 &url(http://cr.yp.to/smtp/8bitmime.html)
12891 .endd
12892 .wen
12893
12894 .option acl_not_smtp main string&!! unset
12895 .cindex "&ACL;" "for non-SMTP messages"
12896 .cindex "non-SMTP messages" "ACLs for"
12897 This option defines the ACL that is run when a non-SMTP message has been
12898 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12899 further details.
12900
12901 .option acl_not_smtp_mime main string&!! unset
12902 This option defines the ACL that is run for individual MIME parts of non-SMTP
12903 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12904 SMTP messages.
12905
12906 .option acl_not_smtp_start main string&!! unset
12907 .cindex "&ACL;" "at start of non-SMTP message"
12908 .cindex "non-SMTP messages" "ACLs for"
12909 This option defines the ACL that is run before Exim starts reading a
12910 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12911
12912 .option acl_smtp_auth main string&!! unset
12913 .cindex "&ACL;" "setting up for SMTP commands"
12914 .cindex "AUTH" "ACL for"
12915 This option defines the ACL that is run when an SMTP AUTH command is
12916 received. See chapter &<<CHAPACL>>& for further details.
12917
12918 .option acl_smtp_connect main string&!! unset
12919 .cindex "&ACL;" "on SMTP connection"
12920 This option defines the ACL that is run when an SMTP connection is received.
12921 See chapter &<<CHAPACL>>& for further details.
12922
12923 .option acl_smtp_data main string&!! unset
12924 .cindex "DATA" "ACL for"
12925 This option defines the ACL that is run after an SMTP DATA command has been
12926 processed and the message itself has been received, but before the final
12927 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12928
12929 .option acl_smtp_etrn main string&!! unset
12930 .cindex "ETRN" "ACL for"
12931 This option defines the ACL that is run when an SMTP ETRN command is
12932 received. See chapter &<<CHAPACL>>& for further details.
12933
12934 .option acl_smtp_expn main string&!! unset
12935 .cindex "EXPN" "ACL for"
12936 This option defines the ACL that is run when an SMTP EXPN command is
12937 received. See chapter &<<CHAPACL>>& for further details.
12938
12939 .option acl_smtp_helo main string&!! unset
12940 .cindex "EHLO" "ACL for"
12941 .cindex "HELO" "ACL for"
12942 This option defines the ACL that is run when an SMTP EHLO or HELO
12943 command is received. See chapter &<<CHAPACL>>& for further details.
12944
12945
12946 .option acl_smtp_mail main string&!! unset
12947 .cindex "MAIL" "ACL for"
12948 This option defines the ACL that is run when an SMTP MAIL command is
12949 received. See chapter &<<CHAPACL>>& for further details.
12950
12951 .option acl_smtp_mailauth main string&!! unset
12952 .cindex "AUTH" "on MAIL command"
12953 This option defines the ACL that is run when there is an AUTH parameter on
12954 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12955 &<<CHAPSMTPAUTH>>& for details of authentication.
12956
12957 .option acl_smtp_mime main string&!! unset
12958 .cindex "MIME content scanning" "ACL for"
12959 This option is available when Exim is built with the content-scanning
12960 extension. It defines the ACL that is run for each MIME part in a message. See
12961 section &<<SECTscanmimepart>>& for details.
12962
12963 .option acl_smtp_predata main string&!! unset
12964 This option defines the ACL that is run when an SMTP DATA command is
12965 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12966 further details.
12967
12968 .option acl_smtp_quit main string&!! unset
12969 .cindex "QUIT, ACL for"
12970 This option defines the ACL that is run when an SMTP QUIT command is
12971 received. See chapter &<<CHAPACL>>& for further details.
12972
12973 .option acl_smtp_rcpt main string&!! unset
12974 .cindex "RCPT" "ACL for"
12975 This option defines the ACL that is run when an SMTP RCPT command is
12976 received. See chapter &<<CHAPACL>>& for further details.
12977
12978 .option acl_smtp_starttls main string&!! unset
12979 .cindex "STARTTLS, ACL for"
12980 This option defines the ACL that is run when an SMTP STARTTLS command is
12981 received. See chapter &<<CHAPACL>>& for further details.
12982
12983 .option acl_smtp_vrfy main string&!! unset
12984 .cindex "VRFY" "ACL for"
12985 This option defines the ACL that is run when an SMTP VRFY command is
12986 received. See chapter &<<CHAPACL>>& for further details.
12987
12988 .option admin_groups main "string list&!!" unset
12989 .cindex "admin user"
12990 This option is expanded just once, at the start of Exim's processing. If the
12991 current group or any of the supplementary groups of an Exim caller is in this
12992 colon-separated list, the caller has admin privileges. If all your system
12993 programmers are in a specific group, for example, you can give them all Exim
12994 admin privileges by putting that group in &%admin_groups%&. However, this does
12995 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12996 To permit this, you have to add individuals to the Exim group.
12997
12998 .option allow_domain_literals main boolean false
12999 .cindex "domain literal"
13000 If this option is set, the RFC 2822 domain literal format is permitted in
13001 email addresses. The option is not set by default, because the domain literal
13002 format is not normally required these days, and few people know about it. It
13003 has, however, been exploited by mail abusers.
13004
13005 Unfortunately, it seems that some DNS black list maintainers are using this
13006 format to report black listing to postmasters. If you want to accept messages
13007 addressed to your hosts by IP address, you need to set
13008 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13009 domains (defined in the named domain list &%local_domains%& in the default
13010 configuration). This &"magic string"& matches the domain literal form of all
13011 the local host's IP addresses.
13012
13013
13014 .option allow_mx_to_ip main boolean false
13015 .cindex "MX record" "pointing to IP address"
13016 It appears that more and more DNS zone administrators are breaking the rules
13017 and putting domain names that look like IP addresses on the right hand side of
13018 MX records. Exim follows the rules and rejects this, giving an error message
13019 that explains the mis-configuration. However, some other MTAs support this
13020 practice, so to avoid &"Why can't Exim do this?"& complaints,
13021 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13022 recommended, except when you have no other choice.
13023
13024 .option allow_utf8_domains main boolean false
13025 .cindex "domain" "UTF-8 characters in"
13026 .cindex "UTF-8" "in domain name"
13027 Lots of discussion is going on about internationalized domain names. One
13028 camp is strongly in favour of just using UTF-8 characters, and it seems
13029 that at least two other MTAs permit this. This option allows Exim users to
13030 experiment if they wish.
13031
13032 If it is set true, Exim's domain parsing function allows valid
13033 UTF-8 multicharacters to appear in domain name components, in addition to
13034 letters, digits, and hyphens. However, just setting this option is not
13035 enough; if you want to look up these domain names in the DNS, you must also
13036 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13037 suitable setting is:
13038 .code
13039 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13040   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13041 .endd
13042 Alternatively, you can just disable this feature by setting
13043 .code
13044 dns_check_names_pattern =
13045 .endd
13046 That is, set the option to an empty string so that no check is done.
13047
13048
13049 .option auth_advertise_hosts main "host list&!!" *
13050 .cindex "authentication" "advertising"
13051 .cindex "AUTH" "advertising"
13052 If any server authentication mechanisms are configured, Exim advertises them in
13053 response to an EHLO command only if the calling host matches this list.
13054 Otherwise, Exim does not advertise AUTH.
13055 Exim does not accept AUTH commands from clients to which it has not
13056 advertised the availability of AUTH. The advertising of individual
13057 authentication mechanisms can be controlled by the use of the
13058 &%server_advertise_condition%& generic authenticator option on the individual
13059 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13060
13061 Certain mail clients (for example, Netscape) require the user to provide a name
13062 and password for authentication if AUTH is advertised, even though it may
13063 not be needed (the host may accept messages from hosts on its local LAN without
13064 authentication, for example). The &%auth_advertise_hosts%& option can be used
13065 to make these clients more friendly by excluding them from the set of hosts to
13066 which Exim advertises AUTH.
13067
13068 .cindex "AUTH" "advertising when encrypted"
13069 If you want to advertise the availability of AUTH only when the connection
13070 is encrypted using TLS, you can make use of the fact that the value of this
13071 option is expanded, with a setting like this:
13072 .code
13073 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
13074 .endd
13075 .vindex "&$tls_cipher$&"
13076 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
13077 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13078 expansion is *, which matches all hosts.
13079
13080
13081 .option auto_thaw main time 0s
13082 .cindex "thawing messages"
13083 .cindex "unfreezing messages"
13084 If this option is set to a time greater than zero, a queue runner will try a
13085 new delivery attempt on any frozen message, other than a bounce message, if
13086 this much time has passed since it was frozen. This may result in the message
13087 being re-frozen if nothing has changed since the last attempt. It is a way of
13088 saying &"keep on trying, even though there are big problems"&.
13089
13090 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13091 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13092 thought to be very useful any more, and its use should probably be avoided.
13093
13094
13095 .option av_scanner main string "see below"
13096 This option is available if Exim is built with the content-scanning extension.
13097 It specifies which anti-virus scanner to use. The default value is:
13098 .code
13099 sophie:/var/run/sophie
13100 .endd
13101 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13102 before use. See section &<<SECTscanvirus>>& for further details.
13103
13104
13105 .option bi_command main string unset
13106 .oindex "&%-bi%&"
13107 This option supplies the name of a command that is run when Exim is called with
13108 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13109 just the command name, it is not a complete command line. If an argument is
13110 required, it must come from the &%-oA%& command line option.
13111
13112
13113 .option bounce_message_file main string unset
13114 .cindex "bounce message" "customizing"
13115 .cindex "customizing" "bounce message"
13116 This option defines a template file containing paragraphs of text to be used
13117 for constructing bounce messages.  Details of the file's contents are given in
13118 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13119
13120
13121 .option bounce_message_text main string unset
13122 When this option is set, its contents are included in the default bounce
13123 message immediately after &"This message was created automatically by mail
13124 delivery software."& It is not used if &%bounce_message_file%& is set.
13125
13126 .option bounce_return_body main boolean true
13127 .cindex "bounce message" "including body"
13128 This option controls whether the body of an incoming message is included in a
13129 bounce message when &%bounce_return_message%& is true. The default setting
13130 causes the entire message, both header and body, to be returned (subject to the
13131 value of &%bounce_return_size_limit%&). If this option is false, only the
13132 message header is included. In the case of a non-SMTP message containing an
13133 error that is detected during reception, only those header lines preceding the
13134 point at which the error was detected are returned.
13135 .cindex "bounce message" "including original"
13136
13137 .option bounce_return_message main boolean true
13138 If this option is set false, none of the original message is included in
13139 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13140 &%bounce_return_body%&.
13141
13142
13143 .option bounce_return_size_limit main integer 100K
13144 .cindex "size" "of bounce, limit"
13145 .cindex "bounce message" "size limit"
13146 .cindex "limit" "bounce message size"
13147 This option sets a limit in bytes on the size of messages that are returned to
13148 senders as part of bounce messages when &%bounce_return_message%& is true. The
13149 limit should be less than the value of the global &%message_size_limit%& and of
13150 any &%message_size_limit%& settings on transports, to allow for the bounce text
13151 that Exim generates. If this option is set to zero there is no limit.
13152
13153 When the body of any message that is to be included in a bounce message is
13154 greater than the limit, it is truncated, and a comment pointing this out is
13155 added at the top. The actual cutoff may be greater than the value given, owing
13156 to the use of buffering for transferring the message in chunks (typically 8K in
13157 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13158 messages.
13159
13160 .option bounce_sender_authentication main string unset
13161 .cindex "bounce message" "sender authentication"
13162 .cindex "authentication" "bounce message"
13163 .cindex "AUTH" "on bounce message"
13164 This option provides an authenticated sender address that is sent with any
13165 bounce messages generated by Exim that are sent over an authenticated SMTP
13166 connection. A typical setting might be:
13167 .code
13168 bounce_sender_authentication = mailer-daemon@my.domain.example
13169 .endd
13170 which would cause bounce messages to be sent using the SMTP command:
13171 .code
13172 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13173 .endd
13174 The value of &%bounce_sender_authentication%& must always be a complete email
13175 address.
13176
13177 .option callout_domain_negative_expire main time 3h
13178 .cindex "caching" "callout timeouts"
13179 .cindex "callout" "caching timeouts"
13180 This option specifies the expiry time for negative callout cache data for a
13181 domain. See section &<<SECTcallver>>& for details of callout verification, and
13182 section &<<SECTcallvercache>>& for details of the caching.
13183
13184
13185 .option callout_domain_positive_expire main time 7d
13186 This option specifies the expiry time for positive callout cache data for a
13187 domain. See section &<<SECTcallver>>& for details of callout verification, and
13188 section &<<SECTcallvercache>>& for details of the caching.
13189
13190
13191 .option callout_negative_expire main time 2h
13192 This option specifies the expiry time for negative callout cache data for an
13193 address. See section &<<SECTcallver>>& for details of callout verification, and
13194 section &<<SECTcallvercache>>& for details of the caching.
13195
13196
13197 .option callout_positive_expire main time 24h
13198 This option specifies the expiry time for positive callout cache data for an
13199 address. See section &<<SECTcallver>>& for details of callout verification, and
13200 section &<<SECTcallvercache>>& for details of the caching.
13201
13202
13203 .option callout_random_local_part main string&!! "see below"
13204 This option defines the &"random"& local part that can be used as part of
13205 callout verification. The default value is
13206 .code
13207 $primary_hostname-$tod_epoch-testing
13208 .endd
13209 See section &<<CALLaddparcall>>& for details of how this value is used.
13210
13211
13212 .option check_log_inodes main integer 0
13213 See &%check_spool_space%& below.
13214
13215
13216 .option check_log_space main integer 0
13217 See &%check_spool_space%& below.
13218
13219 .oindex "&%check_rfc2047_length%&"
13220 .cindex "RFC 2047" "disabling length check"
13221 .option check_rfc2047_length main boolean true
13222 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13223 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13224 word; strings to be encoded that exceed this length are supposed to use
13225 multiple encoded words. By default, Exim does not recognize encoded words that
13226 exceed the maximum length. However, it seems that some software, in violation
13227 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13228 set false, Exim recognizes encoded words of any length.
13229
13230
13231 .option check_spool_inodes main integer 0
13232 See &%check_spool_space%& below.
13233
13234
13235 .option check_spool_space main integer 0
13236 .cindex "checking disk space"
13237 .cindex "disk space, checking"
13238 .cindex "spool directory" "checking space"
13239 The four &%check_...%& options allow for checking of disk resources before a
13240 message is accepted.
13241
13242 .vindex "&$log_inodes$&"
13243 .vindex "&$log_space$&"
13244 .vindex "&$spool_inodes$&"
13245 .vindex "&$spool_space$&"
13246 When any of these options are set, they apply to all incoming messages. If you
13247 want to apply different checks to different kinds of message, you can do so by
13248 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13249 &$spool_space$& in an ACL with appropriate additional conditions.
13250
13251
13252 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13253 either value is greater than zero, for example:
13254 .code
13255 check_spool_space = 10M
13256 check_spool_inodes = 100
13257 .endd
13258 The spool partition is the one that contains the directory defined by
13259 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13260 transit.
13261
13262 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13263 files are written if either is greater than zero. These should be set only if
13264 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13265
13266 If there is less space or fewer inodes than requested, Exim refuses to accept
13267 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13268 error response to the MAIL command. If ESMTP is in use and there was a
13269 SIZE parameter on the MAIL command, its value is added to the
13270 &%check_spool_space%& value, and the check is performed even if
13271 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13272
13273 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13274 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13275
13276 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13277 failure a message is written to stderr and Exim exits with a non-zero code, as
13278 it obviously cannot send an error message of any kind.
13279
13280 .option daemon_smtp_ports main string &`smtp`&
13281 .cindex "port" "for daemon"
13282 .cindex "TCP/IP" "setting listening ports"
13283 This option specifies one or more default SMTP ports on which the Exim daemon
13284 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13285 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13286
13287 .option daemon_startup_retries main integer 9
13288 .cindex "daemon startup, retrying"
13289 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13290 the daemon at startup when it cannot immediately bind a listening socket
13291 (typically because the socket is already in use): &%daemon_startup_retries%&
13292 defines the number of retries after the first failure, and
13293 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13294
13295 .option daemon_startup_sleep main time 30s
13296 See &%daemon_startup_retries%&.
13297
13298 .option delay_warning main "time list" 24h
13299 .cindex "warning of delay"
13300 .cindex "delay warning, specifying"
13301 When a message is delayed, Exim sends a warning message to the sender at
13302 intervals specified by this option. The data is a colon-separated list of times
13303 after which to send warning messages. If the value of the option is an empty
13304 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13305 message has been on the queue for longer than the last time, the last interval
13306 between the times is used to compute subsequent warning times. For example,
13307 with
13308 .code
13309 delay_warning = 4h:8h:24h
13310 .endd
13311 the first message is sent after 4 hours, the second after 8 hours, and
13312 the third one after 24 hours. After that, messages are sent every 16 hours,
13313 because that is the interval between the last two times on the list. If you set
13314 just one time, it specifies the repeat interval. For example, with:
13315 .code
13316 delay_warning = 6h
13317 .endd
13318 messages are repeated every six hours. To stop warnings after a given time, set
13319 a very large time at the end of the list. For example:
13320 .code
13321 delay_warning = 2h:12h:99d
13322 .endd
13323
13324 .option delay_warning_condition main string&!! "see below"
13325 .vindex "&$domain$&"
13326 The string is expanded at the time a warning message might be sent. If all the
13327 deferred addresses have the same domain, it is set in &$domain$& during the
13328 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13329 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13330 &"false"& (the comparison being done caselessly) then the warning message is
13331 not sent. The default is:
13332 .code
13333 delay_warning_condition = ${if or {\
13334   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13335   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13336   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13337   } {no}{yes}}
13338 .endd
13339 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13340 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13341 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13342 &"auto-replied"& in an &'Auto-Submitted:'& header.
13343
13344 .option deliver_drop_privilege main boolean false
13345 .cindex "unprivileged delivery"
13346 .cindex "delivery" "unprivileged"
13347 If this option is set true, Exim drops its root privilege at the start of a
13348 delivery process, and runs as the Exim user throughout. This severely restricts
13349 the kinds of local delivery that are possible, but is viable in certain types
13350 of configuration. There is a discussion about the use of root privilege in
13351 chapter &<<CHAPsecurity>>&.
13352
13353 .option deliver_queue_load_max main fixed-point unset
13354 .cindex "load average"
13355 .cindex "queue runner" "abandoning"
13356 When this option is set, a queue run is abandoned if the system load average
13357 becomes greater than the value of the option. The option has no effect on
13358 ancient operating systems on which Exim cannot determine the load average.
13359 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13360
13361
13362 .option delivery_date_remove main boolean true
13363 .cindex "&'Delivery-date:'& header line"
13364 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13365 message when it is delivered, in exactly the same way as &'Return-path:'& is
13366 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13367 should not be present in incoming messages, and this option causes them to be
13368 removed at the time the message is received, to avoid any problems that might
13369 occur when a delivered message is subsequently sent on to some other recipient.
13370
13371 .option disable_fsync main boolean false
13372 .cindex "&[fsync()]&, disabling"
13373 This option is available only if Exim was built with the compile-time option
13374 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13375 a runtime configuration generates an &"unknown option"& error. You should not
13376 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13377 really, really, really understand what you are doing. &'No pre-compiled
13378 distributions of Exim should ever make this option available.'&
13379
13380 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13381 updated files' data to be written to disc before continuing. Unexpected events
13382 such as crashes and power outages may cause data to be lost or scrambled.
13383 Here be Dragons. &*Beware.*&
13384
13385
13386 .option disable_ipv6 main boolean false
13387 .cindex "IPv6" "disabling"
13388 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13389 activities take place. AAAA records are never looked up, and any IPv6 addresses
13390 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13391 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13392 to handle IPv6 literal addresses.
13393
13394
13395 .option dns_again_means_nonexist main "domain list&!!" unset
13396 .cindex "DNS" "&""try again""& response; overriding"
13397 DNS lookups give a &"try again"& response for the DNS errors
13398 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13399 keep trying to deliver a message, or to give repeated temporary errors to
13400 incoming mail. Sometimes the effect is caused by a badly set up name server and
13401 may persist for a long time. If a domain which exhibits this problem matches
13402 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13403 This option should be used with care. You can make it apply to reverse lookups
13404 by a setting such as this:
13405 .code
13406 dns_again_means_nonexist = *.in-addr.arpa
13407 .endd
13408 This option applies to all DNS lookups that Exim does. It also applies when the
13409 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13410 since these are most likely to be caused by DNS lookup problems. The
13411 &(dnslookup)& router has some options of its own for controlling what happens
13412 when lookups for MX or SRV records give temporary errors. These more specific
13413 options are applied after this global option.
13414
13415 .option dns_check_names_pattern main string "see below"
13416 .cindex "DNS" "pre-check of name syntax"
13417 When this option is set to a non-empty string, it causes Exim to check domain
13418 names for characters that are not allowed in host names before handing them to
13419 the DNS resolver, because some resolvers give temporary errors for names that
13420 contain unusual characters. If a domain name contains any unwanted characters,
13421 a &"not found"& result is forced, and the resolver is not called. The check is
13422 done by matching the domain name against a regular expression, which is the
13423 value of this option. The default pattern is
13424 .code
13425 dns_check_names_pattern = \
13426   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13427 .endd
13428 which permits only letters, digits, slashes, and hyphens in components, but
13429 they must start and end with a letter or digit. Slashes are not, in fact,
13430 permitted in host names, but they are found in certain NS records (which can be
13431 accessed in Exim by using a &%dnsdb%& lookup). If you set
13432 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13433 empty string.
13434
13435 .option dns_csa_search_limit main integer 5
13436 This option controls the depth of parental searching for CSA SRV records in the
13437 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13438
13439 .option dns_csa_use_reverse main boolean true
13440 This option controls whether or not an IP address, given as a CSA domain, is
13441 reversed and looked up in the reverse DNS, as described in more detail in
13442 section &<<SECTverifyCSA>>&.
13443
13444 .option dns_ipv4_lookup main "domain list&!!" unset
13445 .cindex "IPv6" "DNS lookup for AAAA records"
13446 .cindex "DNS" "IPv6 lookup for AAAA records"
13447 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13448 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13449 (A records) when trying to find IP addresses for hosts, unless the host's
13450 domain matches this list.
13451
13452 This is a fudge to help with name servers that give big delays or otherwise do
13453 not work for the AAAA record type. In due course, when the world's name
13454 servers have all been upgraded, there should be no need for this option.
13455
13456
13457 .option dns_retrans main time 0s
13458 .cindex "DNS" "resolver options"
13459 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13460 retransmission and retry parameters for DNS lookups. Values of zero (the
13461 defaults) leave the system default settings unchanged. The first value is the
13462 time between retries, and the second is the number of retries. It isn't
13463 totally clear exactly how these settings affect the total time a DNS lookup may
13464 take. I haven't found any documentation about timeouts on DNS lookups; these
13465 parameter values are available in the external resolver interface structure,
13466 but nowhere does it seem to describe how they are used or what you might want
13467 to set in them.
13468
13469
13470 .option dns_retry main integer 0
13471 See &%dns_retrans%& above.
13472
13473
13474 .new
13475 .option dns_use_edns0 main integer -1
13476 .cindex "DNS" "resolver options"
13477 .cindex "DNS" "EDNS0"
13478 If this option is set to a non-negative number then Exim will initialise the
13479 DNS resolver library to either use or not use EDNS0 extensions, overriding
13480 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13481 on.
13482
13483 If the resolver library does not support EDNS0 then this option has no effect.
13484 .wen
13485
13486
13487 .option drop_cr main boolean false
13488 This is an obsolete option that is now a no-op. It used to affect the way Exim
13489 handled CR and LF characters in incoming messages. What happens now is
13490 described in section &<<SECTlineendings>>&.
13491
13492 .option dsn_from main "string&!!" "see below"
13493 .cindex "&'From:'& header line" "in bounces"
13494 .cindex "bounce messages" "&'From:'& line, specifying"
13495 This option can be used to vary the contents of &'From:'& header lines in
13496 bounces and other automatically generated messages (&"Delivery Status
13497 Notifications"& &-- hence the name of the option). The default setting is:
13498 .code
13499 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13500 .endd
13501 The value is expanded every time it is needed. If the expansion fails, a
13502 panic is logged, and the default value is used.
13503
13504 .option envelope_to_remove main boolean true
13505 .cindex "&'Envelope-to:'& header line"
13506 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13507 message when it is delivered, in exactly the same way as &'Return-path:'& is
13508 handled. &'Envelope-to:'& records the original recipient address from the
13509 messages's envelope that caused the delivery to happen. Such headers should not
13510 be present in incoming messages, and this option causes them to be removed at
13511 the time the message is received, to avoid any problems that might occur when a
13512 delivered message is subsequently sent on to some other recipient.
13513
13514
13515 .option errors_copy main "string list&!!" unset
13516 .cindex "bounce message" "copy to other address"
13517 .cindex "copy of bounce message"
13518 Setting this option causes Exim to send bcc copies of bounce messages that it
13519 generates to other addresses. &*Note*&: This does not apply to bounce messages
13520 coming from elsewhere. The value of the option is a colon-separated list of
13521 items. Each item consists of a pattern, terminated by white space, followed by
13522 a comma-separated list of email addresses. If a pattern contains spaces, it
13523 must be enclosed in double quotes.
13524
13525 Each pattern is processed in the same way as a single item in an address list
13526 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13527 the bounce message, the message is copied to the addresses on the list. The
13528 items are scanned in order, and once a matching one is found, no further items
13529 are examined. For example:
13530 .code
13531 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13532               rqps@mydomain   hostmaster@mydomain.example,\
13533                               postmaster@mydomain.example
13534 .endd
13535 .vindex "&$domain$&"
13536 .vindex "&$local_part$&"
13537 The address list is expanded before use. The expansion variables &$local_part$&
13538 and &$domain$& are set from the original recipient of the error message, and if
13539 there was any wildcard matching in the pattern, the expansion
13540 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13541 variables &$0$&, &$1$&, etc. are set in the normal way.
13542
13543
13544 .option errors_reply_to main string unset
13545 .cindex "bounce message" "&'Reply-to:'& in"
13546 By default, Exim's bounce and delivery warning messages contain the header line
13547 .display
13548 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13549 .endd
13550 .oindex &%quota_warn_message%&
13551 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13552 A warning message that is generated by the &%quota_warn_message%& option in an
13553 &(appendfile)& transport may contain its own &'From:'& header line that
13554 overrides the default.
13555
13556 Experience shows that people reply to bounce messages. If the
13557 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13558 and warning messages. For example:
13559 .code
13560 errors_reply_to = postmaster@my.domain.example
13561 .endd
13562 The value of the option is not expanded. It must specify a valid RFC 2822
13563 address. However, if a warning message that is generated by the
13564 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13565 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13566 not used.
13567
13568
13569 .option exim_group main string "compile-time configured"
13570 .cindex "gid (group id)" "Exim's own"
13571 .cindex "Exim group"
13572 This option changes the gid under which Exim runs when it gives up root
13573 privilege. The default value is compiled into the binary. The value of this
13574 option is used only when &%exim_user%& is also set. Unless it consists entirely
13575 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13576 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13577 security issues.
13578
13579
13580 .option exim_path main string "see below"
13581 .cindex "Exim binary, path name"
13582 This option specifies the path name of the Exim binary, which is used when Exim
13583 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13584 the directory configured at compile time by the BIN_DIRECTORY setting. It
13585 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13586 other place.
13587 &*Warning*&: Do not use a macro to define the value of this option, because
13588 you will break those Exim utilities that scan the configuration file to find
13589 where the binary is. (They then use the &%-bP%& option to extract option
13590 settings such as the value of &%spool_directory%&.)
13591
13592
13593 .option exim_user main string "compile-time configured"
13594 .cindex "uid (user id)" "Exim's own"
13595 .cindex "Exim user"
13596 This option changes the uid under which Exim runs when it gives up root
13597 privilege. The default value is compiled into the binary. Ownership of the run
13598 time configuration file and the use of the &%-C%& and &%-D%& command line
13599 options is checked against the values in the binary, not what is set here.
13600
13601 Unless it consists entirely of digits, the string is looked up using
13602 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13603 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13604 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13605
13606
13607 .option extra_local_interfaces main "string list" unset
13608 This option defines network interfaces that are to be considered local when
13609 routing, but which are not used for listening by the daemon. See section
13610 &<<SECTreclocipadd>>& for details.
13611
13612
13613 . Allow this long option name to split; give it unsplit as a fifth argument
13614 . for the automatic .oindex that is generated by .option.
13615
13616 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13617          extract_addresses_remove_arguments
13618 .oindex "&%-t%&"
13619 .cindex "command line" "addresses with &%-t%&"
13620 .cindex "Sendmail compatibility" "&%-t%& option"
13621 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13622 are present on the command line when the &%-t%& option is used to build an
13623 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13624 line addresses are removed from the recipients list. This is also how Smail
13625 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13626 command line addresses are added to those obtained from the header lines. When
13627 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13628 argument headers. If it is set false, Exim adds rather than removes argument
13629 addresses.
13630
13631
13632 .option finduser_retries main integer 0
13633 .cindex "NIS, retrying user lookups"
13634 On systems running NIS or other schemes in which user and group information is
13635 distributed from a remote system, there can be times when &[getpwnam()]& and
13636 related functions fail, even when given valid data, because things time out.
13637 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13638 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13639 many extra times to find a user or a group, waiting for one second between
13640 retries.
13641
13642 .cindex "&_/etc/passwd_&" "multiple reading of"
13643 You should not set this option greater than zero if your user information is in
13644 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13645 search the file multiple times for non-existent users, and also cause delay.
13646
13647
13648
13649 .option freeze_tell main "string list, comma separated" unset
13650 .cindex "freezing messages" "sending a message when freezing"
13651 On encountering certain errors, or when configured to do so in a system filter,
13652 ACL, or special router, Exim freezes a message. This means that no further
13653 delivery attempts take place until an administrator thaws the message, or the
13654 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13655 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13656 warning message whenever it freezes something, unless the message it is
13657 freezing is a locally-generated bounce message. (Without this exception there
13658 is the possibility of looping.) The warning message is sent to the addresses
13659 supplied as the comma-separated value of this option. If several of the
13660 message's addresses cause freezing, only a single message is sent. If the
13661 freezing was automatic, the reason(s) for freezing can be found in the message
13662 log. If you configure freezing in a filter or ACL, you must arrange for any
13663 logging that you require.
13664
13665
13666 .option gecos_name main string&!! unset
13667 .cindex "HP-UX"
13668 .cindex "&""gecos""& field, parsing"
13669 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13670 password file to hold other information in addition to users' real names. Exim
13671 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13672 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13673 of the field are used unchanged, except that, if an ampersand is encountered,
13674 it is replaced by the user's login name with the first character forced to
13675 upper case, since this is a convention that is observed on many systems.
13676
13677 When these options are set, &%gecos_pattern%& is treated as a regular
13678 expression that is to be applied to the field (again with && replaced by the
13679 login name), and if it matches, &%gecos_name%& is expanded and used as the
13680 user's name.
13681
13682 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13683 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13684 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13685 name terminates at the first comma, the following can be used:
13686 .code
13687 gecos_pattern = ([^,]*)
13688 gecos_name = $1
13689 .endd
13690
13691 .option gecos_pattern main string unset
13692 See &%gecos_name%& above.
13693
13694
13695 .option gnutls_require_kx main string unset
13696 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13697 server. For details, see section &<<SECTreqciphgnu>>&.
13698
13699 .option gnutls_require_mac main string unset
13700 This option controls the MAC algorithms when GnuTLS is used in an Exim
13701 server. For details, see section &<<SECTreqciphgnu>>&.
13702
13703 .option gnutls_require_protocols main string unset
13704 This option controls the protocols when GnuTLS is used in an Exim
13705 server. For details, see section &<<SECTreqciphgnu>>&.
13706
13707 .option gnutls_compat_mode main boolean unset
13708 This option controls whether GnuTLS is used in compatibility mode in an Exim
13709 server. This reduces security slightly, but improves interworking with older
13710 implementations of TLS.
13711
13712 .option headers_charset main string "see below"
13713 This option sets a default character set for translating from encoded MIME
13714 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13715 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13716 ultimate default is ISO-8859-1. For more details see the description of header
13717 insertions in section &<<SECTexpansionitems>>&.
13718
13719
13720
13721 .option header_maxsize main integer "see below"
13722 .cindex "header section" "maximum size of"
13723 .cindex "limit" "size of message header section"
13724 This option controls the overall maximum size of a message's header
13725 section. The default is the value of HEADER_MAXSIZE in
13726 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13727 sections are rejected.
13728
13729
13730 .option header_line_maxsize main integer 0
13731 .cindex "header lines" "maximum size of"
13732 .cindex "limit" "size of one header line"
13733 This option limits the length of any individual header line in a message, after
13734 all the continuations have been joined together. Messages with individual
13735 header lines that are longer than the limit are rejected. The default value of
13736 zero means &"no limit"&.
13737
13738
13739
13740
13741 .option helo_accept_junk_hosts main "host list&!!" unset
13742 .cindex "HELO" "accepting junk data"
13743 .cindex "EHLO" "accepting junk data"
13744 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13745 mail, and gives an error response for invalid data. Unfortunately, there are
13746 some SMTP clients that send syntactic junk. They can be accommodated by setting
13747 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13748 if you want to do semantic checking.
13749 See also &%helo_allow_chars%& for a way of extending the permitted character
13750 set.
13751
13752
13753 .option helo_allow_chars main string unset
13754 .cindex "HELO" "underscores in"
13755 .cindex "EHLO" "underscores in"
13756 .cindex "underscore in EHLO/HELO"
13757 This option can be set to a string of rogue characters that are permitted in
13758 all EHLO and HELO names in addition to the standard letters, digits,
13759 hyphens, and dots. If you really must allow underscores, you can set
13760 .code
13761 helo_allow_chars = _
13762 .endd
13763 Note that the value is one string, not a list.
13764
13765
13766 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13767 .cindex "HELO" "forcing reverse lookup"
13768 .cindex "EHLO" "forcing reverse lookup"
13769 If the domain given by a client in a HELO or EHLO command matches this
13770 list, a reverse lookup is done in order to establish the host's true name. The
13771 default forces a lookup if the client host gives the server's name or any of
13772 its IP addresses (in brackets), something that broken clients have been seen to
13773 do.
13774
13775
13776 .option helo_try_verify_hosts main "host list&!!" unset
13777 .cindex "HELO verifying" "optional"
13778 .cindex "EHLO" "verifying, optional"
13779 By default, Exim just checks the syntax of HELO and EHLO commands (see
13780 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13781 to do more extensive checking of the data supplied by these commands. The ACL
13782 condition &`verify = helo`& is provided to make this possible.
13783 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13784 to force the check to occur. From release 4.53 onwards, this is no longer
13785 necessary. If the check has not been done before &`verify = helo`& is
13786 encountered, it is done at that time. Consequently, this option is obsolete.
13787 Its specification is retained here for backwards compatibility.
13788
13789 When an EHLO or HELO command is received, if the calling host matches
13790 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13791 EHLO command either:
13792
13793 .ilist
13794 is an IP literal matching the calling address of the host, or
13795 .next
13796 .cindex "DNS" "reverse lookup"
13797 .cindex "reverse DNS lookup"
13798 matches the host name that Exim obtains by doing a reverse lookup of the
13799 calling host address, or
13800 .next
13801 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13802 available) yields the calling host address.
13803 .endlist
13804
13805 However, the EHLO or HELO command is not rejected if any of the checks
13806 fail. Processing continues, but the result of the check is remembered, and can
13807 be detected later in an ACL by the &`verify = helo`& condition.
13808
13809 .option helo_verify_hosts main "host list&!!" unset
13810 .cindex "HELO verifying" "mandatory"
13811 .cindex "EHLO" "verifying, mandatory"
13812 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13813 backwards compatibility. For hosts that match this option, Exim checks the host
13814 name given in the HELO or EHLO in the same way as for
13815 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13816 rejected with a 550 error, and entries are written to the main and reject logs.
13817 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13818 error.
13819
13820 .option hold_domains main "domain list&!!" unset
13821 .cindex "domain" "delaying delivery"
13822 .cindex "delivery" "delaying certain domains"
13823 This option allows mail for particular domains to be held on the queue
13824 manually. The option is overridden if a message delivery is forced with the
13825 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13826 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13827 item in &%hold_domains%&, no routing or delivery for that address is done, and
13828 it is deferred every time the message is looked at.
13829
13830 This option is intended as a temporary operational measure for delaying the
13831 delivery of mail while some problem is being sorted out, or some new
13832 configuration tested. If you just want to delay the processing of some
13833 domains until a queue run occurs, you should use &%queue_domains%& or
13834 &%queue_smtp_domains%&, not &%hold_domains%&.
13835
13836 A setting of &%hold_domains%& does not override Exim's code for removing
13837 messages from the queue if they have been there longer than the longest retry
13838 time in any retry rule. If you want to hold messages for longer than the normal
13839 retry times, insert a dummy retry rule with a long retry time.
13840
13841
13842 .option host_lookup main "host list&!!" unset
13843 .cindex "host name" "lookup, forcing"
13844 Exim does not look up the name of a calling host from its IP address unless it
13845 is required to compare against some host list, or the host matches
13846 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13847 option (which normally contains IP addresses rather than host names). The
13848 default configuration file contains
13849 .code
13850 host_lookup = *
13851 .endd
13852 which causes a lookup to happen for all hosts. If the expense of these lookups
13853 is felt to be too great, the setting can be changed or removed.
13854
13855 After a successful reverse lookup, Exim does a forward lookup on the name it
13856 has obtained, to verify that it yields the IP address that it started with. If
13857 this check fails, Exim behaves as if the name lookup failed.
13858
13859 .vindex "&$host_lookup_failed$&"
13860 .vindex "&$sender_host_name$&"
13861 After any kind of failure, the host name (in &$sender_host_name$&) remains
13862 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13863 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13864 &`verify = reverse_host_lookup`& in ACLs.
13865
13866
13867 .option host_lookup_order main "string list" &`bydns:byaddr`&
13868 This option specifies the order of different lookup methods when Exim is trying
13869 to find a host name from an IP address. The default is to do a DNS lookup
13870 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13871 if that fails. You can change the order of these lookups, or omit one entirely,
13872 if you want.
13873
13874 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13875 multiple PTR records in the DNS and the IP address is not listed in
13876 &_/etc/hosts_&. Different operating systems give different results in this
13877 case. That is why the default tries a DNS lookup first.
13878
13879
13880
13881 .option host_reject_connection main "host list&!!" unset
13882 .cindex "host" "rejecting connections from"
13883 If this option is set, incoming SMTP calls from the hosts listed are rejected
13884 as soon as the connection is made.
13885 This option is obsolete, and retained only for backward compatibility, because
13886 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13887 connections immediately.
13888
13889 The ability to give an immediate rejection (either by this option or using an
13890 ACL) is provided for use in unusual cases. Many hosts will just try again,
13891 sometimes without much delay. Normally, it is better to use an ACL to reject
13892 incoming messages at a later stage, such as after RCPT commands. See
13893 chapter &<<CHAPACL>>&.
13894
13895
13896 .option hosts_connection_nolog main "host list&!!" unset
13897 .cindex "host" "not logging connections from"
13898 This option defines a list of hosts for which connection logging does not
13899 happen, even though the &%smtp_connection%& log selector is set. For example,
13900 you might want not to log SMTP connections from local processes, or from
13901 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13902 the daemon; you should therefore strive to restrict its value to a short inline
13903 list of IP addresses and networks. To disable logging SMTP connections from
13904 local processes, you must create a host list with an empty item. For example:
13905 .code
13906 hosts_connection_nolog = :
13907 .endd
13908 If the &%smtp_connection%& log selector is not set, this option has no effect.
13909
13910
13911
13912 .option hosts_treat_as_local main "domain list&!!" unset
13913 .cindex "local host" "domains treated as"
13914 .cindex "host" "treated as local"
13915 If this option is set, any host names that match the domain list are treated as
13916 if they were the local host when Exim is scanning host lists obtained from MX
13917 records
13918 or other sources. Note that the value of this option is a domain list, not a
13919 host list, because it is always used to check host names, not IP addresses.
13920
13921 This option also applies when Exim is matching the special items
13922 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13923 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13924 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13925 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13926 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13927 interfaces and recognizing the local host.
13928
13929
13930 .option ibase_servers main "string list" unset
13931 .cindex "InterBase" "server list"
13932 This option provides a list of InterBase servers and associated connection data,
13933 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13934 The option is available only if Exim has been built with InterBase support.
13935
13936
13937
13938 .option ignore_bounce_errors_after main time 10w
13939 .cindex "bounce message" "discarding"
13940 .cindex "discarding bounce message"
13941 This option affects the processing of bounce messages that cannot be delivered,
13942 that is, those that suffer a permanent delivery failure. (Bounce messages that
13943 suffer temporary delivery failures are of course retried in the usual way.)
13944
13945 After a permanent delivery failure, bounce messages are frozen,
13946 because there is no sender to whom they can be returned. When a frozen bounce
13947 message has been on the queue for more than the given time, it is unfrozen at
13948 the next queue run, and a further delivery is attempted. If delivery fails
13949 again, the bounce message is discarded. This makes it possible to keep failed
13950 bounce messages around for a shorter time than the normal maximum retry time
13951 for frozen messages. For example,
13952 .code
13953 ignore_bounce_errors_after = 12h
13954 .endd
13955 retries failed bounce message deliveries after 12 hours, discarding any further
13956 failures. If the value of this option is set to a zero time period, bounce
13957 failures are discarded immediately. Setting a very long time (as in the default
13958 value) has the effect of disabling this option. For ways of automatically
13959 dealing with other kinds of frozen message, see &%auto_thaw%& and
13960 &%timeout_frozen_after%&.
13961
13962
13963 .option ignore_fromline_hosts main "host list&!!" unset
13964 .cindex "&""From""& line"
13965 .cindex "UUCP" "&""From""& line"
13966 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13967 the headers of a message. By default this is treated as the start of the
13968 message's body, which means that any following headers are not recognized as
13969 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13970 match those hosts that insist on sending it. If the sender is actually a local
13971 process rather than a remote host, and is using &%-bs%& to inject the messages,
13972 &%ignore_fromline_local%& must be set to achieve this effect.
13973
13974
13975 .option ignore_fromline_local main boolean false
13976 See &%ignore_fromline_hosts%& above.
13977
13978
13979 .option keep_malformed main time 4d
13980 This option specifies the length of time to keep messages whose spool files
13981 have been corrupted in some way. This should, of course, never happen. At the
13982 next attempt to deliver such a message, it gets removed. The incident is
13983 logged.
13984
13985
13986 .option ldap_ca_cert_dir main string unset
13987 .cindex "LDAP", "TLS CA certificate directory"
13988 This option indicates which directory contains CA certificates for verifying
13989 a TLS certificate presented by an LDAP server.
13990 While Exim does not provide a default value, your SSL library may.
13991 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13992 and constrained to be a directory.
13993
13994
13995 .option ldap_ca_cert_file main string unset
13996 .cindex "LDAP", "TLS CA certificate file"
13997 This option indicates which file contains CA certificates for verifying
13998 a TLS certificate presented by an LDAP server.
13999 While Exim does not provide a default value, your SSL library may.
14000 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14001 and constrained to be a file.
14002
14003
14004 .option ldap_cert_file main string unset
14005 .cindex "LDAP" "TLS client certificate file"
14006 This option indicates which file contains an TLS client certificate which
14007 Exim should present to the LDAP server during TLS negotiation.
14008 Should be used together with &%ldap_cert_key%&.
14009
14010
14011 .option ldap_cert_key main string unset
14012 .cindex "LDAP" "TLS client key file"
14013 This option indicates which file contains the secret/private key to use
14014 to prove identity to the LDAP server during TLS negotiation.
14015 Should be used together with &%ldap_cert_file%&, which contains the
14016 identity to be proven.
14017
14018
14019 .option ldap_cipher_suite main string unset
14020 .cindex "LDAP" "TLS cipher suite"
14021 This controls the TLS cipher-suite negotiation during TLS negotiation with
14022 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14023 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14024
14025
14026 .option ldap_default_servers main "string list" unset
14027 .cindex "LDAP" "default servers"
14028 This option provides a list of LDAP servers which are tried in turn when an
14029 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14030 details of LDAP queries. This option is available only when Exim has been built
14031 with LDAP support.
14032
14033
14034 .option ldap_require_cert main string unset.
14035 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14036 This should be one of the values "hard", "demand", "allow", "try" or "never".
14037 A value other than one of these is interpreted as "never".
14038 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14039 Although Exim does not set a default, the LDAP library probably defaults
14040 to hard/demand.
14041
14042
14043 .option ldap_start_tls main boolean false
14044 .cindex "LDAP" "whether or not to negotiate TLS"
14045 If set, Exim will attempt to negotiate TLS with the LDAP server when
14046 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14047 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14048 of SSL-on-connect.
14049 In the event of failure to negotiate TLS, the action taken is controlled
14050 by &%ldap_require_cert%&.
14051
14052
14053 .option ldap_version main integer unset
14054 .cindex "LDAP" "protocol version, forcing"
14055 This option can be used to force Exim to set a specific protocol version for
14056 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14057 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14058 the LDAP headers; otherwise it is 2. This option is available only when Exim
14059 has been built with LDAP support.
14060
14061
14062
14063 .option local_from_check main boolean true
14064 .cindex "&'Sender:'& header line" "disabling addition of"
14065 .cindex "&'From:'& header line" "disabling checking of"
14066 When a message is submitted locally (that is, not over a TCP/IP connection) by
14067 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14068 checks that the &'From:'& header line matches the login of the calling user and
14069 the domain specified by &%qualify_domain%&.
14070
14071 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14072 locally submitted message is automatically qualified by Exim, unless the
14073 &%-bnq%& command line option is used.
14074
14075 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14076 on the local part. If the &'From:'& header line does not match, Exim adds a
14077 &'Sender:'& header with an address constructed from the calling user's login
14078 and the default qualify domain.
14079
14080 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14081 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14082 &'Sender:'& header lines supplied by untrusted users, you must also set
14083 &%local_sender_retain%& to be true.
14084
14085 .cindex "envelope sender"
14086 These options affect only the header lines in the message. The envelope sender
14087 is still forced to be the login id at the qualify domain unless
14088 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14089
14090 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14091 request similar header line checking. See section &<<SECTthesenhea>>&, which
14092 has more details about &'Sender:'& processing.
14093
14094
14095
14096
14097 .option local_from_prefix main string unset
14098 When Exim checks the &'From:'& header line of locally submitted messages for
14099 matching the login id (see &%local_from_check%& above), it can be configured to
14100 ignore certain prefixes and suffixes in the local part of the address. This is
14101 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14102 appropriate lists, in the same form as the &%local_part_prefix%& and
14103 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14104 example, if
14105 .code
14106 local_from_prefix = *-
14107 .endd
14108 is set, a &'From:'& line containing
14109 .code
14110 From: anything-user@your.domain.example
14111 .endd
14112 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14113 matches the actual sender address that is constructed from the login name and
14114 qualify domain.
14115
14116
14117 .option local_from_suffix main string unset
14118 See &%local_from_prefix%& above.
14119
14120
14121 .option local_interfaces main "string list" "see below"
14122 This option controls which network interfaces are used by the daemon for
14123 listening; they are also used to identify the local host when routing. Chapter
14124 &<<CHAPinterfaces>>& contains a full description of this option and the related
14125 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14126 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14127 &%local_interfaces%& is
14128 .code
14129 local_interfaces = 0.0.0.0
14130 .endd
14131 when Exim is built without IPv6 support; otherwise it is
14132 .code
14133 local_interfaces = <; ::0 ; 0.0.0.0
14134 .endd
14135
14136 .option local_scan_timeout main time 5m
14137 .cindex "timeout" "for &[local_scan()]& function"
14138 .cindex "&[local_scan()]& function" "timeout"
14139 This timeout applies to the &[local_scan()]& function (see chapter
14140 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14141 the incoming message is rejected with a temporary error if it is an SMTP
14142 message. For a non-SMTP message, the message is dropped and Exim ends with a
14143 non-zero code. The incident is logged on the main and reject logs.
14144
14145
14146
14147 .option local_sender_retain main boolean false
14148 .cindex "&'Sender:'& header line" "retaining from local submission"
14149 When a message is submitted locally (that is, not over a TCP/IP connection) by
14150 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14151 do not want this to happen, you must set &%local_sender_retain%&, and you must
14152 also set &%local_from_check%& to be false (Exim will complain if you do not).
14153 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14154 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14155
14156
14157
14158
14159 .option localhost_number main string&!! unset
14160 .cindex "host" "locally unique number for"
14161 .cindex "message ids" "with multiple hosts"
14162 .vindex "&$localhost_number$&"
14163 Exim's message ids are normally unique only within the local host. If
14164 uniqueness among a set of hosts is required, each host must set a different
14165 value for the &%localhost_number%& option. The string is expanded immediately
14166 after reading the configuration file (so that a number can be computed from the
14167 host name, for example) and the result of the expansion must be a number in the
14168 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14169 systems). This is available in subsequent string expansions via the variable
14170 &$localhost_number$&. When &%localhost_number is set%&, the final two
14171 characters of the message id, instead of just being a fractional part of the
14172 time, are computed from the time and the local host number as described in
14173 section &<<SECTmessiden>>&.
14174
14175
14176
14177 .option log_file_path main "string list&!!" "set at compile time"
14178 .cindex "log" "file path for"
14179 This option sets the path which is used to determine the names of Exim's log
14180 files, or indicates that logging is to be to syslog, or both. It is expanded
14181 when Exim is entered, so it can, for example, contain a reference to the host
14182 name. If no specific path is set for the log files at compile or run time, they
14183 are written in a sub-directory called &_log_& in Exim's spool directory.
14184 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14185 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14186 used. If this string is fixed at your installation (contains no expansion
14187 variables) it is recommended that you do not set this option in the
14188 configuration file, but instead supply the path using LOG_FILE_PATH in
14189 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14190 early on &-- in particular, failure to read the configuration file.
14191
14192
14193 .option log_selector main string unset
14194 .cindex "log" "selectors"
14195 This option can be used to reduce or increase the number of things that Exim
14196 writes to its log files. Its argument is made up of names preceded by plus or
14197 minus characters. For example:
14198 .code
14199 log_selector = +arguments -retry_defer
14200 .endd
14201 A list of possible names and what they control is given in the chapter on
14202 logging, in section &<<SECTlogselector>>&.
14203
14204
14205 .option log_timezone main boolean false
14206 .cindex "log" "timezone for entries"
14207 .vindex "&$tod_log$&"
14208 .vindex "&$tod_zone$&"
14209 By default, the timestamps on log lines are in local time without the
14210 timezone. This means that if your timezone changes twice a year, the timestamps
14211 in log lines are ambiguous for an hour when the clocks go back. One way of
14212 avoiding this problem is to set the timezone to UTC. An alternative is to set
14213 &%log_timezone%& true. This turns on the addition of the timezone offset to
14214 timestamps in log lines. Turning on this option can add quite a lot to the size
14215 of log files because each line is extended by 6 characters. Note that the
14216 &$tod_log$& variable contains the log timestamp without the zone, but there is
14217 another variable called &$tod_zone$& that contains just the timezone offset.
14218
14219
14220 .option lookup_open_max main integer 25
14221 .cindex "too many open files"
14222 .cindex "open files, too many"
14223 .cindex "file" "too many open"
14224 .cindex "lookup" "maximum open files"
14225 .cindex "limit" "open files for lookups"
14226 This option limits the number of simultaneously open files for single-key
14227 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14228 Exim normally keeps these files open during routing, because often the same
14229 file is required several times. If the limit is reached, Exim closes the least
14230 recently used file. Note that if you are using the &'ndbm'& library, it
14231 actually opens two files for each logical DBM database, though it still counts
14232 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14233 open files"& errors with NDBM, you need to reduce the value of
14234 &%lookup_open_max%&.
14235
14236
14237 .option max_username_length main integer 0
14238 .cindex "length of login name"
14239 .cindex "user name" "maximum length"
14240 .cindex "limit" "user name length"
14241 Some operating systems are broken in that they truncate long arguments to
14242 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14243 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14244 an argument that is longer behaves as if &[getpwnam()]& failed.
14245
14246
14247 .option message_body_newlines main bool false
14248 .cindex "message body" "newlines in variables"
14249 .cindex "newline" "in message body variables"
14250 .vindex "&$message_body$&"
14251 .vindex "&$message_body_end$&"
14252 By default, newlines in the message body are replaced by spaces when setting
14253 the &$message_body$& and &$message_body_end$& expansion variables. If this
14254 option is set true, this no longer happens.
14255
14256
14257 .option message_body_visible main integer 500
14258 .cindex "body of message" "visible size"
14259 .cindex "message body" "visible size"
14260 .vindex "&$message_body$&"
14261 .vindex "&$message_body_end$&"
14262 This option specifies how much of a message's body is to be included in the
14263 &$message_body$& and &$message_body_end$& expansion variables.
14264
14265
14266 .option message_id_header_domain main string&!! unset
14267 .cindex "&'Message-ID:'& header line"
14268 If this option is set, the string is expanded and used as the right hand side
14269 (domain) of the &'Message-ID:'& header that Exim creates if a
14270 locally-originated incoming message does not have one. &"Locally-originated"&
14271 means &"not received over TCP/IP."&
14272 Otherwise, the primary host name is used.
14273 Only letters, digits, dot and hyphen are accepted; any other characters are
14274 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14275 empty string, the option is ignored.
14276
14277
14278 .option message_id_header_text main string&!! unset
14279 If this variable is set, the string is expanded and used to augment the text of
14280 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14281 message does not have one. The text of this header is required by RFC 2822 to
14282 take the form of an address. By default, Exim uses its internal message id as
14283 the local part, and the primary host name as the domain. If this option is set,
14284 it is expanded, and provided the expansion is not forced to fail, and does not
14285 yield an empty string, the result is inserted into the header immediately
14286 before the @, separated from the internal message id by a dot. Any characters
14287 that are illegal in an address are automatically converted into hyphens. This
14288 means that variables such as &$tod_log$& can be used, because the spaces and
14289 colons will become hyphens.
14290
14291
14292 .option message_logs main boolean true
14293 .cindex "message logs" "disabling"
14294 .cindex "log" "message log; disabling"
14295 If this option is turned off, per-message log files are not created in the
14296 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14297 Exim, by reducing the number of files involved in handling a message from a
14298 minimum of four (header spool file, body spool file, delivery journal, and
14299 per-message log) to three. The other major I/O activity is Exim's main log,
14300 which is not affected by this option.
14301
14302
14303 .option message_size_limit main string&!! 50M
14304 .cindex "message" "size limit"
14305 .cindex "limit" "message size"
14306 .cindex "size" "of message, limit"
14307 This option limits the maximum size of message that Exim will process. The
14308 value is expanded for each incoming connection so, for example, it can be made
14309 to depend on the IP address of the remote host for messages arriving via
14310 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14311 optionally followed by K or M.
14312
14313 &*Note*&: This limit cannot be made to depend on a message's sender or any
14314 other properties of an individual message, because it has to be advertised in
14315 the server's response to EHLO. String expansion failure causes a temporary
14316 error. A value of zero means no limit, but its use is not recommended. See also
14317 &%bounce_return_size_limit%&.
14318
14319 Incoming SMTP messages are failed with a 552 error if the limit is
14320 exceeded; locally-generated messages either get a stderr message or a delivery
14321 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14322 an oversized message is logged in both the main and the reject logs. See also
14323 the generic transport option &%message_size_limit%&, which limits the size of
14324 message that an individual transport can process.
14325
14326 If you use a virus-scanner and set this option to to a value larger than the
14327 maximum size that your virus-scanner is configured to support, you may get
14328 failures triggered by large mails.  The right size to configure for the
14329 virus-scanner depends upon what data is passed and the options in use but it's
14330 probably safest to just set it to a little larger than this value.  Eg, with a
14331 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14332 some problems may result.
14333
14334 A value of 0 will disable size limit checking; Exim will still advertise the
14335 SIZE extension in an EHLO response, but without a limit, so as to permit
14336 SMTP clients to still indicate the message size along with the MAIL verb.
14337
14338
14339 .option move_frozen_messages main boolean false
14340 .cindex "frozen messages" "moving"
14341 This option, which is available only if Exim has been built with the setting
14342 .code
14343 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14344 .endd
14345 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14346 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14347 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14348 standard utilities for handling such moved messages, and they do not show up in
14349 lists generated by &%-bp%& or by the Exim monitor.
14350
14351
14352 .option mua_wrapper main boolean false
14353 Setting this option true causes Exim to run in a very restrictive mode in which
14354 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14355 contains a full description of this facility.
14356
14357
14358
14359 .option mysql_servers main "string list" unset
14360 .cindex "MySQL" "server list"
14361 This option provides a list of MySQL servers and associated connection data, to
14362 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14363 option is available only if Exim has been built with MySQL support.
14364
14365
14366 .option never_users main "string list&!!" unset
14367 This option is expanded just once, at the start of Exim's processing. Local
14368 message deliveries are normally run in processes that are setuid to the
14369 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14370 It is usually desirable to prevent any deliveries from running as root, as a
14371 safety precaution.
14372
14373 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14374 list of users that must not be used for local deliveries. This list is fixed in
14375 the binary and cannot be overridden by the configuration file. By default, it
14376 contains just the single user name &"root"&. The &%never_users%& runtime option
14377 can be used to add more users to the fixed list.
14378
14379 If a message is to be delivered as one of the users on the fixed list or the
14380 &%never_users%& list, an error occurs, and delivery is deferred. A common
14381 example is
14382 .code
14383 never_users = root:daemon:bin
14384 .endd
14385 Including root is redundant if it is also on the fixed list, but it does no
14386 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14387 transport driver.
14388
14389
14390 .option openssl_options main "string list" unset
14391 .cindex "OpenSSL "compatibility options"
14392 This option allows an administrator to adjust the SSL options applied
14393 by OpenSSL to connections.  It is given as a space-separated list of items,
14394 each one to be +added or -subtracted from the current value.
14395
14396 This option is only available if Exim is built against OpenSSL.  The values
14397 available for this option vary according to the age of your OpenSSL install.
14398 The &"all"& value controls a subset of flags which are available, typically
14399 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14400 list the values known on your system and Exim should support all the
14401 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14402 names lose the leading &"SSL_OP_"& and are lower-cased.
14403
14404 Note that adjusting the options can have severe impact upon the security of
14405 SSL as used by Exim.  It is possible to disable safety checks and shoot
14406 yourself in the foot in various unpleasant ways.  This option should not be
14407 adjusted lightly.  An unrecognised item will be detected at startup, by
14408 invoking Exim with the &%-bV%& flag.
14409
14410 .new
14411 Historical note: prior to release 4.78, Exim defaulted this value to
14412 "+dont_insert_empty_fragments", which may still be needed for compatibility
14413 with some clients, but which lowers security by increasing exposure to
14414 some now infamous attacks.
14415 .wen
14416
14417 An example:
14418 .code
14419 # Make both old MS and old Eudora happy:
14420 openssl_options = -all +microsoft_big_sslv3_buffer \
14421                        +dont_insert_empty_fragments
14422 .endd
14423
14424 Possible options may include:
14425 .ilist
14426 &`all`&
14427 .next
14428 &`allow_unsafe_legacy_renegotiation`&
14429 .next
14430 &`cipher_server_preference`&
14431 .next
14432 &`dont_insert_empty_fragments`&
14433 .next
14434 &`ephemeral_rsa`&
14435 .next
14436 &`legacy_server_connect`&
14437 .next
14438 &`microsoft_big_sslv3_buffer`&
14439 .next
14440 &`microsoft_sess_id_bug`&
14441 .next
14442 &`msie_sslv2_rsa_padding`&
14443 .next
14444 &`netscape_challenge_bug`&
14445 .next
14446 &`netscape_reuse_cipher_change_bug`&
14447 .next
14448 &`no_compression`&
14449 .next
14450 &`no_session_resumption_on_renegotiation`&
14451 .next
14452 &`no_sslv2`&
14453 .next
14454 &`no_sslv3`&
14455 .next
14456 &`no_ticket`&
14457 .next
14458 &`no_tlsv1`&
14459 .next
14460 &`no_tlsv1_1`&
14461 .next
14462 &`no_tlsv1_2`&
14463 .next
14464 &`single_dh_use`&
14465 .next
14466 &`single_ecdh_use`&
14467 .next
14468 &`ssleay_080_client_dh_bug`&
14469 .next
14470 &`sslref2_reuse_cert_type_bug`&
14471 .next
14472 &`tls_block_padding_bug`&
14473 .next
14474 &`tls_d5_bug`&
14475 .next
14476 &`tls_rollback_bug`&
14477 .endlist
14478
14479
14480 .option oracle_servers main "string list" unset
14481 .cindex "Oracle" "server list"
14482 This option provides a list of Oracle servers and associated connection data,
14483 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14484 The option is available only if Exim has been built with Oracle support.
14485
14486
14487 .option percent_hack_domains main "domain list&!!" unset
14488 .cindex "&""percent hack""&"
14489 .cindex "source routing" "in email address"
14490 .cindex "address" "source-routed"
14491 The &"percent hack"& is the convention whereby a local part containing a
14492 percent sign is re-interpreted as a new email address, with the percent
14493 replaced by @. This is sometimes called &"source routing"&, though that term is
14494 also applied to RFC 2822 addresses that begin with an @ character. If this
14495 option is set, Exim implements the percent facility for those domains listed,
14496 but no others. This happens before an incoming SMTP address is tested against
14497 an ACL.
14498
14499 &*Warning*&: The &"percent hack"& has often been abused by people who are
14500 trying to get round relaying restrictions. For this reason, it is best avoided
14501 if at all possible. Unfortunately, a number of less security-conscious MTAs
14502 implement it unconditionally. If you are running Exim on a gateway host, and
14503 routing mail through to internal MTAs without processing the local parts, it is
14504 a good idea to reject recipient addresses with percent characters in their
14505 local parts. Exim's default configuration does this.
14506
14507
14508 .option perl_at_start main boolean false
14509 This option is available only when Exim is built with an embedded Perl
14510 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14511
14512
14513 .option perl_startup main string unset
14514 This option is available only when Exim is built with an embedded Perl
14515 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14516
14517
14518 .option pgsql_servers main "string list" unset
14519 .cindex "PostgreSQL lookup type" "server list"
14520 This option provides a list of PostgreSQL servers and associated connection
14521 data, to be used in conjunction with &(pgsql)& lookups (see section
14522 &<<SECID72>>&). The option is available only if Exim has been built with
14523 PostgreSQL support.
14524
14525
14526 .option pid_file_path main string&!! "set at compile time"
14527 .cindex "daemon" "pid file path"
14528 .cindex "pid file, path for"
14529 This option sets the name of the file to which the Exim daemon writes its
14530 process id. The string is expanded, so it can contain, for example, references
14531 to the host name:
14532 .code
14533 pid_file_path = /var/log/$primary_hostname/exim.pid
14534 .endd
14535 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14536 spool directory.
14537 The value set by the option can be overridden by the &%-oP%& command line
14538 option. A pid file is not written if a &"non-standard"& daemon is run by means
14539 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14540
14541
14542 .option pipelining_advertise_hosts main "host list&!!" *
14543 .cindex "PIPELINING" "suppressing advertising"
14544 This option can be used to suppress the advertisement of the SMTP
14545 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14546 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14547 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14548 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14549 that clients will use it; &"out of order"& commands that are &"expected"& do
14550 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14551
14552
14553 .option preserve_message_logs main boolean false
14554 .cindex "message logs" "preserving"
14555 If this option is set, message log files are not deleted when messages are
14556 completed. Instead, they are moved to a sub-directory of the spool directory
14557 called &_msglog.OLD_&, where they remain available for statistical or debugging
14558 purposes. This is a dangerous option to set on systems with any appreciable
14559 volume of mail. Use with care!
14560
14561
14562 .option primary_hostname main string "see below"
14563 .cindex "name" "of local host"
14564 .cindex "host" "name of local"
14565 .cindex "local host" "name of"
14566 .vindex "&$primary_hostname$&"
14567 This specifies the name of the current host. It is used in the default EHLO or
14568 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14569 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14570 The value is also used by default in some SMTP response messages from an Exim
14571 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14572
14573 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14574 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14575 contains only one component, Exim passes it to &[gethostbyname()]& (or
14576 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14577 version. The variable &$primary_hostname$& contains the host name, whether set
14578 explicitly by this option, or defaulted.
14579
14580
14581 .option print_topbitchars main boolean false
14582 .cindex "printing characters"
14583 .cindex "8-bit characters"
14584 By default, Exim considers only those characters whose codes lie in the range
14585 32&--126 to be printing characters. In a number of circumstances (for example,
14586 when writing log entries) non-printing characters are converted into escape
14587 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14588 is set, code values of 128 and above are also considered to be printing
14589 characters.
14590
14591 This option also affects the header syntax checks performed by the
14592 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14593 the user's full name when constructing From: and Sender: addresses (as
14594 described in section &<<SECTconstr>>&). Setting this option can cause
14595 Exim to generate eight bit message headers that do not conform to the
14596 standards.
14597
14598
14599 .option process_log_path main string unset
14600 .cindex "process log path"
14601 .cindex "log" "process log"
14602 .cindex "&'exiwhat'&"
14603 This option sets the name of the file to which an Exim process writes its
14604 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14605 utility script. If this option is unset, the file called &_exim-process.info_&
14606 in Exim's spool directory is used. The ability to specify the name explicitly
14607 can be useful in environments where two different Exims are running, using
14608 different spool directories.
14609
14610
14611 .option prod_requires_admin main boolean true
14612 .oindex "&%-M%&"
14613 .oindex "&%-R%&"
14614 .oindex "&%-q%&"
14615 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14616 admin user unless &%prod_requires_admin%& is set false. See also
14617 &%queue_list_requires_admin%&.
14618
14619
14620 .option qualify_domain main string "see below"
14621 .cindex "domain" "for qualifying addresses"
14622 .cindex "address" "qualification"
14623 This option specifies the domain name that is added to any envelope sender
14624 addresses that do not have a domain qualification. It also applies to
14625 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14626 are accepted by default only for locally-generated messages. Qualification is
14627 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14628 locally-generated messages, unless the &%-bnq%& command line option is used.
14629
14630 Messages from external sources must always contain fully qualified addresses,
14631 unless the sending host matches &%sender_unqualified_hosts%& or
14632 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14633 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14634 necessary. Internally, Exim always works with fully qualified envelope
14635 addresses. If &%qualify_domain%& is not set, it defaults to the
14636 &%primary_hostname%& value.
14637
14638
14639 .option qualify_recipient main string "see below"
14640 This option allows you to specify a different domain for qualifying recipient
14641 addresses to the one that is used for senders. See &%qualify_domain%& above.
14642
14643
14644
14645 .option queue_domains main "domain list&!!" unset
14646 .cindex "domain" "specifying non-immediate delivery"
14647 .cindex "queueing incoming messages"
14648 .cindex "message" "queueing certain domains"
14649 This option lists domains for which immediate delivery is not required.
14650 A delivery process is started whenever a message is received, but only those
14651 domains that do not match are processed. All other deliveries wait until the
14652 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14653
14654
14655 .option queue_list_requires_admin main boolean true
14656 .oindex "&%-bp%&"
14657 The &%-bp%& command-line option, which lists the messages that are on the
14658 queue, requires the caller to be an admin user unless
14659 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14660
14661
14662 .option queue_only main boolean false
14663 .cindex "queueing incoming messages"
14664 .cindex "message" "queueing unconditionally"
14665 If &%queue_only%& is set, a delivery process is not automatically started
14666 whenever a message is received. Instead, the message waits on the queue for the
14667 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14668 delivered immediately when certain conditions (such as heavy load) occur.
14669
14670 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14671 and &%-odi%& command line options override &%queue_only%& unless
14672 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14673 &%queue_only_load%&, and &%smtp_accept_queue%&.
14674
14675
14676 .option queue_only_file main string unset
14677 .cindex "queueing incoming messages"
14678 .cindex "message" "queueing by file existence"
14679 This option can be set to a colon-separated list of absolute path names, each
14680 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14681 it tests for the existence of each listed path using a call to &[stat()]&. For
14682 each path that exists, the corresponding queueing option is set.
14683 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14684 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14685 .code
14686 queue_only_file = smtp/some/file
14687 .endd
14688 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14689 &_/some/file_& exists.
14690
14691
14692 .option queue_only_load main fixed-point unset
14693 .cindex "load average"
14694 .cindex "queueing incoming messages"
14695 .cindex "message" "queueing by load"
14696 If the system load average is higher than this value, incoming messages from
14697 all sources are queued, and no automatic deliveries are started. If this
14698 happens during local or remote SMTP input, all subsequent messages received on
14699 the same SMTP connection are queued by default, whatever happens to the load in
14700 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14701 false.
14702
14703 Deliveries will subsequently be performed by queue runner processes. This
14704 option has no effect on ancient operating systems on which Exim cannot
14705 determine the load average. See also &%deliver_queue_load_max%& and
14706 &%smtp_load_reserve%&.
14707
14708
14709 .option queue_only_load_latch main boolean true
14710 .cindex "load average" "re-evaluating per message"
14711 When this option is true (the default), once one message has been queued
14712 because the load average is higher than the value set by &%queue_only_load%&,
14713 all subsequent messages received on the same SMTP connection are also queued.
14714 This is a deliberate choice; even though the load average may fall below the
14715 threshold, it doesn't seem right to deliver later messages on the same
14716 connection when not delivering earlier ones. However, there are special
14717 circumstances such as very long-lived connections from scanning appliances
14718 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14719 should be set false. This causes the value of the load average to be
14720 re-evaluated for each message.
14721
14722
14723 .option queue_only_override main boolean true
14724 .cindex "queueing incoming messages"
14725 When this option is true, the &%-od%&&'x'& command line options override the
14726 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14727 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14728 to override; they are accepted, but ignored.
14729
14730
14731 .option queue_run_in_order main boolean false
14732 .cindex "queue runner" "processing messages in order"
14733 If this option is set, queue runs happen in order of message arrival instead of
14734 in an arbitrary order. For this to happen, a complete list of the entire queue
14735 must be set up before the deliveries start. When the queue is all held in a
14736 single directory (the default), a single list is created for both the ordered
14737 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14738 single list is not created when &%queue_run_in_order%& is false. In this case,
14739 the sub-directories are processed one at a time (in a random order), and this
14740 avoids setting up one huge list for the whole queue. Thus, setting
14741 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14742 when the queue is large, because of the extra work in setting up the single,
14743 large list. In most situations, &%queue_run_in_order%& should not be set.
14744
14745
14746
14747 .option queue_run_max main integer 5
14748 .cindex "queue runner" "maximum number of"
14749 This controls the maximum number of queue runner processes that an Exim daemon
14750 can run simultaneously. This does not mean that it starts them all at once,
14751 but rather that if the maximum number are still running when the time comes to
14752 start another one, it refrains from starting another one. This can happen with
14753 very large queues and/or very sluggish deliveries. This option does not,
14754 however, interlock with other processes, so additional queue runners can be
14755 started by other means, or by killing and restarting the daemon.
14756
14757 Setting this option to zero does not suppress queue runs; rather, it disables
14758 the limit, allowing any number of simultaneous queue runner processes to be
14759 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14760 the daemon's command line.
14761
14762 .option queue_smtp_domains main "domain list&!!" unset
14763 .cindex "queueing incoming messages"
14764 .cindex "message" "queueing remote deliveries"
14765 When this option is set, a delivery process is started whenever a message is
14766 received, routing is performed, and local deliveries take place.
14767 However, if any SMTP deliveries are required for domains that match
14768 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14769 message waits on the queue for the next queue run. Since routing of the message
14770 has taken place, Exim knows to which remote hosts it must be delivered, and so
14771 when the queue run happens, multiple messages for the same host are delivered
14772 over a single SMTP connection. The &%-odqs%& command line option causes all
14773 SMTP deliveries to be queued in this way, and is equivalent to setting
14774 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14775 &%queue_domains%&.
14776
14777
14778 .option receive_timeout main time 0s
14779 .cindex "timeout" "for non-SMTP input"
14780 This option sets the timeout for accepting a non-SMTP message, that is, the
14781 maximum time that Exim waits when reading a message on the standard input. If
14782 the value is zero, it will wait for ever. This setting is overridden by the
14783 &%-or%& command line option. The timeout for incoming SMTP messages is
14784 controlled by &%smtp_receive_timeout%&.
14785
14786 .option received_header_text main string&!! "see below"
14787 .cindex "customizing" "&'Received:'& header"
14788 .cindex "&'Received:'& header line" "customizing"
14789 This string defines the contents of the &'Received:'& message header that is
14790 added to each message, except for the timestamp, which is automatically added
14791 on at the end (preceded by a semicolon). The string is expanded each time it is
14792 used. If the expansion yields an empty string, no &'Received:'& header line is
14793 added to the message. Otherwise, the string should start with the text
14794 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14795 header lines. The default setting is:
14796
14797 .code
14798 received_header_text = Received: \
14799   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14800   {${if def:sender_ident \
14801   {from ${quote_local_part:$sender_ident} }}\
14802   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14803   by $primary_hostname \
14804   ${if def:received_protocol {with $received_protocol}} \
14805   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14806   (Exim $version_number)\n\t\
14807   ${if def:sender_address \
14808   {(envelope-from <$sender_address>)\n\t}}\
14809   id $message_exim_id\
14810   ${if def:received_for {\n\tfor $received_for}}
14811 .endd
14812
14813 The reference to the TLS cipher is omitted when Exim is built without TLS
14814 support. The use of conditional expansions ensures that this works for both
14815 locally generated messages and messages received from remote hosts, giving
14816 header lines such as the following:
14817 .code
14818 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14819 by marley.carol.example with esmtp (Exim 4.00)
14820 (envelope-from <bob@carol.example>)
14821 id 16IOWa-00019l-00
14822 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14823 Received: by scrooge.carol.example with local (Exim 4.00)
14824 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14825 .endd
14826 Until the body of the message has been received, the timestamp is the time when
14827 the message started to be received. Once the body has arrived, and all policy
14828 checks have taken place, the timestamp is updated to the time at which the
14829 message was accepted.
14830
14831
14832 .option received_headers_max main integer 30
14833 .cindex "loop" "prevention"
14834 .cindex "mail loop prevention"
14835 .cindex "&'Received:'& header line" "counting"
14836 When a message is to be delivered, the number of &'Received:'& headers is
14837 counted, and if it is greater than this parameter, a mail loop is assumed to
14838 have occurred, the delivery is abandoned, and an error message is generated.
14839 This applies to both local and remote deliveries.
14840
14841
14842 .option recipient_unqualified_hosts main "host list&!!" unset
14843 .cindex "unqualified addresses"
14844 .cindex "host" "unqualified addresses from"
14845 This option lists those hosts from which Exim is prepared to accept unqualified
14846 recipient addresses in message envelopes. The addresses are made fully
14847 qualified by the addition of the &%qualify_recipient%& value. This option also
14848 affects message header lines. Exim does not reject unqualified recipient
14849 addresses in headers, but it qualifies them only if the message came from a
14850 host that matches &%recipient_unqualified_hosts%&,
14851 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14852 option was not set.
14853
14854
14855 .option recipients_max main integer 0
14856 .cindex "limit" "number of recipients"
14857 .cindex "recipient" "maximum number"
14858 If this option is set greater than zero, it specifies the maximum number of
14859 original recipients for any message. Additional recipients that are generated
14860 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14861 all recipients over the limit; earlier recipients are delivered as normal.
14862 Non-SMTP messages with too many recipients are failed, and no deliveries are
14863 done.
14864
14865 .cindex "RCPT" "maximum number of incoming"
14866 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14867 RCPT commands in a single message.
14868
14869
14870 .option recipients_max_reject main boolean false
14871 If this option is set true, Exim rejects SMTP messages containing too many
14872 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14873 error to the eventual DATA command. Otherwise (the default) it gives a 452
14874 error to the surplus RCPT commands and accepts the message on behalf of the
14875 initial set of recipients. The remote server should then re-send the message
14876 for the remaining recipients at a later time.
14877
14878
14879 .option remote_max_parallel main integer 2
14880 .cindex "delivery" "parallelism for remote"
14881 This option controls parallel delivery of one message to a number of remote
14882 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14883 does all the remote deliveries for a message one by one. Otherwise, if a single
14884 message has to be delivered to more than one remote host, or if several copies
14885 have to be sent to the same remote host, up to &%remote_max_parallel%&
14886 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14887 deliveries are required, the maximum number of processes are started, and as
14888 each one finishes, another is begun. The order of starting processes is the
14889 same as if sequential delivery were being done, and can be controlled by the
14890 &%remote_sort_domains%& option. If parallel delivery takes place while running
14891 with debugging turned on, the debugging output from each delivery process is
14892 tagged with its process id.
14893
14894 This option controls only the maximum number of parallel deliveries for one
14895 message in one Exim delivery process. Because Exim has no central queue
14896 manager, there is no way of controlling the total number of simultaneous
14897 deliveries if the configuration allows a delivery attempt as soon as a message
14898 is received.
14899
14900 .cindex "number of deliveries"
14901 .cindex "delivery" "maximum number of"
14902 If you want to control the total number of deliveries on the system, you
14903 need to set the &%queue_only%& option. This ensures that all incoming messages
14904 are added to the queue without starting a delivery process. Then set up an Exim
14905 daemon to start queue runner processes at appropriate intervals (probably
14906 fairly often, for example, every minute), and limit the total number of queue
14907 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14908 delivers only one message at a time, the maximum number of deliveries that can
14909 then take place at once is &%queue_run_max%& multiplied by
14910 &%remote_max_parallel%&.
14911
14912 If it is purely remote deliveries you want to control, use
14913 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14914 doing the SMTP routing before queueing, so that several messages for the same
14915 host will eventually get delivered down the same connection.
14916
14917
14918 .option remote_sort_domains main "domain list&!!" unset
14919 .cindex "sorting remote deliveries"
14920 .cindex "delivery" "sorting remote"
14921 When there are a number of remote deliveries for a message, they are sorted by
14922 domain into the order given by this list. For example,
14923 .code
14924 remote_sort_domains = *.cam.ac.uk:*.uk
14925 .endd
14926 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14927 then to those in the &%uk%& domain, then to any others.
14928
14929
14930 .option retry_data_expire main time 7d
14931 .cindex "hints database" "data expiry"
14932 This option sets a &"use before"& time on retry information in Exim's hints
14933 database. Any older retry data is ignored. This means that, for example, once a
14934 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14935 past failures.
14936
14937
14938 .option retry_interval_max main time 24h
14939 .cindex "retry" "limit on interval"
14940 .cindex "limit" "on retry interval"
14941 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14942 intervals between delivery attempts for messages that cannot be delivered
14943 straight away. This option sets an overall limit to the length of time between
14944 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14945 the default value.
14946
14947
14948 .option return_path_remove main boolean true
14949 .cindex "&'Return-path:'& header line" "removing"
14950 RFC 2821, section 4.4, states that an SMTP server must insert a
14951 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14952 The &'Return-path:'& header preserves the sender address as received in the
14953 MAIL command. This description implies that this header should not be present
14954 in an incoming message. If &%return_path_remove%& is true, any existing
14955 &'Return-path:'& headers are removed from messages at the time they are
14956 received. Exim's transports have options for adding &'Return-path:'& headers at
14957 the time of delivery. They are normally used only for final local deliveries.
14958
14959
14960 .option return_size_limit main integer 100K
14961 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14962
14963
14964 .option rfc1413_hosts main "host list&!!" *
14965 .cindex "RFC 1413"
14966 .cindex "host" "for RFC 1413 calls"
14967 RFC 1413 identification calls are made to any client host which matches an item
14968 in the list.
14969
14970 .option rfc1413_query_timeout main time 5s
14971 .cindex "RFC 1413" "query timeout"
14972 .cindex "timeout" "for RFC 1413 call"
14973 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14974 no RFC 1413 calls are ever made.
14975
14976
14977 .option sender_unqualified_hosts main "host list&!!" unset
14978 .cindex "unqualified addresses"
14979 .cindex "host" "unqualified addresses from"
14980 This option lists those hosts from which Exim is prepared to accept unqualified
14981 sender addresses. The addresses are made fully qualified by the addition of
14982 &%qualify_domain%&. This option also affects message header lines. Exim does
14983 not reject unqualified addresses in headers that contain sender addresses, but
14984 it qualifies them only if the message came from a host that matches
14985 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14986 using TCP/IP), and the &%-bnq%& option was not set.
14987
14988
14989 .option smtp_accept_keepalive main boolean true
14990 .cindex "keepalive" "on incoming connection"
14991 This option controls the setting of the SO_KEEPALIVE option on incoming
14992 TCP/IP socket connections. When set, it causes the kernel to probe idle
14993 connections periodically, by sending packets with &"old"& sequence numbers. The
14994 other end of the connection should send an acknowledgment if the connection is
14995 still okay or a reset if the connection has been aborted. The reason for doing
14996 this is that it has the beneficial effect of freeing up certain types of
14997 connection that can get stuck when the remote host is disconnected without
14998 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14999 hours to detect unreachable hosts.
15000
15001
15002
15003 .option smtp_accept_max main integer 20
15004 .cindex "limit" "incoming SMTP connections"
15005 .cindex "SMTP" "incoming connection count"
15006 .cindex "inetd"
15007 This option specifies the maximum number of simultaneous incoming SMTP calls
15008 that Exim will accept. It applies only to the listening daemon; there is no
15009 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15010 value is set to zero, no limit is applied. However, it is required to be
15011 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15012 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15013
15014 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15015 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15016 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15017 and &%smtp_load_reserve%& are then checked before accepting the connection.
15018
15019
15020 .option smtp_accept_max_nonmail main integer 10
15021 .cindex "limit" "non-mail SMTP commands"
15022 .cindex "SMTP" "limiting non-mail commands"
15023 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15024 the connection if there are too many. This option defines &"too many"&. The
15025 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15026 client looping sending EHLO, for example. The check is applied only if the
15027 client host matches &%smtp_accept_max_nonmail_hosts%&.
15028
15029 When a new message is expected, one occurrence of RSET is not counted. This
15030 allows a client to send one RSET between messages (this is not necessary,
15031 but some clients do it). Exim also allows one uncounted occurrence of HELO
15032 or EHLO, and one occurrence of STARTTLS between messages. After
15033 starting up a TLS session, another EHLO is expected, and so it too is not
15034 counted. The first occurrence of AUTH in a connection, or immediately
15035 following STARTTLS is not counted. Otherwise, all commands other than
15036 MAIL, RCPT, DATA, and QUIT are counted.
15037
15038
15039 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15040 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15041 check by setting this option. The default value makes it apply to all hosts. By
15042 changing the value, you can exclude any badly-behaved hosts that you have to
15043 live with.
15044
15045
15046 . Allow this long option name to split; give it unsplit as a fifth argument
15047 . for the automatic .oindex that is generated by .option.
15048
15049 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
15050          smtp_accept_max_per_connection
15051 .cindex "SMTP" "limiting incoming message count"
15052 .cindex "limit" "messages per SMTP connection"
15053 The value of this option limits the number of MAIL commands that Exim is
15054 prepared to accept over a single SMTP connection, whether or not each command
15055 results in the transfer of a message. After the limit is reached, a 421
15056 response is given to subsequent MAIL commands. This limit is a safety
15057 precaution against a client that goes mad (incidents of this type have been
15058 seen).
15059
15060
15061 .option smtp_accept_max_per_host main string&!! unset
15062 .cindex "limit" "SMTP connections from one host"
15063 .cindex "host" "limiting SMTP connections from"
15064 This option restricts the number of simultaneous IP connections from a single
15065 host (strictly, from a single IP address) to the Exim daemon. The option is
15066 expanded, to enable different limits to be applied to different hosts by
15067 reference to &$sender_host_address$&. Once the limit is reached, additional
15068 connection attempts from the same host are rejected with error code 421. This
15069 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15070 of zero imposes no limit. If this option is set greater than zero, it is
15071 required that &%smtp_accept_max%& be non-zero.
15072
15073 &*Warning*&: When setting this option you should not use any expansion
15074 constructions that take an appreciable amount of time. The expansion and test
15075 happen in the main daemon loop, in order to reject additional connections
15076 without forking additional processes (otherwise a denial-of-service attack
15077 could cause a vast number or processes to be created). While the daemon is
15078 doing this processing, it cannot accept any other incoming connections.
15079
15080
15081
15082 .option smtp_accept_queue main integer 0
15083 .cindex "SMTP" "incoming connection count"
15084 .cindex "queueing incoming messages"
15085 .cindex "message" "queueing by SMTP connection count"
15086 If the number of simultaneous incoming SMTP connections being handled via the
15087 listening daemon exceeds this value, messages received by SMTP are just placed
15088 on the queue; no delivery processes are started automatically. The count is
15089 fixed at the start of an SMTP connection. It cannot be updated in the
15090 subprocess that receives messages, and so the queueing or not queueing applies
15091 to all messages received in the same connection.
15092
15093 A value of zero implies no limit, and clearly any non-zero value is useful only
15094 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15095 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15096 various &%-od%&&'x'& command line options.
15097
15098
15099 . Allow this long option name to split; give it unsplit as a fifth argument
15100 . for the automatic .oindex that is generated by .option.
15101
15102 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15103          smtp_accept_queue_per_connection
15104 .cindex "queueing incoming messages"
15105 .cindex "message" "queueing by message count"
15106 This option limits the number of delivery processes that Exim starts
15107 automatically when receiving messages via SMTP, whether via the daemon or by
15108 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15109 and the number of messages received in a single SMTP session exceeds this
15110 number, subsequent messages are placed on the queue, but no delivery processes
15111 are started. This helps to limit the number of Exim processes when a server
15112 restarts after downtime and there is a lot of mail waiting for it on other
15113 systems. On large systems, the default should probably be increased, and on
15114 dial-in client systems it should probably be set to zero (that is, disabled).
15115
15116
15117 .option smtp_accept_reserve main integer 0
15118 .cindex "SMTP" "incoming call count"
15119 .cindex "host" "reserved"
15120 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15121 number of SMTP connections that are reserved for connections from the hosts
15122 that are specified in &%smtp_reserve_hosts%&. The value set in
15123 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15124 restricted to this number of connections; the option specifies a minimum number
15125 of connection slots for them, not a maximum. It is a guarantee that this group
15126 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15127 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15128 individual host.
15129
15130 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15131 set to 5, once there are 45 active connections (from any hosts), new
15132 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15133 provided the other criteria for acceptance are met.
15134
15135
15136 .option smtp_active_hostname main string&!! unset
15137 .cindex "host" "name in SMTP responses"
15138 .cindex "SMTP" "host name in responses"
15139 .vindex "&$primary_hostname$&"
15140 This option is provided for multi-homed servers that want to masquerade as
15141 several different hosts. At the start of an incoming SMTP connection, its value
15142 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15143 responses. For example, it is used as domain name in the response to an
15144 incoming HELO or EHLO command.
15145
15146 .vindex "&$smtp_active_hostname$&"
15147 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15148 is saved with any messages that are received. It is therefore available for use
15149 in routers and transports when the message is later delivered.
15150
15151 If this option is unset, or if its expansion is forced to fail, or if the
15152 expansion results in an empty string, the value of &$primary_hostname$& is
15153 used. Other expansion failures cause a message to be written to the main and
15154 panic logs, and the SMTP command receives a temporary error. Typically, the
15155 value of &%smtp_active_hostname%& depends on the incoming interface address.
15156 For example:
15157 .code
15158 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15159   {cox.mydomain}{box.mydomain}}
15160 .endd
15161
15162 Although &$smtp_active_hostname$& is primarily concerned with incoming
15163 messages, it is also used as the default for HELO commands in callout
15164 verification if there is no remote transport from which to obtain a
15165 &%helo_data%& value.
15166
15167 .option smtp_banner main string&!! "see below"
15168 .cindex "SMTP" "welcome banner"
15169 .cindex "banner for SMTP"
15170 .cindex "welcome banner for SMTP"
15171 .cindex "customizing" "SMTP banner"
15172 This string, which is expanded every time it is used, is output as the initial
15173 positive response to an SMTP connection. The default setting is:
15174 .code
15175 smtp_banner = $smtp_active_hostname ESMTP Exim \
15176   $version_number $tod_full
15177 .endd
15178 Failure to expand the string causes a panic error. If you want to create a
15179 multiline response to the initial SMTP connection, use &"\n"& in the string at
15180 appropriate points, but not at the end. Note that the 220 code is not included
15181 in this string. Exim adds it automatically (several times in the case of a
15182 multiline response).
15183
15184
15185 .option smtp_check_spool_space main boolean true
15186 .cindex "checking disk space"
15187 .cindex "disk space, checking"
15188 .cindex "spool directory" "checking space"
15189 When this option is set, if an incoming SMTP session encounters the SIZE
15190 option on a MAIL command, it checks that there is enough space in the
15191 spool directory's partition to accept a message of that size, while still
15192 leaving free the amount specified by &%check_spool_space%& (even if that value
15193 is zero). If there isn't enough space, a temporary error code is returned.
15194
15195
15196 .option smtp_connect_backlog main integer 20
15197 .cindex "connection backlog"
15198 .cindex "SMTP" "connection backlog"
15199 .cindex "backlog of connections"
15200 This option specifies a maximum number of waiting SMTP connections. Exim passes
15201 this value to the TCP/IP system when it sets up its listener. Once this number
15202 of connections are waiting for the daemon's attention, subsequent connection
15203 attempts are refused at the TCP/IP level. At least, that is what the manuals
15204 say; in some circumstances such connection attempts have been observed to time
15205 out instead. For large systems it is probably a good idea to increase the
15206 value (to 50, say). It also gives some protection against denial-of-service
15207 attacks by SYN flooding.
15208
15209
15210 .option smtp_enforce_sync main boolean true
15211 .cindex "SMTP" "synchronization checking"
15212 .cindex "synchronization checking in SMTP"
15213 The SMTP protocol specification requires the client to wait for a response from
15214 the server at certain points in the dialogue. Without PIPELINING these
15215 synchronization points are after every command; with PIPELINING they are
15216 fewer, but they still exist.
15217
15218 Some spamming sites send out a complete set of SMTP commands without waiting
15219 for any response. Exim protects against this by rejecting a message if the
15220 client has sent further input when it should not have. The error response &"554
15221 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15222 for this error cannot be perfect because of transmission delays (unexpected
15223 input may be on its way but not yet received when Exim checks). However, it
15224 does detect many instances.
15225
15226 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15227 If you want to disable the check selectively (for example, only for certain
15228 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15229 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15230
15231
15232
15233 .option smtp_etrn_command main string&!! unset
15234 .cindex "ETRN" "command to be run"
15235 .vindex "&$domain$&"
15236 If this option is set, the given command is run whenever an SMTP ETRN
15237 command is received from a host that is permitted to issue such commands (see
15238 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15239 are independently expanded. The expansion variable &$domain$& is set to the
15240 argument of the ETRN command, and no syntax checking is done on it. For
15241 example:
15242 .code
15243 smtp_etrn_command = /etc/etrn_command $domain \
15244                     $sender_host_address
15245 .endd
15246 A new process is created to run the command, but Exim does not wait for it to
15247 complete. Consequently, its status cannot be checked. If the command cannot be
15248 run, a line is written to the panic log, but the ETRN caller still receives
15249 a 250 success response. Exim is normally running under its own uid when
15250 receiving SMTP, so it is not possible for it to change the uid before running
15251 the command.
15252
15253
15254 .option smtp_etrn_serialize main boolean true
15255 .cindex "ETRN" "serializing"
15256 When this option is set, it prevents the simultaneous execution of more than
15257 one identical command as a result of ETRN in an SMTP connection. See
15258 section &<<SECTETRN>>& for details.
15259
15260
15261 .option smtp_load_reserve main fixed-point unset
15262 .cindex "load average"
15263 If the system load average ever gets higher than this, incoming SMTP calls are
15264 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15265 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15266 the load is over the limit. The option has no effect on ancient operating
15267 systems on which Exim cannot determine the load average. See also
15268 &%deliver_queue_load_max%& and &%queue_only_load%&.
15269
15270
15271
15272 .option smtp_max_synprot_errors main integer 3
15273 .cindex "SMTP" "limiting syntax and protocol errors"
15274 .cindex "limit" "SMTP syntax and protocol errors"
15275 Exim rejects SMTP commands that contain syntax or protocol errors. In
15276 particular, a syntactically invalid email address, as in this command:
15277 .code
15278 RCPT TO:<abc xyz@a.b.c>
15279 .endd
15280 causes immediate rejection of the command, before any other tests are done.
15281 (The ACL cannot be run if there is no valid address to set up for it.) An
15282 example of a protocol error is receiving RCPT before MAIL. If there are
15283 too many syntax or protocol errors in one SMTP session, the connection is
15284 dropped. The limit is set by this option.
15285
15286 .cindex "PIPELINING" "expected errors"
15287 When the PIPELINING extension to SMTP is in use, some protocol errors are
15288 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15289 Exim assumes that PIPELINING will be used if it advertises it (see
15290 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15291 not count towards the limit.
15292
15293
15294
15295 .option smtp_max_unknown_commands main integer 3
15296 .cindex "SMTP" "limiting unknown commands"
15297 .cindex "limit" "unknown SMTP commands"
15298 If there are too many unrecognized commands in an incoming SMTP session, an
15299 Exim server drops the connection. This is a defence against some kinds of abuse
15300 that subvert web
15301 clients
15302 into making connections to SMTP ports; in these circumstances, a number of
15303 non-SMTP command lines are sent first.
15304
15305
15306
15307 .option smtp_ratelimit_hosts main "host list&!!" unset
15308 .cindex "SMTP" "rate limiting"
15309 .cindex "limit" "rate of message arrival"
15310 .cindex "RCPT" "rate limiting"
15311 Some sites find it helpful to be able to limit the rate at which certain hosts
15312 can send them messages, and the rate at which an individual message can specify
15313 recipients.
15314
15315 Exim has two rate-limiting facilities. This section describes the older
15316 facility, which can limit rates within a single connection. The newer
15317 &%ratelimit%& ACL condition can limit rates across all connections. See section
15318 &<<SECTratelimiting>>& for details of the newer facility.
15319
15320 When a host matches &%smtp_ratelimit_hosts%&, the values of
15321 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15322 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15323 respectively. Each option, if set, must contain a set of four comma-separated
15324 values:
15325
15326 .ilist
15327 A threshold, before which there is no rate limiting.
15328 .next
15329 An initial time delay. Unlike other times in Exim, numbers with decimal
15330 fractional parts are allowed here.
15331 .next
15332 A factor by which to increase the delay each time.
15333 .next
15334 A maximum value for the delay. This should normally be less than 5 minutes,
15335 because after that time, the client is liable to timeout the SMTP command.
15336 .endlist
15337
15338 For example, these settings have been used successfully at the site which
15339 first suggested this feature, for controlling mail from their customers:
15340 .code
15341 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15342 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15343 .endd
15344 The first setting specifies delays that are applied to MAIL commands after
15345 two have been received over a single connection. The initial delay is 0.5
15346 seconds, increasing by a factor of 1.05 each time. The second setting applies
15347 delays to RCPT commands when more than four occur in a single message.
15348
15349
15350 .option smtp_ratelimit_mail main string unset
15351 See &%smtp_ratelimit_hosts%& above.
15352
15353
15354 .option smtp_ratelimit_rcpt main string unset
15355 See &%smtp_ratelimit_hosts%& above.
15356
15357
15358 .option smtp_receive_timeout main time 5m
15359 .cindex "timeout" "for SMTP input"
15360 .cindex "SMTP" "input timeout"
15361 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15362 input, including batch SMTP. If a line of input (either an SMTP command or a
15363 data line) is not received within this time, the SMTP connection is dropped and
15364 the message is abandoned.
15365 A line is written to the log containing one of the following messages:
15366 .code
15367 SMTP command timeout on connection from...
15368 SMTP data timeout on connection from...
15369 .endd
15370 The former means that Exim was expecting to read an SMTP command; the latter
15371 means that it was in the DATA phase, reading the contents of a message.
15372
15373
15374 .oindex "&%-os%&"
15375 The value set by this option can be overridden by the
15376 &%-os%& command-line option. A setting of zero time disables the timeout, but
15377 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15378 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15379 timeout is controlled by &%receive_timeout%& and &%-or%&.
15380
15381
15382 .option smtp_reserve_hosts main "host list&!!" unset
15383 This option defines hosts for which SMTP connections are reserved; see
15384 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15385
15386
15387 .option smtp_return_error_details main boolean false
15388 .cindex "SMTP" "details policy failures"
15389 .cindex "policy control" "rejection, returning details"
15390 In the default state, Exim uses bland messages such as
15391 &"Administrative prohibition"& when it rejects SMTP commands for policy
15392 reasons. Many sysadmins like this because it gives away little information
15393 to spammers. However, some other sysadmins who are applying strict checking
15394 policies want to give out much fuller information about failures. Setting
15395 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15396 example, instead of &"Administrative prohibition"&, it might give:
15397 .code
15398 550-Rejected after DATA: '>' missing at end of address:
15399 550 failing address in "From" header is: <user@dom.ain
15400 .endd
15401
15402 .option spamd_address main string "see below"
15403 This option is available when Exim is compiled with the content-scanning
15404 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15405 The default value is
15406 .code
15407 127.0.0.1 783
15408 .endd
15409 See section &<<SECTscanspamass>>& for more details.
15410
15411
15412
15413 .option split_spool_directory main boolean false
15414 .cindex "multiple spool directories"
15415 .cindex "spool directory" "split"
15416 .cindex "directories, multiple"
15417 If this option is set, it causes Exim to split its input directory into 62
15418 subdirectories, each with a single alphanumeric character as its name. The
15419 sixth character of the message id is used to allocate messages to
15420 subdirectories; this is the least significant base-62 digit of the time of
15421 arrival of the message.
15422
15423 Splitting up the spool in this way may provide better performance on systems
15424 where there are long mail queues, by reducing the number of files in any one
15425 directory. The msglog directory is also split up in a similar way to the input
15426 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15427 are still placed in the single directory &_msglog.OLD_&.
15428
15429 It is not necessary to take any special action for existing messages when
15430 changing &%split_spool_directory%&. Exim notices messages that are in the
15431 &"wrong"& place, and continues to process them. If the option is turned off
15432 after a period of being on, the subdirectories will eventually empty and be
15433 automatically deleted.
15434
15435 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15436 changes. Instead of creating a list of all messages in the queue, and then
15437 trying to deliver each one in turn, it constructs a list of those in one
15438 sub-directory and tries to deliver them, before moving on to the next
15439 sub-directory. The sub-directories are processed in a random order. This
15440 spreads out the scanning of the input directories, and uses less memory. It is
15441 particularly beneficial when there are lots of messages on the queue. However,
15442 if &%queue_run_in_order%& is set, none of this new processing happens. The
15443 entire queue has to be scanned and sorted before any deliveries can start.
15444
15445
15446 .option spool_directory main string&!! "set at compile time"
15447 .cindex "spool directory" "path to"
15448 This defines the directory in which Exim keeps its spool, that is, the messages
15449 it is waiting to deliver. The default value is taken from the compile-time
15450 configuration setting, if there is one. If not, this option must be set. The
15451 string is expanded, so it can contain, for example, a reference to
15452 &$primary_hostname$&.
15453
15454 If the spool directory name is fixed on your installation, it is recommended
15455 that you set it at build time rather than from this option, particularly if the
15456 log files are being written to the spool directory (see &%log_file_path%&).
15457 Otherwise log files cannot be used for errors that are detected early on, such
15458 as failures in the configuration file.
15459
15460 By using this option to override the compiled-in path, it is possible to run
15461 tests of Exim without using the standard spool.
15462
15463 .option sqlite_lock_timeout main time 5s
15464 .cindex "sqlite lookup type" "lock timeout"
15465 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15466 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15467
15468 .option strict_acl_vars main boolean false
15469 .cindex "&ACL;" "variables, handling unset"
15470 This option controls what happens if a syntactically valid but undefined ACL
15471 variable is referenced. If it is false (the default), an empty string
15472 is substituted; if it is true, an error is generated. See section
15473 &<<SECTaclvariables>>& for details of ACL variables.
15474
15475 .option strip_excess_angle_brackets main boolean false
15476 .cindex "angle brackets, excess"
15477 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15478 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15479 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15480 passed on to another MTA, the excess angle brackets are not passed on. If this
15481 option is not set, multiple pairs of angle brackets cause a syntax error.
15482
15483
15484 .option strip_trailing_dot main boolean false
15485 .cindex "trailing dot on domain"
15486 .cindex "dot" "trailing on domain"
15487 If this option is set, a trailing dot at the end of a domain in an address is
15488 ignored. If this is in the envelope and the message is passed on to another
15489 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15490 domain causes a syntax error.
15491 However, addresses in header lines are checked only when an ACL requests header
15492 syntax checking.
15493
15494
15495 .option syslog_duplication main boolean true
15496 .cindex "syslog" "duplicate log lines; suppressing"
15497 When Exim is logging to syslog, it writes the log lines for its three
15498 separate logs at different syslog priorities so that they can in principle
15499 be separated on the logging hosts. Some installations do not require this
15500 separation, and in those cases, the duplication of certain log lines is a
15501 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15502 particular log line is written to syslog. For lines that normally go to
15503 both the main log and the reject log, the reject log version (possibly
15504 containing message header lines) is written, at LOG_NOTICE priority.
15505 Lines that normally go to both the main and the panic log are written at
15506 the LOG_ALERT priority.
15507
15508
15509 .option syslog_facility main string unset
15510 .cindex "syslog" "facility; setting"
15511 This option sets the syslog &"facility"& name, used when Exim is logging to
15512 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15513 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15514 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15515 details of Exim's logging.
15516
15517
15518
15519 .option syslog_processname main string &`exim`&
15520 .cindex "syslog" "process name; setting"
15521 This option sets the syslog &"ident"& name, used when Exim is logging to
15522 syslog. The value must be no longer than 32 characters. See chapter
15523 &<<CHAPlog>>& for details of Exim's logging.
15524
15525
15526
15527 .option syslog_timestamp main boolean true
15528 .cindex "syslog" "timestamps"
15529 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15530 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15531 details of Exim's logging.
15532
15533
15534 .option system_filter main string&!! unset
15535 .cindex "filter" "system filter"
15536 .cindex "system filter" "specifying"
15537 .cindex "Sieve filter" "not available for system filter"
15538 This option specifies an Exim filter file that is applied to all messages at
15539 the start of each delivery attempt, before any routing is done. System filters
15540 must be Exim filters; they cannot be Sieve filters. If the system filter
15541 generates any deliveries to files or pipes, or any new mail messages, the
15542 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15543 which transports are to be used. Details of this facility are given in chapter
15544 &<<CHAPsystemfilter>>&.
15545
15546
15547 .option system_filter_directory_transport main string&!! unset
15548 .vindex "&$address_file$&"
15549 This sets the name of the transport driver that is to be used when the
15550 &%save%& command in a system message filter specifies a path ending in &"/"&,
15551 implying delivery of each message into a separate file in some directory.
15552 During the delivery, the variable &$address_file$& contains the path name.
15553
15554
15555 .option system_filter_file_transport main string&!! unset
15556 .cindex "file" "transport for system filter"
15557 This sets the name of the transport driver that is to be used when the &%save%&
15558 command in a system message filter specifies a path not ending in &"/"&. During
15559 the delivery, the variable &$address_file$& contains the path name.
15560
15561 .option system_filter_group main string unset
15562 .cindex "gid (group id)" "system filter"
15563 This option is used only when &%system_filter_user%& is also set. It sets the
15564 gid under which the system filter is run, overriding any gid that is associated
15565 with the user. The value may be numerical or symbolic.
15566
15567 .option system_filter_pipe_transport main string&!! unset
15568 .cindex "&(pipe)& transport" "for system filter"
15569 .vindex "&$address_pipe$&"
15570 This specifies the transport driver that is to be used when a &%pipe%& command
15571 is used in a system filter. During the delivery, the variable &$address_pipe$&
15572 contains the pipe command.
15573
15574
15575 .option system_filter_reply_transport main string&!! unset
15576 .cindex "&(autoreply)& transport" "for system filter"
15577 This specifies the transport driver that is to be used when a &%mail%& command
15578 is used in a system filter.
15579
15580
15581 .option system_filter_user main string unset
15582 .cindex "uid (user id)" "system filter"
15583 If this option is set to root, the system filter is run in the main Exim
15584 delivery process, as root.  Otherwise, the system filter runs in a separate
15585 process, as the given user, defaulting to the Exim run-time user.
15586 Unless the string consists entirely of digits, it
15587 is looked up in the password data. Failure to find the named user causes a
15588 configuration error. The gid is either taken from the password data, or
15589 specified by &%system_filter_group%&. When the uid is specified numerically,
15590 &%system_filter_group%& is required to be set.
15591
15592 If the system filter generates any pipe, file, or reply deliveries, the uid
15593 under which the filter is run is used when transporting them, unless a
15594 transport option overrides.
15595
15596
15597 .option tcp_nodelay main boolean true
15598 .cindex "daemon" "TCP_NODELAY on sockets"
15599 .cindex "Nagle algorithm"
15600 .cindex "TCP_NODELAY on listening sockets"
15601 If this option is set false, it stops the Exim daemon setting the
15602 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15603 turns off the &"Nagle algorithm"&, which is a way of improving network
15604 performance in interactive (character-by-character) situations. Turning it off
15605 should improve Exim's performance a bit, so that is what happens by default.
15606 However, it appears that some broken clients cannot cope, and time out. Hence
15607 this option. It affects only those sockets that are set up for listening by the
15608 daemon. Sockets created by the smtp transport for delivering mail always set
15609 TCP_NODELAY.
15610
15611
15612 .option timeout_frozen_after main time 0s
15613 .cindex "frozen messages" "timing out"
15614 .cindex "timeout" "frozen messages"
15615 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15616 message of any kind that has been on the queue for longer than the given time
15617 is automatically cancelled at the next queue run. If the frozen message is a
15618 bounce message, it is just discarded; otherwise, a bounce is sent to the
15619 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15620 If you want to timeout frozen bounce messages earlier than other kinds of
15621 frozen message, see &%ignore_bounce_errors_after%&.
15622
15623 &*Note:*& the default value of zero means no timeouts; with this setting,
15624 frozen messages remain on the queue forever (except for any frozen bounce
15625 messages that are released by &%ignore_bounce_errors_after%&).
15626
15627
15628 .option timezone main string unset
15629 .cindex "timezone, setting"
15630 The value of &%timezone%& is used to set the environment variable TZ while
15631 running Exim (if it is different on entry). This ensures that all timestamps
15632 created by Exim are in the required timezone. If you want all your timestamps
15633 to be in UTC (aka GMT) you should set
15634 .code
15635 timezone = UTC
15636 .endd
15637 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15638 or, if that is not set, from the value of the TZ environment variable when Exim
15639 is built. If &%timezone%& is set to the empty string, either at build or run
15640 time, any existing TZ variable is removed from the environment when Exim
15641 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15642 unfortunately not all, operating systems.
15643
15644
15645 .option tls_advertise_hosts main "host list&!!" unset
15646 .cindex "TLS" "advertising"
15647 .cindex "encryption" "on SMTP connection"
15648 .cindex "SMTP" "encrypted connection"
15649 When Exim is built with support for TLS encrypted connections, the availability
15650 of the STARTTLS command to set up an encrypted session is advertised in
15651 response to EHLO only to those client hosts that match this option. See
15652 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15653
15654
15655 .option tls_certificate main string&!! unset
15656 .cindex "TLS" "server certificate; location of"
15657 .cindex "certificate" "server, location of"
15658 The value of this option is expanded, and must then be the absolute path to a
15659 file which contains the server's certificates. The server's private key is also
15660 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15661 &<<CHAPTLS>>& for further details.
15662
15663 &*Note*&: The certificates defined by this option are used only when Exim is
15664 receiving incoming messages as a server. If you want to supply certificates for
15665 use when sending messages as a client, you must set the &%tls_certificate%&
15666 option in the relevant &(smtp)& transport.
15667
15668 .new
15669 If the option contains &$tls_sni$& and Exim is built against OpenSSL, then
15670 if the OpenSSL build supports TLS extensions and the TLS client sends the
15671 Server Name Indication extension, then this option and others documented in
15672 &<<SECTtlssni>>& will be re-expanded.
15673 .wen
15674
15675 .option tls_crl main string&!! unset
15676 .cindex "TLS" "server certificate revocation list"
15677 .cindex "certificate" "revocation list for server"
15678 This option specifies a certificate revocation list. The expanded value must
15679 be the name of a file that contains a CRL in PEM format.
15680
15681 .new
15682 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15683 .wen
15684
15685
15686 .option tls_dhparam main string&!! unset
15687 .cindex "TLS" "D-H parameters for server"
15688 The value of this option is expanded, and must then be the absolute path to
15689 a file which contains the server's DH parameter values.
15690 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15691 ignored. See section &<<SECTopenvsgnu>>& for further details.
15692
15693
15694 .option tls_on_connect_ports main "string list" unset
15695 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15696 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15697 set up without waiting for the client to issue a STARTTLS command. For
15698 further details, see section &<<SECTsupobssmt>>&.
15699
15700
15701
15702 .option tls_privatekey main string&!! unset
15703 .cindex "TLS" "server private key; location of"
15704 The value of this option is expanded, and must then be the absolute path to a
15705 file which contains the server's private key. If this option is unset, or if
15706 the expansion is forced to fail, or the result is an empty string, the private
15707 key is assumed to be in the same file as the server's certificates. See chapter
15708 &<<CHAPTLS>>& for further details.
15709
15710 .new
15711 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15712 .wen
15713
15714
15715 .option tls_remember_esmtp main boolean false
15716 .cindex "TLS" "esmtp state; remembering"
15717 .cindex "TLS" "broken clients"
15718 If this option is set true, Exim violates the RFCs by remembering that it is in
15719 &"esmtp"& state after successfully negotiating a TLS session. This provides
15720 support for broken clients that fail to send a new EHLO after starting a
15721 TLS session.
15722
15723
15724 .option tls_require_ciphers main string&!! unset
15725 .cindex "TLS" "requiring specific ciphers"
15726 .cindex "cipher" "requiring specific"
15727 This option controls which ciphers can be used for incoming TLS connections.
15728 The &(smtp)& transport has an option of the same name for controlling outgoing
15729 connections. This option is expanded for each connection, so can be varied for
15730 different clients if required. The value of this option must be a list of
15731 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15732 in somewhat different ways. If GnuTLS is being used, the client controls the
15733 preference order of the available ciphers. Details are given in sections
15734 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15735
15736
15737 .option tls_try_verify_hosts main "host list&!!" unset
15738 .cindex "TLS" "client certificate verification"
15739 .cindex "certificate" "verification of client"
15740 See &%tls_verify_hosts%& below.
15741
15742
15743 .option tls_verify_certificates main string&!! unset
15744 .cindex "TLS" "client certificate verification"
15745 .cindex "certificate" "verification of client"
15746 The value of this option is expanded, and must then be the absolute path to
15747 a file containing permitted certificates for clients that
15748 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15749 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15750 directory containing certificate files. This does not work with GnuTLS; the
15751 option must be set to the name of a single file if you are using GnuTLS.
15752
15753 These certificates should be for the certificate authorities trusted, rather
15754 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
15755 the value is a file then the certificates are sent by Exim as a server to
15756 connecting clients, defining the list of accepted certificate authorities.
15757 Thus the values defined should be considered public data.  To avoid this,
15758 use OpenSSL with a directory.
15759
15760 .new
15761 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15762 .wen
15763
15764
15765 .option tls_verify_hosts main "host list&!!" unset
15766 .cindex "TLS" "client certificate verification"
15767 .cindex "certificate" "verification of client"
15768 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15769 certificates from clients. The expected certificates are defined by
15770 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15771 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15772 &%tls_verify_certificates%& is not set.
15773
15774 Any client that matches &%tls_verify_hosts%& is constrained by
15775 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15776 present one of the listed certificates. If it does not, the connection is
15777 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15778 the host to use TLS. It can still send SMTP commands through unencrypted
15779 connections. Forcing a client to use TLS has to be done separately using an
15780 ACL to reject inappropriate commands when the connection is not encrypted.
15781
15782 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15783 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15784 certificate and checks it against &%tls_verify_certificates%&, but does not
15785 abort the connection if there is no certificate or if it does not match. This
15786 state can be detected in an ACL, which makes it possible to implement policies
15787 such as &"accept for relay only if a verified certificate has been received,
15788 but accept for local delivery if encrypted, even without a verified
15789 certificate"&.
15790
15791 Client hosts that match neither of these lists are not asked to present
15792 certificates.
15793
15794
15795 .option trusted_groups main "string list&!!" unset
15796 .cindex "trusted groups"
15797 .cindex "groups" "trusted"
15798 This option is expanded just once, at the start of Exim's processing. If this
15799 option is set, any process that is running in one of the listed groups, or
15800 which has one of them as a supplementary group, is trusted. The groups can be
15801 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15802 details of what trusted callers are permitted to do. If neither
15803 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15804 are trusted.
15805
15806 .option trusted_users main "string list&!!" unset
15807 .cindex "trusted users"
15808 .cindex "user" "trusted"
15809 This option is expanded just once, at the start of Exim's processing. If this
15810 option is set, any process that is running as one of the listed users is
15811 trusted. The users can be specified numerically or by name. See section
15812 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15813 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15814 Exim user are trusted.
15815
15816 .option unknown_login main string&!! unset
15817 .cindex "uid (user id)" "unknown caller"
15818 .vindex "&$caller_uid$&"
15819 This is a specialized feature for use in unusual configurations. By default, if
15820 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15821 gives up. The &%unknown_login%& option can be used to set a login name to be
15822 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15823 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15824 is used for the user's real name (gecos field), unless this has been set by the
15825 &%-F%& option.
15826
15827 .option unknown_username main string unset
15828 See &%unknown_login%&.
15829
15830 .option untrusted_set_sender main "address list&!!" unset
15831 .cindex "trusted users"
15832 .cindex "sender" "setting by untrusted user"
15833 .cindex "untrusted user setting sender"
15834 .cindex "user" "untrusted setting sender"
15835 .cindex "envelope sender"
15836 When an untrusted user submits a message to Exim using the standard input, Exim
15837 normally creates an envelope sender address from the user's login and the
15838 default qualification domain. Data from the &%-f%& option (for setting envelope
15839 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15840 is used) is ignored.
15841
15842 However, untrusted users are permitted to set an empty envelope sender address,
15843 to declare that a message should never generate any bounces. For example:
15844 .code
15845 exim -f '<>' user@domain.example
15846 .endd
15847 .vindex "&$sender_ident$&"
15848 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15849 other envelope sender addresses in a controlled way. When it is set, untrusted
15850 users are allowed to set envelope sender addresses that match any of the
15851 patterns in the list. Like all address lists, the string is expanded. The
15852 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15853 users to setting senders that start with their login ids
15854 followed by a hyphen
15855 by a setting like this:
15856 .code
15857 untrusted_set_sender = ^$sender_ident-
15858 .endd
15859 If you want to allow untrusted users to set envelope sender addresses without
15860 restriction, you can use
15861 .code
15862 untrusted_set_sender = *
15863 .endd
15864 The &%untrusted_set_sender%& option applies to all forms of local input, but
15865 only to the setting of the envelope sender. It does not permit untrusted users
15866 to use the other options which trusted user can use to override message
15867 parameters. Furthermore, it does not stop Exim from removing an existing
15868 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15869 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15870 overriding these actions. The handling of the &'Sender:'& header is also
15871 described in section &<<SECTthesenhea>>&.
15872
15873 The log line for a message's arrival shows the envelope sender following
15874 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15875 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15876 envelope sender address, the user's login is shown in parentheses after the
15877 sender address.
15878
15879
15880 .option uucp_from_pattern main string "see below"
15881 .cindex "&""From""& line"
15882 .cindex "UUCP" "&""From""& line"
15883 Some applications that pass messages to an MTA via a command line interface use
15884 an initial line starting with &"From&~"& to pass the envelope sender. In
15885 particular, this is used by UUCP software. Exim recognizes such a line by means
15886 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15887 matches, the sender address is constructed by expanding the contents of
15888 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15889 default pattern recognizes lines in the following two forms:
15890 .code
15891 From ph10 Fri Jan  5 12:35 GMT 1996
15892 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15893 .endd
15894 The pattern can be seen by running
15895 .code
15896 exim -bP uucp_from_pattern
15897 .endd
15898 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15899 year in the second case. The first word after &"From&~"& is matched in the
15900 regular expression by a parenthesized subpattern. The default value for
15901 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15902 (&"ph10"& in the example above) as the message's sender. See also
15903 &%ignore_fromline_hosts%&.
15904
15905
15906 .option uucp_from_sender main string&!! &`$1`&
15907 See &%uucp_from_pattern%& above.
15908
15909
15910 .option warn_message_file main string unset
15911 .cindex "warning of delay" "customizing the message"
15912 .cindex "customizing" "warning message"
15913 This option defines a template file containing paragraphs of text to be used
15914 for constructing the warning message which is sent by Exim when a message has
15915 been on the queue for a specified amount of time, as specified by
15916 &%delay_warning%&. Details of the file's contents are given in chapter
15917 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15918
15919
15920 .option write_rejectlog main boolean true
15921 .cindex "reject log" "disabling"
15922 If this option is set false, Exim no longer writes anything to the reject log.
15923 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15924 .ecindex IIDconfima
15925 .ecindex IIDmaiconf
15926
15927
15928
15929
15930 . ////////////////////////////////////////////////////////////////////////////
15931 . ////////////////////////////////////////////////////////////////////////////
15932
15933 .chapter "Generic options for routers" "CHAProutergeneric"
15934 .scindex IIDgenoprou1 "options" "generic; for routers"
15935 .scindex IIDgenoprou2 "generic options" "router"
15936 This chapter describes the generic options that apply to all routers.
15937 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15938
15939 For a general description of how a router operates, see sections
15940 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15941 which the preconditions are tested. The order of expansion of the options that
15942 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15943 &%headers_remove%&, &%transport%&.
15944
15945
15946
15947 .option address_data routers string&!! unset
15948 .cindex "router" "data attached to address"
15949 The string is expanded just before the router is run, that is, after all the
15950 precondition tests have succeeded. If the expansion is forced to fail, the
15951 router declines, the value of &%address_data%& remains unchanged, and the
15952 &%more%& option controls what happens next. Other expansion failures cause
15953 delivery of the address to be deferred.
15954
15955 .vindex "&$address_data$&"
15956 When the expansion succeeds, the value is retained with the address, and can be
15957 accessed using the variable &$address_data$& in the current router, subsequent
15958 routers, and the eventual transport.
15959
15960 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15961 that runs a user's filter file, the contents of &$address_data$& are accessible
15962 in the filter. This is not normally a problem, because such data is usually
15963 either not confidential or it &"belongs"& to the current user, but if you do
15964 put confidential data into &$address_data$& you need to remember this point.
15965
15966 Even if the router declines or passes, the value of &$address_data$& remains
15967 with the address, though it can be changed by another &%address_data%& setting
15968 on a subsequent router. If a router generates child addresses, the value of
15969 &$address_data$& propagates to them. This also applies to the special kind of
15970 &"child"& that is generated by a router with the &%unseen%& option.
15971
15972 The idea of &%address_data%& is that you can use it to look up a lot of data
15973 for the address once, and then pick out parts of the data later. For example,
15974 you could use a single LDAP lookup to return a string of the form
15975 .code
15976 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15977 .endd
15978 In the transport you could pick out the mailbox by a setting such as
15979 .code
15980 file = ${extract{mailbox}{$address_data}}
15981 .endd
15982 This makes the configuration file less messy, and also reduces the number of
15983 lookups (though Exim does cache lookups).
15984
15985 .vindex "&$sender_address_data$&"
15986 .vindex "&$address_data$&"
15987 The &%address_data%& facility is also useful as a means of passing information
15988 from one router to another, and from a router to a transport. In addition, if
15989 &$address_data$& is set by a router when verifying a recipient address from an
15990 ACL, it remains available for use in the rest of the ACL statement. After
15991 verifying a sender, the value is transferred to &$sender_address_data$&.
15992
15993
15994
15995 .option address_test routers&!? boolean true
15996 .oindex "&%-bt%&"
15997 .cindex "router" "skipping when address testing"
15998 If this option is set false, the router is skipped when routing is being tested
15999 by means of the &%-bt%& command line option. This can be a convenience when
16000 your first router sends messages to an external scanner, because it saves you
16001 having to set the &"already scanned"& indicator when testing real address
16002 routing.
16003
16004
16005
16006 .option cannot_route_message routers string&!! unset
16007 .cindex "router" "customizing &""cannot route""& message"
16008 .cindex "customizing" "&""cannot route""& message"
16009 This option specifies a text message that is used when an address cannot be
16010 routed because Exim has run out of routers. The default message is
16011 &"Unrouteable address"&. This option is useful only on routers that have
16012 &%more%& set false, or on the very last router in a configuration, because the
16013 value that is used is taken from the last router that is considered. This
16014 includes a router that is skipped because its preconditions are not met, as
16015 well as a router that declines. For example, using the default configuration,
16016 you could put:
16017 .code
16018 cannot_route_message = Remote domain not found in DNS
16019 .endd
16020 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16021 and
16022 .code
16023 cannot_route_message = Unknown local user
16024 .endd
16025 on the final router that checks for local users. If string expansion fails for
16026 this option, the default message is used. Unless the expansion failure was
16027 explicitly forced, a message about the failure is written to the main and panic
16028 logs, in addition to the normal message about the routing failure.
16029
16030
16031 .option caseful_local_part routers boolean false
16032 .cindex "case of local parts"
16033 .cindex "router" "case of local parts"
16034 By default, routers handle the local parts of addresses in a case-insensitive
16035 manner, though the actual case is preserved for transmission with the message.
16036 If you want the case of letters to be significant in a router, you must set
16037 this option true. For individual router options that contain address or local
16038 part lists (for example, &%local_parts%&), case-sensitive matching can be
16039 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16040 more details.
16041
16042 .vindex "&$local_part$&"
16043 .vindex "&$original_local_part$&"
16044 .vindex "&$parent_local_part$&"
16045 The value of the &$local_part$& variable is forced to lower case while a
16046 router is running unless &%caseful_local_part%& is set. When a router assigns
16047 an address to a transport, the value of &$local_part$& when the transport runs
16048 is the same as it was in the router. Similarly, when a router generates child
16049 addresses by aliasing or forwarding, the values of &$original_local_part$&
16050 and &$parent_local_part$& are those that were used by the redirecting router.
16051
16052 This option applies to the processing of an address by a router. When a
16053 recipient address is being processed in an ACL, there is a separate &%control%&
16054 modifier that can be used to specify case-sensitive processing within the ACL
16055 (see section &<<SECTcontrols>>&).
16056
16057
16058
16059 .option check_local_user routers&!? boolean false
16060 .cindex "local user, checking in router"
16061 .cindex "router" "checking for local user"
16062 .cindex "&_/etc/passwd_&"
16063 .vindex "&$home$&"
16064 When this option is true, Exim checks that the local part of the recipient
16065 address (with affixes removed if relevant) is the name of an account on the
16066 local system. The check is done by calling the &[getpwnam()]& function rather
16067 than trying to read &_/etc/passwd_& directly. This means that other methods of
16068 holding password data (such as NIS) are supported. If the local part is a local
16069 user, &$home$& is set from the password data, and can be tested in other
16070 preconditions that are evaluated after this one (the order of evaluation is
16071 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16072 overridden by &%router_home_directory%&. If the local part is not a local user,
16073 the router is skipped.
16074
16075 If you want to check that the local part is either the name of a local user
16076 or matches something else, you cannot combine &%check_local_user%& with a
16077 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16078 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16079 setting to achieve this. For example:
16080 .code
16081 local_parts = passwd;$local_part : lsearch;/etc/other/users
16082 .endd
16083 Note, however, that the side effects of &%check_local_user%& (such as setting
16084 up a home directory) do not occur when a &(passwd)& lookup is used in a
16085 &%local_parts%& (or any other) precondition.
16086
16087
16088
16089 .option condition routers&!? string&!! unset
16090 .cindex "router" "customized precondition"
16091 This option specifies a general precondition test that has to succeed for the
16092 router to be called. The &%condition%& option is the last precondition to be
16093 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16094 result is a forced failure, or an empty string, or one of the strings &"0"& or
16095 &"no"& or &"false"& (checked without regard to the case of the letters), the
16096 router is skipped, and the address is offered to the next one.
16097
16098 If the result is any other value, the router is run (as this is the last
16099 precondition to be evaluated, all the other preconditions must be true).
16100
16101 This option is unique in that multiple &%condition%& options may be present.
16102 All &%condition%& options must succeed.
16103
16104 The &%condition%& option provides a means of applying custom conditions to the
16105 running of routers. Note that in the case of a simple conditional expansion,
16106 the default expansion values are exactly what is wanted. For example:
16107 .code
16108 condition = ${if >{$message_age}{600}}
16109 .endd
16110 Because of the default behaviour of the string expansion, this is equivalent to
16111 .code
16112 condition = ${if >{$message_age}{600}{true}{}}
16113 .endd
16114
16115 A multiple condition example, which succeeds:
16116 .code
16117 condition = ${if >{$message_age}{600}}
16118 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16119 condition = foobar
16120 .endd
16121
16122 If the expansion fails (other than forced failure) delivery is deferred. Some
16123 of the other precondition options are common special cases that could in fact
16124 be specified using &%condition%&.
16125
16126
16127 .option debug_print routers string&!! unset
16128 .cindex "testing" "variables in drivers"
16129 If this option is set and debugging is enabled (see the &%-d%& command line
16130 option), the string is expanded and included in the debugging output.
16131 If expansion of the string fails, the error message is written to the debugging
16132 output, and Exim carries on processing.
16133 This option is provided to help with checking out the values of variables and
16134 so on when debugging router configurations. For example, if a &%condition%&
16135 option appears not to be working, &%debug_print%& can be used to output the
16136 variables it references. The output happens after checks for &%domains%&,
16137 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16138 are tested. A newline is added to the text if it does not end with one.
16139
16140
16141
16142 .option disable_logging routers boolean false
16143 If this option is set true, nothing is logged for any routing errors
16144 or for any deliveries caused by this router. You should not set this option
16145 unless you really, really know what you are doing. See also the generic
16146 transport option of the same name.
16147
16148
16149 .option domains routers&!? "domain list&!!" unset
16150 .cindex "router" "restricting to specific domains"
16151 .vindex "&$domain_data$&"
16152 If this option is set, the router is skipped unless the current domain matches
16153 the list. If the match is achieved by means of a file lookup, the data that the
16154 lookup returned for the domain is placed in &$domain_data$& for use in string
16155 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16156 a list of the order in which preconditions are evaluated.
16157
16158
16159
16160 .option driver routers string unset
16161 This option must always be set. It specifies which of the available routers is
16162 to be used.
16163
16164
16165
16166 .option errors_to routers string&!! unset
16167 .cindex "envelope sender"
16168 .cindex "router" "changing address for errors"
16169 If a router successfully handles an address, it may assign the address to a
16170 transport for delivery or it may generate child addresses. In both cases, if
16171 there is a delivery problem during later processing, the resulting bounce
16172 message is sent to the address that results from expanding this string,
16173 provided that the address verifies successfully. The &%errors_to%& option is
16174 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16175
16176 The &%errors_to%& setting associated with an address can be overridden if it
16177 subsequently passes through other routers that have their own &%errors_to%&
16178 settings, or if the message is delivered by a transport with a &%return_path%&
16179 setting.
16180
16181 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16182 the expansion fails to verify, the errors address associated with the incoming
16183 address is used. At top level, this is the envelope sender. A non-forced
16184 expansion failure causes delivery to be deferred.
16185
16186 If an address for which &%errors_to%& has been set ends up being delivered over
16187 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16188 any bounces that are generated by other MTAs on the delivery route are also
16189 sent there. You can set &%errors_to%& to the empty string by either of these
16190 settings:
16191 .code
16192 errors_to =
16193 errors_to = ""
16194 .endd
16195 An expansion item that yields an empty string has the same effect. If you do
16196 this, a locally detected delivery error for addresses processed by this router
16197 no longer gives rise to a bounce message; the error is discarded. If the
16198 address is delivered to a remote host, the return path is set to &`<>`&, unless
16199 overridden by the &%return_path%& option on the transport.
16200
16201 .vindex "&$address_data$&"
16202 If for some reason you want to discard local errors, but use a non-empty
16203 MAIL command for remote delivery, you can preserve the original return
16204 path in &$address_data$& in the router, and reinstate it in the transport by
16205 setting &%return_path%&.
16206
16207 The most common use of &%errors_to%& is to direct mailing list bounces to the
16208 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16209 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16210
16211
16212
16213 .option expn routers&!? boolean true
16214 .cindex "address" "testing"
16215 .cindex "testing" "addresses"
16216 .cindex "EXPN" "router skipping"
16217 .cindex "router" "skipping for EXPN"
16218 If this option is turned off, the router is skipped when testing an address
16219 as a result of processing an SMTP EXPN command. You might, for example,
16220 want to turn it off on a router for users' &_.forward_& files, while leaving it
16221 on for the system alias file.
16222 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16223 are evaluated.
16224
16225 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16226 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16227 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16228
16229
16230
16231 .option fail_verify routers boolean false
16232 .cindex "router" "forcing verification failure"
16233 Setting this option has the effect of setting both &%fail_verify_sender%& and
16234 &%fail_verify_recipient%& to the same value.
16235
16236
16237
16238 .option fail_verify_recipient routers boolean false
16239 If this option is true and an address is accepted by this router when
16240 verifying a recipient, verification fails.
16241
16242
16243
16244 .option fail_verify_sender routers boolean false
16245 If this option is true and an address is accepted by this router when
16246 verifying a sender, verification fails.
16247
16248
16249
16250 .option fallback_hosts routers "string list" unset
16251 .cindex "router" "fallback hosts"
16252 .cindex "fallback" "hosts specified on router"
16253 String expansion is not applied to this option. The argument must be a
16254 colon-separated list of host names or IP addresses. The list separator can be
16255 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16256 each name or address. In fact, the format of each item is exactly the same as
16257 defined for the list of hosts in a &(manualroute)& router (see section
16258 &<<SECTformatonehostitem>>&).
16259
16260 If a router queues an address for a remote transport, this host list is
16261 associated with the address, and used instead of the transport's fallback host
16262 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16263 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16264 transport for further details.
16265
16266
16267 .option group routers string&!! "see below"
16268 .cindex "gid (group id)" "local delivery"
16269 .cindex "local transports" "uid and gid"
16270 .cindex "transport" "local"
16271 .cindex "router" "setting group"
16272 When a router queues an address for a transport, and the transport does not
16273 specify a group, the group given here is used when running the delivery
16274 process.
16275 The group may be specified numerically or by name. If expansion fails, the
16276 error is logged and delivery is deferred.
16277 The default is unset, unless &%check_local_user%& is set, when the default
16278 is taken from the password information. See also &%initgroups%& and &%user%&
16279 and the discussion in chapter &<<CHAPenvironment>>&.
16280
16281
16282
16283 .option headers_add routers string&!! unset
16284 .cindex "header lines" "adding"
16285 .cindex "router" "adding header lines"
16286 This option specifies a string of text that is expanded at routing time, and
16287 associated with any addresses that are accepted by the router. However, this
16288 option has no effect when an address is just being verified. The way in which
16289 the text is used to add header lines at transport time is described in section
16290 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16291 message is in the process of being transported. This means that references to
16292 header lines in string expansions in the transport's configuration do not
16293 &"see"& the added header lines.
16294
16295 The &%headers_add%& option is expanded after &%errors_to%&, but before
16296 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16297 the expansion is forced to fail, the option has no effect. Other expansion
16298 failures are treated as configuration errors.
16299
16300 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16301 router that has the &%one_time%& option set.
16302
16303 .cindex "duplicate addresses"
16304 .oindex "&%unseen%&"
16305 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16306 additions are deleted when the address is passed on to subsequent routers.
16307 For a &%redirect%& router, if a generated address is the same as the incoming
16308 address, this can lead to duplicate addresses with different header
16309 modifications. Exim does not do duplicate deliveries (except, in certain
16310 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16311 which of the duplicates is discarded, so this ambiguous situation should be
16312 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16313
16314
16315
16316 .option headers_remove routers string&!! unset
16317 .cindex "header lines" "removing"
16318 .cindex "router" "removing header lines"
16319 This option specifies a string of text that is expanded at routing time, and
16320 associated with any addresses that are accepted by the router. However, this
16321 option has no effect when an address is just being verified. The way in which
16322 the text is used to remove header lines at transport time is described in
16323 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16324 the message is in the process of being transported. This means that references
16325 to header lines in string expansions in the transport's configuration still
16326 &"see"& the original header lines.
16327
16328 The &%headers_remove%& option is expanded after &%errors_to%& and
16329 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16330 the option has no effect. Other expansion failures are treated as configuration
16331 errors.
16332
16333 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16334 router that has the &%one_time%& option set.
16335
16336 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16337 removal requests are deleted when the address is passed on to subsequent
16338 routers, and this can lead to problems with duplicates -- see the similar
16339 warning for &%headers_add%& above.
16340
16341
16342 .option ignore_target_hosts routers "host list&!!" unset
16343 .cindex "IP address" "discarding"
16344 .cindex "router" "discarding IP addresses"
16345 Although this option is a host list, it should normally contain IP address
16346 entries rather than names. If any host that is looked up by the router has an
16347 IP address that matches an item in this list, Exim behaves as if that IP
16348 address did not exist. This option allows you to cope with rogue DNS entries
16349 like
16350 .code
16351 remote.domain.example.  A  127.0.0.1
16352 .endd
16353 by setting
16354 .code
16355 ignore_target_hosts = 127.0.0.1
16356 .endd
16357 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16358 discarded in this way, the router declines. In a conventional configuration, an
16359 attempt to mail to such a domain would normally provoke the &"unrouteable
16360 domain"& error, and an attempt to verify an address in the domain would fail.
16361 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16362 router declines if presented with one of the listed addresses.
16363
16364 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16365 means of the first or the second of the following settings, respectively:
16366 .code
16367 ignore_target_hosts = 0.0.0.0/0
16368 ignore_target_hosts = <; 0::0/0
16369 .endd
16370 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16371 in the second line matches all IPv6 addresses.
16372
16373 This option may also be useful for ignoring link-local and site-local IPv6
16374 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16375 is expanded before use as a list, it is possible to make it dependent on the
16376 domain that is being routed.
16377
16378 .vindex "&$host_address$&"
16379 During its expansion, &$host_address$& is set to the IP address that is being
16380 checked.
16381
16382 .option initgroups routers boolean false
16383 .cindex "additional groups"
16384 .cindex "groups" "additional"
16385 .cindex "local transports" "uid and gid"
16386 .cindex "transport" "local"
16387 If the router queues an address for a transport, and this option is true, and
16388 the uid supplied by the router is not overridden by the transport, the
16389 &[initgroups()]& function is called when running the transport to ensure that
16390 any additional groups associated with the uid are set up. See also &%group%&
16391 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16392
16393
16394
16395 .option local_part_prefix routers&!? "string list" unset
16396 .cindex "router" "prefix for local part"
16397 .cindex "prefix" "for local part, used in router"
16398 If this option is set, the router is skipped unless the local part starts with
16399 one of the given strings, or &%local_part_prefix_optional%& is true. See
16400 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16401 evaluated.
16402
16403 The list is scanned from left to right, and the first prefix that matches is
16404 used. A limited form of wildcard is available; if the prefix begins with an
16405 asterisk, it matches the longest possible sequence of arbitrary characters at
16406 the start of the local part. An asterisk should therefore always be followed by
16407 some character that does not occur in normal local parts.
16408 .cindex "multiple mailboxes"
16409 .cindex "mailbox" "multiple"
16410 Wildcarding can be used to set up multiple user mailboxes, as described in
16411 section &<<SECTmulbox>>&.
16412
16413 .vindex "&$local_part$&"
16414 .vindex "&$local_part_prefix$&"
16415 During the testing of the &%local_parts%& option, and while the router is
16416 running, the prefix is removed from the local part, and is available in the
16417 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16418 the router accepts the address, this remains true during subsequent delivery by
16419 a transport. In particular, the local part that is transmitted in the RCPT
16420 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16421 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16422 the relevant transport.
16423
16424 When an address is being verified, &%local_part_prefix%& affects only the
16425 behaviour of the router. If the callout feature of verification is in use, this
16426 means that the full address, including the prefix, will be used during the
16427 callout.
16428
16429 The prefix facility is commonly used to handle local parts of the form
16430 &%owner-something%&. Another common use is to support local parts of the form
16431 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16432 to tell a user their forwarding is broken &-- by placing a router like this one
16433 immediately before the router that handles &_.forward_& files:
16434 .code
16435 real_localuser:
16436   driver = accept
16437   local_part_prefix = real-
16438   check_local_user
16439   transport = local_delivery
16440 .endd
16441 For security, it would probably be a good idea to restrict the use of this
16442 router to locally-generated messages, using a condition such as this:
16443 .code
16444   condition = ${if match {$sender_host_address}\
16445                          {\N^(|127\.0\.0\.1)$\N}}
16446 .endd
16447
16448 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16449 both conditions must be met if not optional. Care must be taken if wildcards
16450 are used in both a prefix and a suffix on the same router. Different
16451 separator characters must be used to avoid ambiguity.
16452
16453
16454 .option local_part_prefix_optional routers boolean false
16455 See &%local_part_prefix%& above.
16456
16457
16458
16459 .option local_part_suffix routers&!? "string list" unset
16460 .cindex "router" "suffix for local part"
16461 .cindex "suffix for local part" "used in router"
16462 This option operates in the same way as &%local_part_prefix%&, except that the
16463 local part must end (rather than start) with the given string, the
16464 &%local_part_suffix_optional%& option determines whether the suffix is
16465 mandatory, and the wildcard * character, if present, must be the last
16466 character of the suffix. This option facility is commonly used to handle local
16467 parts of the form &%something-request%& and multiple user mailboxes of the form
16468 &%username-foo%&.
16469
16470
16471 .option local_part_suffix_optional routers boolean false
16472 See &%local_part_suffix%& above.
16473
16474
16475
16476 .option local_parts routers&!? "local part list&!!" unset
16477 .cindex "router" "restricting to specific local parts"
16478 .cindex "local part" "checking in router"
16479 The router is run only if the local part of the address matches the list.
16480 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16481 are evaluated, and
16482 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16483 string is expanded, it is possible to make it depend on the domain, for
16484 example:
16485 .code
16486 local_parts = dbm;/usr/local/specials/$domain
16487 .endd
16488 .vindex "&$local_part_data$&"
16489 If the match is achieved by a lookup, the data that the lookup returned
16490 for the local part is placed in the variable &$local_part_data$& for use in
16491 expansions of the router's private options. You might use this option, for
16492 example, if you have a large number of local virtual domains, and you want to
16493 send all postmaster mail to the same place without having to set up an alias in
16494 each virtual domain:
16495 .code
16496 postmaster:
16497   driver = redirect
16498   local_parts = postmaster
16499   data = postmaster@real.domain.example
16500 .endd
16501
16502
16503 .option log_as_local routers boolean "see below"
16504 .cindex "log" "delivery line"
16505 .cindex "delivery" "log line format"
16506 Exim has two logging styles for delivery, the idea being to make local
16507 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16508 recipient address is given just as the local part, without a domain. The use of
16509 this style is controlled by this option. It defaults to true for the &(accept)&
16510 router, and false for all the others. This option applies only when a
16511 router assigns an address to a transport. It has no effect on routers that
16512 redirect addresses.
16513
16514
16515
16516 .option more routers boolean&!! true
16517 The result of string expansion for this option must be a valid boolean value,
16518 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16519 result causes an error, and delivery is deferred. If the expansion is forced to
16520 fail, the default value for the option (true) is used. Other failures cause
16521 delivery to be deferred.
16522
16523 If this option is set false, and the router declines to handle the address, no
16524 further routers are tried, routing fails, and the address is bounced.
16525 .oindex "&%self%&"
16526 However, if the router explicitly passes an address to the following router by
16527 means of the setting
16528 .code
16529 self = pass
16530 .endd
16531 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16532 does not affect the behaviour if one of the precondition tests fails. In that
16533 case, the address is always passed to the next router.
16534
16535 Note that &%address_data%& is not considered to be a precondition. If its
16536 expansion is forced to fail, the router declines, and the value of &%more%&
16537 controls what happens next.
16538
16539
16540 .option pass_on_timeout routers boolean false
16541 .cindex "timeout" "of router"
16542 .cindex "router" "timeout"
16543 If a router times out during a host lookup, it normally causes deferral of the
16544 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16545 router, overriding &%no_more%&. This may be helpful for systems that are
16546 intermittently connected to the Internet, or those that want to pass to a smart
16547 host any messages that cannot immediately be delivered.
16548
16549 There are occasional other temporary errors that can occur while doing DNS
16550 lookups. They are treated in the same way as a timeout, and this option
16551 applies to all of them.
16552
16553
16554
16555 .option pass_router routers string unset
16556 .cindex "router" "go to after &""pass""&"
16557 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16558 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16559 routing to continue, and overriding a false setting of &%more%&. When one of
16560 these routers returns &"pass"&, the address is normally handed on to the next
16561 router in sequence. This can be changed by setting &%pass_router%& to the name
16562 of another router. However (unlike &%redirect_router%&) the named router must
16563 be below the current router, to avoid loops. Note that this option applies only
16564 to the special case of &"pass"&. It does not apply when a router returns
16565 &"decline"& because it cannot handle an address.
16566
16567
16568
16569 .option redirect_router routers string unset
16570 .cindex "router" "start at after redirection"
16571 Sometimes an administrator knows that it is pointless to reprocess addresses
16572 generated from alias or forward files with the same router again. For
16573 example, if an alias file translates real names into login ids there is no
16574 point searching the alias file a second time, especially if it is a large file.
16575
16576 The &%redirect_router%& option can be set to the name of any router instance.
16577 It causes the routing of any generated addresses to start at the named router
16578 instead of at the first router. This option has no effect if the router in
16579 which it is set does not generate new addresses.
16580
16581
16582
16583 .option require_files routers&!? "string list&!!" unset
16584 .cindex "file" "requiring for router"
16585 .cindex "router" "requiring file existence"
16586 This option provides a general mechanism for predicating the running of a
16587 router on the existence or non-existence of certain files or directories.
16588 Before running a router, as one of its precondition tests, Exim works its way
16589 through the &%require_files%& list, expanding each item separately.
16590
16591 Because the list is split before expansion, any colons in expansion items must
16592 be doubled, or the facility for using a different list separator must be used.
16593 If any expansion is forced to fail, the item is ignored. Other expansion
16594 failures cause routing of the address to be deferred.
16595
16596 If any expanded string is empty, it is ignored. Otherwise, except as described
16597 below, each string must be a fully qualified file path, optionally preceded by
16598 &"!"&. The paths are passed to the &[stat()]& function to test for the
16599 existence of the files or directories. The router is skipped if any paths not
16600 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16601
16602 .cindex "NFS"
16603 If &[stat()]& cannot determine whether a file exists or not, delivery of
16604 the message is deferred. This can happen when NFS-mounted filesystems are
16605 unavailable.
16606
16607 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16608 options, so you cannot use it to check for the existence of a file in which to
16609 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16610 full list of the order in which preconditions are evaluated.) However, as
16611 these options are all expanded, you can use the &%exists%& expansion condition
16612 to make such tests. The &%require_files%& option is intended for checking files
16613 that the router may be going to use internally, or which are needed by a
16614 transport (for example &_.procmailrc_&).
16615
16616 During delivery, the &[stat()]& function is run as root, but there is a
16617 facility for some checking of the accessibility of a file by another user.
16618 This is not a proper permissions check, but just a &"rough"& check that
16619 operates as follows:
16620
16621 If an item in a &%require_files%& list does not contain any forward slash
16622 characters, it is taken to be the user (and optional group, separated by a
16623 comma) to be checked for subsequent files in the list. If no group is specified
16624 but the user is specified symbolically, the gid associated with the uid is
16625 used. For example:
16626 .code
16627 require_files = mail:/some/file
16628 require_files = $local_part:$home/.procmailrc
16629 .endd
16630 If a user or group name in a &%require_files%& list does not exist, the
16631 &%require_files%& condition fails.
16632
16633 Exim performs the check by scanning along the components of the file path, and
16634 checking the access for the given uid and gid. It checks for &"x"& access on
16635 directories, and &"r"& access on the final file. Note that this means that file
16636 access control lists, if the operating system has them, are ignored.
16637
16638 &*Warning 1*&: When the router is being run to verify addresses for an
16639 incoming SMTP message, Exim is not running as root, but under its own uid. This
16640 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16641 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16642 user is not permitted to read one of the directories on the file's path.
16643
16644 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16645 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16646 without root access. In this case, if a check for access by a particular user
16647 is requested, Exim creates a subprocess that runs as that user, and tries the
16648 check again in that process.
16649
16650 The default action for handling an unresolved EACCES is to consider it to
16651 be caused by a configuration error, and routing is deferred because the
16652 existence or non-existence of the file cannot be determined. However, in some
16653 circumstances it may be desirable to treat this condition as if the file did
16654 not exist. If the file name (or the exclamation mark that precedes the file
16655 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16656 as if the file did not exist. For example:
16657 .code
16658 require_files = +/some/file
16659 .endd
16660 If the router is not an essential part of verification (for example, it
16661 handles users' &_.forward_& files), another solution is to set the &%verify%&
16662 option false so that the router is skipped when verifying.
16663
16664
16665
16666 .option retry_use_local_part routers boolean "see below"
16667 .cindex "hints database" "retry keys"
16668 .cindex "local part" "in retry keys"
16669 When a delivery suffers a temporary routing failure, a retry record is created
16670 in Exim's hints database. For addresses whose routing depends only on the
16671 domain, the key for the retry record should not involve the local part, but for
16672 other addresses, both the domain and the local part should be included.
16673 Usually, remote routing is of the former kind, and local routing is of the
16674 latter kind.
16675
16676 This option controls whether the local part is used to form the key for retry
16677 hints for addresses that suffer temporary errors while being handled by this
16678 router. The default value is true for any router that has &%check_local_user%&
16679 set, and false otherwise. Note that this option does not apply to hints keys
16680 for transport delays; they are controlled by a generic transport option of the
16681 same name.
16682
16683 The setting of &%retry_use_local_part%& applies only to the router on which it
16684 appears. If the router generates child addresses, they are routed
16685 independently; this setting does not become attached to them.
16686
16687
16688
16689 .option router_home_directory routers string&!! unset
16690 .cindex "router" "home directory for"
16691 .cindex "home directory" "for router"
16692 .vindex "&$home$&"
16693 This option sets a home directory for use while the router is running. (Compare
16694 &%transport_home_directory%&, which sets a home directory for later
16695 transporting.) In particular, if used on a &(redirect)& router, this option
16696 sets a value for &$home$& while a filter is running. The value is expanded;
16697 forced expansion failure causes the option to be ignored &-- other failures
16698 cause the router to defer.
16699
16700 Expansion of &%router_home_directory%& happens immediately after the
16701 &%check_local_user%& test (if configured), before any further expansions take
16702 place.
16703 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16704 are evaluated.)
16705 While the router is running, &%router_home_directory%& overrides the value of
16706 &$home$& that came from &%check_local_user%&.
16707
16708 When a router accepts an address and assigns it to a local transport (including
16709 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16710 delivery), the home directory setting for the transport is taken from the first
16711 of these values that is set:
16712
16713 .ilist
16714 The &%home_directory%& option on the transport;
16715 .next
16716 The &%transport_home_directory%& option on the router;
16717 .next
16718 The password data if &%check_local_user%& is set on the router;
16719 .next
16720 The &%router_home_directory%& option on the router.
16721 .endlist
16722
16723 In other words, &%router_home_directory%& overrides the password data for the
16724 router, but not for the transport.
16725
16726
16727
16728 .option self routers string freeze
16729 .cindex "MX record" "pointing to local host"
16730 .cindex "local host" "MX pointing to"
16731 This option applies to those routers that use a recipient address to find a
16732 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16733 and &(manualroute)& routers.
16734 Certain configurations of the &(queryprogram)& router can also specify a list
16735 of remote hosts.
16736 Usually such routers are configured to send the message to a remote host via an
16737 &(smtp)& transport. The &%self%& option specifies what happens when the first
16738 host on the list turns out to be the local host.
16739 The way in which Exim checks for the local host is described in section
16740 &<<SECTreclocipadd>>&.
16741
16742 Normally this situation indicates either an error in Exim's configuration (for
16743 example, the router should be configured not to process this domain), or an
16744 error in the DNS (for example, the MX should not point to this host). For this
16745 reason, the default action is to log the incident, defer the address, and
16746 freeze the message. The following alternatives are provided for use in special
16747 cases:
16748
16749 .vlist
16750 .vitem &%defer%&
16751 Delivery of the message is tried again later, but the message is not frozen.
16752
16753 .vitem "&%reroute%&: <&'domain'&>"
16754 The domain is changed to the given domain, and the address is passed back to
16755 be reprocessed by the routers. No rewriting of headers takes place. This
16756 behaviour is essentially a redirection.
16757
16758 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16759 The domain is changed to the given domain, and the address is passed back to be
16760 reprocessed by the routers. Any headers that contain the original domain are
16761 rewritten.
16762
16763 .vitem &%pass%&
16764 .oindex "&%more%&"
16765 .vindex "&$self_hostname$&"
16766 The router passes the address to the next router, or to the router named in the
16767 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16768 subsequent routing and delivery, the variable &$self_hostname$& contains the
16769 name of the local host that the router encountered. This can be used to
16770 distinguish between different cases for hosts with multiple names. The
16771 combination
16772 .code
16773 self = pass
16774 no_more
16775 .endd
16776 ensures that only those addresses that routed to the local host are passed on.
16777 Without &%no_more%&, addresses that were declined for other reasons would also
16778 be passed to the next router.
16779
16780 .vitem &%fail%&
16781 Delivery fails and an error report is generated.
16782
16783 .vitem &%send%&
16784 .cindex "local host" "sending to"
16785 The anomaly is ignored and the address is queued for the transport. This
16786 setting should be used with extreme caution. For an &(smtp)& transport, it
16787 makes sense only in cases where the program that is listening on the SMTP port
16788 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16789 different configuration file that handles the domain in another way.
16790 .endlist
16791
16792
16793
16794 .option senders routers&!? "address list&!!" unset
16795 .cindex "router" "checking senders"
16796 If this option is set, the router is skipped unless the message's sender
16797 address matches something on the list.
16798 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16799 are evaluated.
16800
16801 There are issues concerning verification when the running of routers is
16802 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16803 setting, it sets the sender to the null string. When using the &%-bt%& option
16804 to check a configuration file, it is necessary also to use the &%-f%& option to
16805 set an appropriate sender. For incoming mail, the sender is unset when
16806 verifying the sender, but is available when verifying any recipients. If the
16807 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16808 matters.
16809
16810
16811 .option translate_ip_address routers string&!! unset
16812 .cindex "IP address" "translating"
16813 .cindex "packet radio"
16814 .cindex "router" "IP address translation"
16815 There exist some rare networking situations (for example, packet radio) where
16816 it is helpful to be able to translate IP addresses generated by normal routing
16817 mechanisms into other IP addresses, thus performing a kind of manual IP
16818 routing. This should be done only if the normal IP routing of the TCP/IP stack
16819 is inadequate or broken. Because this is an extremely uncommon requirement, the
16820 code to support this option is not included in the Exim binary unless
16821 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16822
16823 .vindex "&$host_address$&"
16824 The &%translate_ip_address%& string is expanded for every IP address generated
16825 by the router, with the generated address set in &$host_address$&. If the
16826 expansion is forced to fail, no action is taken.
16827 For any other expansion error, delivery of the message is deferred.
16828 If the result of the expansion is an IP address, that replaces the original
16829 address; otherwise the result is assumed to be a host name &-- this is looked
16830 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16831 produce one or more replacement IP addresses. For example, to subvert all IP
16832 addresses in some specific networks, this could be added to a router:
16833 .code
16834 translate_ip_address = \
16835   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16836     {$value}fail}}
16837 .endd
16838 The file would contain lines like
16839 .code
16840 10.2.3.128/26    some.host
16841 10.8.4.34/26     10.44.8.15
16842 .endd
16843 You should not make use of this facility unless you really understand what you
16844 are doing.
16845
16846
16847
16848 .option transport routers string&!! unset
16849 This option specifies the transport to be used when a router accepts an address
16850 and sets it up for delivery. A transport is never needed if a router is used
16851 only for verification. The value of the option is expanded at routing time,
16852 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16853 and result must be the name of one of the configured transports. If it is not,
16854 delivery is deferred.
16855
16856 The &%transport%& option is not used by the &(redirect)& router, but it does
16857 have some private options that set up transports for pipe and file deliveries
16858 (see chapter &<<CHAPredirect>>&).
16859
16860
16861
16862 .option transport_current_directory routers string&!! unset
16863 .cindex "current directory for local transport"
16864 This option associates a current directory with any address that is routed
16865 to a local transport. This can happen either because a transport is
16866 explicitly configured for the router, or because it generates a delivery to a
16867 file or a pipe. During the delivery process (that is, at transport time), this
16868 option string is expanded and is set as the current directory, unless
16869 overridden by a setting on the transport.
16870 If the expansion fails for any reason, including forced failure, an error is
16871 logged, and delivery is deferred.
16872 See chapter &<<CHAPenvironment>>& for details of the local delivery
16873 environment.
16874
16875
16876
16877
16878 .option transport_home_directory routers string&!! "see below"
16879 .cindex "home directory" "for local transport"
16880 This option associates a home directory with any address that is routed to a
16881 local transport. This can happen either because a transport is explicitly
16882 configured for the router, or because it generates a delivery to a file or a
16883 pipe. During the delivery process (that is, at transport time), the option
16884 string is expanded and is set as the home directory, unless overridden by a
16885 setting of &%home_directory%& on the transport.
16886 If the expansion fails for any reason, including forced failure, an error is
16887 logged, and delivery is deferred.
16888
16889 If the transport does not specify a home directory, and
16890 &%transport_home_directory%& is not set for the router, the home directory for
16891 the transport is taken from the password data if &%check_local_user%& is set for
16892 the router. Otherwise it is taken from &%router_home_directory%& if that option
16893 is set; if not, no home directory is set for the transport.
16894
16895 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16896 environment.
16897
16898
16899
16900
16901 .option unseen routers boolean&!! false
16902 .cindex "router" "carrying on after success"
16903 The result of string expansion for this option must be a valid boolean value,
16904 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16905 result causes an error, and delivery is deferred. If the expansion is forced to
16906 fail, the default value for the option (false) is used. Other failures cause
16907 delivery to be deferred.
16908
16909 When this option is set true, routing does not cease if the router accepts the
16910 address. Instead, a copy of the incoming address is passed to the next router,
16911 overriding a false setting of &%more%&. There is little point in setting
16912 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16913 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16914 sometimes true and sometimes false).
16915
16916 .cindex "copy of message (&%unseen%& option)"
16917 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16918 qualifier in filter files. It can be used to cause copies of messages to be
16919 delivered to some other destination, while also carrying out a normal delivery.
16920 In effect, the current address is made into a &"parent"& that has two children
16921 &-- one that is delivered as specified by this router, and a clone that goes on
16922 to be routed further. For this reason, &%unseen%& may not be combined with the
16923 &%one_time%& option in a &(redirect)& router.
16924
16925 &*Warning*&: Header lines added to the address (or specified for removal) by
16926 this router or by previous routers affect the &"unseen"& copy of the message
16927 only. The clone that continues to be processed by further routers starts with
16928 no added headers and none specified for removal. For a &%redirect%& router, if
16929 a generated address is the same as the incoming address, this can lead to
16930 duplicate addresses with different header modifications. Exim does not do
16931 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16932 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16933 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16934 &%redirect%& router may be of help.
16935
16936 Unlike the handling of header modifications, any data that was set by the
16937 &%address_data%& option in the current or previous routers &'is'& passed on to
16938 subsequent routers.
16939
16940
16941 .option user routers string&!! "see below"
16942 .cindex "uid (user id)" "local delivery"
16943 .cindex "local transports" "uid and gid"
16944 .cindex "transport" "local"
16945 .cindex "router" "user for filter processing"
16946 .cindex "filter" "user for processing"
16947 When a router queues an address for a transport, and the transport does not
16948 specify a user, the user given here is used when running the delivery process.
16949 The user may be specified numerically or by name. If expansion fails, the
16950 error is logged and delivery is deferred.
16951 This user is also used by the &(redirect)& router when running a filter file.
16952 The default is unset, except when &%check_local_user%& is set. In this case,
16953 the default is taken from the password information. If the user is specified as
16954 a name, and &%group%& is not set, the group associated with the user is used.
16955 See also &%initgroups%& and &%group%& and the discussion in chapter
16956 &<<CHAPenvironment>>&.
16957
16958
16959
16960 .option verify routers&!? boolean true
16961 Setting this option has the effect of setting &%verify_sender%& and
16962 &%verify_recipient%& to the same value.
16963
16964
16965 .option verify_only routers&!? boolean false
16966 .cindex "EXPN" "with &%verify_only%&"
16967 .oindex "&%-bv%&"
16968 .cindex "router" "used only when verifying"
16969 If this option is set, the router is used only when verifying an address or
16970 testing with the &%-bv%& option, not when actually doing a delivery, testing
16971 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16972 restricted to verifying only senders or recipients by means of
16973 &%verify_sender%& and &%verify_recipient%&.
16974
16975 &*Warning*&: When the router is being run to verify addresses for an incoming
16976 SMTP message, Exim is not running as root, but under its own uid. If the router
16977 accesses any files, you need to make sure that they are accessible to the Exim
16978 user or group.
16979
16980
16981 .option verify_recipient routers&!? boolean true
16982 If this option is false, the router is skipped when verifying recipient
16983 addresses
16984 or testing recipient verification using &%-bv%&.
16985 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16986 are evaluated.
16987
16988
16989 .option verify_sender routers&!? boolean true
16990 If this option is false, the router is skipped when verifying sender addresses
16991 or testing sender verification using &%-bvs%&.
16992 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16993 are evaluated.
16994 .ecindex IIDgenoprou1
16995 .ecindex IIDgenoprou2
16996
16997
16998
16999
17000
17001
17002 . ////////////////////////////////////////////////////////////////////////////
17003 . ////////////////////////////////////////////////////////////////////////////
17004
17005 .chapter "The accept router" "CHID4"
17006 .cindex "&(accept)& router"
17007 .cindex "routers" "&(accept)&"
17008 The &(accept)& router has no private options of its own. Unless it is being
17009 used purely for verification (see &%verify_only%&) a transport is required to
17010 be defined by the generic &%transport%& option. If the preconditions that are
17011 specified by generic options are met, the router accepts the address and queues
17012 it for the given transport. The most common use of this router is for setting
17013 up deliveries to local mailboxes. For example:
17014 .code
17015 localusers:
17016   driver = accept
17017   domains = mydomain.example
17018   check_local_user
17019   transport = local_delivery
17020 .endd
17021 The &%domains%& condition in this example checks the domain of the address, and
17022 &%check_local_user%& checks that the local part is the login of a local user.
17023 When both preconditions are met, the &(accept)& router runs, and queues the
17024 address for the &(local_delivery)& transport.
17025
17026
17027
17028
17029
17030
17031 . ////////////////////////////////////////////////////////////////////////////
17032 . ////////////////////////////////////////////////////////////////////////////
17033
17034 .chapter "The dnslookup router" "CHAPdnslookup"
17035 .scindex IIDdnsrou1 "&(dnslookup)& router"
17036 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17037 The &(dnslookup)& router looks up the hosts that handle mail for the
17038 recipient's domain in the DNS. A transport must always be set for this router,
17039 unless &%verify_only%& is set.
17040
17041 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17042 SRV records. If none are found, or if SRV support is not configured,
17043 MX records are looked up. If no MX records exist, address records are sought.
17044 However, &%mx_domains%& can be set to disable the direct use of address
17045 records.
17046
17047 MX records of equal priority are sorted by Exim into a random order. Exim then
17048 looks for address records for the host names obtained from MX or SRV records.
17049 When a host has more than one IP address, they are sorted into a random order,
17050 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17051 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17052 generic option, the router declines.
17053
17054 Unless they have the highest priority (lowest MX value), MX records that point
17055 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17056 are discarded, together with any other MX records of equal or lower priority.
17057
17058 .cindex "MX record" "pointing to local host"
17059 .cindex "local host" "MX pointing to"
17060 .oindex "&%self%&" "in &(dnslookup)& router"
17061 If the host pointed to by the highest priority MX record, or looked up as an
17062 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17063 happens is controlled by the generic &%self%& option.
17064
17065
17066 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17067 There have been problems with DNS servers when SRV records are looked up.
17068 Some mis-behaving servers return a DNS error or timeout when a non-existent
17069 SRV record is sought. Similar problems have in the past been reported for
17070 MX records. The global &%dns_again_means_nonexist%& option can help with this
17071 problem, but it is heavy-handed because it is a global option.
17072
17073 For this reason, there are two options, &%srv_fail_domains%& and
17074 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17075 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17076 an attempt to look up an SRV or MX record causes one of these results, and the
17077 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17078 such record"&. In the case of an SRV lookup, this means that the router
17079 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17080 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17081 case routing fails.
17082
17083
17084
17085
17086 .section "Private options for dnslookup" "SECID118"
17087 .cindex "options" "&(dnslookup)& router"
17088 The private options for the &(dnslookup)& router are as follows:
17089
17090 .option check_secondary_mx dnslookup boolean false
17091 .cindex "MX record" "checking for secondary"
17092 If this option is set, the router declines unless the local host is found in
17093 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17094 process domains for which the local host is a secondary mail exchanger
17095 differently to other domains. The way in which Exim decides whether a host is
17096 the local host is described in section &<<SECTreclocipadd>>&.
17097
17098
17099 .option check_srv dnslookup string&!! unset
17100 .cindex "SRV record" "enabling use of"
17101 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17102 addition to MX and address records. The support is disabled by default. To
17103 enable SRV support, set the &%check_srv%& option to the name of the service
17104 required. For example,
17105 .code
17106 check_srv = smtp
17107 .endd
17108 looks for SRV records that refer to the normal smtp service. The option is
17109 expanded, so the service name can vary from message to message or address
17110 to address. This might be helpful if SRV records are being used for a
17111 submission service. If the expansion is forced to fail, the &%check_srv%&
17112 option is ignored, and the router proceeds to look for MX records in the
17113 normal way.
17114
17115 When the expansion succeeds, the router searches first for SRV records for
17116 the given service (it assumes TCP protocol). A single SRV record with a
17117 host name that consists of just a single dot indicates &"no such service for
17118 this domain"&; if this is encountered, the router declines. If other kinds of
17119 SRV record are found, they are used to construct a host list for delivery
17120 according to the rules of RFC 2782. MX records are not sought in this case.
17121
17122 When no SRV records are found, MX records (and address records) are sought in
17123 the traditional way. In other words, SRV records take precedence over MX
17124 records, just as MX records take precedence over address records. Note that
17125 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17126 defined it. It is apparently believed that MX records are sufficient for email
17127 and that SRV records should not be used for this purpose. However, SRV records
17128 have an additional &"weight"& feature which some people might find useful when
17129 trying to split an SMTP load between hosts of different power.
17130
17131 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17132 when there is a DNS lookup error.
17133
17134
17135
17136 .option mx_domains dnslookup "domain list&!!" unset
17137 .cindex "MX record" "required to exist"
17138 .cindex "SRV record" "required to exist"
17139 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17140 record in order to be recognized. (The name of this option could be improved.)
17141 For example, if all the mail hosts in &'fict.example'& are known to have MX
17142 records, except for those in &'discworld.fict.example'&, you could use this
17143 setting:
17144 .code
17145 mx_domains = ! *.discworld.fict.example : *.fict.example
17146 .endd
17147 This specifies that messages addressed to a domain that matches the list but
17148 has no MX record should be bounced immediately instead of being routed using
17149 the address record.
17150
17151
17152 .option mx_fail_domains dnslookup "domain list&!!" unset
17153 If the DNS lookup for MX records for one of the domains in this list causes a
17154 DNS lookup error, Exim behaves as if no MX records were found. See section
17155 &<<SECTprowitdnsloo>>& for more discussion.
17156
17157
17158
17159
17160 .option qualify_single dnslookup boolean true
17161 .cindex "DNS" "resolver options"
17162 .cindex "DNS" "qualifying single-component names"
17163 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17164 lookups. Typically, but not standardly, this causes the resolver to qualify
17165 single-component names with the default domain. For example, on a machine
17166 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17167 &'thesaurus.ref.example'& inside the resolver. For details of what your
17168 resolver actually does, consult your man pages for &'resolver'& and
17169 &'resolv.conf'&.
17170
17171
17172
17173 .option rewrite_headers dnslookup boolean true
17174 .cindex "rewriting" "header lines"
17175 .cindex "header lines" "rewriting"
17176 If the domain name in the address that is being processed is not fully
17177 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17178 an address is specified as &'dormouse@teaparty'&, the domain might be
17179 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17180 occur as a result of setting the &%widen_domains%& option. If
17181 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17182 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17183 header lines of the message are rewritten with the full domain name.
17184
17185 This option should be turned off only when it is known that no message is
17186 ever going to be sent outside an environment where the abbreviation makes
17187 sense.
17188
17189 When an MX record is looked up in the DNS and matches a wildcard record, name
17190 servers normally return a record containing the name that has been looked up,
17191 making it impossible to detect whether a wildcard was present or not. However,
17192 some name servers have recently been seen to return the wildcard entry. If the
17193 name returned by a DNS lookup begins with an asterisk, it is not used for
17194 header rewriting.
17195
17196
17197 .option same_domain_copy_routing dnslookup boolean false
17198 .cindex "address" "copying routing"
17199 Addresses with the same domain are normally routed by the &(dnslookup)& router
17200 to the same list of hosts. However, this cannot be presumed, because the router
17201 options and preconditions may refer to the local part of the address. By
17202 default, therefore, Exim routes each address in a message independently. DNS
17203 servers run caches, so repeated DNS lookups are not normally expensive, and in
17204 any case, personal messages rarely have more than a few recipients.
17205
17206 If you are running mailing lists with large numbers of subscribers at the same
17207 domain, and you are using a &(dnslookup)& router which is independent of the
17208 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17209 lookups for identical domains in one message. In this case, when &(dnslookup)&
17210 routes an address to a remote transport, any other unrouted addresses in the
17211 message that have the same domain are automatically given the same routing
17212 without processing them independently,
17213 provided the following conditions are met:
17214
17215 .ilist
17216 No router that processed the address specified &%headers_add%& or
17217 &%headers_remove%&.
17218 .next
17219 The router did not change the address in any way, for example, by &"widening"&
17220 the domain.
17221 .endlist
17222
17223
17224
17225
17226 .option search_parents dnslookup boolean false
17227 .cindex "DNS" "resolver options"
17228 When this option is true, the resolver option RES_DNSRCH is set for DNS
17229 lookups. This is different from the &%qualify_single%& option in that it
17230 applies to domains containing dots. Typically, but not standardly, it causes
17231 the resolver to search for the name in the current domain and in parent
17232 domains. For example, on a machine in the &'fict.example'& domain, if looking
17233 up &'teaparty.wonderland'& failed, the resolver would try
17234 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17235 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17236
17237 Setting this option true can cause problems in domains that have a wildcard MX
17238 record, because any domain that does not have its own MX record matches the
17239 local wildcard.
17240
17241
17242
17243 .option srv_fail_domains dnslookup "domain list&!!" unset
17244 If the DNS lookup for SRV records for one of the domains in this list causes a
17245 DNS lookup error, Exim behaves as if no SRV records were found. See section
17246 &<<SECTprowitdnsloo>>& for more discussion.
17247
17248
17249
17250
17251 .option widen_domains dnslookup "string list" unset
17252 .cindex "domain" "partial; widening"
17253 If a DNS lookup fails and this option is set, each of its strings in turn is
17254 added onto the end of the domain, and the lookup is tried again. For example,
17255 if
17256 .code
17257 widen_domains = fict.example:ref.example
17258 .endd
17259 is set and a lookup of &'klingon.dictionary'& fails,
17260 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17261 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17262 and &%search_parents%& options can cause some widening to be undertaken inside
17263 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17264 when verifying, unless &%rewrite_headers%& is false (not the default).
17265
17266
17267 .section "Effect of qualify_single and search_parents" "SECID119"
17268 When a domain from an envelope recipient is changed by the resolver as a result
17269 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17270 corresponding address in the message's header lines unless &%rewrite_headers%&
17271 is set false. Exim then re-routes the address, using the full domain.
17272
17273 These two options affect only the DNS lookup that takes place inside the router
17274 for the domain of the address that is being routed. They do not affect lookups
17275 such as that implied by
17276 .code
17277 domains = @mx_any
17278 .endd
17279 that may happen while processing a router precondition before the router is
17280 entered. No widening ever takes place for these lookups.
17281 .ecindex IIDdnsrou1
17282 .ecindex IIDdnsrou2
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292 . ////////////////////////////////////////////////////////////////////////////
17293 . ////////////////////////////////////////////////////////////////////////////
17294
17295 .chapter "The ipliteral router" "CHID5"
17296 .cindex "&(ipliteral)& router"
17297 .cindex "domain literal" "routing"
17298 .cindex "routers" "&(ipliteral)&"
17299 This router has no private options. Unless it is being used purely for
17300 verification (see &%verify_only%&) a transport is required to be defined by the
17301 generic &%transport%& option. The router accepts the address if its domain part
17302 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17303 router handles the address
17304 .code
17305 root@[192.168.1.1]
17306 .endd
17307 by setting up delivery to the host with that IP address. IPv4 domain literals
17308 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17309 are similar, but the address is preceded by &`ipv6:`&. For example:
17310 .code
17311 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17312 .endd
17313 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17314 grounds that sooner or later somebody will try it.
17315
17316 .oindex "&%self%&" "in &(ipliteral)& router"
17317 If the IP address matches something in &%ignore_target_hosts%&, the router
17318 declines. If an IP literal turns out to refer to the local host, the generic
17319 &%self%& option determines what happens.
17320
17321 The RFCs require support for domain literals; however, their use is
17322 controversial in today's Internet. If you want to use this router, you must
17323 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17324 Exim will not recognize the domain literal syntax in addresses.
17325
17326
17327
17328 . ////////////////////////////////////////////////////////////////////////////
17329 . ////////////////////////////////////////////////////////////////////////////
17330
17331 .chapter "The iplookup router" "CHID6"
17332 .cindex "&(iplookup)& router"
17333 .cindex "routers" "&(iplookup)&"
17334 The &(iplookup)& router was written to fulfil a specific requirement in
17335 Cambridge University (which in fact no longer exists). For this reason, it is
17336 not included in the binary of Exim by default. If you want to include it, you
17337 must set
17338 .code
17339 ROUTER_IPLOOKUP=yes
17340 .endd
17341 in your &_Local/Makefile_& configuration file.
17342
17343 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17344 connection to one or more specific hosts. The host can then return the same or
17345 a different address &-- in effect rewriting the recipient address in the
17346 message's envelope. The new address is then passed on to subsequent routers. If
17347 this process fails, the address can be passed on to other routers, or delivery
17348 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17349 must not be specified for it.
17350
17351 .cindex "options" "&(iplookup)& router"
17352 .option hosts iplookup string unset
17353 This option must be supplied. Its value is a colon-separated list of host
17354 names. The hosts are looked up using &[gethostbyname()]&
17355 (or &[getipnodebyname()]& when available)
17356 and are tried in order until one responds to the query. If none respond, what
17357 happens is controlled by &%optional%&.
17358
17359
17360 .option optional iplookup boolean false
17361 If &%optional%& is true, if no response is obtained from any host, the address
17362 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17363 delivery to the address is deferred.
17364
17365
17366 .option port iplookup integer 0
17367 .cindex "port" "&(iplookup)& router"
17368 This option must be supplied. It specifies the port number for the TCP or UDP
17369 call.
17370
17371
17372 .option protocol iplookup string udp
17373 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17374 protocols is to be used.
17375
17376
17377 .option query iplookup string&!! "see below"
17378 This defines the content of the query that is sent to the remote hosts. The
17379 default value is:
17380 .code
17381 $local_part@$domain $local_part@$domain
17382 .endd
17383 The repetition serves as a way of checking that a response is to the correct
17384 query in the default case (see &%response_pattern%& below).
17385
17386
17387 .option reroute iplookup string&!! unset
17388 If this option is not set, the rerouted address is precisely the byte string
17389 returned by the remote host, up to the first white space, if any. If set, the
17390 string is expanded to form the rerouted address. It can include parts matched
17391 in the response by &%response_pattern%& by means of numeric variables such as
17392 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17393 whether or not a pattern is in use. In all cases, the rerouted address must end
17394 up in the form &'local_part@domain'&.
17395
17396
17397 .option response_pattern iplookup string unset
17398 This option can be set to a regular expression that is applied to the string
17399 returned from the remote host. If the pattern does not match the response, the
17400 router declines. If &%response_pattern%& is not set, no checking of the
17401 response is done, unless the query was defaulted, in which case there is a
17402 check that the text returned after the first white space is the original
17403 address. This checks that the answer that has been received is in response to
17404 the correct question. For example, if the response is just a new domain, the
17405 following could be used:
17406 .code
17407 response_pattern = ^([^@]+)$
17408 reroute = $local_part@$1
17409 .endd
17410
17411 .option timeout iplookup time 5s
17412 This specifies the amount of time to wait for a response from the remote
17413 machine. The same timeout is used for the &[connect()]& function for a TCP
17414 call. It does not apply to UDP.
17415
17416
17417
17418
17419 . ////////////////////////////////////////////////////////////////////////////
17420 . ////////////////////////////////////////////////////////////////////////////
17421
17422 .chapter "The manualroute router" "CHID7"
17423 .scindex IIDmanrou1 "&(manualroute)& router"
17424 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17425 .cindex "domain" "manually routing"
17426 The &(manualroute)& router is so-called because it provides a way of manually
17427 routing an address according to its domain. It is mainly used when you want to
17428 route addresses to remote hosts according to your own rules, bypassing the
17429 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17430 route to local transports, a facility that may be useful if you want to save
17431 messages for dial-in hosts in local files.
17432
17433 The &(manualroute)& router compares a list of domain patterns with the domain
17434 it is trying to route. If there is no match, the router declines. Each pattern
17435 has associated with it a list of hosts and some other optional data, which may
17436 include a transport. The combination of a pattern and its data is called a
17437 &"routing rule"&. For patterns that do not have an associated transport, the
17438 generic &%transport%& option must specify a transport, unless the router is
17439 being used purely for verification (see &%verify_only%&).
17440
17441 .vindex "&$host$&"
17442 In the case of verification, matching the domain pattern is sufficient for the
17443 router to accept the address. When actually routing an address for delivery,
17444 an address that matches a domain pattern is queued for the associated
17445 transport. If the transport is not a local one, a host list must be associated
17446 with the pattern; IP addresses are looked up for the hosts, and these are
17447 passed to the transport along with the mail address. For local transports, a
17448 host list is optional. If it is present, it is passed in &$host$& as a single
17449 text string.
17450
17451 The list of routing rules can be provided as an inline string in
17452 &%route_list%&, or the data can be obtained by looking up the domain in a file
17453 or database by setting &%route_data%&. Only one of these settings may appear in
17454 any one instance of &(manualroute)&. The format of routing rules is described
17455 below, following the list of private options.
17456
17457
17458 .section "Private options for manualroute" "SECTprioptman"
17459
17460 .cindex "options" "&(manualroute)& router"
17461 The private options for the &(manualroute)& router are as follows:
17462
17463 .option host_all_ignored manualroute string defer
17464 See &%host_find_failed%&.
17465
17466 .option host_find_failed manualroute string freeze
17467 This option controls what happens when &(manualroute)& tries to find an IP
17468 address for a host, and the host does not exist. The option can be set to one
17469 of the following values:
17470 .code
17471 decline
17472 defer
17473 fail
17474 freeze
17475 ignore
17476 pass
17477 .endd
17478 The default (&"freeze"&) assumes that this state is a serious configuration
17479 error. The difference between &"pass"& and &"decline"& is that the former
17480 forces the address to be passed to the next router (or the router defined by
17481 &%pass_router%&),
17482 .oindex "&%more%&"
17483 overriding &%no_more%&, whereas the latter passes the address to the next
17484 router only if &%more%& is true.
17485
17486 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17487 cannot be found. If all the hosts in the list are ignored, the behaviour is
17488 controlled by the &%host_all_ignored%& option. This takes the same values
17489 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17490
17491 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17492 state; if a host lookup gets a temporary error, delivery is deferred unless the
17493 generic &%pass_on_timeout%& option is set.
17494
17495
17496 .option hosts_randomize manualroute boolean false
17497 .cindex "randomized host list"
17498 .cindex "host" "list of; randomized"
17499 If this option is set, the order of the items in a host list in a routing rule
17500 is randomized each time the list is used, unless an option in the routing rule
17501 overrides (see below). Randomizing the order of a host list can be used to do
17502 crude load sharing. However, if more than one mail address is routed by the
17503 same router to the same host list, the host lists are considered to be the same
17504 (even though they may be randomized into different orders) for the purpose of
17505 deciding whether to batch the deliveries into a single SMTP transaction.
17506
17507 When &%hosts_randomize%& is true, a host list may be split
17508 into groups whose order is separately randomized. This makes it possible to
17509 set up MX-like behaviour. The boundaries between groups are indicated by an
17510 item that is just &`+`& in the host list. For example:
17511 .code
17512 route_list = * host1:host2:host3:+:host4:host5
17513 .endd
17514 The order of the first three hosts and the order of the last two hosts is
17515 randomized for each use, but the first three always end up before the last two.
17516 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17517 randomized host list is passed to an &(smtp)& transport that also has
17518 &%hosts_randomize set%&, the list is not re-randomized.
17519
17520
17521 .option route_data manualroute string&!! unset
17522 If this option is set, it must expand to yield the data part of a routing rule.
17523 Typically, the expansion string includes a lookup based on the domain. For
17524 example:
17525 .code
17526 route_data = ${lookup{$domain}dbm{/etc/routes}}
17527 .endd
17528 If the expansion is forced to fail, or the result is an empty string, the
17529 router declines. Other kinds of expansion failure cause delivery to be
17530 deferred.
17531
17532
17533 .option route_list manualroute "string list" unset
17534 This string is a list of routing rules, in the form defined below. Note that,
17535 unlike most string lists, the items are separated by semicolons. This is so
17536 that they may contain colon-separated host lists.
17537
17538
17539 .option same_domain_copy_routing manualroute boolean false
17540 .cindex "address" "copying routing"
17541 Addresses with the same domain are normally routed by the &(manualroute)&
17542 router to the same list of hosts. However, this cannot be presumed, because the
17543 router options and preconditions may refer to the local part of the address. By
17544 default, therefore, Exim routes each address in a message independently. DNS
17545 servers run caches, so repeated DNS lookups are not normally expensive, and in
17546 any case, personal messages rarely have more than a few recipients.
17547
17548 If you are running mailing lists with large numbers of subscribers at the same
17549 domain, and you are using a &(manualroute)& router which is independent of the
17550 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17551 lookups for identical domains in one message. In this case, when
17552 &(manualroute)& routes an address to a remote transport, any other unrouted
17553 addresses in the message that have the same domain are automatically given the
17554 same routing without processing them independently. However, this is only done
17555 if &%headers_add%& and &%headers_remove%& are unset.
17556
17557
17558
17559
17560 .section "Routing rules in route_list" "SECID120"
17561 The value of &%route_list%& is a string consisting of a sequence of routing
17562 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17563 entered as two semicolons. Alternatively, the list separator can be changed as
17564 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17565 Empty rules are ignored. The format of each rule is
17566 .display
17567 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17568 .endd
17569 The following example contains two rules, each with a simple domain pattern and
17570 no options:
17571 .code
17572 route_list = \
17573   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17574   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17575 .endd
17576 The three parts of a rule are separated by white space. The pattern and the
17577 list of hosts can be enclosed in quotes if necessary, and if they are, the
17578 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17579 single domain pattern, which is the only mandatory item in the rule. The
17580 pattern is in the same format as one item in a domain list (see section
17581 &<<SECTdomainlist>>&),
17582 except that it may not be the name of an interpolated file.
17583 That is, it may be wildcarded, or a regular expression, or a file or database
17584 lookup (with semicolons doubled, because of the use of semicolon as a separator
17585 in a &%route_list%&).
17586
17587 The rules in &%route_list%& are searched in order until one of the patterns
17588 matches the domain that is being routed. The list of hosts and then options are
17589 then used as described below. If there is no match, the router declines. When
17590 &%route_list%& is set, &%route_data%& must not be set.
17591
17592
17593
17594 .section "Routing rules in route_data" "SECID121"
17595 The use of &%route_list%& is convenient when there are only a small number of
17596 routing rules. For larger numbers, it is easier to use a file or database to
17597 hold the routing information, and use the &%route_data%& option instead.
17598 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17599 Most commonly, &%route_data%& is set as a string that contains an
17600 expansion lookup. For example, suppose we place two routing rules in a file
17601 like this:
17602 .code
17603 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17604 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17605 .endd
17606 This data can be accessed by setting
17607 .code
17608 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17609 .endd
17610 Failure of the lookup results in an empty string, causing the router to
17611 decline. However, you do not have to use a lookup in &%route_data%&. The only
17612 requirement is that the result of expanding the string is a list of hosts,
17613 possibly followed by options, separated by white space. The list of hosts must
17614 be enclosed in quotes if it contains white space.
17615
17616
17617
17618
17619 .section "Format of the list of hosts" "SECID122"
17620 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17621 always separately expanded before use. If the expansion fails, the router
17622 declines. The result of the expansion must be a colon-separated list of names
17623 and/or IP addresses, optionally also including ports. The format of each item
17624 in the list is described in the next section. The list separator can be changed
17625 as described in section &<<SECTlistconstruct>>&.
17626
17627 If the list of hosts was obtained from a &%route_list%& item, the following
17628 variables are set during its expansion:
17629
17630 .ilist
17631 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17632 If the domain was matched against a regular expression, the numeric variables
17633 &$1$&, &$2$&, etc. may be set. For example:
17634 .code
17635 route_list = ^domain(\d+)   host-$1.text.example
17636 .endd
17637 .next
17638 &$0$& is always set to the entire domain.
17639 .next
17640 &$1$& is also set when partial matching is done in a file lookup.
17641
17642 .next
17643 .vindex "&$value$&"
17644 If the pattern that matched the domain was a lookup item, the data that was
17645 looked up is available in the expansion variable &$value$&. For example:
17646 .code
17647 route_list = lsearch;;/some/file.routes  $value
17648 .endd
17649 .endlist
17650
17651 Note the doubling of the semicolon in the pattern that is necessary because
17652 semicolon is the default route list separator.
17653
17654
17655
17656 .section "Format of one host item" "SECTformatonehostitem"
17657 Each item in the list of hosts is either a host name or an IP address,
17658 optionally with an attached port number. When no port is given, an IP address
17659 is not enclosed in brackets. When a port is specified, it overrides the port
17660 specification on the transport. The port is separated from the name or address
17661 by a colon. This leads to some complications:
17662
17663 .ilist
17664 Because colon is the default separator for the list of hosts, either
17665 the colon that specifies a port must be doubled, or the list separator must
17666 be changed. The following two examples have the same effect:
17667 .code
17668 route_list = * "host1.tld::1225 : host2.tld::1226"
17669 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17670 .endd
17671 .next
17672 When IPv6 addresses are involved, it gets worse, because they contain
17673 colons of their own. To make this case easier, it is permitted to
17674 enclose an IP address (either v4 or v6) in square brackets if a port
17675 number follows. For example:
17676 .code
17677 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17678 .endd
17679 .endlist
17680
17681 .section "How the list of hosts is used" "SECThostshowused"
17682 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17683 the hosts is tried, in the order specified, when carrying out the SMTP
17684 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17685 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17686 transport.
17687
17688 Hosts may be listed by name or by IP address. An unadorned name in the list of
17689 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17690 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17691 records in the DNS. For example:
17692 .code
17693 route_list = *  x.y.z:p.q.r/MX:e.f.g
17694 .endd
17695 If this feature is used with a port specifier, the port must come last. For
17696 example:
17697 .code
17698 route_list = *  dom1.tld/mx::1225
17699 .endd
17700 If the &%hosts_randomize%& option is set, the order of the items in the list is
17701 randomized before any lookups are done. Exim then scans the list; for any name
17702 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17703 be an interface on the local host and the item is not the first in the list,
17704 Exim discards it and any subsequent items. If it is the first item, what
17705 happens is controlled by the
17706 .oindex "&%self%&" "in &(manualroute)& router"
17707 &%self%& option of the router.
17708
17709 A name on the list that is followed by &`/MX`& is replaced with the list of
17710 hosts obtained by looking up MX records for the name. This is always a DNS
17711 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17712 below) are not relevant here. The order of these hosts is determined by the
17713 preference values in the MX records, according to the usual rules. Because
17714 randomizing happens before the MX lookup, it does not affect the order that is
17715 defined by MX preferences.
17716
17717 If the local host is present in the sublist obtained from MX records, but is
17718 not the most preferred host in that list, it and any equally or less
17719 preferred hosts are removed before the sublist is inserted into the main list.
17720
17721 If the local host is the most preferred host in the MX list, what happens
17722 depends on where in the original list of hosts the &`/MX`& item appears. If it
17723 is not the first item (that is, there are previous hosts in the main list),
17724 Exim discards this name and any subsequent items in the main list.
17725
17726 If the MX item is first in the list of hosts, and the local host is the
17727 most preferred host, what happens is controlled by the &%self%& option of the
17728 router.
17729
17730 DNS failures when lookup up the MX records are treated in the same way as DNS
17731 failures when looking up IP addresses: &%pass_on_timeout%& and
17732 &%host_find_failed%& are used when relevant.
17733
17734 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17735 whether obtained from an MX lookup or not.
17736
17737
17738
17739 .section "How the options are used" "SECThowoptused"
17740 The options are a sequence of words; in practice no more than three are ever
17741 present. One of the words can be the name of a transport; this overrides the
17742 &%transport%& option on the router for this particular routing rule only. The
17743 other words (if present) control randomization of the list of hosts on a
17744 per-rule basis, and how the IP addresses of the hosts are to be found when
17745 routing to a remote transport. These options are as follows:
17746
17747 .ilist
17748 &%randomize%&: randomize the order of the hosts in this list, overriding the
17749 setting of &%hosts_randomize%& for this routing rule only.
17750 .next
17751 &%no_randomize%&: do not randomize the order of the hosts in this list,
17752 overriding the setting of &%hosts_randomize%& for this routing rule only.
17753 .next
17754 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17755 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17756 also look in &_/etc/hosts_& or other sources of information.
17757 .next
17758 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17759 no address records are found. If there is a temporary DNS error (such as a
17760 timeout), delivery is deferred.
17761 .endlist
17762
17763 For example:
17764 .code
17765 route_list = domain1  host1:host2:host3  randomize bydns;\
17766              domain2  host4:host5
17767 .endd
17768 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17769 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17770 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17771 or &[gethostbyname()]&, and the result of the lookup is the result of that
17772 call.
17773
17774 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17775 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17776 instead of TRY_AGAIN. That is why the default action is to try a DNS
17777 lookup first. Only if that gives a definite &"no such host"& is the local
17778 function called.
17779
17780
17781
17782 If no IP address for a host can be found, what happens is controlled by the
17783 &%host_find_failed%& option.
17784
17785 .vindex "&$host$&"
17786 When an address is routed to a local transport, IP addresses are not looked up.
17787 The host list is passed to the transport in the &$host$& variable.
17788
17789
17790
17791 .section "Manualroute examples" "SECID123"
17792 In some of the examples that follow, the presence of the &%remote_smtp%&
17793 transport, as defined in the default configuration file, is assumed:
17794
17795 .ilist
17796 .cindex "smart host" "example router"
17797 The &(manualroute)& router can be used to forward all external mail to a
17798 &'smart host'&. If you have set up, in the main part of the configuration, a
17799 named domain list that contains your local domains, for example:
17800 .code
17801 domainlist local_domains = my.domain.example
17802 .endd
17803 You can arrange for all other domains to be routed to a smart host by making
17804 your first router something like this:
17805 .code
17806 smart_route:
17807   driver = manualroute
17808   domains = !+local_domains
17809   transport = remote_smtp
17810   route_list = * smarthost.ref.example
17811 .endd
17812 This causes all non-local addresses to be sent to the single host
17813 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17814 they are tried in order
17815 (but you can use &%hosts_randomize%& to vary the order each time).
17816 Another way of configuring the same thing is this:
17817 .code
17818 smart_route:
17819   driver = manualroute
17820   transport = remote_smtp
17821   route_list = !+local_domains  smarthost.ref.example
17822 .endd
17823 There is no difference in behaviour between these two routers as they stand.
17824 However, they behave differently if &%no_more%& is added to them. In the first
17825 example, the router is skipped if the domain does not match the &%domains%&
17826 precondition; the following router is always tried. If the router runs, it
17827 always matches the domain and so can never decline. Therefore, &%no_more%&
17828 would have no effect. In the second case, the router is never skipped; it
17829 always runs. However, if it doesn't match the domain, it declines. In this case
17830 &%no_more%& would prevent subsequent routers from running.
17831
17832 .next
17833 .cindex "mail hub example"
17834 A &'mail hub'& is a host which receives mail for a number of domains via MX
17835 records in the DNS and delivers it via its own private routing mechanism. Often
17836 the final destinations are behind a firewall, with the mail hub being the one
17837 machine that can connect to machines both inside and outside the firewall. The
17838 &(manualroute)& router is usually used on a mail hub to route incoming messages
17839 to the correct hosts. For a small number of domains, the routing can be inline,
17840 using the &%route_list%& option, but for a larger number a file or database
17841 lookup is easier to manage.
17842
17843 If the domain names are in fact the names of the machines to which the mail is
17844 to be sent by the mail hub, the configuration can be quite simple. For
17845 example:
17846 .code
17847 hub_route:
17848   driver = manualroute
17849   transport = remote_smtp
17850   route_list = *.rhodes.tvs.example  $domain
17851 .endd
17852 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17853 whose names are the same as the mail domains. A similar approach can be taken
17854 if the host name can be obtained from the domain name by a string manipulation
17855 that the expansion facilities can handle. Otherwise, a lookup based on the
17856 domain can be used to find the host:
17857 .code
17858 through_firewall:
17859   driver = manualroute
17860   transport = remote_smtp
17861   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17862 .endd
17863 The result of the lookup must be the name or IP address of the host (or
17864 hosts) to which the address is to be routed. If the lookup fails, the route
17865 data is empty, causing the router to decline. The address then passes to the
17866 next router.
17867
17868 .next
17869 .cindex "batched SMTP output example"
17870 .cindex "SMTP" "batched outgoing; example"
17871 You can use &(manualroute)& to deliver messages to pipes or files in batched
17872 SMTP format for onward transportation by some other means. This is one way of
17873 storing mail for a dial-up host when it is not connected. The route list entry
17874 can be as simple as a single domain name in a configuration like this:
17875 .code
17876 save_in_file:
17877   driver = manualroute
17878   transport = batchsmtp_appendfile
17879   route_list = saved.domain.example
17880 .endd
17881 though often a pattern is used to pick up more than one domain. If there are
17882 several domains or groups of domains with different transport requirements,
17883 different transports can be listed in the routing information:
17884 .code
17885 save_in_file:
17886   driver = manualroute
17887   route_list = \
17888     *.saved.domain1.example  $domain  batch_appendfile; \
17889     *.saved.domain2.example  \
17890       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17891       batch_pipe
17892 .endd
17893 .vindex "&$domain$&"
17894 .vindex "&$host$&"
17895 The first of these just passes the domain in the &$host$& variable, which
17896 doesn't achieve much (since it is also in &$domain$&), but the second does a
17897 file lookup to find a value to pass, causing the router to decline to handle
17898 the address if the lookup fails.
17899
17900 .next
17901 .cindex "UUCP" "example of router for"
17902 Routing mail directly to UUCP software is a specific case of the use of
17903 &(manualroute)& in a gateway to another mail environment. This is an example of
17904 one way it can be done:
17905 .code
17906 # Transport
17907 uucp:
17908   driver = pipe
17909   user = nobody
17910   command = /usr/local/bin/uux -r - \
17911     ${substr_-5:$host}!rmail ${local_part}
17912   return_fail_output = true
17913
17914 # Router
17915 uucphost:
17916   transport = uucp
17917   driver = manualroute
17918   route_data = \
17919     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17920 .endd
17921 The file &_/usr/local/exim/uucphosts_& contains entries like
17922 .code
17923 darksite.ethereal.example:           darksite.UUCP
17924 .endd
17925 It can be set up more simply without adding and removing &".UUCP"& but this way
17926 makes clear the distinction between the domain name
17927 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17928 .endlist
17929 .ecindex IIDmanrou1
17930 .ecindex IIDmanrou2
17931
17932
17933
17934
17935
17936
17937
17938
17939 . ////////////////////////////////////////////////////////////////////////////
17940 . ////////////////////////////////////////////////////////////////////////////
17941
17942 .chapter "The queryprogram router" "CHAPdriverlast"
17943 .scindex IIDquerou1 "&(queryprogram)& router"
17944 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17945 .cindex "routing" "by external program"
17946 The &(queryprogram)& router routes an address by running an external command
17947 and acting on its output. This is an expensive way to route, and is intended
17948 mainly for use in lightly-loaded systems, or for performing experiments.
17949 However, if it is possible to use the precondition options (&%domains%&,
17950 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17951 be used in special cases, even on a busy host. There are the following private
17952 options:
17953 .cindex "options" "&(queryprogram)& router"
17954
17955 .option command queryprogram string&!! unset
17956 This option must be set. It specifies the command that is to be run. The
17957 command is split up into a command name and arguments, and then each is
17958 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17959 &<<CHAPpipetransport>>&).
17960
17961
17962 .option command_group queryprogram string unset
17963 .cindex "gid (group id)" "in &(queryprogram)& router"
17964 This option specifies a gid to be set when running the command while routing an
17965 address for deliver. It must be set if &%command_user%& specifies a numerical
17966 uid. If it begins with a digit, it is interpreted as the numerical value of the
17967 gid. Otherwise it is looked up using &[getgrnam()]&.
17968
17969
17970 .option command_user queryprogram string unset
17971 .cindex "uid (user id)" "for &(queryprogram)&"
17972 This option must be set. It specifies the uid which is set when running the
17973 command while routing an address for delivery. If the value begins with a digit,
17974 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17975 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17976 not set, a value for the gid also.
17977
17978 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17979 root, which it does during a normal delivery in a conventional configuration.
17980 However, when an address is being verified during message reception, Exim is
17981 usually running as the Exim user, not as root. If the &(queryprogram)& router
17982 is called from a non-root process, Exim cannot change uid or gid before running
17983 the command. In this circumstance the command runs under the current uid and
17984 gid.
17985
17986
17987 .option current_directory queryprogram string /
17988 This option specifies an absolute path which is made the current directory
17989 before running the command.
17990
17991
17992 .option timeout queryprogram time 1h
17993 If the command does not complete within the timeout period, its process group
17994 is killed and the message is frozen. A value of zero time specifies no
17995 timeout.
17996
17997
17998 The standard output of the command is connected to a pipe, which is read when
17999 the command terminates. It should consist of a single line of output,
18000 containing up to five fields, separated by white space. The maximum length of
18001 the line is 1023 characters. Longer lines are silently truncated. The first
18002 field is one of the following words (case-insensitive):
18003
18004 .ilist
18005 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18006 below).
18007 .next
18008 &'Decline'&: the router declines; pass the address to the next router, unless
18009 &%no_more%& is set.
18010 .next
18011 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18012 subsequent text on the line is an error message. If the router is run as part
18013 of address verification during an incoming SMTP message, the message is
18014 included in the SMTP response.
18015 .next
18016 &'Defer'&: routing could not be completed at this time; try again later. Any
18017 subsequent text on the line is an error message which is logged. It is not
18018 included in any SMTP response.
18019 .next
18020 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18021 .next
18022 &'Pass'&: pass the address to the next router (or the router specified by
18023 &%pass_router%&), overriding &%no_more%&.
18024 .next
18025 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18026 new addresses, which are routed independently, starting with the first router,
18027 or the router specified by &%redirect_router%&, if set.
18028 .endlist
18029
18030 When the first word is &'accept'&, the remainder of the line consists of a
18031 number of keyed data values, as follows (split into two lines here, to fit on
18032 the page):
18033 .code
18034 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18035 LOOKUP=byname|bydns DATA=<text>
18036 .endd
18037 The data items can be given in any order, and all are optional. If no transport
18038 is included, the transport specified by the generic &%transport%& option is
18039 used. The list of hosts and the lookup type are needed only if the transport is
18040 an &(smtp)& transport that does not itself supply a list of hosts.
18041
18042 The format of the list of hosts is the same as for the &(manualroute)& router.
18043 As well as host names and IP addresses with optional port numbers, as described
18044 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18045 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18046 (see section &<<SECThostshowused>>&).
18047
18048 If the lookup type is not specified, Exim behaves as follows when trying to
18049 find an IP address for each host: First, a DNS lookup is done. If this yields
18050 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18051 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18052 result of the lookup is the result of that call.
18053
18054 .vindex "&$address_data$&"
18055 If the DATA field is set, its value is placed in the &$address_data$&
18056 variable. For example, this return line
18057 .code
18058 accept hosts=x1.y.example:x2.y.example data="rule1"
18059 .endd
18060 routes the address to the default transport, passing a list of two hosts. When
18061 the transport runs, the string &"rule1"& is in &$address_data$&.
18062 .ecindex IIDquerou1
18063 .ecindex IIDquerou2
18064
18065
18066
18067
18068 . ////////////////////////////////////////////////////////////////////////////
18069 . ////////////////////////////////////////////////////////////////////////////
18070
18071 .chapter "The redirect router" "CHAPredirect"
18072 .scindex IIDredrou1 "&(redirect)& router"
18073 .scindex IIDredrou2 "routers" "&(redirect)&"
18074 .cindex "alias file" "in a &(redirect)& router"
18075 .cindex "address redirection" "&(redirect)& router"
18076 The &(redirect)& router handles several kinds of address redirection. Its most
18077 common uses are for resolving local part aliases from a central alias file
18078 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18079 files, but it has many other potential uses. The incoming address can be
18080 redirected in several different ways:
18081
18082 .ilist
18083 It can be replaced by one or more new addresses which are themselves routed
18084 independently.
18085 .next
18086 It can be routed to be delivered to a given file or directory.
18087 .next
18088 It can be routed to be delivered to a specified pipe command.
18089 .next
18090 It can cause an automatic reply to be generated.
18091 .next
18092 It can be forced to fail, optionally with a custom error message.
18093 .next
18094 It can be temporarily deferred, optionally with a custom message.
18095 .next
18096 It can be discarded.
18097 .endlist
18098
18099 The generic &%transport%& option must not be set for &(redirect)& routers.
18100 However, there are some private options which define transports for delivery to
18101 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18102 &%pipe_transport%& and &%reply_transport%& descriptions below.
18103
18104
18105
18106 .section "Redirection data" "SECID124"
18107 The router operates by interpreting a text string which it obtains either by
18108 expanding the contents of the &%data%& option, or by reading the entire
18109 contents of a file whose name is given in the &%file%& option. These two
18110 options are mutually exclusive. The first is commonly used for handling system
18111 aliases, in a configuration like this:
18112 .code
18113 system_aliases:
18114   driver = redirect
18115   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18116 .endd
18117 If the lookup fails, the expanded string in this example is empty. When the
18118 expansion of &%data%& results in an empty string, the router declines. A forced
18119 expansion failure also causes the router to decline; other expansion failures
18120 cause delivery to be deferred.
18121
18122 A configuration using &%file%& is commonly used for handling users'
18123 &_.forward_& files, like this:
18124 .code
18125 userforward:
18126   driver = redirect
18127   check_local_user
18128   file = $home/.forward
18129   no_verify
18130 .endd
18131 If the file does not exist, or causes no action to be taken (for example, it is
18132 empty or consists only of comments), the router declines. &*Warning*&: This
18133 is not the case when the file contains syntactically valid items that happen to
18134 yield empty addresses, for example, items containing only RFC 2822 address
18135 comments.
18136
18137
18138
18139 .section "Forward files and address verification" "SECID125"
18140 .cindex "address redirection" "while verifying"
18141 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18142 &_.forward_& files, as in the example above. There are two reasons for this:
18143
18144 .ilist
18145 When Exim is receiving an incoming SMTP message from a remote host, it is
18146 running under the Exim uid, not as root. Exim is unable to change uid to read
18147 the file as the user, and it may not be able to read it as the Exim user. So in
18148 practice the router may not be able to operate.
18149 .next
18150 However, even when the router can operate, the existence of a &_.forward_& file
18151 is unimportant when verifying an address. What should be checked is whether the
18152 local part is a valid user name or not. Cutting out the redirection processing
18153 saves some resources.
18154 .endlist
18155
18156
18157
18158
18159
18160
18161 .section "Interpreting redirection data" "SECID126"
18162 .cindex "Sieve filter" "specifying in redirection data"
18163 .cindex "filter" "specifying in redirection data"
18164 The contents of the data string, whether obtained from &%data%& or &%file%&,
18165 can be interpreted in two different ways:
18166
18167 .ilist
18168 If the &%allow_filter%& option is set true, and the data begins with the text
18169 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18170 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18171 respectively. Details of the syntax and semantics of filter files are described
18172 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18173 document is intended for use by end users.
18174 .next
18175 Otherwise, the data must be a comma-separated list of redirection items, as
18176 described in the next section.
18177 .endlist
18178
18179 When a message is redirected to a file (a &"mail folder"&), the file name given
18180 in a non-filter redirection list must always be an absolute path. A filter may
18181 generate a relative path &-- how this is handled depends on the transport's
18182 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18183 for the &(appendfile)& transport.
18184
18185
18186
18187 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18188 .cindex "address redirection" "non-filter list items"
18189 When the redirection data is not an Exim or Sieve filter, for example, if it
18190 comes from a conventional alias or forward file, it consists of a list of
18191 addresses, file names, pipe commands, or certain special items (see section
18192 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18193 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18194 depending on their default values. The items in the list are separated by
18195 commas or newlines.
18196 If a comma is required in an item, the entire item must be enclosed in double
18197 quotes.
18198
18199 Lines starting with a # character are comments, and are ignored, and # may
18200 also appear following a comma, in which case everything between the # and the
18201 next newline character is ignored.
18202
18203 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18204 double quotes are retained because some forms of mail address require their use
18205 (but never to enclose the entire address). In the following description,
18206 &"item"& refers to what remains after any surrounding double quotes have been
18207 removed.
18208
18209 .vindex "&$local_part$&"
18210 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18211 and the expansion contains a reference to &$local_part$&, you should make use
18212 of the &%quote_local_part%& expansion operator, in case the local part contains
18213 special characters. For example, to redirect all mail for the domain
18214 &'obsolete.example'&, retaining the existing local part, you could use this
18215 setting:
18216 .code
18217 data = ${quote_local_part:$local_part}@newdomain.example
18218 .endd
18219
18220
18221 .section "Redirecting to a local mailbox" "SECTredlocmai"
18222 .cindex "routing" "loops in"
18223 .cindex "loop" "while routing, avoidance of"
18224 .cindex "address redirection" "to local mailbox"
18225 A redirection item may safely be the same as the address currently under
18226 consideration. This does not cause a routing loop, because a router is
18227 automatically skipped if any ancestor of the address that is being processed
18228 is the same as the current address and was processed by the current router.
18229 Such an address is therefore passed to the following routers, so it is handled
18230 as if there were no redirection. When making this loop-avoidance test, the
18231 complete local part, including any prefix or suffix, is used.
18232
18233 .cindex "address redirection" "local part without domain"
18234 Specifying the same local part without a domain is a common usage in personal
18235 filter files when the user wants to have messages delivered to the local
18236 mailbox and also forwarded elsewhere. For example, the user whose login is
18237 &'cleo'& might have a &_.forward_& file containing this:
18238 .code
18239 cleo, cleopatra@egypt.example
18240 .endd
18241 .cindex "backslash in alias file"
18242 .cindex "alias file" "backslash in"
18243 For compatibility with other MTAs, such unqualified local parts may be
18244 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18245 it does make a difference if more than one domain is being handled
18246 synonymously.
18247
18248 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18249 2822 address that does not include a domain, the item is qualified using the
18250 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18251 addresses are qualified using the value in &%qualify_recipient%&, but you can
18252 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18253
18254 Care must be taken if there are alias names for local users.
18255 Consider an MTA handling a single local domain where the system alias file
18256 contains:
18257 .code
18258 Sam.Reman: spqr
18259 .endd
18260 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18261 messages in the local mailbox, and also forward copies elsewhere. He creates
18262 this forward file:
18263 .code
18264 Sam.Reman, spqr@reme.elsewhere.example
18265 .endd
18266 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18267 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18268 second time round, because it has previously routed it,
18269 and the following routers presumably cannot handle the alias. The forward file
18270 should really contain
18271 .code
18272 spqr, spqr@reme.elsewhere.example
18273 .endd
18274 but because this is such a common error, the &%check_ancestor%& option (see
18275 below) exists to provide a way to get round it. This is normally set on a
18276 &(redirect)& router that is handling users' &_.forward_& files.
18277
18278
18279
18280 .section "Special items in redirection lists" "SECTspecitredli"
18281 In addition to addresses, the following types of item may appear in redirection
18282 lists (that is, in non-filter redirection data):
18283
18284 .ilist
18285 .cindex "pipe" "in redirection list"
18286 .cindex "address redirection" "to pipe"
18287 An item is treated as a pipe command if it begins with &"|"& and does not parse
18288 as a valid RFC 2822 address that includes a domain. A transport for running the
18289 command must be specified by the &%pipe_transport%& option.
18290 Normally, either the router or the transport specifies a user and a group under
18291 which to run the delivery. The default is to use the Exim user and group.
18292
18293 Single or double quotes can be used for enclosing the individual arguments of
18294 the pipe command; no interpretation of escapes is done for single quotes. If
18295 the command contains a comma character, it is necessary to put the whole item
18296 in double quotes, for example:
18297 .code
18298 "|/some/command ready,steady,go"
18299 .endd
18300 since items in redirection lists are terminated by commas. Do not, however,
18301 quote just the command. An item such as
18302 .code
18303 |"/some/command ready,steady,go"
18304 .endd
18305 is interpreted as a pipe with a rather strange command name, and no arguments.
18306
18307 .next
18308 .cindex "file" "in redirection list"
18309 .cindex "address redirection" "to file"
18310 An item is interpreted as a path name if it begins with &"/"& and does not
18311 parse as a valid RFC 2822 address that includes a domain. For example,
18312 .code
18313 /home/world/minbari
18314 .endd
18315 is treated as a file name, but
18316 .code
18317 /s=molari/o=babylon/@x400gate.way
18318 .endd
18319 is treated as an address. For a file name, a transport must be specified using
18320 the &%file_transport%& option. However, if the generated path name ends with a
18321 forward slash character, it is interpreted as a directory name rather than a
18322 file name, and &%directory_transport%& is used instead.
18323
18324 Normally, either the router or the transport specifies a user and a group under
18325 which to run the delivery. The default is to use the Exim user and group.
18326
18327 .cindex "&_/dev/null_&"
18328 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18329 bypassed at a high level, and the log entry shows &"**bypassed**"&
18330 instead of a transport name. In this case the user and group are not used.
18331
18332 .next
18333 .cindex "included address list"
18334 .cindex "address redirection" "included external list"
18335 If an item is of the form
18336 .code
18337 :include:<path name>
18338 .endd
18339 a list of further items is taken from the given file and included at that
18340 point. &*Note*&: Such a file can not be a filter file; it is just an
18341 out-of-line addition to the list. The items in the included list are separated
18342 by commas or newlines and are not subject to expansion. If this is the first
18343 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18344 the alias name. This example is incorrect:
18345 .code
18346 list1    :include:/opt/lists/list1
18347 .endd
18348 It must be given as
18349 .code
18350 list1:   :include:/opt/lists/list1
18351 .endd
18352 .next
18353 .cindex "address redirection" "to black hole"
18354 Sometimes you want to throw away mail to a particular local part. Making the
18355 &%data%& option expand to an empty string does not work, because that causes
18356 the router to decline. Instead, the alias item
18357 .cindex "black hole"
18358 .cindex "abandoning mail"
18359 &':blackhole:'& can be used. It does what its name implies. No delivery is
18360 done, and no error message is generated. This has the same effect as specifing
18361 &_/dev/null_& as a destination, but it can be independently disabled.
18362
18363 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18364 delivery is done for the original local part, even if other redirection items
18365 are present. If you are generating a multi-item list (for example, by reading a
18366 database) and need the ability to provide a no-op item, you must use
18367 &_/dev/null_&.
18368
18369 .next
18370 .cindex "delivery" "forcing failure"
18371 .cindex "delivery" "forcing deferral"
18372 .cindex "failing delivery" "forcing"
18373 .cindex "deferred delivery, forcing"
18374 .cindex "customizing" "failure message"
18375 An attempt to deliver a particular address can be deferred or forced to fail by
18376 redirection items of the form
18377 .code
18378 :defer:
18379 :fail:
18380 .endd
18381 respectively. When a redirection list contains such an item, it applies
18382 to the entire redirection; any other items in the list are ignored. Any
18383 text following &':fail:'& or &':defer:'& is placed in the error text
18384 associated with the failure. For example, an alias file might contain:
18385 .code
18386 X.Employee:  :fail: Gone away, no forwarding address
18387 .endd
18388 In the case of an address that is being verified from an ACL or as the subject
18389 of a
18390 .cindex "VRFY" "error text, display of"
18391 VRFY command, the text is included in the SMTP error response by
18392 default.
18393 .cindex "EXPN" "error text, display of"
18394 The text is not included in the response to an EXPN command. In non-SMTP cases
18395 the text is included in the error message that Exim generates.
18396
18397 .cindex "SMTP" "error codes"
18398 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18399 &':fail:'&. However, if the message starts with three digits followed by a
18400 space, optionally followed by an extended code of the form &'n.n.n'&, also
18401 followed by a space, and the very first digit is the same as the default error
18402 code, the code from the message is used instead. If the very first digit is
18403 incorrect, a panic error is logged, and the default code is used. You can
18404 suppress the use of the supplied code in a redirect router by setting the
18405 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18406 ignored.
18407
18408 .vindex "&$acl_verify_message$&"
18409 In an ACL, an explicitly provided message overrides the default, but the
18410 default message is available in the variable &$acl_verify_message$& and can
18411 therefore be included in a custom message if this is desired.
18412
18413 Normally the error text is the rest of the redirection list &-- a comma does
18414 not terminate it &-- but a newline does act as a terminator. Newlines are not
18415 normally present in alias expansions. In &(lsearch)& lookups they are removed
18416 as part of the continuation process, but they may exist in other kinds of
18417 lookup and in &':include:'& files.
18418
18419 During routing for message delivery (as opposed to verification), a redirection
18420 containing &':fail:'& causes an immediate failure of the incoming address,
18421 whereas &':defer:'& causes the message to remain on the queue so that a
18422 subsequent delivery attempt can happen at a later time. If an address is
18423 deferred for too long, it will ultimately fail, because the normal retry
18424 rules still apply.
18425
18426 .next
18427 .cindex "alias file" "exception to default"
18428 Sometimes it is useful to use a single-key search type with a default (see
18429 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18430 for exceptions to the default. These can be handled by aliasing them to
18431 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18432 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18433 results in an empty redirection list has the same effect.
18434 .endlist
18435
18436
18437 .section "Duplicate addresses" "SECTdupaddr"
18438 .cindex "duplicate addresses"
18439 .cindex "address duplicate, discarding"
18440 .cindex "pipe" "duplicated"
18441 Exim removes duplicate addresses from the list to which it is delivering, so as
18442 to deliver just one copy to each address. This does not apply to deliveries
18443 routed to pipes by different immediate parent addresses, but an indirect
18444 aliasing scheme of the type
18445 .code
18446 pipe:       |/some/command $local_part
18447 localpart1: pipe
18448 localpart2: pipe
18449 .endd
18450 does not work with a message that is addressed to both local parts, because
18451 when the second is aliased to the intermediate local part &"pipe"& it gets
18452 discarded as being the same as a previously handled address. However, a scheme
18453 such as
18454 .code
18455 localpart1: |/some/command $local_part
18456 localpart2: |/some/command $local_part
18457 .endd
18458 does result in two different pipe deliveries, because the immediate parents of
18459 the pipes are distinct.
18460
18461
18462
18463 .section "Repeated redirection expansion" "SECID128"
18464 .cindex "repeated redirection expansion"
18465 .cindex "address redirection" "repeated for each delivery attempt"
18466 When a message cannot be delivered to all of its recipients immediately,
18467 leading to two or more delivery attempts, redirection expansion is carried out
18468 afresh each time for those addresses whose children were not all previously
18469 delivered. If redirection is being used as a mailing list, this can lead to new
18470 members of the list receiving copies of old messages. The &%one_time%& option
18471 can be used to avoid this.
18472
18473
18474 .section "Errors in redirection lists" "SECID129"
18475 .cindex "address redirection" "errors"
18476 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18477 error is skipped, and an entry is written to the main log. This may be useful
18478 for mailing lists that are automatically managed. Otherwise, if an error is
18479 detected while generating the list of new addresses, the original address is
18480 deferred. See also &%syntax_errors_to%&.
18481
18482
18483
18484 .section "Private options for the redirect router" "SECID130"
18485
18486 .cindex "options" "&(redirect)& router"
18487 The private options for the &(redirect)& router are as follows:
18488
18489
18490 .option allow_defer redirect boolean false
18491 Setting this option allows the use of &':defer:'& in non-filter redirection
18492 data, or the &%defer%& command in an Exim filter file.
18493
18494
18495 .option allow_fail redirect boolean false
18496 .cindex "failing delivery" "from filter"
18497 If this option is true, the &':fail:'& item can be used in a redirection list,
18498 and the &%fail%& command may be used in an Exim filter file.
18499
18500
18501 .option allow_filter redirect boolean false
18502 .cindex "filter" "enabling use of"
18503 .cindex "Sieve filter" "enabling use of"
18504 Setting this option allows Exim to interpret redirection data that starts with
18505 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18506 are some features of Exim filter files that some administrators may wish to
18507 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18508
18509 It is also possible to lock out Exim filters or Sieve filters while allowing
18510 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18511
18512
18513 The filter is run using the uid and gid set by the generic &%user%& and
18514 &%group%& options. These take their defaults from the password data if
18515 &%check_local_user%& is set, so in the normal case of users' personal filter
18516 files, the filter is run as the relevant user. When &%allow_filter%& is set
18517 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18518
18519
18520
18521 .option allow_freeze redirect boolean false
18522 .cindex "freezing messages" "allowing in filter"
18523 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18524 This command is more normally encountered in system filters, and is disabled by
18525 default for redirection filters because it isn't something you usually want to
18526 let ordinary users do.
18527
18528
18529
18530 .option check_ancestor redirect boolean false
18531 This option is concerned with handling generated addresses that are the same
18532 as some address in the list of redirection ancestors of the current address.
18533 Although it is turned off by default in the code, it is set in the default
18534 configuration file for handling users' &_.forward_& files. It is recommended
18535 for this use of the &(redirect)& router.
18536
18537 When &%check_ancestor%& is set, if a generated address (including the domain)
18538 is the same as any ancestor of the current address, it is replaced by a copy of
18539 the current address. This helps in the case where local part A is aliased to B,
18540 and B has a &_.forward_& file pointing back to A. For example, within a single
18541 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18542 &_&~jb/.forward_& contains:
18543 .code
18544 \Joe.Bloggs, <other item(s)>
18545 .endd
18546 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18547 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18548 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18549 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18550 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18551 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18552 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18553 original address. See also the &%repeat_use%& option below.
18554
18555
18556 .option check_group redirect boolean "see below"
18557 When the &%file%& option is used, the group owner of the file is checked only
18558 when this option is set. The permitted groups are those listed in the
18559 &%owngroups%& option, together with the user's default group if
18560 &%check_local_user%& is set. If the file has the wrong group, routing is
18561 deferred. The default setting for this option is true if &%check_local_user%&
18562 is set and the &%modemask%& option permits the group write bit, or if the
18563 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18564
18565
18566
18567 .option check_owner redirect boolean "see below"
18568 When the &%file%& option is used, the owner of the file is checked only when
18569 this option is set. If &%check_local_user%& is set, the local user is
18570 permitted; otherwise the owner must be one of those listed in the &%owners%&
18571 option. The default value for this option is true if &%check_local_user%& or
18572 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18573
18574
18575 .option data redirect string&!! unset
18576 This option is mutually exclusive with &%file%&. One or other of them must be
18577 set, but not both. The contents of &%data%& are expanded, and then used as the
18578 list of forwarding items, or as a set of filtering instructions. If the
18579 expansion is forced to fail, or the result is an empty string or a string that
18580 has no effect (consists entirely of comments), the router declines.
18581
18582 When filtering instructions are used, the string must begin with &"#Exim
18583 filter"&, and all comments in the string, including this initial one, must be
18584 terminated with newline characters. For example:
18585 .code
18586 data = #Exim filter\n\
18587        if $h_to: contains Exim then save $home/mail/exim endif
18588 .endd
18589 If you are reading the data from a database where newlines cannot be included,
18590 you can use the &${sg}$& expansion item to turn the escape string of your
18591 choice into a newline.
18592
18593
18594 .option directory_transport redirect string&!! unset
18595 A &(redirect)& router sets up a direct delivery to a directory when a path name
18596 ending with a slash is specified as a new &"address"&. The transport used is
18597 specified by this option, which, after expansion, must be the name of a
18598 configured transport. This should normally be an &(appendfile)& transport.
18599
18600
18601 .option file redirect string&!! unset
18602 This option specifies the name of a file that contains the redirection data. It
18603 is mutually exclusive with the &%data%& option. The string is expanded before
18604 use; if the expansion is forced to fail, the router declines. Other expansion
18605 failures cause delivery to be deferred. The result of a successful expansion
18606 must be an absolute path. The entire file is read and used as the redirection
18607 data. If the data is an empty string or a string that has no effect (consists
18608 entirely of comments), the router declines.
18609
18610 .cindex "NFS" "checking for file existence"
18611 If the attempt to open the file fails with a &"does not exist"& error, Exim
18612 runs a check on the containing directory,
18613 unless &%ignore_enotdir%& is true (see below).
18614 If the directory does not appear to exist, delivery is deferred. This can
18615 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18616 is a mount problem. If the containing directory does exist, but the file does
18617 not, the router declines.
18618
18619
18620 .option file_transport redirect string&!! unset
18621 .vindex "&$address_file$&"
18622 A &(redirect)& router sets up a direct delivery to a file when a path name not
18623 ending in a slash is specified as a new &"address"&. The transport used is
18624 specified by this option, which, after expansion, must be the name of a
18625 configured transport. This should normally be an &(appendfile)& transport. When
18626 it is running, the file name is in &$address_file$&.
18627
18628
18629 .option filter_prepend_home redirect boolean true
18630 When this option is true, if a &(save)& command in an Exim filter specifies a
18631 relative path, and &$home$& is defined, it is automatically prepended to the
18632 relative path. If this option is set false, this action does not happen. The
18633 relative path is then passed to the transport unmodified.
18634
18635
18636 .option forbid_blackhole redirect boolean false
18637 If this option is true, the &':blackhole:'& item may not appear in a
18638 redirection list.
18639
18640
18641 .option forbid_exim_filter redirect boolean false
18642 If this option is set true, only Sieve filters are permitted when
18643 &%allow_filter%& is true.
18644
18645
18646
18647
18648 .option forbid_file redirect boolean false
18649 .cindex "delivery" "to file; forbidding"
18650 .cindex "Sieve filter" "forbidding delivery to a file"
18651 .cindex "Sieve filter" "&""keep""& facility; disabling"
18652 If this option is true, this router may not generate a new address that
18653 specifies delivery to a local file or directory, either from a filter or from a
18654 conventional forward file. This option is forced to be true if &%one_time%& is
18655 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18656 locks out the Sieve's &"keep"& facility.
18657
18658
18659 .option forbid_filter_dlfunc redirect boolean false
18660 .cindex "filter" "locking out certain features"
18661 If this option is true, string expansions in Exim filters are not allowed to
18662 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18663 functions.
18664
18665 .option forbid_filter_existstest redirect boolean false
18666 .cindex "expansion" "statting a file"
18667 If this option is true, string expansions in Exim filters are not allowed to
18668 make use of the &%exists%& condition or the &%stat%& expansion item.
18669
18670 .option forbid_filter_logwrite redirect boolean false
18671 If this option is true, use of the logging facility in Exim filters is not
18672 permitted. Logging is in any case available only if the filter is being run
18673 under some unprivileged uid (which is normally the case for ordinary users'
18674 &_.forward_& files).
18675
18676
18677 .option forbid_filter_lookup redirect boolean false
18678 If this option is true, string expansions in Exim filter files are not allowed
18679 to make use of &%lookup%& items.
18680
18681
18682 .option forbid_filter_perl redirect boolean false
18683 This option has an effect only if Exim is built with embedded Perl support. If
18684 it is true, string expansions in Exim filter files are not allowed to make use
18685 of the embedded Perl support.
18686
18687
18688 .option forbid_filter_readfile redirect boolean false
18689 If this option is true, string expansions in Exim filter files are not allowed
18690 to make use of &%readfile%& items.
18691
18692
18693 .option forbid_filter_readsocket redirect boolean false
18694 If this option is true, string expansions in Exim filter files are not allowed
18695 to make use of &%readsocket%& items.
18696
18697
18698 .option forbid_filter_reply redirect boolean false
18699 If this option is true, this router may not generate an automatic reply
18700 message. Automatic replies can be generated only from Exim or Sieve filter
18701 files, not from traditional forward files. This option is forced to be true if
18702 &%one_time%& is set.
18703
18704
18705 .option forbid_filter_run redirect boolean false
18706 If this option is true, string expansions in Exim filter files are not allowed
18707 to make use of &%run%& items.
18708
18709
18710 .option forbid_include redirect boolean false
18711 If this option is true, items of the form
18712 .code
18713 :include:<path name>
18714 .endd
18715 are not permitted in non-filter redirection lists.
18716
18717
18718 .option forbid_pipe redirect boolean false
18719 .cindex "delivery" "to pipe; forbidding"
18720 If this option is true, this router may not generate a new address which
18721 specifies delivery to a pipe, either from an Exim filter or from a conventional
18722 forward file. This option is forced to be true if &%one_time%& is set.
18723
18724
18725 .option forbid_sieve_filter redirect boolean false
18726 If this option is set true, only Exim filters are permitted when
18727 &%allow_filter%& is true.
18728
18729
18730 .cindex "SMTP" "error codes"
18731 .option forbid_smtp_code redirect boolean false
18732 If this option is set true, any SMTP error codes that are present at the start
18733 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18734 the default codes (451 and 550, respectively) are always used.
18735
18736
18737
18738
18739 .option hide_child_in_errmsg redirect boolean false
18740 .cindex "bounce message" "redirection details; suppressing"
18741 If this option is true, it prevents Exim from quoting a child address if it
18742 generates a bounce or delay message for it. Instead it says &"an address
18743 generated from <&'the top level address'&>"&. Of course, this applies only to
18744 bounces generated locally. If a message is forwarded to another host, &'its'&
18745 bounce may well quote the generated address.
18746
18747
18748 .option ignore_eacces redirect boolean false
18749 .cindex "EACCES"
18750 If this option is set and an attempt to open a redirection file yields the
18751 EACCES error (permission denied), the &(redirect)& router behaves as if the
18752 file did not exist.
18753
18754
18755 .option ignore_enotdir redirect boolean false
18756 .cindex "ENOTDIR"
18757 If this option is set and an attempt to open a redirection file yields the
18758 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18759 router behaves as if the file did not exist.
18760
18761 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18762 router that has the &%file%& option set discovers that the file does not exist
18763 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18764 against unmounted NFS directories. If the parent can not be statted, delivery
18765 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18766 is set, because that option tells Exim to ignore &"something on the path is not
18767 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18768 that some operating systems give ENOENT where others give ENOTDIR.
18769
18770
18771
18772 .option include_directory redirect string unset
18773 If this option is set, the path names of any &':include:'& items in a
18774 redirection list must start with this directory.
18775
18776
18777 .option modemask redirect "octal integer" 022
18778 This specifies mode bits which must not be set for a file specified by the
18779 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18780
18781
18782 .option one_time redirect boolean false
18783 .cindex "one-time aliasing/forwarding expansion"
18784 .cindex "alias file" "one-time expansion"
18785 .cindex "forward file" "one-time expansion"
18786 .cindex "mailing lists" "one-time expansion"
18787 .cindex "address redirection" "one-time expansion"
18788 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18789 files each time it tries to deliver a message causes a problem when one or more
18790 of the generated addresses fails be delivered at the first attempt. The problem
18791 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18792 but of what happens when the redirection list changes during the time that the
18793 message is on Exim's queue. This is particularly true in the case of mailing
18794 lists, where new subscribers might receive copies of messages that were posted
18795 before they subscribed.
18796
18797 If &%one_time%& is set and any addresses generated by the router fail to
18798 deliver at the first attempt, the failing addresses are added to the message as
18799 &"top level"& addresses, and the parent address that generated them is marked
18800 &"delivered"&. Thus, redirection does not happen again at the next delivery
18801 attempt.
18802
18803 &*Warning 1*&: Any header line addition or removal that is specified by this
18804 router would be lost if delivery did not succeed at the first attempt. For this
18805 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18806 permitted when &%one_time%& is set.
18807
18808 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18809 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18810 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18811
18812 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18813 &%one_time%&.
18814
18815 The original top-level address is remembered with each of the generated
18816 addresses, and is output in any log messages. However, any intermediate parent
18817 addresses are not recorded. This makes a difference to the log only if
18818 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18819 typically be used for mailing lists, where there is normally just one level of
18820 expansion.
18821
18822
18823 .option owners redirect "string list" unset
18824 .cindex "ownership" "alias file"
18825 .cindex "ownership" "forward file"
18826 .cindex "alias file" "ownership"
18827 .cindex "forward file" "ownership"
18828 This specifies a list of permitted owners for the file specified by &%file%&.
18829 This list is in addition to the local user when &%check_local_user%& is set.
18830 See &%check_owner%& above.
18831
18832
18833 .option owngroups redirect "string list" unset
18834 This specifies a list of permitted groups for the file specified by &%file%&.
18835 The list is in addition to the local user's primary group when
18836 &%check_local_user%& is set. See &%check_group%& above.
18837
18838
18839 .option pipe_transport redirect string&!! unset
18840 .vindex "&$address_pipe$&"
18841 A &(redirect)& router sets up a direct delivery to a pipe when a string
18842 starting with a vertical bar character is specified as a new &"address"&. The
18843 transport used is specified by this option, which, after expansion, must be the
18844 name of a configured transport. This should normally be a &(pipe)& transport.
18845 When the transport is run, the pipe command is in &$address_pipe$&.
18846
18847
18848 .option qualify_domain redirect string&!! unset
18849 .vindex "&$qualify_recipient$&"
18850 If this option is set, and an unqualified address (one without a domain) is
18851 generated, and that address would normally be qualified by the global setting
18852 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18853 expanding this string. If the expansion fails, the router declines. If you want
18854 to revert to the default, you can have the expansion generate
18855 &$qualify_recipient$&.
18856
18857 This option applies to all unqualified addresses generated by Exim filters,
18858 but for traditional &_.forward_& files, it applies only to addresses that are
18859 not preceded by a backslash. Sieve filters cannot generate unqualified
18860 addresses.
18861
18862 .option qualify_preserve_domain redirect boolean false
18863 .cindex "domain" "in redirection; preserving"
18864 .cindex "preserving domain in redirection"
18865 .cindex "address redirection" "domain; preserving"
18866 If this option is set, the router's local &%qualify_domain%& option must not be
18867 set (a configuration error occurs if it is). If an unqualified address (one
18868 without a domain) is generated, it is qualified with the domain of the parent
18869 address (the immediately preceding ancestor) instead of the global
18870 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18871 this applies whether or not the address is preceded by a backslash.
18872
18873
18874 .option repeat_use redirect boolean true
18875 If this option is set false, the router is skipped for a child address that has
18876 any ancestor that was routed by this router. This test happens before any of
18877 the other preconditions are tested. Exim's default anti-looping rules skip
18878 only when the ancestor is the same as the current address. See also
18879 &%check_ancestor%& above and the generic &%redirect_router%& option.
18880
18881
18882 .option reply_transport redirect string&!! unset
18883 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18884 &%vacation%& command is used in a filter file. The transport used is specified
18885 by this option, which, after expansion, must be the name of a configured
18886 transport. This should normally be an &(autoreply)& transport. Other transports
18887 are unlikely to do anything sensible or useful.
18888
18889
18890 .option rewrite redirect boolean true
18891 .cindex "address redirection" "disabling rewriting"
18892 If this option is set false, addresses generated by the router are not
18893 subject to address rewriting. Otherwise, they are treated like new addresses
18894 and are rewritten according to the global rewriting rules.
18895
18896
18897 .option sieve_subaddress redirect string&!! unset
18898 The value of this option is passed to a Sieve filter to specify the
18899 :subaddress part of an address.
18900
18901 .option sieve_useraddress redirect string&!! unset
18902 The value of this option is passed to a Sieve filter to specify the :user part
18903 of an address. However, if it is unset, the entire original local part
18904 (including any prefix or suffix) is used for :user.
18905
18906
18907 .option sieve_vacation_directory redirect string&!! unset
18908 .cindex "Sieve filter" "vacation directory"
18909 To enable the &"vacation"& extension for Sieve filters, you must set
18910 &%sieve_vacation_directory%& to the directory where vacation databases are held
18911 (do not put anything else in that directory), and ensure that the
18912 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18913 needs their own directory; Exim will create it if necessary.
18914
18915
18916
18917 .option skip_syntax_errors redirect boolean false
18918 .cindex "forward file" "broken"
18919 .cindex "address redirection" "broken files"
18920 .cindex "alias file" "broken"
18921 .cindex "broken alias or forward files"
18922 .cindex "ignoring faulty addresses"
18923 .cindex "skipping faulty addresses"
18924 .cindex "error" "skipping bad syntax"
18925 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18926 non-filter redirection data are skipped, and each failing address is logged. If
18927 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18928 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18929 are expanded and placed at the head of the error message generated by
18930 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18931 be the same address as the generic &%errors_to%& option. The
18932 &%skip_syntax_errors%& option is often used when handling mailing lists.
18933
18934 If all the addresses in a redirection list are skipped because of syntax
18935 errors, the router declines to handle the original address, and it is passed to
18936 the following routers.
18937
18938 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18939 error in the filter causes filtering to be abandoned without any action being
18940 taken. The incident is logged, and the router declines to handle the address,
18941 so it is passed to the following routers.
18942
18943 .cindex "Sieve filter" "syntax errors in"
18944 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18945 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18946 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18947
18948 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18949 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18950 option, used with an address that does not get redirected, can be used to
18951 notify users of these errors, by means of a router like this:
18952 .code
18953 userforward:
18954   driver = redirect
18955   allow_filter
18956   check_local_user
18957   file = $home/.forward
18958   file_transport = address_file
18959   pipe_transport = address_pipe
18960   reply_transport = address_reply
18961   no_verify
18962   skip_syntax_errors
18963   syntax_errors_to = real-$local_part@$domain
18964   syntax_errors_text = \
18965    This is an automatically generated message. An error has\n\
18966    been found in your .forward file. Details of the error are\n\
18967    reported below. While this error persists, you will receive\n\
18968    a copy of this message for every message that is addressed\n\
18969    to you. If your .forward file is a filter file, or if it is\n\
18970    a non-filter file containing no valid forwarding addresses,\n\
18971    a copy of each incoming message will be put in your normal\n\
18972    mailbox. If a non-filter file contains at least one valid\n\
18973    forwarding address, forwarding to the valid addresses will\n\
18974    happen, and those will be the only deliveries that occur.
18975 .endd
18976 You also need a router to ensure that local addresses that are prefixed by
18977 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18978 put this immediately before the &(userforward)& router:
18979 .code
18980 real_localuser:
18981   driver = accept
18982   check_local_user
18983   local_part_prefix = real-
18984   transport = local_delivery
18985 .endd
18986 For security, it would probably be a good idea to restrict the use of this
18987 router to locally-generated messages, using a condition such as this:
18988 .code
18989   condition = ${if match {$sender_host_address}\
18990                          {\N^(|127\.0\.0\.1)$\N}}
18991 .endd
18992
18993
18994 .option syntax_errors_text redirect string&!! unset
18995 See &%skip_syntax_errors%& above.
18996
18997
18998 .option syntax_errors_to redirect string unset
18999 See &%skip_syntax_errors%& above.
19000 .ecindex IIDredrou1
19001 .ecindex IIDredrou2
19002
19003
19004
19005
19006
19007
19008 . ////////////////////////////////////////////////////////////////////////////
19009 . ////////////////////////////////////////////////////////////////////////////
19010
19011 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19012          "Environment for local transports"
19013 .scindex IIDenvlotra1 "local transports" "environment for"
19014 .scindex IIDenvlotra2 "environment for local transports"
19015 .scindex IIDenvlotra3 "transport" "local; environment for"
19016 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19017 transport can be thought of as similar to a pipe.) Exim always runs transports
19018 in subprocesses, under specified uids and gids. Typical deliveries to local
19019 mailboxes run under the uid and gid of the local user.
19020
19021 Exim also sets a specific current directory while running the transport; for
19022 some transports a home directory setting is also relevant. The &(pipe)&
19023 transport is the only one that sets up environment variables; see section
19024 &<<SECTpipeenv>>& for details.
19025
19026 The values used for the uid, gid, and the directories may come from several
19027 different places. In many cases, the router that handles the address associates
19028 settings with that address as a result of its &%check_local_user%&, &%group%&,
19029 or &%user%& options. However, values may also be given in the transport's own
19030 configuration, and these override anything that comes from the router.
19031
19032
19033
19034 .section "Concurrent deliveries" "SECID131"
19035 .cindex "concurrent deliveries"
19036 .cindex "simultaneous deliveries"
19037 If two different messages for the same local recipient arrive more or less
19038 simultaneously, the two delivery processes are likely to run concurrently. When
19039 the &(appendfile)& transport is used to write to a file, Exim applies locking
19040 rules to stop concurrent processes from writing to the same file at the same
19041 time.
19042
19043 However, when you use a &(pipe)& transport, it is up to you to arrange any
19044 locking that is needed. Here is a silly example:
19045 .code
19046 my_transport:
19047   driver = pipe
19048   command = /bin/sh -c 'cat >>/some/file'
19049 .endd
19050 This is supposed to write the message at the end of the file. However, if two
19051 messages arrive at the same time, the file will be scrambled. You can use the
19052 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19053 file using the same algorithm that Exim itself uses.
19054
19055
19056
19057
19058 .section "Uids and gids" "SECTenvuidgid"
19059 .cindex "local transports" "uid and gid"
19060 .cindex "transport" "local; uid and gid"
19061 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19062 overrides any group that the router set in the address, even if &%user%& is not
19063 set for the transport. This makes it possible, for example, to run local mail
19064 delivery under the uid of the recipient (set by the router), but in a special
19065 group (set by the transport). For example:
19066 .code
19067 # Routers ...
19068 # User/group are set by check_local_user in this router
19069 local_users:
19070   driver = accept
19071   check_local_user
19072   transport = group_delivery
19073
19074 # Transports ...
19075 # This transport overrides the group
19076 group_delivery:
19077   driver = appendfile
19078   file = /var/spool/mail/$local_part
19079   group = mail
19080 .endd
19081 If &%user%& is set for a transport, its value overrides what is set in the
19082 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19083 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19084 set.
19085
19086 .oindex "&%initgroups%&"
19087 When the uid is taken from the transport's configuration, the &[initgroups()]&
19088 function is called for the groups associated with that uid if the
19089 &%initgroups%& option is set for the transport. When the uid is not specified
19090 by the transport, but is associated with the address by a router, the option
19091 for calling &[initgroups()]& is taken from the router configuration.
19092
19093 .cindex "&(pipe)& transport" "uid for"
19094 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19095 is set and &%user%& is not set, the uid of the process that called Exim to
19096 receive the message is used, and if &%group%& is not set, the corresponding
19097 original gid is also used.
19098
19099 This is the detailed preference order for obtaining a gid; the first of the
19100 following that is set is used:
19101
19102 .ilist
19103 A &%group%& setting of the transport;
19104 .next
19105 A &%group%& setting of the router;
19106 .next
19107 A gid associated with a user setting of the router, either as a result of
19108 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19109 .next
19110 The group associated with a non-numeric &%user%& setting of the transport;
19111 .next
19112 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19113 the uid is the creator's uid;
19114 .next
19115 The Exim gid if the Exim uid is being used as a default.
19116 .endlist
19117
19118 If, for example, the user is specified numerically on the router and there are
19119 no group settings, no gid is available. In this situation, an error occurs.
19120 This is different for the uid, for which there always is an ultimate default.
19121 The first of the following that is set is used:
19122
19123 .ilist
19124 A &%user%& setting of the transport;
19125 .next
19126 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19127 .next
19128 A &%user%& setting of the router;
19129 .next
19130 A &%check_local_user%& setting of the router;
19131 .next
19132 The Exim uid.
19133 .endlist
19134
19135 Of course, an error will still occur if the uid that is chosen is on the
19136 &%never_users%& list.
19137
19138
19139
19140
19141
19142 .section "Current and home directories" "SECID132"
19143 .cindex "current directory for local transport"
19144 .cindex "home directory" "for local transport"
19145 .cindex "transport" "local; home directory for"
19146 .cindex "transport" "local; current directory for"
19147 Routers may set current and home directories for local transports by means of
19148 the &%transport_current_directory%& and &%transport_home_directory%& options.
19149 However, if the transport's &%current_directory%& or &%home_directory%& options
19150 are set, they override the router's values. In detail, the home directory
19151 for a local transport is taken from the first of these values that is set:
19152
19153 .ilist
19154 The &%home_directory%& option on the transport;
19155 .next
19156 The &%transport_home_directory%& option on the router;
19157 .next
19158 The password data if &%check_local_user%& is set on the router;
19159 .next
19160 The &%router_home_directory%& option on the router.
19161 .endlist
19162
19163 The current directory is taken from the first of these values that is set:
19164
19165 .ilist
19166 The &%current_directory%& option on the transport;
19167 .next
19168 The &%transport_current_directory%& option on the router.
19169 .endlist
19170
19171
19172 If neither the router nor the transport sets a current directory, Exim uses the
19173 value of the home directory, if it is set. Otherwise it sets the current
19174 directory to &_/_& before running a local transport.
19175
19176
19177
19178 .section "Expansion variables derived from the address" "SECID133"
19179 .vindex "&$domain$&"
19180 .vindex "&$local_part$&"
19181 .vindex "&$original_domain$&"
19182 Normally a local delivery is handling a single address, and in that case the
19183 variables such as &$domain$& and &$local_part$& are set during local
19184 deliveries. However, in some circumstances more than one address may be handled
19185 at once (for example, while writing batch SMTP for onward transmission by some
19186 other means). In this case, the variables associated with the local part are
19187 never set, &$domain$& is set only if all the addresses have the same domain,
19188 and &$original_domain$& is never set.
19189 .ecindex IIDenvlotra1
19190 .ecindex IIDenvlotra2
19191 .ecindex IIDenvlotra3
19192
19193
19194
19195
19196
19197
19198
19199 . ////////////////////////////////////////////////////////////////////////////
19200 . ////////////////////////////////////////////////////////////////////////////
19201
19202 .chapter "Generic options for transports" "CHAPtransportgeneric"
19203 .scindex IIDgenoptra1 "generic options" "transport"
19204 .scindex IIDgenoptra2 "options" "generic; for transports"
19205 .scindex IIDgenoptra3 "transport" "generic options for"
19206 The following generic options apply to all transports:
19207
19208
19209 .option body_only transports boolean false
19210 .cindex "transport" "body only"
19211 .cindex "message" "transporting body only"
19212 .cindex "body of message" "transporting"
19213 If this option is set, the message's headers are not transported. It is
19214 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19215 or &(pipe)& transports, the settings of &%message_prefix%& and
19216 &%message_suffix%& should be checked, because this option does not
19217 automatically suppress them.
19218
19219
19220 .option current_directory transports string&!! unset
19221 .cindex "transport" "current directory for"
19222 This specifies the current directory that is to be set while running the
19223 transport, overriding any value that may have been set by the router.
19224 If the expansion fails for any reason, including forced failure, an error is
19225 logged, and delivery is deferred.
19226
19227
19228 .option disable_logging transports boolean false
19229 If this option is set true, nothing is logged for any
19230 deliveries by the transport or for any
19231 transport errors. You should not set this option unless you really, really know
19232 what you are doing.
19233
19234
19235 .option debug_print transports string&!! unset
19236 .cindex "testing" "variables in drivers"
19237 If this option is set and debugging is enabled (see the &%-d%& command line
19238 option), the string is expanded and included in the debugging output when the
19239 transport is run.
19240 If expansion of the string fails, the error message is written to the debugging
19241 output, and Exim carries on processing.
19242 This facility is provided to help with checking out the values of variables and
19243 so on when debugging driver configurations. For example, if a &%headers_add%&
19244 option is not working properly, &%debug_print%& could be used to output the
19245 variables it references. A newline is added to the text if it does not end with
19246 one.
19247
19248
19249 .option delivery_date_add transports boolean false
19250 .cindex "&'Delivery-date:'& header line"
19251 If this option is true, a &'Delivery-date:'& header is added to the message.
19252 This gives the actual time the delivery was made. As this is not a standard
19253 header, Exim has a configuration option (&%delivery_date_remove%&) which
19254 requests its removal from incoming messages, so that delivered messages can
19255 safely be resent to other recipients.
19256
19257
19258 .option driver transports string unset
19259 This specifies which of the available transport drivers is to be used.
19260 There is no default, and this option must be set for every transport.
19261
19262
19263 .option envelope_to_add transports boolean false
19264 .cindex "&'Envelope-to:'& header line"
19265 If this option is true, an &'Envelope-to:'& header is added to the message.
19266 This gives the original address(es) in the incoming envelope that caused this
19267 delivery to happen. More than one address may be present if the transport is
19268 configured to handle several addresses at once, or if more than one original
19269 address was redirected to the same final address. As this is not a standard
19270 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19271 its removal from incoming messages, so that delivered messages can safely be
19272 resent to other recipients.
19273
19274
19275 .option group transports string&!! "Exim group"
19276 .cindex "transport" "group; specifying"
19277 This option specifies a gid for running the transport process, overriding any
19278 value that the router supplies, and also overriding any value associated with
19279 &%user%& (see below).
19280
19281
19282 .option headers_add transports string&!! unset
19283 .cindex "header lines" "adding in transport"
19284 .cindex "transport" "header lines; adding"
19285 This option specifies a string of text that is expanded and added to the header
19286 portion of a message as it is transported, as described in section
19287 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19288 routers. If the result of the expansion is an empty string, or if the expansion
19289 is forced to fail, no action is taken. Other expansion failures are treated as
19290 errors and cause the delivery to be deferred.
19291
19292
19293
19294 .option headers_only transports boolean false
19295 .cindex "transport" "header lines only"
19296 .cindex "message" "transporting headers only"
19297 .cindex "header lines" "transporting"
19298 If this option is set, the message's body is not transported. It is mutually
19299 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19300 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19301 checked, since this option does not automatically suppress them.
19302
19303
19304 .option headers_remove transports string&!! unset
19305 .cindex "header lines" "removing"
19306 .cindex "transport" "header lines; removing"
19307 This option specifies a string that is expanded into a list of header names;
19308 these headers are omitted from the message as it is transported, as described
19309 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19310 routers. If the result of the expansion is an empty string, or if the expansion
19311 is forced to fail, no action is taken. Other expansion failures are treated as
19312 errors and cause the delivery to be deferred.
19313
19314
19315
19316 .option headers_rewrite transports string unset
19317 .cindex "transport" "header lines; rewriting"
19318 .cindex "rewriting" "at transport time"
19319 This option allows addresses in header lines to be rewritten at transport time,
19320 that is, as the message is being copied to its destination. The contents of the
19321 option are a colon-separated list of rewriting rules. Each rule is in exactly
19322 the same form as one of the general rewriting rules that are applied when a
19323 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19324 example,
19325 .code
19326 headers_rewrite = a@b c@d f : \
19327                   x@y w@z
19328 .endd
19329 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19330 &'w@z'& in all address-bearing header lines. The rules are applied to the
19331 header lines just before they are written out at transport time, so they affect
19332 only those copies of the message that pass through the transport. However, only
19333 the message's original header lines, and any that were added by a system
19334 filter, are rewritten. If a router or transport adds header lines, they are not
19335 affected by this option. These rewriting rules are &'not'& applied to the
19336 envelope. You can change the return path using &%return_path%&, but you cannot
19337 change envelope recipients at this time.
19338
19339
19340 .option home_directory transports string&!! unset
19341 .cindex "transport" "home directory for"
19342 .vindex "&$home$&"
19343 This option specifies a home directory setting for a local transport,
19344 overriding any value that may be set by the router. The home directory is
19345 placed in &$home$& while expanding the transport's private options. It is also
19346 used as the current directory if no current directory is set by the
19347 &%current_directory%& option on the transport or the
19348 &%transport_current_directory%& option on the router. If the expansion fails
19349 for any reason, including forced failure, an error is logged, and delivery is
19350 deferred.
19351
19352
19353 .option initgroups transports boolean false
19354 .cindex "additional groups"
19355 .cindex "groups" "additional"
19356 .cindex "transport" "group; additional"
19357 If this option is true and the uid for the delivery process is provided by the
19358 transport, the &[initgroups()]& function is called when running the transport
19359 to ensure that any additional groups associated with the uid are set up.
19360
19361
19362 .option message_size_limit transports string&!! 0
19363 .cindex "limit" "message size per transport"
19364 .cindex "size" "of message, limit"
19365 .cindex "transport" "message size; limiting"
19366 This option controls the size of messages passed through the transport. It is
19367 expanded before use; the result of the expansion must be a sequence of decimal
19368 digits, optionally followed by K or M. If the expansion fails for any reason,
19369 including forced failure, or if the result is not of the required form,
19370 delivery is deferred. If the value is greater than zero and the size of a
19371 message exceeds this limit, the address is failed. If there is any chance that
19372 the resulting bounce message could be routed to the same transport, you should
19373 ensure that &%return_size_limit%& is less than the transport's
19374 &%message_size_limit%&, as otherwise the bounce message will fail to get
19375 delivered.
19376
19377
19378
19379 .option rcpt_include_affixes transports boolean false
19380 .cindex "prefix" "for local part, including in envelope"
19381 .cindex "suffix for local part" "including in envelope"
19382 .cindex "local part" "prefix"
19383 .cindex "local part" "suffix"
19384 When this option is false (the default), and an address that has had any
19385 affixes (prefixes or suffixes) removed from the local part is delivered by any
19386 form of SMTP or LMTP, the affixes are not included. For example, if a router
19387 that contains
19388 .code
19389 local_part_prefix = *-
19390 .endd
19391 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19392 is delivered with
19393 .code
19394 RCPT TO:<xyz@some.domain>
19395 .endd
19396 This is also the case when an ACL-time callout is being used to verify a
19397 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19398 whole local part is included in the RCPT command. This option applies to BSMTP
19399 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19400 &(lmtp)& and &(smtp)& transports.
19401
19402
19403 .option retry_use_local_part transports boolean "see below"
19404 .cindex "hints database" "retry keys"
19405 When a delivery suffers a temporary failure, a retry record is created
19406 in Exim's hints database. For remote deliveries, the key for the retry record
19407 is based on the name and/or IP address of the failing remote host. For local
19408 deliveries, the key is normally the entire address, including both the local
19409 part and the domain. This is suitable for most common cases of local delivery
19410 temporary failure &-- for example, exceeding a mailbox quota should delay only
19411 deliveries to that mailbox, not to the whole domain.
19412
19413 However, in some special cases you may want to treat a temporary local delivery
19414 as a failure associated with the domain, and not with a particular local part.
19415 (For example, if you are storing all mail for some domain in files.) You can do
19416 this by setting &%retry_use_local_part%& false.
19417
19418 For all the local transports, its default value is true. For remote transports,
19419 the default value is false for tidiness, but changing the value has no effect
19420 on a remote transport in the current implementation.
19421
19422
19423 .option return_path transports string&!! unset
19424 .cindex "envelope sender"
19425 .cindex "transport" "return path; changing"
19426 .cindex "return path" "changing in transport"
19427 If this option is set, the string is expanded at transport time and replaces
19428 the existing return path (envelope sender) value in the copy of the message
19429 that is being delivered. An empty return path is permitted. This feature is
19430 designed for remote deliveries, where the value of this option is used in the
19431 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19432 only effect is to change the address that is placed in the &'Return-path:'&
19433 header line, if one is added to the message (see the next option).
19434
19435 &*Note:*& A changed return path is not logged unless you add
19436 &%return_path_on_delivery%& to the log selector.
19437
19438 .vindex "&$return_path$&"
19439 The expansion can refer to the existing value via &$return_path$&. This is
19440 either the message's envelope sender, or an address set by the
19441 &%errors_to%& option on a router. If the expansion is forced to fail, no
19442 replacement occurs; if it fails for another reason, delivery is deferred. This
19443 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19444 section &<<SECTverp>>&.
19445
19446 &*Note*&: If a delivery error is detected locally, including the case when a
19447 remote server rejects a message at SMTP time, the bounce message is not sent to
19448 the value of this option. It is sent to the previously set errors address.
19449 This defaults to the incoming sender address, but can be changed by setting
19450 &%errors_to%& in a router.
19451
19452
19453
19454 .option return_path_add transports boolean false
19455 .cindex "&'Return-path:'& header line"
19456 If this option is true, a &'Return-path:'& header is added to the message.
19457 Although the return path is normally available in the prefix line of BSD
19458 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19459 have easy access to it.
19460
19461 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19462 the delivery SMTP server makes the final delivery"&. This implies that this
19463 header should not be present in incoming messages. Exim has a configuration
19464 option, &%return_path_remove%&, which requests removal of this header from
19465 incoming messages, so that delivered messages can safely be resent to other
19466 recipients.
19467
19468
19469 .option shadow_condition transports string&!! unset
19470 See &%shadow_transport%& below.
19471
19472
19473 .option shadow_transport transports string unset
19474 .cindex "shadow transport"
19475 .cindex "transport" "shadow"
19476 A local transport may set the &%shadow_transport%& option to the name of
19477 another local transport. Shadow remote transports are not supported.
19478
19479 Whenever a delivery to the main transport succeeds, and either
19480 &%shadow_condition%& is unset, or its expansion does not result in the empty
19481 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19482 passed to the shadow transport, with the same delivery address or addresses. If
19483 expansion fails, no action is taken except that non-forced expansion failures
19484 cause a log line to be written.
19485
19486 The result of the shadow transport is discarded and does not affect the
19487 subsequent processing of the message. Only a single level of shadowing is
19488 provided; the &%shadow_transport%& option is ignored on any transport when it
19489 is running as a shadow. Options concerned with output from pipes are also
19490 ignored. The log line for the successful delivery has an item added on the end,
19491 of the form
19492 .code
19493 ST=<shadow transport name>
19494 .endd
19495 If the shadow transport did not succeed, the error message is put in
19496 parentheses afterwards. Shadow transports can be used for a number of different
19497 purposes, including keeping more detailed log information than Exim normally
19498 provides, and implementing automatic acknowledgment policies based on message
19499 headers that some sites insist on.
19500
19501
19502 .option transport_filter transports string&!! unset
19503 .cindex "transport" "filter"
19504 .cindex "filter" "transport filter"
19505 This option sets up a filtering (in the Unix shell sense) process for messages
19506 at transport time. It should not be confused with mail filtering as set up by
19507 individual users or via a system filter.
19508
19509 When the message is about to be written out, the command specified by
19510 &%transport_filter%& is started up in a separate, parallel process, and
19511 the entire message, including the header lines, is passed to it on its standard
19512 input (this in fact is done from a third process, to avoid deadlock). The
19513 command must be specified as an absolute path.
19514
19515 The lines of the message that are written to the transport filter are
19516 terminated by newline (&"\n"&). The message is passed to the filter before any
19517 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19518 lines beginning with a dot, and also before any processing implied by the
19519 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19520 &(pipe)& transports.
19521
19522 The standard error for the filter process is set to the same destination as its
19523 standard output; this is read and written to the message's ultimate
19524 destination. The process that writes the message to the filter, the
19525 filter itself, and the original process that reads the result and delivers it
19526 are all run in parallel, like a shell pipeline.
19527
19528 The filter can perform any transformations it likes, but of course should take
19529 care not to break RFC 2822 syntax. Exim does not check the result, except to
19530 test for a final newline when SMTP is in use. All messages transmitted over
19531 SMTP must end with a newline, so Exim supplies one if it is missing.
19532
19533 .cindex "content scanning" "per user"
19534 A transport filter can be used to provide content-scanning on a per-user basis
19535 at delivery time if the only required effect of the scan is to modify the
19536 message. For example, a content scan could insert a new header line containing
19537 a spam score. This could be interpreted by a filter in the user's MUA. It is
19538 not possible to discard a message at this stage.
19539
19540 .cindex "SMTP" "SIZE"
19541 A problem might arise if the filter increases the size of a message that is
19542 being sent down an SMTP connection. If the receiving SMTP server has indicated
19543 support for the SIZE parameter, Exim will have sent the size of the message
19544 at the start of the SMTP session. If what is actually sent is substantially
19545 more, the server might reject the message. This can be worked round by setting
19546 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19547 additions to the message, or to disable the use of SIZE altogether.
19548
19549 .vindex "&$pipe_addresses$&"
19550 The value of the &%transport_filter%& option is the command string for starting
19551 the filter, which is run directly from Exim, not under a shell. The string is
19552 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19553 Exim breaks it up into arguments and then expands each argument separately (see
19554 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19555 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19556 of arguments, one for each address that applies to this delivery. (This isn't
19557 an ideal name for this feature here, but as it was already implemented for the
19558 &(pipe)& transport, it seemed sensible not to change it.)
19559
19560 .vindex "&$host$&"
19561 .vindex "&$host_address$&"
19562 The expansion variables &$host$& and &$host_address$& are available when the
19563 transport is a remote one. They contain the name and IP address of the host to
19564 which the message is being sent. For example:
19565 .code
19566 transport_filter = /some/directory/transport-filter.pl \
19567   $host $host_address $sender_address $pipe_addresses
19568 .endd
19569
19570 Two problems arise if you want to use more complicated expansion items to
19571 generate transport filter commands, both of which due to the fact that the
19572 command is split up &'before'& expansion.
19573 .ilist
19574 If an expansion item contains white space, you must quote it, so that it is all
19575 part of the same command item. If the entire option setting is one such
19576 expansion item, you have to take care what kind of quoting you use. For
19577 example:
19578 .code
19579 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19580 .endd
19581 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19582 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19583 stripped by Exim when it read the option's value. When the value is used, if
19584 the single quotes were missing, the line would be split into two items,
19585 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19586 Exim tried to expand the first one.
19587 .next
19588 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19589 expansion cannot generate multiple arguments, or a command name followed by
19590 arguments. Consider this example:
19591 .code
19592 transport_filter = ${lookup{$host}lsearch{/a/file}\
19593                     {$value}{/bin/cat}}
19594 .endd
19595 The result of the lookup is interpreted as the name of the command, even
19596 if it contains white space. The simplest way round this is to use a shell:
19597 .code
19598 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19599                                {$value}{/bin/cat}}
19600 .endd
19601 .endlist
19602
19603 The filter process is run under the same uid and gid as the normal delivery.
19604 For remote deliveries this is the Exim uid/gid by default. The command should
19605 normally yield a zero return code. Transport filters are not supposed to fail.
19606 A non-zero code is taken to mean that the transport filter encountered some
19607 serious problem. Delivery of the message is deferred; the message remains on
19608 the queue and is tried again later. It is not possible to cause a message to be
19609 bounced from a transport filter.
19610
19611 If a transport filter is set on an autoreply transport, the original message is
19612 passed through the filter as it is being copied into the newly generated
19613 message, which happens if the &%return_message%& option is set.
19614
19615
19616 .option transport_filter_timeout transports time 5m
19617 .cindex "transport" "filter, timeout"
19618 When Exim is reading the output of a transport filter, it a applies a timeout
19619 that can be set by this option. Exceeding the timeout is normally treated as a
19620 temporary delivery failure. However, if a transport filter is used with a
19621 &(pipe)& transport, a timeout in the transport filter is treated in the same
19622 way as a timeout in the pipe command itself. By default, a timeout is a hard
19623 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19624 becomes a temporary error.
19625
19626
19627 .option user transports string&!! "Exim user"
19628 .cindex "uid (user id)" "local delivery"
19629 .cindex "transport" "user, specifying"
19630 This option specifies the user under whose uid the delivery process is to be
19631 run, overriding any uid that may have been set by the router. If the user is
19632 given as a name, the uid is looked up from the password data, and the
19633 associated group is taken as the value of the gid to be used if the &%group%&
19634 option is not set.
19635
19636 For deliveries that use local transports, a user and group are normally
19637 specified explicitly or implicitly (for example, as a result of
19638 &%check_local_user%&) by the router or transport.
19639
19640 .cindex "hints database" "access by remote transport"
19641 For remote transports, you should leave this option unset unless you really are
19642 sure you know what you are doing. When a remote transport is running, it needs
19643 to be able to access Exim's hints databases, because each host may have its own
19644 retry data.
19645 .ecindex IIDgenoptra1
19646 .ecindex IIDgenoptra2
19647 .ecindex IIDgenoptra3
19648
19649
19650
19651
19652
19653
19654 . ////////////////////////////////////////////////////////////////////////////
19655 . ////////////////////////////////////////////////////////////////////////////
19656
19657 .chapter "Address batching in local transports" "CHAPbatching" &&&
19658          "Address batching"
19659 .cindex "transport" "local; address batching in"
19660 The only remote transport (&(smtp)&) is normally configured to handle more than
19661 one address at a time, so that when several addresses are routed to the same
19662 remote host, just one copy of the message is sent. Local transports, however,
19663 normally handle one address at a time. That is, a separate instance of the
19664 transport is run for each address that is routed to the transport. A separate
19665 copy of the message is delivered each time.
19666
19667 .cindex "batched local delivery"
19668 .oindex "&%batch_max%&"
19669 .oindex "&%batch_id%&"
19670 In special cases, it may be desirable to handle several addresses at once in a
19671 local transport, for example:
19672
19673 .ilist
19674 In an &(appendfile)& transport, when storing messages in files for later
19675 delivery by some other means, a single copy of the message with multiple
19676 recipients saves space.
19677 .next
19678 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19679 a single copy saves time, and is the normal way LMTP is expected to work.
19680 .next
19681 In a &(pipe)& transport, when passing the message
19682 to a scanner program or
19683 to some other delivery mechanism such as UUCP, multiple recipients may be
19684 acceptable.
19685 .endlist
19686
19687 These three local transports all have the same options for controlling multiple
19688 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19689 repeating the information for each transport, these options are described here.
19690
19691 The &%batch_max%& option specifies the maximum number of addresses that can be
19692 delivered together in a single run of the transport. Its default value is one
19693 (no batching). When more than one address is routed to a transport that has a
19694 &%batch_max%& value greater than one, the addresses are delivered in a batch
19695 (that is, in a single run of the transport with multiple recipients), subject
19696 to certain conditions:
19697
19698 .ilist
19699 .vindex "&$local_part$&"
19700 If any of the transport's options contain a reference to &$local_part$&, no
19701 batching is possible.
19702 .next
19703 .vindex "&$domain$&"
19704 If any of the transport's options contain a reference to &$domain$&, only
19705 addresses with the same domain are batched.
19706 .next
19707 .cindex "customizing" "batching condition"
19708 If &%batch_id%& is set, it is expanded for each address, and only those
19709 addresses with the same expanded value are batched. This allows you to specify
19710 customized batching conditions. Failure of the expansion for any reason,
19711 including forced failure, disables batching, but it does not stop the delivery
19712 from taking place.
19713 .next
19714 Batched addresses must also have the same errors address (where to send
19715 delivery errors), the same header additions and removals, the same user and
19716 group for the transport, and if a host list is present, the first host must
19717 be the same.
19718 .endlist
19719
19720 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19721 both when the file or pipe command is specified in the transport, and when it
19722 is specified by a &(redirect)& router, but all the batched addresses must of
19723 course be routed to the same file or pipe command. These two transports have an
19724 option called &%use_bsmtp%&, which causes them to deliver the message in
19725 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19726 &%check_string%& and &%escape_string%& options are forced to the values
19727 .code
19728 check_string = "."
19729 escape_string = ".."
19730 .endd
19731 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19732 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19733 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19734
19735 .cindex "&'Envelope-to:'& header line"
19736 If the generic &%envelope_to_add%& option is set for a batching transport, the
19737 &'Envelope-to:'& header that is added to the message contains all the addresses
19738 that are being processed together. If you are using a batching &(appendfile)&
19739 transport without &%use_bsmtp%&, the only way to preserve the recipient
19740 addresses is to set the &%envelope_to_add%& option.
19741
19742 .cindex "&(pipe)& transport" "with multiple addresses"
19743 .vindex "&$pipe_addresses$&"
19744 If you are using a &(pipe)& transport without BSMTP, and setting the
19745 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19746 the command. This is not a true variable; it is a bit of magic that causes each
19747 of the recipient addresses to be inserted into the command as a separate
19748 argument. This provides a way of accessing all the addresses that are being
19749 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19750 are specified by a &(redirect)& router.
19751
19752
19753
19754
19755 . ////////////////////////////////////////////////////////////////////////////
19756 . ////////////////////////////////////////////////////////////////////////////
19757
19758 .chapter "The appendfile transport" "CHAPappendfile"
19759 .scindex IIDapptra1 "&(appendfile)& transport"
19760 .scindex IIDapptra2 "transports" "&(appendfile)&"
19761 .cindex "directory creation"
19762 .cindex "creating directories"
19763 The &(appendfile)& transport delivers a message by appending it to an existing
19764 file, or by creating an entirely new file in a specified directory. Single
19765 files to which messages are appended can be in the traditional Unix mailbox
19766 format, or optionally in the MBX format supported by the Pine MUA and
19767 University of Washington IMAP daemon, &'inter alia'&. When each message is
19768 being delivered as a separate file, &"maildir"& format can optionally be used
19769 to give added protection against failures that happen part-way through the
19770 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19771 supported. For all file formats, Exim attempts to create as many levels of
19772 directory as necessary, provided that &%create_directory%& is set.
19773
19774 The code for the optional formats is not included in the Exim binary by
19775 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19776 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19777 included.
19778
19779 .cindex "quota" "system"
19780 Exim recognizes system quota errors, and generates an appropriate message. Exim
19781 also supports its own quota control within the transport, for use when the
19782 system facility is unavailable or cannot be used for some reason.
19783
19784 If there is an error while appending to a file (for example, quota exceeded or
19785 partition filled), Exim attempts to reset the file's length and last
19786 modification time back to what they were before. If there is an error while
19787 creating an entirely new file, the new file is removed.
19788
19789 Before appending to a file, a number of security checks are made, and the
19790 file is locked. A detailed description is given below, after the list of
19791 private options.
19792
19793 The &(appendfile)& transport is most commonly used for local deliveries to
19794 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19795 putting messages into files for remote delivery by some means other than Exim.
19796 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19797 option).
19798
19799
19800
19801 .section "The file and directory options" "SECTfildiropt"
19802 The &%file%& option specifies a single file, to which the message is appended;
19803 the &%directory%& option specifies a directory, in which a new file containing
19804 the message is created. Only one of these two options can be set, and for
19805 normal deliveries to mailboxes, one of them &'must'& be set.
19806
19807 .vindex "&$address_file$&"
19808 .vindex "&$local_part$&"
19809 However, &(appendfile)& is also used for delivering messages to files or
19810 directories whose names (or parts of names) are obtained from alias,
19811 forwarding, or filtering operations (for example, a &%save%& command in a
19812 user's Exim filter). When such a transport is running, &$local_part$& contains
19813 the local part that was aliased or forwarded, and &$address_file$& contains the
19814 name (or partial name) of the file or directory generated by the redirection
19815 operation. There are two cases:
19816
19817 .ilist
19818 If neither &%file%& nor &%directory%& is set, the redirection operation
19819 must specify an absolute path (one that begins with &`/`&). This is the most
19820 common case when users with local accounts use filtering to sort mail into
19821 different folders. See for example, the &(address_file)& transport in the
19822 default configuration. If the path ends with a slash, it is assumed to be the
19823 name of a directory. A delivery to a directory can also be forced by setting
19824 &%maildir_format%& or &%mailstore_format%&.
19825 .next
19826 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19827 used to determine the file or directory name for the delivery. Normally, the
19828 contents of &$address_file$& are used in some way in the string expansion.
19829 .endlist
19830
19831
19832 .cindex "Sieve filter" "configuring &(appendfile)&"
19833 .cindex "Sieve filter" "relative mailbox path handling"
19834 As an example of the second case, consider an environment where users do not
19835 have home directories. They may be permitted to use Exim filter commands of the
19836 form:
19837 .code
19838 save folder23
19839 .endd
19840 or Sieve filter commands of the form:
19841 .code
19842 require "fileinto";
19843 fileinto "folder23";
19844 .endd
19845 In this situation, the expansion of &%file%& or &%directory%& in the transport
19846 must transform the relative path into an appropriate absolute file name. In the
19847 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19848 is used as a result of a &"keep"& action in the filter. This example shows one
19849 way of handling this requirement:
19850 .code
19851 file = ${if eq{$address_file}{inbox} \
19852             {/var/mail/$local_part} \
19853             {${if eq{${substr_0_1:$address_file}}{/} \
19854                   {$address_file} \
19855                   {$home/mail/$address_file} \
19856             }} \
19857        }
19858 .endd
19859 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19860 location, absolute paths are used without change, and other folders are in the
19861 &_mail_& directory within the home directory.
19862
19863 &*Note 1*&: While processing an Exim filter, a relative path such as
19864 &_folder23_& is turned into an absolute path if a home directory is known to
19865 the router. In particular, this is the case if &%check_local_user%& is set. If
19866 you want to prevent this happening at routing time, you can set
19867 &%router_home_directory%& empty. This forces the router to pass the relative
19868 path to the transport.
19869
19870 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19871 the &%file%& or &%directory%& option is still used if it is set.
19872
19873
19874
19875
19876 .section "Private options for appendfile" "SECID134"
19877 .cindex "options" "&(appendfile)& transport"
19878
19879
19880
19881 .option allow_fifo appendfile boolean false
19882 .cindex "fifo (named pipe)"
19883 .cindex "named pipe (fifo)"
19884 .cindex "pipe" "named (fifo)"
19885 Setting this option permits delivery to named pipes (FIFOs) as well as to
19886 regular files. If no process is reading the named pipe at delivery time, the
19887 delivery is deferred.
19888
19889
19890 .option allow_symlink appendfile boolean false
19891 .cindex "symbolic link" "to mailbox"
19892 .cindex "mailbox" "symbolic link"
19893 By default, &(appendfile)& will not deliver if the path name for the file is
19894 that of a symbolic link. Setting this option relaxes that constraint, but there
19895 are security issues involved in the use of symbolic links. Be sure you know
19896 what you are doing if you set this. Details of exactly what this option affects
19897 are included in the discussion which follows this list of options.
19898
19899
19900 .option batch_id appendfile string&!! unset
19901 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19902 However, batching is automatically disabled for &(appendfile)& deliveries that
19903 happen as a result of forwarding or aliasing or other redirection directly to a
19904 file.
19905
19906
19907 .option batch_max appendfile integer 1
19908 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19909
19910
19911 .option check_group appendfile boolean false
19912 When this option is set, the group owner of the file defined by the &%file%&
19913 option is checked to see that it is the same as the group under which the
19914 delivery process is running. The default setting is false because the default
19915 file mode is 0600, which means that the group is irrelevant.
19916
19917
19918 .option check_owner appendfile boolean true
19919 When this option is set, the owner of the file defined by the &%file%& option
19920 is checked to ensure that it is the same as the user under which the delivery
19921 process is running.
19922
19923
19924 .option check_string appendfile string "see below"
19925 .cindex "&""From""& line"
19926 As &(appendfile)& writes the message, the start of each line is tested for
19927 matching &%check_string%&, and if it does, the initial matching characters are
19928 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19929 a literal string, not a regular expression, and the case of any letters it
19930 contains is significant.
19931
19932 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19933 are forced to &"."& and &".."& respectively, and any settings in the
19934 configuration are ignored. Otherwise, they default to &"From&~"& and
19935 &">From&~"& when the &%file%& option is set, and unset when any of the
19936 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19937
19938 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19939 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19940 &"From&~"& indicates the start of a new message. All four options need changing
19941 if another format is used. For example, to deliver to mailboxes in MMDF format:
19942 .cindex "MMDF format mailbox"
19943 .cindex "mailbox" "MMDF format"
19944 .code
19945 check_string = "\1\1\1\1\n"
19946 escape_string = "\1\1\1\1 \n"
19947 message_prefix = "\1\1\1\1\n"
19948 message_suffix = "\1\1\1\1\n"
19949 .endd
19950 .option create_directory appendfile boolean true
19951 .cindex "directory creation"
19952 When this option is true, Exim attempts to create any missing superior
19953 directories for the file that it is about to write. A created directory's mode
19954 is given by the &%directory_mode%& option.
19955
19956 The group ownership of a newly created directory is highly dependent on the
19957 operating system (and possibly the file system) that is being used. For
19958 example, in Solaris, if the parent directory has the setgid bit set, its group
19959 is propagated to the child; if not, the currently set group is used. However,
19960 in FreeBSD, the parent's group is always used.
19961
19962
19963
19964 .option create_file appendfile string anywhere
19965 This option constrains the location of files and directories that are created
19966 by this transport. It applies to files defined by the &%file%& option and
19967 directories defined by the &%directory%& option. In the case of maildir
19968 delivery, it applies to the top level directory, not the maildir directories
19969 beneath.
19970
19971 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19972 &"belowhome"&. In the second and third cases, a home directory must have been
19973 set for the transport. This option is not useful when an explicit file name is
19974 given for normal mailbox deliveries. It is intended for the case when file
19975 names are generated from users' &_.forward_& files. These are usually handled
19976 by an &(appendfile)& transport called &%address_file%&. See also
19977 &%file_must_exist%&.
19978
19979
19980 .option directory appendfile string&!! unset
19981 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19982 or &%directory%& must be set, unless the delivery is the direct result of a
19983 redirection (see section &<<SECTfildiropt>>&).
19984
19985 When &%directory%& is set, the string is expanded, and the message is delivered
19986 into a new file or files in or below the given directory, instead of being
19987 appended to a single mailbox file. A number of different formats are provided
19988 (see &%maildir_format%& and &%mailstore_format%&), and see section
19989 &<<SECTopdir>>& for further details of this form of delivery.
19990
19991
19992 .option directory_file appendfile string&!! "see below"
19993 .cindex "base62"
19994 .vindex "&$inode$&"
19995 When &%directory%& is set, but neither &%maildir_format%& nor
19996 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19997 whose name is obtained by expanding this string. The default value is:
19998 .code
19999 q${base62:$tod_epoch}-$inode
20000 .endd
20001 This generates a unique name from the current time, in base 62 form, and the
20002 inode of the file. The variable &$inode$& is available only when expanding this
20003 option.
20004
20005
20006 .option directory_mode appendfile "octal integer" 0700
20007 If &(appendfile)& creates any directories as a result of the
20008 &%create_directory%& option, their mode is specified by this option.
20009
20010
20011 .option escape_string appendfile string "see description"
20012 See &%check_string%& above.
20013
20014
20015 .option file appendfile string&!! unset
20016 This option is mutually exclusive with the &%directory%& option, but one of
20017 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20018 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20019 specifies a single file, to which the message is appended. One or more of
20020 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20021 &%file%&.
20022
20023 .cindex "NFS" "lock file"
20024 .cindex "locking files"
20025 .cindex "lock files"
20026 If you are using more than one host to deliver over NFS into the same
20027 mailboxes, you should always use lock files.
20028
20029 The string value is expanded for each delivery, and must yield an absolute
20030 path. The most common settings of this option are variations on one of these
20031 examples:
20032 .code
20033 file = /var/spool/mail/$local_part
20034 file = /home/$local_part/inbox
20035 file = $home/inbox
20036 .endd
20037 .cindex "&""sticky""& bit"
20038 In the first example, all deliveries are done into the same directory. If Exim
20039 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20040 create a file in the directory, so the &"sticky"& bit must be turned on for
20041 deliveries to be possible, or alternatively the &%group%& option can be used to
20042 run the delivery under a group id which has write access to the directory.
20043
20044
20045
20046 .option file_format appendfile string unset
20047 .cindex "file" "mailbox; checking existing format"
20048 This option requests the transport to check the format of an existing file
20049 before adding to it. The check consists of matching a specific string at the
20050 start of the file. The value of the option consists of an even number of
20051 colon-separated strings. The first of each pair is the test string, and the
20052 second is the name of a transport. If the transport associated with a matched
20053 string is not the current transport, control is passed over to the other
20054 transport. For example, suppose the standard &(local_delivery)& transport has
20055 this added to it:
20056 .code
20057 file_format = "From       : local_delivery :\
20058                \1\1\1\1\n : local_mmdf_delivery"
20059 .endd
20060 Mailboxes that begin with &"From"& are still handled by this transport, but if
20061 a mailbox begins with four binary ones followed by a newline, control is passed
20062 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20063 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20064 is assumed to match the current transport. If the start of a mailbox doesn't
20065 match any string, or if the transport named for a given string is not defined,
20066 delivery is deferred.
20067
20068
20069 .option file_must_exist appendfile boolean false
20070 If this option is true, the file specified by the &%file%& option must exist.
20071 A temporary error occurs if it does not, causing delivery to be deferred.
20072 If this option is false, the file is created if it does not exist.
20073
20074
20075 .option lock_fcntl_timeout appendfile time 0s
20076 .cindex "timeout" "mailbox locking"
20077 .cindex "mailbox" "locking, blocking and non-blocking"
20078 .cindex "locking files"
20079 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20080 when locking an open mailbox file. If the call fails, the delivery process
20081 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20082 Non-blocking calls are used so that the file is not kept open during the wait
20083 for the lock; the reason for this is to make it as safe as possible for
20084 deliveries over NFS in the case when processes might be accessing an NFS
20085 mailbox without using a lock file. This should not be done, but
20086 misunderstandings and hence misconfigurations are not unknown.
20087
20088 On a busy system, however, the performance of a non-blocking lock approach is
20089 not as good as using a blocking lock with a timeout. In this case, the waiting
20090 is done inside the system call, and Exim's delivery process acquires the lock
20091 and can proceed as soon as the previous lock holder releases it.
20092
20093 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20094 timeout, are used. There may still be some retrying: the maximum number of
20095 retries is
20096 .code
20097 (lock_retries * lock_interval) / lock_fcntl_timeout
20098 .endd
20099 rounded up to the next whole number. In other words, the total time during
20100 which &(appendfile)& is trying to get a lock is roughly the same, unless
20101 &%lock_fcntl_timeout%& is set very large.
20102
20103 You should consider setting this option if you are getting a lot of delayed
20104 local deliveries because of errors of the form
20105 .code
20106 failed to lock mailbox /some/file (fcntl)
20107 .endd
20108
20109 .option lock_flock_timeout appendfile time 0s
20110 This timeout applies to file locking when using &[flock()]& (see
20111 &%use_flock%&); the timeout operates in a similar manner to
20112 &%lock_fcntl_timeout%&.
20113
20114
20115 .option lock_interval appendfile time 3s
20116 This specifies the time to wait between attempts to lock the file. See below
20117 for details of locking.
20118
20119
20120 .option lock_retries appendfile integer 10
20121 This specifies the maximum number of attempts to lock the file. A value of zero
20122 is treated as 1. See below for details of locking.
20123
20124
20125 .option lockfile_mode appendfile "octal integer" 0600
20126 This specifies the mode of the created lock file, when a lock file is being
20127 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20128
20129
20130 .option lockfile_timeout appendfile time 30m
20131 .cindex "timeout" "mailbox locking"
20132 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20133 exists and is older than this value, it is assumed to have been left behind by
20134 accident, and Exim attempts to remove it.
20135
20136
20137 .option mailbox_filecount appendfile string&!! unset
20138 .cindex "mailbox" "specifying size of"
20139 .cindex "size" "of mailbox"
20140 If this option is set, it is expanded, and the result is taken as the current
20141 number of files in the mailbox. It must be a decimal number, optionally
20142 followed by K or M. This provides a way of obtaining this information from an
20143 external source that maintains the data.
20144
20145
20146 .option mailbox_size appendfile string&!! unset
20147 .cindex "mailbox" "specifying size of"
20148 .cindex "size" "of mailbox"
20149 If this option is set, it is expanded, and the result is taken as the current
20150 size the mailbox. It must be a decimal number, optionally followed by K or M.
20151 This provides a way of obtaining this information from an external source that
20152 maintains the data. This is likely to be helpful for maildir deliveries where
20153 it is computationally expensive to compute the size of a mailbox.
20154
20155
20156
20157 .option maildir_format appendfile boolean false
20158 .cindex "maildir format" "specifying"
20159 If this option is set with the &%directory%& option, the delivery is into a new
20160 file, in the &"maildir"& format that is used by other mail software. When the
20161 transport is activated directly from a &(redirect)& router (for example, the
20162 &(address_file)& transport in the default configuration), setting
20163 &%maildir_format%& causes the path received from the router to be treated as a
20164 directory, whether or not it ends with &`/`&. This option is available only if
20165 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20166 &<<SECTmaildirdelivery>>& below for further details.
20167
20168
20169 .option maildir_quota_directory_regex appendfile string "See below"
20170 .cindex "maildir format" "quota; directories included in"
20171 .cindex "quota" "maildir; directories included in"
20172 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20173 a regular expression for specifying directories, relative to the quota
20174 directory (see &%quota_directory%&), that should be included in the quota
20175 calculation. The default value is:
20176 .code
20177 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20178 .endd
20179 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20180 (directories whose names begin with a dot). If you want to exclude the
20181 &_Trash_&
20182 folder from the count (as some sites do), you need to change this setting to
20183 .code
20184 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20185 .endd
20186 This uses a negative lookahead in the regular expression to exclude the
20187 directory whose name is &_.Trash_&. When a directory is excluded from quota
20188 calculations, quota processing is bypassed for any messages that are delivered
20189 directly into that directory.
20190
20191
20192 .option maildir_retries appendfile integer 10
20193 This option specifies the number of times to retry when writing a file in
20194 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20195
20196
20197 .option maildir_tag appendfile string&!! unset
20198 This option applies only to deliveries in maildir format, and is described in
20199 section &<<SECTmaildirdelivery>>& below.
20200
20201
20202 .new
20203 .option maildir_use_size_file appendfile&!! boolean false
20204 .cindex "maildir format" "&_maildirsize_& file"
20205 The result of string expansion for this option must be a valid boolean value.
20206 If it is true, it enables support for &_maildirsize_& files. Exim
20207 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20208 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20209 value is zero. See &%maildir_quota_directory_regex%& above and section
20210 &<<SECTmaildirdelivery>>& below for further details.
20211 .wen
20212
20213 .option maildirfolder_create_regex appendfile string unset
20214 .cindex "maildir format" "&_maildirfolder_& file"
20215 .cindex "&_maildirfolder_&, creating"
20216 The value of this option is a regular expression. If it is unset, it has no
20217 effect. Otherwise, before a maildir delivery takes place, the pattern is
20218 matched against the name of the maildir directory, that is, the directory
20219 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20220 delivery. If there is a match, Exim checks for the existence of a file called
20221 &_maildirfolder_& in the directory, and creates it if it does not exist.
20222 See section &<<SECTmaildirdelivery>>& for more details.
20223
20224
20225 .option mailstore_format appendfile boolean false
20226 .cindex "mailstore format" "specifying"
20227 If this option is set with the &%directory%& option, the delivery is into two
20228 new files in  &"mailstore"& format. The option is available only if
20229 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20230 below for further details.
20231
20232
20233 .option mailstore_prefix appendfile string&!! unset
20234 This option applies only to deliveries in mailstore format, and is described in
20235 section &<<SECTopdir>>& below.
20236
20237
20238 .option mailstore_suffix appendfile string&!! unset
20239 This option applies only to deliveries in mailstore format, and is described in
20240 section &<<SECTopdir>>& below.
20241
20242
20243 .option mbx_format appendfile boolean false
20244 .cindex "locking files"
20245 .cindex "file" "locking"
20246 .cindex "file" "MBX format"
20247 .cindex "MBX format, specifying"
20248 This option is available only if Exim has been compiled with SUPPORT_MBX
20249 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20250 the message is appended to the mailbox file in MBX format instead of
20251 traditional Unix format. This format is supported by Pine4 and its associated
20252 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20253
20254 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20255 automatically changed by the use of &%mbx_format%&. They should normally be set
20256 empty when using MBX format, so this option almost always appears in this
20257 combination:
20258 .code
20259 mbx_format = true
20260 message_prefix =
20261 message_suffix =
20262 .endd
20263 If none of the locking options are mentioned in the configuration,
20264 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20265 is possible to specify the other kinds of locking with &%mbx_format%&, but
20266 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20267 interworks with &'c-client'&, providing for shared access to the mailbox. It
20268 should not be used if any program that does not use this form of locking is
20269 going to access the mailbox, nor should it be used if the mailbox file is NFS
20270 mounted, because it works only when the mailbox is accessed from a single host.
20271
20272 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20273 the standard version of &'c-client'&, because as long as it has a mailbox open
20274 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20275 append messages to it.
20276
20277
20278 .option message_prefix appendfile string&!! "see below"
20279 .cindex "&""From""& line"
20280 The string specified here is expanded and output at the start of every message.
20281 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20282 in which case it is:
20283 .code
20284 message_prefix = "From ${if def:return_path{$return_path}\
20285   {MAILER-DAEMON}} $tod_bsdinbox\n"
20286 .endd
20287 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20288 &`\n`& to &`\r\n`& in &%message_prefix%&.
20289
20290 .option message_suffix appendfile string&!! "see below"
20291 The string specified here is expanded and output at the end of every message.
20292 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20293 in which case it is a single newline character. The suffix can be suppressed by
20294 setting
20295 .code
20296 message_suffix =
20297 .endd
20298 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20299 &`\n`& to &`\r\n`& in &%message_suffix%&.
20300
20301 .option mode appendfile "octal integer" 0600
20302 If the output file is created, it is given this mode. If it already exists and
20303 has wider permissions, they are reduced to this mode. If it has narrower
20304 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20305 if the delivery is the result of a &%save%& command in a filter file specifying
20306 a particular mode, the mode of the output file is always forced to take that
20307 value, and this option is ignored.
20308
20309
20310 .option mode_fail_narrower appendfile boolean true
20311 This option applies in the case when an existing mailbox file has a narrower
20312 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20313 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20314 continues with the delivery attempt, using the existing mode of the file.
20315
20316
20317 .option notify_comsat appendfile boolean false
20318 If this option is true, the &'comsat'& daemon is notified after every
20319 successful delivery to a user mailbox. This is the daemon that notifies logged
20320 on users about incoming mail.
20321
20322
20323 .option quota appendfile string&!! unset
20324 .cindex "quota" "imposed by Exim"
20325 This option imposes a limit on the size of the file to which Exim is appending,
20326 or to the total space used in the directory tree when the &%directory%& option
20327 is set. In the latter case, computation of the space used is expensive, because
20328 all the files in the directory (and any sub-directories) have to be
20329 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20330 &%maildir_use_size_file%& for ways to avoid this in environments where users
20331 have no shell access to their mailboxes).
20332
20333 As there is no interlock against two simultaneous deliveries into a
20334 multi-file mailbox, it is possible for the quota to be overrun in this case.
20335 For single-file mailboxes, of course, an interlock is a necessity.
20336
20337 A file's size is taken as its &'used'& value. Because of blocking effects, this
20338 may be a lot less than the actual amount of disk space allocated to the file.
20339 If the sizes of a number of files are being added up, the rounding effect can
20340 become quite noticeable, especially on systems that have large block sizes.
20341 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20342 the obvious value which users understand most easily.
20343
20344 The value of the option is expanded, and must then be a numerical value
20345 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20346 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20347 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20348 be handled.
20349
20350 &*Note*&: A value of zero is interpreted as &"no quota"&.
20351
20352 The expansion happens while Exim is running as root, before it changes uid for
20353 the delivery. This means that files that are inaccessible to the end user can
20354 be used to hold quota values that are looked up in the expansion. When delivery
20355 fails because this quota is exceeded, the handling of the error is as for
20356 system quota failures.
20357
20358 By default, Exim's quota checking mimics system quotas, and restricts the
20359 mailbox to the specified maximum size, though the value is not accurate to the
20360 last byte, owing to separator lines and additional headers that may get added
20361 during message delivery. When a mailbox is nearly full, large messages may get
20362 refused even though small ones are accepted, because the size of the current
20363 message is added to the quota when the check is made. This behaviour can be
20364 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20365 for exceeding the quota does not include the current message. Thus, deliveries
20366 continue until the quota has been exceeded; thereafter, no further messages are
20367 delivered. See also &%quota_warn_threshold%&.
20368
20369
20370 .option quota_directory appendfile string&!! unset
20371 This option defines the directory to check for quota purposes when delivering
20372 into individual files. The default is the delivery directory, or, if a file
20373 called &_maildirfolder_& exists in a maildir directory, the parent of the
20374 delivery directory.
20375
20376
20377 .option quota_filecount appendfile string&!! 0
20378 This option applies when the &%directory%& option is set. It limits the total
20379 number of files in the directory (compare the inode limit in system quotas). It
20380 can only be used if &%quota%& is also set. The value is expanded; an expansion
20381 failure causes delivery to be deferred. A value of zero is interpreted as
20382 &"no quota"&.
20383
20384
20385 .option quota_is_inclusive appendfile boolean true
20386 See &%quota%& above.
20387
20388
20389 .option quota_size_regex appendfile string unset
20390 This option applies when one of the delivery modes that writes a separate file
20391 for each message is being used. When Exim wants to find the size of one of
20392 these files in order to test the quota, it first checks &%quota_size_regex%&.
20393 If this is set to a regular expression that matches the file name, and it
20394 captures one string, that string is interpreted as a representation of the
20395 file's size. The value of &%quota_size_regex%& is not expanded.
20396
20397 This feature is useful only when users have no shell access to their mailboxes
20398 &-- otherwise they could defeat the quota simply by renaming the files. This
20399 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20400 the file length to the file name. For example:
20401 .code
20402 maildir_tag = ,S=$message_size
20403 quota_size_regex = ,S=(\d+)
20404 .endd
20405 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20406 number of lines in the message.
20407
20408 The regular expression should not assume that the length is at the end of the
20409 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20410 sometimes add other information onto the ends of message file names.
20411
20412 Section &<<SECID136>>& contains further information.
20413
20414
20415 .option quota_warn_message appendfile string&!! "see below"
20416 See below for the use of this option. If it is not set when
20417 &%quota_warn_threshold%& is set, it defaults to
20418 .code
20419 quota_warn_message = "\
20420   To: $local_part@$domain\n\
20421   Subject: Your mailbox\n\n\
20422   This message is automatically created \
20423   by mail delivery software.\n\n\
20424   The size of your mailbox has exceeded \
20425   a warning threshold that is\n\
20426   set by the system administrator.\n"
20427 .endd
20428
20429
20430 .option quota_warn_threshold appendfile string&!! 0
20431 .cindex "quota" "warning threshold"
20432 .cindex "mailbox" "size warning"
20433 .cindex "size" "of mailbox"
20434 This option is expanded in the same way as &%quota%& (see above). If the
20435 resulting value is greater than zero, and delivery of the message causes the
20436 size of the file or total space in the directory tree to cross the given
20437 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20438 may be specified as a percentage of it by following the value with a percent
20439 sign. For example:
20440 .code
20441 quota = 10M
20442 quota_warn_threshold = 75%
20443 .endd
20444 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20445 percent sign is ignored.
20446
20447 The warning message itself is specified by the &%quota_warn_message%& option,
20448 and it must start with a &'To:'& header line containing the recipient(s) of the
20449 warning message. These do not necessarily have to include the recipient(s) of
20450 the original message. A &'Subject:'& line should also normally be supplied. You
20451 can include any other header lines that you want. If you do not include a
20452 &'From:'& line, the default is:
20453 .code
20454 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20455 .endd
20456 .oindex &%errors_reply_to%&
20457 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20458 option.
20459
20460 The &%quota%& option does not have to be set in order to use this option; they
20461 are independent of one another except when the threshold is specified as a
20462 percentage.
20463
20464
20465 .option use_bsmtp appendfile boolean false
20466 .cindex "envelope sender"
20467 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20468 format, with the envelope sender and recipient(s) included as SMTP commands. If
20469 you want to include a leading HELO command with such messages, you can do
20470 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20471 for details of batch SMTP.
20472
20473
20474 .option use_crlf appendfile boolean false
20475 .cindex "carriage return"
20476 .cindex "linefeed"
20477 This option causes lines to be terminated with the two-character CRLF sequence
20478 (carriage return, linefeed) instead of just a linefeed character. In the case
20479 of batched SMTP, the byte sequence written to the file is then an exact image
20480 of what would be sent down a real SMTP connection.
20481
20482 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20483 (which are used to supply the traditional &"From&~"& and blank line separators
20484 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20485 carriage return characters if these are needed. In cases where these options
20486 have non-empty defaults, the values end with a single linefeed, so they must be
20487 changed to end with &`\r\n`& if &%use_crlf%& is set.
20488
20489
20490 .option use_fcntl_lock appendfile boolean "see below"
20491 This option controls the use of the &[fcntl()]& function to lock a file for
20492 exclusive use when a message is being appended. It is set by default unless
20493 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20494 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20495 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20496
20497
20498 .option use_flock_lock appendfile boolean false
20499 This option is provided to support the use of &[flock()]& for file locking, for
20500 the few situations where it is needed. Most modern operating systems support
20501 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20502 each other. Exim uses &[fcntl()]& locking by default.
20503
20504 This option is required only if you are using an operating system where
20505 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20506 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20507 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20508
20509 .cindex "Solaris" "&[flock()]& support"
20510 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20511 have it (and some, I think, provide a not quite right version built on top of
20512 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20513 the ability to use it, and any attempt to do so will cause a configuration
20514 error.
20515
20516 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20517 is just being mapped onto &[fcntl()]& by the OS).
20518
20519
20520 .option use_lockfile appendfile boolean "see below"
20521 If this option is turned off, Exim does not attempt to create a lock file when
20522 appending to a mailbox file. In this situation, the only locking is by
20523 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20524 sure that every MUA that is ever going to look at your users' mailboxes uses
20525 &[fcntl()]& rather than a lock file, and even then only when you are not
20526 delivering over NFS from more than one host.
20527
20528 .cindex "NFS" "lock file"
20529 In order to append to an NFS file safely from more than one host, it is
20530 necessary to take out a lock &'before'& opening the file, and the lock file
20531 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20532 file corruption.
20533
20534 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20535 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20536 except when &%mbx_format%& is set.
20537
20538
20539 .option use_mbx_lock appendfile boolean "see below"
20540 This option is available only if Exim has been compiled with SUPPORT_MBX
20541 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20542 locking rules be used. It is set by default if &%mbx_format%& is set and none
20543 of the locking options are mentioned in the configuration. The locking rules
20544 are the same as are used by the &'c-client'& library that underlies Pine and
20545 the IMAP4 and POP daemons that come with it (see the discussion below). The
20546 rules allow for shared access to the mailbox. However, this kind of locking
20547 does not work when the mailbox is NFS mounted.
20548
20549 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20550 &%use_flock_lock%& to control what kind of locking is used in implementing the
20551 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20552 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20553
20554
20555
20556
20557 .section "Operational details for appending" "SECTopappend"
20558 .cindex "appending to a file"
20559 .cindex "file" "appending"
20560 Before appending to a file, the following preparations are made:
20561
20562 .ilist
20563 If the name of the file is &_/dev/null_&, no action is taken, and a success
20564 return is given.
20565
20566 .next
20567 .cindex "directory creation"
20568 If any directories on the file's path are missing, Exim creates them if the
20569 &%create_directory%& option is set. A created directory's mode is given by the
20570 &%directory_mode%& option.
20571
20572 .next
20573 If &%file_format%& is set, the format of an existing file is checked. If this
20574 indicates that a different transport should be used, control is passed to that
20575 transport.
20576
20577 .next
20578 .cindex "file" "locking"
20579 .cindex "locking files"
20580 .cindex "NFS" "lock file"
20581 If &%use_lockfile%& is set, a lock file is built in a way that will work
20582 reliably over NFS, as follows:
20583
20584 .olist
20585 Create a &"hitching post"& file whose name is that of the lock file with the
20586 current time, primary host name, and process id added, by opening for writing
20587 as a new file. If this fails with an access error, delivery is deferred.
20588 .next
20589 Close the hitching post file, and hard link it to the lock file name.
20590 .next
20591 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20592 Unlink the hitching post name.
20593 .next
20594 Otherwise, use &[stat()]& to get information about the hitching post file, and
20595 then unlink hitching post name. If the number of links is exactly two, creation
20596 of the lock file succeeded but something (for example, an NFS server crash and
20597 restart) caused this fact not to be communicated to the &[link()]& call.
20598 .next
20599 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20600 up to &%lock_retries%& times. However, since any program that writes to a
20601 mailbox should complete its task very quickly, it is reasonable to time out old
20602 lock files that are normally the result of user agent and system crashes. If an
20603 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20604 it before trying again.
20605 .endlist olist
20606
20607 .next
20608 A call is made to &[lstat()]& to discover whether the main file exists, and if
20609 so, what its characteristics are. If &[lstat()]& fails for any reason other
20610 than non-existence, delivery is deferred.
20611
20612 .next
20613 .cindex "symbolic link" "to mailbox"
20614 .cindex "mailbox" "symbolic link"
20615 If the file does exist and is a symbolic link, delivery is deferred, unless the
20616 &%allow_symlink%& option is set, in which case the ownership of the link is
20617 checked, and then &[stat()]& is called to find out about the real file, which
20618 is then subjected to the checks below. The check on the top-level link
20619 ownership prevents one user creating a link for another's mailbox in a sticky
20620 directory, though allowing symbolic links in this case is definitely not a good
20621 idea. If there is a chain of symbolic links, the intermediate ones are not
20622 checked.
20623
20624 .next
20625 If the file already exists but is not a regular file, or if the file's owner
20626 and group (if the group is being checked &-- see &%check_group%& above) are
20627 different from the user and group under which the delivery is running,
20628 delivery is deferred.
20629
20630 .next
20631 If the file's permissions are more generous than specified, they are reduced.
20632 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20633 is set false, in which case the delivery is tried using the existing
20634 permissions.
20635
20636 .next
20637 The file's inode number is saved, and the file is then opened for appending.
20638 If this fails because the file has vanished, &(appendfile)& behaves as if it
20639 hadn't existed (see below). For any other failures, delivery is deferred.
20640
20641 .next
20642 If the file is opened successfully, check that the inode number hasn't
20643 changed, that it is still a regular file, and that the owner and permissions
20644 have not changed. If anything is wrong, defer delivery and freeze the message.
20645
20646 .next
20647 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20648 option is set. Otherwise, check that the file is being created in a permitted
20649 directory if the &%create_file%& option is set (deferring on failure), and then
20650 open for writing as a new file, with the O_EXCL and O_CREAT options,
20651 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20652 set). In this case, which can happen if the link points to a non-existent file,
20653 the file is opened for writing using O_CREAT but not O_EXCL, because
20654 that prevents link following.
20655
20656 .next
20657 .cindex "loop" "while file testing"
20658 If opening fails because the file exists, obey the tests given above for
20659 existing files. However, to avoid looping in a situation where the file is
20660 being continuously created and destroyed, the exists/not-exists loop is broken
20661 after 10 repetitions, and the message is then frozen.
20662
20663 .next
20664 If opening fails with any other error, defer delivery.
20665
20666 .next
20667 .cindex "file" "locking"
20668 .cindex "locking files"
20669 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20670 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20671 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20672 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20673 file, and an exclusive lock on the file whose name is
20674 .code
20675 /tmp/.<device-number>.<inode-number>
20676 .endd
20677 using the device and inode numbers of the open mailbox file, in accordance with
20678 the MBX locking rules. This file is created with a mode that is specified by
20679 the &%lockfile_mode%& option.
20680
20681 If Exim fails to lock the file, there are two possible courses of action,
20682 depending on the value of the locking timeout. This is obtained from
20683 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20684
20685 If the timeout value is zero, the file is closed, Exim waits for
20686 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20687 to lock it again. This happens up to &%lock_retries%& times, after which the
20688 delivery is deferred.
20689
20690 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20691 &[flock()]& are used (with the given timeout), so there has already been some
20692 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20693 immediately. It retries up to
20694 .code
20695 (lock_retries * lock_interval) / <timeout>
20696 .endd
20697 times (rounded up).
20698 .endlist
20699
20700 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20701 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20702
20703
20704 .section "Operational details for delivery to a new file" "SECTopdir"
20705 .cindex "delivery" "to single file"
20706 .cindex "&""From""& line"
20707 When the &%directory%& option is set instead of &%file%&, each message is
20708 delivered into a newly-created file or set of files. When &(appendfile)& is
20709 activated directly from a &(redirect)& router, neither &%file%& nor
20710 &%directory%& is normally set, because the path for delivery is supplied by the
20711 router. (See for example, the &(address_file)& transport in the default
20712 configuration.) In this case, delivery is to a new file if either the path name
20713 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20714
20715 No locking is required while writing the message to a new file, so the various
20716 locking options of the transport are ignored. The &"From"& line that by default
20717 separates messages in a single file is not normally needed, nor is the escaping
20718 of message lines that start with &"From"&, and there is no need to ensure a
20719 newline at the end of each message. Consequently, the default values for
20720 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20721 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20722
20723 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20724 the files in the delivery directory by default. However, you can specify a
20725 different directory by setting &%quota_directory%&. Also, for maildir
20726 deliveries (see below) the &_maildirfolder_& convention is honoured.
20727
20728
20729 .cindex "maildir format"
20730 .cindex "mailstore format"
20731 There are three different ways in which delivery to individual files can be
20732 done, controlled by the settings of the &%maildir_format%& and
20733 &%mailstore_format%& options. Note that code to support maildir or mailstore
20734 formats is not included in the binary unless SUPPORT_MAILDIR or
20735 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20736
20737 .cindex "directory creation"
20738 In all three cases an attempt is made to create the directory and any necessary
20739 sub-directories if they do not exist, provided that the &%create_directory%&
20740 option is set (the default). The location of a created directory can be
20741 constrained by setting &%create_file%&. A created directory's mode is given by
20742 the &%directory_mode%& option. If creation fails, or if the
20743 &%create_directory%& option is not set when creation is required, delivery is
20744 deferred.
20745
20746
20747
20748 .section "Maildir delivery" "SECTmaildirdelivery"
20749 .cindex "maildir format" "description of"
20750 If the &%maildir_format%& option is true, Exim delivers each message by writing
20751 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20752 directory that is defined by the &%directory%& option (the &"delivery
20753 directory"&). If the delivery is successful, the file is renamed into the
20754 &_new_& subdirectory.
20755
20756 In the file name, <&'stime'&> is the current time of day in seconds, and
20757 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20758 Exim checks that the time-of-day clock has moved on by at least one microsecond
20759 before terminating the delivery process. This guarantees uniqueness for the
20760 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20761 opening it. If any response other than ENOENT (does not exist) is given,
20762 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20763
20764 Before Exim carries out a maildir delivery, it ensures that subdirectories
20765 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20766 do not exist, Exim tries to create them and any superior directories in their
20767 path, subject to the &%create_directory%& and &%create_file%& options. If the
20768 &%maildirfolder_create_regex%& option is set, and the regular expression it
20769 contains matches the delivery directory, Exim also ensures that a file called
20770 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20771 &_maildirfolder_& file cannot be created, delivery is deferred.
20772
20773 These features make it possible to use Exim to create all the necessary files
20774 and directories in a maildir mailbox, including subdirectories for maildir++
20775 folders. Consider this example:
20776 .code
20777 maildir_format = true
20778 directory = /var/mail/$local_part\
20779            ${if eq{$local_part_suffix}{}{}\
20780            {/.${substr_1:$local_part_suffix}}}
20781 maildirfolder_create_regex = /\.[^/]+$
20782 .endd
20783 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20784 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20785 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20786 not match this name, so Exim will not look for or create the file
20787 &_/var/mail/pimbo/maildirfolder_&, though it will create
20788 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20789
20790 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20791 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20792 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20793 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20794 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20795
20796 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20797 not inadvertently match the toplevel maildir directory, because a
20798 &_maildirfolder_& file at top level would completely break quota calculations.
20799
20800 .cindex "quota" "in maildir delivery"
20801 .cindex "maildir++"
20802 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20803 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20804 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20805 Exim assumes the directory is a maildir++ folder directory, which is one level
20806 down from the user's top level mailbox directory. This causes it to start at
20807 the parent directory instead of the current directory when calculating the
20808 amount of space used.
20809
20810 One problem with delivering into a multi-file mailbox is that it is
20811 computationally expensive to compute the size of the mailbox for quota
20812 checking. Various approaches have been taken to reduce the amount of work
20813 needed. The next two sections describe two of them. A third alternative is to
20814 use some external process for maintaining the size data, and use the expansion
20815 of the &%mailbox_size%& option as a way of importing it into Exim.
20816
20817
20818
20819
20820 .section "Using tags to record message sizes" "SECID135"
20821 If &%maildir_tag%& is set, the string is expanded for each delivery.
20822 When the maildir file is renamed into the &_new_& sub-directory, the
20823 tag is added to its name. However, if adding the tag takes the length of the
20824 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20825 the tag is dropped and the maildir file is created with no tag.
20826
20827
20828 .vindex "&$message_size$&"
20829 Tags can be used to encode the size of files in their names; see
20830 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20831 happens after the message has been written. The value of the &$message_size$&
20832 variable is set to the number of bytes actually written. If the expansion is
20833 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20834 be deferred. The expanded tag may contain any printing characters except &"/"&.
20835 Non-printing characters in the string are ignored; if the resulting string is
20836 empty, it is ignored. If it starts with an alphanumeric character, a leading
20837 colon is inserted; this default has not proven to be the path that popular
20838 maildir implementations have chosen (but changing it in Exim would break
20839 backwards compatibility).
20840
20841 For one common implementation, you might set:
20842 .code
20843 maildir_tag = ,S=${message_size}
20844 .endd
20845 but you should check the documentation of the other software to be sure.
20846
20847 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
20848 as this allows Exim to extract the size from your tag, instead of having to
20849 &[stat()]& each message file.
20850
20851
20852 .section "Using a maildirsize file" "SECID136"
20853 .cindex "quota" "in maildir delivery"
20854 .cindex "maildir format" "&_maildirsize_& file"
20855 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20856 storing quota and message size information in a file called &_maildirsize_&
20857 within the toplevel maildir directory. If this file does not exist, Exim
20858 creates it, setting the quota from the &%quota%& option of the transport. If
20859 the maildir directory itself does not exist, it is created before any attempt
20860 to write a &_maildirsize_& file.
20861
20862 The &_maildirsize_& file is used to hold information about the sizes of
20863 messages in the maildir, thus speeding up quota calculations. The quota value
20864 in the file is just a cache; if the quota is changed in the transport, the new
20865 value overrides the cached value when the next message is delivered. The cache
20866 is maintained for the benefit of other programs that access the maildir and
20867 need to know the quota.
20868
20869 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20870 file is maintained (with a zero quota setting), but no quota is imposed.
20871
20872 A regular expression is available for controlling which directories in the
20873 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20874 See the description of the &%maildir_quota_directory_regex%& option above for
20875 details.
20876
20877
20878 .section "Mailstore delivery" "SECID137"
20879 .cindex "mailstore format" "description of"
20880 If the &%mailstore_format%& option is true, each message is written as two
20881 files in the given directory. A unique base name is constructed from the
20882 message id and the current delivery process, and the files that are written use
20883 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20884 contains the message's envelope, and the &_.msg_& file contains the message
20885 itself. The base name is placed in the variable &$mailstore_basename$&.
20886
20887 During delivery, the envelope is first written to a file with the suffix
20888 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20889 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20890 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20891 file before accessing either of them. An alternative approach is to wait for
20892 the absence of a &_.tmp_& file.
20893
20894 The envelope file starts with any text defined by the &%mailstore_prefix%&
20895 option, expanded and terminated by a newline if there isn't one. Then follows
20896 the sender address on one line, then all the recipient addresses, one per line.
20897 There can be more than one recipient only if the &%batch_max%& option is set
20898 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20899 appended to the file, followed by a newline if it does not end with one.
20900
20901 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20902 failure, it is ignored. Other expansion errors are treated as serious
20903 configuration errors, and delivery is deferred. The variable
20904 &$mailstore_basename$& is available for use during these expansions.
20905
20906
20907 .section "Non-special new file delivery" "SECID138"
20908 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20909 file is created directly in the named directory. For example, when delivering
20910 messages into files in batched SMTP format for later delivery to some host (see
20911 section &<<SECTbatchSMTP>>&), a setting such as
20912 .code
20913 directory = /var/bsmtp/$host
20914 .endd
20915 might be used. A message is written to a file with a temporary name, which is
20916 then renamed when the delivery is complete. The final name is obtained by
20917 expanding the contents of the &%directory_file%& option.
20918 .ecindex IIDapptra1
20919 .ecindex IIDapptra2
20920
20921
20922
20923
20924
20925
20926 . ////////////////////////////////////////////////////////////////////////////
20927 . ////////////////////////////////////////////////////////////////////////////
20928
20929 .chapter "The autoreply transport" "CHID8"
20930 .scindex IIDauttra1 "transports" "&(autoreply)&"
20931 .scindex IIDauttra2 "&(autoreply)& transport"
20932 The &(autoreply)& transport is not a true transport in that it does not cause
20933 the message to be transmitted. Instead, it generates a new mail message as an
20934 automatic reply to the incoming message. &'References:'& and
20935 &'Auto-Submitted:'& header lines are included. These are constructed according
20936 to the rules in RFCs 2822 and 3834, respectively.
20937
20938 If the router that passes the message to this transport does not have the
20939 &%unseen%& option set, the original message (for the current recipient) is not
20940 delivered anywhere. However, when the &%unseen%& option is set on the router
20941 that passes the message to this transport, routing of the address continues, so
20942 another router can set up a normal message delivery.
20943
20944
20945 The &(autoreply)& transport is usually run as the result of mail filtering, a
20946 &"vacation"& message being the standard example. However, it can also be run
20947 directly from a router like any other transport. To reduce the possibility of
20948 message cascades, messages created by the &(autoreply)& transport always have
20949 empty envelope sender addresses, like bounce messages.
20950
20951 The parameters of the message to be sent can be specified in the configuration
20952 by options described below. However, these are used only when the address
20953 passed to the transport does not contain its own reply information. When the
20954 transport is run as a consequence of a
20955 &%mail%&
20956 or &%vacation%& command in a filter file, the parameters of the message are
20957 supplied by the filter, and passed with the address. The transport's options
20958 that define the message are then ignored (so they are not usually set in this
20959 case). The message is specified entirely by the filter or by the transport; it
20960 is never built from a mixture of options. However, the &%file_optional%&,
20961 &%mode%&, and &%return_message%& options apply in all cases.
20962
20963 &(Autoreply)& is implemented as a local transport. When used as a result of a
20964 command in a user's filter file, &(autoreply)& normally runs under the uid and
20965 gid of the user, and with appropriate current and home directories (see chapter
20966 &<<CHAPenvironment>>&).
20967
20968 There is a subtle difference between routing a message to a &(pipe)& transport
20969 that generates some text to be returned to the sender, and routing it to an
20970 &(autoreply)& transport. This difference is noticeable only if more than one
20971 address from the same message is so handled. In the case of a pipe, the
20972 separate outputs from the different addresses are gathered up and returned to
20973 the sender in a single message, whereas if &(autoreply)& is used, a separate
20974 message is generated for each address that is passed to it.
20975
20976 Non-printing characters are not permitted in the header lines generated for the
20977 message that &(autoreply)& creates, with the exception of newlines that are
20978 immediately followed by white space. If any non-printing characters are found,
20979 the transport defers.
20980 Whether characters with the top bit set count as printing characters or not is
20981 controlled by the &%print_topbitchars%& global option.
20982
20983 If any of the generic options for manipulating headers (for example,
20984 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20985 of the original message that is included in the generated message when
20986 &%return_message%& is set. They do not apply to the generated message itself.
20987
20988 .vindex "&$sender_address$&"
20989 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20990 the message, indicating that there were no recipients, it does not treat this
20991 as an error. This means that autoreplies sent to &$sender_address$& when this
20992 is empty (because the incoming message is a bounce message) do not cause
20993 problems. They are just discarded.
20994
20995
20996
20997 .section "Private options for autoreply" "SECID139"
20998 .cindex "options" "&(autoreply)& transport"
20999
21000 .option bcc autoreply string&!! unset
21001 This specifies the addresses that are to receive &"blind carbon copies"& of the
21002 message when the message is specified by the transport.
21003
21004
21005 .option cc autoreply string&!! unset
21006 This specifies recipients of the message and the contents of the &'Cc:'& header
21007 when the message is specified by the transport.
21008
21009
21010 .option file autoreply string&!! unset
21011 The contents of the file are sent as the body of the message when the message
21012 is specified by the transport. If both &%file%& and &%text%& are set, the text
21013 string comes first.
21014
21015
21016 .option file_expand autoreply boolean false
21017 If this is set, the contents of the file named by the &%file%& option are
21018 subjected to string expansion as they are added to the message.
21019
21020
21021 .option file_optional autoreply boolean false
21022 If this option is true, no error is generated if the file named by the &%file%&
21023 option or passed with the address does not exist or cannot be read.
21024
21025
21026 .option from autoreply string&!! unset
21027 This specifies the contents of the &'From:'& header when the message is
21028 specified by the transport.
21029
21030
21031 .option headers autoreply string&!! unset
21032 This specifies additional RFC 2822 headers that are to be added to the message
21033 when the message is specified by the transport. Several can be given by using
21034 &"\n"& to separate them. There is no check on the format.
21035
21036
21037 .option log autoreply string&!! unset
21038 This option names a file in which a record of every message sent is logged when
21039 the message is specified by the transport.
21040
21041
21042 .option mode autoreply "octal integer" 0600
21043 If either the log file or the &"once"& file has to be created, this mode is
21044 used.
21045
21046
21047 .option never_mail autoreply "address list&!!" unset
21048 If any run of the transport creates a message with a recipient that matches any
21049 item in the list, that recipient is quietly discarded. If all recipients are
21050 discarded, no message is created. This applies both when the recipients are
21051 generated by a filter and when they are specified in the transport.
21052
21053
21054
21055 .option once autoreply string&!! unset
21056 This option names a file or DBM database in which a record of each &'To:'&
21057 recipient is kept when the message is specified by the transport. &*Note*&:
21058 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21059
21060 If &%once%& is unset, or is set to an empty string, the message is always sent.
21061 By default, if &%once%& is set to a non-empty file name, the message
21062 is not sent if a potential recipient is already listed in the database.
21063 However, if the &%once_repeat%& option specifies a time greater than zero, the
21064 message is sent if that much time has elapsed since a message was last sent to
21065 this recipient. A setting of zero time for &%once_repeat%& (the default)
21066 prevents a message from being sent a second time &-- in this case, zero means
21067 infinity.
21068
21069 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21070 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21071 greater than zero, it changes the way Exim implements the &%once%& option.
21072 Instead of using a DBM file to record every recipient it sends to, it uses a
21073 regular file, whose size will never get larger than the given value.
21074
21075 In the file, Exim keeps a linear list of recipient addresses and the times at
21076 which they were sent messages. If the file is full when a new address needs to
21077 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21078 means that a given recipient may receive multiple messages, but at
21079 unpredictable intervals that depend on the rate of turnover of addresses in the
21080 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21081
21082
21083 .option once_file_size autoreply integer 0
21084 See &%once%& above.
21085
21086
21087 .option once_repeat autoreply time&!! 0s
21088 See &%once%& above.
21089 After expansion, the value of this option must be a valid time value.
21090
21091
21092 .option reply_to autoreply string&!! unset
21093 This specifies the contents of the &'Reply-To:'& header when the message is
21094 specified by the transport.
21095
21096
21097 .option return_message autoreply boolean false
21098 If this is set, a copy of the original message is returned with the new
21099 message, subject to the maximum size set in the &%return_size_limit%& global
21100 configuration option.
21101
21102
21103 .option subject autoreply string&!! unset
21104 This specifies the contents of the &'Subject:'& header when the message is
21105 specified by the transport. It is tempting to quote the original subject in
21106 automatic responses. For example:
21107 .code
21108 subject = Re: $h_subject:
21109 .endd
21110 There is a danger in doing this, however. It may allow a third party to
21111 subscribe your users to an opt-in mailing list, provided that the list accepts
21112 bounce messages as subscription confirmations. Well-managed lists require a
21113 non-bounce message to confirm a subscription, so the danger is relatively
21114 small.
21115
21116
21117
21118 .option text autoreply string&!! unset
21119 This specifies a single string to be used as the body of the message when the
21120 message is specified by the transport. If both &%text%& and &%file%& are set,
21121 the text comes first.
21122
21123
21124 .option to autoreply string&!! unset
21125 This specifies recipients of the message and the contents of the &'To:'& header
21126 when the message is specified by the transport.
21127 .ecindex IIDauttra1
21128 .ecindex IIDauttra2
21129
21130
21131
21132
21133 . ////////////////////////////////////////////////////////////////////////////
21134 . ////////////////////////////////////////////////////////////////////////////
21135
21136 .chapter "The lmtp transport" "CHAPLMTP"
21137 .cindex "transports" "&(lmtp)&"
21138 .cindex "&(lmtp)& transport"
21139 .cindex "LMTP" "over a pipe"
21140 .cindex "LMTP" "over a socket"
21141 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21142 specified command
21143 or by interacting with a Unix domain socket.
21144 This transport is something of a cross between the &(pipe)& and &(smtp)&
21145 transports. Exim also has support for using LMTP over TCP/IP; this is
21146 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21147 to be of minority interest, the default build-time configure in &_src/EDITME_&
21148 has it commented out. You need to ensure that
21149 .code
21150 TRANSPORT_LMTP=yes
21151 .endd
21152 .cindex "options" "&(lmtp)& transport"
21153 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21154 included in the Exim binary. The private options of the &(lmtp)& transport are
21155 as follows:
21156
21157 .option batch_id lmtp string&!! unset
21158 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21159
21160
21161 .option batch_max lmtp integer 1
21162 This limits the number of addresses that can be handled in a single delivery.
21163 Most LMTP servers can handle several addresses at once, so it is normally a
21164 good idea to increase this value. See the description of local delivery
21165 batching in chapter &<<CHAPbatching>>&.
21166
21167
21168 .option command lmtp string&!! unset
21169 This option must be set if &%socket%& is not set. The string is a command which
21170 is run in a separate process. It is split up into a command name and list of
21171 arguments, each of which is separately expanded (so expansion cannot change the
21172 number of arguments). The command is run directly, not via a shell. The message
21173 is passed to the new process using the standard input and output to operate the
21174 LMTP protocol.
21175
21176 .option ignore_quota lmtp boolean false
21177 .cindex "LMTP" "ignoring quota errors"
21178 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21179 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21180 in its response to the LHLO command.
21181
21182 .option socket lmtp string&!! unset
21183 This option must be set if &%command%& is not set. The result of expansion must
21184 be the name of a Unix domain socket. The transport connects to the socket and
21185 delivers the message to it using the LMTP protocol.
21186
21187
21188 .option timeout lmtp time 5m
21189 The transport is aborted if the created process or Unix domain socket does not
21190 respond to LMTP commands or message input within this timeout. Delivery
21191 is deferred, and will be tried again later. Here is an example of a typical
21192 LMTP transport:
21193 .code
21194 lmtp:
21195   driver = lmtp
21196   command = /some/local/lmtp/delivery/program
21197   batch_max = 20
21198   user = exim
21199 .endd
21200 This delivers up to 20 addresses at a time, in a mixture of domains if
21201 necessary, running as the user &'exim'&.
21202
21203
21204
21205 . ////////////////////////////////////////////////////////////////////////////
21206 . ////////////////////////////////////////////////////////////////////////////
21207
21208 .chapter "The pipe transport" "CHAPpipetransport"
21209 .scindex IIDpiptra1 "transports" "&(pipe)&"
21210 .scindex IIDpiptra2 "&(pipe)& transport"
21211 The &(pipe)& transport is used to deliver messages via a pipe to a command
21212 running in another process. One example is the use of &(pipe)& as a
21213 pseudo-remote transport for passing messages to some other delivery mechanism
21214 (such as UUCP). Another is the use by individual users to automatically process
21215 their incoming messages. The &(pipe)& transport can be used in one of the
21216 following ways:
21217
21218 .ilist
21219 .vindex "&$local_part$&"
21220 A router routes one address to a transport in the normal way, and the
21221 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21222 contains the local part of the address (as usual), and the command that is run
21223 is specified by the &%command%& option on the transport.
21224 .next
21225 .vindex "&$pipe_addresses$&"
21226 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21227 transport can handle more than one address in a single run. In this case, when
21228 more than one address is routed to the transport, &$local_part$& is not set
21229 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21230 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21231 that are routed to the transport.
21232 .next
21233 .vindex "&$address_pipe$&"
21234 A router redirects an address directly to a pipe command (for example, from an
21235 alias or forward file). In this case, &$address_pipe$& contains the text of the
21236 pipe command, and the &%command%& option on the transport is ignored. If only
21237 one address is being transported (&%batch_max%& is not greater than one, or
21238 only one address was redirected to this pipe command), &$local_part$& contains
21239 the local part that was redirected.
21240 .endlist
21241
21242
21243 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21244 deliver messages over pipes using the LMTP interactive protocol. This is
21245 implemented by the &(lmtp)& transport.
21246
21247 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21248 &_.forward_& file, the command runs under the uid and gid of that user. In
21249 other cases, the uid and gid have to be specified explicitly, either on the
21250 transport or on the router that handles the address. Current and &"home"&
21251 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21252 details of the local delivery environment and chapter &<<CHAPbatching>>&
21253 for a discussion of local delivery batching.
21254
21255
21256 .section "Concurrent delivery" "SECID140"
21257 If two messages arrive at almost the same time, and both are routed to a pipe
21258 delivery, the two pipe transports may be run concurrently. You must ensure that
21259 any pipe commands you set up are robust against this happening. If the commands
21260 write to a file, the &%exim_lock%& utility might be of use.
21261
21262
21263
21264
21265 .section "Returned status and data" "SECID141"
21266 .cindex "&(pipe)& transport" "returned data"
21267 If the command exits with a non-zero return code, the delivery is deemed to
21268 have failed, unless either the &%ignore_status%& option is set (in which case
21269 the return code is treated as zero), or the return code is one of those listed
21270 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21271 later"&. In this case, delivery is deferred. Details of a permanent failure are
21272 logged, but are not included in the bounce message, which merely contains
21273 &"local delivery failed"&.
21274
21275 If the command exits on a signal and the &%freeze_signal%& option is set then
21276 the message will be frozen in the queue. If that option is not set, a bounce
21277 will be sent as normal.
21278
21279 If the return code is greater than 128 and the command being run is a shell
21280 script, it normally means that the script was terminated by a signal whose
21281 value is the return code minus 128. The &%freeze_signal%& option does not
21282 apply in this case.
21283
21284 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21285 return code is set to 127. This is the value that a shell returns if it is
21286 asked to run a non-existent command. The wording for the log line suggests that
21287 a non-existent command may be the problem.
21288
21289 The &%return_output%& option can affect the result of a pipe delivery. If it is
21290 set and the command produces any output on its standard output or standard
21291 error streams, the command is considered to have failed, even if it gave a zero
21292 return code or if &%ignore_status%& is set. The output from the command is
21293 included as part of the bounce message. The &%return_fail_output%& option is
21294 similar, except that output is returned only when the command exits with a
21295 failure return code, that is, a value other than zero or a code that matches
21296 &%temp_errors%&.
21297
21298
21299
21300 .section "How the command is run" "SECThowcommandrun"
21301 .cindex "&(pipe)& transport" "path for command"
21302 The command line is (by default) broken down into a command name and arguments
21303 by the &(pipe)& transport itself. The &%allow_commands%& and
21304 &%restrict_to_path%& options can be used to restrict the commands that may be
21305 run.
21306
21307 .cindex "quoting" "in pipe command"
21308 Unquoted arguments are delimited by white space. If an argument appears in
21309 double quotes, backslash is interpreted as an escape character in the usual
21310 way. If an argument appears in single quotes, no escaping is done.
21311
21312 String expansion is applied to the command line except when it comes from a
21313 traditional &_.forward_& file (commands from a filter file are expanded). The
21314 expansion is applied to each argument in turn rather than to the whole line.
21315 For this reason, any string expansion item that contains white space must be
21316 quoted so as to be contained within a single argument. A setting such as
21317 .code
21318 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21319 .endd
21320 will not work, because the expansion item gets split between several
21321 arguments. You have to write
21322 .code
21323 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21324 .endd
21325 to ensure that it is all in one argument. The expansion is done in this way,
21326 argument by argument, so that the number of arguments cannot be changed as a
21327 result of expansion, and quotes or backslashes in inserted variables do not
21328 interact with external quoting. However, this leads to problems if you want to
21329 generate multiple arguments (or the command name plus arguments) from a single
21330 expansion. In this situation, the simplest solution is to use a shell. For
21331 example:
21332 .code
21333 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21334 .endd
21335
21336 .cindex "transport" "filter"
21337 .cindex "filter" "transport filter"
21338 .vindex "&$pipe_addresses$&"
21339 Special handling takes place when an argument consists of precisely the text
21340 &`$pipe_addresses`&. This is not a general expansion variable; the only
21341 place this string is recognized is when it appears as an argument for a pipe or
21342 transport filter command. It causes each address that is being handled to be
21343 inserted in the argument list at that point &'as a separate argument'&. This
21344 avoids any problems with spaces or shell metacharacters, and is of use when a
21345 &(pipe)& transport is handling groups of addresses in a batch.
21346
21347 After splitting up into arguments and expansion, the resulting command is run
21348 in a subprocess directly from the transport, &'not'& under a shell. The
21349 message that is being delivered is supplied on the standard input, and the
21350 standard output and standard error are both connected to a single pipe that is
21351 read by Exim. The &%max_output%& option controls how much output the command
21352 may produce, and the &%return_output%& and &%return_fail_output%& options
21353 control what is done with it.
21354
21355 Not running the command under a shell (by default) lessens the security risks
21356 in cases when a command from a user's filter file is built out of data that was
21357 taken from an incoming message. If a shell is required, it can of course be
21358 explicitly specified as the command to be run. However, there are circumstances
21359 where existing commands (for example, in &_.forward_& files) expect to be run
21360 under a shell and cannot easily be modified. To allow for these cases, there is
21361 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21362 works. Instead of breaking up the command line as just described, it expands it
21363 as a single string and passes the result to &_/bin/sh_&. The
21364 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21365 with &%use_shell%&, and the whole mechanism is inherently less secure.
21366
21367
21368
21369 .section "Environment variables" "SECTpipeenv"
21370 .cindex "&(pipe)& transport" "environment for command"
21371 .cindex "environment for pipe transport"
21372 The environment variables listed below are set up when the command is invoked.
21373 This list is a compromise for maximum compatibility with other MTAs. Note that
21374 the &%environment%& option can be used to add additional variables to this
21375 environment.
21376 .display
21377 &`DOMAIN            `&   the domain of the address
21378 &`HOME              `&   the home directory, if set
21379 &`HOST              `&   the host name when called from a router (see below)
21380 &`LOCAL_PART        `&   see below
21381 &`LOCAL_PART_PREFIX `&   see below
21382 &`LOCAL_PART_SUFFIX `&   see below
21383 &`LOGNAME           `&   see below
21384 &`MESSAGE_ID        `&   Exim's local ID for the message
21385 &`PATH              `&   as specified by the &%path%& option below
21386 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21387 &`RECIPIENT         `&   the complete recipient address
21388 &`SENDER            `&   the sender of the message (empty if a bounce)
21389 &`SHELL             `&   &`/bin/sh`&
21390 &`TZ                `&   the value of the &%timezone%& option, if set
21391 &`USER              `&   see below
21392 .endd
21393 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21394 router, LOCAL_PART is set to the local part of the address. When it is
21395 called as a result of a forward or alias expansion, LOCAL_PART is set to
21396 the local part of the address that was expanded. In both cases, any affixes are
21397 removed from the local part, and made available in LOCAL_PART_PREFIX and
21398 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21399 same value as LOCAL_PART for compatibility with other MTAs.
21400
21401 .cindex "HOST"
21402 HOST is set only when a &(pipe)& transport is called from a router that
21403 associates hosts with an address, typically when using &(pipe)& as a
21404 pseudo-remote transport. HOST is set to the first host name specified by
21405 the router.
21406
21407 .cindex "HOME"
21408 If the transport's generic &%home_directory%& option is set, its value is used
21409 for the HOME environment variable. Otherwise, a home directory may be set
21410 by the router's &%transport_home_directory%& option, which defaults to the
21411 user's home directory if &%check_local_user%& is set.
21412
21413
21414 .section "Private options for pipe" "SECID142"
21415 .cindex "options" "&(pipe)& transport"
21416
21417
21418
21419 .option allow_commands pipe "string list&!!" unset
21420 .cindex "&(pipe)& transport" "permitted commands"
21421 The string is expanded, and is then interpreted as a colon-separated list of
21422 permitted commands. If &%restrict_to_path%& is not set, the only commands
21423 permitted are those in the &%allow_commands%& list. They need not be absolute
21424 paths; the &%path%& option is still used for relative paths. If
21425 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21426 in the &%allow_commands%& list, or a name without any slashes that is found on
21427 the path. In other words, if neither &%allow_commands%& nor
21428 &%restrict_to_path%& is set, there is no restriction on the command, but
21429 otherwise only commands that are permitted by one or the other are allowed. For
21430 example, if
21431 .code
21432 allow_commands = /usr/bin/vacation
21433 .endd
21434 and &%restrict_to_path%& is not set, the only permitted command is
21435 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21436 &%use_shell%& is set.
21437
21438
21439 .option batch_id pipe string&!! unset
21440 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21441
21442
21443 .option batch_max pipe integer 1
21444 This limits the number of addresses that can be handled in a single delivery.
21445 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21446
21447
21448 .option check_string pipe string unset
21449 As &(pipe)& writes the message, the start of each line is tested for matching
21450 &%check_string%&, and if it does, the initial matching characters are replaced
21451 by the contents of &%escape_string%&, provided both are set. The value of
21452 &%check_string%& is a literal string, not a regular expression, and the case of
21453 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21454 of &%check_string%& and &%escape_string%& are forced to values that implement
21455 the SMTP escaping protocol. Any settings made in the configuration file are
21456 ignored.
21457
21458
21459 .option command pipe string&!! unset
21460 This option need not be set when &(pipe)& is being used to deliver to pipes
21461 obtained directly from address redirections. In other cases, the option must be
21462 set, to provide a command to be run. It need not yield an absolute path (see
21463 the &%path%& option below). The command is split up into separate arguments by
21464 Exim, and each argument is separately expanded, as described in section
21465 &<<SECThowcommandrun>>& above.
21466
21467
21468 .option environment pipe string&!! unset
21469 .cindex "&(pipe)& transport" "environment for command"
21470 .cindex "environment for &(pipe)& transport"
21471 This option is used to add additional variables to the environment in which the
21472 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21473 a string which is expanded, and then interpreted as a colon-separated list of
21474 environment settings of the form <&'name'&>=<&'value'&>.
21475
21476
21477 .option escape_string pipe string unset
21478 See &%check_string%& above.
21479
21480
21481 .option freeze_exec_fail pipe boolean false
21482 .cindex "exec failure"
21483 .cindex "failure of exec"
21484 .cindex "&(pipe)& transport" "failure of exec"
21485 Failure to exec the command in a pipe transport is by default treated like
21486 any other failure while running the command. However, if &%freeze_exec_fail%&
21487 is set, failure to exec is treated specially, and causes the message to be
21488 frozen, whatever the setting of &%ignore_status%&.
21489
21490
21491 .option freeze_signal pipe boolean false
21492 .cindex "signal exit"
21493 .cindex "&(pipe)& transport", "signal exit"
21494 Normally if the process run by a command in a pipe transport exits on a signal,
21495 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21496 frozen in Exim's queue instead.
21497
21498
21499 .option ignore_status pipe boolean false
21500 If this option is true, the status returned by the subprocess that is set up to
21501 run the command is ignored, and Exim behaves as if zero had been returned.
21502 Otherwise, a non-zero status or termination by signal causes an error return
21503 from the transport unless the status value is one of those listed in
21504 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21505
21506 &*Note*&: This option does not apply to timeouts, which do not return a status.
21507 See the &%timeout_defer%& option for how timeouts are handled.
21508
21509 .option log_defer_output pipe boolean false
21510 .cindex "&(pipe)& transport" "logging output"
21511 If this option is set, and the status returned by the command is
21512 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21513 and any output was produced, the first line of it is written to the main log.
21514
21515
21516 .option log_fail_output pipe boolean false
21517 If this option is set, and the command returns any output, and also ends with a
21518 return code that is neither zero nor one of the return codes listed in
21519 &%temp_errors%& (that is, the delivery failed), the first line of output is
21520 written to the main log. This option and &%log_output%& are mutually exclusive.
21521 Only one of them may be set.
21522
21523
21524
21525 .option log_output pipe boolean false
21526 If this option is set and the command returns any output, the first line of
21527 output is written to the main log, whatever the return code. This option and
21528 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21529
21530
21531
21532 .option max_output pipe integer 20K
21533 This specifies the maximum amount of output that the command may produce on its
21534 standard output and standard error file combined. If the limit is exceeded, the
21535 process running the command is killed. This is intended as a safety measure to
21536 catch runaway processes. The limit is applied independently of the settings of
21537 the options that control what is done with such output (for example,
21538 &%return_output%&). Because of buffering effects, the amount of output may
21539 exceed the limit by a small amount before Exim notices.
21540
21541
21542 .option message_prefix pipe string&!! "see below"
21543 The string specified here is expanded and output at the start of every message.
21544 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21545 .code
21546 message_prefix = \
21547   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21548   ${tod_bsdinbox}\n
21549 .endd
21550 .cindex "Cyrus"
21551 .cindex "&%tmail%&"
21552 .cindex "&""From""& line"
21553 This is required by the commonly used &_/usr/bin/vacation_& program.
21554 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21555 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21556 setting
21557 .code
21558 message_prefix =
21559 .endd
21560 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21561 &`\n`& to &`\r\n`& in &%message_prefix%&.
21562
21563
21564 .option message_suffix pipe string&!! "see below"
21565 The string specified here is expanded and output at the end of every message.
21566 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21567 The suffix can be suppressed by setting
21568 .code
21569 message_suffix =
21570 .endd
21571 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21572 &`\n`& to &`\r\n`& in &%message_suffix%&.
21573
21574
21575 .option path pipe string "see below"
21576 This option specifies the string that is set up in the PATH environment
21577 variable of the subprocess. The default is:
21578 .code
21579 /bin:/usr/bin
21580 .endd
21581 If the &%command%& option does not yield an absolute path name, the command is
21582 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21583 apply to a command specified as a transport filter.
21584
21585
21586 .option permit_coredump pipe boolean false
21587 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21588 a core-dump of a pipe command, enable this command.  This enables core-dumps
21589 during delivery and affects both the Exim binary and the pipe command run.
21590 It is recommended that this option remain off unless and until you have a need
21591 for it and that this only be enabled when needed, as the risk of excessive
21592 resource consumption can be quite high.  Note also that Exim is typically
21593 installed as a setuid binary and most operating systems will inhibit coredumps
21594 of these by default, so further OS-specific action may be required.
21595
21596
21597 .option pipe_as_creator pipe boolean false
21598 .cindex "uid (user id)" "local delivery"
21599 If the generic &%user%& option is not set and this option is true, the delivery
21600 process is run under the uid that was in force when Exim was originally called
21601 to accept the message. If the group id is not otherwise set (via the generic
21602 &%group%& option), the gid that was in force when Exim was originally called to
21603 accept the message is used.
21604
21605
21606 .option restrict_to_path pipe boolean false
21607 When this option is set, any command name not listed in &%allow_commands%& must
21608 contain no slashes. The command is searched for only in the directories listed
21609 in the &%path%& option. This option is intended for use in the case when a pipe
21610 command has been generated from a user's &_.forward_& file. This is usually
21611 handled by a &(pipe)& transport called &%address_pipe%&.
21612
21613
21614 .option return_fail_output pipe boolean false
21615 If this option is true, and the command produced any output and ended with a
21616 return code other than zero or one of the codes listed in &%temp_errors%& (that
21617 is, the delivery failed), the output is returned in the bounce message.
21618 However, if the message has a null sender (that is, it is itself a bounce
21619 message), output from the command is discarded. This option and
21620 &%return_output%& are mutually exclusive. Only one of them may be set.
21621
21622
21623
21624 .option return_output pipe boolean false
21625 If this option is true, and the command produced any output, the delivery is
21626 deemed to have failed whatever the return code from the command, and the output
21627 is returned in the bounce message. Otherwise, the output is just discarded.
21628 However, if the message has a null sender (that is, it is a bounce message),
21629 output from the command is always discarded, whatever the setting of this
21630 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21631 of them may be set.
21632
21633
21634
21635 .option temp_errors pipe "string list" "see below"
21636 .cindex "&(pipe)& transport" "temporary failure"
21637 This option contains either a colon-separated list of numbers, or a single
21638 asterisk. If &%ignore_status%& is false
21639 and &%return_output%& is not set,
21640 and the command exits with a non-zero return code, the failure is treated as
21641 temporary and the delivery is deferred if the return code matches one of the
21642 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21643 codes are treated as permanent errors. The default setting contains the codes
21644 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21645 compiled on a system that does not define these macros, it assumes values of 75
21646 and 73, respectively.
21647
21648
21649 .option timeout pipe time 1h
21650 If the command fails to complete within this time, it is killed. This normally
21651 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21652 specifies no timeout. In order to ensure that any subprocesses created by the
21653 command are also killed, Exim makes the initial process a process group leader,
21654 and kills the whole process group on a timeout. However, this can be defeated
21655 if one of the processes starts a new process group.
21656
21657 .option timeout_defer pipe boolean false
21658 A timeout in a &(pipe)& transport, either in the command that the transport
21659 runs, or in a transport filter that is associated with it, is by default
21660 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21661 is set true, both kinds of timeout become temporary errors, causing the
21662 delivery to be deferred.
21663
21664 .option umask pipe "octal integer" 022
21665 This specifies the umask setting for the subprocess that runs the command.
21666
21667
21668 .option use_bsmtp pipe boolean false
21669 .cindex "envelope sender"
21670 If this option is set true, the &(pipe)& transport writes messages in &"batch
21671 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21672 commands. If you want to include a leading HELO command with such messages,
21673 you can do so by setting the &%message_prefix%& option. See section
21674 &<<SECTbatchSMTP>>& for details of batch SMTP.
21675
21676 .option use_classresources pipe boolean false
21677 .cindex "class resources (BSD)"
21678 This option is available only when Exim is running on FreeBSD, NetBSD, or
21679 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21680 resource limits when a &(pipe)& transport is run to perform a delivery. The
21681 limits for the uid under which the pipe is to run are obtained from the login
21682 class database.
21683
21684
21685 .option use_crlf pipe boolean false
21686 .cindex "carriage return"
21687 .cindex "linefeed"
21688 This option causes lines to be terminated with the two-character CRLF sequence
21689 (carriage return, linefeed) instead of just a linefeed character. In the case
21690 of batched SMTP, the byte sequence written to the pipe is then an exact image
21691 of what would be sent down a real SMTP connection.
21692
21693 The contents of the &%message_prefix%& and &%message_suffix%& options are
21694 written verbatim, so must contain their own carriage return characters if these
21695 are needed. When &%use_bsmtp%& is not set, the default values for both
21696 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21697 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21698
21699
21700 .option use_shell pipe boolean false
21701 .vindex "&$pipe_addresses$&"
21702 If this option is set, it causes the command to be passed to &_/bin/sh_&
21703 instead of being run directly from the transport, as described in section
21704 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21705 where the command is expected to be run under a shell and cannot easily be
21706 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21707 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21708 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21709 its &%-c%& option.
21710
21711
21712
21713 .section "Using an external local delivery agent" "SECID143"
21714 .cindex "local delivery" "using an external agent"
21715 .cindex "&'procmail'&"
21716 .cindex "external local delivery"
21717 .cindex "delivery" "&'procmail'&"
21718 .cindex "delivery" "by external agent"
21719 The &(pipe)& transport can be used to pass all messages that require local
21720 delivery to a separate local delivery agent such as &%procmail%&. When doing
21721 this, care must be taken to ensure that the pipe is run under an appropriate
21722 uid and gid. In some configurations one wants this to be a uid that is trusted
21723 by the delivery agent to supply the correct sender of the message. It may be
21724 necessary to recompile or reconfigure the delivery agent so that it trusts an
21725 appropriate user. The following is an example transport and router
21726 configuration for &%procmail%&:
21727 .code
21728 # transport
21729 procmail_pipe:
21730   driver = pipe
21731   command = /usr/local/bin/procmail -d $local_part
21732   return_path_add
21733   delivery_date_add
21734   envelope_to_add
21735   check_string = "From "
21736   escape_string = ">From "
21737   umask = 077
21738   user = $local_part
21739   group = mail
21740
21741 # router
21742 procmail:
21743   driver = accept
21744   check_local_user
21745   transport = procmail_pipe
21746 .endd
21747 In this example, the pipe is run as the local user, but with the group set to
21748 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21749 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21750 user to supply a correct sender address. If you do not specify either a
21751 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21752 home directory is the user's home directory by default.
21753
21754 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21755 .code
21756 IFS=" "
21757 .endd
21758 as shown in some &%procmail%& documentation, because Exim does not by default
21759 use a shell to run pipe commands.
21760
21761 .cindex "Cyrus"
21762 The next example shows a transport and a router for a system where local
21763 deliveries are handled by the Cyrus IMAP server.
21764 .code
21765 # transport
21766 local_delivery_cyrus:
21767   driver = pipe
21768   command = /usr/cyrus/bin/deliver \
21769             -m ${substr_1:$local_part_suffix} -- $local_part
21770   user = cyrus
21771   group = mail
21772   return_output
21773   log_output
21774   message_prefix =
21775   message_suffix =
21776
21777 # router
21778 local_user_cyrus:
21779   driver = accept
21780   check_local_user
21781   local_part_suffix = .*
21782   transport = local_delivery_cyrus
21783 .endd
21784 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21785 &%return_output%& to cause any text written by Cyrus to be returned to the
21786 sender.
21787 .ecindex IIDpiptra1
21788 .ecindex IIDpiptra2
21789
21790
21791 . ////////////////////////////////////////////////////////////////////////////
21792 . ////////////////////////////////////////////////////////////////////////////
21793
21794 .chapter "The smtp transport" "CHAPsmtptrans"
21795 .scindex IIDsmttra1 "transports" "&(smtp)&"
21796 .scindex IIDsmttra2 "&(smtp)& transport"
21797 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21798 or LMTP protocol. The list of hosts to try can either be taken from the address
21799 that is being processed (having been set up by the router), or specified
21800 explicitly for the transport. Timeout and retry processing (see chapter
21801 &<<CHAPretry>>&) is applied to each IP address independently.
21802
21803
21804 .section "Multiple messages on a single connection" "SECID144"
21805 The sending of multiple messages over a single TCP/IP connection can arise in
21806 two ways:
21807
21808 .ilist
21809 If a message contains more than &%max_rcpt%& (see below) addresses that are
21810 routed to the same host, more than one copy of the message has to be sent to
21811 that host. In this situation, multiple copies may be sent in a single run of
21812 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21813 does when it has too many addresses to send in one message also depends on the
21814 value of the global &%remote_max_parallel%& option. Details are given in
21815 section &<<SECToutSMTPTCP>>&.)
21816 .next
21817 .cindex "hints database" "remembering routing"
21818 When a message has been successfully delivered over a TCP/IP connection, Exim
21819 looks in its hints database to see if there are any other messages awaiting a
21820 connection to the same host. If there are, a new delivery process is started
21821 for one of them, and the current TCP/IP connection is passed on to it. The new
21822 process may in turn send multiple copies and possibly create yet another
21823 process.
21824 .endlist
21825
21826
21827 For each copy sent over the same TCP/IP connection, a sequence counter is
21828 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21829 no further messages are sent over that connection.
21830
21831
21832
21833 .section "Use of the $host and $host_address variables" "SECID145"
21834 .vindex "&$host$&"
21835 .vindex "&$host_address$&"
21836 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21837 &$host_address$& are the name and IP address of the first host on the host list
21838 passed by the router. However, when the transport is about to connect to a
21839 specific host, and while it is connected to that host, &$host$& and
21840 &$host_address$& are set to the values for that host. These are the values
21841 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21842 &%serialize_hosts%&, and the various TLS options are expanded.
21843
21844
21845 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21846 .vindex &$tls_bits$&
21847 .vindex &$tls_cipher$&
21848 .vindex &$tls_peerdn$&
21849 .vindex &$tls_sni$&
21850 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
21851 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
21852 are the values that were set when the message was received.
21853 These are the values that are used for options that are expanded before any
21854 SMTP connections are made. Just before each connection is made, these four
21855 variables are emptied. If TLS is subsequently started, they are set to the
21856 appropriate values for the outgoing connection, and these are the values that
21857 are in force when any authenticators are run and when the
21858 &%authenticated_sender%& option is expanded.
21859
21860
21861 .section "Private options for smtp" "SECID146"
21862 .cindex "options" "&(smtp)& transport"
21863 The private options of the &(smtp)& transport are as follows:
21864
21865
21866 .option address_retry_include_sender smtp boolean true
21867 .cindex "4&'xx'& responses" "retrying after"
21868 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21869 is the combination of sender and recipient that is delayed in subsequent queue
21870 runs until the retry time is reached. You can delay the recipient without
21871 reference to the sender (which is what earlier versions of Exim did), by
21872 setting &%address_retry_include_sender%& false. However, this can lead to
21873 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21874
21875 .option allow_localhost smtp boolean false
21876 .cindex "local host" "sending to"
21877 .cindex "fallback" "hosts specified on transport"
21878 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21879 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21880 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21881 the delivery anyway. This should be used only in special cases when the
21882 configuration ensures that no looping will result (for example, a differently
21883 configured Exim is listening on the port to which the message is sent).
21884
21885
21886 .option authenticated_sender smtp string&!! unset
21887 .cindex "Cyrus"
21888 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21889 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21890 overriding any existing authenticated sender value. If the string expansion is
21891 forced to fail, the option is ignored. Other expansion failures cause delivery
21892 to be deferred. If the result of expansion is an empty string, that is also
21893 ignored.
21894
21895 The expansion happens after the outgoing connection has been made and TLS
21896 started, if required. This means that the &$host$&, &$host_address$&,
21897 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21898 particular connection.
21899
21900 If the SMTP session is not authenticated, the expansion of
21901 &%authenticated_sender%& still happens (and can cause the delivery to be
21902 deferred if it fails), but no AUTH= item is added to MAIL commands
21903 unless &%authenticated_sender_force%& is true.
21904
21905 This option allows you to use the &(smtp)& transport in LMTP mode to
21906 deliver mail to Cyrus IMAP and provide the proper local part as the
21907 &"authenticated sender"&, via a setting such as:
21908 .code
21909 authenticated_sender = $local_part
21910 .endd
21911 This removes the need for IMAP subfolders to be assigned special ACLs to
21912 allow direct delivery to those subfolders.
21913
21914 Because of expected uses such as that just described for Cyrus (when no
21915 domain is involved), there is no checking on the syntax of the provided
21916 value.
21917
21918
21919 .option authenticated_sender_force smtp boolean false
21920 If this option is set true, the &%authenticated_sender%& option's value
21921 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21922 authenticated as a client.
21923
21924
21925 .option command_timeout smtp time 5m
21926 This sets a timeout for receiving a response to an SMTP command that has been
21927 sent out. It is also used when waiting for the initial banner line from the
21928 remote host. Its value must not be zero.
21929
21930
21931 .option connect_timeout smtp time 5m
21932 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21933 to a remote host. A setting of zero allows the system timeout (typically
21934 several minutes) to act. To have any effect, the value of this option must be
21935 less than the system timeout. However, it has been observed that on some
21936 systems there is no system timeout, which is why the default value for this
21937 option is 5 minutes, a value recommended by RFC 1123.
21938
21939
21940 .option connection_max_messages smtp integer 500
21941 .cindex "SMTP" "passed connection"
21942 .cindex "SMTP" "multiple deliveries"
21943 .cindex "multiple SMTP deliveries"
21944 This controls the maximum number of separate message deliveries that are sent
21945 over a single TCP/IP connection. If the value is zero, there is no limit.
21946 For testing purposes, this value can be overridden by the &%-oB%& command line
21947 option.
21948
21949
21950 .option data_timeout smtp time 5m
21951 This sets a timeout for the transmission of each block in the data portion of
21952 the message. As a result, the overall timeout for a message depends on the size
21953 of the message. Its value must not be zero. See also &%final_timeout%&.
21954
21955
21956 .option delay_after_cutoff smtp boolean true
21957 This option controls what happens when all remote IP addresses for a given
21958 domain have been inaccessible for so long that they have passed their retry
21959 cutoff times.
21960
21961 In the default state, if the next retry time has not been reached for any of
21962 them, the address is bounced without trying any deliveries. In other words,
21963 Exim delays retrying an IP address after the final cutoff time until a new
21964 retry time is reached, and can therefore bounce an address without ever trying
21965 a delivery, when machines have been down for a long time. Some people are
21966 unhappy at this prospect, so...
21967
21968 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21969 addresses are past their final cutoff time, Exim tries to deliver to those
21970 IP addresses that have not been tried since the message arrived. If there are
21971 none, of if they all fail, the address is bounced. In other words, it does not
21972 delay when a new message arrives, but immediately tries those expired IP
21973 addresses that haven't been tried since the message arrived. If there is a
21974 continuous stream of messages for the dead hosts, unsetting
21975 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21976 to them.
21977
21978
21979 .option dns_qualify_single smtp boolean true
21980 If the &%hosts%& or &%fallback_hosts%& option is being used,
21981 and the &%gethostbyname%& option is false,
21982 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21983 in chapter &<<CHAPdnslookup>>& for more details.
21984
21985
21986 .option dns_search_parents smtp boolean false
21987 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21988 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21989 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21990 details.
21991
21992
21993
21994 .option fallback_hosts smtp "string list" unset
21995 .cindex "fallback" "hosts specified on transport"
21996 String expansion is not applied to this option. The argument must be a
21997 colon-separated list of host names or IP addresses, optionally also including
21998 port numbers, though the separator can be changed, as described in section
21999 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22000 item in a &%route_list%& setting for the &(manualroute)& router, as described
22001 in section &<<SECTformatonehostitem>>&.
22002
22003 Fallback hosts can also be specified on routers, which associate them with the
22004 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22005 &%fallback_hosts%& specified on the transport is used only if the address does
22006 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22007 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22008 However, &%hosts_randomize%& does apply to fallback host lists.
22009
22010 If Exim is unable to deliver to any of the hosts for a particular address, and
22011 the errors are not permanent rejections, the address is put on a separate
22012 transport queue with its host list replaced by the fallback hosts, unless the
22013 address was routed via MX records and the current host was in the original MX
22014 list. In that situation, the fallback host list is not used.
22015
22016 Once normal deliveries are complete, the fallback queue is delivered by
22017 re-running the same transports with the new host lists. If several failing
22018 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22019 copy of the message is sent.
22020
22021 The resolution of the host names on the fallback list is controlled by the
22022 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22023 both to cases when the host list comes with the address and when it is taken
22024 from &%hosts%&. This option provides a &"use a smart host only if delivery
22025 fails"& facility.
22026
22027
22028 .option final_timeout smtp time 10m
22029 This is the timeout that applies while waiting for the response to the final
22030 line containing just &"."& that terminates a message. Its value must not be
22031 zero.
22032
22033 .option gethostbyname smtp boolean false
22034 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22035 being used, names are looked up using &[gethostbyname()]&
22036 (or &[getipnodebyname()]& when available)
22037 instead of using the DNS. Of course, that function may in fact use the DNS, but
22038 it may also consult other sources of information such as &_/etc/hosts_&.
22039
22040 .option gnutls_require_kx smtp string unset
22041 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
22042 client. For details, see section &<<SECTreqciphgnu>>&.
22043
22044 .option gnutls_require_mac smtp string unset
22045 This option controls the MAC algorithms when GnuTLS is used in an Exim
22046 client. For details, see section &<<SECTreqciphgnu>>&.
22047
22048 .option gnutls_require_protocols smtp string unset
22049 This option controls the protocols when GnuTLS is used in an Exim
22050 client. For details, see section &<<SECTreqciphgnu>>&.
22051
22052 .option gnutls_compat_mode smtp boolean unset
22053 This option controls whether GnuTLS is used in compatibility mode in an Exim
22054 server. This reduces security slightly, but improves interworking with older
22055 implementations of TLS.
22056
22057 .option helo_data smtp string&!! "see below"
22058 .cindex "HELO" "argument, setting"
22059 .cindex "EHLO" "argument, setting"
22060 .cindex "LHLO argument setting"
22061 The value of this option is expanded after a connection to a another host has
22062 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22063 command that starts the outgoing SMTP or LMTP session. The default value of the
22064 option is:
22065 .code
22066 $primary_hostname
22067 .endd
22068 During the expansion, the variables &$host$& and &$host_address$& are set to
22069 the identity of the remote host, and the variables &$sending_ip_address$& and
22070 &$sending_port$& are set to the local IP address and port number that are being
22071 used. These variables can be used to generate different values for different
22072 servers or different local IP addresses. For example, if you want the string
22073 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22074 interface address, you could use this:
22075 .code
22076 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22077   {$primary_hostname}}
22078 .endd
22079 The use of &%helo_data%& applies both to sending messages and when doing
22080 callouts.
22081
22082 .option hosts smtp "string list&!!" unset
22083 Hosts are associated with an address by a router such as &(dnslookup)&, which
22084 finds the hosts by looking up the address domain in the DNS, or by
22085 &(manualroute)&, which has lists of hosts in its configuration. However,
22086 email addresses can be passed to the &(smtp)& transport by any router, and not
22087 all of them can provide an associated list of hosts.
22088
22089 The &%hosts%& option specifies a list of hosts to be used if the address being
22090 processed does not have any hosts associated with it. The hosts specified by
22091 &%hosts%& are also used, whether or not the address has its own hosts, if
22092 &%hosts_override%& is set.
22093
22094 The string is first expanded, before being interpreted as a colon-separated
22095 list of host names or IP addresses, possibly including port numbers. The
22096 separator may be changed to something other than colon, as described in section
22097 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22098 item in a &%route_list%& setting for the &(manualroute)& router, as described
22099 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22100 of the &(manualroute)& router is not available here.
22101
22102 If the expansion fails, delivery is deferred. Unless the failure was caused by
22103 the inability to complete a lookup, the error is logged to the panic log as
22104 well as the main log. Host names are looked up either by searching directly for
22105 address records in the DNS or by calling &[gethostbyname()]& (or
22106 &[getipnodebyname()]& when available), depending on the setting of the
22107 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22108 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22109 address are used.
22110
22111 During delivery, the hosts are tried in order, subject to their retry status,
22112 unless &%hosts_randomize%& is set.
22113
22114
22115 .option hosts_avoid_esmtp smtp "host list&!!" unset
22116 .cindex "ESMTP, avoiding use of"
22117 .cindex "HELO" "forcing use of"
22118 .cindex "EHLO" "avoiding use of"
22119 .cindex "PIPELINING" "avoiding the use of"
22120 This option is for use with broken hosts that announce ESMTP facilities (for
22121 example, PIPELINING) and then fail to implement them properly. When a host
22122 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22123 start of the SMTP session. This means that it cannot use any of the ESMTP
22124 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22125
22126
22127 .option hosts_avoid_pipelining smtp "host list&!!" unset
22128 .cindex "PIPELINING" "avoiding the use of"
22129 Exim will not use the SMTP PIPELINING extension when delivering to any host
22130 that matches this list, even if the server host advertises PIPELINING support.
22131
22132
22133 .option hosts_avoid_tls smtp "host list&!!" unset
22134 .cindex "TLS" "avoiding for certain hosts"
22135 Exim will not try to start a TLS session when delivering to any host that
22136 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22137
22138
22139 .option hosts_max_try smtp integer 5
22140 .cindex "host" "maximum number to try"
22141 .cindex "limit" "number of hosts tried"
22142 .cindex "limit" "number of MX tried"
22143 .cindex "MX record" "maximum tried"
22144 This option limits the number of IP addresses that are tried for any one
22145 delivery in cases where there are temporary delivery errors. Section
22146 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22147
22148
22149 .option hosts_max_try_hardlimit smtp integer 50
22150 This is an additional check on the maximum number of IP addresses that Exim
22151 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22152 why it exists.
22153
22154
22155
22156 .option hosts_nopass_tls smtp "host list&!!" unset
22157 .cindex "TLS" "passing connection"
22158 .cindex "multiple SMTP deliveries"
22159 .cindex "TLS" "multiple message deliveries"
22160 For any host that matches this list, a connection on which a TLS session has
22161 been started will not be passed to a new delivery process for sending another
22162 message on the same connection. See section &<<SECTmulmessam>>& for an
22163 explanation of when this might be needed.
22164
22165
22166 .option hosts_override smtp boolean false
22167 If this option is set and the &%hosts%& option is also set, any hosts that are
22168 attached to the address are ignored, and instead the hosts specified by the
22169 &%hosts%& option are always used. This option does not apply to
22170 &%fallback_hosts%&.
22171
22172
22173 .option hosts_randomize smtp boolean false
22174 .cindex "randomized host list"
22175 .cindex "host" "list of; randomized"
22176 .cindex "fallback" "randomized hosts"
22177 If this option is set, and either the list of hosts is taken from the
22178 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22179 were not obtained from MX records (this includes fallback hosts from the
22180 router), and were not randomized by the router, the order of trying the hosts
22181 is randomized each time the transport runs. Randomizing the order of a host
22182 list can be used to do crude load sharing.
22183
22184 When &%hosts_randomize%& is true, a host list may be split into groups whose
22185 order is separately randomized. This makes it possible to set up MX-like
22186 behaviour. The boundaries between groups are indicated by an item that is just
22187 &`+`& in the host list. For example:
22188 .code
22189 hosts = host1:host2:host3:+:host4:host5
22190 .endd
22191 The order of the first three hosts and the order of the last two hosts is
22192 randomized for each use, but the first three always end up before the last two.
22193 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22194
22195 .option hosts_require_auth smtp "host list&!!" unset
22196 .cindex "authentication" "required by client"
22197 This option provides a list of servers for which authentication must succeed
22198 before Exim will try to transfer a message. If authentication fails for
22199 servers which are not in this list, Exim tries to send unauthenticated. If
22200 authentication fails for one of these servers, delivery is deferred. This
22201 temporary error is detectable in the retry rules, so it can be turned into a
22202 hard failure if required. See also &%hosts_try_auth%&, and chapter
22203 &<<CHAPSMTPAUTH>>& for details of authentication.
22204
22205
22206 .option hosts_require_tls smtp "host list&!!" unset
22207 .cindex "TLS" "requiring for certain servers"
22208 Exim will insist on using a TLS session when delivering to any host that
22209 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22210 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22211 incoming messages, use an appropriate ACL.
22212
22213 .option hosts_try_auth smtp "host list&!!" unset
22214 .cindex "authentication" "optional in client"
22215 This option provides a list of servers to which, provided they announce
22216 authentication support, Exim will attempt to authenticate as a client when it
22217 connects. If authentication fails, Exim will try to transfer the message
22218 unauthenticated. See also &%hosts_require_auth%&, and chapter
22219 &<<CHAPSMTPAUTH>>& for details of authentication.
22220
22221 .option interface smtp "string list&!!" unset
22222 .cindex "bind IP address"
22223 .cindex "IP address" "binding"
22224 .vindex "&$host$&"
22225 .vindex "&$host_address$&"
22226 This option specifies which interface to bind to when making an outgoing SMTP
22227 call. The value is an IP address, not an interface name such as
22228 &`eth0`&. Do not confuse this with the interface address that was used when a
22229 message was received, which is in &$received_ip_address$&, formerly known as
22230 &$interface_address$&. The name was changed to minimize confusion with the
22231 outgoing interface address. There is no variable that contains an outgoing
22232 interface address because, unless it is set by this option, its value is
22233 unknown.
22234
22235 During the expansion of the &%interface%& option the variables &$host$& and
22236 &$host_address$& refer to the host to which a connection is about to be made
22237 during the expansion of the string. Forced expansion failure, or an empty
22238 string result causes the option to be ignored. Otherwise, after expansion, the
22239 string must be a list of IP addresses, colon-separated by default, but the
22240 separator can be changed in the usual way. For example:
22241 .code
22242 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22243 .endd
22244 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22245 connection. If none of them are the correct type, the option is ignored. If
22246 &%interface%& is not set, or is ignored, the system's IP functions choose which
22247 interface to use if the host has more than one.
22248
22249
22250 .option keepalive smtp boolean true
22251 .cindex "keepalive" "on outgoing connection"
22252 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22253 connections. When set, it causes the kernel to probe idle connections
22254 periodically, by sending packets with &"old"& sequence numbers. The other end
22255 of the connection should send a acknowledgment if the connection is still okay
22256 or a reset if the connection has been aborted. The reason for doing this is
22257 that it has the beneficial effect of freeing up certain types of connection
22258 that can get stuck when the remote host is disconnected without tidying up the
22259 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22260 unreachable hosts.
22261
22262
22263 .option lmtp_ignore_quota smtp boolean false
22264 .cindex "LMTP" "ignoring quota errors"
22265 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22266 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22267 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22268
22269 .option max_rcpt smtp integer 100
22270 .cindex "RCPT" "maximum number of outgoing"
22271 This option limits the number of RCPT commands that are sent in a single
22272 SMTP message transaction. Each set of addresses is treated independently, and
22273 so can cause parallel connections to the same host if &%remote_max_parallel%&
22274 permits this.
22275
22276
22277 .option multi_domain smtp boolean true
22278 .vindex "&$domain$&"
22279 When this option is set, the &(smtp)& transport can handle a number of
22280 addresses containing a mixture of different domains provided they all resolve
22281 to the same list of hosts. Turning the option off restricts the transport to
22282 handling only one domain at a time. This is useful if you want to use
22283 &$domain$& in an expansion for the transport, because it is set only when there
22284 is a single domain involved in a remote delivery.
22285
22286
22287 .option port smtp string&!! "see below"
22288 .cindex "port" "sending TCP/IP"
22289 .cindex "TCP/IP" "setting outgoing port"
22290 This option specifies the TCP/IP port on the server to which Exim connects.
22291 &*Note:*& Do not confuse this with the port that was used when a message was
22292 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22293 The name was changed to minimize confusion with the outgoing port. There is no
22294 variable that contains an outgoing port.
22295
22296 If the value of this option begins with a digit it is taken as a port number;
22297 otherwise it is looked up using &[getservbyname()]&. The default value is
22298 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22299 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22300 is deferred.
22301
22302
22303
22304 .option protocol smtp string smtp
22305 .cindex "LMTP" "over TCP/IP"
22306 .cindex "ssmtp protocol" "outbound"
22307 .cindex "TLS" "SSL-on-connect outbound"
22308 .vindex "&$port$&"
22309 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22310 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22311 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22312 deliveries into closed message stores. Exim also has support for running LMTP
22313 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22314
22315 .new
22316 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22317 changes to &"smtps"&, and the transport initiates TLS immediately after
22318 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22319 The Internet standards bodies strongly discourage use of this mode.
22320 .wen
22321
22322
22323 .option retry_include_ip_address smtp boolean true
22324 Exim normally includes both the host name and the IP address in the key it
22325 constructs for indexing retry data after a temporary delivery failure. This
22326 means that when one of several IP addresses for a host is failing, it gets
22327 tried periodically (controlled by the retry rules), but use of the other IP
22328 addresses is not affected.
22329
22330 However, in some dialup environments hosts are assigned a different IP address
22331 each time they connect. In this situation the use of the IP address as part of
22332 the retry key leads to undesirable behaviour. Setting this option false causes
22333 Exim to use only the host name. This should normally be done on a separate
22334 instance of the &(smtp)& transport, set up specially to handle the dialup
22335 hosts.
22336
22337
22338 .option serialize_hosts smtp "host list&!!" unset
22339 .cindex "serializing connections"
22340 .cindex "host" "serializing connections"
22341 Because Exim operates in a distributed manner, if several messages for the same
22342 host arrive at around the same time, more than one simultaneous connection to
22343 the remote host can occur. This is not usually a problem except when there is a
22344 slow link between the hosts. In that situation it may be helpful to restrict
22345 Exim to one connection at a time. This can be done by setting
22346 &%serialize_hosts%& to match the relevant hosts.
22347
22348 .cindex "hints database" "serializing deliveries to a host"
22349 Exim implements serialization by means of a hints database in which a record is
22350 written whenever a process connects to one of the restricted hosts. The record
22351 is deleted when the connection is completed. Obviously there is scope for
22352 records to get left lying around if there is a system or program crash. To
22353 guard against this, Exim ignores any records that are more than six hours old.
22354
22355 If you set up this kind of serialization, you should also arrange to delete the
22356 relevant hints database whenever your system reboots. The names of the files
22357 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22358 may be one or two files, depending on the type of DBM in use. The same files
22359 are used for ETRN serialization.
22360
22361
22362 .option size_addition smtp integer 1024
22363 .cindex "SMTP" "SIZE"
22364 .cindex "message" "size issue for transport filter"
22365 .cindex "size" "of message"
22366 .cindex "transport" "filter"
22367 .cindex "filter" "transport filter"
22368 If a remote SMTP server indicates that it supports the SIZE option of the
22369 MAIL command, Exim uses this to pass over the message size at the start of
22370 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22371 sends, to allow for headers and other text that may be added during delivery by
22372 configuration options or in a transport filter. It may be necessary to increase
22373 this if a lot of text is added to messages.
22374
22375 Alternatively, if the value of &%size_addition%& is set negative, it disables
22376 the use of the SIZE option altogether.
22377
22378
22379 .option tls_certificate smtp string&!! unset
22380 .cindex "TLS" "client certificate, location of"
22381 .cindex "certificate" "client, location of"
22382 .vindex "&$host$&"
22383 .vindex "&$host_address$&"
22384 The value of this option must be the absolute path to a file which contains the
22385 client's certificate, for possible use when sending a message over an encrypted
22386 connection. The values of &$host$& and &$host_address$& are set to the name and
22387 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22388 details of TLS.
22389
22390 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22391 certificate when sending messages as a client. The global option of the same
22392 name specifies the certificate for Exim as a server; it is not automatically
22393 assumed that the same certificate should be used when Exim is operating as a
22394 client.
22395
22396
22397 .option tls_crl smtp string&!! unset
22398 .cindex "TLS" "client certificate revocation list"
22399 .cindex "certificate" "revocation list for client"
22400 This option specifies a certificate revocation list. The expanded value must
22401 be the name of a file that contains a CRL in PEM format.
22402
22403
22404 .option tls_privatekey smtp string&!! unset
22405 .cindex "TLS" "client private key, location of"
22406 .vindex "&$host$&"
22407 .vindex "&$host_address$&"
22408 The value of this option must be the absolute path to a file which contains the
22409 client's private key. This is used when sending a message over an encrypted
22410 connection using a client certificate. The values of &$host$& and
22411 &$host_address$& are set to the name and address of the server during the
22412 expansion. If this option is unset, or the expansion is forced to fail, or the
22413 result is an empty string, the private key is assumed to be in the same file as
22414 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22415
22416
22417 .option tls_require_ciphers smtp string&!! unset
22418 .cindex "TLS" "requiring specific ciphers"
22419 .cindex "cipher" "requiring specific"
22420 .vindex "&$host$&"
22421 .vindex "&$host_address$&"
22422 The value of this option must be a list of permitted cipher suites, for use
22423 when setting up an outgoing encrypted connection. (There is a global option of
22424 the same name for controlling incoming connections.) The values of &$host$& and
22425 &$host_address$& are set to the name and address of the server during the
22426 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22427 is used in different ways by OpenSSL and GnuTLS (see sections
22428 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22429 ciphers is a preference order.
22430
22431
22432
22433 .new
22434 .option tls_sni smtp string&!! unset
22435 .cindex "TLS" "Server Name Indication"
22436 .vindex "&$tls_sni$&"
22437 If this option is set then it sets the $tls_sni variable and causes any
22438 TLS session to pass this value as the Server Name Indication extension to
22439 the remote side, which can be used by the remote side to select an appropriate
22440 certificate and private key for the session.
22441
22442 See &<<SECTtlssni>>& for more information.
22443
22444 OpenSSL only, also requiring a build of OpenSSL that supports TLS extensions.
22445 .wen
22446
22447
22448
22449 .option tls_tempfail_tryclear smtp boolean true
22450 .cindex "4&'xx'& responses" "to STARTTLS"
22451 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22452 setting up a TLS session, this option determines whether or not Exim should try
22453 to deliver the message unencrypted. If it is set false, delivery to the
22454 current host is deferred; if there are other hosts, they are tried. If this
22455 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22456 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22457 TLS negotiation fails, Exim closes the current connection (because it is in an
22458 unknown state), opens a new one to the same host, and then tries the delivery
22459 in clear.
22460
22461
22462 .option tls_verify_certificates smtp string&!! unset
22463 .cindex "TLS" "server certificate verification"
22464 .cindex "certificate" "verification of server"
22465 .vindex "&$host$&"
22466 .vindex "&$host_address$&"
22467 The value of this option must be the absolute path to a file containing
22468 permitted server certificates, for use when setting up an encrypted connection.
22469 Alternatively, if you are using OpenSSL, you can set
22470 &%tls_verify_certificates%& to the name of a directory containing certificate
22471 files. This does not work with GnuTLS; the option must be set to the name of a
22472 single file if you are using GnuTLS. The values of &$host$& and
22473 &$host_address$& are set to the name and address of the server during the
22474 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22475
22476
22477
22478
22479 .section "How the limits for the number of hosts to try are used" &&&
22480          "SECTvalhosmax"
22481 .cindex "host" "maximum number to try"
22482 .cindex "limit" "hosts; maximum number tried"
22483 There are two options that are concerned with the number of hosts that are
22484 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22485 &%hosts_max_try_hardlimit%&.
22486
22487
22488 The &%hosts_max_try%& option limits the number of hosts that are tried
22489 for a single delivery. However, despite the term &"host"& in its name, the
22490 option actually applies to each IP address independently. In other words, a
22491 multihomed host is treated as several independent hosts, just as it is for
22492 retrying.
22493
22494 Many of the larger ISPs have multiple MX records which often point to
22495 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22496 created as a result of routing one of these domains.
22497
22498 Trying every single IP address on such a long list does not seem sensible; if
22499 several at the top of the list fail, it is reasonable to assume there is some
22500 problem that is likely to affect all of them. Roughly speaking, the value of
22501 &%hosts_max_try%& is the maximum number that are tried before deferring the
22502 delivery. However, the logic cannot be quite that simple.
22503
22504 Firstly, IP addresses that are skipped because their retry times have not
22505 arrived do not count, and in addition, addresses that are past their retry
22506 limits are also not counted, even when they are tried. This means that when
22507 some IP addresses are past their retry limits, more than the value of
22508 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22509 that all IP addresses are considered before timing out an email address (but
22510 see below for an exception).
22511
22512 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22513 list to see if there is a subsequent host with a different (higher valued) MX.
22514 If there is, that host is considered next, and the current IP address is used
22515 but not counted. This behaviour helps in the case of a domain with a retry rule
22516 that hardly ever delays any hosts, as is now explained:
22517
22518 Consider the case of a long list of hosts with one MX value, and a few with a
22519 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22520 hosts at the top of the list are tried at first. With the default retry rule,
22521 which specifies increasing retry times, the higher MX hosts are eventually
22522 tried when those at the top of the list are skipped because they have not
22523 reached their retry times.
22524
22525 However, it is common practice to put a fixed short retry time on domains for
22526 large ISPs, on the grounds that their servers are rarely down for very long.
22527 Unfortunately, these are exactly the domains that tend to resolve to long lists
22528 of hosts. The short retry time means that the lowest MX hosts are tried every
22529 time. The attempts may be in a different order because of random sorting, but
22530 without the special MX check, the higher MX hosts would never be tried until
22531 all the lower MX hosts had timed out (which might be several days), because
22532 there are always some lower MX hosts that have reached their retry times. With
22533 the special check, Exim considers at least one IP address from each MX value at
22534 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22535 reached.
22536
22537 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22538 particular, Exim normally eventually tries all the IP addresses before timing
22539 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22540 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22541 been set up with hundreds of IP addresses for some domains. It can
22542 take a very long time indeed for an address to time out in these cases.
22543
22544 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22545 Exim never tries more than this number of IP addresses; if it hits this limit
22546 and they are all timed out, the email address is bounced, even though not all
22547 possible IP addresses have been tried.
22548 .ecindex IIDsmttra1
22549 .ecindex IIDsmttra2
22550
22551
22552
22553
22554
22555 . ////////////////////////////////////////////////////////////////////////////
22556 . ////////////////////////////////////////////////////////////////////////////
22557
22558 .chapter "Address rewriting" "CHAPrewrite"
22559 .scindex IIDaddrew "rewriting" "addresses"
22560 There are some circumstances in which Exim automatically rewrites domains in
22561 addresses. The two most common are when an address is given without a domain
22562 (referred to as an &"unqualified address"&) or when an address contains an
22563 abbreviated domain that is expanded by DNS lookup.
22564
22565 Unqualified envelope addresses are accepted only for locally submitted
22566 messages, or for messages that are received from hosts matching
22567 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22568 appropriate. Unqualified addresses in header lines are qualified if they are in
22569 locally submitted messages, or messages from hosts that are permitted to send
22570 unqualified envelope addresses. Otherwise, unqualified addresses in header
22571 lines are neither qualified nor rewritten.
22572
22573 One situation in which Exim does &'not'& automatically rewrite a domain is
22574 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22575 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22576 do this. The new RFCs do not contain this suggestion.
22577
22578
22579 .section "Explicitly configured address rewriting" "SECID147"
22580 This chapter describes the rewriting rules that can be used in the
22581 main rewrite section of the configuration file, and also in the generic
22582 &%headers_rewrite%& option that can be set on any transport.
22583
22584 Some people believe that configured address rewriting is a Mortal Sin.
22585 Others believe that life is not possible without it. Exim provides the
22586 facility; you do not have to use it.
22587
22588 The main rewriting rules that appear in the &"rewrite"& section of the
22589 configuration file are applied to addresses in incoming messages, both envelope
22590 addresses and addresses in header lines. Each rule specifies the types of
22591 address to which it applies.
22592
22593 Whether or not addresses in header lines are rewritten depends on the origin of
22594 the headers and the type of rewriting. Global rewriting, that is, rewriting
22595 rules from the rewrite section of the configuration file, is applied only to
22596 those headers that were received with the message. Header lines that are added
22597 by ACLs or by a system filter or by individual routers or transports (which
22598 are specific to individual recipient addresses) are not rewritten by the global
22599 rules.
22600
22601 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22602 applies all headers except those added by routers and transports. That is, as
22603 well as the headers that were received with the message, it also applies to
22604 headers that were added by an ACL or a system filter.
22605
22606
22607 In general, rewriting addresses from your own system or domain has some
22608 legitimacy. Rewriting other addresses should be done only with great care and
22609 in special circumstances. The author of Exim believes that rewriting should be
22610 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22611 Although it can sometimes be used as a routing tool, this is very strongly
22612 discouraged.
22613
22614 There are two commonly encountered circumstances where rewriting is used, as
22615 illustrated by these examples:
22616
22617 .ilist
22618 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22619 exchange mail with each other behind a firewall, but there is only a single
22620 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22621 &'hitch.fict.example'& when sending mail off-site.
22622 .next
22623 A host rewrites the local parts of its own users so that, for example,
22624 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22625 .endlist
22626
22627
22628
22629 .section "When does rewriting happen?" "SECID148"
22630 .cindex "rewriting" "timing of"
22631 .cindex "&ACL;" "rewriting addresses in"
22632 Configured address rewriting can take place at several different stages of a
22633 message's processing.
22634
22635 .vindex "&$sender_address$&"
22636 At the start of an ACL for MAIL, the sender address may have been rewritten
22637 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22638 ordinary rewrite rules have yet been applied. If, however, the sender address
22639 is verified in the ACL, it is rewritten before verification, and remains
22640 rewritten thereafter. The subsequent value of &$sender_address$& is the
22641 rewritten address. This also applies if sender verification happens in a
22642 RCPT ACL. Otherwise, when the sender address is not verified, it is
22643 rewritten as soon as a message's header lines have been received.
22644
22645 .vindex "&$domain$&"
22646 .vindex "&$local_part$&"
22647 Similarly, at the start of an ACL for RCPT, the current recipient's address
22648 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22649 rewrite rules have yet been applied to it. However, the behaviour is different
22650 from the sender address when a recipient is verified. The address is rewritten
22651 for the verification, but the rewriting is not remembered at this stage. The
22652 value of &$local_part$& and &$domain$& after verification are always the same
22653 as they were before (that is, they contain the unrewritten &-- except for
22654 SMTP-time rewriting &-- address).
22655
22656 As soon as a message's header lines have been received, all the envelope
22657 recipient addresses are permanently rewritten, and rewriting is also applied to
22658 the addresses in the header lines (if configured). This happens before adding
22659 any header lines that were specified in MAIL or RCPT ACLs, and
22660 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22661 before the DATA ACL and &[local_scan()]& functions are run.
22662
22663 When an address is being routed, either for delivery or for verification,
22664 rewriting is applied immediately to child addresses that are generated by
22665 redirection, unless &%no_rewrite%& is set on the router.
22666
22667 .cindex "envelope sender" "rewriting at transport time"
22668 .cindex "rewriting" "at transport time"
22669 .cindex "header lines" "rewriting at transport time"
22670 At transport time, additional rewriting of addresses in header lines can be
22671 specified by setting the generic &%headers_rewrite%& option on a transport.
22672 This option contains rules that are identical in form to those in the rewrite
22673 section of the configuration file. They are applied to the original message
22674 header lines and any that were added by ACLs or a system filter. They are not
22675 applied to header lines that are added by routers or the transport.
22676
22677 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22678 transport option. However, it is not possible to rewrite envelope recipients at
22679 transport time.
22680
22681
22682
22683
22684 .section "Testing the rewriting rules that apply on input" "SECID149"
22685 .cindex "rewriting" "testing"
22686 .cindex "testing" "rewriting"
22687 Exim's input rewriting configuration appears in a part of the run time
22688 configuration file headed by &"begin rewrite"&. It can be tested by the
22689 &%-brw%& command line option. This takes an address (which can be a full RFC
22690 2822 address) as its argument. The output is a list of how the address would be
22691 transformed by the rewriting rules for each of the different places it might
22692 appear in an incoming message, that is, for each different header and for the
22693 envelope sender and recipient fields. For example,
22694 .code
22695 exim -brw ph10@exim.workshop.example
22696 .endd
22697 might produce the output
22698 .code
22699 sender: Philip.Hazel@exim.workshop.example
22700 from: Philip.Hazel@exim.workshop.example
22701 to: ph10@exim.workshop.example
22702 cc: ph10@exim.workshop.example
22703 bcc: ph10@exim.workshop.example
22704 reply-to: Philip.Hazel@exim.workshop.example
22705 env-from: Philip.Hazel@exim.workshop.example
22706 env-to: ph10@exim.workshop.example
22707 .endd
22708 which shows that rewriting has been set up for that address when used in any of
22709 the source fields, but not when it appears as a recipient address. At the
22710 present time, there is no equivalent way of testing rewriting rules that are
22711 set for a particular transport.
22712
22713
22714 .section "Rewriting rules" "SECID150"
22715 .cindex "rewriting" "rules"
22716 The rewrite section of the configuration file consists of lines of rewriting
22717 rules in the form
22718 .display
22719 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22720 .endd
22721 Rewriting rules that are specified for the &%headers_rewrite%& generic
22722 transport option are given as a colon-separated list. Each item in the list
22723 takes the same form as a line in the main rewriting configuration (except that
22724 any colons must be doubled, of course).
22725
22726 The formats of source patterns and replacement strings are described below.
22727 Each is terminated by white space, unless enclosed in double quotes, in which
22728 case normal quoting conventions apply inside the quotes. The flags are single
22729 characters which may appear in any order. Spaces and tabs between them are
22730 ignored.
22731
22732 For each address that could potentially be rewritten, the rules are scanned in
22733 order, and replacements for the address from earlier rules can themselves be
22734 replaced by later rules (but see the &"q"& and &"R"& flags).
22735
22736 The order in which addresses are rewritten is undefined, may change between
22737 releases, and must not be relied on, with one exception: when a message is
22738 received, the envelope sender is always rewritten first, before any header
22739 lines are rewritten. For example, the replacement string for a rewrite of an
22740 address in &'To:'& must not assume that the message's address in &'From:'& has
22741 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22742 that the envelope sender has already been rewritten.
22743
22744 .vindex "&$domain$&"
22745 .vindex "&$local_part$&"
22746 The variables &$local_part$& and &$domain$& can be used in the replacement
22747 string to refer to the address that is being rewritten. Note that lookup-driven
22748 rewriting can be done by a rule of the form
22749 .code
22750 *@*   ${lookup ...
22751 .endd
22752 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22753 refer to the address that is being rewritten.
22754
22755
22756 .section "Rewriting patterns" "SECID151"
22757 .cindex "rewriting" "patterns"
22758 .cindex "address list" "in a rewriting pattern"
22759 The source pattern in a rewriting rule is any item which may appear in an
22760 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22761 single-item address list, which means that it is expanded before being tested
22762 against the address. As always, if you use a regular expression as a pattern,
22763 you must take care to escape dollar and backslash characters, or use the &`\N`&
22764 facility to suppress string expansion within the regular expression.
22765
22766 Domains in patterns should be given in lower case. Local parts in patterns are
22767 case-sensitive. If you want to do case-insensitive matching of local parts, you
22768 can use a regular expression that starts with &`^(?i)`&.
22769
22770 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22771 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22772 depending on the type of match which occurred. These can be used in the
22773 replacement string to insert portions of the incoming address. &$0$& always
22774 refers to the complete incoming address. When a regular expression is used, the
22775 numerical variables are set from its capturing subexpressions. For other types
22776 of pattern they are set as follows:
22777
22778 .ilist
22779 If a local part or domain starts with an asterisk, the numerical variables
22780 refer to the character strings matched by asterisks, with &$1$& associated with
22781 the first asterisk, and &$2$& with the second, if present. For example, if the
22782 pattern
22783 .code
22784 *queen@*.fict.example
22785 .endd
22786 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22787 .code
22788 $0 = hearts-queen@wonderland.fict.example
22789 $1 = hearts-
22790 $2 = wonderland
22791 .endd
22792 Note that if the local part does not start with an asterisk, but the domain
22793 does, it is &$1$& that contains the wild part of the domain.
22794
22795 .next
22796 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22797 of the domain are placed in the next available numerical variables. Suppose,
22798 for example, that the address &'foo@bar.baz.example'& is processed by a
22799 rewriting rule of the form
22800 .display
22801 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22802 .endd
22803 and the key in the file that matches the domain is &`*.baz.example`&. Then
22804 .code
22805 $1 = foo
22806 $2 = bar
22807 $3 = baz.example
22808 .endd
22809 If the address &'foo@baz.example'& is looked up, this matches the same
22810 wildcard file entry, and in this case &$2$& is set to the empty string, but
22811 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22812 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22813 whole domain. For non-partial domain lookups, no numerical variables are set.
22814 .endlist
22815
22816
22817 .section "Rewriting replacements" "SECID152"
22818 .cindex "rewriting" "replacements"
22819 If the replacement string for a rule is a single asterisk, addresses that
22820 match the pattern and the flags are &'not'& rewritten, and no subsequent
22821 rewriting rules are scanned. For example,
22822 .code
22823 hatta@lookingglass.fict.example  *  f
22824 .endd
22825 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22826 &'From:'& headers.
22827
22828 .vindex "&$domain$&"
22829 .vindex "&$local_part$&"
22830 If the replacement string is not a single asterisk, it is expanded, and must
22831 yield a fully qualified address. Within the expansion, the variables
22832 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22833 Any letters they contain retain their original case &-- they are not lower
22834 cased. The numerical variables are set up according to the type of pattern that
22835 matched the address, as described above. If the expansion is forced to fail by
22836 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22837 current rule is abandoned, but subsequent rules may take effect. Any other
22838 expansion failure causes the entire rewriting operation to be abandoned, and an
22839 entry written to the panic log.
22840
22841
22842
22843 .section "Rewriting flags" "SECID153"
22844 There are three different kinds of flag that may appear on rewriting rules:
22845
22846 .ilist
22847 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22848 c, f, h, r, s, t.
22849 .next
22850 A flag that specifies rewriting at SMTP time: S.
22851 .next
22852 Flags that control the rewriting process: Q, q, R, w.
22853 .endlist
22854
22855 For rules that are part of the &%headers_rewrite%& generic transport option,
22856 E, F, T, and S are not permitted.
22857
22858
22859
22860 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22861          "SECID154"
22862 .cindex "rewriting" "flags"
22863 If none of the following flag letters, nor the &"S"& flag (see section
22864 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22865 and to both the sender and recipient fields of the envelope, whereas a
22866 transport-time rewriting rule just applies to all headers. Otherwise, the
22867 rewriting rule is skipped unless the relevant addresses are being processed.
22868 .display
22869 &`E`&       rewrite all envelope fields
22870 &`F`&       rewrite the envelope From field
22871 &`T`&       rewrite the envelope To field
22872 &`b`&       rewrite the &'Bcc:'& header
22873 &`c`&       rewrite the &'Cc:'& header
22874 &`f`&       rewrite the &'From:'& header
22875 &`h`&       rewrite all headers
22876 &`r`&       rewrite the &'Reply-To:'& header
22877 &`s`&       rewrite the &'Sender:'& header
22878 &`t`&       rewrite the &'To:'& header
22879 .endd
22880 "All headers" means all of the headers listed above that can be selected
22881 individually, plus their &'Resent-'& versions. It does not include
22882 other headers such as &'Subject:'& etc.
22883
22884 You should be particularly careful about rewriting &'Sender:'& headers, and
22885 restrict this to special known cases in your own domains.
22886
22887
22888 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22889 .cindex "SMTP" "rewriting malformed addresses"
22890 .cindex "RCPT" "rewriting argument of"
22891 .cindex "MAIL" "rewriting argument of"
22892 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22893 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22894 before any other processing; even before syntax checking. The pattern is
22895 required to be a regular expression, and it is matched against the whole of the
22896 data for the command, including any surrounding angle brackets.
22897
22898 .vindex "&$domain$&"
22899 .vindex "&$local_part$&"
22900 This form of rewrite rule allows for the handling of addresses that are not
22901 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22902 input). Because the input is not required to be a syntactically valid address,
22903 the variables &$local_part$& and &$domain$& are not available during the
22904 expansion of the replacement string. The result of rewriting replaces the
22905 original address in the MAIL or RCPT command.
22906
22907
22908 .section "Flags controlling the rewriting process" "SECID155"
22909 There are four flags which control the way the rewriting process works. These
22910 take effect only when a rule is invoked, that is, when the address is of the
22911 correct type (matches the flags) and matches the pattern:
22912
22913 .ilist
22914 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22915 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22916 absence of &"Q"& the rewritten address must always include a domain.
22917 .next
22918 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22919 even if no rewriting actually takes place because of a &"fail"& in the
22920 expansion. The &"q"& flag is not effective if the address is of the wrong type
22921 (does not match the flags) or does not match the pattern.
22922 .next
22923 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22924 address, up to ten times. It can be combined with the &"q"& flag, to stop
22925 rewriting once it fails to match (after at least one successful rewrite).
22926 .next
22927 .cindex "rewriting" "whole addresses"
22928 When an address in a header is rewritten, the rewriting normally applies only
22929 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22930 left unchanged. For example, rewriting might change
22931 .code
22932 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22933 .endd
22934 into
22935 .code
22936 From: Ford Prefect <prefectf@hitch.fict.example>
22937 .endd
22938 .cindex "RFC 2047"
22939 Sometimes there is a need to replace the whole address item, and this can be
22940 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22941 causes an address in a header line to be rewritten, the entire address is
22942 replaced, not just the working part. The replacement must be a complete RFC
22943 2822 address, including the angle brackets if necessary. If text outside angle
22944 brackets contains a character whose value is greater than 126 or less than 32
22945 (except for tab), the text is encoded according to RFC 2047. The character set
22946 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22947
22948 When the &"w"& flag is set on a rule that causes an envelope address to be
22949 rewritten, all but the working part of the replacement address is discarded.
22950 .endlist
22951
22952
22953 .section "Rewriting examples" "SECID156"
22954 Here is an example of the two common rewriting paradigms:
22955 .code
22956 *@*.hitch.fict.example  $1@hitch.fict.example
22957 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22958                      {$value}fail}@hitch.fict.example bctfrF
22959 .endd
22960 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22961 the string expansion to fail if the lookup does not succeed. In this context it
22962 has the effect of leaving the original address unchanged, but Exim goes on to
22963 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22964 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22965 explicitly, which would cause the rewritten address to be the same as before,
22966 at the cost of a small bit of processing. Not supplying either of these is an
22967 error, since the rewritten address would then contain no local part.
22968
22969 The first example above replaces the domain with a superior, more general
22970 domain. This may not be desirable for certain local parts. If the rule
22971 .code
22972 root@*.hitch.fict.example  *
22973 .endd
22974 were inserted before the first rule, rewriting would be suppressed for the
22975 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22976
22977 Rewriting can be made conditional on a number of tests, by making use of
22978 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22979 messages that originate outside the local host:
22980 .code
22981 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22982                          {$1@hitch.fict.example}fail}"
22983 .endd
22984 The replacement string is quoted in this example because it contains white
22985 space.
22986
22987 .cindex "rewriting" "bang paths"
22988 .cindex "bang paths" "rewriting"
22989 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22990 an address it treats it as an unqualified local part which it qualifies with
22991 the local qualification domain (if the source of the message is local or if the
22992 remote host is permitted to send unqualified addresses). Rewriting can
22993 sometimes be used to handle simple bang paths with a fixed number of
22994 components. For example, the rule
22995 .code
22996 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22997 .endd
22998 rewrites a two-component bang path &'host.name!user'& as the domain address
22999 &'user@host.name'&. However, there is a security implication in using this as
23000 a global rewriting rule for envelope addresses. It can provide a backdoor
23001 method for using your system as a relay, because the incoming addresses appear
23002 to be local. If the bang path addresses are received via SMTP, it is safer to
23003 use the &"S"& flag to rewrite them as they are received, so that relay checking
23004 can be done on the rewritten addresses.
23005 .ecindex IIDaddrew
23006
23007
23008
23009
23010
23011 . ////////////////////////////////////////////////////////////////////////////
23012 . ////////////////////////////////////////////////////////////////////////////
23013
23014 .chapter "Retry configuration" "CHAPretry"
23015 .scindex IIDretconf1 "retry" "configuration, description of"
23016 .scindex IIDregconf2 "configuration file" "retry section"
23017 The &"retry"& section of the runtime configuration file contains a list of
23018 retry rules that control how often Exim tries to deliver messages that cannot
23019 be delivered at the first attempt. If there are no retry rules (the section is
23020 empty or not present), there are no retries. In this situation, temporary
23021 errors are treated as permanent. The default configuration contains a single,
23022 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23023 line option can be used to test which retry rule will be used for a given
23024 address, domain and error.
23025
23026 The most common cause of retries is temporary failure to deliver to a remote
23027 host because the host is down, or inaccessible because of a network problem.
23028 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23029 address) basis, not on a per-message basis. Thus, if one message has recently
23030 been delayed, delivery of a new message to the same host is not immediately
23031 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23032 log selector is set, the message
23033 .cindex "retry" "time not reached"
23034 &"retry time not reached"& is written to the main log whenever a delivery is
23035 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23036 the handling of errors during remote deliveries.
23037
23038 Retry processing applies to routing as well as to delivering, except as covered
23039 in the next paragraph. The retry rules do not distinguish between these
23040 actions. It is not possible, for example, to specify different behaviour for
23041 failures to route the domain &'snark.fict.example'& and failures to deliver to
23042 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23043 added complication, so did not implement it. However, although they share the
23044 same retry rule, the actual retry times for routing and transporting a given
23045 domain are maintained independently.
23046
23047 When a delivery is not part of a queue run (typically an immediate delivery on
23048 receipt of a message), the routers are always run, and local deliveries are
23049 always attempted, even if retry times are set for them. This makes for better
23050 behaviour if one particular message is causing problems (for example, causing
23051 quota overflow, or provoking an error in a filter file). If such a delivery
23052 suffers a temporary failure, the retry data is updated as normal, and
23053 subsequent delivery attempts from queue runs occur only when the retry time for
23054 the local address is reached.
23055
23056 .section "Changing retry rules" "SECID157"
23057 If you change the retry rules in your configuration, you should consider
23058 whether or not to delete the retry data that is stored in Exim's spool area in
23059 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23060 always safe; that is why they are called &"hints"&.
23061
23062 The hints retry data contains suggested retry times based on the previous
23063 rules. In the case of a long-running problem with a remote host, it might
23064 record the fact that the host has timed out. If your new rules increase the
23065 timeout time for such a host, you should definitely remove the old retry data
23066 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23067 messages that it should now be retaining.
23068
23069
23070
23071 .section "Format of retry rules" "SECID158"
23072 .cindex "retry" "rules"
23073 Each retry rule occupies one line and consists of three or four parts,
23074 separated by white space: a pattern, an error name, an optional list of sender
23075 addresses, and a list of retry parameters. The pattern and sender lists must be
23076 enclosed in double quotes if they contain white space. The rules are searched
23077 in order until one is found where the pattern, error name, and sender list (if
23078 present) match the failing host or address, the error that occurred, and the
23079 message's sender, respectively.
23080
23081
23082 The pattern is any single item that may appear in an address list (see section
23083 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23084 which means that it is expanded before being tested against the address that
23085 has been delayed. A negated address list item is permitted. Address
23086 list processing treats a plain domain name as if it were preceded by &"*@"&,
23087 which makes it possible for many retry rules to start with just a domain. For
23088 example,
23089 .code
23090 lookingglass.fict.example        *  F,24h,30m;
23091 .endd
23092 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23093 whereas
23094 .code
23095 alice@lookingglass.fict.example  *  F,24h,30m;
23096 .endd
23097 applies only to temporary failures involving the local part &%alice%&.
23098 In practice, almost all rules start with a domain name pattern without a local
23099 part.
23100
23101 .cindex "regular expressions" "in retry rules"
23102 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23103 must match a complete address, not just a domain, because that is how regular
23104 expressions work in address lists.
23105 .display
23106 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23107 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23108 .endd
23109
23110
23111 .section "Choosing which retry rule to use for address errors" "SECID159"
23112 When Exim is looking for a retry rule after a routing attempt has failed (for
23113 example, after a DNS timeout), each line in the retry configuration is tested
23114 against the complete address only if &%retry_use_local_part%& is set for the
23115 router. Otherwise, only the domain is used, except when matching against a
23116 regular expression, when the local part of the address is replaced with &"*"&.
23117 A domain on its own can match a domain pattern, or a pattern that starts with
23118 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23119 &%check_local_user%& is true, and false for other routers.
23120
23121 Similarly, when Exim is looking for a retry rule after a local delivery has
23122 failed (for example, after a mailbox full error), each line in the retry
23123 configuration is tested against the complete address only if
23124 &%retry_use_local_part%& is set for the transport (it defaults true for all
23125 local transports).
23126
23127 .cindex "4&'xx'& responses" "retry rules for"
23128 However, when Exim is looking for a retry rule after a remote delivery attempt
23129 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23130 whole address is always used as the key when searching the retry rules. The
23131 rule that is found is used to create a retry time for the combination of the
23132 failing address and the message's sender. It is the combination of sender and
23133 recipient that is delayed in subsequent queue runs until its retry time is
23134 reached. You can delay the recipient without regard to the sender by setting
23135 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23136 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23137 commands.
23138
23139
23140
23141 .section "Choosing which retry rule to use for host and message errors" &&&
23142          "SECID160"
23143 For a temporary error that is not related to an individual address (for
23144 example, a connection timeout), each line in the retry configuration is checked
23145 twice. First, the name of the remote host is used as a domain name (preceded by
23146 &"*@"& when matching a regular expression). If this does not match the line,
23147 the domain from the email address is tried in a similar fashion. For example,
23148 suppose the MX records for &'a.b.c.example'& are
23149 .code
23150 a.b.c.example  MX  5  x.y.z.example
23151                MX  6  p.q.r.example
23152                MX  7  m.n.o.example
23153 .endd
23154 and the retry rules are
23155 .code
23156 p.q.r.example    *      F,24h,30m;
23157 a.b.c.example    *      F,4d,45m;
23158 .endd
23159 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23160 first rule matches neither the host nor the domain, so Exim looks at the second
23161 rule. This does not match the host, but it does match the domain, so it is used
23162 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23163 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23164 first retry rule is used, because it matches the host.
23165
23166 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23167 first rule to determine retry times, but for all the other hosts for the domain
23168 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23169 routing to &'a.b.c.example'& suffers a temporary failure.
23170
23171 &*Note*&: The host name is used when matching the patterns, not its IP address.
23172 However, if a message is routed directly to an IP address without the use of a
23173 host name, for example, if a &(manualroute)& router contains a setting such as:
23174 .code
23175 route_list = *.a.example  192.168.34.23
23176 .endd
23177 then the &"host name"& that is used when searching for a retry rule is the
23178 textual form of the IP address.
23179
23180 .section "Retry rules for specific errors" "SECID161"
23181 .cindex "retry" "specific errors; specifying"
23182 The second field in a retry rule is the name of a particular error, or an
23183 asterisk, which matches any error. The errors that can be tested for are:
23184
23185 .vlist
23186 .vitem &%auth_failed%&
23187 Authentication failed when trying to send to a host in the
23188 &%hosts_require_auth%& list in an &(smtp)& transport.
23189
23190 .vitem &%data_4xx%&
23191 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23192 after the command, or after sending the message's data.
23193
23194 .vitem &%mail_4xx%&
23195 A 4&'xx'& error was received for an outgoing MAIL command.
23196
23197 .vitem &%rcpt_4xx%&
23198 A 4&'xx'& error was received for an outgoing RCPT command.
23199 .endlist
23200
23201 For the three 4&'xx'& errors, either the first or both of the x's can be given
23202 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23203 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23204 and have retries every ten minutes with a one-hour timeout, you could set up a
23205 retry rule of this form:
23206 .code
23207 the.domain.name  rcpt_452   F,1h,10m
23208 .endd
23209 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23210 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23211
23212 .vlist
23213 .vitem &%lost_connection%&
23214 A server unexpectedly closed the SMTP connection. There may, of course,
23215 legitimate reasons for this (host died, network died), but if it repeats a lot
23216 for the same host, it indicates something odd.
23217
23218 .vitem &%refused_MX%&
23219 A connection to a host obtained from an MX record was refused.
23220
23221 .vitem &%refused_A%&
23222 A connection to a host not obtained from an MX record was refused.
23223
23224 .vitem &%refused%&
23225 A connection was refused.
23226
23227 .vitem &%timeout_connect_MX%&
23228 A connection attempt to a host obtained from an MX record timed out.
23229
23230 .vitem &%timeout_connect_A%&
23231 A connection attempt to a host not obtained from an MX record timed out.
23232
23233 .vitem &%timeout_connect%&
23234 A connection attempt timed out.
23235
23236 .vitem &%timeout_MX%&
23237 There was a timeout while connecting or during an SMTP session with a host
23238 obtained from an MX record.
23239
23240 .vitem &%timeout_A%&
23241 There was a timeout while connecting or during an SMTP session with a host not
23242 obtained from an MX record.
23243
23244 .vitem &%timeout%&
23245 There was a timeout while connecting or during an SMTP session.
23246
23247 .vitem &%tls_required%&
23248 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23249 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23250 to STARTTLS, or there was a problem setting up the TLS connection.
23251
23252 .vitem &%quota%&
23253 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23254 transport.
23255
23256 .vitem &%quota_%&<&'time'&>
23257 .cindex "quota" "error testing in retry rule"
23258 .cindex "retry" "quota error testing"
23259 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23260 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23261 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23262 for four days.
23263 .endlist
23264
23265 .cindex "mailbox" "time of last read"
23266 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23267 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23268 it should be based on the last time that the user accessed the mailbox.
23269 However, it is not always possible to determine this. Exim uses the following
23270 heuristic rules:
23271
23272 .ilist
23273 If the mailbox is a single file, the time of last access (the &"atime"&) is
23274 used. As no new messages are being delivered (because the mailbox is over
23275 quota), Exim does not access the file, so this is the time of last user access.
23276 .next
23277 .cindex "maildir format" "time of last read"
23278 For a maildir delivery, the time of last modification of the &_new_&
23279 subdirectory is used. As the mailbox is over quota, no new files are created in
23280 the &_new_& subdirectory, because no new messages are being delivered. Any
23281 change to the &_new_& subdirectory is therefore assumed to be the result of an
23282 MUA moving a new message to the &_cur_& directory when it is first read. The
23283 time that is used is therefore the last time that the user read a new message.
23284 .next
23285 For other kinds of multi-file mailbox, the time of last access cannot be
23286 obtained, so a retry rule that uses this type of error field is never matched.
23287 .endlist
23288
23289 The quota errors apply both to system-enforced quotas and to Exim's own quota
23290 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23291 when a local delivery is deferred because a partition is full (the ENOSPC
23292 error).
23293
23294
23295
23296 .section "Retry rules for specified senders" "SECID162"
23297 .cindex "retry" "rules; sender-specific"
23298 You can specify retry rules that apply only when the failing message has a
23299 specific sender. In particular, this can be used to define retry rules that
23300 apply only to bounce messages. The third item in a retry rule can be of this
23301 form:
23302 .display
23303 &`senders=`&<&'address list'&>
23304 .endd
23305 The retry timings themselves are then the fourth item. For example:
23306 .code
23307 *   rcpt_4xx   senders=:   F,1h,30m
23308 .endd
23309 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23310 host. If the address list contains white space, it must be enclosed in quotes.
23311 For example:
23312 .code
23313 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23314 .endd
23315 &*Warning*&: This facility can be unhelpful if it is used for host errors
23316 (which do not depend on the recipient). The reason is that the sender is used
23317 only to match the retry rule. Once the rule has been found for a host error,
23318 its contents are used to set a retry time for the host, and this will apply to
23319 all messages, not just those with specific senders.
23320
23321 When testing retry rules using &%-brt%&, you can supply a sender using the
23322 &%-f%& command line option, like this:
23323 .code
23324 exim -f "" -brt user@dom.ain
23325 .endd
23326 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23327 list is never matched.
23328
23329
23330
23331
23332
23333 .section "Retry parameters" "SECID163"
23334 .cindex "retry" "parameters in rules"
23335 The third (or fourth, if a senders list is present) field in a retry rule is a
23336 sequence of retry parameter sets, separated by semicolons. Each set consists of
23337 .display
23338 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23339 .endd
23340 The letter identifies the algorithm for computing a new retry time; the cutoff
23341 time is the time beyond which this algorithm no longer applies, and the
23342 arguments vary the algorithm's action. The cutoff time is measured from the
23343 time that the first failure for the domain (combined with the local part if
23344 relevant) was detected, not from the time the message was received.
23345
23346 .cindex "retry" "algorithms"
23347 .cindex "retry" "fixed intervals"
23348 .cindex "retry" "increasing intervals"
23349 .cindex "retry" "random intervals"
23350 The available algorithms are:
23351
23352 .ilist
23353 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23354 the interval.
23355 .next
23356 &'G'&: retry at geometrically increasing intervals. The first argument
23357 specifies a starting value for the interval, and the second a multiplier, which
23358 is used to increase the size of the interval at each retry.
23359 .next
23360 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23361 retry, the previous interval is multiplied by the factor in order to get a
23362 maximum for the next interval. The minimum interval is the first argument of
23363 the parameter, and an actual interval is chosen randomly between them. Such a
23364 rule has been found to be helpful in cluster configurations when all the
23365 members of the cluster restart at once, and may therefore synchronize their
23366 queue processing times.
23367 .endlist
23368
23369 When computing the next retry time, the algorithm definitions are scanned in
23370 order until one whose cutoff time has not yet passed is reached. This is then
23371 used to compute a new retry time that is later than the current time. In the
23372 case of fixed interval retries, this simply means adding the interval to the
23373 current time. For geometrically increasing intervals, retry intervals are
23374 computed from the rule's parameters until one that is greater than the previous
23375 interval is found. The main configuration variable
23376 .cindex "limit" "retry interval"
23377 .cindex "retry" "interval, maximum"
23378 .oindex "&%retry_interval_max%&"
23379 &%retry_interval_max%& limits the maximum interval between retries. It
23380 cannot be set greater than &`24h`&, which is its default value.
23381
23382 A single remote domain may have a number of hosts associated with it, and each
23383 host may have more than one IP address. Retry algorithms are selected on the
23384 basis of the domain name, but are applied to each IP address independently. If,
23385 for example, a host has two IP addresses and one is unusable, Exim will
23386 generate retry times for it and will not try to use it until its next retry
23387 time comes. Thus the good IP address is likely to be tried first most of the
23388 time.
23389
23390 .cindex "hints database" "use for retrying"
23391 Retry times are hints rather than promises. Exim does not make any attempt to
23392 run deliveries exactly at the computed times. Instead, a queue runner process
23393 starts delivery processes for delayed messages periodically, and these attempt
23394 new deliveries only for those addresses that have passed their next retry time.
23395 If a new message arrives for a deferred address, an immediate delivery attempt
23396 occurs only if the address has passed its retry time. In the absence of new
23397 messages, the minimum time between retries is the interval between queue runner
23398 processes. There is not much point in setting retry times of five minutes if
23399 your queue runners happen only once an hour, unless there are a significant
23400 number of incoming messages (which might be the case on a system that is
23401 sending everything to a smart host, for example).
23402
23403 The data in the retry hints database can be inspected by using the
23404 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23405 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23406 &'exinext'& utility script can be used to find out what the next retry times
23407 are for the hosts associated with a particular mail domain, and also for local
23408 deliveries that have been deferred.
23409
23410
23411 .section "Retry rule examples" "SECID164"
23412 Here are some example retry rules:
23413 .code
23414 alice@wonderland.fict.example quota_5d  F,7d,3h
23415 wonderland.fict.example       quota_5d
23416 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23417 lookingglass.fict.example     *         F,24h,30m;
23418 *                 refused_A   F,2h,20m;
23419 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23420 .endd
23421 The first rule sets up special handling for mail to
23422 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23423 mailbox has not been read for at least 5 days. Retries continue every three
23424 hours for 7 days. The second rule handles over-quota errors for all other local
23425 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23426 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23427 fail are bounced immediately if the mailbox has not been read for at least 5
23428 days.
23429
23430 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23431 happen every 15 minutes for an hour, then with geometrically increasing
23432 intervals until two days have passed since a delivery first failed. After the
23433 first hour there is a delay of one hour, then two hours, then four hours, and
23434 so on (this is a rather extreme example).
23435
23436 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23437 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23438 all other domains, with special action for connection refusal from hosts that
23439 were not obtained from an MX record.
23440
23441 The final rule in a retry configuration should always have asterisks in the
23442 first two fields so as to provide a general catch-all for any addresses that do
23443 not have their own special handling. This example tries every 15 minutes for 2
23444 hours, then with intervals starting at one hour and increasing by a factor of
23445 1.5 up to 16 hours, then every 8 hours up to 5 days.
23446
23447
23448
23449 .section "Timeout of retry data" "SECID165"
23450 .cindex "timeout" "of retry data"
23451 .oindex "&%retry_data_expire%&"
23452 .cindex "hints database" "data expiry"
23453 .cindex "retry" "timeout of data"
23454 Exim timestamps the data that it writes to its retry hints database. When it
23455 consults the data during a delivery it ignores any that is older than the value
23456 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23457 been tried for 7 days, Exim will try to deliver to it immediately a message
23458 arrives, and if that fails, it will calculate a retry time as if it were
23459 failing for the first time.
23460
23461 This improves the behaviour for messages routed to rarely-used hosts such as MX
23462 backups. If such a host was down at one time, and happens to be down again when
23463 Exim tries a month later, using the old retry data would imply that it had been
23464 down all the time, which is not a justified assumption.
23465
23466 If a host really is permanently dead, this behaviour causes a burst of retries
23467 every now and again, but only if messages routed to it are rare. If there is a
23468 message at least once every 7 days the retry data never expires.
23469
23470
23471
23472
23473 .section "Long-term failures" "SECID166"
23474 .cindex "delivery failure, long-term"
23475 .cindex "retry" "after long-term failure"
23476 Special processing happens when an email address has been failing for so long
23477 that the cutoff time for the last algorithm is reached. For example, using the
23478 default retry rule:
23479 .code
23480 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23481 .endd
23482 the cutoff time is four days. Reaching the retry cutoff is independent of how
23483 long any specific message has been failing; it is the length of continuous
23484 failure for the recipient address that counts.
23485
23486 When the cutoff time is reached for a local delivery, or for all the IP
23487 addresses associated with a remote delivery, a subsequent delivery failure
23488 causes Exim to give up on the address, and a bounce message is generated.
23489 In order to cater for new messages that use the failing address, a next retry
23490 time is still computed from the final algorithm, and is used as follows:
23491
23492 For local deliveries, one delivery attempt is always made for any subsequent
23493 messages. If this delivery fails, the address fails immediately. The
23494 post-cutoff retry time is not used.
23495
23496 If the delivery is remote, there are two possibilities, controlled by the
23497 .oindex "&%delay_after_cutoff%&"
23498 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23499 default. Until the post-cutoff retry time for one of the IP addresses is
23500 reached, the failing email address is bounced immediately, without a delivery
23501 attempt taking place. After that time, one new delivery attempt is made to
23502 those IP addresses that are past their retry times, and if that still fails,
23503 the address is bounced and new retry times are computed.
23504
23505 In other words, when all the hosts for a given email address have been failing
23506 for a long time, Exim bounces rather then defers until one of the hosts' retry
23507 times is reached. Then it tries once, and bounces if that attempt fails. This
23508 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23509 to a broken destination, but if the host does recover, Exim will eventually
23510 notice.
23511
23512 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23513 addresses are past their final cutoff time, Exim tries to deliver to those IP
23514 addresses that have not been tried since the message arrived. If there are
23515 no suitable IP addresses, or if they all fail, the address is bounced. In other
23516 words, it does not delay when a new message arrives, but tries the expired
23517 addresses immediately, unless they have been tried since the message arrived.
23518 If there is a continuous stream of messages for the failing domains, setting
23519 &%delay_after_cutoff%& false means that there will be many more attempts to
23520 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23521 true.
23522
23523 .section "Deliveries that work intermittently" "SECID167"
23524 .cindex "retry" "intermittently working deliveries"
23525 Some additional logic is needed to cope with cases where a host is
23526 intermittently available, or when a message has some attribute that prevents
23527 its delivery when others to the same address get through. In this situation,
23528 because some messages are successfully delivered, the &"retry clock"& for the
23529 host or address keeps getting reset by the successful deliveries, and so
23530 failing messages remain on the queue for ever because the cutoff time is never
23531 reached.
23532
23533 Two exceptional actions are applied to prevent this happening. The first
23534 applies to errors that are related to a message rather than a remote host.
23535 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23536 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23537 commands, and quota failures. For this type of error, if a message's arrival
23538 time is earlier than the &"first failed"& time for the error, the earlier time
23539 is used when scanning the retry rules to decide when to try next and when to
23540 time out the address.
23541
23542 The exceptional second action applies in all cases. If a message has been on
23543 the queue for longer than the cutoff time of any applicable retry rule for a
23544 given address, a delivery is attempted for that address, even if it is not yet
23545 time, and if this delivery fails, the address is timed out. A new retry time is
23546 not computed in this case, so that other messages for the same address are
23547 considered immediately.
23548 .ecindex IIDretconf1
23549 .ecindex IIDregconf2
23550
23551
23552
23553
23554
23555
23556 . ////////////////////////////////////////////////////////////////////////////
23557 . ////////////////////////////////////////////////////////////////////////////
23558
23559 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23560 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23561 .scindex IIDauthconf2 "authentication"
23562 The &"authenticators"& section of Exim's run time configuration is concerned
23563 with SMTP authentication. This facility is an extension to the SMTP protocol,
23564 described in RFC 2554, which allows a client SMTP host to authenticate itself
23565 to a server. This is a common way for a server to recognize clients that are
23566 permitted to use it as a relay. SMTP authentication is not of relevance to the
23567 transfer of mail between servers that have no managerial connection with each
23568 other.
23569
23570 .cindex "AUTH" "description of"
23571 Very briefly, the way SMTP authentication works is as follows:
23572
23573 .ilist
23574 The server advertises a number of authentication &'mechanisms'& in response to
23575 the client's EHLO command.
23576 .next
23577 The client issues an AUTH command, naming a specific mechanism. The command
23578 may, optionally, contain some authentication data.
23579 .next
23580 The server may issue one or more &'challenges'&, to which the client must send
23581 appropriate responses. In simple authentication mechanisms, the challenges are
23582 just prompts for user names and passwords. The server does not have to issue
23583 any challenges &-- in some mechanisms the relevant data may all be transmitted
23584 with the AUTH command.
23585 .next
23586 The server either accepts or denies authentication.
23587 .next
23588 If authentication succeeds, the client may optionally make use of the AUTH
23589 option on the MAIL command to pass an authenticated sender in subsequent
23590 mail transactions. Authentication lasts for the remainder of the SMTP
23591 connection.
23592 .next
23593 If authentication fails, the client may give up, or it may try a different
23594 authentication mechanism, or it may try transferring mail over the
23595 unauthenticated connection.
23596 .endlist
23597
23598 If you are setting up a client, and want to know which authentication
23599 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23600 SMTP port) on the server, and issue an EHLO command. The response to this
23601 includes the list of supported mechanisms. For example:
23602 .display
23603 &`$ `&&*&`telnet server.example 25`&*&
23604 &`Trying 192.168.34.25...`&
23605 &`Connected to server.example.`&
23606 &`Escape character is &#x0027;^]&#x0027;.`&
23607 &`220 server.example ESMTP Exim 4.20 ...`&
23608 &*&`ehlo client.example`&*&
23609 &`250-server.example Hello client.example [10.8.4.5]`&
23610 &`250-SIZE 52428800`&
23611 &`250-PIPELINING`&
23612 &`250-AUTH PLAIN`&
23613 &`250 HELP`&
23614 .endd
23615 The second-last line of this example output shows that the server supports
23616 authentication using the PLAIN mechanism. In Exim, the different authentication
23617 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23618 routers and transports, which authenticators are included in the binary is
23619 controlled by build-time definitions. The following are currently available,
23620 included by setting
23621 .code
23622 AUTH_CRAM_MD5=yes
23623 AUTH_CYRUS_SASL=yes
23624 .new
23625 AUTH_DOVECOT=yes
23626 AUTH_GSASL=yes
23627 AUTH_HEIMDAL_GSSAPI=yes
23628 .wen
23629 AUTH_PLAINTEXT=yes
23630 AUTH_SPA=yes
23631 .endd
23632 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23633 authentication mechanism (RFC 2195), and the second provides an interface to
23634 the Cyrus SASL authentication library.
23635 .new
23636 The third is an interface to Dovecot's authentication system, delegating the
23637 work via a socket interface.
23638 The fourth provides an interface to the GNU SASL authentication library, which
23639 provides mechanisms but typically not data sources.
23640 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
23641 supporting setting a server keytab.
23642 The sixth can be configured to support
23643 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23644 not formally documented, but used by several MUAs. The seventh authenticator
23645 supports Microsoft's &'Secure Password Authentication'& mechanism.
23646 .wen
23647
23648 The authenticators are configured using the same syntax as other drivers (see
23649 section &<<SECTfordricon>>&). If no authenticators are required, no
23650 authentication section need be present in the configuration file. Each
23651 authenticator can in principle have both server and client functions. When Exim
23652 is receiving SMTP mail, it is acting as a server; when it is sending out
23653 messages over SMTP, it is acting as a client. Authenticator configuration
23654 options are provided for use in both these circumstances.
23655
23656 To make it clear which options apply to which situation, the prefixes
23657 &%server_%& and &%client_%& are used on option names that are specific to
23658 either the server or the client function, respectively. Server and client
23659 functions are disabled if none of their options are set. If an authenticator is
23660 to be used for both server and client functions, a single definition, using
23661 both sets of options, is required. For example:
23662 .code
23663 cram:
23664   driver = cram_md5
23665   public_name = CRAM-MD5
23666   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23667   client_name = ph10
23668   client_secret = secret2
23669 .endd
23670 The &%server_%& option is used when Exim is acting as a server, and the
23671 &%client_%& options when it is acting as a client.
23672
23673 Descriptions of the individual authenticators are given in subsequent chapters.
23674 The remainder of this chapter covers the generic options for the
23675 authenticators, followed by general discussion of the way authentication works
23676 in Exim.
23677
23678 .new
23679 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
23680 per-mechanism basis.  Please read carefully to determine which variables hold
23681 account labels such as usercodes and which hold passwords or other
23682 authenticating data.
23683
23684 Note that some mechanisms support two different identifiers for accounts: the
23685 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
23686 and &'authz'& are commonly encountered.  The American spelling is standard here.
23687 Conceptually, authentication data such as passwords are tied to the identifier
23688 used to authenticate; servers may have rules to permit one user to act as a
23689 second user, so that after login the session is treated as though that second
23690 user had logged in.  That second user is the &'authorization id'&.  A robust
23691 configuration might confirm that the &'authz'& field is empty or matches the
23692 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
23693 as verified data, the &'authz'& as an unverified request which the server might
23694 choose to honour.
23695
23696 A &'realm'& is a text string, typically a domain name, presented by a server
23697 to a client to help it select an account and credentials to use.  In some
23698 mechanisms, the client and server provably agree on the realm, but clients
23699 typically can not treat the realm as secure data to be blindly trusted.
23700 .wen
23701
23702
23703
23704 .section "Generic options for authenticators" "SECID168"
23705 .cindex "authentication" "generic options"
23706 .cindex "options" "generic; for authenticators"
23707
23708 .option client_condition authenticators string&!! unset
23709 When Exim is authenticating as a client, it skips any authenticator whose
23710 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23711 used, for example, to skip plain text authenticators when the connection is not
23712 encrypted by a setting such as:
23713 .code
23714 client_condition = ${if !eq{$tls_cipher}{}}
23715 .endd
23716 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23717 used for incoming messages. In fact, during SMTP delivery, it contains the
23718 cipher used for the delivery.)
23719
23720
23721 .option driver authenticators string unset
23722 This option must always be set. It specifies which of the available
23723 authenticators is to be used.
23724
23725
23726 .option public_name authenticators string unset
23727 This option specifies the name of the authentication mechanism that the driver
23728 implements, and by which it is known to the outside world. These names should
23729 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23730 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23731 defaults to the driver's instance name.
23732
23733
23734 .option server_advertise_condition authenticators string&!! unset
23735 When a server is about to advertise an authentication mechanism, the condition
23736 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23737 mechanism is not advertised.
23738 If the expansion fails, the mechanism is not advertised. If the failure was not
23739 forced, and was not caused by a lookup defer, the incident is logged.
23740 See section &<<SECTauthexiser>>& below for further discussion.
23741
23742
23743 .option server_condition authenticators string&!! unset
23744 This option must be set for a &%plaintext%& server authenticator, where it
23745 is used directly to control authentication. See section &<<SECTplainserver>>&
23746 for details.
23747
23748 .new
23749 For the &(gsasl)& authenticator, this option is required for various
23750 mechanisms; see chapter &<<CHAPgsasl>>& for details.
23751 .wen
23752
23753 For the other authenticators, &%server_condition%& can be used as an additional
23754 authentication or authorization mechanism that is applied after the other
23755 authenticator conditions succeed. If it is set, it is expanded when the
23756 authenticator would otherwise return a success code. If the expansion is forced
23757 to fail, authentication fails. Any other expansion failure causes a temporary
23758 error code to be returned. If the result of a successful expansion is an empty
23759 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23760 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23761 other result, a temporary error code is returned, with the expanded string as
23762 the error text.
23763
23764
23765 .option server_debug_print authenticators string&!! unset
23766 If this option is set and authentication debugging is enabled (see the &%-d%&
23767 command line option), the string is expanded and included in the debugging
23768 output when the authenticator is run as a server. This can help with checking
23769 out the values of variables.
23770 If expansion of the string fails, the error message is written to the debugging
23771 output, and Exim carries on processing.
23772
23773
23774 .option server_set_id authenticators string&!! unset
23775 .vindex "&$authenticated_id$&"
23776 When an Exim server successfully authenticates a client, this string is
23777 expanded using data from the authentication, and preserved for any incoming
23778 messages in the variable &$authenticated_id$&. It is also included in the log
23779 lines for incoming messages. For example, a user/password authenticator
23780 configuration might preserve the user name that was used to authenticate, and
23781 refer to it subsequently during delivery of the message.
23782 If expansion fails, the option is ignored.
23783
23784
23785 .option server_mail_auth_condition authenticators string&!! unset
23786 This option allows a server to discard authenticated sender addresses supplied
23787 as part of MAIL commands in SMTP connections that are authenticated by the
23788 driver on which &%server_mail_auth_condition%& is set. The option is not used
23789 as part of the authentication process; instead its (unexpanded) value is
23790 remembered for later use.
23791 How it is used is described in the following section.
23792
23793
23794
23795
23796
23797 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23798 .cindex "authentication" "sender; authenticated"
23799 .cindex "AUTH" "on MAIL command"
23800 When a client supplied an AUTH= item on a MAIL command, Exim applies
23801 the following checks before accepting it as the authenticated sender of the
23802 message:
23803
23804 .ilist
23805 If the connection is not using extended SMTP (that is, HELO was used rather
23806 than EHLO), the use of AUTH= is a syntax error.
23807 .next
23808 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23809 .next
23810 .vindex "&$authenticated_sender$&"
23811 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23812 running, the value of &$authenticated_sender$& is set to the value obtained
23813 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23814 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23815 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23816 given for the MAIL command.
23817 .next
23818 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23819 is accepted and placed in &$authenticated_sender$& only if the client has
23820 authenticated.
23821 .next
23822 If the AUTH= value was accepted by either of the two previous rules, and
23823 the client has authenticated, and the authenticator has a setting for the
23824 &%server_mail_auth_condition%&, the condition is checked at this point. The
23825 valued that was saved from the authenticator is expanded. If the expansion
23826 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23827 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23828 the value of &$authenticated_sender$& is retained and passed on with the
23829 message.
23830 .endlist
23831
23832
23833 When &$authenticated_sender$& is set for a message, it is passed on to other
23834 hosts to which Exim authenticates as a client. Do not confuse this value with
23835 &$authenticated_id$&, which is a string obtained from the authentication
23836 process, and which is not usually a complete email address.
23837
23838 .vindex "&$sender_address$&"
23839 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23840 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23841 therefore make use of &$authenticated_sender$&. The converse is not true: the
23842 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23843 ACL is run.
23844
23845
23846
23847 .section "Authentication on an Exim server" "SECTauthexiser"
23848 .cindex "authentication" "on an Exim server"
23849 When Exim receives an EHLO command, it advertises the public names of those
23850 authenticators that are configured as servers, subject to the following
23851 conditions:
23852
23853 .ilist
23854 The client host must match &%auth_advertise_hosts%& (default *).
23855 .next
23856 It the &%server_advertise_condition%& option is set, its expansion must not
23857 yield the empty string, &"0"&, &"no"&, or &"false"&.
23858 .endlist
23859
23860 The order in which the authenticators are defined controls the order in which
23861 the mechanisms are advertised.
23862
23863 Some mail clients (for example, some versions of Netscape) require the user to
23864 provide a name and password for authentication whenever AUTH is advertised,
23865 even though authentication may not in fact be needed (for example, Exim may be
23866 set up to allow unconditional relaying from the client by an IP address check).
23867 You can make such clients more friendly by not advertising AUTH to them.
23868 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23869 that runs for RCPT) to relay without authentication, you should set
23870 .code
23871 auth_advertise_hosts = ! 10.9.8.0/24
23872 .endd
23873 so that no authentication mechanisms are advertised to them.
23874
23875 The &%server_advertise_condition%& controls the advertisement of individual
23876 authentication mechanisms. For example, it can be used to restrict the
23877 advertisement of a particular mechanism to encrypted connections, by a setting
23878 such as:
23879 .code
23880 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23881 .endd
23882 .vindex "&$tls_cipher$&"
23883 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23884 yields &"yes"&, which allows the advertisement to happen.
23885
23886 When an Exim server receives an AUTH command from a client, it rejects it
23887 immediately if AUTH was not advertised in response to an earlier EHLO
23888 command. This is the case if
23889
23890 .ilist
23891 The client host does not match &%auth_advertise_hosts%&; or
23892 .next
23893 No authenticators are configured with server options; or
23894 .next
23895 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23896 server authenticators.
23897 .endlist
23898
23899
23900 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23901 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23902 AUTH is accepted from any client host.
23903
23904 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23905 server authentication mechanism that was advertised in response to EHLO and
23906 that matches the one named in the AUTH command. If it finds one, it runs
23907 the appropriate authentication protocol, and authentication either succeeds or
23908 fails. If there is no matching advertised mechanism, the AUTH command is
23909 rejected with a 504 error.
23910
23911 .vindex "&$received_protocol$&"
23912 .vindex "&$sender_host_authenticated$&"
23913 When a message is received from an authenticated host, the value of
23914 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23915 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23916 public name) of the authenticator driver that successfully authenticated the
23917 client from which the message was received. This variable is empty if there was
23918 no successful authentication.
23919
23920
23921
23922
23923 .section "Testing server authentication" "SECID169"
23924 .cindex "authentication" "testing a server"
23925 .cindex "AUTH" "testing a server"
23926 .cindex "base64 encoding" "creating authentication test data"
23927 Exim's &%-bh%& option can be useful for testing server authentication
23928 configurations. The data for the AUTH command has to be sent using base64
23929 encoding. A quick way to produce such data for testing is the following Perl
23930 script:
23931 .code
23932 use MIME::Base64;
23933 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23934 .endd
23935 .cindex "binary zero" "in authentication data"
23936 This interprets its argument as a Perl string, and then encodes it. The
23937 interpretation as a Perl string allows binary zeros, which are required for
23938 some kinds of authentication, to be included in the data. For example, a
23939 command line to run this script on such data might be
23940 .code
23941 encode '\0user\0password'
23942 .endd
23943 Note the use of single quotes to prevent the shell interpreting the
23944 backslashes, so that they can be interpreted by Perl to specify characters
23945 whose code value is zero.
23946
23947 &*Warning 1*&: If either of the user or password strings starts with an octal
23948 digit, you must use three zeros instead of one after the leading backslash. If
23949 you do not, the octal digit that starts your string will be incorrectly
23950 interpreted as part of the code for the first character.
23951
23952 &*Warning 2*&: If there are characters in the strings that Perl interprets
23953 specially, you must use a Perl escape to prevent them being misinterpreted. For
23954 example, a command such as
23955 .code
23956 encode '\0user@domain.com\0pas$$word'
23957 .endd
23958 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23959
23960 If you have the &%mimencode%& command installed, another way to do produce
23961 base64-encoded strings is to run the command
23962 .code
23963 echo -e -n `\0user\0password' | mimencode
23964 .endd
23965 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23966 in the argument, and the &%-n%& option specifies no newline at the end of its
23967 output. However, not all versions of &%echo%& recognize these options, so you
23968 should check your version before relying on this suggestion.
23969
23970
23971
23972 .section "Authentication by an Exim client" "SECID170"
23973 .cindex "authentication" "on an Exim client"
23974 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23975 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23976 announces support for authentication, and the host matches an entry in either
23977 of these options, Exim (as a client) tries to authenticate as follows:
23978
23979 .ilist
23980 For each authenticator that is configured as a client, in the order in which
23981 they are defined in the configuration, it searches the authentication
23982 mechanisms announced by the server for one whose name matches the public name
23983 of the authenticator.
23984 .next
23985 .vindex "&$host$&"
23986 .vindex "&$host_address$&"
23987 When it finds one that matches, it runs the authenticator's client code. The
23988 variables &$host$& and &$host_address$& are available for any string expansions
23989 that the client might do. They are set to the server's name and IP address. If
23990 any expansion is forced to fail, the authentication attempt is abandoned, and
23991 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23992 delivery to be deferred.
23993 .next
23994 If the result of the authentication attempt is a temporary error or a timeout,
23995 Exim abandons trying to send the message to the host for the moment. It will
23996 try again later. If there are any backup hosts available, they are tried in the
23997 usual way.
23998 .next
23999 If the response to authentication is a permanent error (5&'xx'& code), Exim
24000 carries on searching the list of authenticators and tries another one if
24001 possible. If all authentication attempts give permanent errors, or if there are
24002 no attempts because no mechanisms match (or option expansions force failure),
24003 what happens depends on whether the host matches &%hosts_require_auth%& or
24004 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24005 delivery is deferred. The error can be detected in the retry rules, and thereby
24006 turned into a permanent error if you wish. In the second case, Exim tries to
24007 deliver the message unauthenticated.
24008 .endlist
24009
24010 .cindex "AUTH" "on MAIL command"
24011 When Exim has authenticated itself to a remote server, it adds the AUTH
24012 parameter to the MAIL commands it sends, if it has an authenticated sender for
24013 the message. If the message came from a remote host, the authenticated sender
24014 is the one that was receiving on an incoming MAIL command, provided that the
24015 incoming connection was authenticated and the &%server_mail_auth%& condition
24016 allowed the authenticated sender to be retained. If a local process calls Exim
24017 to send a message, the sender address that is built from the login name and
24018 &%qualify_domain%& is treated as authenticated. However, if the
24019 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24020 the authenticated sender that was received with the message.
24021 .ecindex IIDauthconf1
24022 .ecindex IIDauthconf2
24023
24024
24025
24026
24027
24028
24029 . ////////////////////////////////////////////////////////////////////////////
24030 . ////////////////////////////////////////////////////////////////////////////
24031
24032 .chapter "The plaintext authenticator" "CHAPplaintext"
24033 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24034 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24035 The &(plaintext)& authenticator can be configured to support the PLAIN and
24036 LOGIN authentication mechanisms, both of which transfer authentication data as
24037 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24038 security risk; you are strongly advised to insist on the use of SMTP encryption
24039 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24040 use unencrypted plain text, you should not use the same passwords for SMTP
24041 connections as you do for login accounts.
24042
24043 .section "Plaintext options" "SECID171"
24044 .cindex "options" "&(plaintext)& authenticator (server)"
24045 When configured as a server, &(plaintext)& uses the following options:
24046
24047 .option server_condition authenticators string&!! unset
24048 This is actually a global authentication option, but it must be set in order to
24049 configure the &(plaintext)& driver as a server. Its use is described below.
24050
24051 .option server_prompts plaintext string&!! unset
24052 The contents of this option, after expansion, must be a colon-separated list of
24053 prompt strings. If expansion fails, a temporary authentication rejection is
24054 given.
24055
24056 .section "Using plaintext in a server" "SECTplainserver"
24057 .cindex "AUTH" "in &(plaintext)& authenticator"
24058 .cindex "binary zero" "in &(plaintext)& authenticator"
24059 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24060         "in &(plaintext)& authenticator"
24061 .vindex "&$auth1$&, &$auth2$&, etc"
24062 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24063
24064 When running as a server, &(plaintext)& performs the authentication test by
24065 expanding a string. The data sent by the client with the AUTH command, or in
24066 response to subsequent prompts, is base64 encoded, and so may contain any byte
24067 values when decoded. If any data is supplied with the command, it is treated as
24068 a list of strings, separated by NULs (binary zeros), the first three of which
24069 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24070 (neither LOGIN nor PLAIN uses more than three strings).
24071
24072 For compatibility with previous releases of Exim, the values are also placed in
24073 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24074 variables for this purpose is now deprecated, as it can lead to confusion in
24075 string expansions that also use them for other things.
24076
24077 If there are more strings in &%server_prompts%& than the number of strings
24078 supplied with the AUTH command, the remaining prompts are used to obtain more
24079 data. Each response from the client may be a list of NUL-separated strings.
24080
24081 .vindex "&$authenticated_id$&"
24082 Once a sufficient number of data strings have been received,
24083 &%server_condition%& is expanded. If the expansion is forced to fail,
24084 authentication fails. Any other expansion failure causes a temporary error code
24085 to be returned. If the result of a successful expansion is an empty string,
24086 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24087 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24088 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24089 For any other result, a temporary error code is returned, with the expanded
24090 string as the error text.
24091
24092 &*Warning*&: If you use a lookup in the expansion to find the user's
24093 password, be sure to make the authentication fail if the user is unknown.
24094 There are good and bad examples at the end of the next section.
24095
24096
24097
24098 .section "The PLAIN authentication mechanism" "SECID172"
24099 .cindex "PLAIN authentication mechanism"
24100 .cindex "authentication" "PLAIN mechanism"
24101 .cindex "binary zero" "in &(plaintext)& authenticator"
24102 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24103 sent as one item of data (that is, one combined string containing two NUL
24104 separators). The data is sent either as part of the AUTH command, or
24105 subsequently in response to an empty prompt from the server.
24106
24107 The second and third strings are a user name and a corresponding password.
24108 Using a single fixed user name and password as an example, this could be
24109 configured as follows:
24110 .code
24111 fixed_plain:
24112   driver = plaintext
24113   public_name = PLAIN
24114   server_prompts = :
24115   server_condition = \
24116     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24117   server_set_id = $auth2
24118 .endd
24119 Note that the default result strings from &%if%& (&"true"& or an empty string)
24120 are exactly what we want here, so they need not be specified. Obviously, if the
24121 password contains expansion-significant characters such as dollar, backslash,
24122 or closing brace, they have to be escaped.
24123
24124 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24125 the end of a string list are ignored). If all the data comes as part of the
24126 AUTH command, as is commonly the case, the prompt is not used. This
24127 authenticator is advertised in the response to EHLO as
24128 .code
24129 250-AUTH PLAIN
24130 .endd
24131 and a client host can authenticate itself by sending the command
24132 .code
24133 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24134 .endd
24135 As this contains three strings (more than the number of prompts), no further
24136 data is required from the client. Alternatively, the client may just send
24137 .code
24138 AUTH PLAIN
24139 .endd
24140 to initiate authentication, in which case the server replies with an empty
24141 prompt. The client must respond with the combined data string.
24142
24143 The data string is base64 encoded, as required by the RFC. This example,
24144 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24145 represents a zero byte. This is split up into three strings, the first of which
24146 is empty. The &%server_condition%& option in the authenticator checks that the
24147 second two are &`username`& and &`mysecret`& respectively.
24148
24149 Having just one fixed user name and password, as in this example, is not very
24150 realistic, though for a small organization with only a handful of
24151 authenticating clients it could make sense.
24152
24153 A more sophisticated instance of this authenticator could use the user name in
24154 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24155 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24156 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24157 This is an incorrect example:
24158 .code
24159 server_condition = \
24160   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24161 .endd
24162 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24163 which it then compares to the supplied password (&$auth3$&). Why is this example
24164 incorrect? It works fine for existing users, but consider what happens if a
24165 non-existent user name is given. The lookup fails, but as no success/failure
24166 strings are given for the lookup, it yields an empty string. Thus, to defeat
24167 the authentication, all a client has to do is to supply a non-existent user
24168 name and an empty password. The correct way of writing this test is:
24169 .code
24170 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24171   {${if eq{$value}{$auth3}}} {false}}
24172 .endd
24173 In this case, if the lookup succeeds, the result is checked; if the lookup
24174 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24175 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24176 always fails if its second argument is empty. However, the second way of
24177 writing the test makes the logic clearer.
24178
24179
24180 .section "The LOGIN authentication mechanism" "SECID173"
24181 .cindex "LOGIN authentication mechanism"
24182 .cindex "authentication" "LOGIN mechanism"
24183 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24184 in a number of programs. No data is sent with the AUTH command. Instead, a
24185 user name and password are supplied separately, in response to prompts. The
24186 plaintext authenticator can be configured to support this as in this example:
24187 .code
24188 fixed_login:
24189   driver = plaintext
24190   public_name = LOGIN
24191   server_prompts = User Name : Password
24192   server_condition = \
24193     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24194   server_set_id = $auth1
24195 .endd
24196 Because of the way plaintext operates, this authenticator accepts data supplied
24197 with the AUTH command (in contravention of the specification of LOGIN), but
24198 if the client does not supply it (as is the case for LOGIN clients), the prompt
24199 strings are used to obtain two data items.
24200
24201 Some clients are very particular about the precise text of the prompts. For
24202 example, Outlook Express is reported to recognize only &"Username:"& and
24203 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24204 strings. It uses the &%ldapauth%& expansion condition to check the user
24205 name and password by binding to an LDAP server:
24206 .code
24207 login:
24208   driver = plaintext
24209   public_name = LOGIN
24210   server_prompts = Username:: : Password::
24211   server_condition = ${if and{{ \
24212     !eq{}{$auth1} }{ \
24213     ldapauth{\
24214       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24215       pass=${quote:$auth2} \
24216       ldap://ldap.example.org/} }} }
24217   server_set_id = uid=$auth1,ou=people,o=example.org
24218 .endd
24219 We have to check that the username is not empty before using it, because LDAP
24220 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24221 operator to correctly quote the DN for authentication. However, the basic
24222 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24223 correct one to use for the password, because quoting is needed only to make
24224 the password conform to the Exim syntax. At the LDAP level, the password is an
24225 uninterpreted string.
24226
24227
24228 .section "Support for different kinds of authentication" "SECID174"
24229 A number of string expansion features are provided for the purpose of
24230 interfacing to different ways of user authentication. These include checking
24231 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24232 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24233 &<<SECTexpcond>>&.
24234
24235
24236
24237
24238 .section "Using plaintext in a client" "SECID175"
24239 .cindex "options" "&(plaintext)& authenticator (client)"
24240 The &(plaintext)& authenticator has two client options:
24241
24242 .option client_ignore_invalid_base64 plaintext boolean false
24243 If the client receives a server prompt that is not a valid base64 string,
24244 authentication is abandoned by default. However, if this option is set true,
24245 the error in the challenge is ignored and the client sends the response as
24246 usual.
24247
24248 .option client_send plaintext string&!! unset
24249 The string is a colon-separated list of authentication data strings. Each
24250 string is independently expanded before being sent to the server. The first
24251 string is sent with the AUTH command; any more strings are sent in response
24252 to prompts from the server. Before each string is expanded, the value of the
24253 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24254 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24255 way. Thus, the prompt that is received in response to sending the first string
24256 (with the AUTH command) can be used in the expansion of the second string, and
24257 so on. If an invalid base64 string is received when
24258 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24259 &$auth$&<&'n'&> variable.
24260
24261 &*Note*&: You cannot use expansion to create multiple strings, because
24262 splitting takes priority and happens first.
24263
24264 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24265 the data, further processing is applied to each string before it is sent. If
24266 there are any single circumflex characters in the string, they are converted to
24267 NULs. Should an actual circumflex be required as data, it must be doubled in
24268 the string.
24269
24270 This is an example of a client configuration that implements the PLAIN
24271 authentication mechanism with a fixed user name and password:
24272 .code
24273 fixed_plain:
24274   driver = plaintext
24275   public_name = PLAIN
24276   client_send = ^username^mysecret
24277 .endd
24278 The lack of colons means that the entire text is sent with the AUTH
24279 command, with the circumflex characters converted to NULs. A similar example
24280 that uses the LOGIN mechanism is:
24281 .code
24282 fixed_login:
24283   driver = plaintext
24284   public_name = LOGIN
24285   client_send = : username : mysecret
24286 .endd
24287 The initial colon means that the first string is empty, so no data is sent with
24288 the AUTH command itself. The remaining strings are sent in response to
24289 prompts.
24290 .ecindex IIDplaiauth1
24291 .ecindex IIDplaiauth2
24292
24293
24294
24295
24296 . ////////////////////////////////////////////////////////////////////////////
24297 . ////////////////////////////////////////////////////////////////////////////
24298
24299 .chapter "The cram_md5 authenticator" "CHID9"
24300 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24301 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24302 .cindex "CRAM-MD5 authentication mechanism"
24303 .cindex "authentication" "CRAM-MD5 mechanism"
24304 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24305 sends a challenge string to the client, and the response consists of a user
24306 name and the CRAM-MD5 digest of the challenge string combined with a secret
24307 string (password) which is known to both server and client. Thus, the secret
24308 is not sent over the network as plain text, which makes this authenticator more
24309 secure than &(plaintext)&. However, the downside is that the secret has to be
24310 available in plain text at either end.
24311
24312
24313 .section "Using cram_md5 as a server" "SECID176"
24314 .cindex "options" "&(cram_md5)& authenticator (server)"
24315 This authenticator has one server option, which must be set to configure the
24316 authenticator as a server:
24317
24318 .option server_secret cram_md5 string&!! unset
24319 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24320 When the server receives the client's response, the user name is placed in
24321 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24322 obtain the password for that user. The server then computes the CRAM-MD5 digest
24323 that the client should have sent, and checks that it received the correct
24324 string. If the expansion of &%server_secret%& is forced to fail, authentication
24325 fails. If the expansion fails for some other reason, a temporary error code is
24326 returned to the client.
24327
24328 For compatibility with previous releases of Exim, the user name is also placed
24329 in &$1$&. However, the use of this variables for this purpose is now
24330 deprecated, as it can lead to confusion in string expansions that also use
24331 numeric variables for other things.
24332
24333 For example, the following authenticator checks that the user name given by the
24334 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24335 user name, authentication fails.
24336 .code
24337 fixed_cram:
24338   driver = cram_md5
24339   public_name = CRAM-MD5
24340   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24341   server_set_id = $auth1
24342 .endd
24343 .vindex "&$authenticated_id$&"
24344 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24345 name in &$authenticated_id$&. A more typical configuration might look up the
24346 secret string in a file, using the user name as the key. For example:
24347 .code
24348 lookup_cram:
24349   driver = cram_md5
24350   public_name = CRAM-MD5
24351   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24352                   {$value}fail}
24353   server_set_id = $auth1
24354 .endd
24355 Note that this expansion explicitly forces failure if the lookup fails
24356 because &$auth1$& contains an unknown user name.
24357
24358 .new
24359 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24360 using the relevant libraries, you need to know the realm to specify in the
24361 lookup and then ask for the &"userPassword"& attribute for that user in that
24362 realm, with:
24363 .code
24364 cyrusless_crammd5:
24365   driver = cram_md5
24366   public_name = CRAM-MD5
24367   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24368                   dbmjz{/etc/sasldb2}}
24369   server_set_id = $auth1
24370 .endd
24371 .wen
24372
24373 .section "Using cram_md5 as a client" "SECID177"
24374 .cindex "options" "&(cram_md5)& authenticator (client)"
24375 When used as a client, the &(cram_md5)& authenticator has two options:
24376
24377
24378
24379 .option client_name cram_md5 string&!! "the primary host name"
24380 This string is expanded, and the result used as the user name data when
24381 computing the response to the server's challenge.
24382
24383
24384 .option client_secret cram_md5 string&!! unset
24385 This option must be set for the authenticator to work as a client. Its value is
24386 expanded and the result used as the secret string when computing the response.
24387
24388
24389 .vindex "&$host$&"
24390 .vindex "&$host_address$&"
24391 Different user names and secrets can be used for different servers by referring
24392 to &$host$& or &$host_address$& in the options. Forced failure of either
24393 expansion string is treated as an indication that this authenticator is not
24394 prepared to handle this case. Exim moves on to the next configured client
24395 authenticator. Any other expansion failure causes Exim to give up trying to
24396 send the message to the current server.
24397
24398 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24399 strings, is:
24400 .code
24401 fixed_cram:
24402   driver = cram_md5
24403   public_name = CRAM-MD5
24404   client_name = ph10
24405   client_secret = secret
24406 .endd
24407 .ecindex IIDcramauth1
24408 .ecindex IIDcramauth2
24409
24410
24411
24412 . ////////////////////////////////////////////////////////////////////////////
24413 . ////////////////////////////////////////////////////////////////////////////
24414
24415 .chapter "The cyrus_sasl authenticator" "CHID10"
24416 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24417 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24418 .cindex "Cyrus" "SASL library"
24419 .cindex "Kerberos"
24420 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24421 Digital Ltd (&url(http://www.aldigital.co.uk)).
24422
24423 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24424 library implementation of the RFC 2222 (&"Simple Authentication and Security
24425 Layer"&). This library supports a number of authentication mechanisms,
24426 including PLAIN and LOGIN, but also several others that Exim does not support
24427 directly. In particular, there is support for Kerberos authentication.
24428
24429 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24430 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24431 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24432 name of the driver to determine which mechanism to support.
24433
24434 Where access to some kind of secret file is required, for example in GSSAPI
24435 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24436 user, and that the Cyrus SASL library has no way of escalating privileges
24437 by default. You may also find you need to set environment variables,
24438 depending on the driver you are using.
24439
24440 The application name provided by Exim is &"exim"&, so various SASL options may
24441 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24442 Kerberos, note that because of limitations in the GSSAPI interface,
24443 changing the server keytab might need to be communicated down to the Kerberos
24444 layer independently. The mechanism for doing so is dependent upon the Kerberos
24445 implementation.
24446 .new
24447 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24448 may be set to point to an alternative keytab file. Exim will pass this
24449 variable through from its own inherited environment when started as root or the
24450 Exim user. The keytab file needs to be readable by the Exim user.
24451 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24452 environment variable.  In practice, for those releases, the Cyrus authenticator
24453 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24454 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24455 .wen
24456
24457
24458 .section "Using cyrus_sasl as a server" "SECID178"
24459 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24460 (on a successful authentication) into &$auth1$&. For compatibility with
24461 previous releases of Exim, the username is also placed in &$1$&. However, the
24462 use of this variable for this purpose is now deprecated, as it can lead to
24463 confusion in string expansions that also use numeric variables for other
24464 things.
24465
24466
24467 .option server_hostname cyrus_sasl string&!! "see below"
24468 This option selects the hostname that is used when communicating with the
24469 library. The default value is &`$primary_hostname`&. It is up to the underlying
24470 SASL plug-in what it does with this data.
24471
24472
24473 .option server_mech cyrus_sasl string "see below"
24474 This option selects the authentication mechanism this driver should use. The
24475 default is the value of the generic &%public_name%& option. This option allows
24476 you to use a different underlying mechanism from the advertised name. For
24477 example:
24478 .code
24479 sasl:
24480   driver = cyrus_sasl
24481   public_name = X-ANYTHING
24482   server_mech = CRAM-MD5
24483   server_set_id = $auth1
24484 .endd
24485
24486 .new
24487 .option server_realm cyrus_sasl string&!! unset
24488 This specifies the SASL realm that the server claims to be in.
24489 .wen
24490
24491
24492 .option server_service cyrus_sasl string &`smtp`&
24493 This is the SASL service that the server claims to implement.
24494
24495
24496 For straightforward cases, you do not need to set any of the authenticator's
24497 private options. All you need to do is to specify an appropriate mechanism as
24498 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24499 PLAIN, you could have two authenticators as follows:
24500 .code
24501 sasl_cram_md5:
24502   driver = cyrus_sasl
24503   public_name = CRAM-MD5
24504   server_set_id = $auth1
24505
24506 sasl_plain:
24507   driver = cyrus_sasl
24508   public_name = PLAIN
24509   server_set_id = $auth2
24510 .endd
24511 Cyrus SASL does implement the LOGIN authentication method, even though it is
24512 not a standard method. It is disabled by default in the source distribution,
24513 but it is present in many binary distributions.
24514 .ecindex IIDcyrauth1
24515 .ecindex IIDcyrauth2
24516
24517
24518
24519
24520 . ////////////////////////////////////////////////////////////////////////////
24521 . ////////////////////////////////////////////////////////////////////////////
24522 .chapter "The dovecot authenticator" "CHAPdovecot"
24523 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24524 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24525 This authenticator is an interface to the authentication facility of the
24526 Dovecot POP/IMAP server, which can support a number of authentication methods.
24527 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24528 to use the same mechanisms for SMTP authentication. This is a server
24529 authenticator only. There is only one option:
24530
24531 .option server_socket dovecot string unset
24532
24533 This option must specify the socket that is the interface to Dovecot
24534 authentication. The &%public_name%& option must specify an authentication
24535 mechanism that Dovecot is configured to support. You can have several
24536 authenticators for different mechanisms. For example:
24537 .code
24538 dovecot_plain:
24539   driver = dovecot
24540   public_name = PLAIN
24541   server_socket = /var/run/dovecot/auth-client
24542   server_set_id = $auth2
24543
24544 dovecot_ntlm:
24545   driver = dovecot
24546   public_name = NTLM
24547   server_socket = /var/run/dovecot/auth-client
24548   server_set_id = $auth1
24549 .endd
24550 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24551 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24552 option is passed in the Dovecot authentication command. If, for a TLS
24553 connection, a client certificate has been verified, the &"valid-client-cert"&
24554 option is passed. When authentication succeeds, the identity of the user
24555 who authenticated is placed in &$auth1$&.
24556 .ecindex IIDdcotauth1
24557 .ecindex IIDdcotauth2
24558
24559
24560 . ////////////////////////////////////////////////////////////////////////////
24561 . ////////////////////////////////////////////////////////////////////////////
24562 .new
24563 .chapter "The gsasl authenticator" "CHAPgsasl"
24564 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
24565 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
24566 .cindex "authentication" "GNU SASL"
24567 .cindex "authentication" "SASL"
24568 .cindex "authentication" "EXTERNAL"
24569 .cindex "authentication" "ANONYMOUS"
24570 .cindex "authentication" "PLAIN"
24571 .cindex "authentication" "LOGIN"
24572 .cindex "authentication" "DIGEST-MD5"
24573 .cindex "authentication" "CRAM-MD5"
24574 .cindex "authentication" "SCRAM-SHA-1"
24575 The &(gsasl)& authenticator provides server integration for the GNU SASL
24576 library and the mechanisms it provides.  This is new as of the 4.78 release
24577 and there are a few areas where the library does not let Exim smoothly
24578 scale to handle future authentication mechanisms, so no guarantee can be
24579 made that any particular new authentication mechanism will be supported
24580 without code changes in Exim.
24581
24582
24583 .option server_channelbinding gsasl bool false
24584 Some authentication mechanisms are able to use external context at both ends
24585 of the session to bind the authentication to that context, and fail the
24586 authentication process if that context differs.  Specifically, some TLS
24587 ciphersuites can provide identifying information about the cryptographic
24588 context.
24589
24590 This means that certificate identity and verification becomes a non-issue,
24591 as a man-in-the-middle attack will cause the correct client and server to
24592 see different identifiers and authentication will fail.
24593
24594 This is currently only supported when using the GnuTLS library.  This is
24595 only usable by mechanisms which support "channel binding"; at time of
24596 writing, that's the SCRAM family.
24597
24598 This defaults off to ensure smooth upgrade across Exim releases, in case
24599 this option causes some clients to start failing.  Some future release
24600 of Exim may switch the default to be true.
24601
24602
24603 .option server_hostname gsasl string&!! "see below"
24604 This option selects the hostname that is used when communicating with the
24605 library. The default value is &`$primary_hostname`&.
24606 Some mechanisms will use this data.
24607
24608
24609 .option server_mech gsasl string "see below"
24610 This option selects the authentication mechanism this driver should use. The
24611 default is the value of the generic &%public_name%& option. This option allows
24612 you to use a different underlying mechanism from the advertised name. For
24613 example:
24614 .code
24615 sasl:
24616   driver = gsasl
24617   public_name = X-ANYTHING
24618   server_mech = CRAM-MD5
24619   server_set_id = $auth1
24620 .endd
24621
24622
24623 .option server_password gsasl string&!! unset
24624 Various mechanisms need access to the cleartext password on the server, so
24625 that proof-of-possession can be demonstrated on the wire, without sending
24626 the password itself.
24627
24628 The data available for lookup varies per mechanism.
24629 In all cases, &$auth1$& is set to the &'authentication id'&.
24630 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
24631 if available, else the empty string.
24632 The &$auth3$& variable will always be the &'realm'& if available,
24633 else the empty string.
24634
24635 A forced failure will cause authentication to defer.
24636
24637 If using this option, it may make sense to set the &%server_condition%&
24638 option to be simply "true".
24639
24640
24641 .option server_realm gsasl string&!! unset
24642 This specifies the SASL realm that the server claims to be in.
24643 Some mechanisms will use this data.
24644
24645
24646 .option server_scram_iter gsasl string&!! unset
24647 This option provides data for the SCRAM family of mechanisms.
24648 &$auth1$& is not available at evaluation time.
24649 (This may change, as we receive feedback on use)
24650
24651
24652 .option server_scram_salt gsasl string&!! unset
24653 This option provides data for the SCRAM family of mechanisms.
24654 &$auth1$& is not available at evaluation time.
24655 (This may change, as we receive feedback on use)
24656
24657
24658 .option server_service gsasl string &`smtp`&
24659 This is the SASL service that the server claims to implement.
24660 Some mechanisms will use this data.
24661
24662
24663 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
24664 .vindex "&$auth1$&, &$auth2$&, etc"
24665 These may be set when evaluating specific options, as detailed above.
24666 They will also be set when evaluating &%server_condition%&.
24667
24668 Unless otherwise stated below, the &(gsasl)& integration will use the following
24669 meanings for these variables:
24670
24671 .ilist
24672 .vindex "&$auth1$&"
24673 &$auth1$&: the &'authentication id'&
24674 .next
24675 .vindex "&$auth2$&"
24676 &$auth2$&: the &'authorization id'&
24677 .next
24678 .vindex "&$auth3$&"
24679 &$auth3$&: the &'realm'&
24680 .endlist
24681
24682 On a per-mechanism basis:
24683
24684 .ilist
24685 .cindex "authentication" "EXTERNAL"
24686 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
24687 the &%server_condition%& option must be present.
24688 .next
24689 .cindex "authentication" "ANONYMOUS"
24690 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
24691 the &%server_condition%& option must be present.
24692 .next
24693 .cindex "authentication" "GSSAPI"
24694 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
24695 &$auth2$& will be set to the &'authorization id'&,
24696 the &%server_condition%& option must be present.
24697 .endlist
24698
24699 An &'anonymous token'& is something passed along as an unauthenticated
24700 identifier; this is analogous to FTP anonymous authentication passing an
24701 email address, or software-identifier@, as the "password".
24702
24703
24704 An example showing the password having the realm specified in the callback
24705 and demonstrating a Cyrus SASL to GSASL migration approach is:
24706 .code
24707 gsasl_cyrusless_crammd5:
24708   driver = gsasl
24709   public_name = CRAM-MD5
24710   server_realm = imap.example.org
24711   server_password = ${lookup{$auth1:$auth3:userPassword}\
24712                     dbmjz{/etc/sasldb2}{$value}fail}
24713   server_set_id = ${quote:$auth1}
24714   server_condition = yes
24715 .endd
24716
24717 .wen
24718
24719 . ////////////////////////////////////////////////////////////////////////////
24720 . ////////////////////////////////////////////////////////////////////////////
24721
24722 .new
24723 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
24724 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
24725 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
24726 .cindex "authentication" "GSSAPI"
24727 .cindex "authentication" "Kerberos"
24728 The &(heimdal_gssapi)& authenticator provides server integration for the
24729 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
24730 reliably.
24731
24732 .option server_hostname heimdal_gssapi string&!! "see below"
24733 This option selects the hostname that is used, with &%server_service%&,
24734 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
24735 identifier.  The default value is &`$primary_hostname`&.
24736
24737 .option server_keytab heimdal_gssapi string&!! unset
24738 If set, then Heimdal will not use the system default keytab (typically
24739 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
24740 The value should be a pathname, with no &"file:"& prefix.
24741
24742 .option server_service heimdal_gssapi string&!! "smtp"
24743 This option specifies the service identifier used, in conjunction with
24744 &%server_hostname%&, for building the identifer for finding credentials
24745 from the keytab.
24746
24747
24748 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
24749 Beware that these variables will typically include a realm, thus will appear
24750 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
24751 not verified, so a malicious client can set it to anything.
24752
24753 The &$auth1$& field should be safely trustable as a value from the Key
24754 Distribution Center.  Note that these are not quite email addresses.
24755 Each identifier is for a role, and so the left-hand-side may include a
24756 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
24757
24758 .vindex "&$auth1$&, &$auth2$&, etc"
24759 .ilist
24760 .vindex "&$auth1$&"
24761 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
24762 .next
24763 .vindex "&$auth2$&"
24764 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
24765 authentication.  If that was empty, this will also be set to the
24766 GSS Display Name.
24767 .endlist
24768
24769 .wen
24770
24771 . ////////////////////////////////////////////////////////////////////////////
24772 . ////////////////////////////////////////////////////////////////////////////
24773
24774 .chapter "The spa authenticator" "CHAPspa"
24775 .scindex IIDspaauth1 "&(spa)& authenticator"
24776 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24777 .cindex "authentication" "Microsoft Secure Password"
24778 .cindex "authentication" "NTLM"
24779 .cindex "Microsoft Secure Password Authentication"
24780 .cindex "NTLM authentication"
24781 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24782 Password Authentication'& mechanism,
24783 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24784 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24785 taken from the Samba project (&url(http://www.samba.org)). The code for the
24786 server side was subsequently contributed by Tom Kistner. The mechanism works as
24787 follows:
24788
24789 .ilist
24790 After the AUTH command has been accepted, the client sends an SPA
24791 authentication request based on the user name and optional domain.
24792 .next
24793 The server sends back a challenge.
24794 .next
24795 The client builds a challenge response which makes use of the user's password
24796 and sends it to the server, which then accepts or rejects it.
24797 .endlist
24798
24799 Encryption is used to protect the password in transit.
24800
24801
24802
24803 .section "Using spa as a server" "SECID179"
24804 .cindex "options" "&(spa)& authenticator (server)"
24805 The &(spa)& authenticator has just one server option:
24806
24807 .option server_password spa string&!! unset
24808 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24809 This option is expanded, and the result must be the cleartext password for the
24810 authenticating user, whose name is at this point in &$auth1$&. For
24811 compatibility with previous releases of Exim, the user name is also placed in
24812 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24813 it can lead to confusion in string expansions that also use numeric variables
24814 for other things. For example:
24815 .code
24816 spa:
24817   driver = spa
24818   public_name = NTLM
24819   server_password = \
24820     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24821 .endd
24822 If the expansion is forced to fail, authentication fails. Any other expansion
24823 failure causes a temporary error code to be returned.
24824
24825
24826
24827
24828
24829 .section "Using spa as a client" "SECID180"
24830 .cindex "options" "&(spa)& authenticator (client)"
24831 The &(spa)& authenticator has the following client options:
24832
24833
24834
24835 .option client_domain spa string&!! unset
24836 This option specifies an optional domain for the authentication.
24837
24838
24839 .option client_password spa string&!! unset
24840 This option specifies the user's password, and must be set.
24841
24842
24843 .option client_username spa string&!! unset
24844 This option specifies the user name, and must be set. Here is an example of a
24845 configuration of this authenticator for use with the mail servers at
24846 &'msn.com'&:
24847 .code
24848 msn:
24849   driver = spa
24850   public_name = MSN
24851   client_username = msn/msn_username
24852   client_password = msn_plaintext_password
24853   client_domain = DOMAIN_OR_UNSET
24854 .endd
24855 .ecindex IIDspaauth1
24856 .ecindex IIDspaauth2
24857
24858
24859
24860
24861
24862 . ////////////////////////////////////////////////////////////////////////////
24863 . ////////////////////////////////////////////////////////////////////////////
24864
24865 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24866          "Encrypted SMTP connections"
24867 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24868 .scindex IIDencsmtp2 "SMTP" "encryption"
24869 .cindex "TLS" "on SMTP connection"
24870 .cindex "OpenSSL"
24871 .cindex "GnuTLS"
24872 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24873 Sockets Layer), is implemented by making use of the OpenSSL library or the
24874 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24875 cryptographic code in the Exim distribution itself for implementing TLS. In
24876 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24877 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24878 You also need to understand the basic concepts of encryption at a managerial
24879 level, and in particular, the way that public keys, private keys, and
24880 certificates are used.
24881
24882 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24883 connection is established, the client issues a STARTTLS command. If the
24884 server accepts this, the client and the server negotiate an encryption
24885 mechanism. If the negotiation succeeds, the data that subsequently passes
24886 between them is encrypted.
24887
24888 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24889 and if so, what cipher suite is in use, whether the client supplied a
24890 certificate, and whether or not that certificate was verified. This makes it
24891 possible for an Exim server to deny or accept certain commands based on the
24892 encryption state.
24893
24894 &*Warning*&: Certain types of firewall and certain anti-virus products can
24895 disrupt TLS connections. You need to turn off SMTP scanning for these products
24896 in order to get TLS to work.
24897
24898
24899
24900 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24901          "SECID284"
24902 .cindex "ssmtp protocol"
24903 .cindex "smtps protocol"
24904 .cindex "SMTP" "ssmtp protocol"
24905 .cindex "SMTP" "smtps protocol"
24906 Early implementations of encrypted SMTP used a different TCP port from normal
24907 SMTP, and expected an encryption negotiation to start immediately, instead of
24908 waiting for a STARTTLS command from the client using the standard SMTP
24909 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24910 allocated for this purpose.
24911
24912 This approach was abandoned when encrypted SMTP was standardized, but there are
24913 still some legacy clients that use it. Exim supports these clients by means of
24914 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24915 numbers; the most common use is expected to be:
24916 .code
24917 tls_on_connect_ports = 465
24918 .endd
24919 The port numbers specified by this option apply to all SMTP connections, both
24920 via the daemon and via &'inetd'&. You still need to specify all the ports that
24921 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24922 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24923 an extra port &-- rather, it specifies different behaviour on a port that is
24924 defined elsewhere.
24925
24926 There is also a &%-tls-on-connect%& command line option. This overrides
24927 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24928
24929
24930
24931
24932
24933
24934 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24935 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24936 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24937 followed later, when the first versions of GnuTLS were released. To build Exim
24938 to use GnuTLS, you need to set
24939 .code
24940 USE_GNUTLS=yes
24941 .endd
24942 in Local/Makefile, in addition to
24943 .code
24944 SUPPORT_TLS=yes
24945 .endd
24946 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24947 include files and libraries for GnuTLS can be found.
24948
24949 There are some differences in usage when using GnuTLS instead of OpenSSL:
24950
24951 .ilist
24952 The &%tls_verify_certificates%& option must contain the name of a file, not the
24953 name of a directory (for OpenSSL it can be either).
24954 .next
24955 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24956 facility for varying its Diffie-Hellman parameters. I understand that this has
24957 changed, but Exim has not been updated to provide this facility.
24958 .next
24959 .vindex "&$tls_peerdn$&"
24960 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24961 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24962 affects the value of the &$tls_peerdn$& variable.
24963 .next
24964 OpenSSL identifies cipher suites using hyphens as separators, for example:
24965 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24966 more, OpenSSL complains if underscores are present in a cipher list. To make
24967 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24968 underscores for GnuTLS when processing lists of cipher suites in the
24969 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24970 option).
24971 .next
24972 The &%tls_require_ciphers%& options operate differently, as described in the
24973 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24974 .new
24975 .next
24976 Some other recently added features may only be available in one or the other.
24977 This should be documented with the feature.  If the documentation does not
24978 explicitly state that the feature is infeasible in the other TLS
24979 implementation, then patches are welcome.
24980 .wen
24981 .endlist
24982
24983
24984 .section "GnuTLS parameter computation" "SECID181"
24985 GnuTLS uses D-H parameters that may take a substantial amount of time
24986 to compute. It is unreasonable to re-compute them for every TLS session.
24987 Therefore, Exim keeps this data in a file in its spool directory, called
24988 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24989 its owner. Every Exim process that start up GnuTLS reads the D-H
24990 parameters from this file. If the file does not exist, the first Exim process
24991 that needs it computes the data and writes it to a temporary file which is
24992 renamed once it is complete. It does not matter if several Exim processes do
24993 this simultaneously (apart from wasting a few resources). Once a file is in
24994 place, new Exim processes immediately start using it.
24995
24996 For maximum security, the parameters that are stored in this file should be
24997 recalculated periodically, the frequency depending on your paranoia level.
24998 Arranging this is easy in principle; just delete the file when you want new
24999 values to be computed. However, there may be a problem. The calculation of new
25000 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25001 If the system is not very active, &_/dev/random_& may delay returning data
25002 until enough randomness (entropy) is available. This may cause Exim to hang for
25003 a substantial amount of time, causing timeouts on incoming connections.
25004
25005 The solution is to generate the parameters externally to Exim. They are stored
25006 in &_gnutls-params_& in PEM format, which means that they can be generated
25007 externally using the &(certtool)& command that is part of GnuTLS.
25008
25009 To replace the parameters with new ones, instead of deleting the file
25010 and letting Exim re-create it, you can generate new parameters using
25011 &(certtool)& and, when this has been done, replace Exim's cache file by
25012 renaming. The relevant commands are something like this:
25013 .code
25014 # rm -f new-params
25015 # touch new-params
25016 # chown exim:exim new-params
25017 # chmod 0400 new-params
25018 # certtool --generate-privkey --bits 512 >new-params
25019 # echo "" >>new-params
25020 # certtool --generate-dh-params --bits 1024 >> new-params
25021 # mv new-params gnutls-params
25022 .endd
25023 If Exim never has to generate the parameters itself, the possibility of
25024 stalling is removed.
25025
25026
25027 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25028 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25029 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25030 There is a function in the OpenSSL library that can be passed a list of cipher
25031 suites before the cipher negotiation takes place. This specifies which ciphers
25032 are acceptable. The list is colon separated and may contain names like
25033 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25034 directly to this function call. The following quotation from the OpenSSL
25035 documentation specifies what forms of item are allowed in the cipher string:
25036
25037 .ilist
25038 It can consist of a single cipher suite such as RC4-SHA.
25039 .next
25040 It can represent a list of cipher suites containing a certain algorithm,
25041 or cipher suites of a certain type. For example SHA1 represents all
25042 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25043 SSL v3 algorithms.
25044 .next
25045 Lists of cipher suites can be combined in a single cipher string using
25046 the + character. This is used as a logical and operation. For example
25047 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25048 algorithms.
25049 .endlist
25050
25051 Each cipher string can be optionally preceded by one of the characters &`!`&,
25052 &`-`& or &`+`&.
25053 .ilist
25054 If &`!`& is used, the ciphers are permanently deleted from the list. The
25055 ciphers deleted can never reappear in the list even if they are explicitly
25056 stated.
25057 .next
25058 If &`-`& is used, the ciphers are deleted from the list, but some or all
25059 of the ciphers can be added again by later options.
25060 .next
25061 If &`+`& is used, the ciphers are moved to the end of the list. This
25062 option does not add any new ciphers; it just moves matching existing ones.
25063 .endlist
25064
25065 If none of these characters is present, the string is interpreted as
25066 a list of ciphers to be appended to the current preference list. If the list
25067 includes any ciphers already present they will be ignored: that is, they will
25068 not be moved to the end of the list.
25069 .endlist
25070
25071
25072
25073 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25074          "SECTreqciphgnu"
25075 .cindex "GnuTLS" "specifying parameters for"
25076 .cindex "TLS" "specifying ciphers (GnuTLS)"
25077 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25078 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25079 .cindex "TLS" "specifying protocols (GnuTLS)"
25080 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25081 The GnuTLS library allows the caller to specify separate lists of permitted key
25082 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
25083 Unfortunately, these lists are numerical, and the library does not have a
25084 function for turning names into numbers. Consequently, lists of recognized
25085 names have to be built into the application. The permitted key exchange
25086 methods, ciphers, and MAC algorithms may be used in any combination to form a
25087 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
25088 passed to its control function.
25089
25090 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
25091 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
25092 option controls only the cipher algorithms. Exim searches each item in the
25093 list for the name of an available algorithm. For example, if the list
25094 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
25095 the same as if just AES were given.
25096
25097 .oindex "&%gnutls_require_kx%&"
25098 .oindex "&%gnutls_require_mac%&"
25099 .oindex "&%gnutls_require_protocols%&"
25100 There are additional options called &%gnutls_require_kx%&,
25101 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
25102 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
25103 These options are ignored if OpenSSL is in use.
25104
25105 All four options are available as global options, controlling how Exim
25106 behaves as a server, and also as options of the &(smtp)& transport, controlling
25107 how Exim behaves as a client. All the values are string expanded. After
25108 expansion, the values must be colon-separated lists, though the separator
25109 can be changed in the usual way.
25110
25111 Each of the four lists starts out with a default set of algorithms. If the
25112 first item in a list does &'not'& start with an exclamation mark, all the
25113 default items are deleted. In this case, only those that are explicitly
25114 specified can be used. If the first item in a list &'does'& start with an
25115 exclamation mark, the defaults are left on the list.
25116
25117 Then, any item that starts with an exclamation mark causes the relevant
25118 entry to be removed from the list, and any item that does not start with an
25119 exclamation mark causes a new entry to be added to the list. Unrecognized
25120 items in the list are ignored. Thus:
25121 .code
25122 tls_require_ciphers = !ARCFOUR
25123 .endd
25124 allows all the defaults except ARCFOUR, whereas
25125 .code
25126 tls_require_ciphers = AES : 3DES
25127 .endd
25128 allows only cipher suites that use AES or 3DES.
25129
25130 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
25131 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
25132 the preceding). The default list does not contain all of these; it just has
25133 AES_256, AES_128, 3DES, and ARCFOUR_128.
25134
25135 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
25136 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
25137 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
25138
25139 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
25140 MD5. The default list contains SHA, MD5.
25141
25142 .new
25143 For &%gnutls_require_protocols%&, the recognized names are TLS1.2, TLS1.1,
25144 TLS1.0, (TLS1) and SSL3.
25145 The default list contains TLS1.2, TLS1.1, TLS1.0, SSL3.
25146 TLS1 is an alias for TLS1.0, for backwards compatibility.
25147 For sufficiently old versions of the GnuTLS library, TLS1.2 or TLS1.1 might
25148 not be supported and will not be recognised by Exim.
25149 .wen
25150
25151 In a server, the order of items in these lists is unimportant. The server
25152 advertises the availability of all the relevant cipher suites. However, in a
25153 client, the order in the &%tls_require_ciphers%& list specifies a preference
25154 order for the cipher algorithms. The first one in the client's list that is
25155 also advertised by the server is tried first. The default order is as listed
25156 above.
25157
25158
25159
25160 .section "Configuring an Exim server to use TLS" "SECID182"
25161 .cindex "TLS" "configuring an Exim server"
25162 When Exim has been built with TLS support, it advertises the availability of
25163 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25164 but not to any others. The default value of this option is unset, which means
25165 that STARTTLS is not advertised at all. This default is chosen because you
25166 need to set some other options in order to make TLS available, and also it is
25167 sensible for systems that want to use TLS only as a client.
25168
25169 If a client issues a STARTTLS command and there is some configuration
25170 problem in the server, the command is rejected with a 454 error. If the client
25171 persists in trying to issue SMTP commands, all except QUIT are rejected
25172 with the error
25173 .code
25174 554 Security failure
25175 .endd
25176 If a STARTTLS command is issued within an existing TLS session, it is
25177 rejected with a 554 error code.
25178
25179 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25180 match some hosts. You can, of course, set it to * to match all hosts.
25181 However, this is not all you need to do. TLS sessions to a server won't work
25182 without some further configuration at the server end.
25183
25184 It is rumoured that all existing clients that support TLS/SSL use RSA
25185 encryption. To make this work you need to set, in the server,
25186 .code
25187 tls_certificate = /some/file/name
25188 tls_privatekey = /some/file/name
25189 .endd
25190 These options are, in fact, expanded strings, so you can make them depend on
25191 the identity of the client that is connected if you wish. The first file
25192 contains the server's X509 certificate, and the second contains the private key
25193 that goes with it. These files need to be readable by the Exim user, and must
25194 always be given as full path names. They can be the same file if both the
25195 certificate and the key are contained within it. If &%tls_privatekey%& is not
25196 set, or if its expansion is forced to fail or results in an empty string, this
25197 is assumed to be the case. The certificate file may also contain intermediate
25198 certificates that need to be sent to the client to enable it to authenticate
25199 the server's certificate.
25200
25201 If you do not understand about certificates and keys, please try to find a
25202 source of this background information, which is not Exim-specific. (There are a
25203 few comments below in section &<<SECTcerandall>>&.)
25204
25205 &*Note*&: These options do not apply when Exim is operating as a client &--
25206 they apply only in the case of a server. If you need to use a certificate in an
25207 Exim client, you must set the options of the same names in an &(smtp)&
25208 transport.
25209
25210 With just these options, an Exim server will be able to use TLS. It does not
25211 require the client to have a certificate (but see below for how to insist on
25212 this). There is one other option that may be needed in other situations. If
25213 .code
25214 tls_dhparam = /some/file/name
25215 .endd
25216 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25217 with the parameters contained in the file. This increases the set of cipher
25218 suites that the server supports. See the command
25219 .code
25220 openssl dhparam
25221 .endd
25222 for a way of generating this data. At present, &%tls_dhparam%& is used only
25223 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
25224
25225 The strings supplied for these three options are expanded every time a client
25226 host connects. It is therefore possible to use different certificates and keys
25227 for different hosts, if you so wish, by making use of the client's IP address
25228 in &$sender_host_address$& to control the expansion. If a string expansion is
25229 forced to fail, Exim behaves as if the option is not set.
25230
25231 .cindex "cipher" "logging"
25232 .cindex "log" "TLS cipher"
25233 .vindex "&$tls_cipher$&"
25234 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
25235 an incoming TLS connection. It is included in the &'Received:'& header of an
25236 incoming message (by default &-- you can, of course, change this), and it is
25237 also included in the log line that records a message's arrival, keyed by
25238 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25239 condition can be used to test for specific cipher suites in ACLs.
25240 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
25241 &<<SECID185>>&.)
25242
25243 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25244 can check the name of the cipher suite and vary their actions accordingly. The
25245 cipher suite names vary, depending on which TLS library is being used. For
25246 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25247 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25248 documentation for more details.
25249
25250
25251 .section "Requesting and verifying client certificates" "SECID183"
25252 .cindex "certificate" "verification of client"
25253 .cindex "TLS" "client certificate verification"
25254 If you want an Exim server to request a certificate when negotiating a TLS
25255 session with a client, you must set either &%tls_verify_hosts%& or
25256 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25257 apply to all TLS connections. For any host that matches one of these options,
25258 Exim requests a certificate as part of the setup of the TLS session. The
25259 contents of the certificate are verified by comparing it with a list of
25260 expected certificates. These must be available in a file or,
25261 for OpenSSL only (not GnuTLS), a directory, identified by
25262 &%tls_verify_certificates%&.
25263
25264 A file can contain multiple certificates, concatenated end to end. If a
25265 directory is used
25266 (OpenSSL only),
25267 each certificate must be in a separate file, with a name (or a symbolic link)
25268 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25269 certificate. You can compute the relevant hash by running the command
25270 .code
25271 openssl x509 -hash -noout -in /cert/file
25272 .endd
25273 where &_/cert/file_& contains a single certificate.
25274
25275 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25276 what happens if the client does not supply a certificate, or if the certificate
25277 does not match any of the certificates in the collection named by
25278 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25279 attempt to set up a TLS session is aborted, and the incoming connection is
25280 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25281 session continues. ACLs that run for subsequent SMTP commands can detect the
25282 fact that no certificate was verified, and vary their actions accordingly. For
25283 example, you can insist on a certificate before accepting a message for
25284 relaying, but not when the message is destined for local delivery.
25285
25286 .vindex "&$tls_peerdn$&"
25287 When a client supplies a certificate (whether it verifies or not), the value of
25288 the Distinguished Name of the certificate is made available in the variable
25289 &$tls_peerdn$& during subsequent processing of the message.
25290
25291 .cindex "log" "distinguished name"
25292 Because it is often a long text string, it is not included in the log line or
25293 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25294 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25295 &%received_header_text%& to change the &'Received:'& header. When no
25296 certificate is supplied, &$tls_peerdn$& is empty.
25297
25298
25299 .section "Revoked certificates" "SECID184"
25300 .cindex "TLS" "revoked certificates"
25301 .cindex "revocation list"
25302 .cindex "certificate" "revocation list"
25303 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25304 certificates are revoked. If you have such a list, you can pass it to an Exim
25305 server using the global option called &%tls_crl%& and to an Exim client using
25306 an identically named option for the &(smtp)& transport. In each case, the value
25307 of the option is expanded and must then be the name of a file that contains a
25308 CRL in PEM format.
25309
25310
25311 .section "Configuring an Exim client to use TLS" "SECID185"
25312 .cindex "cipher" "logging"
25313 .cindex "log" "TLS cipher"
25314 .cindex "log" "distinguished name"
25315 .cindex "TLS" "configuring an Exim client"
25316 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25317 deliveries as well as to incoming, the latter one causing logging of the
25318 server certificate's DN. The remaining client configuration for TLS is all
25319 within the &(smtp)& transport.
25320
25321 It is not necessary to set any options to have TLS work in the &(smtp)&
25322 transport. If Exim is built with TLS support, and TLS is advertised by a
25323 server, the &(smtp)& transport always tries to start a TLS session. However,
25324 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25325 transport) to a list of server hosts for which TLS should not be used.
25326
25327 If you do not want Exim to attempt to send messages unencrypted when an attempt
25328 to set up an encrypted connection fails in any way, you can set
25329 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25330 those hosts, delivery is always deferred if an encrypted connection cannot be
25331 set up. If there are any other hosts for the address, they are tried in the
25332 usual way.
25333
25334 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25335 the message unencrypted. It always does this if the response to STARTTLS is
25336 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25337 session after a success response code, what happens is controlled by the
25338 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25339 delivery to this host is deferred, and other hosts (if available) are tried. If
25340 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25341 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25342 negotiation fails, Exim closes the current connection (because it is in an
25343 unknown state), opens a new one to the same host, and then tries the delivery
25344 unencrypted.
25345
25346 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25347 transport provide the client with a certificate, which is passed to the server
25348 if it requests it. If the server is Exim, it will request a certificate only if
25349 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25350
25351 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25352 must name a file or,
25353 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25354 expected server certificates. The client verifies the server's certificate
25355 against this collection, taking into account any revoked certificates that are
25356 in the list defined by &%tls_crl%&.
25357
25358 If
25359 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25360 list of permitted cipher suites. If either of these checks fails, delivery to
25361 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25362 alternative hosts, if any.
25363
25364  &*Note*&:
25365 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25366 is operating as a client. Exim does not assume that a server certificate (set
25367 by the global options of the same name) should also be used when operating as a
25368 client.
25369
25370 .vindex "&$host$&"
25371 .vindex "&$host_address$&"
25372 All the TLS options in the &(smtp)& transport are expanded before use, with
25373 &$host$& and &$host_address$& containing the name and address of the server to
25374 which the client is connected. Forced failure of an expansion causes Exim to
25375 behave as if the relevant option were unset.
25376
25377 .vindex &$tls_bits$&
25378 .vindex &$tls_cipher$&
25379 .vindex &$tls_peerdn$&
25380 .vindex &$tls_sni$&
25381 Before an SMTP connection is established, the
25382 &$tls_bits$&, &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25383 variables are emptied. (Until the first connection, they contain the values
25384 that were set when the message was received.) If STARTTLS is subsequently
25385 successfully obeyed, these variables are set to the relevant values for the
25386 outgoing connection.
25387
25388
25389
25390 .new
25391 .section "Use of TLS Server Name Indication" "SECTtlssni"
25392 .cindex "TLS" "Server Name Indication"
25393 .vindex "&$tls_sni$&"
25394 .oindex "&%tls_sni%&"
25395 With TLS1.0 or above, there is an extension mechanism by which extra
25396 information can be included at various points in the protocol.  One of these
25397 extensions, documented in RFC 6066 (and before that RFC 4366) is
25398 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25399 client in the initial handshake, so that the server can examine the servername
25400 within and possibly choose to use different certificates and keys (and more)
25401 for this session.
25402
25403 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25404 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25405 address.
25406
25407 With SMTP to MX, there are the same problems here as in choosing the identity
25408 against which to validate a certificate: you can't rely on insecure DNS to
25409 provide the identity which you then cryptographically verify.  So this will
25410 be of limited use in that environment.
25411
25412 With SMTP to Submission, there is a well-defined hostname which clients are
25413 connecting to and can validate certificates against.  Thus clients &*can*&
25414 choose to include this information in the TLS negotiation.  If this becomes
25415 wide-spread, then hosters can choose to present different certificates to
25416 different clients.  Or even negotiate different cipher suites.
25417
25418 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25419 if not empty, will be sent on a TLS session as part of the handshake.  There's
25420 nothing more to it.  Choosing a sensible value not derived insecurely is the
25421 only point of caution.  The &$tls_sni$& variable will be set to this string
25422 for the lifetime of the client connection (including during authentication).
25423
25424 Except during SMTP client sessions, if &$tls_sni$& is set then it is a string
25425 received from a client.
25426 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25427
25428 If the string &`tls_sni`& appears in the main section's &%tls_certificate%&
25429 option (prior to expansion) then the following options will be re-expanded
25430 during TLS session handshake, to permit alternative values to be chosen:
25431
25432 .ilist
25433 .vindex "&%tls_certificate%&"
25434 &%tls_certificate%&
25435 .next
25436 .vindex "&%tls_crl%&"
25437 &%tls_crl%&
25438 .next
25439 .vindex "&%tls_privatekey%&"
25440 &%tls_privatekey%&
25441 .next
25442 .vindex "&%tls_verify_certificates%&"
25443 &%tls_verify_certificates%&
25444 .endlist
25445
25446 Great care should be taken to deal with matters of case, various injection
25447 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25448 can always be referenced; it is important to remember that &$tls_sni$& is
25449 arbitrary unverified data provided prior to authentication.
25450
25451 The Exim developers are proceeding cautiously and so far no other TLS options
25452 are re-expanded.
25453
25454 Currently SNI support is only available if using OpenSSL, with TLS Extensions
25455 support enabled therein.
25456 .wen
25457
25458
25459
25460 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25461          "SECTmulmessam"
25462 .cindex "multiple SMTP deliveries with TLS"
25463 .cindex "TLS" "multiple message deliveries"
25464 Exim sends multiple messages down the same TCP/IP connection by starting up
25465 an entirely new delivery process for each message, passing the socket from
25466 one process to the next. This implementation does not fit well with the use
25467 of TLS, because there is quite a lot of state information associated with a TLS
25468 connection, not just a socket identification. Passing all the state information
25469 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25470 session before passing the socket to a new process. The new process may then
25471 try to start a new TLS session, and if successful, may try to re-authenticate
25472 if AUTH is in use, before sending the next message.
25473
25474 The RFC is not clear as to whether or not an SMTP session continues in clear
25475 after TLS has been shut down, or whether TLS may be restarted again later, as
25476 just described. However, if the server is Exim, this shutdown and
25477 reinitialization works. It is not known which (if any) other servers operate
25478 successfully if the client closes a TLS session and continues with unencrypted
25479 SMTP, but there are certainly some that do not work. For such servers, Exim
25480 should not pass the socket to another process, because the failure of the
25481 subsequent attempt to use it would cause Exim to record a temporary host error,
25482 and delay other deliveries to that host.
25483
25484 To test for this case, Exim sends an EHLO command to the server after
25485 closing down the TLS session. If this fails in any way, the connection is
25486 closed instead of being passed to a new delivery process, but no retry
25487 information is recorded.
25488
25489 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25490 &(smtp)& transport to match those hosts for which Exim should not pass
25491 connections to new processes if TLS has been used.
25492
25493
25494
25495
25496 .section "Certificates and all that" "SECTcerandall"
25497 .cindex "certificate" "references to discussion"
25498 In order to understand fully how TLS works, you need to know about
25499 certificates, certificate signing, and certificate authorities. This is not the
25500 place to give a tutorial, especially as I do not know very much about it
25501 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25502 to Apache, currently at
25503 .display
25504 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25505 .endd
25506 Other parts of the &'modssl'& documentation are also helpful, and have
25507 links to further files.
25508 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25509 0-201-61598-3), contains both introductory and more in-depth descriptions.
25510 Some sample programs taken from the book are available from
25511 .display
25512 &url(http://www.rtfm.com/openssl-examples/)
25513 .endd
25514
25515
25516 .section "Certificate chains" "SECID186"
25517 The file named by &%tls_certificate%& may contain more than one
25518 certificate. This is useful in the case where the certificate that is being
25519 sent is validated by an intermediate certificate which the other end does
25520 not have. Multiple certificates must be in the correct order in the file.
25521 First the host's certificate itself, then the first intermediate
25522 certificate to validate the issuer of the host certificate, then the next
25523 intermediate certificate to validate the issuer of the first intermediate
25524 certificate, and so on, until finally (optionally) the root certificate.
25525 The root certificate must already be trusted by the recipient for
25526 validation to succeed, of course, but if it's not preinstalled, sending the
25527 root certificate along with the rest makes it available for the user to
25528 install if the receiving end is a client MUA that can interact with a user.
25529
25530
25531 .section "Self-signed certificates" "SECID187"
25532 .cindex "certificate" "self-signed"
25533 You can create a self-signed certificate using the &'req'& command provided
25534 with OpenSSL, like this:
25535 .code
25536 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
25537             -days 9999 -nodes
25538 .endd
25539 &_file1_& and &_file2_& can be the same file; the key and the certificate are
25540 delimited and so can be identified independently. The &%-days%& option
25541 specifies a period for which the certificate is valid. The &%-nodes%& option is
25542 important: if you do not set it, the key is encrypted with a passphrase
25543 that you are prompted for, and any use that is made of the key causes more
25544 prompting for the passphrase. This is not helpful if you are going to use
25545 this certificate and key in an MTA, where prompting is not possible.
25546
25547 A self-signed certificate made in this way is sufficient for testing, and
25548 may be adequate for all your requirements if you are mainly interested in
25549 encrypting transfers, and not in secure identification.
25550
25551 However, many clients require that the certificate presented by the server be a
25552 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
25553 certificate. In this situation, the self-signed certificate described above
25554 must be installed on the client host as a trusted root &'certification
25555 authority'& (CA), and the certificate used by Exim must be a user certificate
25556 signed with that self-signed certificate.
25557
25558 For information on creating self-signed CA certificates and using them to sign
25559 user certificates, see the &'General implementation overview'& chapter of the
25560 Open-source PKI book, available online at
25561 &url(http://ospkibook.sourceforge.net/).
25562 .ecindex IIDencsmtp1
25563 .ecindex IIDencsmtp2
25564
25565
25566
25567 . ////////////////////////////////////////////////////////////////////////////
25568 . ////////////////////////////////////////////////////////////////////////////
25569
25570 .chapter "Access control lists" "CHAPACL"
25571 .scindex IIDacl "&ACL;" "description"
25572 .cindex "control of incoming mail"
25573 .cindex "message" "controlling incoming"
25574 .cindex "policy control" "access control lists"
25575 Access Control Lists (ACLs) are defined in a separate section of the run time
25576 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
25577 name, terminated by a colon. Here is a complete ACL section that contains just
25578 one very small ACL:
25579 .code
25580 begin acl
25581 small_acl:
25582   accept   hosts = one.host.only
25583 .endd
25584 You can have as many lists as you like in the ACL section, and the order in
25585 which they appear does not matter. The lists are self-terminating.
25586
25587 The majority of ACLs are used to control Exim's behaviour when it receives
25588 certain SMTP commands. This applies both to incoming TCP/IP connections, and
25589 when a local process submits a message using SMTP by specifying the &%-bs%&
25590 option. The most common use is for controlling which recipients are accepted
25591 in incoming messages. In addition, you can define an ACL that is used to check
25592 local non-SMTP messages. The default configuration file contains an example of
25593 a realistic ACL for checking RCPT commands. This is discussed in chapter
25594 &<<CHAPdefconfil>>&.
25595
25596
25597 .section "Testing ACLs" "SECID188"
25598 The &%-bh%& command line option provides a way of testing your ACL
25599 configuration locally by running a fake SMTP session with which you interact.
25600 The host &'relay-test.mail-abuse.org'& provides a service for checking your
25601 relaying configuration (see section &<<SECTcheralcon>>& for more details).
25602
25603
25604
25605 .section "Specifying when ACLs are used" "SECID189"
25606 .cindex "&ACL;" "options for specifying"
25607 In order to cause an ACL to be used, you have to name it in one of the relevant
25608 options in the main part of the configuration. These options are:
25609 .cindex "AUTH" "ACL for"
25610 .cindex "DATA" "ACLs for"
25611 .cindex "ETRN" "ACL for"
25612 .cindex "EXPN" "ACL for"
25613 .cindex "HELO" "ACL for"
25614 .cindex "EHLO" "ACL for"
25615 .cindex "MAIL" "ACL for"
25616 .cindex "QUIT, ACL for"
25617 .cindex "RCPT" "ACL for"
25618 .cindex "STARTTLS, ACL for"
25619 .cindex "VRFY" "ACL for"
25620 .cindex "SMTP" "connection, ACL for"
25621 .cindex "non-SMTP messages" "ACLs for"
25622 .cindex "MIME content scanning" "ACL for"
25623
25624 .table2 140pt
25625 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
25626 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25627 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25628 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25629 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
25630 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
25631 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
25632 .irow &%acl_smtp_expn%&        "ACL for EXPN"
25633 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
25634 .irow &%acl_smtp_mail%&        "ACL for MAIL"
25635 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
25636 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
25637 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
25638 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
25639 .irow &%acl_smtp_quit%&        "ACL for QUIT"
25640 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
25641 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
25642 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
25643 .endtable
25644
25645 For example, if you set
25646 .code
25647 acl_smtp_rcpt = small_acl
25648 .endd
25649 the little ACL defined above is used whenever Exim receives a RCPT command
25650 in an SMTP dialogue. The majority of policy tests on incoming messages can be
25651 done when RCPT commands arrive. A rejection of RCPT should cause the
25652 sending MTA to give up on the recipient address contained in the RCPT
25653 command, whereas rejection at other times may cause the client MTA to keep on
25654 trying to deliver the message. It is therefore recommended that you do as much
25655 testing as possible at RCPT time.
25656
25657
25658 .section "The non-SMTP ACLs" "SECID190"
25659 .cindex "non-SMTP messages" "ACLs for"
25660 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
25661 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
25662 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
25663 the state of the SMTP connection such as encryption and authentication) are not
25664 relevant and are forbidden in these ACLs. However, the sender and recipients
25665 are known, so the &%senders%& and &%sender_domains%& conditions and the
25666 &$sender_address$& and &$recipients$& variables can be used. Variables such as
25667 &$authenticated_sender$& are also available. You can specify added header lines
25668 in any of these ACLs.
25669
25670 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
25671 non-SMTP message, before any of the message has been read. (This is the
25672 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
25673 batched SMTP input, it runs after the DATA command has been reached. The
25674 result of this ACL is ignored; it cannot be used to reject a message. If you
25675 really need to, you could set a value in an ACL variable here and reject based
25676 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
25677 controls, and in particular, it can be used to set
25678 .code
25679 control = suppress_local_fixups
25680 .endd
25681 This cannot be used in the other non-SMTP ACLs because by the time they are
25682 run, it is too late.
25683
25684 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
25685 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25686
25687 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
25688 kind of rejection is treated as permanent, because there is no way of sending a
25689 temporary error for these kinds of message.
25690
25691
25692 .section "The SMTP connect ACL" "SECID191"
25693 .cindex "SMTP" "connection, ACL for"
25694 .oindex &%smtp_banner%&
25695 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
25696 session, after the test specified by &%host_reject_connection%& (which is now
25697 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
25698 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
25699 the message override the banner message that is otherwise specified by the
25700 &%smtp_banner%& option.
25701
25702
25703 .section "The EHLO/HELO ACL" "SECID192"
25704 .cindex "EHLO" "ACL for"
25705 .cindex "HELO" "ACL for"
25706 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
25707 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
25708 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
25709 Note that a client may issue more than one EHLO or HELO command in an SMTP
25710 session, and indeed is required to issue a new EHLO or HELO after successfully
25711 setting up encryption following a STARTTLS command.
25712
25713 If the command is accepted by an &%accept%& verb that has a &%message%&
25714 modifier, the message may not contain more than one line (it will be truncated
25715 at the first newline and a panic logged if it does). Such a message cannot
25716 affect the EHLO options that are listed on the second and subsequent lines of
25717 an EHLO response.
25718
25719
25720 .section "The DATA ACLs" "SECID193"
25721 .cindex "DATA" "ACLs for"
25722 Two ACLs are associated with the DATA command, because it is two-stage
25723 command, with two responses being sent to the client.
25724 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
25725 is obeyed. This gives you control after all the RCPT commands, but before
25726 the message itself is received. It offers the opportunity to give a negative
25727 response to the DATA command before the data is transmitted. Header lines
25728 added by MAIL or RCPT ACLs are not visible at this time, but any that
25729 are defined here are visible when the &%acl_smtp_data%& ACL is run.
25730
25731 You cannot test the contents of the message, for example, to verify addresses
25732 in the headers, at RCPT time or when the DATA command is received. Such
25733 tests have to appear in the ACL that is run after the message itself has been
25734 received, before the final response to the DATA command is sent. This is
25735 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
25736 associated with the DATA command.
25737
25738 For both of these ACLs, it is not possible to reject individual recipients. An
25739 error response rejects the entire message. Unfortunately, it is known that some
25740 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
25741 before or after the data) correctly &-- they keep the message on their queues
25742 and try again later, but that is their problem, though it does waste some of
25743 your resources.
25744
25745
25746 .section "The SMTP DKIM ACL" "SECTDKIMACL"
25747 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
25748 enabled (which is the default).
25749
25750 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
25751 received, and is executed for each DKIM signature found in a message.  If not
25752 otherwise specified, the default action is to accept.
25753
25754 For details on the operation of DKIM, see chapter &<<CHID12>>&.
25755
25756
25757 .section "The SMTP MIME ACL" "SECID194"
25758 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
25759 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25760
25761
25762 .section "The QUIT ACL" "SECTQUITACL"
25763 .cindex "QUIT, ACL for"
25764 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
25765 does not affect the response code to QUIT, which is always 221. Thus, the ACL
25766 does not in fact control any access. For this reason, the only verbs that are
25767 permitted are &%accept%& and &%warn%&.
25768
25769 This ACL can be used for tasks such as custom logging at the end of an SMTP
25770 session. For example, you can use ACL variables in other ACLs to count
25771 messages, recipients, etc., and log the totals at QUIT time using one or
25772 more &%logwrite%& modifiers on a &%warn%& verb.
25773
25774 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
25775 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
25776
25777 You do not need to have a final &%accept%&, but if you do, you can use a
25778 &%message%& modifier to specify custom text that is sent as part of the 221
25779 response to QUIT.
25780
25781 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
25782 failure (for example, failure to open a log file, or when Exim is bombing out
25783 because it has detected an unrecoverable error), all SMTP commands from the
25784 client are given temporary error responses until QUIT is received or the
25785 connection is closed. In these special cases, the QUIT ACL does not run.
25786
25787
25788 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25789 .vindex &$acl_smtp_notquit$&
25790 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25791 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25792 trouble, such as being unable to write to its log files, this ACL is not run,
25793 because it might try to do things (such as write to log files) that make the
25794 situation even worse.
25795
25796 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25797 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25798 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25799 and &%warn%&.
25800
25801 .vindex &$smtp_notquit_reason$&
25802 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25803 to a string that indicates the reason for the termination of the SMTP
25804 connection. The possible values are:
25805 .table2
25806 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25807 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25808 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25809 .irow &`connection-lost`&          "The SMTP connection has been lost"
25810 .irow &`data-timeout`&             "Timeout while reading message data"
25811 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25812 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25813 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25814 .irow &`synchronization-error`&    "SMTP synchronization error"
25815 .irow &`tls-failed`&               "TLS failed to start"
25816 .endtable
25817 In most cases when an SMTP connection is closed without having received QUIT,
25818 Exim sends an SMTP response message before actually closing the connection.
25819 With the exception of the &`acl-drop`& case, the default message can be
25820 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25821 &%drop%& verb in another ACL, it is the message from the other ACL that is
25822 used.
25823
25824
25825 .section "Finding an ACL to use" "SECID195"
25826 .cindex "&ACL;" "finding which to use"
25827 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25828 you can use different ACLs in different circumstances. For example,
25829 .code
25830 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25831                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25832 .endd
25833 In the default configuration file there are some example settings for
25834 providing an RFC 4409 message submission service on port 587 and a
25835 non-standard &"smtps"& service on port 465. You can use a string
25836 expansion like this to choose an ACL for MUAs on these ports which is
25837 more appropriate for this purpose than the default ACL on port 25.
25838
25839 The expanded string does not have to be the name of an ACL in the
25840 configuration file; there are other possibilities. Having expanded the
25841 string, Exim searches for an ACL as follows:
25842
25843 .ilist
25844 If the string begins with a slash, Exim uses it as a file name, and reads its
25845 contents as an ACL. The lines are processed in the same way as lines in the
25846 Exim configuration file. In particular, continuation lines are supported, blank
25847 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25848 If the file does not exist or cannot be read, an error occurs (typically
25849 causing a temporary failure of whatever caused the ACL to be run). For example:
25850 .code
25851 acl_smtp_data = /etc/acls/\
25852   ${lookup{$sender_host_address}lsearch\
25853   {/etc/acllist}{$value}{default}}
25854 .endd
25855 This looks up an ACL file to use on the basis of the host's IP address, falling
25856 back to a default if the lookup fails. If an ACL is successfully read from a
25857 file, it is retained in memory for the duration of the Exim process, so that it
25858 can be re-used without having to re-read the file.
25859 .next
25860 If the string does not start with a slash, and does not contain any spaces,
25861 Exim searches the ACL section of the configuration for an ACL whose name
25862 matches the string.
25863 .next
25864 If no named ACL is found, or if the string contains spaces, Exim parses
25865 the string as an inline ACL. This can save typing in cases where you just
25866 want to have something like
25867 .code
25868 acl_smtp_vrfy = accept
25869 .endd
25870 in order to allow free use of the VRFY command. Such a string may contain
25871 newlines; it is processed in the same way as an ACL that is read from a file.
25872 .endlist
25873
25874
25875
25876
25877 .section "ACL return codes" "SECID196"
25878 .cindex "&ACL;" "return codes"
25879 Except for the QUIT ACL, which does not affect the SMTP return code (see
25880 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25881 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25882 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25883 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25884 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25885 This also causes a 4&'xx'& return code.
25886
25887 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25888 &"deny"&, because there is no mechanism for passing temporary errors to the
25889 submitters of non-SMTP messages.
25890
25891
25892 ACLs that are relevant to message reception may also return &"discard"&. This
25893 has the effect of &"accept"&, but causes either the entire message or an
25894 individual recipient address to be discarded. In other words, it is a
25895 blackholing facility. Use it with care.
25896
25897 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25898 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25899 RCPT ACL is to discard just the one recipient address. If there are no
25900 recipients left when the message's data is received, the DATA ACL is not
25901 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25902 remaining recipients. The &"discard"& return is not permitted for the
25903 &%acl_smtp_predata%& ACL.
25904
25905
25906 .cindex "&[local_scan()]& function" "when all recipients discarded"
25907 The &[local_scan()]& function is always run, even if there are no remaining
25908 recipients; it may create new recipients.
25909
25910
25911
25912 .section "Unset ACL options" "SECID197"
25913 .cindex "&ACL;" "unset options"
25914 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25915 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25916 not defined at all. For any defined ACL, the default action when control
25917 reaches the end of the ACL statements is &"deny"&.
25918
25919 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25920 these two are ACLs that are used only for their side effects. They cannot be
25921 used to accept or reject anything.
25922
25923 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25924 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25925 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25926 when the ACL is not defined is &"accept"&.
25927
25928 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25929 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25930 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25931 messages over an SMTP connection. For an example, see the ACL in the default
25932 configuration file.
25933
25934
25935
25936
25937 .section "Data for message ACLs" "SECID198"
25938 .cindex "&ACL;" "data for message ACL"
25939 .vindex &$domain$&
25940 .vindex &$local_part$&
25941 .vindex &$sender_address$&
25942 .vindex &$sender_host_address$&
25943 .vindex &$smtp_command$&
25944 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25945 that contain information about the host and the message's sender (for example,
25946 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25947 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25948 &$local_part$& are set from the argument address. The entire SMTP command
25949 is available in &$smtp_command$&.
25950
25951 When an ACL for the AUTH parameter of MAIL is running, the variables that
25952 contain information about the host are set, but &$sender_address$& is not yet
25953 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25954 how it is used.
25955
25956 .vindex "&$message_size$&"
25957 The &$message_size$& variable is set to the value of the SIZE parameter on
25958 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25959 that parameter is not given. The value is updated to the true message size by
25960 the time the final DATA ACL is run (after the message data has been
25961 received).
25962
25963 .vindex "&$rcpt_count$&"
25964 .vindex "&$recipients_count$&"
25965 The &$rcpt_count$& variable increases by one for each RCPT command received.
25966 The &$recipients_count$& variable increases by one each time a RCPT command is
25967 accepted, so while an ACL for RCPT is being processed, it contains the number
25968 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25969 &$rcpt_count$& contains the total number of RCPT commands, and
25970 &$recipients_count$& contains the total number of accepted recipients.
25971
25972
25973
25974
25975
25976 .section "Data for non-message ACLs" "SECTdatfornon"
25977 .cindex "&ACL;" "data for non-message ACL"
25978 .vindex &$smtp_command_argument$&
25979 .vindex &$smtp_command$&
25980 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25981 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25982 and the entire SMTP command is available in &$smtp_command$&.
25983 These variables can be tested using a &%condition%& condition. For example,
25984 here is an ACL for use with AUTH, which insists that either the session is
25985 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25986 does not permit authentication methods that use cleartext passwords on
25987 unencrypted connections.
25988 .code
25989 acl_check_auth:
25990   accept encrypted = *
25991   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25992                      {CRAM-MD5}}
25993   deny   message   = TLS encryption or CRAM-MD5 required
25994 .endd
25995 (Another way of applying this restriction is to arrange for the authenticators
25996 that use cleartext passwords not to be advertised when the connection is not
25997 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25998 option to do this.)
25999
26000
26001
26002 .section "Format of an ACL" "SECID199"
26003 .cindex "&ACL;" "format of"
26004 .cindex "&ACL;" "verbs, definition of"
26005 An individual ACL consists of a number of statements. Each statement starts
26006 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26007 Modifiers can change the way the verb operates, define error and log messages,
26008 set variables, insert delays, and vary the processing of accepted messages.
26009
26010 If all the conditions are met, the verb is obeyed. The same condition may be
26011 used (with different arguments) more than once in the same statement. This
26012 provides a means of specifying an &"and"& conjunction between conditions. For
26013 example:
26014 .code
26015 deny  dnslists = list1.example
26016 dnslists = list2.example
26017 .endd
26018 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26019 the conditions and modifiers when it reaches a condition that fails. What
26020 happens then depends on the verb (and in one case, on a special modifier). Not
26021 all the conditions make sense at every testing point. For example, you cannot
26022 test a sender address in the ACL that is run for a VRFY command.
26023
26024
26025 .section "ACL verbs" "SECID200"
26026 The ACL verbs are as follows:
26027
26028 .ilist
26029 .cindex "&%accept%& ACL verb"
26030 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26031 of the conditions are not met, what happens depends on whether &%endpass%&
26032 appears among the conditions (for syntax see below). If the failing condition
26033 is before &%endpass%&, control is passed to the next ACL statement; if it is
26034 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26035 check a RCPT command:
26036 .code
26037 accept domains = +local_domains
26038 endpass
26039 verify = recipient
26040 .endd
26041 If the recipient domain does not match the &%domains%& condition, control
26042 passes to the next statement. If it does match, the recipient is verified, and
26043 the command is accepted if verification succeeds. However, if verification
26044 fails, the ACL yields &"deny"&, because the failing condition is after
26045 &%endpass%&.
26046
26047 The &%endpass%& feature has turned out to be confusing to many people, so its
26048 use is not recommended nowadays. It is always possible to rewrite an ACL so
26049 that &%endpass%& is not needed, and it is no longer used in the default
26050 configuration.
26051
26052 .cindex "&%message%& ACL modifier" "with &%accept%&"
26053 If a &%message%& modifier appears on an &%accept%& statement, its action
26054 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26055 (when an &%accept%& verb either accepts or passes control to the next
26056 statement), &%message%& can be used to vary the message that is sent when an
26057 SMTP command is accepted. For example, in a RCPT ACL you could have:
26058 .display
26059 &`accept  `&<&'some conditions'&>
26060 &`        message = OK, I will allow you through today`&
26061 .endd
26062 You can specify an SMTP response code, optionally followed by an &"extended
26063 response code"& at the start of the message, but the first digit must be the
26064 same as would be sent by default, which is 2 for an &%accept%& verb.
26065
26066 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26067 an error message that is used when access is denied. This behaviour is retained
26068 for backward compatibility, but current &"best practice"& is to avoid the use
26069 of &%endpass%&.
26070
26071
26072 .next
26073 .cindex "&%defer%& ACL verb"
26074 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26075 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26076 &%defer%& is the same as &%deny%&, because there is no way of sending a
26077 temporary error. For a RCPT command, &%defer%& is much the same as using a
26078 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26079 be used in any ACL, and even for a recipient it might be a simpler approach.
26080
26081
26082 .next
26083 .cindex "&%deny%& ACL verb"
26084 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26085 the conditions are not met, control is passed to the next ACL statement. For
26086 example,
26087 .code
26088 deny dnslists = blackholes.mail-abuse.org
26089 .endd
26090 rejects commands from hosts that are on a DNS black list.
26091
26092
26093 .next
26094 .cindex "&%discard%& ACL verb"
26095 &%discard%&: This verb behaves like &%accept%&, except that it returns
26096 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26097 that are concerned with receiving messages. When all the conditions are true,
26098 the sending entity receives a &"success"& response. However, &%discard%& causes
26099 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26100 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26101 message's recipients are discarded. Recipients that are discarded before DATA
26102 do not appear in the log line when the &%received_recipients%& log selector is set.
26103
26104 If the &%log_message%& modifier is set when &%discard%& operates,
26105 its contents are added to the line that is automatically written to the log.
26106 The &%message%& modifier operates exactly as it does for &%accept%&.
26107
26108
26109 .next
26110 .cindex "&%drop%& ACL verb"
26111 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26112 forcibly closed after the 5&'xx'& error message has been sent. For example:
26113 .code
26114 drop   message   = I don't take more than 20 RCPTs
26115        condition = ${if > {$rcpt_count}{20}}
26116 .endd
26117 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26118 The connection is always dropped after sending a 550 response.
26119
26120 .next
26121 .cindex "&%require%& ACL verb"
26122 &%require%&: If all the conditions are met, control is passed to the next ACL
26123 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26124 example, when checking a RCPT command,
26125 .code
26126 require message = Sender did not verify
26127         verify  = sender
26128 .endd
26129 passes control to subsequent statements only if the message's sender can be
26130 verified. Otherwise, it rejects the command. Note the positioning of the
26131 &%message%& modifier, before the &%verify%& condition. The reason for this is
26132 discussed in section &<<SECTcondmodproc>>&.
26133
26134 .next
26135 .cindex "&%warn%& ACL verb"
26136 &%warn%&: If all the conditions are true, a line specified by the
26137 &%log_message%& modifier is written to Exim's main log. Control always passes
26138 to the next ACL statement. If any condition is false, the log line is not
26139 written. If an identical log line is requested several times in the same
26140 message, only one copy is actually written to the log. If you want to force
26141 duplicates to be written, use the &%logwrite%& modifier instead.
26142
26143 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26144 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26145 &%logwrite%&, and &%add_header%&) that appear before the first failing
26146 condition. There is more about adding header lines in section
26147 &<<SECTaddheadacl>>&.
26148
26149 If any condition on a &%warn%& statement cannot be completed (that is, there is
26150 some sort of defer), the log line specified by &%log_message%& is not written.
26151 This does not include the case of a forced failure from a lookup, which
26152 is considered to be a successful completion. After a defer, no further
26153 conditions or modifiers in the &%warn%& statement are processed. The incident
26154 is logged, and the ACL continues to be processed, from the next statement
26155 onwards.
26156
26157
26158 .vindex "&$acl_verify_message$&"
26159 When one of the &%warn%& conditions is an address verification that fails, the
26160 text of the verification failure message is in &$acl_verify_message$&. If you
26161 want this logged, you must set it up explicitly. For example:
26162 .code
26163 warn   !verify = sender
26164        log_message = sender verify failed: $acl_verify_message
26165 .endd
26166 .endlist
26167
26168 At the end of each ACL there is an implicit unconditional &%deny%&.
26169
26170 As you can see from the examples above, the conditions and modifiers are
26171 written one to a line, with the first one on the same line as the verb, and
26172 subsequent ones on following lines. If you have a very long condition, you can
26173 continue it onto several physical lines by the usual backslash continuation
26174 mechanism. It is conventional to align the conditions vertically.
26175
26176
26177
26178 .section "ACL variables" "SECTaclvariables"
26179 .cindex "&ACL;" "variables"
26180 There are some special variables that can be set during ACL processing. They
26181 can be used to pass information between different ACLs, different invocations
26182 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26183 transports, and filters that are used to deliver a message. The names of these
26184 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26185 an underscore, but the remainder of the name can be any sequence of
26186 alphanumeric characters and underscores that you choose. There is no limit on
26187 the number of ACL variables. The two sets act as follows:
26188 .ilist
26189 The values of those variables whose names begin with &$acl_c$& persist
26190 throughout an SMTP connection. They are never reset. Thus, a value that is set
26191 while receiving one message is still available when receiving the next message
26192 on the same SMTP connection.
26193 .next
26194 The values of those variables whose names begin with &$acl_m$& persist only
26195 while a message is being received. They are reset afterwards. They are also
26196 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26197 .endlist
26198
26199 When a message is accepted, the current values of all the ACL variables are
26200 preserved with the message and are subsequently made available at delivery
26201 time. The ACL variables are set by a modifier called &%set%&. For example:
26202 .code
26203 accept hosts = whatever
26204        set acl_m4 = some value
26205 accept authenticated = *
26206        set acl_c_auth = yes
26207 .endd
26208 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26209 be set. If you want to set a variable without taking any action, you can use a
26210 &%warn%& verb without any other modifiers or conditions.
26211
26212 .oindex &%strict_acl_vars%&
26213 What happens if a syntactically valid but undefined ACL variable is
26214 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26215 false (the default), an empty string is substituted; if it is true, an
26216 error is generated.
26217
26218 Versions of Exim before 4.64 have a limited set of numbered variables, but
26219 their names are compatible, so there is no problem with upgrading.
26220
26221
26222 .section "Condition and modifier processing" "SECTcondmodproc"
26223 .cindex "&ACL;" "conditions; processing"
26224 .cindex "&ACL;" "modifiers; processing"
26225 An exclamation mark preceding a condition negates its result. For example:
26226 .code
26227 deny   domains = *.dom.example
26228       !verify  = recipient
26229 .endd
26230 causes the ACL to return &"deny"& if the recipient domain ends in
26231 &'dom.example'& and the recipient address cannot be verified. Sometimes
26232 negation can be used on the right-hand side of a condition. For example, these
26233 two statements are equivalent:
26234 .code
26235 deny  hosts = !192.168.3.4
26236 deny !hosts =  192.168.3.4
26237 .endd
26238 However, for many conditions (&%verify%& being a good example), only left-hand
26239 side negation of the whole condition is possible.
26240
26241 The arguments of conditions and modifiers are expanded. A forced failure
26242 of an expansion causes a condition to be ignored, that is, it behaves as if the
26243 condition is true. Consider these two statements:
26244 .code
26245 accept  senders = ${lookup{$host_name}lsearch\
26246                   {/some/file}{$value}fail}
26247 accept  senders = ${lookup{$host_name}lsearch\
26248                   {/some/file}{$value}{}}
26249 .endd
26250 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26251 the returned list is searched, but if the lookup fails the behaviour is
26252 different in the two cases. The &%fail%& in the first statement causes the
26253 condition to be ignored, leaving no further conditions. The &%accept%& verb
26254 therefore succeeds. The second statement, however, generates an empty list when
26255 the lookup fails. No sender can match an empty list, so the condition fails,
26256 and therefore the &%accept%& also fails.
26257
26258 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26259 specify actions that are taken as the conditions for a statement are checked;
26260 others specify text for messages that are used when access is denied or a
26261 warning is generated. The &%control%& modifier affects the way an incoming
26262 message is handled.
26263
26264 The positioning of the modifiers in an ACL statement important, because the
26265 processing of a verb ceases as soon as its outcome is known. Only those
26266 modifiers that have already been encountered will take effect. For example,
26267 consider this use of the &%message%& modifier:
26268 .code
26269 require message = Can't verify sender
26270         verify  = sender
26271         message = Can't verify recipient
26272         verify  = recipient
26273         message = This message cannot be used
26274 .endd
26275 If sender verification fails, Exim knows that the result of the statement is
26276 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26277 so its text is used as the error message. If sender verification succeeds, but
26278 recipient verification fails, the second message is used. If recipient
26279 verification succeeds, the third message becomes &"current"&, but is never used
26280 because there are no more conditions to cause failure.
26281
26282 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26283 modifier that is used, because all the conditions must be true for rejection to
26284 happen. Specifying more than one &%message%& modifier does not make sense, and
26285 the message can even be specified after all the conditions. For example:
26286 .code
26287 deny   hosts = ...
26288       !senders = *@my.domain.example
26289        message = Invalid sender from client host
26290 .endd
26291 The &"deny"& result does not happen until the end of the statement is reached,
26292 by which time Exim has set up the message.
26293
26294
26295
26296 .section "ACL modifiers" "SECTACLmodi"
26297 .cindex "&ACL;" "modifiers; list of"
26298 The ACL modifiers are as follows:
26299
26300 .vlist
26301 .vitem &*add_header*&&~=&~<&'text'&>
26302 This modifier specifies one or more header lines that are to be added to an
26303 incoming message, assuming, of course, that the message is ultimately
26304 accepted. For details, see section &<<SECTaddheadacl>>&.
26305
26306 .vitem &*continue*&&~=&~<&'text'&>
26307 .cindex "&%continue%& ACL modifier"
26308 .cindex "database" "updating in ACL"
26309 This modifier does nothing of itself, and processing of the ACL always
26310 continues with the next condition or modifier. The value of &%continue%& is in
26311 the side effects of expanding its argument. Typically this could be used to
26312 update a database. It is really just a syntactic tidiness, to avoid having to
26313 write rather ugly lines like this:
26314 .display
26315 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26316 .endd
26317 Instead, all you need is
26318 .display
26319 &`continue = `&<&'some expansion'&>
26320 .endd
26321
26322 .vitem &*control*&&~=&~<&'text'&>
26323 .cindex "&%control%& ACL modifier"
26324 This modifier affects the subsequent processing of the SMTP connection or of an
26325 incoming message that is accepted. The effect of the first type of control
26326 lasts for the duration of the connection, whereas the effect of the second type
26327 lasts only until the current message has been received. The message-specific
26328 controls always apply to the whole message, not to individual recipients,
26329 even if the &%control%& modifier appears in a RCPT ACL.
26330
26331 As there are now quite a few controls that can be applied, they are described
26332 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26333 in several different ways. For example:
26334
26335 . ==== As this is a nested list, any displays it contains must be indented
26336 . ==== as otherwise they are too far to the left. That comment applies only
26337 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26338 . ==== way.
26339
26340 .ilist
26341 It can be at the end of an &%accept%& statement:
26342 .code
26343     accept  ...some conditions
26344             control = queue_only
26345 .endd
26346 In this case, the control is applied when this statement yields &"accept"&, in
26347 other words, when the conditions are all true.
26348
26349 .next
26350 It can be in the middle of an &%accept%& statement:
26351 .code
26352     accept  ...some conditions...
26353             control = queue_only
26354             ...some more conditions...
26355 .endd
26356 If the first set of conditions are true, the control is applied, even if the
26357 statement does not accept because one of the second set of conditions is false.
26358 In this case, some subsequent statement must yield &"accept"& for the control
26359 to be relevant.
26360
26361 .next
26362 It can be used with &%warn%& to apply the control, leaving the
26363 decision about accepting or denying to a subsequent verb. For
26364 example:
26365 .code
26366     warn    ...some conditions...
26367             control = freeze
26368     accept  ...
26369 .endd
26370 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26371 &%logwrite%&, so it does not add anything to the message and does not write a
26372 log entry.
26373
26374 .next
26375 If you want to apply a control unconditionally, you can use it with a
26376 &%require%& verb. For example:
26377 .code
26378     require  control = no_multiline_responses
26379 .endd
26380 .endlist
26381
26382 .vitem &*delay*&&~=&~<&'time'&>
26383 .cindex "&%delay%& ACL modifier"
26384 .oindex "&%-bh%&"
26385 This modifier may appear in any ACL. It causes Exim to wait for the time
26386 interval before proceeding. However, when testing Exim using the &%-bh%&
26387 option, the delay is not actually imposed (an appropriate message is output
26388 instead). The time is given in the usual Exim notation, and the delay happens
26389 as soon as the modifier is processed. In an SMTP session, pending output is
26390 flushed before the delay is imposed.
26391
26392 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26393 example:
26394 .code
26395 deny    ...some conditions...
26396         delay = 30s
26397 .endd
26398 The delay happens if all the conditions are true, before the statement returns
26399 &"deny"&. Compare this with:
26400 .code
26401 deny    delay = 30s
26402         ...some conditions...
26403 .endd
26404 which waits for 30s before processing the conditions. The &%delay%& modifier
26405 can also be used with &%warn%& and together with &%control%&:
26406 .code
26407 warn    ...some conditions...
26408         delay = 2m
26409         control = freeze
26410 accept  ...
26411 .endd
26412
26413 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26414 responses to several commands are no longer buffered and sent in one packet (as
26415 they would normally be) because all output is flushed before imposing the
26416 delay. This optimization is disabled so that a number of small delays do not
26417 appear to the client as one large aggregated delay that might provoke an
26418 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26419 using a &%control%& modifier to set &%no_delay_flush%&.
26420
26421
26422 .vitem &*endpass*&
26423 .cindex "&%endpass%& ACL modifier"
26424 This modifier, which has no argument, is recognized only in &%accept%& and
26425 &%discard%& statements. It marks the boundary between the conditions whose
26426 failure causes control to pass to the next statement, and the conditions whose
26427 failure causes the ACL to return &"deny"&. This concept has proved to be
26428 confusing to some people, so the use of &%endpass%& is no longer recommended as
26429 &"best practice"&. See the description of &%accept%& above for more details.
26430
26431
26432 .vitem &*log_message*&&~=&~<&'text'&>
26433 .cindex "&%log_message%& ACL modifier"
26434 This modifier sets up a message that is used as part of the log message if the
26435 ACL denies access or a &%warn%& statement's conditions are true. For example:
26436 .code
26437 require log_message = wrong cipher suite $tls_cipher
26438         encrypted   = DES-CBC3-SHA
26439 .endd
26440 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26441 example:
26442 .display
26443 &`discard `&<&'some conditions'&>
26444 &`        log_message = Discarded $local_part@$domain because...`&
26445 .endd
26446 When access is denied, &%log_message%& adds to any underlying error message
26447 that may exist because of a condition failure. For example, while verifying a
26448 recipient address, a &':fail:'& redirection might have already set up a
26449 message.
26450
26451 The message may be defined before the conditions to which it applies, because
26452 the string expansion does not happen until Exim decides that access is to be
26453 denied. This means that any variables that are set by the condition are
26454 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26455 variables are set after a DNS black list lookup succeeds. If the expansion of
26456 &%log_message%& fails, or if the result is an empty string, the modifier is
26457 ignored.
26458
26459 .vindex "&$acl_verify_message$&"
26460 If you want to use a &%warn%& statement to log the result of an address
26461 verification, you can use &$acl_verify_message$& to include the verification
26462 error message.
26463
26464 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26465 the start of the logged message. If the same warning log message is requested
26466 more than once while receiving  a single email message, only one copy is
26467 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26468 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26469 is logged for a successful &%warn%& statement.
26470
26471 If &%log_message%& is not present and there is no underlying error message (for
26472 example, from the failure of address verification), but &%message%& is present,
26473 the &%message%& text is used for logging rejections. However, if any text for
26474 logging contains newlines, only the first line is logged. In the absence of
26475 both &%log_message%& and &%message%&, a default built-in message is used for
26476 logging rejections.
26477
26478
26479 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26480 .cindex "&%log_reject_target%& ACL modifier"
26481 .cindex "logging in ACL" "specifying which log"
26482 This modifier makes it possible to specify which logs are used for messages
26483 about ACL rejections. Its argument is a colon-separated list of words that can
26484 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26485 may be empty, in which case a rejection is not logged at all. For example, this
26486 ACL fragment writes no logging information when access is denied:
26487 .display
26488 &`deny `&<&'some conditions'&>
26489 &`     log_reject_target =`&
26490 .endd
26491 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26492 permanent and temporary rejections. Its effect lasts for the rest of the
26493 current ACL.
26494
26495
26496 .vitem &*logwrite*&&~=&~<&'text'&>
26497 .cindex "&%logwrite%& ACL modifier"
26498 .cindex "logging in ACL" "immediate"
26499 This modifier writes a message to a log file as soon as it is encountered when
26500 processing an ACL. (Compare &%log_message%&, which, except in the case of
26501 &%warn%& and &%discard%&, is used only if the ACL statement denies
26502 access.) The &%logwrite%& modifier can be used to log special incidents in
26503 ACLs. For example:
26504 .display
26505 &`accept `&<&'some special conditions'&>
26506 &`       control  = freeze`&
26507 &`       logwrite = froze message because ...`&
26508 .endd
26509 By default, the message is written to the main log. However, it may begin
26510 with a colon, followed by a comma-separated list of log names, and then
26511 another colon, to specify exactly which logs are to be written. For
26512 example:
26513 .code
26514 logwrite = :main,reject: text for main and reject logs
26515 logwrite = :panic: text for panic log only
26516 .endd
26517
26518
26519 .vitem &*message*&&~=&~<&'text'&>
26520 .cindex "&%message%& ACL modifier"
26521 This modifier sets up a text string that is expanded and used as a response
26522 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
26523 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
26524 there is some complication if &%endpass%& is involved; see the description of
26525 &%accept%& for details.)
26526
26527 The expansion of the message happens at the time Exim decides that the ACL is
26528 to end, not at the time it processes &%message%&. If the expansion fails, or
26529 generates an empty string, the modifier is ignored. Here is an example where
26530 &%message%& must be specified first, because the ACL ends with a rejection if
26531 the &%hosts%& condition fails:
26532 .code
26533 require  message = Host not recognized
26534          hosts = 10.0.0.0/8
26535 .endd
26536 (Once a condition has failed, no further conditions or modifiers are
26537 processed.)
26538
26539 .cindex "SMTP" "error codes"
26540 .oindex "&%smtp_banner%&
26541 For ACLs that are triggered by SMTP commands, the message is returned as part
26542 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
26543 is meaningful only for SMTP, as no message is returned when a non-SMTP message
26544 is accepted. In the case of the connect ACL, accepting with a message modifier
26545 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
26546 accept message may not contain more than one line (otherwise it will be
26547 truncated at the first newline and a panic logged), and it cannot affect the
26548 EHLO options.
26549
26550 When SMTP is involved, the message may begin with an overriding response code,
26551 consisting of three digits optionally followed by an &"extended response code"&
26552 of the form &'n.n.n'&, each code being followed by a space. For example:
26553 .code
26554 deny  message = 599 1.2.3 Host not welcome
26555       hosts = 192.168.34.0/24
26556 .endd
26557 The first digit of the supplied response code must be the same as would be sent
26558 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
26559 access, but for the predata ACL, note that the default success code is 354, not
26560 2&'xx'&.
26561
26562 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
26563 the message modifier cannot override the 221 response code.
26564
26565 The text in a &%message%& modifier is literal; any quotes are taken as
26566 literals, but because the string is expanded, backslash escapes are processed
26567 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
26568 response.
26569
26570 .vindex "&$acl_verify_message$&"
26571 If &%message%& is used on a statement that verifies an address, the message
26572 specified overrides any message that is generated by the verification process.
26573 However, the original message is available in the variable
26574 &$acl_verify_message$&, so you can incorporate it into your message if you
26575 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
26576 routers to be passed back as part of the SMTP response, you should either not
26577 use a &%message%& modifier, or make use of &$acl_verify_message$&.
26578
26579 For compatibility with previous releases of Exim, a &%message%& modifier that
26580 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
26581 modifier, but this usage is now deprecated. However, &%message%& acts only when
26582 all the conditions are true, wherever it appears in an ACL command, whereas
26583 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
26584 &%warn%& in an ACL that is not concerned with receiving a message, it has no
26585 effect.
26586
26587
26588 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
26589 .cindex "&%set%& ACL modifier"
26590 This modifier puts a value into one of the ACL variables (see section
26591 &<<SECTaclvariables>>&).
26592 .endlist
26593
26594
26595
26596
26597
26598 .section "Use of the control modifier" "SECTcontrols"
26599 .cindex "&%control%& ACL modifier"
26600 The &%control%& modifier supports the following settings:
26601
26602 .vlist
26603 .vitem &*control&~=&~allow_auth_unadvertised*&
26604 This modifier allows a client host to use the SMTP AUTH command even when it
26605 has not been advertised in response to EHLO. Furthermore, because there are
26606 apparently some really broken clients that do this, Exim will accept AUTH after
26607 HELO (rather than EHLO) when this control is set. It should be used only if you
26608 really need it, and you should limit its use to those broken clients that do
26609 not work without it. For example:
26610 .code
26611 warn hosts   = 192.168.34.25
26612      control = allow_auth_unadvertised
26613 .endd
26614 Normally, when an Exim server receives an AUTH command, it checks the name of
26615 the authentication mechanism that is given in the command to ensure that it
26616 matches an advertised mechanism. When this control is set, the check that a
26617 mechanism has been advertised is bypassed. Any configured mechanism can be used
26618 by the client. This control is permitted only in the connection and HELO ACLs.
26619
26620
26621 .vitem &*control&~=&~caseful_local_part*& &&&
26622        &*control&~=&~caselower_local_part*&
26623 .cindex "&ACL;" "case of local part in"
26624 .cindex "case of local parts"
26625 .vindex "&$local_part$&"
26626 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
26627 (that is, during RCPT processing). By default, the contents of &$local_part$&
26628 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
26629 any uppercase letters in the original local part are restored in &$local_part$&
26630 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
26631 is encountered.
26632
26633 These controls affect only the current recipient. Moreover, they apply only to
26634 local part handling that takes place directly in the ACL (for example, as a key
26635 in lookups). If a test to verify the recipient is obeyed, the case-related
26636 handling of the local part during the verification is controlled by the router
26637 configuration (see the &%caseful_local_part%& generic router option).
26638
26639 This facility could be used, for example, to add a spam score to local parts
26640 containing upper case letters. For example, using &$acl_m4$& to accumulate the
26641 spam score:
26642 .code
26643 warn  control = caseful_local_part
26644       set acl_m4 = ${eval:\
26645                      $acl_m4 + \
26646                      ${if match{$local_part}{[A-Z]}{1}{0}}\
26647                     }
26648       control = caselower_local_part
26649 .endd
26650 Notice that we put back the lower cased version afterwards, assuming that
26651 is what is wanted for subsequent tests.
26652
26653
26654 .vitem &*control&~=&~debug/*&<&'options'&>
26655 .cindex "&ACL;" "enabling debug logging"
26656 .cindex "debugging" "enabling from an ACL"
26657 This control turns on debug logging, almost as though Exim had been invoked
26658 with &`-d`&, with the output going to a new logfile, by default called
26659 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
26660 may access any variables already defined.  The logging may be adjusted with
26661 the &'opts'& option, which takes the same values as the &`-d`& command-line
26662 option.  Some examples (which depend on variables that don't exist in all
26663 contexts):
26664 .code
26665       control = debug
26666       control = debug/tag=.$sender_host_address
26667       control = debug/opts=+expand+acl
26668       control = debug/tag=.$message_exim_id/opts=+expand
26669 .endd
26670
26671
26672 .vitem &*control&~=&~enforce_sync*& &&&
26673        &*control&~=&~no_enforce_sync*&
26674 .cindex "SMTP" "synchronization checking"
26675 .cindex "synchronization checking in SMTP"
26676 These controls make it possible to be selective about when SMTP synchronization
26677 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
26678 state of the switch (it is true by default). See the description of this option
26679 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
26680
26681 The effect of these two controls lasts for the remainder of the SMTP
26682 connection. They can appear in any ACL except the one for the non-SMTP
26683 messages. The most straightforward place to put them is in the ACL defined by
26684 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
26685 before the first synchronization check. The expected use is to turn off the
26686 synchronization checks for badly-behaved hosts that you nevertheless need to
26687 work with.
26688
26689
26690 .vitem &*control&~=&~fakedefer/*&<&'message'&>
26691 .cindex "fake defer"
26692 .cindex "defer, fake"
26693 This control works in exactly the same way as &%fakereject%& (described below)
26694 except that it causes an SMTP 450 response after the message data instead of a
26695 550 response. You must take care when using &%fakedefer%& because it causes the
26696 messages to be duplicated when the sender retries. Therefore, you should not
26697 use &%fakedefer%& if the message is to be delivered normally.
26698
26699 .vitem &*control&~=&~fakereject/*&<&'message'&>
26700 .cindex "fake rejection"
26701 .cindex "rejection, fake"
26702 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
26703 words, only when an SMTP message is being received. If Exim accepts the
26704 message, instead the final 250 response, a 550 rejection message is sent.
26705 However, Exim proceeds to deliver the message as normal. The control applies
26706 only to the current message, not to any subsequent ones that may be received in
26707 the same SMTP connection.
26708
26709 The text for the 550 response is taken from the &%control%& modifier. If no
26710 message is supplied, the following is used:
26711 .code
26712 550-Your message has been rejected but is being
26713 550-kept for evaluation.
26714 550-If it was a legitimate message, it may still be
26715 550 delivered to the target recipient(s).
26716 .endd
26717 This facility should be used with extreme caution.
26718
26719 .vitem &*control&~=&~freeze*&
26720 .cindex "frozen messages" "forcing in ACL"
26721 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26722 other words, only when a message is being received. If the message is accepted,
26723 it is placed on Exim's queue and frozen. The control applies only to the
26724 current message, not to any subsequent ones that may be received in the same
26725 SMTP connection.
26726
26727 This modifier can optionally be followed by &`/no_tell`&. If the global option
26728 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
26729 is told about the freezing), provided all the &*control=freeze*& modifiers that
26730 are obeyed for the current message have the &`/no_tell`& option.
26731
26732 .vitem &*control&~=&~no_delay_flush*&
26733 .cindex "SMTP" "output flushing, disabling for delay"
26734 Exim normally flushes SMTP output before implementing a delay in an ACL, to
26735 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26736 use. This control, as long as it is encountered before the &%delay%& modifier,
26737 disables such output flushing.
26738
26739 .vitem &*control&~=&~no_callout_flush*&
26740 .cindex "SMTP" "output flushing, disabling for callout"
26741 Exim normally flushes SMTP output before performing a callout in an ACL, to
26742 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26743 use. This control, as long as it is encountered before the &%verify%& condition
26744 that causes the callout, disables such output flushing.
26745
26746 .vitem &*control&~=&~no_mbox_unspool*&
26747 This control is available when Exim is compiled with the content scanning
26748 extension. Content scanning may require a copy of the current message, or parts
26749 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
26750 or spam scanner. Normally, such copies are deleted when they are no longer
26751 needed. If this control is set, the copies are not deleted. The control applies
26752 only to the current message, not to any subsequent ones that may be received in
26753 the same SMTP connection. It is provided for debugging purposes and is unlikely
26754 to be useful in production.
26755
26756 .vitem &*control&~=&~no_multiline_responses*&
26757 .cindex "multiline responses, suppressing"
26758 This control is permitted for any ACL except the one for non-SMTP messages.
26759 It seems that there are broken clients in use that cannot handle multiline
26760 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
26761
26762 If this control is set, multiline SMTP responses from ACL rejections are
26763 suppressed. One way of doing this would have been to put out these responses as
26764 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
26765 (&"use multiline responses for more"& it says &-- ha!), and some of the
26766 responses might get close to that. So this facility, which is after all only a
26767 sop to broken clients, is implemented by doing two very easy things:
26768
26769 .ilist
26770 Extra information that is normally output as part of a rejection caused by
26771 sender verification failure is omitted. Only the final line (typically &"sender
26772 verification failed"&) is sent.
26773 .next
26774 If a &%message%& modifier supplies a multiline response, only the first
26775 line is output.
26776 .endlist
26777
26778 The setting of the switch can, of course, be made conditional on the
26779 calling host. Its effect lasts until the end of the SMTP connection.
26780
26781 .vitem &*control&~=&~no_pipelining*&
26782 .cindex "PIPELINING" "suppressing advertising"
26783 This control turns off the advertising of the PIPELINING extension to SMTP in
26784 the current session. To be useful, it must be obeyed before Exim sends its
26785 response to an EHLO command. Therefore, it should normally appear in an ACL
26786 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26787 &%pipelining_advertise_hosts%&.
26788
26789 .vitem &*control&~=&~queue_only*&
26790 .oindex "&%queue_only%&"
26791 .cindex "queueing incoming messages"
26792 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26793 other words, only when a message is being received. If the message is accepted,
26794 it is placed on Exim's queue and left there for delivery by a subsequent queue
26795 runner. No immediate delivery process is started. In other words, it has the
26796 effect as the &%queue_only%& global option. However, the control applies only
26797 to the current message, not to any subsequent ones that may be received in the
26798 same SMTP connection.
26799
26800 .vitem &*control&~=&~submission/*&<&'options'&>
26801 .cindex "message" "submission"
26802 .cindex "submission mode"
26803 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26804 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26805 the current message is a submission from a local MUA. In this case, Exim
26806 operates in &"submission mode"&, and applies certain fixups to the message if
26807 necessary. For example, it adds a &'Date:'& header line if one is not present.
26808 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26809 late (the message has already been created).
26810
26811 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26812 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26813 submission mode; the available options for this control are described there.
26814 The control applies only to the current message, not to any subsequent ones
26815 that may be received in the same SMTP connection.
26816
26817 .vitem &*control&~=&~suppress_local_fixups*&
26818 .cindex "submission fixups, suppressing"
26819 This control applies to locally submitted (non TCP/IP) messages, and is the
26820 complement of &`control = submission`&. It disables the fixups that are
26821 normally applied to locally-submitted messages. Specifically:
26822
26823 .ilist
26824 Any &'Sender:'& header line is left alone (in this respect, it is a
26825 dynamic version of &%local_sender_retain%&).
26826 .next
26827 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26828 .next
26829 There is no check that &'From:'& corresponds to the actual sender.
26830 .endlist ilist
26831
26832 This control may be useful when a remotely-originated message is accepted,
26833 passed to some scanning program, and then re-submitted for delivery. It can be
26834 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26835 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26836 data is read.
26837
26838 &*Note:*& This control applies only to the current message, not to any others
26839 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26840 .endlist vlist
26841
26842
26843 .section "Summary of message fixup control" "SECTsummesfix"
26844 All four possibilities for message fixups can be specified:
26845
26846 .ilist
26847 Locally submitted, fixups applied: the default.
26848 .next
26849 Locally submitted, no fixups applied: use
26850 &`control = suppress_local_fixups`&.
26851 .next
26852 Remotely submitted, no fixups applied: the default.
26853 .next
26854 Remotely submitted, fixups applied: use &`control = submission`&.
26855 .endlist
26856
26857
26858
26859 .section "Adding header lines in ACLs" "SECTaddheadacl"
26860 .cindex "header lines" "adding in an ACL"
26861 .cindex "header lines" "position of added lines"
26862 .cindex "&%message%& ACL modifier"
26863 The &%add_header%& modifier can be used to add one or more extra header lines
26864 to an incoming message, as in this example:
26865 .code
26866 warn dnslists = sbl.spamhaus.org : \
26867                 dialup.mail-abuse.org
26868      add_header = X-blacklisted-at: $dnslist_domain
26869 .endd
26870 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26871 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26872 receiving a message). The message must ultimately be accepted for
26873 &%add_header%& to have any significant effect. You can use &%add_header%& with
26874 any ACL verb, including &%deny%& (though this is potentially useful only in a
26875 RCPT ACL).
26876
26877 If the data for the &%add_header%& modifier contains one or more newlines that
26878 are not followed by a space or a tab, it is assumed to contain multiple header
26879 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26880 front of any line that is not a valid header line.
26881
26882 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26883 They are added to the message before processing the DATA and MIME ACLs.
26884 However, if an identical header line is requested more than once, only one copy
26885 is actually added to the message. Further header lines may be accumulated
26886 during the DATA and MIME ACLs, after which they are added to the message, again
26887 with duplicates suppressed. Thus, it is possible to add two identical header
26888 lines to an SMTP message, but only if one is added before DATA and one after.
26889 In the case of non-SMTP messages, new headers are accumulated during the
26890 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26891 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26892 are included in the entry that is written to the reject log.
26893
26894 .cindex "header lines" "added; visibility of"
26895 Header lines are not visible in string expansions until they are added to the
26896 message. It follows that header lines defined in the MAIL, RCPT, and predata
26897 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26898 header lines that are added by the DATA or MIME ACLs are not visible in those
26899 ACLs. Because of this restriction, you cannot use header lines as a way of
26900 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26901 this, you can use ACL variables, as described in section
26902 &<<SECTaclvariables>>&.
26903
26904 The &%add_header%& modifier acts immediately it is encountered during the
26905 processing of an ACL. Notice the difference between these two cases:
26906 .display
26907 &`accept add_header = ADDED: some text`&
26908 &`       `&<&'some condition'&>
26909
26910 &`accept `&<&'some condition'&>
26911 &`       add_header = ADDED: some text`&
26912 .endd
26913 In the first case, the header line is always added, whether or not the
26914 condition is true. In the second case, the header line is added only if the
26915 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26916 ACL statement. All those that are encountered before a condition fails are
26917 honoured.
26918
26919 .cindex "&%warn%& ACL verb"
26920 For compatibility with previous versions of Exim, a &%message%& modifier for a
26921 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26922 effect only if all the conditions are true, even if it appears before some of
26923 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26924 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26925 are present on a &%warn%& verb, both are processed according to their
26926 specifications.
26927
26928 By default, new header lines are added to a message at the end of the existing
26929 header lines. However, you can specify that any particular header line should
26930 be added right at the start (before all the &'Received:'& lines), immediately
26931 after the first block of &'Received:'& lines, or immediately before any line
26932 that is not a &'Received:'& or &'Resent-something:'& header.
26933
26934 This is done by specifying &":at_start:"&, &":after_received:"&, or
26935 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26936 header line, respectively. (Header text cannot start with a colon, as there has
26937 to be a header name first.) For example:
26938 .code
26939 warn add_header = \
26940        :after_received:X-My-Header: something or other...
26941 .endd
26942 If more than one header line is supplied in a single &%add_header%& modifier,
26943 each one is treated independently and can therefore be placed differently. If
26944 you add more than one line at the start, or after the Received: block, they end
26945 up in reverse order.
26946
26947 &*Warning*&: This facility currently applies only to header lines that are
26948 added in an ACL. It does NOT work for header lines that are added in a
26949 system filter or in a router or transport.
26950
26951
26952
26953
26954 .section "ACL conditions" "SECTaclconditions"
26955 .cindex "&ACL;" "conditions; list of"
26956 Some of conditions listed in this section are available only when Exim is
26957 compiled with the content-scanning extension. They are included here briefly
26958 for completeness. More detailed descriptions can be found in the discussion on
26959 content scanning in chapter &<<CHAPexiscan>>&.
26960
26961 Not all conditions are relevant in all circumstances. For example, testing
26962 senders and recipients does not make sense in an ACL that is being run as the
26963 result of the arrival of an ETRN command, and checks on message headers can be
26964 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26965 can use the same condition (with different parameters) more than once in the
26966 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26967 The conditions are as follows:
26968
26969
26970 .vlist
26971 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26972 .cindex "&ACL;" "nested"
26973 .cindex "&ACL;" "indirect"
26974 .cindex "&%acl%& ACL condition"
26975 The possible values of the argument are the same as for the
26976 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26977 &"accept"& the condition is true; if it returns &"deny"& the condition is
26978 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26979 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26980 condition false. This means that further processing of the &%warn%& verb
26981 ceases, but processing of the ACL continues.
26982
26983 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26984 the connection is dropped. If it returns &"discard"&, the verb must be
26985 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26986 conditions are tested.
26987
26988 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26989 loops. This condition allows you to use different ACLs in different
26990 circumstances. For example, different ACLs can be used to handle RCPT commands
26991 for different local users or different local domains.
26992
26993 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26994 .cindex "&%authenticated%& ACL condition"
26995 .cindex "authentication" "ACL checking"
26996 .cindex "&ACL;" "testing for authentication"
26997 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26998 the name of the authenticator is tested against the list. To test for
26999 authentication by any authenticator, you can set
27000 .code
27001 authenticated = *
27002 .endd
27003
27004 .vitem &*condition&~=&~*&<&'string'&>
27005 .cindex "&%condition%& ACL condition"
27006 .cindex "customizing" "ACL condition"
27007 .cindex "&ACL;" "customized test"
27008 .cindex "&ACL;" "testing, customized"
27009 This feature allows you to make up custom conditions. If the result of
27010 expanding the string is an empty string, the number zero, or one of the strings
27011 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27012 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27013 any other value, some error is assumed to have occurred, and the ACL returns
27014 &"defer"&. However, if the expansion is forced to fail, the condition is
27015 ignored. The effect is to treat it as true, whether it is positive or
27016 negative.
27017
27018 .vitem &*decode&~=&~*&<&'location'&>
27019 .cindex "&%decode%& ACL condition"
27020 This condition is available only when Exim is compiled with the
27021 content-scanning extension, and it is allowed only in the ACL defined by
27022 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27023 If all goes well, the condition is true. It is false only if there are
27024 problems such as a syntax error or a memory shortage. For more details, see
27025 chapter &<<CHAPexiscan>>&.
27026
27027 .vitem &*demime&~=&~*&<&'extension&~list'&>
27028 .cindex "&%demime%& ACL condition"
27029 This condition is available only when Exim is compiled with the
27030 content-scanning extension. Its use is described in section
27031 &<<SECTdemimecond>>&.
27032
27033 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27034 .cindex "&%dnslists%& ACL condition"
27035 .cindex "DNS list" "in ACL"
27036 .cindex "black list (DNS)"
27037 .cindex "&ACL;" "testing a DNS list"
27038 This condition checks for entries in DNS black lists. These are also known as
27039 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27040 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27041 different variants of this condition to describe briefly here. See sections
27042 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27043
27044 .vitem &*domains&~=&~*&<&'domain&~list'&>
27045 .cindex "&%domains%& ACL condition"
27046 .cindex "domain" "ACL checking"
27047 .cindex "&ACL;" "testing a recipient domain"
27048 .vindex "&$domain_data$&"
27049 This condition is relevant only after a RCPT command. It checks that the domain
27050 of the recipient address is in the domain list. If percent-hack processing is
27051 enabled, it is done before this test is done. If the check succeeds with a
27052 lookup, the result of the lookup is placed in &$domain_data$& until the next
27053 &%domains%& test.
27054
27055 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27056 use &%domains%& in a DATA ACL.
27057
27058
27059 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27060 .cindex "&%encrypted%& ACL condition"
27061 .cindex "encryption" "checking in an ACL"
27062 .cindex "&ACL;" "testing for encryption"
27063 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27064 name of the cipher suite in use is tested against the list. To test for
27065 encryption without testing for any specific cipher suite(s), set
27066 .code
27067 encrypted = *
27068 .endd
27069
27070
27071 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
27072 .cindex "&%hosts%& ACL condition"
27073 .cindex "host" "ACL checking"
27074 .cindex "&ACL;" "testing the client host"
27075 This condition tests that the calling host matches the host list. If you have
27076 name lookups or wildcarded host names and IP addresses in the same host list,
27077 you should normally put the IP addresses first. For example, you could have:
27078 .code
27079 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27080 .endd
27081 The lookup in this example uses the host name for its key. This is implied by
27082 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27083 and it wouldn't matter which way round you had these two items.)
27084
27085 The reason for the problem with host names lies in the left-to-right way that
27086 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27087 but when it reaches an item that requires a host name, it fails if it cannot
27088 find a host name to compare with the pattern. If the above list is given in the
27089 opposite order, the &%accept%& statement fails for a host whose name cannot be
27090 found, even if its IP address is 10.9.8.7.
27091
27092 If you really do want to do the name check first, and still recognize the IP
27093 address even if the name lookup fails, you can rewrite the ACL like this:
27094 .code
27095 accept hosts = dbm;/etc/friendly/hosts
27096 accept hosts = 10.9.8.7
27097 .endd
27098 The default action on failing to find the host name is to assume that the host
27099 is not in the list, so the first &%accept%& statement fails. The second
27100 statement can then check the IP address.
27101
27102 .vindex "&$host_data$&"
27103 If a &%hosts%& condition is satisfied by means of a lookup, the result
27104 of the lookup is made available in the &$host_data$& variable. This
27105 allows you, for example, to set up a statement like this:
27106 .code
27107 deny  hosts = net-lsearch;/some/file
27108 message = $host_data
27109 .endd
27110 which gives a custom error message for each denied host.
27111
27112 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27113 .cindex "&%local_parts%& ACL condition"
27114 .cindex "local part" "ACL checking"
27115 .cindex "&ACL;" "testing a local part"
27116 .vindex "&$local_part_data$&"
27117 This condition is relevant only after a RCPT command. It checks that the local
27118 part of the recipient address is in the list. If percent-hack processing is
27119 enabled, it is done before this test. If the check succeeds with a lookup, the
27120 result of the lookup is placed in &$local_part_data$&, which remains set until
27121 the next &%local_parts%& test.
27122
27123 .vitem &*malware&~=&~*&<&'option'&>
27124 .cindex "&%malware%& ACL condition"
27125 .cindex "&ACL;" "virus scanning"
27126 .cindex "&ACL;" "scanning for viruses"
27127 This condition is available only when Exim is compiled with the
27128 content-scanning extension. It causes the incoming message to be scanned for
27129 viruses. For details, see chapter &<<CHAPexiscan>>&.
27130
27131 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27132 .cindex "&%mime_regex%& ACL condition"
27133 .cindex "&ACL;" "testing by regex matching"
27134 This condition is available only when Exim is compiled with the
27135 content-scanning extension, and it is allowed only in the ACL defined by
27136 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27137 with any of the regular expressions. For details, see chapter
27138 &<<CHAPexiscan>>&.
27139
27140 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27141 .cindex "rate limiting"
27142 This condition can be used to limit the rate at which a user or host submits
27143 messages. Details are given in section &<<SECTratelimiting>>&.
27144
27145 .vitem &*recipients&~=&~*&<&'address&~list'&>
27146 .cindex "&%recipients%& ACL condition"
27147 .cindex "recipient" "ACL checking"
27148 .cindex "&ACL;" "testing a recipient"
27149 This condition is relevant only after a RCPT command. It checks the entire
27150 recipient address against a list of recipients.
27151
27152 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27153 .cindex "&%regex%& ACL condition"
27154 .cindex "&ACL;" "testing by regex matching"
27155 This condition is available only when Exim is compiled with the
27156 content-scanning extension, and is available only in the DATA, MIME, and
27157 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27158 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27159
27160 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27161 .cindex "&%sender_domains%& ACL condition"
27162 .cindex "sender" "ACL checking"
27163 .cindex "&ACL;" "testing a sender domain"
27164 .vindex "&$domain$&"
27165 .vindex "&$sender_address_domain$&"
27166 This condition tests the domain of the sender of the message against the given
27167 domain list. &*Note*&: The domain of the sender address is in
27168 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27169 of this condition. This is an exception to the general rule for testing domain
27170 lists. It is done this way so that, if this condition is used in an ACL for a
27171 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27172 influence the sender checking.
27173
27174 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27175 relaying, because sender addresses are easily, and commonly, forged.
27176
27177 .vitem &*senders&~=&~*&<&'address&~list'&>
27178 .cindex "&%senders%& ACL condition"
27179 .cindex "sender" "ACL checking"
27180 .cindex "&ACL;" "testing a sender"
27181 This condition tests the sender of the message against the given list. To test
27182 for a bounce message, which has an empty sender, set
27183 .code
27184 senders = :
27185 .endd
27186 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27187 relaying, because sender addresses are easily, and commonly, forged.
27188
27189 .vitem &*spam&~=&~*&<&'username'&>
27190 .cindex "&%spam%& ACL condition"
27191 .cindex "&ACL;" "scanning for spam"
27192 This condition is available only when Exim is compiled with the
27193 content-scanning extension. It causes the incoming message to be scanned by
27194 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27195
27196 .vitem &*verify&~=&~certificate*&
27197 .cindex "&%verify%& ACL condition"
27198 .cindex "TLS" "client certificate verification"
27199 .cindex "certificate" "verification of client"
27200 .cindex "&ACL;" "certificate verification"
27201 .cindex "&ACL;" "testing a TLS certificate"
27202 This condition is true in an SMTP session if the session is encrypted, and a
27203 certificate was received from the client, and the certificate was verified. The
27204 server requests a certificate only if the client matches &%tls_verify_hosts%&
27205 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27206
27207 .vitem &*verify&~=&~csa*&
27208 .cindex "CSA verification"
27209 This condition checks whether the sending host (the client) is authorized to
27210 send email. Details of how this works are given in section
27211 &<<SECTverifyCSA>>&.
27212
27213 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27214 .cindex "&%verify%& ACL condition"
27215 .cindex "&ACL;" "verifying sender in the header"
27216 .cindex "header lines" "verifying the sender in"
27217 .cindex "sender" "verifying in header"
27218 .cindex "verifying" "sender in header"
27219 This condition is relevant only in an ACL that is run after a message has been
27220 received, that is, in an ACL specified by &%acl_smtp_data%& or
27221 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27222 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27223 is loosely thought of as a &"sender"& address (hence the name of the test).
27224 However, an address that appears in one of these headers need not be an address
27225 that accepts bounce messages; only sender addresses in envelopes are required
27226 to accept bounces. Therefore, if you use the callout option on this check, you
27227 might want to arrange for a non-empty address in the MAIL command.
27228
27229 Details of address verification and the options are given later, starting at
27230 section &<<SECTaddressverification>>& (callouts are described in section
27231 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27232 condition to restrict it to bounce messages only:
27233 .code
27234 deny    senders = :
27235         message = A valid sender header is required for bounces
27236        !verify  = header_sender
27237 .endd
27238
27239 .vitem &*verify&~=&~header_syntax*&
27240 .cindex "&%verify%& ACL condition"
27241 .cindex "&ACL;" "verifying header syntax"
27242 .cindex "header lines" "verifying syntax"
27243 .cindex "verifying" "header syntax"
27244 This condition is relevant only in an ACL that is run after a message has been
27245 received, that is, in an ACL specified by &%acl_smtp_data%& or
27246 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27247 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27248 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27249 permitted only in locally generated messages and from hosts that match
27250 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27251 appropriate.
27252
27253 Note that this condition is a syntax check only. However, a common spamming
27254 ploy used to be to send syntactically invalid headers such as
27255 .code
27256 To: @
27257 .endd
27258 and this condition can be used to reject such messages, though they are not as
27259 common as they used to be.
27260
27261 .vitem &*verify&~=&~helo*&
27262 .cindex "&%verify%& ACL condition"
27263 .cindex "&ACL;" "verifying HELO/EHLO"
27264 .cindex "HELO" "verifying"
27265 .cindex "EHLO" "verifying"
27266 .cindex "verifying" "EHLO"
27267 .cindex "verifying" "HELO"
27268 This condition is true if a HELO or EHLO command has been received from the
27269 client host, and its contents have been verified. If there has been no previous
27270 attempt to verify the HELO/EHLO contents, it is carried out when this
27271 condition is encountered. See the description of the &%helo_verify_hosts%& and
27272 &%helo_try_verify_hosts%& options for details of how to request verification
27273 independently of this condition.
27274
27275 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27276 option), this condition is always true.
27277
27278
27279 .vitem &*verify&~=&~not_blind*&
27280 .cindex "verifying" "not blind"
27281 .cindex "bcc recipients, verifying none"
27282 This condition checks that there are no blind (bcc) recipients in the message.
27283 Every envelope recipient must appear either in a &'To:'& header line or in a
27284 &'Cc:'& header line for this condition to be true. Local parts are checked
27285 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27286 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27287 used only in a DATA or non-SMTP ACL.
27288
27289 There are, of course, many legitimate messages that make use of blind (bcc)
27290 recipients. This check should not be used on its own for blocking messages.
27291
27292
27293 .vitem &*verify&~=&~recipient/*&<&'options'&>
27294 .cindex "&%verify%& ACL condition"
27295 .cindex "&ACL;" "verifying recipient"
27296 .cindex "recipient" "verifying"
27297 .cindex "verifying" "recipient"
27298 .vindex "&$address_data$&"
27299 This condition is relevant only after a RCPT command. It verifies the current
27300 recipient. Details of address verification are given later, starting at section
27301 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27302 of &$address_data$& is the last value that was set while routing the address.
27303 This applies even if the verification fails. When an address that is being
27304 verified is redirected to a single address, verification continues with the new
27305 address, and in that case, the subsequent value of &$address_data$& is the
27306 value for the child address.
27307
27308 .vitem &*verify&~=&~reverse_host_lookup*&
27309 .cindex "&%verify%& ACL condition"
27310 .cindex "&ACL;" "verifying host reverse lookup"
27311 .cindex "host" "verifying reverse lookup"
27312 This condition ensures that a verified host name has been looked up from the IP
27313 address of the client host. (This may have happened already if the host name
27314 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27315 Verification ensures that the host name obtained from a reverse DNS lookup, or
27316 one of its aliases, does, when it is itself looked up in the DNS, yield the
27317 original IP address.
27318
27319 If this condition is used for a locally generated message (that is, when there
27320 is no client host involved), it always succeeds.
27321
27322 .vitem &*verify&~=&~sender/*&<&'options'&>
27323 .cindex "&%verify%& ACL condition"
27324 .cindex "&ACL;" "verifying sender"
27325 .cindex "sender" "verifying"
27326 .cindex "verifying" "sender"
27327 This condition is relevant only after a MAIL or RCPT command, or after a
27328 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27329 the message's sender is empty (that is, this is a bounce message), the
27330 condition is true. Otherwise, the sender address is verified.
27331
27332 .vindex "&$address_data$&"
27333 .vindex "&$sender_address_data$&"
27334 If there is data in the &$address_data$& variable at the end of routing, its
27335 value is placed in &$sender_address_data$& at the end of verification. This
27336 value can be used in subsequent conditions and modifiers in the same ACL
27337 statement. It does not persist after the end of the current statement. If you
27338 want to preserve the value for longer, you can save it in an ACL variable.
27339
27340 Details of verification are given later, starting at section
27341 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
27342 to avoid doing it more than once per message.
27343
27344 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
27345 .cindex "&%verify%& ACL condition"
27346 This is a variation of the previous option, in which a modified address is
27347 verified as a sender.
27348 .endlist
27349
27350
27351
27352 .section "Using DNS lists" "SECTmorednslists"
27353 .cindex "DNS list" "in ACL"
27354 .cindex "black list (DNS)"
27355 .cindex "&ACL;" "testing a DNS list"
27356 In its simplest form, the &%dnslists%& condition tests whether the calling host
27357 is on at least one of a number of DNS lists by looking up the inverted IP
27358 address in one or more DNS domains. (Note that DNS list domains are not mail
27359 domains, so the &`+`& syntax for named lists doesn't work - it is used for
27360 special options instead.) For example, if the calling host's IP
27361 address is 192.168.62.43, and the ACL statement is
27362 .code
27363 deny dnslists = blackholes.mail-abuse.org : \
27364                 dialups.mail-abuse.org
27365 .endd
27366 the following records are looked up:
27367 .code
27368 43.62.168.192.blackholes.mail-abuse.org
27369 43.62.168.192.dialups.mail-abuse.org
27370 .endd
27371 As soon as Exim finds an existing DNS record, processing of the list stops.
27372 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
27373 to test that a host is on more than one list (an &"and"& conjunction), you can
27374 use two separate conditions:
27375 .code
27376 deny dnslists = blackholes.mail-abuse.org
27377      dnslists = dialups.mail-abuse.org
27378 .endd
27379 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
27380 behaves as if the host does not match the list item, that is, as if the DNS
27381 record does not exist. If there are further items in the DNS list, they are
27382 processed.
27383
27384 This is usually the required action when &%dnslists%& is used with &%deny%&
27385 (which is the most common usage), because it prevents a DNS failure from
27386 blocking mail. However, you can change this behaviour by putting one of the
27387 following special items in the list:
27388 .display
27389 &`+include_unknown `&   behave as if the item is on the list
27390 &`+exclude_unknown `&   behave as if the item is not on the list (default)
27391 &`+defer_unknown   `&   give a temporary error
27392 .endd
27393 .cindex "&`+include_unknown`&"
27394 .cindex "&`+exclude_unknown`&"
27395 .cindex "&`+defer_unknown`&"
27396 Each of these applies to any subsequent items on the list. For example:
27397 .code
27398 deny dnslists = +defer_unknown : foo.bar.example
27399 .endd
27400 Testing the list of domains stops as soon as a match is found. If you want to
27401 warn for one list and block for another, you can use two different statements:
27402 .code
27403 deny  dnslists = blackholes.mail-abuse.org
27404 warn  message  = X-Warn: sending host is on dialups list
27405       dnslists = dialups.mail-abuse.org
27406 .endd
27407 DNS list lookups are cached by Exim for the duration of the SMTP session,
27408 so a lookup based on the IP address is done at most once for any incoming
27409 connection. Exim does not share information between multiple incoming
27410 connections (but your local name server cache should be active).
27411
27412
27413
27414 .section "Specifying the IP address for a DNS list lookup" "SECID201"
27415 .cindex "DNS list" "keyed by explicit IP address"
27416 By default, the IP address that is used in a DNS list lookup is the IP address
27417 of the calling host. However, you can specify another IP address by listing it
27418 after the domain name, introduced by a slash. For example:
27419 .code
27420 deny dnslists = black.list.tld/192.168.1.2
27421 .endd
27422 This feature is not very helpful with explicit IP addresses; it is intended for
27423 use with IP addresses that are looked up, for example, the IP addresses of the
27424 MX hosts or nameservers of an email sender address. For an example, see section
27425 &<<SECTmulkeyfor>>& below.
27426
27427
27428
27429
27430 .section "DNS lists keyed on domain names" "SECID202"
27431 .cindex "DNS list" "keyed by domain name"
27432 There are some lists that are keyed on domain names rather than inverted IP
27433 addresses (see for example the &'domain based zones'& link at
27434 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
27435 with these lists. You can change the name that is looked up in a DNS list by
27436 listing it after the domain name, introduced by a slash. For example,
27437 .code
27438 deny  message  = Sender's domain is listed at $dnslist_domain
27439       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
27440 .endd
27441 This particular example is useful only in ACLs that are obeyed after the
27442 RCPT or DATA commands, when a sender address is available. If (for
27443 example) the message's sender is &'user@tld.example'& the name that is looked
27444 up by this example is
27445 .code
27446 tld.example.dsn.rfc-ignorant.org
27447 .endd
27448 A single &%dnslists%& condition can contain entries for both names and IP
27449 addresses. For example:
27450 .code
27451 deny dnslists = sbl.spamhaus.org : \
27452                 dsn.rfc-ignorant.org/$sender_address_domain
27453 .endd
27454 The first item checks the sending host's IP address; the second checks a domain
27455 name. The whole condition is true if either of the DNS lookups succeeds.
27456
27457
27458
27459
27460 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
27461 .cindex "DNS list" "multiple keys for"
27462 The syntax described above for looking up explicitly-defined values (either
27463 names or IP addresses) in a DNS blacklist is a simplification. After the domain
27464 name for the DNS list, what follows the slash can in fact be a list of items.
27465 As with all lists in Exim, the default separator is a colon. However, because
27466 this is a sublist within the list of DNS blacklist domains, it is necessary
27467 either to double the separators like this:
27468 .code
27469 dnslists = black.list.tld/name.1::name.2
27470 .endd
27471 or to change the separator character, like this:
27472 .code
27473 dnslists = black.list.tld/<;name.1;name.2
27474 .endd
27475 If an item in the list is an IP address, it is inverted before the DNS
27476 blacklist domain is appended. If it is not an IP address, no inversion
27477 occurs. Consider this condition:
27478 .code
27479 dnslists = black.list.tld/<;192.168.1.2;a.domain
27480 .endd
27481 The DNS lookups that occur are:
27482 .code
27483 2.1.168.192.black.list.tld
27484 a.domain.black.list.tld
27485 .endd
27486 Once a DNS record has been found (that matches a specific IP return
27487 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
27488 are done. If there is a temporary DNS error, the rest of the sublist of domains
27489 or IP addresses is tried. A temporary error for the whole dnslists item occurs
27490 only if no other DNS lookup in this sublist succeeds. In other words, a
27491 successful lookup for any of the items in the sublist overrides a temporary
27492 error for a previous item.
27493
27494 The ability to supply a list of items after the slash is in some sense just a
27495 syntactic convenience. These two examples have the same effect:
27496 .code
27497 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
27498 dnslists = black.list.tld/a.domain::b.domain
27499 .endd
27500 However, when the data for the list is obtained from a lookup, the second form
27501 is usually much more convenient. Consider this example:
27502 .code
27503 deny message  = The mail servers for the domain \
27504                 $sender_address_domain \
27505                 are listed at $dnslist_domain ($dnslist_value); \
27506                 see $dnslist_text.
27507      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
27508                                    ${lookup dnsdb {>|mxh=\
27509                                    $sender_address_domain} }} }
27510 .endd
27511 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
27512 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
27513 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
27514 of expanding the condition might be something like this:
27515 .code
27516 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
27517 .endd
27518 Thus, this example checks whether or not the IP addresses of the sender
27519 domain's mail servers are on the Spamhaus black list.
27520
27521 The key that was used for a successful DNS list lookup is put into the variable
27522 &$dnslist_matched$& (see section &<<SECID204>>&).
27523
27524
27525
27526
27527 .section "Data returned by DNS lists" "SECID203"
27528 .cindex "DNS list" "data returned from"
27529 DNS lists are constructed using address records in the DNS. The original RBL
27530 just used the address 127.0.0.1 on the right hand side of each record, but the
27531 RBL+ list and some other lists use a number of values with different meanings.
27532 The values used on the RBL+ list are:
27533 .display
27534 127.1.0.1  RBL
27535 127.1.0.2  DUL
27536 127.1.0.3  DUL and RBL
27537 127.1.0.4  RSS
27538 127.1.0.5  RSS and RBL
27539 127.1.0.6  RSS and DUL
27540 127.1.0.7  RSS and DUL and RBL
27541 .endd
27542 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
27543 different values. Some DNS lists may return more than one address record;
27544 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
27545
27546
27547 .section "Variables set from DNS lists" "SECID204"
27548 .cindex "expansion" "variables, set from DNS list"
27549 .cindex "DNS list" "variables set from"
27550 .vindex "&$dnslist_domain$&"
27551 .vindex "&$dnslist_matched$&"
27552 .vindex "&$dnslist_text$&"
27553 .vindex "&$dnslist_value$&"
27554 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
27555 the name of the overall domain that matched (for example,
27556 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
27557 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
27558 the DNS record. When the key is an IP address, it is not reversed in
27559 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
27560 cases, for example:
27561 .code
27562 deny dnslists = spamhaus.example
27563 .endd
27564 the key is also available in another variable (in this case,
27565 &$sender_host_address$&). In more complicated cases, however, this is not true.
27566 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
27567 might generate a dnslists lookup like this:
27568 .code
27569 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
27570 .endd
27571 If this condition succeeds, the value in &$dnslist_matched$& might be
27572 &`192.168.6.7`& (for example).
27573
27574 If more than one address record is returned by the DNS lookup, all the IP
27575 addresses are included in &$dnslist_value$&, separated by commas and spaces.
27576 The variable &$dnslist_text$& contains the contents of any associated TXT
27577 record. For lists such as RBL+ the TXT record for a merged entry is often not
27578 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
27579 information.
27580
27581 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
27582 &-- although these appear before the condition in the ACL, they are not
27583 expanded until after it has failed. For example:
27584 .code
27585 deny    hosts = !+local_networks
27586         message = $sender_host_address is listed \
27587                   at $dnslist_domain
27588         dnslists = rbl-plus.mail-abuse.example
27589 .endd
27590
27591
27592
27593 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
27594 .cindex "DNS list" "matching specific returned data"
27595 You can add an equals sign and an IP address after a &%dnslists%& domain name
27596 in order to restrict its action to DNS records with a matching right hand side.
27597 For example,
27598 .code
27599 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
27600 .endd
27601 rejects only those hosts that yield 127.0.0.2. Without this additional data,
27602 any address record is considered to be a match. For the moment, we assume
27603 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
27604 describes how multiple records are handled.
27605
27606 More than one IP address may be given for checking, using a comma as a
27607 separator. These are alternatives &-- if any one of them matches, the
27608 &%dnslists%& condition is true. For example:
27609 .code
27610 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27611 .endd
27612 If you want to specify a constraining address list and also specify names or IP
27613 addresses to be looked up, the constraining address list must be specified
27614 first. For example:
27615 .code
27616 deny dnslists = dsn.rfc-ignorant.org\
27617                 =127.0.0.2/$sender_address_domain
27618 .endd
27619
27620 If the character &`&&`& is used instead of &`=`&, the comparison for each
27621 listed IP address is done by a bitwise &"and"& instead of by an equality test.
27622 In other words, the listed addresses are used as bit masks. The comparison is
27623 true if all the bits in the mask are present in the address that is being
27624 tested. For example:
27625 .code
27626 dnslists = a.b.c&0.0.0.3
27627 .endd
27628 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
27629 want to test whether one bit or another bit is present (as opposed to both
27630 being present), you must use multiple values. For example:
27631 .code
27632 dnslists = a.b.c&0.0.0.1,0.0.0.2
27633 .endd
27634 matches if the final component of the address is an odd number or two times
27635 an odd number.
27636
27637
27638
27639 .section "Negated DNS matching conditions" "SECID205"
27640 You can supply a negative list of IP addresses as part of a &%dnslists%&
27641 condition. Whereas
27642 .code
27643 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27644 .endd
27645 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27646 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
27647 .code
27648 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
27649 .endd
27650 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27651 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
27652 words, the result of the test is inverted if an exclamation mark appears before
27653 the &`=`& (or the &`&&`&) sign.
27654
27655 &*Note*&: This kind of negation is not the same as negation in a domain,
27656 host, or address list (which is why the syntax is different).
27657
27658 If you are using just one list, the negation syntax does not gain you much. The
27659 previous example is precisely equivalent to
27660 .code
27661 deny  dnslists = a.b.c
27662      !dnslists = a.b.c=127.0.0.2,127.0.0.3
27663 .endd
27664 However, if you are using multiple lists, the negation syntax is clearer.
27665 Consider this example:
27666 .code
27667 deny  dnslists = sbl.spamhaus.org : \
27668                  list.dsbl.org : \
27669                  dnsbl.njabl.org!=127.0.0.3 : \
27670                  relays.ordb.org
27671 .endd
27672 Using only positive lists, this would have to be:
27673 .code
27674 deny  dnslists = sbl.spamhaus.org : \
27675                  list.dsbl.org
27676 deny  dnslists = dnsbl.njabl.org
27677      !dnslists = dnsbl.njabl.org=127.0.0.3
27678 deny  dnslists = relays.ordb.org
27679 .endd
27680 which is less clear, and harder to maintain.
27681
27682
27683
27684
27685 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
27686 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
27687 thereby providing more than one IP address. When an item in a &%dnslists%& list
27688 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
27689 the match to specific results from the DNS lookup, there are two ways in which
27690 the checking can be handled. For example, consider the condition:
27691 .code
27692 dnslists = a.b.c=127.0.0.1
27693 .endd
27694 What happens if the DNS lookup for the incoming IP address yields both
27695 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
27696 condition true because at least one given value was found, or is it false
27697 because at least one of the found values was not listed? And how does this
27698 affect negated conditions? Both possibilities are provided for with the help of
27699 additional separators &`==`& and &`=&&`&.
27700
27701 .ilist
27702 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
27703 IP addresses matches one of the listed addresses. For the example above, the
27704 condition is true because 127.0.0.1 matches.
27705 .next
27706 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
27707 looked up IP addresses matches one of the listed addresses. If the condition is
27708 changed to:
27709 .code
27710 dnslists = a.b.c==127.0.0.1
27711 .endd
27712 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27713 false because 127.0.0.2 is not listed. You would need to have:
27714 .code
27715 dnslists = a.b.c==127.0.0.1,127.0.0.2
27716 .endd
27717 for the condition to be true.
27718 .endlist
27719
27720 When &`!`& is used to negate IP address matching, it inverts the result, giving
27721 the precise opposite of the behaviour above. Thus:
27722 .ilist
27723 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
27724 addresses matches one of the listed addresses. Consider:
27725 .code
27726 dnslists = a.b.c!&0.0.0.1
27727 .endd
27728 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27729 false because 127.0.0.1 matches.
27730 .next
27731 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
27732 looked up IP address that does not match. Consider:
27733 .code
27734 dnslists = a.b.c!=&0.0.0.1
27735 .endd
27736 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27737 true, because 127.0.0.2 does not match. You would need to have:
27738 .code
27739 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
27740 .endd
27741 for the condition to be false.
27742 .endlist
27743 When the DNS lookup yields only a single IP address, there is no difference
27744 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
27745
27746
27747
27748
27749 .section "Detailed information from merged DNS lists" "SECTmordetinf"
27750 .cindex "DNS list" "information from merged"
27751 When the facility for restricting the matching IP values in a DNS list is used,
27752 the text from the TXT record that is set in &$dnslist_text$& may not reflect
27753 the true reason for rejection. This happens when lists are merged and the IP
27754 address in the A record is used to distinguish them; unfortunately there is
27755 only one TXT record. One way round this is not to use merged lists, but that
27756 can be inefficient because it requires multiple DNS lookups where one would do
27757 in the vast majority of cases when the host of interest is not on any of the
27758 lists.
27759
27760 A less inefficient way of solving this problem is available. If
27761 two domain names, comma-separated, are given, the second is used first to
27762 do an initial check, making use of any IP value restrictions that are set.
27763 If there is a match, the first domain is used, without any IP value
27764 restrictions, to get the TXT record. As a byproduct of this, there is also
27765 a check that the IP being tested is indeed on the first list. The first
27766 domain is the one that is put in &$dnslist_domain$&. For example:
27767 .code
27768 reject message  = \
27769          rejected because $sender_host_address is blacklisted \
27770          at $dnslist_domain\n$dnslist_text
27771        dnslists = \
27772          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
27773          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27774 .endd
27775 For the first blacklist item, this starts by doing a lookup in
27776 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
27777 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
27778 value, and as long as something is found, it looks for the corresponding TXT
27779 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
27780 The second blacklist item is processed similarly.
27781
27782 If you are interested in more than one merged list, the same list must be
27783 given several times, but because the results of the DNS lookups are cached,
27784 the DNS calls themselves are not repeated. For example:
27785 .code
27786 reject dnslists = \
27787          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27788          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27789          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27790          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27791 .endd
27792 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27793 values matches (or if no record is found), this is the only lookup that is
27794 done. Only if there is a match is one of the more specific lists consulted.
27795
27796
27797
27798 .section "DNS lists and IPv6" "SECTmorednslistslast"
27799 .cindex "IPv6" "DNS black lists"
27800 .cindex "DNS list" "IPv6 usage"
27801 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27802 nibble by nibble. For example, if the calling host's IP address is
27803 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27804 .code
27805 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27806   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27807 .endd
27808 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27809 lists contain wildcard records, intended for IPv4, that interact badly with
27810 IPv6. For example, the DNS entry
27811 .code
27812 *.3.some.list.example.    A    127.0.0.1
27813 .endd
27814 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27815 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27816
27817 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27818 &%condition%& condition, as in this example:
27819 .code
27820 deny   condition = ${if isip4{$sender_host_address}}
27821        dnslists  = some.list.example
27822 .endd
27823
27824 .section "Rate limiting incoming messages" "SECTratelimiting"
27825 .cindex "rate limiting" "client sending"
27826 .cindex "limiting client sending rates"
27827 .oindex "&%smtp_ratelimit_*%&"
27828 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27829 which clients can send email. This is more powerful than the
27830 &%smtp_ratelimit_*%& options, because those options control the rate of
27831 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27832 works across all connections (concurrent and sequential) from the same client
27833 host. The syntax of the &%ratelimit%& condition is:
27834 .display
27835 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27836 .endd
27837 If the average client sending rate is less than &'m'& messages per time
27838 period &'p'& then the condition is false; otherwise it is true.
27839
27840 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27841 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27842 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27843 of &'p'&.
27844
27845 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27846 time interval, for example, &`8h`& for eight hours. A larger time constant
27847 means that it takes Exim longer to forget a client's past behaviour. The
27848 parameter &'m'& is the maximum number of messages that a client is permitted to
27849 send in each time interval. It also specifies the number of messages permitted
27850 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27851 constant, you can allow a client to send more messages in a burst without
27852 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27853 both small, messages must be sent at an even rate.
27854
27855 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27856 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27857 when deploying the &%ratelimit%& ACL condition. The script prints usage
27858 instructions when it is run with no arguments.
27859
27860 The key is used to look up the data for calculating the client's average
27861 sending rate. This data is stored in Exim's spool directory, alongside the
27862 retry and other hints databases. The default key is &$sender_host_address$&,
27863 which means Exim computes the sending rate of each client host IP address.
27864 By changing the key you can change how Exim identifies clients for the purpose
27865 of ratelimiting. For example, to limit the sending rate of each authenticated
27866 user, independent of the computer they are sending from, set the key to
27867 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27868 example, &$authenticated_id$& is only meaningful if the client has
27869 authenticated (which you can check with the &%authenticated%& ACL condition).
27870
27871 The lookup key does not have to identify clients: If you want to limit the
27872 rate at which a recipient receives messages, you can use the key
27873 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27874 ACL.
27875
27876 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
27877 specifies what Exim measures the rate of, for example messages or recipients
27878 or bytes. You can adjust the measurement using the &%unique=%& and/or
27879 &%count=%& options. You can also control when Exim updates the recorded rate
27880 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
27881 separated by a slash, like the other parameters. They may appear in any order.
27882
27883 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
27884 any options that alter the meaning of the stored data. The limit &'m'& is not
27885 stored, so you can alter the configured maximum rate and Exim will still
27886 remember clients' past behaviour. If you change the &%per_*%& mode or add or
27887 remove the &%unique=%& option, the lookup key changes so Exim will forget past
27888 behaviour. The lookup key is not affected by changes to the update mode and
27889 the &%count=%& option.
27890
27891
27892 .section "Ratelimit options for what is being measured" "ratoptmea"
27893 .cindex "rate limiting" "per_* options"
27894 The &%per_conn%& option limits the client's connection rate. It is not
27895 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
27896 &%acl_not_smtp_start%& ACLs.
27897
27898 The &%per_mail%& option limits the client's rate of sending messages. This is
27899 the default if none of the &%per_*%& options is specified. It can be used in
27900 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
27901 &%acl_smtp_data%&, or &%acl_not_smtp%&.
27902
27903 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
27904 the same ACLs as the &%per_mail%& option, though it is best to use this option
27905 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
27906 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
27907 in its MAIL command, which may be inaccurate or completely missing. You can
27908 follow the limit &'m'& in the configuration with K, M, or G to specify limits
27909 in kilobytes, megabytes, or gigabytes, respectively.
27910
27911 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
27912 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27913 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
27914 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
27915 ACLs the rate is updated with the total recipient count in one go. Note that
27916 in either case the rate limiting engine will see a message with many
27917 recipients as a large high-speed burst.
27918
27919 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
27920 number of different recipients that the client has sent messages to in the
27921 last time period. That is, if the client repeatedly sends messages to the same
27922 recipient, its measured rate is not increased. This option can only be used in
27923 &%acl_smtp_rcpt%&.
27924
27925 The &%per_cmd%& option causes Exim to recompute the rate every time the
27926 condition is processed. This can be used to limit the rate of any SMTP
27927 command. If it is used in multiple ACLs it can limit the aggregate rate of
27928 multiple different commands.
27929
27930 The &%count=%& option can be used to alter how much Exim adds to the client's
27931 measured rate. For example, the &%per_byte%& option is equivalent to
27932 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
27933 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
27934 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
27935
27936 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
27937
27938
27939 .section "Ratelimit update modes" "ratoptupd"
27940 .cindex "rate limiting" "reading data without updating"
27941 You can specify one of three options with the &%ratelimit%& condition to
27942 control when its database is updated. This section describes the &%readonly%&
27943 mode, and the next section describes the &%strict%& and &%leaky%& modes.
27944
27945 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
27946 previously-computed rate to check against the limit.
27947
27948 For example, you can test the client's sending rate and deny it access (when
27949 it is too fast) in the connect ACL. If the client passes this check then it
27950 can go on to send a message, in which case its recorded rate will be updated
27951 in the MAIL ACL. Subsequent connections from the same client will check this
27952 new rate.
27953 .code
27954 acl_check_connect:
27955  deny ratelimit = 100 / 5m / readonly
27956     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
27957                   (max $sender_rate_limit)
27958 # ...
27959 acl_check_mail:
27960  warn ratelimit = 100 / 5m / strict
27961     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
27962                   (max $sender_rate_limit)
27963 .endd
27964
27965 If Exim encounters multiple &%ratelimit%& conditions with the same key when
27966 processing a message then it may increase the client's measured rate more than
27967 it should. For example, this will happen if you check the &%per_rcpt%& option
27968 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
27969 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
27970 multiple update problems by using the &%readonly%& option on later ratelimit
27971 checks.
27972
27973 The &%per_*%& options described above do not make sense in some ACLs. If you
27974 use a &%per_*%& option in an ACL where it is not normally permitted then the
27975 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
27976 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
27977 next section) so you must specify the &%readonly%& option explicitly.
27978
27979
27980 .section "Ratelimit options for handling fast clients" "ratoptfast"
27981 .cindex "rate limiting" "strict and leaky modes"
27982 If a client's average rate is greater than the maximum, the rate limiting
27983 engine can react in two possible ways, depending on the presence of the
27984 &%strict%& or &%leaky%& update modes. This is independent of the other
27985 counter-measures (such as rejecting the message) that may be specified by the
27986 rest of the ACL.
27987
27988 The &%leaky%& (default) option means that the client's recorded rate is not
27989 updated if it is above the limit. The effect of this is that Exim measures the
27990 client's average rate of successfully sent email, which cannot be greater than
27991 the maximum allowed. If the client is over the limit it may suffer some
27992 counter-measures (as specified in the ACL), but it will still be able to send
27993 email at the configured maximum rate, whatever the rate of its attempts. This
27994 is generally the better choice if you have clients that retry automatically.
27995 For example, it does not prevent a sender with an over-aggressive retry rate
27996 from getting any email through.
27997
27998 The &%strict%& option means that the client's recorded rate is always
27999 updated. The effect of this is that Exim measures the client's average rate
28000 of attempts to send email, which can be much higher than the maximum it is
28001 actually allowed. If the client is over the limit it may be subjected to
28002 counter-measures by the ACL. It must slow down and allow sufficient time to
28003 pass that its computed rate falls below the maximum before it can send email
28004 again. The time (the number of smoothing periods) it must wait and not
28005 attempt to send mail can be calculated with this formula:
28006 .code
28007         ln(peakrate/maxrate)
28008 .endd
28009
28010
28011 .section "Limiting the rate of different events" "ratoptuniq"
28012 .cindex "rate limiting" "counting unique events"
28013 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28014 rate of different events. For example, the &%per_addr%& option uses this
28015 mechanism to count the number of different recipients that the client has
28016 sent messages to in the last time period; it is equivalent to
28017 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28018 measure the rate that a client uses different sender addresses with the
28019 options &`per_mail/unique=$sender_address`&.
28020
28021 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28022 has seen for that key. The whole set is thrown away when it is older than the
28023 rate smoothing period &'p'&, so each different event is counted at most once
28024 per period. In the &%leaky%& update mode, an event that causes the client to
28025 go over the limit is not added to the set, in the same way that the client's
28026 recorded rate is not updated in the same situation.
28027
28028 When you combine the &%unique=%& and &%readonly%& options, the specific
28029 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28030 rate.
28031
28032 The &%unique=%& mechanism needs more space in the ratelimit database than the
28033 other &%ratelimit%& options in order to store the event set. The number of
28034 unique values is potentially as large as the rate limit, so the extra space
28035 required increases with larger limits.
28036
28037 The uniqueification is not perfect: there is a small probability that Exim
28038 will think a new event has happened before. If the sender's rate is less than
28039 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28040 the measured rate can go above the limit, in which case Exim may under-count
28041 events by a significant margin. Fortunately, if the rate is high enough (2.7
28042 times the limit) that the false positive rate goes above 9%, then Exim will
28043 throw away the over-full event set before the measured rate falls below the
28044 limit. Therefore the only harm should be that exceptionally high sending rates
28045 are logged incorrectly; any countermeasures you configure will be as effective
28046 as intended.
28047
28048
28049 .section "Using rate limiting" "useratlim"
28050 Exim's other ACL facilities are used to define what counter-measures are taken
28051 when the rate limit is exceeded. This might be anything from logging a warning
28052 (for example, while measuring existing sending rates in order to define
28053 policy), through time delays to slow down fast senders, up to rejecting the
28054 message. For example:
28055 .code
28056 # Log all senders' rates
28057 warn ratelimit = 0 / 1h / strict
28058      log_message = Sender rate $sender_rate / $sender_rate_period
28059
28060 # Slow down fast senders; note the need to truncate $sender_rate
28061 # at the decimal point.
28062 warn ratelimit = 100 / 1h / per_rcpt / strict
28063      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28064                    $sender_rate_limit }s
28065
28066 # Keep authenticated users under control
28067 deny authenticated = *
28068      ratelimit = 100 / 1d / strict / $authenticated_id
28069
28070 # System-wide rate limit
28071 defer message = Sorry, too busy. Try again later.
28072      ratelimit = 10 / 1s / $primary_hostname
28073
28074 # Restrict incoming rate from each host, with a default
28075 # set using a macro and special cases looked up in a table.
28076 defer message = Sender rate exceeds $sender_rate_limit \
28077                messages per $sender_rate_period
28078      ratelimit = ${lookup {$sender_host_address} \
28079                    cdb {DB/ratelimits.cdb} \
28080                    {$value} {RATELIMIT} }
28081 .endd
28082 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28083 especially with the &%per_rcpt%& option, you may suffer from a performance
28084 bottleneck caused by locking on the ratelimit hints database. Apart from
28085 making your ACLs less complicated, you can reduce the problem by using a
28086 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28087 this means that Exim will lose its hints data after a reboot (including retry
28088 hints, the callout cache, and ratelimit data).
28089
28090
28091
28092 .section "Address verification" "SECTaddressverification"
28093 .cindex "verifying address" "options for"
28094 .cindex "policy control" "address verification"
28095 Several of the &%verify%& conditions described in section
28096 &<<SECTaclconditions>>& cause addresses to be verified. Section
28097 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28098 The verification conditions can be followed by options that modify the
28099 verification process. The options are separated from the keyword and from each
28100 other by slashes, and some of them contain parameters. For example:
28101 .code
28102 verify = sender/callout
28103 verify = recipient/defer_ok/callout=10s,defer_ok
28104 .endd
28105 The first stage of address verification, which always happens, is to run the
28106 address through the routers, in &"verify mode"&. Routers can detect the
28107 difference between verification and routing for delivery, and their actions can
28108 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28109 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28110 The available options are as follows:
28111
28112 .ilist
28113 If the &%callout%& option is specified, successful routing to one or more
28114 remote hosts is followed by a &"callout"& to those hosts as an additional
28115 check. Callouts and their sub-options are discussed in the next section.
28116 .next
28117 If there is a defer error while doing verification routing, the ACL
28118 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28119 options, the condition is forced to be true instead. Note that this is a main
28120 verification option as well as a suboption for callouts.
28121 .next
28122 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28123 discusses the reporting of sender address verification failures.
28124 .next
28125 The &%success_on_redirect%& option causes verification always to succeed
28126 immediately after a successful redirection. By default, if a redirection
28127 generates just one address, that address is also verified. See further
28128 discussion in section &<<SECTredirwhilveri>>&.
28129 .endlist
28130
28131 .cindex "verifying address" "differentiating failures"
28132 .vindex "&$recipient_verify_failure$&"
28133 .vindex "&$sender_verify_failure$&"
28134 .vindex "&$acl_verify_message$&"
28135 After an address verification failure, &$acl_verify_message$& contains the
28136 error message that is associated with the failure. It can be preserved by
28137 coding like this:
28138 .code
28139 warn  !verify = sender
28140        set acl_m0 = $acl_verify_message
28141 .endd
28142 If you are writing your own custom rejection message or log message when
28143 denying access, you can use this variable to include information about the
28144 verification failure.
28145
28146 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28147 appropriate) contains one of the following words:
28148
28149 .ilist
28150 &%qualify%&: The address was unqualified (no domain), and the message
28151 was neither local nor came from an exempted host.
28152 .next
28153 &%route%&: Routing failed.
28154 .next
28155 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28156 occurred at or before the MAIL command (that is, on initial
28157 connection, HELO, or MAIL).
28158 .next
28159 &%recipient%&: The RCPT command in a callout was rejected.
28160 .next
28161 &%postmaster%&: The postmaster check in a callout was rejected.
28162 .endlist
28163
28164 The main use of these variables is expected to be to distinguish between
28165 rejections of MAIL and rejections of RCPT in callouts.
28166
28167
28168
28169
28170 .section "Callout verification" "SECTcallver"
28171 .cindex "verifying address" "by callout"
28172 .cindex "callout" "verification"
28173 .cindex "SMTP" "callout verification"
28174 For non-local addresses, routing verifies the domain, but is unable to do any
28175 checking of the local part. There are situations where some means of verifying
28176 the local part is desirable. One way this can be done is to make an SMTP
28177 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28178 a subsequent host for a recipient address, to see if the host accepts the
28179 address. We use the term &'callout'& to cover both cases. Note that for a
28180 sender address, the callback is not to the client host that is trying to
28181 deliver the message, but to one of the hosts that accepts incoming mail for the
28182 sender's domain.
28183
28184 Exim does not do callouts by default. If you want them to happen, you must
28185 request them by setting appropriate options on the &%verify%& condition, as
28186 described below. This facility should be used with care, because it can add a
28187 lot of resource usage to the cost of verifying an address. However, Exim does
28188 cache the results of callouts, which helps to reduce the cost. Details of
28189 caching are in section &<<SECTcallvercache>>&.
28190
28191 Recipient callouts are usually used only between hosts that are controlled by
28192 the same administration. For example, a corporate gateway host could use
28193 callouts to check for valid recipients on an internal mailserver. A successful
28194 callout does not guarantee that a real delivery to the address would succeed;
28195 on the other hand, a failing callout does guarantee that a delivery would fail.
28196
28197 If the &%callout%& option is present on a condition that verifies an address, a
28198 second stage of verification occurs if the address is successfully routed to
28199 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28200 &(manualroute)& router, where the router specifies the hosts. However, if a
28201 router that does not set up hosts routes to an &(smtp)& transport with a
28202 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28203 &%hosts_override%& set, its hosts are always used, whether or not the router
28204 supplies a host list.
28205
28206 The port that is used is taken from the transport, if it is specified and is a
28207 remote transport. (For routers that do verification only, no transport need be
28208 specified.) Otherwise, the default SMTP port is used. If a remote transport
28209 specifies an outgoing interface, this is used; otherwise the interface is not
28210 specified. Likewise, the text that is used for the HELO command is taken from
28211 the transport's &%helo_data%& option; if there is no transport, the value of
28212 &$smtp_active_hostname$& is used.
28213
28214 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28215 test whether a bounce message could be delivered to the sender address. The
28216 following SMTP commands are sent:
28217 .display
28218 &`HELO `&<&'local host name'&>
28219 &`MAIL FROM:<>`&
28220 &`RCPT TO:`&<&'the address to be tested'&>
28221 &`QUIT`&
28222 .endd
28223 LHLO is used instead of HELO if the transport's &%protocol%& option is
28224 set to &"lmtp"&.
28225
28226 A recipient callout check is similar. By default, it also uses an empty address
28227 for the sender. This default is chosen because most hosts do not make use of
28228 the sender address when verifying a recipient. Using the same address means
28229 that a single cache entry can be used for each recipient. Some sites, however,
28230 do make use of the sender address when verifying. These are catered for by the
28231 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28232
28233 If the response to the RCPT command is a 2&'xx'& code, the verification
28234 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28235 Exim tries the next host, if any. If there is a problem with all the remote
28236 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28237 &%callout%& option is given, in which case the condition is forced to succeed.
28238
28239 .cindex "SMTP" "output flushing, disabling for callout"
28240 A callout may take a little time. For this reason, Exim normally flushes SMTP
28241 output before performing a callout in an ACL, to avoid unexpected timeouts in
28242 clients when the SMTP PIPELINING extension is in use. The flushing can be
28243 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28244
28245
28246
28247
28248 .section "Additional parameters for callouts" "CALLaddparcall"
28249 .cindex "callout" "additional parameters for"
28250 The &%callout%& option can be followed by an equals sign and a number of
28251 optional parameters, separated by commas. For example:
28252 .code
28253 verify = recipient/callout=10s,defer_ok
28254 .endd
28255 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28256 separate verify options, is retained for backwards compatibility, but is now
28257 deprecated. The additional parameters for &%callout%& are as follows:
28258
28259
28260 .vlist
28261 .vitem <&'a&~time&~interval'&>
28262 .cindex "callout" "timeout, specifying"
28263 This specifies the timeout that applies for the callout attempt to each host.
28264 For example:
28265 .code
28266 verify = sender/callout=5s
28267 .endd
28268 The default is 30 seconds. The timeout is used for each response from the
28269 remote host. It is also used for the initial connection, unless overridden by
28270 the &%connect%& parameter.
28271
28272
28273 .vitem &*connect&~=&~*&<&'time&~interval'&>
28274 .cindex "callout" "connection timeout, specifying"
28275 This parameter makes it possible to set a different (usually smaller) timeout
28276 for making the SMTP connection. For example:
28277 .code
28278 verify = sender/callout=5s,connect=1s
28279 .endd
28280 If not specified, this timeout defaults to the general timeout value.
28281
28282 .vitem &*defer_ok*&
28283 .cindex "callout" "defer, action on"
28284 When this parameter is present, failure to contact any host, or any other kind
28285 of temporary error, is treated as success by the ACL. However, the cache is not
28286 updated in this circumstance.
28287
28288 .vitem &*fullpostmaster*&
28289 .cindex "callout" "full postmaster check"
28290 This operates like the &%postmaster%& option (see below), but if the check for
28291 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28292 accordance with the specification in RFC 2821. The RFC states that the
28293 unqualified address &'postmaster'& should be accepted.
28294
28295
28296 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28297 .cindex "callout" "sender when verifying header"
28298 When verifying addresses in header lines using the &%header_sender%&
28299 verification option, Exim behaves by default as if the addresses are envelope
28300 sender addresses from a message. Callout verification therefore tests to see
28301 whether a bounce message could be delivered, by using an empty address in the
28302 MAIL command. However, it is arguable that these addresses might never be used
28303 as envelope senders, and could therefore justifiably reject bounce messages
28304 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28305 address to use in the MAIL command. For example:
28306 .code
28307 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28308 .endd
28309 This parameter is available only for the &%header_sender%& verification option.
28310
28311
28312 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28313 .cindex "callout" "overall timeout, specifying"
28314 This parameter sets an overall timeout for performing a callout verification.
28315 For example:
28316 .code
28317 verify = sender/callout=5s,maxwait=30s
28318 .endd
28319 This timeout defaults to four times the callout timeout for individual SMTP
28320 commands. The overall timeout applies when there is more than one host that can
28321 be tried. The timeout is checked before trying the next host. This prevents
28322 very long delays if there are a large number of hosts and all are timing out
28323 (for example, when network connections are timing out).
28324
28325
28326 .vitem &*no_cache*&
28327 .cindex "callout" "cache, suppressing"
28328 .cindex "caching callout, suppressing"
28329 When this parameter is given, the callout cache is neither read nor updated.
28330
28331 .vitem &*postmaster*&
28332 .cindex "callout" "postmaster; checking"
28333 When this parameter is set, a successful callout check is followed by a similar
28334 check for the local part &'postmaster'& at the same domain. If this address is
28335 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28336 the postmaster check is recorded in a cache record; if it is a failure, this is
28337 used to fail subsequent callouts for the domain without a connection being
28338 made, until the cache record expires.
28339
28340 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
28341 The postmaster check uses an empty sender in the MAIL command by default.
28342 You can use this parameter to do a postmaster check using a different address.
28343 For example:
28344 .code
28345 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
28346 .endd
28347 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
28348 one overrides. The &%postmaster%& parameter is equivalent to this example:
28349 .code
28350 require  verify = sender/callout=postmaster_mailfrom=
28351 .endd
28352 &*Warning*&: The caching arrangements for postmaster checking do not take
28353 account of the sender address. It is assumed that either the empty address or
28354 a fixed non-empty address will be used. All that Exim remembers is that the
28355 postmaster check for the domain succeeded or failed.
28356
28357
28358 .vitem &*random*&
28359 .cindex "callout" "&""random""& check"
28360 When this parameter is set, before doing the normal callout check, Exim does a
28361 check for a &"random"& local part at the same domain. The local part is not
28362 really random &-- it is defined by the expansion of the option
28363 &%callout_random_local_part%&, which defaults to
28364 .code
28365 $primary_hostname-$tod_epoch-testing
28366 .endd
28367 The idea here is to try to determine whether the remote host accepts all local
28368 parts without checking. If it does, there is no point in doing callouts for
28369 specific local parts. If the &"random"& check succeeds, the result is saved in
28370 a cache record, and used to force the current and subsequent callout checks to
28371 succeed without a connection being made, until the cache record expires.
28372
28373 .vitem &*use_postmaster*&
28374 .cindex "callout" "sender for recipient check"
28375 This parameter applies to recipient callouts only. For example:
28376 .code
28377 deny  !verify = recipient/callout=use_postmaster
28378 .endd
28379 .vindex "&$qualify_domain$&"
28380 It causes a non-empty postmaster address to be used in the MAIL command when
28381 performing the callout for the recipient, and also for a &"random"& check if
28382 that is configured. The local part of the address is &`postmaster`& and the
28383 domain is the contents of &$qualify_domain$&.
28384
28385 .vitem &*use_sender*&
28386 This option applies to recipient callouts only. For example:
28387 .code
28388 require  verify = recipient/callout=use_sender
28389 .endd
28390 It causes the message's actual sender address to be used in the MAIL
28391 command when performing the callout, instead of an empty address. There is no
28392 need to use this option unless you know that the called hosts make use of the
28393 sender when checking recipients. If used indiscriminately, it reduces the
28394 usefulness of callout caching.
28395 .endlist
28396
28397 If you use any of the parameters that set a non-empty sender for the MAIL
28398 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
28399 &%use_sender%&), you should think about possible loops. Recipient checking is
28400 usually done between two hosts that are under the same management, and the host
28401 that receives the callouts is not normally configured to do callouts itself.
28402 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
28403 these circumstances.
28404
28405 However, if you use a non-empty sender address for a callout to an arbitrary
28406 host, there is the likelihood that the remote host will itself initiate a
28407 callout check back to your host. As it is checking what appears to be a message
28408 sender, it is likely to use an empty address in MAIL, thus avoiding a
28409 callout loop. However, to be on the safe side it would be best to set up your
28410 own ACLs so that they do not do sender verification checks when the recipient
28411 is the address you use for header sender or postmaster callout checking.
28412
28413 Another issue to think about when using non-empty senders for callouts is
28414 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
28415 by the sender/recipient combination; thus, for any given recipient, many more
28416 actual callouts are performed than when an empty sender or postmaster is used.
28417
28418
28419
28420
28421 .section "Callout caching" "SECTcallvercache"
28422 .cindex "hints database" "callout cache"
28423 .cindex "callout" "cache, description of"
28424 .cindex "caching" "callout"
28425 Exim caches the results of callouts in order to reduce the amount of resources
28426 used, unless you specify the &%no_cache%& parameter with the &%callout%&
28427 option. A hints database called &"callout"& is used for the cache. Two
28428 different record types are used: one records the result of a callout check for
28429 a specific address, and the other records information that applies to the
28430 entire domain (for example, that it accepts the local part &'postmaster'&).
28431
28432 When an original callout fails, a detailed SMTP error message is given about
28433 the failure. However, for subsequent failures use the cache data, this message
28434 is not available.
28435
28436 The expiry times for negative and positive address cache records are
28437 independent, and can be set by the global options &%callout_negative_expire%&
28438 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
28439
28440 If a host gives a negative response to an SMTP connection, or rejects any
28441 commands up to and including
28442 .code
28443 MAIL FROM:<>
28444 .endd
28445 (but not including the MAIL command with a non-empty address),
28446 any callout attempt is bound to fail. Exim remembers such failures in a
28447 domain cache record, which it uses to fail callouts for the domain without
28448 making new connections, until the domain record times out. There are two
28449 separate expiry times for domain cache records:
28450 &%callout_domain_negative_expire%& (default 3h) and
28451 &%callout_domain_positive_expire%& (default 7d).
28452
28453 Domain records expire when the negative expiry time is reached if callouts
28454 cannot be made for the domain, or if the postmaster check failed.
28455 Otherwise, they expire when the positive expiry time is reached. This
28456 ensures that, for example, a host that stops accepting &"random"& local parts
28457 will eventually be noticed.
28458
28459 The callout caching mechanism is based on the domain of the address that is
28460 being tested. If the domain routes to several hosts, it is assumed that their
28461 behaviour will be the same.
28462
28463
28464
28465 .section "Sender address verification reporting" "SECTsenaddver"
28466 .cindex "verifying" "suppressing error details"
28467 See section &<<SECTaddressverification>>& for a general discussion of
28468 verification. When sender verification fails in an ACL, the details of the
28469 failure are given as additional output lines before the 550 response to the
28470 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
28471 you might see:
28472 .code
28473 MAIL FROM:<xyz@abc.example>
28474 250 OK
28475 RCPT TO:<pqr@def.example>
28476 550-Verification failed for <xyz@abc.example>
28477 550-Called:   192.168.34.43
28478 550-Sent:     RCPT TO:<xyz@abc.example>
28479 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
28480 550 Sender verification failed
28481 .endd
28482 If more than one RCPT command fails in the same way, the details are given
28483 only for the first of them. However, some administrators do not want to send
28484 out this much information. You can suppress the details by adding
28485 &`/no_details`& to the ACL statement that requests sender verification. For
28486 example:
28487 .code
28488 verify = sender/no_details
28489 .endd
28490
28491 .section "Redirection while verifying" "SECTredirwhilveri"
28492 .cindex "verifying" "redirection while"
28493 .cindex "address redirection" "while verifying"
28494 A dilemma arises when a local address is redirected by aliasing or forwarding
28495 during verification: should the generated addresses themselves be verified,
28496 or should the successful expansion of the original address be enough to verify
28497 it? By default, Exim takes the following pragmatic approach:
28498
28499 .ilist
28500 When an incoming address is redirected to just one child address, verification
28501 continues with the child address, and if that fails to verify, the original
28502 verification also fails.
28503 .next
28504 When an incoming address is redirected to more than one child address,
28505 verification does not continue. A success result is returned.
28506 .endlist
28507
28508 This seems the most reasonable behaviour for the common use of aliasing as a
28509 way of redirecting different local parts to the same mailbox. It means, for
28510 example, that a pair of alias entries of the form
28511 .code
28512 A.Wol:   aw123
28513 aw123:   :fail: Gone away, no forwarding address
28514 .endd
28515 work as expected, with both local parts causing verification failure. When a
28516 redirection generates more than one address, the behaviour is more like a
28517 mailing list, where the existence of the alias itself is sufficient for
28518 verification to succeed.
28519
28520 It is possible, however, to change the default behaviour so that all successful
28521 redirections count as successful verifications, however many new addresses are
28522 generated. This is specified by the &%success_on_redirect%& verification
28523 option. For example:
28524 .code
28525 require verify = recipient/success_on_redirect/callout=10s
28526 .endd
28527 In this example, verification succeeds if a router generates a new address, and
28528 the callout does not occur, because no address was routed to a remote host.
28529
28530 When verification is being tested via the &%-bv%& option, the treatment of
28531 redirections is as just described, unless the &%-v%& or any debugging option is
28532 also specified. In that case, full verification is done for every generated
28533 address and a report is output for each of them.
28534
28535
28536
28537 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
28538 .cindex "CSA" "verifying"
28539 Client SMTP Authorization is a system that allows a site to advertise
28540 which machines are and are not permitted to send email. This is done by placing
28541 special SRV records in the DNS; these are looked up using the client's HELO
28542 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
28543 Authorization checks in Exim are performed by the ACL condition:
28544 .code
28545 verify = csa
28546 .endd
28547 This fails if the client is not authorized. If there is a DNS problem, or if no
28548 valid CSA SRV record is found, or if the client is authorized, the condition
28549 succeeds. These three cases can be distinguished using the expansion variable
28550 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
28551 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
28552 be likely to cause problems for legitimate email.
28553
28554 The error messages produced by the CSA code include slightly more
28555 detail. If &$csa_status$& is &"defer"&, this may be because of problems
28556 looking up the CSA SRV record, or problems looking up the CSA target
28557 address record. There are four reasons for &$csa_status$& being &"fail"&:
28558
28559 .ilist
28560 The client's host name is explicitly not authorized.
28561 .next
28562 The client's IP address does not match any of the CSA target IP addresses.
28563 .next
28564 The client's host name is authorized but it has no valid target IP addresses
28565 (for example, the target's addresses are IPv6 and the client is using IPv4).
28566 .next
28567 The client's host name has no CSA SRV record but a parent domain has asserted
28568 that all subdomains must be explicitly authorized.
28569 .endlist
28570
28571 The &%csa%& verification condition can take an argument which is the domain to
28572 use for the DNS query. The default is:
28573 .code
28574 verify = csa/$sender_helo_name
28575 .endd
28576 This implementation includes an extension to CSA. If the query domain
28577 is an address literal such as [192.0.2.95], or if it is a bare IP
28578 address, Exim searches for CSA SRV records in the reverse DNS as if
28579 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
28580 meaningful to say:
28581 .code
28582 verify = csa/$sender_host_address
28583 .endd
28584 In fact, this is the check that Exim performs if the client does not say HELO.
28585 This extension can be turned off by setting the main configuration option
28586 &%dns_csa_use_reverse%& to be false.
28587
28588 If a CSA SRV record is not found for the domain itself, a search
28589 is performed through its parent domains for a record which might be
28590 making assertions about subdomains. The maximum depth of this search is limited
28591 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
28592 default. Exim does not look for CSA SRV records in a top level domain, so the
28593 default settings handle HELO domains as long as seven
28594 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
28595 of legitimate HELO domains.
28596
28597 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
28598 direct SRV lookups, this is not sufficient because of the extra parent domain
28599 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
28600 addresses into lookups in the reverse DNS space. The result of a successful
28601 lookup such as:
28602 .code
28603 ${lookup dnsdb {csa=$sender_helo_name}}
28604 .endd
28605 has two space-separated fields: an authorization code and a target host name.
28606 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
28607 authorization required but absent, or &"?"& for unknown.
28608
28609
28610
28611
28612 .section "Bounce address tag validation" "SECTverifyPRVS"
28613 .cindex "BATV, verifying"
28614 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
28615 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
28616 Genuine incoming bounce messages should therefore always be addressed to
28617 recipients that have a valid tag. This scheme is a way of detecting unwanted
28618 bounce messages caused by sender address forgeries (often called &"collateral
28619 spam"&), because the recipients of such messages do not include valid tags.
28620
28621 There are two expansion items to help with the implementation of the BATV
28622 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
28623 the original envelope sender address by using a simple key to add a hash of the
28624 address and some time-based randomizing information. The &%prvs%& expansion
28625 item creates a signed address, and the &%prvscheck%& expansion item checks one.
28626 The syntax of these expansion items is described in section
28627 &<<SECTexpansionitems>>&.
28628
28629 As an example, suppose the secret per-address keys are stored in an MySQL
28630 database. A query to look up the key for an address could be defined as a macro
28631 like this:
28632 .code
28633 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
28634                 WHERE sender='${quote_mysql:$prvscheck_address}'\
28635                 }{$value}}
28636 .endd
28637 Suppose also that the senders who make use of BATV are defined by an address
28638 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
28639 use this:
28640 .code
28641 # Bounces: drop unsigned addresses for BATV senders
28642 deny message = This address does not send an unsigned reverse path
28643      senders = :
28644      recipients = +batv_senders
28645
28646 # Bounces: In case of prvs-signed address, check signature.
28647 deny message = Invalid reverse path signature.
28648      senders = :
28649      condition  = ${prvscheck {$local_part@$domain}\
28650                   {PRVSCHECK_SQL}{1}}
28651      !condition = $prvscheck_result
28652 .endd
28653 The first statement rejects recipients for bounce messages that are addressed
28654 to plain BATV sender addresses, because it is known that BATV senders do not
28655 send out messages with plain sender addresses. The second statement rejects
28656 recipients that are prvs-signed, but with invalid signatures (either because
28657 the key is wrong, or the signature has timed out).
28658
28659 A non-prvs-signed address is not rejected by the second statement, because the
28660 &%prvscheck%& expansion yields an empty string if its first argument is not a
28661 prvs-signed address, thus causing the &%condition%& condition to be false. If
28662 the first argument is a syntactically valid prvs-signed address, the yield is
28663 the third string (in this case &"1"&), whether or not the cryptographic and
28664 timeout checks succeed. The &$prvscheck_result$& variable contains the result
28665 of the checks (empty for failure, &"1"& for success).
28666
28667 There is one more issue you must consider when implementing prvs-signing:
28668 you have to ensure that the routers accept prvs-signed addresses and
28669 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
28670 router to remove the signature with a configuration along these lines:
28671 .code
28672 batv_redirect:
28673   driver = redirect
28674   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
28675 .endd
28676 This works because, if the third argument of &%prvscheck%& is empty, the result
28677 of the expansion of a prvs-signed address is the decoded value of the original
28678 address. This router should probably be the first of your routers that handles
28679 local addresses.
28680
28681 To create BATV-signed addresses in the first place, a transport of this form
28682 can be used:
28683 .code
28684 external_smtp_batv:
28685   driver = smtp
28686   return_path = ${prvs {$return_path} \
28687                        {${lookup mysql{SELECT \
28688                        secret FROM batv_prvs WHERE \
28689                        sender='${quote_mysql:$sender_address}'} \
28690                        {$value}fail}}}
28691 .endd
28692 If no key can be found for the existing return path, no signing takes place.
28693
28694
28695
28696 .section "Using an ACL to control relaying" "SECTrelaycontrol"
28697 .cindex "&ACL;" "relay control"
28698 .cindex "relaying" "control by ACL"
28699 .cindex "policy control" "relay control"
28700 An MTA is said to &'relay'& a message if it receives it from some host and
28701 delivers it directly to another host as a result of a remote address contained
28702 within it. Redirecting a local address via an alias or forward file and then
28703 passing the message on to another host is not relaying,
28704 .cindex "&""percent hack""&"
28705 but a redirection as a result of the &"percent hack"& is.
28706
28707 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
28708 A host which is acting as a gateway or an MX backup is concerned with incoming
28709 relaying from arbitrary hosts to a specific set of domains. On the other hand,
28710 a host which is acting as a smart host for a number of clients is concerned
28711 with outgoing relaying from those clients to the Internet at large. Often the
28712 same host is fulfilling both functions,
28713 . ///
28714 . as illustrated in the diagram below,
28715 . ///
28716 but in principle these two kinds of relaying are entirely independent. What is
28717 not wanted is the transmission of mail from arbitrary remote hosts through your
28718 system to arbitrary domains.
28719
28720
28721 You can implement relay control by means of suitable statements in the ACL that
28722 runs for each RCPT command. For convenience, it is often easiest to use
28723 Exim's named list facility to define the domains and hosts involved. For
28724 example, suppose you want to do the following:
28725
28726 .ilist
28727 Deliver a number of domains to mailboxes on the local host (or process them
28728 locally in some other way). Let's say these are &'my.dom1.example'& and
28729 &'my.dom2.example'&.
28730 .next
28731 Relay mail for a number of other domains for which you are the secondary MX.
28732 These might be &'friend1.example'& and &'friend2.example'&.
28733 .next
28734 Relay mail from the hosts on your local LAN, to whatever domains are involved.
28735 Suppose your LAN is 192.168.45.0/24.
28736 .endlist
28737
28738
28739 In the main part of the configuration, you put the following definitions:
28740 .code
28741 domainlist local_domains = my.dom1.example : my.dom2.example
28742 domainlist relay_domains = friend1.example : friend2.example
28743 hostlist   relay_hosts   = 192.168.45.0/24
28744 .endd
28745 Now you can use these definitions in the ACL that is run for every RCPT
28746 command:
28747 .code
28748 acl_check_rcpt:
28749   accept domains = +local_domains : +relay_domains
28750   accept hosts   = +relay_hosts
28751 .endd
28752 The first statement accepts any RCPT command that contains an address in
28753 the local or relay domains. For any other domain, control passes to the second
28754 statement, which accepts the command only if it comes from one of the relay
28755 hosts. In practice, you will probably want to make your ACL more sophisticated
28756 than this, for example, by including sender and recipient verification. The
28757 default configuration includes a more comprehensive example, which is described
28758 in chapter &<<CHAPdefconfil>>&.
28759
28760
28761
28762 .section "Checking a relay configuration" "SECTcheralcon"
28763 .cindex "relaying" "checking control of"
28764 You can check the relay characteristics of your configuration in the same way
28765 that you can test any ACL behaviour for an incoming SMTP connection, by using
28766 the &%-bh%& option to run a fake SMTP session with which you interact.
28767
28768 For specifically testing for unwanted relaying, the host
28769 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
28770 host from the host on which Exim is running, using the normal telnet port, you
28771 will see a normal telnet connection message and then quite a long delay. Be
28772 patient. The remote host is making an SMTP connection back to your host, and
28773 trying a number of common probes to test for open relay vulnerability. The
28774 results of the tests will eventually appear on your terminal.
28775 .ecindex IIDacl
28776
28777
28778
28779 . ////////////////////////////////////////////////////////////////////////////
28780 . ////////////////////////////////////////////////////////////////////////////
28781
28782 .chapter "Content scanning at ACL time" "CHAPexiscan"
28783 .scindex IIDcosca "content scanning" "at ACL time"
28784 The extension of Exim to include content scanning at ACL time, formerly known
28785 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
28786 was integrated into the main source for Exim release 4.50, and Tom continues to
28787 maintain it. Most of the wording of this chapter is taken from Tom's
28788 specification.
28789
28790 It is also possible to scan the content of messages at other times. The
28791 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
28792 scanning after all the ACLs have run. A transport filter can be used to scan
28793 messages at delivery time (see the &%transport_filter%& option, described in
28794 chapter &<<CHAPtransportgeneric>>&).
28795
28796 If you want to include the ACL-time content-scanning features when you compile
28797 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
28798 &_Local/Makefile_&. When you do that, the Exim binary is built with:
28799
28800 .ilist
28801 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
28802 for all MIME parts for SMTP and non-SMTP messages, respectively.
28803 .next
28804 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
28805 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
28806 run at the end of message reception (the &%acl_smtp_data%& ACL).
28807 .next
28808 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
28809 of messages, or parts of messages, for debugging purposes.
28810 .next
28811 Additional expansion variables that are set in the new ACL and by the new
28812 conditions.
28813 .next
28814 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
28815 .endlist
28816
28817 There is another content-scanning configuration option for &_Local/Makefile_&,
28818 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
28819 condition is compiled, in addition to all the other content-scanning features.
28820
28821 Content-scanning is continually evolving, and new features are still being
28822 added. While such features are still unstable and liable to incompatible
28823 changes, they are made available in Exim by setting options whose names begin
28824 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
28825 this manual. You can find out about them by reading the file called
28826 &_doc/experimental.txt_&.
28827
28828 All the content-scanning facilities work on a MBOX copy of the message that is
28829 temporarily created in a file called:
28830 .display
28831 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
28832 .endd
28833 The &_.eml_& extension is a friendly hint to virus scanners that they can
28834 expect an MBOX-like structure inside that file. The file is created when the
28835 first content scanning facility is called. Subsequent calls to content
28836 scanning conditions open the same file again. The directory is recursively
28837 removed when the &%acl_smtp_data%& ACL has finished running, unless
28838 .code
28839 control = no_mbox_unspool
28840 .endd
28841 has been encountered. When the MIME ACL decodes files, they are put into the
28842 same directory by default.
28843
28844
28845
28846 .section "Scanning for viruses" "SECTscanvirus"
28847 .cindex "virus scanning"
28848 .cindex "content scanning" "for viruses"
28849 .cindex "content scanning" "the &%malware%& condition"
28850 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
28851 It supports a &"generic"& interface to scanners called via the shell, and
28852 specialized interfaces for &"daemon"& type virus scanners, which are resident
28853 in memory and thus are much faster.
28854
28855
28856 .oindex "&%av_scanner%&"
28857 You can set the &%av_scanner%& option in first part of the Exim configuration
28858 file to specify which scanner to use, together with any additional options that
28859 are needed. The basic syntax is as follows:
28860 .display
28861 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28862 .endd
28863 If you do not set &%av_scanner%&, it defaults to
28864 .code
28865 av_scanner = sophie:/var/run/sophie
28866 .endd
28867 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28868 before use. The following scanner types are supported in this release:
28869
28870 .vlist
28871 .vitem &%aveserver%&
28872 .cindex "virus scanners" "Kaspersky"
28873 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28874 at &url(http://www.kaspersky.com). This scanner type takes one option,
28875 which is the path to the daemon's UNIX socket. The default is shown in this
28876 example:
28877 .code
28878 av_scanner = aveserver:/var/run/aveserver
28879 .endd
28880
28881
28882 .vitem &%clamd%&
28883 .cindex "virus scanners" "clamd"
28884 This daemon-type scanner is GPL and free. You can get it at
28885 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28886 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28887 in the MIME ACL. This no longer believed to be necessary. One option is
28888 required: either the path and name of a UNIX socket file, or a hostname or IP
28889 number, and a port, separated by space, as in the second of these examples:
28890 .code
28891 av_scanner = clamd:/opt/clamd/socket
28892 av_scanner = clamd:192.0.2.3 1234
28893 av_scanner = clamd:192.0.2.3 1234:local
28894 .endd
28895 If the value of av_scanner points to a UNIX socket file or contains the local
28896 keyword, then the ClamAV interface will pass a filename containing the data
28897 to be scanned, which will should normally result in less I/O happening and be
28898 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28899 Exim does not assume that there is a common filesystem with the remote host.
28900 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28901 you be running a version of ClamAV prior to 0.95.
28902 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28903 contributing the code for this scanner.
28904
28905 .vitem &%cmdline%&
28906 .cindex "virus scanners" "command line interface"
28907 This is the keyword for the generic command line scanner interface. It can be
28908 used to attach virus scanners that are invoked from the shell. This scanner
28909 type takes 3 mandatory options:
28910
28911 .olist
28912 The full path and name of the scanner binary, with all command line options,
28913 and a placeholder (&`%s`&) for the directory to scan.
28914
28915 .next
28916 A regular expression to match against the STDOUT and STDERR output of the
28917 virus scanner. If the expression matches, a virus was found. You must make
28918 absolutely sure that this expression matches on &"virus found"&. This is called
28919 the &"trigger"& expression.
28920
28921 .next
28922 Another regular expression, containing exactly one pair of parentheses, to
28923 match the name of the virus found in the scanners output. This is called the
28924 &"name"& expression.
28925 .endlist olist
28926
28927 For example, Sophos Sweep reports a virus on a line like this:
28928 .code
28929 Virus 'W32/Magistr-B' found in file ./those.bat
28930 .endd
28931 For the trigger expression, we can match the phrase &"found in file"&. For the
28932 name expression, we want to extract the W32/Magistr-B string, so we can match
28933 for the single quotes left and right of it. Altogether, this makes the
28934 configuration setting:
28935 .code
28936 av_scanner = cmdline:\
28937              /path/to/sweep -ss -all -rec -archive %s:\
28938              found in file:'(.+)'
28939 .endd
28940 .vitem &%drweb%&
28941 .cindex "virus scanners" "DrWeb"
28942 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28943 argument, either a full path to a UNIX socket, or an IP address and port
28944 separated by white space, as in these examples:
28945 .code
28946 av_scanner = drweb:/var/run/drwebd.sock
28947 av_scanner = drweb:192.168.2.20 31337
28948 .endd
28949 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28950 is used. Thanks to Alex Miller for contributing the code for this scanner.
28951
28952 .vitem &%fsecure%&
28953 .cindex "virus scanners" "F-Secure"
28954 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28955 argument which is the path to a UNIX socket. For example:
28956 .code
28957 av_scanner = fsecure:/path/to/.fsav
28958 .endd
28959 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28960 Thelmen for contributing the code for this scanner.
28961
28962 .vitem &%kavdaemon%&
28963 .cindex "virus scanners" "Kaspersky"
28964 This is the scanner daemon of Kaspersky Version 4. This version of the
28965 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28966 scanner type takes one option, which is the path to the daemon's UNIX socket.
28967 For example:
28968 .code
28969 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28970 .endd
28971 The default path is &_/var/run/AvpCtl_&.
28972
28973 .vitem &%mksd%&
28974 .cindex "virus scanners" "mksd"
28975 This is a daemon type scanner that is aimed mainly at Polish users, though some
28976 parts of documentation are now available in English. You can get it at
28977 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28978 the maximum number of processes used simultaneously to scan the attachments,
28979 provided that the demime facility is employed and also provided that mksd has
28980 been run with at least the same number of child processes. For example:
28981 .code
28982 av_scanner = mksd:2
28983 .endd
28984 You can safely omit this option (the default value is 1).
28985
28986 .vitem &%sophie%&
28987 .cindex "virus scanners" "Sophos and Sophie"
28988 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28989 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28990 for this scanner type is the path to the UNIX socket that Sophie uses for
28991 client communication. For example:
28992 .code
28993 av_scanner = sophie:/tmp/sophie
28994 .endd
28995 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28996 the option.
28997 .endlist
28998
28999 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29000 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29001 ACL.
29002
29003 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29004 makes it possible to use different scanners. See further below for an example.
29005 The &%malware%& condition caches its results, so when you use it multiple times
29006 for the same message, the actual scanning process is only carried out once.
29007 However, using expandable items in &%av_scanner%& disables this caching, in
29008 which case each use of the &%malware%& condition causes a new scan of the
29009 message.
29010
29011 The &%malware%& condition takes a right-hand argument that is expanded before
29012 use. It can then be one of
29013
29014 .ilist
29015 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29016 The condition succeeds if a virus was found, and fail otherwise. This is the
29017 recommended usage.
29018 .next
29019 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29020 the condition fails immediately.
29021 .next
29022 A regular expression, in which case the message is scanned for viruses. The
29023 condition succeeds if a virus is found and its name matches the regular
29024 expression. This allows you to take special actions on certain types of virus.
29025 .endlist
29026
29027 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29028 even if there is a problem with the virus scanner. Otherwise, such a problem
29029 causes the ACL to defer.
29030
29031 .vindex "&$malware_name$&"
29032 When a virus is found, the condition sets up an expansion variable called
29033 &$malware_name$& that contains the name of the virus. You can use it in a
29034 &%message%& modifier that specifies the error returned to the sender, and/or in
29035 logging data.
29036
29037 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29038 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29039 &%malware%& condition.
29040
29041 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29042 imposed by your anti-virus scanner.
29043
29044 Here is a very simple scanning example:
29045 .code
29046 deny message = This message contains malware ($malware_name)
29047      demime = *
29048      malware = *
29049 .endd
29050 The next example accepts messages when there is a problem with the scanner:
29051 .code
29052 deny message = This message contains malware ($malware_name)
29053      demime = *
29054      malware = */defer_ok
29055 .endd
29056 The next example shows how to use an ACL variable to scan with both sophie and
29057 aveserver. It assumes you have set:
29058 .code
29059 av_scanner = $acl_m0
29060 .endd
29061 in the main Exim configuration.
29062 .code
29063 deny message = This message contains malware ($malware_name)
29064      set acl_m0 = sophie
29065      malware = *
29066
29067 deny message = This message contains malware ($malware_name)
29068      set acl_m0 = aveserver
29069      malware = *
29070 .endd
29071
29072
29073 .section "Scanning with SpamAssassin" "SECTscanspamass"
29074 .cindex "content scanning" "for spam"
29075 .cindex "spam scanning"
29076 .cindex "SpamAssassin"
29077 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29078 score and a report for the message. You can get SpamAssassin at
29079 &url(http://www.spamassassin.org), or, if you have a working Perl
29080 installation, you can use CPAN by running:
29081 .code
29082 perl -MCPAN -e 'install Mail::SpamAssassin'
29083 .endd
29084 SpamAssassin has its own set of configuration files. Please review its
29085 documentation to see how you can tweak it. The default installation should work
29086 nicely, however.
29087
29088 .oindex "&%spamd_address%&"
29089 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29090 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29091 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29092 part of the Exim configuration as follows (example):
29093 .code
29094 spamd_address = 192.168.99.45 387
29095 .endd
29096 You do not need to set this option if you use the default. As of version 2.60,
29097 &%spamd%& also supports communication over UNIX sockets. If you want to use
29098 these, supply &%spamd_address%& with an absolute file name instead of a
29099 address/port pair:
29100 .code
29101 spamd_address = /var/run/spamd_socket
29102 .endd
29103 You can have multiple &%spamd%& servers to improve scalability. These can
29104 reside on other hardware reachable over the network. To specify multiple
29105 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29106 option, separated with colons:
29107 .code
29108 spamd_address = 192.168.2.10 783 : \
29109                 192.168.2.11 783 : \
29110                 192.168.2.12 783
29111 .endd
29112 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29113 fashion. When a server fails to respond to the connection attempt, all other
29114 servers are tried until one succeeds. If no server responds, the &%spam%&
29115 condition defers.
29116
29117 &*Warning*&: It is not possible to use the UNIX socket connection method with
29118 multiple &%spamd%& servers.
29119
29120 The &%spamd_address%& variable is expanded before use if it starts with
29121 a dollar sign. In this case, the expansion may return a string that is
29122 used as the list so that multiple spamd servers can be the result of an
29123 expansion.
29124
29125 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29126 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29127 .code
29128 deny message = This message was classified as SPAM
29129      spam = joe
29130 .endd
29131 The right-hand side of the &%spam%& condition specifies a name. This is
29132 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29133 to scan using a specific profile, but rather use the SpamAssassin system-wide
29134 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29135 However, you must put something on the right-hand side.
29136
29137 The name allows you to use per-domain or per-user antispam profiles in
29138 principle, but this is not straightforward in practice, because a message may
29139 have multiple recipients, not necessarily all in the same domain. Because the
29140 &%spam%& condition has to be called from a DATA ACL in order to be able to
29141 read the contents of the message, the variables &$local_part$& and &$domain$&
29142 are not set.
29143
29144 The right-hand side of the &%spam%& condition is expanded before being used, so
29145 you can put lookups or conditions there. When the right-hand side evaluates to
29146 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29147
29148
29149 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29150 large ones may cause significant performance degradation. As most spam messages
29151 are quite small, it is recommended that you do not scan the big ones. For
29152 example:
29153 .code
29154 deny message = This message was classified as SPAM
29155      condition = ${if < {$message_size}{10K}}
29156      spam = nobody
29157 .endd
29158
29159 The &%spam%& condition returns true if the threshold specified in the user's
29160 SpamAssassin profile has been matched or exceeded. If you want to use the
29161 &%spam%& condition for its side effects (see the variables below), you can make
29162 it always return &"true"& by appending &`:true`& to the username.
29163
29164 .cindex "spam scanning" "returned variables"
29165 When the &%spam%& condition is run, it sets up a number of expansion
29166 variables. These variables are saved with the received message, thus they are
29167 available for use at delivery time.
29168
29169 .vlist
29170 .vitem &$spam_score$&
29171 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29172 for inclusion in log or reject messages.
29173
29174 .vitem &$spam_score_int$&
29175 The spam score of the message, multiplied by ten, as an integer value. For
29176 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29177 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29178 The integer value is useful for numeric comparisons in conditions.
29179
29180 .vitem &$spam_bar$&
29181 A string consisting of a number of &"+"& or &"-"& characters, representing the
29182 integer part of the spam score value. A spam score of 4.4 would have a
29183 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29184 headers, since MUAs can match on such strings.
29185
29186 .vitem &$spam_report$&
29187 A multiline text table, containing the full SpamAssassin report for the
29188 message. Useful for inclusion in headers or reject messages.
29189 .endlist
29190
29191 The &%spam%& condition caches its results unless expansion in
29192 spamd_address was used. If you call it again with the same user name, it
29193 does not scan again, but rather returns the same values as before.
29194
29195 The &%spam%& condition returns DEFER if there is any error while running
29196 the message through SpamAssassin or if the expansion of spamd_address
29197 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29198 statement block), append &`/defer_ok`& to the right-hand side of the
29199 spam condition, like this:
29200 .code
29201 deny message = This message was classified as SPAM
29202      spam    = joe/defer_ok
29203 .endd
29204 This causes messages to be accepted even if there is a problem with &%spamd%&.
29205
29206 Here is a longer, commented example of the use of the &%spam%&
29207 condition:
29208 .code
29209 # put headers in all messages (no matter if spam or not)
29210 warn  spam = nobody:true
29211       add_header = X-Spam-Score: $spam_score ($spam_bar)
29212       add_header = X-Spam-Report: $spam_report
29213
29214 # add second subject line with *SPAM* marker when message
29215 # is over threshold
29216 warn  spam = nobody
29217       add_header = Subject: *SPAM* $h_Subject:
29218
29219 # reject spam at high scores (> 12)
29220 deny  message = This message scored $spam_score spam points.
29221       spam = nobody:true
29222       condition = ${if >{$spam_score_int}{120}{1}{0}}
29223 .endd
29224
29225
29226
29227 .section "Scanning MIME parts" "SECTscanmimepart"
29228 .cindex "content scanning" "MIME parts"
29229 .cindex "MIME content scanning"
29230 .oindex "&%acl_smtp_mime%&"
29231 .oindex "&%acl_not_smtp_mime%&"
29232 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29233 each MIME part of an SMTP message, including multipart types, in the sequence
29234 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29235 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29236 options may both refer to the same ACL if you want the same processing in both
29237 cases.
29238
29239 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29240 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29241 the case of a non-SMTP message. However, a MIME ACL is called only if the
29242 message contains a &'Content-Type:'& header line. When a call to a MIME
29243 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29244 result code is sent to the client. In the case of an SMTP message, the
29245 &%acl_smtp_data%& ACL is not called when this happens.
29246
29247 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29248 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29249 condition to match against the raw MIME part. You can also use the
29250 &%mime_regex%& condition to match against the decoded MIME part (see section
29251 &<<SECTscanregex>>&).
29252
29253 At the start of a MIME ACL, a number of variables are set from the header
29254 information for the relevant MIME part. These are described below. The contents
29255 of the MIME part are not by default decoded into a disk file except for MIME
29256 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29257 part into a disk file, you can use the &%decode%& condition. The general
29258 syntax is:
29259 .display
29260 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29261 .endd
29262 The right hand side is expanded before use. After expansion,
29263 the value can be:
29264
29265 .olist
29266 &"0"& or &"false"&, in which case no decoding is done.
29267 .next
29268 The string &"default"&. In that case, the file is put in the temporary
29269 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29270 a sequential file name consisting of the message id and a sequence number. The
29271 full path and name is available in &$mime_decoded_filename$& after decoding.
29272 .next
29273 A full path name starting with a slash. If the full name is an existing
29274 directory, it is used as a replacement for the default directory. The filename
29275 is then sequentially assigned. If the path does not exist, it is used as
29276 the full path and file name.
29277 .next
29278 If the string does not start with a slash, it is used as the
29279 filename, and the default path is then used.
29280 .endlist
29281 The &%decode%& condition normally succeeds. It is only false for syntax
29282 errors or unusual circumstances such as memory shortages. You can easily decode
29283 a file with its original, proposed filename using
29284 .code
29285 decode = $mime_filename
29286 .endd
29287 However, you should keep in mind that &$mime_filename$& might contain
29288 anything. If you place files outside of the default path, they are not
29289 automatically unlinked.
29290
29291 For RFC822 attachments (these are messages attached to messages, with a
29292 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29293 as for the primary message, only that the &$mime_is_rfc822$& expansion
29294 variable is set (see below). Attached messages are always decoded to disk
29295 before being checked, and the files are unlinked once the check is done.
29296
29297 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29298 used to match regular expressions against raw and decoded MIME parts,
29299 respectively. They are described in section &<<SECTscanregex>>&.
29300
29301 .cindex "MIME content scanning" "returned variables"
29302 The following list describes all expansion variables that are
29303 available in the MIME ACL:
29304
29305 .vlist
29306 .vitem &$mime_boundary$&
29307 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29308 have a boundary string, which is stored in this variable. If the current part
29309 has no boundary parameter in the &'Content-Type:'& header, this variable
29310 contains the empty string.
29311
29312 .vitem &$mime_charset$&
29313 This variable contains the character set identifier, if one was found in the
29314 &'Content-Type:'& header. Examples for charset identifiers are:
29315 .code
29316 us-ascii
29317 gb2312 (Chinese)
29318 iso-8859-1
29319 .endd
29320 Please note that this value is not normalized, so you should do matches
29321 case-insensitively.
29322
29323 .vitem &$mime_content_description$&
29324 This variable contains the normalized content of the &'Content-Description:'&
29325 header. It can contain a human-readable description of the parts content. Some
29326 implementations repeat the filename for attachments here, but they are usually
29327 only used for display purposes.
29328
29329 .vitem &$mime_content_disposition$&
29330 This variable contains the normalized content of the &'Content-Disposition:'&
29331 header. You can expect strings like &"attachment"& or &"inline"& here.
29332
29333 .vitem &$mime_content_id$&
29334 This variable contains the normalized content of the &'Content-ID:'& header.
29335 This is a unique ID that can be used to reference a part from another part.
29336
29337 .vitem &$mime_content_size$&
29338 This variable is set only after the &%decode%& modifier (see above) has been
29339 successfully run. It contains the size of the decoded part in kilobytes. The
29340 size is always rounded up to full kilobytes, so only a completely empty part
29341 has a &$mime_content_size$& of zero.
29342
29343 .vitem &$mime_content_transfer_encoding$&
29344 This variable contains the normalized content of the
29345 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
29346 type. Typical values are &"base64"& and &"quoted-printable"&.
29347
29348 .vitem &$mime_content_type$&
29349 If the MIME part has a &'Content-Type:'& header, this variable contains its
29350 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
29351 are some examples of popular MIME types, as they may appear in this variable:
29352 .code
29353 text/plain
29354 text/html
29355 application/octet-stream
29356 image/jpeg
29357 audio/midi
29358 .endd
29359 If the MIME part has no &'Content-Type:'& header, this variable contains the
29360 empty string.
29361
29362 .vitem &$mime_decoded_filename$&
29363 This variable is set only after the &%decode%& modifier (see above) has been
29364 successfully run. It contains the full path and file name of the file
29365 containing the decoded data.
29366 .endlist
29367
29368 .cindex "RFC 2047"
29369 .vlist
29370 .vitem &$mime_filename$&
29371 This is perhaps the most important of the MIME variables. It contains a
29372 proposed filename for an attachment, if one was found in either the
29373 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
29374 RFC2047 decoded, but no additional sanity checks are done. If no filename was
29375 found, this variable contains the empty string.
29376
29377 .vitem &$mime_is_coverletter$&
29378 This variable attempts to differentiate the &"cover letter"& of an e-mail from
29379 attached data. It can be used to clamp down on flashy or unnecessarily encoded
29380 content in the cover letter, while not restricting attachments at all.
29381
29382 The variable contains 1 (true) for a MIME part believed to be part of the
29383 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
29384 follows:
29385
29386 .olist
29387 The outermost MIME part of a message is always a cover letter.
29388
29389 .next
29390 If a multipart/alternative or multipart/related MIME part is a cover letter,
29391 so are all MIME subparts within that multipart.
29392
29393 .next
29394 If any other multipart is a cover letter, the first subpart is a cover letter,
29395 and the rest are attachments.
29396
29397 .next
29398 All parts contained within an attachment multipart are attachments.
29399 .endlist olist
29400
29401 As an example, the following will ban &"HTML mail"& (including that sent with
29402 alternative plain text), while allowing HTML files to be attached. HTML
29403 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
29404 .code
29405 deny message = HTML mail is not accepted here
29406 !condition = $mime_is_rfc822
29407 condition = $mime_is_coverletter
29408 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
29409 .endd
29410 .vitem &$mime_is_multipart$&
29411 This variable has the value 1 (true) when the current part has the main type
29412 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
29413 Since multipart entities only serve as containers for other parts, you may not
29414 want to carry out specific actions on them.
29415
29416 .vitem &$mime_is_rfc822$&
29417 This variable has the value 1 (true) if the current part is not a part of the
29418 checked message itself, but part of an attached message. Attached message
29419 decoding is fully recursive.
29420
29421 .vitem &$mime_part_count$&
29422 This variable is a counter that is raised for each processed MIME part. It
29423 starts at zero for the very first part (which is usually a multipart). The
29424 counter is per-message, so it is reset when processing RFC822 attachments (see
29425 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
29426 complete, so you can use it in the DATA ACL to determine the number of MIME
29427 parts of a message. For non-MIME messages, this variable contains the value -1.
29428 .endlist
29429
29430
29431
29432 .section "Scanning with regular expressions" "SECTscanregex"
29433 .cindex "content scanning" "with regular expressions"
29434 .cindex "regular expressions" "content scanning with"
29435 You can specify your own custom regular expression matches on the full body of
29436 the message, or on individual MIME parts.
29437
29438 The &%regex%& condition takes one or more regular expressions as arguments and
29439 matches them against the full message (when called in the DATA ACL) or a raw
29440 MIME part (when called in the MIME ACL). The &%regex%& condition matches
29441 linewise, with a maximum line length of 32K characters. That means you cannot
29442 have multiline matches with the &%regex%& condition.
29443
29444 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
29445 to 32K of decoded content (the whole content at once, not linewise). If the
29446 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
29447 is decoded automatically when &%mime_regex%& is executed (using default path
29448 and filename values). If the decoded data is larger than  32K, only the first
29449 32K characters are checked.
29450
29451 The regular expressions are passed as a colon-separated list. To include a
29452 literal colon, you must double it. Since the whole right-hand side string is
29453 expanded before being used, you must also escape dollar signs and backslashes
29454 with more backslashes, or use the &`\N`& facility to disable expansion.
29455 Here is a simple example that contains two regular expressions:
29456 .code
29457 deny message = contains blacklisted regex ($regex_match_string)
29458      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
29459 .endd
29460 The conditions returns true if any one of the regular expressions matches. The
29461 &$regex_match_string$& expansion variable is then set up and contains the
29462 matching regular expression.
29463
29464 &*Warning*&: With large messages, these conditions can be fairly
29465 CPU-intensive.
29466
29467
29468
29469
29470 .section "The demime condition" "SECTdemimecond"
29471 .cindex "content scanning" "MIME checking"
29472 .cindex "MIME content scanning"
29473 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
29474 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
29475 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
29476 ACL functionality, but provides no additional facilities. Please note that this
29477 condition is deprecated and kept only for backward compatibility. You must set
29478 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
29479 use the &%demime%& condition.
29480
29481 The &%demime%& condition unpacks MIME containers in the message. It detects
29482 errors in MIME containers and can match file extensions found in the message
29483 against a list. Using this facility produces files containing the unpacked MIME
29484 parts of the message in the temporary scan directory. If you do antivirus
29485 scanning, it is recommended that you use the &%demime%& condition before the
29486 antivirus (&%malware%&) condition.
29487
29488 On the right-hand side of the &%demime%& condition you can pass a
29489 colon-separated list of file extensions that it should match against. For
29490 example:
29491 .code
29492 deny message = Found blacklisted file attachment
29493      demime  = vbs:com:bat:pif:prf:lnk
29494 .endd
29495 If one of the file extensions is found, the condition is true, otherwise it is
29496 false. If there is a temporary error while demimeing (for example, &"disk
29497 full"&), the condition defers, and the message is temporarily rejected (unless
29498 the condition is on a &%warn%& verb).
29499
29500 The right-hand side is expanded before being treated as a list, so you can have
29501 conditions and lookups there. If it expands to an empty string, &"false"&, or
29502 zero (&"0"&), no demimeing is done and the condition is false.
29503
29504 The &%demime%& condition set the following variables:
29505
29506 .vlist
29507 .vitem &$demime_errorlevel$&
29508 .vindex "&$demime_errorlevel$&"
29509 When an error is detected in a MIME container, this variable contains the
29510 severity of the error, as an integer number. The higher the value, the more
29511 severe the error (the current maximum value is 3). If this variable is unset or
29512 zero, no error occurred.
29513
29514 .vitem &$demime_reason$&
29515 .vindex "&$demime_reason$&"
29516 When &$demime_errorlevel$& is greater than zero, this variable contains a
29517 human-readable text string describing the MIME error that occurred.
29518 .endlist
29519
29520 .vlist
29521 .vitem &$found_extension$&
29522 .vindex "&$found_extension$&"
29523 When the &%demime%& condition is true, this variable contains the file
29524 extension it found.
29525 .endlist
29526
29527 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
29528 the &%demime%& condition, and are not changed on subsequent calls.
29529
29530 If you do not want to check for file extensions, but rather use the &%demime%&
29531 condition for unpacking or error checking purposes, pass &"*"& as the
29532 right-hand side value. Here is a more elaborate example of how to use this
29533 facility:
29534 .code
29535 # Reject messages with serious MIME container errors
29536 deny  message = Found MIME error ($demime_reason).
29537       demime = *
29538       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
29539
29540 # Reject known virus spreading file extensions.
29541 # Accepting these is pretty much braindead.
29542 deny  message = contains $found_extension file (blacklisted).
29543       demime  = com:vbs:bat:pif:scr
29544
29545 # Freeze .exe and .doc files. Postmaster can
29546 # examine them and eventually thaw them.
29547 deny  log_message = Another $found_extension file.
29548       demime = exe:doc
29549       control = freeze
29550 .endd
29551 .ecindex IIDcosca
29552
29553
29554
29555
29556 . ////////////////////////////////////////////////////////////////////////////
29557 . ////////////////////////////////////////////////////////////////////////////
29558
29559 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
29560          "Local scan function"
29561 .scindex IIDlosca "&[local_scan()]& function" "description of"
29562 .cindex "customizing" "input scan using C function"
29563 .cindex "policy control" "by local scan function"
29564 In these days of email worms, viruses, and ever-increasing spam, some sites
29565 want to apply a lot of checking to messages before accepting them.
29566
29567 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
29568 passing messages to external virus and spam scanning software. You can also do
29569 a certain amount in Exim itself through string expansions and the &%condition%&
29570 condition in the ACL that runs after the SMTP DATA command or the ACL for
29571 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
29572
29573 To allow for further customization to a site's own requirements, there is the
29574 possibility of linking Exim with a private message scanning function, written
29575 in C. If you want to run code that is written in something other than C, you
29576 can of course use a little C stub to call it.
29577
29578 The local scan function is run once for every incoming message, at the point
29579 when Exim is just about to accept the message.
29580 It can therefore be used to control non-SMTP messages from local processes as
29581 well as messages arriving via SMTP.
29582
29583 Exim applies a timeout to calls of the local scan function, and there is an
29584 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
29585 Zero means &"no timeout"&.
29586 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
29587 before calling the local scan function, so that the most common types of crash
29588 are caught. If the timeout is exceeded or one of those signals is caught, the
29589 incoming message is rejected with a temporary error if it is an SMTP message.
29590 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
29591 code. The incident is logged on the main and reject logs.
29592
29593
29594
29595 .section "Building Exim to use a local scan function" "SECID207"
29596 .cindex "&[local_scan()]& function" "building Exim to use"
29597 To make use of the local scan function feature, you must tell Exim where your
29598 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
29599 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
29600 directory, so you might set
29601 .code
29602 LOCAL_SCAN_SOURCE=Local/local_scan.c
29603 .endd
29604 for example. The function must be called &[local_scan()]&. It is called by
29605 Exim after it has received a message, when the success return code is about to
29606 be sent. This is after all the ACLs have been run. The return code from your
29607 function controls whether the message is actually accepted or not. There is a
29608 commented template function (that just accepts the message) in the file
29609 _src/local_scan.c_.
29610
29611 If you want to make use of Exim's run time configuration file to set options
29612 for your &[local_scan()]& function, you must also set
29613 .code
29614 LOCAL_SCAN_HAS_OPTIONS=yes
29615 .endd
29616 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
29617
29618
29619
29620
29621 .section "API for local_scan()" "SECTapiforloc"
29622 .cindex "&[local_scan()]& function" "API description"
29623 You must include this line near the start of your code:
29624 .code
29625 #include "local_scan.h"
29626 .endd
29627 This header file defines a number of variables and other values, and the
29628 prototype for the function itself. Exim is coded to use unsigned char values
29629 almost exclusively, and one of the things this header defines is a shorthand
29630 for &`unsigned char`& called &`uschar`&.
29631 It also contains the following macro definitions, to simplify casting character
29632 strings and pointers to character strings:
29633 .code
29634 #define CS   (char *)
29635 #define CCS  (const char *)
29636 #define CSS  (char **)
29637 #define US   (unsigned char *)
29638 #define CUS  (const unsigned char *)
29639 #define USS  (unsigned char **)
29640 .endd
29641 The function prototype for &[local_scan()]& is:
29642 .code
29643 extern int local_scan(int fd, uschar **return_text);
29644 .endd
29645 The arguments are as follows:
29646
29647 .ilist
29648 &%fd%& is a file descriptor for the file that contains the body of the message
29649 (the -D file). The file is open for reading and writing, but updating it is not
29650 recommended. &*Warning*&: You must &'not'& close this file descriptor.
29651
29652 The descriptor is positioned at character 19 of the file, which is the first
29653 character of the body itself, because the first 19 characters are the message
29654 id followed by &`-D`& and a newline. If you rewind the file, you should use the
29655 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
29656 case this changes in some future version.
29657 .next
29658 &%return_text%& is an address which you can use to return a pointer to a text
29659 string at the end of the function. The value it points to on entry is NULL.
29660 .endlist
29661
29662 The function must return an &%int%& value which is one of the following macros:
29663
29664 .vlist
29665 .vitem &`LOCAL_SCAN_ACCEPT`&
29666 .vindex "&$local_scan_data$&"
29667 The message is accepted. If you pass back a string of text, it is saved with
29668 the message, and made available in the variable &$local_scan_data$&. No
29669 newlines are permitted (if there are any, they are turned into spaces) and the
29670 maximum length of text is 1000 characters.
29671
29672 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
29673 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29674 queued without immediate delivery, and is frozen.
29675
29676 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
29677 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29678 queued without immediate delivery.
29679
29680 .vitem &`LOCAL_SCAN_REJECT`&
29681 The message is rejected; the returned text is used as an error message which is
29682 passed back to the sender and which is also logged. Newlines are permitted &--
29683 they cause a multiline response for SMTP rejections, but are converted to
29684 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
29685 used.
29686
29687 .vitem &`LOCAL_SCAN_TEMPREJECT`&
29688 The message is temporarily rejected; the returned text is used as an error
29689 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
29690 problem"& is used.
29691
29692 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
29693 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
29694 message is not written to the reject log. It has the effect of unsetting the
29695 &%rejected_header%& log selector for just this rejection. If
29696 &%rejected_header%& is already unset (see the discussion of the
29697 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
29698 same as LOCAL_SCAN_REJECT.
29699
29700 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
29701 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
29702 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
29703 .endlist
29704
29705 If the message is not being received by interactive SMTP, rejections are
29706 reported by writing to &%stderr%& or by sending an email, as configured by the
29707 &%-oe%& command line options.
29708
29709
29710
29711 .section "Configuration options for local_scan()" "SECTconoptloc"
29712 .cindex "&[local_scan()]& function" "configuration options"
29713 It is possible to have option settings in the main configuration file
29714 that set values in static variables in the &[local_scan()]& module. If you
29715 want to do this, you must have the line
29716 .code
29717 LOCAL_SCAN_HAS_OPTIONS=yes
29718 .endd
29719 in your &_Local/Makefile_& when you build Exim. (This line is in
29720 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
29721 file, you must define static variables to hold the option values, and a table
29722 to define them.
29723
29724 The table must be a vector called &%local_scan_options%&, of type
29725 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
29726 and a pointer to the variable that holds the value. The entries must appear in
29727 alphabetical order. Following &%local_scan_options%& you must also define a
29728 variable called &%local_scan_options_count%& that contains the number of
29729 entries in the table. Here is a short example, showing two kinds of option:
29730 .code
29731 static int my_integer_option = 42;
29732 static uschar *my_string_option = US"a default string";
29733
29734 optionlist local_scan_options[] = {
29735   { "my_integer", opt_int,       &my_integer_option },
29736   { "my_string",  opt_stringptr, &my_string_option }
29737 };
29738
29739 int local_scan_options_count =
29740   sizeof(local_scan_options)/sizeof(optionlist);
29741 .endd
29742 The values of the variables can now be changed from Exim's runtime
29743 configuration file by including a local scan section as in this example:
29744 .code
29745 begin local_scan
29746 my_integer = 99
29747 my_string = some string of text...
29748 .endd
29749 The available types of option data are as follows:
29750
29751 .vlist
29752 .vitem &*opt_bool*&
29753 This specifies a boolean (true/false) option. The address should point to a
29754 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
29755 that are defined as &"1"& and &"0"&, respectively. If you want to detect
29756 whether such a variable has been set at all, you can initialize it to
29757 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
29758 values.)
29759
29760 .vitem &*opt_fixed*&
29761 This specifies a fixed point number, such as is used for load averages.
29762 The address should point to a variable of type &`int`&. The value is stored
29763 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
29764
29765 .vitem &*opt_int*&
29766 This specifies an integer; the address should point to a variable of type
29767 &`int`&. The value may be specified in any of the integer formats accepted by
29768 Exim.
29769
29770 .vitem &*opt_mkint*&
29771 This is the same as &%opt_int%&, except that when such a value is output in a
29772 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
29773 printed with the suffix K or M.
29774
29775 .vitem &*opt_octint*&
29776 This also specifies an integer, but the value is always interpreted as an
29777 octal integer, whether or not it starts with the digit zero, and it is
29778 always output in octal.
29779
29780 .vitem &*opt_stringptr*&
29781 This specifies a string value; the address must be a pointer to a
29782 variable that points to a string (for example, of type &`uschar *`&).
29783
29784 .vitem &*opt_time*&
29785 This specifies a time interval value. The address must point to a variable of
29786 type &`int`&. The value that is placed there is a number of seconds.
29787 .endlist
29788
29789 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
29790 out the values of all the &[local_scan()]& options.
29791
29792
29793
29794 .section "Available Exim variables" "SECID208"
29795 .cindex "&[local_scan()]& function" "available Exim variables"
29796 The header &_local_scan.h_& gives you access to a number of C variables. These
29797 are the only ones that are guaranteed to be maintained from release to release.
29798 Note, however, that you can obtain the value of any Exim expansion variable,
29799 including &$recipients$&, by calling &'expand_string()'&. The exported
29800 C variables are as follows:
29801
29802 .vlist
29803 .vitem &*int&~body_linecount*&
29804 This variable contains the number of lines in the message's body.
29805
29806 .vitem &*int&~body_zerocount*&
29807 This variable contains the number of binary zero bytes in the message's body.
29808
29809 .vitem &*unsigned&~int&~debug_selector*&
29810 This variable is set to zero when no debugging is taking place. Otherwise, it
29811 is a bitmap of debugging selectors. Two bits are identified for use in
29812 &[local_scan()]&; they are defined as macros:
29813
29814 .ilist
29815 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
29816 testing option that is not privileged &-- any caller may set it. All the
29817 other selector bits can be set only by admin users.
29818
29819 .next
29820 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
29821 by the &`+local_scan`& debug selector. It is not included in the default set
29822 of debugging bits.
29823 .endlist ilist
29824
29825 Thus, to write to the debugging output only when &`+local_scan`& has been
29826 selected, you should use code like this:
29827 .code
29828 if ((debug_selector & D_local_scan) != 0)
29829   debug_printf("xxx", ...);
29830 .endd
29831 .vitem &*uschar&~*expand_string_message*&
29832 After a failing call to &'expand_string()'& (returned value NULL), the
29833 variable &%expand_string_message%& contains the error message, zero-terminated.
29834
29835 .vitem &*header_line&~*header_list*&
29836 A pointer to a chain of header lines. The &%header_line%& structure is
29837 discussed below.
29838
29839 .vitem &*header_line&~*header_last*&
29840 A pointer to the last of the header lines.
29841
29842 .vitem &*uschar&~*headers_charset*&
29843 The value of the &%headers_charset%& configuration option.
29844
29845 .vitem &*BOOL&~host_checking*&
29846 This variable is TRUE during a host checking session that is initiated by the
29847 &%-bh%& command line option.
29848
29849 .vitem &*uschar&~*interface_address*&
29850 The IP address of the interface that received the message, as a string. This
29851 is NULL for locally submitted messages.
29852
29853 .vitem &*int&~interface_port*&
29854 The port on which this message was received. When testing with the &%-bh%&
29855 command line option, the value of this variable is -1 unless a port has been
29856 specified via the &%-oMi%& option.
29857
29858 .vitem &*uschar&~*message_id*&
29859 This variable contains Exim's message id for the incoming message (the value of
29860 &$message_exim_id$&) as a zero-terminated string.
29861
29862 .vitem &*uschar&~*received_protocol*&
29863 The name of the protocol by which the message was received.
29864
29865 .vitem &*int&~recipients_count*&
29866 The number of accepted recipients.
29867
29868 .vitem &*recipient_item&~*recipients_list*&
29869 .cindex "recipient" "adding in local scan"
29870 .cindex "recipient" "removing in local scan"
29871 The list of accepted recipients, held in a vector of length
29872 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29873 can add additional recipients by calling &'receive_add_recipient()'& (see
29874 below). You can delete recipients by removing them from the vector and
29875 adjusting the value in &%recipients_count%&. In particular, by setting
29876 &%recipients_count%& to zero you remove all recipients. If you then return the
29877 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29878 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29879 and then call &'receive_add_recipient()'& as often as needed.
29880
29881 .vitem &*uschar&~*sender_address*&
29882 The envelope sender address. For bounce messages this is the empty string.
29883
29884 .vitem &*uschar&~*sender_host_address*&
29885 The IP address of the sending host, as a string. This is NULL for
29886 locally-submitted messages.
29887
29888 .vitem &*uschar&~*sender_host_authenticated*&
29889 The name of the authentication mechanism that was used, or NULL if the message
29890 was not received over an authenticated SMTP connection.
29891
29892 .vitem &*uschar&~*sender_host_name*&
29893 The name of the sending host, if known.
29894
29895 .vitem &*int&~sender_host_port*&
29896 The port on the sending host.
29897
29898 .vitem &*BOOL&~smtp_input*&
29899 This variable is TRUE for all SMTP input, including BSMTP.
29900
29901 .vitem &*BOOL&~smtp_batched_input*&
29902 This variable is TRUE for BSMTP input.
29903
29904 .vitem &*int&~store_pool*&
29905 The contents of this variable control which pool of memory is used for new
29906 requests. See section &<<SECTmemhanloc>>& for details.
29907 .endlist
29908
29909
29910 .section "Structure of header lines" "SECID209"
29911 The &%header_line%& structure contains the members listed below.
29912 You can add additional header lines by calling the &'header_add()'& function
29913 (see below). You can cause header lines to be ignored (deleted) by setting
29914 their type to *.
29915
29916
29917 .vlist
29918 .vitem &*struct&~header_line&~*next*&
29919 A pointer to the next header line, or NULL for the last line.
29920
29921 .vitem &*int&~type*&
29922 A code identifying certain headers that Exim recognizes. The codes are printing
29923 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29924 Notice in particular that any header line whose type is * is not transmitted
29925 with the message. This flagging is used for header lines that have been
29926 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29927 lines.) Effectively, * means &"deleted"&.
29928
29929 .vitem &*int&~slen*&
29930 The number of characters in the header line, including the terminating and any
29931 internal newlines.
29932
29933 .vitem &*uschar&~*text*&
29934 A pointer to the text of the header. It always ends with a newline, followed by
29935 a zero byte. Internal newlines are preserved.
29936 .endlist
29937
29938
29939
29940 .section "Structure of recipient items" "SECID210"
29941 The &%recipient_item%& structure contains these members:
29942
29943 .vlist
29944 .vitem &*uschar&~*address*&
29945 This is a pointer to the recipient address as it was received.
29946
29947 .vitem &*int&~pno*&
29948 This is used in later Exim processing when top level addresses are created by
29949 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29950 and must always contain -1 at this stage.
29951
29952 .vitem &*uschar&~*errors_to*&
29953 If this value is not NULL, bounce messages caused by failing to deliver to the
29954 recipient are sent to the address it contains. In other words, it overrides the
29955 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29956 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29957 an unqualified address, Exim qualifies it using the domain from
29958 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29959 is NULL for all recipients.
29960 .endlist
29961
29962
29963
29964 .section "Available Exim functions" "SECID211"
29965 .cindex "&[local_scan()]& function" "available Exim functions"
29966 The header &_local_scan.h_& gives you access to a number of Exim functions.
29967 These are the only ones that are guaranteed to be maintained from release to
29968 release:
29969
29970 .vlist
29971 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29972        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29973
29974 This function creates a child process that runs the command specified by
29975 &%argv%&. The environment for the process is specified by &%envp%&, which can
29976 be NULL if no environment variables are to be passed. A new umask is supplied
29977 for the process in &%newumask%&.
29978
29979 Pipes to the standard input and output of the new process are set up
29980 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29981 standard error is cloned to the standard output. If there are any file
29982 descriptors &"in the way"& in the new process, they are closed. If the final
29983 argument is TRUE, the new process is made into a process group leader.
29984
29985 The function returns the pid of the new process, or -1 if things go wrong.
29986
29987 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29988 This function waits for a child process to terminate, or for a timeout (in
29989 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29990 return value is as follows:
29991
29992 .ilist
29993 >= 0
29994
29995 The process terminated by a normal exit and the value is the process
29996 ending status.
29997
29998 .next
29999 < 0 and > &--256
30000
30001 The process was terminated by a signal and the value is the negation of the
30002 signal number.
30003
30004 .next
30005 &--256
30006
30007 The process timed out.
30008 .next
30009 &--257
30010
30011 The was some other error in wait(); &%errno%& is still set.
30012 .endlist
30013
30014 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30015 This function provide you with a means of submitting a new message to
30016 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30017 want, but this packages it all up for you.) The function creates a pipe,
30018 forks a subprocess that is running
30019 .code
30020 exim -t -oem -oi -f <>
30021 .endd
30022 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30023 that is connected to the standard input. The yield of the function is the PID
30024 of the subprocess. You can then write a message to the file descriptor, with
30025 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30026
30027 When you have finished, call &'child_close()'& to wait for the process to
30028 finish and to collect its ending status. A timeout value of zero is usually
30029 fine in this circumstance. Unless you have made a mistake with the recipient
30030 addresses, you should get a return code of zero.
30031
30032
30033 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30034        *sender_authentication)*&
30035 This function is a more sophisticated version of &'child_open()'&. The command
30036 that it runs is:
30037 .display
30038 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30039 .endd
30040 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30041
30042
30043 .vitem &*void&~debug_printf(char&~*,&~...)*&
30044 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30045 output is written to the standard error stream. If no debugging is selected,
30046 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30047 conditional on the &`local_scan`& debug selector by coding like this:
30048 .code
30049 if ((debug_selector & D_local_scan) != 0)
30050   debug_printf("xxx", ...);
30051 .endd
30052
30053 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30054 This is an interface to Exim's string expansion code. The return value is the
30055 expanded string, or NULL if there was an expansion failure.
30056 The C variable &%expand_string_message%& contains an error message after an
30057 expansion failure. If expansion does not change the string, the return value is
30058 the pointer to the input string. Otherwise, the return value points to a new
30059 block of memory that was obtained by a call to &'store_get()'&. See section
30060 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30061
30062 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30063 This function allows you to an add additional header line at the end of the
30064 existing ones. The first argument is the type, and should normally be a space
30065 character. The second argument is a format string and any number of
30066 substitution arguments as for &[sprintf()]&. You may include internal newlines
30067 if you want, and you must ensure that the string ends with a newline.
30068
30069 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30070         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30071 This function adds a new header line at a specified point in the header
30072 chain. The header itself is specified as for &'header_add()'&.
30073
30074 If &%name%& is NULL, the new header is added at the end of the chain if
30075 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30076 NULL, the header lines are searched for the first non-deleted header that
30077 matches the name. If one is found, the new header is added before it if
30078 &%after%& is false. If &%after%& is true, the new header is added after the
30079 found header and any adjacent subsequent ones with the same name (even if
30080 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30081 option controls where the header is added. If it is true, addition is at the
30082 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30083 headers, or at the top if there are no &'Received:'& headers, you could use
30084 .code
30085 header_add_at_position(TRUE, US"Received", TRUE,
30086   ' ', "X-xxx: ...");
30087 .endd
30088 Normally, there is always at least one non-deleted &'Received:'& header, but
30089 there may not be if &%received_header_text%& expands to an empty string.
30090
30091
30092 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30093 This function removes header lines. If &%occurrence%& is zero or negative, all
30094 occurrences of the header are removed. If occurrence is greater than zero, that
30095 particular instance of the header is removed. If no header(s) can be found that
30096 match the specification, the function does nothing.
30097
30098
30099 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30100         int&~length,&~BOOL&~notdel)*&"
30101 This function tests whether the given header has the given name. It is not just
30102 a string comparison, because white space is permitted between the name and the
30103 colon. If the &%notdel%& argument is true, a false return is forced for all
30104 &"deleted"& headers; otherwise they are not treated specially. For example:
30105 .code
30106 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30107 .endd
30108 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30109 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30110 This function base64-encodes a string, which is passed by address and length.
30111 The text may contain bytes of any value, including zero. The result is passed
30112 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30113 zero-terminated.
30114
30115 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30116 This function decodes a base64-encoded string. Its arguments are a
30117 zero-terminated base64-encoded string and the address of a variable that is set
30118 to point to the result, which is in dynamic memory. The length of the decoded
30119 string is the yield of the function. If the input is invalid base64 data, the
30120 yield is -1. A zero byte is added to the end of the output string to make it
30121 easy to interpret as a C string (assuming it contains no zeros of its own). The
30122 added zero byte is not included in the returned count.
30123
30124 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30125 This function checks for a match in a domain list. Domains are always
30126 matched caselessly. The return value is one of the following:
30127 .display
30128 &`OK     `& match succeeded
30129 &`FAIL   `& match failed
30130 &`DEFER  `& match deferred
30131 .endd
30132 DEFER is usually caused by some kind of lookup defer, such as the
30133 inability to contact a database.
30134
30135 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30136         BOOL&~caseless)*&"
30137 This function checks for a match in a local part list. The third argument
30138 controls case-sensitivity. The return values are as for
30139 &'lss_match_domain()'&.
30140
30141 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30142         BOOL&~caseless)*&"
30143 This function checks for a match in an address list. The third argument
30144 controls the case-sensitivity of the local part match. The domain is always
30145 matched caselessly. The return values are as for &'lss_match_domain()'&.
30146
30147 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30148         uschar&~*list)*&"
30149 This function checks for a match in a host list. The most common usage is
30150 expected to be
30151 .code
30152 lss_match_host(sender_host_name, sender_host_address, ...)
30153 .endd
30154 .vindex "&$sender_host_address$&"
30155 An empty address field matches an empty item in the host list. If the host name
30156 is NULL, the name corresponding to &$sender_host_address$& is automatically
30157 looked up if a host name is required to match an item in the list. The return
30158 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30159 returns ERROR in the case when it had to look up a host name, but the lookup
30160 failed.
30161
30162 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30163         *format,&~...)*&"
30164 This function writes to Exim's log files. The first argument should be zero (it
30165 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30166 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30167 them. It specifies to which log or logs the message is written. The remaining
30168 arguments are a format and relevant insertion arguments. The string should not
30169 contain any newlines, not even at the end.
30170
30171
30172 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30173 This function adds an additional recipient to the message. The first argument
30174 is the recipient address. If it is unqualified (has no domain), it is qualified
30175 with the &%qualify_recipient%& domain. The second argument must always be -1.
30176
30177 This function does not allow you to specify a private &%errors_to%& address (as
30178 described with the structure of &%recipient_item%& above), because it pre-dates
30179 the addition of that field to the structure. However, it is easy to add such a
30180 value afterwards. For example:
30181 .code
30182  receive_add_recipient(US"monitor@mydom.example", -1);
30183  recipients_list[recipients_count-1].errors_to =
30184    US"postmaster@mydom.example";
30185 .endd
30186
30187 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30188 This is a convenience function to remove a named recipient from the list of
30189 recipients. It returns true if a recipient was removed, and false if no
30190 matching recipient could be found. The argument must be a complete email
30191 address.
30192 .endlist
30193
30194
30195 .cindex "RFC 2047"
30196 .vlist
30197 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30198   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30199 This function decodes strings that are encoded according to RFC 2047. Typically
30200 these are the contents of header lines. First, each &"encoded word"& is decoded
30201 from the Q or B encoding into a byte-string. Then, if provided with the name of
30202 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30203 made  to translate the result to the named character set. If this fails, the
30204 binary string is returned with an error message.
30205
30206 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30207 maximum MIME word length is enforced. The third argument is the target
30208 encoding, or NULL if no translation is wanted.
30209
30210 .cindex "binary zero" "in RFC 2047 decoding"
30211 .cindex "RFC 2047" "binary zero in"
30212 If a binary zero is encountered in the decoded string, it is replaced by the
30213 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30214 not be 0 because header lines are handled as zero-terminated strings.
30215
30216 The function returns the result of processing the string, zero-terminated; if
30217 &%lenptr%& is not NULL, the length of the result is set in the variable to
30218 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30219
30220 If an error is encountered, the function returns NULL and uses the &%error%&
30221 argument to return an error message. The variable pointed to by &%error%& is
30222 set to NULL if there is no error; it may be set non-NULL even when the function
30223 returns a non-NULL value if decoding was successful, but there was a problem
30224 with translation.
30225
30226
30227 .vitem &*int&~smtp_fflush(void)*&
30228 This function is used in conjunction with &'smtp_printf()'&, as described
30229 below.
30230
30231 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30232 The arguments of this function are like &[printf()]&; it writes to the SMTP
30233 output stream. You should use this function only when there is an SMTP output
30234 stream, that is, when the incoming message is being received via interactive
30235 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30236 is FALSE. If you want to test for an incoming message from another host (as
30237 opposed to a local process that used the &%-bs%& command line option), you can
30238 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30239 is involved.
30240
30241 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30242 output function, so it can be used for all forms of SMTP connection.
30243
30244 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30245 must start with an appropriate response code: 550 if you are going to return
30246 LOCAL_SCAN_REJECT, 451 if you are going to return
30247 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30248 initial lines of a multi-line response, the code must be followed by a hyphen
30249 to indicate that the line is not the final response line. You must also ensure
30250 that the lines you write terminate with CRLF. For example:
30251 .code
30252 smtp_printf("550-this is some extra info\r\n");
30253 return LOCAL_SCAN_REJECT;
30254 .endd
30255 Note that you can also create multi-line responses by including newlines in
30256 the data returned via the &%return_text%& argument. The added value of using
30257 &'smtp_printf()'& is that, for instance, you could introduce delays between
30258 multiple output lines.
30259
30260 The &'smtp_printf()'& function does not return any error indication, because it
30261 does not automatically flush pending output, and therefore does not test
30262 the state of the stream. (In the main code of Exim, flushing and error
30263 detection is done when Exim is ready for the next SMTP input command.) If
30264 you want to flush the output and check for an error (for example, the
30265 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30266 arguments. It flushes the output stream, and returns a non-zero value if there
30267 is an error.
30268
30269 .vitem &*void&~*store_get(int)*&
30270 This function accesses Exim's internal store (memory) manager. It gets a new
30271 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30272 runs out of memory. See the next section for a discussion of memory handling.
30273
30274 .vitem &*void&~*store_get_perm(int)*&
30275 This function is like &'store_get()'&, but it always gets memory from the
30276 permanent pool. See the next section for a discussion of memory handling.
30277
30278 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30279 See below.
30280
30281 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30282 See below.
30283
30284 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30285 These three functions create strings using Exim's dynamic memory facilities.
30286 The first makes a copy of an entire string. The second copies up to a maximum
30287 number of characters, indicated by the second argument. The third uses a format
30288 and insertion arguments to create a new string. In each case, the result is a
30289 pointer to a new string in the current memory pool. See the next section for
30290 more discussion.
30291 .endlist
30292
30293
30294
30295 .section "More about Exim's memory handling" "SECTmemhanloc"
30296 .cindex "&[local_scan()]& function" "memory handling"
30297 No function is provided for freeing memory, because that is never needed.
30298 The dynamic memory that Exim uses when receiving a message is automatically
30299 recycled if another message is received by the same process (this applies only
30300 to incoming SMTP connections &-- other input methods can supply only one
30301 message at a time). After receiving the last message, a reception process
30302 terminates.
30303
30304 Because it is recycled, the normal dynamic memory cannot be used for holding
30305 data that must be preserved over a number of incoming messages on the same SMTP
30306 connection. However, Exim in fact uses two pools of dynamic memory; the second
30307 one is not recycled, and can be used for this purpose.
30308
30309 If you want to allocate memory that remains available for subsequent messages
30310 in the same SMTP connection, you should set
30311 .code
30312 store_pool = POOL_PERM
30313 .endd
30314 before calling the function that does the allocation. There is no need to
30315 restore the value if you do not need to; however, if you do want to revert to
30316 the normal pool, you can either restore the previous value of &%store_pool%& or
30317 set it explicitly to POOL_MAIN.
30318
30319 The pool setting applies to all functions that get dynamic memory, including
30320 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30321 There is also a convenience function called &'store_get_perm()'& that gets a
30322 block of memory from the permanent pool while preserving the value of
30323 &%store_pool%&.
30324 .ecindex IIDlosca
30325
30326
30327
30328
30329 . ////////////////////////////////////////////////////////////////////////////
30330 . ////////////////////////////////////////////////////////////////////////////
30331
30332 .chapter "System-wide message filtering" "CHAPsystemfilter"
30333 .scindex IIDsysfil1 "filter" "system filter"
30334 .scindex IIDsysfil2 "filtering all mail"
30335 .scindex IIDsysfil3 "system filter"
30336 The previous chapters (on ACLs and the local scan function) describe checks
30337 that can be applied to messages before they are accepted by a host. There is
30338 also a mechanism for checking messages once they have been received, but before
30339 they are delivered. This is called the &'system filter'&.
30340
30341 The system filter operates in a similar manner to users' filter files, but it
30342 is run just once per message (however many recipients the message has).
30343 It should not normally be used as a substitute for routing, because &%deliver%&
30344 commands in a system router provide new envelope recipient addresses.
30345 The system filter must be an Exim filter. It cannot be a Sieve filter.
30346
30347 The system filter is run at the start of a delivery attempt, before any routing
30348 is done. If a message fails to be completely delivered at the first attempt,
30349 the system filter is run again at the start of every retry.
30350 If you want your filter to do something only once per message, you can make use
30351 of the &%first_delivery%& condition in an &%if%& command in the filter to
30352 prevent it happening on retries.
30353
30354 .vindex "&$domain$&"
30355 .vindex "&$local_part$&"
30356 &*Warning*&: Because the system filter runs just once, variables that are
30357 specific to individual recipient addresses, such as &$local_part$& and
30358 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
30359 you want to run a centrally-specified filter for each recipient address
30360 independently, you can do so by setting up a suitable &(redirect)& router, as
30361 described in section &<<SECTperaddfil>>& below.
30362
30363
30364 .section "Specifying a system filter" "SECID212"
30365 .cindex "uid (user id)" "system filter"
30366 .cindex "gid (group id)" "system filter"
30367 The name of the file that contains the system filter must be specified by
30368 setting &%system_filter%&. If you want the filter to run under a uid and gid
30369 other than root, you must also set &%system_filter_user%& and
30370 &%system_filter_group%& as appropriate. For example:
30371 .code
30372 system_filter = /etc/mail/exim.filter
30373 system_filter_user = exim
30374 .endd
30375 If a system filter generates any deliveries directly to files or pipes (via the
30376 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
30377 specified by setting &%system_filter_file_transport%& and
30378 &%system_filter_pipe_transport%&, respectively. Similarly,
30379 &%system_filter_reply_transport%& must be set to handle any messages generated
30380 by the &%reply%& command.
30381
30382
30383 .section "Testing a system filter" "SECID213"
30384 You can run simple tests of a system filter in the same way as for a user
30385 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
30386 are permitted only in system filters are recognized.
30387
30388 If you want to test the combined effect of a system filter and a user filter,
30389 you can use both &%-bF%& and &%-bf%& on the same command line.
30390
30391
30392
30393 .section "Contents of a system filter" "SECID214"
30394 The language used to specify system filters is the same as for users' filter
30395 files. It is described in the separate end-user document &'Exim's interface to
30396 mail filtering'&. However, there are some additional features that are
30397 available only in system filters; these are described in subsequent sections.
30398 If they are encountered in a user's filter file or when testing with &%-bf%&,
30399 they cause errors.
30400
30401 .cindex "frozen messages" "manual thaw; testing in filter"
30402 There are two special conditions which, though available in users' filter
30403 files, are designed for use in system filters. The condition &%first_delivery%&
30404 is true only for the first attempt at delivering a message, and
30405 &%manually_thawed%& is true only if the message has been frozen, and
30406 subsequently thawed by an admin user. An explicit forced delivery counts as a
30407 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
30408
30409 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
30410 specify an &"unseen"& (non-significant) delivery, and that delivery does not
30411 succeed, it will not be tried again.
30412 If you want Exim to retry an unseen delivery until it succeeds, you should
30413 arrange to set it up every time the filter runs.
30414
30415 When a system filter finishes running, the values of the variables &$n0$& &--
30416 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
30417 users' filter files. Thus a system filter can, for example, set up &"scores"&
30418 to which users' filter files can refer.
30419
30420
30421
30422 .section "Additional variable for system filters" "SECID215"
30423 .vindex "&$recipients$&"
30424 The expansion variable &$recipients$&, containing a list of all the recipients
30425 of the message (separated by commas and white space), is available in system
30426 filters. It is not available in users' filters for privacy reasons.
30427
30428
30429
30430 .section "Defer, freeze, and fail commands for system filters" "SECID216"
30431 .cindex "freezing messages"
30432 .cindex "message" "freezing"
30433 .cindex "message" "forced failure"
30434 .cindex "&%fail%&" "in system filter"
30435 .cindex "&%freeze%& in system filter"
30436 .cindex "&%defer%& in system filter"
30437 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
30438 always available in system filters, but are not normally enabled in users'
30439 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
30440 for the &(redirect)& router.) These commands can optionally be followed by the
30441 word &%text%& and a string containing an error message, for example:
30442 .code
30443 fail text "this message looks like spam to me"
30444 .endd
30445 The keyword &%text%& is optional if the next character is a double quote.
30446
30447 The &%defer%& command defers delivery of the original recipients of the
30448 message. The &%fail%& command causes all the original recipients to be failed,
30449 and a bounce message to be created. The &%freeze%& command suspends all
30450 delivery attempts for the original recipients. In all cases, any new deliveries
30451 that are specified by the filter are attempted as normal after the filter has
30452 run.
30453
30454 The &%freeze%& command is ignored if the message has been manually unfrozen and
30455 not manually frozen since. This means that automatic freezing by a system
30456 filter can be used as a way of checking out suspicious messages. If a message
30457 is found to be all right, manually unfreezing it allows it to be delivered.
30458
30459 .cindex "log" "&%fail%& command log line"
30460 .cindex "&%fail%&" "log line; reducing"
30461 The text given with a fail command is used as part of the bounce message as
30462 well as being written to the log. If the message is quite long, this can fill
30463 up a lot of log space when such failures are common. To reduce the size of the
30464 log message, Exim interprets the text in a special way if it starts with the
30465 two characters &`<<`& and contains &`>>`& later. The text between these two
30466 strings is written to the log, and the rest of the text is used in the bounce
30467 message. For example:
30468 .code
30469 fail "<<filter test 1>>Your message is rejected \
30470      because it contains attachments that we are \
30471      not prepared to receive."
30472 .endd
30473
30474 .cindex "loop" "caused by &%fail%&"
30475 Take great care with the &%fail%& command when basing the decision to fail on
30476 the contents of the message, because the bounce message will of course include
30477 the contents of the original message and will therefore trigger the &%fail%&
30478 command again (causing a mail loop) unless steps are taken to prevent this.
30479 Testing the &%error_message%& condition is one way to prevent this. You could
30480 use, for example
30481 .code
30482 if $message_body contains "this is spam" and not error_message
30483 then fail text "spam is not wanted here" endif
30484 .endd
30485 though of course that might let through unwanted bounce messages. The
30486 alternative is clever checking of the body and/or headers to detect bounces
30487 generated by the filter.
30488
30489 The interpretation of a system filter file ceases after a
30490 &%defer%&,
30491 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
30492 set up earlier in the filter file are honoured, so you can use a sequence such
30493 as
30494 .code
30495 mail ...
30496 freeze
30497 .endd
30498 to send a specified message when the system filter is freezing (or deferring or
30499 failing) a message. The normal deliveries for the message do not, of course,
30500 take place.
30501
30502
30503
30504 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
30505 .cindex "header lines" "adding; in system filter"
30506 .cindex "header lines" "removing; in system filter"
30507 .cindex "filter" "header lines; adding/removing"
30508 Two filter commands that are available only in system filters are:
30509 .code
30510 headers add <string>
30511 headers remove <string>
30512 .endd
30513 The argument for the &%headers add%& is a string that is expanded and then
30514 added to the end of the message's headers. It is the responsibility of the
30515 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
30516 space is ignored, and if the string is otherwise empty, or if the expansion is
30517 forced to fail, the command has no effect.
30518
30519 You can use &"\n"& within the string, followed by white space, to specify
30520 continued header lines. More than one header may be added in one command by
30521 including &"\n"& within the string without any following white space. For
30522 example:
30523 .code
30524 headers add "X-header-1: ....\n  \
30525              continuation of X-header-1 ...\n\
30526              X-header-2: ...."
30527 .endd
30528 Note that the header line continuation white space after the first newline must
30529 be placed before the backslash that continues the input string, because white
30530 space after input continuations is ignored.
30531
30532 The argument for &%headers remove%& is a colon-separated list of header names.
30533 This command applies only to those headers that are stored with the message;
30534 those that are added at delivery time (such as &'Envelope-To:'& and
30535 &'Return-Path:'&) cannot be removed by this means. If there is more than one
30536 header with the same name, they are all removed.
30537
30538 The &%headers%& command in a system filter makes an immediate change to the set
30539 of header lines that was received with the message (with possible additions
30540 from ACL processing). Subsequent commands in the system filter operate on the
30541 modified set, which also forms the basis for subsequent message delivery.
30542 Unless further modified during routing or transporting, this set of headers is
30543 used for all recipients of the message.
30544
30545 During routing and transporting, the variables that refer to the contents of
30546 header lines refer only to those lines that are in this set. Thus, header lines
30547 that are added by a system filter are visible to users' filter files and to all
30548 routers and transports. This contrasts with the manipulation of header lines by
30549 routers and transports, which is not immediate, but which instead is saved up
30550 until the message is actually being written (see section
30551 &<<SECTheadersaddrem>>&).
30552
30553 If the message is not delivered at the first attempt, header lines that were
30554 added by the system filter are stored with the message, and so are still
30555 present at the next delivery attempt. Header lines that were removed are still
30556 present, but marked &"deleted"& so that they are not transported with the
30557 message. For this reason, it is usual to make the &%headers%& command
30558 conditional on &%first_delivery%& so that the set of header lines is not
30559 modified more than once.
30560
30561 Because header modification in a system filter acts immediately, you have to
30562 use an indirect approach if you want to modify the contents of a header line.
30563 For example:
30564 .code
30565 headers add "Old-Subject: $h_subject:"
30566 headers remove "Subject"
30567 headers add "Subject: new subject (was: $h_old-subject:)"
30568 headers remove "Old-Subject"
30569 .endd
30570
30571
30572
30573 .section "Setting an errors address in a system filter" "SECID217"
30574 .cindex "envelope sender"
30575 In a system filter, if a &%deliver%& command is followed by
30576 .code
30577 errors_to <some address>
30578 .endd
30579 in order to change the envelope sender (and hence the error reporting) for that
30580 delivery, any address may be specified. (In a user filter, only the current
30581 user's address can be set.) For example, if some mail is being monitored, you
30582 might use
30583 .code
30584 unseen deliver monitor@spying.example errors_to root@local.example
30585 .endd
30586 to take a copy which would not be sent back to the normal error reporting
30587 address if its delivery failed.
30588
30589
30590
30591 .section "Per-address filtering" "SECTperaddfil"
30592 .vindex "&$domain$&"
30593 .vindex "&$local_part$&"
30594 In contrast to the system filter, which is run just once per message for each
30595 delivery attempt, it is also possible to set up a system-wide filtering
30596 operation that runs once for each recipient address. In this case, variables
30597 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
30598 filter file could be made dependent on them. This is an example of a router
30599 which implements such a filter:
30600 .code
30601 central_filter:
30602   check_local_user
30603   driver = redirect
30604   domains = +local_domains
30605   file = /central/filters/$local_part
30606   no_verify
30607   allow_filter
30608   allow_freeze
30609 .endd
30610 The filter is run in a separate process under its own uid. Therefore, either
30611 &%check_local_user%& must be set (as above), in which case the filter is run as
30612 the local user, or the &%user%& option must be used to specify which user to
30613 use. If both are set, &%user%& overrides.
30614
30615 Care should be taken to ensure that none of the commands in the filter file
30616 specify a significant delivery if the message is to go on to be delivered to
30617 its intended recipient. The router will not then claim to have dealt with the
30618 address, so it will be passed on to subsequent routers to be delivered in the
30619 normal way.
30620 .ecindex IIDsysfil1
30621 .ecindex IIDsysfil2
30622 .ecindex IIDsysfil3
30623
30624
30625
30626
30627
30628
30629 . ////////////////////////////////////////////////////////////////////////////
30630 . ////////////////////////////////////////////////////////////////////////////
30631
30632 .chapter "Message processing" "CHAPmsgproc"
30633 .scindex IIDmesproc "message" "general processing"
30634 Exim performs various transformations on the sender and recipient addresses of
30635 all messages that it handles, and also on the messages' header lines. Some of
30636 these are optional and configurable, while others always take place. All of
30637 this processing, except rewriting as a result of routing, and the addition or
30638 removal of header lines while delivering, happens when a message is received,
30639 before it is placed on Exim's queue.
30640
30641 Some of the automatic processing takes place by default only for
30642 &"locally-originated"& messages. This adjective is used to describe messages
30643 that are not received over TCP/IP, but instead are passed to an Exim process on
30644 its standard input. This includes the interactive &"local SMTP"& case that is
30645 set up by the &%-bs%& command line option.
30646
30647 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
30648 or ::1) are not considered to be locally-originated. Exim does not treat the
30649 loopback interface specially in any way.
30650
30651 If you want the loopback interface to be treated specially, you must ensure
30652 that there are appropriate entries in your ACLs.
30653
30654
30655
30656
30657 .section "Submission mode for non-local messages" "SECTsubmodnon"
30658 .cindex "message" "submission"
30659 .cindex "submission mode"
30660 Processing that happens automatically for locally-originated messages (unless
30661 &%suppress_local_fixups%& is set) can also be requested for messages that are
30662 received over TCP/IP. The term &"submission mode"& is used to describe this
30663 state. Submission mode is set by the modifier
30664 .code
30665 control = submission
30666 .endd
30667 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
30668 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
30669 a local submission, and is normally used when the source of the message is
30670 known to be an MUA running on a client host (as opposed to an MTA). For
30671 example, to set submission mode for messages originating on the IPv4 loopback
30672 interface, you could include the following in the MAIL ACL:
30673 .code
30674 warn  hosts = 127.0.0.1
30675       control = submission
30676 .endd
30677 .cindex "&%sender_retain%& submission option"
30678 There are some options that can be used when setting submission mode. A slash
30679 is used to separate options. For example:
30680 .code
30681 control = submission/sender_retain
30682 .endd
30683 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
30684 true and &%local_from_check%& false for the current incoming message. The first
30685 of these allows an existing &'Sender:'& header in the message to remain, and
30686 the second suppresses the check to ensure that &'From:'& matches the
30687 authenticated sender. With this setting, Exim still fixes up messages by adding
30688 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
30689 attempt to check sender authenticity in header lines.
30690
30691 When &%sender_retain%& is not set, a submission mode setting may specify a
30692 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
30693 example:
30694 .code
30695 control = submission/domain=some.domain
30696 .endd
30697 The domain may be empty. How this value is used is described in sections
30698 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
30699 that allows you to specify the user's full name for inclusion in a created
30700 &'Sender:'& or &'From:'& header line. For example:
30701 .code
30702 accept authenticated = *
30703        control = submission/domain=wonderland.example/\
30704                             name=${lookup {$authenticated_id} \
30705                                    lsearch {/etc/exim/namelist}}
30706 .endd
30707 Because the name may contain any characters, including slashes, the &%name%&
30708 option must be given last. The remainder of the string is used as the name. For
30709 the example above, if &_/etc/exim/namelist_& contains:
30710 .code
30711 bigegg:  Humpty Dumpty
30712 .endd
30713 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
30714 line would be:
30715 .code
30716 Sender: Humpty Dumpty <bigegg@wonderland.example>
30717 .endd
30718 .cindex "return path" "in submission mode"
30719 By default, submission mode forces the return path to the same address as is
30720 used to create the &'Sender:'& header. However, if &%sender_retain%& is
30721 specified, the return path is also left unchanged.
30722
30723 &*Note*&: The changes caused by submission mode take effect after the predata
30724 ACL. This means that any sender checks performed before the fix-ups use the
30725 untrusted sender address specified by the user, not the trusted sender address
30726 specified by submission mode. Although this might be slightly unexpected, it
30727 does mean that you can configure ACL checks to spot that a user is trying to
30728 spoof another's address.
30729
30730 .section "Line endings" "SECTlineendings"
30731 .cindex "line endings"
30732 .cindex "carriage return"
30733 .cindex "linefeed"
30734 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
30735 linefeed) is the line ending for messages transmitted over the Internet using
30736 SMTP over TCP/IP. However, within individual operating systems, different
30737 conventions are used. For example, Unix-like systems use just LF, but others
30738 use CRLF or just CR.
30739
30740 Exim was designed for Unix-like systems, and internally, it stores messages
30741 using the system's convention of a single LF as a line terminator. When
30742 receiving a message, all line endings are translated to this standard format.
30743 Originally, it was thought that programs that passed messages directly to an
30744 MTA within an operating system would use that system's convention. Experience
30745 has shown that this is not the case; for example, there are Unix applications
30746 that use CRLF in this circumstance. For this reason, and for compatibility with
30747 other MTAs, the way Exim handles line endings for all messages is now as
30748 follows:
30749
30750 .ilist
30751 LF not preceded by CR is treated as a line ending.
30752 .next
30753 CR is treated as a line ending; if it is immediately followed by LF, the LF
30754 is ignored.
30755 .next
30756 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
30757 nor a local message in the state where a line containing only a dot is a
30758 terminator.
30759 .next
30760 If a bare CR is encountered within a header line, an extra space is added after
30761 the line terminator so as not to end the header line. The reasoning behind this
30762 is that bare CRs in header lines are most likely either to be mistakes, or
30763 people trying to play silly games.
30764 .next
30765 If the first header line received in a message ends with CRLF, a subsequent
30766 bare LF in a header line is treated in the same way as a bare CR in a header
30767 line.
30768 .endlist
30769
30770
30771
30772
30773
30774 .section "Unqualified addresses" "SECID218"
30775 .cindex "unqualified addresses"
30776 .cindex "address" "qualification"
30777 By default, Exim expects every envelope address it receives from an external
30778 host to be fully qualified. Unqualified addresses cause negative responses to
30779 SMTP commands. However, because SMTP is used as a means of transporting
30780 messages from MUAs running on personal workstations, there is sometimes a
30781 requirement to accept unqualified addresses from specific hosts or IP networks.
30782
30783 Exim has two options that separately control which hosts may send unqualified
30784 sender or recipient addresses in SMTP commands, namely
30785 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
30786 cases, if an unqualified address is accepted, it is qualified by adding the
30787 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
30788
30789 .oindex "&%qualify_domain%&"
30790 .oindex "&%qualify_recipient%&"
30791 Unqualified addresses in header lines are automatically qualified for messages
30792 that are locally originated, unless the &%-bnq%& option is given on the command
30793 line. For messages received over SMTP, unqualified addresses in header lines
30794 are qualified only if unqualified addresses are permitted in SMTP commands. In
30795 other words, such qualification is also controlled by
30796 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
30797
30798
30799
30800
30801 .section "The UUCP From line" "SECID219"
30802 .cindex "&""From""& line"
30803 .cindex "UUCP" "&""From""& line"
30804 .cindex "sender" "address"
30805 .oindex "&%uucp_from_pattern%&"
30806 .oindex "&%uucp_from_sender%&"
30807 .cindex "envelope sender"
30808 .cindex "Sendmail compatibility" "&""From""& line"
30809 Messages that have come from UUCP (and some other applications) often begin
30810 with a line containing the envelope sender and a timestamp, following the word
30811 &"From"&. Examples of two common formats are:
30812 .code
30813 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
30814 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
30815 .endd
30816 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
30817 Exim recognizes such lines at the start of messages that are submitted to it
30818 via the command line (that is, on the standard input). It does not recognize
30819 such lines in incoming SMTP messages, unless the sending host matches
30820 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
30821 and &%ignore_fromline_local%& is set. The recognition is controlled by a
30822 regular expression that is defined by the &%uucp_from_pattern%& option, whose
30823 default value matches the two common cases shown above and puts the address
30824 that follows &"From"& into &$1$&.
30825
30826 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
30827 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
30828 a trusted user, the message's sender address is constructed by expanding the
30829 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
30830 then parsed as an RFC 2822 address. If there is no domain, the local part is
30831 qualified with &%qualify_domain%& unless it is the empty string. However, if
30832 the command line &%-f%& option is used, it overrides the &"From"& line.
30833
30834 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
30835 sender address is not changed. This is also the case for incoming SMTP messages
30836 that are permitted to contain &"From"& lines.
30837
30838 Only one &"From"& line is recognized. If there is more than one, the second is
30839 treated as a data line that starts the body of the message, as it is not valid
30840 as a header line. This also happens if a &"From"& line is present in an
30841 incoming SMTP message from a source that is not permitted to send them.
30842
30843
30844
30845 .section "Resent- header lines" "SECID220"
30846 .cindex "&%Resent-%& header lines"
30847 RFC 2822 makes provision for sets of header lines starting with the string
30848 &`Resent-`& to be added to a message when it is resent by the original
30849 recipient to somebody else. These headers are &'Resent-Date:'&,
30850 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
30851 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
30852
30853 .blockquote
30854 &'Resent fields are strictly informational. They MUST NOT be used in the normal
30855 processing of replies or other such automatic actions on messages.'&
30856 .endblockquote
30857
30858 This leaves things a bit vague as far as other processing actions such as
30859 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30860 follows:
30861
30862 .ilist
30863 A &'Resent-From:'& line that just contains the login id of the submitting user
30864 is automatically rewritten in the same way as &'From:'& (see below).
30865 .next
30866 If there's a rewriting rule for a particular header line, it is also applied to
30867 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30868 &'From:'& also rewrites &'Resent-From:'&.
30869 .next
30870 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30871 also removed.
30872 .next
30873 For a locally-submitted message,
30874 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30875 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30876 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30877 included in log lines in this case.
30878 .next
30879 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30880 &%Resent-%& header lines are present.
30881 .endlist
30882
30883
30884
30885
30886 .section "The Auto-Submitted: header line" "SECID221"
30887 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30888 includes the header line:
30889 .code
30890 Auto-Submitted: auto-replied
30891 .endd
30892
30893 .section "The Bcc: header line" "SECID222"
30894 .cindex "&'Bcc:'& header line"
30895 If Exim is called with the &%-t%& option, to take recipient addresses from a
30896 message's header, it removes any &'Bcc:'& header line that may exist (after
30897 extracting its addresses). If &%-t%& is not present on the command line, any
30898 existing &'Bcc:'& is not removed.
30899
30900
30901 .section "The Date: header line" "SECID223"
30902 .cindex "&'Date:'& header line"
30903 If a locally-generated or submission-mode message has no &'Date:'& header line,
30904 Exim adds one, using the current date and time, unless the
30905 &%suppress_local_fixups%& control has been specified.
30906
30907 .section "The Delivery-date: header line" "SECID224"
30908 .cindex "&'Delivery-date:'& header line"
30909 .oindex "&%delivery_date_remove%&"
30910 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30911 set. Exim can be configured to add them to the final delivery of messages. (See
30912 the generic &%delivery_date_add%& transport option.) They should not be present
30913 in messages in transit. If the &%delivery_date_remove%& configuration option is
30914 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30915 messages.
30916
30917
30918 .section "The Envelope-to: header line" "SECID225"
30919 .cindex "&'Envelope-to:'& header line"
30920 .oindex "&%envelope_to_remove%&"
30921 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30922 Exim can be configured to add them to the final delivery of messages. (See the
30923 generic &%envelope_to_add%& transport option.) They should not be present in
30924 messages in transit. If the &%envelope_to_remove%& configuration option is set
30925 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30926 messages.
30927
30928
30929 .section "The From: header line" "SECTthefrohea"
30930 .cindex "&'From:'& header line"
30931 .cindex "Sendmail compatibility" "&""From""& line"
30932 .cindex "message" "submission"
30933 .cindex "submission mode"
30934 If a submission-mode message does not contain a &'From:'& header line, Exim
30935 adds one if either of the following conditions is true:
30936
30937 .ilist
30938 The envelope sender address is not empty (that is, this is not a bounce
30939 message). The added header line copies the envelope sender address.
30940 .next
30941 .vindex "&$authenticated_id$&"
30942 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30943 .olist
30944 .vindex "&$qualify_domain$&"
30945 If no domain is specified by the submission control, the local part is
30946 &$authenticated_id$& and the domain is &$qualify_domain$&.
30947 .next
30948 If a non-empty domain is specified by the submission control, the local
30949 part is &$authenticated_id$&, and the domain is the specified domain.
30950 .next
30951 If an empty domain is specified by the submission control,
30952 &$authenticated_id$& is assumed to be the complete address.
30953 .endlist
30954 .endlist
30955
30956 A non-empty envelope sender takes precedence.
30957
30958 If a locally-generated incoming message does not contain a &'From:'& header
30959 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30960 containing the sender's address. The calling user's login name and full name
30961 are used to construct the address, as described in section &<<SECTconstr>>&.
30962 They are obtained from the password data by calling &[getpwuid()]& (but see the
30963 &%unknown_login%& configuration option). The address is qualified with
30964 &%qualify_domain%&.
30965
30966 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30967 &'From:'& header line containing just the unqualified login name of the calling
30968 user, this is replaced by an address containing the user's login name and full
30969 name as described in section &<<SECTconstr>>&.
30970
30971
30972 .section "The Message-ID: header line" "SECID226"
30973 .cindex "&'Message-ID:'& header line"
30974 .cindex "message" "submission"
30975 .oindex "&%message_id_header_text%&"
30976 If a locally-generated or submission-mode incoming message does not contain a
30977 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30978 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30979 to the message. If there are any &'Resent-:'& headers in the message, it
30980 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30981 message id, preceded by the letter E to ensure it starts with a letter, and
30982 followed by @ and the primary host name. Additional information can be included
30983 in this header line by setting the &%message_id_header_text%& and/or
30984 &%message_id_header_domain%& options.
30985
30986
30987 .section "The Received: header line" "SECID227"
30988 .cindex "&'Received:'& header line"
30989 A &'Received:'& header line is added at the start of every message. The
30990 contents are defined by the &%received_header_text%& configuration option, and
30991 Exim automatically adds a semicolon and a timestamp to the configured string.
30992
30993 The &'Received:'& header is generated as soon as the message's header lines
30994 have been received. At this stage, the timestamp in the &'Received:'& header
30995 line is the time that the message started to be received. This is the value
30996 that is seen by the DATA ACL and by the &[local_scan()]& function.
30997
30998 Once a message is accepted, the timestamp in the &'Received:'& header line is
30999 changed to the time of acceptance, which is (apart from a small delay while the
31000 -H spool file is written) the earliest time at which delivery could start.
31001
31002
31003 .section "The References: header line" "SECID228"
31004 .cindex "&'References:'& header line"
31005 Messages created by the &(autoreply)& transport include a &'References:'&
31006 header line. This is constructed according to the rules that are described in
31007 section 3.64 of RFC 2822 (which states that replies should contain such a
31008 header line), and section 3.14 of RFC 3834 (which states that automatic
31009 responses are not different in this respect). However, because some mail
31010 processing software does not cope well with very long header lines, no more
31011 than 12 message IDs are copied from the &'References:'& header line in the
31012 incoming message. If there are more than 12, the first one and then the final
31013 11 are copied, before adding the message ID of the incoming message.
31014
31015
31016
31017 .section "The Return-path: header line" "SECID229"
31018 .cindex "&'Return-path:'& header line"
31019 .oindex "&%return_path_remove%&"
31020 &'Return-path:'& header lines are defined as something an MTA may insert when
31021 it does the final delivery of messages. (See the generic &%return_path_add%&
31022 transport option.) Therefore, they should not be present in messages in
31023 transit. If the &%return_path_remove%& configuration option is set (the
31024 default), Exim removes &'Return-path:'& header lines from incoming messages.
31025
31026
31027
31028 .section "The Sender: header line" "SECTthesenhea"
31029 .cindex "&'Sender:'& header line"
31030 .cindex "message" "submission"
31031 For a locally-originated message from an untrusted user, Exim may remove an
31032 existing &'Sender:'& header line, and it may add a new one. You can modify
31033 these actions by setting the &%local_sender_retain%& option true, the
31034 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31035 control setting.
31036
31037 When a local message is received from an untrusted user and
31038 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31039 control has not been set, a check is made to see if the address given in the
31040 &'From:'& header line is the correct (local) sender of the message. The address
31041 that is expected has the login name as the local part and the value of
31042 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31043 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31044 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31045 line is added to the message.
31046
31047 If you set &%local_from_check%& false, this checking does not occur. However,
31048 the removal of an existing &'Sender:'& line still happens, unless you also set
31049 &%local_sender_retain%& to be true. It is not possible to set both of these
31050 options true at the same time.
31051
31052 .cindex "submission mode"
31053 By default, no processing of &'Sender:'& header lines is done for messages
31054 received over TCP/IP or for messages submitted by trusted users. However, when
31055 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31056 not specified on the submission control, the following processing takes place:
31057
31058 .vindex "&$authenticated_id$&"
31059 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31060 authenticated, and &$authenticated_id$& is not empty, a sender address is
31061 created as follows:
31062
31063 .ilist
31064 .vindex "&$qualify_domain$&"
31065 If no domain is specified by the submission control, the local part is
31066 &$authenticated_id$& and the domain is &$qualify_domain$&.
31067 .next
31068 If a non-empty domain is specified by the submission control, the local part
31069 is &$authenticated_id$&, and the domain is the specified domain.
31070 .next
31071 If an empty domain is specified by the submission control,
31072 &$authenticated_id$& is assumed to be the complete address.
31073 .endlist
31074
31075 This address is compared with the address in the &'From:'& header line. If they
31076 are different, a &'Sender:'& header line containing the created address is
31077 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31078 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31079
31080 .cindex "return path" "created from &'Sender:'&"
31081 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31082 the message (the envelope sender address) is changed to be the same address,
31083 except in the case of submission mode when &%sender_retain%& is specified.
31084
31085
31086
31087 .section "Adding and removing header lines in routers and transports" &&&
31088          "SECTheadersaddrem"
31089 .cindex "header lines" "adding; in router or transport"
31090 .cindex "header lines" "removing; in router or transport"
31091 When a message is delivered, the addition and removal of header lines can be
31092 specified in a system filter, or on any of the routers and transports that
31093 process the message. Section &<<SECTaddremheasys>>& contains details about
31094 modifying headers in a system filter. Header lines can also be added in an ACL
31095 as a message is received (see section &<<SECTaddheadacl>>&).
31096
31097 In contrast to what happens in a system filter, header modifications that are
31098 specified on routers and transports apply only to the particular recipient
31099 addresses that are being processed by those routers and transports. These
31100 changes do not actually take place until a copy of the message is being
31101 transported. Therefore, they do not affect the basic set of header lines, and
31102 they do not affect the values of the variables that refer to header lines.
31103
31104 &*Note*&: In particular, this means that any expansions in the configuration of
31105 the transport cannot refer to the modified header lines, because such
31106 expansions all occur before the message is actually transported.
31107
31108 For both routers and transports, the result of expanding a &%headers_add%&
31109 option must be in the form of one or more RFC 2822 header lines, separated by
31110 newlines (coded as &"\n"&). For example:
31111 .code
31112 headers_add = X-added-header: added by $primary_hostname\n\
31113               X-added-second: another added header line
31114 .endd
31115 Exim does not check the syntax of these added header lines.
31116
31117 The result of expanding &%headers_remove%& must consist of a colon-separated
31118 list of header names. This is confusing, because header names themselves are
31119 often terminated by colons. In this case, the colons are the list separators,
31120 not part of the names. For example:
31121 .code
31122 headers_remove = return-receipt-to:acknowledge-to
31123 .endd
31124 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31125 is expanded at routing time, and then associated with all addresses that are
31126 accepted by that router, and also with any new addresses that it generates. If
31127 an address passes through several routers as a result of aliasing or
31128 forwarding, the changes are cumulative.
31129
31130 .oindex "&%unseen%&"
31131 However, this does not apply to multiple routers that result from the use of
31132 the &%unseen%& option. Any header modifications that were specified by the
31133 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31134
31135 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31136 settings cannot be delivered together in a batch, so a transport is always
31137 dealing with a set of addresses that have the same header-processing
31138 requirements.
31139
31140 The transport starts by writing the original set of header lines that arrived
31141 with the message, possibly modified by the system filter. As it writes out
31142 these lines, it consults the list of header names that were attached to the
31143 recipient address(es) by &%headers_remove%& options in routers, and it also
31144 consults the transport's own &%headers_remove%& option. Header lines whose
31145 names are on either of these lists are not written out. If there are multiple
31146 instances of any listed header, they are all skipped.
31147
31148 After the remaining original header lines have been written, new header
31149 lines that were specified by routers' &%headers_add%& options are written, in
31150 the order in which they were attached to the address. These are followed by any
31151 header lines specified by the transport's &%headers_add%& option.
31152
31153 This way of handling header line modifications in routers and transports has
31154 the following consequences:
31155
31156 .ilist
31157 The original set of header lines, possibly modified by the system filter,
31158 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31159 to it, at all times.
31160 .next
31161 Header lines that are added by a router's
31162 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31163 expansion syntax in subsequent routers or the transport.
31164 .next
31165 Conversely, header lines that are specified for removal by &%headers_remove%&
31166 in a router remain visible to subsequent routers and the transport.
31167 .next
31168 Headers added to an address by &%headers_add%& in a router cannot be removed by
31169 a later router or by a transport.
31170 .next
31171 An added header can refer to the contents of an original header that is to be
31172 removed, even it has the same name as the added header. For example:
31173 .code
31174 headers_remove = subject
31175 headers_add = Subject: new subject (was: $h_subject:)
31176 .endd
31177 .endlist
31178
31179 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31180 for a &(redirect)& router that has the &%one_time%& option set.
31181
31182
31183
31184
31185
31186 .section "Constructed addresses" "SECTconstr"
31187 .cindex "address" "constructed"
31188 .cindex "constructed address"
31189 When Exim constructs a sender address for a locally-generated message, it uses
31190 the form
31191 .display
31192 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31193 .endd
31194 For example:
31195 .code
31196 Zaphod Beeblebrox <zaphod@end.univ.example>
31197 .endd
31198 The user name is obtained from the &%-F%& command line option if set, or
31199 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31200 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31201 ampersand character, this is replaced by the login name with the first letter
31202 upper cased, as is conventional in a number of operating systems. See the
31203 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31204 The &%unknown_username%& option can be used to specify user names in cases when
31205 there is no password file entry.
31206
31207 .cindex "RFC 2047"
31208 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31209 parts of it if necessary. In addition, if it contains any non-printing
31210 characters, it is encoded as described in RFC 2047, which defines a way of
31211 including non-ASCII characters in header lines. The value of the
31212 &%headers_charset%& option specifies the name of the encoding that is used (the
31213 characters are assumed to be in this encoding). The setting of
31214 &%print_topbitchars%& controls whether characters with the top bit set (that
31215 is, with codes greater than 127) count as printing characters or not.
31216
31217
31218
31219 .section "Case of local parts" "SECID230"
31220 .cindex "case of local parts"
31221 .cindex "local part" "case of"
31222 RFC 2822 states that the case of letters in the local parts of addresses cannot
31223 be assumed to be non-significant. Exim preserves the case of local parts of
31224 addresses, but by default it uses a lower-cased form when it is routing,
31225 because on most Unix systems, usernames are in lower case and case-insensitive
31226 routing is required. However, any particular router can be made to use the
31227 original case for local parts by setting the &%caseful_local_part%& generic
31228 router option.
31229
31230 .cindex "mixed-case login names"
31231 If you must have mixed-case user names on your system, the best way to proceed,
31232 assuming you want case-independent handling of incoming email, is to set up
31233 your first router to convert incoming local parts in your domains to the
31234 correct case by means of a file lookup. For example:
31235 .code
31236 correct_case:
31237   driver = redirect
31238   domains = +local_domains
31239   data = ${lookup{$local_part}cdb\
31240               {/etc/usercased.cdb}{$value}fail}\
31241               @$domain
31242 .endd
31243 For this router, the local part is forced to lower case by the default action
31244 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31245 up a new local part in the correct case. If you then set &%caseful_local_part%&
31246 on any subsequent routers which process your domains, they will operate on
31247 local parts with the correct case in a case-sensitive manner.
31248
31249
31250
31251 .section "Dots in local parts" "SECID231"
31252 .cindex "dot" "in local part"
31253 .cindex "local part" "dots in"
31254 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31255 part may not begin or end with a dot, nor have two consecutive dots in the
31256 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31257 empty components for compatibility.
31258
31259
31260
31261 .section "Rewriting addresses" "SECID232"
31262 .cindex "rewriting" "addresses"
31263 Rewriting of sender and recipient addresses, and addresses in headers, can
31264 happen automatically, or as the result of configuration options, as described
31265 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31266 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31267
31268 Automatic rewriting includes qualification, as mentioned above. The other case
31269 in which it can happen is when an incomplete non-local domain is given. The
31270 routing process may cause this to be expanded into the full domain name. For
31271 example, a header such as
31272 .code
31273 To: hare@teaparty
31274 .endd
31275 might get rewritten as
31276 .code
31277 To: hare@teaparty.wonderland.fict.example
31278 .endd
31279 Rewriting as a result of routing is the one kind of message processing that
31280 does not happen at input time, as it cannot be done until the address has
31281 been routed.
31282
31283 Strictly, one should not do &'any'& deliveries of a message until all its
31284 addresses have been routed, in case any of the headers get changed as a
31285 result of routing. However, doing this in practice would hold up many
31286 deliveries for unreasonable amounts of time, just because one address could not
31287 immediately be routed. Exim therefore does not delay other deliveries when
31288 routing of one or more addresses is deferred.
31289 .ecindex IIDmesproc
31290
31291
31292
31293 . ////////////////////////////////////////////////////////////////////////////
31294 . ////////////////////////////////////////////////////////////////////////////
31295
31296 .chapter "SMTP processing" "CHAPSMTP"
31297 .scindex IIDsmtpproc1 "SMTP" "processing details"
31298 .scindex IIDsmtpproc2 "LMTP" "processing details"
31299 Exim supports a number of different ways of using the SMTP protocol, and its
31300 LMTP variant, which is an interactive protocol for transferring messages into a
31301 closed mail store application. This chapter contains details of how SMTP is
31302 processed. For incoming mail, the following are available:
31303
31304 .ilist
31305 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31306 .next
31307 SMTP over the standard input and output (the &%-bs%& option);
31308 .next
31309 Batched SMTP on the standard input (the &%-bS%& option).
31310 .endlist
31311
31312 For mail delivery, the following are available:
31313
31314 .ilist
31315 SMTP over TCP/IP (the &(smtp)& transport);
31316 .next
31317 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31318 &"lmtp"&);
31319 .next
31320 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31321 transport);
31322 .next
31323 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31324 the &%use_bsmtp%& option set).
31325 .endlist
31326
31327 &'Batched SMTP'& is the name for a process in which batches of messages are
31328 stored in or read from files (or pipes), in a format in which SMTP commands are
31329 used to contain the envelope information.
31330
31331
31332
31333 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
31334 .cindex "SMTP" "outgoing over TCP/IP"
31335 .cindex "outgoing SMTP over TCP/IP"
31336 .cindex "LMTP" "over TCP/IP"
31337 .cindex "outgoing LMTP over TCP/IP"
31338 .cindex "EHLO"
31339 .cindex "HELO"
31340 .cindex "SIZE option on MAIL command"
31341 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
31342 The &%protocol%& option selects which protocol is to be used, but the actual
31343 processing is the same in both cases.
31344
31345 If, in response to its EHLO command, Exim is told that the SIZE
31346 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
31347 command. The value of <&'n'&> is the message size plus the value of the
31348 &%size_addition%& option (default 1024) to allow for additions to the message
31349 such as per-transport header lines, or changes made in a
31350 .cindex "transport" "filter"
31351 .cindex "filter" "transport filter"
31352 transport filter. If &%size_addition%& is set negative, the use of SIZE is
31353 suppressed.
31354
31355 If the remote server advertises support for PIPELINING, Exim uses the
31356 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
31357 required for the transaction.
31358
31359 If the remote server advertises support for the STARTTLS command, and Exim
31360 was built to support TLS encryption, it tries to start a TLS session unless the
31361 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
31362
31363 If the remote server advertises support for the AUTH command, Exim scans
31364 the authenticators configuration for any suitable client settings, as described
31365 in chapter &<<CHAPSMTPAUTH>>&.
31366
31367 .cindex "carriage return"
31368 .cindex "linefeed"
31369 Responses from the remote host are supposed to be terminated by CR followed by
31370 LF. However, there are known to be hosts that do not send CR characters, so in
31371 order to be able to interwork with such hosts, Exim treats LF on its own as a
31372 line terminator.
31373
31374 If a message contains a number of different addresses, all those with the same
31375 characteristics (for example, the same envelope sender) that resolve to the
31376 same set of hosts, in the same order, are sent in a single SMTP transaction,
31377 even if they are for different domains, unless there are more than the setting
31378 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
31379 they are split into groups containing no more than &%max_rcpt%&s addresses
31380 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
31381 in parallel sessions. The order of hosts with identical MX values is not
31382 significant when checking whether addresses can be batched in this way.
31383
31384 When the &(smtp)& transport suffers a temporary failure that is not
31385 message-related, Exim updates its transport-specific database, which contains
31386 records indexed by host name that remember which messages are waiting for each
31387 particular host. It also updates the retry database with new retry times.
31388
31389 .cindex "hints database" "retry keys"
31390 Exim's retry hints are based on host name plus IP address, so if one address of
31391 a multi-homed host is broken, it will soon be skipped most of the time.
31392 See the next section for more detail about error handling.
31393
31394 .cindex "SMTP" "passed connection"
31395 .cindex "SMTP" "batching over TCP/IP"
31396 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
31397 looks in the hints database for the transport to see if there are any queued
31398 messages waiting for the host to which it is connected. If it finds one, it
31399 creates a new Exim process using the &%-MC%& option (which can only be used by
31400 a process running as root or the Exim user) and passes the TCP/IP socket to it
31401 so that it can deliver another message using the same socket. The new process
31402 does only those deliveries that are routed to the connected host, and may in
31403 turn pass the socket on to a third process, and so on.
31404
31405 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
31406 limit the number of messages sent down a single TCP/IP connection.
31407
31408 .cindex "asterisk" "after IP address"
31409 The second and subsequent messages delivered down an existing connection are
31410 identified in the main log by the addition of an asterisk after the closing
31411 square bracket of the IP address.
31412
31413
31414
31415
31416 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
31417 .cindex "error" "in outgoing SMTP"
31418 .cindex "SMTP" "errors in outgoing"
31419 .cindex "host" "error"
31420 Three different kinds of error are recognized for outgoing SMTP: host errors,
31421 message errors, and recipient errors.
31422
31423 .vlist
31424 .vitem "&*Host errors*&"
31425 A host error is not associated with a particular message or with a
31426 particular recipient of a message. The host errors are:
31427
31428 .ilist
31429 Connection refused or timed out,
31430 .next
31431 Any error response code on connection,
31432 .next
31433 Any error response code to EHLO or HELO,
31434 .next
31435 Loss of connection at any time, except after &"."&,
31436 .next
31437 I/O errors at any time,
31438 .next
31439 Timeouts during the session, other than in response to MAIL, RCPT or
31440 the &"."& at the end of the data.
31441 .endlist ilist
31442
31443 For a host error, a permanent error response on connection, or in response to
31444 EHLO, causes all addresses routed to the host to be failed. Any other host
31445 error causes all addresses to be deferred, and retry data to be created for the
31446 host. It is not tried again, for any message, until its retry time arrives. If
31447 the current set of addresses are not all delivered in this run (to some
31448 alternative host), the message is added to the list of those waiting for this
31449 host, so if it is still undelivered when a subsequent successful delivery is
31450 made to the host, it will be sent down the same SMTP connection.
31451
31452 .vitem "&*Message errors*&"
31453 .cindex "message" "error"
31454 A message error is associated with a particular message when sent to a
31455 particular host, but not with a particular recipient of the message. The
31456 message errors are:
31457
31458 .ilist
31459 Any error response code to MAIL, DATA, or the &"."& that terminates
31460 the data,
31461 .next
31462 Timeout after MAIL,
31463 .next
31464 Timeout or loss of connection after the &"."& that terminates the data. A
31465 timeout after the DATA command itself is treated as a host error, as is loss of
31466 connection at any other time.
31467 .endlist ilist
31468
31469 For a message error, a permanent error response (5&'xx'&) causes all addresses
31470 to be failed, and a delivery error report to be returned to the sender. A
31471 temporary error response (4&'xx'&), or one of the timeouts, causes all
31472 addresses to be deferred. Retry data is not created for the host, but instead,
31473 a retry record for the combination of host plus message id is created. The
31474 message is not added to the list of those waiting for this host. This ensures
31475 that the failing message will not be sent to this host again until the retry
31476 time arrives. However, other messages that are routed to the host are not
31477 affected, so if it is some property of the message that is causing the error,
31478 it will not stop the delivery of other mail.
31479
31480 If the remote host specified support for the SIZE parameter in its response
31481 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
31482 over-large message will cause a message error because the error arrives as a
31483 response to MAIL.
31484
31485 .vitem "&*Recipient errors*&"
31486 .cindex "recipient" "error"
31487 A recipient error is associated with a particular recipient of a message. The
31488 recipient errors are:
31489
31490 .ilist
31491 Any error response to RCPT,
31492 .next
31493 Timeout after RCPT.
31494 .endlist
31495
31496 For a recipient error, a permanent error response (5&'xx'&) causes the
31497 recipient address to be failed, and a bounce message to be returned to the
31498 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
31499 address to be deferred, and routing retry data to be created for it. This is
31500 used to delay processing of the address in subsequent queue runs, until its
31501 routing retry time arrives. This applies to all messages, but because it
31502 operates only in queue runs, one attempt will be made to deliver a new message
31503 to the failing address before the delay starts to operate. This ensures that,
31504 if the failure is really related to the message rather than the recipient
31505 (&"message too big for this recipient"& is a possible example), other messages
31506 have a chance of getting delivered. If a delivery to the address does succeed,
31507 the retry information gets cleared, so all stuck messages get tried again, and
31508 the retry clock is reset.
31509
31510 The message is not added to the list of those waiting for this host. Use of the
31511 host for other messages is unaffected, and except in the case of a timeout,
31512 other recipients are processed independently, and may be successfully delivered
31513 in the current SMTP session. After a timeout it is of course impossible to
31514 proceed with the session, so all addresses get deferred. However, those other
31515 than the one that failed do not suffer any subsequent retry delays. Therefore,
31516 if one recipient is causing trouble, the others have a chance of getting
31517 through when a subsequent delivery attempt occurs before the failing
31518 recipient's retry time.
31519 .endlist
31520
31521 In all cases, if there are other hosts (or IP addresses) available for the
31522 current set of addresses (for example, from multiple MX records), they are
31523 tried in this run for any undelivered addresses, subject of course to their
31524 own retry data. In other words, recipient error retry data does not take effect
31525 until the next delivery attempt.
31526
31527 Some hosts have been observed to give temporary error responses to every
31528 MAIL command at certain times (&"insufficient space"& has been seen). It
31529 would be nice if such circumstances could be recognized, and defer data for the
31530 host itself created, but this is not possible within the current Exim design.
31531 What actually happens is that retry data for every (host, message) combination
31532 is created.
31533
31534 The reason that timeouts after MAIL and RCPT are treated specially is that
31535 these can sometimes arise as a result of the remote host's verification
31536 procedures. Exim makes this assumption, and treats them as if a temporary error
31537 response had been received. A timeout after &"."& is treated specially because
31538 it is known that some broken implementations fail to recognize the end of the
31539 message if the last character of the last line is a binary zero. Thus, it is
31540 helpful to treat this case as a message error.
31541
31542 Timeouts at other times are treated as host errors, assuming a problem with the
31543 host, or the connection to it. If a timeout after MAIL, RCPT,
31544 or &"."& is really a connection problem, the assumption is that at the next try
31545 the timeout is likely to occur at some other point in the dialogue, causing it
31546 then to be treated as a host error.
31547
31548 There is experimental evidence that some MTAs drop the connection after the
31549 terminating &"."& if they do not like the contents of the message for some
31550 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
31551 should be given. That is why Exim treats this case as a message rather than a
31552 host error, in order not to delay other messages to the same host.
31553
31554
31555
31556
31557 .section "Incoming SMTP messages over TCP/IP" "SECID233"
31558 .cindex "SMTP" "incoming over TCP/IP"
31559 .cindex "incoming SMTP over TCP/IP"
31560 .cindex "inetd"
31561 .cindex "daemon"
31562 Incoming SMTP messages can be accepted in one of two ways: by running a
31563 listening daemon, or by using &'inetd'&. In the latter case, the entry in
31564 &_/etc/inetd.conf_& should be like this:
31565 .code
31566 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
31567 .endd
31568 Exim distinguishes between this case and the case of a locally running user
31569 agent using the &%-bs%& option by checking whether or not the standard input is
31570 a socket. When it is, either the port must be privileged (less than 1024), or
31571 the caller must be root or the Exim user. If any other user passes a socket
31572 with an unprivileged port number, Exim prints a message on the standard error
31573 stream and exits with an error code.
31574
31575 By default, Exim does not make a log entry when a remote host connects or
31576 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
31577 unexpected. It can be made to write such log entries by setting the
31578 &%smtp_connection%& log selector.
31579
31580 .cindex "carriage return"
31581 .cindex "linefeed"
31582 Commands from the remote host are supposed to be terminated by CR followed by
31583 LF. However, there are known to be hosts that do not send CR characters. In
31584 order to be able to interwork with such hosts, Exim treats LF on its own as a
31585 line terminator.
31586 Furthermore, because common code is used for receiving messages from all
31587 sources, a CR on its own is also interpreted as a line terminator. However, the
31588 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
31589
31590 .cindex "EHLO" "invalid data"
31591 .cindex "HELO" "invalid data"
31592 One area that sometimes gives rise to problems concerns the EHLO or
31593 HELO commands. Some clients send syntactically invalid versions of these
31594 commands, which Exim rejects by default. (This is nothing to do with verifying
31595 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
31596 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
31597 match the broken hosts that send invalid commands.
31598
31599 .cindex "SIZE option on MAIL command"
31600 .cindex "MAIL" "SIZE option"
31601 The amount of disk space available is checked whenever SIZE is received on
31602 a MAIL command, independently of whether &%message_size_limit%& or
31603 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
31604 false. A temporary error is given if there is not enough space. If
31605 &%check_spool_space%& is set, the check is for that amount of space plus the
31606 value given with SIZE, that is, it checks that the addition of the incoming
31607 message will not reduce the space below the threshold.
31608
31609 When a message is successfully received, Exim includes the local message id in
31610 its response to the final &"."& that terminates the data. If the remote host
31611 logs this text it can help with tracing what has happened to a message.
31612
31613 The Exim daemon can limit the number of simultaneous incoming connections it is
31614 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
31615 number of simultaneous incoming connections from a single remote host (see the
31616 &%smtp_accept_max_per_host%& option). Additional connection attempts are
31617 rejected using the SMTP temporary error code 421.
31618
31619 The Exim daemon does not rely on the SIGCHLD signal to detect when a
31620 subprocess has finished, as this can get lost at busy times. Instead, it looks
31621 for completed subprocesses every time it wakes up. Provided there are other
31622 things happening (new incoming calls, starts of queue runs), completed
31623 processes will be noticed and tidied away. On very quiet systems you may
31624 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
31625 it will be noticed when the daemon next wakes up.
31626
31627 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
31628 and can also be set up to reject SMTP calls from non-reserved hosts at times of
31629 high system load &-- for details see the &%smtp_accept_reserve%&,
31630 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
31631 applies in both the daemon and &'inetd'& cases.
31632
31633 Exim normally starts a delivery process for each message received, though this
31634 can be varied by means of the &%-odq%& command line option and the
31635 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
31636 number of simultaneously running delivery processes started in this way from
31637 SMTP input can be limited by the &%smtp_accept_queue%& and
31638 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
31639 subsequently received messages are just put on the input queue without starting
31640 a delivery process.
31641
31642 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
31643 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
31644 started up from the &'inetd'& daemon, because in that case each connection is
31645 handled by an entirely independent Exim process. Control by load average is,
31646 however, available with &'inetd'&.
31647
31648 Exim can be configured to verify addresses in incoming SMTP commands as they
31649 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
31650 to rewrite addresses at this time &-- before any syntax checking is done. See
31651 section &<<SECTrewriteS>>&.
31652
31653 Exim can also be configured to limit the rate at which a client host submits
31654 MAIL and RCPT commands in a single SMTP session. See the
31655 &%smtp_ratelimit_hosts%& option.
31656
31657
31658
31659 .section "Unrecognized SMTP commands" "SECID234"
31660 .cindex "SMTP" "unrecognized commands"
31661 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
31662 commands during a single SMTP connection, it drops the connection after sending
31663 the error response to the last command. The default value for
31664 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
31665 abuse that subvert web servers into making connections to SMTP ports; in these
31666 circumstances, a number of non-SMTP lines are sent first.
31667
31668
31669 .section "Syntax and protocol errors in SMTP commands" "SECID235"
31670 .cindex "SMTP" "syntax errors"
31671 .cindex "SMTP" "protocol errors"
31672 A syntax error is detected if an SMTP command is recognized, but there is
31673 something syntactically wrong with its data, for example, a malformed email
31674 address in a RCPT command. Protocol errors include invalid command
31675 sequencing such as RCPT before MAIL. If Exim receives more than
31676 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
31677 drops the connection after sending the error response to the last command. The
31678 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
31679 broken clients that loop sending bad commands (yes, it has been seen).
31680
31681
31682
31683 .section "Use of non-mail SMTP commands" "SECID236"
31684 .cindex "SMTP" "non-mail commands"
31685 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
31686 DATA. Exim counts such commands, and drops the connection if there are too
31687 many of them in a single SMTP session. This action catches some
31688 denial-of-service attempts and things like repeated failing AUTHs, or a mad
31689 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
31690 defines what &"too many"& means. Its default value is 10.
31691
31692 When a new message is expected, one occurrence of RSET is not counted. This
31693 allows a client to send one RSET between messages (this is not necessary,
31694 but some clients do it). Exim also allows one uncounted occurrence of HELO
31695 or EHLO, and one occurrence of STARTTLS between messages. After
31696 starting up a TLS session, another EHLO is expected, and so it too is not
31697 counted.
31698
31699 The first occurrence of AUTH in a connection, or immediately following
31700 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
31701 RCPT, DATA, and QUIT are counted.
31702
31703 You can control which hosts are subject to the limit set by
31704 &%smtp_accept_max_nonmail%& by setting
31705 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
31706 the limit apply to all hosts. This option means that you can exclude any
31707 specific badly-behaved hosts that you have to live with.
31708
31709
31710
31711
31712 .section "The VRFY and EXPN commands" "SECID237"
31713 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
31714 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
31715 appropriate) in order to decide whether the command should be accepted or not.
31716 If no ACL is defined, the command is rejected.
31717
31718 .cindex "VRFY" "processing"
31719 When VRFY is accepted, it runs exactly the same code as when Exim is
31720 called with the &%-bv%& option.
31721
31722 .cindex "EXPN" "processing"
31723 When EXPN is accepted, a single-level expansion of the address is done.
31724 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
31725 than a verification (the &%-bv%& option). If an unqualified local part is given
31726 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
31727 of VRFY and EXPN commands are logged on the main and reject logs, and
31728 VRFY verification failures are logged on the main log for consistency with
31729 RCPT failures.
31730
31731
31732
31733 .section "The ETRN command" "SECTETRN"
31734 .cindex "ETRN" "processing"
31735 RFC 1985 describes an SMTP command called ETRN that is designed to
31736 overcome the security problems of the TURN command (which has fallen into
31737 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
31738 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
31739 should be accepted or not. If no ACL is defined, the command is rejected.
31740
31741 The ETRN command is concerned with &"releasing"& messages that are awaiting
31742 delivery to certain hosts. As Exim does not organize its message queue by host,
31743 the only form of ETRN that is supported by default is the one where the
31744 text starts with the &"#"& prefix, in which case the remainder of the text is
31745 specific to the SMTP server. A valid ETRN command causes a run of Exim with
31746 the &%-R%& option to happen, with the remainder of the ETRN text as its
31747 argument. For example,
31748 .code
31749 ETRN #brigadoon
31750 .endd
31751 runs the command
31752 .code
31753 exim -R brigadoon
31754 .endd
31755 which causes a delivery attempt on all messages with undelivered addresses
31756 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
31757 default), Exim prevents the simultaneous execution of more than one queue run
31758 for the same argument string as a result of an ETRN command. This stops
31759 a misbehaving client from starting more than one queue runner at once.
31760
31761 .cindex "hints database" "ETRN serialization"
31762 Exim implements the serialization by means of a hints database in which a
31763 record is written whenever a process is started by ETRN, and deleted when
31764 the process completes. However, Exim does not keep the SMTP session waiting for
31765 the ETRN process to complete. Once ETRN is accepted, the client is sent
31766 a &"success"& return code. Obviously there is scope for hints records to get
31767 left lying around if there is a system or program crash. To guard against this,
31768 Exim ignores any records that are more than six hours old.
31769
31770 .oindex "&%smtp_etrn_command%&"
31771 For more control over what ETRN does, the &%smtp_etrn_command%& option can
31772 used. This specifies a command that is run whenever ETRN is received,
31773 whatever the form of its argument. For
31774 example:
31775 .code
31776 smtp_etrn_command = /etc/etrn_command $domain \
31777                     $sender_host_address
31778 .endd
31779 .vindex "&$domain$&"
31780 The string is split up into arguments which are independently expanded. The
31781 expansion variable &$domain$& is set to the argument of the ETRN command,
31782 and no syntax checking is done on the contents of this argument. Exim does not
31783 wait for the command to complete, so its status code is not checked. Exim runs
31784 under its own uid and gid when receiving incoming SMTP, so it is not possible
31785 for it to change them before running the command.
31786
31787
31788
31789 .section "Incoming local SMTP" "SECID238"
31790 .cindex "SMTP" "local incoming"
31791 Some user agents use SMTP to pass messages to their local MTA using the
31792 standard input and output, as opposed to passing the envelope on the command
31793 line and writing the message to the standard input. This is supported by the
31794 &%-bs%& option. This form of SMTP is handled in the same way as incoming
31795 messages over TCP/IP (including the use of ACLs), except that the envelope
31796 sender given in a MAIL command is ignored unless the caller is trusted. In
31797 an ACL you can detect this form of SMTP input by testing for an empty host
31798 identification. It is common to have this as the first line in the ACL that
31799 runs for RCPT commands:
31800 .code
31801 accept hosts = :
31802 .endd
31803 This accepts SMTP messages from local processes without doing any other tests.
31804
31805
31806
31807 .section "Outgoing batched SMTP" "SECTbatchSMTP"
31808 .cindex "SMTP" "batched outgoing"
31809 .cindex "batched SMTP output"
31810 Both the &(appendfile)& and &(pipe)& transports can be used for handling
31811 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
31812 be output in BSMTP format. No SMTP responses are possible for this form of
31813 delivery. All it is doing is using SMTP commands as a way of transmitting the
31814 envelope along with the message.
31815
31816 The message is written to the file or pipe preceded by the SMTP commands
31817 MAIL and RCPT, and followed by a line containing a single dot. Lines in
31818 the message that start with a dot have an extra dot added. The SMTP command
31819 HELO is not normally used. If it is required, the &%message_prefix%& option
31820 can be used to specify it.
31821
31822 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
31823 one recipient address at a time by default. However, you can arrange for them
31824 to handle several addresses at once by setting the &%batch_max%& option. When
31825 this is done for BSMTP, messages may contain multiple RCPT commands. See
31826 chapter &<<CHAPbatching>>& for more details.
31827
31828 .vindex "&$host$&"
31829 When one or more addresses are routed to a BSMTP transport by a router that
31830 sets up a host list, the name of the first host on the list is available to the
31831 transport in the variable &$host$&. Here is an example of such a transport and
31832 router:
31833 .code
31834 begin routers
31835 route_append:
31836   driver = manualroute
31837   transport = smtp_appendfile
31838   route_list = domain.example  batch.host.example
31839
31840 begin transports
31841 smtp_appendfile:
31842   driver = appendfile
31843   directory = /var/bsmtp/$host
31844   batch_max = 1000
31845   use_bsmtp
31846   user = exim
31847 .endd
31848 This causes messages addressed to &'domain.example'& to be written in BSMTP
31849 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
31850 message (unless there are more than 1000 recipients).
31851
31852
31853
31854 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
31855 .cindex "SMTP" "batched incoming"
31856 .cindex "batched SMTP input"
31857 The &%-bS%& command line option causes Exim to accept one or more messages by
31858 reading SMTP on the standard input, but to generate no responses. If the caller
31859 is trusted, the senders in the MAIL commands are believed; otherwise the
31860 sender is always the caller of Exim. Unqualified senders and receivers are not
31861 rejected (there seems little point) but instead just get qualified. HELO
31862 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31863 as NOOP; QUIT quits.
31864
31865 Minimal policy checking is done for BSMTP input. Only the non-SMTP
31866 ACL is run in the same way as for non-SMTP local input.
31867
31868 If an error is detected while reading a message, including a missing &"."& at
31869 the end, Exim gives up immediately. It writes details of the error to the
31870 standard output in a stylized way that the calling program should be able to
31871 make some use of automatically, for example:
31872 .code
31873 554 Unexpected end of file
31874 Transaction started in line 10
31875 Error detected in line 14
31876 .endd
31877 It writes a more verbose version, for human consumption, to the standard error
31878 file, for example:
31879 .code
31880 An error was detected while processing a file of BSMTP input.
31881 The error message was:
31882
31883 501 '>' missing at end of address
31884
31885 The SMTP transaction started in line 10.
31886 The error was detected in line 12.
31887 The SMTP command at fault was:
31888
31889 rcpt to:<malformed@in.com.plete
31890
31891 1 previous message was successfully processed.
31892 The rest of the batch was abandoned.
31893 .endd
31894 The return code from Exim is zero only if there were no errors. It is 1 if some
31895 messages were accepted before an error was detected, and 2 if no messages were
31896 accepted.
31897 .ecindex IIDsmtpproc1
31898 .ecindex IIDsmtpproc2
31899
31900
31901
31902 . ////////////////////////////////////////////////////////////////////////////
31903 . ////////////////////////////////////////////////////////////////////////////
31904
31905 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31906          "Customizing messages"
31907 When a message fails to be delivered, or remains on the queue for more than a
31908 configured amount of time, Exim sends a message to the original sender, or
31909 to an alternative configured address. The text of these messages is built into
31910 the code of Exim, but it is possible to change it, either by adding a single
31911 string, or by replacing each of the paragraphs by text supplied in a file.
31912
31913 The &'From:'& and &'To:'& header lines are automatically generated; you can
31914 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31915 option. Exim also adds the line
31916 .code
31917 Auto-Submitted: auto-generated
31918 .endd
31919 to all warning and bounce messages,
31920
31921
31922 .section "Customizing bounce messages" "SECID239"
31923 .cindex "customizing" "bounce message"
31924 .cindex "bounce message" "customizing"
31925 If &%bounce_message_text%& is set, its contents are included in the default
31926 message immediately after &"This message was created automatically by mail
31927 delivery software."& The string is not expanded. It is not used if
31928 &%bounce_message_file%& is set.
31929
31930 When &%bounce_message_file%& is set, it must point to a template file for
31931 constructing error messages. The file consists of a series of text items,
31932 separated by lines consisting of exactly four asterisks. If the file cannot be
31933 opened, default text is used and a message is written to the main and panic
31934 logs. If any text item in the file is empty, default text is used for that
31935 item.
31936
31937 .vindex "&$bounce_recipient$&"
31938 .vindex "&$bounce_return_size_limit$&"
31939 Each item of text that is read from the file is expanded, and there are two
31940 expansion variables which can be of use here: &$bounce_recipient$& is set to
31941 the recipient of an error message while it is being created, and
31942 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31943 option, rounded to a whole number.
31944
31945 The items must appear in the file in the following order:
31946
31947 .ilist
31948 The first item is included in the headers, and should include at least a
31949 &'Subject:'& header. Exim does not check the syntax of these headers.
31950 .next
31951 The second item forms the start of the error message. After it, Exim lists the
31952 failing addresses with their error messages.
31953 .next
31954 The third item is used to introduce any text from pipe transports that is to be
31955 returned to the sender. It is omitted if there is no such text.
31956 .next
31957 The fourth item is used to introduce the copy of the message that is returned
31958 as part of the error report.
31959 .next
31960 The fifth item is added after the fourth one if the returned message is
31961 truncated because it is bigger than &%return_size_limit%&.
31962 .next
31963 The sixth item is added after the copy of the original message.
31964 .endlist
31965
31966 The default state (&%bounce_message_file%& unset) is equivalent to the
31967 following file, in which the sixth item is empty. The &'Subject:'& and some
31968 other lines have been split in order to fit them on the page:
31969 .code
31970 Subject: Mail delivery failed
31971   ${if eq{$sender_address}{$bounce_recipient}
31972   {: returning message to sender}}
31973 ****
31974 This message was created automatically by mail delivery software.
31975
31976 A message ${if eq{$sender_address}{$bounce_recipient}
31977   {that you sent }{sent by
31978
31979 <$sender_address>
31980
31981 }}could not be delivered to all of its recipients.
31982 This is a permanent error. The following address(es) failed:
31983 ****
31984 The following text was generated during the delivery attempt(s):
31985 ****
31986 ------ This is a copy of the message, including all the headers.
31987   ------
31988 ****
31989 ------ The body of the message is $message_size characters long;
31990   only the first
31991 ------ $bounce_return_size_limit or so are included here.
31992 ****
31993 .endd
31994 .section "Customizing warning messages" "SECTcustwarn"
31995 .cindex "customizing" "warning message"
31996 .cindex "warning of delay" "customizing the message"
31997 The option &%warn_message_file%& can be pointed at a template file for use when
31998 warnings about message delays are created. In this case there are only three
31999 text sections:
32000
32001 .ilist
32002 The first item is included in the headers, and should include at least a
32003 &'Subject:'& header. Exim does not check the syntax of these headers.
32004 .next
32005 The second item forms the start of the warning message. After it, Exim lists
32006 the delayed addresses.
32007 .next
32008 The third item then ends the message.
32009 .endlist
32010
32011 The default state is equivalent to the following file, except that some lines
32012 have been split here, in order to fit them on the page:
32013 .code
32014 Subject: Warning: message $message_exim_id delayed
32015   $warn_message_delay
32016 ****
32017 This message was created automatically by mail delivery software.
32018
32019 A message ${if eq{$sender_address}{$warn_message_recipients}
32020 {that you sent }{sent by
32021
32022 <$sender_address>
32023
32024 }}has not been delivered to all of its recipients after
32025 more than $warn_message_delay on the queue on $primary_hostname.
32026
32027 The message identifier is:     $message_exim_id
32028 The subject of the message is: $h_subject
32029 The date of the message is:    $h_date
32030
32031 The following address(es) have not yet been delivered:
32032 ****
32033 No action is required on your part. Delivery attempts will
32034 continue for some time, and this warning may be repeated at
32035 intervals if the message remains undelivered. Eventually the
32036 mail delivery software will give up, and when that happens,
32037 the message will be returned to you.
32038 .endd
32039 .vindex "&$warn_message_delay$&"
32040 .vindex "&$warn_message_recipients$&"
32041 However, in the default state the subject and date lines are omitted if no
32042 appropriate headers exist. During the expansion of this file,
32043 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32044 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32045 of recipients for the warning message. There may be more than one if there are
32046 multiple addresses with different &%errors_to%& settings on the routers that
32047 handled them.
32048
32049
32050
32051
32052 . ////////////////////////////////////////////////////////////////////////////
32053 . ////////////////////////////////////////////////////////////////////////////
32054
32055 .chapter "Some common configuration settings" "CHAPcomconreq"
32056 This chapter discusses some configuration settings that seem to be fairly
32057 common. More examples and discussion can be found in the Exim book.
32058
32059
32060
32061 .section "Sending mail to a smart host" "SECID240"
32062 .cindex "smart host" "example router"
32063 If you want to send all mail for non-local domains to a &"smart host"&, you
32064 should replace the default &(dnslookup)& router with a router which does the
32065 routing explicitly:
32066 .code
32067 send_to_smart_host:
32068   driver = manualroute
32069   route_list = !+local_domains smart.host.name
32070   transport = remote_smtp
32071 .endd
32072 You can use the smart host's IP address instead of the name if you wish.
32073 If you are using Exim only to submit messages to a smart host, and not for
32074 receiving incoming messages, you can arrange for it to do the submission
32075 synchronously by setting the &%mua_wrapper%& option (see chapter
32076 &<<CHAPnonqueueing>>&).
32077
32078
32079
32080
32081 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32082 .cindex "mailing lists"
32083 Exim can be used to run simple mailing lists, but for large and/or complicated
32084 requirements, the use of additional specialized mailing list software such as
32085 Majordomo or Mailman is recommended.
32086
32087 The &(redirect)& router can be used to handle mailing lists where each list
32088 is maintained in a separate file, which can therefore be managed by an
32089 independent manager. The &%domains%& router option can be used to run these
32090 lists in a separate domain from normal mail. For example:
32091 .code
32092 lists:
32093   driver = redirect
32094   domains = lists.example
32095   file = /usr/lists/$local_part
32096   forbid_pipe
32097   forbid_file
32098   errors_to = $local_part-request@lists.example
32099   no_more
32100 .endd
32101 This router is skipped for domains other than &'lists.example'&. For addresses
32102 in that domain, it looks for a file that matches the local part. If there is no
32103 such file, the router declines, but because &%no_more%& is set, no subsequent
32104 routers are tried, and so the whole delivery fails.
32105
32106 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32107 expanded into a file name or a pipe delivery, which is usually inappropriate in
32108 a mailing list.
32109
32110 .oindex "&%errors_to%&"
32111 The &%errors_to%& option specifies that any delivery errors caused by addresses
32112 taken from a mailing list are to be sent to the given address rather than the
32113 original sender of the message. However, before acting on this, Exim verifies
32114 the error address, and ignores it if verification fails.
32115
32116 For example, using the configuration above, mail sent to
32117 &'dicts@lists.example'& is passed on to those addresses contained in
32118 &_/usr/lists/dicts_&, with error reports directed to
32119 &'dicts-request@lists.example'&, provided that this address can be verified.
32120 There could be a file called &_/usr/lists/dicts-request_& containing
32121 the address(es) of this particular list's manager(s), but other approaches,
32122 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32123 or &%local_part_suffix%& options) to handle addresses of the form
32124 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32125
32126
32127
32128 .section "Syntax errors in mailing lists" "SECID241"
32129 .cindex "mailing lists" "syntax errors in"
32130 If an entry in redirection data contains a syntax error, Exim normally defers
32131 delivery of the original address. That means that a syntax error in a mailing
32132 list holds up all deliveries to the list. This may not be appropriate when a
32133 list is being maintained automatically from data supplied by users, and the
32134 addresses are not rigorously checked.
32135
32136 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32137 entries that fail to parse, noting the incident in the log. If in addition
32138 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32139 whenever a broken address is skipped. It is usually appropriate to set
32140 &%syntax_errors_to%& to the same address as &%errors_to%&.
32141
32142
32143
32144 .section "Re-expansion of mailing lists" "SECID242"
32145 .cindex "mailing lists" "re-expansion of"
32146 Exim remembers every individual address to which a message has been delivered,
32147 in order to avoid duplication, but it normally stores only the original
32148 recipient addresses with a message. If all the deliveries to a mailing list
32149 cannot be done at the first attempt, the mailing list is re-expanded when the
32150 delivery is next tried. This means that alterations to the list are taken into
32151 account at each delivery attempt, so addresses that have been added to
32152 the list since the message arrived will therefore receive a copy of the
32153 message, even though it pre-dates their subscription.
32154
32155 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32156 on the &(redirect)& router. If this is done, any addresses generated by the
32157 router that fail to deliver at the first attempt are added to the message as
32158 &"top level"& addresses, and the parent address that generated them is marked
32159 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32160 subsequent delivery attempts. The disadvantage of this is that if any of the
32161 failing addresses are incorrect, correcting them in the file has no effect on
32162 pre-existing messages.
32163
32164 The original top-level address is remembered with each of the generated
32165 addresses, and is output in any log messages. However, any intermediate parent
32166 addresses are not recorded. This makes a difference to the log only if the
32167 &%all_parents%& selector is set, but for mailing lists there is normally only
32168 one level of expansion anyway.
32169
32170
32171
32172 .section "Closed mailing lists" "SECID243"
32173 .cindex "mailing lists" "closed"
32174 The examples so far have assumed open mailing lists, to which anybody may
32175 send mail. It is also possible to set up closed lists, where mail is accepted
32176 from specified senders only. This is done by making use of the generic
32177 &%senders%& option to restrict the router that handles the list.
32178
32179 The following example uses the same file as a list of recipients and as a list
32180 of permitted senders. It requires three routers:
32181 .code
32182 lists_request:
32183   driver = redirect
32184   domains = lists.example
32185   local_part_suffix = -request
32186   file = /usr/lists/$local_part$local_part_suffix
32187   no_more
32188
32189 lists_post:
32190   driver = redirect
32191   domains = lists.example
32192   senders = ${if exists {/usr/lists/$local_part}\
32193              {lsearch;/usr/lists/$local_part}{*}}
32194   file = /usr/lists/$local_part
32195   forbid_pipe
32196   forbid_file
32197   errors_to = $local_part-request@lists.example
32198   no_more
32199
32200 lists_closed:
32201   driver = redirect
32202   domains = lists.example
32203   allow_fail
32204   data = :fail: $local_part@lists.example is a closed mailing list
32205 .endd
32206 All three routers have the same &%domains%& setting, so for any other domains,
32207 they are all skipped. The first router runs only if the local part ends in
32208 &%-request%&. It handles messages to the list manager(s) by means of an open
32209 mailing list.
32210
32211 The second router runs only if the &%senders%& precondition is satisfied. It
32212 checks for the existence of a list that corresponds to the local part, and then
32213 checks that the sender is on the list by means of a linear search. It is
32214 necessary to check for the existence of the file before trying to search it,
32215 because otherwise Exim thinks there is a configuration error. If the file does
32216 not exist, the expansion of &%senders%& is *, which matches all senders. This
32217 means that the router runs, but because there is no list, declines, and
32218 &%no_more%& ensures that no further routers are run. The address fails with an
32219 &"unrouteable address"& error.
32220
32221 The third router runs only if the second router is skipped, which happens when
32222 a mailing list exists, but the sender is not on it. This router forcibly fails
32223 the address, giving a suitable error message.
32224
32225
32226
32227
32228 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32229 .cindex "VERP"
32230 .cindex "Variable Envelope Return Paths"
32231 .cindex "envelope sender"
32232 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32233 are a way of helping mailing list administrators discover which subscription
32234 address is the cause of a particular delivery failure. The idea is to encode
32235 the original recipient address in the outgoing envelope sender address, so that
32236 if the message is forwarded by another host and then subsequently bounces, the
32237 original recipient can be extracted from the recipient address of the bounce.
32238
32239 .oindex &%errors_to%&
32240 .oindex &%return_path%&
32241 Envelope sender addresses can be modified by Exim using two different
32242 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32243 list examples), or the &%return_path%& option on a transport. The second of
32244 these is effective only if the message is successfully delivered to another
32245 host; it is not used for errors detected on the local host (see the description
32246 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32247 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32248 .code
32249 verp_smtp:
32250   driver = smtp
32251   max_rcpt = 1
32252   return_path = \
32253     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32254       {$1-request+$local_part=$domain@your.dom.example}fail}
32255 .endd
32256 This has the effect of rewriting the return path (envelope sender) on outgoing
32257 SMTP messages, if the local part of the original return path ends in
32258 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32259 local part and domain of the recipient into the return path. Suppose, for
32260 example, that a message whose return path has been set to
32261 &'somelist-request@your.dom.example'& is sent to
32262 &'subscriber@other.dom.example'&. In the transport, the return path is
32263 rewritten as
32264 .code
32265 somelist-request+subscriber=other.dom.example@your.dom.example
32266 .endd
32267 .vindex "&$local_part$&"
32268 For this to work, you must tell Exim to send multiple copies of messages that
32269 have more than one recipient, so that each copy has just one recipient. This is
32270 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32271 might be sent to several different recipients in the same domain, in which case
32272 &$local_part$& is not available in the transport, because it is not unique.
32273
32274 Unless your host is doing nothing but mailing list deliveries, you should
32275 probably use a separate transport for the VERP deliveries, so as not to use
32276 extra resources in making one-per-recipient copies for other deliveries. This
32277 can easily be done by expanding the &%transport%& option in the router:
32278 .code
32279 dnslookup:
32280   driver = dnslookup
32281   domains = ! +local_domains
32282   transport = \
32283     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32284       {verp_smtp}{remote_smtp}}
32285   no_more
32286 .endd
32287 If you want to change the return path using &%errors_to%& in a router instead
32288 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32289 routers that handle mailing list addresses. This will ensure that all delivery
32290 errors, including those detected on the local host, are sent to the VERP
32291 address.
32292
32293 On a host that does no local deliveries and has no manual routing, only the
32294 &(dnslookup)& router needs to be changed. A special transport is not needed for
32295 SMTP deliveries. Every mailing list recipient has its own return path value,
32296 and so Exim must hand them to the transport one at a time. Here is an example
32297 of a &(dnslookup)& router that implements VERP:
32298 .code
32299 verp_dnslookup:
32300   driver = dnslookup
32301   domains = ! +local_domains
32302   transport = remote_smtp
32303   errors_to = \
32304     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32305      {$1-request+$local_part=$domain@your.dom.example}fail}
32306   no_more
32307 .endd
32308 Before you start sending out messages with VERPed return paths, you must also
32309 configure Exim to accept the bounce messages that come back to those paths.
32310 Typically this is done by setting a &%local_part_suffix%& option for a
32311 router, and using this to route the messages to wherever you want to handle
32312 them.
32313
32314 The overhead incurred in using VERP depends very much on the size of the
32315 message, the number of recipient addresses that resolve to the same remote
32316 host, and the speed of the connection over which the message is being sent. If
32317 a lot of addresses resolve to the same host and the connection is slow, sending
32318 a separate copy of the message for each address may take substantially longer
32319 than sending a single copy with many recipients (for which VERP cannot be
32320 used).
32321
32322
32323
32324
32325
32326
32327 .section "Virtual domains" "SECTvirtualdomains"
32328 .cindex "virtual domains"
32329 .cindex "domain" "virtual"
32330 The phrase &'virtual domain'& is unfortunately used with two rather different
32331 meanings:
32332
32333 .ilist
32334 A domain for which there are no real mailboxes; all valid local parts are
32335 aliases for other email addresses. Common examples are organizational
32336 top-level domains and &"vanity"& domains.
32337 .next
32338 One of a number of independent domains that are all handled by the same host,
32339 with mailboxes on that host, but where the mailbox owners do not necessarily
32340 have login accounts on that host.
32341 .endlist
32342
32343 The first usage is probably more common, and does seem more &"virtual"& than
32344 the second. This kind of domain can be handled in Exim with a straightforward
32345 aliasing router. One approach is to create a separate alias file for each
32346 virtual domain. Exim can test for the existence of the alias file to determine
32347 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
32348 to a router of this form:
32349 .code
32350 virtual:
32351   driver = redirect
32352   domains = dsearch;/etc/mail/virtual
32353   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
32354   no_more
32355 .endd
32356 The &%domains%& option specifies that the router is to be skipped, unless there
32357 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
32358 domain that is being processed. When the router runs, it looks up the local
32359 part in the file to find a new address (or list of addresses). The &%no_more%&
32360 setting ensures that if the lookup fails (leading to &%data%& being an empty
32361 string), Exim gives up on the address without trying any subsequent routers.
32362
32363 This one router can handle all the virtual domains because the alias file names
32364 follow a fixed pattern. Permissions can be arranged so that appropriate people
32365 can edit the different alias files. A successful aliasing operation results in
32366 a new envelope recipient address, which is then routed from scratch.
32367
32368 The other kind of &"virtual"& domain can also be handled in a straightforward
32369 way. One approach is to create a file for each domain containing a list of
32370 valid local parts, and use it in a router like this:
32371 .code
32372 my_domains:
32373   driver = accept
32374   domains = dsearch;/etc/mail/domains
32375   local_parts = lsearch;/etc/mail/domains/$domain
32376   transport = my_mailboxes
32377 .endd
32378 The address is accepted if there is a file for the domain, and the local part
32379 can be found in the file. The &%domains%& option is used to check for the
32380 file's existence because &%domains%& is tested before the &%local_parts%&
32381 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
32382 because that option is tested after &%local_parts%&. The transport is as
32383 follows:
32384 .code
32385 my_mailboxes:
32386   driver = appendfile
32387   file = /var/mail/$domain/$local_part
32388   user = mail
32389 .endd
32390 This uses a directory of mailboxes for each domain. The &%user%& setting is
32391 required, to specify which uid is to be used for writing to the mailboxes.
32392
32393 The configuration shown here is just one example of how you might support this
32394 requirement. There are many other ways this kind of configuration can be set
32395 up, for example, by using a database instead of separate files to hold all the
32396 information about the domains.
32397
32398
32399
32400 .section "Multiple user mailboxes" "SECTmulbox"
32401 .cindex "multiple mailboxes"
32402 .cindex "mailbox" "multiple"
32403 .cindex "local part" "prefix"
32404 .cindex "local part" "suffix"
32405 Heavy email users often want to operate with multiple mailboxes, into which
32406 incoming mail is automatically sorted. A popular way of handling this is to
32407 allow users to use multiple sender addresses, so that replies can easily be
32408 identified. Users are permitted to add prefixes or suffixes to their local
32409 parts for this purpose. The wildcard facility of the generic router options
32410 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
32411 example, consider this router:
32412 .code
32413 userforward:
32414   driver = redirect
32415   check_local_user
32416   file = $home/.forward
32417   local_part_suffix = -*
32418   local_part_suffix_optional
32419   allow_filter
32420 .endd
32421 .vindex "&$local_part_suffix$&"
32422 It runs a user's &_.forward_& file for all local parts of the form
32423 &'username-*'&. Within the filter file the user can distinguish different
32424 cases by testing the variable &$local_part_suffix$&. For example:
32425 .code
32426 if $local_part_suffix contains -special then
32427 save /home/$local_part/Mail/special
32428 endif
32429 .endd
32430 If the filter file does not exist, or does not deal with such addresses, they
32431 fall through to subsequent routers, and, assuming no subsequent use of the
32432 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
32433 control over which suffixes are valid.
32434
32435 Alternatively, a suffix can be used to trigger the use of a different
32436 &_.forward_& file &-- which is the way a similar facility is implemented in
32437 another MTA:
32438 .code
32439 userforward:
32440   driver = redirect
32441   check_local_user
32442   file = $home/.forward$local_part_suffix
32443   local_part_suffix = -*
32444   local_part_suffix_optional
32445   allow_filter
32446 .endd
32447 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
32448 example, &_.forward-special_& is used. Once again, if the appropriate file
32449 does not exist, or does not deal with the address, it is passed on to
32450 subsequent routers, which could, if required, look for an unqualified
32451 &_.forward_& file to use as a default.
32452
32453
32454
32455 .section "Simplified vacation processing" "SECID244"
32456 .cindex "vacation processing"
32457 The traditional way of running the &'vacation'& program is for a user to set up
32458 a pipe command in a &_.forward_& file
32459 (see section &<<SECTspecitredli>>& for syntax details).
32460 This is prone to error by inexperienced users. There are two features of Exim
32461 that can be used to make this process simpler for users:
32462
32463 .ilist
32464 A local part prefix such as &"vacation-"& can be specified on a router which
32465 can cause the message to be delivered directly to the &'vacation'& program, or
32466 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
32467 &_.forward_& file are then much simpler. For example:
32468 .code
32469 spqr, vacation-spqr
32470 .endd
32471 .next
32472 The &%require_files%& generic router option can be used to trigger a
32473 vacation delivery by checking for the existence of a certain file in the
32474 user's home directory. The &%unseen%& generic option should also be used, to
32475 ensure that the original delivery also proceeds. In this case, all the user has
32476 to do is to create a file called, say, &_.vacation_&, containing a vacation
32477 message.
32478 .endlist
32479
32480 Another advantage of both these methods is that they both work even when the
32481 use of arbitrary pipes by users is locked out.
32482
32483
32484
32485 .section "Taking copies of mail" "SECID245"
32486 .cindex "message" "copying every"
32487 Some installations have policies that require archive copies of all messages to
32488 be made. A single copy of each message can easily be taken by an appropriate
32489 command in a system filter, which could, for example, use a different file for
32490 each day's messages.
32491
32492 There is also a shadow transport mechanism that can be used to take copies of
32493 messages that are successfully delivered by local transports, one copy per
32494 delivery. This could be used, &'inter alia'&, to implement automatic
32495 notification of delivery by sites that insist on doing such things.
32496
32497
32498
32499 .section "Intermittently connected hosts" "SECID246"
32500 .cindex "intermittently connected hosts"
32501 It has become quite common (because it is cheaper) for hosts to connect to the
32502 Internet periodically rather than remain connected all the time. The normal
32503 arrangement is that mail for such hosts accumulates on a system that is
32504 permanently connected.
32505
32506 Exim was designed for use on permanently connected hosts, and so it is not
32507 particularly well-suited to use in an intermittently connected environment.
32508 Nevertheless there are some features that can be used.
32509
32510
32511 .section "Exim on the upstream server host" "SECID247"
32512 It is tempting to arrange for incoming mail for the intermittently connected
32513 host to remain on Exim's queue until the client connects. However, this
32514 approach does not scale very well. Two different kinds of waiting message are
32515 being mixed up in the same queue &-- those that cannot be delivered because of
32516 some temporary problem, and those that are waiting for their destination host
32517 to connect. This makes it hard to manage the queue, as well as wasting
32518 resources, because each queue runner scans the entire queue.
32519
32520 A better approach is to separate off those messages that are waiting for an
32521 intermittently connected host. This can be done by delivering these messages
32522 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
32523 format, from where they are transmitted by other software when their
32524 destination connects. This makes it easy to collect all the mail for one host
32525 in a single directory, and to apply local timeout rules on a per-message basis
32526 if required.
32527
32528 On a very small scale, leaving the mail on Exim's queue can be made to work. If
32529 you are doing this, you should configure Exim with a long retry period for the
32530 intermittent host. For example:
32531 .code
32532 cheshire.wonderland.fict.example    *   F,5d,24h
32533 .endd
32534 This stops a lot of failed delivery attempts from occurring, but Exim remembers
32535 which messages it has queued up for that host. Once the intermittent host comes
32536 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
32537 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
32538 causes all the queued up messages to be delivered, often down a single SMTP
32539 connection. While the host remains connected, any new messages get delivered
32540 immediately.
32541
32542 If the connecting hosts do not have fixed IP addresses, that is, if a host is
32543 issued with a different IP address each time it connects, Exim's retry
32544 mechanisms on the holding host get confused, because the IP address is normally
32545 used as part of the key string for holding retry information. This can be
32546 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
32547 Since this has disadvantages for permanently connected hosts, it is best to
32548 arrange a separate transport for the intermittently connected ones.
32549
32550
32551
32552 .section "Exim on the intermittently connected client host" "SECID248"
32553 The value of &%smtp_accept_queue_per_connection%& should probably be
32554 increased, or even set to zero (that is, disabled) on the intermittently
32555 connected host, so that all incoming messages down a single connection get
32556 delivered immediately.
32557
32558 .cindex "SMTP" "passed connection"
32559 .cindex "SMTP" "multiple deliveries"
32560 .cindex "multiple SMTP deliveries"
32561 Mail waiting to be sent from an intermittently connected host will probably
32562 not have been routed, because without a connection DNS lookups are not
32563 possible. This means that if a normal queue run is done at connection time,
32564 each message is likely to be sent in a separate SMTP session. This can be
32565 avoided by starting the queue run with a command line option beginning with
32566 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
32567 first pass, routing is done but no deliveries take place. The second pass is a
32568 normal queue run; since all the messages have been previously routed, those
32569 destined for the same host are likely to get sent as multiple deliveries in a
32570 single SMTP connection.
32571
32572
32573
32574 . ////////////////////////////////////////////////////////////////////////////
32575 . ////////////////////////////////////////////////////////////////////////////
32576
32577 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
32578          "Exim as a non-queueing client"
32579 .cindex "client, non-queueing"
32580 .cindex "smart host" "suppressing queueing"
32581 On a personal computer, it is a common requirement for all
32582 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
32583 configured to operate that way, for all the popular operating systems.
32584 However, there are some MUAs for Unix-like systems that cannot be so
32585 configured: they submit messages using the command line interface of
32586 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
32587 messages this way.
32588
32589 If the personal computer runs continuously, there is no problem, because it can
32590 run a conventional MTA that handles delivery to the smart host, and deal with
32591 any delays via its queueing mechanism. However, if the computer does not run
32592 continuously or runs different operating systems at different times, queueing
32593 email is not desirable.
32594
32595 There is therefore a requirement for something that can provide the
32596 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
32597 any queueing or retrying facilities. Furthermore, the delivery to the smart
32598 host should be synchronous, so that if it fails, the sending MUA is immediately
32599 informed. In other words, we want something that extends an MUA that submits
32600 to a local MTA via the command line so that it behaves like one that submits
32601 to a remote smart host using TCP/SMTP.
32602
32603 There are a number of applications (for example, there is one called &'ssmtp'&)
32604 that do this job. However, people have found them to be lacking in various
32605 ways. For instance, you might want to allow aliasing and forwarding to be done
32606 before sending a message to the smart host.
32607
32608 Exim already had the necessary infrastructure for doing this job. Just a few
32609 tweaks were needed to make it behave as required, though it is somewhat of an
32610 overkill to use a fully-featured MTA for this purpose.
32611
32612 .oindex "&%mua_wrapper%&"
32613 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
32614 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
32615 assumes that it is being used to &"wrap"& a command-line MUA in the manner
32616 just described. As well as setting &%mua_wrapper%&, you also need to provide a
32617 compatible router and transport configuration. Typically there will be just one
32618 router and one transport, sending everything to a smart host.
32619
32620 When run in MUA wrapping mode, the behaviour of Exim changes in the
32621 following ways:
32622
32623 .ilist
32624 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
32625 In other words, the only way to submit messages is via the command line.
32626 .next
32627 Each message is synchronously delivered as soon as it is received (&%-odi%& is
32628 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
32629 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
32630 does not finish until the delivery attempt is complete. If the delivery is
32631 successful, a zero return code is given.
32632 .next
32633 Address redirection is permitted, but the final routing for all addresses must
32634 be to the same remote transport, and to the same list of hosts. Furthermore,
32635 the return address (envelope sender) must be the same for all recipients, as
32636 must any added or deleted header lines. In other words, it must be possible to
32637 deliver the message in a single SMTP transaction, however many recipients there
32638 are.
32639 .next
32640 If these conditions are not met, or if routing any address results in a
32641 failure or defer status, or if Exim is unable to deliver all the recipients
32642 successfully to one of the smart hosts, delivery of the entire message fails.
32643 .next
32644 Because no queueing is allowed, all failures are treated as permanent; there
32645 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
32646 smart host. Furthermore, because only a single yes/no response can be given to
32647 the caller, it is not possible to deliver to some recipients and not others. If
32648 there is an error (temporary or permanent) for any recipient, all are failed.
32649 .next
32650 If more than one smart host is listed, Exim will try another host after a
32651 connection failure or a timeout, in the normal way. However, if this kind of
32652 failure happens for all the hosts, the delivery fails.
32653 .next
32654 When delivery fails, an error message is written to the standard error stream
32655 (as well as to Exim's log), and Exim exits to the caller with a return code
32656 value 1. The message is expunged from Exim's spool files. No bounce messages
32657 are ever generated.
32658 .next
32659 No retry data is maintained, and any retry rules are ignored.
32660 .next
32661 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
32662 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
32663 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
32664 .endlist
32665
32666 The overall effect is that Exim makes a single synchronous attempt to deliver
32667 the message, failing if there is any kind of problem. Because no local
32668 deliveries are done and no daemon can be run, Exim does not need root
32669 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
32670 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
32671 the advantages and disadvantages of running without root privilege.
32672
32673
32674
32675
32676 . ////////////////////////////////////////////////////////////////////////////
32677 . ////////////////////////////////////////////////////////////////////////////
32678
32679 .chapter "Log files" "CHAPlog"
32680 .scindex IIDloggen "log" "general description"
32681 .cindex "log" "types of"
32682 Exim writes three different logs, referred to as the main log, the reject log,
32683 and the panic log:
32684
32685 .ilist
32686 .cindex "main log"
32687 The main log records the arrival of each message and each delivery in a single
32688 line in each case. The format is as compact as possible, in an attempt to keep
32689 down the size of log files. Two-character flag sequences make it easy to pick
32690 out these lines. A number of other events are recorded in the main log. Some of
32691 them are optional, in which case the &%log_selector%& option controls whether
32692 they are included or not. A Perl script called &'eximstats'&, which does simple
32693 analysis of main log files, is provided in the Exim distribution (see section
32694 &<<SECTmailstat>>&).
32695 .next
32696 .cindex "reject log"
32697 The reject log records information from messages that are rejected as a result
32698 of a configuration option (that is, for policy reasons).
32699 The first line of each rejection is a copy of the line that is also written to
32700 the main log. Then, if the message's header has been read at the time the log
32701 is written, its contents are written to this log. Only the original header
32702 lines are available; header lines added by ACLs are not logged. You can use the
32703 reject log to check that your policy controls are working correctly; on a busy
32704 host this may be easier than scanning the main log for rejection messages. You
32705 can suppress the writing of the reject log by setting &%write_rejectlog%&
32706 false.
32707 .next
32708 .cindex "panic log"
32709 .cindex "system log"
32710 When certain serious errors occur, Exim writes entries to its panic log. If the
32711 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
32712 are usually written to the main log as well, but can get lost amid the mass of
32713 other entries. The panic log should be empty under normal circumstances. It is
32714 therefore a good idea to check it (or to have a &'cron'& script check it)
32715 regularly, in order to become aware of any problems. When Exim cannot open its
32716 panic log, it tries as a last resort to write to the system log (syslog). This
32717 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
32718 message itself is written at priority LOG_CRIT.
32719 .endlist
32720
32721 Every log line starts with a timestamp, in the format shown in the following
32722 example. Note that many of the examples shown in this chapter are line-wrapped.
32723 In the log file, this would be all on one line:
32724 .code
32725 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
32726   by QUIT
32727 .endd
32728 By default, the timestamps are in the local timezone. There are two
32729 ways of changing this:
32730
32731 .ilist
32732 You can set the &%timezone%& option to a different time zone; in particular, if
32733 you set
32734 .code
32735 timezone = UTC
32736 .endd
32737 the timestamps will be in UTC (aka GMT).
32738 .next
32739 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
32740 example:
32741 .code
32742 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
32743 .endd
32744 .endlist
32745
32746 .cindex "log" "process ids in"
32747 .cindex "pid (process id)" "in log lines"
32748 Exim does not include its process id in log lines by default, but you can
32749 request that it does so by specifying the &`pid`& log selector (see section
32750 &<<SECTlogselector>>&). When this is set, the process id is output, in square
32751 brackets, immediately after the time and date.
32752
32753
32754
32755
32756 .section "Where the logs are written" "SECTwhelogwri"
32757 .cindex "log" "destination"
32758 .cindex "log" "to file"
32759 .cindex "log" "to syslog"
32760 .cindex "syslog"
32761 The logs may be written to local files, or to syslog, or both. However, it
32762 should be noted that many syslog implementations use UDP as a transport, and
32763 are therefore unreliable in the sense that messages are not guaranteed to
32764 arrive at the loghost, nor is the ordering of messages necessarily maintained.
32765 It has also been reported that on large log files (tens of megabytes) you may
32766 need to tweak syslog to prevent it syncing the file with each write &-- on
32767 Linux this has been seen to make syslog take 90% plus of CPU time.
32768
32769 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
32770 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
32771 configuration. This latter string is expanded, so it can contain, for example,
32772 references to the host name:
32773 .code
32774 log_file_path = /var/log/$primary_hostname/exim_%slog
32775 .endd
32776 It is generally advisable, however, to set the string in &_Local/Makefile_&
32777 rather than at run time, because then the setting is available right from the
32778 start of Exim's execution. Otherwise, if there's something it wants to log
32779 before it has read the configuration file (for example, an error in the
32780 configuration file) it will not use the path you want, and may not be able to
32781 log at all.
32782
32783 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
32784 list, currently limited to at most two items. This is one option where the
32785 facility for changing a list separator may not be used. The list must always be
32786 colon-separated. If an item in the list is &"syslog"& then syslog is used;
32787 otherwise the item must either be an absolute path, containing &`%s`& at the
32788 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
32789 implying the use of a default path.
32790
32791 When Exim encounters an empty item in the list, it searches the list defined by
32792 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
32793 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
32794 mean &"use the path specified at build time"&. It no such item exists, log
32795 files are written in the &_log_& subdirectory of the spool directory. This is
32796 equivalent to the setting:
32797 .code
32798 log_file_path = $spool_directory/log/%slog
32799 .endd
32800 If you do not specify anything at build time or run time, that is where the
32801 logs are written.
32802
32803 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
32804 are in use &-- see section &<<SECTdatlogfil>>& below.
32805
32806 Here are some examples of possible settings:
32807 .display
32808 &`LOG_FILE_PATH=syslog                    `& syslog only
32809 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
32810 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
32811 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
32812 .endd
32813 If there are more than two paths in the list, the first is used and a panic
32814 error is logged.
32815
32816
32817
32818 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
32819 .cindex "log" "cycling local files"
32820 .cindex "cycling logs"
32821 .cindex "&'exicyclog'&"
32822 .cindex "log" "local files; writing to"
32823 Some operating systems provide centralized and standardized methods for cycling
32824 log files. For those that do not, a utility script called &'exicyclog'& is
32825 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
32826 main and reject logs each time it is called. The maximum number of old logs to
32827 keep can be set. It is suggested this script is run as a daily &'cron'& job.
32828
32829 An Exim delivery process opens the main log when it first needs to write to it,
32830 and it keeps the file open in case subsequent entries are required &-- for
32831 example, if a number of different deliveries are being done for the same
32832 message. However, remote SMTP deliveries can take a long time, and this means
32833 that the file may be kept open long after it is renamed if &'exicyclog'& or
32834 something similar is being used to rename log files on a regular basis. To
32835 ensure that a switch of log files is noticed as soon as possible, Exim calls
32836 &[stat()]& on the main log's name before reusing an open file, and if the file
32837 does not exist, or its inode has changed, the old file is closed and Exim
32838 tries to open the main log from scratch. Thus, an old log file may remain open
32839 for quite some time, but no Exim processes should write to it once it has been
32840 renamed.
32841
32842
32843
32844 .section "Datestamped log files" "SECTdatlogfil"
32845 .cindex "log" "datestamped files"
32846 Instead of cycling the main and reject log files by renaming them
32847 periodically, some sites like to use files whose names contain a datestamp,
32848 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
32849 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
32850 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
32851 point where the datestamp is required. For example:
32852 .code
32853 log_file_path = /var/spool/exim/log/%slog-%D
32854 log_file_path = /var/log/exim-%s-%D.log
32855 log_file_path = /var/spool/exim/log/%D-%slog
32856 log_file_path = /var/log/exim/%s.%M
32857 .endd
32858 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32859 examples of names generated by the above examples:
32860 .code
32861 /var/spool/exim/log/mainlog-20021225
32862 /var/log/exim-reject-20021225.log
32863 /var/spool/exim/log/20021225-mainlog
32864 /var/log/exim/main.200212
32865 .endd
32866 When this form of log file is specified, Exim automatically switches to new
32867 files at midnight. It does not make any attempt to compress old logs; you
32868 will need to write your own script if you require this. You should not
32869 run &'exicyclog'& with this form of logging.
32870
32871 The location of the panic log is also determined by &%log_file_path%&, but it
32872 is not datestamped, because rotation of the panic log does not make sense.
32873 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
32874 the string. In addition, if it immediately follows a slash, a following
32875 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
32876 character is removed. Thus, the four examples above would give these panic
32877 log names:
32878 .code
32879 /var/spool/exim/log/paniclog
32880 /var/log/exim-panic.log
32881 /var/spool/exim/log/paniclog
32882 /var/log/exim/panic
32883 .endd
32884
32885
32886 .section "Logging to syslog" "SECID249"
32887 .cindex "log" "syslog; writing to"
32888 The use of syslog does not change what Exim logs or the format of its messages,
32889 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32890 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32891 that, the same strings are written to syslog as to log files. The syslog
32892 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32893 by default, but you can change these by setting the &%syslog_facility%& and
32894 &%syslog_processname%& options, respectively. If Exim was compiled with
32895 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32896 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32897 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32898 the time and host name to each line.
32899 The three log streams are mapped onto syslog priorities as follows:
32900
32901 .ilist
32902 &'mainlog'& is mapped to LOG_INFO
32903 .next
32904 &'rejectlog'& is mapped to LOG_NOTICE
32905 .next
32906 &'paniclog'& is mapped to LOG_ALERT
32907 .endlist
32908
32909 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32910 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32911 these are routed by syslog to the same place. You can suppress this duplication
32912 by setting &%syslog_duplication%& false.
32913
32914 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32915 entries contain multiple lines when headers are included. To cope with both
32916 these cases, entries written to syslog are split into separate &[syslog()]&
32917 calls at each internal newline, and also after a maximum of
32918 870 data characters. (This allows for a total syslog line length of 1024, when
32919 additions such as timestamps are added.) If you are running a syslog
32920 replacement that can handle lines longer than the 1024 characters allowed by
32921 RFC 3164, you should set
32922 .code
32923 SYSLOG_LONG_LINES=yes
32924 .endd
32925 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32926 lines, but it still splits at internal newlines in &'reject'& log entries.
32927
32928 To make it easy to re-assemble split lines later, each component of a split
32929 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32930 where <&'n'&> is the component number and <&'m'&> is the total number of
32931 components in the entry. The / delimiter is used when the line was split
32932 because it was too long; if it was split because of an internal newline, the \
32933 delimiter is used. For example, supposing the length limit to be 50 instead of
32934 870, the following would be the result of a typical rejection message to
32935 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32936 name, and pid as added by syslog:
32937 .code
32938 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32939 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32940 [3/5]  when scanning for sender: missing or malformed lo
32941 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32942 [5/5] mple>)
32943 .endd
32944 The same error might cause the following lines to be written to &"rejectlog"&
32945 (LOG_NOTICE):
32946 .code
32947 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32948 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32949 [3/18] er when scanning for sender: missing or malformed
32950 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32951 [5\18] .example>)
32952 [6\18] Recipients: ph10@some.domain.cam.example
32953 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32954 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32955 [9\18]        id 16RdAL-0006pc-00
32956 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32957 [11\18] 09:43 +0100
32958 [12\18] F From: <>
32959 [13\18]   Subject: this is a test header
32960 [18\18]   X-something: this is another header
32961 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32962 [16\18] le>
32963 [17\18] B Bcc:
32964 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32965 .endd
32966 Log lines that are neither too long nor contain newlines are written to syslog
32967 without modification.
32968
32969 If only syslog is being used, the Exim monitor is unable to provide a log tail
32970 display, unless syslog is routing &'mainlog'& to a file on the local host and
32971 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32972 where it is.
32973
32974
32975
32976 .section "Log line flags" "SECID250"
32977 One line is written to the main log for each message received, and for each
32978 successful, unsuccessful, and delayed delivery. These lines can readily be
32979 picked out by the distinctive two-character flags that immediately follow the
32980 timestamp. The flags are:
32981 .display
32982 &`<=`&     message arrival
32983 &`=>`&     normal message delivery
32984 &`->`&     additional address in same delivery
32985 &`*>`&     delivery suppressed by &%-N%&
32986 &`**`&     delivery failed; address bounced
32987 &`==`&     delivery deferred; temporary problem
32988 .endd
32989
32990
32991 .section "Logging message reception" "SECID251"
32992 .cindex "log" "reception line"
32993 The format of the single-line entry in the main log that is written for every
32994 message received is shown in the basic example below, which is split over
32995 several lines in order to fit it on the page:
32996 .code
32997 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32998   H=mailer.fict.example [192.168.123.123] U=exim
32999   P=smtp S=5678 id=<incoming message id>
33000 .endd
33001 The address immediately following &"<="& is the envelope sender address. A
33002 bounce message is shown with the sender address &"<>"&, and if it is locally
33003 generated, this is followed by an item of the form
33004 .code
33005 R=<message id>
33006 .endd
33007 which is a reference to the message that caused the bounce to be sent.
33008
33009 .cindex "HELO"
33010 .cindex "EHLO"
33011 For messages from other hosts, the H and U fields identify the remote host and
33012 record the RFC 1413 identity of the user that sent the message, if one was
33013 received. The number given in square brackets is the IP address of the sending
33014 host. If there is a single, unparenthesized  host name in the H field, as
33015 above, it has been verified to correspond to the IP address (see the
33016 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33017 by the remote host in the SMTP HELO or EHLO command, and has not been
33018 verified. If verification yields a different name to that given for HELO or
33019 EHLO, the verified name appears first, followed by the HELO or EHLO
33020 name in parentheses.
33021
33022 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33023 without brackets, in the HELO or EHLO command, leading to entries in
33024 the log containing text like these examples:
33025 .code
33026 H=(10.21.32.43) [192.168.8.34]
33027 H=([10.21.32.43]) [192.168.8.34]
33028 .endd
33029 This can be confusing. Only the final address in square brackets can be relied
33030 on.
33031
33032 For locally generated messages (that is, messages not received over TCP/IP),
33033 the H field is omitted, and the U field contains the login name of the caller
33034 of Exim.
33035
33036 .cindex "authentication" "logging"
33037 .cindex "AUTH" "logging"
33038 For all messages, the P field specifies the protocol used to receive the
33039 message. This is the value that is stored in &$received_protocol$&. In the case
33040 of incoming SMTP messages, the value indicates whether or not any SMTP
33041 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33042 session was encrypted, there is an additional X field that records the cipher
33043 suite that was used.
33044
33045 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33046 hosts that have authenticated themselves using the SMTP AUTH command. The first
33047 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33048 there is an additional item A= followed by the name of the authenticator that
33049 was used. If an authenticated identification was set up by the authenticator's
33050 &%server_set_id%& option, this is logged too, separated by a colon from the
33051 authenticator name.
33052
33053 .cindex "size" "of message"
33054 The id field records the existing message id, if present. The size of the
33055 received message is given by the S field. When the message is delivered,
33056 headers may be removed or added, so that the size of delivered copies of the
33057 message may not correspond with this value (and indeed may be different to each
33058 other).
33059
33060 The &%log_selector%& option can be used to request the logging of additional
33061 data when a message is received. See section &<<SECTlogselector>>& below.
33062
33063
33064
33065 .section "Logging deliveries" "SECID252"
33066 .cindex "log" "delivery line"
33067 The format of the single-line entry in the main log that is written for every
33068 delivery is shown in one of the examples below, for local and remote
33069 deliveries, respectively. Each example has been split into two lines in order
33070 to fit it on the page:
33071 .code
33072 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33073   <marv@hitch.fict.example> R=localuser T=local_delivery
33074 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33075   monk@holistic.fict.example R=dnslookup T=remote_smtp
33076   H=holistic.fict.example [192.168.234.234]
33077 .endd
33078 For ordinary local deliveries, the original address is given in angle brackets
33079 after the final delivery address, which might be a pipe or a file. If
33080 intermediate address(es) exist between the original and the final address, the
33081 last of these is given in parentheses after the final address. The R and T
33082 fields record the router and transport that were used to process the address.
33083
33084 If a shadow transport was run after a successful local delivery, the log line
33085 for the successful delivery has an item added on the end, of the form
33086 .display
33087 &`ST=<`&&'shadow transport name'&&`>`&
33088 .endd
33089 If the shadow transport did not succeed, the error message is put in
33090 parentheses afterwards.
33091
33092 .cindex "asterisk" "after IP address"
33093 When more than one address is included in a single delivery (for example, two
33094 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33095 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33096 down a single SMTP connection, an asterisk follows the IP address in the log
33097 lines for the second and subsequent messages.
33098
33099 The generation of a reply message by a filter file gets logged as a
33100 &"delivery"& to the addressee, preceded by &">"&.
33101
33102 The &%log_selector%& option can be used to request the logging of additional
33103 data when a message is delivered. See section &<<SECTlogselector>>& below.
33104
33105
33106 .section "Discarded deliveries" "SECID253"
33107 .cindex "discarded messages"
33108 .cindex "message" "discarded"
33109 .cindex "delivery" "discarded; logging"
33110 When a message is discarded as a result of the command &"seen finish"& being
33111 obeyed in a filter file which generates no deliveries, a log entry of the form
33112 .code
33113 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33114   <low.club@bridge.example> R=userforward
33115 .endd
33116 is written, to record why no deliveries are logged. When a message is discarded
33117 because it is aliased to &":blackhole:"& the log line is like this:
33118 .code
33119 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33120   <hole@nowhere.example> R=blackhole_router
33121 .endd
33122
33123
33124 .section "Deferred deliveries" "SECID254"
33125 When a delivery is deferred, a line of the following form is logged:
33126 .code
33127 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33128   R=dnslookup T=smtp defer (146): Connection refused
33129 .endd
33130 In the case of remote deliveries, the error is the one that was given for the
33131 last IP address that was tried. Details of individual SMTP failures are also
33132 written to the log, so the above line would be preceded by something like
33133 .code
33134 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33135   mail1.endrest.example [192.168.239.239]: Connection refused
33136 .endd
33137 When a deferred address is skipped because its retry time has not been reached,
33138 a message is written to the log, but this can be suppressed by setting an
33139 appropriate value in &%log_selector%&.
33140
33141
33142
33143 .section "Delivery failures" "SECID255"
33144 .cindex "delivery" "failure; logging"
33145 If a delivery fails because an address cannot be routed, a line of the
33146 following form is logged:
33147 .code
33148 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33149   <jim@trek99.example>: unknown mail domain
33150 .endd
33151 If a delivery fails at transport time, the router and transport are shown, and
33152 the response from the remote host is included, as in this example:
33153 .code
33154 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33155   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33156   after pipelined RCPT TO:<ace400@pb.example>: host
33157   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33158   <ace400@pb.example>...Addressee unknown
33159 .endd
33160 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33161 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33162 disabling PIPELINING. The log lines for all forms of delivery failure are
33163 flagged with &`**`&.
33164
33165
33166
33167 .section "Fake deliveries" "SECID256"
33168 .cindex "delivery" "fake; logging"
33169 If a delivery does not actually take place because the &%-N%& option has been
33170 used to suppress it, a normal delivery line is written to the log, except that
33171 &"=>"& is replaced by &"*>"&.
33172
33173
33174
33175 .section "Completion" "SECID257"
33176 A line of the form
33177 .code
33178 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33179 .endd
33180 is written to the main log when a message is about to be removed from the spool
33181 at the end of its processing.
33182
33183
33184
33185
33186 .section "Summary of Fields in Log Lines" "SECID258"
33187 .cindex "log" "summary of fields"
33188 A summary of the field identifiers that are used in log lines is shown in
33189 the following table:
33190 .display
33191 &`A   `&        authenticator name (and optional id)
33192 &`C   `&        SMTP confirmation on delivery
33193 &`    `&        command list for &"no mail in SMTP session"&
33194 &`CV  `&        certificate verification status
33195 &`D   `&        duration of &"no mail in SMTP session"&
33196 &`DN  `&        distinguished name from peer certificate
33197 &`DT  `&        on &`=>`& lines: time taken for a delivery
33198 &`F   `&        sender address (on delivery lines)
33199 &`H   `&        host name and IP address
33200 &`I   `&        local interface used
33201 &`id  `&        message id for incoming message
33202 &`P   `&        on &`<=`& lines: protocol used
33203 &`    `&        on &`=>`& and &`**`& lines: return path
33204 &`QT  `&        on &`=>`& lines: time spent on queue so far
33205 &`    `&        on &"Completed"& lines: time spent on queue
33206 &`R   `&        on &`<=`& lines: reference for local bounce
33207 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33208 &`S   `&        size of message
33209 &`ST  `&        shadow transport name
33210 &`T   `&        on &`<=`& lines: message subject (topic)
33211 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33212 &`U   `&        local user or RFC 1413 identity
33213 &`X   `&        TLS cipher suite
33214 .endd
33215
33216
33217 .section "Other log entries" "SECID259"
33218 Various other types of log entry are written from time to time. Most should be
33219 self-explanatory. Among the more common are:
33220
33221 .ilist
33222 .cindex "retry" "time not reached"
33223 &'retry time not reached'&&~&~An address previously suffered a temporary error
33224 during routing or local delivery, and the time to retry has not yet arrived.
33225 This message is not written to an individual message log file unless it happens
33226 during the first delivery attempt.
33227 .next
33228 &'retry time not reached for any host'&&~&~An address previously suffered
33229 temporary errors during remote delivery, and the retry time has not yet arrived
33230 for any of the hosts to which it is routed.
33231 .next
33232 .cindex "spool directory" "file locked"
33233 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33234 some other Exim process is already working on the message. This can be quite
33235 common if queue running processes are started at frequent intervals. The
33236 &'exiwhat'& utility script can be used to find out what Exim processes are
33237 doing.
33238 .next
33239 .cindex "error" "ignored"
33240 &'error ignored'&&~&~There are several circumstances that give rise to this
33241 message:
33242 .olist
33243 Exim failed to deliver a bounce message whose age was greater than
33244 &%ignore_bounce_errors_after%&. The bounce was discarded.
33245 .next
33246 A filter file set up a delivery using the &"noerror"& option, and the delivery
33247 failed. The delivery was discarded.
33248 .next
33249 A delivery set up by a router configured with
33250 . ==== As this is a nested list, any displays it contains must be indented
33251 . ==== as otherwise they are too far to the left.
33252 .code
33253     errors_to = <>
33254 .endd
33255 failed. The delivery was discarded.
33256 .endlist olist
33257 .endlist ilist
33258
33259
33260
33261
33262
33263 .section "Reducing or increasing what is logged" "SECTlogselector"
33264 .cindex "log" "selectors"
33265 By setting the &%log_selector%& global option, you can disable some of Exim's
33266 default logging, or you can request additional logging. The value of
33267 &%log_selector%& is made up of names preceded by plus or minus characters. For
33268 example:
33269 .code
33270 log_selector = +arguments -retry_defer
33271 .endd
33272 The list of optional log items is in the following table, with the default
33273 selection marked by asterisks:
33274 .display
33275 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33276 &` address_rewrite            `&  address rewriting
33277 &` all_parents                `&  all parents in => lines
33278 &` arguments                  `&  command line arguments
33279 &`*connection_reject          `&  connection rejections
33280 &`*delay_delivery             `&  immediate delivery delayed
33281 &` deliver_time               `&  time taken to perform delivery
33282 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33283 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33284 &`*etrn                       `&  ETRN commands
33285 &`*host_lookup_failed         `&  as it says
33286 &` ident_timeout              `&  timeout for ident connection
33287 &` incoming_interface         `&  incoming interface on <= lines
33288 &` incoming_port              `&  incoming port on <= lines
33289 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33290 &` outgoing_port              `&  add remote port to => lines
33291 &`*queue_run                  `&  start and end queue runs
33292 &` queue_time                 `&  time on queue for one recipient
33293 &` queue_time_overall         `&  time on queue for whole message
33294 &` pid                        `&  Exim process id
33295 &` received_recipients        `&  recipients on <= lines
33296 &` received_sender            `&  sender on <= lines
33297 &`*rejected_header            `&  header contents on reject log
33298 &`*retry_defer                `&  &"retry time not reached"&
33299 &` return_path_on_delivery    `&  put return path on => and ** lines
33300 &` sender_on_delivery         `&  add sender to => lines
33301 &`*sender_verify_fail         `&  sender verification failures
33302 &`*size_reject                `&  rejection because too big
33303 &`*skip_delivery              `&  delivery skipped in a queue run
33304 &` smtp_confirmation          `&  SMTP confirmation on => lines
33305 &` smtp_connection            `&  SMTP connections
33306 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33307 &` smtp_no_mail               `&  session with no MAIL commands
33308 &` smtp_protocol_error        `&  SMTP protocol errors
33309 &` smtp_syntax_error          `&  SMTP syntax errors
33310 &` subject                    `&  contents of &'Subject:'& on <= lines
33311 &` tls_certificate_verified   `&  certificate verification status
33312 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
33313 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
33314 &` tls_sni                    `&  TLS SNI on <= lines
33315 &` unknown_in_list            `&  DNS lookup failed in list match
33316
33317 &` all                        `&  all of the above
33318 .endd
33319 More details on each of these items follows:
33320
33321 .ilist
33322 .cindex "&%warn%& ACL verb" "log when skipping"
33323 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
33324 its conditions cannot be evaluated, a log line to this effect is written if
33325 this log selector is set.
33326 .next
33327 .cindex "log" "rewriting"
33328 .cindex "rewriting" "logging"
33329 &%address_rewrite%&: This applies both to global rewrites and per-transport
33330 rewrites, but not to rewrites in filters run as an unprivileged user (because
33331 such users cannot access the log).
33332 .next
33333 .cindex "log" "full parentage"
33334 &%all_parents%&: Normally only the original and final addresses are logged on
33335 delivery lines; with this selector, intermediate parents are given in
33336 parentheses between them.
33337 .next
33338 .cindex "log" "Exim arguments"
33339 .cindex "Exim arguments, logging"
33340 &%arguments%&: This causes Exim to write the arguments with which it was called
33341 to the main log, preceded by the current working directory. This is a debugging
33342 feature, added to make it easier to find out how certain MUAs call
33343 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
33344 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
33345 that are empty or that contain white space are quoted. Non-printing characters
33346 are shown as escape sequences. This facility cannot log unrecognized arguments,
33347 because the arguments are checked before the configuration file is read. The
33348 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
33349 between the caller and Exim.
33350 .next
33351 .cindex "log" "connection rejections"
33352 &%connection_reject%&: A log entry is written whenever an incoming SMTP
33353 connection is rejected, for whatever reason.
33354 .next
33355 .cindex "log" "delayed delivery"
33356 .cindex "delayed delivery, logging"
33357 &%delay_delivery%&: A log entry is written whenever a delivery process is not
33358 started for an incoming message because the load is too high or too many
33359 messages were received on one connection. Logging does not occur if no delivery
33360 process is started because &%queue_only%& is set or &%-odq%& was used.
33361 .next
33362 .cindex "log" "delivery duration"
33363 &%deliver_time%&: For each delivery, the amount of real time it has taken to
33364 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
33365 .next
33366 .cindex "log" "message size on delivery"
33367 .cindex "size" "of message"
33368 &%delivery_size%&: For each delivery, the size of message delivered is added to
33369 the &"=>"& line, tagged with S=.
33370 .next
33371 .cindex "log" "dnslist defer"
33372 .cindex "DNS list" "logging defer"
33373 .cindex "black list (DNS)"
33374 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
33375 DNS black list suffers a temporary error.
33376 .next
33377 .cindex "log" "ETRN commands"
33378 .cindex "ETRN" "logging"
33379 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
33380 is run to determine whether or not it is actually accepted. An invalid ETRN
33381 command, or one received within a message transaction is not logged by this
33382 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
33383 .next
33384 .cindex "log" "host lookup failure"
33385 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
33386 any addresses, or when a lookup of an IP address fails to find a host name, a
33387 log line is written. This logging does not apply to direct DNS lookups when
33388 routing email addresses, but it does apply to &"byname"& lookups.
33389 .next
33390 .cindex "log" "ident timeout"
33391 .cindex "RFC 1413" "logging timeout"
33392 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
33393 client's ident port times out.
33394 .next
33395 .cindex "log" "incoming interface"
33396 .cindex "interface" "logging"
33397 &%incoming_interface%&: The interface on which a message was received is added
33398 to the &"<="& line as an IP address in square brackets, tagged by I= and
33399 followed by a colon and the port number. The local interface and port are also
33400 added to other SMTP log lines, for example &"SMTP connection from"&, and to
33401 rejection lines.
33402 .next
33403 .cindex "log" "incoming remote port"
33404 .cindex "port" "logging remote"
33405 .cindex "TCP/IP" "logging incoming remote port"
33406 .vindex "&$sender_fullhost$&"
33407 .vindex "&$sender_rcvhost$&"
33408 &%incoming_port%&: The remote port number from which a message was received is
33409 added to log entries and &'Received:'& header lines, following the IP address
33410 in square brackets, and separated from it by a colon. This is implemented by
33411 changing the value that is put in the &$sender_fullhost$& and
33412 &$sender_rcvhost$& variables. Recording the remote port number has become more
33413 important with the widening use of NAT (see RFC 2505).
33414 .next
33415 .cindex "log" "dropped connection"
33416 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
33417 connection is unexpectedly dropped.
33418 .next
33419 .cindex "log" "outgoing remote port"
33420 .cindex "port" "logging outgoint remote"
33421 .cindex "TCP/IP" "logging ougtoing remote port"
33422 &%outgoing_port%&: The remote port number is added to delivery log lines (those
33423 containing => tags) following the IP address. This option is not included in
33424 the default setting, because for most ordinary configurations, the remote port
33425 number is always 25 (the SMTP port).
33426 .next
33427 .cindex "log" "process ids in"
33428 .cindex "pid (process id)" "in log lines"
33429 &%pid%&: The current process id is added to every log line, in square brackets,
33430 immediately after the time and date.
33431 .next
33432 .cindex "log" "queue run"
33433 .cindex "queue runner" "logging"
33434 &%queue_run%&: The start and end of every queue run are logged.
33435 .next
33436 .cindex "log" "queue time"
33437 &%queue_time%&: The amount of time the message has been in the queue on the
33438 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
33439 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
33440 includes reception time as well as the delivery time for the current address.
33441 This means that it may be longer than the difference between the arrival and
33442 delivery log line times, because the arrival log line is not written until the
33443 message has been successfully received.
33444 .next
33445 &%queue_time_overall%&: The amount of time the message has been in the queue on
33446 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
33447 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
33448 message, so it includes reception time as well as the total delivery time.
33449 .next
33450 .cindex "log" "recipients"
33451 &%received_recipients%&: The recipients of a message are listed in the main log
33452 as soon as the message is received. The list appears at the end of the log line
33453 that is written when a message is received, preceded by the word &"for"&. The
33454 addresses are listed after they have been qualified, but before any rewriting
33455 has taken place.
33456 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
33457 in the list.
33458 .next
33459 .cindex "log" "sender reception"
33460 &%received_sender%&: The unrewritten original sender of a message is added to
33461 the end of the log line that records the message's arrival, after the word
33462 &"from"& (before the recipients if &%received_recipients%& is also set).
33463 .next
33464 .cindex "log" "header lines for rejection"
33465 &%rejected_header%&: If a message's header has been received at the time a
33466 rejection is written to the reject log, the complete header is added to the
33467 log. Header logging can be turned off individually for messages that are
33468 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
33469 .next
33470 .cindex "log" "retry defer"
33471 &%retry_defer%&: A log line is written if a delivery is deferred because a
33472 retry time has not yet been reached. However, this &"retry time not reached"&
33473 message is always omitted from individual message logs after the first delivery
33474 attempt.
33475 .next
33476 .cindex "log" "return path"
33477 &%return_path_on_delivery%&: The return path that is being transmitted with
33478 the message is included in delivery and bounce lines, using the tag P=.
33479 This is omitted if no delivery actually happens, for example, if routing fails,
33480 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
33481 .next
33482 .cindex "log" "sender on delivery"
33483 &%sender_on_delivery%&: The message's sender address is added to every delivery
33484 and bounce line, tagged by F= (for &"from"&).
33485 This is the original sender that was received with the message; it is not
33486 necessarily the same as the outgoing return path.
33487 .next
33488 .cindex "log" "sender verify failure"
33489 &%sender_verify_fail%&: If this selector is unset, the separate log line that
33490 gives details of a sender verification failure is not written. Log lines for
33491 the rejection of SMTP commands contain just &"sender verify failed"&, so some
33492 detail is lost.
33493 .next
33494 .cindex "log" "size rejection"
33495 &%size_reject%&: A log line is written whenever a message is rejected because
33496 it is too big.
33497 .next
33498 .cindex "log" "frozen messages; skipped"
33499 .cindex "frozen messages" "logging skipping"
33500 &%skip_delivery%&: A log line is written whenever a message is skipped during a
33501 queue run because it is frozen or because another process is already delivering
33502 it.
33503 .cindex "&""spool file is locked""&"
33504 The message that is written is &"spool file is locked"&.
33505 .next
33506 .cindex "log" "smtp confirmation"
33507 .cindex "SMTP" "logging confirmation"
33508 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
33509 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
33510 A number of MTAs (including Exim) return an identifying string in this
33511 response.
33512 .next
33513 .cindex "log" "SMTP connections"
33514 .cindex "SMTP" "logging connections"
33515 &%smtp_connection%&: A log line is written whenever an SMTP connection is
33516 established or closed, unless the connection is from a host that matches
33517 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
33518 only when the closure is unexpected.) This applies to connections from local
33519 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
33520 dropped in the middle of a message, a log line is always written, whether or
33521 not this selector is set, but otherwise nothing is written at the start and end
33522 of connections unless this selector is enabled.
33523
33524 For TCP/IP connections to an Exim daemon, the current number of connections is
33525 included in the log message for each new connection, but note that the count is
33526 reset if the daemon is restarted.
33527 Also, because connections are closed (and the closure is logged) in
33528 subprocesses, the count may not include connections that have been closed but
33529 whose termination the daemon has not yet noticed. Thus, while it is possible to
33530 match up the opening and closing of connections in the log, the value of the
33531 logged counts may not be entirely accurate.
33532 .next
33533 .cindex "log" "SMTP transaction; incomplete"
33534 .cindex "SMTP" "logging incomplete transactions"
33535 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
33536 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
33537 and the message sender plus any accepted recipients are included in the log
33538 line. This can provide evidence of dictionary attacks.
33539 .next
33540 .cindex "log" "non-MAIL SMTP sessions"
33541 .cindex "MAIL" "logging session without"
33542 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
33543 connection terminates without having issued a MAIL command. This includes both
33544 the case when the connection is dropped, and the case when QUIT is used. It
33545 does not include cases where the connection is rejected right at the start (by
33546 an ACL, or because there are too many connections, or whatever). These cases
33547 already have their own log lines.
33548
33549 The log line that is written contains the identity of the client in the usual
33550 way, followed by D= and a time, which records the duration of the connection.
33551 If the connection was authenticated, this fact is logged exactly as it is for
33552 an incoming message, with an A= item. If the connection was encrypted, CV=,
33553 DN=, and X= items may appear as they do for an incoming message, controlled by
33554 the same logging options.
33555
33556 Finally, if any SMTP commands were issued during the connection, a C= item
33557 is added to the line, listing the commands that were used. For example,
33558 .code
33559 C=EHLO,QUIT
33560 .endd
33561 shows that the client issued QUIT straight after EHLO. If there were fewer
33562 than 20 commands, they are all listed. If there were more than 20 commands,
33563 the last 20 are listed, preceded by &"..."&. However, with the default
33564 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
33565 have been aborted before 20 non-mail commands are processed.
33566 .next
33567 .cindex "log" "SMTP protocol error"
33568 .cindex "SMTP" "logging protocol error"
33569 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
33570 encountered. Exim does not have perfect detection of all protocol errors
33571 because of transmission delays and the use of pipelining. If PIPELINING has
33572 been advertised to a client, an Exim server assumes that the client will use
33573 it, and therefore it does not count &"expected"& errors (for example, RCPT
33574 received after rejecting MAIL) as protocol errors.
33575 .next
33576 .cindex "SMTP" "logging syntax errors"
33577 .cindex "SMTP" "syntax errors; logging"
33578 .cindex "SMTP" "unknown command; logging"
33579 .cindex "log" "unknown SMTP command"
33580 .cindex "log" "SMTP syntax error"
33581 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
33582 encountered. An unrecognized command is treated as a syntax error. For an
33583 external connection, the host identity is given; for an internal connection
33584 using &%-bs%& the sender identification (normally the calling user) is given.
33585 .next
33586 .cindex "log" "subject"
33587 .cindex "subject, logging"
33588 &%subject%&: The subject of the message is added to the arrival log line,
33589 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
33590 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
33591 specifies whether characters with values greater than 127 should be logged
33592 unchanged, or whether they should be rendered as escape sequences.
33593 .next
33594 .cindex "log" "certificate verification"
33595 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
33596 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
33597 verified, and &`CV=no`& if not.
33598 .next
33599 .cindex "log" "TLS cipher"
33600 .cindex "TLS" "logging cipher"
33601 &%tls_cipher%&: When a message is sent or received over an encrypted
33602 connection, the cipher suite used is added to the log line, preceded by X=.
33603 .next
33604 .cindex "log" "TLS peer DN"
33605 .cindex "TLS" "logging peer DN"
33606 &%tls_peerdn%&: When a message is sent or received over an encrypted
33607 connection, and a certificate is supplied by the remote host, the peer DN is
33608 added to the log line, preceded by DN=.
33609 .next
33610 .cindex "log" "TLS SNI"
33611 .cindex "TLS" "logging SNI"
33612 &%tls_sni%&: When a message is received over an encrypted connection, and
33613 the remote host provided the Server Name Indication extension, the SNI is
33614 added to the log line, preceded by SNI=.
33615 .next
33616 .cindex "log" "DNS failure in list"
33617 &%unknown_in_list%&: This setting causes a log entry to be written when the
33618 result of a list match is failure because a DNS lookup failed.
33619 .endlist
33620
33621
33622 .section "Message log" "SECID260"
33623 .cindex "message" "log file for"
33624 .cindex "log" "message log; description of"
33625 .cindex "&_msglog_& directory"
33626 .oindex "&%preserve_message_logs%&"
33627 In addition to the general log files, Exim writes a log file for each message
33628 that it handles. The names of these per-message logs are the message ids, and
33629 they are kept in the &_msglog_& sub-directory of the spool directory. Each
33630 message log contains copies of the log lines that apply to the message. This
33631 makes it easier to inspect the status of an individual message without having
33632 to search the main log. A message log is deleted when processing of the message
33633 is complete, unless &%preserve_message_logs%& is set, but this should be used
33634 only with great care because they can fill up your disk very quickly.
33635
33636 On a heavily loaded system, it may be desirable to disable the use of
33637 per-message logs, in order to reduce disk I/O. This can be done by setting the
33638 &%message_logs%& option false.
33639 .ecindex IIDloggen
33640
33641
33642
33643
33644 . ////////////////////////////////////////////////////////////////////////////
33645 . ////////////////////////////////////////////////////////////////////////////
33646
33647 .chapter "Exim utilities" "CHAPutils"
33648 .scindex IIDutils "utilities"
33649 A number of utility scripts and programs are supplied with Exim and are
33650 described in this chapter. There is also the Exim Monitor, which is covered in
33651 the next chapter. The utilities described here are:
33652
33653 .itable none 0 0 3  7* left  15* left  40* left
33654 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
33655   "list what Exim processes are doing"
33656 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
33657 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
33658 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
33659 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
33660                                                 various criteria"
33661 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
33662 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
33663   "extract statistics from the log"
33664 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
33665   "check address acceptance from given IP"
33666 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
33667 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
33668 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
33669 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
33670 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
33671 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
33672 .endtable
33673
33674 Another utility that might be of use to sites with many MTAs is Tom Kistner's
33675 &'exilog'&. It provides log visualizations across multiple Exim servers. See
33676 &url(http://duncanthrax.net/exilog/) for details.
33677
33678
33679
33680
33681 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
33682 .cindex "&'exiwhat'&"
33683 .cindex "process, querying"
33684 .cindex "SIGUSR1"
33685 On operating systems that can restart a system call after receiving a signal
33686 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
33687 a line describing what it is doing to the file &_exim-process.info_& in the
33688 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
33689 processes it can find, having first emptied the file. It then waits for one
33690 second to allow the Exim processes to react before displaying the results. In
33691 order to run &'exiwhat'& successfully you have to have sufficient privilege to
33692 send the signal to the Exim processes, so it is normally run as root.
33693
33694 &*Warning*&: This is not an efficient process. It is intended for occasional
33695 use by system administrators. It is not sensible, for example, to set up a
33696 script that sends SIGUSR1 signals to Exim processes at short intervals.
33697
33698
33699 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
33700 varies in different operating systems. Not only are different options used,
33701 but the format of the output is different. For this reason, there are some
33702 system configuration options that configure exactly how &'exiwhat'& works. If
33703 it doesn't seem to be working for you, check the following compile-time
33704 options:
33705 .display
33706 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
33707 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
33708 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
33709 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
33710 .endd
33711 An example of typical output from &'exiwhat'& is
33712 .code
33713 164 daemon: -q1h, listening on port 25
33714 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
33715 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
33716   [10.19.42.42] (editor@ref.example)
33717 10592 handling incoming call from [192.168.243.242]
33718 10628 accepting a local non-SMTP message
33719 .endd
33720 The first number in the output line is the process number. The third line has
33721 been split here, in order to fit it on the page.
33722
33723
33724
33725 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
33726 .cindex "&'exiqgrep'&"
33727 .cindex "queue" "grepping"
33728 This utility is a Perl script contributed by Matt Hubbard. It runs
33729 .code
33730 exim -bpu
33731 .endd
33732 to obtain a queue listing with undelivered recipients only, and then greps the
33733 output to select messages that match given criteria. The following selection
33734 options are available:
33735
33736 .vlist
33737 .vitem &*-f*&&~<&'regex'&>
33738 Match the sender address. The field that is tested is enclosed in angle
33739 brackets, so you can test for bounce messages with
33740 .code
33741 exiqgrep -f '^<>$'
33742 .endd
33743 .vitem &*-r*&&~<&'regex'&>
33744 Match a recipient address. The field that is tested is not enclosed in angle
33745 brackets.
33746
33747 .vitem &*-s*&&~<&'regex'&>
33748 Match against the size field.
33749
33750 .vitem &*-y*&&~<&'seconds'&>
33751 Match messages that are younger than the given time.
33752
33753 .vitem &*-o*&&~<&'seconds'&>
33754 Match messages that are older than the given time.
33755
33756 .vitem &*-z*&
33757 Match only frozen messages.
33758
33759 .vitem &*-x*&
33760 Match only non-frozen messages.
33761 .endlist
33762
33763 The following options control the format of the output:
33764
33765 .vlist
33766 .vitem &*-c*&
33767 Display only the count of matching messages.
33768
33769 .vitem &*-l*&
33770 Long format &-- display the full message information as output by Exim. This is
33771 the default.
33772
33773 .vitem &*-i*&
33774 Display message ids only.
33775
33776 .vitem &*-b*&
33777 Brief format &-- one line per message.
33778
33779 .vitem &*-R*&
33780 Display messages in reverse order.
33781 .endlist
33782
33783 There is one more option, &%-h%&, which outputs a list of options.
33784
33785
33786
33787 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
33788 .cindex "&'exiqsumm'&"
33789 .cindex "queue" "summary"
33790 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
33791 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
33792 running a command such as
33793 .code
33794 exim -bp | exiqsumm
33795 .endd
33796 The output consists of one line for each domain that has messages waiting for
33797 it, as in the following example:
33798 .code
33799 3   2322   74m   66m  msn.com.example
33800 .endd
33801 Each line lists the number of pending deliveries for a domain, their total
33802 volume, and the length of time that the oldest and the newest messages have
33803 been waiting. Note that the number of pending deliveries is greater than the
33804 number of messages when messages have more than one recipient.
33805
33806 A summary line is output at the end. By default the output is sorted on the
33807 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
33808 the output to be sorted by oldest message and by count of messages,
33809 respectively. There are also three options that split the messages for each
33810 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
33811 separates frozen messages, and &%-s%& separates messages according to their
33812 sender.
33813
33814 The output of &'exim -bp'& contains the original addresses in the message, so
33815 this also applies to the output from &'exiqsumm'&. No domains from addresses
33816 generated by aliasing or forwarding are included (unless the &%one_time%&
33817 option of the &(redirect)& router has been used to convert them into &"top
33818 level"& addresses).
33819
33820
33821
33822
33823 .section "Extracting specific information from the log (exigrep)" &&&
33824          "SECTextspeinf"
33825 .cindex "&'exigrep'&"
33826 .cindex "log" "extracts; grepping for"
33827 The &'exigrep'& utility is a Perl script that searches one or more main log
33828 files for entries that match a given pattern. When it finds a match, it
33829 extracts all the log entries for the relevant message, not just those that
33830 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
33831 given message, or all mail for a given user, or for a given host, for example.
33832 The input files can be in Exim log format or syslog format.
33833 If a matching log line is not associated with a specific message, it is
33834 included in &'exigrep'&'s output without any additional lines. The usage is:
33835 .display
33836 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
33837 .endd
33838 If no log file names are given on the command line, the standard input is read.
33839
33840 The &%-t%& argument specifies a number of seconds. It adds an additional
33841 condition for message selection. Messages that are complete are shown only if
33842 they spent more than <&'n'&> seconds on the queue.
33843
33844 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
33845 makes it case-sensitive. This may give a performance improvement when searching
33846 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
33847 option; with &%-I%& they do not. In both cases it is possible to change the
33848 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
33849
33850 The &%-l%& option means &"literal"&, that is, treat all characters in the
33851 pattern as standing for themselves. Otherwise the pattern must be a Perl
33852 regular expression.
33853
33854 The &%-v%& option inverts the matching condition. That is, a line is selected
33855 if it does &'not'& match the pattern.
33856
33857 If the location of a &'zcat'& command is known from the definition of
33858 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
33859 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
33860
33861
33862 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
33863 .cindex "&'exipick'&"
33864 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
33865 lists messages from the queue according to a variety of criteria. For details
33866 of &'exipick'&'s facilities, visit the web page at
33867 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33868 the &%--help%& option.
33869
33870
33871 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33872 .cindex "log" "cycling local files"
33873 .cindex "cycling logs"
33874 .cindex "&'exicyclog'&"
33875 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33876 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33877 you are using log files with datestamps in their names (see section
33878 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33879 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33880 There are two command line options for &'exicyclog'&:
33881 .ilist
33882 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33883 default that is set when Exim is built. The default default is 10.
33884 .next
33885 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33886 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33887 overriding the script's default, which is to find the setting from Exim's
33888 configuration.
33889 .endlist
33890
33891 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33892 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33893 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33894 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33895 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33896 logs are handled similarly.
33897
33898 If the limit is greater than 99, the script uses 3-digit numbers such as
33899 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33900 to one that is greater, or &'vice versa'&, you will have to fix the names of
33901 any existing log files.
33902
33903 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33904 the end are deleted. All files with numbers greater than 01 are compressed,
33905 using a compression command which is configured by the COMPRESS_COMMAND
33906 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33907 root &%crontab%& entry of the form
33908 .code
33909 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33910 .endd
33911 assuming you have used the name &"exim"& for the Exim user. You can run
33912 &'exicyclog'& as root if you wish, but there is no need.
33913
33914
33915
33916 .section "Mail statistics (eximstats)" "SECTmailstat"
33917 .cindex "statistics"
33918 .cindex "&'eximstats'&"
33919 A Perl script called &'eximstats'& is provided for extracting statistical
33920 information from log files. The output is either plain text, or HTML.
33921 Exim log files are also supported by the &'Lire'& system produced by the
33922 LogReport Foundation &url(http://www.logreport.org).
33923
33924 The &'eximstats'& script has been hacked about quite a bit over time. The
33925 latest version is the result of some extensive revision by Steve Campbell. A
33926 lot of information is given by default, but there are options for suppressing
33927 various parts of it. Following any options, the arguments to the script are a
33928 list of files, which should be main log files. For example:
33929 .code
33930 eximstats -nr /var/spool/exim/log/mainlog.01
33931 .endd
33932 By default, &'eximstats'& extracts information about the number and volume of
33933 messages received from or delivered to various hosts. The information is sorted
33934 both by message count and by volume, and the top fifty hosts in each category
33935 are listed on the standard output. Similar information, based on email
33936 addresses or domains instead of hosts can be requested by means of various
33937 options. For messages delivered and received locally, similar statistics are
33938 also produced per user.
33939
33940 The output also includes total counts and statistics about delivery errors, and
33941 histograms showing the number of messages received and deliveries made in each
33942 hour of the day. A delivery with more than one address in its envelope (for
33943 example, an SMTP transaction with more than one RCPT command) is counted
33944 as a single delivery by &'eximstats'&.
33945
33946 Though normally more deliveries than receipts are reported (as messages may
33947 have multiple recipients), it is possible for &'eximstats'& to report more
33948 messages received than delivered, even though the queue is empty at the start
33949 and end of the period in question. If an incoming message contains no valid
33950 recipients, no deliveries are recorded for it. A bounce message is handled as
33951 an entirely separate message.
33952
33953 &'eximstats'& always outputs a grand total summary giving the volume and number
33954 of messages received and deliveries made, and the number of hosts involved in
33955 each case. It also outputs the number of messages that were delayed (that is,
33956 not completely delivered at the first attempt), and the number that had at
33957 least one address that failed.
33958
33959 The remainder of the output is in sections that can be independently disabled
33960 or modified by various options. It consists of a summary of deliveries by
33961 transport, histograms of messages received and delivered per time interval
33962 (default per hour), information about the time messages spent on the queue,
33963 a list of relayed messages, lists of the top fifty sending hosts, local
33964 senders, destination hosts, and destination local users by count and by volume,
33965 and a list of delivery errors that occurred.
33966
33967 The relay information lists messages that were actually relayed, that is, they
33968 came from a remote host and were directly delivered to some other remote host,
33969 without being processed (for example, for aliasing or forwarding) locally.
33970
33971 There are quite a few options for &'eximstats'& to control exactly what it
33972 outputs. These are documented in the Perl script itself, and can be extracted
33973 by running the command &(perldoc)& on the script. For example:
33974 .code
33975 perldoc /usr/exim/bin/eximstats
33976 .endd
33977
33978 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33979 .cindex "&'exim_checkaccess'&"
33980 .cindex "policy control" "checking access"
33981 .cindex "checking access"
33982 The &%-bh%& command line argument allows you to run a fake SMTP session with
33983 debugging output, in order to check what Exim is doing when it is applying
33984 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33985 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33986 sometimes you just want to answer the question &"Does this address have
33987 access?"& without bothering with any further details.
33988
33989 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33990 two arguments, an IP address and an email address:
33991 .code
33992 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33993 .endd
33994 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33995 given email address would be accepted in a RCPT command in a TCP/IP
33996 connection from the host with the given IP address. The output of the utility
33997 is either the word &"accepted"&, or the SMTP error response, for example:
33998 .code
33999 Rejected:
34000 550 Relay not permitted
34001 .endd
34002 When running this test, the utility uses &`<>`& as the envelope sender address
34003 for the MAIL command, but you can change this by providing additional
34004 options. These are passed directly to the Exim command. For example, to specify
34005 that the test is to be run with the sender address &'himself@there.example'&
34006 you can use:
34007 .code
34008 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34009                  -f himself@there.example
34010 .endd
34011 Note that these additional Exim command line items must be given after the two
34012 mandatory arguments.
34013
34014 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34015 while running its checks. You can run checks that include callouts by using
34016 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34017
34018
34019
34020 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34021 .cindex "DBM" "building dbm files"
34022 .cindex "building DBM files"
34023 .cindex "&'exim_dbmbuild'&"
34024 .cindex "lower casing"
34025 .cindex "binary zero" "in lookup key"
34026 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34027 the format used by the &(lsearch)& lookup (see section
34028 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34029 names as keys and the remainder of the information as data. The lower-casing
34030 can be prevented by calling the program with the &%-nolc%& option.
34031
34032 A terminating zero is included as part of the key string. This is expected by
34033 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34034 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34035 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34036 files.
34037
34038 The program requires two arguments: the name of the input file (which can be a
34039 single hyphen to indicate the standard input), and the name of the output file.
34040 It creates the output under a temporary name, and then renames it if all went
34041 well.
34042
34043 .cindex "USE_DB"
34044 If the native DB interface is in use (USE_DB is set in a compile-time
34045 configuration file &-- this is common in free versions of Unix) the two file
34046 names must be different, because in this mode the Berkeley DB functions create
34047 a single output file using exactly the name given. For example,
34048 .code
34049 exim_dbmbuild /etc/aliases /etc/aliases.db
34050 .endd
34051 reads the system alias file and creates a DBM version of it in
34052 &_/etc/aliases.db_&.
34053
34054 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34055 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34056 environment, the suffixes are added to the second argument of
34057 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34058 when the Berkeley functions are used in compatibility mode (though this is not
34059 recommended), because in that case it adds a &_.db_& suffix to the file name.
34060
34061 If a duplicate key is encountered, the program outputs a warning, and when it
34062 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34063 option is used. By default, only the first of a set of duplicates is used &--
34064 this makes it compatible with &(lsearch)& lookups. There is an option
34065 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34066 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34067 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34068 return code is 2.
34069
34070
34071
34072
34073 .section "Finding individual retry times (exinext)" "SECTfinindret"
34074 .cindex "retry" "times"
34075 .cindex "&'exinext'&"
34076 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34077 fish specific information out of the retry database. Given a mail domain (or a
34078 complete address), it looks up the hosts for that domain, and outputs any retry
34079 information for the hosts or for the domain. At present, the retry information
34080 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34081 output. For example:
34082 .code
34083 $ exinext piglet@milne.fict.example
34084 kanga.milne.example:192.168.8.1 error 146: Connection refused
34085   first failed: 21-Feb-1996 14:57:34
34086   last tried:   21-Feb-1996 14:57:34
34087   next try at:  21-Feb-1996 15:02:34
34088 roo.milne.example:192.168.8.3 error 146: Connection refused
34089   first failed: 20-Jan-1996 13:12:08
34090   last tried:   21-Feb-1996 11:42:03
34091   next try at:  21-Feb-1996 19:42:03
34092   past final cutoff time
34093 .endd
34094 You can also give &'exinext'& a local part, without a domain, and it
34095 will give any retry information for that local part in your default domain.
34096 A message id can be used to obtain retry information pertaining to a specific
34097 message. This exists only when an attempt to deliver a message to a remote host
34098 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34099 &'exinext'& is not particularly efficient, but then it is not expected to be
34100 run very often.
34101
34102 The &'exinext'& utility calls Exim to find out information such as the location
34103 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34104 passed on to the &'exim'& commands. The first specifies an alternate Exim
34105 configuration file, and the second sets macros for use within the configuration
34106 file. These features are mainly to help in testing, but might also be useful in
34107 environments where more than one configuration file is in use.
34108
34109
34110
34111 .section "Hints database maintenance" "SECThindatmai"
34112 .cindex "hints database" "maintenance"
34113 .cindex "maintaining Exim's hints database"
34114 Three utility programs are provided for maintaining the DBM files that Exim
34115 uses to contain its delivery hint information. Each program requires two
34116 arguments. The first specifies the name of Exim's spool directory, and the
34117 second is the name of the database it is to operate on. These are as follows:
34118
34119 .ilist
34120 &'retry'&: the database of retry information
34121 .next
34122 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34123 for remote hosts
34124 .next
34125 &'callout'&: the callout cache
34126 .next
34127 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34128 .next
34129 &'misc'&: other hints data
34130 .endlist
34131
34132 The &'misc'& database is used for
34133
34134 .ilist
34135 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34136 .next
34137 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34138 &(smtp)& transport)
34139 .endlist
34140
34141
34142
34143 .section "exim_dumpdb" "SECID261"
34144 .cindex "&'exim_dumpdb'&"
34145 The entire contents of a database are written to the standard output by the
34146 &'exim_dumpdb'& program, which has no options or arguments other than the
34147 spool and database names. For example, to dump the retry database:
34148 .code
34149 exim_dumpdb /var/spool/exim retry
34150 .endd
34151 Two lines of output are produced for each entry:
34152 .code
34153 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34154 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34155 .endd
34156 The first item on the first line is the key of the record. It starts with one
34157 of the letters R, or T, depending on whether it refers to a routing or
34158 transport retry. For a local delivery, the next part is the local address; for
34159 a remote delivery it is the name of the remote host, followed by its failing IP
34160 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34161 transport). If the remote port is not the standard one (port 25), it is added
34162 to the IP address. Then there follows an error code, an additional error code,
34163 and a textual description of the error.
34164
34165 The three times on the second line are the time of first failure, the time of
34166 the last delivery attempt, and the computed time for the next attempt. The line
34167 ends with an asterisk if the cutoff time for the last retry rule has been
34168 exceeded.
34169
34170 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34171 consists of a host name followed by a list of ids for messages that are or were
34172 waiting to be delivered to that host. If there are a very large number for any
34173 one host, continuation records, with a sequence number added to the host name,
34174 may be seen. The data in these records is often out of date, because a message
34175 may be routed to several alternative hosts, and Exim makes no effort to keep
34176 cross-references.
34177
34178
34179
34180 .section "exim_tidydb" "SECID262"
34181 .cindex "&'exim_tidydb'&"
34182 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34183 database. If run with no options, it removes all records that are more than 30
34184 days old. The age is calculated from the date and time that the record was last
34185 updated. Note that, in the case of the retry database, it is &'not'& the time
34186 since the first delivery failure. Information about a host that has been down
34187 for more than 30 days will remain in the database, provided that the record is
34188 updated sufficiently often.
34189
34190 The cutoff date can be altered by means of the &%-t%& option, which must be
34191 followed by a time. For example, to remove all records older than a week from
34192 the retry database:
34193 .code
34194 exim_tidydb -t 7d /var/spool/exim retry
34195 .endd
34196 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34197 message ids. In the former these appear as data in records keyed by host &--
34198 they were messages that were waiting for that host &-- and in the latter they
34199 are the keys for retry information for messages that have suffered certain
34200 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34201 message ids in database records are those of messages that are still on the
34202 queue. Message ids for messages that no longer exist are removed from
34203 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34204 For the &'retry'& database, records whose keys are non-existent message ids are
34205 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34206 whenever it removes information from the database.
34207
34208 Certain records are automatically removed by Exim when they are no longer
34209 needed, but others are not. For example, if all the MX hosts for a domain are
34210 down, a retry record is created for each one. If the primary MX host comes back
34211 first, its record is removed when Exim successfully delivers to it, but the
34212 records for the others remain because Exim has not tried to use those hosts.
34213
34214 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34215 hints databases. You should do this at a quiet time of day, because it requires
34216 a database to be locked (and therefore inaccessible to Exim) while it does its
34217 work. Removing records from a DBM file does not normally make the file smaller,
34218 but all the common DBM libraries are able to re-use the space that is released.
34219 After an initial phase of increasing in size, the databases normally reach a
34220 point at which they no longer get any bigger, as long as they are regularly
34221 tidied.
34222
34223 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34224 databases is likely to keep on increasing.
34225
34226
34227
34228
34229 .section "exim_fixdb" "SECID263"
34230 .cindex "&'exim_fixdb'&"
34231 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34232 Its main use is for testing Exim, but it might also be occasionally useful for
34233 getting round problems in a live system. It has no options, and its interface
34234 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34235 key of a database record can then be entered, and the data for that record is
34236 displayed.
34237
34238 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34239 except the &'retry'& database, that is the only operation that can be carried
34240 out. For the &'retry'& database, each field is output preceded by a number, and
34241 data for individual fields can be changed by typing the field number followed
34242 by new data, for example:
34243 .code
34244 > 4 951102:1000
34245 .endd
34246 resets the time of the next delivery attempt. Time values are given as a
34247 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34248 used as optional separators.
34249
34250
34251
34252
34253 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34254 .cindex "mailbox" "maintenance"
34255 .cindex "&'exim_lock'&"
34256 .cindex "locking mailboxes"
34257 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34258 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34259 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34260 a user agent while investigating a problem. The utility requires the name of
34261 the file as its first argument. If the locking is successful, the second
34262 argument is run as a command (using C's &[system()]& function); if there is no
34263 second argument, the value of the SHELL environment variable is used; if this
34264 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34265 is unlocked and the utility ends. The following options are available:
34266
34267 .vlist
34268 .vitem &%-fcntl%&
34269 Use &[fcntl()]& locking on the open mailbox.
34270
34271 .vitem &%-flock%&
34272 Use &[flock()]& locking on the open mailbox, provided the operating system
34273 supports it.
34274
34275 .vitem &%-interval%&
34276 This must be followed by a number, which is a number of seconds; it sets the
34277 interval to sleep between retries (default 3).
34278
34279 .vitem &%-lockfile%&
34280 Create a lock file before opening the mailbox.
34281
34282 .vitem &%-mbx%&
34283 Lock the mailbox using MBX rules.
34284
34285 .vitem &%-q%&
34286 Suppress verification output.
34287
34288 .vitem &%-retries%&
34289 This must be followed by a number; it sets the number of times to try to get
34290 the lock (default 10).
34291
34292 .vitem &%-restore_time%&
34293 This option causes &%exim_lock%& to restore the modified and read times to the
34294 locked file before exiting. This allows you to access a locked mailbox (for
34295 example, to take a backup copy) without disturbing the times that the user
34296 subsequently sees.
34297
34298 .vitem &%-timeout%&
34299 This must be followed by a number, which is a number of seconds; it sets a
34300 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
34301 default), a non-blocking call is used.
34302
34303 .vitem &%-v%&
34304 Generate verbose output.
34305 .endlist
34306
34307 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
34308 default is to create a lock file and also to use &[fcntl()]& locking on the
34309 mailbox, which is the same as Exim's default. The use of &%-flock%& or
34310 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
34311 requires that the directory containing the file be writeable. Locking by lock
34312 file does not last for ever; Exim assumes that a lock file is expired if it is
34313 more than 30 minutes old.
34314
34315 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
34316 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
34317 to be taken out on the open mailbox, and an exclusive lock on the file
34318 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
34319 number of the mailbox file. When the locking is released, if an exclusive lock
34320 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
34321
34322 The default output contains verification of the locking that takes place. The
34323 &%-v%& option causes some additional information to be given. The &%-q%& option
34324 suppresses all output except error messages.
34325
34326 A command such as
34327 .code
34328 exim_lock /var/spool/mail/spqr
34329 .endd
34330 runs an interactive shell while the file is locked, whereas
34331 .display
34332 &`exim_lock -q /var/spool/mail/spqr <<End`&
34333 <&'some commands'&>
34334 &`End`&
34335 .endd
34336 runs a specific non-interactive sequence of commands while the file is locked,
34337 suppressing all verification output. A single command can be run by a command
34338 such as
34339 .code
34340 exim_lock -q /var/spool/mail/spqr \
34341   "cp /var/spool/mail/spqr /some/where"
34342 .endd
34343 Note that if a command is supplied, it must be entirely contained within the
34344 second argument &-- hence the quotes.
34345 .ecindex IIDutils
34346
34347
34348 . ////////////////////////////////////////////////////////////////////////////
34349 . ////////////////////////////////////////////////////////////////////////////
34350
34351 .chapter "The Exim monitor" "CHAPeximon"
34352 .scindex IIDeximon "Exim monitor" "description"
34353 .cindex "X-windows"
34354 .cindex "&'eximon'&"
34355 .cindex "Local/eximon.conf"
34356 .cindex "&_exim_monitor/EDITME_&"
34357 The Exim monitor is an application which displays in an X window information
34358 about the state of Exim's queue and what Exim is doing. An admin user can
34359 perform certain operations on messages from this GUI interface; however all
34360 such facilities are also available from the command line, and indeed, the
34361 monitor itself makes use of the command line to perform any actions requested.
34362
34363
34364
34365 .section "Running the monitor" "SECID264"
34366 The monitor is started by running the script called &'eximon'&. This is a shell
34367 script that sets up a number of environment variables, and then runs the
34368 binary called &_eximon.bin_&. The default appearance of the monitor window can
34369 be changed by editing the &_Local/eximon.conf_& file created by editing
34370 &_exim_monitor/EDITME_&. Comments in that file describe what the various
34371 parameters are for.
34372
34373 The parameters that get built into the &'eximon'& script can be overridden for
34374 a particular invocation by setting up environment variables of the same names,
34375 preceded by &`EXIMON_`&. For example, a shell command such as
34376 .code
34377 EXIMON_LOG_DEPTH=400 eximon
34378 .endd
34379 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
34380 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
34381 overrides the Exim log file configuration. This makes it possible to have
34382 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
34383 syslog messages are routed to a file on the local host.
34384
34385 X resources can be used to change the appearance of the window in the normal
34386 way. For example, a resource setting of the form
34387 .code
34388 Eximon*background: gray94
34389 .endd
34390 changes the colour of the background to light grey rather than white. The
34391 stripcharts are drawn with both the data lines and the reference lines in
34392 black. This means that the reference lines are not visible when on top of the
34393 data. However, their colour can be changed by setting a resource called
34394 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
34395 For example, if your X server is running Unix, you could set up lighter
34396 reference lines in the stripcharts by obeying
34397 .code
34398 xrdb -merge <<End
34399 Eximon*highlight: gray
34400 End
34401 .endd
34402 .cindex "admin user"
34403 In order to see the contents of messages on the queue, and to operate on them,
34404 &'eximon'& must either be run as root or by an admin user.
34405
34406 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
34407 contain X11 resource parameters interpreted by the X11 library.  In addition,
34408 if the first parameter starts with the string "gdb" then it is removed and the
34409 binary is invoked under gdb (the parameter is used as the gdb command-name, so
34410 versioned variants of gdb can be invoked).
34411
34412 The monitor's window is divided into three parts. The first contains one or
34413 more stripcharts and two action buttons, the second contains a &"tail"& of the
34414 main log file, and the third is a display of the queue of messages awaiting
34415 delivery, with two more action buttons. The following sections describe these
34416 different parts of the display.
34417
34418
34419
34420
34421 .section "The stripcharts" "SECID265"
34422 .cindex "stripchart"
34423 The first stripchart is always a count of messages on the queue. Its name can
34424 be configured by setting QUEUE_STRIPCHART_NAME in the
34425 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
34426 configuration script by regular expression matches on log file entries, making
34427 it possible to display, for example, counts of messages delivered to certain
34428 hosts or using certain transports. The supplied defaults display counts of
34429 received and delivered messages, and of local and SMTP deliveries. The default
34430 period between stripchart updates is one minute; this can be adjusted by a
34431 parameter in the &_Local/eximon.conf_& file.
34432
34433 The stripchart displays rescale themselves automatically as the value they are
34434 displaying changes. There are always 10 horizontal lines in each chart; the
34435 title string indicates the value of each division when it is greater than one.
34436 For example, &"x2"& means that each division represents a value of 2.
34437
34438 It is also possible to have a stripchart which shows the percentage fullness of
34439 a particular disk partition, which is useful when local deliveries are confined
34440 to a single partition.
34441
34442 .cindex "&%statvfs%& function"
34443 This relies on the availability of the &[statvfs()]& function or equivalent in
34444 the operating system. Most, but not all versions of Unix that support Exim have
34445 this. For this particular stripchart, the top of the chart always represents
34446 100%, and the scale is given as &"x10%"&. This chart is configured by setting
34447 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
34448 &_Local/eximon.conf_& file.
34449
34450
34451
34452
34453 .section "Main action buttons" "SECID266"
34454 .cindex "size" "of monitor window"
34455 .cindex "Exim monitor" "window size"
34456 .cindex "window size"
34457 Below the stripcharts there is an action button for quitting the monitor. Next
34458 to this is another button marked &"Size"&. They are placed here so that
34459 shrinking the window to its default minimum size leaves just the queue count
34460 stripchart and these two buttons visible. Pressing the &"Size"& button causes
34461 the window to expand to its maximum size, unless it is already at the maximum,
34462 in which case it is reduced to its minimum.
34463
34464 When expanding to the maximum, if the window cannot be fully seen where it
34465 currently is, it is moved back to where it was the last time it was at full
34466 size. When it is expanding from its minimum size, the old position is
34467 remembered, and next time it is reduced to the minimum it is moved back there.
34468
34469 The idea is that you can keep a reduced window just showing one or two
34470 stripcharts at a convenient place on your screen, easily expand it to show
34471 the full window when required, and just as easily put it back to what it was.
34472 The idea is copied from what the &'twm'& window manager does for its
34473 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
34474 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
34475
34476 Normally, the monitor starts up with the window at its full size, but it can be
34477 built so that it starts up with the window at its smallest size, by setting
34478 START_SMALL=yes in &_Local/eximon.conf_&.
34479
34480
34481
34482 .section "The log display" "SECID267"
34483 .cindex "log" "tail of; in monitor"
34484 The second section of the window is an area in which a display of the tail of
34485 the main log is maintained.
34486 To save space on the screen, the timestamp on each log line is shortened by
34487 removing the date and, if &%log_timezone%& is set, the timezone.
34488 The log tail is not available when the only destination for logging data is
34489 syslog, unless the syslog lines are routed to a local file whose name is passed
34490 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
34491
34492 The log sub-window has a scroll bar at its lefthand side which can be used to
34493 move back to look at earlier text, and the up and down arrow keys also have a
34494 scrolling effect. The amount of log that is kept depends on the setting of
34495 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
34496 to use. When this is full, the earlier 50% of data is discarded &-- this is
34497 much more efficient than throwing it away line by line. The sub-window also has
34498 a horizontal scroll bar for accessing the ends of long log lines. This is the
34499 only means of horizontal scrolling; the right and left arrow keys are not
34500 available. Text can be cut from this part of the window using the mouse in the
34501 normal way. The size of this subwindow is controlled by parameters in the
34502 configuration file &_Local/eximon.conf_&.
34503
34504 Searches of the text in the log window can be carried out by means of the ^R
34505 and ^S keystrokes, which default to a reverse and a forward search,
34506 respectively. The search covers only the text that is displayed in the window.
34507 It cannot go further back up the log.
34508
34509 The point from which the search starts is indicated by a caret marker. This is
34510 normally at the end of the text in the window, but can be positioned explicitly
34511 by pointing and clicking with the left mouse button, and is moved automatically
34512 by a successful search. If new text arrives in the window when it is scrolled
34513 back, the caret remains where it is, but if the window is not scrolled back,
34514 the caret is moved to the end of the new text.
34515
34516 Pressing ^R or ^S pops up a window into which the search text can be typed.
34517 There are buttons for selecting forward or reverse searching, for carrying out
34518 the search, and for cancelling. If the &"Search"& button is pressed, the search
34519 happens and the window remains so that further searches can be done. If the
34520 &"Return"& key is pressed, a single search is done and the window is closed. If
34521 ^C is typed the search is cancelled.
34522
34523 The searching facility is implemented using the facilities of the Athena text
34524 widget. By default this pops up a window containing both &"search"& and
34525 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
34526 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
34527 However, the linkers in BSDI and HP-UX seem unable to handle an externally
34528 provided version of &%TextPop%& when the remaining parts of the text widget
34529 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
34530 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
34531 on these systems, at the expense of having unwanted items in the search popup
34532 window.
34533
34534
34535
34536 .section "The queue display" "SECID268"
34537 .cindex "queue" "display in monitor"
34538 The bottom section of the monitor window contains a list of all messages that
34539 are on the queue, which includes those currently being received or delivered,
34540 as well as those awaiting delivery. The size of this subwindow is controlled by
34541 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
34542 at which it is updated is controlled by another parameter in the same file &--
34543 the default is 5 minutes, since queue scans can be quite expensive. However,
34544 there is an &"Update"& action button just above the display which can be used
34545 to force an update of the queue display at any time.
34546
34547 When a host is down for some time, a lot of pending mail can build up for it,
34548 and this can make it hard to deal with other messages on the queue. To help
34549 with this situation there is a button next to &"Update"& called &"Hide"&. If
34550 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
34551 type anything in here and press &"Return"&, the text is added to a chain of
34552 such texts, and if every undelivered address in a message matches at least one
34553 of the texts, the message is not displayed.
34554
34555 If there is an address that does not match any of the texts, all the addresses
34556 are displayed as normal. The matching happens on the ends of addresses so, for
34557 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
34558 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
34559 has been set up, a button called &"Unhide"& is displayed. If pressed, it
34560 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
34561 a hide request is automatically cancelled after one hour.
34562
34563 While the dialogue box is displayed, you can't press any buttons or do anything
34564 else to the monitor window. For this reason, if you want to cut text from the
34565 queue display to use in the dialogue box, you have to do the cutting before
34566 pressing the &"Hide"& button.
34567
34568 The queue display contains, for each unhidden queued message, the length of
34569 time it has been on the queue, the size of the message, the message id, the
34570 message sender, and the first undelivered recipient, all on one line. If it is
34571 a bounce message, the sender is shown as &"<>"&. If there is more than one
34572 recipient to which the message has not yet been delivered, subsequent ones are
34573 listed on additional lines, up to a maximum configured number, following which
34574 an ellipsis is displayed. Recipients that have already received the message are
34575 not shown.
34576
34577 .cindex "frozen messages" "display"
34578 If a message is frozen, an asterisk is displayed at the left-hand side.
34579
34580 The queue display has a vertical scroll bar, and can also be scrolled by means
34581 of the arrow keys. Text can be cut from it using the mouse in the normal way.
34582 The text searching facilities, as described above for the log window, are also
34583 available, but the caret is always moved to the end of the text when the queue
34584 display is updated.
34585
34586
34587
34588 .section "The queue menu" "SECID269"
34589 .cindex "queue" "menu in monitor"
34590 If the &%shift%& key is held down and the left button is clicked when the mouse
34591 pointer is over the text for any message, an action menu pops up, and the first
34592 line of the queue display for the message is highlighted. This does not affect
34593 any selected text.
34594
34595 If you want to use some other event for popping up the menu, you can set the
34596 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
34597 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
34598 value set in this parameter is a standard X event description. For example, to
34599 run eximon using &%ctrl%& rather than &%shift%& you could use
34600 .code
34601 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
34602 .endd
34603 The title of the menu is the message id, and it contains entries which act as
34604 follows:
34605
34606 .ilist
34607 &'message log'&: The contents of the message log for the message are displayed
34608 in a new text window.
34609 .next
34610 &'headers'&: Information from the spool file that contains the envelope
34611 information and headers is displayed in a new text window. See chapter
34612 &<<CHAPspool>>& for a description of the format of spool files.
34613 .next
34614 &'body'&: The contents of the spool file containing the body of the message are
34615 displayed in a new text window. There is a default limit of 20,000 bytes to the
34616 amount of data displayed. This can be changed by setting the BODY_MAX
34617 option at compile time, or the EXIMON_BODY_MAX option at run time.
34618 .next
34619 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
34620 delivery of the message. This causes an automatic thaw if the message is
34621 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
34622 a new text window. The delivery is run in a separate process, to avoid holding
34623 up the monitor while the delivery proceeds.
34624 .next
34625 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
34626 that the message be frozen.
34627 .next
34628 .cindex "thawing messages"
34629 .cindex "unfreezing messages"
34630 .cindex "frozen messages" "thawing"
34631 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
34632 that the message be thawed.
34633 .next
34634 .cindex "delivery" "forcing failure"
34635 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
34636 that Exim gives up trying to deliver the message. A bounce message is generated
34637 for any remaining undelivered addresses.
34638 .next
34639 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
34640 that the message be deleted from the system without generating a bounce
34641 message.
34642 .next
34643 &'add recipient'&: A dialog box is displayed into which a recipient address can
34644 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34645 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34646 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34647 causes a call to Exim to be made using the &%-Mar%& option to request that an
34648 additional recipient be added to the message, unless the entry box is empty, in
34649 which case no action is taken.
34650 .next
34651 &'mark delivered'&: A dialog box is displayed into which a recipient address
34652 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34653 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34654 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34655 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
34656 recipient address as already delivered, unless the entry box is empty, in which
34657 case no action is taken.
34658 .next
34659 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
34660 mark all recipient addresses as already delivered.
34661 .next
34662 &'edit sender'&: A dialog box is displayed initialized with the current
34663 sender's address. Pressing RETURN causes a call to Exim to be made using the
34664 &%-Mes%& option to replace the sender address, unless the entry box is empty,
34665 in which case no action is taken. If you want to set an empty sender (as in
34666 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
34667 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
34668 the address is qualified with that domain.
34669 .endlist
34670
34671 When a delivery is forced, a window showing the &%-v%& output is displayed. In
34672 other cases when a call to Exim is made, if there is any output from Exim (in
34673 particular, if the command fails) a window containing the command and the
34674 output is displayed. Otherwise, the results of the action are normally apparent
34675 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
34676 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
34677 if no output is generated.
34678
34679 The queue display is automatically updated for actions such as freezing and
34680 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
34681 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
34682 force an update of the display after one of these actions.
34683
34684 In any text window that is displayed as result of a menu action, the normal
34685 cut-and-paste facility is available, and searching can be carried out using ^R
34686 and ^S, as described above for the log tail window.
34687 .ecindex IIDeximon
34688
34689
34690
34691
34692
34693 . ////////////////////////////////////////////////////////////////////////////
34694 . ////////////////////////////////////////////////////////////////////////////
34695
34696 .chapter "Security considerations" "CHAPsecurity"
34697 .scindex IIDsecurcon "security" "discussion of"
34698 This chapter discusses a number of issues concerned with security, some of
34699 which are also covered in other parts of this manual.
34700
34701 For reasons that this author does not understand, some people have promoted
34702 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
34703 existence of this chapter in the documentation. However, the intent of the
34704 chapter is simply to describe the way Exim works in relation to certain
34705 security concerns, not to make any specific claims about the effectiveness of
34706 its security as compared with other MTAs.
34707
34708 What follows is a description of the way Exim is supposed to be. Best efforts
34709 have been made to try to ensure that the code agrees with the theory, but an
34710 absence of bugs can never be guaranteed. Any that are reported will get fixed
34711 as soon as possible.
34712
34713
34714 .section "Building a more &""hardened""& Exim" "SECID286"
34715 .cindex "security" "build-time features"
34716 There are a number of build-time options that can be set in &_Local/Makefile_&
34717 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
34718 Exim administrator who does not have the root password, or by someone who has
34719 penetrated the Exim (but not the root) account. These options are as follows:
34720
34721 .ilist
34722 ALT_CONFIG_PREFIX can be set to a string that is required to match the
34723 start of any file names used with the &%-C%& option. When it is set, these file
34724 names are also not allowed to contain the sequence &"/../"&. (However, if the
34725 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
34726 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
34727 default setting for &%ALT_CONFIG_PREFIX%&.
34728
34729 If the permitted configuration files are confined to a directory to
34730 which only root has access, this guards against someone who has broken
34731 into the Exim account from running a privileged Exim with an arbitrary
34732 configuration file, and using it to break into other accounts.
34733 .next
34734
34735 If a non-trusted configuration file (i.e. not the default configuration file
34736 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
34737 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
34738 the next item), then root privilege is retained only if the caller of Exim is
34739 root. This locks out the possibility of testing a configuration using &%-C%&
34740 right through message reception and delivery, even if the caller is root. The
34741 reception works, but by that time, Exim is running as the Exim user, so when
34742 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
34743 privilege to be lost. However, root can test reception and delivery using two
34744 separate commands.
34745
34746 .next
34747 The WHITELIST_D_MACROS build option declares some macros to be safe to override
34748 with &%-D%& if the real uid is one of root, the Exim run-time user or the
34749 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
34750 requiring the run-time value supplied to &%-D%& to match a regex that errs on
34751 the restrictive side.  Requiring build-time selection of safe macros is onerous
34752 but this option is intended solely as a transition mechanism to permit
34753 previously-working configurations to continue to work after release 4.73.
34754 .next
34755 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
34756 is disabled.
34757 .next
34758 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
34759 never to be used for any deliveries. This is like the &%never_users%& runtime
34760 option, but it cannot be overridden; the runtime option adds additional users
34761 to the list. The default setting is &"root"&; this prevents a non-root user who
34762 is permitted to modify the runtime file from using Exim as a way to get root.
34763 .endlist
34764
34765
34766
34767 .section "Root privilege" "SECID270"
34768 .cindex "setuid"
34769 .cindex "root privilege"
34770 The Exim binary is normally setuid to root, which means that it gains root
34771 privilege (runs as root) when it starts execution. In some special cases (for
34772 example, when the daemon is not in use and there are no local deliveries), it
34773 may be possible to run Exim setuid to some user other than root. This is
34774 discussed in the next section. However, in most installations, root privilege
34775 is required for two things:
34776
34777 .ilist
34778 To set up a socket connected to the standard SMTP port (25) when initialising
34779 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
34780 not required.
34781 .next
34782 To be able to change uid and gid in order to read users' &_.forward_& files and
34783 perform local deliveries as the receiving user or as specified in the
34784 configuration.
34785 .endlist
34786
34787 It is not necessary to be root to do any of the other things Exim does, such as
34788 receiving messages and delivering them externally over SMTP, and it is
34789 obviously more secure if Exim does not run as root except when necessary.
34790 For this reason, a user and group for Exim to use must be defined in
34791 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
34792 group"&. Their values can be changed by the run time configuration, though this
34793 is not recommended. Often a user called &'exim'& is used, but some sites use
34794 &'mail'& or another user name altogether.
34795
34796 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
34797 abdication; the process cannot regain root afterwards. Prior to release 4.00,
34798 &[seteuid()]& was used in some circumstances, but this is no longer the case.
34799
34800 After a new Exim process has interpreted its command line options, it changes
34801 uid and gid in the following cases:
34802
34803 .ilist
34804 .oindex "&%-C%&"
34805 .oindex "&%-D%&"
34806 If the &%-C%& option is used to specify an alternate configuration file, or if
34807 the &%-D%& option is used to define macro values for the configuration, and the
34808 calling process is not running as root, the uid and gid are changed to those of
34809 the calling process.
34810 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
34811 option may not be used at all.
34812 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
34813 can be supplied if the calling process is running as root, the Exim run-time
34814 user or CONFIGURE_OWNER, if defined.
34815 .next
34816 .oindex "&%-be%&"
34817 .oindex "&%-bf%&"
34818 .oindex "&%-bF%&"
34819 If the expansion test option (&%-be%&) or one of the filter testing options
34820 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
34821 calling process.
34822 .next
34823 If the process is not a daemon process or a queue runner process or a delivery
34824 process or a process for testing address routing (started with &%-bt%&), the
34825 uid and gid are changed to the Exim user and group. This means that Exim always
34826 runs under its own uid and gid when receiving messages. This also applies when
34827 testing address verification
34828 .oindex "&%-bv%&"
34829 .oindex "&%-bh%&"
34830 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
34831 option).
34832 .next
34833 For a daemon, queue runner, delivery, or address testing process, the uid
34834 remains as root at this stage, but the gid is changed to the Exim group.
34835 .endlist
34836
34837 The processes that initially retain root privilege behave as follows:
34838
34839 .ilist
34840 A daemon process changes the gid to the Exim group and the uid to the Exim
34841 user after setting up one or more listening sockets. The &[initgroups()]&
34842 function is called, so that if the Exim user is in any additional groups, they
34843 will be used during message reception.
34844 .next
34845 A queue runner process retains root privilege throughout its execution. Its
34846 job is to fork a controlled sequence of delivery processes.
34847 .next
34848 A delivery process retains root privilege throughout most of its execution,
34849 but any actual deliveries (that is, the transports themselves) are run in
34850 subprocesses which always change to a non-root uid and gid. For local
34851 deliveries this is typically the uid and gid of the owner of the mailbox; for
34852 remote deliveries, the Exim uid and gid are used. Once all the delivery
34853 subprocesses have been run, a delivery process changes to the Exim uid and gid
34854 while doing post-delivery tidying up such as updating the retry database and
34855 generating bounce and warning messages.
34856
34857 While the recipient addresses in a message are being routed, the delivery
34858 process runs as root. However, if a user's filter file has to be processed,
34859 this is done in a subprocess that runs under the individual user's uid and
34860 gid. A system filter is run as root unless &%system_filter_user%& is set.
34861 .next
34862 A process that is testing addresses (the &%-bt%& option) runs as root so that
34863 the routing is done in the same environment as a message delivery.
34864 .endlist
34865
34866
34867
34868
34869 .section "Running Exim without privilege" "SECTrunexiwitpri"
34870 .cindex "privilege, running without"
34871 .cindex "unprivileged running"
34872 .cindex "root privilege" "running without"
34873 Some installations like to run Exim in an unprivileged state for more of its
34874 operation, for added security. Support for this mode of operation is provided
34875 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34876 gid are changed to the Exim user and group at the start of a delivery process
34877 (and also queue runner and address testing processes). This means that address
34878 routing is no longer run as root, and the deliveries themselves cannot change
34879 to any other uid.
34880
34881 .cindex SIGHUP
34882 .cindex "daemon" "restarting"
34883 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34884 that the daemon can still be started in the usual way, and it can respond
34885 correctly to SIGHUP because the re-invocation regains root privilege.
34886
34887 An alternative approach is to make Exim setuid to the Exim user and also setgid
34888 to the Exim group. If you do this, the daemon must be started from a root
34889 process. (Calling Exim from a root process makes it behave in the way it does
34890 when it is setuid root.) However, the daemon cannot restart itself after a
34891 SIGHUP signal because it cannot regain privilege.
34892
34893 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34894 stops Exim from trying to re-invoke itself to do a delivery after a message has
34895 been received. Such a re-invocation is a waste of resources because it has no
34896 effect.
34897
34898 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34899 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34900 to the Exim user seems a clean approach, but there is one complication:
34901
34902 In this style of operation, Exim is running with the real uid and gid set to
34903 those of the calling process, and the effective uid/gid set to Exim's values.
34904 Ideally, any association with the calling process' uid/gid should be dropped,
34905 that is, the real uid/gid should be reset to the effective values so as to
34906 discard any privileges that the caller may have. While some operating systems
34907 have a function that permits this action for a non-root effective uid, quite a
34908 number of them do not. Because of this lack of standardization, Exim does not
34909 address this problem at this time.
34910
34911 For this reason, the recommended approach for &"mostly unprivileged"& running
34912 is to keep the Exim binary setuid to root, and to set
34913 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34914 be used in the most straightforward way.
34915
34916 If you configure Exim not to run delivery processes as root, there are a
34917 number of restrictions on what you can do:
34918
34919 .ilist
34920 You can deliver only as the Exim user/group. You should  explicitly use the
34921 &%user%& and &%group%& options to override routers or local transports that
34922 normally deliver as the recipient. This makes sure that configurations that
34923 work in this mode function the same way in normal mode. Any implicit or
34924 explicit specification of another user causes an error.
34925 .next
34926 Use of &_.forward_& files is severely restricted, such that it is usually
34927 not worthwhile to include them in the configuration.
34928 .next
34929 Users who wish to use &_.forward_& would have to make their home directory and
34930 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34931 and their equivalents in Exim filters, cannot be used. While they could be
34932 enabled in the Exim user's name, that would be insecure and not very useful.
34933 .next
34934 Unless the local user mailboxes are all owned by the Exim user (possible in
34935 some POP3 or IMAP-only environments):
34936
34937 .olist
34938 They must be owned by the Exim group and be writeable by that group. This
34939 implies you must set &%mode%& in the appendfile configuration, as well as the
34940 mode of the mailbox files themselves.
34941 .next
34942 You must set &%no_check_owner%&, since most or all of the files will not be
34943 owned by the Exim user.
34944 .next
34945 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34946 on a newly created mailbox when unprivileged. This also implies that new
34947 mailboxes need to be created manually.
34948 .endlist olist
34949 .endlist ilist
34950
34951
34952 These restrictions severely restrict what can be done in local deliveries.
34953 However, there are no restrictions on remote deliveries. If you are running a
34954 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34955 gives more security at essentially no cost.
34956
34957 If you are using the &%mua_wrapper%& facility (see chapter
34958 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34959
34960
34961
34962
34963 .section "Delivering to local files" "SECID271"
34964 Full details of the checks applied by &(appendfile)& before it writes to a file
34965 are given in chapter &<<CHAPappendfile>>&.
34966
34967
34968
34969 .section "IPv4 source routing" "SECID272"
34970 .cindex "source routing" "in IP packets"
34971 .cindex "IP source routing"
34972 Many operating systems suppress IP source-routed packets in the kernel, but
34973 some cannot be made to do this, so Exim does its own check. It logs incoming
34974 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34975 IPv6. No special checking is currently done.
34976
34977
34978
34979 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34980 Support for these SMTP commands is disabled by default. If required, they can
34981 be enabled by defining suitable ACLs.
34982
34983
34984
34985
34986 .section "Privileged users" "SECID274"
34987 .cindex "trusted users"
34988 .cindex "admin user"
34989 .cindex "privileged user"
34990 .cindex "user" "trusted"
34991 .cindex "user" "admin"
34992 Exim recognizes two sets of users with special privileges. Trusted users are
34993 able to submit new messages to Exim locally, but supply their own sender
34994 addresses and information about a sending host. For other users submitting
34995 local messages, Exim sets up the sender address from the uid, and doesn't
34996 permit a remote host to be specified.
34997
34998 .oindex "&%-f%&"
34999 However, an untrusted user is permitted to use the &%-f%& command line option
35000 in the special form &%-f <>%& to indicate that a delivery failure for the
35001 message should not cause an error report. This affects the message's envelope,
35002 but it does not affect the &'Sender:'& header. Untrusted users may also be
35003 permitted to use specific forms of address with the &%-f%& option by setting
35004 the &%untrusted_set_sender%& option.
35005
35006 Trusted users are used to run processes that receive mail messages from some
35007 other mail domain and pass them on to Exim for delivery either locally, or over
35008 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35009 as any user listed in the &%trusted_users%& configuration option, or under any
35010 group listed in the &%trusted_groups%& option.
35011
35012 Admin users are permitted to do things to the messages on Exim's queue. They
35013 can freeze or thaw messages, cause them to be returned to their senders, remove
35014 them entirely, or modify them in various ways. In addition, admin users can run
35015 the Exim monitor and see all the information it is capable of providing, which
35016 includes the contents of files on the spool.
35017
35018 .oindex "&%-M%&"
35019 .oindex "&%-q%&"
35020 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35021 delivery of messages on its queue is restricted to admin users. This
35022 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35023 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35024 queue is also restricted to admin users. This restriction can be relaxed by
35025 setting &%no_queue_list_requires_admin%&.
35026
35027 Exim recognizes an admin user if the calling process is running as root or as
35028 the Exim user or if any of the groups associated with the calling process is
35029 the Exim group. It is not necessary actually to be running under the Exim
35030 group. However, if admin users who are not root or the Exim user are to access
35031 the contents of files on the spool via the Exim monitor (which runs
35032 unprivileged), Exim must be built to allow group read access to its spool
35033 files.
35034
35035
35036
35037 .section "Spool files" "SECID275"
35038 .cindex "spool directory" "files"
35039 Exim's spool directory and everything it contains is owned by the Exim user and
35040 set to the Exim group. The mode for spool files is defined in the
35041 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35042 any user who is a member of the Exim group can access these files.
35043
35044
35045
35046 .section "Use of argv[0]" "SECID276"
35047 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35048 of specific strings, Exim assumes certain options. For example, calling Exim
35049 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35050 to calling it with the option &%-bS%&. There are no security implications in
35051 this.
35052
35053
35054
35055 .section "Use of %f formatting" "SECID277"
35056 The only use made of &"%f"& by Exim is in formatting load average values. These
35057 are actually stored in integer variables as 1000 times the load average.
35058 Consequently, their range is limited and so therefore is the length of the
35059 converted output.
35060
35061
35062
35063 .section "Embedded Exim path" "SECID278"
35064 Exim uses its own path name, which is embedded in the code, only when it needs
35065 to re-exec in order to regain root privilege. Therefore, it is not root when it
35066 does so. If some bug allowed the path to get overwritten, it would lead to an
35067 arbitrary program's being run as exim, not as root.
35068
35069
35070
35071 .section "Dynamic module directory" "SECTdynmoddir"
35072 Any dynamically loadable modules must be installed into the directory
35073 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35074 loading it.
35075
35076
35077 .section "Use of sprintf()" "SECID279"
35078 .cindex "&[sprintf()]&"
35079 A large number of occurrences of &"sprintf"& in the code are actually calls to
35080 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35081 The intermediate formatting is done into a large fixed buffer by a function
35082 that runs through the format string itself, and checks the length of each
35083 conversion before performing it, thus preventing buffer overruns.
35084
35085 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35086 the output buffer is known to be sufficiently long to contain the converted
35087 string.
35088
35089
35090
35091 .section "Use of debug_printf() and log_write()" "SECID280"
35092 Arbitrary strings are passed to both these functions, but they do their
35093 formatting by calling the function &'string_vformat()'&, which runs through
35094 the format string itself, and checks the length of each conversion.
35095
35096
35097
35098 .section "Use of strcat() and strcpy()" "SECID281"
35099 These are used only in cases where the output buffer is known to be large
35100 enough to hold the result.
35101 .ecindex IIDsecurcon
35102
35103
35104
35105
35106 . ////////////////////////////////////////////////////////////////////////////
35107 . ////////////////////////////////////////////////////////////////////////////
35108
35109 .chapter "Format of spool files" "CHAPspool"
35110 .scindex IIDforspo1 "format" "spool files"
35111 .scindex IIDforspo2 "spool directory" "format of files"
35112 .scindex IIDforspo3 "spool files" "format of"
35113 .cindex "spool files" "editing"
35114 A message on Exim's queue consists of two files, whose names are the message id
35115 followed by -D and -H, respectively. The data portion of the message is kept in
35116 the -D file on its own. The message's envelope, status, and headers are all
35117 kept in the -H file, whose format is described in this chapter. Each of these
35118 two files contains the final component of its own name as its first line. This
35119 is insurance against disk crashes where the directory is lost but the files
35120 themselves are recoverable.
35121
35122 Some people are tempted into editing -D files in order to modify messages. You
35123 need to be extremely careful if you do this; it is not recommended and you are
35124 on your own if you do it. Here are some of the pitfalls:
35125
35126 .ilist
35127 You must ensure that Exim does not try to deliver the message while you are
35128 fiddling with it. The safest way is to take out a write lock on the -D file,
35129 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35130 place, the lock will be retained. If you write a new file and rename it, the
35131 lock will be lost at the instant of rename.
35132 .next
35133 .vindex "&$body_linecount$&"
35134 If you change the number of lines in the file, the value of
35135 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35136 present, this value is not used by Exim, but there is no guarantee that this
35137 will always be the case.
35138 .next
35139 If the message is in MIME format, you must take care not to break it.
35140 .next
35141 If the message is cryptographically signed, any change will invalidate the
35142 signature.
35143 .endlist
35144 All in all, modifying -D files is fraught with danger.
35145
35146 Files whose names end with -J may also be seen in the &_input_& directory (or
35147 its subdirectories when &%split_spool_directory%& is set). These are journal
35148 files, used to record addresses to which the message has been delivered during
35149 the course of a delivery attempt. If there are still undelivered recipients at
35150 the end, the -H file is updated, and the -J file is deleted. If, however, there
35151 is some kind of crash (for example, a power outage) before this happens, the -J
35152 file remains in existence. When Exim next processes the message, it notices the
35153 -J file and uses it to update the -H file before starting the next delivery
35154 attempt.
35155
35156 .section "Format of the -H file" "SECID282"
35157 .cindex "uid (user id)" "in spool file"
35158 .cindex "gid (group id)" "in spool file"
35159 The second line of the -H file contains the login name for the uid of the
35160 process that called Exim to read the message, followed by the numerical uid and
35161 gid. For a locally generated message, this is normally the user who sent the
35162 message. For a message received over TCP/IP via the daemon, it is
35163 normally the Exim user.
35164
35165 The third line of the file contains the address of the message's sender as
35166 transmitted in the envelope, contained in angle brackets. The sender address is
35167 empty for bounce messages. For incoming SMTP mail, the sender address is given
35168 in the MAIL command. For locally generated mail, the sender address is
35169 created by Exim from the login name of the current user and the configured
35170 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35171 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35172 &"<>"& or an address that matches &%untrusted_set_senders%&.
35173
35174 The fourth line contains two numbers. The first is the time that the message
35175 was received, in the conventional Unix form &-- the number of seconds since the
35176 start of the epoch. The second number is a count of the number of messages
35177 warning of delayed delivery that have been sent to the sender.
35178
35179 There follow a number of lines starting with a hyphen. These can appear in any
35180 order, and are omitted when not relevant:
35181
35182 .vlist
35183 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35184 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35185 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35186 recognized, to provide backward compatibility. In the old format, a line of
35187 this form is present for every ACL variable that is not empty. The number
35188 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35189 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35190 the data string for the variable. The string itself starts at the beginning of
35191 the next line, and is followed by a newline character. It may contain internal
35192 newlines.
35193
35194 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35195 A line of this form is present for every ACL connection variable that is
35196 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35197 The length is the length of the data string for the variable. The string itself
35198 starts at the beginning of the next line, and is followed by a newline
35199 character. It may contain internal newlines.
35200
35201 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35202 A line of this form is present for every ACL message variable that is defined.
35203 Note that there is a space between &%-aclm%& and the rest of the name. The
35204 length is the length of the data string for the variable. The string itself
35205 starts at the beginning of the next line, and is followed by a newline
35206 character. It may contain internal newlines.
35207
35208 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35209 This is present if, when the message was received over SMTP, the value of
35210 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35211
35212 .vitem &%-allow_unqualified_recipient%&
35213 This is present if unqualified recipient addresses are permitted in header
35214 lines (to stop such addresses from being qualified if rewriting occurs at
35215 transport time). Local messages that were input using &%-bnq%& and remote
35216 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35217
35218 .vitem &%-allow_unqualified_sender%&
35219 This is present if unqualified sender addresses are permitted in header lines
35220 (to stop such addresses from being qualified if rewriting occurs at transport
35221 time). Local messages that were input using &%-bnq%& and remote messages from
35222 hosts that match &%sender_unqualified_hosts%& set this flag.
35223
35224 .vitem "&%-auth_id%&&~<&'text'&>"
35225 The id information for a message received on an authenticated SMTP connection
35226 &-- the value of the &$authenticated_id$& variable.
35227
35228 .vitem "&%-auth_sender%&&~<&'address'&>"
35229 The address of an authenticated sender &-- the value of the
35230 &$authenticated_sender$& variable.
35231
35232 .vitem "&%-body_linecount%&&~<&'number'&>"
35233 This records the number of lines in the body of the message, and is always
35234 present.
35235
35236 .vitem "&%-body_zerocount%&&~<&'number'&>"
35237 This records the number of binary zero bytes in the body of the message, and is
35238 present if the number is greater than zero.
35239
35240 .vitem &%-deliver_firsttime%&
35241 This is written when a new message is first added to the spool. When the spool
35242 file is updated after a deferral, it is omitted.
35243
35244 .vitem "&%-frozen%&&~<&'time'&>"
35245 .cindex "frozen messages" "spool data"
35246 The message is frozen, and the freezing happened at <&'time'&>.
35247
35248 .vitem "&%-helo_name%&&~<&'text'&>"
35249 This records the host name as specified by a remote host in a HELO or EHLO
35250 command.
35251
35252 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35253 This records the IP address of the host from which the message was received and
35254 the remote port number that was used. It is omitted for locally generated
35255 messages.
35256
35257 .vitem "&%-host_auth%&&~<&'text'&>"
35258 If the message was received on an authenticated SMTP connection, this records
35259 the name of the authenticator &-- the value of the
35260 &$sender_host_authenticated$& variable.
35261
35262 .vitem &%-host_lookup_failed%&
35263 This is present if an attempt to look up the sending host's name from its IP
35264 address failed. It corresponds to the &$host_lookup_failed$& variable.
35265
35266 .vitem "&%-host_name%&&~<&'text'&>"
35267 .cindex "reverse DNS lookup"
35268 .cindex "DNS" "reverse lookup"
35269 This records the name of the remote host from which the message was received,
35270 if the host name was looked up from the IP address when the message was being
35271 received. It is not present if no reverse lookup was done.
35272
35273 .vitem "&%-ident%&&~<&'text'&>"
35274 For locally submitted messages, this records the login of the originating user,
35275 unless it was a trusted user and the &%-oMt%& option was used to specify an
35276 ident value. For messages received over TCP/IP, this records the ident string
35277 supplied by the remote host, if any.
35278
35279 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
35280 This records the IP address of the local interface and the port number through
35281 which a message was received from a remote host. It is omitted for locally
35282 generated messages.
35283
35284 .vitem &%-local%&
35285 The message is from a local sender.
35286
35287 .vitem &%-localerror%&
35288 The message is a locally-generated bounce message.
35289
35290 .vitem "&%-local_scan%&&~<&'string'&>"
35291 This records the data string that was returned by the &[local_scan()]& function
35292 when the message was received &-- the value of the &$local_scan_data$&
35293 variable. It is omitted if no data was returned.
35294
35295 .vitem &%-manual_thaw%&
35296 The message was frozen but has been thawed manually, that is, by an explicit
35297 Exim command rather than via the auto-thaw process.
35298
35299 .vitem &%-N%&
35300 A testing delivery process was started using the &%-N%& option to suppress any
35301 actual deliveries, but delivery was deferred. At any further delivery attempts,
35302 &%-N%& is assumed.
35303
35304 .vitem &%-received_protocol%&
35305 This records the value of the &$received_protocol$& variable, which contains
35306 the name of the protocol by which the message was received.
35307
35308 .vitem &%-sender_set_untrusted%&
35309 The envelope sender of this message was set by an untrusted local caller (used
35310 to ensure that the caller is displayed in queue listings).
35311
35312 .vitem "&%-spam_score_int%&&~<&'number'&>"
35313 If a message was scanned by SpamAssassin, this is present. It records the value
35314 of &$spam_score_int$&.
35315
35316 .vitem &%-tls_certificate_verified%&
35317 A TLS certificate was received from the client that sent this message, and the
35318 certificate was verified by the server.
35319
35320 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
35321 When the message was received over an encrypted connection, this records the
35322 name of the cipher suite that was used.
35323
35324 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
35325 When the message was received over an encrypted connection, and a certificate
35326 was received from the client, this records the Distinguished Name from that
35327 certificate.
35328 .endlist
35329
35330 Following the options there is a list of those addresses to which the message
35331 is not to be delivered. This set of addresses is initialized from the command
35332 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
35333 is set; otherwise it starts out empty. Whenever a successful delivery is made,
35334 the address is added to this set. The addresses are kept internally as a
35335 balanced binary tree, and it is a representation of that tree which is written
35336 to the spool file. If an address is expanded via an alias or forward file, the
35337 original address is added to the tree when deliveries to all its child
35338 addresses are complete.
35339
35340 If the tree is empty, there is a single line in the spool file containing just
35341 the text &"XX"&. Otherwise, each line consists of two letters, which are either
35342 Y or N, followed by an address. The address is the value for the node of the
35343 tree, and the letters indicate whether the node has a left branch and/or a
35344 right branch attached to it, respectively. If branches exist, they immediately
35345 follow. Here is an example of a three-node tree:
35346 .code
35347 YY darcy@austen.fict.example
35348 NN alice@wonderland.fict.example
35349 NN editor@thesaurus.ref.example
35350 .endd
35351 After the non-recipients tree, there is a list of the message's recipients.
35352 This is a simple list, preceded by a count. It includes all the original
35353 recipients of the message, including those to whom the message has already been
35354 delivered. In the simplest case, the list contains one address per line. For
35355 example:
35356 .code
35357 4
35358 editor@thesaurus.ref.example
35359 darcy@austen.fict.example
35360 rdo@foundation
35361 alice@wonderland.fict.example
35362 .endd
35363 However, when a child address has been added to the top-level addresses as a
35364 result of the use of the &%one_time%& option on a &(redirect)& router, each
35365 line is of the following form:
35366 .display
35367 <&'top-level address'&> <&'errors_to address'&> &&&
35368   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
35369 .endd
35370 The 01 flag bit indicates the presence of the three other fields that follow
35371 the top-level address. Other bits may be used in future to support additional
35372 fields. The <&'parent number'&> is the offset in the recipients list of the
35373 original parent of the &"one time"& address. The first two fields are the
35374 envelope sender that is associated with this address and its length. If the
35375 length is zero, there is no special envelope sender (there are then two space
35376 characters in the line). A non-empty field can arise from a &(redirect)& router
35377 that has an &%errors_to%& setting.
35378
35379
35380 A blank line separates the envelope and status information from the headers
35381 which follow. A header may occupy several lines of the file, and to save effort
35382 when reading it in, each header is preceded by a number and an identifying
35383 character. The number is the number of characters in the header, including any
35384 embedded newlines and the terminating newline. The character is one of the
35385 following:
35386
35387 .table2 50pt
35388 .row <&'blank'&>         "header in which Exim has no special interest"
35389 .row &`B`&               "&'Bcc:'& header"
35390 .row &`C`&               "&'Cc:'& header"
35391 .row &`F`&               "&'From:'& header"
35392 .row &`I`&               "&'Message-id:'& header"
35393 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
35394 .row &`R`&               "&'Reply-To:'& header"
35395 .row &`S`&               "&'Sender:'& header"
35396 .row &`T`&               "&'To:'& header"
35397 .row &`*`&               "replaced or deleted header"
35398 .endtable
35399
35400 Deleted or replaced (rewritten) headers remain in the spool file for debugging
35401 purposes. They are not transmitted when the message is delivered. Here is a
35402 typical set of headers:
35403 .code
35404 111P Received: by hobbit.fict.example with local (Exim 4.00)
35405 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
35406 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
35407 038* X-rewrote-sender: bb@hobbit.fict.example
35408 042* From: Bilbo Baggins <bb@hobbit.fict.example>
35409 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
35410 099* To: alice@wonderland.fict.example, rdo@foundation,
35411 darcy@austen.fict.example, editor@thesaurus.ref.example
35412 104T To: alice@wonderland.fict.example, rdo@foundation.example,
35413 darcy@austen.fict.example, editor@thesaurus.ref.example
35414 038  Date: Fri, 11 May 2001 10:28:59 +0100
35415 .endd
35416 The asterisked headers indicate that the envelope sender, &'From:'& header, and
35417 &'To:'& header have been rewritten, the last one because routing expanded the
35418 unqualified domain &'foundation'&.
35419 .ecindex IIDforspo1
35420 .ecindex IIDforspo2
35421 .ecindex IIDforspo3
35422
35423 . ////////////////////////////////////////////////////////////////////////////
35424 . ////////////////////////////////////////////////////////////////////////////
35425
35426 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHID12" &&&
35427          "DKIM Support"
35428 .cindex "DKIM"
35429
35430 DKIM is a mechanism by which messages sent by some entity can be provably
35431 linked to a domain which that entity controls.  It permits reputation to
35432 be tracked on a per-domain basis, rather than merely upon source IP address.
35433 DKIM is documented in RFC 4871.
35434
35435 Since version 4.70, DKIM support is compiled into Exim by default. It can be
35436 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
35437
35438 Exim's DKIM implementation allows to
35439 .olist
35440 Sign outgoing messages: This function is implemented in the SMTP transport.
35441 It can co-exist with all other Exim features, including transport filters.
35442 .next
35443 Verify signatures in incoming messages: This is implemented by an additional
35444 ACL (acl_smtp_dkim), which can be called several times per message, with
35445 different signature contexts.
35446 .endlist
35447
35448 In typical Exim style, the verification implementation does not include any
35449 default "policy". Instead it enables you to build your own policy using
35450 Exim's standard controls.
35451
35452 Please note that verification of DKIM signatures in incoming mail is turned
35453 on by default for logging purposes. For each signature in incoming email,
35454 exim will log a line displaying the most important signature details, and the
35455 signature status. Here is an example (with line-breaks added for clarity):
35456 .code
35457 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
35458     d=facebookmail.com s=q1-2009b
35459     c=relaxed/relaxed a=rsa-sha1
35460     i=@facebookmail.com t=1252484542 [verification succeeded]
35461 .endd
35462 You might want to turn off DKIM verification processing entirely for internal
35463 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
35464 control modifier. This should typically be done in the RCPT ACL, at points
35465 where you accept mail from relay sources (internal hosts or authenticated
35466 senders).
35467
35468
35469 .section "Signing outgoing messages" "SECID513"
35470 .cindex "DKIM" "signing"
35471
35472 Signing is implemented by setting private options on the SMTP transport.
35473 These options take (expandable) strings as arguments.
35474
35475 .option dkim_domain smtp string&!! unset
35476 MANDATORY:
35477 The domain you want to sign with. The result of this expanded
35478 option is put into the &%$dkim_domain%& expansion variable.
35479
35480 .option dkim_selector smtp string&!! unset
35481 MANDATORY:
35482 This sets the key selector string. You can use the &%$dkim_domain%& expansion
35483 variable to look up a matching selector. The result is put in the expansion
35484 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
35485 option along with &%$dkim_domain%&.
35486
35487 .option dkim_private_key smtp string&!! unset
35488 MANDATORY:
35489 This sets the private key to use. You can use the &%$dkim_domain%& and
35490 &%$dkim_selector%& expansion variables to determine the private key to use.
35491 The result can either
35492 .ilist
35493 be a valid RSA private key in ASCII armor, including line breaks.
35494 .next
35495 start with a slash, in which case it is treated as a file that contains
35496 the private key.
35497 .next
35498 be "0", "false" or the empty string, in which case the message will not
35499 be signed. This case will not result in an error, even if &%dkim_strict%&
35500 is set.
35501 .endlist
35502
35503 .option dkim_canon smtp string&!! unset
35504 OPTIONAL:
35505 This option sets the canonicalization method used when signing a message.
35506 The DKIM RFC currently supports two methods: "simple" and "relaxed".
35507 The option defaults to "relaxed" when unset. Note: the current implementation
35508 only supports using the same canonicalization method for both headers and body.
35509
35510 .option dkim_strict smtp string&!! unset
35511 OPTIONAL:
35512 This  option  defines  how  Exim  behaves  when  signing a message that
35513 should be signed fails for some reason.  When the expansion evaluates to
35514 either "1" or "true", Exim will defer. Otherwise Exim will send the message
35515 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
35516 variables here.
35517
35518 .option dkim_sign_headers smtp string&!! unset
35519 OPTIONAL:
35520 When set, this option must expand to (or be specified as) a colon-separated
35521 list of header names. Headers with these names will be included in the message
35522 signature. When unspecified, the header names recommended in RFC4871 will be
35523 used.
35524
35525
35526 .section "Verifying DKIM signatures in incoming mail" "SECID514"
35527 .cindex "DKIM" "verification"
35528
35529 Verification of DKIM signatures in incoming email is implemented via the
35530 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
35531 syntactically(!) correct signature in the incoming message.
35532
35533 To evaluate the signature in the ACL a large number of expansion variables
35534 containing the signature status and its details are set up during the
35535 runtime of the ACL.
35536
35537 Calling the ACL only for existing signatures is not sufficient to build
35538 more advanced policies. For that reason, the global option
35539 &%dkim_verify_signers%&, and a global expansion variable
35540 &%$dkim_signers%& exist.
35541
35542 The global option &%dkim_verify_signers%& can be set to a colon-separated
35543 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
35544 called. It is expanded when the message has been received. At this point,
35545 the expansion variable &%$dkim_signers%& already contains a colon-separated
35546 list of signer domains and identities for the message. When
35547 &%dkim_verify_signers%& is not specified in the main configuration,
35548 it defaults as:
35549 .code
35550 dkim_verify_signers = $dkim_signers
35551 .endd
35552 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
35553 DKIM signature in the message. Current DKIM verifiers may want to explicitly
35554 call the ACL for known domains or identities. This would be achieved as follows:
35555 .code
35556 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
35557 .endd
35558 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
35559 and "ebay.com", plus all domains and identities that have signatures in the message.
35560 You can also be more creative in constructing your policy. For example:
35561 .code
35562 dkim_verify_signers = $sender_address_domain:$dkim_signers
35563 .endd
35564
35565 If a domain or identity is listed several times in the (expanded) value of
35566 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
35567
35568
35569 Inside the &%acl_smtp_dkim%&, the following expansion variables are
35570 available (from most to least important):
35571
35572
35573 .vlist
35574 .vitem &%$dkim_cur_signer%&
35575 The signer that is being evaluated in this ACL run. This can be a domain or
35576 an identity. This is one of the list items from the expanded main option
35577 &%dkim_verify_signers%& (see above).
35578 .vitem &%$dkim_verify_status%&
35579 A string describing the general status of the signature. One of
35580 .ilist
35581 &%none%&: There is no signature in the message for the current domain or
35582 identity (as reflected by &%$dkim_cur_signer%&).
35583 .next
35584 &%invalid%&: The signature could not be verified due to a processing error.
35585 More detail is available in &%$dkim_verify_reason%&.
35586 .next
35587 &%fail%&: Verification of the signature failed.  More detail is
35588 available in &%$dkim_verify_reason%&.
35589 .next
35590 &%pass%&: The signature passed verification. It is valid.
35591 .endlist
35592 .vitem &%$dkim_verify_reason%&
35593 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
35594 "fail" or "invalid". One of
35595 .ilist
35596 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
35597 key for the domain could not be retrieved. This may be a temporary problem.
35598 .next
35599 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
35600 record for the domain is syntactically invalid.
35601 .next
35602 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
35603 body hash does not match the one specified in the signature header. This
35604 means that the message body was modified in transit.
35605 .next
35606 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
35607 could not be verified. This may mean that headers were modified,
35608 re-written or otherwise changed in a way which is incompatible with
35609 DKIM verification. It may of course also mean that the signature is forged.
35610 .endlist
35611 .vitem &%$dkim_domain%&
35612 The signing domain. IMPORTANT: This variable is only populated if there is
35613 an actual signature in the message for the current domain or identity (as
35614 reflected by &%$dkim_cur_signer%&).
35615 .vitem &%$dkim_identity%&
35616 The signing identity, if present. IMPORTANT: This variable is only populated
35617 if there is an actual signature in the message for the current domain or
35618 identity (as reflected by &%$dkim_cur_signer%&).
35619 .vitem &%$dkim_selector%&
35620 The key record selector string.
35621 .vitem &%$dkim_algo%&
35622 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
35623 .vitem &%$dkim_canon_body%&
35624 The body canonicalization method. One of 'relaxed' or 'simple'.
35625 .vitem &%dkim_canon_headers%&
35626 The header canonicalization method. One of 'relaxed' or 'simple'.
35627 .vitem &%$dkim_copiedheaders%&
35628 A transcript of headers and their values which are included in the signature
35629 (copied from the 'z=' tag of the signature).
35630 .vitem &%$dkim_bodylength%&
35631 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
35632 limit was set by the signer, "9999999999999" is returned. This makes sure
35633 that this variable always expands to an integer value.
35634 .vitem &%$dkim_created%&
35635 UNIX timestamp reflecting the date and time when the signature was created.
35636 When this was not specified by the signer, "0" is returned.
35637 .vitem &%$dkim_expires%&
35638 UNIX timestamp reflecting the date and time when the signer wants the
35639 signature to be treated as "expired". When this was not specified by the
35640 signer, "9999999999999" is returned. This makes it possible to do useful
35641 integer size comparisons against this value.
35642 .vitem &%$dkim_headernames%&
35643 A colon-separated list of names of headers included in the signature.
35644 .vitem &%$dkim_key_testing%&
35645 "1" if the key record has the "testing" flag set, "0" if not.
35646 .vitem &%$nosubdomains%&
35647 "1" if the key record forbids subdomaining, "0" otherwise.
35648 .vitem &%$dkim_key_srvtype%&
35649 Service type (tag s=) from the key record. Defaults to "*" if not specified
35650 in the key record.
35651 .vitem &%$dkim_key_granularity%&
35652 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
35653 in the key record.
35654 .vitem &%$dkim_key_notes%&
35655 Notes from the key record (tag n=).
35656 .endlist
35657
35658 In addition, two ACL conditions are provided:
35659
35660 .vlist
35661 .vitem &%dkim_signers%&
35662 ACL condition that checks a colon-separated list of domains or identities
35663 for a match against the domain or identity that the ACL is currently verifying
35664 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
35665 verb to a group of domains or identities. For example:
35666
35667 .code
35668 # Warn when Mail purportedly from GMail has no signature at all
35669 warn log_message = GMail sender without DKIM signature
35670      sender_domains = gmail.com
35671      dkim_signers = gmail.com
35672      dkim_status = none
35673 .endd
35674
35675 .vitem &%dkim_status%&
35676 ACL condition that checks a colon-separated list of possible DKIM verification
35677 results agains the actual result of verification. This is typically used
35678 to restrict an ACL verb to a list of verification outcomes, for example:
35679
35680 .code
35681 deny message = Mail from Paypal with invalid/missing signature
35682      sender_domains = paypal.com:paypal.de
35683      dkim_signers = paypal.com:paypal.de
35684      dkim_status = none:invalid:fail
35685 .endd
35686
35687 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
35688 see the documentation of the &%$dkim_verify_status%& expansion variable above
35689 for more information of what they mean.
35690 .endlist
35691
35692 . ////////////////////////////////////////////////////////////////////////////
35693 . ////////////////////////////////////////////////////////////////////////////
35694
35695 .chapter "Adding new drivers or lookup types" "CHID13" &&&
35696          "Adding drivers or lookups"
35697 .cindex "adding drivers"
35698 .cindex "new drivers, adding"
35699 .cindex "drivers" "adding new"
35700 The following actions have to be taken in order to add a new router, transport,
35701 authenticator, or lookup type to Exim:
35702
35703 .olist
35704 Choose a name for the driver or lookup type that does not conflict with any
35705 existing name; I will use &"newdriver"& in what follows.
35706 .next
35707 Add to &_src/EDITME_& the line:
35708 .display
35709 <&'type'&>&`_NEWDRIVER=yes`&
35710 .endd
35711 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
35712 code is not to be included in the binary by default, comment this line out. You
35713 should also add any relevant comments about the driver or lookup type.
35714 .next
35715 Add to &_src/config.h.defaults_& the line:
35716 .code
35717 #define <type>_NEWDRIVER
35718 .endd
35719 .next
35720 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
35721 and create a table entry as is done for all the other drivers and lookup types.
35722 .next
35723 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
35724 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
35725 driver or lookup type and add it to the definition of OBJ.
35726 .next
35727 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
35728 &_src_&.
35729 .next
35730 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
35731 as for other drivers and lookups.
35732 .endlist
35733
35734 Then all you need to do is write the code! A good way to start is to make a
35735 proforma by copying an existing module of the same type, globally changing all
35736 occurrences of the name, and cutting out most of the code. Note that any
35737 options you create must be listed in alphabetical order, because the tables are
35738 searched using a binary chop procedure.
35739
35740 There is a &_README_& file in each of the sub-directories of &_src_& describing
35741 the interface that is expected.
35742
35743
35744
35745
35746 . ////////////////////////////////////////////////////////////////////////////
35747 . ////////////////////////////////////////////////////////////////////////////
35748
35749 . /////////////////////////////////////////////////////////////////////////////
35750 . These lines are processing instructions for the Simple DocBook Processor that
35751 . Philip Hazel has developed as a less cumbersome way of making PostScript and
35752 . PDFs than using xmlto and fop. They will be ignored by all other XML
35753 . processors.
35754 . /////////////////////////////////////////////////////////////////////////////
35755
35756 .literal xml
35757 <?sdop
35758   format="newpage"
35759   foot_right_recto="&chaptertitle;"
35760   foot_right_verso="&chaptertitle;"
35761 ?>
35762 .literal off
35763
35764 .makeindex "Options index"   "option"
35765 .makeindex "Variables index" "variable"
35766 .makeindex "Concept index"   "concept"
35767
35768
35769 . /////////////////////////////////////////////////////////////////////////////
35770 . /////////////////////////////////////////////////////////////////////////////