typo fix
[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"& or &"M"& to multiply it by 1024 or 1024*1024,
9548 respectively. Negative numbers are supported. The result of the computation is
9549 a decimal representation of the answer (without &"K"& or &"M"&). For example:
9550
9551 .display
9552 &`${eval:1+1}            `&  yields 2
9553 &`${eval:1+2*3}          `&  yields 7
9554 &`${eval:(1+2)*3}        `&  yields 9
9555 &`${eval:2+42%5}         `&  yields 4
9556 &`${eval:0xc&amp;5}          `&  yields 4
9557 &`${eval:0xc|5}          `&  yields 13
9558 &`${eval:0xc^5}          `&  yields 9
9559 &`${eval:0xc>>1}         `&  yields 6
9560 &`${eval:0xc<<1}         `&  yields 24
9561 &`${eval:~255&amp;0x1234}    `&  yields 4608
9562 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9563 .endd
9564
9565 As a more realistic example, in an ACL you might have
9566 .code
9567 deny   message = Too many bad recipients
9568        condition =                    \
9569          ${if and {                   \
9570            {>{$rcpt_count}{10}}       \
9571            {                          \
9572            <                          \
9573              {$recipients_count}      \
9574              {${eval:$rcpt_count/2}}  \
9575            }                          \
9576          }{yes}{no}}
9577 .endd
9578 The condition is true if there have been more than 10 RCPT commands and
9579 fewer than half of them have resulted in a valid recipient.
9580
9581
9582 .vitem &*${expand:*&<&'string'&>&*}*&
9583 .cindex "expansion" "re-expansion of substring"
9584 The &%expand%& operator causes a string to be expanded for a second time. For
9585 example,
9586 .code
9587 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9588 .endd
9589 first looks up a string in a file while expanding the operand for &%expand%&,
9590 and then re-expands what it has found.
9591
9592
9593 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9594 .cindex "Unicode"
9595 .cindex "UTF-8" "conversion from"
9596 .cindex "expansion" "UTF-8 conversion"
9597 .cindex "&%from_utf8%& expansion item"
9598 The world is slowly moving towards Unicode, although there are no standards for
9599 email yet. However, other applications (including some databases) are starting
9600 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9601 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9602 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9603 the result is an undefined sequence of bytes.
9604
9605 Unicode code points with values less than 256 are compatible with ASCII and
9606 ISO-8859-1 (also known as Latin-1).
9607 For example, character 169 is the copyright symbol in both cases, though the
9608 way it is encoded is different. In UTF-8, more than one byte is needed for
9609 characters with code values greater than 127, whereas ISO-8859-1 is a
9610 single-byte encoding (but thereby limited to 256 characters). This makes
9611 translation from UTF-8 to ISO-8859-1 straightforward.
9612
9613
9614 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9615 .cindex "hash function" "textual"
9616 .cindex "expansion" "textual hash"
9617 The &%hash%& operator is a simpler interface to the hashing function that can
9618 be used when the two parameters are fixed numbers (as opposed to strings that
9619 change when expanded). The effect is the same as
9620 .code
9621 ${hash{<n>}{<m>}{<string>}}
9622 .endd
9623 See the description of the general &%hash%& item above for details. The
9624 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9625
9626
9627
9628 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9629 .cindex "base64 encoding" "conversion from hex"
9630 .cindex "expansion" "hex to base64"
9631 .cindex "&%hex2b64%& expansion item"
9632 This operator converts a hex string into one that is base64 encoded. This can
9633 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9634
9635
9636 .vitem &*${lc:*&<&'string'&>&*}*&
9637 .cindex "case forcing in strings"
9638 .cindex "string" "case forcing"
9639 .cindex "lower casing"
9640 .cindex "expansion" "case forcing"
9641 .cindex "&%lc%& expansion item"
9642 This forces the letters in the string into lower-case, for example:
9643 .code
9644 ${lc:$local_part}
9645 .endd
9646
9647 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9648 .cindex "expansion" "string truncation"
9649 .cindex "&%length%& expansion item"
9650 The &%length%& operator is a simpler interface to the &%length%& function that
9651 can be used when the parameter is a fixed number (as opposed to a string that
9652 changes when expanded). The effect is the same as
9653 .code
9654 ${length{<number>}{<string>}}
9655 .endd
9656 See the description of the general &%length%& item above for details. Note that
9657 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9658 when &%length%& is used as an operator.
9659
9660
9661 .vitem &*${local_part:*&<&'string'&>&*}*&
9662 .cindex "expansion" "local part extraction"
9663 .cindex "&%local_part%& expansion item"
9664 The string is interpreted as an RFC 2822 address and the local part is
9665 extracted from it. If the string does not parse successfully, the result is
9666 empty.
9667
9668
9669 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9670 .cindex "masked IP address"
9671 .cindex "IP address" "masking"
9672 .cindex "CIDR notation"
9673 .cindex "expansion" "IP address masking"
9674 .cindex "&%mask%& expansion item"
9675 If the form of the string to be operated on is not an IP address followed by a
9676 slash and an integer (that is, a network address in CIDR notation), the
9677 expansion fails. Otherwise, this operator converts the IP address to binary,
9678 masks off the least significant bits according to the bit count, and converts
9679 the result back to text, with mask appended. For example,
9680 .code
9681 ${mask:10.111.131.206/28}
9682 .endd
9683 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9684 be mostly used for looking up masked addresses in files, the result for an IPv6
9685 address uses dots to separate components instead of colons, because colon
9686 terminates a key string in lsearch files. So, for example,
9687 .code
9688 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9689 .endd
9690 returns the string
9691 .code
9692 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9693 .endd
9694 Letters in IPv6 addresses are always output in lower case.
9695
9696
9697 .vitem &*${md5:*&<&'string'&>&*}*&
9698 .cindex "MD5 hash"
9699 .cindex "expansion" "MD5 hash"
9700 .cindex "&%md5%& expansion item"
9701 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9702 as a 32-digit hexadecimal number, in which any letters are in lower case.
9703
9704
9705 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9706 .cindex "expansion" "numeric hash"
9707 .cindex "hash function" "numeric"
9708 The &%nhash%& operator is a simpler interface to the numeric hashing function
9709 that can be used when the two parameters are fixed numbers (as opposed to
9710 strings that change when expanded). The effect is the same as
9711 .code
9712 ${nhash{<n>}{<m>}{<string>}}
9713 .endd
9714 See the description of the general &%nhash%& item above for details.
9715
9716
9717 .vitem &*${quote:*&<&'string'&>&*}*&
9718 .cindex "quoting" "in string expansions"
9719 .cindex "expansion" "quoting"
9720 .cindex "&%quote%& expansion item"
9721 The &%quote%& operator puts its argument into double quotes if it
9722 is an empty string or
9723 contains anything other than letters, digits, underscores, dots, and hyphens.
9724 Any occurrences of double quotes and backslashes are escaped with a backslash.
9725 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9726 respectively For example,
9727 .code
9728 ${quote:ab"*"cd}
9729 .endd
9730 becomes
9731 .code
9732 "ab\"*\"cd"
9733 .endd
9734 The place where this is useful is when the argument is a substitution from a
9735 variable or a message header.
9736
9737 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9738 .cindex "&%quote_local_part%& expansion item"
9739 This operator is like &%quote%&, except that it quotes the string only if
9740 required to do so by the rules of RFC 2822 for quoting local parts. For
9741 example, a plus sign would not cause quoting (but it would for &%quote%&).
9742 If you are creating a new email address from the contents of &$local_part$&
9743 (or any other unknown data), you should always use this operator.
9744
9745
9746 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9747 .cindex "quoting" "lookup-specific"
9748 This operator applies lookup-specific quoting rules to the string. Each
9749 query-style lookup type has its own quoting rules which are described with
9750 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9751 .code
9752 ${quote_ldap:two * two}
9753 .endd
9754 returns
9755 .code
9756 two%20%5C2A%20two
9757 .endd
9758 For single-key lookup types, no quoting is ever necessary and this operator
9759 yields an unchanged string.
9760
9761
9762 .vitem &*${randint:*&<&'n'&>&*}*&
9763 .cindex "random number"
9764 This operator returns a somewhat random number which is less than the
9765 supplied number and is at least 0.  The quality of this randomness depends
9766 on how Exim was built; the values are not suitable for keying material.
9767 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9768 Otherwise, the implementation may be arc4random(), random() seeded by
9769 srandomdev() or srandom(), or a custom implementation even weaker than
9770 random().
9771
9772
9773 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9774 .cindex "expansion" "IP address"
9775 This operator reverses an IP address; for IPv4 addresses, the result is in
9776 dotted-quad decimal form, while for IPv6 addreses the result is in
9777 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9778 for DNS.  For example,
9779 .code
9780 ${reverse_ip:192.0.2.4}
9781 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9782 .endd
9783 returns
9784 .code
9785 4.2.0.192
9786 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
9787 .endd
9788
9789
9790 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9791 .cindex "expansion" "RFC 2047"
9792 .cindex "RFC 2047" "expansion operator"
9793 .cindex "&%rfc2047%& expansion item"
9794 This operator encodes text according to the rules of RFC 2047. This is an
9795 encoding that is used in header lines to encode non-ASCII characters. It is
9796 assumed that the input string is in the encoding specified by the
9797 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9798 contains only characters in the range 33&--126, and no instances of the
9799 characters
9800 .code
9801 ? = ( ) < > @ , ; : \ " . [ ] _
9802 .endd
9803 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9804 string, using as many &"encoded words"& as necessary to encode all the
9805 characters.
9806
9807
9808 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9809 .cindex "expansion" "RFC 2047"
9810 .cindex "RFC 2047" "decoding"
9811 .cindex "&%rfc2047d%& expansion item"
9812 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9813 bytes are replaced by question marks. Characters are converted into the
9814 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9815 not recognized unless &%check_rfc2047_length%& is set false.
9816
9817 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9818 access a header line, RFC 2047 decoding is done automatically. You do not need
9819 to use this operator as well.
9820
9821
9822
9823 .vitem &*${rxquote:*&<&'string'&>&*}*&
9824 .cindex "quoting" "in regular expressions"
9825 .cindex "regular expressions" "quoting"
9826 .cindex "&%rxquote%& expansion item"
9827 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9828 characters in its argument. This is useful when substituting the values of
9829 variables or headers inside regular expressions.
9830
9831
9832 .vitem &*${sha1:*&<&'string'&>&*}*&
9833 .cindex "SHA-1 hash"
9834 .cindex "expansion" "SHA-1 hashing"
9835 .cindex "&%sha2%& expansion item"
9836 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9837 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9838
9839
9840 .vitem &*${stat:*&<&'string'&>&*}*&
9841 .cindex "expansion" "statting a file"
9842 .cindex "file" "extracting characteristics"
9843 .cindex "&%stat%& expansion item"
9844 The string, after expansion, must be a file path. A call to the &[stat()]&
9845 function is made for this path. If &[stat()]& fails, an error occurs and the
9846 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9847 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9848 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9849 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9850 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9851 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9852 can extract individual fields using the &%extract%& expansion item.
9853
9854 The use of the &%stat%& expansion in users' filter files can be locked out by
9855 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9856 systems for files larger than 2GB.
9857
9858 .vitem &*${str2b64:*&<&'string'&>&*}*&
9859 .cindex "expansion" "base64 encoding"
9860 .cindex "base64 encoding" "in string expansion"
9861 .cindex "&%str2b64%& expansion item"
9862 This operator converts a string into one that is base64 encoded.
9863
9864
9865
9866 .vitem &*${strlen:*&<&'string'&>&*}*&
9867 .cindex "expansion" "string length"
9868 .cindex "string" "length in expansion"
9869 .cindex "&%strlen%& expansion item"
9870 The item is replace by the length of the expanded string, expressed as a
9871 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9872
9873
9874 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9875 .cindex "&%substr%& expansion item"
9876 .cindex "substring extraction"
9877 .cindex "expansion" "substring expansion"
9878 The &%substr%& operator is a simpler interface to the &%substr%& function that
9879 can be used when the two parameters are fixed numbers (as opposed to strings
9880 that change when expanded). The effect is the same as
9881 .code
9882 ${substr{<start>}{<length>}{<string>}}
9883 .endd
9884 See the description of the general &%substr%& item above for details. The
9885 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9886
9887 .vitem &*${time_eval:*&<&'string'&>&*}*&
9888 .cindex "&%time_eval%& expansion item"
9889 .cindex "time interval" "decoding"
9890 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9891 seconds.
9892
9893 .vitem &*${time_interval:*&<&'string'&>&*}*&
9894 .cindex "&%time_interval%& expansion item"
9895 .cindex "time interval" "formatting"
9896 The argument (after sub-expansion) must be a sequence of decimal digits that
9897 represents an interval of time as a number of seconds. It is converted into a
9898 number of larger units and output in Exim's normal time format, for example,
9899 &`1w3d4h2m6s`&.
9900
9901 .vitem &*${uc:*&<&'string'&>&*}*&
9902 .cindex "case forcing in strings"
9903 .cindex "string" "case forcing"
9904 .cindex "upper casing"
9905 .cindex "expansion" "case forcing"
9906 .cindex "&%uc%& expansion item"
9907 This forces the letters in the string into upper-case.
9908 .endlist
9909
9910
9911
9912
9913
9914
9915 .section "Expansion conditions" "SECTexpcond"
9916 .scindex IIDexpcond "expansion" "conditions"
9917 The following conditions are available for testing by the &%${if%& construct
9918 while expanding strings:
9919
9920 .vlist
9921 .vitem &*!*&<&'condition'&>
9922 .cindex "expansion" "negating a condition"
9923 .cindex "negation" "in expansion condition"
9924 Preceding any condition with an exclamation mark negates the result of the
9925 condition.
9926
9927 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9928 .cindex "numeric comparison"
9929 .cindex "expansion" "numeric comparison"
9930 There are a number of symbolic operators for doing numeric comparisons. They
9931 are:
9932 .display
9933 &`=   `&   equal
9934 &`==  `&   equal
9935 &`>   `&   greater
9936 &`>=  `&   greater or equal
9937 &`<   `&   less
9938 &`<=  `&   less or equal
9939 .endd
9940 For example:
9941 .code
9942 ${if >{$message_size}{10M} ...
9943 .endd
9944 Note that the general negation operator provides for inequality testing. The
9945 two strings must take the form of optionally signed decimal integers,
9946 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9947 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9948 As a special case, the numerical value of an empty string is taken as
9949 zero.
9950
9951 In all cases, a relative comparator OP is testing if <&'string1'&> OP
9952 <&'string2'&>; the above example is checking if &$message_size$& is larger than
9953 10M, not if 10M is larger than &$message_size$&.
9954
9955
9956 .vitem &*bool&~{*&<&'string'&>&*}*&
9957 .cindex "expansion" "boolean parsing"
9958 .cindex "&%bool%& expansion condition"
9959 This condition turns a string holding a true or false representation into
9960 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9961 (case-insensitively); also positive integer numbers map to true if non-zero,
9962 false if zero.
9963 An empty string is treated as false.
9964 Leading and trailing whitespace is ignored;
9965 thus a string consisting only of whitespace is false.
9966 All other string values will result in expansion failure.
9967
9968 When combined with ACL variables, this expansion condition will let you
9969 make decisions in one place and act on those decisions in another place.
9970 For example:
9971 .code
9972 ${if bool{$acl_m_privileged_sender} ...
9973 .endd
9974
9975
9976 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9977 .cindex "expansion" "boolean parsing"
9978 .cindex "&%bool_lax%& expansion condition"
9979 Like &%bool%&, this condition turns a string into a boolean state.  But
9980 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9981 loose definition that the Router &%condition%& option uses.  The empty string
9982 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9983 true.  Leading and trailing whitespace is ignored.
9984
9985 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9986
9987 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9988 .cindex "expansion" "encrypted comparison"
9989 .cindex "encrypted strings, comparing"
9990 .cindex "&%crypteq%& expansion condition"
9991 This condition is included in the Exim binary if it is built to support any
9992 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9993 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9994 included in the binary.
9995
9996 The &%crypteq%& condition has two arguments. The first is encrypted and
9997 compared against the second, which is already encrypted. The second string may
9998 be in the LDAP form for storing encrypted strings, which starts with the
9999 encryption type in curly brackets, followed by the data. If the second string
10000 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10001 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10002 Typically this will be a field from a password file. An example of an encrypted
10003 string in LDAP form is:
10004 .code
10005 {md5}CY9rzUYh03PK3k6DJie09g==
10006 .endd
10007 If such a string appears directly in an expansion, the curly brackets have to
10008 be quoted, because they are part of the expansion syntax. For example:
10009 .code
10010 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10011 .endd
10012 The following encryption types (whose names are matched case-independently) are
10013 supported:
10014
10015 .ilist
10016 .cindex "MD5 hash"
10017 .cindex "base64 encoding" "in encrypted password"
10018 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10019 printable characters to compare with the remainder of the second string. If the
10020 length of the comparison string is 24, Exim assumes that it is base64 encoded
10021 (as in the above example). If the length is 32, Exim assumes that it is a
10022 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10023 comparison fails.
10024
10025 .next
10026 .cindex "SHA-1 hash"
10027 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10028 printable characters to compare with the remainder of the second string. If the
10029 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10030 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10031 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10032
10033 .next
10034 .cindex "&[crypt()]&"
10035 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10036 only the first eight characters of the password. However, in modern operating
10037 systems this is no longer true, and in many cases the entire password is used,
10038 whatever its length.
10039
10040 .next
10041 .cindex "&[crypt16()]&"
10042 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10043 use up to 16 characters of the password in some operating systems. Again, in
10044 modern operating systems, more characters may be used.
10045 .endlist
10046 Exim has its own version of &[crypt16()]&, which is just a double call to
10047 &[crypt()]&. For operating systems that have their own version, setting
10048 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10049 operating system version instead of its own. This option is set by default in
10050 the OS-dependent &_Makefile_& for those operating systems that are known to
10051 support &[crypt16()]&.
10052
10053 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10054 it was not using the same algorithm as some operating systems' versions. It
10055 turns out that as well as &[crypt16()]& there is a function called
10056 &[bigcrypt()]& in some operating systems. This may or may not use the same
10057 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10058
10059 However, since there is now a move away from the traditional &[crypt()]&
10060 functions towards using SHA1 and other algorithms, tidying up this area of
10061 Exim is seen as very low priority.
10062
10063 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10064 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10065 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10066 default is &`{crypt}`&. Whatever the default, you can always use either
10067 function by specifying it explicitly in curly brackets.
10068
10069 .vitem &*def:*&<&'variable&~name'&>
10070 .cindex "expansion" "checking for empty variable"
10071 .cindex "&%def%& expansion condition"
10072 The &%def%& condition must be followed by the name of one of the expansion
10073 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10074 variable does not contain the empty string. For example:
10075 .code
10076 ${if def:sender_ident {from $sender_ident}}
10077 .endd
10078 Note that the variable name is given without a leading &%$%& character. If the
10079 variable does not exist, the expansion fails.
10080
10081 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10082         &~&*def:h_*&<&'header&~name'&>&*:*&"
10083 .cindex "expansion" "checking header line existence"
10084 This condition is true if a message is being processed and the named header
10085 exists in the message. For example,
10086 .code
10087 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10088 .endd
10089 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10090 the header name must be terminated by a colon if white space does not follow.
10091
10092 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10093        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10094 .cindex "string" "comparison"
10095 .cindex "expansion" "string comparison"
10096 .cindex "&%eq%& expansion condition"
10097 .cindex "&%eqi%& expansion condition"
10098 The two substrings are first expanded. The condition is true if the two
10099 resulting strings are identical. For &%eq%& the comparison includes the case of
10100 letters, whereas for &%eqi%& the comparison is case-independent.
10101
10102 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10103 .cindex "expansion" "file existence test"
10104 .cindex "file" "existence test"
10105 .cindex "&%exists%&, expansion condition"
10106 The substring is first expanded and then interpreted as an absolute path. The
10107 condition is true if the named file (or directory) exists. The existence test
10108 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10109 users' filter files may be locked out by the system administrator.
10110
10111 .vitem &*first_delivery*&
10112 .cindex "delivery" "first"
10113 .cindex "first delivery"
10114 .cindex "expansion" "first delivery test"
10115 .cindex "&%first_delivery%& expansion condition"
10116 This condition, which has no data, is true during a message's first delivery
10117 attempt. It is false during any subsequent delivery attempts.
10118
10119
10120 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10121        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10122 .cindex "list" "iterative conditions"
10123 .cindex "expansion" "&*forall*& condition"
10124 .cindex "expansion" "&*forany*& condition"
10125 .vindex "&$item$&"
10126 These conditions iterate over a list. The first argument is expanded to form
10127 the list. By default, the list separator is a colon, but it can be changed by
10128 the normal method. The second argument is interpreted as a condition that is to
10129 be applied to each item in the list in turn. During the interpretation of the
10130 condition, the current list item is placed in a variable called &$item$&.
10131 .ilist
10132 For &*forany*&, interpretation stops if the condition is true for any item, and
10133 the result of the whole condition is true. If the condition is false for all
10134 items in the list, the overall condition is false.
10135 .next
10136 For &*forall*&, interpretation stops if the condition is false for any item,
10137 and the result of the whole condition is false. If the condition is true for
10138 all items in the list, the overall condition is true.
10139 .endlist
10140 Note that negation of &*forany*& means that the condition must be false for all
10141 items for the overall condition to succeed, and negation of &*forall*& means
10142 that the condition must be false for at least one item. In this example, the
10143 list separator is changed to a comma:
10144 .code
10145 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10146 .endd
10147 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10148 being processed, to enable these expansion items to be nested.
10149
10150
10151 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10152        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10153 .cindex "string" "comparison"
10154 .cindex "expansion" "string comparison"
10155 .cindex "&%ge%& expansion condition"
10156 .cindex "&%gei%& expansion condition"
10157 The two substrings are first expanded. The condition is true if the first
10158 string is lexically greater than or equal to the second string. For &%ge%& the
10159 comparison includes the case of letters, whereas for &%gei%& the comparison is
10160 case-independent.
10161
10162 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10163        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10164 .cindex "string" "comparison"
10165 .cindex "expansion" "string comparison"
10166 .cindex "&%gt%& expansion condition"
10167 .cindex "&%gti%& expansion condition"
10168 The two substrings are first expanded. The condition is true if the first
10169 string is lexically greater than the second string. For &%gt%& the comparison
10170 includes the case of letters, whereas for &%gti%& the comparison is
10171 case-independent.
10172
10173 .new
10174 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10175        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10176 .cindex "string" "comparison"
10177 .cindex "list" "iterative conditions"
10178 Both strings are expanded; the second string is treated as a list of simple
10179 strings; if the first string is a member of the second, then the condition
10180 is true.
10181
10182 These are simpler to use versions of the more powerful &*forany*& condition.
10183 Examples, and the &*forany*& equivalents:
10184 .code
10185 ${if inlist{needle}{foo:needle:bar}}
10186   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10187 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10188   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10189 .endd
10190 .wen
10191
10192 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10193        &*isip4&~{*&<&'string'&>&*}*& &&&
10194        &*isip6&~{*&<&'string'&>&*}*&
10195 .cindex "IP address" "testing string format"
10196 .cindex "string" "testing for IP address"
10197 .cindex "&%isip%& expansion condition"
10198 .cindex "&%isip4%& expansion condition"
10199 .cindex "&%isip6%& expansion condition"
10200 The substring is first expanded, and then tested to see if it has the form of
10201 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10202 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10203
10204 For an IPv4 address, the test is for four dot-separated components, each of
10205 which consists of from one to three digits. For an IPv6 address, up to eight
10206 colon-separated components are permitted, each containing from one to four
10207 hexadecimal digits. There may be fewer than eight components if an empty
10208 component (adjacent colons) is present. Only one empty component is permitted.
10209
10210 &*Note*&: The checks are just on the form of the address; actual numerical
10211 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10212 check. The main use of these tests is to distinguish between IP addresses and
10213 host names, or between IPv4 and IPv6 addresses. For example, you could use
10214 .code
10215 ${if isip4{$sender_host_address}...
10216 .endd
10217 to test which IP version an incoming SMTP connection is using.
10218
10219 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10220 .cindex "LDAP" "use for authentication"
10221 .cindex "expansion" "LDAP authentication test"
10222 .cindex "&%ldapauth%& expansion condition"
10223 This condition supports user authentication using LDAP. See section
10224 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10225 queries. For this use, the query must contain a user name and password. The
10226 query itself is not used, and can be empty. The condition is true if the
10227 password is not empty, and the user name and password are accepted by the LDAP
10228 server. An empty password is rejected without calling LDAP because LDAP binds
10229 with an empty password are considered anonymous regardless of the username, and
10230 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10231 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10232 this can be used.
10233
10234
10235 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10236        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10237 .cindex "string" "comparison"
10238 .cindex "expansion" "string comparison"
10239 .cindex "&%le%& expansion condition"
10240 .cindex "&%lei%& expansion condition"
10241 The two substrings are first expanded. The condition is true if the first
10242 string is lexically less than or equal to the second string. For &%le%& the
10243 comparison includes the case of letters, whereas for &%lei%& the comparison is
10244 case-independent.
10245
10246 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10247        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10248 .cindex "string" "comparison"
10249 .cindex "expansion" "string comparison"
10250 .cindex "&%lt%& expansion condition"
10251 .cindex "&%lti%& expansion condition"
10252 The two substrings are first expanded. The condition is true if the first
10253 string is lexically less than the second string. For &%lt%& the comparison
10254 includes the case of letters, whereas for &%lti%& the comparison is
10255 case-independent.
10256
10257
10258 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10259 .cindex "expansion" "regular expression comparison"
10260 .cindex "regular expressions" "match in expanded string"
10261 .cindex "&%match%& expansion condition"
10262 The two substrings are first expanded. The second is then treated as a regular
10263 expression and applied to the first. Because of the pre-expansion, if the
10264 regular expression contains dollar, or backslash characters, they must be
10265 escaped. Care must also be taken if the regular expression contains braces
10266 (curly brackets). A closing brace must be escaped so that it is not taken as a
10267 premature termination of <&'string2'&>. The easiest approach is to use the
10268 &`\N`& feature to disable expansion of the regular expression.
10269 For example,
10270 .code
10271 ${if match {$local_part}{\N^\d{3}\N} ...
10272 .endd
10273 If the whole expansion string is in double quotes, further escaping of
10274 backslashes is also required.
10275
10276 The condition is true if the regular expression match succeeds.
10277 The regular expression is not required to begin with a circumflex
10278 metacharacter, but if there is no circumflex, the expression is not anchored,
10279 and it may match anywhere in the subject, not just at the start. If you want
10280 the pattern to match at the end of the subject, you must include the &`$`&
10281 metacharacter at an appropriate point.
10282
10283 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10284 At the start of an &%if%& expansion the values of the numeric variable
10285 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10286 succeeds causes them to be reset to the substrings of that condition and they
10287 will have these values during the expansion of the success string. At the end
10288 of the &%if%& expansion, the previous values are restored. After testing a
10289 combination of conditions using &%or%&, the subsequent values of the numeric
10290 variables are those of the condition that succeeded.
10291
10292 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10293 .cindex "&%match_address%& expansion condition"
10294 See &*match_local_part*&.
10295
10296 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10297 .cindex "&%match_domain%& expansion condition"
10298 See &*match_local_part*&.
10299
10300 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10301 .cindex "&%match_ip%& expansion condition"
10302 .new
10303 This condition matches an IP address to a list of IP address patterns. It must
10304 be followed by two argument strings. The first (after expansion) must be an IP
10305 address or an empty string. The second (not expanded) is a restricted host
10306 list that can match only an IP address, not a host name. For example:
10307 .wen
10308 .code
10309 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10310 .endd
10311 The specific types of host list item that are permitted in the list are:
10312
10313 .ilist
10314 An IP address, optionally with a CIDR mask.
10315 .next
10316 A single asterisk, which matches any IP address.
10317 .next
10318 An empty item, which matches only if the IP address is empty. This could be
10319 useful for testing for a locally submitted message or one from specific hosts
10320 in a single test such as
10321 . ==== As this is a nested list, any displays it contains must be indented
10322 . ==== as otherwise they are too far to the left. This comment applies to
10323 . ==== the use of xmlto plus fop. There's no problem when formatting with
10324 . ==== sdop, with or without the extra indent.
10325 .code
10326   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10327 .endd
10328 where the first item in the list is the empty string.
10329 .next
10330 The item @[] matches any of the local host's interface addresses.
10331 .next
10332 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10333 even if &`net-`& is not specified. There is never any attempt to turn the IP
10334 address into a host name. The most common type of linear search for
10335 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10336 masks. For example:
10337 .code
10338   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10339 .endd
10340 It is of course possible to use other kinds of lookup, and in such a case, you
10341 do need to specify the &`net-`& prefix if you want to specify a specific
10342 address mask, for example:
10343 .code
10344   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10345 .endd
10346 However, unless you are combining a &%match_ip%& condition with others, it is
10347 just as easy to use the fact that a lookup is itself a condition, and write:
10348 .code
10349   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10350 .endd
10351 .endlist ilist
10352
10353 .new
10354 Note that <&'string2'&> is not itself subject to string expansion, unless
10355 Exim was built with the EXPAND_LISTMATCH_RHS option.
10356 .wen
10357
10358 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10359
10360 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10361 .cindex "domain list" "in expansion condition"
10362 .cindex "address list" "in expansion condition"
10363 .cindex "local part" "list, in expansion condition"
10364 .cindex "&%match_local_part%& expansion condition"
10365 This condition, together with &%match_address%& and &%match_domain%&, make it
10366 possible to test domain, address, and local part lists within expansions. Each
10367 condition requires two arguments: an item and a list to match. A trivial
10368 example is:
10369 .code
10370 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10371 .endd
10372 In each case, the second argument may contain any of the allowable items for a
10373 list of the appropriate type. Also, because the second argument (after
10374 expansion) is a standard form of list, it is possible to refer to a named list.
10375 Thus, you can use conditions like this:
10376 .code
10377 ${if match_domain{$domain}{+local_domains}{...
10378 .endd
10379 .cindex "&`+caseful`&"
10380 For address lists, the matching starts off caselessly, but the &`+caseful`&
10381 item can be used, as in all address lists, to cause subsequent items to
10382 have their local parts matched casefully. Domains are always matched
10383 caselessly.
10384
10385 .new
10386 Note that <&'string2'&> is not itself subject to string expansion, unless
10387 Exim was built with the EXPAND_LISTMATCH_RHS option.
10388 .wen
10389
10390 &*Note*&: Host lists are &'not'& supported in this way. This is because
10391 hosts have two identities: a name and an IP address, and it is not clear
10392 how to specify cleanly how such a test would work. However, IP addresses can be
10393 matched using &%match_ip%&.
10394
10395 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10396 .cindex "PAM authentication"
10397 .cindex "AUTH" "with PAM"
10398 .cindex "Solaris" "PAM support"
10399 .cindex "expansion" "PAM authentication test"
10400 .cindex "&%pam%& expansion condition"
10401 &'Pluggable Authentication Modules'&
10402 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10403 available in the latest releases of Solaris and in some GNU/Linux
10404 distributions. The Exim support, which is intended for use in conjunction with
10405 the SMTP AUTH command, is available only if Exim is compiled with
10406 .code
10407 SUPPORT_PAM=yes
10408 .endd
10409 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10410 in some releases of GNU/Linux &%-ldl%& is also needed.
10411
10412 The argument string is first expanded, and the result must be a
10413 colon-separated list of strings. Leading and trailing white space is ignored.
10414 The PAM module is initialized with the service name &"exim"& and the user name
10415 taken from the first item in the colon-separated data string (<&'string1'&>).
10416 The remaining items in the data string are passed over in response to requests
10417 from the authentication function. In the simple case there will only be one
10418 request, for a password, so the data consists of just two strings.
10419
10420 There can be problems if any of the strings are permitted to contain colon
10421 characters. In the usual way, these have to be doubled to avoid being taken as
10422 separators. If the data is being inserted from a variable, the &%sg%& expansion
10423 item can be used to double any existing colons. For example, the configuration
10424 of a LOGIN authenticator might contain this setting:
10425 .code
10426 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10427 .endd
10428 For a PLAIN authenticator you could use:
10429 .code
10430 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10431 .endd
10432 In some operating systems, PAM authentication can be done only from a process
10433 running as root. Since Exim is running as the Exim user when receiving
10434 messages, this means that PAM cannot be used directly in those systems.
10435 A patched version of the &'pam_unix'& module that comes with the
10436 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10437 The patched module allows one special uid/gid combination, in addition to root,
10438 to authenticate. If you build the patched module to allow the Exim user and
10439 group, PAM can then be used from an Exim authenticator.
10440
10441
10442 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10443 .cindex "&'pwcheck'& daemon"
10444 .cindex "Cyrus"
10445 .cindex "expansion" "&'pwcheck'& authentication test"
10446 .cindex "&%pwcheck%& expansion condition"
10447 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10448 This is one way of making it possible for passwords to be checked by a process
10449 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10450 deprecated. Its replacement is &'saslauthd'& (see below).
10451
10452 The pwcheck support is not included in Exim by default. You need to specify
10453 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10454 building Exim. For example:
10455 .code
10456 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10457 .endd
10458 You do not need to install the full Cyrus software suite in order to use
10459 the pwcheck daemon. You can compile and install just the daemon alone
10460 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10461 access to the &_/var/pwcheck_& directory.
10462
10463 The &%pwcheck%& condition takes one argument, which must be the user name and
10464 password, separated by a colon. For example, in a LOGIN authenticator
10465 configuration, you might have this:
10466 .code
10467 server_condition = ${if pwcheck{$auth1:$auth2}}
10468 .endd
10469 Again, for a PLAIN authenticator configuration, this would be:
10470 .code
10471 server_condition = ${if pwcheck{$auth2:$auth3}}
10472 .endd
10473 .vitem &*queue_running*&
10474 .cindex "queue runner" "detecting when delivering from"
10475 .cindex "expansion" "queue runner test"
10476 .cindex "&%queue_running%& expansion condition"
10477 This condition, which has no data, is true during delivery attempts that are
10478 initiated by queue runner processes, and false otherwise.
10479
10480
10481 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10482 .cindex "Radius"
10483 .cindex "expansion" "Radius authentication"
10484 .cindex "&%radius%& expansion condition"
10485 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10486 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10487 the Radius client configuration file in order to build Exim with Radius
10488 support.
10489
10490 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10491 library, using the original API. If you are using release 0.4.0 or later of
10492 this library, you need to set
10493 .code
10494 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10495 .endd
10496 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10497 &%libradius%& library that comes with FreeBSD. To do this, set
10498 .code
10499 RADIUS_LIB_TYPE=RADLIB
10500 .endd
10501 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10502 You may also have to supply a suitable setting in EXTRALIBS so that the
10503 Radius library can be found when Exim is linked.
10504
10505 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10506 Radius client library, which calls the Radius server. The condition is true if
10507 the authentication is successful. For example:
10508 .code
10509 server_condition = ${if radius{<arguments>}}
10510 .endd
10511
10512
10513 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10514         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10515 .cindex "&'saslauthd'& daemon"
10516 .cindex "Cyrus"
10517 .cindex "expansion" "&'saslauthd'& authentication test"
10518 .cindex "&%saslauthd%& expansion condition"
10519 This condition supports user authentication using the Cyrus &'saslauthd'&
10520 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10521 Using this daemon is one way of making it possible for passwords to be checked
10522 by a process that is not running as root.
10523
10524 The saslauthd support is not included in Exim by default. You need to specify
10525 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10526 building Exim. For example:
10527 .code
10528 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10529 .endd
10530 You do not need to install the full Cyrus software suite in order to use
10531 the saslauthd daemon. You can compile and install just the daemon alone
10532 from the Cyrus SASL library.
10533
10534 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10535 two are mandatory. For example:
10536 .code
10537 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10538 .endd
10539 The service and the realm are optional (which is why the arguments are enclosed
10540 in their own set of braces). For details of the meaning of the service and
10541 realm, and how to run the daemon, consult the Cyrus documentation.
10542 .endlist vlist
10543
10544
10545
10546 .section "Combining expansion conditions" "SECID84"
10547 .cindex "expansion" "combining conditions"
10548 Several conditions can be tested at once by combining them using the &%and%&
10549 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10550 conditions on their own, and precede their lists of sub-conditions. Each
10551 sub-condition must be enclosed in braces within the overall braces that contain
10552 the list. No repetition of &%if%& is used.
10553
10554
10555 .vlist
10556 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10557 .cindex "&""or""& expansion condition"
10558 .cindex "expansion" "&""or""& of conditions"
10559 The sub-conditions are evaluated from left to right. The condition is true if
10560 any one of the sub-conditions is true.
10561 For example,
10562 .code
10563 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10564 .endd
10565 When a true sub-condition is found, the following ones are parsed but not
10566 evaluated. If there are several &"match"& sub-conditions the values of the
10567 numeric variables afterwards are taken from the first one that succeeds.
10568
10569 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10570 .cindex "&""and""& expansion condition"
10571 .cindex "expansion" "&""and""& of conditions"
10572 The sub-conditions are evaluated from left to right. The condition is true if
10573 all of the sub-conditions are true. If there are several &"match"&
10574 sub-conditions, the values of the numeric variables afterwards are taken from
10575 the last one. When a false sub-condition is found, the following ones are
10576 parsed but not evaluated.
10577 .endlist
10578 .ecindex IIDexpcond
10579
10580
10581
10582
10583 .section "Expansion variables" "SECTexpvar"
10584 .cindex "expansion" "variables, list of"
10585 This section contains an alphabetical list of all the expansion variables. Some
10586 of them are available only when Exim is compiled with specific options such as
10587 support for TLS or the content scanning extension.
10588
10589 .vlist
10590 .vitem "&$0$&, &$1$&, etc"
10591 .cindex "numerical variables (&$1$& &$2$& etc)"
10592 When a &%match%& expansion condition succeeds, these variables contain the
10593 captured substrings identified by the regular expression during subsequent
10594 processing of the success string of the containing &%if%& expansion item.
10595 However, they do not retain their values afterwards; in fact, their previous
10596 values are restored at the end of processing an &%if%& item. The numerical
10597 variables may also be set externally by some other matching process which
10598 precedes the expansion of the string. For example, the commands available in
10599 Exim filter files include an &%if%& command with its own regular expression
10600 matching condition.
10601
10602 .vitem "&$acl_c...$&"
10603 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10604 can be given any name that starts with &$acl_c$& and is at least six characters
10605 long, but the sixth character must be either a digit or an underscore. For
10606 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10607 variables persist throughout the lifetime of an SMTP connection. They can be
10608 used to pass information between ACLs and between different invocations of the
10609 same ACL. When a message is received, the values of these variables are saved
10610 with the message, and can be accessed by filters, routers, and transports
10611 during subsequent delivery.
10612
10613 .vitem "&$acl_m...$&"
10614 These variables are like the &$acl_c...$& variables, except that their values
10615 are reset after a message has been received. Thus, if several messages are
10616 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10617 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10618 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10619 message is received, the values of these variables are saved with the message,
10620 and can be accessed by filters, routers, and transports during subsequent
10621 delivery.
10622
10623 .vitem &$acl_verify_message$&
10624 .vindex "&$acl_verify_message$&"
10625 After an address verification has failed, this variable contains the failure
10626 message. It retains its value for use in subsequent modifiers. The message can
10627 be preserved by coding like this:
10628 .code
10629 warn !verify = sender
10630      set acl_m0 = $acl_verify_message
10631 .endd
10632 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10633 &%log_message%& modifiers, to include information about the verification
10634 failure.
10635
10636 .vitem &$address_data$&
10637 .vindex "&$address_data$&"
10638 This variable is set by means of the &%address_data%& option in routers. The
10639 value then remains with the address while it is processed by subsequent routers
10640 and eventually a transport. If the transport is handling multiple addresses,
10641 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10642 for more details. &*Note*&: The contents of &$address_data$& are visible in
10643 user filter files.
10644
10645 If &$address_data$& is set when the routers are called from an ACL to verify
10646 a recipient address, the final value is still in the variable for subsequent
10647 conditions and modifiers of the ACL statement. If routing the address caused it
10648 to be redirected to just one address, the child address is also routed as part
10649 of the verification, and in this case the final value of &$address_data$& is
10650 from the child's routing.
10651
10652 If &$address_data$& is set when the routers are called from an ACL to verify a
10653 sender address, the final value is also preserved, but this time in
10654 &$sender_address_data$&, to distinguish it from data from a recipient
10655 address.
10656
10657 In both cases (recipient and sender verification), the value does not persist
10658 after the end of the current ACL statement. If you want to preserve
10659 these values for longer, you can save them in ACL variables.
10660
10661 .vitem &$address_file$&
10662 .vindex "&$address_file$&"
10663 When, as a result of aliasing, forwarding, or filtering, a message is directed
10664 to a specific file, this variable holds the name of the file when the transport
10665 is running. At other times, the variable is empty. For example, using the
10666 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10667 .code
10668 /home/r2d2/savemail
10669 .endd
10670 then when the &(address_file)& transport is running, &$address_file$&
10671 contains the text string &`/home/r2d2/savemail`&.
10672 .cindex "Sieve filter" "value of &$address_file$&"
10673 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10674 then up to the transport configuration to generate an appropriate absolute path
10675 to the relevant file.
10676
10677 .vitem &$address_pipe$&
10678 .vindex "&$address_pipe$&"
10679 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10680 this variable holds the pipe command when the transport is running.
10681
10682 .vitem "&$auth1$& &-- &$auth3$&"
10683 .vindex "&$auth1$&, &$auth2$&, etc"
10684 These variables are used in SMTP authenticators (see chapters
10685 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10686
10687 .vitem &$authenticated_id$&
10688 .cindex "authentication" "id"
10689 .vindex "&$authenticated_id$&"
10690 When a server successfully authenticates a client it may be configured to
10691 preserve some of the authentication information in the variable
10692 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10693 user/password authenticator configuration might preserve the user name for use
10694 in the routers. Note that this is not the same information that is saved in
10695 &$sender_host_authenticated$&.
10696 When a message is submitted locally (that is, not over a TCP connection)
10697 the value of &$authenticated_id$& is normally the login name of the calling
10698 process. However, a trusted user can override this by means of the &%-oMai%&
10699 command line option.
10700
10701
10702
10703
10704 .vitem &$authenticated_sender$&
10705 .cindex "sender" "authenticated"
10706 .cindex "authentication" "sender"
10707 .cindex "AUTH" "on MAIL command"
10708 .vindex "&$authenticated_sender$&"
10709 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10710 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10711 described in section &<<SECTauthparamail>>&. Unless the data is the string
10712 &"<>"&, it is set as the authenticated sender of the message, and the value is
10713 available during delivery in the &$authenticated_sender$& variable. If the
10714 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10715
10716 .vindex "&$qualify_domain$&"
10717 When a message is submitted locally (that is, not over a TCP connection), the
10718 value of &$authenticated_sender$& is an address constructed from the login
10719 name of the calling process and &$qualify_domain$&, except that a trusted user
10720 can override this by means of the &%-oMas%& command line option.
10721
10722
10723 .vitem &$authentication_failed$&
10724 .cindex "authentication" "failure"
10725 .vindex "&$authentication_failed$&"
10726 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10727 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10728 possible to distinguish between &"did not try to authenticate"&
10729 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10730 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10731 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10732 negative response to an AUTH command, including (for example) an attempt to use
10733 an undefined mechanism.
10734
10735 .new
10736 .vitem &$av_failed$&
10737 .cindex "content scanning" "AV scanner failure"
10738 This variable is available when Exim is compiled with the content-scanning
10739 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10740 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10741 the ACL malware condition.
10742 .wen
10743
10744 .vitem &$body_linecount$&
10745 .cindex "message body" "line count"
10746 .cindex "body of message" "line count"
10747 .vindex "&$body_linecount$&"
10748 When a message is being received or delivered, this variable contains the
10749 number of lines in the message's body. See also &$message_linecount$&.
10750
10751 .vitem &$body_zerocount$&
10752 .cindex "message body" "binary zero count"
10753 .cindex "body of message" "binary zero count"
10754 .cindex "binary zero" "in message body"
10755 .vindex "&$body_zerocount$&"
10756 When a message is being received or delivered, this variable contains the
10757 number of binary zero bytes (ASCII NULs) in the message's body.
10758
10759 .vitem &$bounce_recipient$&
10760 .vindex "&$bounce_recipient$&"
10761 This is set to the recipient address of a bounce message while Exim is creating
10762 it. It is useful if a customized bounce message text file is in use (see
10763 chapter &<<CHAPemsgcust>>&).
10764
10765 .vitem &$bounce_return_size_limit$&
10766 .vindex "&$bounce_return_size_limit$&"
10767 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10768 up to a multiple of 1000. It is useful when a customized error message text
10769 file is in use (see chapter &<<CHAPemsgcust>>&).
10770
10771 .vitem &$caller_gid$&
10772 .cindex "gid (group id)" "caller"
10773 .vindex "&$caller_gid$&"
10774 The real group id under which the process that called Exim was running. This is
10775 not the same as the group id of the originator of a message (see
10776 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10777 incarnation normally contains the Exim gid.
10778
10779 .vitem &$caller_uid$&
10780 .cindex "uid (user id)" "caller"
10781 .vindex "&$caller_uid$&"
10782 The real user id under which the process that called Exim was running. This is
10783 not the same as the user id of the originator of a message (see
10784 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10785 incarnation normally contains the Exim uid.
10786
10787 .vitem &$compile_date$&
10788 .vindex "&$compile_date$&"
10789 The date on which the Exim binary was compiled.
10790
10791 .vitem &$compile_number$&
10792 .vindex "&$compile_number$&"
10793 The building process for Exim keeps a count of the number
10794 of times it has been compiled. This serves to distinguish different
10795 compilations of the same version of the program.
10796
10797 .vitem &$demime_errorlevel$&
10798 .vindex "&$demime_errorlevel$&"
10799 This variable is available when Exim is compiled with
10800 the content-scanning extension and the obsolete &%demime%& condition. For
10801 details, see section &<<SECTdemimecond>>&.
10802
10803 .vitem &$demime_reason$&
10804 .vindex "&$demime_reason$&"
10805 This variable is available when Exim is compiled with the
10806 content-scanning extension and the obsolete &%demime%& condition. For details,
10807 see section &<<SECTdemimecond>>&.
10808
10809 .vitem &$dnslist_domain$& &&&
10810        &$dnslist_matched$& &&&
10811        &$dnslist_text$& &&&
10812        &$dnslist_value$&
10813 .vindex "&$dnslist_domain$&"
10814 .vindex "&$dnslist_matched$&"
10815 .vindex "&$dnslist_text$&"
10816 .vindex "&$dnslist_value$&"
10817 .cindex "black list (DNS)"
10818 When a DNS (black) list lookup succeeds, these variables are set to contain
10819 the following data from the lookup: the list's domain name, the key that was
10820 looked up, the contents of any associated TXT record, and the value from the
10821 main A record. See section &<<SECID204>>& for more details.
10822
10823 .vitem &$domain$&
10824 .vindex "&$domain$&"
10825 When an address is being routed, or delivered on its own, this variable
10826 contains the domain. Uppercase letters in the domain are converted into lower
10827 case for &$domain$&.
10828
10829 Global address rewriting happens when a message is received, so the value of
10830 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10831 is set during user filtering, but not during system filtering, because a
10832 message may have many recipients and the system filter is called just once.
10833
10834 When more than one address is being delivered at once (for example, several
10835 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10836 have the same domain. Transports can be restricted to handling only one domain
10837 at a time if the value of &$domain$& is required at transport time &-- this is
10838 the default for local transports. For further details of the environment in
10839 which local transports are run, see chapter &<<CHAPenvironment>>&.
10840
10841 .oindex "&%delay_warning_condition%&"
10842 At the end of a delivery, if all deferred addresses have the same domain, it is
10843 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10844
10845 The &$domain$& variable is also used in some other circumstances:
10846
10847 .ilist
10848 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10849 the recipient address. The domain of the &'sender'& address is in
10850 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10851 normally set during the running of the MAIL ACL. However, if the sender address
10852 is verified with a callout during the MAIL ACL, the sender domain is placed in
10853 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10854 the &(smtp)& transport.
10855
10856 .next
10857 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10858 &$domain$& contains the domain portion of the address that is being rewritten;
10859 it can be used in the expansion of the replacement address, for example, to
10860 rewrite domains by file lookup.
10861
10862 .next
10863 With one important exception, whenever a domain list is being scanned,
10864 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10865 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10866 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10867 that, in a RCPT ACL, the sender domain list can be dependent on the
10868 recipient domain (which is what is in &$domain$& at this time).
10869
10870 .next
10871 .cindex "ETRN" "value of &$domain$&"
10872 .oindex "&%smtp_etrn_command%&"
10873 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10874 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10875 .endlist
10876
10877
10878 .vitem &$domain_data$&
10879 .vindex "&$domain_data$&"
10880 When the &%domains%& option on a router matches a domain by
10881 means of a lookup, the data read by the lookup is available during the running
10882 of the router as &$domain_data$&. In addition, if the driver routes the
10883 address to a transport, the value is available in that transport. If the
10884 transport is handling multiple addresses, the value from the first address is
10885 used.
10886
10887 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10888 domain by means of a lookup. The data read by the lookup is available during
10889 the rest of the ACL statement. In all other situations, this variable expands
10890 to nothing.
10891
10892 .vitem &$exim_gid$&
10893 .vindex "&$exim_gid$&"
10894 This variable contains the numerical value of the Exim group id.
10895
10896 .vitem &$exim_path$&
10897 .vindex "&$exim_path$&"
10898 This variable contains the path to the Exim binary.
10899
10900 .vitem &$exim_uid$&
10901 .vindex "&$exim_uid$&"
10902 This variable contains the numerical value of the Exim user id.
10903
10904 .vitem &$found_extension$&
10905 .vindex "&$found_extension$&"
10906 This variable is available when Exim is compiled with the
10907 content-scanning extension and the obsolete &%demime%& condition. For details,
10908 see section &<<SECTdemimecond>>&.
10909
10910 .vitem &$header_$&<&'name'&>
10911 This is not strictly an expansion variable. It is expansion syntax for
10912 inserting the message header line with the given name. Note that the name must
10913 be terminated by colon or white space, because it may contain a wide variety of
10914 characters. Note also that braces must &'not'& be used.
10915
10916 .vitem &$home$&
10917 .vindex "&$home$&"
10918 When the &%check_local_user%& option is set for a router, the user's home
10919 directory is placed in &$home$& when the check succeeds. In particular, this
10920 means it is set during the running of users' filter files. A router may also
10921 explicitly set a home directory for use by a transport; this can be overridden
10922 by a setting on the transport itself.
10923
10924 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10925 of the environment variable HOME.
10926
10927 .vitem &$host$&
10928 .vindex "&$host$&"
10929 If a router assigns an address to a transport (any transport), and passes a
10930 list of hosts with the address, the value of &$host$& when the transport starts
10931 to run is the name of the first host on the list. Note that this applies both
10932 to local and remote transports.
10933
10934 .cindex "transport" "filter"
10935 .cindex "filter" "transport filter"
10936 For the &(smtp)& transport, if there is more than one host, the value of
10937 &$host$& changes as the transport works its way through the list. In
10938 particular, when the &(smtp)& transport is expanding its options for encryption
10939 using TLS, or for specifying a transport filter (see chapter
10940 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10941 is connected.
10942
10943 When used in the client part of an authenticator configuration (see chapter
10944 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10945 client is connected.
10946
10947
10948 .vitem &$host_address$&
10949 .vindex "&$host_address$&"
10950 This variable is set to the remote host's IP address whenever &$host$& is set
10951 for a remote connection. It is also set to the IP address that is being checked
10952 when the &%ignore_target_hosts%& option is being processed.
10953
10954 .vitem &$host_data$&
10955 .vindex "&$host_data$&"
10956 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10957 result of the lookup is made available in the &$host_data$& variable. This
10958 allows you, for example, to do things like this:
10959 .code
10960 deny  hosts = net-lsearch;/some/file
10961 message = $host_data
10962 .endd
10963 .vitem &$host_lookup_deferred$&
10964 .cindex "host name" "lookup, failure of"
10965 .vindex "&$host_lookup_deferred$&"
10966 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10967 message comes from a remote host and there is an attempt to look up the host's
10968 name from its IP address, and the attempt is not successful, one of these
10969 variables is set to &"1"&.
10970
10971 .ilist
10972 If the lookup receives a definite negative response (for example, a DNS lookup
10973 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10974
10975 .next
10976 If there is any kind of problem during the lookup, such that Exim cannot
10977 tell whether or not the host name is defined (for example, a timeout for a DNS
10978 lookup), &$host_lookup_deferred$& is set to &"1"&.
10979 .endlist ilist
10980
10981 Looking up a host's name from its IP address consists of more than just a
10982 single reverse lookup. Exim checks that a forward lookup of at least one of the
10983 names it receives from a reverse lookup yields the original IP address. If this
10984 is not the case, Exim does not accept the looked up name(s), and
10985 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10986 IP address (for example, the existence of a PTR record in the DNS) is not
10987 sufficient on its own for the success of a host name lookup. If the reverse
10988 lookup succeeds, but there is a lookup problem such as a timeout when checking
10989 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10990 &"1"&. See also &$sender_host_name$&.
10991
10992 .vitem &$host_lookup_failed$&
10993 .vindex "&$host_lookup_failed$&"
10994 See &$host_lookup_deferred$&.
10995
10996
10997 .vitem &$inode$&
10998 .vindex "&$inode$&"
10999 The only time this variable is set is while expanding the &%directory_file%&
11000 option in the &(appendfile)& transport. The variable contains the inode number
11001 of the temporary file which is about to be renamed. It can be used to construct
11002 a unique name for the file.
11003
11004 .vitem &$interface_address$&
11005 .vindex "&$interface_address$&"
11006 This is an obsolete name for &$received_ip_address$&.
11007
11008 .vitem &$interface_port$&
11009 .vindex "&$interface_port$&"
11010 This is an obsolete name for &$received_port$&.
11011
11012 .vitem &$item$&
11013 .vindex "&$item$&"
11014 This variable is used during the expansion of &*forall*& and &*forany*&
11015 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11016 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11017 empty.
11018
11019 .vitem &$ldap_dn$&
11020 .vindex "&$ldap_dn$&"
11021 This variable, which is available only when Exim is compiled with LDAP support,
11022 contains the DN from the last entry in the most recently successful LDAP
11023 lookup.
11024
11025 .vitem &$load_average$&
11026 .vindex "&$load_average$&"
11027 This variable contains the system load average, multiplied by 1000 so that it
11028 is an integer. For example, if the load average is 0.21, the value of the
11029 variable is 210. The value is recomputed every time the variable is referenced.
11030
11031 .vitem &$local_part$&
11032 .vindex "&$local_part$&"
11033 When an address is being routed, or delivered on its own, this
11034 variable contains the local part. When a number of addresses are being
11035 delivered together (for example, multiple RCPT commands in an SMTP
11036 session), &$local_part$& is not set.
11037
11038 Global address rewriting happens when a message is received, so the value of
11039 &$local_part$& during routing and delivery is the value after rewriting.
11040 &$local_part$& is set during user filtering, but not during system filtering,
11041 because a message may have many recipients and the system filter is called just
11042 once.
11043
11044 .vindex "&$local_part_prefix$&"
11045 .vindex "&$local_part_suffix$&"
11046 If a local part prefix or suffix has been recognized, it is not included in the
11047 value of &$local_part$& during routing and subsequent delivery. The values of
11048 any prefix or suffix are in &$local_part_prefix$& and
11049 &$local_part_suffix$&, respectively.
11050
11051 When a message is being delivered to a file, pipe, or autoreply transport as a
11052 result of aliasing or forwarding, &$local_part$& is set to the local part of
11053 the parent address, not to the file name or command (see &$address_file$& and
11054 &$address_pipe$&).
11055
11056 When an ACL is running for a RCPT command, &$local_part$& contains the
11057 local part of the recipient address.
11058
11059 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11060 &$local_part$& contains the local part of the address that is being rewritten;
11061 it can be used in the expansion of the replacement address, for example.
11062
11063 In all cases, all quoting is removed from the local part. For example, for both
11064 the addresses
11065 .code
11066 "abc:xyz"@test.example
11067 abc\:xyz@test.example
11068 .endd
11069 the value of &$local_part$& is
11070 .code
11071 abc:xyz
11072 .endd
11073 If you use &$local_part$& to create another address, you should always wrap it
11074 inside a quoting operator. For example, in a &(redirect)& router you could
11075 have:
11076 .code
11077 data = ${quote_local_part:$local_part}@new.domain.example
11078 .endd
11079 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11080 to process local parts in a case-dependent manner in a router, you can set the
11081 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11082
11083 .vitem &$local_part_data$&
11084 .vindex "&$local_part_data$&"
11085 When the &%local_parts%& option on a router matches a local part by means of a
11086 lookup, the data read by the lookup is available during the running of the
11087 router as &$local_part_data$&. In addition, if the driver routes the address
11088 to a transport, the value is available in that transport. If the transport is
11089 handling multiple addresses, the value from the first address is used.
11090
11091 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11092 matches a local part by means of a lookup. The data read by the lookup is
11093 available during the rest of the ACL statement. In all other situations, this
11094 variable expands to nothing.
11095
11096 .vitem &$local_part_prefix$&
11097 .vindex "&$local_part_prefix$&"
11098 When an address is being routed or delivered, and a
11099 specific prefix for the local part was recognized, it is available in this
11100 variable, having been removed from &$local_part$&.
11101
11102 .vitem &$local_part_suffix$&
11103 .vindex "&$local_part_suffix$&"
11104 When an address is being routed or delivered, and a
11105 specific suffix for the local part was recognized, it is available in this
11106 variable, having been removed from &$local_part$&.
11107
11108 .vitem &$local_scan_data$&
11109 .vindex "&$local_scan_data$&"
11110 This variable contains the text returned by the &[local_scan()]& function when
11111 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11112
11113 .vitem &$local_user_gid$&
11114 .vindex "&$local_user_gid$&"
11115 See &$local_user_uid$&.
11116
11117 .vitem &$local_user_uid$&
11118 .vindex "&$local_user_uid$&"
11119 This variable and &$local_user_gid$& are set to the uid and gid after the
11120 &%check_local_user%& router precondition succeeds. This means that their values
11121 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11122 and &%condition%&), for the &%address_data%& expansion, and for any
11123 router-specific expansions. At all other times, the values in these variables
11124 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11125
11126 .vitem &$localhost_number$&
11127 .vindex "&$localhost_number$&"
11128 This contains the expanded value of the
11129 &%localhost_number%& option. The expansion happens after the main options have
11130 been read.
11131
11132 .vitem &$log_inodes$&
11133 .vindex "&$log_inodes$&"
11134 The number of free inodes in the disk partition where Exim's
11135 log files are being written. The value is recalculated whenever the variable is
11136 referenced. If the relevant file system does not have the concept of inodes,
11137 the value of is -1. See also the &%check_log_inodes%& option.
11138
11139 .vitem &$log_space$&
11140 .vindex "&$log_space$&"
11141 The amount of free space (as a number of kilobytes) in the disk
11142 partition where Exim's log files are being written. The value is recalculated
11143 whenever the variable is referenced. If the operating system does not have the
11144 ability to find the amount of free space (only true for experimental systems),
11145 the space value is -1. See also the &%check_log_space%& option.
11146
11147
11148 .vitem &$mailstore_basename$&
11149 .vindex "&$mailstore_basename$&"
11150 This variable is set only when doing deliveries in &"mailstore"& format in the
11151 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11152 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11153 contains the basename of the files that are being written, that is, the name
11154 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11155 variable is empty.
11156
11157 .vitem &$malware_name$&
11158 .vindex "&$malware_name$&"
11159 This variable is available when Exim is compiled with the
11160 content-scanning extension. It is set to the name of the virus that was found
11161 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11162
11163 .vitem &$max_received_linelength$&
11164 .vindex "&$max_received_linelength$&"
11165 .cindex "maximum" "line length"
11166 .cindex "line length" "maximum"
11167 This variable contains the number of bytes in the longest line that was
11168 received as part of the message, not counting the line termination
11169 character(s).
11170
11171 .vitem &$message_age$&
11172 .cindex "message" "age of"
11173 .vindex "&$message_age$&"
11174 This variable is set at the start of a delivery attempt to contain the number
11175 of seconds since the message was received. It does not change during a single
11176 delivery attempt.
11177
11178 .vitem &$message_body$&
11179 .cindex "body of message" "expansion variable"
11180 .cindex "message body" "in expansion"
11181 .cindex "binary zero" "in message body"
11182 .vindex "&$message_body$&"
11183 .oindex "&%message_body_visible%&"
11184 This variable contains the initial portion of a message's body while it is
11185 being delivered, and is intended mainly for use in filter files. The maximum
11186 number of characters of the body that are put into the variable is set by the
11187 &%message_body_visible%& configuration option; the default is 500.
11188
11189 .oindex "&%message_body_newlines%&"
11190 By default, newlines are converted into spaces in &$message_body$&, to make it
11191 easier to search for phrases that might be split over a line break. However,
11192 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11193 zeros are always converted into spaces.
11194
11195 .vitem &$message_body_end$&
11196 .cindex "body of message" "expansion variable"
11197 .cindex "message body" "in expansion"
11198 .vindex "&$message_body_end$&"
11199 This variable contains the final portion of a message's
11200 body while it is being delivered. The format and maximum size are as for
11201 &$message_body$&.
11202
11203 .vitem &$message_body_size$&
11204 .cindex "body of message" "size"
11205 .cindex "message body" "size"
11206 .vindex "&$message_body_size$&"
11207 When a message is being delivered, this variable contains the size of the body
11208 in bytes. The count starts from the character after the blank line that
11209 separates the body from the header. Newlines are included in the count. See
11210 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11211
11212 .vitem &$message_exim_id$&
11213 .vindex "&$message_exim_id$&"
11214 When a message is being received or delivered, this variable contains the
11215 unique message id that is generated and used by Exim to identify the message.
11216 An id is not created for a message until after its header has been successfully
11217 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11218 line; it is the local id that Exim assigns to the message, for example:
11219 &`1BXTIK-0001yO-VA`&.
11220
11221 .vitem &$message_headers$&
11222 .vindex &$message_headers$&
11223 This variable contains a concatenation of all the header lines when a message
11224 is being processed, except for lines added by routers or transports. The header
11225 lines are separated by newline characters. Their contents are decoded in the
11226 same way as a header line that is inserted by &%bheader%&.
11227
11228 .vitem &$message_headers_raw$&
11229 .vindex &$message_headers_raw$&
11230 This variable is like &$message_headers$& except that no processing of the
11231 contents of header lines is done.
11232
11233 .vitem &$message_id$&
11234 This is an old name for &$message_exim_id$&, which is now deprecated.
11235
11236 .vitem &$message_linecount$&
11237 .vindex "&$message_linecount$&"
11238 This variable contains the total number of lines in the header and body of the
11239 message. Compare &$body_linecount$&, which is the count for the body only.
11240 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11241 number of lines received. Before delivery happens (that is, before filters,
11242 routers, and transports run) the count is increased to include the
11243 &'Received:'& header line that Exim standardly adds, and also any other header
11244 lines that are added by ACLs. The blank line that separates the message header
11245 from the body is not counted.
11246
11247 As with the special case of &$message_size$&, during the expansion of the
11248 appendfile transport's maildir_tag option in maildir format, the value of
11249 &$message_linecount$& is the precise size of the number of newlines in the
11250 file that has been written (minus one for the blank line between the
11251 header and the body).
11252
11253 Here is an example of the use of this variable in a DATA ACL:
11254 .code
11255 deny message   = Too many lines in message header
11256      condition = \
11257       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11258 .endd
11259 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11260 message has not yet been received.
11261
11262 .vitem &$message_size$&
11263 .cindex "size" "of message"
11264 .cindex "message" "size"
11265 .vindex "&$message_size$&"
11266 When a message is being processed, this variable contains its size in bytes. In
11267 most cases, the size includes those headers that were received with the
11268 message, but not those (such as &'Envelope-to:'&) that are added to individual
11269 deliveries as they are written. However, there is one special case: during the
11270 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11271 doing a delivery in maildir format, the value of &$message_size$& is the
11272 precise size of the file that has been written. See also
11273 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11274
11275 .cindex "RCPT" "value of &$message_size$&"
11276 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11277 contains the size supplied on the MAIL command, or -1 if no size was given. The
11278 value may not, of course, be truthful.
11279
11280 .vitem &$mime_$&&'xxx'&
11281 A number of variables whose names start with &$mime$& are
11282 available when Exim is compiled with the content-scanning extension. For
11283 details, see section &<<SECTscanmimepart>>&.
11284
11285 .vitem "&$n0$& &-- &$n9$&"
11286 These variables are counters that can be incremented by means
11287 of the &%add%& command in filter files.
11288
11289 .vitem &$original_domain$&
11290 .vindex "&$domain$&"
11291 .vindex "&$original_domain$&"
11292 When a top-level address is being processed for delivery, this contains the
11293 same value as &$domain$&. However, if a &"child"& address (for example,
11294 generated by an alias, forward, or filter file) is being processed, this
11295 variable contains the domain of the original address (lower cased). This
11296 differs from &$parent_domain$& only when there is more than one level of
11297 aliasing or forwarding. When more than one address is being delivered in a
11298 single transport run, &$original_domain$& is not set.
11299
11300 If a new address is created by means of a &%deliver%& command in a system
11301 filter, it is set up with an artificial &"parent"& address. This has the local
11302 part &'system-filter'& and the default qualify domain.
11303
11304 .vitem &$original_local_part$&
11305 .vindex "&$local_part$&"
11306 .vindex "&$original_local_part$&"
11307 When a top-level address is being processed for delivery, this contains the
11308 same value as &$local_part$&, unless a prefix or suffix was removed from the
11309 local part, because &$original_local_part$& always contains the full local
11310 part. When a &"child"& address (for example, generated by an alias, forward, or
11311 filter file) is being processed, this variable contains the full local part of
11312 the original address.
11313
11314 If the router that did the redirection processed the local part
11315 case-insensitively, the value in &$original_local_part$& is in lower case.
11316 This variable differs from &$parent_local_part$& only when there is more than
11317 one level of aliasing or forwarding. When more than one address is being
11318 delivered in a single transport run, &$original_local_part$& is not set.
11319
11320 If a new address is created by means of a &%deliver%& command in a system
11321 filter, it is set up with an artificial &"parent"& address. This has the local
11322 part &'system-filter'& and the default qualify domain.
11323
11324 .vitem &$originator_gid$&
11325 .cindex "gid (group id)" "of originating user"
11326 .cindex "sender" "gid"
11327 .vindex "&$caller_gid$&"
11328 .vindex "&$originator_gid$&"
11329 This variable contains the value of &$caller_gid$& that was set when the
11330 message was received. For messages received via the command line, this is the
11331 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11332 normally the gid of the Exim user.
11333
11334 .vitem &$originator_uid$&
11335 .cindex "uid (user id)" "of originating user"
11336 .cindex "sender" "uid"
11337 .vindex "&$caller_uid$&"
11338 .vindex "&$originaltor_uid$&"
11339 The value of &$caller_uid$& that was set when the message was received. For
11340 messages received via the command line, this is the uid of the sending user.
11341 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11342 user.
11343
11344 .vitem &$parent_domain$&
11345 .vindex "&$parent_domain$&"
11346 This variable is similar to &$original_domain$& (see
11347 above), except that it refers to the immediately preceding parent address.
11348
11349 .vitem &$parent_local_part$&
11350 .vindex "&$parent_local_part$&"
11351 This variable is similar to &$original_local_part$&
11352 (see above), except that it refers to the immediately preceding parent address.
11353
11354 .vitem &$pid$&
11355 .cindex "pid (process id)" "of current process"
11356 .vindex "&$pid$&"
11357 This variable contains the current process id.
11358
11359 .vitem &$pipe_addresses$&
11360 .cindex "filter" "transport filter"
11361 .cindex "transport" "filter"
11362 .vindex "&$pipe_addresses$&"
11363 This is not an expansion variable, but is mentioned here because the string
11364 &`$pipe_addresses`& is handled specially in the command specification for the
11365 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11366 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11367 It cannot be used in general expansion strings, and provokes an &"unknown
11368 variable"& error if encountered.
11369
11370 .vitem &$primary_hostname$&
11371 .vindex "&$primary_hostname$&"
11372 This variable contains the value set by &%primary_hostname%& in the
11373 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11374 a single-component name, Exim calls &[gethostbyname()]& (or
11375 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11376 qualified host name. See also &$smtp_active_hostname$&.
11377
11378
11379 .vitem &$prvscheck_address$&
11380 This variable is used in conjunction with the &%prvscheck%& expansion item,
11381 which is described in sections &<<SECTexpansionitems>>& and
11382 &<<SECTverifyPRVS>>&.
11383
11384 .vitem &$prvscheck_keynum$&
11385 This variable is used in conjunction with the &%prvscheck%& expansion item,
11386 which is described in sections &<<SECTexpansionitems>>& and
11387 &<<SECTverifyPRVS>>&.
11388
11389 .vitem &$prvscheck_result$&
11390 This variable is used in conjunction with the &%prvscheck%& expansion item,
11391 which is described in sections &<<SECTexpansionitems>>& and
11392 &<<SECTverifyPRVS>>&.
11393
11394 .vitem &$qualify_domain$&
11395 .vindex "&$qualify_domain$&"
11396 The value set for the &%qualify_domain%& option in the configuration file.
11397
11398 .vitem &$qualify_recipient$&
11399 .vindex "&$qualify_recipient$&"
11400 The value set for the &%qualify_recipient%& option in the configuration file,
11401 or if not set, the value of &$qualify_domain$&.
11402
11403 .vitem &$rcpt_count$&
11404 .vindex "&$rcpt_count$&"
11405 When a message is being received by SMTP, this variable contains the number of
11406 RCPT commands received for the current message. If this variable is used in a
11407 RCPT ACL, its value includes the current command.
11408
11409 .vitem &$rcpt_defer_count$&
11410 .vindex "&$rcpt_defer_count$&"
11411 .cindex "4&'xx'& responses" "count of"
11412 When a message is being received by SMTP, this variable contains the number of
11413 RCPT commands in the current message that have previously been rejected with a
11414 temporary (4&'xx'&) response.
11415
11416 .vitem &$rcpt_fail_count$&
11417 .vindex "&$rcpt_fail_count$&"
11418 When a message is being received by SMTP, this variable contains the number of
11419 RCPT commands in the current message that have previously been rejected with a
11420 permanent (5&'xx'&) response.
11421
11422 .vitem &$received_count$&
11423 .vindex "&$received_count$&"
11424 This variable contains the number of &'Received:'& header lines in the message,
11425 including the one added by Exim (so its value is always greater than zero). It
11426 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11427 delivering.
11428
11429 .vitem &$received_for$&
11430 .vindex "&$received_for$&"
11431 If there is only a single recipient address in an incoming message, this
11432 variable contains that address when the &'Received:'& header line is being
11433 built. The value is copied after recipient rewriting has happened, but before
11434 the &[local_scan()]& function is run.
11435
11436 .vitem &$received_ip_address$&
11437 .vindex "&$received_ip_address$&"
11438 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11439 variable is set to the address of the local IP interface, and &$received_port$&
11440 is set to the local port number. (The remote IP address and port are in
11441 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11442 the port value is -1 unless it has been set using the &%-oMi%& command line
11443 option.
11444
11445 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11446 could be used, for example, to make the file name for a TLS certificate depend
11447 on which interface and/or port is being used for the incoming connection. The
11448 values of &$received_ip_address$& and &$received_port$& are saved with any
11449 messages that are received, thus making these variables available at delivery
11450 time.
11451
11452 &*Note:*& There are no equivalent variables for outgoing connections, because
11453 the values are unknown (unless they are explicitly set by options of the
11454 &(smtp)& transport).
11455
11456 .vitem &$received_port$&
11457 .vindex "&$received_port$&"
11458 See &$received_ip_address$&.
11459
11460 .vitem &$received_protocol$&
11461 .vindex "&$received_protocol$&"
11462 When a message is being processed, this variable contains the name of the
11463 protocol by which it was received. Most of the names used by Exim are defined
11464 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11465 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11466 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11467 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11468 connection and the client was successfully authenticated.
11469
11470 Exim uses the protocol name &"smtps"& for the case when encryption is
11471 automatically set up on connection without the use of STARTTLS (see
11472 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11473 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11474 where the client initially uses EHLO, sets up an encrypted connection using
11475 STARTTLS, and then uses HELO afterwards.
11476
11477 The &%-oMr%& option provides a way of specifying a custom protocol name for
11478 messages that are injected locally by trusted callers. This is commonly used to
11479 identify messages that are being re-injected after some kind of scanning.
11480
11481 .vitem &$received_time$&
11482 .vindex "&$received_time$&"
11483 This variable contains the date and time when the current message was received,
11484 as a number of seconds since the start of the Unix epoch.
11485
11486 .vitem &$recipient_data$&
11487 .vindex "&$recipient_data$&"
11488 This variable is set after an indexing lookup success in an ACL &%recipients%&
11489 condition. It contains the data from the lookup, and the value remains set
11490 until the next &%recipients%& test. Thus, you can do things like this:
11491 .display
11492 &`require recipients  = cdb*@;/some/file`&
11493 &`deny    `&&'some further test involving'& &`$recipient_data`&
11494 .endd
11495 &*Warning*&: This variable is set only when a lookup is used as an indexing
11496 method in the address list, using the semicolon syntax as in the example above.
11497 The variable is not set for a lookup that is used as part of the string
11498 expansion that all such lists undergo before being interpreted.
11499
11500 .vitem &$recipient_verify_failure$&
11501 .vindex "&$recipient_verify_failure$&"
11502 In an ACL, when a recipient verification fails, this variable contains
11503 information about the failure. It is set to one of the following words:
11504
11505 .ilist
11506 &"qualify"&: The address was unqualified (no domain), and the message
11507 was neither local nor came from an exempted host.
11508
11509 .next
11510 &"route"&: Routing failed.
11511
11512 .next
11513 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11514 or before the MAIL command (that is, on initial connection, HELO, or
11515 MAIL).
11516
11517 .next
11518 &"recipient"&: The RCPT command in a callout was rejected.
11519 .next
11520
11521 &"postmaster"&: The postmaster check in a callout was rejected.
11522 .endlist
11523
11524 The main use of this variable is expected to be to distinguish between
11525 rejections of MAIL and rejections of RCPT.
11526
11527 .vitem &$recipients$&
11528 .vindex "&$recipients$&"
11529 This variable contains a list of envelope recipients for a message. A comma and
11530 a space separate the addresses in the replacement text. However, the variable
11531 is not generally available, to prevent exposure of Bcc recipients in
11532 unprivileged users' filter files. You can use &$recipients$& only in these
11533 cases:
11534
11535 .olist
11536 In a system filter file.
11537 .next
11538 In the ACLs associated with the DATA command and with non-SMTP messages, that
11539 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11540 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11541 &%acl_not_smtp_mime%&.
11542 .next
11543 From within a &[local_scan()]& function.
11544 .endlist
11545
11546
11547 .vitem &$recipients_count$&
11548 .vindex "&$recipients_count$&"
11549 When a message is being processed, this variable contains the number of
11550 envelope recipients that came with the message. Duplicates are not excluded
11551 from the count. While a message is being received over SMTP, the number
11552 increases for each accepted recipient. It can be referenced in an ACL.
11553
11554
11555 .vitem &$regex_match_string$&
11556 .vindex "&$regex_match_string$&"
11557 This variable is set to contain the matching regular expression after a
11558 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11559
11560
11561 .vitem &$reply_address$&
11562 .vindex "&$reply_address$&"
11563 When a message is being processed, this variable contains the contents of the
11564 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11565 contents of the &'From:'& header line. Apart from the removal of leading
11566 white space, the value is not processed in any way. In particular, no RFC 2047
11567 decoding or character code translation takes place.
11568
11569 .vitem &$return_path$&
11570 .vindex "&$return_path$&"
11571 When a message is being delivered, this variable contains the return path &--
11572 the sender field that will be sent as part of the envelope. It is not enclosed
11573 in <> characters. At the start of routing an address, &$return_path$& has the
11574 same value as &$sender_address$&, but if, for example, an incoming message to a
11575 mailing list has been expanded by a router which specifies a different address
11576 for bounce messages, &$return_path$& subsequently contains the new bounce
11577 address, whereas &$sender_address$& always contains the original sender address
11578 that was received with the message. In other words, &$sender_address$& contains
11579 the incoming envelope sender, and &$return_path$& contains the outgoing
11580 envelope sender.
11581
11582 .vitem &$return_size_limit$&
11583 .vindex "&$return_size_limit$&"
11584 This is an obsolete name for &$bounce_return_size_limit$&.
11585
11586 .vitem &$runrc$&
11587 .cindex "return code" "from &%run%& expansion"
11588 .vindex "&$runrc$&"
11589 This variable contains the return code from a command that is run by the
11590 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11591 assume the order in which option values are expanded, except for those
11592 preconditions whose order of testing is documented. Therefore, you cannot
11593 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11594 another.
11595
11596 .vitem &$self_hostname$&
11597 .oindex "&%self%&" "value of host name"
11598 .vindex "&$self_hostname$&"
11599 When an address is routed to a supposedly remote host that turns out to be the
11600 local host, what happens is controlled by the &%self%& generic router option.
11601 One of its values causes the address to be passed to another router. When this
11602 happens, &$self_hostname$& is set to the name of the local host that the
11603 original router encountered. In other circumstances its contents are null.
11604
11605 .vitem &$sender_address$&
11606 .vindex "&$sender_address$&"
11607 When a message is being processed, this variable contains the sender's address
11608 that was received in the message's envelope. The case of letters in the address
11609 is retained, in both the local part and the domain. For bounce messages, the
11610 value of this variable is the empty string. See also &$return_path$&.
11611
11612 .vitem &$sender_address_data$&
11613 .vindex "&$address_data$&"
11614 .vindex "&$sender_address_data$&"
11615 If &$address_data$& is set when the routers are called from an ACL to verify a
11616 sender address, the final value is preserved in &$sender_address_data$&, to
11617 distinguish it from data from a recipient address. The value does not persist
11618 after the end of the current ACL statement. If you want to preserve it for
11619 longer, you can save it in an ACL variable.
11620
11621 .vitem &$sender_address_domain$&
11622 .vindex "&$sender_address_domain$&"
11623 The domain portion of &$sender_address$&.
11624
11625 .vitem &$sender_address_local_part$&
11626 .vindex "&$sender_address_local_part$&"
11627 The local part portion of &$sender_address$&.
11628
11629 .vitem &$sender_data$&
11630 .vindex "&$sender_data$&"
11631 This variable is set after a lookup success in an ACL &%senders%& condition or
11632 in a router &%senders%& option. It contains the data from the lookup, and the
11633 value remains set until the next &%senders%& test. Thus, you can do things like
11634 this:
11635 .display
11636 &`require senders      = cdb*@;/some/file`&
11637 &`deny    `&&'some further test involving'& &`$sender_data`&
11638 .endd
11639 &*Warning*&: This variable is set only when a lookup is used as an indexing
11640 method in the address list, using the semicolon syntax as in the example above.
11641 The variable is not set for a lookup that is used as part of the string
11642 expansion that all such lists undergo before being interpreted.
11643
11644 .vitem &$sender_fullhost$&
11645 .vindex "&$sender_fullhost$&"
11646 When a message is received from a remote host, this variable contains the host
11647 name and IP address in a single string. It ends with the IP address in square
11648 brackets, followed by a colon and a port number if the logging of ports is
11649 enabled. The format of the rest of the string depends on whether the host
11650 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11651 looking up its IP address. (Looking up the IP address can be forced by the
11652 &%host_lookup%& option, independent of verification.) A plain host name at the
11653 start of the string is a verified host name; if this is not present,
11654 verification either failed or was not requested. A host name in parentheses is
11655 the argument of a HELO or EHLO command. This is omitted if it is identical to
11656 the verified host name or to the host's IP address in square brackets.
11657
11658 .vitem &$sender_helo_name$&
11659 .vindex "&$sender_helo_name$&"
11660 When a message is received from a remote host that has issued a HELO or EHLO
11661 command, the argument of that command is placed in this variable. It is also
11662 set if HELO or EHLO is used when a message is received using SMTP locally via
11663 the &%-bs%& or &%-bS%& options.
11664
11665 .vitem &$sender_host_address$&
11666 .vindex "&$sender_host_address$&"
11667 When a message is received from a remote host, this variable contains that
11668 host's IP address. For locally submitted messages, it is empty.
11669
11670 .vitem &$sender_host_authenticated$&
11671 .vindex "&$sender_host_authenticated$&"
11672 This variable contains the name (not the public name) of the authenticator
11673 driver that successfully authenticated the client from which the message was
11674 received. It is empty if there was no successful authentication. See also
11675 &$authenticated_id$&.
11676
11677 .vitem &$sender_host_name$&
11678 .vindex "&$sender_host_name$&"
11679 When a message is received from a remote host, this variable contains the
11680 host's name as obtained by looking up its IP address. For messages received by
11681 other means, this variable is empty.
11682
11683 .vindex "&$host_lookup_failed$&"
11684 If the host name has not previously been looked up, a reference to
11685 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11686 A looked up name is accepted only if it leads back to the original IP address
11687 via a forward lookup. If either the reverse or the forward lookup fails to find
11688 any data, or if the forward lookup does not yield the original IP address,
11689 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11690
11691 .vindex "&$host_lookup_deferred$&"
11692 However, if either of the lookups cannot be completed (for example, there is a
11693 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11694 &$host_lookup_failed$& remains set to &"0"&.
11695
11696 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11697 host name again if there is a subsequent reference to &$sender_host_name$&
11698 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11699 is set to &"1"&.
11700
11701 Exim does not automatically look up every calling host's name. If you want
11702 maximum efficiency, you should arrange your configuration so that it avoids
11703 these lookups altogether. The lookup happens only if one or more of the
11704 following are true:
11705
11706 .ilist
11707 A string containing &$sender_host_name$& is expanded.
11708 .next
11709 The calling host matches the list in &%host_lookup%&. In the default
11710 configuration, this option is set to *, so it must be changed if lookups are
11711 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11712 .next
11713 Exim needs the host name in order to test an item in a host list. The items
11714 that require this are described in sections &<<SECThoslispatnam>>& and
11715 &<<SECThoslispatnamsk>>&.
11716 .next
11717 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11718 In this case, the host name is required to compare with the name quoted in any
11719 EHLO or HELO commands that the client issues.
11720 .next
11721 The remote host issues a EHLO or HELO command that quotes one of the
11722 domains in &%helo_lookup_domains%&. The default value of this option is
11723 . ==== As this is a nested list, any displays it contains must be indented
11724 . ==== as otherwise they are too far to the left.
11725 .code
11726   helo_lookup_domains = @ : @[]
11727 .endd
11728 which causes a lookup if a remote host (incorrectly) gives the server's name or
11729 IP address in an EHLO or HELO command.
11730 .endlist
11731
11732
11733 .vitem &$sender_host_port$&
11734 .vindex "&$sender_host_port$&"
11735 When a message is received from a remote host, this variable contains the port
11736 number that was used on the remote host.
11737
11738 .vitem &$sender_ident$&
11739 .vindex "&$sender_ident$&"
11740 When a message is received from a remote host, this variable contains the
11741 identification received in response to an RFC 1413 request. When a message has
11742 been received locally, this variable contains the login name of the user that
11743 called Exim.
11744
11745 .vitem &$sender_rate_$&&'xxx'&
11746 A number of variables whose names begin &$sender_rate_$& are set as part of the
11747 &%ratelimit%& ACL condition. Details are given in section
11748 &<<SECTratelimiting>>&.
11749
11750 .vitem &$sender_rcvhost$&
11751 .cindex "DNS" "reverse lookup"
11752 .cindex "reverse DNS lookup"
11753 .vindex "&$sender_rcvhost$&"
11754 This is provided specifically for use in &'Received:'& headers. It starts with
11755 either the verified host name (as obtained from a reverse DNS lookup) or, if
11756 there is no verified host name, the IP address in square brackets. After that
11757 there may be text in parentheses. When the first item is a verified host name,
11758 the first thing in the parentheses is the IP address in square brackets,
11759 followed by a colon and a port number if port logging is enabled. When the
11760 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11761 the parentheses.
11762
11763 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11764 was used and its argument was not identical to the real host name or IP
11765 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11766 all three items are present in the parentheses, a newline and tab are inserted
11767 into the string, to improve the formatting of the &'Received:'& header.
11768
11769 .vitem &$sender_verify_failure$&
11770 .vindex "&$sender_verify_failure$&"
11771 In an ACL, when a sender verification fails, this variable contains information
11772 about the failure. The details are the same as for
11773 &$recipient_verify_failure$&.
11774
11775 .vitem &$sending_ip_address$&
11776 .vindex "&$sending_ip_address$&"
11777 This variable is set whenever an outgoing SMTP connection to another host has
11778 been set up. It contains the IP address of the local interface that is being
11779 used. This is useful if a host that has more than one IP address wants to take
11780 on different personalities depending on which one is being used. For incoming
11781 connections, see &$received_ip_address$&.
11782
11783 .vitem &$sending_port$&
11784 .vindex "&$sending_port$&"
11785 This variable is set whenever an outgoing SMTP connection to another host has
11786 been set up. It contains the local port that is being used. For incoming
11787 connections, see &$received_port$&.
11788
11789 .vitem &$smtp_active_hostname$&
11790 .vindex "&$smtp_active_hostname$&"
11791 During an incoming SMTP session, this variable contains the value of the active
11792 host name, as specified by the &%smtp_active_hostname%& option. The value of
11793 &$smtp_active_hostname$& is saved with any message that is received, so its
11794 value can be consulted during routing and delivery.
11795
11796 .vitem &$smtp_command$&
11797 .vindex "&$smtp_command$&"
11798 During the processing of an incoming SMTP command, this variable contains the
11799 entire command. This makes it possible to distinguish between HELO and EHLO in
11800 the HELO ACL, and also to distinguish between commands such as these:
11801 .code
11802 MAIL FROM:<>
11803 MAIL FROM: <>
11804 .endd
11805 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11806 command, the address in &$smtp_command$& is the original address before any
11807 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11808 the address after SMTP-time rewriting.
11809
11810 .vitem &$smtp_command_argument$&
11811 .cindex "SMTP" "command, argument for"
11812 .vindex "&$smtp_command_argument$&"
11813 While an ACL is running to check an SMTP command, this variable contains the
11814 argument, that is, the text that follows the command name, with leading white
11815 space removed. Following the introduction of &$smtp_command$&, this variable is
11816 somewhat redundant, but is retained for backwards compatibility.
11817
11818 .vitem &$smtp_count_at_connection_start$&
11819 .vindex "&$smtp_count_at_connection_start$&"
11820 This variable is set greater than zero only in processes spawned by the Exim
11821 daemon for handling incoming SMTP connections. The name is deliberately long,
11822 in order to emphasize what the contents are. When the daemon accepts a new
11823 connection, it increments this variable. A copy of the variable is passed to
11824 the child process that handles the connection, but its value is fixed, and
11825 never changes. It is only an approximation of how many incoming connections
11826 there actually are, because many other connections may come and go while a
11827 single connection is being processed. When a child process terminates, the
11828 daemon decrements its copy of the variable.
11829
11830 .vitem "&$sn0$& &-- &$sn9$&"
11831 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11832 that were current at the end of the system filter file. This allows a system
11833 filter file to set values that can be tested in users' filter files. For
11834 example, a system filter could set a value indicating how likely it is that a
11835 message is junk mail.
11836
11837 .vitem &$spam_$&&'xxx'&
11838 A number of variables whose names start with &$spam$& are available when Exim
11839 is compiled with the content-scanning extension. For details, see section
11840 &<<SECTscanspamass>>&.
11841
11842
11843 .vitem &$spool_directory$&
11844 .vindex "&$spool_directory$&"
11845 The name of Exim's spool directory.
11846
11847 .vitem &$spool_inodes$&
11848 .vindex "&$spool_inodes$&"
11849 The number of free inodes in the disk partition where Exim's spool files are
11850 being written. The value is recalculated whenever the variable is referenced.
11851 If the relevant file system does not have the concept of inodes, the value of
11852 is -1. See also the &%check_spool_inodes%& option.
11853
11854 .vitem &$spool_space$&
11855 .vindex "&$spool_space$&"
11856 The amount of free space (as a number of kilobytes) in the disk partition where
11857 Exim's spool files are being written. The value is recalculated whenever the
11858 variable is referenced. If the operating system does not have the ability to
11859 find the amount of free space (only true for experimental systems), the space
11860 value is -1. For example, to check in an ACL that there is at least 50
11861 megabytes free on the spool, you could write:
11862 .code
11863 condition = ${if > {$spool_space}{50000}}
11864 .endd
11865 See also the &%check_spool_space%& option.
11866
11867
11868 .vitem &$thisaddress$&
11869 .vindex "&$thisaddress$&"
11870 This variable is set only during the processing of the &%foranyaddress%&
11871 command in a filter file. Its use is explained in the description of that
11872 command, which can be found in the separate document entitled &'Exim's
11873 interfaces to mail filtering'&.
11874
11875 .new
11876 .vitem &$tls_bits$&
11877 .vindex "&$tls_bits$&"
11878 Contains an approximation of the TLS cipher's bit-strength; the meaning of
11879 this depends upon the TLS implementation used.
11880 If TLS has not been negotiated, the value will be 0.
11881 The value of this is automatically fed into the Cyrus SASL authenticator
11882 when acting as a server, to specify the "external SSF" (a SASL term).
11883 .wen
11884
11885 .vitem &$tls_certificate_verified$&
11886 .vindex "&$tls_certificate_verified$&"
11887 This variable is set to &"1"& if a TLS certificate was verified when the
11888 message was received, and &"0"& otherwise.
11889
11890 .vitem &$tls_cipher$&
11891 .vindex "&$tls_cipher$&"
11892 When a message is received from a remote host over an encrypted SMTP
11893 connection, this variable is set to the cipher suite that was negotiated, for
11894 example DES-CBC3-SHA. In other circumstances, in particular, for message
11895 received over unencrypted connections, the variable is empty. Testing
11896 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11897 non-encrypted connections during ACL processing.
11898
11899 The &$tls_cipher$& variable retains its value during message delivery, except
11900 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11901 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11902 and then set to the outgoing cipher suite if one is negotiated. See chapter
11903 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11904 details of the &(smtp)& transport.
11905
11906 .vitem &$tls_peerdn$&
11907 .vindex "&$tls_peerdn$&"
11908 When a message is received from a remote host over an encrypted SMTP
11909 connection, and Exim is configured to request a certificate from the client,
11910 the value of the Distinguished Name of the certificate is made available in the
11911 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11912 value is retained during message delivery, except during outbound SMTP
11913 deliveries.
11914
11915 .new
11916 .vitem &$tls_sni$&
11917 .vindex "&$tls_sni$&"
11918 .cindex "TLS" "Server Name Indication"
11919 When a TLS session is being established, if the client sends the Server
11920 Name Indication extension, the value will be placed in this variable.
11921 If the variable appears in &%tls_certificate%& then this option and
11922 some others, described in &<<SECTtlssni>>&,
11923 will be re-expanded early in the TLS session, to permit
11924 a different certificate to be presented (and optionally a different key to be
11925 used) to the client, based upon the value of the SNI extension.
11926
11927 The value will be retained for the lifetime of the message.  During outbound
11928 SMTP deliveries, it reflects the value of the &%tls_sni%& option on
11929 the transport.
11930
11931 This is currently only available when using OpenSSL, built with support for
11932 SNI.
11933 .wen
11934
11935 .vitem &$tod_bsdinbox$&
11936 .vindex "&$tod_bsdinbox$&"
11937 The time of day and the date, in the format required for BSD-style mailbox
11938 files, for example: Thu Oct 17 17:14:09 1995.
11939
11940 .vitem &$tod_epoch$&
11941 .vindex "&$tod_epoch$&"
11942 The time and date as a number of seconds since the start of the Unix epoch.
11943
11944 .vitem &$tod_full$&
11945 .vindex "&$tod_full$&"
11946 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11947 +0100. The timezone is always given as a numerical offset from UTC, with
11948 positive values used for timezones that are ahead (east) of UTC, and negative
11949 values for those that are behind (west).
11950
11951 .vitem &$tod_log$&
11952 .vindex "&$tod_log$&"
11953 The time and date in the format used for writing Exim's log files, for example:
11954 1995-10-12 15:32:29, but without a timezone.
11955
11956 .vitem &$tod_logfile$&
11957 .vindex "&$tod_logfile$&"
11958 This variable contains the date in the format yyyymmdd. This is the format that
11959 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11960 flag.
11961
11962 .vitem &$tod_zone$&
11963 .vindex "&$tod_zone$&"
11964 This variable contains the numerical value of the local timezone, for example:
11965 -0500.
11966
11967 .vitem &$tod_zulu$&
11968 .vindex "&$tod_zulu$&"
11969 This variable contains the UTC date and time in &"Zulu"& format, as specified
11970 by ISO 8601, for example: 20030221154023Z.
11971
11972 .vitem &$value$&
11973 .vindex "&$value$&"
11974 This variable contains the result of an expansion lookup, extraction operation,
11975 or external command, as described above. It is also used during a
11976 &*reduce*& expansion.
11977
11978 .vitem &$version_number$&
11979 .vindex "&$version_number$&"
11980 The version number of Exim.
11981
11982 .vitem &$warn_message_delay$&
11983 .vindex "&$warn_message_delay$&"
11984 This variable is set only during the creation of a message warning about a
11985 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11986
11987 .vitem &$warn_message_recipients$&
11988 .vindex "&$warn_message_recipients$&"
11989 This variable is set only during the creation of a message warning about a
11990 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11991 .endlist
11992 .ecindex IIDstrexp
11993
11994
11995
11996 . ////////////////////////////////////////////////////////////////////////////
11997 . ////////////////////////////////////////////////////////////////////////////
11998
11999 .chapter "Embedded Perl" "CHAPperl"
12000 .scindex IIDperl "Perl" "calling from Exim"
12001 Exim can be built to include an embedded Perl interpreter. When this is done,
12002 Perl subroutines can be called as part of the string expansion process. To make
12003 use of the Perl support, you need version 5.004 or later of Perl installed on
12004 your system. To include the embedded interpreter in the Exim binary, include
12005 the line
12006 .code
12007 EXIM_PERL = perl.o
12008 .endd
12009 in your &_Local/Makefile_& and then build Exim in the normal way.
12010
12011
12012 .section "Setting up so Perl can be used" "SECID85"
12013 .oindex "&%perl_startup%&"
12014 Access to Perl subroutines is via a global configuration option called
12015 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12016 no &%perl_startup%& option in the Exim configuration file then no Perl
12017 interpreter is started and there is almost no overhead for Exim (since none of
12018 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12019 option then the associated value is taken to be Perl code which is executed in
12020 a newly created Perl interpreter.
12021
12022 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12023 need backslashes before any characters to escape special meanings. The option
12024 should usually be something like
12025 .code
12026 perl_startup = do '/etc/exim.pl'
12027 .endd
12028 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12029 use from Exim. Exim can be configured either to start up a Perl interpreter as
12030 soon as it is entered, or to wait until the first time it is needed. Starting
12031 the interpreter at the beginning ensures that it is done while Exim still has
12032 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12033 fact used in a particular run. Also, note that this does not mean that Exim is
12034 necessarily running as root when Perl is called at a later time. By default,
12035 the interpreter is started only when it is needed, but this can be changed in
12036 two ways:
12037
12038 .ilist
12039 .oindex "&%perl_at_start%&"
12040 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12041 a startup when Exim is entered.
12042 .next
12043 The command line option &%-ps%& also requests a startup when Exim is entered,
12044 overriding the setting of &%perl_at_start%&.
12045 .endlist
12046
12047 There is also a command line option &%-pd%& (for delay) which suppresses the
12048 initial startup, even if &%perl_at_start%& is set.
12049
12050
12051 .section "Calling Perl subroutines" "SECID86"
12052 When the configuration file includes a &%perl_startup%& option you can make use
12053 of the string expansion item to call the Perl subroutines that are defined
12054 by the &%perl_startup%& code. The operator is used in any of the following
12055 forms:
12056 .code
12057 ${perl{foo}}
12058 ${perl{foo}{argument}}
12059 ${perl{foo}{argument1}{argument2} ... }
12060 .endd
12061 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12062 arguments may be passed. Passing more than this results in an expansion failure
12063 with an error message of the form
12064 .code
12065 Too many arguments passed to Perl subroutine "foo" (max is 8)
12066 .endd
12067 The return value of the Perl subroutine is evaluated in a scalar context before
12068 it is passed back to Exim to be inserted into the expanded string. If the
12069 return value is &'undef'&, the expansion is forced to fail in the same way as
12070 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12071 by obeying Perl's &%die%& function, the expansion fails with the error message
12072 that was passed to &%die%&.
12073
12074
12075 .section "Calling Exim functions from Perl" "SECID87"
12076 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12077 is available to call back into Exim's string expansion function. For example,
12078 the Perl code
12079 .code
12080 my $lp = Exim::expand_string('$local_part');
12081 .endd
12082 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12083 Note those are single quotes and not double quotes to protect against
12084 &$local_part$& being interpolated as a Perl variable.
12085
12086 If the string expansion is forced to fail by a &"fail"& item, the result of
12087 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12088 expansion string, the Perl call from the original expansion string fails with
12089 an appropriate error message, in the same way as if &%die%& were used.
12090
12091 .cindex "debugging" "from embedded Perl"
12092 .cindex "log" "writing from embedded Perl"
12093 Two other Exim functions are available for use from within Perl code.
12094 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12095 debugging is enabled. If you want a newline at the end, you must supply it.
12096 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12097 timestamp. In this case, you should not supply a terminating newline.
12098
12099
12100 .section "Use of standard output and error by Perl" "SECID88"
12101 .cindex "Perl" "standard output and error"
12102 You should not write to the standard error or output streams from within your
12103 Perl code, as it is not defined how these are set up. In versions of Exim
12104 before 4.50, it is possible for the standard output or error to refer to the
12105 SMTP connection during message reception via the daemon. Writing to this stream
12106 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12107 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12108 avoided, but the output is lost.
12109
12110 .cindex "Perl" "use of &%warn%&"
12111 The Perl &%warn%& statement writes to the standard error stream by default.
12112 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12113 you have no control. When Exim starts up the Perl interpreter, it arranges for
12114 output from the &%warn%& statement to be written to the Exim main log. You can
12115 change this by including appropriate Perl magic somewhere in your Perl code.
12116 For example, to discard &%warn%& output completely, you need this:
12117 .code
12118 $SIG{__WARN__} = sub { };
12119 .endd
12120 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12121 example, the code for the subroutine is empty, so it does nothing, but you can
12122 include any Perl code that you like. The text of the &%warn%& message is passed
12123 as the first subroutine argument.
12124 .ecindex IIDperl
12125
12126
12127 . ////////////////////////////////////////////////////////////////////////////
12128 . ////////////////////////////////////////////////////////////////////////////
12129
12130 .chapter "Starting the daemon and the use of network interfaces" &&&
12131          "CHAPinterfaces" &&&
12132          "Starting the daemon"
12133 .cindex "daemon" "starting"
12134 .cindex "interface" "listening"
12135 .cindex "network interface"
12136 .cindex "interface" "network"
12137 .cindex "IP address" "for listening"
12138 .cindex "daemon" "listening IP addresses"
12139 .cindex "TCP/IP" "setting listening interfaces"
12140 .cindex "TCP/IP" "setting listening ports"
12141 A host that is connected to a TCP/IP network may have one or more physical
12142 hardware network interfaces. Each of these interfaces may be configured as one
12143 or more &"logical"& interfaces, which are the entities that a program actually
12144 works with. Each of these logical interfaces is associated with an IP address.
12145 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12146 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12147 knowledge about the host's interfaces for use in three different circumstances:
12148
12149 .olist
12150 When a listening daemon is started, Exim needs to know which interfaces
12151 and ports to listen on.
12152 .next
12153 When Exim is routing an address, it needs to know which IP addresses
12154 are associated with local interfaces. This is required for the correct
12155 processing of MX lists by removing the local host and others with the
12156 same or higher priority values. Also, Exim needs to detect cases
12157 when an address is routed to an IP address that in fact belongs to the
12158 local host. Unless the &%self%& router option or the &%allow_localhost%&
12159 option of the smtp transport is set (as appropriate), this is treated
12160 as an error situation.
12161 .next
12162 When Exim connects to a remote host, it may need to know which interface to use
12163 for the outgoing connection.
12164 .endlist
12165
12166
12167 Exim's default behaviour is likely to be appropriate in the vast majority
12168 of cases. If your host has only one interface, and you want all its IP
12169 addresses to be treated in the same way, and you are using only the
12170 standard SMTP port, you should not need to take any special action. The
12171 rest of this chapter does not apply to you.
12172
12173 In a more complicated situation you may want to listen only on certain
12174 interfaces, or on different ports, and for this reason there are a number of
12175 options that can be used to influence Exim's behaviour. The rest of this
12176 chapter describes how they operate.
12177
12178 When a message is received over TCP/IP, the interface and port that were
12179 actually used are set in &$received_ip_address$& and &$received_port$&.
12180
12181
12182
12183 .section "Starting a listening daemon" "SECID89"
12184 When a listening daemon is started (by means of the &%-bd%& command line
12185 option), the interfaces and ports on which it listens are controlled by the
12186 following options:
12187
12188 .ilist
12189 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12190 compatibility, this option can also be specified in the singular.)
12191 .next
12192 &%local_interfaces%& contains list of interface IP addresses on which to
12193 listen. Each item may optionally also specify a port.
12194 .endlist
12195
12196 The default list separator in both cases is a colon, but this can be changed as
12197 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12198 it is usually best to change the separator to avoid having to double all the
12199 colons. For example:
12200 .code
12201 local_interfaces = <; 127.0.0.1 ; \
12202                       192.168.23.65 ; \
12203                       ::1 ; \
12204                       3ffe:ffff:836f::fe86:a061
12205 .endd
12206 There are two different formats for specifying a port along with an IP address
12207 in &%local_interfaces%&:
12208
12209 .olist
12210 The port is added onto the address with a dot separator. For example, to listen
12211 on port 1234 on two different IP addresses:
12212 .code
12213 local_interfaces = <; 192.168.23.65.1234 ; \
12214                       3ffe:ffff:836f::fe86:a061.1234
12215 .endd
12216 .next
12217 The IP address is enclosed in square brackets, and the port is added
12218 with a colon separator, for example:
12219 .code
12220 local_interfaces = <; [192.168.23.65]:1234 ; \
12221                       [3ffe:ffff:836f::fe86:a061]:1234
12222 .endd
12223 .endlist
12224
12225 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12226 default setting contains just one port:
12227 .code
12228 daemon_smtp_ports = smtp
12229 .endd
12230 If more than one port is listed, each interface that does not have its own port
12231 specified listens on all of them. Ports that are listed in
12232 &%daemon_smtp_ports%& can be identified either by name (defined in
12233 &_/etc/services_&) or by number. However, when ports are given with individual
12234 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12235
12236
12237
12238 .section "Special IP listening addresses" "SECID90"
12239 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12240 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12241 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12242 instead of setting up separate listening sockets for each interface. The
12243 default value of &%local_interfaces%& is
12244 .code
12245 local_interfaces = 0.0.0.0
12246 .endd
12247 when Exim is built without IPv6 support; otherwise it is:
12248 .code
12249 local_interfaces = <; ::0 ; 0.0.0.0
12250 .endd
12251 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12252
12253
12254
12255 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12256 The &%-oX%& command line option can be used to override the values of
12257 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12258 instance. Another way of doing this would be to use macros and the &%-D%&
12259 option. However, &%-oX%& can be used by any admin user, whereas modification of
12260 the runtime configuration by &%-D%& is allowed only when the caller is root or
12261 exim.
12262
12263 The value of &%-oX%& is a list of items. The default colon separator can be
12264 changed in the usual way if required. If there are any items that do not
12265 contain dots or colons (that is, are not IP addresses), the value of
12266 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12267 items that do contain dots or colons, the value of &%local_interfaces%& is
12268 replaced by those items. Thus, for example,
12269 .code
12270 -oX 1225
12271 .endd
12272 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12273 whereas
12274 .code
12275 -oX 192.168.34.5.1125
12276 .endd
12277 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12278 (However, since &%local_interfaces%& now contains no items without ports, the
12279 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12280
12281
12282
12283 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12284 .cindex "ssmtp protocol"
12285 .cindex "smtps protocol"
12286 .cindex "SMTP" "ssmtp protocol"
12287 .cindex "SMTP" "smtps protocol"
12288 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12289 before the STARTTLS command was standardized for SMTP. Some legacy clients
12290 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12291 list of port numbers, connections to those ports must use SSMTP. The most
12292 common use of this option is expected to be
12293 .code
12294 tls_on_connect_ports = 465
12295 .endd
12296 because 465 is the usual port number used by the legacy clients. There is also
12297 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12298 this way when a daemon is started.
12299
12300 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12301 daemon to listen on those ports. You must still specify them in
12302 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12303 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12304 connections via the daemon.)
12305
12306
12307
12308
12309 .section "IPv6 address scopes" "SECID92"
12310 .cindex "IPv6" "address scopes"
12311 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12312 can, in principle, have the same link-local IPv6 address on different
12313 interfaces. Thus, additional information is needed, over and above the IP
12314 address, to distinguish individual interfaces. A convention of using a
12315 percent sign followed by something (often the interface name) has been
12316 adopted in some cases, leading to addresses like this:
12317 .code
12318 fe80::202:b3ff:fe03:45c1%eth0
12319 .endd
12320 To accommodate this usage, a percent sign followed by an arbitrary string is
12321 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12322 to convert a textual IPv6 address for actual use. This function recognizes the
12323 percent convention in operating systems that support it, and it processes the
12324 address appropriately. Unfortunately, some older libraries have problems with
12325 &[getaddrinfo()]&. If
12326 .code
12327 IPV6_USE_INET_PTON=yes
12328 .endd
12329 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12330 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12331 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12332 function.) Of course, this means that the additional functionality of
12333 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12334
12335 .section "Disabling IPv6" "SECID93"
12336 .cindex "IPv6" "disabling"
12337 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12338 run on a host whose kernel does not support IPv6. The binary will fall back to
12339 using IPv4, but it may waste resources looking up AAAA records, and trying to
12340 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12341 .oindex "&%disable_ipv6%&"
12342 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12343 activities take place. AAAA records are never looked up, and any IPv6 addresses
12344 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12345 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12346 to handle IPv6 literal addresses.
12347
12348 On the other hand, when IPv6 is in use, there may be times when you want to
12349 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12350 option to globally suppress the lookup of AAAA records for specified domains,
12351 and you can use the &%ignore_target_hosts%& generic router option to ignore
12352 IPv6 addresses in an individual router.
12353
12354
12355
12356 .section "Examples of starting a listening daemon" "SECID94"
12357 The default case in an IPv6 environment is
12358 .code
12359 daemon_smtp_ports = smtp
12360 local_interfaces = <; ::0 ; 0.0.0.0
12361 .endd
12362 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12363 Either one or two sockets may be used, depending on the characteristics of
12364 the TCP/IP stack. (This is complicated and messy; for more information,
12365 read the comments in the &_daemon.c_& source file.)
12366
12367 To specify listening on ports 25 and 26 on all interfaces:
12368 .code
12369 daemon_smtp_ports = 25 : 26
12370 .endd
12371 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12372 .code
12373 local_interfaces = <; ::0.25     ; ::0.26 \
12374                       0.0.0.0.25 ; 0.0.0.0.26
12375 .endd
12376 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12377 IPv4 loopback address only:
12378 .code
12379 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12380 .endd
12381 To specify listening on the default port on specific interfaces only:
12382 .code
12383 local_interfaces = 192.168.34.67 : 192.168.34.67
12384 .endd
12385 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12386
12387
12388
12389 .section "Recognizing the local host" "SECTreclocipadd"
12390 The &%local_interfaces%& option is also used when Exim needs to determine
12391 whether or not an IP address refers to the local host. That is, the IP
12392 addresses of all the interfaces on which a daemon is listening are always
12393 treated as local.
12394
12395 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12396 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12397 available interfaces from the operating system, and extracts the relevant
12398 (that is, IPv4 or IPv6) addresses to use for checking.
12399
12400 Some systems set up large numbers of virtual interfaces in order to provide
12401 many virtual web servers. In this situation, you may want to listen for
12402 email on only a few of the available interfaces, but nevertheless treat all
12403 interfaces as local when routing. You can do this by setting
12404 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12405 &"all"& wildcard values. These addresses are recognized as local, but are not
12406 used for listening. Consider this example:
12407 .code
12408 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12409                       192.168.53.235 ; \
12410                       3ffe:2101:12:1:a00:20ff:fe86:a061
12411
12412 extra_local_interfaces = <; ::0 ; 0.0.0.0
12413 .endd
12414 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12415 address, but all available interface addresses are treated as local when
12416 Exim is routing.
12417
12418 In some environments the local host name may be in an MX list, but with an IP
12419 address that is not assigned to any local interface. In other cases it may be
12420 desirable to treat other host names as if they referred to the local host. Both
12421 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12422 This contains host names rather than IP addresses. When a host is referenced
12423 during routing, either via an MX record or directly, it is treated as the local
12424 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12425 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12426
12427
12428
12429 .section "Delivering to a remote host" "SECID95"
12430 Delivery to a remote host is handled by the smtp transport. By default, it
12431 allows the system's TCP/IP functions to choose which interface to use (if
12432 there is more than one) when connecting to a remote host. However, the
12433 &%interface%& option can be set to specify which interface is used. See the
12434 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12435 details.
12436
12437
12438
12439
12440 . ////////////////////////////////////////////////////////////////////////////
12441 . ////////////////////////////////////////////////////////////////////////////
12442
12443 .chapter "Main configuration" "CHAPmainconfig"
12444 .scindex IIDconfima "configuration file" "main section"
12445 .scindex IIDmaiconf "main configuration"
12446 The first part of the run time configuration file contains three types of item:
12447
12448 .ilist
12449 Macro definitions: These lines start with an upper case letter. See section
12450 &<<SECTmacrodefs>>& for details of macro processing.
12451 .next
12452 Named list definitions: These lines start with one of the words &"domainlist"&,
12453 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12454 section &<<SECTnamedlists>>&.
12455 .next
12456 Main configuration settings: Each setting occupies one line of the file
12457 (with possible continuations). If any setting is preceded by the word
12458 &"hide"&, the &%-bP%& command line option displays its value to admin users
12459 only. See section &<<SECTcos>>& for a description of the syntax of these option
12460 settings.
12461 .endlist
12462
12463 This chapter specifies all the main configuration options, along with their
12464 types and default values. For ease of finding a particular option, they appear
12465 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12466 are now so many options, they are first listed briefly in functional groups, as
12467 an aid to finding the name of the option you are looking for. Some options are
12468 listed in more than one group.
12469
12470 .section "Miscellaneous" "SECID96"
12471 .table2
12472 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12473 .row &%disable_ipv6%&                "do no IPv6 processing"
12474 .row &%keep_malformed%&              "for broken files &-- should not happen"
12475 .row &%localhost_number%&            "for unique message ids in clusters"
12476 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12477 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12478 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12479 .row &%print_topbitchars%&           "top-bit characters are printing"
12480 .row &%timezone%&                    "force time zone"
12481 .endtable
12482
12483
12484 .section "Exim parameters" "SECID97"
12485 .table2
12486 .row &%exim_group%&                  "override compiled-in value"
12487 .row &%exim_path%&                   "override compiled-in value"
12488 .row &%exim_user%&                   "override compiled-in value"
12489 .row &%primary_hostname%&            "default from &[uname()]&"
12490 .row &%split_spool_directory%&       "use multiple directories"
12491 .row &%spool_directory%&             "override compiled-in value"
12492 .endtable
12493
12494
12495
12496 .section "Privilege controls" "SECID98"
12497 .table2
12498 .row &%admin_groups%&                "groups that are Exim admin users"
12499 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12500 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12501 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12502 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12503 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12504 .row &%never_users%&                 "do not run deliveries as these"
12505 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12506 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12507 .row &%trusted_groups%&              "groups that are trusted"
12508 .row &%trusted_users%&               "users that are trusted"
12509 .endtable
12510
12511
12512
12513 .section "Logging" "SECID99"
12514 .table2
12515 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12516 .row &%log_file_path%&               "override compiled-in value"
12517 .row &%log_selector%&                "set/unset optional logging"
12518 .row &%log_timezone%&                "add timezone to log lines"
12519 .row &%message_logs%&                "create per-message logs"
12520 .row &%preserve_message_logs%&       "after message completion"
12521 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12522 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12523 .row &%syslog_facility%&             "set syslog &""facility""& field"
12524 .row &%syslog_processname%&          "set syslog &""ident""& field"
12525 .row &%syslog_timestamp%&            "timestamp syslog lines"
12526 .row &%write_rejectlog%&             "control use of message log"
12527 .endtable
12528
12529
12530
12531 .section "Frozen messages" "SECID100"
12532 .table2
12533 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12534 .row &%freeze_tell%&                 "send message when freezing"
12535 .row &%move_frozen_messages%&        "to another directory"
12536 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12537 .endtable
12538
12539
12540
12541 .section "Data lookups" "SECID101"
12542 .table2
12543 .row &%ibase_servers%&               "InterBase servers"
12544 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12545 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12546 .row &%ldap_cert_file%&              "client cert file for LDAP"
12547 .row &%ldap_cert_key%&               "client key file for LDAP"
12548 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12549 .row &%ldap_default_servers%&        "used if no server in query"
12550 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12551 .row &%ldap_start_tls%&              "require TLS within LDAP"
12552 .row &%ldap_version%&                "set protocol version"
12553 .row &%lookup_open_max%&             "lookup files held open"
12554 .row &%mysql_servers%&               "default MySQL servers"
12555 .row &%oracle_servers%&              "Oracle servers"
12556 .row &%pgsql_servers%&               "default PostgreSQL servers"
12557 .row &%sqlite_lock_timeout%&         "as it says"
12558 .endtable
12559
12560
12561
12562 .section "Message ids" "SECID102"
12563 .table2
12564 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12565 .row &%message_id_header_text%&      "ditto"
12566 .endtable
12567
12568
12569
12570 .section "Embedded Perl Startup" "SECID103"
12571 .table2
12572 .row &%perl_at_start%&               "always start the interpreter"
12573 .row &%perl_startup%&                "code to obey when starting Perl"
12574 .endtable
12575
12576
12577
12578 .section "Daemon" "SECID104"
12579 .table2
12580 .row &%daemon_smtp_ports%&           "default ports"
12581 .row &%daemon_startup_retries%&      "number of times to retry"
12582 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12583 .row &%extra_local_interfaces%&      "not necessarily listened on"
12584 .row &%local_interfaces%&            "on which to listen, with optional ports"
12585 .row &%pid_file_path%&               "override compiled-in value"
12586 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12587 .endtable
12588
12589
12590
12591 .section "Resource control" "SECID105"
12592 .table2
12593 .row &%check_log_inodes%&            "before accepting a message"
12594 .row &%check_log_space%&             "before accepting a message"
12595 .row &%check_spool_inodes%&          "before accepting a message"
12596 .row &%check_spool_space%&           "before accepting a message"
12597 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12598 .row &%queue_only_load%&             "queue incoming if load high"
12599 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12600 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12601 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12602 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12603 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12604 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12605 .row &%smtp_accept_max_per_connection%& "messages per connection"
12606 .row &%smtp_accept_max_per_host%&    "connections from one host"
12607 .row &%smtp_accept_queue%&           "queue mail if more connections"
12608 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12609                                            connection"
12610 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12611 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12612 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12613 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12614 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12615 .endtable
12616
12617
12618
12619 .section "Policy controls" "SECID106"
12620 .table2
12621 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12622 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12623 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12624 .row &%acl_smtp_auth%&               "ACL for AUTH"
12625 .row &%acl_smtp_connect%&            "ACL for connection"
12626 .row &%acl_smtp_data%&               "ACL for DATA"
12627 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12628 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12629 .row &%acl_smtp_expn%&               "ACL for EXPN"
12630 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12631 .row &%acl_smtp_mail%&               "ACL for MAIL"
12632 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12633 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12634 .row &%acl_smtp_predata%&            "ACL for start of data"
12635 .row &%acl_smtp_quit%&               "ACL for QUIT"
12636 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12637 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12638 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12639 .row &%av_scanner%&                  "specify virus scanner"
12640 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12641                                       words""&"
12642 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12643 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12644 .row &%header_maxsize%&              "total size of message header"
12645 .row &%header_line_maxsize%&         "individual header line limit"
12646 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12647 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12648 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12649 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12650 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12651 .row &%host_lookup%&                 "host name looked up for these hosts"
12652 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12653 .row &%host_reject_connection%&      "reject connection from these hosts"
12654 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12655 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12656 .row &%message_size_limit%&          "for all messages"
12657 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12658 .row &%spamd_address%&               "set interface to SpamAssassin"
12659 .row &%strict_acl_vars%&             "object to unset ACL variables"
12660 .endtable
12661
12662
12663
12664 .section "Callout cache" "SECID107"
12665 .table2
12666 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12667                                          item"
12668 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12669                                          item"
12670 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12671 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12672 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12673 .endtable
12674
12675
12676
12677 .section "TLS" "SECID108"
12678 .table2
12679 .row &%gnutls_require_kx%&           "control GnuTLS key exchanges"
12680 .row &%gnutls_require_mac%&          "control GnuTLS MAC algorithms"
12681 .row &%gnutls_require_protocols%&    "control GnuTLS protocols"
12682 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12683 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12684 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12685 .row &%tls_certificate%&             "location of server certificate"
12686 .row &%tls_crl%&                     "certificate revocation list"
12687 .row &%tls_dhparam%&                 "DH parameters for server"
12688 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12689 .row &%tls_privatekey%&              "location of server private key"
12690 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12691 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12692 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12693 .row &%tls_verify_certificates%&     "expected client certificates"
12694 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12695 .endtable
12696
12697
12698
12699 .section "Local user handling" "SECID109"
12700 .table2
12701 .row &%finduser_retries%&            "useful in NIS environments"
12702 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12703 .row &%gecos_pattern%&               "ditto"
12704 .row &%max_username_length%&         "for systems that truncate"
12705 .row &%unknown_login%&               "used when no login name found"
12706 .row &%unknown_username%&            "ditto"
12707 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12708 .row &%uucp_from_sender%&            "ditto"
12709 .endtable
12710
12711
12712
12713 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12714 .table2
12715 .row &%header_maxsize%&              "total size of message header"
12716 .row &%header_line_maxsize%&         "individual header line limit"
12717 .row &%message_size_limit%&          "applies to all messages"
12718 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12719 .row &%received_header_text%&        "expanded to make &'Received:'&"
12720 .row &%received_headers_max%&        "for mail loop detection"
12721 .row &%recipients_max%&              "limit per message"
12722 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12723 .endtable
12724
12725
12726
12727
12728 .section "Non-SMTP incoming messages" "SECID111"
12729 .table2
12730 .row &%receive_timeout%&             "for non-SMTP messages"
12731 .endtable
12732
12733
12734
12735
12736
12737 .section "Incoming SMTP messages" "SECID112"
12738 See also the &'Policy controls'& section above.
12739
12740 .table2
12741 .row &%host_lookup%&                 "host name looked up for these hosts"
12742 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12743 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12744 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12745 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12746 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12747 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12748 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12749 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12750 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12751 .row &%smtp_accept_max_per_connection%& "messages per connection"
12752 .row &%smtp_accept_max_per_host%&    "connections from one host"
12753 .row &%smtp_accept_queue%&           "queue mail if more connections"
12754 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12755                                            connection"
12756 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12757 .row &%smtp_active_hostname%&        "host name to use in messages"
12758 .row &%smtp_banner%&                 "text for welcome banner"
12759 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12760 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12761 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12762 .row &%smtp_etrn_command%&           "what to run for ETRN"
12763 .row &%smtp_etrn_serialize%&         "only one at once"
12764 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12765 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12766 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12767 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12768 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12769 .row &%smtp_receive_timeout%&        "per command or data line"
12770 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12771 .row &%smtp_return_error_details%&   "give detail on rejections"
12772 .endtable
12773
12774
12775
12776 .section "SMTP extensions" "SECID113"
12777 .table2
12778 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12779 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12780 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12781 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12782 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12783 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12784 .endtable
12785
12786
12787
12788 .section "Processing messages" "SECID114"
12789 .table2
12790 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12791 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12792 .row &%allow_utf8_domains%&          "in addresses"
12793 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12794                                       words""&"
12795 .row &%delivery_date_remove%&        "from incoming messages"
12796 .row &%envelope_to_remove%&          "from incoming messages"
12797 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12798 .row &%headers_charset%&             "default for translations"
12799 .row &%qualify_domain%&              "default for senders"
12800 .row &%qualify_recipient%&           "default for recipients"
12801 .row &%return_path_remove%&          "from incoming messages"
12802 .row &%strip_excess_angle_brackets%& "in addresses"
12803 .row &%strip_trailing_dot%&          "at end of addresses"
12804 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12805 .endtable
12806
12807
12808
12809 .section "System filter" "SECID115"
12810 .table2
12811 .row &%system_filter%&               "locate system filter"
12812 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12813                                             directory"
12814 .row &%system_filter_file_transport%& "transport for delivery to a file"
12815 .row &%system_filter_group%&         "group for filter running"
12816 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12817 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12818 .row &%system_filter_user%&          "user for filter running"
12819 .endtable
12820
12821
12822
12823 .section "Routing and delivery" "SECID116"
12824 .table2
12825 .row &%disable_ipv6%&                "do no IPv6 processing"
12826 .row &%dns_again_means_nonexist%&    "for broken domains"
12827 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12828 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12829 .row &%dns_retrans%&                 "parameter for resolver"
12830 .row &%dns_retry%&                   "parameter for resolver"
12831 .row &%dns_use_edns0%&               "parameter for resolver"
12832 .row &%hold_domains%&                "hold delivery for these domains"
12833 .row &%local_interfaces%&            "for routing checks"
12834 .row &%queue_domains%&               "no immediate delivery for these"
12835 .row &%queue_only%&                  "no immediate delivery at all"
12836 .row &%queue_only_file%&             "no immediate delivery if file exists"
12837 .row &%queue_only_load%&             "no immediate delivery if load is high"
12838 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12839 .row &%queue_only_override%&         "allow command line to override"
12840 .row &%queue_run_in_order%&          "order of arrival"
12841 .row &%queue_run_max%&               "of simultaneous queue runners"
12842 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12843 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12844 .row &%remote_sort_domains%&         "order of remote deliveries"
12845 .row &%retry_data_expire%&           "timeout for retry data"
12846 .row &%retry_interval_max%&          "safety net for retry rules"
12847 .endtable
12848
12849
12850
12851 .section "Bounce and warning messages" "SECID117"
12852 .table2
12853 .row &%bounce_message_file%&         "content of bounce"
12854 .row &%bounce_message_text%&         "content of bounce"
12855 .row &%bounce_return_body%&          "include body if returning message"
12856 .row &%bounce_return_message%&       "include original message in bounce"
12857 .row &%bounce_return_size_limit%&    "limit on returned message"
12858 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12859 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12860 .row &%errors_copy%&                 "copy bounce messages"
12861 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12862 .row &%delay_warning%&               "time schedule"
12863 .row &%delay_warning_condition%&     "condition for warning messages"
12864 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12865 .row &%smtp_return_error_details%&   "give detail on rejections"
12866 .row &%warn_message_file%&           "content of warning message"
12867 .endtable
12868
12869
12870
12871 .section "Alphabetical list of main options" "SECTalomo"
12872 Those options that undergo string expansion before use are marked with
12873 &dagger;.
12874
12875 .new
12876 .option accept_8bitmime main boolean true
12877 .cindex "8BITMIME"
12878 .cindex "8-bit characters"
12879 This option causes Exim to send 8BITMIME in its response to an SMTP
12880 EHLO command, and to accept the BODY= parameter on MAIL commands.
12881 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12882 takes no steps to do anything special with messages received by this route.
12883
12884 Historically Exim kept this option off by default, but the maintainers
12885 feel that in today's Internet, this causes more problems than it solves.
12886 It now defaults to true.
12887 A more detailed analysis of the issues is provided by Dan Bernstein:
12888 .display
12889 &url(http://cr.yp.to/smtp/8bitmime.html)
12890 .endd
12891 .wen
12892
12893 .option acl_not_smtp main string&!! unset
12894 .cindex "&ACL;" "for non-SMTP messages"
12895 .cindex "non-SMTP messages" "ACLs for"
12896 This option defines the ACL that is run when a non-SMTP message has been
12897 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12898 further details.
12899
12900 .option acl_not_smtp_mime main string&!! unset
12901 This option defines the ACL that is run for individual MIME parts of non-SMTP
12902 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12903 SMTP messages.
12904
12905 .option acl_not_smtp_start main string&!! unset
12906 .cindex "&ACL;" "at start of non-SMTP message"
12907 .cindex "non-SMTP messages" "ACLs for"
12908 This option defines the ACL that is run before Exim starts reading a
12909 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12910
12911 .option acl_smtp_auth main string&!! unset
12912 .cindex "&ACL;" "setting up for SMTP commands"
12913 .cindex "AUTH" "ACL for"
12914 This option defines the ACL that is run when an SMTP AUTH command is
12915 received. See chapter &<<CHAPACL>>& for further details.
12916
12917 .option acl_smtp_connect main string&!! unset
12918 .cindex "&ACL;" "on SMTP connection"
12919 This option defines the ACL that is run when an SMTP connection is received.
12920 See chapter &<<CHAPACL>>& for further details.
12921
12922 .option acl_smtp_data main string&!! unset
12923 .cindex "DATA" "ACL for"
12924 This option defines the ACL that is run after an SMTP DATA command has been
12925 processed and the message itself has been received, but before the final
12926 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12927
12928 .option acl_smtp_etrn main string&!! unset
12929 .cindex "ETRN" "ACL for"
12930 This option defines the ACL that is run when an SMTP ETRN command is
12931 received. See chapter &<<CHAPACL>>& for further details.
12932
12933 .option acl_smtp_expn main string&!! unset
12934 .cindex "EXPN" "ACL for"
12935 This option defines the ACL that is run when an SMTP EXPN command is
12936 received. See chapter &<<CHAPACL>>& for further details.
12937
12938 .option acl_smtp_helo main string&!! unset
12939 .cindex "EHLO" "ACL for"
12940 .cindex "HELO" "ACL for"
12941 This option defines the ACL that is run when an SMTP EHLO or HELO
12942 command is received. See chapter &<<CHAPACL>>& for further details.
12943
12944
12945 .option acl_smtp_mail main string&!! unset
12946 .cindex "MAIL" "ACL for"
12947 This option defines the ACL that is run when an SMTP MAIL command is
12948 received. See chapter &<<CHAPACL>>& for further details.
12949
12950 .option acl_smtp_mailauth main string&!! unset
12951 .cindex "AUTH" "on MAIL command"
12952 This option defines the ACL that is run when there is an AUTH parameter on
12953 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12954 &<<CHAPSMTPAUTH>>& for details of authentication.
12955
12956 .option acl_smtp_mime main string&!! unset
12957 .cindex "MIME content scanning" "ACL for"
12958 This option is available when Exim is built with the content-scanning
12959 extension. It defines the ACL that is run for each MIME part in a message. See
12960 section &<<SECTscanmimepart>>& for details.
12961
12962 .option acl_smtp_predata main string&!! unset
12963 This option defines the ACL that is run when an SMTP DATA command is
12964 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12965 further details.
12966
12967 .option acl_smtp_quit main string&!! unset
12968 .cindex "QUIT, ACL for"
12969 This option defines the ACL that is run when an SMTP QUIT command is
12970 received. See chapter &<<CHAPACL>>& for further details.
12971
12972 .option acl_smtp_rcpt main string&!! unset
12973 .cindex "RCPT" "ACL for"
12974 This option defines the ACL that is run when an SMTP RCPT command is
12975 received. See chapter &<<CHAPACL>>& for further details.
12976
12977 .option acl_smtp_starttls main string&!! unset
12978 .cindex "STARTTLS, ACL for"
12979 This option defines the ACL that is run when an SMTP STARTTLS command is
12980 received. See chapter &<<CHAPACL>>& for further details.
12981
12982 .option acl_smtp_vrfy main string&!! unset
12983 .cindex "VRFY" "ACL for"
12984 This option defines the ACL that is run when an SMTP VRFY command is
12985 received. See chapter &<<CHAPACL>>& for further details.
12986
12987 .option admin_groups main "string list&!!" unset
12988 .cindex "admin user"
12989 This option is expanded just once, at the start of Exim's processing. If the
12990 current group or any of the supplementary groups of an Exim caller is in this
12991 colon-separated list, the caller has admin privileges. If all your system
12992 programmers are in a specific group, for example, you can give them all Exim
12993 admin privileges by putting that group in &%admin_groups%&. However, this does
12994 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12995 To permit this, you have to add individuals to the Exim group.
12996
12997 .option allow_domain_literals main boolean false
12998 .cindex "domain literal"
12999 If this option is set, the RFC 2822 domain literal format is permitted in
13000 email addresses. The option is not set by default, because the domain literal
13001 format is not normally required these days, and few people know about it. It
13002 has, however, been exploited by mail abusers.
13003
13004 Unfortunately, it seems that some DNS black list maintainers are using this
13005 format to report black listing to postmasters. If you want to accept messages
13006 addressed to your hosts by IP address, you need to set
13007 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13008 domains (defined in the named domain list &%local_domains%& in the default
13009 configuration). This &"magic string"& matches the domain literal form of all
13010 the local host's IP addresses.
13011
13012
13013 .option allow_mx_to_ip main boolean false
13014 .cindex "MX record" "pointing to IP address"
13015 It appears that more and more DNS zone administrators are breaking the rules
13016 and putting domain names that look like IP addresses on the right hand side of
13017 MX records. Exim follows the rules and rejects this, giving an error message
13018 that explains the mis-configuration. However, some other MTAs support this
13019 practice, so to avoid &"Why can't Exim do this?"& complaints,
13020 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13021 recommended, except when you have no other choice.
13022
13023 .option allow_utf8_domains main boolean false
13024 .cindex "domain" "UTF-8 characters in"
13025 .cindex "UTF-8" "in domain name"
13026 Lots of discussion is going on about internationalized domain names. One
13027 camp is strongly in favour of just using UTF-8 characters, and it seems
13028 that at least two other MTAs permit this. This option allows Exim users to
13029 experiment if they wish.
13030
13031 If it is set true, Exim's domain parsing function allows valid
13032 UTF-8 multicharacters to appear in domain name components, in addition to
13033 letters, digits, and hyphens. However, just setting this option is not
13034 enough; if you want to look up these domain names in the DNS, you must also
13035 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13036 suitable setting is:
13037 .code
13038 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13039   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13040 .endd
13041 Alternatively, you can just disable this feature by setting
13042 .code
13043 dns_check_names_pattern =
13044 .endd
13045 That is, set the option to an empty string so that no check is done.
13046
13047
13048 .option auth_advertise_hosts main "host list&!!" *
13049 .cindex "authentication" "advertising"
13050 .cindex "AUTH" "advertising"
13051 If any server authentication mechanisms are configured, Exim advertises them in
13052 response to an EHLO command only if the calling host matches this list.
13053 Otherwise, Exim does not advertise AUTH.
13054 Exim does not accept AUTH commands from clients to which it has not
13055 advertised the availability of AUTH. The advertising of individual
13056 authentication mechanisms can be controlled by the use of the
13057 &%server_advertise_condition%& generic authenticator option on the individual
13058 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13059
13060 Certain mail clients (for example, Netscape) require the user to provide a name
13061 and password for authentication if AUTH is advertised, even though it may
13062 not be needed (the host may accept messages from hosts on its local LAN without
13063 authentication, for example). The &%auth_advertise_hosts%& option can be used
13064 to make these clients more friendly by excluding them from the set of hosts to
13065 which Exim advertises AUTH.
13066
13067 .cindex "AUTH" "advertising when encrypted"
13068 If you want to advertise the availability of AUTH only when the connection
13069 is encrypted using TLS, you can make use of the fact that the value of this
13070 option is expanded, with a setting like this:
13071 .code
13072 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
13073 .endd
13074 .vindex "&$tls_cipher$&"
13075 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
13076 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13077 expansion is *, which matches all hosts.
13078
13079
13080 .option auto_thaw main time 0s
13081 .cindex "thawing messages"
13082 .cindex "unfreezing messages"
13083 If this option is set to a time greater than zero, a queue runner will try a
13084 new delivery attempt on any frozen message, other than a bounce message, if
13085 this much time has passed since it was frozen. This may result in the message
13086 being re-frozen if nothing has changed since the last attempt. It is a way of
13087 saying &"keep on trying, even though there are big problems"&.
13088
13089 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13090 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13091 thought to be very useful any more, and its use should probably be avoided.
13092
13093
13094 .option av_scanner main string "see below"
13095 This option is available if Exim is built with the content-scanning extension.
13096 It specifies which anti-virus scanner to use. The default value is:
13097 .code
13098 sophie:/var/run/sophie
13099 .endd
13100 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13101 before use. See section &<<SECTscanvirus>>& for further details.
13102
13103
13104 .option bi_command main string unset
13105 .oindex "&%-bi%&"
13106 This option supplies the name of a command that is run when Exim is called with
13107 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13108 just the command name, it is not a complete command line. If an argument is
13109 required, it must come from the &%-oA%& command line option.
13110
13111
13112 .option bounce_message_file main string unset
13113 .cindex "bounce message" "customizing"
13114 .cindex "customizing" "bounce message"
13115 This option defines a template file containing paragraphs of text to be used
13116 for constructing bounce messages.  Details of the file's contents are given in
13117 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13118
13119
13120 .option bounce_message_text main string unset
13121 When this option is set, its contents are included in the default bounce
13122 message immediately after &"This message was created automatically by mail
13123 delivery software."& It is not used if &%bounce_message_file%& is set.
13124
13125 .option bounce_return_body main boolean true
13126 .cindex "bounce message" "including body"
13127 This option controls whether the body of an incoming message is included in a
13128 bounce message when &%bounce_return_message%& is true. The default setting
13129 causes the entire message, both header and body, to be returned (subject to the
13130 value of &%bounce_return_size_limit%&). If this option is false, only the
13131 message header is included. In the case of a non-SMTP message containing an
13132 error that is detected during reception, only those header lines preceding the
13133 point at which the error was detected are returned.
13134 .cindex "bounce message" "including original"
13135
13136 .option bounce_return_message main boolean true
13137 If this option is set false, none of the original message is included in
13138 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13139 &%bounce_return_body%&.
13140
13141
13142 .option bounce_return_size_limit main integer 100K
13143 .cindex "size" "of bounce, limit"
13144 .cindex "bounce message" "size limit"
13145 .cindex "limit" "bounce message size"
13146 This option sets a limit in bytes on the size of messages that are returned to
13147 senders as part of bounce messages when &%bounce_return_message%& is true. The
13148 limit should be less than the value of the global &%message_size_limit%& and of
13149 any &%message_size_limit%& settings on transports, to allow for the bounce text
13150 that Exim generates. If this option is set to zero there is no limit.
13151
13152 When the body of any message that is to be included in a bounce message is
13153 greater than the limit, it is truncated, and a comment pointing this out is
13154 added at the top. The actual cutoff may be greater than the value given, owing
13155 to the use of buffering for transferring the message in chunks (typically 8K in
13156 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13157 messages.
13158
13159 .option bounce_sender_authentication main string unset
13160 .cindex "bounce message" "sender authentication"
13161 .cindex "authentication" "bounce message"
13162 .cindex "AUTH" "on bounce message"
13163 This option provides an authenticated sender address that is sent with any
13164 bounce messages generated by Exim that are sent over an authenticated SMTP
13165 connection. A typical setting might be:
13166 .code
13167 bounce_sender_authentication = mailer-daemon@my.domain.example
13168 .endd
13169 which would cause bounce messages to be sent using the SMTP command:
13170 .code
13171 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13172 .endd
13173 The value of &%bounce_sender_authentication%& must always be a complete email
13174 address.
13175
13176 .option callout_domain_negative_expire main time 3h
13177 .cindex "caching" "callout timeouts"
13178 .cindex "callout" "caching timeouts"
13179 This option specifies the expiry time for negative callout cache data for a
13180 domain. See section &<<SECTcallver>>& for details of callout verification, and
13181 section &<<SECTcallvercache>>& for details of the caching.
13182
13183
13184 .option callout_domain_positive_expire main time 7d
13185 This option specifies the expiry time for positive callout cache data for a
13186 domain. See section &<<SECTcallver>>& for details of callout verification, and
13187 section &<<SECTcallvercache>>& for details of the caching.
13188
13189
13190 .option callout_negative_expire main time 2h
13191 This option specifies the expiry time for negative callout cache data for an
13192 address. See section &<<SECTcallver>>& for details of callout verification, and
13193 section &<<SECTcallvercache>>& for details of the caching.
13194
13195
13196 .option callout_positive_expire main time 24h
13197 This option specifies the expiry time for positive callout cache data for an
13198 address. See section &<<SECTcallver>>& for details of callout verification, and
13199 section &<<SECTcallvercache>>& for details of the caching.
13200
13201
13202 .option callout_random_local_part main string&!! "see below"
13203 This option defines the &"random"& local part that can be used as part of
13204 callout verification. The default value is
13205 .code
13206 $primary_hostname-$tod_epoch-testing
13207 .endd
13208 See section &<<CALLaddparcall>>& for details of how this value is used.
13209
13210
13211 .option check_log_inodes main integer 0
13212 See &%check_spool_space%& below.
13213
13214
13215 .option check_log_space main integer 0
13216 See &%check_spool_space%& below.
13217
13218 .oindex "&%check_rfc2047_length%&"
13219 .cindex "RFC 2047" "disabling length check"
13220 .option check_rfc2047_length main boolean true
13221 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13222 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13223 word; strings to be encoded that exceed this length are supposed to use
13224 multiple encoded words. By default, Exim does not recognize encoded words that
13225 exceed the maximum length. However, it seems that some software, in violation
13226 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13227 set false, Exim recognizes encoded words of any length.
13228
13229
13230 .option check_spool_inodes main integer 0
13231 See &%check_spool_space%& below.
13232
13233
13234 .option check_spool_space main integer 0
13235 .cindex "checking disk space"
13236 .cindex "disk space, checking"
13237 .cindex "spool directory" "checking space"
13238 The four &%check_...%& options allow for checking of disk resources before a
13239 message is accepted.
13240
13241 .vindex "&$log_inodes$&"
13242 .vindex "&$log_space$&"
13243 .vindex "&$spool_inodes$&"
13244 .vindex "&$spool_space$&"
13245 When any of these options are set, they apply to all incoming messages. If you
13246 want to apply different checks to different kinds of message, you can do so by
13247 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13248 &$spool_space$& in an ACL with appropriate additional conditions.
13249
13250
13251 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13252 either value is greater than zero, for example:
13253 .code
13254 check_spool_space = 10M
13255 check_spool_inodes = 100
13256 .endd
13257 The spool partition is the one that contains the directory defined by
13258 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13259 transit.
13260
13261 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13262 files are written if either is greater than zero. These should be set only if
13263 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13264
13265 If there is less space or fewer inodes than requested, Exim refuses to accept
13266 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13267 error response to the MAIL command. If ESMTP is in use and there was a
13268 SIZE parameter on the MAIL command, its value is added to the
13269 &%check_spool_space%& value, and the check is performed even if
13270 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13271
13272 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13273 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13274
13275 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13276 failure a message is written to stderr and Exim exits with a non-zero code, as
13277 it obviously cannot send an error message of any kind.
13278
13279 .option daemon_smtp_ports main string &`smtp`&
13280 .cindex "port" "for daemon"
13281 .cindex "TCP/IP" "setting listening ports"
13282 This option specifies one or more default SMTP ports on which the Exim daemon
13283 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13284 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13285
13286 .option daemon_startup_retries main integer 9
13287 .cindex "daemon startup, retrying"
13288 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13289 the daemon at startup when it cannot immediately bind a listening socket
13290 (typically because the socket is already in use): &%daemon_startup_retries%&
13291 defines the number of retries after the first failure, and
13292 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13293
13294 .option daemon_startup_sleep main time 30s
13295 See &%daemon_startup_retries%&.
13296
13297 .option delay_warning main "time list" 24h
13298 .cindex "warning of delay"
13299 .cindex "delay warning, specifying"
13300 When a message is delayed, Exim sends a warning message to the sender at
13301 intervals specified by this option. The data is a colon-separated list of times
13302 after which to send warning messages. If the value of the option is an empty
13303 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13304 message has been on the queue for longer than the last time, the last interval
13305 between the times is used to compute subsequent warning times. For example,
13306 with
13307 .code
13308 delay_warning = 4h:8h:24h
13309 .endd
13310 the first message is sent after 4 hours, the second after 8 hours, and
13311 the third one after 24 hours. After that, messages are sent every 16 hours,
13312 because that is the interval between the last two times on the list. If you set
13313 just one time, it specifies the repeat interval. For example, with:
13314 .code
13315 delay_warning = 6h
13316 .endd
13317 messages are repeated every six hours. To stop warnings after a given time, set
13318 a very large time at the end of the list. For example:
13319 .code
13320 delay_warning = 2h:12h:99d
13321 .endd
13322
13323 .option delay_warning_condition main string&!! "see below"
13324 .vindex "&$domain$&"
13325 The string is expanded at the time a warning message might be sent. If all the
13326 deferred addresses have the same domain, it is set in &$domain$& during the
13327 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13328 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13329 &"false"& (the comparison being done caselessly) then the warning message is
13330 not sent. The default is:
13331 .code
13332 delay_warning_condition = ${if or {\
13333   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13334   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13335   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13336   } {no}{yes}}
13337 .endd
13338 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13339 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13340 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13341 &"auto-replied"& in an &'Auto-Submitted:'& header.
13342
13343 .option deliver_drop_privilege main boolean false
13344 .cindex "unprivileged delivery"
13345 .cindex "delivery" "unprivileged"
13346 If this option is set true, Exim drops its root privilege at the start of a
13347 delivery process, and runs as the Exim user throughout. This severely restricts
13348 the kinds of local delivery that are possible, but is viable in certain types
13349 of configuration. There is a discussion about the use of root privilege in
13350 chapter &<<CHAPsecurity>>&.
13351
13352 .option deliver_queue_load_max main fixed-point unset
13353 .cindex "load average"
13354 .cindex "queue runner" "abandoning"
13355 When this option is set, a queue run is abandoned if the system load average
13356 becomes greater than the value of the option. The option has no effect on
13357 ancient operating systems on which Exim cannot determine the load average.
13358 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13359
13360
13361 .option delivery_date_remove main boolean true
13362 .cindex "&'Delivery-date:'& header line"
13363 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13364 message when it is delivered, in exactly the same way as &'Return-path:'& is
13365 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13366 should not be present in incoming messages, and this option causes them to be
13367 removed at the time the message is received, to avoid any problems that might
13368 occur when a delivered message is subsequently sent on to some other recipient.
13369
13370 .option disable_fsync main boolean false
13371 .cindex "&[fsync()]&, disabling"
13372 This option is available only if Exim was built with the compile-time option
13373 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13374 a runtime configuration generates an &"unknown option"& error. You should not
13375 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13376 really, really, really understand what you are doing. &'No pre-compiled
13377 distributions of Exim should ever make this option available.'&
13378
13379 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13380 updated files' data to be written to disc before continuing. Unexpected events
13381 such as crashes and power outages may cause data to be lost or scrambled.
13382 Here be Dragons. &*Beware.*&
13383
13384
13385 .option disable_ipv6 main boolean false
13386 .cindex "IPv6" "disabling"
13387 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13388 activities take place. AAAA records are never looked up, and any IPv6 addresses
13389 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13390 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13391 to handle IPv6 literal addresses.
13392
13393
13394 .option dns_again_means_nonexist main "domain list&!!" unset
13395 .cindex "DNS" "&""try again""& response; overriding"
13396 DNS lookups give a &"try again"& response for the DNS errors
13397 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13398 keep trying to deliver a message, or to give repeated temporary errors to
13399 incoming mail. Sometimes the effect is caused by a badly set up name server and
13400 may persist for a long time. If a domain which exhibits this problem matches
13401 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13402 This option should be used with care. You can make it apply to reverse lookups
13403 by a setting such as this:
13404 .code
13405 dns_again_means_nonexist = *.in-addr.arpa
13406 .endd
13407 This option applies to all DNS lookups that Exim does. It also applies when the
13408 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13409 since these are most likely to be caused by DNS lookup problems. The
13410 &(dnslookup)& router has some options of its own for controlling what happens
13411 when lookups for MX or SRV records give temporary errors. These more specific
13412 options are applied after this global option.
13413
13414 .option dns_check_names_pattern main string "see below"
13415 .cindex "DNS" "pre-check of name syntax"
13416 When this option is set to a non-empty string, it causes Exim to check domain
13417 names for characters that are not allowed in host names before handing them to
13418 the DNS resolver, because some resolvers give temporary errors for names that
13419 contain unusual characters. If a domain name contains any unwanted characters,
13420 a &"not found"& result is forced, and the resolver is not called. The check is
13421 done by matching the domain name against a regular expression, which is the
13422 value of this option. The default pattern is
13423 .code
13424 dns_check_names_pattern = \
13425   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13426 .endd
13427 which permits only letters, digits, slashes, and hyphens in components, but
13428 they must start and end with a letter or digit. Slashes are not, in fact,
13429 permitted in host names, but they are found in certain NS records (which can be
13430 accessed in Exim by using a &%dnsdb%& lookup). If you set
13431 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13432 empty string.
13433
13434 .option dns_csa_search_limit main integer 5
13435 This option controls the depth of parental searching for CSA SRV records in the
13436 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13437
13438 .option dns_csa_use_reverse main boolean true
13439 This option controls whether or not an IP address, given as a CSA domain, is
13440 reversed and looked up in the reverse DNS, as described in more detail in
13441 section &<<SECTverifyCSA>>&.
13442
13443 .option dns_ipv4_lookup main "domain list&!!" unset
13444 .cindex "IPv6" "DNS lookup for AAAA records"
13445 .cindex "DNS" "IPv6 lookup for AAAA records"
13446 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13447 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13448 (A records) when trying to find IP addresses for hosts, unless the host's
13449 domain matches this list.
13450
13451 This is a fudge to help with name servers that give big delays or otherwise do
13452 not work for the AAAA record type. In due course, when the world's name
13453 servers have all been upgraded, there should be no need for this option.
13454
13455
13456 .option dns_retrans main time 0s
13457 .cindex "DNS" "resolver options"
13458 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13459 retransmission and retry parameters for DNS lookups. Values of zero (the
13460 defaults) leave the system default settings unchanged. The first value is the
13461 time between retries, and the second is the number of retries. It isn't
13462 totally clear exactly how these settings affect the total time a DNS lookup may
13463 take. I haven't found any documentation about timeouts on DNS lookups; these
13464 parameter values are available in the external resolver interface structure,
13465 but nowhere does it seem to describe how they are used or what you might want
13466 to set in them.
13467
13468
13469 .option dns_retry main integer 0
13470 See &%dns_retrans%& above.
13471
13472
13473 .new
13474 .option dns_use_edns0 main integer -1
13475 .cindex "DNS" "resolver options"
13476 .cindex "DNS" "EDNS0"
13477 If this option is set to a non-negative number then Exim will initialise the
13478 DNS resolver library to either use or not use EDNS0 extensions, overriding
13479 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13480 on.
13481
13482 If the resolver library does not support EDNS0 then this option has no effect.
13483 .wen
13484
13485
13486 .option drop_cr main boolean false
13487 This is an obsolete option that is now a no-op. It used to affect the way Exim
13488 handled CR and LF characters in incoming messages. What happens now is
13489 described in section &<<SECTlineendings>>&.
13490
13491 .option dsn_from main "string&!!" "see below"
13492 .cindex "&'From:'& header line" "in bounces"
13493 .cindex "bounce messages" "&'From:'& line, specifying"
13494 This option can be used to vary the contents of &'From:'& header lines in
13495 bounces and other automatically generated messages (&"Delivery Status
13496 Notifications"& &-- hence the name of the option). The default setting is:
13497 .code
13498 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13499 .endd
13500 The value is expanded every time it is needed. If the expansion fails, a
13501 panic is logged, and the default value is used.
13502
13503 .option envelope_to_remove main boolean true
13504 .cindex "&'Envelope-to:'& header line"
13505 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13506 message when it is delivered, in exactly the same way as &'Return-path:'& is
13507 handled. &'Envelope-to:'& records the original recipient address from the
13508 messages's envelope that caused the delivery to happen. Such headers should not
13509 be present in incoming messages, and this option causes them to be removed at
13510 the time the message is received, to avoid any problems that might occur when a
13511 delivered message is subsequently sent on to some other recipient.
13512
13513
13514 .option errors_copy main "string list&!!" unset
13515 .cindex "bounce message" "copy to other address"
13516 .cindex "copy of bounce message"
13517 Setting this option causes Exim to send bcc copies of bounce messages that it
13518 generates to other addresses. &*Note*&: This does not apply to bounce messages
13519 coming from elsewhere. The value of the option is a colon-separated list of
13520 items. Each item consists of a pattern, terminated by white space, followed by
13521 a comma-separated list of email addresses. If a pattern contains spaces, it
13522 must be enclosed in double quotes.
13523
13524 Each pattern is processed in the same way as a single item in an address list
13525 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13526 the bounce message, the message is copied to the addresses on the list. The
13527 items are scanned in order, and once a matching one is found, no further items
13528 are examined. For example:
13529 .code
13530 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13531               rqps@mydomain   hostmaster@mydomain.example,\
13532                               postmaster@mydomain.example
13533 .endd
13534 .vindex "&$domain$&"
13535 .vindex "&$local_part$&"
13536 The address list is expanded before use. The expansion variables &$local_part$&
13537 and &$domain$& are set from the original recipient of the error message, and if
13538 there was any wildcard matching in the pattern, the expansion
13539 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13540 variables &$0$&, &$1$&, etc. are set in the normal way.
13541
13542
13543 .option errors_reply_to main string unset
13544 .cindex "bounce message" "&'Reply-to:'& in"
13545 By default, Exim's bounce and delivery warning messages contain the header line
13546 .display
13547 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13548 .endd
13549 .oindex &%quota_warn_message%&
13550 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13551 A warning message that is generated by the &%quota_warn_message%& option in an
13552 &(appendfile)& transport may contain its own &'From:'& header line that
13553 overrides the default.
13554
13555 Experience shows that people reply to bounce messages. If the
13556 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13557 and warning messages. For example:
13558 .code
13559 errors_reply_to = postmaster@my.domain.example
13560 .endd
13561 The value of the option is not expanded. It must specify a valid RFC 2822
13562 address. However, if a warning message that is generated by the
13563 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13564 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13565 not used.
13566
13567
13568 .option exim_group main string "compile-time configured"
13569 .cindex "gid (group id)" "Exim's own"
13570 .cindex "Exim group"
13571 This option changes the gid under which Exim runs when it gives up root
13572 privilege. The default value is compiled into the binary. The value of this
13573 option is used only when &%exim_user%& is also set. Unless it consists entirely
13574 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13575 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13576 security issues.
13577
13578
13579 .option exim_path main string "see below"
13580 .cindex "Exim binary, path name"
13581 This option specifies the path name of the Exim binary, which is used when Exim
13582 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13583 the directory configured at compile time by the BIN_DIRECTORY setting. It
13584 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13585 other place.
13586 &*Warning*&: Do not use a macro to define the value of this option, because
13587 you will break those Exim utilities that scan the configuration file to find
13588 where the binary is. (They then use the &%-bP%& option to extract option
13589 settings such as the value of &%spool_directory%&.)
13590
13591
13592 .option exim_user main string "compile-time configured"
13593 .cindex "uid (user id)" "Exim's own"
13594 .cindex "Exim user"
13595 This option changes the uid under which Exim runs when it gives up root
13596 privilege. The default value is compiled into the binary. Ownership of the run
13597 time configuration file and the use of the &%-C%& and &%-D%& command line
13598 options is checked against the values in the binary, not what is set here.
13599
13600 Unless it consists entirely of digits, the string is looked up using
13601 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13602 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13603 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13604
13605
13606 .option extra_local_interfaces main "string list" unset
13607 This option defines network interfaces that are to be considered local when
13608 routing, but which are not used for listening by the daemon. See section
13609 &<<SECTreclocipadd>>& for details.
13610
13611
13612 . Allow this long option name to split; give it unsplit as a fifth argument
13613 . for the automatic .oindex that is generated by .option.
13614
13615 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13616          extract_addresses_remove_arguments
13617 .oindex "&%-t%&"
13618 .cindex "command line" "addresses with &%-t%&"
13619 .cindex "Sendmail compatibility" "&%-t%& option"
13620 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13621 are present on the command line when the &%-t%& option is used to build an
13622 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13623 line addresses are removed from the recipients list. This is also how Smail
13624 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13625 command line addresses are added to those obtained from the header lines. When
13626 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13627 argument headers. If it is set false, Exim adds rather than removes argument
13628 addresses.
13629
13630
13631 .option finduser_retries main integer 0
13632 .cindex "NIS, retrying user lookups"
13633 On systems running NIS or other schemes in which user and group information is
13634 distributed from a remote system, there can be times when &[getpwnam()]& and
13635 related functions fail, even when given valid data, because things time out.
13636 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13637 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13638 many extra times to find a user or a group, waiting for one second between
13639 retries.
13640
13641 .cindex "&_/etc/passwd_&" "multiple reading of"
13642 You should not set this option greater than zero if your user information is in
13643 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13644 search the file multiple times for non-existent users, and also cause delay.
13645
13646
13647
13648 .option freeze_tell main "string list, comma separated" unset
13649 .cindex "freezing messages" "sending a message when freezing"
13650 On encountering certain errors, or when configured to do so in a system filter,
13651 ACL, or special router, Exim freezes a message. This means that no further
13652 delivery attempts take place until an administrator thaws the message, or the
13653 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13654 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13655 warning message whenever it freezes something, unless the message it is
13656 freezing is a locally-generated bounce message. (Without this exception there
13657 is the possibility of looping.) The warning message is sent to the addresses
13658 supplied as the comma-separated value of this option. If several of the
13659 message's addresses cause freezing, only a single message is sent. If the
13660 freezing was automatic, the reason(s) for freezing can be found in the message
13661 log. If you configure freezing in a filter or ACL, you must arrange for any
13662 logging that you require.
13663
13664
13665 .option gecos_name main string&!! unset
13666 .cindex "HP-UX"
13667 .cindex "&""gecos""& field, parsing"
13668 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13669 password file to hold other information in addition to users' real names. Exim
13670 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13671 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13672 of the field are used unchanged, except that, if an ampersand is encountered,
13673 it is replaced by the user's login name with the first character forced to
13674 upper case, since this is a convention that is observed on many systems.
13675
13676 When these options are set, &%gecos_pattern%& is treated as a regular
13677 expression that is to be applied to the field (again with && replaced by the
13678 login name), and if it matches, &%gecos_name%& is expanded and used as the
13679 user's name.
13680
13681 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13682 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13683 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13684 name terminates at the first comma, the following can be used:
13685 .code
13686 gecos_pattern = ([^,]*)
13687 gecos_name = $1
13688 .endd
13689
13690 .option gecos_pattern main string unset
13691 See &%gecos_name%& above.
13692
13693
13694 .option gnutls_require_kx main string unset
13695 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13696 server. For details, see section &<<SECTreqciphgnu>>&.
13697
13698 .option gnutls_require_mac main string unset
13699 This option controls the MAC algorithms when GnuTLS is used in an Exim
13700 server. For details, see section &<<SECTreqciphgnu>>&.
13701
13702 .option gnutls_require_protocols main string unset
13703 This option controls the protocols when GnuTLS is used in an Exim
13704 server. For details, see section &<<SECTreqciphgnu>>&.
13705
13706 .option gnutls_compat_mode main boolean unset
13707 This option controls whether GnuTLS is used in compatibility mode in an Exim
13708 server. This reduces security slightly, but improves interworking with older
13709 implementations of TLS.
13710
13711 .option headers_charset main string "see below"
13712 This option sets a default character set for translating from encoded MIME
13713 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13714 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13715 ultimate default is ISO-8859-1. For more details see the description of header
13716 insertions in section &<<SECTexpansionitems>>&.
13717
13718
13719
13720 .option header_maxsize main integer "see below"
13721 .cindex "header section" "maximum size of"
13722 .cindex "limit" "size of message header section"
13723 This option controls the overall maximum size of a message's header
13724 section. The default is the value of HEADER_MAXSIZE in
13725 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13726 sections are rejected.
13727
13728
13729 .option header_line_maxsize main integer 0
13730 .cindex "header lines" "maximum size of"
13731 .cindex "limit" "size of one header line"
13732 This option limits the length of any individual header line in a message, after
13733 all the continuations have been joined together. Messages with individual
13734 header lines that are longer than the limit are rejected. The default value of
13735 zero means &"no limit"&.
13736
13737
13738
13739
13740 .option helo_accept_junk_hosts main "host list&!!" unset
13741 .cindex "HELO" "accepting junk data"
13742 .cindex "EHLO" "accepting junk data"
13743 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13744 mail, and gives an error response for invalid data. Unfortunately, there are
13745 some SMTP clients that send syntactic junk. They can be accommodated by setting
13746 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13747 if you want to do semantic checking.
13748 See also &%helo_allow_chars%& for a way of extending the permitted character
13749 set.
13750
13751
13752 .option helo_allow_chars main string unset
13753 .cindex "HELO" "underscores in"
13754 .cindex "EHLO" "underscores in"
13755 .cindex "underscore in EHLO/HELO"
13756 This option can be set to a string of rogue characters that are permitted in
13757 all EHLO and HELO names in addition to the standard letters, digits,
13758 hyphens, and dots. If you really must allow underscores, you can set
13759 .code
13760 helo_allow_chars = _
13761 .endd
13762 Note that the value is one string, not a list.
13763
13764
13765 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13766 .cindex "HELO" "forcing reverse lookup"
13767 .cindex "EHLO" "forcing reverse lookup"
13768 If the domain given by a client in a HELO or EHLO command matches this
13769 list, a reverse lookup is done in order to establish the host's true name. The
13770 default forces a lookup if the client host gives the server's name or any of
13771 its IP addresses (in brackets), something that broken clients have been seen to
13772 do.
13773
13774
13775 .option helo_try_verify_hosts main "host list&!!" unset
13776 .cindex "HELO verifying" "optional"
13777 .cindex "EHLO" "verifying, optional"
13778 By default, Exim just checks the syntax of HELO and EHLO commands (see
13779 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13780 to do more extensive checking of the data supplied by these commands. The ACL
13781 condition &`verify = helo`& is provided to make this possible.
13782 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13783 to force the check to occur. From release 4.53 onwards, this is no longer
13784 necessary. If the check has not been done before &`verify = helo`& is
13785 encountered, it is done at that time. Consequently, this option is obsolete.
13786 Its specification is retained here for backwards compatibility.
13787
13788 When an EHLO or HELO command is received, if the calling host matches
13789 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13790 EHLO command either:
13791
13792 .ilist
13793 is an IP literal matching the calling address of the host, or
13794 .next
13795 .cindex "DNS" "reverse lookup"
13796 .cindex "reverse DNS lookup"
13797 matches the host name that Exim obtains by doing a reverse lookup of the
13798 calling host address, or
13799 .next
13800 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13801 available) yields the calling host address.
13802 .endlist
13803
13804 However, the EHLO or HELO command is not rejected if any of the checks
13805 fail. Processing continues, but the result of the check is remembered, and can
13806 be detected later in an ACL by the &`verify = helo`& condition.
13807
13808 .option helo_verify_hosts main "host list&!!" unset
13809 .cindex "HELO verifying" "mandatory"
13810 .cindex "EHLO" "verifying, mandatory"
13811 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13812 backwards compatibility. For hosts that match this option, Exim checks the host
13813 name given in the HELO or EHLO in the same way as for
13814 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13815 rejected with a 550 error, and entries are written to the main and reject logs.
13816 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13817 error.
13818
13819 .option hold_domains main "domain list&!!" unset
13820 .cindex "domain" "delaying delivery"
13821 .cindex "delivery" "delaying certain domains"
13822 This option allows mail for particular domains to be held on the queue
13823 manually. The option is overridden if a message delivery is forced with the
13824 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13825 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13826 item in &%hold_domains%&, no routing or delivery for that address is done, and
13827 it is deferred every time the message is looked at.
13828
13829 This option is intended as a temporary operational measure for delaying the
13830 delivery of mail while some problem is being sorted out, or some new
13831 configuration tested. If you just want to delay the processing of some
13832 domains until a queue run occurs, you should use &%queue_domains%& or
13833 &%queue_smtp_domains%&, not &%hold_domains%&.
13834
13835 A setting of &%hold_domains%& does not override Exim's code for removing
13836 messages from the queue if they have been there longer than the longest retry
13837 time in any retry rule. If you want to hold messages for longer than the normal
13838 retry times, insert a dummy retry rule with a long retry time.
13839
13840
13841 .option host_lookup main "host list&!!" unset
13842 .cindex "host name" "lookup, forcing"
13843 Exim does not look up the name of a calling host from its IP address unless it
13844 is required to compare against some host list, or the host matches
13845 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13846 option (which normally contains IP addresses rather than host names). The
13847 default configuration file contains
13848 .code
13849 host_lookup = *
13850 .endd
13851 which causes a lookup to happen for all hosts. If the expense of these lookups
13852 is felt to be too great, the setting can be changed or removed.
13853
13854 After a successful reverse lookup, Exim does a forward lookup on the name it
13855 has obtained, to verify that it yields the IP address that it started with. If
13856 this check fails, Exim behaves as if the name lookup failed.
13857
13858 .vindex "&$host_lookup_failed$&"
13859 .vindex "&$sender_host_name$&"
13860 After any kind of failure, the host name (in &$sender_host_name$&) remains
13861 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13862 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13863 &`verify = reverse_host_lookup`& in ACLs.
13864
13865
13866 .option host_lookup_order main "string list" &`bydns:byaddr`&
13867 This option specifies the order of different lookup methods when Exim is trying
13868 to find a host name from an IP address. The default is to do a DNS lookup
13869 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13870 if that fails. You can change the order of these lookups, or omit one entirely,
13871 if you want.
13872
13873 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13874 multiple PTR records in the DNS and the IP address is not listed in
13875 &_/etc/hosts_&. Different operating systems give different results in this
13876 case. That is why the default tries a DNS lookup first.
13877
13878
13879
13880 .option host_reject_connection main "host list&!!" unset
13881 .cindex "host" "rejecting connections from"
13882 If this option is set, incoming SMTP calls from the hosts listed are rejected
13883 as soon as the connection is made.
13884 This option is obsolete, and retained only for backward compatibility, because
13885 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13886 connections immediately.
13887
13888 The ability to give an immediate rejection (either by this option or using an
13889 ACL) is provided for use in unusual cases. Many hosts will just try again,
13890 sometimes without much delay. Normally, it is better to use an ACL to reject
13891 incoming messages at a later stage, such as after RCPT commands. See
13892 chapter &<<CHAPACL>>&.
13893
13894
13895 .option hosts_connection_nolog main "host list&!!" unset
13896 .cindex "host" "not logging connections from"
13897 This option defines a list of hosts for which connection logging does not
13898 happen, even though the &%smtp_connection%& log selector is set. For example,
13899 you might want not to log SMTP connections from local processes, or from
13900 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13901 the daemon; you should therefore strive to restrict its value to a short inline
13902 list of IP addresses and networks. To disable logging SMTP connections from
13903 local processes, you must create a host list with an empty item. For example:
13904 .code
13905 hosts_connection_nolog = :
13906 .endd
13907 If the &%smtp_connection%& log selector is not set, this option has no effect.
13908
13909
13910
13911 .option hosts_treat_as_local main "domain list&!!" unset
13912 .cindex "local host" "domains treated as"
13913 .cindex "host" "treated as local"
13914 If this option is set, any host names that match the domain list are treated as
13915 if they were the local host when Exim is scanning host lists obtained from MX
13916 records
13917 or other sources. Note that the value of this option is a domain list, not a
13918 host list, because it is always used to check host names, not IP addresses.
13919
13920 This option also applies when Exim is matching the special items
13921 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13922 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13923 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13924 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13925 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13926 interfaces and recognizing the local host.
13927
13928
13929 .option ibase_servers main "string list" unset
13930 .cindex "InterBase" "server list"
13931 This option provides a list of InterBase servers and associated connection data,
13932 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13933 The option is available only if Exim has been built with InterBase support.
13934
13935
13936
13937 .option ignore_bounce_errors_after main time 10w
13938 .cindex "bounce message" "discarding"
13939 .cindex "discarding bounce message"
13940 This option affects the processing of bounce messages that cannot be delivered,
13941 that is, those that suffer a permanent delivery failure. (Bounce messages that
13942 suffer temporary delivery failures are of course retried in the usual way.)
13943
13944 After a permanent delivery failure, bounce messages are frozen,
13945 because there is no sender to whom they can be returned. When a frozen bounce
13946 message has been on the queue for more than the given time, it is unfrozen at
13947 the next queue run, and a further delivery is attempted. If delivery fails
13948 again, the bounce message is discarded. This makes it possible to keep failed
13949 bounce messages around for a shorter time than the normal maximum retry time
13950 for frozen messages. For example,
13951 .code
13952 ignore_bounce_errors_after = 12h
13953 .endd
13954 retries failed bounce message deliveries after 12 hours, discarding any further
13955 failures. If the value of this option is set to a zero time period, bounce
13956 failures are discarded immediately. Setting a very long time (as in the default
13957 value) has the effect of disabling this option. For ways of automatically
13958 dealing with other kinds of frozen message, see &%auto_thaw%& and
13959 &%timeout_frozen_after%&.
13960
13961
13962 .option ignore_fromline_hosts main "host list&!!" unset
13963 .cindex "&""From""& line"
13964 .cindex "UUCP" "&""From""& line"
13965 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13966 the headers of a message. By default this is treated as the start of the
13967 message's body, which means that any following headers are not recognized as
13968 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13969 match those hosts that insist on sending it. If the sender is actually a local
13970 process rather than a remote host, and is using &%-bs%& to inject the messages,
13971 &%ignore_fromline_local%& must be set to achieve this effect.
13972
13973
13974 .option ignore_fromline_local main boolean false
13975 See &%ignore_fromline_hosts%& above.
13976
13977
13978 .option keep_malformed main time 4d
13979 This option specifies the length of time to keep messages whose spool files
13980 have been corrupted in some way. This should, of course, never happen. At the
13981 next attempt to deliver such a message, it gets removed. The incident is
13982 logged.
13983
13984
13985 .option ldap_ca_cert_dir main string unset
13986 .cindex "LDAP", "TLS CA certificate directory"
13987 This option indicates which directory contains CA certificates for verifying
13988 a TLS certificate presented by an LDAP server.
13989 While Exim does not provide a default value, your SSL library may.
13990 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13991 and constrained to be a directory.
13992
13993
13994 .option ldap_ca_cert_file main string unset
13995 .cindex "LDAP", "TLS CA certificate file"
13996 This option indicates which file contains CA certificates for verifying
13997 a TLS certificate presented by an LDAP server.
13998 While Exim does not provide a default value, your SSL library may.
13999 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14000 and constrained to be a file.
14001
14002
14003 .option ldap_cert_file main string unset
14004 .cindex "LDAP" "TLS client certificate file"
14005 This option indicates which file contains an TLS client certificate which
14006 Exim should present to the LDAP server during TLS negotiation.
14007 Should be used together with &%ldap_cert_key%&.
14008
14009
14010 .option ldap_cert_key main string unset
14011 .cindex "LDAP" "TLS client key file"
14012 This option indicates which file contains the secret/private key to use
14013 to prove identity to the LDAP server during TLS negotiation.
14014 Should be used together with &%ldap_cert_file%&, which contains the
14015 identity to be proven.
14016
14017
14018 .option ldap_cipher_suite main string unset
14019 .cindex "LDAP" "TLS cipher suite"
14020 This controls the TLS cipher-suite negotiation during TLS negotiation with
14021 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14022 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14023
14024
14025 .option ldap_default_servers main "string list" unset
14026 .cindex "LDAP" "default servers"
14027 This option provides a list of LDAP servers which are tried in turn when an
14028 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14029 details of LDAP queries. This option is available only when Exim has been built
14030 with LDAP support.
14031
14032
14033 .option ldap_require_cert main string unset.
14034 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14035 This should be one of the values "hard", "demand", "allow", "try" or "never".
14036 A value other than one of these is interpreted as "never".
14037 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14038 Although Exim does not set a default, the LDAP library probably defaults
14039 to hard/demand.
14040
14041
14042 .option ldap_start_tls main boolean false
14043 .cindex "LDAP" "whether or not to negotiate TLS"
14044 If set, Exim will attempt to negotiate TLS with the LDAP server when
14045 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14046 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14047 of SSL-on-connect.
14048 In the event of failure to negotiate TLS, the action taken is controlled
14049 by &%ldap_require_cert%&.
14050
14051
14052 .option ldap_version main integer unset
14053 .cindex "LDAP" "protocol version, forcing"
14054 This option can be used to force Exim to set a specific protocol version for
14055 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14056 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14057 the LDAP headers; otherwise it is 2. This option is available only when Exim
14058 has been built with LDAP support.
14059
14060
14061
14062 .option local_from_check main boolean true
14063 .cindex "&'Sender:'& header line" "disabling addition of"
14064 .cindex "&'From:'& header line" "disabling checking of"
14065 When a message is submitted locally (that is, not over a TCP/IP connection) by
14066 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14067 checks that the &'From:'& header line matches the login of the calling user and
14068 the domain specified by &%qualify_domain%&.
14069
14070 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14071 locally submitted message is automatically qualified by Exim, unless the
14072 &%-bnq%& command line option is used.
14073
14074 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14075 on the local part. If the &'From:'& header line does not match, Exim adds a
14076 &'Sender:'& header with an address constructed from the calling user's login
14077 and the default qualify domain.
14078
14079 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14080 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14081 &'Sender:'& header lines supplied by untrusted users, you must also set
14082 &%local_sender_retain%& to be true.
14083
14084 .cindex "envelope sender"
14085 These options affect only the header lines in the message. The envelope sender
14086 is still forced to be the login id at the qualify domain unless
14087 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14088
14089 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14090 request similar header line checking. See section &<<SECTthesenhea>>&, which
14091 has more details about &'Sender:'& processing.
14092
14093
14094
14095
14096 .option local_from_prefix main string unset
14097 When Exim checks the &'From:'& header line of locally submitted messages for
14098 matching the login id (see &%local_from_check%& above), it can be configured to
14099 ignore certain prefixes and suffixes in the local part of the address. This is
14100 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14101 appropriate lists, in the same form as the &%local_part_prefix%& and
14102 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14103 example, if
14104 .code
14105 local_from_prefix = *-
14106 .endd
14107 is set, a &'From:'& line containing
14108 .code
14109 From: anything-user@your.domain.example
14110 .endd
14111 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14112 matches the actual sender address that is constructed from the login name and
14113 qualify domain.
14114
14115
14116 .option local_from_suffix main string unset
14117 See &%local_from_prefix%& above.
14118
14119
14120 .option local_interfaces main "string list" "see below"
14121 This option controls which network interfaces are used by the daemon for
14122 listening; they are also used to identify the local host when routing. Chapter
14123 &<<CHAPinterfaces>>& contains a full description of this option and the related
14124 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14125 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14126 &%local_interfaces%& is
14127 .code
14128 local_interfaces = 0.0.0.0
14129 .endd
14130 when Exim is built without IPv6 support; otherwise it is
14131 .code
14132 local_interfaces = <; ::0 ; 0.0.0.0
14133 .endd
14134
14135 .option local_scan_timeout main time 5m
14136 .cindex "timeout" "for &[local_scan()]& function"
14137 .cindex "&[local_scan()]& function" "timeout"
14138 This timeout applies to the &[local_scan()]& function (see chapter
14139 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14140 the incoming message is rejected with a temporary error if it is an SMTP
14141 message. For a non-SMTP message, the message is dropped and Exim ends with a
14142 non-zero code. The incident is logged on the main and reject logs.
14143
14144
14145
14146 .option local_sender_retain main boolean false
14147 .cindex "&'Sender:'& header line" "retaining from local submission"
14148 When a message is submitted locally (that is, not over a TCP/IP connection) by
14149 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14150 do not want this to happen, you must set &%local_sender_retain%&, and you must
14151 also set &%local_from_check%& to be false (Exim will complain if you do not).
14152 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14153 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14154
14155
14156
14157
14158 .option localhost_number main string&!! unset
14159 .cindex "host" "locally unique number for"
14160 .cindex "message ids" "with multiple hosts"
14161 .vindex "&$localhost_number$&"
14162 Exim's message ids are normally unique only within the local host. If
14163 uniqueness among a set of hosts is required, each host must set a different
14164 value for the &%localhost_number%& option. The string is expanded immediately
14165 after reading the configuration file (so that a number can be computed from the
14166 host name, for example) and the result of the expansion must be a number in the
14167 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14168 systems). This is available in subsequent string expansions via the variable
14169 &$localhost_number$&. When &%localhost_number is set%&, the final two
14170 characters of the message id, instead of just being a fractional part of the
14171 time, are computed from the time and the local host number as described in
14172 section &<<SECTmessiden>>&.
14173
14174
14175
14176 .option log_file_path main "string list&!!" "set at compile time"
14177 .cindex "log" "file path for"
14178 This option sets the path which is used to determine the names of Exim's log
14179 files, or indicates that logging is to be to syslog, or both. It is expanded
14180 when Exim is entered, so it can, for example, contain a reference to the host
14181 name. If no specific path is set for the log files at compile or run time, they
14182 are written in a sub-directory called &_log_& in Exim's spool directory.
14183 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14184 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14185 used. If this string is fixed at your installation (contains no expansion
14186 variables) it is recommended that you do not set this option in the
14187 configuration file, but instead supply the path using LOG_FILE_PATH in
14188 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14189 early on &-- in particular, failure to read the configuration file.
14190
14191
14192 .option log_selector main string unset
14193 .cindex "log" "selectors"
14194 This option can be used to reduce or increase the number of things that Exim
14195 writes to its log files. Its argument is made up of names preceded by plus or
14196 minus characters. For example:
14197 .code
14198 log_selector = +arguments -retry_defer
14199 .endd
14200 A list of possible names and what they control is given in the chapter on
14201 logging, in section &<<SECTlogselector>>&.
14202
14203
14204 .option log_timezone main boolean false
14205 .cindex "log" "timezone for entries"
14206 .vindex "&$tod_log$&"
14207 .vindex "&$tod_zone$&"
14208 By default, the timestamps on log lines are in local time without the
14209 timezone. This means that if your timezone changes twice a year, the timestamps
14210 in log lines are ambiguous for an hour when the clocks go back. One way of
14211 avoiding this problem is to set the timezone to UTC. An alternative is to set
14212 &%log_timezone%& true. This turns on the addition of the timezone offset to
14213 timestamps in log lines. Turning on this option can add quite a lot to the size
14214 of log files because each line is extended by 6 characters. Note that the
14215 &$tod_log$& variable contains the log timestamp without the zone, but there is
14216 another variable called &$tod_zone$& that contains just the timezone offset.
14217
14218
14219 .option lookup_open_max main integer 25
14220 .cindex "too many open files"
14221 .cindex "open files, too many"
14222 .cindex "file" "too many open"
14223 .cindex "lookup" "maximum open files"
14224 .cindex "limit" "open files for lookups"
14225 This option limits the number of simultaneously open files for single-key
14226 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14227 Exim normally keeps these files open during routing, because often the same
14228 file is required several times. If the limit is reached, Exim closes the least
14229 recently used file. Note that if you are using the &'ndbm'& library, it
14230 actually opens two files for each logical DBM database, though it still counts
14231 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14232 open files"& errors with NDBM, you need to reduce the value of
14233 &%lookup_open_max%&.
14234
14235
14236 .option max_username_length main integer 0
14237 .cindex "length of login name"
14238 .cindex "user name" "maximum length"
14239 .cindex "limit" "user name length"
14240 Some operating systems are broken in that they truncate long arguments to
14241 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14242 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14243 an argument that is longer behaves as if &[getpwnam()]& failed.
14244
14245
14246 .option message_body_newlines main bool false
14247 .cindex "message body" "newlines in variables"
14248 .cindex "newline" "in message body variables"
14249 .vindex "&$message_body$&"
14250 .vindex "&$message_body_end$&"
14251 By default, newlines in the message body are replaced by spaces when setting
14252 the &$message_body$& and &$message_body_end$& expansion variables. If this
14253 option is set true, this no longer happens.
14254
14255
14256 .option message_body_visible main integer 500
14257 .cindex "body of message" "visible size"
14258 .cindex "message body" "visible size"
14259 .vindex "&$message_body$&"
14260 .vindex "&$message_body_end$&"
14261 This option specifies how much of a message's body is to be included in the
14262 &$message_body$& and &$message_body_end$& expansion variables.
14263
14264
14265 .option message_id_header_domain main string&!! unset
14266 .cindex "&'Message-ID:'& header line"
14267 If this option is set, the string is expanded and used as the right hand side
14268 (domain) of the &'Message-ID:'& header that Exim creates if a
14269 locally-originated incoming message does not have one. &"Locally-originated"&
14270 means &"not received over TCP/IP."&
14271 Otherwise, the primary host name is used.
14272 Only letters, digits, dot and hyphen are accepted; any other characters are
14273 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14274 empty string, the option is ignored.
14275
14276
14277 .option message_id_header_text main string&!! unset
14278 If this variable is set, the string is expanded and used to augment the text of
14279 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14280 message does not have one. The text of this header is required by RFC 2822 to
14281 take the form of an address. By default, Exim uses its internal message id as
14282 the local part, and the primary host name as the domain. If this option is set,
14283 it is expanded, and provided the expansion is not forced to fail, and does not
14284 yield an empty string, the result is inserted into the header immediately
14285 before the @, separated from the internal message id by a dot. Any characters
14286 that are illegal in an address are automatically converted into hyphens. This
14287 means that variables such as &$tod_log$& can be used, because the spaces and
14288 colons will become hyphens.
14289
14290
14291 .option message_logs main boolean true
14292 .cindex "message logs" "disabling"
14293 .cindex "log" "message log; disabling"
14294 If this option is turned off, per-message log files are not created in the
14295 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14296 Exim, by reducing the number of files involved in handling a message from a
14297 minimum of four (header spool file, body spool file, delivery journal, and
14298 per-message log) to three. The other major I/O activity is Exim's main log,
14299 which is not affected by this option.
14300
14301
14302 .option message_size_limit main string&!! 50M
14303 .cindex "message" "size limit"
14304 .cindex "limit" "message size"
14305 .cindex "size" "of message, limit"
14306 This option limits the maximum size of message that Exim will process. The
14307 value is expanded for each incoming connection so, for example, it can be made
14308 to depend on the IP address of the remote host for messages arriving via
14309 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14310 optionally followed by K or M.
14311
14312 &*Note*&: This limit cannot be made to depend on a message's sender or any
14313 other properties of an individual message, because it has to be advertised in
14314 the server's response to EHLO. String expansion failure causes a temporary
14315 error. A value of zero means no limit, but its use is not recommended. See also
14316 &%bounce_return_size_limit%&.
14317
14318 Incoming SMTP messages are failed with a 552 error if the limit is
14319 exceeded; locally-generated messages either get a stderr message or a delivery
14320 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14321 an oversized message is logged in both the main and the reject logs. See also
14322 the generic transport option &%message_size_limit%&, which limits the size of
14323 message that an individual transport can process.
14324
14325 If you use a virus-scanner and set this option to to a value larger than the
14326 maximum size that your virus-scanner is configured to support, you may get
14327 failures triggered by large mails.  The right size to configure for the
14328 virus-scanner depends upon what data is passed and the options in use but it's
14329 probably safest to just set it to a little larger than this value.  Eg, with a
14330 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14331 some problems may result.
14332
14333 A value of 0 will disable size limit checking; Exim will still advertise the
14334 SIZE extension in an EHLO response, but without a limit, so as to permit
14335 SMTP clients to still indicate the message size along with the MAIL verb.
14336
14337
14338 .option move_frozen_messages main boolean false
14339 .cindex "frozen messages" "moving"
14340 This option, which is available only if Exim has been built with the setting
14341 .code
14342 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14343 .endd
14344 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14345 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14346 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14347 standard utilities for handling such moved messages, and they do not show up in
14348 lists generated by &%-bp%& or by the Exim monitor.
14349
14350
14351 .option mua_wrapper main boolean false
14352 Setting this option true causes Exim to run in a very restrictive mode in which
14353 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14354 contains a full description of this facility.
14355
14356
14357
14358 .option mysql_servers main "string list" unset
14359 .cindex "MySQL" "server list"
14360 This option provides a list of MySQL servers and associated connection data, to
14361 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14362 option is available only if Exim has been built with MySQL support.
14363
14364
14365 .option never_users main "string list&!!" unset
14366 This option is expanded just once, at the start of Exim's processing. Local
14367 message deliveries are normally run in processes that are setuid to the
14368 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14369 It is usually desirable to prevent any deliveries from running as root, as a
14370 safety precaution.
14371
14372 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14373 list of users that must not be used for local deliveries. This list is fixed in
14374 the binary and cannot be overridden by the configuration file. By default, it
14375 contains just the single user name &"root"&. The &%never_users%& runtime option
14376 can be used to add more users to the fixed list.
14377
14378 If a message is to be delivered as one of the users on the fixed list or the
14379 &%never_users%& list, an error occurs, and delivery is deferred. A common
14380 example is
14381 .code
14382 never_users = root:daemon:bin
14383 .endd
14384 Including root is redundant if it is also on the fixed list, but it does no
14385 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14386 transport driver.
14387
14388
14389 .option openssl_options main "string list" unset
14390 .cindex "OpenSSL "compatibility options"
14391 This option allows an administrator to adjust the SSL options applied
14392 by OpenSSL to connections.  It is given as a space-separated list of items,
14393 each one to be +added or -subtracted from the current value.
14394
14395 This option is only available if Exim is built against OpenSSL.  The values
14396 available for this option vary according to the age of your OpenSSL install.
14397 The &"all"& value controls a subset of flags which are available, typically
14398 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14399 list the values known on your system and Exim should support all the
14400 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14401 names lose the leading &"SSL_OP_"& and are lower-cased.
14402
14403 Note that adjusting the options can have severe impact upon the security of
14404 SSL as used by Exim.  It is possible to disable safety checks and shoot
14405 yourself in the foot in various unpleasant ways.  This option should not be
14406 adjusted lightly.  An unrecognised item will be detected at startup, by
14407 invoking Exim with the &%-bV%& flag.
14408
14409 .new
14410 Historical note: prior to release 4.78, Exim defaulted this value to
14411 "+dont_insert_empty_fragments", which may still be needed for compatibility
14412 with some clients, but which lowers security by increasing exposure to
14413 some now infamous attacks.
14414 .wen
14415
14416 An example:
14417 .code
14418 # Make both old MS and old Eudora happy:
14419 openssl_options = -all +microsoft_big_sslv3_buffer \
14420                        +dont_insert_empty_fragments
14421 .endd
14422
14423 Possible options may include:
14424 .ilist
14425 &`all`&
14426 .next
14427 &`allow_unsafe_legacy_renegotiation`&
14428 .next
14429 &`cipher_server_preference`&
14430 .next
14431 &`dont_insert_empty_fragments`&
14432 .next
14433 &`ephemeral_rsa`&
14434 .next
14435 &`legacy_server_connect`&
14436 .next
14437 &`microsoft_big_sslv3_buffer`&
14438 .next
14439 &`microsoft_sess_id_bug`&
14440 .next
14441 &`msie_sslv2_rsa_padding`&
14442 .next
14443 &`netscape_challenge_bug`&
14444 .next
14445 &`netscape_reuse_cipher_change_bug`&
14446 .next
14447 &`no_compression`&
14448 .next
14449 &`no_session_resumption_on_renegotiation`&
14450 .next
14451 &`no_sslv2`&
14452 .next
14453 &`no_sslv3`&
14454 .next
14455 &`no_ticket`&
14456 .next
14457 &`no_tlsv1`&
14458 .next
14459 &`no_tlsv1_1`&
14460 .next
14461 &`no_tlsv1_2`&
14462 .next
14463 &`single_dh_use`&
14464 .next
14465 &`single_ecdh_use`&
14466 .next
14467 &`ssleay_080_client_dh_bug`&
14468 .next
14469 &`sslref2_reuse_cert_type_bug`&
14470 .next
14471 &`tls_block_padding_bug`&
14472 .next
14473 &`tls_d5_bug`&
14474 .next
14475 &`tls_rollback_bug`&
14476 .endlist
14477
14478
14479 .option oracle_servers main "string list" unset
14480 .cindex "Oracle" "server list"
14481 This option provides a list of Oracle servers and associated connection data,
14482 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14483 The option is available only if Exim has been built with Oracle support.
14484
14485
14486 .option percent_hack_domains main "domain list&!!" unset
14487 .cindex "&""percent hack""&"
14488 .cindex "source routing" "in email address"
14489 .cindex "address" "source-routed"
14490 The &"percent hack"& is the convention whereby a local part containing a
14491 percent sign is re-interpreted as a new email address, with the percent
14492 replaced by @. This is sometimes called &"source routing"&, though that term is
14493 also applied to RFC 2822 addresses that begin with an @ character. If this
14494 option is set, Exim implements the percent facility for those domains listed,
14495 but no others. This happens before an incoming SMTP address is tested against
14496 an ACL.
14497
14498 &*Warning*&: The &"percent hack"& has often been abused by people who are
14499 trying to get round relaying restrictions. For this reason, it is best avoided
14500 if at all possible. Unfortunately, a number of less security-conscious MTAs
14501 implement it unconditionally. If you are running Exim on a gateway host, and
14502 routing mail through to internal MTAs without processing the local parts, it is
14503 a good idea to reject recipient addresses with percent characters in their
14504 local parts. Exim's default configuration does this.
14505
14506
14507 .option perl_at_start main boolean false
14508 This option is available only when Exim is built with an embedded Perl
14509 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14510
14511
14512 .option perl_startup main string unset
14513 This option is available only when Exim is built with an embedded Perl
14514 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14515
14516
14517 .option pgsql_servers main "string list" unset
14518 .cindex "PostgreSQL lookup type" "server list"
14519 This option provides a list of PostgreSQL servers and associated connection
14520 data, to be used in conjunction with &(pgsql)& lookups (see section
14521 &<<SECID72>>&). The option is available only if Exim has been built with
14522 PostgreSQL support.
14523
14524
14525 .option pid_file_path main string&!! "set at compile time"
14526 .cindex "daemon" "pid file path"
14527 .cindex "pid file, path for"
14528 This option sets the name of the file to which the Exim daemon writes its
14529 process id. The string is expanded, so it can contain, for example, references
14530 to the host name:
14531 .code
14532 pid_file_path = /var/log/$primary_hostname/exim.pid
14533 .endd
14534 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14535 spool directory.
14536 The value set by the option can be overridden by the &%-oP%& command line
14537 option. A pid file is not written if a &"non-standard"& daemon is run by means
14538 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14539
14540
14541 .option pipelining_advertise_hosts main "host list&!!" *
14542 .cindex "PIPELINING" "suppressing advertising"
14543 This option can be used to suppress the advertisement of the SMTP
14544 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14545 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14546 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14547 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14548 that clients will use it; &"out of order"& commands that are &"expected"& do
14549 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14550
14551
14552 .option preserve_message_logs main boolean false
14553 .cindex "message logs" "preserving"
14554 If this option is set, message log files are not deleted when messages are
14555 completed. Instead, they are moved to a sub-directory of the spool directory
14556 called &_msglog.OLD_&, where they remain available for statistical or debugging
14557 purposes. This is a dangerous option to set on systems with any appreciable
14558 volume of mail. Use with care!
14559
14560
14561 .option primary_hostname main string "see below"
14562 .cindex "name" "of local host"
14563 .cindex "host" "name of local"
14564 .cindex "local host" "name of"
14565 .vindex "&$primary_hostname$&"
14566 This specifies the name of the current host. It is used in the default EHLO or
14567 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14568 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14569 The value is also used by default in some SMTP response messages from an Exim
14570 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14571
14572 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14573 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14574 contains only one component, Exim passes it to &[gethostbyname()]& (or
14575 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14576 version. The variable &$primary_hostname$& contains the host name, whether set
14577 explicitly by this option, or defaulted.
14578
14579
14580 .option print_topbitchars main boolean false
14581 .cindex "printing characters"
14582 .cindex "8-bit characters"
14583 By default, Exim considers only those characters whose codes lie in the range
14584 32&--126 to be printing characters. In a number of circumstances (for example,
14585 when writing log entries) non-printing characters are converted into escape
14586 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14587 is set, code values of 128 and above are also considered to be printing
14588 characters.
14589
14590 This option also affects the header syntax checks performed by the
14591 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14592 the user's full name when constructing From: and Sender: addresses (as
14593 described in section &<<SECTconstr>>&). Setting this option can cause
14594 Exim to generate eight bit message headers that do not conform to the
14595 standards.
14596
14597
14598 .option process_log_path main string unset
14599 .cindex "process log path"
14600 .cindex "log" "process log"
14601 .cindex "&'exiwhat'&"
14602 This option sets the name of the file to which an Exim process writes its
14603 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14604 utility script. If this option is unset, the file called &_exim-process.info_&
14605 in Exim's spool directory is used. The ability to specify the name explicitly
14606 can be useful in environments where two different Exims are running, using
14607 different spool directories.
14608
14609
14610 .option prod_requires_admin main boolean true
14611 .oindex "&%-M%&"
14612 .oindex "&%-R%&"
14613 .oindex "&%-q%&"
14614 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14615 admin user unless &%prod_requires_admin%& is set false. See also
14616 &%queue_list_requires_admin%&.
14617
14618
14619 .option qualify_domain main string "see below"
14620 .cindex "domain" "for qualifying addresses"
14621 .cindex "address" "qualification"
14622 This option specifies the domain name that is added to any envelope sender
14623 addresses that do not have a domain qualification. It also applies to
14624 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14625 are accepted by default only for locally-generated messages. Qualification is
14626 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14627 locally-generated messages, unless the &%-bnq%& command line option is used.
14628
14629 Messages from external sources must always contain fully qualified addresses,
14630 unless the sending host matches &%sender_unqualified_hosts%& or
14631 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14632 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14633 necessary. Internally, Exim always works with fully qualified envelope
14634 addresses. If &%qualify_domain%& is not set, it defaults to the
14635 &%primary_hostname%& value.
14636
14637
14638 .option qualify_recipient main string "see below"
14639 This option allows you to specify a different domain for qualifying recipient
14640 addresses to the one that is used for senders. See &%qualify_domain%& above.
14641
14642
14643
14644 .option queue_domains main "domain list&!!" unset
14645 .cindex "domain" "specifying non-immediate delivery"
14646 .cindex "queueing incoming messages"
14647 .cindex "message" "queueing certain domains"
14648 This option lists domains for which immediate delivery is not required.
14649 A delivery process is started whenever a message is received, but only those
14650 domains that do not match are processed. All other deliveries wait until the
14651 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14652
14653
14654 .option queue_list_requires_admin main boolean true
14655 .oindex "&%-bp%&"
14656 The &%-bp%& command-line option, which lists the messages that are on the
14657 queue, requires the caller to be an admin user unless
14658 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14659
14660
14661 .option queue_only main boolean false
14662 .cindex "queueing incoming messages"
14663 .cindex "message" "queueing unconditionally"
14664 If &%queue_only%& is set, a delivery process is not automatically started
14665 whenever a message is received. Instead, the message waits on the queue for the
14666 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14667 delivered immediately when certain conditions (such as heavy load) occur.
14668
14669 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14670 and &%-odi%& command line options override &%queue_only%& unless
14671 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14672 &%queue_only_load%&, and &%smtp_accept_queue%&.
14673
14674
14675 .option queue_only_file main string unset
14676 .cindex "queueing incoming messages"
14677 .cindex "message" "queueing by file existence"
14678 This option can be set to a colon-separated list of absolute path names, each
14679 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14680 it tests for the existence of each listed path using a call to &[stat()]&. For
14681 each path that exists, the corresponding queueing option is set.
14682 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14683 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14684 .code
14685 queue_only_file = smtp/some/file
14686 .endd
14687 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14688 &_/some/file_& exists.
14689
14690
14691 .option queue_only_load main fixed-point unset
14692 .cindex "load average"
14693 .cindex "queueing incoming messages"
14694 .cindex "message" "queueing by load"
14695 If the system load average is higher than this value, incoming messages from
14696 all sources are queued, and no automatic deliveries are started. If this
14697 happens during local or remote SMTP input, all subsequent messages received on
14698 the same SMTP connection are queued by default, whatever happens to the load in
14699 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14700 false.
14701
14702 Deliveries will subsequently be performed by queue runner processes. This
14703 option has no effect on ancient operating systems on which Exim cannot
14704 determine the load average. See also &%deliver_queue_load_max%& and
14705 &%smtp_load_reserve%&.
14706
14707
14708 .option queue_only_load_latch main boolean true
14709 .cindex "load average" "re-evaluating per message"
14710 When this option is true (the default), once one message has been queued
14711 because the load average is higher than the value set by &%queue_only_load%&,
14712 all subsequent messages received on the same SMTP connection are also queued.
14713 This is a deliberate choice; even though the load average may fall below the
14714 threshold, it doesn't seem right to deliver later messages on the same
14715 connection when not delivering earlier ones. However, there are special
14716 circumstances such as very long-lived connections from scanning appliances
14717 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14718 should be set false. This causes the value of the load average to be
14719 re-evaluated for each message.
14720
14721
14722 .option queue_only_override main boolean true
14723 .cindex "queueing incoming messages"
14724 When this option is true, the &%-od%&&'x'& command line options override the
14725 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14726 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14727 to override; they are accepted, but ignored.
14728
14729
14730 .option queue_run_in_order main boolean false
14731 .cindex "queue runner" "processing messages in order"
14732 If this option is set, queue runs happen in order of message arrival instead of
14733 in an arbitrary order. For this to happen, a complete list of the entire queue
14734 must be set up before the deliveries start. When the queue is all held in a
14735 single directory (the default), a single list is created for both the ordered
14736 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14737 single list is not created when &%queue_run_in_order%& is false. In this case,
14738 the sub-directories are processed one at a time (in a random order), and this
14739 avoids setting up one huge list for the whole queue. Thus, setting
14740 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14741 when the queue is large, because of the extra work in setting up the single,
14742 large list. In most situations, &%queue_run_in_order%& should not be set.
14743
14744
14745
14746 .option queue_run_max main integer 5
14747 .cindex "queue runner" "maximum number of"
14748 This controls the maximum number of queue runner processes that an Exim daemon
14749 can run simultaneously. This does not mean that it starts them all at once,
14750 but rather that if the maximum number are still running when the time comes to
14751 start another one, it refrains from starting another one. This can happen with
14752 very large queues and/or very sluggish deliveries. This option does not,
14753 however, interlock with other processes, so additional queue runners can be
14754 started by other means, or by killing and restarting the daemon.
14755
14756 Setting this option to zero does not suppress queue runs; rather, it disables
14757 the limit, allowing any number of simultaneous queue runner processes to be
14758 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14759 the daemon's command line.
14760
14761 .option queue_smtp_domains main "domain list&!!" unset
14762 .cindex "queueing incoming messages"
14763 .cindex "message" "queueing remote deliveries"
14764 When this option is set, a delivery process is started whenever a message is
14765 received, routing is performed, and local deliveries take place.
14766 However, if any SMTP deliveries are required for domains that match
14767 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14768 message waits on the queue for the next queue run. Since routing of the message
14769 has taken place, Exim knows to which remote hosts it must be delivered, and so
14770 when the queue run happens, multiple messages for the same host are delivered
14771 over a single SMTP connection. The &%-odqs%& command line option causes all
14772 SMTP deliveries to be queued in this way, and is equivalent to setting
14773 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14774 &%queue_domains%&.
14775
14776
14777 .option receive_timeout main time 0s
14778 .cindex "timeout" "for non-SMTP input"
14779 This option sets the timeout for accepting a non-SMTP message, that is, the
14780 maximum time that Exim waits when reading a message on the standard input. If
14781 the value is zero, it will wait for ever. This setting is overridden by the
14782 &%-or%& command line option. The timeout for incoming SMTP messages is
14783 controlled by &%smtp_receive_timeout%&.
14784
14785 .option received_header_text main string&!! "see below"
14786 .cindex "customizing" "&'Received:'& header"
14787 .cindex "&'Received:'& header line" "customizing"
14788 This string defines the contents of the &'Received:'& message header that is
14789 added to each message, except for the timestamp, which is automatically added
14790 on at the end (preceded by a semicolon). The string is expanded each time it is
14791 used. If the expansion yields an empty string, no &'Received:'& header line is
14792 added to the message. Otherwise, the string should start with the text
14793 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14794 header lines. The default setting is:
14795
14796 .code
14797 received_header_text = Received: \
14798   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14799   {${if def:sender_ident \
14800   {from ${quote_local_part:$sender_ident} }}\
14801   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14802   by $primary_hostname \
14803   ${if def:received_protocol {with $received_protocol}} \
14804   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14805   (Exim $version_number)\n\t\
14806   ${if def:sender_address \
14807   {(envelope-from <$sender_address>)\n\t}}\
14808   id $message_exim_id\
14809   ${if def:received_for {\n\tfor $received_for}}
14810 .endd
14811
14812 The reference to the TLS cipher is omitted when Exim is built without TLS
14813 support. The use of conditional expansions ensures that this works for both
14814 locally generated messages and messages received from remote hosts, giving
14815 header lines such as the following:
14816 .code
14817 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14818 by marley.carol.example with esmtp (Exim 4.00)
14819 (envelope-from <bob@carol.example>)
14820 id 16IOWa-00019l-00
14821 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14822 Received: by scrooge.carol.example with local (Exim 4.00)
14823 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14824 .endd
14825 Until the body of the message has been received, the timestamp is the time when
14826 the message started to be received. Once the body has arrived, and all policy
14827 checks have taken place, the timestamp is updated to the time at which the
14828 message was accepted.
14829
14830
14831 .option received_headers_max main integer 30
14832 .cindex "loop" "prevention"
14833 .cindex "mail loop prevention"
14834 .cindex "&'Received:'& header line" "counting"
14835 When a message is to be delivered, the number of &'Received:'& headers is
14836 counted, and if it is greater than this parameter, a mail loop is assumed to
14837 have occurred, the delivery is abandoned, and an error message is generated.
14838 This applies to both local and remote deliveries.
14839
14840
14841 .option recipient_unqualified_hosts main "host list&!!" unset
14842 .cindex "unqualified addresses"
14843 .cindex "host" "unqualified addresses from"
14844 This option lists those hosts from which Exim is prepared to accept unqualified
14845 recipient addresses in message envelopes. The addresses are made fully
14846 qualified by the addition of the &%qualify_recipient%& value. This option also
14847 affects message header lines. Exim does not reject unqualified recipient
14848 addresses in headers, but it qualifies them only if the message came from a
14849 host that matches &%recipient_unqualified_hosts%&,
14850 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14851 option was not set.
14852
14853
14854 .option recipients_max main integer 0
14855 .cindex "limit" "number of recipients"
14856 .cindex "recipient" "maximum number"
14857 If this option is set greater than zero, it specifies the maximum number of
14858 original recipients for any message. Additional recipients that are generated
14859 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14860 all recipients over the limit; earlier recipients are delivered as normal.
14861 Non-SMTP messages with too many recipients are failed, and no deliveries are
14862 done.
14863
14864 .cindex "RCPT" "maximum number of incoming"
14865 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14866 RCPT commands in a single message.
14867
14868
14869 .option recipients_max_reject main boolean false
14870 If this option is set true, Exim rejects SMTP messages containing too many
14871 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14872 error to the eventual DATA command. Otherwise (the default) it gives a 452
14873 error to the surplus RCPT commands and accepts the message on behalf of the
14874 initial set of recipients. The remote server should then re-send the message
14875 for the remaining recipients at a later time.
14876
14877
14878 .option remote_max_parallel main integer 2
14879 .cindex "delivery" "parallelism for remote"
14880 This option controls parallel delivery of one message to a number of remote
14881 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14882 does all the remote deliveries for a message one by one. Otherwise, if a single
14883 message has to be delivered to more than one remote host, or if several copies
14884 have to be sent to the same remote host, up to &%remote_max_parallel%&
14885 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14886 deliveries are required, the maximum number of processes are started, and as
14887 each one finishes, another is begun. The order of starting processes is the
14888 same as if sequential delivery were being done, and can be controlled by the
14889 &%remote_sort_domains%& option. If parallel delivery takes place while running
14890 with debugging turned on, the debugging output from each delivery process is
14891 tagged with its process id.
14892
14893 This option controls only the maximum number of parallel deliveries for one
14894 message in one Exim delivery process. Because Exim has no central queue
14895 manager, there is no way of controlling the total number of simultaneous
14896 deliveries if the configuration allows a delivery attempt as soon as a message
14897 is received.
14898
14899 .cindex "number of deliveries"
14900 .cindex "delivery" "maximum number of"
14901 If you want to control the total number of deliveries on the system, you
14902 need to set the &%queue_only%& option. This ensures that all incoming messages
14903 are added to the queue without starting a delivery process. Then set up an Exim
14904 daemon to start queue runner processes at appropriate intervals (probably
14905 fairly often, for example, every minute), and limit the total number of queue
14906 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14907 delivers only one message at a time, the maximum number of deliveries that can
14908 then take place at once is &%queue_run_max%& multiplied by
14909 &%remote_max_parallel%&.
14910
14911 If it is purely remote deliveries you want to control, use
14912 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14913 doing the SMTP routing before queueing, so that several messages for the same
14914 host will eventually get delivered down the same connection.
14915
14916
14917 .option remote_sort_domains main "domain list&!!" unset
14918 .cindex "sorting remote deliveries"
14919 .cindex "delivery" "sorting remote"
14920 When there are a number of remote deliveries for a message, they are sorted by
14921 domain into the order given by this list. For example,
14922 .code
14923 remote_sort_domains = *.cam.ac.uk:*.uk
14924 .endd
14925 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14926 then to those in the &%uk%& domain, then to any others.
14927
14928
14929 .option retry_data_expire main time 7d
14930 .cindex "hints database" "data expiry"
14931 This option sets a &"use before"& time on retry information in Exim's hints
14932 database. Any older retry data is ignored. This means that, for example, once a
14933 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14934 past failures.
14935
14936
14937 .option retry_interval_max main time 24h
14938 .cindex "retry" "limit on interval"
14939 .cindex "limit" "on retry interval"
14940 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14941 intervals between delivery attempts for messages that cannot be delivered
14942 straight away. This option sets an overall limit to the length of time between
14943 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14944 the default value.
14945
14946
14947 .option return_path_remove main boolean true
14948 .cindex "&'Return-path:'& header line" "removing"
14949 RFC 2821, section 4.4, states that an SMTP server must insert a
14950 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14951 The &'Return-path:'& header preserves the sender address as received in the
14952 MAIL command. This description implies that this header should not be present
14953 in an incoming message. If &%return_path_remove%& is true, any existing
14954 &'Return-path:'& headers are removed from messages at the time they are
14955 received. Exim's transports have options for adding &'Return-path:'& headers at
14956 the time of delivery. They are normally used only for final local deliveries.
14957
14958
14959 .option return_size_limit main integer 100K
14960 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14961
14962
14963 .option rfc1413_hosts main "host list&!!" *
14964 .cindex "RFC 1413"
14965 .cindex "host" "for RFC 1413 calls"
14966 RFC 1413 identification calls are made to any client host which matches an item
14967 in the list.
14968
14969 .option rfc1413_query_timeout main time 5s
14970 .cindex "RFC 1413" "query timeout"
14971 .cindex "timeout" "for RFC 1413 call"
14972 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14973 no RFC 1413 calls are ever made.
14974
14975
14976 .option sender_unqualified_hosts main "host list&!!" unset
14977 .cindex "unqualified addresses"
14978 .cindex "host" "unqualified addresses from"
14979 This option lists those hosts from which Exim is prepared to accept unqualified
14980 sender addresses. The addresses are made fully qualified by the addition of
14981 &%qualify_domain%&. This option also affects message header lines. Exim does
14982 not reject unqualified addresses in headers that contain sender addresses, but
14983 it qualifies them only if the message came from a host that matches
14984 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14985 using TCP/IP), and the &%-bnq%& option was not set.
14986
14987
14988 .option smtp_accept_keepalive main boolean true
14989 .cindex "keepalive" "on incoming connection"
14990 This option controls the setting of the SO_KEEPALIVE option on incoming
14991 TCP/IP socket connections. When set, it causes the kernel to probe idle
14992 connections periodically, by sending packets with &"old"& sequence numbers. The
14993 other end of the connection should send an acknowledgment if the connection is
14994 still okay or a reset if the connection has been aborted. The reason for doing
14995 this is that it has the beneficial effect of freeing up certain types of
14996 connection that can get stuck when the remote host is disconnected without
14997 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14998 hours to detect unreachable hosts.
14999
15000
15001
15002 .option smtp_accept_max main integer 20
15003 .cindex "limit" "incoming SMTP connections"
15004 .cindex "SMTP" "incoming connection count"
15005 .cindex "inetd"
15006 This option specifies the maximum number of simultaneous incoming SMTP calls
15007 that Exim will accept. It applies only to the listening daemon; there is no
15008 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15009 value is set to zero, no limit is applied. However, it is required to be
15010 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15011 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15012
15013 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15014 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15015 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15016 and &%smtp_load_reserve%& are then checked before accepting the connection.
15017
15018
15019 .option smtp_accept_max_nonmail main integer 10
15020 .cindex "limit" "non-mail SMTP commands"
15021 .cindex "SMTP" "limiting non-mail commands"
15022 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15023 the connection if there are too many. This option defines &"too many"&. The
15024 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15025 client looping sending EHLO, for example. The check is applied only if the
15026 client host matches &%smtp_accept_max_nonmail_hosts%&.
15027
15028 When a new message is expected, one occurrence of RSET is not counted. This
15029 allows a client to send one RSET between messages (this is not necessary,
15030 but some clients do it). Exim also allows one uncounted occurrence of HELO
15031 or EHLO, and one occurrence of STARTTLS between messages. After
15032 starting up a TLS session, another EHLO is expected, and so it too is not
15033 counted. The first occurrence of AUTH in a connection, or immediately
15034 following STARTTLS is not counted. Otherwise, all commands other than
15035 MAIL, RCPT, DATA, and QUIT are counted.
15036
15037
15038 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15039 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15040 check by setting this option. The default value makes it apply to all hosts. By
15041 changing the value, you can exclude any badly-behaved hosts that you have to
15042 live with.
15043
15044
15045 . Allow this long option name to split; give it unsplit as a fifth argument
15046 . for the automatic .oindex that is generated by .option.
15047
15048 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
15049          smtp_accept_max_per_connection
15050 .cindex "SMTP" "limiting incoming message count"
15051 .cindex "limit" "messages per SMTP connection"
15052 The value of this option limits the number of MAIL commands that Exim is
15053 prepared to accept over a single SMTP connection, whether or not each command
15054 results in the transfer of a message. After the limit is reached, a 421
15055 response is given to subsequent MAIL commands. This limit is a safety
15056 precaution against a client that goes mad (incidents of this type have been
15057 seen).
15058
15059
15060 .option smtp_accept_max_per_host main string&!! unset
15061 .cindex "limit" "SMTP connections from one host"
15062 .cindex "host" "limiting SMTP connections from"
15063 This option restricts the number of simultaneous IP connections from a single
15064 host (strictly, from a single IP address) to the Exim daemon. The option is
15065 expanded, to enable different limits to be applied to different hosts by
15066 reference to &$sender_host_address$&. Once the limit is reached, additional
15067 connection attempts from the same host are rejected with error code 421. This
15068 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15069 of zero imposes no limit. If this option is set greater than zero, it is
15070 required that &%smtp_accept_max%& be non-zero.
15071
15072 &*Warning*&: When setting this option you should not use any expansion
15073 constructions that take an appreciable amount of time. The expansion and test
15074 happen in the main daemon loop, in order to reject additional connections
15075 without forking additional processes (otherwise a denial-of-service attack
15076 could cause a vast number or processes to be created). While the daemon is
15077 doing this processing, it cannot accept any other incoming connections.
15078
15079
15080
15081 .option smtp_accept_queue main integer 0
15082 .cindex "SMTP" "incoming connection count"
15083 .cindex "queueing incoming messages"
15084 .cindex "message" "queueing by SMTP connection count"
15085 If the number of simultaneous incoming SMTP connections being handled via the
15086 listening daemon exceeds this value, messages received by SMTP are just placed
15087 on the queue; no delivery processes are started automatically. The count is
15088 fixed at the start of an SMTP connection. It cannot be updated in the
15089 subprocess that receives messages, and so the queueing or not queueing applies
15090 to all messages received in the same connection.
15091
15092 A value of zero implies no limit, and clearly any non-zero value is useful only
15093 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15094 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15095 various &%-od%&&'x'& command line options.
15096
15097
15098 . Allow this long option name to split; give it unsplit as a fifth argument
15099 . for the automatic .oindex that is generated by .option.
15100
15101 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15102          smtp_accept_queue_per_connection
15103 .cindex "queueing incoming messages"
15104 .cindex "message" "queueing by message count"
15105 This option limits the number of delivery processes that Exim starts
15106 automatically when receiving messages via SMTP, whether via the daemon or by
15107 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15108 and the number of messages received in a single SMTP session exceeds this
15109 number, subsequent messages are placed on the queue, but no delivery processes
15110 are started. This helps to limit the number of Exim processes when a server
15111 restarts after downtime and there is a lot of mail waiting for it on other
15112 systems. On large systems, the default should probably be increased, and on
15113 dial-in client systems it should probably be set to zero (that is, disabled).
15114
15115
15116 .option smtp_accept_reserve main integer 0
15117 .cindex "SMTP" "incoming call count"
15118 .cindex "host" "reserved"
15119 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15120 number of SMTP connections that are reserved for connections from the hosts
15121 that are specified in &%smtp_reserve_hosts%&. The value set in
15122 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15123 restricted to this number of connections; the option specifies a minimum number
15124 of connection slots for them, not a maximum. It is a guarantee that this group
15125 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15126 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15127 individual host.
15128
15129 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15130 set to 5, once there are 45 active connections (from any hosts), new
15131 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15132 provided the other criteria for acceptance are met.
15133
15134
15135 .option smtp_active_hostname main string&!! unset
15136 .cindex "host" "name in SMTP responses"
15137 .cindex "SMTP" "host name in responses"
15138 .vindex "&$primary_hostname$&"
15139 This option is provided for multi-homed servers that want to masquerade as
15140 several different hosts. At the start of an incoming SMTP connection, its value
15141 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15142 responses. For example, it is used as domain name in the response to an
15143 incoming HELO or EHLO command.
15144
15145 .vindex "&$smtp_active_hostname$&"
15146 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15147 is saved with any messages that are received. It is therefore available for use
15148 in routers and transports when the message is later delivered.
15149
15150 If this option is unset, or if its expansion is forced to fail, or if the
15151 expansion results in an empty string, the value of &$primary_hostname$& is
15152 used. Other expansion failures cause a message to be written to the main and
15153 panic logs, and the SMTP command receives a temporary error. Typically, the
15154 value of &%smtp_active_hostname%& depends on the incoming interface address.
15155 For example:
15156 .code
15157 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15158   {cox.mydomain}{box.mydomain}}
15159 .endd
15160
15161 Although &$smtp_active_hostname$& is primarily concerned with incoming
15162 messages, it is also used as the default for HELO commands in callout
15163 verification if there is no remote transport from which to obtain a
15164 &%helo_data%& value.
15165
15166 .option smtp_banner main string&!! "see below"
15167 .cindex "SMTP" "welcome banner"
15168 .cindex "banner for SMTP"
15169 .cindex "welcome banner for SMTP"
15170 .cindex "customizing" "SMTP banner"
15171 This string, which is expanded every time it is used, is output as the initial
15172 positive response to an SMTP connection. The default setting is:
15173 .code
15174 smtp_banner = $smtp_active_hostname ESMTP Exim \
15175   $version_number $tod_full
15176 .endd
15177 Failure to expand the string causes a panic error. If you want to create a
15178 multiline response to the initial SMTP connection, use &"\n"& in the string at
15179 appropriate points, but not at the end. Note that the 220 code is not included
15180 in this string. Exim adds it automatically (several times in the case of a
15181 multiline response).
15182
15183
15184 .option smtp_check_spool_space main boolean true
15185 .cindex "checking disk space"
15186 .cindex "disk space, checking"
15187 .cindex "spool directory" "checking space"
15188 When this option is set, if an incoming SMTP session encounters the SIZE
15189 option on a MAIL command, it checks that there is enough space in the
15190 spool directory's partition to accept a message of that size, while still
15191 leaving free the amount specified by &%check_spool_space%& (even if that value
15192 is zero). If there isn't enough space, a temporary error code is returned.
15193
15194
15195 .option smtp_connect_backlog main integer 20
15196 .cindex "connection backlog"
15197 .cindex "SMTP" "connection backlog"
15198 .cindex "backlog of connections"
15199 This option specifies a maximum number of waiting SMTP connections. Exim passes
15200 this value to the TCP/IP system when it sets up its listener. Once this number
15201 of connections are waiting for the daemon's attention, subsequent connection
15202 attempts are refused at the TCP/IP level. At least, that is what the manuals
15203 say; in some circumstances such connection attempts have been observed to time
15204 out instead. For large systems it is probably a good idea to increase the
15205 value (to 50, say). It also gives some protection against denial-of-service
15206 attacks by SYN flooding.
15207
15208
15209 .option smtp_enforce_sync main boolean true
15210 .cindex "SMTP" "synchronization checking"
15211 .cindex "synchronization checking in SMTP"
15212 The SMTP protocol specification requires the client to wait for a response from
15213 the server at certain points in the dialogue. Without PIPELINING these
15214 synchronization points are after every command; with PIPELINING they are
15215 fewer, but they still exist.
15216
15217 Some spamming sites send out a complete set of SMTP commands without waiting
15218 for any response. Exim protects against this by rejecting a message if the
15219 client has sent further input when it should not have. The error response &"554
15220 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15221 for this error cannot be perfect because of transmission delays (unexpected
15222 input may be on its way but not yet received when Exim checks). However, it
15223 does detect many instances.
15224
15225 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15226 If you want to disable the check selectively (for example, only for certain
15227 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15228 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15229
15230
15231
15232 .option smtp_etrn_command main string&!! unset
15233 .cindex "ETRN" "command to be run"
15234 .vindex "&$domain$&"
15235 If this option is set, the given command is run whenever an SMTP ETRN
15236 command is received from a host that is permitted to issue such commands (see
15237 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15238 are independently expanded. The expansion variable &$domain$& is set to the
15239 argument of the ETRN command, and no syntax checking is done on it. For
15240 example:
15241 .code
15242 smtp_etrn_command = /etc/etrn_command $domain \
15243                     $sender_host_address
15244 .endd
15245 A new process is created to run the command, but Exim does not wait for it to
15246 complete. Consequently, its status cannot be checked. If the command cannot be
15247 run, a line is written to the panic log, but the ETRN caller still receives
15248 a 250 success response. Exim is normally running under its own uid when
15249 receiving SMTP, so it is not possible for it to change the uid before running
15250 the command.
15251
15252
15253 .option smtp_etrn_serialize main boolean true
15254 .cindex "ETRN" "serializing"
15255 When this option is set, it prevents the simultaneous execution of more than
15256 one identical command as a result of ETRN in an SMTP connection. See
15257 section &<<SECTETRN>>& for details.
15258
15259
15260 .option smtp_load_reserve main fixed-point unset
15261 .cindex "load average"
15262 If the system load average ever gets higher than this, incoming SMTP calls are
15263 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15264 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15265 the load is over the limit. The option has no effect on ancient operating
15266 systems on which Exim cannot determine the load average. See also
15267 &%deliver_queue_load_max%& and &%queue_only_load%&.
15268
15269
15270
15271 .option smtp_max_synprot_errors main integer 3
15272 .cindex "SMTP" "limiting syntax and protocol errors"
15273 .cindex "limit" "SMTP syntax and protocol errors"
15274 Exim rejects SMTP commands that contain syntax or protocol errors. In
15275 particular, a syntactically invalid email address, as in this command:
15276 .code
15277 RCPT TO:<abc xyz@a.b.c>
15278 .endd
15279 causes immediate rejection of the command, before any other tests are done.
15280 (The ACL cannot be run if there is no valid address to set up for it.) An
15281 example of a protocol error is receiving RCPT before MAIL. If there are
15282 too many syntax or protocol errors in one SMTP session, the connection is
15283 dropped. The limit is set by this option.
15284
15285 .cindex "PIPELINING" "expected errors"
15286 When the PIPELINING extension to SMTP is in use, some protocol errors are
15287 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15288 Exim assumes that PIPELINING will be used if it advertises it (see
15289 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15290 not count towards the limit.
15291
15292
15293
15294 .option smtp_max_unknown_commands main integer 3
15295 .cindex "SMTP" "limiting unknown commands"
15296 .cindex "limit" "unknown SMTP commands"
15297 If there are too many unrecognized commands in an incoming SMTP session, an
15298 Exim server drops the connection. This is a defence against some kinds of abuse
15299 that subvert web
15300 clients
15301 into making connections to SMTP ports; in these circumstances, a number of
15302 non-SMTP command lines are sent first.
15303
15304
15305
15306 .option smtp_ratelimit_hosts main "host list&!!" unset
15307 .cindex "SMTP" "rate limiting"
15308 .cindex "limit" "rate of message arrival"
15309 .cindex "RCPT" "rate limiting"
15310 Some sites find it helpful to be able to limit the rate at which certain hosts
15311 can send them messages, and the rate at which an individual message can specify
15312 recipients.
15313
15314 Exim has two rate-limiting facilities. This section describes the older
15315 facility, which can limit rates within a single connection. The newer
15316 &%ratelimit%& ACL condition can limit rates across all connections. See section
15317 &<<SECTratelimiting>>& for details of the newer facility.
15318
15319 When a host matches &%smtp_ratelimit_hosts%&, the values of
15320 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15321 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15322 respectively. Each option, if set, must contain a set of four comma-separated
15323 values:
15324
15325 .ilist
15326 A threshold, before which there is no rate limiting.
15327 .next
15328 An initial time delay. Unlike other times in Exim, numbers with decimal
15329 fractional parts are allowed here.
15330 .next
15331 A factor by which to increase the delay each time.
15332 .next
15333 A maximum value for the delay. This should normally be less than 5 minutes,
15334 because after that time, the client is liable to timeout the SMTP command.
15335 .endlist
15336
15337 For example, these settings have been used successfully at the site which
15338 first suggested this feature, for controlling mail from their customers:
15339 .code
15340 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15341 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15342 .endd
15343 The first setting specifies delays that are applied to MAIL commands after
15344 two have been received over a single connection. The initial delay is 0.5
15345 seconds, increasing by a factor of 1.05 each time. The second setting applies
15346 delays to RCPT commands when more than four occur in a single message.
15347
15348
15349 .option smtp_ratelimit_mail main string unset
15350 See &%smtp_ratelimit_hosts%& above.
15351
15352
15353 .option smtp_ratelimit_rcpt main string unset
15354 See &%smtp_ratelimit_hosts%& above.
15355
15356
15357 .option smtp_receive_timeout main time 5m
15358 .cindex "timeout" "for SMTP input"
15359 .cindex "SMTP" "input timeout"
15360 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15361 input, including batch SMTP. If a line of input (either an SMTP command or a
15362 data line) is not received within this time, the SMTP connection is dropped and
15363 the message is abandoned.
15364 A line is written to the log containing one of the following messages:
15365 .code
15366 SMTP command timeout on connection from...
15367 SMTP data timeout on connection from...
15368 .endd
15369 The former means that Exim was expecting to read an SMTP command; the latter
15370 means that it was in the DATA phase, reading the contents of a message.
15371
15372
15373 .oindex "&%-os%&"
15374 The value set by this option can be overridden by the
15375 &%-os%& command-line option. A setting of zero time disables the timeout, but
15376 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15377 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15378 timeout is controlled by &%receive_timeout%& and &%-or%&.
15379
15380
15381 .option smtp_reserve_hosts main "host list&!!" unset
15382 This option defines hosts for which SMTP connections are reserved; see
15383 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15384
15385
15386 .option smtp_return_error_details main boolean false
15387 .cindex "SMTP" "details policy failures"
15388 .cindex "policy control" "rejection, returning details"
15389 In the default state, Exim uses bland messages such as
15390 &"Administrative prohibition"& when it rejects SMTP commands for policy
15391 reasons. Many sysadmins like this because it gives away little information
15392 to spammers. However, some other sysadmins who are applying strict checking
15393 policies want to give out much fuller information about failures. Setting
15394 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15395 example, instead of &"Administrative prohibition"&, it might give:
15396 .code
15397 550-Rejected after DATA: '>' missing at end of address:
15398 550 failing address in "From" header is: <user@dom.ain
15399 .endd
15400
15401 .option spamd_address main string "see below"
15402 This option is available when Exim is compiled with the content-scanning
15403 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15404 The default value is
15405 .code
15406 127.0.0.1 783
15407 .endd
15408 See section &<<SECTscanspamass>>& for more details.
15409
15410
15411
15412 .option split_spool_directory main boolean false
15413 .cindex "multiple spool directories"
15414 .cindex "spool directory" "split"
15415 .cindex "directories, multiple"
15416 If this option is set, it causes Exim to split its input directory into 62
15417 subdirectories, each with a single alphanumeric character as its name. The
15418 sixth character of the message id is used to allocate messages to
15419 subdirectories; this is the least significant base-62 digit of the time of
15420 arrival of the message.
15421
15422 Splitting up the spool in this way may provide better performance on systems
15423 where there are long mail queues, by reducing the number of files in any one
15424 directory. The msglog directory is also split up in a similar way to the input
15425 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15426 are still placed in the single directory &_msglog.OLD_&.
15427
15428 It is not necessary to take any special action for existing messages when
15429 changing &%split_spool_directory%&. Exim notices messages that are in the
15430 &"wrong"& place, and continues to process them. If the option is turned off
15431 after a period of being on, the subdirectories will eventually empty and be
15432 automatically deleted.
15433
15434 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15435 changes. Instead of creating a list of all messages in the queue, and then
15436 trying to deliver each one in turn, it constructs a list of those in one
15437 sub-directory and tries to deliver them, before moving on to the next
15438 sub-directory. The sub-directories are processed in a random order. This
15439 spreads out the scanning of the input directories, and uses less memory. It is
15440 particularly beneficial when there are lots of messages on the queue. However,
15441 if &%queue_run_in_order%& is set, none of this new processing happens. The
15442 entire queue has to be scanned and sorted before any deliveries can start.
15443
15444
15445 .option spool_directory main string&!! "set at compile time"
15446 .cindex "spool directory" "path to"
15447 This defines the directory in which Exim keeps its spool, that is, the messages
15448 it is waiting to deliver. The default value is taken from the compile-time
15449 configuration setting, if there is one. If not, this option must be set. The
15450 string is expanded, so it can contain, for example, a reference to
15451 &$primary_hostname$&.
15452
15453 If the spool directory name is fixed on your installation, it is recommended
15454 that you set it at build time rather than from this option, particularly if the
15455 log files are being written to the spool directory (see &%log_file_path%&).
15456 Otherwise log files cannot be used for errors that are detected early on, such
15457 as failures in the configuration file.
15458
15459 By using this option to override the compiled-in path, it is possible to run
15460 tests of Exim without using the standard spool.
15461
15462 .option sqlite_lock_timeout main time 5s
15463 .cindex "sqlite lookup type" "lock timeout"
15464 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15465 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15466
15467 .option strict_acl_vars main boolean false
15468 .cindex "&ACL;" "variables, handling unset"
15469 This option controls what happens if a syntactically valid but undefined ACL
15470 variable is referenced. If it is false (the default), an empty string
15471 is substituted; if it is true, an error is generated. See section
15472 &<<SECTaclvariables>>& for details of ACL variables.
15473
15474 .option strip_excess_angle_brackets main boolean false
15475 .cindex "angle brackets, excess"
15476 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15477 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15478 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15479 passed on to another MTA, the excess angle brackets are not passed on. If this
15480 option is not set, multiple pairs of angle brackets cause a syntax error.
15481
15482
15483 .option strip_trailing_dot main boolean false
15484 .cindex "trailing dot on domain"
15485 .cindex "dot" "trailing on domain"
15486 If this option is set, a trailing dot at the end of a domain in an address is
15487 ignored. If this is in the envelope and the message is passed on to another
15488 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15489 domain causes a syntax error.
15490 However, addresses in header lines are checked only when an ACL requests header
15491 syntax checking.
15492
15493
15494 .option syslog_duplication main boolean true
15495 .cindex "syslog" "duplicate log lines; suppressing"
15496 When Exim is logging to syslog, it writes the log lines for its three
15497 separate logs at different syslog priorities so that they can in principle
15498 be separated on the logging hosts. Some installations do not require this
15499 separation, and in those cases, the duplication of certain log lines is a
15500 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15501 particular log line is written to syslog. For lines that normally go to
15502 both the main log and the reject log, the reject log version (possibly
15503 containing message header lines) is written, at LOG_NOTICE priority.
15504 Lines that normally go to both the main and the panic log are written at
15505 the LOG_ALERT priority.
15506
15507
15508 .option syslog_facility main string unset
15509 .cindex "syslog" "facility; setting"
15510 This option sets the syslog &"facility"& name, used when Exim is logging to
15511 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15512 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15513 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15514 details of Exim's logging.
15515
15516
15517
15518 .option syslog_processname main string &`exim`&
15519 .cindex "syslog" "process name; setting"
15520 This option sets the syslog &"ident"& name, used when Exim is logging to
15521 syslog. The value must be no longer than 32 characters. See chapter
15522 &<<CHAPlog>>& for details of Exim's logging.
15523
15524
15525
15526 .option syslog_timestamp main boolean true
15527 .cindex "syslog" "timestamps"
15528 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15529 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15530 details of Exim's logging.
15531
15532
15533 .option system_filter main string&!! unset
15534 .cindex "filter" "system filter"
15535 .cindex "system filter" "specifying"
15536 .cindex "Sieve filter" "not available for system filter"
15537 This option specifies an Exim filter file that is applied to all messages at
15538 the start of each delivery attempt, before any routing is done. System filters
15539 must be Exim filters; they cannot be Sieve filters. If the system filter
15540 generates any deliveries to files or pipes, or any new mail messages, the
15541 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15542 which transports are to be used. Details of this facility are given in chapter
15543 &<<CHAPsystemfilter>>&.
15544
15545
15546 .option system_filter_directory_transport main string&!! unset
15547 .vindex "&$address_file$&"
15548 This sets the name of the transport driver that is to be used when the
15549 &%save%& command in a system message filter specifies a path ending in &"/"&,
15550 implying delivery of each message into a separate file in some directory.
15551 During the delivery, the variable &$address_file$& contains the path name.
15552
15553
15554 .option system_filter_file_transport main string&!! unset
15555 .cindex "file" "transport for system filter"
15556 This sets the name of the transport driver that is to be used when the &%save%&
15557 command in a system message filter specifies a path not ending in &"/"&. During
15558 the delivery, the variable &$address_file$& contains the path name.
15559
15560 .option system_filter_group main string unset
15561 .cindex "gid (group id)" "system filter"
15562 This option is used only when &%system_filter_user%& is also set. It sets the
15563 gid under which the system filter is run, overriding any gid that is associated
15564 with the user. The value may be numerical or symbolic.
15565
15566 .option system_filter_pipe_transport main string&!! unset
15567 .cindex "&(pipe)& transport" "for system filter"
15568 .vindex "&$address_pipe$&"
15569 This specifies the transport driver that is to be used when a &%pipe%& command
15570 is used in a system filter. During the delivery, the variable &$address_pipe$&
15571 contains the pipe command.
15572
15573
15574 .option system_filter_reply_transport main string&!! unset
15575 .cindex "&(autoreply)& transport" "for system filter"
15576 This specifies the transport driver that is to be used when a &%mail%& command
15577 is used in a system filter.
15578
15579
15580 .option system_filter_user main string unset
15581 .cindex "uid (user id)" "system filter"
15582 If this option is set to root, the system filter is run in the main Exim
15583 delivery process, as root.  Otherwise, the system filter runs in a separate
15584 process, as the given user, defaulting to the Exim run-time user.
15585 Unless the string consists entirely of digits, it
15586 is looked up in the password data. Failure to find the named user causes a
15587 configuration error. The gid is either taken from the password data, or
15588 specified by &%system_filter_group%&. When the uid is specified numerically,
15589 &%system_filter_group%& is required to be set.
15590
15591 If the system filter generates any pipe, file, or reply deliveries, the uid
15592 under which the filter is run is used when transporting them, unless a
15593 transport option overrides.
15594
15595
15596 .option tcp_nodelay main boolean true
15597 .cindex "daemon" "TCP_NODELAY on sockets"
15598 .cindex "Nagle algorithm"
15599 .cindex "TCP_NODELAY on listening sockets"
15600 If this option is set false, it stops the Exim daemon setting the
15601 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15602 turns off the &"Nagle algorithm"&, which is a way of improving network
15603 performance in interactive (character-by-character) situations. Turning it off
15604 should improve Exim's performance a bit, so that is what happens by default.
15605 However, it appears that some broken clients cannot cope, and time out. Hence
15606 this option. It affects only those sockets that are set up for listening by the
15607 daemon. Sockets created by the smtp transport for delivering mail always set
15608 TCP_NODELAY.
15609
15610
15611 .option timeout_frozen_after main time 0s
15612 .cindex "frozen messages" "timing out"
15613 .cindex "timeout" "frozen messages"
15614 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15615 message of any kind that has been on the queue for longer than the given time
15616 is automatically cancelled at the next queue run. If the frozen message is a
15617 bounce message, it is just discarded; otherwise, a bounce is sent to the
15618 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15619 If you want to timeout frozen bounce messages earlier than other kinds of
15620 frozen message, see &%ignore_bounce_errors_after%&.
15621
15622 &*Note:*& the default value of zero means no timeouts; with this setting,
15623 frozen messages remain on the queue forever (except for any frozen bounce
15624 messages that are released by &%ignore_bounce_errors_after%&).
15625
15626
15627 .option timezone main string unset
15628 .cindex "timezone, setting"
15629 The value of &%timezone%& is used to set the environment variable TZ while
15630 running Exim (if it is different on entry). This ensures that all timestamps
15631 created by Exim are in the required timezone. If you want all your timestamps
15632 to be in UTC (aka GMT) you should set
15633 .code
15634 timezone = UTC
15635 .endd
15636 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15637 or, if that is not set, from the value of the TZ environment variable when Exim
15638 is built. If &%timezone%& is set to the empty string, either at build or run
15639 time, any existing TZ variable is removed from the environment when Exim
15640 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15641 unfortunately not all, operating systems.
15642
15643
15644 .option tls_advertise_hosts main "host list&!!" unset
15645 .cindex "TLS" "advertising"
15646 .cindex "encryption" "on SMTP connection"
15647 .cindex "SMTP" "encrypted connection"
15648 When Exim is built with support for TLS encrypted connections, the availability
15649 of the STARTTLS command to set up an encrypted session is advertised in
15650 response to EHLO only to those client hosts that match this option. See
15651 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15652
15653
15654 .option tls_certificate main string&!! unset
15655 .cindex "TLS" "server certificate; location of"
15656 .cindex "certificate" "server, location of"
15657 The value of this option is expanded, and must then be the absolute path to a
15658 file which contains the server's certificates. The server's private key is also
15659 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15660 &<<CHAPTLS>>& for further details.
15661
15662 &*Note*&: The certificates defined by this option are used only when Exim is
15663 receiving incoming messages as a server. If you want to supply certificates for
15664 use when sending messages as a client, you must set the &%tls_certificate%&
15665 option in the relevant &(smtp)& transport.
15666
15667 .new
15668 If the option contains &$tls_sni$& and Exim is built against OpenSSL, then
15669 if the OpenSSL build supports TLS extensions and the TLS client sends the
15670 Server Name Indication extension, then this option and others documented in
15671 &<<SECTtlssni>>& will be re-expanded.
15672 .wen
15673
15674 .option tls_crl main string&!! unset
15675 .cindex "TLS" "server certificate revocation list"
15676 .cindex "certificate" "revocation list for server"
15677 This option specifies a certificate revocation list. The expanded value must
15678 be the name of a file that contains a CRL in PEM format.
15679
15680 .new
15681 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15682 .wen
15683
15684
15685 .option tls_dhparam main string&!! unset
15686 .cindex "TLS" "D-H parameters for server"
15687 The value of this option is expanded, and must then be the absolute path to
15688 a file which contains the server's DH parameter values.
15689 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15690 ignored. See section &<<SECTopenvsgnu>>& for further details.
15691
15692
15693 .option tls_on_connect_ports main "string list" unset
15694 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15695 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15696 set up without waiting for the client to issue a STARTTLS command. For
15697 further details, see section &<<SECTsupobssmt>>&.
15698
15699
15700
15701 .option tls_privatekey main string&!! unset
15702 .cindex "TLS" "server private key; location of"
15703 The value of this option is expanded, and must then be the absolute path to a
15704 file which contains the server's private key. If this option is unset, or if
15705 the expansion is forced to fail, or the result is an empty string, the private
15706 key is assumed to be in the same file as the server's certificates. See chapter
15707 &<<CHAPTLS>>& for further details.
15708
15709 .new
15710 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15711 .wen
15712
15713
15714 .option tls_remember_esmtp main boolean false
15715 .cindex "TLS" "esmtp state; remembering"
15716 .cindex "TLS" "broken clients"
15717 If this option is set true, Exim violates the RFCs by remembering that it is in
15718 &"esmtp"& state after successfully negotiating a TLS session. This provides
15719 support for broken clients that fail to send a new EHLO after starting a
15720 TLS session.
15721
15722
15723 .option tls_require_ciphers main string&!! unset
15724 .cindex "TLS" "requiring specific ciphers"
15725 .cindex "cipher" "requiring specific"
15726 This option controls which ciphers can be used for incoming TLS connections.
15727 The &(smtp)& transport has an option of the same name for controlling outgoing
15728 connections. This option is expanded for each connection, so can be varied for
15729 different clients if required. The value of this option must be a list of
15730 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15731 in somewhat different ways. If GnuTLS is being used, the client controls the
15732 preference order of the available ciphers. Details are given in sections
15733 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15734
15735
15736 .option tls_try_verify_hosts main "host list&!!" unset
15737 .cindex "TLS" "client certificate verification"
15738 .cindex "certificate" "verification of client"
15739 See &%tls_verify_hosts%& below.
15740
15741
15742 .option tls_verify_certificates main string&!! unset
15743 .cindex "TLS" "client certificate verification"
15744 .cindex "certificate" "verification of client"
15745 The value of this option is expanded, and must then be the absolute path to
15746 a file containing permitted certificates for clients that
15747 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15748 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15749 directory containing certificate files. This does not work with GnuTLS; the
15750 option must be set to the name of a single file if you are using GnuTLS.
15751
15752 These certificates should be for the certificate authorities trusted, rather
15753 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
15754 the value is a file then the certificates are sent by Exim as a server to
15755 connecting clients, defining the list of accepted certificate authorities.
15756 Thus the values defined should be considered public data.  To avoid this,
15757 use OpenSSL with a directory.
15758
15759 .new
15760 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15761 .wen
15762
15763
15764 .option tls_verify_hosts main "host list&!!" unset
15765 .cindex "TLS" "client certificate verification"
15766 .cindex "certificate" "verification of client"
15767 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15768 certificates from clients. The expected certificates are defined by
15769 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15770 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15771 &%tls_verify_certificates%& is not set.
15772
15773 Any client that matches &%tls_verify_hosts%& is constrained by
15774 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15775 present one of the listed certificates. If it does not, the connection is
15776 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15777 the host to use TLS. It can still send SMTP commands through unencrypted
15778 connections. Forcing a client to use TLS has to be done separately using an
15779 ACL to reject inappropriate commands when the connection is not encrypted.
15780
15781 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15782 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15783 certificate and checks it against &%tls_verify_certificates%&, but does not
15784 abort the connection if there is no certificate or if it does not match. This
15785 state can be detected in an ACL, which makes it possible to implement policies
15786 such as &"accept for relay only if a verified certificate has been received,
15787 but accept for local delivery if encrypted, even without a verified
15788 certificate"&.
15789
15790 Client hosts that match neither of these lists are not asked to present
15791 certificates.
15792
15793
15794 .option trusted_groups main "string list&!!" unset
15795 .cindex "trusted groups"
15796 .cindex "groups" "trusted"
15797 This option is expanded just once, at the start of Exim's processing. If this
15798 option is set, any process that is running in one of the listed groups, or
15799 which has one of them as a supplementary group, is trusted. The groups can be
15800 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15801 details of what trusted callers are permitted to do. If neither
15802 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15803 are trusted.
15804
15805 .option trusted_users main "string list&!!" unset
15806 .cindex "trusted users"
15807 .cindex "user" "trusted"
15808 This option is expanded just once, at the start of Exim's processing. If this
15809 option is set, any process that is running as one of the listed users is
15810 trusted. The users can be specified numerically or by name. See section
15811 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15812 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15813 Exim user are trusted.
15814
15815 .option unknown_login main string&!! unset
15816 .cindex "uid (user id)" "unknown caller"
15817 .vindex "&$caller_uid$&"
15818 This is a specialized feature for use in unusual configurations. By default, if
15819 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15820 gives up. The &%unknown_login%& option can be used to set a login name to be
15821 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15822 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15823 is used for the user's real name (gecos field), unless this has been set by the
15824 &%-F%& option.
15825
15826 .option unknown_username main string unset
15827 See &%unknown_login%&.
15828
15829 .option untrusted_set_sender main "address list&!!" unset
15830 .cindex "trusted users"
15831 .cindex "sender" "setting by untrusted user"
15832 .cindex "untrusted user setting sender"
15833 .cindex "user" "untrusted setting sender"
15834 .cindex "envelope sender"
15835 When an untrusted user submits a message to Exim using the standard input, Exim
15836 normally creates an envelope sender address from the user's login and the
15837 default qualification domain. Data from the &%-f%& option (for setting envelope
15838 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15839 is used) is ignored.
15840
15841 However, untrusted users are permitted to set an empty envelope sender address,
15842 to declare that a message should never generate any bounces. For example:
15843 .code
15844 exim -f '<>' user@domain.example
15845 .endd
15846 .vindex "&$sender_ident$&"
15847 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15848 other envelope sender addresses in a controlled way. When it is set, untrusted
15849 users are allowed to set envelope sender addresses that match any of the
15850 patterns in the list. Like all address lists, the string is expanded. The
15851 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15852 users to setting senders that start with their login ids
15853 followed by a hyphen
15854 by a setting like this:
15855 .code
15856 untrusted_set_sender = ^$sender_ident-
15857 .endd
15858 If you want to allow untrusted users to set envelope sender addresses without
15859 restriction, you can use
15860 .code
15861 untrusted_set_sender = *
15862 .endd
15863 The &%untrusted_set_sender%& option applies to all forms of local input, but
15864 only to the setting of the envelope sender. It does not permit untrusted users
15865 to use the other options which trusted user can use to override message
15866 parameters. Furthermore, it does not stop Exim from removing an existing
15867 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15868 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15869 overriding these actions. The handling of the &'Sender:'& header is also
15870 described in section &<<SECTthesenhea>>&.
15871
15872 The log line for a message's arrival shows the envelope sender following
15873 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15874 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15875 envelope sender address, the user's login is shown in parentheses after the
15876 sender address.
15877
15878
15879 .option uucp_from_pattern main string "see below"
15880 .cindex "&""From""& line"
15881 .cindex "UUCP" "&""From""& line"
15882 Some applications that pass messages to an MTA via a command line interface use
15883 an initial line starting with &"From&~"& to pass the envelope sender. In
15884 particular, this is used by UUCP software. Exim recognizes such a line by means
15885 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15886 matches, the sender address is constructed by expanding the contents of
15887 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15888 default pattern recognizes lines in the following two forms:
15889 .code
15890 From ph10 Fri Jan  5 12:35 GMT 1996
15891 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15892 .endd
15893 The pattern can be seen by running
15894 .code
15895 exim -bP uucp_from_pattern
15896 .endd
15897 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15898 year in the second case. The first word after &"From&~"& is matched in the
15899 regular expression by a parenthesized subpattern. The default value for
15900 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15901 (&"ph10"& in the example above) as the message's sender. See also
15902 &%ignore_fromline_hosts%&.
15903
15904
15905 .option uucp_from_sender main string&!! &`$1`&
15906 See &%uucp_from_pattern%& above.
15907
15908
15909 .option warn_message_file main string unset
15910 .cindex "warning of delay" "customizing the message"
15911 .cindex "customizing" "warning message"
15912 This option defines a template file containing paragraphs of text to be used
15913 for constructing the warning message which is sent by Exim when a message has
15914 been on the queue for a specified amount of time, as specified by
15915 &%delay_warning%&. Details of the file's contents are given in chapter
15916 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15917
15918
15919 .option write_rejectlog main boolean true
15920 .cindex "reject log" "disabling"
15921 If this option is set false, Exim no longer writes anything to the reject log.
15922 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15923 .ecindex IIDconfima
15924 .ecindex IIDmaiconf
15925
15926
15927
15928
15929 . ////////////////////////////////////////////////////////////////////////////
15930 . ////////////////////////////////////////////////////////////////////////////
15931
15932 .chapter "Generic options for routers" "CHAProutergeneric"
15933 .scindex IIDgenoprou1 "options" "generic; for routers"
15934 .scindex IIDgenoprou2 "generic options" "router"
15935 This chapter describes the generic options that apply to all routers.
15936 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15937
15938 For a general description of how a router operates, see sections
15939 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15940 which the preconditions are tested. The order of expansion of the options that
15941 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15942 &%headers_remove%&, &%transport%&.
15943
15944
15945
15946 .option address_data routers string&!! unset
15947 .cindex "router" "data attached to address"
15948 The string is expanded just before the router is run, that is, after all the
15949 precondition tests have succeeded. If the expansion is forced to fail, the
15950 router declines, the value of &%address_data%& remains unchanged, and the
15951 &%more%& option controls what happens next. Other expansion failures cause
15952 delivery of the address to be deferred.
15953
15954 .vindex "&$address_data$&"
15955 When the expansion succeeds, the value is retained with the address, and can be
15956 accessed using the variable &$address_data$& in the current router, subsequent
15957 routers, and the eventual transport.
15958
15959 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15960 that runs a user's filter file, the contents of &$address_data$& are accessible
15961 in the filter. This is not normally a problem, because such data is usually
15962 either not confidential or it &"belongs"& to the current user, but if you do
15963 put confidential data into &$address_data$& you need to remember this point.
15964
15965 Even if the router declines or passes, the value of &$address_data$& remains
15966 with the address, though it can be changed by another &%address_data%& setting
15967 on a subsequent router. If a router generates child addresses, the value of
15968 &$address_data$& propagates to them. This also applies to the special kind of
15969 &"child"& that is generated by a router with the &%unseen%& option.
15970
15971 The idea of &%address_data%& is that you can use it to look up a lot of data
15972 for the address once, and then pick out parts of the data later. For example,
15973 you could use a single LDAP lookup to return a string of the form
15974 .code
15975 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15976 .endd
15977 In the transport you could pick out the mailbox by a setting such as
15978 .code
15979 file = ${extract{mailbox}{$address_data}}
15980 .endd
15981 This makes the configuration file less messy, and also reduces the number of
15982 lookups (though Exim does cache lookups).
15983
15984 .vindex "&$sender_address_data$&"
15985 .vindex "&$address_data$&"
15986 The &%address_data%& facility is also useful as a means of passing information
15987 from one router to another, and from a router to a transport. In addition, if
15988 &$address_data$& is set by a router when verifying a recipient address from an
15989 ACL, it remains available for use in the rest of the ACL statement. After
15990 verifying a sender, the value is transferred to &$sender_address_data$&.
15991
15992
15993
15994 .option address_test routers&!? boolean true
15995 .oindex "&%-bt%&"
15996 .cindex "router" "skipping when address testing"
15997 If this option is set false, the router is skipped when routing is being tested
15998 by means of the &%-bt%& command line option. This can be a convenience when
15999 your first router sends messages to an external scanner, because it saves you
16000 having to set the &"already scanned"& indicator when testing real address
16001 routing.
16002
16003
16004
16005 .option cannot_route_message routers string&!! unset
16006 .cindex "router" "customizing &""cannot route""& message"
16007 .cindex "customizing" "&""cannot route""& message"
16008 This option specifies a text message that is used when an address cannot be
16009 routed because Exim has run out of routers. The default message is
16010 &"Unrouteable address"&. This option is useful only on routers that have
16011 &%more%& set false, or on the very last router in a configuration, because the
16012 value that is used is taken from the last router that is considered. This
16013 includes a router that is skipped because its preconditions are not met, as
16014 well as a router that declines. For example, using the default configuration,
16015 you could put:
16016 .code
16017 cannot_route_message = Remote domain not found in DNS
16018 .endd
16019 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16020 and
16021 .code
16022 cannot_route_message = Unknown local user
16023 .endd
16024 on the final router that checks for local users. If string expansion fails for
16025 this option, the default message is used. Unless the expansion failure was
16026 explicitly forced, a message about the failure is written to the main and panic
16027 logs, in addition to the normal message about the routing failure.
16028
16029
16030 .option caseful_local_part routers boolean false
16031 .cindex "case of local parts"
16032 .cindex "router" "case of local parts"
16033 By default, routers handle the local parts of addresses in a case-insensitive
16034 manner, though the actual case is preserved for transmission with the message.
16035 If you want the case of letters to be significant in a router, you must set
16036 this option true. For individual router options that contain address or local
16037 part lists (for example, &%local_parts%&), case-sensitive matching can be
16038 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16039 more details.
16040
16041 .vindex "&$local_part$&"
16042 .vindex "&$original_local_part$&"
16043 .vindex "&$parent_local_part$&"
16044 The value of the &$local_part$& variable is forced to lower case while a
16045 router is running unless &%caseful_local_part%& is set. When a router assigns
16046 an address to a transport, the value of &$local_part$& when the transport runs
16047 is the same as it was in the router. Similarly, when a router generates child
16048 addresses by aliasing or forwarding, the values of &$original_local_part$&
16049 and &$parent_local_part$& are those that were used by the redirecting router.
16050
16051 This option applies to the processing of an address by a router. When a
16052 recipient address is being processed in an ACL, there is a separate &%control%&
16053 modifier that can be used to specify case-sensitive processing within the ACL
16054 (see section &<<SECTcontrols>>&).
16055
16056
16057
16058 .option check_local_user routers&!? boolean false
16059 .cindex "local user, checking in router"
16060 .cindex "router" "checking for local user"
16061 .cindex "&_/etc/passwd_&"
16062 .vindex "&$home$&"
16063 When this option is true, Exim checks that the local part of the recipient
16064 address (with affixes removed if relevant) is the name of an account on the
16065 local system. The check is done by calling the &[getpwnam()]& function rather
16066 than trying to read &_/etc/passwd_& directly. This means that other methods of
16067 holding password data (such as NIS) are supported. If the local part is a local
16068 user, &$home$& is set from the password data, and can be tested in other
16069 preconditions that are evaluated after this one (the order of evaluation is
16070 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16071 overridden by &%router_home_directory%&. If the local part is not a local user,
16072 the router is skipped.
16073
16074 If you want to check that the local part is either the name of a local user
16075 or matches something else, you cannot combine &%check_local_user%& with a
16076 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16077 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16078 setting to achieve this. For example:
16079 .code
16080 local_parts = passwd;$local_part : lsearch;/etc/other/users
16081 .endd
16082 Note, however, that the side effects of &%check_local_user%& (such as setting
16083 up a home directory) do not occur when a &(passwd)& lookup is used in a
16084 &%local_parts%& (or any other) precondition.
16085
16086
16087
16088 .option condition routers&!? string&!! unset
16089 .cindex "router" "customized precondition"
16090 This option specifies a general precondition test that has to succeed for the
16091 router to be called. The &%condition%& option is the last precondition to be
16092 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16093 result is a forced failure, or an empty string, or one of the strings &"0"& or
16094 &"no"& or &"false"& (checked without regard to the case of the letters), the
16095 router is skipped, and the address is offered to the next one.
16096
16097 If the result is any other value, the router is run (as this is the last
16098 precondition to be evaluated, all the other preconditions must be true).
16099
16100 This option is unique in that multiple &%condition%& options may be present.
16101 All &%condition%& options must succeed.
16102
16103 The &%condition%& option provides a means of applying custom conditions to the
16104 running of routers. Note that in the case of a simple conditional expansion,
16105 the default expansion values are exactly what is wanted. For example:
16106 .code
16107 condition = ${if >{$message_age}{600}}
16108 .endd
16109 Because of the default behaviour of the string expansion, this is equivalent to
16110 .code
16111 condition = ${if >{$message_age}{600}{true}{}}
16112 .endd
16113
16114 A multiple condition example, which succeeds:
16115 .code
16116 condition = ${if >{$message_age}{600}}
16117 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16118 condition = foobar
16119 .endd
16120
16121 If the expansion fails (other than forced failure) delivery is deferred. Some
16122 of the other precondition options are common special cases that could in fact
16123 be specified using &%condition%&.
16124
16125
16126 .option debug_print routers string&!! unset
16127 .cindex "testing" "variables in drivers"
16128 If this option is set and debugging is enabled (see the &%-d%& command line
16129 option), the string is expanded and included in the debugging output.
16130 If expansion of the string fails, the error message is written to the debugging
16131 output, and Exim carries on processing.
16132 This option is provided to help with checking out the values of variables and
16133 so on when debugging router configurations. For example, if a &%condition%&
16134 option appears not to be working, &%debug_print%& can be used to output the
16135 variables it references. The output happens after checks for &%domains%&,
16136 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16137 are tested. A newline is added to the text if it does not end with one.
16138
16139
16140
16141 .option disable_logging routers boolean false
16142 If this option is set true, nothing is logged for any routing errors
16143 or for any deliveries caused by this router. You should not set this option
16144 unless you really, really know what you are doing. See also the generic
16145 transport option of the same name.
16146
16147
16148 .option domains routers&!? "domain list&!!" unset
16149 .cindex "router" "restricting to specific domains"
16150 .vindex "&$domain_data$&"
16151 If this option is set, the router is skipped unless the current domain matches
16152 the list. If the match is achieved by means of a file lookup, the data that the
16153 lookup returned for the domain is placed in &$domain_data$& for use in string
16154 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16155 a list of the order in which preconditions are evaluated.
16156
16157
16158
16159 .option driver routers string unset
16160 This option must always be set. It specifies which of the available routers is
16161 to be used.
16162
16163
16164
16165 .option errors_to routers string&!! unset
16166 .cindex "envelope sender"
16167 .cindex "router" "changing address for errors"
16168 If a router successfully handles an address, it may assign the address to a
16169 transport for delivery or it may generate child addresses. In both cases, if
16170 there is a delivery problem during later processing, the resulting bounce
16171 message is sent to the address that results from expanding this string,
16172 provided that the address verifies successfully. The &%errors_to%& option is
16173 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16174
16175 The &%errors_to%& setting associated with an address can be overridden if it
16176 subsequently passes through other routers that have their own &%errors_to%&
16177 settings, or if the message is delivered by a transport with a &%return_path%&
16178 setting.
16179
16180 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16181 the expansion fails to verify, the errors address associated with the incoming
16182 address is used. At top level, this is the envelope sender. A non-forced
16183 expansion failure causes delivery to be deferred.
16184
16185 If an address for which &%errors_to%& has been set ends up being delivered over
16186 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16187 any bounces that are generated by other MTAs on the delivery route are also
16188 sent there. You can set &%errors_to%& to the empty string by either of these
16189 settings:
16190 .code
16191 errors_to =
16192 errors_to = ""
16193 .endd
16194 An expansion item that yields an empty string has the same effect. If you do
16195 this, a locally detected delivery error for addresses processed by this router
16196 no longer gives rise to a bounce message; the error is discarded. If the
16197 address is delivered to a remote host, the return path is set to &`<>`&, unless
16198 overridden by the &%return_path%& option on the transport.
16199
16200 .vindex "&$address_data$&"
16201 If for some reason you want to discard local errors, but use a non-empty
16202 MAIL command for remote delivery, you can preserve the original return
16203 path in &$address_data$& in the router, and reinstate it in the transport by
16204 setting &%return_path%&.
16205
16206 The most common use of &%errors_to%& is to direct mailing list bounces to the
16207 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16208 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16209
16210
16211
16212 .option expn routers&!? boolean true
16213 .cindex "address" "testing"
16214 .cindex "testing" "addresses"
16215 .cindex "EXPN" "router skipping"
16216 .cindex "router" "skipping for EXPN"
16217 If this option is turned off, the router is skipped when testing an address
16218 as a result of processing an SMTP EXPN command. You might, for example,
16219 want to turn it off on a router for users' &_.forward_& files, while leaving it
16220 on for the system alias file.
16221 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16222 are evaluated.
16223
16224 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16225 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16226 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16227
16228
16229
16230 .option fail_verify routers boolean false
16231 .cindex "router" "forcing verification failure"
16232 Setting this option has the effect of setting both &%fail_verify_sender%& and
16233 &%fail_verify_recipient%& to the same value.
16234
16235
16236
16237 .option fail_verify_recipient routers boolean false
16238 If this option is true and an address is accepted by this router when
16239 verifying a recipient, verification fails.
16240
16241
16242
16243 .option fail_verify_sender routers boolean false
16244 If this option is true and an address is accepted by this router when
16245 verifying a sender, verification fails.
16246
16247
16248
16249 .option fallback_hosts routers "string list" unset
16250 .cindex "router" "fallback hosts"
16251 .cindex "fallback" "hosts specified on router"
16252 String expansion is not applied to this option. The argument must be a
16253 colon-separated list of host names or IP addresses. The list separator can be
16254 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16255 each name or address. In fact, the format of each item is exactly the same as
16256 defined for the list of hosts in a &(manualroute)& router (see section
16257 &<<SECTformatonehostitem>>&).
16258
16259 If a router queues an address for a remote transport, this host list is
16260 associated with the address, and used instead of the transport's fallback host
16261 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16262 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16263 transport for further details.
16264
16265
16266 .option group routers string&!! "see below"
16267 .cindex "gid (group id)" "local delivery"
16268 .cindex "local transports" "uid and gid"
16269 .cindex "transport" "local"
16270 .cindex "router" "setting group"
16271 When a router queues an address for a transport, and the transport does not
16272 specify a group, the group given here is used when running the delivery
16273 process.
16274 The group may be specified numerically or by name. If expansion fails, the
16275 error is logged and delivery is deferred.
16276 The default is unset, unless &%check_local_user%& is set, when the default
16277 is taken from the password information. See also &%initgroups%& and &%user%&
16278 and the discussion in chapter &<<CHAPenvironment>>&.
16279
16280
16281
16282 .option headers_add routers string&!! unset
16283 .cindex "header lines" "adding"
16284 .cindex "router" "adding header lines"
16285 This option specifies a string of text that is expanded at routing time, and
16286 associated with any addresses that are accepted by the router. However, this
16287 option has no effect when an address is just being verified. The way in which
16288 the text is used to add header lines at transport time is described in section
16289 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16290 message is in the process of being transported. This means that references to
16291 header lines in string expansions in the transport's configuration do not
16292 &"see"& the added header lines.
16293
16294 The &%headers_add%& option is expanded after &%errors_to%&, but before
16295 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16296 the expansion is forced to fail, the option has no effect. Other expansion
16297 failures are treated as configuration errors.
16298
16299 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16300 router that has the &%one_time%& option set.
16301
16302 .cindex "duplicate addresses"
16303 .oindex "&%unseen%&"
16304 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16305 additions are deleted when the address is passed on to subsequent routers.
16306 For a &%redirect%& router, if a generated address is the same as the incoming
16307 address, this can lead to duplicate addresses with different header
16308 modifications. Exim does not do duplicate deliveries (except, in certain
16309 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16310 which of the duplicates is discarded, so this ambiguous situation should be
16311 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16312
16313
16314
16315 .option headers_remove routers string&!! unset
16316 .cindex "header lines" "removing"
16317 .cindex "router" "removing header lines"
16318 This option specifies a string of text that is expanded at routing time, and
16319 associated with any addresses that are accepted by the router. However, this
16320 option has no effect when an address is just being verified. The way in which
16321 the text is used to remove header lines at transport time is described in
16322 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16323 the message is in the process of being transported. This means that references
16324 to header lines in string expansions in the transport's configuration still
16325 &"see"& the original header lines.
16326
16327 The &%headers_remove%& option is expanded after &%errors_to%& and
16328 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16329 the option has no effect. Other expansion failures are treated as configuration
16330 errors.
16331
16332 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16333 router that has the &%one_time%& option set.
16334
16335 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16336 removal requests are deleted when the address is passed on to subsequent
16337 routers, and this can lead to problems with duplicates -- see the similar
16338 warning for &%headers_add%& above.
16339
16340
16341 .option ignore_target_hosts routers "host list&!!" unset
16342 .cindex "IP address" "discarding"
16343 .cindex "router" "discarding IP addresses"
16344 Although this option is a host list, it should normally contain IP address
16345 entries rather than names. If any host that is looked up by the router has an
16346 IP address that matches an item in this list, Exim behaves as if that IP
16347 address did not exist. This option allows you to cope with rogue DNS entries
16348 like
16349 .code
16350 remote.domain.example.  A  127.0.0.1
16351 .endd
16352 by setting
16353 .code
16354 ignore_target_hosts = 127.0.0.1
16355 .endd
16356 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16357 discarded in this way, the router declines. In a conventional configuration, an
16358 attempt to mail to such a domain would normally provoke the &"unrouteable
16359 domain"& error, and an attempt to verify an address in the domain would fail.
16360 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16361 router declines if presented with one of the listed addresses.
16362
16363 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16364 means of the first or the second of the following settings, respectively:
16365 .code
16366 ignore_target_hosts = 0.0.0.0/0
16367 ignore_target_hosts = <; 0::0/0
16368 .endd
16369 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16370 in the second line matches all IPv6 addresses.
16371
16372 This option may also be useful for ignoring link-local and site-local IPv6
16373 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16374 is expanded before use as a list, it is possible to make it dependent on the
16375 domain that is being routed.
16376
16377 .vindex "&$host_address$&"
16378 During its expansion, &$host_address$& is set to the IP address that is being
16379 checked.
16380
16381 .option initgroups routers boolean false
16382 .cindex "additional groups"
16383 .cindex "groups" "additional"
16384 .cindex "local transports" "uid and gid"
16385 .cindex "transport" "local"
16386 If the router queues an address for a transport, and this option is true, and
16387 the uid supplied by the router is not overridden by the transport, the
16388 &[initgroups()]& function is called when running the transport to ensure that
16389 any additional groups associated with the uid are set up. See also &%group%&
16390 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16391
16392
16393
16394 .option local_part_prefix routers&!? "string list" unset
16395 .cindex "router" "prefix for local part"
16396 .cindex "prefix" "for local part, used in router"
16397 If this option is set, the router is skipped unless the local part starts with
16398 one of the given strings, or &%local_part_prefix_optional%& is true. See
16399 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16400 evaluated.
16401
16402 The list is scanned from left to right, and the first prefix that matches is
16403 used. A limited form of wildcard is available; if the prefix begins with an
16404 asterisk, it matches the longest possible sequence of arbitrary characters at
16405 the start of the local part. An asterisk should therefore always be followed by
16406 some character that does not occur in normal local parts.
16407 .cindex "multiple mailboxes"
16408 .cindex "mailbox" "multiple"
16409 Wildcarding can be used to set up multiple user mailboxes, as described in
16410 section &<<SECTmulbox>>&.
16411
16412 .vindex "&$local_part$&"
16413 .vindex "&$local_part_prefix$&"
16414 During the testing of the &%local_parts%& option, and while the router is
16415 running, the prefix is removed from the local part, and is available in the
16416 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16417 the router accepts the address, this remains true during subsequent delivery by
16418 a transport. In particular, the local part that is transmitted in the RCPT
16419 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16420 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16421 the relevant transport.
16422
16423 When an address is being verified, &%local_part_prefix%& affects only the
16424 behaviour of the router. If the callout feature of verification is in use, this
16425 means that the full address, including the prefix, will be used during the
16426 callout.
16427
16428 The prefix facility is commonly used to handle local parts of the form
16429 &%owner-something%&. Another common use is to support local parts of the form
16430 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16431 to tell a user their forwarding is broken &-- by placing a router like this one
16432 immediately before the router that handles &_.forward_& files:
16433 .code
16434 real_localuser:
16435   driver = accept
16436   local_part_prefix = real-
16437   check_local_user
16438   transport = local_delivery
16439 .endd
16440 For security, it would probably be a good idea to restrict the use of this
16441 router to locally-generated messages, using a condition such as this:
16442 .code
16443   condition = ${if match {$sender_host_address}\
16444                          {\N^(|127\.0\.0\.1)$\N}}
16445 .endd
16446
16447 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16448 both conditions must be met if not optional. Care must be taken if wildcards
16449 are used in both a prefix and a suffix on the same router. Different
16450 separator characters must be used to avoid ambiguity.
16451
16452
16453 .option local_part_prefix_optional routers boolean false
16454 See &%local_part_prefix%& above.
16455
16456
16457
16458 .option local_part_suffix routers&!? "string list" unset
16459 .cindex "router" "suffix for local part"
16460 .cindex "suffix for local part" "used in router"
16461 This option operates in the same way as &%local_part_prefix%&, except that the
16462 local part must end (rather than start) with the given string, the
16463 &%local_part_suffix_optional%& option determines whether the suffix is
16464 mandatory, and the wildcard * character, if present, must be the last
16465 character of the suffix. This option facility is commonly used to handle local
16466 parts of the form &%something-request%& and multiple user mailboxes of the form
16467 &%username-foo%&.
16468
16469
16470 .option local_part_suffix_optional routers boolean false
16471 See &%local_part_suffix%& above.
16472
16473
16474
16475 .option local_parts routers&!? "local part list&!!" unset
16476 .cindex "router" "restricting to specific local parts"
16477 .cindex "local part" "checking in router"
16478 The router is run only if the local part of the address matches the list.
16479 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16480 are evaluated, and
16481 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16482 string is expanded, it is possible to make it depend on the domain, for
16483 example:
16484 .code
16485 local_parts = dbm;/usr/local/specials/$domain
16486 .endd
16487 .vindex "&$local_part_data$&"
16488 If the match is achieved by a lookup, the data that the lookup returned
16489 for the local part is placed in the variable &$local_part_data$& for use in
16490 expansions of the router's private options. You might use this option, for
16491 example, if you have a large number of local virtual domains, and you want to
16492 send all postmaster mail to the same place without having to set up an alias in
16493 each virtual domain:
16494 .code
16495 postmaster:
16496   driver = redirect
16497   local_parts = postmaster
16498   data = postmaster@real.domain.example
16499 .endd
16500
16501
16502 .option log_as_local routers boolean "see below"
16503 .cindex "log" "delivery line"
16504 .cindex "delivery" "log line format"
16505 Exim has two logging styles for delivery, the idea being to make local
16506 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16507 recipient address is given just as the local part, without a domain. The use of
16508 this style is controlled by this option. It defaults to true for the &(accept)&
16509 router, and false for all the others. This option applies only when a
16510 router assigns an address to a transport. It has no effect on routers that
16511 redirect addresses.
16512
16513
16514
16515 .option more routers boolean&!! true
16516 The result of string expansion for this option must be a valid boolean value,
16517 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16518 result causes an error, and delivery is deferred. If the expansion is forced to
16519 fail, the default value for the option (true) is used. Other failures cause
16520 delivery to be deferred.
16521
16522 If this option is set false, and the router declines to handle the address, no
16523 further routers are tried, routing fails, and the address is bounced.
16524 .oindex "&%self%&"
16525 However, if the router explicitly passes an address to the following router by
16526 means of the setting
16527 .code
16528 self = pass
16529 .endd
16530 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16531 does not affect the behaviour if one of the precondition tests fails. In that
16532 case, the address is always passed to the next router.
16533
16534 Note that &%address_data%& is not considered to be a precondition. If its
16535 expansion is forced to fail, the router declines, and the value of &%more%&
16536 controls what happens next.
16537
16538
16539 .option pass_on_timeout routers boolean false
16540 .cindex "timeout" "of router"
16541 .cindex "router" "timeout"
16542 If a router times out during a host lookup, it normally causes deferral of the
16543 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16544 router, overriding &%no_more%&. This may be helpful for systems that are
16545 intermittently connected to the Internet, or those that want to pass to a smart
16546 host any messages that cannot immediately be delivered.
16547
16548 There are occasional other temporary errors that can occur while doing DNS
16549 lookups. They are treated in the same way as a timeout, and this option
16550 applies to all of them.
16551
16552
16553
16554 .option pass_router routers string unset
16555 .cindex "router" "go to after &""pass""&"
16556 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16557 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16558 routing to continue, and overriding a false setting of &%more%&. When one of
16559 these routers returns &"pass"&, the address is normally handed on to the next
16560 router in sequence. This can be changed by setting &%pass_router%& to the name
16561 of another router. However (unlike &%redirect_router%&) the named router must
16562 be below the current router, to avoid loops. Note that this option applies only
16563 to the special case of &"pass"&. It does not apply when a router returns
16564 &"decline"& because it cannot handle an address.
16565
16566
16567
16568 .option redirect_router routers string unset
16569 .cindex "router" "start at after redirection"
16570 Sometimes an administrator knows that it is pointless to reprocess addresses
16571 generated from alias or forward files with the same router again. For
16572 example, if an alias file translates real names into login ids there is no
16573 point searching the alias file a second time, especially if it is a large file.
16574
16575 The &%redirect_router%& option can be set to the name of any router instance.
16576 It causes the routing of any generated addresses to start at the named router
16577 instead of at the first router. This option has no effect if the router in
16578 which it is set does not generate new addresses.
16579
16580
16581
16582 .option require_files routers&!? "string list&!!" unset
16583 .cindex "file" "requiring for router"
16584 .cindex "router" "requiring file existence"
16585 This option provides a general mechanism for predicating the running of a
16586 router on the existence or non-existence of certain files or directories.
16587 Before running a router, as one of its precondition tests, Exim works its way
16588 through the &%require_files%& list, expanding each item separately.
16589
16590 Because the list is split before expansion, any colons in expansion items must
16591 be doubled, or the facility for using a different list separator must be used.
16592 If any expansion is forced to fail, the item is ignored. Other expansion
16593 failures cause routing of the address to be deferred.
16594
16595 If any expanded string is empty, it is ignored. Otherwise, except as described
16596 below, each string must be a fully qualified file path, optionally preceded by
16597 &"!"&. The paths are passed to the &[stat()]& function to test for the
16598 existence of the files or directories. The router is skipped if any paths not
16599 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16600
16601 .cindex "NFS"
16602 If &[stat()]& cannot determine whether a file exists or not, delivery of
16603 the message is deferred. This can happen when NFS-mounted filesystems are
16604 unavailable.
16605
16606 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16607 options, so you cannot use it to check for the existence of a file in which to
16608 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16609 full list of the order in which preconditions are evaluated.) However, as
16610 these options are all expanded, you can use the &%exists%& expansion condition
16611 to make such tests. The &%require_files%& option is intended for checking files
16612 that the router may be going to use internally, or which are needed by a
16613 transport (for example &_.procmailrc_&).
16614
16615 During delivery, the &[stat()]& function is run as root, but there is a
16616 facility for some checking of the accessibility of a file by another user.
16617 This is not a proper permissions check, but just a &"rough"& check that
16618 operates as follows:
16619
16620 If an item in a &%require_files%& list does not contain any forward slash
16621 characters, it is taken to be the user (and optional group, separated by a
16622 comma) to be checked for subsequent files in the list. If no group is specified
16623 but the user is specified symbolically, the gid associated with the uid is
16624 used. For example:
16625 .code
16626 require_files = mail:/some/file
16627 require_files = $local_part:$home/.procmailrc
16628 .endd
16629 If a user or group name in a &%require_files%& list does not exist, the
16630 &%require_files%& condition fails.
16631
16632 Exim performs the check by scanning along the components of the file path, and
16633 checking the access for the given uid and gid. It checks for &"x"& access on
16634 directories, and &"r"& access on the final file. Note that this means that file
16635 access control lists, if the operating system has them, are ignored.
16636
16637 &*Warning 1*&: When the router is being run to verify addresses for an
16638 incoming SMTP message, Exim is not running as root, but under its own uid. This
16639 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16640 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16641 user is not permitted to read one of the directories on the file's path.
16642
16643 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16644 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16645 without root access. In this case, if a check for access by a particular user
16646 is requested, Exim creates a subprocess that runs as that user, and tries the
16647 check again in that process.
16648
16649 The default action for handling an unresolved EACCES is to consider it to
16650 be caused by a configuration error, and routing is deferred because the
16651 existence or non-existence of the file cannot be determined. However, in some
16652 circumstances it may be desirable to treat this condition as if the file did
16653 not exist. If the file name (or the exclamation mark that precedes the file
16654 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16655 as if the file did not exist. For example:
16656 .code
16657 require_files = +/some/file
16658 .endd
16659 If the router is not an essential part of verification (for example, it
16660 handles users' &_.forward_& files), another solution is to set the &%verify%&
16661 option false so that the router is skipped when verifying.
16662
16663
16664
16665 .option retry_use_local_part routers boolean "see below"
16666 .cindex "hints database" "retry keys"
16667 .cindex "local part" "in retry keys"
16668 When a delivery suffers a temporary routing failure, a retry record is created
16669 in Exim's hints database. For addresses whose routing depends only on the
16670 domain, the key for the retry record should not involve the local part, but for
16671 other addresses, both the domain and the local part should be included.
16672 Usually, remote routing is of the former kind, and local routing is of the
16673 latter kind.
16674
16675 This option controls whether the local part is used to form the key for retry
16676 hints for addresses that suffer temporary errors while being handled by this
16677 router. The default value is true for any router that has &%check_local_user%&
16678 set, and false otherwise. Note that this option does not apply to hints keys
16679 for transport delays; they are controlled by a generic transport option of the
16680 same name.
16681
16682 The setting of &%retry_use_local_part%& applies only to the router on which it
16683 appears. If the router generates child addresses, they are routed
16684 independently; this setting does not become attached to them.
16685
16686
16687
16688 .option router_home_directory routers string&!! unset
16689 .cindex "router" "home directory for"
16690 .cindex "home directory" "for router"
16691 .vindex "&$home$&"
16692 This option sets a home directory for use while the router is running. (Compare
16693 &%transport_home_directory%&, which sets a home directory for later
16694 transporting.) In particular, if used on a &(redirect)& router, this option
16695 sets a value for &$home$& while a filter is running. The value is expanded;
16696 forced expansion failure causes the option to be ignored &-- other failures
16697 cause the router to defer.
16698
16699 Expansion of &%router_home_directory%& happens immediately after the
16700 &%check_local_user%& test (if configured), before any further expansions take
16701 place.
16702 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16703 are evaluated.)
16704 While the router is running, &%router_home_directory%& overrides the value of
16705 &$home$& that came from &%check_local_user%&.
16706
16707 When a router accepts an address and assigns it to a local transport (including
16708 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16709 delivery), the home directory setting for the transport is taken from the first
16710 of these values that is set:
16711
16712 .ilist
16713 The &%home_directory%& option on the transport;
16714 .next
16715 The &%transport_home_directory%& option on the router;
16716 .next
16717 The password data if &%check_local_user%& is set on the router;
16718 .next
16719 The &%router_home_directory%& option on the router.
16720 .endlist
16721
16722 In other words, &%router_home_directory%& overrides the password data for the
16723 router, but not for the transport.
16724
16725
16726
16727 .option self routers string freeze
16728 .cindex "MX record" "pointing to local host"
16729 .cindex "local host" "MX pointing to"
16730 This option applies to those routers that use a recipient address to find a
16731 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16732 and &(manualroute)& routers.
16733 Certain configurations of the &(queryprogram)& router can also specify a list
16734 of remote hosts.
16735 Usually such routers are configured to send the message to a remote host via an
16736 &(smtp)& transport. The &%self%& option specifies what happens when the first
16737 host on the list turns out to be the local host.
16738 The way in which Exim checks for the local host is described in section
16739 &<<SECTreclocipadd>>&.
16740
16741 Normally this situation indicates either an error in Exim's configuration (for
16742 example, the router should be configured not to process this domain), or an
16743 error in the DNS (for example, the MX should not point to this host). For this
16744 reason, the default action is to log the incident, defer the address, and
16745 freeze the message. The following alternatives are provided for use in special
16746 cases:
16747
16748 .vlist
16749 .vitem &%defer%&
16750 Delivery of the message is tried again later, but the message is not frozen.
16751
16752 .vitem "&%reroute%&: <&'domain'&>"
16753 The domain is changed to the given domain, and the address is passed back to
16754 be reprocessed by the routers. No rewriting of headers takes place. This
16755 behaviour is essentially a redirection.
16756
16757 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16758 The domain is changed to the given domain, and the address is passed back to be
16759 reprocessed by the routers. Any headers that contain the original domain are
16760 rewritten.
16761
16762 .vitem &%pass%&
16763 .oindex "&%more%&"
16764 .vindex "&$self_hostname$&"
16765 The router passes the address to the next router, or to the router named in the
16766 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16767 subsequent routing and delivery, the variable &$self_hostname$& contains the
16768 name of the local host that the router encountered. This can be used to
16769 distinguish between different cases for hosts with multiple names. The
16770 combination
16771 .code
16772 self = pass
16773 no_more
16774 .endd
16775 ensures that only those addresses that routed to the local host are passed on.
16776 Without &%no_more%&, addresses that were declined for other reasons would also
16777 be passed to the next router.
16778
16779 .vitem &%fail%&
16780 Delivery fails and an error report is generated.
16781
16782 .vitem &%send%&
16783 .cindex "local host" "sending to"
16784 The anomaly is ignored and the address is queued for the transport. This
16785 setting should be used with extreme caution. For an &(smtp)& transport, it
16786 makes sense only in cases where the program that is listening on the SMTP port
16787 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16788 different configuration file that handles the domain in another way.
16789 .endlist
16790
16791
16792
16793 .option senders routers&!? "address list&!!" unset
16794 .cindex "router" "checking senders"
16795 If this option is set, the router is skipped unless the message's sender
16796 address matches something on the list.
16797 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16798 are evaluated.
16799
16800 There are issues concerning verification when the running of routers is
16801 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16802 setting, it sets the sender to the null string. When using the &%-bt%& option
16803 to check a configuration file, it is necessary also to use the &%-f%& option to
16804 set an appropriate sender. For incoming mail, the sender is unset when
16805 verifying the sender, but is available when verifying any recipients. If the
16806 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16807 matters.
16808
16809
16810 .option translate_ip_address routers string&!! unset
16811 .cindex "IP address" "translating"
16812 .cindex "packet radio"
16813 .cindex "router" "IP address translation"
16814 There exist some rare networking situations (for example, packet radio) where
16815 it is helpful to be able to translate IP addresses generated by normal routing
16816 mechanisms into other IP addresses, thus performing a kind of manual IP
16817 routing. This should be done only if the normal IP routing of the TCP/IP stack
16818 is inadequate or broken. Because this is an extremely uncommon requirement, the
16819 code to support this option is not included in the Exim binary unless
16820 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16821
16822 .vindex "&$host_address$&"
16823 The &%translate_ip_address%& string is expanded for every IP address generated
16824 by the router, with the generated address set in &$host_address$&. If the
16825 expansion is forced to fail, no action is taken.
16826 For any other expansion error, delivery of the message is deferred.
16827 If the result of the expansion is an IP address, that replaces the original
16828 address; otherwise the result is assumed to be a host name &-- this is looked
16829 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16830 produce one or more replacement IP addresses. For example, to subvert all IP
16831 addresses in some specific networks, this could be added to a router:
16832 .code
16833 translate_ip_address = \
16834   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16835     {$value}fail}}
16836 .endd
16837 The file would contain lines like
16838 .code
16839 10.2.3.128/26    some.host
16840 10.8.4.34/26     10.44.8.15
16841 .endd
16842 You should not make use of this facility unless you really understand what you
16843 are doing.
16844
16845
16846
16847 .option transport routers string&!! unset
16848 This option specifies the transport to be used when a router accepts an address
16849 and sets it up for delivery. A transport is never needed if a router is used
16850 only for verification. The value of the option is expanded at routing time,
16851 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16852 and result must be the name of one of the configured transports. If it is not,
16853 delivery is deferred.
16854
16855 The &%transport%& option is not used by the &(redirect)& router, but it does
16856 have some private options that set up transports for pipe and file deliveries
16857 (see chapter &<<CHAPredirect>>&).
16858
16859
16860
16861 .option transport_current_directory routers string&!! unset
16862 .cindex "current directory for local transport"
16863 This option associates a current directory with any address that is routed
16864 to a local transport. This can happen either because a transport is
16865 explicitly configured for the router, or because it generates a delivery to a
16866 file or a pipe. During the delivery process (that is, at transport time), this
16867 option string is expanded and is set as the current directory, unless
16868 overridden by a setting on the transport.
16869 If the expansion fails for any reason, including forced failure, an error is
16870 logged, and delivery is deferred.
16871 See chapter &<<CHAPenvironment>>& for details of the local delivery
16872 environment.
16873
16874
16875
16876
16877 .option transport_home_directory routers string&!! "see below"
16878 .cindex "home directory" "for local transport"
16879 This option associates a home directory with any address that is routed to a
16880 local transport. This can happen either because a transport is explicitly
16881 configured for the router, or because it generates a delivery to a file or a
16882 pipe. During the delivery process (that is, at transport time), the option
16883 string is expanded and is set as the home directory, unless overridden by a
16884 setting of &%home_directory%& on the transport.
16885 If the expansion fails for any reason, including forced failure, an error is
16886 logged, and delivery is deferred.
16887
16888 If the transport does not specify a home directory, and
16889 &%transport_home_directory%& is not set for the router, the home directory for
16890 the transport is taken from the password data if &%check_local_user%& is set for
16891 the router. Otherwise it is taken from &%router_home_directory%& if that option
16892 is set; if not, no home directory is set for the transport.
16893
16894 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16895 environment.
16896
16897
16898
16899
16900 .option unseen routers boolean&!! false
16901 .cindex "router" "carrying on after success"
16902 The result of string expansion for this option must be a valid boolean value,
16903 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16904 result causes an error, and delivery is deferred. If the expansion is forced to
16905 fail, the default value for the option (false) is used. Other failures cause
16906 delivery to be deferred.
16907
16908 When this option is set true, routing does not cease if the router accepts the
16909 address. Instead, a copy of the incoming address is passed to the next router,
16910 overriding a false setting of &%more%&. There is little point in setting
16911 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16912 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16913 sometimes true and sometimes false).
16914
16915 .cindex "copy of message (&%unseen%& option)"
16916 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16917 qualifier in filter files. It can be used to cause copies of messages to be
16918 delivered to some other destination, while also carrying out a normal delivery.
16919 In effect, the current address is made into a &"parent"& that has two children
16920 &-- one that is delivered as specified by this router, and a clone that goes on
16921 to be routed further. For this reason, &%unseen%& may not be combined with the
16922 &%one_time%& option in a &(redirect)& router.
16923
16924 &*Warning*&: Header lines added to the address (or specified for removal) by
16925 this router or by previous routers affect the &"unseen"& copy of the message
16926 only. The clone that continues to be processed by further routers starts with
16927 no added headers and none specified for removal. For a &%redirect%& router, if
16928 a generated address is the same as the incoming address, this can lead to
16929 duplicate addresses with different header modifications. Exim does not do
16930 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16931 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16932 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16933 &%redirect%& router may be of help.
16934
16935 Unlike the handling of header modifications, any data that was set by the
16936 &%address_data%& option in the current or previous routers &'is'& passed on to
16937 subsequent routers.
16938
16939
16940 .option user routers string&!! "see below"
16941 .cindex "uid (user id)" "local delivery"
16942 .cindex "local transports" "uid and gid"
16943 .cindex "transport" "local"
16944 .cindex "router" "user for filter processing"
16945 .cindex "filter" "user for processing"
16946 When a router queues an address for a transport, and the transport does not
16947 specify a user, the user given here is used when running the delivery process.
16948 The user may be specified numerically or by name. If expansion fails, the
16949 error is logged and delivery is deferred.
16950 This user is also used by the &(redirect)& router when running a filter file.
16951 The default is unset, except when &%check_local_user%& is set. In this case,
16952 the default is taken from the password information. If the user is specified as
16953 a name, and &%group%& is not set, the group associated with the user is used.
16954 See also &%initgroups%& and &%group%& and the discussion in chapter
16955 &<<CHAPenvironment>>&.
16956
16957
16958
16959 .option verify routers&!? boolean true
16960 Setting this option has the effect of setting &%verify_sender%& and
16961 &%verify_recipient%& to the same value.
16962
16963
16964 .option verify_only routers&!? boolean false
16965 .cindex "EXPN" "with &%verify_only%&"
16966 .oindex "&%-bv%&"
16967 .cindex "router" "used only when verifying"
16968 If this option is set, the router is used only when verifying an address or
16969 testing with the &%-bv%& option, not when actually doing a delivery, testing
16970 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16971 restricted to verifying only senders or recipients by means of
16972 &%verify_sender%& and &%verify_recipient%&.
16973
16974 &*Warning*&: When the router is being run to verify addresses for an incoming
16975 SMTP message, Exim is not running as root, but under its own uid. If the router
16976 accesses any files, you need to make sure that they are accessible to the Exim
16977 user or group.
16978
16979
16980 .option verify_recipient routers&!? boolean true
16981 If this option is false, the router is skipped when verifying recipient
16982 addresses
16983 or testing recipient verification using &%-bv%&.
16984 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16985 are evaluated.
16986
16987
16988 .option verify_sender routers&!? boolean true
16989 If this option is false, the router is skipped when verifying sender addresses
16990 or testing sender verification using &%-bvs%&.
16991 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16992 are evaluated.
16993 .ecindex IIDgenoprou1
16994 .ecindex IIDgenoprou2
16995
16996
16997
16998
16999
17000
17001 . ////////////////////////////////////////////////////////////////////////////
17002 . ////////////////////////////////////////////////////////////////////////////
17003
17004 .chapter "The accept router" "CHID4"
17005 .cindex "&(accept)& router"
17006 .cindex "routers" "&(accept)&"
17007 The &(accept)& router has no private options of its own. Unless it is being
17008 used purely for verification (see &%verify_only%&) a transport is required to
17009 be defined by the generic &%transport%& option. If the preconditions that are
17010 specified by generic options are met, the router accepts the address and queues
17011 it for the given transport. The most common use of this router is for setting
17012 up deliveries to local mailboxes. For example:
17013 .code
17014 localusers:
17015   driver = accept
17016   domains = mydomain.example
17017   check_local_user
17018   transport = local_delivery
17019 .endd
17020 The &%domains%& condition in this example checks the domain of the address, and
17021 &%check_local_user%& checks that the local part is the login of a local user.
17022 When both preconditions are met, the &(accept)& router runs, and queues the
17023 address for the &(local_delivery)& transport.
17024
17025
17026
17027
17028
17029
17030 . ////////////////////////////////////////////////////////////////////////////
17031 . ////////////////////////////////////////////////////////////////////////////
17032
17033 .chapter "The dnslookup router" "CHAPdnslookup"
17034 .scindex IIDdnsrou1 "&(dnslookup)& router"
17035 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17036 The &(dnslookup)& router looks up the hosts that handle mail for the
17037 recipient's domain in the DNS. A transport must always be set for this router,
17038 unless &%verify_only%& is set.
17039
17040 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17041 SRV records. If none are found, or if SRV support is not configured,
17042 MX records are looked up. If no MX records exist, address records are sought.
17043 However, &%mx_domains%& can be set to disable the direct use of address
17044 records.
17045
17046 MX records of equal priority are sorted by Exim into a random order. Exim then
17047 looks for address records for the host names obtained from MX or SRV records.
17048 When a host has more than one IP address, they are sorted into a random order,
17049 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17050 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17051 generic option, the router declines.
17052
17053 Unless they have the highest priority (lowest MX value), MX records that point
17054 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17055 are discarded, together with any other MX records of equal or lower priority.
17056
17057 .cindex "MX record" "pointing to local host"
17058 .cindex "local host" "MX pointing to"
17059 .oindex "&%self%&" "in &(dnslookup)& router"
17060 If the host pointed to by the highest priority MX record, or looked up as an
17061 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17062 happens is controlled by the generic &%self%& option.
17063
17064
17065 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17066 There have been problems with DNS servers when SRV records are looked up.
17067 Some mis-behaving servers return a DNS error or timeout when a non-existent
17068 SRV record is sought. Similar problems have in the past been reported for
17069 MX records. The global &%dns_again_means_nonexist%& option can help with this
17070 problem, but it is heavy-handed because it is a global option.
17071
17072 For this reason, there are two options, &%srv_fail_domains%& and
17073 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17074 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17075 an attempt to look up an SRV or MX record causes one of these results, and the
17076 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17077 such record"&. In the case of an SRV lookup, this means that the router
17078 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17079 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17080 case routing fails.
17081
17082
17083
17084
17085 .section "Private options for dnslookup" "SECID118"
17086 .cindex "options" "&(dnslookup)& router"
17087 The private options for the &(dnslookup)& router are as follows:
17088
17089 .option check_secondary_mx dnslookup boolean false
17090 .cindex "MX record" "checking for secondary"
17091 If this option is set, the router declines unless the local host is found in
17092 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17093 process domains for which the local host is a secondary mail exchanger
17094 differently to other domains. The way in which Exim decides whether a host is
17095 the local host is described in section &<<SECTreclocipadd>>&.
17096
17097
17098 .option check_srv dnslookup string&!! unset
17099 .cindex "SRV record" "enabling use of"
17100 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17101 addition to MX and address records. The support is disabled by default. To
17102 enable SRV support, set the &%check_srv%& option to the name of the service
17103 required. For example,
17104 .code
17105 check_srv = smtp
17106 .endd
17107 looks for SRV records that refer to the normal smtp service. The option is
17108 expanded, so the service name can vary from message to message or address
17109 to address. This might be helpful if SRV records are being used for a
17110 submission service. If the expansion is forced to fail, the &%check_srv%&
17111 option is ignored, and the router proceeds to look for MX records in the
17112 normal way.
17113
17114 When the expansion succeeds, the router searches first for SRV records for
17115 the given service (it assumes TCP protocol). A single SRV record with a
17116 host name that consists of just a single dot indicates &"no such service for
17117 this domain"&; if this is encountered, the router declines. If other kinds of
17118 SRV record are found, they are used to construct a host list for delivery
17119 according to the rules of RFC 2782. MX records are not sought in this case.
17120
17121 When no SRV records are found, MX records (and address records) are sought in
17122 the traditional way. In other words, SRV records take precedence over MX
17123 records, just as MX records take precedence over address records. Note that
17124 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17125 defined it. It is apparently believed that MX records are sufficient for email
17126 and that SRV records should not be used for this purpose. However, SRV records
17127 have an additional &"weight"& feature which some people might find useful when
17128 trying to split an SMTP load between hosts of different power.
17129
17130 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17131 when there is a DNS lookup error.
17132
17133
17134
17135 .option mx_domains dnslookup "domain list&!!" unset
17136 .cindex "MX record" "required to exist"
17137 .cindex "SRV record" "required to exist"
17138 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17139 record in order to be recognized. (The name of this option could be improved.)
17140 For example, if all the mail hosts in &'fict.example'& are known to have MX
17141 records, except for those in &'discworld.fict.example'&, you could use this
17142 setting:
17143 .code
17144 mx_domains = ! *.discworld.fict.example : *.fict.example
17145 .endd
17146 This specifies that messages addressed to a domain that matches the list but
17147 has no MX record should be bounced immediately instead of being routed using
17148 the address record.
17149
17150
17151 .option mx_fail_domains dnslookup "domain list&!!" unset
17152 If the DNS lookup for MX records for one of the domains in this list causes a
17153 DNS lookup error, Exim behaves as if no MX records were found. See section
17154 &<<SECTprowitdnsloo>>& for more discussion.
17155
17156
17157
17158
17159 .option qualify_single dnslookup boolean true
17160 .cindex "DNS" "resolver options"
17161 .cindex "DNS" "qualifying single-component names"
17162 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17163 lookups. Typically, but not standardly, this causes the resolver to qualify
17164 single-component names with the default domain. For example, on a machine
17165 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17166 &'thesaurus.ref.example'& inside the resolver. For details of what your
17167 resolver actually does, consult your man pages for &'resolver'& and
17168 &'resolv.conf'&.
17169
17170
17171
17172 .option rewrite_headers dnslookup boolean true
17173 .cindex "rewriting" "header lines"
17174 .cindex "header lines" "rewriting"
17175 If the domain name in the address that is being processed is not fully
17176 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17177 an address is specified as &'dormouse@teaparty'&, the domain might be
17178 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17179 occur as a result of setting the &%widen_domains%& option. If
17180 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17181 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17182 header lines of the message are rewritten with the full domain name.
17183
17184 This option should be turned off only when it is known that no message is
17185 ever going to be sent outside an environment where the abbreviation makes
17186 sense.
17187
17188 When an MX record is looked up in the DNS and matches a wildcard record, name
17189 servers normally return a record containing the name that has been looked up,
17190 making it impossible to detect whether a wildcard was present or not. However,
17191 some name servers have recently been seen to return the wildcard entry. If the
17192 name returned by a DNS lookup begins with an asterisk, it is not used for
17193 header rewriting.
17194
17195
17196 .option same_domain_copy_routing dnslookup boolean false
17197 .cindex "address" "copying routing"
17198 Addresses with the same domain are normally routed by the &(dnslookup)& router
17199 to the same list of hosts. However, this cannot be presumed, because the router
17200 options and preconditions may refer to the local part of the address. By
17201 default, therefore, Exim routes each address in a message independently. DNS
17202 servers run caches, so repeated DNS lookups are not normally expensive, and in
17203 any case, personal messages rarely have more than a few recipients.
17204
17205 If you are running mailing lists with large numbers of subscribers at the same
17206 domain, and you are using a &(dnslookup)& router which is independent of the
17207 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17208 lookups for identical domains in one message. In this case, when &(dnslookup)&
17209 routes an address to a remote transport, any other unrouted addresses in the
17210 message that have the same domain are automatically given the same routing
17211 without processing them independently,
17212 provided the following conditions are met:
17213
17214 .ilist
17215 No router that processed the address specified &%headers_add%& or
17216 &%headers_remove%&.
17217 .next
17218 The router did not change the address in any way, for example, by &"widening"&
17219 the domain.
17220 .endlist
17221
17222
17223
17224
17225 .option search_parents dnslookup boolean false
17226 .cindex "DNS" "resolver options"
17227 When this option is true, the resolver option RES_DNSRCH is set for DNS
17228 lookups. This is different from the &%qualify_single%& option in that it
17229 applies to domains containing dots. Typically, but not standardly, it causes
17230 the resolver to search for the name in the current domain and in parent
17231 domains. For example, on a machine in the &'fict.example'& domain, if looking
17232 up &'teaparty.wonderland'& failed, the resolver would try
17233 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17234 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17235
17236 Setting this option true can cause problems in domains that have a wildcard MX
17237 record, because any domain that does not have its own MX record matches the
17238 local wildcard.
17239
17240
17241
17242 .option srv_fail_domains dnslookup "domain list&!!" unset
17243 If the DNS lookup for SRV records for one of the domains in this list causes a
17244 DNS lookup error, Exim behaves as if no SRV records were found. See section
17245 &<<SECTprowitdnsloo>>& for more discussion.
17246
17247
17248
17249
17250 .option widen_domains dnslookup "string list" unset
17251 .cindex "domain" "partial; widening"
17252 If a DNS lookup fails and this option is set, each of its strings in turn is
17253 added onto the end of the domain, and the lookup is tried again. For example,
17254 if
17255 .code
17256 widen_domains = fict.example:ref.example
17257 .endd
17258 is set and a lookup of &'klingon.dictionary'& fails,
17259 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17260 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17261 and &%search_parents%& options can cause some widening to be undertaken inside
17262 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17263 when verifying, unless &%rewrite_headers%& is false (not the default).
17264
17265
17266 .section "Effect of qualify_single and search_parents" "SECID119"
17267 When a domain from an envelope recipient is changed by the resolver as a result
17268 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17269 corresponding address in the message's header lines unless &%rewrite_headers%&
17270 is set false. Exim then re-routes the address, using the full domain.
17271
17272 These two options affect only the DNS lookup that takes place inside the router
17273 for the domain of the address that is being routed. They do not affect lookups
17274 such as that implied by
17275 .code
17276 domains = @mx_any
17277 .endd
17278 that may happen while processing a router precondition before the router is
17279 entered. No widening ever takes place for these lookups.
17280 .ecindex IIDdnsrou1
17281 .ecindex IIDdnsrou2
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291 . ////////////////////////////////////////////////////////////////////////////
17292 . ////////////////////////////////////////////////////////////////////////////
17293
17294 .chapter "The ipliteral router" "CHID5"
17295 .cindex "&(ipliteral)& router"
17296 .cindex "domain literal" "routing"
17297 .cindex "routers" "&(ipliteral)&"
17298 This router has no private options. Unless it is being used purely for
17299 verification (see &%verify_only%&) a transport is required to be defined by the
17300 generic &%transport%& option. The router accepts the address if its domain part
17301 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17302 router handles the address
17303 .code
17304 root@[192.168.1.1]
17305 .endd
17306 by setting up delivery to the host with that IP address. IPv4 domain literals
17307 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17308 are similar, but the address is preceded by &`ipv6:`&. For example:
17309 .code
17310 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17311 .endd
17312 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17313 grounds that sooner or later somebody will try it.
17314
17315 .oindex "&%self%&" "in &(ipliteral)& router"
17316 If the IP address matches something in &%ignore_target_hosts%&, the router
17317 declines. If an IP literal turns out to refer to the local host, the generic
17318 &%self%& option determines what happens.
17319
17320 The RFCs require support for domain literals; however, their use is
17321 controversial in today's Internet. If you want to use this router, you must
17322 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17323 Exim will not recognize the domain literal syntax in addresses.
17324
17325
17326
17327 . ////////////////////////////////////////////////////////////////////////////
17328 . ////////////////////////////////////////////////////////////////////////////
17329
17330 .chapter "The iplookup router" "CHID6"
17331 .cindex "&(iplookup)& router"
17332 .cindex "routers" "&(iplookup)&"
17333 The &(iplookup)& router was written to fulfil a specific requirement in
17334 Cambridge University (which in fact no longer exists). For this reason, it is
17335 not included in the binary of Exim by default. If you want to include it, you
17336 must set
17337 .code
17338 ROUTER_IPLOOKUP=yes
17339 .endd
17340 in your &_Local/Makefile_& configuration file.
17341
17342 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17343 connection to one or more specific hosts. The host can then return the same or
17344 a different address &-- in effect rewriting the recipient address in the
17345 message's envelope. The new address is then passed on to subsequent routers. If
17346 this process fails, the address can be passed on to other routers, or delivery
17347 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17348 must not be specified for it.
17349
17350 .cindex "options" "&(iplookup)& router"
17351 .option hosts iplookup string unset
17352 This option must be supplied. Its value is a colon-separated list of host
17353 names. The hosts are looked up using &[gethostbyname()]&
17354 (or &[getipnodebyname()]& when available)
17355 and are tried in order until one responds to the query. If none respond, what
17356 happens is controlled by &%optional%&.
17357
17358
17359 .option optional iplookup boolean false
17360 If &%optional%& is true, if no response is obtained from any host, the address
17361 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17362 delivery to the address is deferred.
17363
17364
17365 .option port iplookup integer 0
17366 .cindex "port" "&(iplookup)& router"
17367 This option must be supplied. It specifies the port number for the TCP or UDP
17368 call.
17369
17370
17371 .option protocol iplookup string udp
17372 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17373 protocols is to be used.
17374
17375
17376 .option query iplookup string&!! "see below"
17377 This defines the content of the query that is sent to the remote hosts. The
17378 default value is:
17379 .code
17380 $local_part@$domain $local_part@$domain
17381 .endd
17382 The repetition serves as a way of checking that a response is to the correct
17383 query in the default case (see &%response_pattern%& below).
17384
17385
17386 .option reroute iplookup string&!! unset
17387 If this option is not set, the rerouted address is precisely the byte string
17388 returned by the remote host, up to the first white space, if any. If set, the
17389 string is expanded to form the rerouted address. It can include parts matched
17390 in the response by &%response_pattern%& by means of numeric variables such as
17391 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17392 whether or not a pattern is in use. In all cases, the rerouted address must end
17393 up in the form &'local_part@domain'&.
17394
17395
17396 .option response_pattern iplookup string unset
17397 This option can be set to a regular expression that is applied to the string
17398 returned from the remote host. If the pattern does not match the response, the
17399 router declines. If &%response_pattern%& is not set, no checking of the
17400 response is done, unless the query was defaulted, in which case there is a
17401 check that the text returned after the first white space is the original
17402 address. This checks that the answer that has been received is in response to
17403 the correct question. For example, if the response is just a new domain, the
17404 following could be used:
17405 .code
17406 response_pattern = ^([^@]+)$
17407 reroute = $local_part@$1
17408 .endd
17409
17410 .option timeout iplookup time 5s
17411 This specifies the amount of time to wait for a response from the remote
17412 machine. The same timeout is used for the &[connect()]& function for a TCP
17413 call. It does not apply to UDP.
17414
17415
17416
17417
17418 . ////////////////////////////////////////////////////////////////////////////
17419 . ////////////////////////////////////////////////////////////////////////////
17420
17421 .chapter "The manualroute router" "CHID7"
17422 .scindex IIDmanrou1 "&(manualroute)& router"
17423 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17424 .cindex "domain" "manually routing"
17425 The &(manualroute)& router is so-called because it provides a way of manually
17426 routing an address according to its domain. It is mainly used when you want to
17427 route addresses to remote hosts according to your own rules, bypassing the
17428 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17429 route to local transports, a facility that may be useful if you want to save
17430 messages for dial-in hosts in local files.
17431
17432 The &(manualroute)& router compares a list of domain patterns with the domain
17433 it is trying to route. If there is no match, the router declines. Each pattern
17434 has associated with it a list of hosts and some other optional data, which may
17435 include a transport. The combination of a pattern and its data is called a
17436 &"routing rule"&. For patterns that do not have an associated transport, the
17437 generic &%transport%& option must specify a transport, unless the router is
17438 being used purely for verification (see &%verify_only%&).
17439
17440 .vindex "&$host$&"
17441 In the case of verification, matching the domain pattern is sufficient for the
17442 router to accept the address. When actually routing an address for delivery,
17443 an address that matches a domain pattern is queued for the associated
17444 transport. If the transport is not a local one, a host list must be associated
17445 with the pattern; IP addresses are looked up for the hosts, and these are
17446 passed to the transport along with the mail address. For local transports, a
17447 host list is optional. If it is present, it is passed in &$host$& as a single
17448 text string.
17449
17450 The list of routing rules can be provided as an inline string in
17451 &%route_list%&, or the data can be obtained by looking up the domain in a file
17452 or database by setting &%route_data%&. Only one of these settings may appear in
17453 any one instance of &(manualroute)&. The format of routing rules is described
17454 below, following the list of private options.
17455
17456
17457 .section "Private options for manualroute" "SECTprioptman"
17458
17459 .cindex "options" "&(manualroute)& router"
17460 The private options for the &(manualroute)& router are as follows:
17461
17462 .option host_all_ignored manualroute string defer
17463 See &%host_find_failed%&.
17464
17465 .option host_find_failed manualroute string freeze
17466 This option controls what happens when &(manualroute)& tries to find an IP
17467 address for a host, and the host does not exist. The option can be set to one
17468 of the following values:
17469 .code
17470 decline
17471 defer
17472 fail
17473 freeze
17474 ignore
17475 pass
17476 .endd
17477 The default (&"freeze"&) assumes that this state is a serious configuration
17478 error. The difference between &"pass"& and &"decline"& is that the former
17479 forces the address to be passed to the next router (or the router defined by
17480 &%pass_router%&),
17481 .oindex "&%more%&"
17482 overriding &%no_more%&, whereas the latter passes the address to the next
17483 router only if &%more%& is true.
17484
17485 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17486 cannot be found. If all the hosts in the list are ignored, the behaviour is
17487 controlled by the &%host_all_ignored%& option. This takes the same values
17488 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17489
17490 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17491 state; if a host lookup gets a temporary error, delivery is deferred unless the
17492 generic &%pass_on_timeout%& option is set.
17493
17494
17495 .option hosts_randomize manualroute boolean false
17496 .cindex "randomized host list"
17497 .cindex "host" "list of; randomized"
17498 If this option is set, the order of the items in a host list in a routing rule
17499 is randomized each time the list is used, unless an option in the routing rule
17500 overrides (see below). Randomizing the order of a host list can be used to do
17501 crude load sharing. However, if more than one mail address is routed by the
17502 same router to the same host list, the host lists are considered to be the same
17503 (even though they may be randomized into different orders) for the purpose of
17504 deciding whether to batch the deliveries into a single SMTP transaction.
17505
17506 When &%hosts_randomize%& is true, a host list may be split
17507 into groups whose order is separately randomized. This makes it possible to
17508 set up MX-like behaviour. The boundaries between groups are indicated by an
17509 item that is just &`+`& in the host list. For example:
17510 .code
17511 route_list = * host1:host2:host3:+:host4:host5
17512 .endd
17513 The order of the first three hosts and the order of the last two hosts is
17514 randomized for each use, but the first three always end up before the last two.
17515 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17516 randomized host list is passed to an &(smtp)& transport that also has
17517 &%hosts_randomize set%&, the list is not re-randomized.
17518
17519
17520 .option route_data manualroute string&!! unset
17521 If this option is set, it must expand to yield the data part of a routing rule.
17522 Typically, the expansion string includes a lookup based on the domain. For
17523 example:
17524 .code
17525 route_data = ${lookup{$domain}dbm{/etc/routes}}
17526 .endd
17527 If the expansion is forced to fail, or the result is an empty string, the
17528 router declines. Other kinds of expansion failure cause delivery to be
17529 deferred.
17530
17531
17532 .option route_list manualroute "string list" unset
17533 This string is a list of routing rules, in the form defined below. Note that,
17534 unlike most string lists, the items are separated by semicolons. This is so
17535 that they may contain colon-separated host lists.
17536
17537
17538 .option same_domain_copy_routing manualroute boolean false
17539 .cindex "address" "copying routing"
17540 Addresses with the same domain are normally routed by the &(manualroute)&
17541 router to the same list of hosts. However, this cannot be presumed, because the
17542 router options and preconditions may refer to the local part of the address. By
17543 default, therefore, Exim routes each address in a message independently. DNS
17544 servers run caches, so repeated DNS lookups are not normally expensive, and in
17545 any case, personal messages rarely have more than a few recipients.
17546
17547 If you are running mailing lists with large numbers of subscribers at the same
17548 domain, and you are using a &(manualroute)& router which is independent of the
17549 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17550 lookups for identical domains in one message. In this case, when
17551 &(manualroute)& routes an address to a remote transport, any other unrouted
17552 addresses in the message that have the same domain are automatically given the
17553 same routing without processing them independently. However, this is only done
17554 if &%headers_add%& and &%headers_remove%& are unset.
17555
17556
17557
17558
17559 .section "Routing rules in route_list" "SECID120"
17560 The value of &%route_list%& is a string consisting of a sequence of routing
17561 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17562 entered as two semicolons. Alternatively, the list separator can be changed as
17563 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17564 Empty rules are ignored. The format of each rule is
17565 .display
17566 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17567 .endd
17568 The following example contains two rules, each with a simple domain pattern and
17569 no options:
17570 .code
17571 route_list = \
17572   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17573   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17574 .endd
17575 The three parts of a rule are separated by white space. The pattern and the
17576 list of hosts can be enclosed in quotes if necessary, and if they are, the
17577 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17578 single domain pattern, which is the only mandatory item in the rule. The
17579 pattern is in the same format as one item in a domain list (see section
17580 &<<SECTdomainlist>>&),
17581 except that it may not be the name of an interpolated file.
17582 That is, it may be wildcarded, or a regular expression, or a file or database
17583 lookup (with semicolons doubled, because of the use of semicolon as a separator
17584 in a &%route_list%&).
17585
17586 The rules in &%route_list%& are searched in order until one of the patterns
17587 matches the domain that is being routed. The list of hosts and then options are
17588 then used as described below. If there is no match, the router declines. When
17589 &%route_list%& is set, &%route_data%& must not be set.
17590
17591
17592
17593 .section "Routing rules in route_data" "SECID121"
17594 The use of &%route_list%& is convenient when there are only a small number of
17595 routing rules. For larger numbers, it is easier to use a file or database to
17596 hold the routing information, and use the &%route_data%& option instead.
17597 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17598 Most commonly, &%route_data%& is set as a string that contains an
17599 expansion lookup. For example, suppose we place two routing rules in a file
17600 like this:
17601 .code
17602 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17603 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17604 .endd
17605 This data can be accessed by setting
17606 .code
17607 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17608 .endd
17609 Failure of the lookup results in an empty string, causing the router to
17610 decline. However, you do not have to use a lookup in &%route_data%&. The only
17611 requirement is that the result of expanding the string is a list of hosts,
17612 possibly followed by options, separated by white space. The list of hosts must
17613 be enclosed in quotes if it contains white space.
17614
17615
17616
17617
17618 .section "Format of the list of hosts" "SECID122"
17619 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17620 always separately expanded before use. If the expansion fails, the router
17621 declines. The result of the expansion must be a colon-separated list of names
17622 and/or IP addresses, optionally also including ports. The format of each item
17623 in the list is described in the next section. The list separator can be changed
17624 as described in section &<<SECTlistconstruct>>&.
17625
17626 If the list of hosts was obtained from a &%route_list%& item, the following
17627 variables are set during its expansion:
17628
17629 .ilist
17630 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17631 If the domain was matched against a regular expression, the numeric variables
17632 &$1$&, &$2$&, etc. may be set. For example:
17633 .code
17634 route_list = ^domain(\d+)   host-$1.text.example
17635 .endd
17636 .next
17637 &$0$& is always set to the entire domain.
17638 .next
17639 &$1$& is also set when partial matching is done in a file lookup.
17640
17641 .next
17642 .vindex "&$value$&"
17643 If the pattern that matched the domain was a lookup item, the data that was
17644 looked up is available in the expansion variable &$value$&. For example:
17645 .code
17646 route_list = lsearch;;/some/file.routes  $value
17647 .endd
17648 .endlist
17649
17650 Note the doubling of the semicolon in the pattern that is necessary because
17651 semicolon is the default route list separator.
17652
17653
17654
17655 .section "Format of one host item" "SECTformatonehostitem"
17656 Each item in the list of hosts is either a host name or an IP address,
17657 optionally with an attached port number. When no port is given, an IP address
17658 is not enclosed in brackets. When a port is specified, it overrides the port
17659 specification on the transport. The port is separated from the name or address
17660 by a colon. This leads to some complications:
17661
17662 .ilist
17663 Because colon is the default separator for the list of hosts, either
17664 the colon that specifies a port must be doubled, or the list separator must
17665 be changed. The following two examples have the same effect:
17666 .code
17667 route_list = * "host1.tld::1225 : host2.tld::1226"
17668 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17669 .endd
17670 .next
17671 When IPv6 addresses are involved, it gets worse, because they contain
17672 colons of their own. To make this case easier, it is permitted to
17673 enclose an IP address (either v4 or v6) in square brackets if a port
17674 number follows. For example:
17675 .code
17676 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17677 .endd
17678 .endlist
17679
17680 .section "How the list of hosts is used" "SECThostshowused"
17681 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17682 the hosts is tried, in the order specified, when carrying out the SMTP
17683 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17684 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17685 transport.
17686
17687 Hosts may be listed by name or by IP address. An unadorned name in the list of
17688 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17689 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17690 records in the DNS. For example:
17691 .code
17692 route_list = *  x.y.z:p.q.r/MX:e.f.g
17693 .endd
17694 If this feature is used with a port specifier, the port must come last. For
17695 example:
17696 .code
17697 route_list = *  dom1.tld/mx::1225
17698 .endd
17699 If the &%hosts_randomize%& option is set, the order of the items in the list is
17700 randomized before any lookups are done. Exim then scans the list; for any name
17701 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17702 be an interface on the local host and the item is not the first in the list,
17703 Exim discards it and any subsequent items. If it is the first item, what
17704 happens is controlled by the
17705 .oindex "&%self%&" "in &(manualroute)& router"
17706 &%self%& option of the router.
17707
17708 A name on the list that is followed by &`/MX`& is replaced with the list of
17709 hosts obtained by looking up MX records for the name. This is always a DNS
17710 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17711 below) are not relevant here. The order of these hosts is determined by the
17712 preference values in the MX records, according to the usual rules. Because
17713 randomizing happens before the MX lookup, it does not affect the order that is
17714 defined by MX preferences.
17715
17716 If the local host is present in the sublist obtained from MX records, but is
17717 not the most preferred host in that list, it and any equally or less
17718 preferred hosts are removed before the sublist is inserted into the main list.
17719
17720 If the local host is the most preferred host in the MX list, what happens
17721 depends on where in the original list of hosts the &`/MX`& item appears. If it
17722 is not the first item (that is, there are previous hosts in the main list),
17723 Exim discards this name and any subsequent items in the main list.
17724
17725 If the MX item is first in the list of hosts, and the local host is the
17726 most preferred host, what happens is controlled by the &%self%& option of the
17727 router.
17728
17729 DNS failures when lookup up the MX records are treated in the same way as DNS
17730 failures when looking up IP addresses: &%pass_on_timeout%& and
17731 &%host_find_failed%& are used when relevant.
17732
17733 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17734 whether obtained from an MX lookup or not.
17735
17736
17737
17738 .section "How the options are used" "SECThowoptused"
17739 The options are a sequence of words; in practice no more than three are ever
17740 present. One of the words can be the name of a transport; this overrides the
17741 &%transport%& option on the router for this particular routing rule only. The
17742 other words (if present) control randomization of the list of hosts on a
17743 per-rule basis, and how the IP addresses of the hosts are to be found when
17744 routing to a remote transport. These options are as follows:
17745
17746 .ilist
17747 &%randomize%&: randomize the order of the hosts in this list, overriding the
17748 setting of &%hosts_randomize%& for this routing rule only.
17749 .next
17750 &%no_randomize%&: do not randomize the order of the hosts in this list,
17751 overriding the setting of &%hosts_randomize%& for this routing rule only.
17752 .next
17753 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17754 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17755 also look in &_/etc/hosts_& or other sources of information.
17756 .next
17757 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17758 no address records are found. If there is a temporary DNS error (such as a
17759 timeout), delivery is deferred.
17760 .endlist
17761
17762 For example:
17763 .code
17764 route_list = domain1  host1:host2:host3  randomize bydns;\
17765              domain2  host4:host5
17766 .endd
17767 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17768 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17769 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17770 or &[gethostbyname()]&, and the result of the lookup is the result of that
17771 call.
17772
17773 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17774 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17775 instead of TRY_AGAIN. That is why the default action is to try a DNS
17776 lookup first. Only if that gives a definite &"no such host"& is the local
17777 function called.
17778
17779
17780
17781 If no IP address for a host can be found, what happens is controlled by the
17782 &%host_find_failed%& option.
17783
17784 .vindex "&$host$&"
17785 When an address is routed to a local transport, IP addresses are not looked up.
17786 The host list is passed to the transport in the &$host$& variable.
17787
17788
17789
17790 .section "Manualroute examples" "SECID123"
17791 In some of the examples that follow, the presence of the &%remote_smtp%&
17792 transport, as defined in the default configuration file, is assumed:
17793
17794 .ilist
17795 .cindex "smart host" "example router"
17796 The &(manualroute)& router can be used to forward all external mail to a
17797 &'smart host'&. If you have set up, in the main part of the configuration, a
17798 named domain list that contains your local domains, for example:
17799 .code
17800 domainlist local_domains = my.domain.example
17801 .endd
17802 You can arrange for all other domains to be routed to a smart host by making
17803 your first router something like this:
17804 .code
17805 smart_route:
17806   driver = manualroute
17807   domains = !+local_domains
17808   transport = remote_smtp
17809   route_list = * smarthost.ref.example
17810 .endd
17811 This causes all non-local addresses to be sent to the single host
17812 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17813 they are tried in order
17814 (but you can use &%hosts_randomize%& to vary the order each time).
17815 Another way of configuring the same thing is this:
17816 .code
17817 smart_route:
17818   driver = manualroute
17819   transport = remote_smtp
17820   route_list = !+local_domains  smarthost.ref.example
17821 .endd
17822 There is no difference in behaviour between these two routers as they stand.
17823 However, they behave differently if &%no_more%& is added to them. In the first
17824 example, the router is skipped if the domain does not match the &%domains%&
17825 precondition; the following router is always tried. If the router runs, it
17826 always matches the domain and so can never decline. Therefore, &%no_more%&
17827 would have no effect. In the second case, the router is never skipped; it
17828 always runs. However, if it doesn't match the domain, it declines. In this case
17829 &%no_more%& would prevent subsequent routers from running.
17830
17831 .next
17832 .cindex "mail hub example"
17833 A &'mail hub'& is a host which receives mail for a number of domains via MX
17834 records in the DNS and delivers it via its own private routing mechanism. Often
17835 the final destinations are behind a firewall, with the mail hub being the one
17836 machine that can connect to machines both inside and outside the firewall. The
17837 &(manualroute)& router is usually used on a mail hub to route incoming messages
17838 to the correct hosts. For a small number of domains, the routing can be inline,
17839 using the &%route_list%& option, but for a larger number a file or database
17840 lookup is easier to manage.
17841
17842 If the domain names are in fact the names of the machines to which the mail is
17843 to be sent by the mail hub, the configuration can be quite simple. For
17844 example:
17845 .code
17846 hub_route:
17847   driver = manualroute
17848   transport = remote_smtp
17849   route_list = *.rhodes.tvs.example  $domain
17850 .endd
17851 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17852 whose names are the same as the mail domains. A similar approach can be taken
17853 if the host name can be obtained from the domain name by a string manipulation
17854 that the expansion facilities can handle. Otherwise, a lookup based on the
17855 domain can be used to find the host:
17856 .code
17857 through_firewall:
17858   driver = manualroute
17859   transport = remote_smtp
17860   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17861 .endd
17862 The result of the lookup must be the name or IP address of the host (or
17863 hosts) to which the address is to be routed. If the lookup fails, the route
17864 data is empty, causing the router to decline. The address then passes to the
17865 next router.
17866
17867 .next
17868 .cindex "batched SMTP output example"
17869 .cindex "SMTP" "batched outgoing; example"
17870 You can use &(manualroute)& to deliver messages to pipes or files in batched
17871 SMTP format for onward transportation by some other means. This is one way of
17872 storing mail for a dial-up host when it is not connected. The route list entry
17873 can be as simple as a single domain name in a configuration like this:
17874 .code
17875 save_in_file:
17876   driver = manualroute
17877   transport = batchsmtp_appendfile
17878   route_list = saved.domain.example
17879 .endd
17880 though often a pattern is used to pick up more than one domain. If there are
17881 several domains or groups of domains with different transport requirements,
17882 different transports can be listed in the routing information:
17883 .code
17884 save_in_file:
17885   driver = manualroute
17886   route_list = \
17887     *.saved.domain1.example  $domain  batch_appendfile; \
17888     *.saved.domain2.example  \
17889       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17890       batch_pipe
17891 .endd
17892 .vindex "&$domain$&"
17893 .vindex "&$host$&"
17894 The first of these just passes the domain in the &$host$& variable, which
17895 doesn't achieve much (since it is also in &$domain$&), but the second does a
17896 file lookup to find a value to pass, causing the router to decline to handle
17897 the address if the lookup fails.
17898
17899 .next
17900 .cindex "UUCP" "example of router for"
17901 Routing mail directly to UUCP software is a specific case of the use of
17902 &(manualroute)& in a gateway to another mail environment. This is an example of
17903 one way it can be done:
17904 .code
17905 # Transport
17906 uucp:
17907   driver = pipe
17908   user = nobody
17909   command = /usr/local/bin/uux -r - \
17910     ${substr_-5:$host}!rmail ${local_part}
17911   return_fail_output = true
17912
17913 # Router
17914 uucphost:
17915   transport = uucp
17916   driver = manualroute
17917   route_data = \
17918     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17919 .endd
17920 The file &_/usr/local/exim/uucphosts_& contains entries like
17921 .code
17922 darksite.ethereal.example:           darksite.UUCP
17923 .endd
17924 It can be set up more simply without adding and removing &".UUCP"& but this way
17925 makes clear the distinction between the domain name
17926 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17927 .endlist
17928 .ecindex IIDmanrou1
17929 .ecindex IIDmanrou2
17930
17931
17932
17933
17934
17935
17936
17937
17938 . ////////////////////////////////////////////////////////////////////////////
17939 . ////////////////////////////////////////////////////////////////////////////
17940
17941 .chapter "The queryprogram router" "CHAPdriverlast"
17942 .scindex IIDquerou1 "&(queryprogram)& router"
17943 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17944 .cindex "routing" "by external program"
17945 The &(queryprogram)& router routes an address by running an external command
17946 and acting on its output. This is an expensive way to route, and is intended
17947 mainly for use in lightly-loaded systems, or for performing experiments.
17948 However, if it is possible to use the precondition options (&%domains%&,
17949 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17950 be used in special cases, even on a busy host. There are the following private
17951 options:
17952 .cindex "options" "&(queryprogram)& router"
17953
17954 .option command queryprogram string&!! unset
17955 This option must be set. It specifies the command that is to be run. The
17956 command is split up into a command name and arguments, and then each is
17957 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17958 &<<CHAPpipetransport>>&).
17959
17960
17961 .option command_group queryprogram string unset
17962 .cindex "gid (group id)" "in &(queryprogram)& router"
17963 This option specifies a gid to be set when running the command while routing an
17964 address for deliver. It must be set if &%command_user%& specifies a numerical
17965 uid. If it begins with a digit, it is interpreted as the numerical value of the
17966 gid. Otherwise it is looked up using &[getgrnam()]&.
17967
17968
17969 .option command_user queryprogram string unset
17970 .cindex "uid (user id)" "for &(queryprogram)&"
17971 This option must be set. It specifies the uid which is set when running the
17972 command while routing an address for delivery. If the value begins with a digit,
17973 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17974 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17975 not set, a value for the gid also.
17976
17977 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17978 root, which it does during a normal delivery in a conventional configuration.
17979 However, when an address is being verified during message reception, Exim is
17980 usually running as the Exim user, not as root. If the &(queryprogram)& router
17981 is called from a non-root process, Exim cannot change uid or gid before running
17982 the command. In this circumstance the command runs under the current uid and
17983 gid.
17984
17985
17986 .option current_directory queryprogram string /
17987 This option specifies an absolute path which is made the current directory
17988 before running the command.
17989
17990
17991 .option timeout queryprogram time 1h
17992 If the command does not complete within the timeout period, its process group
17993 is killed and the message is frozen. A value of zero time specifies no
17994 timeout.
17995
17996
17997 The standard output of the command is connected to a pipe, which is read when
17998 the command terminates. It should consist of a single line of output,
17999 containing up to five fields, separated by white space. The maximum length of
18000 the line is 1023 characters. Longer lines are silently truncated. The first
18001 field is one of the following words (case-insensitive):
18002
18003 .ilist
18004 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18005 below).
18006 .next
18007 &'Decline'&: the router declines; pass the address to the next router, unless
18008 &%no_more%& is set.
18009 .next
18010 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18011 subsequent text on the line is an error message. If the router is run as part
18012 of address verification during an incoming SMTP message, the message is
18013 included in the SMTP response.
18014 .next
18015 &'Defer'&: routing could not be completed at this time; try again later. Any
18016 subsequent text on the line is an error message which is logged. It is not
18017 included in any SMTP response.
18018 .next
18019 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18020 .next
18021 &'Pass'&: pass the address to the next router (or the router specified by
18022 &%pass_router%&), overriding &%no_more%&.
18023 .next
18024 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18025 new addresses, which are routed independently, starting with the first router,
18026 or the router specified by &%redirect_router%&, if set.
18027 .endlist
18028
18029 When the first word is &'accept'&, the remainder of the line consists of a
18030 number of keyed data values, as follows (split into two lines here, to fit on
18031 the page):
18032 .code
18033 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18034 LOOKUP=byname|bydns DATA=<text>
18035 .endd
18036 The data items can be given in any order, and all are optional. If no transport
18037 is included, the transport specified by the generic &%transport%& option is
18038 used. The list of hosts and the lookup type are needed only if the transport is
18039 an &(smtp)& transport that does not itself supply a list of hosts.
18040
18041 The format of the list of hosts is the same as for the &(manualroute)& router.
18042 As well as host names and IP addresses with optional port numbers, as described
18043 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18044 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18045 (see section &<<SECThostshowused>>&).
18046
18047 If the lookup type is not specified, Exim behaves as follows when trying to
18048 find an IP address for each host: First, a DNS lookup is done. If this yields
18049 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18050 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18051 result of the lookup is the result of that call.
18052
18053 .vindex "&$address_data$&"
18054 If the DATA field is set, its value is placed in the &$address_data$&
18055 variable. For example, this return line
18056 .code
18057 accept hosts=x1.y.example:x2.y.example data="rule1"
18058 .endd
18059 routes the address to the default transport, passing a list of two hosts. When
18060 the transport runs, the string &"rule1"& is in &$address_data$&.
18061 .ecindex IIDquerou1
18062 .ecindex IIDquerou2
18063
18064
18065
18066
18067 . ////////////////////////////////////////////////////////////////////////////
18068 . ////////////////////////////////////////////////////////////////////////////
18069
18070 .chapter "The redirect router" "CHAPredirect"
18071 .scindex IIDredrou1 "&(redirect)& router"
18072 .scindex IIDredrou2 "routers" "&(redirect)&"
18073 .cindex "alias file" "in a &(redirect)& router"
18074 .cindex "address redirection" "&(redirect)& router"
18075 The &(redirect)& router handles several kinds of address redirection. Its most
18076 common uses are for resolving local part aliases from a central alias file
18077 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18078 files, but it has many other potential uses. The incoming address can be
18079 redirected in several different ways:
18080
18081 .ilist
18082 It can be replaced by one or more new addresses which are themselves routed
18083 independently.
18084 .next
18085 It can be routed to be delivered to a given file or directory.
18086 .next
18087 It can be routed to be delivered to a specified pipe command.
18088 .next
18089 It can cause an automatic reply to be generated.
18090 .next
18091 It can be forced to fail, optionally with a custom error message.
18092 .next
18093 It can be temporarily deferred, optionally with a custom message.
18094 .next
18095 It can be discarded.
18096 .endlist
18097
18098 The generic &%transport%& option must not be set for &(redirect)& routers.
18099 However, there are some private options which define transports for delivery to
18100 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18101 &%pipe_transport%& and &%reply_transport%& descriptions below.
18102
18103
18104
18105 .section "Redirection data" "SECID124"
18106 The router operates by interpreting a text string which it obtains either by
18107 expanding the contents of the &%data%& option, or by reading the entire
18108 contents of a file whose name is given in the &%file%& option. These two
18109 options are mutually exclusive. The first is commonly used for handling system
18110 aliases, in a configuration like this:
18111 .code
18112 system_aliases:
18113   driver = redirect
18114   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18115 .endd
18116 If the lookup fails, the expanded string in this example is empty. When the
18117 expansion of &%data%& results in an empty string, the router declines. A forced
18118 expansion failure also causes the router to decline; other expansion failures
18119 cause delivery to be deferred.
18120
18121 A configuration using &%file%& is commonly used for handling users'
18122 &_.forward_& files, like this:
18123 .code
18124 userforward:
18125   driver = redirect
18126   check_local_user
18127   file = $home/.forward
18128   no_verify
18129 .endd
18130 If the file does not exist, or causes no action to be taken (for example, it is
18131 empty or consists only of comments), the router declines. &*Warning*&: This
18132 is not the case when the file contains syntactically valid items that happen to
18133 yield empty addresses, for example, items containing only RFC 2822 address
18134 comments.
18135
18136
18137
18138 .section "Forward files and address verification" "SECID125"
18139 .cindex "address redirection" "while verifying"
18140 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18141 &_.forward_& files, as in the example above. There are two reasons for this:
18142
18143 .ilist
18144 When Exim is receiving an incoming SMTP message from a remote host, it is
18145 running under the Exim uid, not as root. Exim is unable to change uid to read
18146 the file as the user, and it may not be able to read it as the Exim user. So in
18147 practice the router may not be able to operate.
18148 .next
18149 However, even when the router can operate, the existence of a &_.forward_& file
18150 is unimportant when verifying an address. What should be checked is whether the
18151 local part is a valid user name or not. Cutting out the redirection processing
18152 saves some resources.
18153 .endlist
18154
18155
18156
18157
18158
18159
18160 .section "Interpreting redirection data" "SECID126"
18161 .cindex "Sieve filter" "specifying in redirection data"
18162 .cindex "filter" "specifying in redirection data"
18163 The contents of the data string, whether obtained from &%data%& or &%file%&,
18164 can be interpreted in two different ways:
18165
18166 .ilist
18167 If the &%allow_filter%& option is set true, and the data begins with the text
18168 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18169 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18170 respectively. Details of the syntax and semantics of filter files are described
18171 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18172 document is intended for use by end users.
18173 .next
18174 Otherwise, the data must be a comma-separated list of redirection items, as
18175 described in the next section.
18176 .endlist
18177
18178 When a message is redirected to a file (a &"mail folder"&), the file name given
18179 in a non-filter redirection list must always be an absolute path. A filter may
18180 generate a relative path &-- how this is handled depends on the transport's
18181 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18182 for the &(appendfile)& transport.
18183
18184
18185
18186 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18187 .cindex "address redirection" "non-filter list items"
18188 When the redirection data is not an Exim or Sieve filter, for example, if it
18189 comes from a conventional alias or forward file, it consists of a list of
18190 addresses, file names, pipe commands, or certain special items (see section
18191 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18192 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18193 depending on their default values. The items in the list are separated by
18194 commas or newlines.
18195 If a comma is required in an item, the entire item must be enclosed in double
18196 quotes.
18197
18198 Lines starting with a # character are comments, and are ignored, and # may
18199 also appear following a comma, in which case everything between the # and the
18200 next newline character is ignored.
18201
18202 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18203 double quotes are retained because some forms of mail address require their use
18204 (but never to enclose the entire address). In the following description,
18205 &"item"& refers to what remains after any surrounding double quotes have been
18206 removed.
18207
18208 .vindex "&$local_part$&"
18209 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18210 and the expansion contains a reference to &$local_part$&, you should make use
18211 of the &%quote_local_part%& expansion operator, in case the local part contains
18212 special characters. For example, to redirect all mail for the domain
18213 &'obsolete.example'&, retaining the existing local part, you could use this
18214 setting:
18215 .code
18216 data = ${quote_local_part:$local_part}@newdomain.example
18217 .endd
18218
18219
18220 .section "Redirecting to a local mailbox" "SECTredlocmai"
18221 .cindex "routing" "loops in"
18222 .cindex "loop" "while routing, avoidance of"
18223 .cindex "address redirection" "to local mailbox"
18224 A redirection item may safely be the same as the address currently under
18225 consideration. This does not cause a routing loop, because a router is
18226 automatically skipped if any ancestor of the address that is being processed
18227 is the same as the current address and was processed by the current router.
18228 Such an address is therefore passed to the following routers, so it is handled
18229 as if there were no redirection. When making this loop-avoidance test, the
18230 complete local part, including any prefix or suffix, is used.
18231
18232 .cindex "address redirection" "local part without domain"
18233 Specifying the same local part without a domain is a common usage in personal
18234 filter files when the user wants to have messages delivered to the local
18235 mailbox and also forwarded elsewhere. For example, the user whose login is
18236 &'cleo'& might have a &_.forward_& file containing this:
18237 .code
18238 cleo, cleopatra@egypt.example
18239 .endd
18240 .cindex "backslash in alias file"
18241 .cindex "alias file" "backslash in"
18242 For compatibility with other MTAs, such unqualified local parts may be
18243 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18244 it does make a difference if more than one domain is being handled
18245 synonymously.
18246
18247 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18248 2822 address that does not include a domain, the item is qualified using the
18249 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18250 addresses are qualified using the value in &%qualify_recipient%&, but you can
18251 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18252
18253 Care must be taken if there are alias names for local users.
18254 Consider an MTA handling a single local domain where the system alias file
18255 contains:
18256 .code
18257 Sam.Reman: spqr
18258 .endd
18259 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18260 messages in the local mailbox, and also forward copies elsewhere. He creates
18261 this forward file:
18262 .code
18263 Sam.Reman, spqr@reme.elsewhere.example
18264 .endd
18265 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18266 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18267 second time round, because it has previously routed it,
18268 and the following routers presumably cannot handle the alias. The forward file
18269 should really contain
18270 .code
18271 spqr, spqr@reme.elsewhere.example
18272 .endd
18273 but because this is such a common error, the &%check_ancestor%& option (see
18274 below) exists to provide a way to get round it. This is normally set on a
18275 &(redirect)& router that is handling users' &_.forward_& files.
18276
18277
18278
18279 .section "Special items in redirection lists" "SECTspecitredli"
18280 In addition to addresses, the following types of item may appear in redirection
18281 lists (that is, in non-filter redirection data):
18282
18283 .ilist
18284 .cindex "pipe" "in redirection list"
18285 .cindex "address redirection" "to pipe"
18286 An item is treated as a pipe command if it begins with &"|"& and does not parse
18287 as a valid RFC 2822 address that includes a domain. A transport for running the
18288 command must be specified by the &%pipe_transport%& option.
18289 Normally, either the router or the transport specifies a user and a group under
18290 which to run the delivery. The default is to use the Exim user and group.
18291
18292 Single or double quotes can be used for enclosing the individual arguments of
18293 the pipe command; no interpretation of escapes is done for single quotes. If
18294 the command contains a comma character, it is necessary to put the whole item
18295 in double quotes, for example:
18296 .code
18297 "|/some/command ready,steady,go"
18298 .endd
18299 since items in redirection lists are terminated by commas. Do not, however,
18300 quote just the command. An item such as
18301 .code
18302 |"/some/command ready,steady,go"
18303 .endd
18304 is interpreted as a pipe with a rather strange command name, and no arguments.
18305
18306 .next
18307 .cindex "file" "in redirection list"
18308 .cindex "address redirection" "to file"
18309 An item is interpreted as a path name if it begins with &"/"& and does not
18310 parse as a valid RFC 2822 address that includes a domain. For example,
18311 .code
18312 /home/world/minbari
18313 .endd
18314 is treated as a file name, but
18315 .code
18316 /s=molari/o=babylon/@x400gate.way
18317 .endd
18318 is treated as an address. For a file name, a transport must be specified using
18319 the &%file_transport%& option. However, if the generated path name ends with a
18320 forward slash character, it is interpreted as a directory name rather than a
18321 file name, and &%directory_transport%& is used instead.
18322
18323 Normally, either the router or the transport specifies a user and a group under
18324 which to run the delivery. The default is to use the Exim user and group.
18325
18326 .cindex "&_/dev/null_&"
18327 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18328 bypassed at a high level, and the log entry shows &"**bypassed**"&
18329 instead of a transport name. In this case the user and group are not used.
18330
18331 .next
18332 .cindex "included address list"
18333 .cindex "address redirection" "included external list"
18334 If an item is of the form
18335 .code
18336 :include:<path name>
18337 .endd
18338 a list of further items is taken from the given file and included at that
18339 point. &*Note*&: Such a file can not be a filter file; it is just an
18340 out-of-line addition to the list. The items in the included list are separated
18341 by commas or newlines and are not subject to expansion. If this is the first
18342 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18343 the alias name. This example is incorrect:
18344 .code
18345 list1    :include:/opt/lists/list1
18346 .endd
18347 It must be given as
18348 .code
18349 list1:   :include:/opt/lists/list1
18350 .endd
18351 .next
18352 .cindex "address redirection" "to black hole"
18353 Sometimes you want to throw away mail to a particular local part. Making the
18354 &%data%& option expand to an empty string does not work, because that causes
18355 the router to decline. Instead, the alias item
18356 .cindex "black hole"
18357 .cindex "abandoning mail"
18358 &':blackhole:'& can be used. It does what its name implies. No delivery is
18359 done, and no error message is generated. This has the same effect as specifing
18360 &_/dev/null_& as a destination, but it can be independently disabled.
18361
18362 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18363 delivery is done for the original local part, even if other redirection items
18364 are present. If you are generating a multi-item list (for example, by reading a
18365 database) and need the ability to provide a no-op item, you must use
18366 &_/dev/null_&.
18367
18368 .next
18369 .cindex "delivery" "forcing failure"
18370 .cindex "delivery" "forcing deferral"
18371 .cindex "failing delivery" "forcing"
18372 .cindex "deferred delivery, forcing"
18373 .cindex "customizing" "failure message"
18374 An attempt to deliver a particular address can be deferred or forced to fail by
18375 redirection items of the form
18376 .code
18377 :defer:
18378 :fail:
18379 .endd
18380 respectively. When a redirection list contains such an item, it applies
18381 to the entire redirection; any other items in the list are ignored. Any
18382 text following &':fail:'& or &':defer:'& is placed in the error text
18383 associated with the failure. For example, an alias file might contain:
18384 .code
18385 X.Employee:  :fail: Gone away, no forwarding address
18386 .endd
18387 In the case of an address that is being verified from an ACL or as the subject
18388 of a
18389 .cindex "VRFY" "error text, display of"
18390 VRFY command, the text is included in the SMTP error response by
18391 default.
18392 .cindex "EXPN" "error text, display of"
18393 The text is not included in the response to an EXPN command. In non-SMTP cases
18394 the text is included in the error message that Exim generates.
18395
18396 .cindex "SMTP" "error codes"
18397 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18398 &':fail:'&. However, if the message starts with three digits followed by a
18399 space, optionally followed by an extended code of the form &'n.n.n'&, also
18400 followed by a space, and the very first digit is the same as the default error
18401 code, the code from the message is used instead. If the very first digit is
18402 incorrect, a panic error is logged, and the default code is used. You can
18403 suppress the use of the supplied code in a redirect router by setting the
18404 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18405 ignored.
18406
18407 .vindex "&$acl_verify_message$&"
18408 In an ACL, an explicitly provided message overrides the default, but the
18409 default message is available in the variable &$acl_verify_message$& and can
18410 therefore be included in a custom message if this is desired.
18411
18412 Normally the error text is the rest of the redirection list &-- a comma does
18413 not terminate it &-- but a newline does act as a terminator. Newlines are not
18414 normally present in alias expansions. In &(lsearch)& lookups they are removed
18415 as part of the continuation process, but they may exist in other kinds of
18416 lookup and in &':include:'& files.
18417
18418 During routing for message delivery (as opposed to verification), a redirection
18419 containing &':fail:'& causes an immediate failure of the incoming address,
18420 whereas &':defer:'& causes the message to remain on the queue so that a
18421 subsequent delivery attempt can happen at a later time. If an address is
18422 deferred for too long, it will ultimately fail, because the normal retry
18423 rules still apply.
18424
18425 .next
18426 .cindex "alias file" "exception to default"
18427 Sometimes it is useful to use a single-key search type with a default (see
18428 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18429 for exceptions to the default. These can be handled by aliasing them to
18430 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18431 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18432 results in an empty redirection list has the same effect.
18433 .endlist
18434
18435
18436 .section "Duplicate addresses" "SECTdupaddr"
18437 .cindex "duplicate addresses"
18438 .cindex "address duplicate, discarding"
18439 .cindex "pipe" "duplicated"
18440 Exim removes duplicate addresses from the list to which it is delivering, so as
18441 to deliver just one copy to each address. This does not apply to deliveries
18442 routed to pipes by different immediate parent addresses, but an indirect
18443 aliasing scheme of the type
18444 .code
18445 pipe:       |/some/command $local_part
18446 localpart1: pipe
18447 localpart2: pipe
18448 .endd
18449 does not work with a message that is addressed to both local parts, because
18450 when the second is aliased to the intermediate local part &"pipe"& it gets
18451 discarded as being the same as a previously handled address. However, a scheme
18452 such as
18453 .code
18454 localpart1: |/some/command $local_part
18455 localpart2: |/some/command $local_part
18456 .endd
18457 does result in two different pipe deliveries, because the immediate parents of
18458 the pipes are distinct.
18459
18460
18461
18462 .section "Repeated redirection expansion" "SECID128"
18463 .cindex "repeated redirection expansion"
18464 .cindex "address redirection" "repeated for each delivery attempt"
18465 When a message cannot be delivered to all of its recipients immediately,
18466 leading to two or more delivery attempts, redirection expansion is carried out
18467 afresh each time for those addresses whose children were not all previously
18468 delivered. If redirection is being used as a mailing list, this can lead to new
18469 members of the list receiving copies of old messages. The &%one_time%& option
18470 can be used to avoid this.
18471
18472
18473 .section "Errors in redirection lists" "SECID129"
18474 .cindex "address redirection" "errors"
18475 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18476 error is skipped, and an entry is written to the main log. This may be useful
18477 for mailing lists that are automatically managed. Otherwise, if an error is
18478 detected while generating the list of new addresses, the original address is
18479 deferred. See also &%syntax_errors_to%&.
18480
18481
18482
18483 .section "Private options for the redirect router" "SECID130"
18484
18485 .cindex "options" "&(redirect)& router"
18486 The private options for the &(redirect)& router are as follows:
18487
18488
18489 .option allow_defer redirect boolean false
18490 Setting this option allows the use of &':defer:'& in non-filter redirection
18491 data, or the &%defer%& command in an Exim filter file.
18492
18493
18494 .option allow_fail redirect boolean false
18495 .cindex "failing delivery" "from filter"
18496 If this option is true, the &':fail:'& item can be used in a redirection list,
18497 and the &%fail%& command may be used in an Exim filter file.
18498
18499
18500 .option allow_filter redirect boolean false
18501 .cindex "filter" "enabling use of"
18502 .cindex "Sieve filter" "enabling use of"
18503 Setting this option allows Exim to interpret redirection data that starts with
18504 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18505 are some features of Exim filter files that some administrators may wish to
18506 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18507
18508 It is also possible to lock out Exim filters or Sieve filters while allowing
18509 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18510
18511
18512 The filter is run using the uid and gid set by the generic &%user%& and
18513 &%group%& options. These take their defaults from the password data if
18514 &%check_local_user%& is set, so in the normal case of users' personal filter
18515 files, the filter is run as the relevant user. When &%allow_filter%& is set
18516 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18517
18518
18519
18520 .option allow_freeze redirect boolean false
18521 .cindex "freezing messages" "allowing in filter"
18522 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18523 This command is more normally encountered in system filters, and is disabled by
18524 default for redirection filters because it isn't something you usually want to
18525 let ordinary users do.
18526
18527
18528
18529 .option check_ancestor redirect boolean false
18530 This option is concerned with handling generated addresses that are the same
18531 as some address in the list of redirection ancestors of the current address.
18532 Although it is turned off by default in the code, it is set in the default
18533 configuration file for handling users' &_.forward_& files. It is recommended
18534 for this use of the &(redirect)& router.
18535
18536 When &%check_ancestor%& is set, if a generated address (including the domain)
18537 is the same as any ancestor of the current address, it is replaced by a copy of
18538 the current address. This helps in the case where local part A is aliased to B,
18539 and B has a &_.forward_& file pointing back to A. For example, within a single
18540 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18541 &_&~jb/.forward_& contains:
18542 .code
18543 \Joe.Bloggs, <other item(s)>
18544 .endd
18545 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18546 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18547 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18548 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18549 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18550 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18551 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18552 original address. See also the &%repeat_use%& option below.
18553
18554
18555 .option check_group redirect boolean "see below"
18556 When the &%file%& option is used, the group owner of the file is checked only
18557 when this option is set. The permitted groups are those listed in the
18558 &%owngroups%& option, together with the user's default group if
18559 &%check_local_user%& is set. If the file has the wrong group, routing is
18560 deferred. The default setting for this option is true if &%check_local_user%&
18561 is set and the &%modemask%& option permits the group write bit, or if the
18562 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18563
18564
18565
18566 .option check_owner redirect boolean "see below"
18567 When the &%file%& option is used, the owner of the file is checked only when
18568 this option is set. If &%check_local_user%& is set, the local user is
18569 permitted; otherwise the owner must be one of those listed in the &%owners%&
18570 option. The default value for this option is true if &%check_local_user%& or
18571 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18572
18573
18574 .option data redirect string&!! unset
18575 This option is mutually exclusive with &%file%&. One or other of them must be
18576 set, but not both. The contents of &%data%& are expanded, and then used as the
18577 list of forwarding items, or as a set of filtering instructions. If the
18578 expansion is forced to fail, or the result is an empty string or a string that
18579 has no effect (consists entirely of comments), the router declines.
18580
18581 When filtering instructions are used, the string must begin with &"#Exim
18582 filter"&, and all comments in the string, including this initial one, must be
18583 terminated with newline characters. For example:
18584 .code
18585 data = #Exim filter\n\
18586        if $h_to: contains Exim then save $home/mail/exim endif
18587 .endd
18588 If you are reading the data from a database where newlines cannot be included,
18589 you can use the &${sg}$& expansion item to turn the escape string of your
18590 choice into a newline.
18591
18592
18593 .option directory_transport redirect string&!! unset
18594 A &(redirect)& router sets up a direct delivery to a directory when a path name
18595 ending with a slash is specified as a new &"address"&. The transport used is
18596 specified by this option, which, after expansion, must be the name of a
18597 configured transport. This should normally be an &(appendfile)& transport.
18598
18599
18600 .option file redirect string&!! unset
18601 This option specifies the name of a file that contains the redirection data. It
18602 is mutually exclusive with the &%data%& option. The string is expanded before
18603 use; if the expansion is forced to fail, the router declines. Other expansion
18604 failures cause delivery to be deferred. The result of a successful expansion
18605 must be an absolute path. The entire file is read and used as the redirection
18606 data. If the data is an empty string or a string that has no effect (consists
18607 entirely of comments), the router declines.
18608
18609 .cindex "NFS" "checking for file existence"
18610 If the attempt to open the file fails with a &"does not exist"& error, Exim
18611 runs a check on the containing directory,
18612 unless &%ignore_enotdir%& is true (see below).
18613 If the directory does not appear to exist, delivery is deferred. This can
18614 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18615 is a mount problem. If the containing directory does exist, but the file does
18616 not, the router declines.
18617
18618
18619 .option file_transport redirect string&!! unset
18620 .vindex "&$address_file$&"
18621 A &(redirect)& router sets up a direct delivery to a file when a path name not
18622 ending in a slash is specified as a new &"address"&. The transport used is
18623 specified by this option, which, after expansion, must be the name of a
18624 configured transport. This should normally be an &(appendfile)& transport. When
18625 it is running, the file name is in &$address_file$&.
18626
18627
18628 .option filter_prepend_home redirect boolean true
18629 When this option is true, if a &(save)& command in an Exim filter specifies a
18630 relative path, and &$home$& is defined, it is automatically prepended to the
18631 relative path. If this option is set false, this action does not happen. The
18632 relative path is then passed to the transport unmodified.
18633
18634
18635 .option forbid_blackhole redirect boolean false
18636 If this option is true, the &':blackhole:'& item may not appear in a
18637 redirection list.
18638
18639
18640 .option forbid_exim_filter redirect boolean false
18641 If this option is set true, only Sieve filters are permitted when
18642 &%allow_filter%& is true.
18643
18644
18645
18646
18647 .option forbid_file redirect boolean false
18648 .cindex "delivery" "to file; forbidding"
18649 .cindex "Sieve filter" "forbidding delivery to a file"
18650 .cindex "Sieve filter" "&""keep""& facility; disabling"
18651 If this option is true, this router may not generate a new address that
18652 specifies delivery to a local file or directory, either from a filter or from a
18653 conventional forward file. This option is forced to be true if &%one_time%& is
18654 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18655 locks out the Sieve's &"keep"& facility.
18656
18657
18658 .option forbid_filter_dlfunc redirect boolean false
18659 .cindex "filter" "locking out certain features"
18660 If this option is true, string expansions in Exim filters are not allowed to
18661 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18662 functions.
18663
18664 .option forbid_filter_existstest redirect boolean false
18665 .cindex "expansion" "statting a file"
18666 If this option is true, string expansions in Exim filters are not allowed to
18667 make use of the &%exists%& condition or the &%stat%& expansion item.
18668
18669 .option forbid_filter_logwrite redirect boolean false
18670 If this option is true, use of the logging facility in Exim filters is not
18671 permitted. Logging is in any case available only if the filter is being run
18672 under some unprivileged uid (which is normally the case for ordinary users'
18673 &_.forward_& files).
18674
18675
18676 .option forbid_filter_lookup redirect boolean false
18677 If this option is true, string expansions in Exim filter files are not allowed
18678 to make use of &%lookup%& items.
18679
18680
18681 .option forbid_filter_perl redirect boolean false
18682 This option has an effect only if Exim is built with embedded Perl support. If
18683 it is true, string expansions in Exim filter files are not allowed to make use
18684 of the embedded Perl support.
18685
18686
18687 .option forbid_filter_readfile redirect boolean false
18688 If this option is true, string expansions in Exim filter files are not allowed
18689 to make use of &%readfile%& items.
18690
18691
18692 .option forbid_filter_readsocket redirect boolean false
18693 If this option is true, string expansions in Exim filter files are not allowed
18694 to make use of &%readsocket%& items.
18695
18696
18697 .option forbid_filter_reply redirect boolean false
18698 If this option is true, this router may not generate an automatic reply
18699 message. Automatic replies can be generated only from Exim or Sieve filter
18700 files, not from traditional forward files. This option is forced to be true if
18701 &%one_time%& is set.
18702
18703
18704 .option forbid_filter_run redirect boolean false
18705 If this option is true, string expansions in Exim filter files are not allowed
18706 to make use of &%run%& items.
18707
18708
18709 .option forbid_include redirect boolean false
18710 If this option is true, items of the form
18711 .code
18712 :include:<path name>
18713 .endd
18714 are not permitted in non-filter redirection lists.
18715
18716
18717 .option forbid_pipe redirect boolean false
18718 .cindex "delivery" "to pipe; forbidding"
18719 If this option is true, this router may not generate a new address which
18720 specifies delivery to a pipe, either from an Exim filter or from a conventional
18721 forward file. This option is forced to be true if &%one_time%& is set.
18722
18723
18724 .option forbid_sieve_filter redirect boolean false
18725 If this option is set true, only Exim filters are permitted when
18726 &%allow_filter%& is true.
18727
18728
18729 .cindex "SMTP" "error codes"
18730 .option forbid_smtp_code redirect boolean false
18731 If this option is set true, any SMTP error codes that are present at the start
18732 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18733 the default codes (451 and 550, respectively) are always used.
18734
18735
18736
18737
18738 .option hide_child_in_errmsg redirect boolean false
18739 .cindex "bounce message" "redirection details; suppressing"
18740 If this option is true, it prevents Exim from quoting a child address if it
18741 generates a bounce or delay message for it. Instead it says &"an address
18742 generated from <&'the top level address'&>"&. Of course, this applies only to
18743 bounces generated locally. If a message is forwarded to another host, &'its'&
18744 bounce may well quote the generated address.
18745
18746
18747 .option ignore_eacces redirect boolean false
18748 .cindex "EACCES"
18749 If this option is set and an attempt to open a redirection file yields the
18750 EACCES error (permission denied), the &(redirect)& router behaves as if the
18751 file did not exist.
18752
18753
18754 .option ignore_enotdir redirect boolean false
18755 .cindex "ENOTDIR"
18756 If this option is set and an attempt to open a redirection file yields the
18757 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18758 router behaves as if the file did not exist.
18759
18760 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18761 router that has the &%file%& option set discovers that the file does not exist
18762 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18763 against unmounted NFS directories. If the parent can not be statted, delivery
18764 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18765 is set, because that option tells Exim to ignore &"something on the path is not
18766 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18767 that some operating systems give ENOENT where others give ENOTDIR.
18768
18769
18770
18771 .option include_directory redirect string unset
18772 If this option is set, the path names of any &':include:'& items in a
18773 redirection list must start with this directory.
18774
18775
18776 .option modemask redirect "octal integer" 022
18777 This specifies mode bits which must not be set for a file specified by the
18778 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18779
18780
18781 .option one_time redirect boolean false
18782 .cindex "one-time aliasing/forwarding expansion"
18783 .cindex "alias file" "one-time expansion"
18784 .cindex "forward file" "one-time expansion"
18785 .cindex "mailing lists" "one-time expansion"
18786 .cindex "address redirection" "one-time expansion"
18787 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18788 files each time it tries to deliver a message causes a problem when one or more
18789 of the generated addresses fails be delivered at the first attempt. The problem
18790 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18791 but of what happens when the redirection list changes during the time that the
18792 message is on Exim's queue. This is particularly true in the case of mailing
18793 lists, where new subscribers might receive copies of messages that were posted
18794 before they subscribed.
18795
18796 If &%one_time%& is set and any addresses generated by the router fail to
18797 deliver at the first attempt, the failing addresses are added to the message as
18798 &"top level"& addresses, and the parent address that generated them is marked
18799 &"delivered"&. Thus, redirection does not happen again at the next delivery
18800 attempt.
18801
18802 &*Warning 1*&: Any header line addition or removal that is specified by this
18803 router would be lost if delivery did not succeed at the first attempt. For this
18804 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18805 permitted when &%one_time%& is set.
18806
18807 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18808 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18809 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18810
18811 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18812 &%one_time%&.
18813
18814 The original top-level address is remembered with each of the generated
18815 addresses, and is output in any log messages. However, any intermediate parent
18816 addresses are not recorded. This makes a difference to the log only if
18817 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18818 typically be used for mailing lists, where there is normally just one level of
18819 expansion.
18820
18821
18822 .option owners redirect "string list" unset
18823 .cindex "ownership" "alias file"
18824 .cindex "ownership" "forward file"
18825 .cindex "alias file" "ownership"
18826 .cindex "forward file" "ownership"
18827 This specifies a list of permitted owners for the file specified by &%file%&.
18828 This list is in addition to the local user when &%check_local_user%& is set.
18829 See &%check_owner%& above.
18830
18831
18832 .option owngroups redirect "string list" unset
18833 This specifies a list of permitted groups for the file specified by &%file%&.
18834 The list is in addition to the local user's primary group when
18835 &%check_local_user%& is set. See &%check_group%& above.
18836
18837
18838 .option pipe_transport redirect string&!! unset
18839 .vindex "&$address_pipe$&"
18840 A &(redirect)& router sets up a direct delivery to a pipe when a string
18841 starting with a vertical bar character is specified as a new &"address"&. The
18842 transport used is specified by this option, which, after expansion, must be the
18843 name of a configured transport. This should normally be a &(pipe)& transport.
18844 When the transport is run, the pipe command is in &$address_pipe$&.
18845
18846
18847 .option qualify_domain redirect string&!! unset
18848 .vindex "&$qualify_recipient$&"
18849 If this option is set, and an unqualified address (one without a domain) is
18850 generated, and that address would normally be qualified by the global setting
18851 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18852 expanding this string. If the expansion fails, the router declines. If you want
18853 to revert to the default, you can have the expansion generate
18854 &$qualify_recipient$&.
18855
18856 This option applies to all unqualified addresses generated by Exim filters,
18857 but for traditional &_.forward_& files, it applies only to addresses that are
18858 not preceded by a backslash. Sieve filters cannot generate unqualified
18859 addresses.
18860
18861 .option qualify_preserve_domain redirect boolean false
18862 .cindex "domain" "in redirection; preserving"
18863 .cindex "preserving domain in redirection"
18864 .cindex "address redirection" "domain; preserving"
18865 If this option is set, the router's local &%qualify_domain%& option must not be
18866 set (a configuration error occurs if it is). If an unqualified address (one
18867 without a domain) is generated, it is qualified with the domain of the parent
18868 address (the immediately preceding ancestor) instead of the global
18869 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18870 this applies whether or not the address is preceded by a backslash.
18871
18872
18873 .option repeat_use redirect boolean true
18874 If this option is set false, the router is skipped for a child address that has
18875 any ancestor that was routed by this router. This test happens before any of
18876 the other preconditions are tested. Exim's default anti-looping rules skip
18877 only when the ancestor is the same as the current address. See also
18878 &%check_ancestor%& above and the generic &%redirect_router%& option.
18879
18880
18881 .option reply_transport redirect string&!! unset
18882 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18883 &%vacation%& command is used in a filter file. The transport used is specified
18884 by this option, which, after expansion, must be the name of a configured
18885 transport. This should normally be an &(autoreply)& transport. Other transports
18886 are unlikely to do anything sensible or useful.
18887
18888
18889 .option rewrite redirect boolean true
18890 .cindex "address redirection" "disabling rewriting"
18891 If this option is set false, addresses generated by the router are not
18892 subject to address rewriting. Otherwise, they are treated like new addresses
18893 and are rewritten according to the global rewriting rules.
18894
18895
18896 .option sieve_subaddress redirect string&!! unset
18897 The value of this option is passed to a Sieve filter to specify the
18898 :subaddress part of an address.
18899
18900 .option sieve_useraddress redirect string&!! unset
18901 The value of this option is passed to a Sieve filter to specify the :user part
18902 of an address. However, if it is unset, the entire original local part
18903 (including any prefix or suffix) is used for :user.
18904
18905
18906 .option sieve_vacation_directory redirect string&!! unset
18907 .cindex "Sieve filter" "vacation directory"
18908 To enable the &"vacation"& extension for Sieve filters, you must set
18909 &%sieve_vacation_directory%& to the directory where vacation databases are held
18910 (do not put anything else in that directory), and ensure that the
18911 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18912 needs their own directory; Exim will create it if necessary.
18913
18914
18915
18916 .option skip_syntax_errors redirect boolean false
18917 .cindex "forward file" "broken"
18918 .cindex "address redirection" "broken files"
18919 .cindex "alias file" "broken"
18920 .cindex "broken alias or forward files"
18921 .cindex "ignoring faulty addresses"
18922 .cindex "skipping faulty addresses"
18923 .cindex "error" "skipping bad syntax"
18924 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18925 non-filter redirection data are skipped, and each failing address is logged. If
18926 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18927 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18928 are expanded and placed at the head of the error message generated by
18929 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18930 be the same address as the generic &%errors_to%& option. The
18931 &%skip_syntax_errors%& option is often used when handling mailing lists.
18932
18933 If all the addresses in a redirection list are skipped because of syntax
18934 errors, the router declines to handle the original address, and it is passed to
18935 the following routers.
18936
18937 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18938 error in the filter causes filtering to be abandoned without any action being
18939 taken. The incident is logged, and the router declines to handle the address,
18940 so it is passed to the following routers.
18941
18942 .cindex "Sieve filter" "syntax errors in"
18943 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18944 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18945 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18946
18947 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18948 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18949 option, used with an address that does not get redirected, can be used to
18950 notify users of these errors, by means of a router like this:
18951 .code
18952 userforward:
18953   driver = redirect
18954   allow_filter
18955   check_local_user
18956   file = $home/.forward
18957   file_transport = address_file
18958   pipe_transport = address_pipe
18959   reply_transport = address_reply
18960   no_verify
18961   skip_syntax_errors
18962   syntax_errors_to = real-$local_part@$domain
18963   syntax_errors_text = \
18964    This is an automatically generated message. An error has\n\
18965    been found in your .forward file. Details of the error are\n\
18966    reported below. While this error persists, you will receive\n\
18967    a copy of this message for every message that is addressed\n\
18968    to you. If your .forward file is a filter file, or if it is\n\
18969    a non-filter file containing no valid forwarding addresses,\n\
18970    a copy of each incoming message will be put in your normal\n\
18971    mailbox. If a non-filter file contains at least one valid\n\
18972    forwarding address, forwarding to the valid addresses will\n\
18973    happen, and those will be the only deliveries that occur.
18974 .endd
18975 You also need a router to ensure that local addresses that are prefixed by
18976 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18977 put this immediately before the &(userforward)& router:
18978 .code
18979 real_localuser:
18980   driver = accept
18981   check_local_user
18982   local_part_prefix = real-
18983   transport = local_delivery
18984 .endd
18985 For security, it would probably be a good idea to restrict the use of this
18986 router to locally-generated messages, using a condition such as this:
18987 .code
18988   condition = ${if match {$sender_host_address}\
18989                          {\N^(|127\.0\.0\.1)$\N}}
18990 .endd
18991
18992
18993 .option syntax_errors_text redirect string&!! unset
18994 See &%skip_syntax_errors%& above.
18995
18996
18997 .option syntax_errors_to redirect string unset
18998 See &%skip_syntax_errors%& above.
18999 .ecindex IIDredrou1
19000 .ecindex IIDredrou2
19001
19002
19003
19004
19005
19006
19007 . ////////////////////////////////////////////////////////////////////////////
19008 . ////////////////////////////////////////////////////////////////////////////
19009
19010 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19011          "Environment for local transports"
19012 .scindex IIDenvlotra1 "local transports" "environment for"
19013 .scindex IIDenvlotra2 "environment for local transports"
19014 .scindex IIDenvlotra3 "transport" "local; environment for"
19015 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19016 transport can be thought of as similar to a pipe.) Exim always runs transports
19017 in subprocesses, under specified uids and gids. Typical deliveries to local
19018 mailboxes run under the uid and gid of the local user.
19019
19020 Exim also sets a specific current directory while running the transport; for
19021 some transports a home directory setting is also relevant. The &(pipe)&
19022 transport is the only one that sets up environment variables; see section
19023 &<<SECTpipeenv>>& for details.
19024
19025 The values used for the uid, gid, and the directories may come from several
19026 different places. In many cases, the router that handles the address associates
19027 settings with that address as a result of its &%check_local_user%&, &%group%&,
19028 or &%user%& options. However, values may also be given in the transport's own
19029 configuration, and these override anything that comes from the router.
19030
19031
19032
19033 .section "Concurrent deliveries" "SECID131"
19034 .cindex "concurrent deliveries"
19035 .cindex "simultaneous deliveries"
19036 If two different messages for the same local recipient arrive more or less
19037 simultaneously, the two delivery processes are likely to run concurrently. When
19038 the &(appendfile)& transport is used to write to a file, Exim applies locking
19039 rules to stop concurrent processes from writing to the same file at the same
19040 time.
19041
19042 However, when you use a &(pipe)& transport, it is up to you to arrange any
19043 locking that is needed. Here is a silly example:
19044 .code
19045 my_transport:
19046   driver = pipe
19047   command = /bin/sh -c 'cat >>/some/file'
19048 .endd
19049 This is supposed to write the message at the end of the file. However, if two
19050 messages arrive at the same time, the file will be scrambled. You can use the
19051 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19052 file using the same algorithm that Exim itself uses.
19053
19054
19055
19056
19057 .section "Uids and gids" "SECTenvuidgid"
19058 .cindex "local transports" "uid and gid"
19059 .cindex "transport" "local; uid and gid"
19060 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19061 overrides any group that the router set in the address, even if &%user%& is not
19062 set for the transport. This makes it possible, for example, to run local mail
19063 delivery under the uid of the recipient (set by the router), but in a special
19064 group (set by the transport). For example:
19065 .code
19066 # Routers ...
19067 # User/group are set by check_local_user in this router
19068 local_users:
19069   driver = accept
19070   check_local_user
19071   transport = group_delivery
19072
19073 # Transports ...
19074 # This transport overrides the group
19075 group_delivery:
19076   driver = appendfile
19077   file = /var/spool/mail/$local_part
19078   group = mail
19079 .endd
19080 If &%user%& is set for a transport, its value overrides what is set in the
19081 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19082 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19083 set.
19084
19085 .oindex "&%initgroups%&"
19086 When the uid is taken from the transport's configuration, the &[initgroups()]&
19087 function is called for the groups associated with that uid if the
19088 &%initgroups%& option is set for the transport. When the uid is not specified
19089 by the transport, but is associated with the address by a router, the option
19090 for calling &[initgroups()]& is taken from the router configuration.
19091
19092 .cindex "&(pipe)& transport" "uid for"
19093 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19094 is set and &%user%& is not set, the uid of the process that called Exim to
19095 receive the message is used, and if &%group%& is not set, the corresponding
19096 original gid is also used.
19097
19098 This is the detailed preference order for obtaining a gid; the first of the
19099 following that is set is used:
19100
19101 .ilist
19102 A &%group%& setting of the transport;
19103 .next
19104 A &%group%& setting of the router;
19105 .next
19106 A gid associated with a user setting of the router, either as a result of
19107 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19108 .next
19109 The group associated with a non-numeric &%user%& setting of the transport;
19110 .next
19111 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19112 the uid is the creator's uid;
19113 .next
19114 The Exim gid if the Exim uid is being used as a default.
19115 .endlist
19116
19117 If, for example, the user is specified numerically on the router and there are
19118 no group settings, no gid is available. In this situation, an error occurs.
19119 This is different for the uid, for which there always is an ultimate default.
19120 The first of the following that is set is used:
19121
19122 .ilist
19123 A &%user%& setting of the transport;
19124 .next
19125 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19126 .next
19127 A &%user%& setting of the router;
19128 .next
19129 A &%check_local_user%& setting of the router;
19130 .next
19131 The Exim uid.
19132 .endlist
19133
19134 Of course, an error will still occur if the uid that is chosen is on the
19135 &%never_users%& list.
19136
19137
19138
19139
19140
19141 .section "Current and home directories" "SECID132"
19142 .cindex "current directory for local transport"
19143 .cindex "home directory" "for local transport"
19144 .cindex "transport" "local; home directory for"
19145 .cindex "transport" "local; current directory for"
19146 Routers may set current and home directories for local transports by means of
19147 the &%transport_current_directory%& and &%transport_home_directory%& options.
19148 However, if the transport's &%current_directory%& or &%home_directory%& options
19149 are set, they override the router's values. In detail, the home directory
19150 for a local transport is taken from the first of these values that is set:
19151
19152 .ilist
19153 The &%home_directory%& option on the transport;
19154 .next
19155 The &%transport_home_directory%& option on the router;
19156 .next
19157 The password data if &%check_local_user%& is set on the router;
19158 .next
19159 The &%router_home_directory%& option on the router.
19160 .endlist
19161
19162 The current directory is taken from the first of these values that is set:
19163
19164 .ilist
19165 The &%current_directory%& option on the transport;
19166 .next
19167 The &%transport_current_directory%& option on the router.
19168 .endlist
19169
19170
19171 If neither the router nor the transport sets a current directory, Exim uses the
19172 value of the home directory, if it is set. Otherwise it sets the current
19173 directory to &_/_& before running a local transport.
19174
19175
19176
19177 .section "Expansion variables derived from the address" "SECID133"
19178 .vindex "&$domain$&"
19179 .vindex "&$local_part$&"
19180 .vindex "&$original_domain$&"
19181 Normally a local delivery is handling a single address, and in that case the
19182 variables such as &$domain$& and &$local_part$& are set during local
19183 deliveries. However, in some circumstances more than one address may be handled
19184 at once (for example, while writing batch SMTP for onward transmission by some
19185 other means). In this case, the variables associated with the local part are
19186 never set, &$domain$& is set only if all the addresses have the same domain,
19187 and &$original_domain$& is never set.
19188 .ecindex IIDenvlotra1
19189 .ecindex IIDenvlotra2
19190 .ecindex IIDenvlotra3
19191
19192
19193
19194
19195
19196
19197
19198 . ////////////////////////////////////////////////////////////////////////////
19199 . ////////////////////////////////////////////////////////////////////////////
19200
19201 .chapter "Generic options for transports" "CHAPtransportgeneric"
19202 .scindex IIDgenoptra1 "generic options" "transport"
19203 .scindex IIDgenoptra2 "options" "generic; for transports"
19204 .scindex IIDgenoptra3 "transport" "generic options for"
19205 The following generic options apply to all transports:
19206
19207
19208 .option body_only transports boolean false
19209 .cindex "transport" "body only"
19210 .cindex "message" "transporting body only"
19211 .cindex "body of message" "transporting"
19212 If this option is set, the message's headers are not transported. It is
19213 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19214 or &(pipe)& transports, the settings of &%message_prefix%& and
19215 &%message_suffix%& should be checked, because this option does not
19216 automatically suppress them.
19217
19218
19219 .option current_directory transports string&!! unset
19220 .cindex "transport" "current directory for"
19221 This specifies the current directory that is to be set while running the
19222 transport, overriding any value that may have been set by the router.
19223 If the expansion fails for any reason, including forced failure, an error is
19224 logged, and delivery is deferred.
19225
19226
19227 .option disable_logging transports boolean false
19228 If this option is set true, nothing is logged for any
19229 deliveries by the transport or for any
19230 transport errors. You should not set this option unless you really, really know
19231 what you are doing.
19232
19233
19234 .option debug_print transports string&!! unset
19235 .cindex "testing" "variables in drivers"
19236 If this option is set and debugging is enabled (see the &%-d%& command line
19237 option), the string is expanded and included in the debugging output when the
19238 transport is run.
19239 If expansion of the string fails, the error message is written to the debugging
19240 output, and Exim carries on processing.
19241 This facility is provided to help with checking out the values of variables and
19242 so on when debugging driver configurations. For example, if a &%headers_add%&
19243 option is not working properly, &%debug_print%& could be used to output the
19244 variables it references. A newline is added to the text if it does not end with
19245 one.
19246
19247
19248 .option delivery_date_add transports boolean false
19249 .cindex "&'Delivery-date:'& header line"
19250 If this option is true, a &'Delivery-date:'& header is added to the message.
19251 This gives the actual time the delivery was made. As this is not a standard
19252 header, Exim has a configuration option (&%delivery_date_remove%&) which
19253 requests its removal from incoming messages, so that delivered messages can
19254 safely be resent to other recipients.
19255
19256
19257 .option driver transports string unset
19258 This specifies which of the available transport drivers is to be used.
19259 There is no default, and this option must be set for every transport.
19260
19261
19262 .option envelope_to_add transports boolean false
19263 .cindex "&'Envelope-to:'& header line"
19264 If this option is true, an &'Envelope-to:'& header is added to the message.
19265 This gives the original address(es) in the incoming envelope that caused this
19266 delivery to happen. More than one address may be present if the transport is
19267 configured to handle several addresses at once, or if more than one original
19268 address was redirected to the same final address. As this is not a standard
19269 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19270 its removal from incoming messages, so that delivered messages can safely be
19271 resent to other recipients.
19272
19273
19274 .option group transports string&!! "Exim group"
19275 .cindex "transport" "group; specifying"
19276 This option specifies a gid for running the transport process, overriding any
19277 value that the router supplies, and also overriding any value associated with
19278 &%user%& (see below).
19279
19280
19281 .option headers_add transports string&!! unset
19282 .cindex "header lines" "adding in transport"
19283 .cindex "transport" "header lines; adding"
19284 This option specifies a string of text that is expanded and added to the header
19285 portion of a message as it is transported, as described in section
19286 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19287 routers. If the result of the expansion is an empty string, or if the expansion
19288 is forced to fail, no action is taken. Other expansion failures are treated as
19289 errors and cause the delivery to be deferred.
19290
19291
19292
19293 .option headers_only transports boolean false
19294 .cindex "transport" "header lines only"
19295 .cindex "message" "transporting headers only"
19296 .cindex "header lines" "transporting"
19297 If this option is set, the message's body is not transported. It is mutually
19298 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19299 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19300 checked, since this option does not automatically suppress them.
19301
19302
19303 .option headers_remove transports string&!! unset
19304 .cindex "header lines" "removing"
19305 .cindex "transport" "header lines; removing"
19306 This option specifies a string that is expanded into a list of header names;
19307 these headers are omitted from the message as it is transported, as described
19308 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19309 routers. If the result of the expansion is an empty string, or if the expansion
19310 is forced to fail, no action is taken. Other expansion failures are treated as
19311 errors and cause the delivery to be deferred.
19312
19313
19314
19315 .option headers_rewrite transports string unset
19316 .cindex "transport" "header lines; rewriting"
19317 .cindex "rewriting" "at transport time"
19318 This option allows addresses in header lines to be rewritten at transport time,
19319 that is, as the message is being copied to its destination. The contents of the
19320 option are a colon-separated list of rewriting rules. Each rule is in exactly
19321 the same form as one of the general rewriting rules that are applied when a
19322 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19323 example,
19324 .code
19325 headers_rewrite = a@b c@d f : \
19326                   x@y w@z
19327 .endd
19328 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19329 &'w@z'& in all address-bearing header lines. The rules are applied to the
19330 header lines just before they are written out at transport time, so they affect
19331 only those copies of the message that pass through the transport. However, only
19332 the message's original header lines, and any that were added by a system
19333 filter, are rewritten. If a router or transport adds header lines, they are not
19334 affected by this option. These rewriting rules are &'not'& applied to the
19335 envelope. You can change the return path using &%return_path%&, but you cannot
19336 change envelope recipients at this time.
19337
19338
19339 .option home_directory transports string&!! unset
19340 .cindex "transport" "home directory for"
19341 .vindex "&$home$&"
19342 This option specifies a home directory setting for a local transport,
19343 overriding any value that may be set by the router. The home directory is
19344 placed in &$home$& while expanding the transport's private options. It is also
19345 used as the current directory if no current directory is set by the
19346 &%current_directory%& option on the transport or the
19347 &%transport_current_directory%& option on the router. If the expansion fails
19348 for any reason, including forced failure, an error is logged, and delivery is
19349 deferred.
19350
19351
19352 .option initgroups transports boolean false
19353 .cindex "additional groups"
19354 .cindex "groups" "additional"
19355 .cindex "transport" "group; additional"
19356 If this option is true and the uid for the delivery process is provided by the
19357 transport, the &[initgroups()]& function is called when running the transport
19358 to ensure that any additional groups associated with the uid are set up.
19359
19360
19361 .option message_size_limit transports string&!! 0
19362 .cindex "limit" "message size per transport"
19363 .cindex "size" "of message, limit"
19364 .cindex "transport" "message size; limiting"
19365 This option controls the size of messages passed through the transport. It is
19366 expanded before use; the result of the expansion must be a sequence of decimal
19367 digits, optionally followed by K or M. If the expansion fails for any reason,
19368 including forced failure, or if the result is not of the required form,
19369 delivery is deferred. If the value is greater than zero and the size of a
19370 message exceeds this limit, the address is failed. If there is any chance that
19371 the resulting bounce message could be routed to the same transport, you should
19372 ensure that &%return_size_limit%& is less than the transport's
19373 &%message_size_limit%&, as otherwise the bounce message will fail to get
19374 delivered.
19375
19376
19377
19378 .option rcpt_include_affixes transports boolean false
19379 .cindex "prefix" "for local part, including in envelope"
19380 .cindex "suffix for local part" "including in envelope"
19381 .cindex "local part" "prefix"
19382 .cindex "local part" "suffix"
19383 When this option is false (the default), and an address that has had any
19384 affixes (prefixes or suffixes) removed from the local part is delivered by any
19385 form of SMTP or LMTP, the affixes are not included. For example, if a router
19386 that contains
19387 .code
19388 local_part_prefix = *-
19389 .endd
19390 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19391 is delivered with
19392 .code
19393 RCPT TO:<xyz@some.domain>
19394 .endd
19395 This is also the case when an ACL-time callout is being used to verify a
19396 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19397 whole local part is included in the RCPT command. This option applies to BSMTP
19398 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19399 &(lmtp)& and &(smtp)& transports.
19400
19401
19402 .option retry_use_local_part transports boolean "see below"
19403 .cindex "hints database" "retry keys"
19404 When a delivery suffers a temporary failure, a retry record is created
19405 in Exim's hints database. For remote deliveries, the key for the retry record
19406 is based on the name and/or IP address of the failing remote host. For local
19407 deliveries, the key is normally the entire address, including both the local
19408 part and the domain. This is suitable for most common cases of local delivery
19409 temporary failure &-- for example, exceeding a mailbox quota should delay only
19410 deliveries to that mailbox, not to the whole domain.
19411
19412 However, in some special cases you may want to treat a temporary local delivery
19413 as a failure associated with the domain, and not with a particular local part.
19414 (For example, if you are storing all mail for some domain in files.) You can do
19415 this by setting &%retry_use_local_part%& false.
19416
19417 For all the local transports, its default value is true. For remote transports,
19418 the default value is false for tidiness, but changing the value has no effect
19419 on a remote transport in the current implementation.
19420
19421
19422 .option return_path transports string&!! unset
19423 .cindex "envelope sender"
19424 .cindex "transport" "return path; changing"
19425 .cindex "return path" "changing in transport"
19426 If this option is set, the string is expanded at transport time and replaces
19427 the existing return path (envelope sender) value in the copy of the message
19428 that is being delivered. An empty return path is permitted. This feature is
19429 designed for remote deliveries, where the value of this option is used in the
19430 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19431 only effect is to change the address that is placed in the &'Return-path:'&
19432 header line, if one is added to the message (see the next option).
19433
19434 &*Note:*& A changed return path is not logged unless you add
19435 &%return_path_on_delivery%& to the log selector.
19436
19437 .vindex "&$return_path$&"
19438 The expansion can refer to the existing value via &$return_path$&. This is
19439 either the message's envelope sender, or an address set by the
19440 &%errors_to%& option on a router. If the expansion is forced to fail, no
19441 replacement occurs; if it fails for another reason, delivery is deferred. This
19442 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19443 section &<<SECTverp>>&.
19444
19445 &*Note*&: If a delivery error is detected locally, including the case when a
19446 remote server rejects a message at SMTP time, the bounce message is not sent to
19447 the value of this option. It is sent to the previously set errors address.
19448 This defaults to the incoming sender address, but can be changed by setting
19449 &%errors_to%& in a router.
19450
19451
19452
19453 .option return_path_add transports boolean false
19454 .cindex "&'Return-path:'& header line"
19455 If this option is true, a &'Return-path:'& header is added to the message.
19456 Although the return path is normally available in the prefix line of BSD
19457 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19458 have easy access to it.
19459
19460 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19461 the delivery SMTP server makes the final delivery"&. This implies that this
19462 header should not be present in incoming messages. Exim has a configuration
19463 option, &%return_path_remove%&, which requests removal of this header from
19464 incoming messages, so that delivered messages can safely be resent to other
19465 recipients.
19466
19467
19468 .option shadow_condition transports string&!! unset
19469 See &%shadow_transport%& below.
19470
19471
19472 .option shadow_transport transports string unset
19473 .cindex "shadow transport"
19474 .cindex "transport" "shadow"
19475 A local transport may set the &%shadow_transport%& option to the name of
19476 another local transport. Shadow remote transports are not supported.
19477
19478 Whenever a delivery to the main transport succeeds, and either
19479 &%shadow_condition%& is unset, or its expansion does not result in the empty
19480 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19481 passed to the shadow transport, with the same delivery address or addresses. If
19482 expansion fails, no action is taken except that non-forced expansion failures
19483 cause a log line to be written.
19484
19485 The result of the shadow transport is discarded and does not affect the
19486 subsequent processing of the message. Only a single level of shadowing is
19487 provided; the &%shadow_transport%& option is ignored on any transport when it
19488 is running as a shadow. Options concerned with output from pipes are also
19489 ignored. The log line for the successful delivery has an item added on the end,
19490 of the form
19491 .code
19492 ST=<shadow transport name>
19493 .endd
19494 If the shadow transport did not succeed, the error message is put in
19495 parentheses afterwards. Shadow transports can be used for a number of different
19496 purposes, including keeping more detailed log information than Exim normally
19497 provides, and implementing automatic acknowledgment policies based on message
19498 headers that some sites insist on.
19499
19500
19501 .option transport_filter transports string&!! unset
19502 .cindex "transport" "filter"
19503 .cindex "filter" "transport filter"
19504 This option sets up a filtering (in the Unix shell sense) process for messages
19505 at transport time. It should not be confused with mail filtering as set up by
19506 individual users or via a system filter.
19507
19508 When the message is about to be written out, the command specified by
19509 &%transport_filter%& is started up in a separate, parallel process, and
19510 the entire message, including the header lines, is passed to it on its standard
19511 input (this in fact is done from a third process, to avoid deadlock). The
19512 command must be specified as an absolute path.
19513
19514 The lines of the message that are written to the transport filter are
19515 terminated by newline (&"\n"&). The message is passed to the filter before any
19516 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19517 lines beginning with a dot, and also before any processing implied by the
19518 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19519 &(pipe)& transports.
19520
19521 The standard error for the filter process is set to the same destination as its
19522 standard output; this is read and written to the message's ultimate
19523 destination. The process that writes the message to the filter, the
19524 filter itself, and the original process that reads the result and delivers it
19525 are all run in parallel, like a shell pipeline.
19526
19527 The filter can perform any transformations it likes, but of course should take
19528 care not to break RFC 2822 syntax. Exim does not check the result, except to
19529 test for a final newline when SMTP is in use. All messages transmitted over
19530 SMTP must end with a newline, so Exim supplies one if it is missing.
19531
19532 .cindex "content scanning" "per user"
19533 A transport filter can be used to provide content-scanning on a per-user basis
19534 at delivery time if the only required effect of the scan is to modify the
19535 message. For example, a content scan could insert a new header line containing
19536 a spam score. This could be interpreted by a filter in the user's MUA. It is
19537 not possible to discard a message at this stage.
19538
19539 .cindex "SMTP" "SIZE"
19540 A problem might arise if the filter increases the size of a message that is
19541 being sent down an SMTP connection. If the receiving SMTP server has indicated
19542 support for the SIZE parameter, Exim will have sent the size of the message
19543 at the start of the SMTP session. If what is actually sent is substantially
19544 more, the server might reject the message. This can be worked round by setting
19545 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19546 additions to the message, or to disable the use of SIZE altogether.
19547
19548 .vindex "&$pipe_addresses$&"
19549 The value of the &%transport_filter%& option is the command string for starting
19550 the filter, which is run directly from Exim, not under a shell. The string is
19551 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19552 Exim breaks it up into arguments and then expands each argument separately (see
19553 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19554 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19555 of arguments, one for each address that applies to this delivery. (This isn't
19556 an ideal name for this feature here, but as it was already implemented for the
19557 &(pipe)& transport, it seemed sensible not to change it.)
19558
19559 .vindex "&$host$&"
19560 .vindex "&$host_address$&"
19561 The expansion variables &$host$& and &$host_address$& are available when the
19562 transport is a remote one. They contain the name and IP address of the host to
19563 which the message is being sent. For example:
19564 .code
19565 transport_filter = /some/directory/transport-filter.pl \
19566   $host $host_address $sender_address $pipe_addresses
19567 .endd
19568
19569 Two problems arise if you want to use more complicated expansion items to
19570 generate transport filter commands, both of which due to the fact that the
19571 command is split up &'before'& expansion.
19572 .ilist
19573 If an expansion item contains white space, you must quote it, so that it is all
19574 part of the same command item. If the entire option setting is one such
19575 expansion item, you have to take care what kind of quoting you use. For
19576 example:
19577 .code
19578 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19579 .endd
19580 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19581 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19582 stripped by Exim when it read the option's value. When the value is used, if
19583 the single quotes were missing, the line would be split into two items,
19584 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19585 Exim tried to expand the first one.
19586 .next
19587 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19588 expansion cannot generate multiple arguments, or a command name followed by
19589 arguments. Consider this example:
19590 .code
19591 transport_filter = ${lookup{$host}lsearch{/a/file}\
19592                     {$value}{/bin/cat}}
19593 .endd
19594 The result of the lookup is interpreted as the name of the command, even
19595 if it contains white space. The simplest way round this is to use a shell:
19596 .code
19597 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19598                                {$value}{/bin/cat}}
19599 .endd
19600 .endlist
19601
19602 The filter process is run under the same uid and gid as the normal delivery.
19603 For remote deliveries this is the Exim uid/gid by default. The command should
19604 normally yield a zero return code. Transport filters are not supposed to fail.
19605 A non-zero code is taken to mean that the transport filter encountered some
19606 serious problem. Delivery of the message is deferred; the message remains on
19607 the queue and is tried again later. It is not possible to cause a message to be
19608 bounced from a transport filter.
19609
19610 If a transport filter is set on an autoreply transport, the original message is
19611 passed through the filter as it is being copied into the newly generated
19612 message, which happens if the &%return_message%& option is set.
19613
19614
19615 .option transport_filter_timeout transports time 5m
19616 .cindex "transport" "filter, timeout"
19617 When Exim is reading the output of a transport filter, it a applies a timeout
19618 that can be set by this option. Exceeding the timeout is normally treated as a
19619 temporary delivery failure. However, if a transport filter is used with a
19620 &(pipe)& transport, a timeout in the transport filter is treated in the same
19621 way as a timeout in the pipe command itself. By default, a timeout is a hard
19622 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19623 becomes a temporary error.
19624
19625
19626 .option user transports string&!! "Exim user"
19627 .cindex "uid (user id)" "local delivery"
19628 .cindex "transport" "user, specifying"
19629 This option specifies the user under whose uid the delivery process is to be
19630 run, overriding any uid that may have been set by the router. If the user is
19631 given as a name, the uid is looked up from the password data, and the
19632 associated group is taken as the value of the gid to be used if the &%group%&
19633 option is not set.
19634
19635 For deliveries that use local transports, a user and group are normally
19636 specified explicitly or implicitly (for example, as a result of
19637 &%check_local_user%&) by the router or transport.
19638
19639 .cindex "hints database" "access by remote transport"
19640 For remote transports, you should leave this option unset unless you really are
19641 sure you know what you are doing. When a remote transport is running, it needs
19642 to be able to access Exim's hints databases, because each host may have its own
19643 retry data.
19644 .ecindex IIDgenoptra1
19645 .ecindex IIDgenoptra2
19646 .ecindex IIDgenoptra3
19647
19648
19649
19650
19651
19652
19653 . ////////////////////////////////////////////////////////////////////////////
19654 . ////////////////////////////////////////////////////////////////////////////
19655
19656 .chapter "Address batching in local transports" "CHAPbatching" &&&
19657          "Address batching"
19658 .cindex "transport" "local; address batching in"
19659 The only remote transport (&(smtp)&) is normally configured to handle more than
19660 one address at a time, so that when several addresses are routed to the same
19661 remote host, just one copy of the message is sent. Local transports, however,
19662 normally handle one address at a time. That is, a separate instance of the
19663 transport is run for each address that is routed to the transport. A separate
19664 copy of the message is delivered each time.
19665
19666 .cindex "batched local delivery"
19667 .oindex "&%batch_max%&"
19668 .oindex "&%batch_id%&"
19669 In special cases, it may be desirable to handle several addresses at once in a
19670 local transport, for example:
19671
19672 .ilist
19673 In an &(appendfile)& transport, when storing messages in files for later
19674 delivery by some other means, a single copy of the message with multiple
19675 recipients saves space.
19676 .next
19677 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19678 a single copy saves time, and is the normal way LMTP is expected to work.
19679 .next
19680 In a &(pipe)& transport, when passing the message
19681 to a scanner program or
19682 to some other delivery mechanism such as UUCP, multiple recipients may be
19683 acceptable.
19684 .endlist
19685
19686 These three local transports all have the same options for controlling multiple
19687 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19688 repeating the information for each transport, these options are described here.
19689
19690 The &%batch_max%& option specifies the maximum number of addresses that can be
19691 delivered together in a single run of the transport. Its default value is one
19692 (no batching). When more than one address is routed to a transport that has a
19693 &%batch_max%& value greater than one, the addresses are delivered in a batch
19694 (that is, in a single run of the transport with multiple recipients), subject
19695 to certain conditions:
19696
19697 .ilist
19698 .vindex "&$local_part$&"
19699 If any of the transport's options contain a reference to &$local_part$&, no
19700 batching is possible.
19701 .next
19702 .vindex "&$domain$&"
19703 If any of the transport's options contain a reference to &$domain$&, only
19704 addresses with the same domain are batched.
19705 .next
19706 .cindex "customizing" "batching condition"
19707 If &%batch_id%& is set, it is expanded for each address, and only those
19708 addresses with the same expanded value are batched. This allows you to specify
19709 customized batching conditions. Failure of the expansion for any reason,
19710 including forced failure, disables batching, but it does not stop the delivery
19711 from taking place.
19712 .next
19713 Batched addresses must also have the same errors address (where to send
19714 delivery errors), the same header additions and removals, the same user and
19715 group for the transport, and if a host list is present, the first host must
19716 be the same.
19717 .endlist
19718
19719 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19720 both when the file or pipe command is specified in the transport, and when it
19721 is specified by a &(redirect)& router, but all the batched addresses must of
19722 course be routed to the same file or pipe command. These two transports have an
19723 option called &%use_bsmtp%&, which causes them to deliver the message in
19724 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19725 &%check_string%& and &%escape_string%& options are forced to the values
19726 .code
19727 check_string = "."
19728 escape_string = ".."
19729 .endd
19730 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19731 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19732 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19733
19734 .cindex "&'Envelope-to:'& header line"
19735 If the generic &%envelope_to_add%& option is set for a batching transport, the
19736 &'Envelope-to:'& header that is added to the message contains all the addresses
19737 that are being processed together. If you are using a batching &(appendfile)&
19738 transport without &%use_bsmtp%&, the only way to preserve the recipient
19739 addresses is to set the &%envelope_to_add%& option.
19740
19741 .cindex "&(pipe)& transport" "with multiple addresses"
19742 .vindex "&$pipe_addresses$&"
19743 If you are using a &(pipe)& transport without BSMTP, and setting the
19744 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19745 the command. This is not a true variable; it is a bit of magic that causes each
19746 of the recipient addresses to be inserted into the command as a separate
19747 argument. This provides a way of accessing all the addresses that are being
19748 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19749 are specified by a &(redirect)& router.
19750
19751
19752
19753
19754 . ////////////////////////////////////////////////////////////////////////////
19755 . ////////////////////////////////////////////////////////////////////////////
19756
19757 .chapter "The appendfile transport" "CHAPappendfile"
19758 .scindex IIDapptra1 "&(appendfile)& transport"
19759 .scindex IIDapptra2 "transports" "&(appendfile)&"
19760 .cindex "directory creation"
19761 .cindex "creating directories"
19762 The &(appendfile)& transport delivers a message by appending it to an existing
19763 file, or by creating an entirely new file in a specified directory. Single
19764 files to which messages are appended can be in the traditional Unix mailbox
19765 format, or optionally in the MBX format supported by the Pine MUA and
19766 University of Washington IMAP daemon, &'inter alia'&. When each message is
19767 being delivered as a separate file, &"maildir"& format can optionally be used
19768 to give added protection against failures that happen part-way through the
19769 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19770 supported. For all file formats, Exim attempts to create as many levels of
19771 directory as necessary, provided that &%create_directory%& is set.
19772
19773 The code for the optional formats is not included in the Exim binary by
19774 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19775 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19776 included.
19777
19778 .cindex "quota" "system"
19779 Exim recognizes system quota errors, and generates an appropriate message. Exim
19780 also supports its own quota control within the transport, for use when the
19781 system facility is unavailable or cannot be used for some reason.
19782
19783 If there is an error while appending to a file (for example, quota exceeded or
19784 partition filled), Exim attempts to reset the file's length and last
19785 modification time back to what they were before. If there is an error while
19786 creating an entirely new file, the new file is removed.
19787
19788 Before appending to a file, a number of security checks are made, and the
19789 file is locked. A detailed description is given below, after the list of
19790 private options.
19791
19792 The &(appendfile)& transport is most commonly used for local deliveries to
19793 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19794 putting messages into files for remote delivery by some means other than Exim.
19795 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19796 option).
19797
19798
19799
19800 .section "The file and directory options" "SECTfildiropt"
19801 The &%file%& option specifies a single file, to which the message is appended;
19802 the &%directory%& option specifies a directory, in which a new file containing
19803 the message is created. Only one of these two options can be set, and for
19804 normal deliveries to mailboxes, one of them &'must'& be set.
19805
19806 .vindex "&$address_file$&"
19807 .vindex "&$local_part$&"
19808 However, &(appendfile)& is also used for delivering messages to files or
19809 directories whose names (or parts of names) are obtained from alias,
19810 forwarding, or filtering operations (for example, a &%save%& command in a
19811 user's Exim filter). When such a transport is running, &$local_part$& contains
19812 the local part that was aliased or forwarded, and &$address_file$& contains the
19813 name (or partial name) of the file or directory generated by the redirection
19814 operation. There are two cases:
19815
19816 .ilist
19817 If neither &%file%& nor &%directory%& is set, the redirection operation
19818 must specify an absolute path (one that begins with &`/`&). This is the most
19819 common case when users with local accounts use filtering to sort mail into
19820 different folders. See for example, the &(address_file)& transport in the
19821 default configuration. If the path ends with a slash, it is assumed to be the
19822 name of a directory. A delivery to a directory can also be forced by setting
19823 &%maildir_format%& or &%mailstore_format%&.
19824 .next
19825 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19826 used to determine the file or directory name for the delivery. Normally, the
19827 contents of &$address_file$& are used in some way in the string expansion.
19828 .endlist
19829
19830
19831 .cindex "Sieve filter" "configuring &(appendfile)&"
19832 .cindex "Sieve filter" "relative mailbox path handling"
19833 As an example of the second case, consider an environment where users do not
19834 have home directories. They may be permitted to use Exim filter commands of the
19835 form:
19836 .code
19837 save folder23
19838 .endd
19839 or Sieve filter commands of the form:
19840 .code
19841 require "fileinto";
19842 fileinto "folder23";
19843 .endd
19844 In this situation, the expansion of &%file%& or &%directory%& in the transport
19845 must transform the relative path into an appropriate absolute file name. In the
19846 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19847 is used as a result of a &"keep"& action in the filter. This example shows one
19848 way of handling this requirement:
19849 .code
19850 file = ${if eq{$address_file}{inbox} \
19851             {/var/mail/$local_part} \
19852             {${if eq{${substr_0_1:$address_file}}{/} \
19853                   {$address_file} \
19854                   {$home/mail/$address_file} \
19855             }} \
19856        }
19857 .endd
19858 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19859 location, absolute paths are used without change, and other folders are in the
19860 &_mail_& directory within the home directory.
19861
19862 &*Note 1*&: While processing an Exim filter, a relative path such as
19863 &_folder23_& is turned into an absolute path if a home directory is known to
19864 the router. In particular, this is the case if &%check_local_user%& is set. If
19865 you want to prevent this happening at routing time, you can set
19866 &%router_home_directory%& empty. This forces the router to pass the relative
19867 path to the transport.
19868
19869 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19870 the &%file%& or &%directory%& option is still used if it is set.
19871
19872
19873
19874
19875 .section "Private options for appendfile" "SECID134"
19876 .cindex "options" "&(appendfile)& transport"
19877
19878
19879
19880 .option allow_fifo appendfile boolean false
19881 .cindex "fifo (named pipe)"
19882 .cindex "named pipe (fifo)"
19883 .cindex "pipe" "named (fifo)"
19884 Setting this option permits delivery to named pipes (FIFOs) as well as to
19885 regular files. If no process is reading the named pipe at delivery time, the
19886 delivery is deferred.
19887
19888
19889 .option allow_symlink appendfile boolean false
19890 .cindex "symbolic link" "to mailbox"
19891 .cindex "mailbox" "symbolic link"
19892 By default, &(appendfile)& will not deliver if the path name for the file is
19893 that of a symbolic link. Setting this option relaxes that constraint, but there
19894 are security issues involved in the use of symbolic links. Be sure you know
19895 what you are doing if you set this. Details of exactly what this option affects
19896 are included in the discussion which follows this list of options.
19897
19898
19899 .option batch_id appendfile string&!! unset
19900 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19901 However, batching is automatically disabled for &(appendfile)& deliveries that
19902 happen as a result of forwarding or aliasing or other redirection directly to a
19903 file.
19904
19905
19906 .option batch_max appendfile integer 1
19907 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19908
19909
19910 .option check_group appendfile boolean false
19911 When this option is set, the group owner of the file defined by the &%file%&
19912 option is checked to see that it is the same as the group under which the
19913 delivery process is running. The default setting is false because the default
19914 file mode is 0600, which means that the group is irrelevant.
19915
19916
19917 .option check_owner appendfile boolean true
19918 When this option is set, the owner of the file defined by the &%file%& option
19919 is checked to ensure that it is the same as the user under which the delivery
19920 process is running.
19921
19922
19923 .option check_string appendfile string "see below"
19924 .cindex "&""From""& line"
19925 As &(appendfile)& writes the message, the start of each line is tested for
19926 matching &%check_string%&, and if it does, the initial matching characters are
19927 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19928 a literal string, not a regular expression, and the case of any letters it
19929 contains is significant.
19930
19931 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19932 are forced to &"."& and &".."& respectively, and any settings in the
19933 configuration are ignored. Otherwise, they default to &"From&~"& and
19934 &">From&~"& when the &%file%& option is set, and unset when any of the
19935 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19936
19937 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19938 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19939 &"From&~"& indicates the start of a new message. All four options need changing
19940 if another format is used. For example, to deliver to mailboxes in MMDF format:
19941 .cindex "MMDF format mailbox"
19942 .cindex "mailbox" "MMDF format"
19943 .code
19944 check_string = "\1\1\1\1\n"
19945 escape_string = "\1\1\1\1 \n"
19946 message_prefix = "\1\1\1\1\n"
19947 message_suffix = "\1\1\1\1\n"
19948 .endd
19949 .option create_directory appendfile boolean true
19950 .cindex "directory creation"
19951 When this option is true, Exim attempts to create any missing superior
19952 directories for the file that it is about to write. A created directory's mode
19953 is given by the &%directory_mode%& option.
19954
19955 The group ownership of a newly created directory is highly dependent on the
19956 operating system (and possibly the file system) that is being used. For
19957 example, in Solaris, if the parent directory has the setgid bit set, its group
19958 is propagated to the child; if not, the currently set group is used. However,
19959 in FreeBSD, the parent's group is always used.
19960
19961
19962
19963 .option create_file appendfile string anywhere
19964 This option constrains the location of files and directories that are created
19965 by this transport. It applies to files defined by the &%file%& option and
19966 directories defined by the &%directory%& option. In the case of maildir
19967 delivery, it applies to the top level directory, not the maildir directories
19968 beneath.
19969
19970 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19971 &"belowhome"&. In the second and third cases, a home directory must have been
19972 set for the transport. This option is not useful when an explicit file name is
19973 given for normal mailbox deliveries. It is intended for the case when file
19974 names are generated from users' &_.forward_& files. These are usually handled
19975 by an &(appendfile)& transport called &%address_file%&. See also
19976 &%file_must_exist%&.
19977
19978
19979 .option directory appendfile string&!! unset
19980 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19981 or &%directory%& must be set, unless the delivery is the direct result of a
19982 redirection (see section &<<SECTfildiropt>>&).
19983
19984 When &%directory%& is set, the string is expanded, and the message is delivered
19985 into a new file or files in or below the given directory, instead of being
19986 appended to a single mailbox file. A number of different formats are provided
19987 (see &%maildir_format%& and &%mailstore_format%&), and see section
19988 &<<SECTopdir>>& for further details of this form of delivery.
19989
19990
19991 .option directory_file appendfile string&!! "see below"
19992 .cindex "base62"
19993 .vindex "&$inode$&"
19994 When &%directory%& is set, but neither &%maildir_format%& nor
19995 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19996 whose name is obtained by expanding this string. The default value is:
19997 .code
19998 q${base62:$tod_epoch}-$inode
19999 .endd
20000 This generates a unique name from the current time, in base 62 form, and the
20001 inode of the file. The variable &$inode$& is available only when expanding this
20002 option.
20003
20004
20005 .option directory_mode appendfile "octal integer" 0700
20006 If &(appendfile)& creates any directories as a result of the
20007 &%create_directory%& option, their mode is specified by this option.
20008
20009
20010 .option escape_string appendfile string "see description"
20011 See &%check_string%& above.
20012
20013
20014 .option file appendfile string&!! unset
20015 This option is mutually exclusive with the &%directory%& option, but one of
20016 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20017 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20018 specifies a single file, to which the message is appended. One or more of
20019 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20020 &%file%&.
20021
20022 .cindex "NFS" "lock file"
20023 .cindex "locking files"
20024 .cindex "lock files"
20025 If you are using more than one host to deliver over NFS into the same
20026 mailboxes, you should always use lock files.
20027
20028 The string value is expanded for each delivery, and must yield an absolute
20029 path. The most common settings of this option are variations on one of these
20030 examples:
20031 .code
20032 file = /var/spool/mail/$local_part
20033 file = /home/$local_part/inbox
20034 file = $home/inbox
20035 .endd
20036 .cindex "&""sticky""& bit"
20037 In the first example, all deliveries are done into the same directory. If Exim
20038 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20039 create a file in the directory, so the &"sticky"& bit must be turned on for
20040 deliveries to be possible, or alternatively the &%group%& option can be used to
20041 run the delivery under a group id which has write access to the directory.
20042
20043
20044
20045 .option file_format appendfile string unset
20046 .cindex "file" "mailbox; checking existing format"
20047 This option requests the transport to check the format of an existing file
20048 before adding to it. The check consists of matching a specific string at the
20049 start of the file. The value of the option consists of an even number of
20050 colon-separated strings. The first of each pair is the test string, and the
20051 second is the name of a transport. If the transport associated with a matched
20052 string is not the current transport, control is passed over to the other
20053 transport. For example, suppose the standard &(local_delivery)& transport has
20054 this added to it:
20055 .code
20056 file_format = "From       : local_delivery :\
20057                \1\1\1\1\n : local_mmdf_delivery"
20058 .endd
20059 Mailboxes that begin with &"From"& are still handled by this transport, but if
20060 a mailbox begins with four binary ones followed by a newline, control is passed
20061 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20062 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20063 is assumed to match the current transport. If the start of a mailbox doesn't
20064 match any string, or if the transport named for a given string is not defined,
20065 delivery is deferred.
20066
20067
20068 .option file_must_exist appendfile boolean false
20069 If this option is true, the file specified by the &%file%& option must exist.
20070 A temporary error occurs if it does not, causing delivery to be deferred.
20071 If this option is false, the file is created if it does not exist.
20072
20073
20074 .option lock_fcntl_timeout appendfile time 0s
20075 .cindex "timeout" "mailbox locking"
20076 .cindex "mailbox" "locking, blocking and non-blocking"
20077 .cindex "locking files"
20078 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20079 when locking an open mailbox file. If the call fails, the delivery process
20080 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20081 Non-blocking calls are used so that the file is not kept open during the wait
20082 for the lock; the reason for this is to make it as safe as possible for
20083 deliveries over NFS in the case when processes might be accessing an NFS
20084 mailbox without using a lock file. This should not be done, but
20085 misunderstandings and hence misconfigurations are not unknown.
20086
20087 On a busy system, however, the performance of a non-blocking lock approach is
20088 not as good as using a blocking lock with a timeout. In this case, the waiting
20089 is done inside the system call, and Exim's delivery process acquires the lock
20090 and can proceed as soon as the previous lock holder releases it.
20091
20092 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20093 timeout, are used. There may still be some retrying: the maximum number of
20094 retries is
20095 .code
20096 (lock_retries * lock_interval) / lock_fcntl_timeout
20097 .endd
20098 rounded up to the next whole number. In other words, the total time during
20099 which &(appendfile)& is trying to get a lock is roughly the same, unless
20100 &%lock_fcntl_timeout%& is set very large.
20101
20102 You should consider setting this option if you are getting a lot of delayed
20103 local deliveries because of errors of the form
20104 .code
20105 failed to lock mailbox /some/file (fcntl)
20106 .endd
20107
20108 .option lock_flock_timeout appendfile time 0s
20109 This timeout applies to file locking when using &[flock()]& (see
20110 &%use_flock%&); the timeout operates in a similar manner to
20111 &%lock_fcntl_timeout%&.
20112
20113
20114 .option lock_interval appendfile time 3s
20115 This specifies the time to wait between attempts to lock the file. See below
20116 for details of locking.
20117
20118
20119 .option lock_retries appendfile integer 10
20120 This specifies the maximum number of attempts to lock the file. A value of zero
20121 is treated as 1. See below for details of locking.
20122
20123
20124 .option lockfile_mode appendfile "octal integer" 0600
20125 This specifies the mode of the created lock file, when a lock file is being
20126 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20127
20128
20129 .option lockfile_timeout appendfile time 30m
20130 .cindex "timeout" "mailbox locking"
20131 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20132 exists and is older than this value, it is assumed to have been left behind by
20133 accident, and Exim attempts to remove it.
20134
20135
20136 .option mailbox_filecount appendfile string&!! unset
20137 .cindex "mailbox" "specifying size of"
20138 .cindex "size" "of mailbox"
20139 If this option is set, it is expanded, and the result is taken as the current
20140 number of files in the mailbox. It must be a decimal number, optionally
20141 followed by K or M. This provides a way of obtaining this information from an
20142 external source that maintains the data.
20143
20144
20145 .option mailbox_size appendfile string&!! unset
20146 .cindex "mailbox" "specifying size of"
20147 .cindex "size" "of mailbox"
20148 If this option is set, it is expanded, and the result is taken as the current
20149 size the mailbox. It must be a decimal number, optionally followed by K or M.
20150 This provides a way of obtaining this information from an external source that
20151 maintains the data. This is likely to be helpful for maildir deliveries where
20152 it is computationally expensive to compute the size of a mailbox.
20153
20154
20155
20156 .option maildir_format appendfile boolean false
20157 .cindex "maildir format" "specifying"
20158 If this option is set with the &%directory%& option, the delivery is into a new
20159 file, in the &"maildir"& format that is used by other mail software. When the
20160 transport is activated directly from a &(redirect)& router (for example, the
20161 &(address_file)& transport in the default configuration), setting
20162 &%maildir_format%& causes the path received from the router to be treated as a
20163 directory, whether or not it ends with &`/`&. This option is available only if
20164 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20165 &<<SECTmaildirdelivery>>& below for further details.
20166
20167
20168 .option maildir_quota_directory_regex appendfile string "See below"
20169 .cindex "maildir format" "quota; directories included in"
20170 .cindex "quota" "maildir; directories included in"
20171 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20172 a regular expression for specifying directories, relative to the quota
20173 directory (see &%quota_directory%&), that should be included in the quota
20174 calculation. The default value is:
20175 .code
20176 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20177 .endd
20178 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20179 (directories whose names begin with a dot). If you want to exclude the
20180 &_Trash_&
20181 folder from the count (as some sites do), you need to change this setting to
20182 .code
20183 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20184 .endd
20185 This uses a negative lookahead in the regular expression to exclude the
20186 directory whose name is &_.Trash_&. When a directory is excluded from quota
20187 calculations, quota processing is bypassed for any messages that are delivered
20188 directly into that directory.
20189
20190
20191 .option maildir_retries appendfile integer 10
20192 This option specifies the number of times to retry when writing a file in
20193 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20194
20195
20196 .option maildir_tag appendfile string&!! unset
20197 This option applies only to deliveries in maildir format, and is described in
20198 section &<<SECTmaildirdelivery>>& below.
20199
20200
20201 .new
20202 .option maildir_use_size_file appendfile&!! boolean false
20203 .cindex "maildir format" "&_maildirsize_& file"
20204 The result of string expansion for this option must be a valid boolean value.
20205 If it is true, it enables support for &_maildirsize_& files. Exim
20206 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20207 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20208 value is zero. See &%maildir_quota_directory_regex%& above and section
20209 &<<SECTmaildirdelivery>>& below for further details.
20210 .wen
20211
20212 .option maildirfolder_create_regex appendfile string unset
20213 .cindex "maildir format" "&_maildirfolder_& file"
20214 .cindex "&_maildirfolder_&, creating"
20215 The value of this option is a regular expression. If it is unset, it has no
20216 effect. Otherwise, before a maildir delivery takes place, the pattern is
20217 matched against the name of the maildir directory, that is, the directory
20218 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20219 delivery. If there is a match, Exim checks for the existence of a file called
20220 &_maildirfolder_& in the directory, and creates it if it does not exist.
20221 See section &<<SECTmaildirdelivery>>& for more details.
20222
20223
20224 .option mailstore_format appendfile boolean false
20225 .cindex "mailstore format" "specifying"
20226 If this option is set with the &%directory%& option, the delivery is into two
20227 new files in  &"mailstore"& format. The option is available only if
20228 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20229 below for further details.
20230
20231
20232 .option mailstore_prefix appendfile string&!! unset
20233 This option applies only to deliveries in mailstore format, and is described in
20234 section &<<SECTopdir>>& below.
20235
20236
20237 .option mailstore_suffix appendfile string&!! unset
20238 This option applies only to deliveries in mailstore format, and is described in
20239 section &<<SECTopdir>>& below.
20240
20241
20242 .option mbx_format appendfile boolean false
20243 .cindex "locking files"
20244 .cindex "file" "locking"
20245 .cindex "file" "MBX format"
20246 .cindex "MBX format, specifying"
20247 This option is available only if Exim has been compiled with SUPPORT_MBX
20248 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20249 the message is appended to the mailbox file in MBX format instead of
20250 traditional Unix format. This format is supported by Pine4 and its associated
20251 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20252
20253 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20254 automatically changed by the use of &%mbx_format%&. They should normally be set
20255 empty when using MBX format, so this option almost always appears in this
20256 combination:
20257 .code
20258 mbx_format = true
20259 message_prefix =
20260 message_suffix =
20261 .endd
20262 If none of the locking options are mentioned in the configuration,
20263 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20264 is possible to specify the other kinds of locking with &%mbx_format%&, but
20265 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20266 interworks with &'c-client'&, providing for shared access to the mailbox. It
20267 should not be used if any program that does not use this form of locking is
20268 going to access the mailbox, nor should it be used if the mailbox file is NFS
20269 mounted, because it works only when the mailbox is accessed from a single host.
20270
20271 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20272 the standard version of &'c-client'&, because as long as it has a mailbox open
20273 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20274 append messages to it.
20275
20276
20277 .option message_prefix appendfile string&!! "see below"
20278 .cindex "&""From""& line"
20279 The string specified here is expanded and output at the start of every message.
20280 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20281 in which case it is:
20282 .code
20283 message_prefix = "From ${if def:return_path{$return_path}\
20284   {MAILER-DAEMON}} $tod_bsdinbox\n"
20285 .endd
20286 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20287 &`\n`& to &`\r\n`& in &%message_prefix%&.
20288
20289 .option message_suffix appendfile string&!! "see below"
20290 The string specified here is expanded and output at the end of every message.
20291 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20292 in which case it is a single newline character. The suffix can be suppressed by
20293 setting
20294 .code
20295 message_suffix =
20296 .endd
20297 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20298 &`\n`& to &`\r\n`& in &%message_suffix%&.
20299
20300 .option mode appendfile "octal integer" 0600
20301 If the output file is created, it is given this mode. If it already exists and
20302 has wider permissions, they are reduced to this mode. If it has narrower
20303 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20304 if the delivery is the result of a &%save%& command in a filter file specifying
20305 a particular mode, the mode of the output file is always forced to take that
20306 value, and this option is ignored.
20307
20308
20309 .option mode_fail_narrower appendfile boolean true
20310 This option applies in the case when an existing mailbox file has a narrower
20311 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20312 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20313 continues with the delivery attempt, using the existing mode of the file.
20314
20315
20316 .option notify_comsat appendfile boolean false
20317 If this option is true, the &'comsat'& daemon is notified after every
20318 successful delivery to a user mailbox. This is the daemon that notifies logged
20319 on users about incoming mail.
20320
20321
20322 .option quota appendfile string&!! unset
20323 .cindex "quota" "imposed by Exim"
20324 This option imposes a limit on the size of the file to which Exim is appending,
20325 or to the total space used in the directory tree when the &%directory%& option
20326 is set. In the latter case, computation of the space used is expensive, because
20327 all the files in the directory (and any sub-directories) have to be
20328 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20329 &%maildir_use_size_file%& for ways to avoid this in environments where users
20330 have no shell access to their mailboxes).
20331
20332 As there is no interlock against two simultaneous deliveries into a
20333 multi-file mailbox, it is possible for the quota to be overrun in this case.
20334 For single-file mailboxes, of course, an interlock is a necessity.
20335
20336 A file's size is taken as its &'used'& value. Because of blocking effects, this
20337 may be a lot less than the actual amount of disk space allocated to the file.
20338 If the sizes of a number of files are being added up, the rounding effect can
20339 become quite noticeable, especially on systems that have large block sizes.
20340 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20341 the obvious value which users understand most easily.
20342
20343 The value of the option is expanded, and must then be a numerical value
20344 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20345 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20346 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20347 be handled.
20348
20349 &*Note*&: A value of zero is interpreted as &"no quota"&.
20350
20351 The expansion happens while Exim is running as root, before it changes uid for
20352 the delivery. This means that files that are inaccessible to the end user can
20353 be used to hold quota values that are looked up in the expansion. When delivery
20354 fails because this quota is exceeded, the handling of the error is as for
20355 system quota failures.
20356
20357 By default, Exim's quota checking mimics system quotas, and restricts the
20358 mailbox to the specified maximum size, though the value is not accurate to the
20359 last byte, owing to separator lines and additional headers that may get added
20360 during message delivery. When a mailbox is nearly full, large messages may get
20361 refused even though small ones are accepted, because the size of the current
20362 message is added to the quota when the check is made. This behaviour can be
20363 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20364 for exceeding the quota does not include the current message. Thus, deliveries
20365 continue until the quota has been exceeded; thereafter, no further messages are
20366 delivered. See also &%quota_warn_threshold%&.
20367
20368
20369 .option quota_directory appendfile string&!! unset
20370 This option defines the directory to check for quota purposes when delivering
20371 into individual files. The default is the delivery directory, or, if a file
20372 called &_maildirfolder_& exists in a maildir directory, the parent of the
20373 delivery directory.
20374
20375
20376 .option quota_filecount appendfile string&!! 0
20377 This option applies when the &%directory%& option is set. It limits the total
20378 number of files in the directory (compare the inode limit in system quotas). It
20379 can only be used if &%quota%& is also set. The value is expanded; an expansion
20380 failure causes delivery to be deferred. A value of zero is interpreted as
20381 &"no quota"&.
20382
20383
20384 .option quota_is_inclusive appendfile boolean true
20385 See &%quota%& above.
20386
20387
20388 .option quota_size_regex appendfile string unset
20389 This option applies when one of the delivery modes that writes a separate file
20390 for each message is being used. When Exim wants to find the size of one of
20391 these files in order to test the quota, it first checks &%quota_size_regex%&.
20392 If this is set to a regular expression that matches the file name, and it
20393 captures one string, that string is interpreted as a representation of the
20394 file's size. The value of &%quota_size_regex%& is not expanded.
20395
20396 This feature is useful only when users have no shell access to their mailboxes
20397 &-- otherwise they could defeat the quota simply by renaming the files. This
20398 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20399 the file length to the file name. For example:
20400 .code
20401 maildir_tag = ,S=$message_size
20402 quota_size_regex = ,S=(\d+)
20403 .endd
20404 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20405 number of lines in the message.
20406
20407 The regular expression should not assume that the length is at the end of the
20408 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20409 sometimes add other information onto the ends of message file names.
20410
20411 Section &<<SECID136>>& contains further information.
20412
20413
20414 .option quota_warn_message appendfile string&!! "see below"
20415 See below for the use of this option. If it is not set when
20416 &%quota_warn_threshold%& is set, it defaults to
20417 .code
20418 quota_warn_message = "\
20419   To: $local_part@$domain\n\
20420   Subject: Your mailbox\n\n\
20421   This message is automatically created \
20422   by mail delivery software.\n\n\
20423   The size of your mailbox has exceeded \
20424   a warning threshold that is\n\
20425   set by the system administrator.\n"
20426 .endd
20427
20428
20429 .option quota_warn_threshold appendfile string&!! 0
20430 .cindex "quota" "warning threshold"
20431 .cindex "mailbox" "size warning"
20432 .cindex "size" "of mailbox"
20433 This option is expanded in the same way as &%quota%& (see above). If the
20434 resulting value is greater than zero, and delivery of the message causes the
20435 size of the file or total space in the directory tree to cross the given
20436 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20437 may be specified as a percentage of it by following the value with a percent
20438 sign. For example:
20439 .code
20440 quota = 10M
20441 quota_warn_threshold = 75%
20442 .endd
20443 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20444 percent sign is ignored.
20445
20446 The warning message itself is specified by the &%quota_warn_message%& option,
20447 and it must start with a &'To:'& header line containing the recipient(s) of the
20448 warning message. These do not necessarily have to include the recipient(s) of
20449 the original message. A &'Subject:'& line should also normally be supplied. You
20450 can include any other header lines that you want. If you do not include a
20451 &'From:'& line, the default is:
20452 .code
20453 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20454 .endd
20455 .oindex &%errors_reply_to%&
20456 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20457 option.
20458
20459 The &%quota%& option does not have to be set in order to use this option; they
20460 are independent of one another except when the threshold is specified as a
20461 percentage.
20462
20463
20464 .option use_bsmtp appendfile boolean false
20465 .cindex "envelope sender"
20466 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20467 format, with the envelope sender and recipient(s) included as SMTP commands. If
20468 you want to include a leading HELO command with such messages, you can do
20469 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20470 for details of batch SMTP.
20471
20472
20473 .option use_crlf appendfile boolean false
20474 .cindex "carriage return"
20475 .cindex "linefeed"
20476 This option causes lines to be terminated with the two-character CRLF sequence
20477 (carriage return, linefeed) instead of just a linefeed character. In the case
20478 of batched SMTP, the byte sequence written to the file is then an exact image
20479 of what would be sent down a real SMTP connection.
20480
20481 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20482 (which are used to supply the traditional &"From&~"& and blank line separators
20483 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20484 carriage return characters if these are needed. In cases where these options
20485 have non-empty defaults, the values end with a single linefeed, so they must be
20486 changed to end with &`\r\n`& if &%use_crlf%& is set.
20487
20488
20489 .option use_fcntl_lock appendfile boolean "see below"
20490 This option controls the use of the &[fcntl()]& function to lock a file for
20491 exclusive use when a message is being appended. It is set by default unless
20492 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20493 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20494 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20495
20496
20497 .option use_flock_lock appendfile boolean false
20498 This option is provided to support the use of &[flock()]& for file locking, for
20499 the few situations where it is needed. Most modern operating systems support
20500 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20501 each other. Exim uses &[fcntl()]& locking by default.
20502
20503 This option is required only if you are using an operating system where
20504 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20505 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20506 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20507
20508 .cindex "Solaris" "&[flock()]& support"
20509 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20510 have it (and some, I think, provide a not quite right version built on top of
20511 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20512 the ability to use it, and any attempt to do so will cause a configuration
20513 error.
20514
20515 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20516 is just being mapped onto &[fcntl()]& by the OS).
20517
20518
20519 .option use_lockfile appendfile boolean "see below"
20520 If this option is turned off, Exim does not attempt to create a lock file when
20521 appending to a mailbox file. In this situation, the only locking is by
20522 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20523 sure that every MUA that is ever going to look at your users' mailboxes uses
20524 &[fcntl()]& rather than a lock file, and even then only when you are not
20525 delivering over NFS from more than one host.
20526
20527 .cindex "NFS" "lock file"
20528 In order to append to an NFS file safely from more than one host, it is
20529 necessary to take out a lock &'before'& opening the file, and the lock file
20530 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20531 file corruption.
20532
20533 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20534 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20535 except when &%mbx_format%& is set.
20536
20537
20538 .option use_mbx_lock appendfile boolean "see below"
20539 This option is available only if Exim has been compiled with SUPPORT_MBX
20540 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20541 locking rules be used. It is set by default if &%mbx_format%& is set and none
20542 of the locking options are mentioned in the configuration. The locking rules
20543 are the same as are used by the &'c-client'& library that underlies Pine and
20544 the IMAP4 and POP daemons that come with it (see the discussion below). The
20545 rules allow for shared access to the mailbox. However, this kind of locking
20546 does not work when the mailbox is NFS mounted.
20547
20548 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20549 &%use_flock_lock%& to control what kind of locking is used in implementing the
20550 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20551 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20552
20553
20554
20555
20556 .section "Operational details for appending" "SECTopappend"
20557 .cindex "appending to a file"
20558 .cindex "file" "appending"
20559 Before appending to a file, the following preparations are made:
20560
20561 .ilist
20562 If the name of the file is &_/dev/null_&, no action is taken, and a success
20563 return is given.
20564
20565 .next
20566 .cindex "directory creation"
20567 If any directories on the file's path are missing, Exim creates them if the
20568 &%create_directory%& option is set. A created directory's mode is given by the
20569 &%directory_mode%& option.
20570
20571 .next
20572 If &%file_format%& is set, the format of an existing file is checked. If this
20573 indicates that a different transport should be used, control is passed to that
20574 transport.
20575
20576 .next
20577 .cindex "file" "locking"
20578 .cindex "locking files"
20579 .cindex "NFS" "lock file"
20580 If &%use_lockfile%& is set, a lock file is built in a way that will work
20581 reliably over NFS, as follows:
20582
20583 .olist
20584 Create a &"hitching post"& file whose name is that of the lock file with the
20585 current time, primary host name, and process id added, by opening for writing
20586 as a new file. If this fails with an access error, delivery is deferred.
20587 .next
20588 Close the hitching post file, and hard link it to the lock file name.
20589 .next
20590 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20591 Unlink the hitching post name.
20592 .next
20593 Otherwise, use &[stat()]& to get information about the hitching post file, and
20594 then unlink hitching post name. If the number of links is exactly two, creation
20595 of the lock file succeeded but something (for example, an NFS server crash and
20596 restart) caused this fact not to be communicated to the &[link()]& call.
20597 .next
20598 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20599 up to &%lock_retries%& times. However, since any program that writes to a
20600 mailbox should complete its task very quickly, it is reasonable to time out old
20601 lock files that are normally the result of user agent and system crashes. If an
20602 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20603 it before trying again.
20604 .endlist olist
20605
20606 .next
20607 A call is made to &[lstat()]& to discover whether the main file exists, and if
20608 so, what its characteristics are. If &[lstat()]& fails for any reason other
20609 than non-existence, delivery is deferred.
20610
20611 .next
20612 .cindex "symbolic link" "to mailbox"
20613 .cindex "mailbox" "symbolic link"
20614 If the file does exist and is a symbolic link, delivery is deferred, unless the
20615 &%allow_symlink%& option is set, in which case the ownership of the link is
20616 checked, and then &[stat()]& is called to find out about the real file, which
20617 is then subjected to the checks below. The check on the top-level link
20618 ownership prevents one user creating a link for another's mailbox in a sticky
20619 directory, though allowing symbolic links in this case is definitely not a good
20620 idea. If there is a chain of symbolic links, the intermediate ones are not
20621 checked.
20622
20623 .next
20624 If the file already exists but is not a regular file, or if the file's owner
20625 and group (if the group is being checked &-- see &%check_group%& above) are
20626 different from the user and group under which the delivery is running,
20627 delivery is deferred.
20628
20629 .next
20630 If the file's permissions are more generous than specified, they are reduced.
20631 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20632 is set false, in which case the delivery is tried using the existing
20633 permissions.
20634
20635 .next
20636 The file's inode number is saved, and the file is then opened for appending.
20637 If this fails because the file has vanished, &(appendfile)& behaves as if it
20638 hadn't existed (see below). For any other failures, delivery is deferred.
20639
20640 .next
20641 If the file is opened successfully, check that the inode number hasn't
20642 changed, that it is still a regular file, and that the owner and permissions
20643 have not changed. If anything is wrong, defer delivery and freeze the message.
20644
20645 .next
20646 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20647 option is set. Otherwise, check that the file is being created in a permitted
20648 directory if the &%create_file%& option is set (deferring on failure), and then
20649 open for writing as a new file, with the O_EXCL and O_CREAT options,
20650 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20651 set). In this case, which can happen if the link points to a non-existent file,
20652 the file is opened for writing using O_CREAT but not O_EXCL, because
20653 that prevents link following.
20654
20655 .next
20656 .cindex "loop" "while file testing"
20657 If opening fails because the file exists, obey the tests given above for
20658 existing files. However, to avoid looping in a situation where the file is
20659 being continuously created and destroyed, the exists/not-exists loop is broken
20660 after 10 repetitions, and the message is then frozen.
20661
20662 .next
20663 If opening fails with any other error, defer delivery.
20664
20665 .next
20666 .cindex "file" "locking"
20667 .cindex "locking files"
20668 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20669 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20670 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20671 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20672 file, and an exclusive lock on the file whose name is
20673 .code
20674 /tmp/.<device-number>.<inode-number>
20675 .endd
20676 using the device and inode numbers of the open mailbox file, in accordance with
20677 the MBX locking rules. This file is created with a mode that is specified by
20678 the &%lockfile_mode%& option.
20679
20680 If Exim fails to lock the file, there are two possible courses of action,
20681 depending on the value of the locking timeout. This is obtained from
20682 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20683
20684 If the timeout value is zero, the file is closed, Exim waits for
20685 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20686 to lock it again. This happens up to &%lock_retries%& times, after which the
20687 delivery is deferred.
20688
20689 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20690 &[flock()]& are used (with the given timeout), so there has already been some
20691 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20692 immediately. It retries up to
20693 .code
20694 (lock_retries * lock_interval) / <timeout>
20695 .endd
20696 times (rounded up).
20697 .endlist
20698
20699 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20700 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20701
20702
20703 .section "Operational details for delivery to a new file" "SECTopdir"
20704 .cindex "delivery" "to single file"
20705 .cindex "&""From""& line"
20706 When the &%directory%& option is set instead of &%file%&, each message is
20707 delivered into a newly-created file or set of files. When &(appendfile)& is
20708 activated directly from a &(redirect)& router, neither &%file%& nor
20709 &%directory%& is normally set, because the path for delivery is supplied by the
20710 router. (See for example, the &(address_file)& transport in the default
20711 configuration.) In this case, delivery is to a new file if either the path name
20712 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20713
20714 No locking is required while writing the message to a new file, so the various
20715 locking options of the transport are ignored. The &"From"& line that by default
20716 separates messages in a single file is not normally needed, nor is the escaping
20717 of message lines that start with &"From"&, and there is no need to ensure a
20718 newline at the end of each message. Consequently, the default values for
20719 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20720 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20721
20722 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20723 the files in the delivery directory by default. However, you can specify a
20724 different directory by setting &%quota_directory%&. Also, for maildir
20725 deliveries (see below) the &_maildirfolder_& convention is honoured.
20726
20727
20728 .cindex "maildir format"
20729 .cindex "mailstore format"
20730 There are three different ways in which delivery to individual files can be
20731 done, controlled by the settings of the &%maildir_format%& and
20732 &%mailstore_format%& options. Note that code to support maildir or mailstore
20733 formats is not included in the binary unless SUPPORT_MAILDIR or
20734 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20735
20736 .cindex "directory creation"
20737 In all three cases an attempt is made to create the directory and any necessary
20738 sub-directories if they do not exist, provided that the &%create_directory%&
20739 option is set (the default). The location of a created directory can be
20740 constrained by setting &%create_file%&. A created directory's mode is given by
20741 the &%directory_mode%& option. If creation fails, or if the
20742 &%create_directory%& option is not set when creation is required, delivery is
20743 deferred.
20744
20745
20746
20747 .section "Maildir delivery" "SECTmaildirdelivery"
20748 .cindex "maildir format" "description of"
20749 If the &%maildir_format%& option is true, Exim delivers each message by writing
20750 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20751 directory that is defined by the &%directory%& option (the &"delivery
20752 directory"&). If the delivery is successful, the file is renamed into the
20753 &_new_& subdirectory.
20754
20755 In the file name, <&'stime'&> is the current time of day in seconds, and
20756 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20757 Exim checks that the time-of-day clock has moved on by at least one microsecond
20758 before terminating the delivery process. This guarantees uniqueness for the
20759 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20760 opening it. If any response other than ENOENT (does not exist) is given,
20761 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20762
20763 Before Exim carries out a maildir delivery, it ensures that subdirectories
20764 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20765 do not exist, Exim tries to create them and any superior directories in their
20766 path, subject to the &%create_directory%& and &%create_file%& options. If the
20767 &%maildirfolder_create_regex%& option is set, and the regular expression it
20768 contains matches the delivery directory, Exim also ensures that a file called
20769 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20770 &_maildirfolder_& file cannot be created, delivery is deferred.
20771
20772 These features make it possible to use Exim to create all the necessary files
20773 and directories in a maildir mailbox, including subdirectories for maildir++
20774 folders. Consider this example:
20775 .code
20776 maildir_format = true
20777 directory = /var/mail/$local_part\
20778            ${if eq{$local_part_suffix}{}{}\
20779            {/.${substr_1:$local_part_suffix}}}
20780 maildirfolder_create_regex = /\.[^/]+$
20781 .endd
20782 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20783 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20784 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20785 not match this name, so Exim will not look for or create the file
20786 &_/var/mail/pimbo/maildirfolder_&, though it will create
20787 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20788
20789 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20790 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20791 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20792 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20793 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20794
20795 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20796 not inadvertently match the toplevel maildir directory, because a
20797 &_maildirfolder_& file at top level would completely break quota calculations.
20798
20799 .cindex "quota" "in maildir delivery"
20800 .cindex "maildir++"
20801 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20802 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20803 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20804 Exim assumes the directory is a maildir++ folder directory, which is one level
20805 down from the user's top level mailbox directory. This causes it to start at
20806 the parent directory instead of the current directory when calculating the
20807 amount of space used.
20808
20809 One problem with delivering into a multi-file mailbox is that it is
20810 computationally expensive to compute the size of the mailbox for quota
20811 checking. Various approaches have been taken to reduce the amount of work
20812 needed. The next two sections describe two of them. A third alternative is to
20813 use some external process for maintaining the size data, and use the expansion
20814 of the &%mailbox_size%& option as a way of importing it into Exim.
20815
20816
20817
20818
20819 .section "Using tags to record message sizes" "SECID135"
20820 If &%maildir_tag%& is set, the string is expanded for each delivery.
20821 When the maildir file is renamed into the &_new_& sub-directory, the
20822 tag is added to its name. However, if adding the tag takes the length of the
20823 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20824 the tag is dropped and the maildir file is created with no tag.
20825
20826
20827 .vindex "&$message_size$&"
20828 Tags can be used to encode the size of files in their names; see
20829 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20830 happens after the message has been written. The value of the &$message_size$&
20831 variable is set to the number of bytes actually written. If the expansion is
20832 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20833 be deferred. The expanded tag may contain any printing characters except &"/"&.
20834 Non-printing characters in the string are ignored; if the resulting string is
20835 empty, it is ignored. If it starts with an alphanumeric character, a leading
20836 colon is inserted; this default has not proven to be the path that popular
20837 maildir implementations have chosen (but changing it in Exim would break
20838 backwards compatibility).
20839
20840 For one common implementation, you might set:
20841 .code
20842 maildir_tag = ,S=${message_size}
20843 .endd
20844 but you should check the documentation of the other software to be sure.
20845
20846 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
20847 as this allows Exim to extract the size from your tag, instead of having to
20848 &[stat()]& each message file.
20849
20850
20851 .section "Using a maildirsize file" "SECID136"
20852 .cindex "quota" "in maildir delivery"
20853 .cindex "maildir format" "&_maildirsize_& file"
20854 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20855 storing quota and message size information in a file called &_maildirsize_&
20856 within the toplevel maildir directory. If this file does not exist, Exim
20857 creates it, setting the quota from the &%quota%& option of the transport. If
20858 the maildir directory itself does not exist, it is created before any attempt
20859 to write a &_maildirsize_& file.
20860
20861 The &_maildirsize_& file is used to hold information about the sizes of
20862 messages in the maildir, thus speeding up quota calculations. The quota value
20863 in the file is just a cache; if the quota is changed in the transport, the new
20864 value overrides the cached value when the next message is delivered. The cache
20865 is maintained for the benefit of other programs that access the maildir and
20866 need to know the quota.
20867
20868 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20869 file is maintained (with a zero quota setting), but no quota is imposed.
20870
20871 A regular expression is available for controlling which directories in the
20872 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20873 See the description of the &%maildir_quota_directory_regex%& option above for
20874 details.
20875
20876
20877 .section "Mailstore delivery" "SECID137"
20878 .cindex "mailstore format" "description of"
20879 If the &%mailstore_format%& option is true, each message is written as two
20880 files in the given directory. A unique base name is constructed from the
20881 message id and the current delivery process, and the files that are written use
20882 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20883 contains the message's envelope, and the &_.msg_& file contains the message
20884 itself. The base name is placed in the variable &$mailstore_basename$&.
20885
20886 During delivery, the envelope is first written to a file with the suffix
20887 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20888 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20889 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20890 file before accessing either of them. An alternative approach is to wait for
20891 the absence of a &_.tmp_& file.
20892
20893 The envelope file starts with any text defined by the &%mailstore_prefix%&
20894 option, expanded and terminated by a newline if there isn't one. Then follows
20895 the sender address on one line, then all the recipient addresses, one per line.
20896 There can be more than one recipient only if the &%batch_max%& option is set
20897 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20898 appended to the file, followed by a newline if it does not end with one.
20899
20900 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20901 failure, it is ignored. Other expansion errors are treated as serious
20902 configuration errors, and delivery is deferred. The variable
20903 &$mailstore_basename$& is available for use during these expansions.
20904
20905
20906 .section "Non-special new file delivery" "SECID138"
20907 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20908 file is created directly in the named directory. For example, when delivering
20909 messages into files in batched SMTP format for later delivery to some host (see
20910 section &<<SECTbatchSMTP>>&), a setting such as
20911 .code
20912 directory = /var/bsmtp/$host
20913 .endd
20914 might be used. A message is written to a file with a temporary name, which is
20915 then renamed when the delivery is complete. The final name is obtained by
20916 expanding the contents of the &%directory_file%& option.
20917 .ecindex IIDapptra1
20918 .ecindex IIDapptra2
20919
20920
20921
20922
20923
20924
20925 . ////////////////////////////////////////////////////////////////////////////
20926 . ////////////////////////////////////////////////////////////////////////////
20927
20928 .chapter "The autoreply transport" "CHID8"
20929 .scindex IIDauttra1 "transports" "&(autoreply)&"
20930 .scindex IIDauttra2 "&(autoreply)& transport"
20931 The &(autoreply)& transport is not a true transport in that it does not cause
20932 the message to be transmitted. Instead, it generates a new mail message as an
20933 automatic reply to the incoming message. &'References:'& and
20934 &'Auto-Submitted:'& header lines are included. These are constructed according
20935 to the rules in RFCs 2822 and 3834, respectively.
20936
20937 If the router that passes the message to this transport does not have the
20938 &%unseen%& option set, the original message (for the current recipient) is not
20939 delivered anywhere. However, when the &%unseen%& option is set on the router
20940 that passes the message to this transport, routing of the address continues, so
20941 another router can set up a normal message delivery.
20942
20943
20944 The &(autoreply)& transport is usually run as the result of mail filtering, a
20945 &"vacation"& message being the standard example. However, it can also be run
20946 directly from a router like any other transport. To reduce the possibility of
20947 message cascades, messages created by the &(autoreply)& transport always have
20948 empty envelope sender addresses, like bounce messages.
20949
20950 The parameters of the message to be sent can be specified in the configuration
20951 by options described below. However, these are used only when the address
20952 passed to the transport does not contain its own reply information. When the
20953 transport is run as a consequence of a
20954 &%mail%&
20955 or &%vacation%& command in a filter file, the parameters of the message are
20956 supplied by the filter, and passed with the address. The transport's options
20957 that define the message are then ignored (so they are not usually set in this
20958 case). The message is specified entirely by the filter or by the transport; it
20959 is never built from a mixture of options. However, the &%file_optional%&,
20960 &%mode%&, and &%return_message%& options apply in all cases.
20961
20962 &(Autoreply)& is implemented as a local transport. When used as a result of a
20963 command in a user's filter file, &(autoreply)& normally runs under the uid and
20964 gid of the user, and with appropriate current and home directories (see chapter
20965 &<<CHAPenvironment>>&).
20966
20967 There is a subtle difference between routing a message to a &(pipe)& transport
20968 that generates some text to be returned to the sender, and routing it to an
20969 &(autoreply)& transport. This difference is noticeable only if more than one
20970 address from the same message is so handled. In the case of a pipe, the
20971 separate outputs from the different addresses are gathered up and returned to
20972 the sender in a single message, whereas if &(autoreply)& is used, a separate
20973 message is generated for each address that is passed to it.
20974
20975 Non-printing characters are not permitted in the header lines generated for the
20976 message that &(autoreply)& creates, with the exception of newlines that are
20977 immediately followed by white space. If any non-printing characters are found,
20978 the transport defers.
20979 Whether characters with the top bit set count as printing characters or not is
20980 controlled by the &%print_topbitchars%& global option.
20981
20982 If any of the generic options for manipulating headers (for example,
20983 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20984 of the original message that is included in the generated message when
20985 &%return_message%& is set. They do not apply to the generated message itself.
20986
20987 .vindex "&$sender_address$&"
20988 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20989 the message, indicating that there were no recipients, it does not treat this
20990 as an error. This means that autoreplies sent to &$sender_address$& when this
20991 is empty (because the incoming message is a bounce message) do not cause
20992 problems. They are just discarded.
20993
20994
20995
20996 .section "Private options for autoreply" "SECID139"
20997 .cindex "options" "&(autoreply)& transport"
20998
20999 .option bcc autoreply string&!! unset
21000 This specifies the addresses that are to receive &"blind carbon copies"& of the
21001 message when the message is specified by the transport.
21002
21003
21004 .option cc autoreply string&!! unset
21005 This specifies recipients of the message and the contents of the &'Cc:'& header
21006 when the message is specified by the transport.
21007
21008
21009 .option file autoreply string&!! unset
21010 The contents of the file are sent as the body of the message when the message
21011 is specified by the transport. If both &%file%& and &%text%& are set, the text
21012 string comes first.
21013
21014
21015 .option file_expand autoreply boolean false
21016 If this is set, the contents of the file named by the &%file%& option are
21017 subjected to string expansion as they are added to the message.
21018
21019
21020 .option file_optional autoreply boolean false
21021 If this option is true, no error is generated if the file named by the &%file%&
21022 option or passed with the address does not exist or cannot be read.
21023
21024
21025 .option from autoreply string&!! unset
21026 This specifies the contents of the &'From:'& header when the message is
21027 specified by the transport.
21028
21029
21030 .option headers autoreply string&!! unset
21031 This specifies additional RFC 2822 headers that are to be added to the message
21032 when the message is specified by the transport. Several can be given by using
21033 &"\n"& to separate them. There is no check on the format.
21034
21035
21036 .option log autoreply string&!! unset
21037 This option names a file in which a record of every message sent is logged when
21038 the message is specified by the transport.
21039
21040
21041 .option mode autoreply "octal integer" 0600
21042 If either the log file or the &"once"& file has to be created, this mode is
21043 used.
21044
21045
21046 .option never_mail autoreply "address list&!!" unset
21047 If any run of the transport creates a message with a recipient that matches any
21048 item in the list, that recipient is quietly discarded. If all recipients are
21049 discarded, no message is created. This applies both when the recipients are
21050 generated by a filter and when they are specified in the transport.
21051
21052
21053
21054 .option once autoreply string&!! unset
21055 This option names a file or DBM database in which a record of each &'To:'&
21056 recipient is kept when the message is specified by the transport. &*Note*&:
21057 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21058
21059 If &%once%& is unset, or is set to an empty string, the message is always sent.
21060 By default, if &%once%& is set to a non-empty file name, the message
21061 is not sent if a potential recipient is already listed in the database.
21062 However, if the &%once_repeat%& option specifies a time greater than zero, the
21063 message is sent if that much time has elapsed since a message was last sent to
21064 this recipient. A setting of zero time for &%once_repeat%& (the default)
21065 prevents a message from being sent a second time &-- in this case, zero means
21066 infinity.
21067
21068 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21069 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21070 greater than zero, it changes the way Exim implements the &%once%& option.
21071 Instead of using a DBM file to record every recipient it sends to, it uses a
21072 regular file, whose size will never get larger than the given value.
21073
21074 In the file, Exim keeps a linear list of recipient addresses and the times at
21075 which they were sent messages. If the file is full when a new address needs to
21076 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21077 means that a given recipient may receive multiple messages, but at
21078 unpredictable intervals that depend on the rate of turnover of addresses in the
21079 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21080
21081
21082 .option once_file_size autoreply integer 0
21083 See &%once%& above.
21084
21085
21086 .option once_repeat autoreply time&!! 0s
21087 See &%once%& above.
21088 After expansion, the value of this option must be a valid time value.
21089
21090
21091 .option reply_to autoreply string&!! unset
21092 This specifies the contents of the &'Reply-To:'& header when the message is
21093 specified by the transport.
21094
21095
21096 .option return_message autoreply boolean false
21097 If this is set, a copy of the original message is returned with the new
21098 message, subject to the maximum size set in the &%return_size_limit%& global
21099 configuration option.
21100
21101
21102 .option subject autoreply string&!! unset
21103 This specifies the contents of the &'Subject:'& header when the message is
21104 specified by the transport. It is tempting to quote the original subject in
21105 automatic responses. For example:
21106 .code
21107 subject = Re: $h_subject:
21108 .endd
21109 There is a danger in doing this, however. It may allow a third party to
21110 subscribe your users to an opt-in mailing list, provided that the list accepts
21111 bounce messages as subscription confirmations. Well-managed lists require a
21112 non-bounce message to confirm a subscription, so the danger is relatively
21113 small.
21114
21115
21116
21117 .option text autoreply string&!! unset
21118 This specifies a single string to be used as the body of the message when the
21119 message is specified by the transport. If both &%text%& and &%file%& are set,
21120 the text comes first.
21121
21122
21123 .option to autoreply string&!! unset
21124 This specifies recipients of the message and the contents of the &'To:'& header
21125 when the message is specified by the transport.
21126 .ecindex IIDauttra1
21127 .ecindex IIDauttra2
21128
21129
21130
21131
21132 . ////////////////////////////////////////////////////////////////////////////
21133 . ////////////////////////////////////////////////////////////////////////////
21134
21135 .chapter "The lmtp transport" "CHAPLMTP"
21136 .cindex "transports" "&(lmtp)&"
21137 .cindex "&(lmtp)& transport"
21138 .cindex "LMTP" "over a pipe"
21139 .cindex "LMTP" "over a socket"
21140 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21141 specified command
21142 or by interacting with a Unix domain socket.
21143 This transport is something of a cross between the &(pipe)& and &(smtp)&
21144 transports. Exim also has support for using LMTP over TCP/IP; this is
21145 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21146 to be of minority interest, the default build-time configure in &_src/EDITME_&
21147 has it commented out. You need to ensure that
21148 .code
21149 TRANSPORT_LMTP=yes
21150 .endd
21151 .cindex "options" "&(lmtp)& transport"
21152 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21153 included in the Exim binary. The private options of the &(lmtp)& transport are
21154 as follows:
21155
21156 .option batch_id lmtp string&!! unset
21157 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21158
21159
21160 .option batch_max lmtp integer 1
21161 This limits the number of addresses that can be handled in a single delivery.
21162 Most LMTP servers can handle several addresses at once, so it is normally a
21163 good idea to increase this value. See the description of local delivery
21164 batching in chapter &<<CHAPbatching>>&.
21165
21166
21167 .option command lmtp string&!! unset
21168 This option must be set if &%socket%& is not set. The string is a command which
21169 is run in a separate process. It is split up into a command name and list of
21170 arguments, each of which is separately expanded (so expansion cannot change the
21171 number of arguments). The command is run directly, not via a shell. The message
21172 is passed to the new process using the standard input and output to operate the
21173 LMTP protocol.
21174
21175 .option ignore_quota lmtp boolean false
21176 .cindex "LMTP" "ignoring quota errors"
21177 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21178 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21179 in its response to the LHLO command.
21180
21181 .option socket lmtp string&!! unset
21182 This option must be set if &%command%& is not set. The result of expansion must
21183 be the name of a Unix domain socket. The transport connects to the socket and
21184 delivers the message to it using the LMTP protocol.
21185
21186
21187 .option timeout lmtp time 5m
21188 The transport is aborted if the created process or Unix domain socket does not
21189 respond to LMTP commands or message input within this timeout. Delivery
21190 is deferred, and will be tried again later. Here is an example of a typical
21191 LMTP transport:
21192 .code
21193 lmtp:
21194   driver = lmtp
21195   command = /some/local/lmtp/delivery/program
21196   batch_max = 20
21197   user = exim
21198 .endd
21199 This delivers up to 20 addresses at a time, in a mixture of domains if
21200 necessary, running as the user &'exim'&.
21201
21202
21203
21204 . ////////////////////////////////////////////////////////////////////////////
21205 . ////////////////////////////////////////////////////////////////////////////
21206
21207 .chapter "The pipe transport" "CHAPpipetransport"
21208 .scindex IIDpiptra1 "transports" "&(pipe)&"
21209 .scindex IIDpiptra2 "&(pipe)& transport"
21210 The &(pipe)& transport is used to deliver messages via a pipe to a command
21211 running in another process. One example is the use of &(pipe)& as a
21212 pseudo-remote transport for passing messages to some other delivery mechanism
21213 (such as UUCP). Another is the use by individual users to automatically process
21214 their incoming messages. The &(pipe)& transport can be used in one of the
21215 following ways:
21216
21217 .ilist
21218 .vindex "&$local_part$&"
21219 A router routes one address to a transport in the normal way, and the
21220 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21221 contains the local part of the address (as usual), and the command that is run
21222 is specified by the &%command%& option on the transport.
21223 .next
21224 .vindex "&$pipe_addresses$&"
21225 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21226 transport can handle more than one address in a single run. In this case, when
21227 more than one address is routed to the transport, &$local_part$& is not set
21228 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21229 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21230 that are routed to the transport.
21231 .next
21232 .vindex "&$address_pipe$&"
21233 A router redirects an address directly to a pipe command (for example, from an
21234 alias or forward file). In this case, &$address_pipe$& contains the text of the
21235 pipe command, and the &%command%& option on the transport is ignored. If only
21236 one address is being transported (&%batch_max%& is not greater than one, or
21237 only one address was redirected to this pipe command), &$local_part$& contains
21238 the local part that was redirected.
21239 .endlist
21240
21241
21242 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21243 deliver messages over pipes using the LMTP interactive protocol. This is
21244 implemented by the &(lmtp)& transport.
21245
21246 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21247 &_.forward_& file, the command runs under the uid and gid of that user. In
21248 other cases, the uid and gid have to be specified explicitly, either on the
21249 transport or on the router that handles the address. Current and &"home"&
21250 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21251 details of the local delivery environment and chapter &<<CHAPbatching>>&
21252 for a discussion of local delivery batching.
21253
21254
21255 .section "Concurrent delivery" "SECID140"
21256 If two messages arrive at almost the same time, and both are routed to a pipe
21257 delivery, the two pipe transports may be run concurrently. You must ensure that
21258 any pipe commands you set up are robust against this happening. If the commands
21259 write to a file, the &%exim_lock%& utility might be of use.
21260
21261
21262
21263
21264 .section "Returned status and data" "SECID141"
21265 .cindex "&(pipe)& transport" "returned data"
21266 If the command exits with a non-zero return code, the delivery is deemed to
21267 have failed, unless either the &%ignore_status%& option is set (in which case
21268 the return code is treated as zero), or the return code is one of those listed
21269 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21270 later"&. In this case, delivery is deferred. Details of a permanent failure are
21271 logged, but are not included in the bounce message, which merely contains
21272 &"local delivery failed"&.
21273
21274 If the command exits on a signal and the &%freeze_signal%& option is set then
21275 the message will be frozen in the queue. If that option is not set, a bounce
21276 will be sent as normal.
21277
21278 If the return code is greater than 128 and the command being run is a shell
21279 script, it normally means that the script was terminated by a signal whose
21280 value is the return code minus 128. The &%freeze_signal%& option does not
21281 apply in this case.
21282
21283 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21284 return code is set to 127. This is the value that a shell returns if it is
21285 asked to run a non-existent command. The wording for the log line suggests that
21286 a non-existent command may be the problem.
21287
21288 The &%return_output%& option can affect the result of a pipe delivery. If it is
21289 set and the command produces any output on its standard output or standard
21290 error streams, the command is considered to have failed, even if it gave a zero
21291 return code or if &%ignore_status%& is set. The output from the command is
21292 included as part of the bounce message. The &%return_fail_output%& option is
21293 similar, except that output is returned only when the command exits with a
21294 failure return code, that is, a value other than zero or a code that matches
21295 &%temp_errors%&.
21296
21297
21298
21299 .section "How the command is run" "SECThowcommandrun"
21300 .cindex "&(pipe)& transport" "path for command"
21301 The command line is (by default) broken down into a command name and arguments
21302 by the &(pipe)& transport itself. The &%allow_commands%& and
21303 &%restrict_to_path%& options can be used to restrict the commands that may be
21304 run.
21305
21306 .cindex "quoting" "in pipe command"
21307 Unquoted arguments are delimited by white space. If an argument appears in
21308 double quotes, backslash is interpreted as an escape character in the usual
21309 way. If an argument appears in single quotes, no escaping is done.
21310
21311 String expansion is applied to the command line except when it comes from a
21312 traditional &_.forward_& file (commands from a filter file are expanded). The
21313 expansion is applied to each argument in turn rather than to the whole line.
21314 For this reason, any string expansion item that contains white space must be
21315 quoted so as to be contained within a single argument. A setting such as
21316 .code
21317 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21318 .endd
21319 will not work, because the expansion item gets split between several
21320 arguments. You have to write
21321 .code
21322 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21323 .endd
21324 to ensure that it is all in one argument. The expansion is done in this way,
21325 argument by argument, so that the number of arguments cannot be changed as a
21326 result of expansion, and quotes or backslashes in inserted variables do not
21327 interact with external quoting. However, this leads to problems if you want to
21328 generate multiple arguments (or the command name plus arguments) from a single
21329 expansion. In this situation, the simplest solution is to use a shell. For
21330 example:
21331 .code
21332 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21333 .endd
21334
21335 .cindex "transport" "filter"
21336 .cindex "filter" "transport filter"
21337 .vindex "&$pipe_addresses$&"
21338 Special handling takes place when an argument consists of precisely the text
21339 &`$pipe_addresses`&. This is not a general expansion variable; the only
21340 place this string is recognized is when it appears as an argument for a pipe or
21341 transport filter command. It causes each address that is being handled to be
21342 inserted in the argument list at that point &'as a separate argument'&. This
21343 avoids any problems with spaces or shell metacharacters, and is of use when a
21344 &(pipe)& transport is handling groups of addresses in a batch.
21345
21346 After splitting up into arguments and expansion, the resulting command is run
21347 in a subprocess directly from the transport, &'not'& under a shell. The
21348 message that is being delivered is supplied on the standard input, and the
21349 standard output and standard error are both connected to a single pipe that is
21350 read by Exim. The &%max_output%& option controls how much output the command
21351 may produce, and the &%return_output%& and &%return_fail_output%& options
21352 control what is done with it.
21353
21354 Not running the command under a shell (by default) lessens the security risks
21355 in cases when a command from a user's filter file is built out of data that was
21356 taken from an incoming message. If a shell is required, it can of course be
21357 explicitly specified as the command to be run. However, there are circumstances
21358 where existing commands (for example, in &_.forward_& files) expect to be run
21359 under a shell and cannot easily be modified. To allow for these cases, there is
21360 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21361 works. Instead of breaking up the command line as just described, it expands it
21362 as a single string and passes the result to &_/bin/sh_&. The
21363 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21364 with &%use_shell%&, and the whole mechanism is inherently less secure.
21365
21366
21367
21368 .section "Environment variables" "SECTpipeenv"
21369 .cindex "&(pipe)& transport" "environment for command"
21370 .cindex "environment for pipe transport"
21371 The environment variables listed below are set up when the command is invoked.
21372 This list is a compromise for maximum compatibility with other MTAs. Note that
21373 the &%environment%& option can be used to add additional variables to this
21374 environment.
21375 .display
21376 &`DOMAIN            `&   the domain of the address
21377 &`HOME              `&   the home directory, if set
21378 &`HOST              `&   the host name when called from a router (see below)
21379 &`LOCAL_PART        `&   see below
21380 &`LOCAL_PART_PREFIX `&   see below
21381 &`LOCAL_PART_SUFFIX `&   see below
21382 &`LOGNAME           `&   see below
21383 &`MESSAGE_ID        `&   Exim's local ID for the message
21384 &`PATH              `&   as specified by the &%path%& option below
21385 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21386 &`RECIPIENT         `&   the complete recipient address
21387 &`SENDER            `&   the sender of the message (empty if a bounce)
21388 &`SHELL             `&   &`/bin/sh`&
21389 &`TZ                `&   the value of the &%timezone%& option, if set
21390 &`USER              `&   see below
21391 .endd
21392 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21393 router, LOCAL_PART is set to the local part of the address. When it is
21394 called as a result of a forward or alias expansion, LOCAL_PART is set to
21395 the local part of the address that was expanded. In both cases, any affixes are
21396 removed from the local part, and made available in LOCAL_PART_PREFIX and
21397 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21398 same value as LOCAL_PART for compatibility with other MTAs.
21399
21400 .cindex "HOST"
21401 HOST is set only when a &(pipe)& transport is called from a router that
21402 associates hosts with an address, typically when using &(pipe)& as a
21403 pseudo-remote transport. HOST is set to the first host name specified by
21404 the router.
21405
21406 .cindex "HOME"
21407 If the transport's generic &%home_directory%& option is set, its value is used
21408 for the HOME environment variable. Otherwise, a home directory may be set
21409 by the router's &%transport_home_directory%& option, which defaults to the
21410 user's home directory if &%check_local_user%& is set.
21411
21412
21413 .section "Private options for pipe" "SECID142"
21414 .cindex "options" "&(pipe)& transport"
21415
21416
21417
21418 .option allow_commands pipe "string list&!!" unset
21419 .cindex "&(pipe)& transport" "permitted commands"
21420 The string is expanded, and is then interpreted as a colon-separated list of
21421 permitted commands. If &%restrict_to_path%& is not set, the only commands
21422 permitted are those in the &%allow_commands%& list. They need not be absolute
21423 paths; the &%path%& option is still used for relative paths. If
21424 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21425 in the &%allow_commands%& list, or a name without any slashes that is found on
21426 the path. In other words, if neither &%allow_commands%& nor
21427 &%restrict_to_path%& is set, there is no restriction on the command, but
21428 otherwise only commands that are permitted by one or the other are allowed. For
21429 example, if
21430 .code
21431 allow_commands = /usr/bin/vacation
21432 .endd
21433 and &%restrict_to_path%& is not set, the only permitted command is
21434 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21435 &%use_shell%& is set.
21436
21437
21438 .option batch_id pipe string&!! unset
21439 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21440
21441
21442 .option batch_max pipe integer 1
21443 This limits the number of addresses that can be handled in a single delivery.
21444 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21445
21446
21447 .option check_string pipe string unset
21448 As &(pipe)& writes the message, the start of each line is tested for matching
21449 &%check_string%&, and if it does, the initial matching characters are replaced
21450 by the contents of &%escape_string%&, provided both are set. The value of
21451 &%check_string%& is a literal string, not a regular expression, and the case of
21452 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21453 of &%check_string%& and &%escape_string%& are forced to values that implement
21454 the SMTP escaping protocol. Any settings made in the configuration file are
21455 ignored.
21456
21457
21458 .option command pipe string&!! unset
21459 This option need not be set when &(pipe)& is being used to deliver to pipes
21460 obtained directly from address redirections. In other cases, the option must be
21461 set, to provide a command to be run. It need not yield an absolute path (see
21462 the &%path%& option below). The command is split up into separate arguments by
21463 Exim, and each argument is separately expanded, as described in section
21464 &<<SECThowcommandrun>>& above.
21465
21466
21467 .option environment pipe string&!! unset
21468 .cindex "&(pipe)& transport" "environment for command"
21469 .cindex "environment for &(pipe)& transport"
21470 This option is used to add additional variables to the environment in which the
21471 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21472 a string which is expanded, and then interpreted as a colon-separated list of
21473 environment settings of the form <&'name'&>=<&'value'&>.
21474
21475
21476 .option escape_string pipe string unset
21477 See &%check_string%& above.
21478
21479
21480 .option freeze_exec_fail pipe boolean false
21481 .cindex "exec failure"
21482 .cindex "failure of exec"
21483 .cindex "&(pipe)& transport" "failure of exec"
21484 Failure to exec the command in a pipe transport is by default treated like
21485 any other failure while running the command. However, if &%freeze_exec_fail%&
21486 is set, failure to exec is treated specially, and causes the message to be
21487 frozen, whatever the setting of &%ignore_status%&.
21488
21489
21490 .option freeze_signal pipe boolean false
21491 .cindex "signal exit"
21492 .cindex "&(pipe)& transport", "signal exit"
21493 Normally if the process run by a command in a pipe transport exits on a signal,
21494 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21495 frozen in Exim's queue instead.
21496
21497
21498 .option ignore_status pipe boolean false
21499 If this option is true, the status returned by the subprocess that is set up to
21500 run the command is ignored, and Exim behaves as if zero had been returned.
21501 Otherwise, a non-zero status or termination by signal causes an error return
21502 from the transport unless the status value is one of those listed in
21503 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21504
21505 &*Note*&: This option does not apply to timeouts, which do not return a status.
21506 See the &%timeout_defer%& option for how timeouts are handled.
21507
21508 .option log_defer_output pipe boolean false
21509 .cindex "&(pipe)& transport" "logging output"
21510 If this option is set, and the status returned by the command is
21511 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21512 and any output was produced, the first line of it is written to the main log.
21513
21514
21515 .option log_fail_output pipe boolean false
21516 If this option is set, and the command returns any output, and also ends with a
21517 return code that is neither zero nor one of the return codes listed in
21518 &%temp_errors%& (that is, the delivery failed), the first line of output is
21519 written to the main log. This option and &%log_output%& are mutually exclusive.
21520 Only one of them may be set.
21521
21522
21523
21524 .option log_output pipe boolean false
21525 If this option is set and the command returns any output, the first line of
21526 output is written to the main log, whatever the return code. This option and
21527 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21528
21529
21530
21531 .option max_output pipe integer 20K
21532 This specifies the maximum amount of output that the command may produce on its
21533 standard output and standard error file combined. If the limit is exceeded, the
21534 process running the command is killed. This is intended as a safety measure to
21535 catch runaway processes. The limit is applied independently of the settings of
21536 the options that control what is done with such output (for example,
21537 &%return_output%&). Because of buffering effects, the amount of output may
21538 exceed the limit by a small amount before Exim notices.
21539
21540
21541 .option message_prefix pipe string&!! "see below"
21542 The string specified here is expanded and output at the start of every message.
21543 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21544 .code
21545 message_prefix = \
21546   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21547   ${tod_bsdinbox}\n
21548 .endd
21549 .cindex "Cyrus"
21550 .cindex "&%tmail%&"
21551 .cindex "&""From""& line"
21552 This is required by the commonly used &_/usr/bin/vacation_& program.
21553 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21554 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21555 setting
21556 .code
21557 message_prefix =
21558 .endd
21559 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21560 &`\n`& to &`\r\n`& in &%message_prefix%&.
21561
21562
21563 .option message_suffix pipe string&!! "see below"
21564 The string specified here is expanded and output at the end of every message.
21565 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21566 The suffix can be suppressed by setting
21567 .code
21568 message_suffix =
21569 .endd
21570 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21571 &`\n`& to &`\r\n`& in &%message_suffix%&.
21572
21573
21574 .option path pipe string "see below"
21575 This option specifies the string that is set up in the PATH environment
21576 variable of the subprocess. The default is:
21577 .code
21578 /bin:/usr/bin
21579 .endd
21580 If the &%command%& option does not yield an absolute path name, the command is
21581 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21582 apply to a command specified as a transport filter.
21583
21584
21585 .option permit_coredump pipe boolean false
21586 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21587 a core-dump of a pipe command, enable this command.  This enables core-dumps
21588 during delivery and affects both the Exim binary and the pipe command run.
21589 It is recommended that this option remain off unless and until you have a need
21590 for it and that this only be enabled when needed, as the risk of excessive
21591 resource consumption can be quite high.  Note also that Exim is typically
21592 installed as a setuid binary and most operating systems will inhibit coredumps
21593 of these by default, so further OS-specific action may be required.
21594
21595
21596 .option pipe_as_creator pipe boolean false
21597 .cindex "uid (user id)" "local delivery"
21598 If the generic &%user%& option is not set and this option is true, the delivery
21599 process is run under the uid that was in force when Exim was originally called
21600 to accept the message. If the group id is not otherwise set (via the generic
21601 &%group%& option), the gid that was in force when Exim was originally called to
21602 accept the message is used.
21603
21604
21605 .option restrict_to_path pipe boolean false
21606 When this option is set, any command name not listed in &%allow_commands%& must
21607 contain no slashes. The command is searched for only in the directories listed
21608 in the &%path%& option. This option is intended for use in the case when a pipe
21609 command has been generated from a user's &_.forward_& file. This is usually
21610 handled by a &(pipe)& transport called &%address_pipe%&.
21611
21612
21613 .option return_fail_output pipe boolean false
21614 If this option is true, and the command produced any output and ended with a
21615 return code other than zero or one of the codes listed in &%temp_errors%& (that
21616 is, the delivery failed), the output is returned in the bounce message.
21617 However, if the message has a null sender (that is, it is itself a bounce
21618 message), output from the command is discarded. This option and
21619 &%return_output%& are mutually exclusive. Only one of them may be set.
21620
21621
21622
21623 .option return_output pipe boolean false
21624 If this option is true, and the command produced any output, the delivery is
21625 deemed to have failed whatever the return code from the command, and the output
21626 is returned in the bounce message. Otherwise, the output is just discarded.
21627 However, if the message has a null sender (that is, it is a bounce message),
21628 output from the command is always discarded, whatever the setting of this
21629 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21630 of them may be set.
21631
21632
21633
21634 .option temp_errors pipe "string list" "see below"
21635 .cindex "&(pipe)& transport" "temporary failure"
21636 This option contains either a colon-separated list of numbers, or a single
21637 asterisk. If &%ignore_status%& is false
21638 and &%return_output%& is not set,
21639 and the command exits with a non-zero return code, the failure is treated as
21640 temporary and the delivery is deferred if the return code matches one of the
21641 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21642 codes are treated as permanent errors. The default setting contains the codes
21643 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21644 compiled on a system that does not define these macros, it assumes values of 75
21645 and 73, respectively.
21646
21647
21648 .option timeout pipe time 1h
21649 If the command fails to complete within this time, it is killed. This normally
21650 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21651 specifies no timeout. In order to ensure that any subprocesses created by the
21652 command are also killed, Exim makes the initial process a process group leader,
21653 and kills the whole process group on a timeout. However, this can be defeated
21654 if one of the processes starts a new process group.
21655
21656 .option timeout_defer pipe boolean false
21657 A timeout in a &(pipe)& transport, either in the command that the transport
21658 runs, or in a transport filter that is associated with it, is by default
21659 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21660 is set true, both kinds of timeout become temporary errors, causing the
21661 delivery to be deferred.
21662
21663 .option umask pipe "octal integer" 022
21664 This specifies the umask setting for the subprocess that runs the command.
21665
21666
21667 .option use_bsmtp pipe boolean false
21668 .cindex "envelope sender"
21669 If this option is set true, the &(pipe)& transport writes messages in &"batch
21670 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21671 commands. If you want to include a leading HELO command with such messages,
21672 you can do so by setting the &%message_prefix%& option. See section
21673 &<<SECTbatchSMTP>>& for details of batch SMTP.
21674
21675 .option use_classresources pipe boolean false
21676 .cindex "class resources (BSD)"
21677 This option is available only when Exim is running on FreeBSD, NetBSD, or
21678 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21679 resource limits when a &(pipe)& transport is run to perform a delivery. The
21680 limits for the uid under which the pipe is to run are obtained from the login
21681 class database.
21682
21683
21684 .option use_crlf pipe boolean false
21685 .cindex "carriage return"
21686 .cindex "linefeed"
21687 This option causes lines to be terminated with the two-character CRLF sequence
21688 (carriage return, linefeed) instead of just a linefeed character. In the case
21689 of batched SMTP, the byte sequence written to the pipe is then an exact image
21690 of what would be sent down a real SMTP connection.
21691
21692 The contents of the &%message_prefix%& and &%message_suffix%& options are
21693 written verbatim, so must contain their own carriage return characters if these
21694 are needed. When &%use_bsmtp%& is not set, the default values for both
21695 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21696 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21697
21698
21699 .option use_shell pipe boolean false
21700 .vindex "&$pipe_addresses$&"
21701 If this option is set, it causes the command to be passed to &_/bin/sh_&
21702 instead of being run directly from the transport, as described in section
21703 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21704 where the command is expected to be run under a shell and cannot easily be
21705 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21706 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21707 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21708 its &%-c%& option.
21709
21710
21711
21712 .section "Using an external local delivery agent" "SECID143"
21713 .cindex "local delivery" "using an external agent"
21714 .cindex "&'procmail'&"
21715 .cindex "external local delivery"
21716 .cindex "delivery" "&'procmail'&"
21717 .cindex "delivery" "by external agent"
21718 The &(pipe)& transport can be used to pass all messages that require local
21719 delivery to a separate local delivery agent such as &%procmail%&. When doing
21720 this, care must be taken to ensure that the pipe is run under an appropriate
21721 uid and gid. In some configurations one wants this to be a uid that is trusted
21722 by the delivery agent to supply the correct sender of the message. It may be
21723 necessary to recompile or reconfigure the delivery agent so that it trusts an
21724 appropriate user. The following is an example transport and router
21725 configuration for &%procmail%&:
21726 .code
21727 # transport
21728 procmail_pipe:
21729   driver = pipe
21730   command = /usr/local/bin/procmail -d $local_part
21731   return_path_add
21732   delivery_date_add
21733   envelope_to_add
21734   check_string = "From "
21735   escape_string = ">From "
21736   umask = 077
21737   user = $local_part
21738   group = mail
21739
21740 # router
21741 procmail:
21742   driver = accept
21743   check_local_user
21744   transport = procmail_pipe
21745 .endd
21746 In this example, the pipe is run as the local user, but with the group set to
21747 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21748 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21749 user to supply a correct sender address. If you do not specify either a
21750 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21751 home directory is the user's home directory by default.
21752
21753 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21754 .code
21755 IFS=" "
21756 .endd
21757 as shown in some &%procmail%& documentation, because Exim does not by default
21758 use a shell to run pipe commands.
21759
21760 .cindex "Cyrus"
21761 The next example shows a transport and a router for a system where local
21762 deliveries are handled by the Cyrus IMAP server.
21763 .code
21764 # transport
21765 local_delivery_cyrus:
21766   driver = pipe
21767   command = /usr/cyrus/bin/deliver \
21768             -m ${substr_1:$local_part_suffix} -- $local_part
21769   user = cyrus
21770   group = mail
21771   return_output
21772   log_output
21773   message_prefix =
21774   message_suffix =
21775
21776 # router
21777 local_user_cyrus:
21778   driver = accept
21779   check_local_user
21780   local_part_suffix = .*
21781   transport = local_delivery_cyrus
21782 .endd
21783 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21784 &%return_output%& to cause any text written by Cyrus to be returned to the
21785 sender.
21786 .ecindex IIDpiptra1
21787 .ecindex IIDpiptra2
21788
21789
21790 . ////////////////////////////////////////////////////////////////////////////
21791 . ////////////////////////////////////////////////////////////////////////////
21792
21793 .chapter "The smtp transport" "CHAPsmtptrans"
21794 .scindex IIDsmttra1 "transports" "&(smtp)&"
21795 .scindex IIDsmttra2 "&(smtp)& transport"
21796 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21797 or LMTP protocol. The list of hosts to try can either be taken from the address
21798 that is being processed (having been set up by the router), or specified
21799 explicitly for the transport. Timeout and retry processing (see chapter
21800 &<<CHAPretry>>&) is applied to each IP address independently.
21801
21802
21803 .section "Multiple messages on a single connection" "SECID144"
21804 The sending of multiple messages over a single TCP/IP connection can arise in
21805 two ways:
21806
21807 .ilist
21808 If a message contains more than &%max_rcpt%& (see below) addresses that are
21809 routed to the same host, more than one copy of the message has to be sent to
21810 that host. In this situation, multiple copies may be sent in a single run of
21811 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21812 does when it has too many addresses to send in one message also depends on the
21813 value of the global &%remote_max_parallel%& option. Details are given in
21814 section &<<SECToutSMTPTCP>>&.)
21815 .next
21816 .cindex "hints database" "remembering routing"
21817 When a message has been successfully delivered over a TCP/IP connection, Exim
21818 looks in its hints database to see if there are any other messages awaiting a
21819 connection to the same host. If there are, a new delivery process is started
21820 for one of them, and the current TCP/IP connection is passed on to it. The new
21821 process may in turn send multiple copies and possibly create yet another
21822 process.
21823 .endlist
21824
21825
21826 For each copy sent over the same TCP/IP connection, a sequence counter is
21827 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21828 no further messages are sent over that connection.
21829
21830
21831
21832 .section "Use of the $host and $host_address variables" "SECID145"
21833 .vindex "&$host$&"
21834 .vindex "&$host_address$&"
21835 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21836 &$host_address$& are the name and IP address of the first host on the host list
21837 passed by the router. However, when the transport is about to connect to a
21838 specific host, and while it is connected to that host, &$host$& and
21839 &$host_address$& are set to the values for that host. These are the values
21840 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21841 &%serialize_hosts%&, and the various TLS options are expanded.
21842
21843
21844 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21845 .vindex &$tls_bits$&
21846 .vindex &$tls_cipher$&
21847 .vindex &$tls_peerdn$&
21848 .vindex &$tls_sni$&
21849 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
21850 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
21851 are the values that were set when the message was received.
21852 These are the values that are used for options that are expanded before any
21853 SMTP connections are made. Just before each connection is made, these four
21854 variables are emptied. If TLS is subsequently started, they are set to the
21855 appropriate values for the outgoing connection, and these are the values that
21856 are in force when any authenticators are run and when the
21857 &%authenticated_sender%& option is expanded.
21858
21859
21860 .section "Private options for smtp" "SECID146"
21861 .cindex "options" "&(smtp)& transport"
21862 The private options of the &(smtp)& transport are as follows:
21863
21864
21865 .option address_retry_include_sender smtp boolean true
21866 .cindex "4&'xx'& responses" "retrying after"
21867 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21868 is the combination of sender and recipient that is delayed in subsequent queue
21869 runs until the retry time is reached. You can delay the recipient without
21870 reference to the sender (which is what earlier versions of Exim did), by
21871 setting &%address_retry_include_sender%& false. However, this can lead to
21872 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21873
21874 .option allow_localhost smtp boolean false
21875 .cindex "local host" "sending to"
21876 .cindex "fallback" "hosts specified on transport"
21877 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21878 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21879 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21880 the delivery anyway. This should be used only in special cases when the
21881 configuration ensures that no looping will result (for example, a differently
21882 configured Exim is listening on the port to which the message is sent).
21883
21884
21885 .option authenticated_sender smtp string&!! unset
21886 .cindex "Cyrus"
21887 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21888 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21889 overriding any existing authenticated sender value. If the string expansion is
21890 forced to fail, the option is ignored. Other expansion failures cause delivery
21891 to be deferred. If the result of expansion is an empty string, that is also
21892 ignored.
21893
21894 The expansion happens after the outgoing connection has been made and TLS
21895 started, if required. This means that the &$host$&, &$host_address$&,
21896 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21897 particular connection.
21898
21899 If the SMTP session is not authenticated, the expansion of
21900 &%authenticated_sender%& still happens (and can cause the delivery to be
21901 deferred if it fails), but no AUTH= item is added to MAIL commands
21902 unless &%authenticated_sender_force%& is true.
21903
21904 This option allows you to use the &(smtp)& transport in LMTP mode to
21905 deliver mail to Cyrus IMAP and provide the proper local part as the
21906 &"authenticated sender"&, via a setting such as:
21907 .code
21908 authenticated_sender = $local_part
21909 .endd
21910 This removes the need for IMAP subfolders to be assigned special ACLs to
21911 allow direct delivery to those subfolders.
21912
21913 Because of expected uses such as that just described for Cyrus (when no
21914 domain is involved), there is no checking on the syntax of the provided
21915 value.
21916
21917
21918 .option authenticated_sender_force smtp boolean false
21919 If this option is set true, the &%authenticated_sender%& option's value
21920 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21921 authenticated as a client.
21922
21923
21924 .option command_timeout smtp time 5m
21925 This sets a timeout for receiving a response to an SMTP command that has been
21926 sent out. It is also used when waiting for the initial banner line from the
21927 remote host. Its value must not be zero.
21928
21929
21930 .option connect_timeout smtp time 5m
21931 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21932 to a remote host. A setting of zero allows the system timeout (typically
21933 several minutes) to act. To have any effect, the value of this option must be
21934 less than the system timeout. However, it has been observed that on some
21935 systems there is no system timeout, which is why the default value for this
21936 option is 5 minutes, a value recommended by RFC 1123.
21937
21938
21939 .option connection_max_messages smtp integer 500
21940 .cindex "SMTP" "passed connection"
21941 .cindex "SMTP" "multiple deliveries"
21942 .cindex "multiple SMTP deliveries"
21943 This controls the maximum number of separate message deliveries that are sent
21944 over a single TCP/IP connection. If the value is zero, there is no limit.
21945 For testing purposes, this value can be overridden by the &%-oB%& command line
21946 option.
21947
21948
21949 .option data_timeout smtp time 5m
21950 This sets a timeout for the transmission of each block in the data portion of
21951 the message. As a result, the overall timeout for a message depends on the size
21952 of the message. Its value must not be zero. See also &%final_timeout%&.
21953
21954
21955 .option delay_after_cutoff smtp boolean true
21956 This option controls what happens when all remote IP addresses for a given
21957 domain have been inaccessible for so long that they have passed their retry
21958 cutoff times.
21959
21960 In the default state, if the next retry time has not been reached for any of
21961 them, the address is bounced without trying any deliveries. In other words,
21962 Exim delays retrying an IP address after the final cutoff time until a new
21963 retry time is reached, and can therefore bounce an address without ever trying
21964 a delivery, when machines have been down for a long time. Some people are
21965 unhappy at this prospect, so...
21966
21967 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21968 addresses are past their final cutoff time, Exim tries to deliver to those
21969 IP addresses that have not been tried since the message arrived. If there are
21970 none, of if they all fail, the address is bounced. In other words, it does not
21971 delay when a new message arrives, but immediately tries those expired IP
21972 addresses that haven't been tried since the message arrived. If there is a
21973 continuous stream of messages for the dead hosts, unsetting
21974 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21975 to them.
21976
21977
21978 .option dns_qualify_single smtp boolean true
21979 If the &%hosts%& or &%fallback_hosts%& option is being used,
21980 and the &%gethostbyname%& option is false,
21981 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21982 in chapter &<<CHAPdnslookup>>& for more details.
21983
21984
21985 .option dns_search_parents smtp boolean false
21986 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21987 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21988 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21989 details.
21990
21991
21992
21993 .option fallback_hosts smtp "string list" unset
21994 .cindex "fallback" "hosts specified on transport"
21995 String expansion is not applied to this option. The argument must be a
21996 colon-separated list of host names or IP addresses, optionally also including
21997 port numbers, though the separator can be changed, as described in section
21998 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21999 item in a &%route_list%& setting for the &(manualroute)& router, as described
22000 in section &<<SECTformatonehostitem>>&.
22001
22002 Fallback hosts can also be specified on routers, which associate them with the
22003 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22004 &%fallback_hosts%& specified on the transport is used only if the address does
22005 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22006 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22007 However, &%hosts_randomize%& does apply to fallback host lists.
22008
22009 If Exim is unable to deliver to any of the hosts for a particular address, and
22010 the errors are not permanent rejections, the address is put on a separate
22011 transport queue with its host list replaced by the fallback hosts, unless the
22012 address was routed via MX records and the current host was in the original MX
22013 list. In that situation, the fallback host list is not used.
22014
22015 Once normal deliveries are complete, the fallback queue is delivered by
22016 re-running the same transports with the new host lists. If several failing
22017 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22018 copy of the message is sent.
22019
22020 The resolution of the host names on the fallback list is controlled by the
22021 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22022 both to cases when the host list comes with the address and when it is taken
22023 from &%hosts%&. This option provides a &"use a smart host only if delivery
22024 fails"& facility.
22025
22026
22027 .option final_timeout smtp time 10m
22028 This is the timeout that applies while waiting for the response to the final
22029 line containing just &"."& that terminates a message. Its value must not be
22030 zero.
22031
22032 .option gethostbyname smtp boolean false
22033 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22034 being used, names are looked up using &[gethostbyname()]&
22035 (or &[getipnodebyname()]& when available)
22036 instead of using the DNS. Of course, that function may in fact use the DNS, but
22037 it may also consult other sources of information such as &_/etc/hosts_&.
22038
22039 .option gnutls_require_kx smtp string unset
22040 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
22041 client. For details, see section &<<SECTreqciphgnu>>&.
22042
22043 .option gnutls_require_mac smtp string unset
22044 This option controls the MAC algorithms when GnuTLS is used in an Exim
22045 client. For details, see section &<<SECTreqciphgnu>>&.
22046
22047 .option gnutls_require_protocols smtp string unset
22048 This option controls the protocols when GnuTLS is used in an Exim
22049 client. For details, see section &<<SECTreqciphgnu>>&.
22050
22051 .option gnutls_compat_mode smtp boolean unset
22052 This option controls whether GnuTLS is used in compatibility mode in an Exim
22053 server. This reduces security slightly, but improves interworking with older
22054 implementations of TLS.
22055
22056 .option helo_data smtp string&!! "see below"
22057 .cindex "HELO" "argument, setting"
22058 .cindex "EHLO" "argument, setting"
22059 .cindex "LHLO argument setting"
22060 The value of this option is expanded after a connection to a another host has
22061 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22062 command that starts the outgoing SMTP or LMTP session. The default value of the
22063 option is:
22064 .code
22065 $primary_hostname
22066 .endd
22067 During the expansion, the variables &$host$& and &$host_address$& are set to
22068 the identity of the remote host, and the variables &$sending_ip_address$& and
22069 &$sending_port$& are set to the local IP address and port number that are being
22070 used. These variables can be used to generate different values for different
22071 servers or different local IP addresses. For example, if you want the string
22072 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22073 interface address, you could use this:
22074 .code
22075 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22076   {$primary_hostname}}
22077 .endd
22078 The use of &%helo_data%& applies both to sending messages and when doing
22079 callouts.
22080
22081 .option hosts smtp "string list&!!" unset
22082 Hosts are associated with an address by a router such as &(dnslookup)&, which
22083 finds the hosts by looking up the address domain in the DNS, or by
22084 &(manualroute)&, which has lists of hosts in its configuration. However,
22085 email addresses can be passed to the &(smtp)& transport by any router, and not
22086 all of them can provide an associated list of hosts.
22087
22088 The &%hosts%& option specifies a list of hosts to be used if the address being
22089 processed does not have any hosts associated with it. The hosts specified by
22090 &%hosts%& are also used, whether or not the address has its own hosts, if
22091 &%hosts_override%& is set.
22092
22093 The string is first expanded, before being interpreted as a colon-separated
22094 list of host names or IP addresses, possibly including port numbers. The
22095 separator may be changed to something other than colon, as described in section
22096 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22097 item in a &%route_list%& setting for the &(manualroute)& router, as described
22098 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22099 of the &(manualroute)& router is not available here.
22100
22101 If the expansion fails, delivery is deferred. Unless the failure was caused by
22102 the inability to complete a lookup, the error is logged to the panic log as
22103 well as the main log. Host names are looked up either by searching directly for
22104 address records in the DNS or by calling &[gethostbyname()]& (or
22105 &[getipnodebyname()]& when available), depending on the setting of the
22106 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22107 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22108 address are used.
22109
22110 During delivery, the hosts are tried in order, subject to their retry status,
22111 unless &%hosts_randomize%& is set.
22112
22113
22114 .option hosts_avoid_esmtp smtp "host list&!!" unset
22115 .cindex "ESMTP, avoiding use of"
22116 .cindex "HELO" "forcing use of"
22117 .cindex "EHLO" "avoiding use of"
22118 .cindex "PIPELINING" "avoiding the use of"
22119 This option is for use with broken hosts that announce ESMTP facilities (for
22120 example, PIPELINING) and then fail to implement them properly. When a host
22121 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22122 start of the SMTP session. This means that it cannot use any of the ESMTP
22123 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22124
22125
22126 .option hosts_avoid_pipelining smtp "host list&!!" unset
22127 .cindex "PIPELINING" "avoiding the use of"
22128 Exim will not use the SMTP PIPELINING extension when delivering to any host
22129 that matches this list, even if the server host advertises PIPELINING support.
22130
22131
22132 .option hosts_avoid_tls smtp "host list&!!" unset
22133 .cindex "TLS" "avoiding for certain hosts"
22134 Exim will not try to start a TLS session when delivering to any host that
22135 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22136
22137
22138 .option hosts_max_try smtp integer 5
22139 .cindex "host" "maximum number to try"
22140 .cindex "limit" "number of hosts tried"
22141 .cindex "limit" "number of MX tried"
22142 .cindex "MX record" "maximum tried"
22143 This option limits the number of IP addresses that are tried for any one
22144 delivery in cases where there are temporary delivery errors. Section
22145 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22146
22147
22148 .option hosts_max_try_hardlimit smtp integer 50
22149 This is an additional check on the maximum number of IP addresses that Exim
22150 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22151 why it exists.
22152
22153
22154
22155 .option hosts_nopass_tls smtp "host list&!!" unset
22156 .cindex "TLS" "passing connection"
22157 .cindex "multiple SMTP deliveries"
22158 .cindex "TLS" "multiple message deliveries"
22159 For any host that matches this list, a connection on which a TLS session has
22160 been started will not be passed to a new delivery process for sending another
22161 message on the same connection. See section &<<SECTmulmessam>>& for an
22162 explanation of when this might be needed.
22163
22164
22165 .option hosts_override smtp boolean false
22166 If this option is set and the &%hosts%& option is also set, any hosts that are
22167 attached to the address are ignored, and instead the hosts specified by the
22168 &%hosts%& option are always used. This option does not apply to
22169 &%fallback_hosts%&.
22170
22171
22172 .option hosts_randomize smtp boolean false
22173 .cindex "randomized host list"
22174 .cindex "host" "list of; randomized"
22175 .cindex "fallback" "randomized hosts"
22176 If this option is set, and either the list of hosts is taken from the
22177 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22178 were not obtained from MX records (this includes fallback hosts from the
22179 router), and were not randomized by the router, the order of trying the hosts
22180 is randomized each time the transport runs. Randomizing the order of a host
22181 list can be used to do crude load sharing.
22182
22183 When &%hosts_randomize%& is true, a host list may be split into groups whose
22184 order is separately randomized. This makes it possible to set up MX-like
22185 behaviour. The boundaries between groups are indicated by an item that is just
22186 &`+`& in the host list. For example:
22187 .code
22188 hosts = host1:host2:host3:+:host4:host5
22189 .endd
22190 The order of the first three hosts and the order of the last two hosts is
22191 randomized for each use, but the first three always end up before the last two.
22192 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22193
22194 .option hosts_require_auth smtp "host list&!!" unset
22195 .cindex "authentication" "required by client"
22196 This option provides a list of servers for which authentication must succeed
22197 before Exim will try to transfer a message. If authentication fails for
22198 servers which are not in this list, Exim tries to send unauthenticated. If
22199 authentication fails for one of these servers, delivery is deferred. This
22200 temporary error is detectable in the retry rules, so it can be turned into a
22201 hard failure if required. See also &%hosts_try_auth%&, and chapter
22202 &<<CHAPSMTPAUTH>>& for details of authentication.
22203
22204
22205 .option hosts_require_tls smtp "host list&!!" unset
22206 .cindex "TLS" "requiring for certain servers"
22207 Exim will insist on using a TLS session when delivering to any host that
22208 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22209 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22210 incoming messages, use an appropriate ACL.
22211
22212 .option hosts_try_auth smtp "host list&!!" unset
22213 .cindex "authentication" "optional in client"
22214 This option provides a list of servers to which, provided they announce
22215 authentication support, Exim will attempt to authenticate as a client when it
22216 connects. If authentication fails, Exim will try to transfer the message
22217 unauthenticated. See also &%hosts_require_auth%&, and chapter
22218 &<<CHAPSMTPAUTH>>& for details of authentication.
22219
22220 .option interface smtp "string list&!!" unset
22221 .cindex "bind IP address"
22222 .cindex "IP address" "binding"
22223 .vindex "&$host$&"
22224 .vindex "&$host_address$&"
22225 This option specifies which interface to bind to when making an outgoing SMTP
22226 call. The value is an IP address, not an interface name such as
22227 &`eth0`&. Do not confuse this with the interface address that was used when a
22228 message was received, which is in &$received_ip_address$&, formerly known as
22229 &$interface_address$&. The name was changed to minimize confusion with the
22230 outgoing interface address. There is no variable that contains an outgoing
22231 interface address because, unless it is set by this option, its value is
22232 unknown.
22233
22234 During the expansion of the &%interface%& option the variables &$host$& and
22235 &$host_address$& refer to the host to which a connection is about to be made
22236 during the expansion of the string. Forced expansion failure, or an empty
22237 string result causes the option to be ignored. Otherwise, after expansion, the
22238 string must be a list of IP addresses, colon-separated by default, but the
22239 separator can be changed in the usual way. For example:
22240 .code
22241 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22242 .endd
22243 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22244 connection. If none of them are the correct type, the option is ignored. If
22245 &%interface%& is not set, or is ignored, the system's IP functions choose which
22246 interface to use if the host has more than one.
22247
22248
22249 .option keepalive smtp boolean true
22250 .cindex "keepalive" "on outgoing connection"
22251 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22252 connections. When set, it causes the kernel to probe idle connections
22253 periodically, by sending packets with &"old"& sequence numbers. The other end
22254 of the connection should send a acknowledgment if the connection is still okay
22255 or a reset if the connection has been aborted. The reason for doing this is
22256 that it has the beneficial effect of freeing up certain types of connection
22257 that can get stuck when the remote host is disconnected without tidying up the
22258 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22259 unreachable hosts.
22260
22261
22262 .option lmtp_ignore_quota smtp boolean false
22263 .cindex "LMTP" "ignoring quota errors"
22264 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22265 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22266 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22267
22268 .option max_rcpt smtp integer 100
22269 .cindex "RCPT" "maximum number of outgoing"
22270 This option limits the number of RCPT commands that are sent in a single
22271 SMTP message transaction. Each set of addresses is treated independently, and
22272 so can cause parallel connections to the same host if &%remote_max_parallel%&
22273 permits this.
22274
22275
22276 .option multi_domain smtp boolean true
22277 .vindex "&$domain$&"
22278 When this option is set, the &(smtp)& transport can handle a number of
22279 addresses containing a mixture of different domains provided they all resolve
22280 to the same list of hosts. Turning the option off restricts the transport to
22281 handling only one domain at a time. This is useful if you want to use
22282 &$domain$& in an expansion for the transport, because it is set only when there
22283 is a single domain involved in a remote delivery.
22284
22285
22286 .option port smtp string&!! "see below"
22287 .cindex "port" "sending TCP/IP"
22288 .cindex "TCP/IP" "setting outgoing port"
22289 This option specifies the TCP/IP port on the server to which Exim connects.
22290 &*Note:*& Do not confuse this with the port that was used when a message was
22291 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22292 The name was changed to minimize confusion with the outgoing port. There is no
22293 variable that contains an outgoing port.
22294
22295 If the value of this option begins with a digit it is taken as a port number;
22296 otherwise it is looked up using &[getservbyname()]&. The default value is
22297 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22298 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22299 is deferred.
22300
22301
22302
22303 .option protocol smtp string smtp
22304 .cindex "LMTP" "over TCP/IP"
22305 .cindex "ssmtp protocol" "outbound"
22306 .cindex "TLS" "SSL-on-connect outbound"
22307 .vindex "&$port$&"
22308 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22309 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22310 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22311 deliveries into closed message stores. Exim also has support for running LMTP
22312 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22313
22314 .new
22315 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22316 changes to &"smtps"&, and the transport initiates TLS immediately after
22317 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22318 The Internet standards bodies strongly discourage use of this mode.
22319 .wen
22320
22321
22322 .option retry_include_ip_address smtp boolean true
22323 Exim normally includes both the host name and the IP address in the key it
22324 constructs for indexing retry data after a temporary delivery failure. This
22325 means that when one of several IP addresses for a host is failing, it gets
22326 tried periodically (controlled by the retry rules), but use of the other IP
22327 addresses is not affected.
22328
22329 However, in some dialup environments hosts are assigned a different IP address
22330 each time they connect. In this situation the use of the IP address as part of
22331 the retry key leads to undesirable behaviour. Setting this option false causes
22332 Exim to use only the host name. This should normally be done on a separate
22333 instance of the &(smtp)& transport, set up specially to handle the dialup
22334 hosts.
22335
22336
22337 .option serialize_hosts smtp "host list&!!" unset
22338 .cindex "serializing connections"
22339 .cindex "host" "serializing connections"
22340 Because Exim operates in a distributed manner, if several messages for the same
22341 host arrive at around the same time, more than one simultaneous connection to
22342 the remote host can occur. This is not usually a problem except when there is a
22343 slow link between the hosts. In that situation it may be helpful to restrict
22344 Exim to one connection at a time. This can be done by setting
22345 &%serialize_hosts%& to match the relevant hosts.
22346
22347 .cindex "hints database" "serializing deliveries to a host"
22348 Exim implements serialization by means of a hints database in which a record is
22349 written whenever a process connects to one of the restricted hosts. The record
22350 is deleted when the connection is completed. Obviously there is scope for
22351 records to get left lying around if there is a system or program crash. To
22352 guard against this, Exim ignores any records that are more than six hours old.
22353
22354 If you set up this kind of serialization, you should also arrange to delete the
22355 relevant hints database whenever your system reboots. The names of the files
22356 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22357 may be one or two files, depending on the type of DBM in use. The same files
22358 are used for ETRN serialization.
22359
22360
22361 .option size_addition smtp integer 1024
22362 .cindex "SMTP" "SIZE"
22363 .cindex "message" "size issue for transport filter"
22364 .cindex "size" "of message"
22365 .cindex "transport" "filter"
22366 .cindex "filter" "transport filter"
22367 If a remote SMTP server indicates that it supports the SIZE option of the
22368 MAIL command, Exim uses this to pass over the message size at the start of
22369 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22370 sends, to allow for headers and other text that may be added during delivery by
22371 configuration options or in a transport filter. It may be necessary to increase
22372 this if a lot of text is added to messages.
22373
22374 Alternatively, if the value of &%size_addition%& is set negative, it disables
22375 the use of the SIZE option altogether.
22376
22377
22378 .option tls_certificate smtp string&!! unset
22379 .cindex "TLS" "client certificate, location of"
22380 .cindex "certificate" "client, location of"
22381 .vindex "&$host$&"
22382 .vindex "&$host_address$&"
22383 The value of this option must be the absolute path to a file which contains the
22384 client's certificate, for possible use when sending a message over an encrypted
22385 connection. The values of &$host$& and &$host_address$& are set to the name and
22386 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22387 details of TLS.
22388
22389 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22390 certificate when sending messages as a client. The global option of the same
22391 name specifies the certificate for Exim as a server; it is not automatically
22392 assumed that the same certificate should be used when Exim is operating as a
22393 client.
22394
22395
22396 .option tls_crl smtp string&!! unset
22397 .cindex "TLS" "client certificate revocation list"
22398 .cindex "certificate" "revocation list for client"
22399 This option specifies a certificate revocation list. The expanded value must
22400 be the name of a file that contains a CRL in PEM format.
22401
22402
22403 .option tls_privatekey smtp string&!! unset
22404 .cindex "TLS" "client private key, location of"
22405 .vindex "&$host$&"
22406 .vindex "&$host_address$&"
22407 The value of this option must be the absolute path to a file which contains the
22408 client's private key. This is used when sending a message over an encrypted
22409 connection using a client certificate. The values of &$host$& and
22410 &$host_address$& are set to the name and address of the server during the
22411 expansion. If this option is unset, or the expansion is forced to fail, or the
22412 result is an empty string, the private key is assumed to be in the same file as
22413 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22414
22415
22416 .option tls_require_ciphers smtp string&!! unset
22417 .cindex "TLS" "requiring specific ciphers"
22418 .cindex "cipher" "requiring specific"
22419 .vindex "&$host$&"
22420 .vindex "&$host_address$&"
22421 The value of this option must be a list of permitted cipher suites, for use
22422 when setting up an outgoing encrypted connection. (There is a global option of
22423 the same name for controlling incoming connections.) The values of &$host$& and
22424 &$host_address$& are set to the name and address of the server during the
22425 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22426 is used in different ways by OpenSSL and GnuTLS (see sections
22427 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22428 ciphers is a preference order.
22429
22430
22431
22432 .new
22433 .option tls_sni smtp string&!! unset
22434 .cindex "TLS" "Server Name Indication"
22435 .vindex "&$tls_sni$&"
22436 If this option is set then it sets the $tls_sni variable and causes any
22437 TLS session to pass this value as the Server Name Indication extension to
22438 the remote side, which can be used by the remote side to select an appropriate
22439 certificate and private key for the session.
22440
22441 See &<<SECTtlssni>>& for more information.
22442
22443 OpenSSL only, also requiring a build of OpenSSL that supports TLS extensions.
22444 .wen
22445
22446
22447
22448 .option tls_tempfail_tryclear smtp boolean true
22449 .cindex "4&'xx'& responses" "to STARTTLS"
22450 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22451 setting up a TLS session, this option determines whether or not Exim should try
22452 to deliver the message unencrypted. If it is set false, delivery to the
22453 current host is deferred; if there are other hosts, they are tried. If this
22454 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22455 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22456 TLS negotiation fails, Exim closes the current connection (because it is in an
22457 unknown state), opens a new one to the same host, and then tries the delivery
22458 in clear.
22459
22460
22461 .option tls_verify_certificates smtp string&!! unset
22462 .cindex "TLS" "server certificate verification"
22463 .cindex "certificate" "verification of server"
22464 .vindex "&$host$&"
22465 .vindex "&$host_address$&"
22466 The value of this option must be the absolute path to a file containing
22467 permitted server certificates, for use when setting up an encrypted connection.
22468 Alternatively, if you are using OpenSSL, you can set
22469 &%tls_verify_certificates%& to the name of a directory containing certificate
22470 files. This does not work with GnuTLS; the option must be set to the name of a
22471 single file if you are using GnuTLS. The values of &$host$& and
22472 &$host_address$& are set to the name and address of the server during the
22473 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22474
22475
22476
22477
22478 .section "How the limits for the number of hosts to try are used" &&&
22479          "SECTvalhosmax"
22480 .cindex "host" "maximum number to try"
22481 .cindex "limit" "hosts; maximum number tried"
22482 There are two options that are concerned with the number of hosts that are
22483 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22484 &%hosts_max_try_hardlimit%&.
22485
22486
22487 The &%hosts_max_try%& option limits the number of hosts that are tried
22488 for a single delivery. However, despite the term &"host"& in its name, the
22489 option actually applies to each IP address independently. In other words, a
22490 multihomed host is treated as several independent hosts, just as it is for
22491 retrying.
22492
22493 Many of the larger ISPs have multiple MX records which often point to
22494 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22495 created as a result of routing one of these domains.
22496
22497 Trying every single IP address on such a long list does not seem sensible; if
22498 several at the top of the list fail, it is reasonable to assume there is some
22499 problem that is likely to affect all of them. Roughly speaking, the value of
22500 &%hosts_max_try%& is the maximum number that are tried before deferring the
22501 delivery. However, the logic cannot be quite that simple.
22502
22503 Firstly, IP addresses that are skipped because their retry times have not
22504 arrived do not count, and in addition, addresses that are past their retry
22505 limits are also not counted, even when they are tried. This means that when
22506 some IP addresses are past their retry limits, more than the value of
22507 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22508 that all IP addresses are considered before timing out an email address (but
22509 see below for an exception).
22510
22511 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22512 list to see if there is a subsequent host with a different (higher valued) MX.
22513 If there is, that host is considered next, and the current IP address is used
22514 but not counted. This behaviour helps in the case of a domain with a retry rule
22515 that hardly ever delays any hosts, as is now explained:
22516
22517 Consider the case of a long list of hosts with one MX value, and a few with a
22518 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22519 hosts at the top of the list are tried at first. With the default retry rule,
22520 which specifies increasing retry times, the higher MX hosts are eventually
22521 tried when those at the top of the list are skipped because they have not
22522 reached their retry times.
22523
22524 However, it is common practice to put a fixed short retry time on domains for
22525 large ISPs, on the grounds that their servers are rarely down for very long.
22526 Unfortunately, these are exactly the domains that tend to resolve to long lists
22527 of hosts. The short retry time means that the lowest MX hosts are tried every
22528 time. The attempts may be in a different order because of random sorting, but
22529 without the special MX check, the higher MX hosts would never be tried until
22530 all the lower MX hosts had timed out (which might be several days), because
22531 there are always some lower MX hosts that have reached their retry times. With
22532 the special check, Exim considers at least one IP address from each MX value at
22533 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22534 reached.
22535
22536 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22537 particular, Exim normally eventually tries all the IP addresses before timing
22538 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22539 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22540 been set up with hundreds of IP addresses for some domains. It can
22541 take a very long time indeed for an address to time out in these cases.
22542
22543 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22544 Exim never tries more than this number of IP addresses; if it hits this limit
22545 and they are all timed out, the email address is bounced, even though not all
22546 possible IP addresses have been tried.
22547 .ecindex IIDsmttra1
22548 .ecindex IIDsmttra2
22549
22550
22551
22552
22553
22554 . ////////////////////////////////////////////////////////////////////////////
22555 . ////////////////////////////////////////////////////////////////////////////
22556
22557 .chapter "Address rewriting" "CHAPrewrite"
22558 .scindex IIDaddrew "rewriting" "addresses"
22559 There are some circumstances in which Exim automatically rewrites domains in
22560 addresses. The two most common are when an address is given without a domain
22561 (referred to as an &"unqualified address"&) or when an address contains an
22562 abbreviated domain that is expanded by DNS lookup.
22563
22564 Unqualified envelope addresses are accepted only for locally submitted
22565 messages, or for messages that are received from hosts matching
22566 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22567 appropriate. Unqualified addresses in header lines are qualified if they are in
22568 locally submitted messages, or messages from hosts that are permitted to send
22569 unqualified envelope addresses. Otherwise, unqualified addresses in header
22570 lines are neither qualified nor rewritten.
22571
22572 One situation in which Exim does &'not'& automatically rewrite a domain is
22573 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22574 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22575 do this. The new RFCs do not contain this suggestion.
22576
22577
22578 .section "Explicitly configured address rewriting" "SECID147"
22579 This chapter describes the rewriting rules that can be used in the
22580 main rewrite section of the configuration file, and also in the generic
22581 &%headers_rewrite%& option that can be set on any transport.
22582
22583 Some people believe that configured address rewriting is a Mortal Sin.
22584 Others believe that life is not possible without it. Exim provides the
22585 facility; you do not have to use it.
22586
22587 The main rewriting rules that appear in the &"rewrite"& section of the
22588 configuration file are applied to addresses in incoming messages, both envelope
22589 addresses and addresses in header lines. Each rule specifies the types of
22590 address to which it applies.
22591
22592 Whether or not addresses in header lines are rewritten depends on the origin of
22593 the headers and the type of rewriting. Global rewriting, that is, rewriting
22594 rules from the rewrite section of the configuration file, is applied only to
22595 those headers that were received with the message. Header lines that are added
22596 by ACLs or by a system filter or by individual routers or transports (which
22597 are specific to individual recipient addresses) are not rewritten by the global
22598 rules.
22599
22600 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22601 applies all headers except those added by routers and transports. That is, as
22602 well as the headers that were received with the message, it also applies to
22603 headers that were added by an ACL or a system filter.
22604
22605
22606 In general, rewriting addresses from your own system or domain has some
22607 legitimacy. Rewriting other addresses should be done only with great care and
22608 in special circumstances. The author of Exim believes that rewriting should be
22609 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22610 Although it can sometimes be used as a routing tool, this is very strongly
22611 discouraged.
22612
22613 There are two commonly encountered circumstances where rewriting is used, as
22614 illustrated by these examples:
22615
22616 .ilist
22617 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22618 exchange mail with each other behind a firewall, but there is only a single
22619 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22620 &'hitch.fict.example'& when sending mail off-site.
22621 .next
22622 A host rewrites the local parts of its own users so that, for example,
22623 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22624 .endlist
22625
22626
22627
22628 .section "When does rewriting happen?" "SECID148"
22629 .cindex "rewriting" "timing of"
22630 .cindex "&ACL;" "rewriting addresses in"
22631 Configured address rewriting can take place at several different stages of a
22632 message's processing.
22633
22634 .vindex "&$sender_address$&"
22635 At the start of an ACL for MAIL, the sender address may have been rewritten
22636 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22637 ordinary rewrite rules have yet been applied. If, however, the sender address
22638 is verified in the ACL, it is rewritten before verification, and remains
22639 rewritten thereafter. The subsequent value of &$sender_address$& is the
22640 rewritten address. This also applies if sender verification happens in a
22641 RCPT ACL. Otherwise, when the sender address is not verified, it is
22642 rewritten as soon as a message's header lines have been received.
22643
22644 .vindex "&$domain$&"
22645 .vindex "&$local_part$&"
22646 Similarly, at the start of an ACL for RCPT, the current recipient's address
22647 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22648 rewrite rules have yet been applied to it. However, the behaviour is different
22649 from the sender address when a recipient is verified. The address is rewritten
22650 for the verification, but the rewriting is not remembered at this stage. The
22651 value of &$local_part$& and &$domain$& after verification are always the same
22652 as they were before (that is, they contain the unrewritten &-- except for
22653 SMTP-time rewriting &-- address).
22654
22655 As soon as a message's header lines have been received, all the envelope
22656 recipient addresses are permanently rewritten, and rewriting is also applied to
22657 the addresses in the header lines (if configured). This happens before adding
22658 any header lines that were specified in MAIL or RCPT ACLs, and
22659 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22660 before the DATA ACL and &[local_scan()]& functions are run.
22661
22662 When an address is being routed, either for delivery or for verification,
22663 rewriting is applied immediately to child addresses that are generated by
22664 redirection, unless &%no_rewrite%& is set on the router.
22665
22666 .cindex "envelope sender" "rewriting at transport time"
22667 .cindex "rewriting" "at transport time"
22668 .cindex "header lines" "rewriting at transport time"
22669 At transport time, additional rewriting of addresses in header lines can be
22670 specified by setting the generic &%headers_rewrite%& option on a transport.
22671 This option contains rules that are identical in form to those in the rewrite
22672 section of the configuration file. They are applied to the original message
22673 header lines and any that were added by ACLs or a system filter. They are not
22674 applied to header lines that are added by routers or the transport.
22675
22676 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22677 transport option. However, it is not possible to rewrite envelope recipients at
22678 transport time.
22679
22680
22681
22682
22683 .section "Testing the rewriting rules that apply on input" "SECID149"
22684 .cindex "rewriting" "testing"
22685 .cindex "testing" "rewriting"
22686 Exim's input rewriting configuration appears in a part of the run time
22687 configuration file headed by &"begin rewrite"&. It can be tested by the
22688 &%-brw%& command line option. This takes an address (which can be a full RFC
22689 2822 address) as its argument. The output is a list of how the address would be
22690 transformed by the rewriting rules for each of the different places it might
22691 appear in an incoming message, that is, for each different header and for the
22692 envelope sender and recipient fields. For example,
22693 .code
22694 exim -brw ph10@exim.workshop.example
22695 .endd
22696 might produce the output
22697 .code
22698 sender: Philip.Hazel@exim.workshop.example
22699 from: Philip.Hazel@exim.workshop.example
22700 to: ph10@exim.workshop.example
22701 cc: ph10@exim.workshop.example
22702 bcc: ph10@exim.workshop.example
22703 reply-to: Philip.Hazel@exim.workshop.example
22704 env-from: Philip.Hazel@exim.workshop.example
22705 env-to: ph10@exim.workshop.example
22706 .endd
22707 which shows that rewriting has been set up for that address when used in any of
22708 the source fields, but not when it appears as a recipient address. At the
22709 present time, there is no equivalent way of testing rewriting rules that are
22710 set for a particular transport.
22711
22712
22713 .section "Rewriting rules" "SECID150"
22714 .cindex "rewriting" "rules"
22715 The rewrite section of the configuration file consists of lines of rewriting
22716 rules in the form
22717 .display
22718 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22719 .endd
22720 Rewriting rules that are specified for the &%headers_rewrite%& generic
22721 transport option are given as a colon-separated list. Each item in the list
22722 takes the same form as a line in the main rewriting configuration (except that
22723 any colons must be doubled, of course).
22724
22725 The formats of source patterns and replacement strings are described below.
22726 Each is terminated by white space, unless enclosed in double quotes, in which
22727 case normal quoting conventions apply inside the quotes. The flags are single
22728 characters which may appear in any order. Spaces and tabs between them are
22729 ignored.
22730
22731 For each address that could potentially be rewritten, the rules are scanned in
22732 order, and replacements for the address from earlier rules can themselves be
22733 replaced by later rules (but see the &"q"& and &"R"& flags).
22734
22735 The order in which addresses are rewritten is undefined, may change between
22736 releases, and must not be relied on, with one exception: when a message is
22737 received, the envelope sender is always rewritten first, before any header
22738 lines are rewritten. For example, the replacement string for a rewrite of an
22739 address in &'To:'& must not assume that the message's address in &'From:'& has
22740 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22741 that the envelope sender has already been rewritten.
22742
22743 .vindex "&$domain$&"
22744 .vindex "&$local_part$&"
22745 The variables &$local_part$& and &$domain$& can be used in the replacement
22746 string to refer to the address that is being rewritten. Note that lookup-driven
22747 rewriting can be done by a rule of the form
22748 .code
22749 *@*   ${lookup ...
22750 .endd
22751 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22752 refer to the address that is being rewritten.
22753
22754
22755 .section "Rewriting patterns" "SECID151"
22756 .cindex "rewriting" "patterns"
22757 .cindex "address list" "in a rewriting pattern"
22758 The source pattern in a rewriting rule is any item which may appear in an
22759 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22760 single-item address list, which means that it is expanded before being tested
22761 against the address. As always, if you use a regular expression as a pattern,
22762 you must take care to escape dollar and backslash characters, or use the &`\N`&
22763 facility to suppress string expansion within the regular expression.
22764
22765 Domains in patterns should be given in lower case. Local parts in patterns are
22766 case-sensitive. If you want to do case-insensitive matching of local parts, you
22767 can use a regular expression that starts with &`^(?i)`&.
22768
22769 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22770 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22771 depending on the type of match which occurred. These can be used in the
22772 replacement string to insert portions of the incoming address. &$0$& always
22773 refers to the complete incoming address. When a regular expression is used, the
22774 numerical variables are set from its capturing subexpressions. For other types
22775 of pattern they are set as follows:
22776
22777 .ilist
22778 If a local part or domain starts with an asterisk, the numerical variables
22779 refer to the character strings matched by asterisks, with &$1$& associated with
22780 the first asterisk, and &$2$& with the second, if present. For example, if the
22781 pattern
22782 .code
22783 *queen@*.fict.example
22784 .endd
22785 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22786 .code
22787 $0 = hearts-queen@wonderland.fict.example
22788 $1 = hearts-
22789 $2 = wonderland
22790 .endd
22791 Note that if the local part does not start with an asterisk, but the domain
22792 does, it is &$1$& that contains the wild part of the domain.
22793
22794 .next
22795 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22796 of the domain are placed in the next available numerical variables. Suppose,
22797 for example, that the address &'foo@bar.baz.example'& is processed by a
22798 rewriting rule of the form
22799 .display
22800 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22801 .endd
22802 and the key in the file that matches the domain is &`*.baz.example`&. Then
22803 .code
22804 $1 = foo
22805 $2 = bar
22806 $3 = baz.example
22807 .endd
22808 If the address &'foo@baz.example'& is looked up, this matches the same
22809 wildcard file entry, and in this case &$2$& is set to the empty string, but
22810 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22811 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22812 whole domain. For non-partial domain lookups, no numerical variables are set.
22813 .endlist
22814
22815
22816 .section "Rewriting replacements" "SECID152"
22817 .cindex "rewriting" "replacements"
22818 If the replacement string for a rule is a single asterisk, addresses that
22819 match the pattern and the flags are &'not'& rewritten, and no subsequent
22820 rewriting rules are scanned. For example,
22821 .code
22822 hatta@lookingglass.fict.example  *  f
22823 .endd
22824 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22825 &'From:'& headers.
22826
22827 .vindex "&$domain$&"
22828 .vindex "&$local_part$&"
22829 If the replacement string is not a single asterisk, it is expanded, and must
22830 yield a fully qualified address. Within the expansion, the variables
22831 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22832 Any letters they contain retain their original case &-- they are not lower
22833 cased. The numerical variables are set up according to the type of pattern that
22834 matched the address, as described above. If the expansion is forced to fail by
22835 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22836 current rule is abandoned, but subsequent rules may take effect. Any other
22837 expansion failure causes the entire rewriting operation to be abandoned, and an
22838 entry written to the panic log.
22839
22840
22841
22842 .section "Rewriting flags" "SECID153"
22843 There are three different kinds of flag that may appear on rewriting rules:
22844
22845 .ilist
22846 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22847 c, f, h, r, s, t.
22848 .next
22849 A flag that specifies rewriting at SMTP time: S.
22850 .next
22851 Flags that control the rewriting process: Q, q, R, w.
22852 .endlist
22853
22854 For rules that are part of the &%headers_rewrite%& generic transport option,
22855 E, F, T, and S are not permitted.
22856
22857
22858
22859 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22860          "SECID154"
22861 .cindex "rewriting" "flags"
22862 If none of the following flag letters, nor the &"S"& flag (see section
22863 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22864 and to both the sender and recipient fields of the envelope, whereas a
22865 transport-time rewriting rule just applies to all headers. Otherwise, the
22866 rewriting rule is skipped unless the relevant addresses are being processed.
22867 .display
22868 &`E`&       rewrite all envelope fields
22869 &`F`&       rewrite the envelope From field
22870 &`T`&       rewrite the envelope To field
22871 &`b`&       rewrite the &'Bcc:'& header
22872 &`c`&       rewrite the &'Cc:'& header
22873 &`f`&       rewrite the &'From:'& header
22874 &`h`&       rewrite all headers
22875 &`r`&       rewrite the &'Reply-To:'& header
22876 &`s`&       rewrite the &'Sender:'& header
22877 &`t`&       rewrite the &'To:'& header
22878 .endd
22879 "All headers" means all of the headers listed above that can be selected
22880 individually, plus their &'Resent-'& versions. It does not include
22881 other headers such as &'Subject:'& etc.
22882
22883 You should be particularly careful about rewriting &'Sender:'& headers, and
22884 restrict this to special known cases in your own domains.
22885
22886
22887 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22888 .cindex "SMTP" "rewriting malformed addresses"
22889 .cindex "RCPT" "rewriting argument of"
22890 .cindex "MAIL" "rewriting argument of"
22891 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22892 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22893 before any other processing; even before syntax checking. The pattern is
22894 required to be a regular expression, and it is matched against the whole of the
22895 data for the command, including any surrounding angle brackets.
22896
22897 .vindex "&$domain$&"
22898 .vindex "&$local_part$&"
22899 This form of rewrite rule allows for the handling of addresses that are not
22900 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22901 input). Because the input is not required to be a syntactically valid address,
22902 the variables &$local_part$& and &$domain$& are not available during the
22903 expansion of the replacement string. The result of rewriting replaces the
22904 original address in the MAIL or RCPT command.
22905
22906
22907 .section "Flags controlling the rewriting process" "SECID155"
22908 There are four flags which control the way the rewriting process works. These
22909 take effect only when a rule is invoked, that is, when the address is of the
22910 correct type (matches the flags) and matches the pattern:
22911
22912 .ilist
22913 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22914 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22915 absence of &"Q"& the rewritten address must always include a domain.
22916 .next
22917 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22918 even if no rewriting actually takes place because of a &"fail"& in the
22919 expansion. The &"q"& flag is not effective if the address is of the wrong type
22920 (does not match the flags) or does not match the pattern.
22921 .next
22922 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22923 address, up to ten times. It can be combined with the &"q"& flag, to stop
22924 rewriting once it fails to match (after at least one successful rewrite).
22925 .next
22926 .cindex "rewriting" "whole addresses"
22927 When an address in a header is rewritten, the rewriting normally applies only
22928 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22929 left unchanged. For example, rewriting might change
22930 .code
22931 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22932 .endd
22933 into
22934 .code
22935 From: Ford Prefect <prefectf@hitch.fict.example>
22936 .endd
22937 .cindex "RFC 2047"
22938 Sometimes there is a need to replace the whole address item, and this can be
22939 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22940 causes an address in a header line to be rewritten, the entire address is
22941 replaced, not just the working part. The replacement must be a complete RFC
22942 2822 address, including the angle brackets if necessary. If text outside angle
22943 brackets contains a character whose value is greater than 126 or less than 32
22944 (except for tab), the text is encoded according to RFC 2047. The character set
22945 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22946
22947 When the &"w"& flag is set on a rule that causes an envelope address to be
22948 rewritten, all but the working part of the replacement address is discarded.
22949 .endlist
22950
22951
22952 .section "Rewriting examples" "SECID156"
22953 Here is an example of the two common rewriting paradigms:
22954 .code
22955 *@*.hitch.fict.example  $1@hitch.fict.example
22956 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22957                      {$value}fail}@hitch.fict.example bctfrF
22958 .endd
22959 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22960 the string expansion to fail if the lookup does not succeed. In this context it
22961 has the effect of leaving the original address unchanged, but Exim goes on to
22962 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22963 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22964 explicitly, which would cause the rewritten address to be the same as before,
22965 at the cost of a small bit of processing. Not supplying either of these is an
22966 error, since the rewritten address would then contain no local part.
22967
22968 The first example above replaces the domain with a superior, more general
22969 domain. This may not be desirable for certain local parts. If the rule
22970 .code
22971 root@*.hitch.fict.example  *
22972 .endd
22973 were inserted before the first rule, rewriting would be suppressed for the
22974 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22975
22976 Rewriting can be made conditional on a number of tests, by making use of
22977 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22978 messages that originate outside the local host:
22979 .code
22980 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22981                          {$1@hitch.fict.example}fail}"
22982 .endd
22983 The replacement string is quoted in this example because it contains white
22984 space.
22985
22986 .cindex "rewriting" "bang paths"
22987 .cindex "bang paths" "rewriting"
22988 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22989 an address it treats it as an unqualified local part which it qualifies with
22990 the local qualification domain (if the source of the message is local or if the
22991 remote host is permitted to send unqualified addresses). Rewriting can
22992 sometimes be used to handle simple bang paths with a fixed number of
22993 components. For example, the rule
22994 .code
22995 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22996 .endd
22997 rewrites a two-component bang path &'host.name!user'& as the domain address
22998 &'user@host.name'&. However, there is a security implication in using this as
22999 a global rewriting rule for envelope addresses. It can provide a backdoor
23000 method for using your system as a relay, because the incoming addresses appear
23001 to be local. If the bang path addresses are received via SMTP, it is safer to
23002 use the &"S"& flag to rewrite them as they are received, so that relay checking
23003 can be done on the rewritten addresses.
23004 .ecindex IIDaddrew
23005
23006
23007
23008
23009
23010 . ////////////////////////////////////////////////////////////////////////////
23011 . ////////////////////////////////////////////////////////////////////////////
23012
23013 .chapter "Retry configuration" "CHAPretry"
23014 .scindex IIDretconf1 "retry" "configuration, description of"
23015 .scindex IIDregconf2 "configuration file" "retry section"
23016 The &"retry"& section of the runtime configuration file contains a list of
23017 retry rules that control how often Exim tries to deliver messages that cannot
23018 be delivered at the first attempt. If there are no retry rules (the section is
23019 empty or not present), there are no retries. In this situation, temporary
23020 errors are treated as permanent. The default configuration contains a single,
23021 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23022 line option can be used to test which retry rule will be used for a given
23023 address, domain and error.
23024
23025 The most common cause of retries is temporary failure to deliver to a remote
23026 host because the host is down, or inaccessible because of a network problem.
23027 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23028 address) basis, not on a per-message basis. Thus, if one message has recently
23029 been delayed, delivery of a new message to the same host is not immediately
23030 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23031 log selector is set, the message
23032 .cindex "retry" "time not reached"
23033 &"retry time not reached"& is written to the main log whenever a delivery is
23034 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23035 the handling of errors during remote deliveries.
23036
23037 Retry processing applies to routing as well as to delivering, except as covered
23038 in the next paragraph. The retry rules do not distinguish between these
23039 actions. It is not possible, for example, to specify different behaviour for
23040 failures to route the domain &'snark.fict.example'& and failures to deliver to
23041 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23042 added complication, so did not implement it. However, although they share the
23043 same retry rule, the actual retry times for routing and transporting a given
23044 domain are maintained independently.
23045
23046 When a delivery is not part of a queue run (typically an immediate delivery on
23047 receipt of a message), the routers are always run, and local deliveries are
23048 always attempted, even if retry times are set for them. This makes for better
23049 behaviour if one particular message is causing problems (for example, causing
23050 quota overflow, or provoking an error in a filter file). If such a delivery
23051 suffers a temporary failure, the retry data is updated as normal, and
23052 subsequent delivery attempts from queue runs occur only when the retry time for
23053 the local address is reached.
23054
23055 .section "Changing retry rules" "SECID157"
23056 If you change the retry rules in your configuration, you should consider
23057 whether or not to delete the retry data that is stored in Exim's spool area in
23058 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23059 always safe; that is why they are called &"hints"&.
23060
23061 The hints retry data contains suggested retry times based on the previous
23062 rules. In the case of a long-running problem with a remote host, it might
23063 record the fact that the host has timed out. If your new rules increase the
23064 timeout time for such a host, you should definitely remove the old retry data
23065 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23066 messages that it should now be retaining.
23067
23068
23069
23070 .section "Format of retry rules" "SECID158"
23071 .cindex "retry" "rules"
23072 Each retry rule occupies one line and consists of three or four parts,
23073 separated by white space: a pattern, an error name, an optional list of sender
23074 addresses, and a list of retry parameters. The pattern and sender lists must be
23075 enclosed in double quotes if they contain white space. The rules are searched
23076 in order until one is found where the pattern, error name, and sender list (if
23077 present) match the failing host or address, the error that occurred, and the
23078 message's sender, respectively.
23079
23080
23081 The pattern is any single item that may appear in an address list (see section
23082 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23083 which means that it is expanded before being tested against the address that
23084 has been delayed. A negated address list item is permitted. Address
23085 list processing treats a plain domain name as if it were preceded by &"*@"&,
23086 which makes it possible for many retry rules to start with just a domain. For
23087 example,
23088 .code
23089 lookingglass.fict.example        *  F,24h,30m;
23090 .endd
23091 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23092 whereas
23093 .code
23094 alice@lookingglass.fict.example  *  F,24h,30m;
23095 .endd
23096 applies only to temporary failures involving the local part &%alice%&.
23097 In practice, almost all rules start with a domain name pattern without a local
23098 part.
23099
23100 .cindex "regular expressions" "in retry rules"
23101 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23102 must match a complete address, not just a domain, because that is how regular
23103 expressions work in address lists.
23104 .display
23105 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23106 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23107 .endd
23108
23109
23110 .section "Choosing which retry rule to use for address errors" "SECID159"
23111 When Exim is looking for a retry rule after a routing attempt has failed (for
23112 example, after a DNS timeout), each line in the retry configuration is tested
23113 against the complete address only if &%retry_use_local_part%& is set for the
23114 router. Otherwise, only the domain is used, except when matching against a
23115 regular expression, when the local part of the address is replaced with &"*"&.
23116 A domain on its own can match a domain pattern, or a pattern that starts with
23117 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23118 &%check_local_user%& is true, and false for other routers.
23119
23120 Similarly, when Exim is looking for a retry rule after a local delivery has
23121 failed (for example, after a mailbox full error), each line in the retry
23122 configuration is tested against the complete address only if
23123 &%retry_use_local_part%& is set for the transport (it defaults true for all
23124 local transports).
23125
23126 .cindex "4&'xx'& responses" "retry rules for"
23127 However, when Exim is looking for a retry rule after a remote delivery attempt
23128 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23129 whole address is always used as the key when searching the retry rules. The
23130 rule that is found is used to create a retry time for the combination of the
23131 failing address and the message's sender. It is the combination of sender and
23132 recipient that is delayed in subsequent queue runs until its retry time is
23133 reached. You can delay the recipient without regard to the sender by setting
23134 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23135 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23136 commands.
23137
23138
23139
23140 .section "Choosing which retry rule to use for host and message errors" &&&
23141          "SECID160"
23142 For a temporary error that is not related to an individual address (for
23143 example, a connection timeout), each line in the retry configuration is checked
23144 twice. First, the name of the remote host is used as a domain name (preceded by
23145 &"*@"& when matching a regular expression). If this does not match the line,
23146 the domain from the email address is tried in a similar fashion. For example,
23147 suppose the MX records for &'a.b.c.example'& are
23148 .code
23149 a.b.c.example  MX  5  x.y.z.example
23150                MX  6  p.q.r.example
23151                MX  7  m.n.o.example
23152 .endd
23153 and the retry rules are
23154 .code
23155 p.q.r.example    *      F,24h,30m;
23156 a.b.c.example    *      F,4d,45m;
23157 .endd
23158 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23159 first rule matches neither the host nor the domain, so Exim looks at the second
23160 rule. This does not match the host, but it does match the domain, so it is used
23161 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23162 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23163 first retry rule is used, because it matches the host.
23164
23165 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23166 first rule to determine retry times, but for all the other hosts for the domain
23167 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23168 routing to &'a.b.c.example'& suffers a temporary failure.
23169
23170 &*Note*&: The host name is used when matching the patterns, not its IP address.
23171 However, if a message is routed directly to an IP address without the use of a
23172 host name, for example, if a &(manualroute)& router contains a setting such as:
23173 .code
23174 route_list = *.a.example  192.168.34.23
23175 .endd
23176 then the &"host name"& that is used when searching for a retry rule is the
23177 textual form of the IP address.
23178
23179 .section "Retry rules for specific errors" "SECID161"
23180 .cindex "retry" "specific errors; specifying"
23181 The second field in a retry rule is the name of a particular error, or an
23182 asterisk, which matches any error. The errors that can be tested for are:
23183
23184 .vlist
23185 .vitem &%auth_failed%&
23186 Authentication failed when trying to send to a host in the
23187 &%hosts_require_auth%& list in an &(smtp)& transport.
23188
23189 .vitem &%data_4xx%&
23190 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23191 after the command, or after sending the message's data.
23192
23193 .vitem &%mail_4xx%&
23194 A 4&'xx'& error was received for an outgoing MAIL command.
23195
23196 .vitem &%rcpt_4xx%&
23197 A 4&'xx'& error was received for an outgoing RCPT command.
23198 .endlist
23199
23200 For the three 4&'xx'& errors, either the first or both of the x's can be given
23201 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23202 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23203 and have retries every ten minutes with a one-hour timeout, you could set up a
23204 retry rule of this form:
23205 .code
23206 the.domain.name  rcpt_452   F,1h,10m
23207 .endd
23208 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23209 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23210
23211 .vlist
23212 .vitem &%lost_connection%&
23213 A server unexpectedly closed the SMTP connection. There may, of course,
23214 legitimate reasons for this (host died, network died), but if it repeats a lot
23215 for the same host, it indicates something odd.
23216
23217 .vitem &%refused_MX%&
23218 A connection to a host obtained from an MX record was refused.
23219
23220 .vitem &%refused_A%&
23221 A connection to a host not obtained from an MX record was refused.
23222
23223 .vitem &%refused%&
23224 A connection was refused.
23225
23226 .vitem &%timeout_connect_MX%&
23227 A connection attempt to a host obtained from an MX record timed out.
23228
23229 .vitem &%timeout_connect_A%&
23230 A connection attempt to a host not obtained from an MX record timed out.
23231
23232 .vitem &%timeout_connect%&
23233 A connection attempt timed out.
23234
23235 .vitem &%timeout_MX%&
23236 There was a timeout while connecting or during an SMTP session with a host
23237 obtained from an MX record.
23238
23239 .vitem &%timeout_A%&
23240 There was a timeout while connecting or during an SMTP session with a host not
23241 obtained from an MX record.
23242
23243 .vitem &%timeout%&
23244 There was a timeout while connecting or during an SMTP session.
23245
23246 .vitem &%tls_required%&
23247 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23248 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23249 to STARTTLS, or there was a problem setting up the TLS connection.
23250
23251 .vitem &%quota%&
23252 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23253 transport.
23254
23255 .vitem &%quota_%&<&'time'&>
23256 .cindex "quota" "error testing in retry rule"
23257 .cindex "retry" "quota error testing"
23258 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23259 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23260 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23261 for four days.
23262 .endlist
23263
23264 .cindex "mailbox" "time of last read"
23265 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23266 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23267 it should be based on the last time that the user accessed the mailbox.
23268 However, it is not always possible to determine this. Exim uses the following
23269 heuristic rules:
23270
23271 .ilist
23272 If the mailbox is a single file, the time of last access (the &"atime"&) is
23273 used. As no new messages are being delivered (because the mailbox is over
23274 quota), Exim does not access the file, so this is the time of last user access.
23275 .next
23276 .cindex "maildir format" "time of last read"
23277 For a maildir delivery, the time of last modification of the &_new_&
23278 subdirectory is used. As the mailbox is over quota, no new files are created in
23279 the &_new_& subdirectory, because no new messages are being delivered. Any
23280 change to the &_new_& subdirectory is therefore assumed to be the result of an
23281 MUA moving a new message to the &_cur_& directory when it is first read. The
23282 time that is used is therefore the last time that the user read a new message.
23283 .next
23284 For other kinds of multi-file mailbox, the time of last access cannot be
23285 obtained, so a retry rule that uses this type of error field is never matched.
23286 .endlist
23287
23288 The quota errors apply both to system-enforced quotas and to Exim's own quota
23289 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23290 when a local delivery is deferred because a partition is full (the ENOSPC
23291 error).
23292
23293
23294
23295 .section "Retry rules for specified senders" "SECID162"
23296 .cindex "retry" "rules; sender-specific"
23297 You can specify retry rules that apply only when the failing message has a
23298 specific sender. In particular, this can be used to define retry rules that
23299 apply only to bounce messages. The third item in a retry rule can be of this
23300 form:
23301 .display
23302 &`senders=`&<&'address list'&>
23303 .endd
23304 The retry timings themselves are then the fourth item. For example:
23305 .code
23306 *   rcpt_4xx   senders=:   F,1h,30m
23307 .endd
23308 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23309 host. If the address list contains white space, it must be enclosed in quotes.
23310 For example:
23311 .code
23312 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23313 .endd
23314 &*Warning*&: This facility can be unhelpful if it is used for host errors
23315 (which do not depend on the recipient). The reason is that the sender is used
23316 only to match the retry rule. Once the rule has been found for a host error,
23317 its contents are used to set a retry time for the host, and this will apply to
23318 all messages, not just those with specific senders.
23319
23320 When testing retry rules using &%-brt%&, you can supply a sender using the
23321 &%-f%& command line option, like this:
23322 .code
23323 exim -f "" -brt user@dom.ain
23324 .endd
23325 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23326 list is never matched.
23327
23328
23329
23330
23331
23332 .section "Retry parameters" "SECID163"
23333 .cindex "retry" "parameters in rules"
23334 The third (or fourth, if a senders list is present) field in a retry rule is a
23335 sequence of retry parameter sets, separated by semicolons. Each set consists of
23336 .display
23337 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23338 .endd
23339 The letter identifies the algorithm for computing a new retry time; the cutoff
23340 time is the time beyond which this algorithm no longer applies, and the
23341 arguments vary the algorithm's action. The cutoff time is measured from the
23342 time that the first failure for the domain (combined with the local part if
23343 relevant) was detected, not from the time the message was received.
23344
23345 .cindex "retry" "algorithms"
23346 .cindex "retry" "fixed intervals"
23347 .cindex "retry" "increasing intervals"
23348 .cindex "retry" "random intervals"
23349 The available algorithms are:
23350
23351 .ilist
23352 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23353 the interval.
23354 .next
23355 &'G'&: retry at geometrically increasing intervals. The first argument
23356 specifies a starting value for the interval, and the second a multiplier, which
23357 is used to increase the size of the interval at each retry.
23358 .next
23359 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23360 retry, the previous interval is multiplied by the factor in order to get a
23361 maximum for the next interval. The minimum interval is the first argument of
23362 the parameter, and an actual interval is chosen randomly between them. Such a
23363 rule has been found to be helpful in cluster configurations when all the
23364 members of the cluster restart at once, and may therefore synchronize their
23365 queue processing times.
23366 .endlist
23367
23368 When computing the next retry time, the algorithm definitions are scanned in
23369 order until one whose cutoff time has not yet passed is reached. This is then
23370 used to compute a new retry time that is later than the current time. In the
23371 case of fixed interval retries, this simply means adding the interval to the
23372 current time. For geometrically increasing intervals, retry intervals are
23373 computed from the rule's parameters until one that is greater than the previous
23374 interval is found. The main configuration variable
23375 .cindex "limit" "retry interval"
23376 .cindex "retry" "interval, maximum"
23377 .oindex "&%retry_interval_max%&"
23378 &%retry_interval_max%& limits the maximum interval between retries. It
23379 cannot be set greater than &`24h`&, which is its default value.
23380
23381 A single remote domain may have a number of hosts associated with it, and each
23382 host may have more than one IP address. Retry algorithms are selected on the
23383 basis of the domain name, but are applied to each IP address independently. If,
23384 for example, a host has two IP addresses and one is unusable, Exim will
23385 generate retry times for it and will not try to use it until its next retry
23386 time comes. Thus the good IP address is likely to be tried first most of the
23387 time.
23388
23389 .cindex "hints database" "use for retrying"
23390 Retry times are hints rather than promises. Exim does not make any attempt to
23391 run deliveries exactly at the computed times. Instead, a queue runner process
23392 starts delivery processes for delayed messages periodically, and these attempt
23393 new deliveries only for those addresses that have passed their next retry time.
23394 If a new message arrives for a deferred address, an immediate delivery attempt
23395 occurs only if the address has passed its retry time. In the absence of new
23396 messages, the minimum time between retries is the interval between queue runner
23397 processes. There is not much point in setting retry times of five minutes if
23398 your queue runners happen only once an hour, unless there are a significant
23399 number of incoming messages (which might be the case on a system that is
23400 sending everything to a smart host, for example).
23401
23402 The data in the retry hints database can be inspected by using the
23403 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23404 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23405 &'exinext'& utility script can be used to find out what the next retry times
23406 are for the hosts associated with a particular mail domain, and also for local
23407 deliveries that have been deferred.
23408
23409
23410 .section "Retry rule examples" "SECID164"
23411 Here are some example retry rules:
23412 .code
23413 alice@wonderland.fict.example quota_5d  F,7d,3h
23414 wonderland.fict.example       quota_5d
23415 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23416 lookingglass.fict.example     *         F,24h,30m;
23417 *                 refused_A   F,2h,20m;
23418 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23419 .endd
23420 The first rule sets up special handling for mail to
23421 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23422 mailbox has not been read for at least 5 days. Retries continue every three
23423 hours for 7 days. The second rule handles over-quota errors for all other local
23424 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23425 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23426 fail are bounced immediately if the mailbox has not been read for at least 5
23427 days.
23428
23429 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23430 happen every 15 minutes for an hour, then with geometrically increasing
23431 intervals until two days have passed since a delivery first failed. After the
23432 first hour there is a delay of one hour, then two hours, then four hours, and
23433 so on (this is a rather extreme example).
23434
23435 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23436 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23437 all other domains, with special action for connection refusal from hosts that
23438 were not obtained from an MX record.
23439
23440 The final rule in a retry configuration should always have asterisks in the
23441 first two fields so as to provide a general catch-all for any addresses that do
23442 not have their own special handling. This example tries every 15 minutes for 2
23443 hours, then with intervals starting at one hour and increasing by a factor of
23444 1.5 up to 16 hours, then every 8 hours up to 5 days.
23445
23446
23447
23448 .section "Timeout of retry data" "SECID165"
23449 .cindex "timeout" "of retry data"
23450 .oindex "&%retry_data_expire%&"
23451 .cindex "hints database" "data expiry"
23452 .cindex "retry" "timeout of data"
23453 Exim timestamps the data that it writes to its retry hints database. When it
23454 consults the data during a delivery it ignores any that is older than the value
23455 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23456 been tried for 7 days, Exim will try to deliver to it immediately a message
23457 arrives, and if that fails, it will calculate a retry time as if it were
23458 failing for the first time.
23459
23460 This improves the behaviour for messages routed to rarely-used hosts such as MX
23461 backups. If such a host was down at one time, and happens to be down again when
23462 Exim tries a month later, using the old retry data would imply that it had been
23463 down all the time, which is not a justified assumption.
23464
23465 If a host really is permanently dead, this behaviour causes a burst of retries
23466 every now and again, but only if messages routed to it are rare. If there is a
23467 message at least once every 7 days the retry data never expires.
23468
23469
23470
23471
23472 .section "Long-term failures" "SECID166"
23473 .cindex "delivery failure, long-term"
23474 .cindex "retry" "after long-term failure"
23475 Special processing happens when an email address has been failing for so long
23476 that the cutoff time for the last algorithm is reached. For example, using the
23477 default retry rule:
23478 .code
23479 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23480 .endd
23481 the cutoff time is four days. Reaching the retry cutoff is independent of how
23482 long any specific message has been failing; it is the length of continuous
23483 failure for the recipient address that counts.
23484
23485 When the cutoff time is reached for a local delivery, or for all the IP
23486 addresses associated with a remote delivery, a subsequent delivery failure
23487 causes Exim to give up on the address, and a bounce message is generated.
23488 In order to cater for new messages that use the failing address, a next retry
23489 time is still computed from the final algorithm, and is used as follows:
23490
23491 For local deliveries, one delivery attempt is always made for any subsequent
23492 messages. If this delivery fails, the address fails immediately. The
23493 post-cutoff retry time is not used.
23494
23495 If the delivery is remote, there are two possibilities, controlled by the
23496 .oindex "&%delay_after_cutoff%&"
23497 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23498 default. Until the post-cutoff retry time for one of the IP addresses is
23499 reached, the failing email address is bounced immediately, without a delivery
23500 attempt taking place. After that time, one new delivery attempt is made to
23501 those IP addresses that are past their retry times, and if that still fails,
23502 the address is bounced and new retry times are computed.
23503
23504 In other words, when all the hosts for a given email address have been failing
23505 for a long time, Exim bounces rather then defers until one of the hosts' retry
23506 times is reached. Then it tries once, and bounces if that attempt fails. This
23507 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23508 to a broken destination, but if the host does recover, Exim will eventually
23509 notice.
23510
23511 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23512 addresses are past their final cutoff time, Exim tries to deliver to those IP
23513 addresses that have not been tried since the message arrived. If there are
23514 no suitable IP addresses, or if they all fail, the address is bounced. In other
23515 words, it does not delay when a new message arrives, but tries the expired
23516 addresses immediately, unless they have been tried since the message arrived.
23517 If there is a continuous stream of messages for the failing domains, setting
23518 &%delay_after_cutoff%& false means that there will be many more attempts to
23519 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23520 true.
23521
23522 .section "Deliveries that work intermittently" "SECID167"
23523 .cindex "retry" "intermittently working deliveries"
23524 Some additional logic is needed to cope with cases where a host is
23525 intermittently available, or when a message has some attribute that prevents
23526 its delivery when others to the same address get through. In this situation,
23527 because some messages are successfully delivered, the &"retry clock"& for the
23528 host or address keeps getting reset by the successful deliveries, and so
23529 failing messages remain on the queue for ever because the cutoff time is never
23530 reached.
23531
23532 Two exceptional actions are applied to prevent this happening. The first
23533 applies to errors that are related to a message rather than a remote host.
23534 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23535 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23536 commands, and quota failures. For this type of error, if a message's arrival
23537 time is earlier than the &"first failed"& time for the error, the earlier time
23538 is used when scanning the retry rules to decide when to try next and when to
23539 time out the address.
23540
23541 The exceptional second action applies in all cases. If a message has been on
23542 the queue for longer than the cutoff time of any applicable retry rule for a
23543 given address, a delivery is attempted for that address, even if it is not yet
23544 time, and if this delivery fails, the address is timed out. A new retry time is
23545 not computed in this case, so that other messages for the same address are
23546 considered immediately.
23547 .ecindex IIDretconf1
23548 .ecindex IIDregconf2
23549
23550
23551
23552
23553
23554
23555 . ////////////////////////////////////////////////////////////////////////////
23556 . ////////////////////////////////////////////////////////////////////////////
23557
23558 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23559 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23560 .scindex IIDauthconf2 "authentication"
23561 The &"authenticators"& section of Exim's run time configuration is concerned
23562 with SMTP authentication. This facility is an extension to the SMTP protocol,
23563 described in RFC 2554, which allows a client SMTP host to authenticate itself
23564 to a server. This is a common way for a server to recognize clients that are
23565 permitted to use it as a relay. SMTP authentication is not of relevance to the
23566 transfer of mail between servers that have no managerial connection with each
23567 other.
23568
23569 .cindex "AUTH" "description of"
23570 Very briefly, the way SMTP authentication works is as follows:
23571
23572 .ilist
23573 The server advertises a number of authentication &'mechanisms'& in response to
23574 the client's EHLO command.
23575 .next
23576 The client issues an AUTH command, naming a specific mechanism. The command
23577 may, optionally, contain some authentication data.
23578 .next
23579 The server may issue one or more &'challenges'&, to which the client must send
23580 appropriate responses. In simple authentication mechanisms, the challenges are
23581 just prompts for user names and passwords. The server does not have to issue
23582 any challenges &-- in some mechanisms the relevant data may all be transmitted
23583 with the AUTH command.
23584 .next
23585 The server either accepts or denies authentication.
23586 .next
23587 If authentication succeeds, the client may optionally make use of the AUTH
23588 option on the MAIL command to pass an authenticated sender in subsequent
23589 mail transactions. Authentication lasts for the remainder of the SMTP
23590 connection.
23591 .next
23592 If authentication fails, the client may give up, or it may try a different
23593 authentication mechanism, or it may try transferring mail over the
23594 unauthenticated connection.
23595 .endlist
23596
23597 If you are setting up a client, and want to know which authentication
23598 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23599 SMTP port) on the server, and issue an EHLO command. The response to this
23600 includes the list of supported mechanisms. For example:
23601 .display
23602 &`$ `&&*&`telnet server.example 25`&*&
23603 &`Trying 192.168.34.25...`&
23604 &`Connected to server.example.`&
23605 &`Escape character is &#x0027;^]&#x0027;.`&
23606 &`220 server.example ESMTP Exim 4.20 ...`&
23607 &*&`ehlo client.example`&*&
23608 &`250-server.example Hello client.example [10.8.4.5]`&
23609 &`250-SIZE 52428800`&
23610 &`250-PIPELINING`&
23611 &`250-AUTH PLAIN`&
23612 &`250 HELP`&
23613 .endd
23614 The second-last line of this example output shows that the server supports
23615 authentication using the PLAIN mechanism. In Exim, the different authentication
23616 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23617 routers and transports, which authenticators are included in the binary is
23618 controlled by build-time definitions. The following are currently available,
23619 included by setting
23620 .code
23621 AUTH_CRAM_MD5=yes
23622 AUTH_CYRUS_SASL=yes
23623 .new
23624 AUTH_DOVECOT=yes
23625 AUTH_GSASL=yes
23626 AUTH_HEIMDAL_GSSAPI=yes
23627 .wen
23628 AUTH_PLAINTEXT=yes
23629 AUTH_SPA=yes
23630 .endd
23631 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23632 authentication mechanism (RFC 2195), and the second provides an interface to
23633 the Cyrus SASL authentication library.
23634 .new
23635 The third is an interface to Dovecot's authentication system, delegating the
23636 work via a socket interface.
23637 The fourth provides an interface to the GNU SASL authentication library, which
23638 provides mechanisms but typically not data sources.
23639 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
23640 supporting setting a server keytab.
23641 The sixth can be configured to support
23642 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23643 not formally documented, but used by several MUAs. The seventh authenticator
23644 supports Microsoft's &'Secure Password Authentication'& mechanism.
23645 .wen
23646
23647 The authenticators are configured using the same syntax as other drivers (see
23648 section &<<SECTfordricon>>&). If no authenticators are required, no
23649 authentication section need be present in the configuration file. Each
23650 authenticator can in principle have both server and client functions. When Exim
23651 is receiving SMTP mail, it is acting as a server; when it is sending out
23652 messages over SMTP, it is acting as a client. Authenticator configuration
23653 options are provided for use in both these circumstances.
23654
23655 To make it clear which options apply to which situation, the prefixes
23656 &%server_%& and &%client_%& are used on option names that are specific to
23657 either the server or the client function, respectively. Server and client
23658 functions are disabled if none of their options are set. If an authenticator is
23659 to be used for both server and client functions, a single definition, using
23660 both sets of options, is required. For example:
23661 .code
23662 cram:
23663   driver = cram_md5
23664   public_name = CRAM-MD5
23665   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23666   client_name = ph10
23667   client_secret = secret2
23668 .endd
23669 The &%server_%& option is used when Exim is acting as a server, and the
23670 &%client_%& options when it is acting as a client.
23671
23672 Descriptions of the individual authenticators are given in subsequent chapters.
23673 The remainder of this chapter covers the generic options for the
23674 authenticators, followed by general discussion of the way authentication works
23675 in Exim.
23676
23677 .new
23678 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
23679 per-mechanism basis.  Please read carefully to determine which variables hold
23680 account labels such as usercodes and which hold passwords or other
23681 authenticating data.
23682
23683 Note that some mechanisms support two different identifiers for accounts: the
23684 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
23685 and &'authz'& are commonly encountered.  The American spelling is standard here.
23686 Conceptually, authentication data such as passwords are tied to the identifier
23687 used to authenticate; servers may have rules to permit one user to act as a
23688 second user, so that after login the session is treated as though that second
23689 user had logged in.  That second user is the &'authorization id'&.  A robust
23690 configuration might confirm that the &'authz'& field is empty or matches the
23691 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
23692 as verified data, the &'authz'& as an unverified request which the server might
23693 choose to honour.
23694
23695 A &'realm'& is a text string, typically a domain name, presented by a server
23696 to a client to help it select an account and credentials to use.  In some
23697 mechanisms, the client and server provably agree on the realm, but clients
23698 typically can not treat the realm as secure data to be blindly trusted.
23699 .wen
23700
23701
23702
23703 .section "Generic options for authenticators" "SECID168"
23704 .cindex "authentication" "generic options"
23705 .cindex "options" "generic; for authenticators"
23706
23707 .option client_condition authenticators string&!! unset
23708 When Exim is authenticating as a client, it skips any authenticator whose
23709 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23710 used, for example, to skip plain text authenticators when the connection is not
23711 encrypted by a setting such as:
23712 .code
23713 client_condition = ${if !eq{$tls_cipher}{}}
23714 .endd
23715 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23716 used for incoming messages. In fact, during SMTP delivery, it contains the
23717 cipher used for the delivery.)
23718
23719
23720 .option driver authenticators string unset
23721 This option must always be set. It specifies which of the available
23722 authenticators is to be used.
23723
23724
23725 .option public_name authenticators string unset
23726 This option specifies the name of the authentication mechanism that the driver
23727 implements, and by which it is known to the outside world. These names should
23728 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23729 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23730 defaults to the driver's instance name.
23731
23732
23733 .option server_advertise_condition authenticators string&!! unset
23734 When a server is about to advertise an authentication mechanism, the condition
23735 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23736 mechanism is not advertised.
23737 If the expansion fails, the mechanism is not advertised. If the failure was not
23738 forced, and was not caused by a lookup defer, the incident is logged.
23739 See section &<<SECTauthexiser>>& below for further discussion.
23740
23741
23742 .option server_condition authenticators string&!! unset
23743 This option must be set for a &%plaintext%& server authenticator, where it
23744 is used directly to control authentication. See section &<<SECTplainserver>>&
23745 for details.
23746
23747 .new
23748 For the &(gsasl)& authenticator, this option is required for various
23749 mechanisms; see chapter &<<CHAPgsasl>>& for details.
23750 .wen
23751
23752 For the other authenticators, &%server_condition%& can be used as an additional
23753 authentication or authorization mechanism that is applied after the other
23754 authenticator conditions succeed. If it is set, it is expanded when the
23755 authenticator would otherwise return a success code. If the expansion is forced
23756 to fail, authentication fails. Any other expansion failure causes a temporary
23757 error code to be returned. If the result of a successful expansion is an empty
23758 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23759 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23760 other result, a temporary error code is returned, with the expanded string as
23761 the error text.
23762
23763
23764 .option server_debug_print authenticators string&!! unset
23765 If this option is set and authentication debugging is enabled (see the &%-d%&
23766 command line option), the string is expanded and included in the debugging
23767 output when the authenticator is run as a server. This can help with checking
23768 out the values of variables.
23769 If expansion of the string fails, the error message is written to the debugging
23770 output, and Exim carries on processing.
23771
23772
23773 .option server_set_id authenticators string&!! unset
23774 .vindex "&$authenticated_id$&"
23775 When an Exim server successfully authenticates a client, this string is
23776 expanded using data from the authentication, and preserved for any incoming
23777 messages in the variable &$authenticated_id$&. It is also included in the log
23778 lines for incoming messages. For example, a user/password authenticator
23779 configuration might preserve the user name that was used to authenticate, and
23780 refer to it subsequently during delivery of the message.
23781 If expansion fails, the option is ignored.
23782
23783
23784 .option server_mail_auth_condition authenticators string&!! unset
23785 This option allows a server to discard authenticated sender addresses supplied
23786 as part of MAIL commands in SMTP connections that are authenticated by the
23787 driver on which &%server_mail_auth_condition%& is set. The option is not used
23788 as part of the authentication process; instead its (unexpanded) value is
23789 remembered for later use.
23790 How it is used is described in the following section.
23791
23792
23793
23794
23795
23796 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23797 .cindex "authentication" "sender; authenticated"
23798 .cindex "AUTH" "on MAIL command"
23799 When a client supplied an AUTH= item on a MAIL command, Exim applies
23800 the following checks before accepting it as the authenticated sender of the
23801 message:
23802
23803 .ilist
23804 If the connection is not using extended SMTP (that is, HELO was used rather
23805 than EHLO), the use of AUTH= is a syntax error.
23806 .next
23807 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23808 .next
23809 .vindex "&$authenticated_sender$&"
23810 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23811 running, the value of &$authenticated_sender$& is set to the value obtained
23812 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23813 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23814 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23815 given for the MAIL command.
23816 .next
23817 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23818 is accepted and placed in &$authenticated_sender$& only if the client has
23819 authenticated.
23820 .next
23821 If the AUTH= value was accepted by either of the two previous rules, and
23822 the client has authenticated, and the authenticator has a setting for the
23823 &%server_mail_auth_condition%&, the condition is checked at this point. The
23824 valued that was saved from the authenticator is expanded. If the expansion
23825 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23826 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23827 the value of &$authenticated_sender$& is retained and passed on with the
23828 message.
23829 .endlist
23830
23831
23832 When &$authenticated_sender$& is set for a message, it is passed on to other
23833 hosts to which Exim authenticates as a client. Do not confuse this value with
23834 &$authenticated_id$&, which is a string obtained from the authentication
23835 process, and which is not usually a complete email address.
23836
23837 .vindex "&$sender_address$&"
23838 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23839 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23840 therefore make use of &$authenticated_sender$&. The converse is not true: the
23841 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23842 ACL is run.
23843
23844
23845
23846 .section "Authentication on an Exim server" "SECTauthexiser"
23847 .cindex "authentication" "on an Exim server"
23848 When Exim receives an EHLO command, it advertises the public names of those
23849 authenticators that are configured as servers, subject to the following
23850 conditions:
23851
23852 .ilist
23853 The client host must match &%auth_advertise_hosts%& (default *).
23854 .next
23855 It the &%server_advertise_condition%& option is set, its expansion must not
23856 yield the empty string, &"0"&, &"no"&, or &"false"&.
23857 .endlist
23858
23859 The order in which the authenticators are defined controls the order in which
23860 the mechanisms are advertised.
23861
23862 Some mail clients (for example, some versions of Netscape) require the user to
23863 provide a name and password for authentication whenever AUTH is advertised,
23864 even though authentication may not in fact be needed (for example, Exim may be
23865 set up to allow unconditional relaying from the client by an IP address check).
23866 You can make such clients more friendly by not advertising AUTH to them.
23867 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23868 that runs for RCPT) to relay without authentication, you should set
23869 .code
23870 auth_advertise_hosts = ! 10.9.8.0/24
23871 .endd
23872 so that no authentication mechanisms are advertised to them.
23873
23874 The &%server_advertise_condition%& controls the advertisement of individual
23875 authentication mechanisms. For example, it can be used to restrict the
23876 advertisement of a particular mechanism to encrypted connections, by a setting
23877 such as:
23878 .code
23879 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23880 .endd
23881 .vindex "&$tls_cipher$&"
23882 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23883 yields &"yes"&, which allows the advertisement to happen.
23884
23885 When an Exim server receives an AUTH command from a client, it rejects it
23886 immediately if AUTH was not advertised in response to an earlier EHLO
23887 command. This is the case if
23888
23889 .ilist
23890 The client host does not match &%auth_advertise_hosts%&; or
23891 .next
23892 No authenticators are configured with server options; or
23893 .next
23894 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23895 server authenticators.
23896 .endlist
23897
23898
23899 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23900 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23901 AUTH is accepted from any client host.
23902
23903 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23904 server authentication mechanism that was advertised in response to EHLO and
23905 that matches the one named in the AUTH command. If it finds one, it runs
23906 the appropriate authentication protocol, and authentication either succeeds or
23907 fails. If there is no matching advertised mechanism, the AUTH command is
23908 rejected with a 504 error.
23909
23910 .vindex "&$received_protocol$&"
23911 .vindex "&$sender_host_authenticated$&"
23912 When a message is received from an authenticated host, the value of
23913 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23914 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23915 public name) of the authenticator driver that successfully authenticated the
23916 client from which the message was received. This variable is empty if there was
23917 no successful authentication.
23918
23919
23920
23921
23922 .section "Testing server authentication" "SECID169"
23923 .cindex "authentication" "testing a server"
23924 .cindex "AUTH" "testing a server"
23925 .cindex "base64 encoding" "creating authentication test data"
23926 Exim's &%-bh%& option can be useful for testing server authentication
23927 configurations. The data for the AUTH command has to be sent using base64
23928 encoding. A quick way to produce such data for testing is the following Perl
23929 script:
23930 .code
23931 use MIME::Base64;
23932 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23933 .endd
23934 .cindex "binary zero" "in authentication data"
23935 This interprets its argument as a Perl string, and then encodes it. The
23936 interpretation as a Perl string allows binary zeros, which are required for
23937 some kinds of authentication, to be included in the data. For example, a
23938 command line to run this script on such data might be
23939 .code
23940 encode '\0user\0password'
23941 .endd
23942 Note the use of single quotes to prevent the shell interpreting the
23943 backslashes, so that they can be interpreted by Perl to specify characters
23944 whose code value is zero.
23945
23946 &*Warning 1*&: If either of the user or password strings starts with an octal
23947 digit, you must use three zeros instead of one after the leading backslash. If
23948 you do not, the octal digit that starts your string will be incorrectly
23949 interpreted as part of the code for the first character.
23950
23951 &*Warning 2*&: If there are characters in the strings that Perl interprets
23952 specially, you must use a Perl escape to prevent them being misinterpreted. For
23953 example, a command such as
23954 .code
23955 encode '\0user@domain.com\0pas$$word'
23956 .endd
23957 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23958
23959 If you have the &%mimencode%& command installed, another way to do produce
23960 base64-encoded strings is to run the command
23961 .code
23962 echo -e -n `\0user\0password' | mimencode
23963 .endd
23964 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23965 in the argument, and the &%-n%& option specifies no newline at the end of its
23966 output. However, not all versions of &%echo%& recognize these options, so you
23967 should check your version before relying on this suggestion.
23968
23969
23970
23971 .section "Authentication by an Exim client" "SECID170"
23972 .cindex "authentication" "on an Exim client"
23973 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23974 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23975 announces support for authentication, and the host matches an entry in either
23976 of these options, Exim (as a client) tries to authenticate as follows:
23977
23978 .ilist
23979 For each authenticator that is configured as a client, in the order in which
23980 they are defined in the configuration, it searches the authentication
23981 mechanisms announced by the server for one whose name matches the public name
23982 of the authenticator.
23983 .next
23984 .vindex "&$host$&"
23985 .vindex "&$host_address$&"
23986 When it finds one that matches, it runs the authenticator's client code. The
23987 variables &$host$& and &$host_address$& are available for any string expansions
23988 that the client might do. They are set to the server's name and IP address. If
23989 any expansion is forced to fail, the authentication attempt is abandoned, and
23990 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23991 delivery to be deferred.
23992 .next
23993 If the result of the authentication attempt is a temporary error or a timeout,
23994 Exim abandons trying to send the message to the host for the moment. It will
23995 try again later. If there are any backup hosts available, they are tried in the
23996 usual way.
23997 .next
23998 If the response to authentication is a permanent error (5&'xx'& code), Exim
23999 carries on searching the list of authenticators and tries another one if
24000 possible. If all authentication attempts give permanent errors, or if there are
24001 no attempts because no mechanisms match (or option expansions force failure),
24002 what happens depends on whether the host matches &%hosts_require_auth%& or
24003 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24004 delivery is deferred. The error can be detected in the retry rules, and thereby
24005 turned into a permanent error if you wish. In the second case, Exim tries to
24006 deliver the message unauthenticated.
24007 .endlist
24008
24009 .cindex "AUTH" "on MAIL command"
24010 When Exim has authenticated itself to a remote server, it adds the AUTH
24011 parameter to the MAIL commands it sends, if it has an authenticated sender for
24012 the message. If the message came from a remote host, the authenticated sender
24013 is the one that was receiving on an incoming MAIL command, provided that the
24014 incoming connection was authenticated and the &%server_mail_auth%& condition
24015 allowed the authenticated sender to be retained. If a local process calls Exim
24016 to send a message, the sender address that is built from the login name and
24017 &%qualify_domain%& is treated as authenticated. However, if the
24018 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24019 the authenticated sender that was received with the message.
24020 .ecindex IIDauthconf1
24021 .ecindex IIDauthconf2
24022
24023
24024
24025
24026
24027
24028 . ////////////////////////////////////////////////////////////////////////////
24029 . ////////////////////////////////////////////////////////////////////////////
24030
24031 .chapter "The plaintext authenticator" "CHAPplaintext"
24032 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24033 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24034 The &(plaintext)& authenticator can be configured to support the PLAIN and
24035 LOGIN authentication mechanisms, both of which transfer authentication data as
24036 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24037 security risk; you are strongly advised to insist on the use of SMTP encryption
24038 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24039 use unencrypted plain text, you should not use the same passwords for SMTP
24040 connections as you do for login accounts.
24041
24042 .section "Plaintext options" "SECID171"
24043 .cindex "options" "&(plaintext)& authenticator (server)"
24044 When configured as a server, &(plaintext)& uses the following options:
24045
24046 .option server_condition authenticators string&!! unset
24047 This is actually a global authentication option, but it must be set in order to
24048 configure the &(plaintext)& driver as a server. Its use is described below.
24049
24050 .option server_prompts plaintext string&!! unset
24051 The contents of this option, after expansion, must be a colon-separated list of
24052 prompt strings. If expansion fails, a temporary authentication rejection is
24053 given.
24054
24055 .section "Using plaintext in a server" "SECTplainserver"
24056 .cindex "AUTH" "in &(plaintext)& authenticator"
24057 .cindex "binary zero" "in &(plaintext)& authenticator"
24058 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24059         "in &(plaintext)& authenticator"
24060 .vindex "&$auth1$&, &$auth2$&, etc"
24061 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24062
24063 When running as a server, &(plaintext)& performs the authentication test by
24064 expanding a string. The data sent by the client with the AUTH command, or in
24065 response to subsequent prompts, is base64 encoded, and so may contain any byte
24066 values when decoded. If any data is supplied with the command, it is treated as
24067 a list of strings, separated by NULs (binary zeros), the first three of which
24068 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24069 (neither LOGIN nor PLAIN uses more than three strings).
24070
24071 For compatibility with previous releases of Exim, the values are also placed in
24072 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24073 variables for this purpose is now deprecated, as it can lead to confusion in
24074 string expansions that also use them for other things.
24075
24076 If there are more strings in &%server_prompts%& than the number of strings
24077 supplied with the AUTH command, the remaining prompts are used to obtain more
24078 data. Each response from the client may be a list of NUL-separated strings.
24079
24080 .vindex "&$authenticated_id$&"
24081 Once a sufficient number of data strings have been received,
24082 &%server_condition%& is expanded. If the expansion is forced to fail,
24083 authentication fails. Any other expansion failure causes a temporary error code
24084 to be returned. If the result of a successful expansion is an empty string,
24085 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24086 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24087 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24088 For any other result, a temporary error code is returned, with the expanded
24089 string as the error text.
24090
24091 &*Warning*&: If you use a lookup in the expansion to find the user's
24092 password, be sure to make the authentication fail if the user is unknown.
24093 There are good and bad examples at the end of the next section.
24094
24095
24096
24097 .section "The PLAIN authentication mechanism" "SECID172"
24098 .cindex "PLAIN authentication mechanism"
24099 .cindex "authentication" "PLAIN mechanism"
24100 .cindex "binary zero" "in &(plaintext)& authenticator"
24101 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24102 sent as one item of data (that is, one combined string containing two NUL
24103 separators). The data is sent either as part of the AUTH command, or
24104 subsequently in response to an empty prompt from the server.
24105
24106 The second and third strings are a user name and a corresponding password.
24107 Using a single fixed user name and password as an example, this could be
24108 configured as follows:
24109 .code
24110 fixed_plain:
24111   driver = plaintext
24112   public_name = PLAIN
24113   server_prompts = :
24114   server_condition = \
24115     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24116   server_set_id = $auth2
24117 .endd
24118 Note that the default result strings from &%if%& (&"true"& or an empty string)
24119 are exactly what we want here, so they need not be specified. Obviously, if the
24120 password contains expansion-significant characters such as dollar, backslash,
24121 or closing brace, they have to be escaped.
24122
24123 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24124 the end of a string list are ignored). If all the data comes as part of the
24125 AUTH command, as is commonly the case, the prompt is not used. This
24126 authenticator is advertised in the response to EHLO as
24127 .code
24128 250-AUTH PLAIN
24129 .endd
24130 and a client host can authenticate itself by sending the command
24131 .code
24132 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24133 .endd
24134 As this contains three strings (more than the number of prompts), no further
24135 data is required from the client. Alternatively, the client may just send
24136 .code
24137 AUTH PLAIN
24138 .endd
24139 to initiate authentication, in which case the server replies with an empty
24140 prompt. The client must respond with the combined data string.
24141
24142 The data string is base64 encoded, as required by the RFC. This example,
24143 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24144 represents a zero byte. This is split up into three strings, the first of which
24145 is empty. The &%server_condition%& option in the authenticator checks that the
24146 second two are &`username`& and &`mysecret`& respectively.
24147
24148 Having just one fixed user name and password, as in this example, is not very
24149 realistic, though for a small organization with only a handful of
24150 authenticating clients it could make sense.
24151
24152 A more sophisticated instance of this authenticator could use the user name in
24153 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24154 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24155 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24156 This is an incorrect example:
24157 .code
24158 server_condition = \
24159   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24160 .endd
24161 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24162 which it then compares to the supplied password (&$auth3$&). Why is this example
24163 incorrect? It works fine for existing users, but consider what happens if a
24164 non-existent user name is given. The lookup fails, but as no success/failure
24165 strings are given for the lookup, it yields an empty string. Thus, to defeat
24166 the authentication, all a client has to do is to supply a non-existent user
24167 name and an empty password. The correct way of writing this test is:
24168 .code
24169 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24170   {${if eq{$value}{$auth3}}} {false}}
24171 .endd
24172 In this case, if the lookup succeeds, the result is checked; if the lookup
24173 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24174 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24175 always fails if its second argument is empty. However, the second way of
24176 writing the test makes the logic clearer.
24177
24178
24179 .section "The LOGIN authentication mechanism" "SECID173"
24180 .cindex "LOGIN authentication mechanism"
24181 .cindex "authentication" "LOGIN mechanism"
24182 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24183 in a number of programs. No data is sent with the AUTH command. Instead, a
24184 user name and password are supplied separately, in response to prompts. The
24185 plaintext authenticator can be configured to support this as in this example:
24186 .code
24187 fixed_login:
24188   driver = plaintext
24189   public_name = LOGIN
24190   server_prompts = User Name : Password
24191   server_condition = \
24192     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24193   server_set_id = $auth1
24194 .endd
24195 Because of the way plaintext operates, this authenticator accepts data supplied
24196 with the AUTH command (in contravention of the specification of LOGIN), but
24197 if the client does not supply it (as is the case for LOGIN clients), the prompt
24198 strings are used to obtain two data items.
24199
24200 Some clients are very particular about the precise text of the prompts. For
24201 example, Outlook Express is reported to recognize only &"Username:"& and
24202 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24203 strings. It uses the &%ldapauth%& expansion condition to check the user
24204 name and password by binding to an LDAP server:
24205 .code
24206 login:
24207   driver = plaintext
24208   public_name = LOGIN
24209   server_prompts = Username:: : Password::
24210   server_condition = ${if and{{ \
24211     !eq{}{$auth1} }{ \
24212     ldapauth{\
24213       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24214       pass=${quote:$auth2} \
24215       ldap://ldap.example.org/} }} }
24216   server_set_id = uid=$auth1,ou=people,o=example.org
24217 .endd
24218 We have to check that the username is not empty before using it, because LDAP
24219 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24220 operator to correctly quote the DN for authentication. However, the basic
24221 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24222 correct one to use for the password, because quoting is needed only to make
24223 the password conform to the Exim syntax. At the LDAP level, the password is an
24224 uninterpreted string.
24225
24226
24227 .section "Support for different kinds of authentication" "SECID174"
24228 A number of string expansion features are provided for the purpose of
24229 interfacing to different ways of user authentication. These include checking
24230 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24231 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24232 &<<SECTexpcond>>&.
24233
24234
24235
24236
24237 .section "Using plaintext in a client" "SECID175"
24238 .cindex "options" "&(plaintext)& authenticator (client)"
24239 The &(plaintext)& authenticator has two client options:
24240
24241 .option client_ignore_invalid_base64 plaintext boolean false
24242 If the client receives a server prompt that is not a valid base64 string,
24243 authentication is abandoned by default. However, if this option is set true,
24244 the error in the challenge is ignored and the client sends the response as
24245 usual.
24246
24247 .option client_send plaintext string&!! unset
24248 The string is a colon-separated list of authentication data strings. Each
24249 string is independently expanded before being sent to the server. The first
24250 string is sent with the AUTH command; any more strings are sent in response
24251 to prompts from the server. Before each string is expanded, the value of the
24252 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24253 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24254 way. Thus, the prompt that is received in response to sending the first string
24255 (with the AUTH command) can be used in the expansion of the second string, and
24256 so on. If an invalid base64 string is received when
24257 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24258 &$auth$&<&'n'&> variable.
24259
24260 &*Note*&: You cannot use expansion to create multiple strings, because
24261 splitting takes priority and happens first.
24262
24263 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24264 the data, further processing is applied to each string before it is sent. If
24265 there are any single circumflex characters in the string, they are converted to
24266 NULs. Should an actual circumflex be required as data, it must be doubled in
24267 the string.
24268
24269 This is an example of a client configuration that implements the PLAIN
24270 authentication mechanism with a fixed user name and password:
24271 .code
24272 fixed_plain:
24273   driver = plaintext
24274   public_name = PLAIN
24275   client_send = ^username^mysecret
24276 .endd
24277 The lack of colons means that the entire text is sent with the AUTH
24278 command, with the circumflex characters converted to NULs. A similar example
24279 that uses the LOGIN mechanism is:
24280 .code
24281 fixed_login:
24282   driver = plaintext
24283   public_name = LOGIN
24284   client_send = : username : mysecret
24285 .endd
24286 The initial colon means that the first string is empty, so no data is sent with
24287 the AUTH command itself. The remaining strings are sent in response to
24288 prompts.
24289 .ecindex IIDplaiauth1
24290 .ecindex IIDplaiauth2
24291
24292
24293
24294
24295 . ////////////////////////////////////////////////////////////////////////////
24296 . ////////////////////////////////////////////////////////////////////////////
24297
24298 .chapter "The cram_md5 authenticator" "CHID9"
24299 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24300 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24301 .cindex "CRAM-MD5 authentication mechanism"
24302 .cindex "authentication" "CRAM-MD5 mechanism"
24303 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24304 sends a challenge string to the client, and the response consists of a user
24305 name and the CRAM-MD5 digest of the challenge string combined with a secret
24306 string (password) which is known to both server and client. Thus, the secret
24307 is not sent over the network as plain text, which makes this authenticator more
24308 secure than &(plaintext)&. However, the downside is that the secret has to be
24309 available in plain text at either end.
24310
24311
24312 .section "Using cram_md5 as a server" "SECID176"
24313 .cindex "options" "&(cram_md5)& authenticator (server)"
24314 This authenticator has one server option, which must be set to configure the
24315 authenticator as a server:
24316
24317 .option server_secret cram_md5 string&!! unset
24318 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24319 When the server receives the client's response, the user name is placed in
24320 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24321 obtain the password for that user. The server then computes the CRAM-MD5 digest
24322 that the client should have sent, and checks that it received the correct
24323 string. If the expansion of &%server_secret%& is forced to fail, authentication
24324 fails. If the expansion fails for some other reason, a temporary error code is
24325 returned to the client.
24326
24327 For compatibility with previous releases of Exim, the user name is also placed
24328 in &$1$&. However, the use of this variables for this purpose is now
24329 deprecated, as it can lead to confusion in string expansions that also use
24330 numeric variables for other things.
24331
24332 For example, the following authenticator checks that the user name given by the
24333 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24334 user name, authentication fails.
24335 .code
24336 fixed_cram:
24337   driver = cram_md5
24338   public_name = CRAM-MD5
24339   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24340   server_set_id = $auth1
24341 .endd
24342 .vindex "&$authenticated_id$&"
24343 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24344 name in &$authenticated_id$&. A more typical configuration might look up the
24345 secret string in a file, using the user name as the key. For example:
24346 .code
24347 lookup_cram:
24348   driver = cram_md5
24349   public_name = CRAM-MD5
24350   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24351                   {$value}fail}
24352   server_set_id = $auth1
24353 .endd
24354 Note that this expansion explicitly forces failure if the lookup fails
24355 because &$auth1$& contains an unknown user name.
24356
24357 .new
24358 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24359 using the relevant libraries, you need to know the realm to specify in the
24360 lookup and then ask for the &"userPassword"& attribute for that user in that
24361 realm, with:
24362 .code
24363 cyrusless_crammd5:
24364   driver = cram_md5
24365   public_name = CRAM-MD5
24366   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24367                   dbmjz{/etc/sasldb2}}
24368   server_set_id = $auth1
24369 .endd
24370 .wen
24371
24372 .section "Using cram_md5 as a client" "SECID177"
24373 .cindex "options" "&(cram_md5)& authenticator (client)"
24374 When used as a client, the &(cram_md5)& authenticator has two options:
24375
24376
24377
24378 .option client_name cram_md5 string&!! "the primary host name"
24379 This string is expanded, and the result used as the user name data when
24380 computing the response to the server's challenge.
24381
24382
24383 .option client_secret cram_md5 string&!! unset
24384 This option must be set for the authenticator to work as a client. Its value is
24385 expanded and the result used as the secret string when computing the response.
24386
24387
24388 .vindex "&$host$&"
24389 .vindex "&$host_address$&"
24390 Different user names and secrets can be used for different servers by referring
24391 to &$host$& or &$host_address$& in the options. Forced failure of either
24392 expansion string is treated as an indication that this authenticator is not
24393 prepared to handle this case. Exim moves on to the next configured client
24394 authenticator. Any other expansion failure causes Exim to give up trying to
24395 send the message to the current server.
24396
24397 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24398 strings, is:
24399 .code
24400 fixed_cram:
24401   driver = cram_md5
24402   public_name = CRAM-MD5
24403   client_name = ph10
24404   client_secret = secret
24405 .endd
24406 .ecindex IIDcramauth1
24407 .ecindex IIDcramauth2
24408
24409
24410
24411 . ////////////////////////////////////////////////////////////////////////////
24412 . ////////////////////////////////////////////////////////////////////////////
24413
24414 .chapter "The cyrus_sasl authenticator" "CHID10"
24415 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24416 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24417 .cindex "Cyrus" "SASL library"
24418 .cindex "Kerberos"
24419 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24420 Digital Ltd (&url(http://www.aldigital.co.uk)).
24421
24422 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24423 library implementation of the RFC 2222 (&"Simple Authentication and Security
24424 Layer"&). This library supports a number of authentication mechanisms,
24425 including PLAIN and LOGIN, but also several others that Exim does not support
24426 directly. In particular, there is support for Kerberos authentication.
24427
24428 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24429 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24430 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24431 name of the driver to determine which mechanism to support.
24432
24433 Where access to some kind of secret file is required, for example in GSSAPI
24434 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24435 user, and that the Cyrus SASL library has no way of escalating privileges
24436 by default. You may also find you need to set environment variables,
24437 depending on the driver you are using.
24438
24439 The application name provided by Exim is &"exim"&, so various SASL options may
24440 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24441 Kerberos, note that because of limitations in the GSSAPI interface,
24442 changing the server keytab might need to be communicated down to the Kerberos
24443 layer independently. The mechanism for doing so is dependent upon the Kerberos
24444 implementation.
24445 .new
24446 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24447 may be set to point to an alternative keytab file. Exim will pass this
24448 variable through from its own inherited environment when started as root or the
24449 Exim user. The keytab file needs to be readable by the Exim user.
24450 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24451 environment variable.  In practice, for those releases, the Cyrus authenticator
24452 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24453 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24454 .wen
24455
24456
24457 .section "Using cyrus_sasl as a server" "SECID178"
24458 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24459 (on a successful authentication) into &$auth1$&. For compatibility with
24460 previous releases of Exim, the username is also placed in &$1$&. However, the
24461 use of this variable for this purpose is now deprecated, as it can lead to
24462 confusion in string expansions that also use numeric variables for other
24463 things.
24464
24465
24466 .option server_hostname cyrus_sasl string&!! "see below"
24467 This option selects the hostname that is used when communicating with the
24468 library. The default value is &`$primary_hostname`&. It is up to the underlying
24469 SASL plug-in what it does with this data.
24470
24471
24472 .option server_mech cyrus_sasl string "see below"
24473 This option selects the authentication mechanism this driver should use. The
24474 default is the value of the generic &%public_name%& option. This option allows
24475 you to use a different underlying mechanism from the advertised name. For
24476 example:
24477 .code
24478 sasl:
24479   driver = cyrus_sasl
24480   public_name = X-ANYTHING
24481   server_mech = CRAM-MD5
24482   server_set_id = $auth1
24483 .endd
24484
24485 .new
24486 .option server_realm cyrus_sasl string&!! unset
24487 This specifies the SASL realm that the server claims to be in.
24488 .wen
24489
24490
24491 .option server_service cyrus_sasl string &`smtp`&
24492 This is the SASL service that the server claims to implement.
24493
24494
24495 For straightforward cases, you do not need to set any of the authenticator's
24496 private options. All you need to do is to specify an appropriate mechanism as
24497 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24498 PLAIN, you could have two authenticators as follows:
24499 .code
24500 sasl_cram_md5:
24501   driver = cyrus_sasl
24502   public_name = CRAM-MD5
24503   server_set_id = $auth1
24504
24505 sasl_plain:
24506   driver = cyrus_sasl
24507   public_name = PLAIN
24508   server_set_id = $auth2
24509 .endd
24510 Cyrus SASL does implement the LOGIN authentication method, even though it is
24511 not a standard method. It is disabled by default in the source distribution,
24512 but it is present in many binary distributions.
24513 .ecindex IIDcyrauth1
24514 .ecindex IIDcyrauth2
24515
24516
24517
24518
24519 . ////////////////////////////////////////////////////////////////////////////
24520 . ////////////////////////////////////////////////////////////////////////////
24521 .chapter "The dovecot authenticator" "CHAPdovecot"
24522 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24523 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24524 This authenticator is an interface to the authentication facility of the
24525 Dovecot POP/IMAP server, which can support a number of authentication methods.
24526 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24527 to use the same mechanisms for SMTP authentication. This is a server
24528 authenticator only. There is only one option:
24529
24530 .option server_socket dovecot string unset
24531
24532 This option must specify the socket that is the interface to Dovecot
24533 authentication. The &%public_name%& option must specify an authentication
24534 mechanism that Dovecot is configured to support. You can have several
24535 authenticators for different mechanisms. For example:
24536 .code
24537 dovecot_plain:
24538   driver = dovecot
24539   public_name = PLAIN
24540   server_socket = /var/run/dovecot/auth-client
24541   server_set_id = $auth2
24542
24543 dovecot_ntlm:
24544   driver = dovecot
24545   public_name = NTLM
24546   server_socket = /var/run/dovecot/auth-client
24547   server_set_id = $auth1
24548 .endd
24549 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24550 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24551 option is passed in the Dovecot authentication command. If, for a TLS
24552 connection, a client certificate has been verified, the &"valid-client-cert"&
24553 option is passed. When authentication succeeds, the identity of the user
24554 who authenticated is placed in &$auth1$&.
24555 .ecindex IIDdcotauth1
24556 .ecindex IIDdcotauth2
24557
24558
24559 . ////////////////////////////////////////////////////////////////////////////
24560 . ////////////////////////////////////////////////////////////////////////////
24561 .new
24562 .chapter "The gsasl authenticator" "CHAPgsasl"
24563 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
24564 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
24565 .cindex "authentication" "GNU SASL"
24566 .cindex "authentication" "SASL"
24567 .cindex "authentication" "EXTERNAL"
24568 .cindex "authentication" "ANONYMOUS"
24569 .cindex "authentication" "PLAIN"
24570 .cindex "authentication" "LOGIN"
24571 .cindex "authentication" "DIGEST-MD5"
24572 .cindex "authentication" "CRAM-MD5"
24573 .cindex "authentication" "SCRAM-SHA-1"
24574 The &(gsasl)& authenticator provides server integration for the GNU SASL
24575 library and the mechanisms it provides.  This is new as of the 4.78 release
24576 and there are a few areas where the library does not let Exim smoothly
24577 scale to handle future authentication mechanisms, so no guarantee can be
24578 made that any particular new authentication mechanism will be supported
24579 without code changes in Exim.
24580
24581
24582 .option server_channelbinding gsasl bool false
24583 Some authentication mechanisms are able to use external context at both ends
24584 of the session to bind the authentication to that context, and fail the
24585 authentication process if that context differs.  Specifically, some TLS
24586 ciphersuites can provide identifying information about the cryptographic
24587 context.
24588
24589 This means that certificate identity and verification becomes a non-issue,
24590 as a man-in-the-middle attack will cause the correct client and server to
24591 see different identifiers and authentication will fail.
24592
24593 This is currently only supported when using the GnuTLS library.  This is
24594 only usable by mechanisms which support "channel binding"; at time of
24595 writing, that's the SCRAM family.
24596
24597 This defaults off to ensure smooth upgrade across Exim releases, in case
24598 this option causes some clients to start failing.  Some future release
24599 of Exim may switch the default to be true.
24600
24601
24602 .option server_hostname gsasl string&!! "see below"
24603 This option selects the hostname that is used when communicating with the
24604 library. The default value is &`$primary_hostname`&.
24605 Some mechanisms will use this data.
24606
24607
24608 .option server_mech gsasl string "see below"
24609 This option selects the authentication mechanism this driver should use. The
24610 default is the value of the generic &%public_name%& option. This option allows
24611 you to use a different underlying mechanism from the advertised name. For
24612 example:
24613 .code
24614 sasl:
24615   driver = gsasl
24616   public_name = X-ANYTHING
24617   server_mech = CRAM-MD5
24618   server_set_id = $auth1
24619 .endd
24620
24621
24622 .option server_password gsasl string&!! unset
24623 Various mechanisms need access to the cleartext password on the server, so
24624 that proof-of-possession can be demonstrated on the wire, without sending
24625 the password itself.
24626
24627 The data available for lookup varies per mechanism.
24628 In all cases, &$auth1$& is set to the &'authentication id'&.
24629 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
24630 if available, else the empty string.
24631 The &$auth3$& variable will always be the &'realm'& if available,
24632 else the empty string.
24633
24634 A forced failure will cause authentication to defer.
24635
24636 If using this option, it may make sense to set the &%server_condition%&
24637 option to be simply "true".
24638
24639
24640 .option server_realm gsasl string&!! unset
24641 This specifies the SASL realm that the server claims to be in.
24642 Some mechanisms will use this data.
24643
24644
24645 .option server_scram_iter gsasl string&!! unset
24646 This option provides data for the SCRAM family of mechanisms.
24647 &$auth1$& is not available at evaluation time.
24648 (This may change, as we receive feedback on use)
24649
24650
24651 .option server_scram_salt gsasl string&!! unset
24652 This option provides data for the SCRAM family of mechanisms.
24653 &$auth1$& is not available at evaluation time.
24654 (This may change, as we receive feedback on use)
24655
24656
24657 .option server_service gsasl string &`smtp`&
24658 This is the SASL service that the server claims to implement.
24659 Some mechanisms will use this data.
24660
24661
24662 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
24663 .vindex "&$auth1$&, &$auth2$&, etc"
24664 These may be set when evaluating specific options, as detailed above.
24665 They will also be set when evaluating &%server_condition%&.
24666
24667 Unless otherwise stated below, the &(gsasl)& integration will use the following
24668 meanings for these variables:
24669
24670 .ilist
24671 .vindex "&$auth1$&"
24672 &$auth1$&: the &'authentication id'&
24673 .next
24674 .vindex "&$auth2$&"
24675 &$auth2$&: the &'authorization id'&
24676 .next
24677 .vindex "&$auth3$&"
24678 &$auth3$&: the &'realm'&
24679 .endlist
24680
24681 On a per-mechanism basis:
24682
24683 .ilist
24684 .cindex "authentication" "EXTERNAL"
24685 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
24686 the &%server_condition%& option must be present.
24687 .next
24688 .cindex "authentication" "ANONYMOUS"
24689 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
24690 the &%server_condition%& option must be present.
24691 .next
24692 .cindex "authentication" "GSSAPI"
24693 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
24694 &$auth2$& will be set to the &'authorization id'&,
24695 the &%server_condition%& option must be present.
24696 .endlist
24697
24698 An &'anonymous token'& is something passed along as an unauthenticated
24699 identifier; this is analogous to FTP anonymous authentication passing an
24700 email address, or software-identifier@, as the "password".
24701
24702
24703 An example showing the password having the realm specified in the callback
24704 and demonstrating a Cyrus SASL to GSASL migration approach is:
24705 .code
24706 gsasl_cyrusless_crammd5:
24707   driver = gsasl
24708   public_name = CRAM-MD5
24709   server_realm = imap.example.org
24710   server_password = ${lookup{$auth1:$auth3:userPassword}\
24711                     dbmjz{/etc/sasldb2}{$value}fail}
24712   server_set_id = ${quote:$auth1}
24713   server_condition = yes
24714 .endd
24715
24716 .wen
24717
24718 . ////////////////////////////////////////////////////////////////////////////
24719 . ////////////////////////////////////////////////////////////////////////////
24720
24721 .new
24722 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
24723 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
24724 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
24725 .cindex "authentication" "GSSAPI"
24726 .cindex "authentication" "Kerberos"
24727 The &(heimdal_gssapi)& authenticator provides server integration for the
24728 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
24729 reliably.
24730
24731 .option server_hostname heimdal_gssapi string&!! "see below"
24732 This option selects the hostname that is used, with &%server_service%&,
24733 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
24734 identifier.  The default value is &`$primary_hostname`&.
24735
24736 .option server_keytab heimdal_gssapi string&!! unset
24737 If set, then Heimdal will not use the system default keytab (typically
24738 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
24739 The value should be a pathname, with no &"file:"& prefix.
24740
24741 .option server_service heimdal_gssapi string&!! "smtp"
24742 This option specifies the service identifier used, in conjunction with
24743 &%server_hostname%&, for building the identifer for finding credentials
24744 from the keytab.
24745
24746
24747 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
24748 Beware that these variables will typically include a realm, thus will appear
24749 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
24750 not verified, so a malicious client can set it to anything.
24751
24752 The &$auth1$& field should be safely trustable as a value from the Key
24753 Distribution Center.  Note that these are not quite email addresses.
24754 Each identifier is for a role, and so the left-hand-side may include a
24755 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
24756
24757 .vindex "&$auth1$&, &$auth2$&, etc"
24758 .ilist
24759 .vindex "&$auth1$&"
24760 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
24761 .next
24762 .vindex "&$auth2$&"
24763 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
24764 authentication.  If that was empty, this will also be set to the
24765 GSS Display Name.
24766 .endlist
24767
24768 .wen
24769
24770 . ////////////////////////////////////////////////////////////////////////////
24771 . ////////////////////////////////////////////////////////////////////////////
24772
24773 .chapter "The spa authenticator" "CHAPspa"
24774 .scindex IIDspaauth1 "&(spa)& authenticator"
24775 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24776 .cindex "authentication" "Microsoft Secure Password"
24777 .cindex "authentication" "NTLM"
24778 .cindex "Microsoft Secure Password Authentication"
24779 .cindex "NTLM authentication"
24780 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24781 Password Authentication'& mechanism,
24782 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24783 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24784 taken from the Samba project (&url(http://www.samba.org)). The code for the
24785 server side was subsequently contributed by Tom Kistner. The mechanism works as
24786 follows:
24787
24788 .ilist
24789 After the AUTH command has been accepted, the client sends an SPA
24790 authentication request based on the user name and optional domain.
24791 .next
24792 The server sends back a challenge.
24793 .next
24794 The client builds a challenge response which makes use of the user's password
24795 and sends it to the server, which then accepts or rejects it.
24796 .endlist
24797
24798 Encryption is used to protect the password in transit.
24799
24800
24801
24802 .section "Using spa as a server" "SECID179"
24803 .cindex "options" "&(spa)& authenticator (server)"
24804 The &(spa)& authenticator has just one server option:
24805
24806 .option server_password spa string&!! unset
24807 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24808 This option is expanded, and the result must be the cleartext password for the
24809 authenticating user, whose name is at this point in &$auth1$&. For
24810 compatibility with previous releases of Exim, the user name is also placed in
24811 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24812 it can lead to confusion in string expansions that also use numeric variables
24813 for other things. For example:
24814 .code
24815 spa:
24816   driver = spa
24817   public_name = NTLM
24818   server_password = \
24819     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24820 .endd
24821 If the expansion is forced to fail, authentication fails. Any other expansion
24822 failure causes a temporary error code to be returned.
24823
24824
24825
24826
24827
24828 .section "Using spa as a client" "SECID180"
24829 .cindex "options" "&(spa)& authenticator (client)"
24830 The &(spa)& authenticator has the following client options:
24831
24832
24833
24834 .option client_domain spa string&!! unset
24835 This option specifies an optional domain for the authentication.
24836
24837
24838 .option client_password spa string&!! unset
24839 This option specifies the user's password, and must be set.
24840
24841
24842 .option client_username spa string&!! unset
24843 This option specifies the user name, and must be set. Here is an example of a
24844 configuration of this authenticator for use with the mail servers at
24845 &'msn.com'&:
24846 .code
24847 msn:
24848   driver = spa
24849   public_name = MSN
24850   client_username = msn/msn_username
24851   client_password = msn_plaintext_password
24852   client_domain = DOMAIN_OR_UNSET
24853 .endd
24854 .ecindex IIDspaauth1
24855 .ecindex IIDspaauth2
24856
24857
24858
24859
24860
24861 . ////////////////////////////////////////////////////////////////////////////
24862 . ////////////////////////////////////////////////////////////////////////////
24863
24864 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24865          "Encrypted SMTP connections"
24866 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24867 .scindex IIDencsmtp2 "SMTP" "encryption"
24868 .cindex "TLS" "on SMTP connection"
24869 .cindex "OpenSSL"
24870 .cindex "GnuTLS"
24871 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24872 Sockets Layer), is implemented by making use of the OpenSSL library or the
24873 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24874 cryptographic code in the Exim distribution itself for implementing TLS. In
24875 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24876 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24877 You also need to understand the basic concepts of encryption at a managerial
24878 level, and in particular, the way that public keys, private keys, and
24879 certificates are used.
24880
24881 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24882 connection is established, the client issues a STARTTLS command. If the
24883 server accepts this, the client and the server negotiate an encryption
24884 mechanism. If the negotiation succeeds, the data that subsequently passes
24885 between them is encrypted.
24886
24887 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24888 and if so, what cipher suite is in use, whether the client supplied a
24889 certificate, and whether or not that certificate was verified. This makes it
24890 possible for an Exim server to deny or accept certain commands based on the
24891 encryption state.
24892
24893 &*Warning*&: Certain types of firewall and certain anti-virus products can
24894 disrupt TLS connections. You need to turn off SMTP scanning for these products
24895 in order to get TLS to work.
24896
24897
24898
24899 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24900          "SECID284"
24901 .cindex "ssmtp protocol"
24902 .cindex "smtps protocol"
24903 .cindex "SMTP" "ssmtp protocol"
24904 .cindex "SMTP" "smtps protocol"
24905 Early implementations of encrypted SMTP used a different TCP port from normal
24906 SMTP, and expected an encryption negotiation to start immediately, instead of
24907 waiting for a STARTTLS command from the client using the standard SMTP
24908 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24909 allocated for this purpose.
24910
24911 This approach was abandoned when encrypted SMTP was standardized, but there are
24912 still some legacy clients that use it. Exim supports these clients by means of
24913 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24914 numbers; the most common use is expected to be:
24915 .code
24916 tls_on_connect_ports = 465
24917 .endd
24918 The port numbers specified by this option apply to all SMTP connections, both
24919 via the daemon and via &'inetd'&. You still need to specify all the ports that
24920 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24921 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24922 an extra port &-- rather, it specifies different behaviour on a port that is
24923 defined elsewhere.
24924
24925 There is also a &%-tls-on-connect%& command line option. This overrides
24926 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24927
24928
24929
24930
24931
24932
24933 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24934 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24935 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24936 followed later, when the first versions of GnuTLS were released. To build Exim
24937 to use GnuTLS, you need to set
24938 .code
24939 USE_GNUTLS=yes
24940 .endd
24941 in Local/Makefile, in addition to
24942 .code
24943 SUPPORT_TLS=yes
24944 .endd
24945 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24946 include files and libraries for GnuTLS can be found.
24947
24948 There are some differences in usage when using GnuTLS instead of OpenSSL:
24949
24950 .ilist
24951 The &%tls_verify_certificates%& option must contain the name of a file, not the
24952 name of a directory (for OpenSSL it can be either).
24953 .next
24954 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24955 facility for varying its Diffie-Hellman parameters. I understand that this has
24956 changed, but Exim has not been updated to provide this facility.
24957 .next
24958 .vindex "&$tls_peerdn$&"
24959 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24960 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24961 affects the value of the &$tls_peerdn$& variable.
24962 .next
24963 OpenSSL identifies cipher suites using hyphens as separators, for example:
24964 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24965 more, OpenSSL complains if underscores are present in a cipher list. To make
24966 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24967 underscores for GnuTLS when processing lists of cipher suites in the
24968 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24969 option).
24970 .next
24971 The &%tls_require_ciphers%& options operate differently, as described in the
24972 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24973 .new
24974 .next
24975 Some other recently added features may only be available in one or the other.
24976 This should be documented with the feature.  If the documentation does not
24977 explicitly state that the feature is infeasible in the other TLS
24978 implementation, then patches are welcome.
24979 .wen
24980 .endlist
24981
24982
24983 .section "GnuTLS parameter computation" "SECID181"
24984 GnuTLS uses D-H parameters that may take a substantial amount of time
24985 to compute. It is unreasonable to re-compute them for every TLS session.
24986 Therefore, Exim keeps this data in a file in its spool directory, called
24987 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24988 its owner. Every Exim process that start up GnuTLS reads the D-H
24989 parameters from this file. If the file does not exist, the first Exim process
24990 that needs it computes the data and writes it to a temporary file which is
24991 renamed once it is complete. It does not matter if several Exim processes do
24992 this simultaneously (apart from wasting a few resources). Once a file is in
24993 place, new Exim processes immediately start using it.
24994
24995 For maximum security, the parameters that are stored in this file should be
24996 recalculated periodically, the frequency depending on your paranoia level.
24997 Arranging this is easy in principle; just delete the file when you want new
24998 values to be computed. However, there may be a problem. The calculation of new
24999 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25000 If the system is not very active, &_/dev/random_& may delay returning data
25001 until enough randomness (entropy) is available. This may cause Exim to hang for
25002 a substantial amount of time, causing timeouts on incoming connections.
25003
25004 The solution is to generate the parameters externally to Exim. They are stored
25005 in &_gnutls-params_& in PEM format, which means that they can be generated
25006 externally using the &(certtool)& command that is part of GnuTLS.
25007
25008 To replace the parameters with new ones, instead of deleting the file
25009 and letting Exim re-create it, you can generate new parameters using
25010 &(certtool)& and, when this has been done, replace Exim's cache file by
25011 renaming. The relevant commands are something like this:
25012 .code
25013 # rm -f new-params
25014 # touch new-params
25015 # chown exim:exim new-params
25016 # chmod 0400 new-params
25017 # certtool --generate-privkey --bits 512 >new-params
25018 # echo "" >>new-params
25019 # certtool --generate-dh-params --bits 1024 >> new-params
25020 # mv new-params gnutls-params
25021 .endd
25022 If Exim never has to generate the parameters itself, the possibility of
25023 stalling is removed.
25024
25025
25026 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25027 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25028 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25029 There is a function in the OpenSSL library that can be passed a list of cipher
25030 suites before the cipher negotiation takes place. This specifies which ciphers
25031 are acceptable. The list is colon separated and may contain names like
25032 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25033 directly to this function call. The following quotation from the OpenSSL
25034 documentation specifies what forms of item are allowed in the cipher string:
25035
25036 .ilist
25037 It can consist of a single cipher suite such as RC4-SHA.
25038 .next
25039 It can represent a list of cipher suites containing a certain algorithm,
25040 or cipher suites of a certain type. For example SHA1 represents all
25041 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25042 SSL v3 algorithms.
25043 .next
25044 Lists of cipher suites can be combined in a single cipher string using
25045 the + character. This is used as a logical and operation. For example
25046 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25047 algorithms.
25048 .endlist
25049
25050 Each cipher string can be optionally preceded by one of the characters &`!`&,
25051 &`-`& or &`+`&.
25052 .ilist
25053 If &`!`& is used, the ciphers are permanently deleted from the list. The
25054 ciphers deleted can never reappear in the list even if they are explicitly
25055 stated.
25056 .next
25057 If &`-`& is used, the ciphers are deleted from the list, but some or all
25058 of the ciphers can be added again by later options.
25059 .next
25060 If &`+`& is used, the ciphers are moved to the end of the list. This
25061 option does not add any new ciphers; it just moves matching existing ones.
25062 .endlist
25063
25064 If none of these characters is present, the string is interpreted as
25065 a list of ciphers to be appended to the current preference list. If the list
25066 includes any ciphers already present they will be ignored: that is, they will
25067 not be moved to the end of the list.
25068 .endlist
25069
25070
25071
25072 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25073          "SECTreqciphgnu"
25074 .cindex "GnuTLS" "specifying parameters for"
25075 .cindex "TLS" "specifying ciphers (GnuTLS)"
25076 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25077 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25078 .cindex "TLS" "specifying protocols (GnuTLS)"
25079 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25080 The GnuTLS library allows the caller to specify separate lists of permitted key
25081 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
25082 Unfortunately, these lists are numerical, and the library does not have a
25083 function for turning names into numbers. Consequently, lists of recognized
25084 names have to be built into the application. The permitted key exchange
25085 methods, ciphers, and MAC algorithms may be used in any combination to form a
25086 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
25087 passed to its control function.
25088
25089 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
25090 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
25091 option controls only the cipher algorithms. Exim searches each item in the
25092 list for the name of an available algorithm. For example, if the list
25093 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
25094 the same as if just AES were given.
25095
25096 .oindex "&%gnutls_require_kx%&"
25097 .oindex "&%gnutls_require_mac%&"
25098 .oindex "&%gnutls_require_protocols%&"
25099 There are additional options called &%gnutls_require_kx%&,
25100 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
25101 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
25102 These options are ignored if OpenSSL is in use.
25103
25104 All four options are available as global options, controlling how Exim
25105 behaves as a server, and also as options of the &(smtp)& transport, controlling
25106 how Exim behaves as a client. All the values are string expanded. After
25107 expansion, the values must be colon-separated lists, though the separator
25108 can be changed in the usual way.
25109
25110 Each of the four lists starts out with a default set of algorithms. If the
25111 first item in a list does &'not'& start with an exclamation mark, all the
25112 default items are deleted. In this case, only those that are explicitly
25113 specified can be used. If the first item in a list &'does'& start with an
25114 exclamation mark, the defaults are left on the list.
25115
25116 Then, any item that starts with an exclamation mark causes the relevant
25117 entry to be removed from the list, and any item that does not start with an
25118 exclamation mark causes a new entry to be added to the list. Unrecognized
25119 items in the list are ignored. Thus:
25120 .code
25121 tls_require_ciphers = !ARCFOUR
25122 .endd
25123 allows all the defaults except ARCFOUR, whereas
25124 .code
25125 tls_require_ciphers = AES : 3DES
25126 .endd
25127 allows only cipher suites that use AES or 3DES.
25128
25129 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
25130 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
25131 the preceding). The default list does not contain all of these; it just has
25132 AES_256, AES_128, 3DES, and ARCFOUR_128.
25133
25134 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
25135 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
25136 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
25137
25138 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
25139 MD5. The default list contains SHA, MD5.
25140
25141 .new
25142 For &%gnutls_require_protocols%&, the recognized names are TLS1.2, TLS1.1,
25143 TLS1.0, (TLS1) and SSL3.
25144 The default list contains TLS1.2, TLS1.1, TLS1.0, SSL3.
25145 TLS1 is an alias for TLS1.0, for backwards compatibility.
25146 For sufficiently old versions of the GnuTLS library, TLS1.2 or TLS1.1 might
25147 not be supported and will not be recognised by Exim.
25148 .wen
25149
25150 In a server, the order of items in these lists is unimportant. The server
25151 advertises the availability of all the relevant cipher suites. However, in a
25152 client, the order in the &%tls_require_ciphers%& list specifies a preference
25153 order for the cipher algorithms. The first one in the client's list that is
25154 also advertised by the server is tried first. The default order is as listed
25155 above.
25156
25157
25158
25159 .section "Configuring an Exim server to use TLS" "SECID182"
25160 .cindex "TLS" "configuring an Exim server"
25161 When Exim has been built with TLS support, it advertises the availability of
25162 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25163 but not to any others. The default value of this option is unset, which means
25164 that STARTTLS is not advertised at all. This default is chosen because you
25165 need to set some other options in order to make TLS available, and also it is
25166 sensible for systems that want to use TLS only as a client.
25167
25168 If a client issues a STARTTLS command and there is some configuration
25169 problem in the server, the command is rejected with a 454 error. If the client
25170 persists in trying to issue SMTP commands, all except QUIT are rejected
25171 with the error
25172 .code
25173 554 Security failure
25174 .endd
25175 If a STARTTLS command is issued within an existing TLS session, it is
25176 rejected with a 554 error code.
25177
25178 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25179 match some hosts. You can, of course, set it to * to match all hosts.
25180 However, this is not all you need to do. TLS sessions to a server won't work
25181 without some further configuration at the server end.
25182
25183 It is rumoured that all existing clients that support TLS/SSL use RSA
25184 encryption. To make this work you need to set, in the server,
25185 .code
25186 tls_certificate = /some/file/name
25187 tls_privatekey = /some/file/name
25188 .endd
25189 These options are, in fact, expanded strings, so you can make them depend on
25190 the identity of the client that is connected if you wish. The first file
25191 contains the server's X509 certificate, and the second contains the private key
25192 that goes with it. These files need to be readable by the Exim user, and must
25193 always be given as full path names. They can be the same file if both the
25194 certificate and the key are contained within it. If &%tls_privatekey%& is not
25195 set, or if its expansion is forced to fail or results in an empty string, this
25196 is assumed to be the case. The certificate file may also contain intermediate
25197 certificates that need to be sent to the client to enable it to authenticate
25198 the server's certificate.
25199
25200 If you do not understand about certificates and keys, please try to find a
25201 source of this background information, which is not Exim-specific. (There are a
25202 few comments below in section &<<SECTcerandall>>&.)
25203
25204 &*Note*&: These options do not apply when Exim is operating as a client &--
25205 they apply only in the case of a server. If you need to use a certificate in an
25206 Exim client, you must set the options of the same names in an &(smtp)&
25207 transport.
25208
25209 With just these options, an Exim server will be able to use TLS. It does not
25210 require the client to have a certificate (but see below for how to insist on
25211 this). There is one other option that may be needed in other situations. If
25212 .code
25213 tls_dhparam = /some/file/name
25214 .endd
25215 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25216 with the parameters contained in the file. This increases the set of cipher
25217 suites that the server supports. See the command
25218 .code
25219 openssl dhparam
25220 .endd
25221 for a way of generating this data. At present, &%tls_dhparam%& is used only
25222 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
25223
25224 The strings supplied for these three options are expanded every time a client
25225 host connects. It is therefore possible to use different certificates and keys
25226 for different hosts, if you so wish, by making use of the client's IP address
25227 in &$sender_host_address$& to control the expansion. If a string expansion is
25228 forced to fail, Exim behaves as if the option is not set.
25229
25230 .cindex "cipher" "logging"
25231 .cindex "log" "TLS cipher"
25232 .vindex "&$tls_cipher$&"
25233 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
25234 an incoming TLS connection. It is included in the &'Received:'& header of an
25235 incoming message (by default &-- you can, of course, change this), and it is
25236 also included in the log line that records a message's arrival, keyed by
25237 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25238 condition can be used to test for specific cipher suites in ACLs.
25239 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
25240 &<<SECID185>>&.)
25241
25242 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25243 can check the name of the cipher suite and vary their actions accordingly. The
25244 cipher suite names vary, depending on which TLS library is being used. For
25245 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25246 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25247 documentation for more details.
25248
25249
25250 .section "Requesting and verifying client certificates" "SECID183"
25251 .cindex "certificate" "verification of client"
25252 .cindex "TLS" "client certificate verification"
25253 If you want an Exim server to request a certificate when negotiating a TLS
25254 session with a client, you must set either &%tls_verify_hosts%& or
25255 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25256 apply to all TLS connections. For any host that matches one of these options,
25257 Exim requests a certificate as part of the setup of the TLS session. The
25258 contents of the certificate are verified by comparing it with a list of
25259 expected certificates. These must be available in a file or,
25260 for OpenSSL only (not GnuTLS), a directory, identified by
25261 &%tls_verify_certificates%&.
25262
25263 A file can contain multiple certificates, concatenated end to end. If a
25264 directory is used
25265 (OpenSSL only),
25266 each certificate must be in a separate file, with a name (or a symbolic link)
25267 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25268 certificate. You can compute the relevant hash by running the command
25269 .code
25270 openssl x509 -hash -noout -in /cert/file
25271 .endd
25272 where &_/cert/file_& contains a single certificate.
25273
25274 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25275 what happens if the client does not supply a certificate, or if the certificate
25276 does not match any of the certificates in the collection named by
25277 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25278 attempt to set up a TLS session is aborted, and the incoming connection is
25279 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25280 session continues. ACLs that run for subsequent SMTP commands can detect the
25281 fact that no certificate was verified, and vary their actions accordingly. For
25282 example, you can insist on a certificate before accepting a message for
25283 relaying, but not when the message is destined for local delivery.
25284
25285 .vindex "&$tls_peerdn$&"
25286 When a client supplies a certificate (whether it verifies or not), the value of
25287 the Distinguished Name of the certificate is made available in the variable
25288 &$tls_peerdn$& during subsequent processing of the message.
25289
25290 .cindex "log" "distinguished name"
25291 Because it is often a long text string, it is not included in the log line or
25292 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25293 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25294 &%received_header_text%& to change the &'Received:'& header. When no
25295 certificate is supplied, &$tls_peerdn$& is empty.
25296
25297
25298 .section "Revoked certificates" "SECID184"
25299 .cindex "TLS" "revoked certificates"
25300 .cindex "revocation list"
25301 .cindex "certificate" "revocation list"
25302 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25303 certificates are revoked. If you have such a list, you can pass it to an Exim
25304 server using the global option called &%tls_crl%& and to an Exim client using
25305 an identically named option for the &(smtp)& transport. In each case, the value
25306 of the option is expanded and must then be the name of a file that contains a
25307 CRL in PEM format.
25308
25309
25310 .section "Configuring an Exim client to use TLS" "SECID185"
25311 .cindex "cipher" "logging"
25312 .cindex "log" "TLS cipher"
25313 .cindex "log" "distinguished name"
25314 .cindex "TLS" "configuring an Exim client"
25315 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25316 deliveries as well as to incoming, the latter one causing logging of the
25317 server certificate's DN. The remaining client configuration for TLS is all
25318 within the &(smtp)& transport.
25319
25320 It is not necessary to set any options to have TLS work in the &(smtp)&
25321 transport. If Exim is built with TLS support, and TLS is advertised by a
25322 server, the &(smtp)& transport always tries to start a TLS session. However,
25323 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25324 transport) to a list of server hosts for which TLS should not be used.
25325
25326 If you do not want Exim to attempt to send messages unencrypted when an attempt
25327 to set up an encrypted connection fails in any way, you can set
25328 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25329 those hosts, delivery is always deferred if an encrypted connection cannot be
25330 set up. If there are any other hosts for the address, they are tried in the
25331 usual way.
25332
25333 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25334 the message unencrypted. It always does this if the response to STARTTLS is
25335 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25336 session after a success response code, what happens is controlled by the
25337 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25338 delivery to this host is deferred, and other hosts (if available) are tried. If
25339 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25340 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25341 negotiation fails, Exim closes the current connection (because it is in an
25342 unknown state), opens a new one to the same host, and then tries the delivery
25343 unencrypted.
25344
25345 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25346 transport provide the client with a certificate, which is passed to the server
25347 if it requests it. If the server is Exim, it will request a certificate only if
25348 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25349
25350 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25351 must name a file or,
25352 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25353 expected server certificates. The client verifies the server's certificate
25354 against this collection, taking into account any revoked certificates that are
25355 in the list defined by &%tls_crl%&.
25356
25357 If
25358 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25359 list of permitted cipher suites. If either of these checks fails, delivery to
25360 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25361 alternative hosts, if any.
25362
25363  &*Note*&:
25364 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25365 is operating as a client. Exim does not assume that a server certificate (set
25366 by the global options of the same name) should also be used when operating as a
25367 client.
25368
25369 .vindex "&$host$&"
25370 .vindex "&$host_address$&"
25371 All the TLS options in the &(smtp)& transport are expanded before use, with
25372 &$host$& and &$host_address$& containing the name and address of the server to
25373 which the client is connected. Forced failure of an expansion causes Exim to
25374 behave as if the relevant option were unset.
25375
25376 .vindex &$tls_bits$&
25377 .vindex &$tls_cipher$&
25378 .vindex &$tls_peerdn$&
25379 .vindex &$tls_sni$&
25380 Before an SMTP connection is established, the
25381 &$tls_bits$&, &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25382 variables are emptied. (Until the first connection, they contain the values
25383 that were set when the message was received.) If STARTTLS is subsequently
25384 successfully obeyed, these variables are set to the relevant values for the
25385 outgoing connection.
25386
25387
25388
25389 .new
25390 .section "Use of TLS Server Name Indication" "SECTtlssni"
25391 .cindex "TLS" "Server Name Indication"
25392 .vindex "&$tls_sni$&"
25393 .oindex "&%tls_sni%&"
25394 With TLS1.0 or above, there is an extension mechanism by which extra
25395 information can be included at various points in the protocol.  One of these
25396 extensions, documented in RFC 6066 (and before that RFC 4366) is
25397 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25398 client in the initial handshake, so that the server can examine the servername
25399 within and possibly choose to use different certificates and keys (and more)
25400 for this session.
25401
25402 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25403 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25404 address.
25405
25406 With SMTP to MX, there are the same problems here as in choosing the identity
25407 against which to validate a certificate: you can't rely on insecure DNS to
25408 provide the identity which you then cryptographically verify.  So this will
25409 be of limited use in that environment.
25410
25411 With SMTP to Submission, there is a well-defined hostname which clients are
25412 connecting to and can validate certificates against.  Thus clients &*can*&
25413 choose to include this information in the TLS negotiation.  If this becomes
25414 wide-spread, then hosters can choose to present different certificates to
25415 different clients.  Or even negotiate different cipher suites.
25416
25417 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25418 if not empty, will be sent on a TLS session as part of the handshake.  There's
25419 nothing more to it.  Choosing a sensible value not derived insecurely is the
25420 only point of caution.  The &$tls_sni$& variable will be set to this string
25421 for the lifetime of the client connection (including during authentication).
25422
25423 Except during SMTP client sessions, if &$tls_sni$& is set then it is a string
25424 received from a client.
25425 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25426
25427 If the string &`tls_sni`& appears in the main section's &%tls_certificate%&
25428 option (prior to expansion) then the following options will be re-expanded
25429 during TLS session handshake, to permit alternative values to be chosen:
25430
25431 .ilist
25432 .vindex "&%tls_certificate%&"
25433 &%tls_certificate%&
25434 .next
25435 .vindex "&%tls_crl%&"
25436 &%tls_crl%&
25437 .next
25438 .vindex "&%tls_privatekey%&"
25439 &%tls_privatekey%&
25440 .next
25441 .vindex "&%tls_verify_certificates%&"
25442 &%tls_verify_certificates%&
25443 .endlist
25444
25445 Great care should be taken to deal with matters of case, various injection
25446 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25447 can always be referenced; it is important to remember that &$tls_sni$& is
25448 arbitrary unverified data provided prior to authentication.
25449
25450 The Exim developers are proceeding cautiously and so far no other TLS options
25451 are re-expanded.
25452
25453 Currently SNI support is only available if using OpenSSL, with TLS Extensions
25454 support enabled therein.
25455 .wen
25456
25457
25458
25459 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25460          "SECTmulmessam"
25461 .cindex "multiple SMTP deliveries with TLS"
25462 .cindex "TLS" "multiple message deliveries"
25463 Exim sends multiple messages down the same TCP/IP connection by starting up
25464 an entirely new delivery process for each message, passing the socket from
25465 one process to the next. This implementation does not fit well with the use
25466 of TLS, because there is quite a lot of state information associated with a TLS
25467 connection, not just a socket identification. Passing all the state information
25468 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25469 session before passing the socket to a new process. The new process may then
25470 try to start a new TLS session, and if successful, may try to re-authenticate
25471 if AUTH is in use, before sending the next message.
25472
25473 The RFC is not clear as to whether or not an SMTP session continues in clear
25474 after TLS has been shut down, or whether TLS may be restarted again later, as
25475 just described. However, if the server is Exim, this shutdown and
25476 reinitialization works. It is not known which (if any) other servers operate
25477 successfully if the client closes a TLS session and continues with unencrypted
25478 SMTP, but there are certainly some that do not work. For such servers, Exim
25479 should not pass the socket to another process, because the failure of the
25480 subsequent attempt to use it would cause Exim to record a temporary host error,
25481 and delay other deliveries to that host.
25482
25483 To test for this case, Exim sends an EHLO command to the server after
25484 closing down the TLS session. If this fails in any way, the connection is
25485 closed instead of being passed to a new delivery process, but no retry
25486 information is recorded.
25487
25488 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25489 &(smtp)& transport to match those hosts for which Exim should not pass
25490 connections to new processes if TLS has been used.
25491
25492
25493
25494
25495 .section "Certificates and all that" "SECTcerandall"
25496 .cindex "certificate" "references to discussion"
25497 In order to understand fully how TLS works, you need to know about
25498 certificates, certificate signing, and certificate authorities. This is not the
25499 place to give a tutorial, especially as I do not know very much about it
25500 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25501 to Apache, currently at
25502 .display
25503 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25504 .endd
25505 Other parts of the &'modssl'& documentation are also helpful, and have
25506 links to further files.
25507 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25508 0-201-61598-3), contains both introductory and more in-depth descriptions.
25509 Some sample programs taken from the book are available from
25510 .display
25511 &url(http://www.rtfm.com/openssl-examples/)
25512 .endd
25513
25514
25515 .section "Certificate chains" "SECID186"
25516 The file named by &%tls_certificate%& may contain more than one
25517 certificate. This is useful in the case where the certificate that is being
25518 sent is validated by an intermediate certificate which the other end does
25519 not have. Multiple certificates must be in the correct order in the file.
25520 First the host's certificate itself, then the first intermediate
25521 certificate to validate the issuer of the host certificate, then the next
25522 intermediate certificate to validate the issuer of the first intermediate
25523 certificate, and so on, until finally (optionally) the root certificate.
25524 The root certificate must already be trusted by the recipient for
25525 validation to succeed, of course, but if it's not preinstalled, sending the
25526 root certificate along with the rest makes it available for the user to
25527 install if the receiving end is a client MUA that can interact with a user.
25528
25529
25530 .section "Self-signed certificates" "SECID187"
25531 .cindex "certificate" "self-signed"
25532 You can create a self-signed certificate using the &'req'& command provided
25533 with OpenSSL, like this:
25534 .code
25535 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
25536             -days 9999 -nodes
25537 .endd
25538 &_file1_& and &_file2_& can be the same file; the key and the certificate are
25539 delimited and so can be identified independently. The &%-days%& option
25540 specifies a period for which the certificate is valid. The &%-nodes%& option is
25541 important: if you do not set it, the key is encrypted with a passphrase
25542 that you are prompted for, and any use that is made of the key causes more
25543 prompting for the passphrase. This is not helpful if you are going to use
25544 this certificate and key in an MTA, where prompting is not possible.
25545
25546 A self-signed certificate made in this way is sufficient for testing, and
25547 may be adequate for all your requirements if you are mainly interested in
25548 encrypting transfers, and not in secure identification.
25549
25550 However, many clients require that the certificate presented by the server be a
25551 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
25552 certificate. In this situation, the self-signed certificate described above
25553 must be installed on the client host as a trusted root &'certification
25554 authority'& (CA), and the certificate used by Exim must be a user certificate
25555 signed with that self-signed certificate.
25556
25557 For information on creating self-signed CA certificates and using them to sign
25558 user certificates, see the &'General implementation overview'& chapter of the
25559 Open-source PKI book, available online at
25560 &url(http://ospkibook.sourceforge.net/).
25561 .ecindex IIDencsmtp1
25562 .ecindex IIDencsmtp2
25563
25564
25565
25566 . ////////////////////////////////////////////////////////////////////////////
25567 . ////////////////////////////////////////////////////////////////////////////
25568
25569 .chapter "Access control lists" "CHAPACL"
25570 .scindex IIDacl "&ACL;" "description"
25571 .cindex "control of incoming mail"
25572 .cindex "message" "controlling incoming"
25573 .cindex "policy control" "access control lists"
25574 Access Control Lists (ACLs) are defined in a separate section of the run time
25575 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
25576 name, terminated by a colon. Here is a complete ACL section that contains just
25577 one very small ACL:
25578 .code
25579 begin acl
25580 small_acl:
25581   accept   hosts = one.host.only
25582 .endd
25583 You can have as many lists as you like in the ACL section, and the order in
25584 which they appear does not matter. The lists are self-terminating.
25585
25586 The majority of ACLs are used to control Exim's behaviour when it receives
25587 certain SMTP commands. This applies both to incoming TCP/IP connections, and
25588 when a local process submits a message using SMTP by specifying the &%-bs%&
25589 option. The most common use is for controlling which recipients are accepted
25590 in incoming messages. In addition, you can define an ACL that is used to check
25591 local non-SMTP messages. The default configuration file contains an example of
25592 a realistic ACL for checking RCPT commands. This is discussed in chapter
25593 &<<CHAPdefconfil>>&.
25594
25595
25596 .section "Testing ACLs" "SECID188"
25597 The &%-bh%& command line option provides a way of testing your ACL
25598 configuration locally by running a fake SMTP session with which you interact.
25599 The host &'relay-test.mail-abuse.org'& provides a service for checking your
25600 relaying configuration (see section &<<SECTcheralcon>>& for more details).
25601
25602
25603
25604 .section "Specifying when ACLs are used" "SECID189"
25605 .cindex "&ACL;" "options for specifying"
25606 In order to cause an ACL to be used, you have to name it in one of the relevant
25607 options in the main part of the configuration. These options are:
25608 .cindex "AUTH" "ACL for"
25609 .cindex "DATA" "ACLs for"
25610 .cindex "ETRN" "ACL for"
25611 .cindex "EXPN" "ACL for"
25612 .cindex "HELO" "ACL for"
25613 .cindex "EHLO" "ACL for"
25614 .cindex "MAIL" "ACL for"
25615 .cindex "QUIT, ACL for"
25616 .cindex "RCPT" "ACL for"
25617 .cindex "STARTTLS, ACL for"
25618 .cindex "VRFY" "ACL for"
25619 .cindex "SMTP" "connection, ACL for"
25620 .cindex "non-SMTP messages" "ACLs for"
25621 .cindex "MIME content scanning" "ACL for"
25622
25623 .table2 140pt
25624 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
25625 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25626 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25627 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25628 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
25629 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
25630 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
25631 .irow &%acl_smtp_expn%&        "ACL for EXPN"
25632 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
25633 .irow &%acl_smtp_mail%&        "ACL for MAIL"
25634 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
25635 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
25636 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
25637 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
25638 .irow &%acl_smtp_quit%&        "ACL for QUIT"
25639 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
25640 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
25641 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
25642 .endtable
25643
25644 For example, if you set
25645 .code
25646 acl_smtp_rcpt = small_acl
25647 .endd
25648 the little ACL defined above is used whenever Exim receives a RCPT command
25649 in an SMTP dialogue. The majority of policy tests on incoming messages can be
25650 done when RCPT commands arrive. A rejection of RCPT should cause the
25651 sending MTA to give up on the recipient address contained in the RCPT
25652 command, whereas rejection at other times may cause the client MTA to keep on
25653 trying to deliver the message. It is therefore recommended that you do as much
25654 testing as possible at RCPT time.
25655
25656
25657 .section "The non-SMTP ACLs" "SECID190"
25658 .cindex "non-SMTP messages" "ACLs for"
25659 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
25660 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
25661 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
25662 the state of the SMTP connection such as encryption and authentication) are not
25663 relevant and are forbidden in these ACLs. However, the sender and recipients
25664 are known, so the &%senders%& and &%sender_domains%& conditions and the
25665 &$sender_address$& and &$recipients$& variables can be used. Variables such as
25666 &$authenticated_sender$& are also available. You can specify added header lines
25667 in any of these ACLs.
25668
25669 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
25670 non-SMTP message, before any of the message has been read. (This is the
25671 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
25672 batched SMTP input, it runs after the DATA command has been reached. The
25673 result of this ACL is ignored; it cannot be used to reject a message. If you
25674 really need to, you could set a value in an ACL variable here and reject based
25675 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
25676 controls, and in particular, it can be used to set
25677 .code
25678 control = suppress_local_fixups
25679 .endd
25680 This cannot be used in the other non-SMTP ACLs because by the time they are
25681 run, it is too late.
25682
25683 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
25684 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25685
25686 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
25687 kind of rejection is treated as permanent, because there is no way of sending a
25688 temporary error for these kinds of message.
25689
25690
25691 .section "The SMTP connect ACL" "SECID191"
25692 .cindex "SMTP" "connection, ACL for"
25693 .oindex &%smtp_banner%&
25694 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
25695 session, after the test specified by &%host_reject_connection%& (which is now
25696 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
25697 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
25698 the message override the banner message that is otherwise specified by the
25699 &%smtp_banner%& option.
25700
25701
25702 .section "The EHLO/HELO ACL" "SECID192"
25703 .cindex "EHLO" "ACL for"
25704 .cindex "HELO" "ACL for"
25705 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
25706 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
25707 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
25708 Note that a client may issue more than one EHLO or HELO command in an SMTP
25709 session, and indeed is required to issue a new EHLO or HELO after successfully
25710 setting up encryption following a STARTTLS command.
25711
25712 If the command is accepted by an &%accept%& verb that has a &%message%&
25713 modifier, the message may not contain more than one line (it will be truncated
25714 at the first newline and a panic logged if it does). Such a message cannot
25715 affect the EHLO options that are listed on the second and subsequent lines of
25716 an EHLO response.
25717
25718
25719 .section "The DATA ACLs" "SECID193"
25720 .cindex "DATA" "ACLs for"
25721 Two ACLs are associated with the DATA command, because it is two-stage
25722 command, with two responses being sent to the client.
25723 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
25724 is obeyed. This gives you control after all the RCPT commands, but before
25725 the message itself is received. It offers the opportunity to give a negative
25726 response to the DATA command before the data is transmitted. Header lines
25727 added by MAIL or RCPT ACLs are not visible at this time, but any that
25728 are defined here are visible when the &%acl_smtp_data%& ACL is run.
25729
25730 You cannot test the contents of the message, for example, to verify addresses
25731 in the headers, at RCPT time or when the DATA command is received. Such
25732 tests have to appear in the ACL that is run after the message itself has been
25733 received, before the final response to the DATA command is sent. This is
25734 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
25735 associated with the DATA command.
25736
25737 For both of these ACLs, it is not possible to reject individual recipients. An
25738 error response rejects the entire message. Unfortunately, it is known that some
25739 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
25740 before or after the data) correctly &-- they keep the message on their queues
25741 and try again later, but that is their problem, though it does waste some of
25742 your resources.
25743
25744
25745 .section "The SMTP DKIM ACL" "SECTDKIMACL"
25746 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
25747 enabled (which is the default).
25748
25749 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
25750 received, and is executed for each DKIM signature found in a message.  If not
25751 otherwise specified, the default action is to accept.
25752
25753 For details on the operation of DKIM, see chapter &<<CHID12>>&.
25754
25755
25756 .section "The SMTP MIME ACL" "SECID194"
25757 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
25758 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25759
25760
25761 .section "The QUIT ACL" "SECTQUITACL"
25762 .cindex "QUIT, ACL for"
25763 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
25764 does not affect the response code to QUIT, which is always 221. Thus, the ACL
25765 does not in fact control any access. For this reason, the only verbs that are
25766 permitted are &%accept%& and &%warn%&.
25767
25768 This ACL can be used for tasks such as custom logging at the end of an SMTP
25769 session. For example, you can use ACL variables in other ACLs to count
25770 messages, recipients, etc., and log the totals at QUIT time using one or
25771 more &%logwrite%& modifiers on a &%warn%& verb.
25772
25773 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
25774 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
25775
25776 You do not need to have a final &%accept%&, but if you do, you can use a
25777 &%message%& modifier to specify custom text that is sent as part of the 221
25778 response to QUIT.
25779
25780 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
25781 failure (for example, failure to open a log file, or when Exim is bombing out
25782 because it has detected an unrecoverable error), all SMTP commands from the
25783 client are given temporary error responses until QUIT is received or the
25784 connection is closed. In these special cases, the QUIT ACL does not run.
25785
25786
25787 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25788 .vindex &$acl_smtp_notquit$&
25789 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25790 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25791 trouble, such as being unable to write to its log files, this ACL is not run,
25792 because it might try to do things (such as write to log files) that make the
25793 situation even worse.
25794
25795 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25796 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25797 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25798 and &%warn%&.
25799
25800 .vindex &$smtp_notquit_reason$&
25801 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25802 to a string that indicates the reason for the termination of the SMTP
25803 connection. The possible values are:
25804 .table2
25805 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25806 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25807 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25808 .irow &`connection-lost`&          "The SMTP connection has been lost"
25809 .irow &`data-timeout`&             "Timeout while reading message data"
25810 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25811 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25812 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25813 .irow &`synchronization-error`&    "SMTP synchronization error"
25814 .irow &`tls-failed`&               "TLS failed to start"
25815 .endtable
25816 In most cases when an SMTP connection is closed without having received QUIT,
25817 Exim sends an SMTP response message before actually closing the connection.
25818 With the exception of the &`acl-drop`& case, the default message can be
25819 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25820 &%drop%& verb in another ACL, it is the message from the other ACL that is
25821 used.
25822
25823
25824 .section "Finding an ACL to use" "SECID195"
25825 .cindex "&ACL;" "finding which to use"
25826 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25827 you can use different ACLs in different circumstances. For example,
25828 .code
25829 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25830                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25831 .endd
25832 In the default configuration file there are some example settings for
25833 providing an RFC 4409 message submission service on port 587 and a
25834 non-standard &"smtps"& service on port 465. You can use a string
25835 expansion like this to choose an ACL for MUAs on these ports which is
25836 more appropriate for this purpose than the default ACL on port 25.
25837
25838 The expanded string does not have to be the name of an ACL in the
25839 configuration file; there are other possibilities. Having expanded the
25840 string, Exim searches for an ACL as follows:
25841
25842 .ilist
25843 If the string begins with a slash, Exim uses it as a file name, and reads its
25844 contents as an ACL. The lines are processed in the same way as lines in the
25845 Exim configuration file. In particular, continuation lines are supported, blank
25846 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25847 If the file does not exist or cannot be read, an error occurs (typically
25848 causing a temporary failure of whatever caused the ACL to be run). For example:
25849 .code
25850 acl_smtp_data = /etc/acls/\
25851   ${lookup{$sender_host_address}lsearch\
25852   {/etc/acllist}{$value}{default}}
25853 .endd
25854 This looks up an ACL file to use on the basis of the host's IP address, falling
25855 back to a default if the lookup fails. If an ACL is successfully read from a
25856 file, it is retained in memory for the duration of the Exim process, so that it
25857 can be re-used without having to re-read the file.
25858 .next
25859 If the string does not start with a slash, and does not contain any spaces,
25860 Exim searches the ACL section of the configuration for an ACL whose name
25861 matches the string.
25862 .next
25863 If no named ACL is found, or if the string contains spaces, Exim parses
25864 the string as an inline ACL. This can save typing in cases where you just
25865 want to have something like
25866 .code
25867 acl_smtp_vrfy = accept
25868 .endd
25869 in order to allow free use of the VRFY command. Such a string may contain
25870 newlines; it is processed in the same way as an ACL that is read from a file.
25871 .endlist
25872
25873
25874
25875
25876 .section "ACL return codes" "SECID196"
25877 .cindex "&ACL;" "return codes"
25878 Except for the QUIT ACL, which does not affect the SMTP return code (see
25879 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25880 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25881 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25882 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25883 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25884 This also causes a 4&'xx'& return code.
25885
25886 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25887 &"deny"&, because there is no mechanism for passing temporary errors to the
25888 submitters of non-SMTP messages.
25889
25890
25891 ACLs that are relevant to message reception may also return &"discard"&. This
25892 has the effect of &"accept"&, but causes either the entire message or an
25893 individual recipient address to be discarded. In other words, it is a
25894 blackholing facility. Use it with care.
25895
25896 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25897 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25898 RCPT ACL is to discard just the one recipient address. If there are no
25899 recipients left when the message's data is received, the DATA ACL is not
25900 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25901 remaining recipients. The &"discard"& return is not permitted for the
25902 &%acl_smtp_predata%& ACL.
25903
25904
25905 .cindex "&[local_scan()]& function" "when all recipients discarded"
25906 The &[local_scan()]& function is always run, even if there are no remaining
25907 recipients; it may create new recipients.
25908
25909
25910
25911 .section "Unset ACL options" "SECID197"
25912 .cindex "&ACL;" "unset options"
25913 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25914 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25915 not defined at all. For any defined ACL, the default action when control
25916 reaches the end of the ACL statements is &"deny"&.
25917
25918 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25919 these two are ACLs that are used only for their side effects. They cannot be
25920 used to accept or reject anything.
25921
25922 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25923 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25924 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25925 when the ACL is not defined is &"accept"&.
25926
25927 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25928 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25929 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25930 messages over an SMTP connection. For an example, see the ACL in the default
25931 configuration file.
25932
25933
25934
25935
25936 .section "Data for message ACLs" "SECID198"
25937 .cindex "&ACL;" "data for message ACL"
25938 .vindex &$domain$&
25939 .vindex &$local_part$&
25940 .vindex &$sender_address$&
25941 .vindex &$sender_host_address$&
25942 .vindex &$smtp_command$&
25943 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25944 that contain information about the host and the message's sender (for example,
25945 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25946 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25947 &$local_part$& are set from the argument address. The entire SMTP command
25948 is available in &$smtp_command$&.
25949
25950 When an ACL for the AUTH parameter of MAIL is running, the variables that
25951 contain information about the host are set, but &$sender_address$& is not yet
25952 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25953 how it is used.
25954
25955 .vindex "&$message_size$&"
25956 The &$message_size$& variable is set to the value of the SIZE parameter on
25957 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25958 that parameter is not given. The value is updated to the true message size by
25959 the time the final DATA ACL is run (after the message data has been
25960 received).
25961
25962 .vindex "&$rcpt_count$&"
25963 .vindex "&$recipients_count$&"
25964 The &$rcpt_count$& variable increases by one for each RCPT command received.
25965 The &$recipients_count$& variable increases by one each time a RCPT command is
25966 accepted, so while an ACL for RCPT is being processed, it contains the number
25967 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25968 &$rcpt_count$& contains the total number of RCPT commands, and
25969 &$recipients_count$& contains the total number of accepted recipients.
25970
25971
25972
25973
25974
25975 .section "Data for non-message ACLs" "SECTdatfornon"
25976 .cindex "&ACL;" "data for non-message ACL"
25977 .vindex &$smtp_command_argument$&
25978 .vindex &$smtp_command$&
25979 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25980 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25981 and the entire SMTP command is available in &$smtp_command$&.
25982 These variables can be tested using a &%condition%& condition. For example,
25983 here is an ACL for use with AUTH, which insists that either the session is
25984 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25985 does not permit authentication methods that use cleartext passwords on
25986 unencrypted connections.
25987 .code
25988 acl_check_auth:
25989   accept encrypted = *
25990   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25991                      {CRAM-MD5}}
25992   deny   message   = TLS encryption or CRAM-MD5 required
25993 .endd
25994 (Another way of applying this restriction is to arrange for the authenticators
25995 that use cleartext passwords not to be advertised when the connection is not
25996 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25997 option to do this.)
25998
25999
26000
26001 .section "Format of an ACL" "SECID199"
26002 .cindex "&ACL;" "format of"
26003 .cindex "&ACL;" "verbs, definition of"
26004 An individual ACL consists of a number of statements. Each statement starts
26005 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26006 Modifiers can change the way the verb operates, define error and log messages,
26007 set variables, insert delays, and vary the processing of accepted messages.
26008
26009 If all the conditions are met, the verb is obeyed. The same condition may be
26010 used (with different arguments) more than once in the same statement. This
26011 provides a means of specifying an &"and"& conjunction between conditions. For
26012 example:
26013 .code
26014 deny  dnslists = list1.example
26015 dnslists = list2.example
26016 .endd
26017 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26018 the conditions and modifiers when it reaches a condition that fails. What
26019 happens then depends on the verb (and in one case, on a special modifier). Not
26020 all the conditions make sense at every testing point. For example, you cannot
26021 test a sender address in the ACL that is run for a VRFY command.
26022
26023
26024 .section "ACL verbs" "SECID200"
26025 The ACL verbs are as follows:
26026
26027 .ilist
26028 .cindex "&%accept%& ACL verb"
26029 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26030 of the conditions are not met, what happens depends on whether &%endpass%&
26031 appears among the conditions (for syntax see below). If the failing condition
26032 is before &%endpass%&, control is passed to the next ACL statement; if it is
26033 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26034 check a RCPT command:
26035 .code
26036 accept domains = +local_domains
26037 endpass
26038 verify = recipient
26039 .endd
26040 If the recipient domain does not match the &%domains%& condition, control
26041 passes to the next statement. If it does match, the recipient is verified, and
26042 the command is accepted if verification succeeds. However, if verification
26043 fails, the ACL yields &"deny"&, because the failing condition is after
26044 &%endpass%&.
26045
26046 The &%endpass%& feature has turned out to be confusing to many people, so its
26047 use is not recommended nowadays. It is always possible to rewrite an ACL so
26048 that &%endpass%& is not needed, and it is no longer used in the default
26049 configuration.
26050
26051 .cindex "&%message%& ACL modifier" "with &%accept%&"
26052 If a &%message%& modifier appears on an &%accept%& statement, its action
26053 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26054 (when an &%accept%& verb either accepts or passes control to the next
26055 statement), &%message%& can be used to vary the message that is sent when an
26056 SMTP command is accepted. For example, in a RCPT ACL you could have:
26057 .display
26058 &`accept  `&<&'some conditions'&>
26059 &`        message = OK, I will allow you through today`&
26060 .endd
26061 You can specify an SMTP response code, optionally followed by an &"extended
26062 response code"& at the start of the message, but the first digit must be the
26063 same as would be sent by default, which is 2 for an &%accept%& verb.
26064
26065 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26066 an error message that is used when access is denied. This behaviour is retained
26067 for backward compatibility, but current &"best practice"& is to avoid the use
26068 of &%endpass%&.
26069
26070
26071 .next
26072 .cindex "&%defer%& ACL verb"
26073 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26074 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26075 &%defer%& is the same as &%deny%&, because there is no way of sending a
26076 temporary error. For a RCPT command, &%defer%& is much the same as using a
26077 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26078 be used in any ACL, and even for a recipient it might be a simpler approach.
26079
26080
26081 .next
26082 .cindex "&%deny%& ACL verb"
26083 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26084 the conditions are not met, control is passed to the next ACL statement. For
26085 example,
26086 .code
26087 deny dnslists = blackholes.mail-abuse.org
26088 .endd
26089 rejects commands from hosts that are on a DNS black list.
26090
26091
26092 .next
26093 .cindex "&%discard%& ACL verb"
26094 &%discard%&: This verb behaves like &%accept%&, except that it returns
26095 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26096 that are concerned with receiving messages. When all the conditions are true,
26097 the sending entity receives a &"success"& response. However, &%discard%& causes
26098 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26099 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26100 message's recipients are discarded. Recipients that are discarded before DATA
26101 do not appear in the log line when the &%received_recipients%& log selector is set.
26102
26103 If the &%log_message%& modifier is set when &%discard%& operates,
26104 its contents are added to the line that is automatically written to the log.
26105 The &%message%& modifier operates exactly as it does for &%accept%&.
26106
26107
26108 .next
26109 .cindex "&%drop%& ACL verb"
26110 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26111 forcibly closed after the 5&'xx'& error message has been sent. For example:
26112 .code
26113 drop   message   = I don't take more than 20 RCPTs
26114        condition = ${if > {$rcpt_count}{20}}
26115 .endd
26116 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26117 The connection is always dropped after sending a 550 response.
26118
26119 .next
26120 .cindex "&%require%& ACL verb"
26121 &%require%&: If all the conditions are met, control is passed to the next ACL
26122 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26123 example, when checking a RCPT command,
26124 .code
26125 require message = Sender did not verify
26126         verify  = sender
26127 .endd
26128 passes control to subsequent statements only if the message's sender can be
26129 verified. Otherwise, it rejects the command. Note the positioning of the
26130 &%message%& modifier, before the &%verify%& condition. The reason for this is
26131 discussed in section &<<SECTcondmodproc>>&.
26132
26133 .next
26134 .cindex "&%warn%& ACL verb"
26135 &%warn%&: If all the conditions are true, a line specified by the
26136 &%log_message%& modifier is written to Exim's main log. Control always passes
26137 to the next ACL statement. If any condition is false, the log line is not
26138 written. If an identical log line is requested several times in the same
26139 message, only one copy is actually written to the log. If you want to force
26140 duplicates to be written, use the &%logwrite%& modifier instead.
26141
26142 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26143 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26144 &%logwrite%&, and &%add_header%&) that appear before the first failing
26145 condition. There is more about adding header lines in section
26146 &<<SECTaddheadacl>>&.
26147
26148 If any condition on a &%warn%& statement cannot be completed (that is, there is
26149 some sort of defer), the log line specified by &%log_message%& is not written.
26150 This does not include the case of a forced failure from a lookup, which
26151 is considered to be a successful completion. After a defer, no further
26152 conditions or modifiers in the &%warn%& statement are processed. The incident
26153 is logged, and the ACL continues to be processed, from the next statement
26154 onwards.
26155
26156
26157 .vindex "&$acl_verify_message$&"
26158 When one of the &%warn%& conditions is an address verification that fails, the
26159 text of the verification failure message is in &$acl_verify_message$&. If you
26160 want this logged, you must set it up explicitly. For example:
26161 .code
26162 warn   !verify = sender
26163        log_message = sender verify failed: $acl_verify_message
26164 .endd
26165 .endlist
26166
26167 At the end of each ACL there is an implicit unconditional &%deny%&.
26168
26169 As you can see from the examples above, the conditions and modifiers are
26170 written one to a line, with the first one on the same line as the verb, and
26171 subsequent ones on following lines. If you have a very long condition, you can
26172 continue it onto several physical lines by the usual backslash continuation
26173 mechanism. It is conventional to align the conditions vertically.
26174
26175
26176
26177 .section "ACL variables" "SECTaclvariables"
26178 .cindex "&ACL;" "variables"
26179 There are some special variables that can be set during ACL processing. They
26180 can be used to pass information between different ACLs, different invocations
26181 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26182 transports, and filters that are used to deliver a message. The names of these
26183 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26184 an underscore, but the remainder of the name can be any sequence of
26185 alphanumeric characters and underscores that you choose. There is no limit on
26186 the number of ACL variables. The two sets act as follows:
26187 .ilist
26188 The values of those variables whose names begin with &$acl_c$& persist
26189 throughout an SMTP connection. They are never reset. Thus, a value that is set
26190 while receiving one message is still available when receiving the next message
26191 on the same SMTP connection.
26192 .next
26193 The values of those variables whose names begin with &$acl_m$& persist only
26194 while a message is being received. They are reset afterwards. They are also
26195 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26196 .endlist
26197
26198 When a message is accepted, the current values of all the ACL variables are
26199 preserved with the message and are subsequently made available at delivery
26200 time. The ACL variables are set by a modifier called &%set%&. For example:
26201 .code
26202 accept hosts = whatever
26203        set acl_m4 = some value
26204 accept authenticated = *
26205        set acl_c_auth = yes
26206 .endd
26207 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26208 be set. If you want to set a variable without taking any action, you can use a
26209 &%warn%& verb without any other modifiers or conditions.
26210
26211 .oindex &%strict_acl_vars%&
26212 What happens if a syntactically valid but undefined ACL variable is
26213 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26214 false (the default), an empty string is substituted; if it is true, an
26215 error is generated.
26216
26217 Versions of Exim before 4.64 have a limited set of numbered variables, but
26218 their names are compatible, so there is no problem with upgrading.
26219
26220
26221 .section "Condition and modifier processing" "SECTcondmodproc"
26222 .cindex "&ACL;" "conditions; processing"
26223 .cindex "&ACL;" "modifiers; processing"
26224 An exclamation mark preceding a condition negates its result. For example:
26225 .code
26226 deny   domains = *.dom.example
26227       !verify  = recipient
26228 .endd
26229 causes the ACL to return &"deny"& if the recipient domain ends in
26230 &'dom.example'& and the recipient address cannot be verified. Sometimes
26231 negation can be used on the right-hand side of a condition. For example, these
26232 two statements are equivalent:
26233 .code
26234 deny  hosts = !192.168.3.4
26235 deny !hosts =  192.168.3.4
26236 .endd
26237 However, for many conditions (&%verify%& being a good example), only left-hand
26238 side negation of the whole condition is possible.
26239
26240 The arguments of conditions and modifiers are expanded. A forced failure
26241 of an expansion causes a condition to be ignored, that is, it behaves as if the
26242 condition is true. Consider these two statements:
26243 .code
26244 accept  senders = ${lookup{$host_name}lsearch\
26245                   {/some/file}{$value}fail}
26246 accept  senders = ${lookup{$host_name}lsearch\
26247                   {/some/file}{$value}{}}
26248 .endd
26249 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26250 the returned list is searched, but if the lookup fails the behaviour is
26251 different in the two cases. The &%fail%& in the first statement causes the
26252 condition to be ignored, leaving no further conditions. The &%accept%& verb
26253 therefore succeeds. The second statement, however, generates an empty list when
26254 the lookup fails. No sender can match an empty list, so the condition fails,
26255 and therefore the &%accept%& also fails.
26256
26257 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26258 specify actions that are taken as the conditions for a statement are checked;
26259 others specify text for messages that are used when access is denied or a
26260 warning is generated. The &%control%& modifier affects the way an incoming
26261 message is handled.
26262
26263 The positioning of the modifiers in an ACL statement important, because the
26264 processing of a verb ceases as soon as its outcome is known. Only those
26265 modifiers that have already been encountered will take effect. For example,
26266 consider this use of the &%message%& modifier:
26267 .code
26268 require message = Can't verify sender
26269         verify  = sender
26270         message = Can't verify recipient
26271         verify  = recipient
26272         message = This message cannot be used
26273 .endd
26274 If sender verification fails, Exim knows that the result of the statement is
26275 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26276 so its text is used as the error message. If sender verification succeeds, but
26277 recipient verification fails, the second message is used. If recipient
26278 verification succeeds, the third message becomes &"current"&, but is never used
26279 because there are no more conditions to cause failure.
26280
26281 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26282 modifier that is used, because all the conditions must be true for rejection to
26283 happen. Specifying more than one &%message%& modifier does not make sense, and
26284 the message can even be specified after all the conditions. For example:
26285 .code
26286 deny   hosts = ...
26287       !senders = *@my.domain.example
26288        message = Invalid sender from client host
26289 .endd
26290 The &"deny"& result does not happen until the end of the statement is reached,
26291 by which time Exim has set up the message.
26292
26293
26294
26295 .section "ACL modifiers" "SECTACLmodi"
26296 .cindex "&ACL;" "modifiers; list of"
26297 The ACL modifiers are as follows:
26298
26299 .vlist
26300 .vitem &*add_header*&&~=&~<&'text'&>
26301 This modifier specifies one or more header lines that are to be added to an
26302 incoming message, assuming, of course, that the message is ultimately
26303 accepted. For details, see section &<<SECTaddheadacl>>&.
26304
26305 .vitem &*continue*&&~=&~<&'text'&>
26306 .cindex "&%continue%& ACL modifier"
26307 .cindex "database" "updating in ACL"
26308 This modifier does nothing of itself, and processing of the ACL always
26309 continues with the next condition or modifier. The value of &%continue%& is in
26310 the side effects of expanding its argument. Typically this could be used to
26311 update a database. It is really just a syntactic tidiness, to avoid having to
26312 write rather ugly lines like this:
26313 .display
26314 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26315 .endd
26316 Instead, all you need is
26317 .display
26318 &`continue = `&<&'some expansion'&>
26319 .endd
26320
26321 .vitem &*control*&&~=&~<&'text'&>
26322 .cindex "&%control%& ACL modifier"
26323 This modifier affects the subsequent processing of the SMTP connection or of an
26324 incoming message that is accepted. The effect of the first type of control
26325 lasts for the duration of the connection, whereas the effect of the second type
26326 lasts only until the current message has been received. The message-specific
26327 controls always apply to the whole message, not to individual recipients,
26328 even if the &%control%& modifier appears in a RCPT ACL.
26329
26330 As there are now quite a few controls that can be applied, they are described
26331 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26332 in several different ways. For example:
26333
26334 . ==== As this is a nested list, any displays it contains must be indented
26335 . ==== as otherwise they are too far to the left. That comment applies only
26336 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26337 . ==== way.
26338
26339 .ilist
26340 It can be at the end of an &%accept%& statement:
26341 .code
26342     accept  ...some conditions
26343             control = queue_only
26344 .endd
26345 In this case, the control is applied when this statement yields &"accept"&, in
26346 other words, when the conditions are all true.
26347
26348 .next
26349 It can be in the middle of an &%accept%& statement:
26350 .code
26351     accept  ...some conditions...
26352             control = queue_only
26353             ...some more conditions...
26354 .endd
26355 If the first set of conditions are true, the control is applied, even if the
26356 statement does not accept because one of the second set of conditions is false.
26357 In this case, some subsequent statement must yield &"accept"& for the control
26358 to be relevant.
26359
26360 .next
26361 It can be used with &%warn%& to apply the control, leaving the
26362 decision about accepting or denying to a subsequent verb. For
26363 example:
26364 .code
26365     warn    ...some conditions...
26366             control = freeze
26367     accept  ...
26368 .endd
26369 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26370 &%logwrite%&, so it does not add anything to the message and does not write a
26371 log entry.
26372
26373 .next
26374 If you want to apply a control unconditionally, you can use it with a
26375 &%require%& verb. For example:
26376 .code
26377     require  control = no_multiline_responses
26378 .endd
26379 .endlist
26380
26381 .vitem &*delay*&&~=&~<&'time'&>
26382 .cindex "&%delay%& ACL modifier"
26383 .oindex "&%-bh%&"
26384 This modifier may appear in any ACL. It causes Exim to wait for the time
26385 interval before proceeding. However, when testing Exim using the &%-bh%&
26386 option, the delay is not actually imposed (an appropriate message is output
26387 instead). The time is given in the usual Exim notation, and the delay happens
26388 as soon as the modifier is processed. In an SMTP session, pending output is
26389 flushed before the delay is imposed.
26390
26391 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26392 example:
26393 .code
26394 deny    ...some conditions...
26395         delay = 30s
26396 .endd
26397 The delay happens if all the conditions are true, before the statement returns
26398 &"deny"&. Compare this with:
26399 .code
26400 deny    delay = 30s
26401         ...some conditions...
26402 .endd
26403 which waits for 30s before processing the conditions. The &%delay%& modifier
26404 can also be used with &%warn%& and together with &%control%&:
26405 .code
26406 warn    ...some conditions...
26407         delay = 2m
26408         control = freeze
26409 accept  ...
26410 .endd
26411
26412 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26413 responses to several commands are no longer buffered and sent in one packet (as
26414 they would normally be) because all output is flushed before imposing the
26415 delay. This optimization is disabled so that a number of small delays do not
26416 appear to the client as one large aggregated delay that might provoke an
26417 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26418 using a &%control%& modifier to set &%no_delay_flush%&.
26419
26420
26421 .vitem &*endpass*&
26422 .cindex "&%endpass%& ACL modifier"
26423 This modifier, which has no argument, is recognized only in &%accept%& and
26424 &%discard%& statements. It marks the boundary between the conditions whose
26425 failure causes control to pass to the next statement, and the conditions whose
26426 failure causes the ACL to return &"deny"&. This concept has proved to be
26427 confusing to some people, so the use of &%endpass%& is no longer recommended as
26428 &"best practice"&. See the description of &%accept%& above for more details.
26429
26430
26431 .vitem &*log_message*&&~=&~<&'text'&>
26432 .cindex "&%log_message%& ACL modifier"
26433 This modifier sets up a message that is used as part of the log message if the
26434 ACL denies access or a &%warn%& statement's conditions are true. For example:
26435 .code
26436 require log_message = wrong cipher suite $tls_cipher
26437         encrypted   = DES-CBC3-SHA
26438 .endd
26439 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26440 example:
26441 .display
26442 &`discard `&<&'some conditions'&>
26443 &`        log_message = Discarded $local_part@$domain because...`&
26444 .endd
26445 When access is denied, &%log_message%& adds to any underlying error message
26446 that may exist because of a condition failure. For example, while verifying a
26447 recipient address, a &':fail:'& redirection might have already set up a
26448 message.
26449
26450 The message may be defined before the conditions to which it applies, because
26451 the string expansion does not happen until Exim decides that access is to be
26452 denied. This means that any variables that are set by the condition are
26453 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26454 variables are set after a DNS black list lookup succeeds. If the expansion of
26455 &%log_message%& fails, or if the result is an empty string, the modifier is
26456 ignored.
26457
26458 .vindex "&$acl_verify_message$&"
26459 If you want to use a &%warn%& statement to log the result of an address
26460 verification, you can use &$acl_verify_message$& to include the verification
26461 error message.
26462
26463 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26464 the start of the logged message. If the same warning log message is requested
26465 more than once while receiving  a single email message, only one copy is
26466 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26467 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26468 is logged for a successful &%warn%& statement.
26469
26470 If &%log_message%& is not present and there is no underlying error message (for
26471 example, from the failure of address verification), but &%message%& is present,
26472 the &%message%& text is used for logging rejections. However, if any text for
26473 logging contains newlines, only the first line is logged. In the absence of
26474 both &%log_message%& and &%message%&, a default built-in message is used for
26475 logging rejections.
26476
26477
26478 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26479 .cindex "&%log_reject_target%& ACL modifier"
26480 .cindex "logging in ACL" "specifying which log"
26481 This modifier makes it possible to specify which logs are used for messages
26482 about ACL rejections. Its argument is a colon-separated list of words that can
26483 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26484 may be empty, in which case a rejection is not logged at all. For example, this
26485 ACL fragment writes no logging information when access is denied:
26486 .display
26487 &`deny `&<&'some conditions'&>
26488 &`     log_reject_target =`&
26489 .endd
26490 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26491 permanent and temporary rejections. Its effect lasts for the rest of the
26492 current ACL.
26493
26494
26495 .vitem &*logwrite*&&~=&~<&'text'&>
26496 .cindex "&%logwrite%& ACL modifier"
26497 .cindex "logging in ACL" "immediate"
26498 This modifier writes a message to a log file as soon as it is encountered when
26499 processing an ACL. (Compare &%log_message%&, which, except in the case of
26500 &%warn%& and &%discard%&, is used only if the ACL statement denies
26501 access.) The &%logwrite%& modifier can be used to log special incidents in
26502 ACLs. For example:
26503 .display
26504 &`accept `&<&'some special conditions'&>
26505 &`       control  = freeze`&
26506 &`       logwrite = froze message because ...`&
26507 .endd
26508 By default, the message is written to the main log. However, it may begin
26509 with a colon, followed by a comma-separated list of log names, and then
26510 another colon, to specify exactly which logs are to be written. For
26511 example:
26512 .code
26513 logwrite = :main,reject: text for main and reject logs
26514 logwrite = :panic: text for panic log only
26515 .endd
26516
26517
26518 .vitem &*message*&&~=&~<&'text'&>
26519 .cindex "&%message%& ACL modifier"
26520 This modifier sets up a text string that is expanded and used as a response
26521 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
26522 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
26523 there is some complication if &%endpass%& is involved; see the description of
26524 &%accept%& for details.)
26525
26526 The expansion of the message happens at the time Exim decides that the ACL is
26527 to end, not at the time it processes &%message%&. If the expansion fails, or
26528 generates an empty string, the modifier is ignored. Here is an example where
26529 &%message%& must be specified first, because the ACL ends with a rejection if
26530 the &%hosts%& condition fails:
26531 .code
26532 require  message = Host not recognized
26533          hosts = 10.0.0.0/8
26534 .endd
26535 (Once a condition has failed, no further conditions or modifiers are
26536 processed.)
26537
26538 .cindex "SMTP" "error codes"
26539 .oindex "&%smtp_banner%&
26540 For ACLs that are triggered by SMTP commands, the message is returned as part
26541 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
26542 is meaningful only for SMTP, as no message is returned when a non-SMTP message
26543 is accepted. In the case of the connect ACL, accepting with a message modifier
26544 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
26545 accept message may not contain more than one line (otherwise it will be
26546 truncated at the first newline and a panic logged), and it cannot affect the
26547 EHLO options.
26548
26549 When SMTP is involved, the message may begin with an overriding response code,
26550 consisting of three digits optionally followed by an &"extended response code"&
26551 of the form &'n.n.n'&, each code being followed by a space. For example:
26552 .code
26553 deny  message = 599 1.2.3 Host not welcome
26554       hosts = 192.168.34.0/24
26555 .endd
26556 The first digit of the supplied response code must be the same as would be sent
26557 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
26558 access, but for the predata ACL, note that the default success code is 354, not
26559 2&'xx'&.
26560
26561 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
26562 the message modifier cannot override the 221 response code.
26563
26564 The text in a &%message%& modifier is literal; any quotes are taken as
26565 literals, but because the string is expanded, backslash escapes are processed
26566 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
26567 response.
26568
26569 .vindex "&$acl_verify_message$&"
26570 If &%message%& is used on a statement that verifies an address, the message
26571 specified overrides any message that is generated by the verification process.
26572 However, the original message is available in the variable
26573 &$acl_verify_message$&, so you can incorporate it into your message if you
26574 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
26575 routers to be passed back as part of the SMTP response, you should either not
26576 use a &%message%& modifier, or make use of &$acl_verify_message$&.
26577
26578 For compatibility with previous releases of Exim, a &%message%& modifier that
26579 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
26580 modifier, but this usage is now deprecated. However, &%message%& acts only when
26581 all the conditions are true, wherever it appears in an ACL command, whereas
26582 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
26583 &%warn%& in an ACL that is not concerned with receiving a message, it has no
26584 effect.
26585
26586
26587 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
26588 .cindex "&%set%& ACL modifier"
26589 This modifier puts a value into one of the ACL variables (see section
26590 &<<SECTaclvariables>>&).
26591 .endlist
26592
26593
26594
26595
26596
26597 .section "Use of the control modifier" "SECTcontrols"
26598 .cindex "&%control%& ACL modifier"
26599 The &%control%& modifier supports the following settings:
26600
26601 .vlist
26602 .vitem &*control&~=&~allow_auth_unadvertised*&
26603 This modifier allows a client host to use the SMTP AUTH command even when it
26604 has not been advertised in response to EHLO. Furthermore, because there are
26605 apparently some really broken clients that do this, Exim will accept AUTH after
26606 HELO (rather than EHLO) when this control is set. It should be used only if you
26607 really need it, and you should limit its use to those broken clients that do
26608 not work without it. For example:
26609 .code
26610 warn hosts   = 192.168.34.25
26611      control = allow_auth_unadvertised
26612 .endd
26613 Normally, when an Exim server receives an AUTH command, it checks the name of
26614 the authentication mechanism that is given in the command to ensure that it
26615 matches an advertised mechanism. When this control is set, the check that a
26616 mechanism has been advertised is bypassed. Any configured mechanism can be used
26617 by the client. This control is permitted only in the connection and HELO ACLs.
26618
26619
26620 .vitem &*control&~=&~caseful_local_part*& &&&
26621        &*control&~=&~caselower_local_part*&
26622 .cindex "&ACL;" "case of local part in"
26623 .cindex "case of local parts"
26624 .vindex "&$local_part$&"
26625 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
26626 (that is, during RCPT processing). By default, the contents of &$local_part$&
26627 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
26628 any uppercase letters in the original local part are restored in &$local_part$&
26629 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
26630 is encountered.
26631
26632 These controls affect only the current recipient. Moreover, they apply only to
26633 local part handling that takes place directly in the ACL (for example, as a key
26634 in lookups). If a test to verify the recipient is obeyed, the case-related
26635 handling of the local part during the verification is controlled by the router
26636 configuration (see the &%caseful_local_part%& generic router option).
26637
26638 This facility could be used, for example, to add a spam score to local parts
26639 containing upper case letters. For example, using &$acl_m4$& to accumulate the
26640 spam score:
26641 .code
26642 warn  control = caseful_local_part
26643       set acl_m4 = ${eval:\
26644                      $acl_m4 + \
26645                      ${if match{$local_part}{[A-Z]}{1}{0}}\
26646                     }
26647       control = caselower_local_part
26648 .endd
26649 Notice that we put back the lower cased version afterwards, assuming that
26650 is what is wanted for subsequent tests.
26651
26652
26653 .vitem &*control&~=&~debug/*&<&'options'&>
26654 .cindex "&ACL;" "enabling debug logging"
26655 .cindex "debugging" "enabling from an ACL"
26656 This control turns on debug logging, almost as though Exim had been invoked
26657 with &`-d`&, with the output going to a new logfile, by default called
26658 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
26659 may access any variables already defined.  The logging may be adjusted with
26660 the &'opts'& option, which takes the same values as the &`-d`& command-line
26661 option.  Some examples (which depend on variables that don't exist in all
26662 contexts):
26663 .code
26664       control = debug
26665       control = debug/tag=.$sender_host_address
26666       control = debug/opts=+expand+acl
26667       control = debug/tag=.$message_exim_id/opts=+expand
26668 .endd
26669
26670
26671 .vitem &*control&~=&~enforce_sync*& &&&
26672        &*control&~=&~no_enforce_sync*&
26673 .cindex "SMTP" "synchronization checking"
26674 .cindex "synchronization checking in SMTP"
26675 These controls make it possible to be selective about when SMTP synchronization
26676 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
26677 state of the switch (it is true by default). See the description of this option
26678 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
26679
26680 The effect of these two controls lasts for the remainder of the SMTP
26681 connection. They can appear in any ACL except the one for the non-SMTP
26682 messages. The most straightforward place to put them is in the ACL defined by
26683 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
26684 before the first synchronization check. The expected use is to turn off the
26685 synchronization checks for badly-behaved hosts that you nevertheless need to
26686 work with.
26687
26688
26689 .vitem &*control&~=&~fakedefer/*&<&'message'&>
26690 .cindex "fake defer"
26691 .cindex "defer, fake"
26692 This control works in exactly the same way as &%fakereject%& (described below)
26693 except that it causes an SMTP 450 response after the message data instead of a
26694 550 response. You must take care when using &%fakedefer%& because it causes the
26695 messages to be duplicated when the sender retries. Therefore, you should not
26696 use &%fakedefer%& if the message is to be delivered normally.
26697
26698 .vitem &*control&~=&~fakereject/*&<&'message'&>
26699 .cindex "fake rejection"
26700 .cindex "rejection, fake"
26701 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
26702 words, only when an SMTP message is being received. If Exim accepts the
26703 message, instead the final 250 response, a 550 rejection message is sent.
26704 However, Exim proceeds to deliver the message as normal. The control applies
26705 only to the current message, not to any subsequent ones that may be received in
26706 the same SMTP connection.
26707
26708 The text for the 550 response is taken from the &%control%& modifier. If no
26709 message is supplied, the following is used:
26710 .code
26711 550-Your message has been rejected but is being
26712 550-kept for evaluation.
26713 550-If it was a legitimate message, it may still be
26714 550 delivered to the target recipient(s).
26715 .endd
26716 This facility should be used with extreme caution.
26717
26718 .vitem &*control&~=&~freeze*&
26719 .cindex "frozen messages" "forcing in ACL"
26720 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26721 other words, only when a message is being received. If the message is accepted,
26722 it is placed on Exim's queue and frozen. The control applies only to the
26723 current message, not to any subsequent ones that may be received in the same
26724 SMTP connection.
26725
26726 This modifier can optionally be followed by &`/no_tell`&. If the global option
26727 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
26728 is told about the freezing), provided all the &*control=freeze*& modifiers that
26729 are obeyed for the current message have the &`/no_tell`& option.
26730
26731 .vitem &*control&~=&~no_delay_flush*&
26732 .cindex "SMTP" "output flushing, disabling for delay"
26733 Exim normally flushes SMTP output before implementing a delay in an ACL, to
26734 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26735 use. This control, as long as it is encountered before the &%delay%& modifier,
26736 disables such output flushing.
26737
26738 .vitem &*control&~=&~no_callout_flush*&
26739 .cindex "SMTP" "output flushing, disabling for callout"
26740 Exim normally flushes SMTP output before performing a callout in an ACL, to
26741 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26742 use. This control, as long as it is encountered before the &%verify%& condition
26743 that causes the callout, disables such output flushing.
26744
26745 .vitem &*control&~=&~no_mbox_unspool*&
26746 This control is available when Exim is compiled with the content scanning
26747 extension. Content scanning may require a copy of the current message, or parts
26748 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
26749 or spam scanner. Normally, such copies are deleted when they are no longer
26750 needed. If this control is set, the copies are not deleted. The control applies
26751 only to the current message, not to any subsequent ones that may be received in
26752 the same SMTP connection. It is provided for debugging purposes and is unlikely
26753 to be useful in production.
26754
26755 .vitem &*control&~=&~no_multiline_responses*&
26756 .cindex "multiline responses, suppressing"
26757 This control is permitted for any ACL except the one for non-SMTP messages.
26758 It seems that there are broken clients in use that cannot handle multiline
26759 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
26760
26761 If this control is set, multiline SMTP responses from ACL rejections are
26762 suppressed. One way of doing this would have been to put out these responses as
26763 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
26764 (&"use multiline responses for more"& it says &-- ha!), and some of the
26765 responses might get close to that. So this facility, which is after all only a
26766 sop to broken clients, is implemented by doing two very easy things:
26767
26768 .ilist
26769 Extra information that is normally output as part of a rejection caused by
26770 sender verification failure is omitted. Only the final line (typically &"sender
26771 verification failed"&) is sent.
26772 .next
26773 If a &%message%& modifier supplies a multiline response, only the first
26774 line is output.
26775 .endlist
26776
26777 The setting of the switch can, of course, be made conditional on the
26778 calling host. Its effect lasts until the end of the SMTP connection.
26779
26780 .vitem &*control&~=&~no_pipelining*&
26781 .cindex "PIPELINING" "suppressing advertising"
26782 This control turns off the advertising of the PIPELINING extension to SMTP in
26783 the current session. To be useful, it must be obeyed before Exim sends its
26784 response to an EHLO command. Therefore, it should normally appear in an ACL
26785 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26786 &%pipelining_advertise_hosts%&.
26787
26788 .vitem &*control&~=&~queue_only*&
26789 .oindex "&%queue_only%&"
26790 .cindex "queueing incoming messages"
26791 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26792 other words, only when a message is being received. If the message is accepted,
26793 it is placed on Exim's queue and left there for delivery by a subsequent queue
26794 runner. No immediate delivery process is started. In other words, it has the
26795 effect as the &%queue_only%& global option. However, the control applies only
26796 to the current message, not to any subsequent ones that may be received in the
26797 same SMTP connection.
26798
26799 .vitem &*control&~=&~submission/*&<&'options'&>
26800 .cindex "message" "submission"
26801 .cindex "submission mode"
26802 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26803 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26804 the current message is a submission from a local MUA. In this case, Exim
26805 operates in &"submission mode"&, and applies certain fixups to the message if
26806 necessary. For example, it adds a &'Date:'& header line if one is not present.
26807 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26808 late (the message has already been created).
26809
26810 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26811 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26812 submission mode; the available options for this control are described there.
26813 The control applies only to the current message, not to any subsequent ones
26814 that may be received in the same SMTP connection.
26815
26816 .vitem &*control&~=&~suppress_local_fixups*&
26817 .cindex "submission fixups, suppressing"
26818 This control applies to locally submitted (non TCP/IP) messages, and is the
26819 complement of &`control = submission`&. It disables the fixups that are
26820 normally applied to locally-submitted messages. Specifically:
26821
26822 .ilist
26823 Any &'Sender:'& header line is left alone (in this respect, it is a
26824 dynamic version of &%local_sender_retain%&).
26825 .next
26826 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26827 .next
26828 There is no check that &'From:'& corresponds to the actual sender.
26829 .endlist ilist
26830
26831 This control may be useful when a remotely-originated message is accepted,
26832 passed to some scanning program, and then re-submitted for delivery. It can be
26833 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26834 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26835 data is read.
26836
26837 &*Note:*& This control applies only to the current message, not to any others
26838 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26839 .endlist vlist
26840
26841
26842 .section "Summary of message fixup control" "SECTsummesfix"
26843 All four possibilities for message fixups can be specified:
26844
26845 .ilist
26846 Locally submitted, fixups applied: the default.
26847 .next
26848 Locally submitted, no fixups applied: use
26849 &`control = suppress_local_fixups`&.
26850 .next
26851 Remotely submitted, no fixups applied: the default.
26852 .next
26853 Remotely submitted, fixups applied: use &`control = submission`&.
26854 .endlist
26855
26856
26857
26858 .section "Adding header lines in ACLs" "SECTaddheadacl"
26859 .cindex "header lines" "adding in an ACL"
26860 .cindex "header lines" "position of added lines"
26861 .cindex "&%message%& ACL modifier"
26862 The &%add_header%& modifier can be used to add one or more extra header lines
26863 to an incoming message, as in this example:
26864 .code
26865 warn dnslists = sbl.spamhaus.org : \
26866                 dialup.mail-abuse.org
26867      add_header = X-blacklisted-at: $dnslist_domain
26868 .endd
26869 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26870 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26871 receiving a message). The message must ultimately be accepted for
26872 &%add_header%& to have any significant effect. You can use &%add_header%& with
26873 any ACL verb, including &%deny%& (though this is potentially useful only in a
26874 RCPT ACL).
26875
26876 If the data for the &%add_header%& modifier contains one or more newlines that
26877 are not followed by a space or a tab, it is assumed to contain multiple header
26878 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26879 front of any line that is not a valid header line.
26880
26881 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26882 They are added to the message before processing the DATA and MIME ACLs.
26883 However, if an identical header line is requested more than once, only one copy
26884 is actually added to the message. Further header lines may be accumulated
26885 during the DATA and MIME ACLs, after which they are added to the message, again
26886 with duplicates suppressed. Thus, it is possible to add two identical header
26887 lines to an SMTP message, but only if one is added before DATA and one after.
26888 In the case of non-SMTP messages, new headers are accumulated during the
26889 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26890 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26891 are included in the entry that is written to the reject log.
26892
26893 .cindex "header lines" "added; visibility of"
26894 Header lines are not visible in string expansions until they are added to the
26895 message. It follows that header lines defined in the MAIL, RCPT, and predata
26896 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26897 header lines that are added by the DATA or MIME ACLs are not visible in those
26898 ACLs. Because of this restriction, you cannot use header lines as a way of
26899 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26900 this, you can use ACL variables, as described in section
26901 &<<SECTaclvariables>>&.
26902
26903 The &%add_header%& modifier acts immediately it is encountered during the
26904 processing of an ACL. Notice the difference between these two cases:
26905 .display
26906 &`accept add_header = ADDED: some text`&
26907 &`       `&<&'some condition'&>
26908
26909 &`accept `&<&'some condition'&>
26910 &`       add_header = ADDED: some text`&
26911 .endd
26912 In the first case, the header line is always added, whether or not the
26913 condition is true. In the second case, the header line is added only if the
26914 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26915 ACL statement. All those that are encountered before a condition fails are
26916 honoured.
26917
26918 .cindex "&%warn%& ACL verb"
26919 For compatibility with previous versions of Exim, a &%message%& modifier for a
26920 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26921 effect only if all the conditions are true, even if it appears before some of
26922 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26923 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26924 are present on a &%warn%& verb, both are processed according to their
26925 specifications.
26926
26927 By default, new header lines are added to a message at the end of the existing
26928 header lines. However, you can specify that any particular header line should
26929 be added right at the start (before all the &'Received:'& lines), immediately
26930 after the first block of &'Received:'& lines, or immediately before any line
26931 that is not a &'Received:'& or &'Resent-something:'& header.
26932
26933 This is done by specifying &":at_start:"&, &":after_received:"&, or
26934 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26935 header line, respectively. (Header text cannot start with a colon, as there has
26936 to be a header name first.) For example:
26937 .code
26938 warn add_header = \
26939        :after_received:X-My-Header: something or other...
26940 .endd
26941 If more than one header line is supplied in a single &%add_header%& modifier,
26942 each one is treated independently and can therefore be placed differently. If
26943 you add more than one line at the start, or after the Received: block, they end
26944 up in reverse order.
26945
26946 &*Warning*&: This facility currently applies only to header lines that are
26947 added in an ACL. It does NOT work for header lines that are added in a
26948 system filter or in a router or transport.
26949
26950
26951
26952
26953 .section "ACL conditions" "SECTaclconditions"
26954 .cindex "&ACL;" "conditions; list of"
26955 Some of conditions listed in this section are available only when Exim is
26956 compiled with the content-scanning extension. They are included here briefly
26957 for completeness. More detailed descriptions can be found in the discussion on
26958 content scanning in chapter &<<CHAPexiscan>>&.
26959
26960 Not all conditions are relevant in all circumstances. For example, testing
26961 senders and recipients does not make sense in an ACL that is being run as the
26962 result of the arrival of an ETRN command, and checks on message headers can be
26963 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26964 can use the same condition (with different parameters) more than once in the
26965 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26966 The conditions are as follows:
26967
26968
26969 .vlist
26970 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26971 .cindex "&ACL;" "nested"
26972 .cindex "&ACL;" "indirect"
26973 .cindex "&%acl%& ACL condition"
26974 The possible values of the argument are the same as for the
26975 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26976 &"accept"& the condition is true; if it returns &"deny"& the condition is
26977 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26978 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26979 condition false. This means that further processing of the &%warn%& verb
26980 ceases, but processing of the ACL continues.
26981
26982 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26983 the connection is dropped. If it returns &"discard"&, the verb must be
26984 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26985 conditions are tested.
26986
26987 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26988 loops. This condition allows you to use different ACLs in different
26989 circumstances. For example, different ACLs can be used to handle RCPT commands
26990 for different local users or different local domains.
26991
26992 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26993 .cindex "&%authenticated%& ACL condition"
26994 .cindex "authentication" "ACL checking"
26995 .cindex "&ACL;" "testing for authentication"
26996 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26997 the name of the authenticator is tested against the list. To test for
26998 authentication by any authenticator, you can set
26999 .code
27000 authenticated = *
27001 .endd
27002
27003 .vitem &*condition&~=&~*&<&'string'&>
27004 .cindex "&%condition%& ACL condition"
27005 .cindex "customizing" "ACL condition"
27006 .cindex "&ACL;" "customized test"
27007 .cindex "&ACL;" "testing, customized"
27008 This feature allows you to make up custom conditions. If the result of
27009 expanding the string is an empty string, the number zero, or one of the strings
27010 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27011 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27012 any other value, some error is assumed to have occurred, and the ACL returns
27013 &"defer"&. However, if the expansion is forced to fail, the condition is
27014 ignored. The effect is to treat it as true, whether it is positive or
27015 negative.
27016
27017 .vitem &*decode&~=&~*&<&'location'&>
27018 .cindex "&%decode%& ACL condition"
27019 This condition is available only when Exim is compiled with the
27020 content-scanning extension, and it is allowed only in the ACL defined by
27021 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27022 If all goes well, the condition is true. It is false only if there are
27023 problems such as a syntax error or a memory shortage. For more details, see
27024 chapter &<<CHAPexiscan>>&.
27025
27026 .vitem &*demime&~=&~*&<&'extension&~list'&>
27027 .cindex "&%demime%& ACL condition"
27028 This condition is available only when Exim is compiled with the
27029 content-scanning extension. Its use is described in section
27030 &<<SECTdemimecond>>&.
27031
27032 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27033 .cindex "&%dnslists%& ACL condition"
27034 .cindex "DNS list" "in ACL"
27035 .cindex "black list (DNS)"
27036 .cindex "&ACL;" "testing a DNS list"
27037 This condition checks for entries in DNS black lists. These are also known as
27038 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27039 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27040 different variants of this condition to describe briefly here. See sections
27041 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27042
27043 .vitem &*domains&~=&~*&<&'domain&~list'&>
27044 .cindex "&%domains%& ACL condition"
27045 .cindex "domain" "ACL checking"
27046 .cindex "&ACL;" "testing a recipient domain"
27047 .vindex "&$domain_data$&"
27048 This condition is relevant only after a RCPT command. It checks that the domain
27049 of the recipient address is in the domain list. If percent-hack processing is
27050 enabled, it is done before this test is done. If the check succeeds with a
27051 lookup, the result of the lookup is placed in &$domain_data$& until the next
27052 &%domains%& test.
27053
27054 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27055 use &%domains%& in a DATA ACL.
27056
27057
27058 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27059 .cindex "&%encrypted%& ACL condition"
27060 .cindex "encryption" "checking in an ACL"
27061 .cindex "&ACL;" "testing for encryption"
27062 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27063 name of the cipher suite in use is tested against the list. To test for
27064 encryption without testing for any specific cipher suite(s), set
27065 .code
27066 encrypted = *
27067 .endd
27068
27069
27070 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
27071 .cindex "&%hosts%& ACL condition"
27072 .cindex "host" "ACL checking"
27073 .cindex "&ACL;" "testing the client host"
27074 This condition tests that the calling host matches the host list. If you have
27075 name lookups or wildcarded host names and IP addresses in the same host list,
27076 you should normally put the IP addresses first. For example, you could have:
27077 .code
27078 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27079 .endd
27080 The lookup in this example uses the host name for its key. This is implied by
27081 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27082 and it wouldn't matter which way round you had these two items.)
27083
27084 The reason for the problem with host names lies in the left-to-right way that
27085 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27086 but when it reaches an item that requires a host name, it fails if it cannot
27087 find a host name to compare with the pattern. If the above list is given in the
27088 opposite order, the &%accept%& statement fails for a host whose name cannot be
27089 found, even if its IP address is 10.9.8.7.
27090
27091 If you really do want to do the name check first, and still recognize the IP
27092 address even if the name lookup fails, you can rewrite the ACL like this:
27093 .code
27094 accept hosts = dbm;/etc/friendly/hosts
27095 accept hosts = 10.9.8.7
27096 .endd
27097 The default action on failing to find the host name is to assume that the host
27098 is not in the list, so the first &%accept%& statement fails. The second
27099 statement can then check the IP address.
27100
27101 .vindex "&$host_data$&"
27102 If a &%hosts%& condition is satisfied by means of a lookup, the result
27103 of the lookup is made available in the &$host_data$& variable. This
27104 allows you, for example, to set up a statement like this:
27105 .code
27106 deny  hosts = net-lsearch;/some/file
27107 message = $host_data
27108 .endd
27109 which gives a custom error message for each denied host.
27110
27111 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27112 .cindex "&%local_parts%& ACL condition"
27113 .cindex "local part" "ACL checking"
27114 .cindex "&ACL;" "testing a local part"
27115 .vindex "&$local_part_data$&"
27116 This condition is relevant only after a RCPT command. It checks that the local
27117 part of the recipient address is in the list. If percent-hack processing is
27118 enabled, it is done before this test. If the check succeeds with a lookup, the
27119 result of the lookup is placed in &$local_part_data$&, which remains set until
27120 the next &%local_parts%& test.
27121
27122 .vitem &*malware&~=&~*&<&'option'&>
27123 .cindex "&%malware%& ACL condition"
27124 .cindex "&ACL;" "virus scanning"
27125 .cindex "&ACL;" "scanning for viruses"
27126 This condition is available only when Exim is compiled with the
27127 content-scanning extension. It causes the incoming message to be scanned for
27128 viruses. For details, see chapter &<<CHAPexiscan>>&.
27129
27130 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27131 .cindex "&%mime_regex%& ACL condition"
27132 .cindex "&ACL;" "testing by regex matching"
27133 This condition is available only when Exim is compiled with the
27134 content-scanning extension, and it is allowed only in the ACL defined by
27135 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27136 with any of the regular expressions. For details, see chapter
27137 &<<CHAPexiscan>>&.
27138
27139 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27140 .cindex "rate limiting"
27141 This condition can be used to limit the rate at which a user or host submits
27142 messages. Details are given in section &<<SECTratelimiting>>&.
27143
27144 .vitem &*recipients&~=&~*&<&'address&~list'&>
27145 .cindex "&%recipients%& ACL condition"
27146 .cindex "recipient" "ACL checking"
27147 .cindex "&ACL;" "testing a recipient"
27148 This condition is relevant only after a RCPT command. It checks the entire
27149 recipient address against a list of recipients.
27150
27151 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27152 .cindex "&%regex%& ACL condition"
27153 .cindex "&ACL;" "testing by regex matching"
27154 This condition is available only when Exim is compiled with the
27155 content-scanning extension, and is available only in the DATA, MIME, and
27156 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27157 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27158
27159 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27160 .cindex "&%sender_domains%& ACL condition"
27161 .cindex "sender" "ACL checking"
27162 .cindex "&ACL;" "testing a sender domain"
27163 .vindex "&$domain$&"
27164 .vindex "&$sender_address_domain$&"
27165 This condition tests the domain of the sender of the message against the given
27166 domain list. &*Note*&: The domain of the sender address is in
27167 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27168 of this condition. This is an exception to the general rule for testing domain
27169 lists. It is done this way so that, if this condition is used in an ACL for a
27170 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27171 influence the sender checking.
27172
27173 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27174 relaying, because sender addresses are easily, and commonly, forged.
27175
27176 .vitem &*senders&~=&~*&<&'address&~list'&>
27177 .cindex "&%senders%& ACL condition"
27178 .cindex "sender" "ACL checking"
27179 .cindex "&ACL;" "testing a sender"
27180 This condition tests the sender of the message against the given list. To test
27181 for a bounce message, which has an empty sender, set
27182 .code
27183 senders = :
27184 .endd
27185 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27186 relaying, because sender addresses are easily, and commonly, forged.
27187
27188 .vitem &*spam&~=&~*&<&'username'&>
27189 .cindex "&%spam%& ACL condition"
27190 .cindex "&ACL;" "scanning for spam"
27191 This condition is available only when Exim is compiled with the
27192 content-scanning extension. It causes the incoming message to be scanned by
27193 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27194
27195 .vitem &*verify&~=&~certificate*&
27196 .cindex "&%verify%& ACL condition"
27197 .cindex "TLS" "client certificate verification"
27198 .cindex "certificate" "verification of client"
27199 .cindex "&ACL;" "certificate verification"
27200 .cindex "&ACL;" "testing a TLS certificate"
27201 This condition is true in an SMTP session if the session is encrypted, and a
27202 certificate was received from the client, and the certificate was verified. The
27203 server requests a certificate only if the client matches &%tls_verify_hosts%&
27204 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27205
27206 .vitem &*verify&~=&~csa*&
27207 .cindex "CSA verification"
27208 This condition checks whether the sending host (the client) is authorized to
27209 send email. Details of how this works are given in section
27210 &<<SECTverifyCSA>>&.
27211
27212 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27213 .cindex "&%verify%& ACL condition"
27214 .cindex "&ACL;" "verifying sender in the header"
27215 .cindex "header lines" "verifying the sender in"
27216 .cindex "sender" "verifying in header"
27217 .cindex "verifying" "sender in header"
27218 This condition is relevant only in an ACL that is run after a message has been
27219 received, that is, in an ACL specified by &%acl_smtp_data%& or
27220 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27221 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27222 is loosely thought of as a &"sender"& address (hence the name of the test).
27223 However, an address that appears in one of these headers need not be an address
27224 that accepts bounce messages; only sender addresses in envelopes are required
27225 to accept bounces. Therefore, if you use the callout option on this check, you
27226 might want to arrange for a non-empty address in the MAIL command.
27227
27228 Details of address verification and the options are given later, starting at
27229 section &<<SECTaddressverification>>& (callouts are described in section
27230 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27231 condition to restrict it to bounce messages only:
27232 .code
27233 deny    senders = :
27234         message = A valid sender header is required for bounces
27235        !verify  = header_sender
27236 .endd
27237
27238 .vitem &*verify&~=&~header_syntax*&
27239 .cindex "&%verify%& ACL condition"
27240 .cindex "&ACL;" "verifying header syntax"
27241 .cindex "header lines" "verifying syntax"
27242 .cindex "verifying" "header syntax"
27243 This condition is relevant only in an ACL that is run after a message has been
27244 received, that is, in an ACL specified by &%acl_smtp_data%& or
27245 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27246 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27247 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27248 permitted only in locally generated messages and from hosts that match
27249 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27250 appropriate.
27251
27252 Note that this condition is a syntax check only. However, a common spamming
27253 ploy used to be to send syntactically invalid headers such as
27254 .code
27255 To: @
27256 .endd
27257 and this condition can be used to reject such messages, though they are not as
27258 common as they used to be.
27259
27260 .vitem &*verify&~=&~helo*&
27261 .cindex "&%verify%& ACL condition"
27262 .cindex "&ACL;" "verifying HELO/EHLO"
27263 .cindex "HELO" "verifying"
27264 .cindex "EHLO" "verifying"
27265 .cindex "verifying" "EHLO"
27266 .cindex "verifying" "HELO"
27267 This condition is true if a HELO or EHLO command has been received from the
27268 client host, and its contents have been verified. If there has been no previous
27269 attempt to verify the HELO/EHLO contents, it is carried out when this
27270 condition is encountered. See the description of the &%helo_verify_hosts%& and
27271 &%helo_try_verify_hosts%& options for details of how to request verification
27272 independently of this condition.
27273
27274 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27275 option), this condition is always true.
27276
27277
27278 .vitem &*verify&~=&~not_blind*&
27279 .cindex "verifying" "not blind"
27280 .cindex "bcc recipients, verifying none"
27281 This condition checks that there are no blind (bcc) recipients in the message.
27282 Every envelope recipient must appear either in a &'To:'& header line or in a
27283 &'Cc:'& header line for this condition to be true. Local parts are checked
27284 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27285 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27286 used only in a DATA or non-SMTP ACL.
27287
27288 There are, of course, many legitimate messages that make use of blind (bcc)
27289 recipients. This check should not be used on its own for blocking messages.
27290
27291
27292 .vitem &*verify&~=&~recipient/*&<&'options'&>
27293 .cindex "&%verify%& ACL condition"
27294 .cindex "&ACL;" "verifying recipient"
27295 .cindex "recipient" "verifying"
27296 .cindex "verifying" "recipient"
27297 .vindex "&$address_data$&"
27298 This condition is relevant only after a RCPT command. It verifies the current
27299 recipient. Details of address verification are given later, starting at section
27300 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27301 of &$address_data$& is the last value that was set while routing the address.
27302 This applies even if the verification fails. When an address that is being
27303 verified is redirected to a single address, verification continues with the new
27304 address, and in that case, the subsequent value of &$address_data$& is the
27305 value for the child address.
27306
27307 .vitem &*verify&~=&~reverse_host_lookup*&
27308 .cindex "&%verify%& ACL condition"
27309 .cindex "&ACL;" "verifying host reverse lookup"
27310 .cindex "host" "verifying reverse lookup"
27311 This condition ensures that a verified host name has been looked up from the IP
27312 address of the client host. (This may have happened already if the host name
27313 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27314 Verification ensures that the host name obtained from a reverse DNS lookup, or
27315 one of its aliases, does, when it is itself looked up in the DNS, yield the
27316 original IP address.
27317
27318 If this condition is used for a locally generated message (that is, when there
27319 is no client host involved), it always succeeds.
27320
27321 .vitem &*verify&~=&~sender/*&<&'options'&>
27322 .cindex "&%verify%& ACL condition"
27323 .cindex "&ACL;" "verifying sender"
27324 .cindex "sender" "verifying"
27325 .cindex "verifying" "sender"
27326 This condition is relevant only after a MAIL or RCPT command, or after a
27327 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27328 the message's sender is empty (that is, this is a bounce message), the
27329 condition is true. Otherwise, the sender address is verified.
27330
27331 .vindex "&$address_data$&"
27332 .vindex "&$sender_address_data$&"
27333 If there is data in the &$address_data$& variable at the end of routing, its
27334 value is placed in &$sender_address_data$& at the end of verification. This
27335 value can be used in subsequent conditions and modifiers in the same ACL
27336 statement. It does not persist after the end of the current statement. If you
27337 want to preserve the value for longer, you can save it in an ACL variable.
27338
27339 Details of verification are given later, starting at section
27340 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
27341 to avoid doing it more than once per message.
27342
27343 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
27344 .cindex "&%verify%& ACL condition"
27345 This is a variation of the previous option, in which a modified address is
27346 verified as a sender.
27347 .endlist
27348
27349
27350
27351 .section "Using DNS lists" "SECTmorednslists"
27352 .cindex "DNS list" "in ACL"
27353 .cindex "black list (DNS)"
27354 .cindex "&ACL;" "testing a DNS list"
27355 In its simplest form, the &%dnslists%& condition tests whether the calling host
27356 is on at least one of a number of DNS lists by looking up the inverted IP
27357 address in one or more DNS domains. (Note that DNS list domains are not mail
27358 domains, so the &`+`& syntax for named lists doesn't work - it is used for
27359 special options instead.) For example, if the calling host's IP
27360 address is 192.168.62.43, and the ACL statement is
27361 .code
27362 deny dnslists = blackholes.mail-abuse.org : \
27363                 dialups.mail-abuse.org
27364 .endd
27365 the following records are looked up:
27366 .code
27367 43.62.168.192.blackholes.mail-abuse.org
27368 43.62.168.192.dialups.mail-abuse.org
27369 .endd
27370 As soon as Exim finds an existing DNS record, processing of the list stops.
27371 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
27372 to test that a host is on more than one list (an &"and"& conjunction), you can
27373 use two separate conditions:
27374 .code
27375 deny dnslists = blackholes.mail-abuse.org
27376      dnslists = dialups.mail-abuse.org
27377 .endd
27378 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
27379 behaves as if the host does not match the list item, that is, as if the DNS
27380 record does not exist. If there are further items in the DNS list, they are
27381 processed.
27382
27383 This is usually the required action when &%dnslists%& is used with &%deny%&
27384 (which is the most common usage), because it prevents a DNS failure from
27385 blocking mail. However, you can change this behaviour by putting one of the
27386 following special items in the list:
27387 .display
27388 &`+include_unknown `&   behave as if the item is on the list
27389 &`+exclude_unknown `&   behave as if the item is not on the list (default)
27390 &`+defer_unknown   `&   give a temporary error
27391 .endd
27392 .cindex "&`+include_unknown`&"
27393 .cindex "&`+exclude_unknown`&"
27394 .cindex "&`+defer_unknown`&"
27395 Each of these applies to any subsequent items on the list. For example:
27396 .code
27397 deny dnslists = +defer_unknown : foo.bar.example
27398 .endd
27399 Testing the list of domains stops as soon as a match is found. If you want to
27400 warn for one list and block for another, you can use two different statements:
27401 .code
27402 deny  dnslists = blackholes.mail-abuse.org
27403 warn  message  = X-Warn: sending host is on dialups list
27404       dnslists = dialups.mail-abuse.org
27405 .endd
27406 DNS list lookups are cached by Exim for the duration of the SMTP session,
27407 so a lookup based on the IP address is done at most once for any incoming
27408 connection. Exim does not share information between multiple incoming
27409 connections (but your local name server cache should be active).
27410
27411
27412
27413 .section "Specifying the IP address for a DNS list lookup" "SECID201"
27414 .cindex "DNS list" "keyed by explicit IP address"
27415 By default, the IP address that is used in a DNS list lookup is the IP address
27416 of the calling host. However, you can specify another IP address by listing it
27417 after the domain name, introduced by a slash. For example:
27418 .code
27419 deny dnslists = black.list.tld/192.168.1.2
27420 .endd
27421 This feature is not very helpful with explicit IP addresses; it is intended for
27422 use with IP addresses that are looked up, for example, the IP addresses of the
27423 MX hosts or nameservers of an email sender address. For an example, see section
27424 &<<SECTmulkeyfor>>& below.
27425
27426
27427
27428
27429 .section "DNS lists keyed on domain names" "SECID202"
27430 .cindex "DNS list" "keyed by domain name"
27431 There are some lists that are keyed on domain names rather than inverted IP
27432 addresses (see for example the &'domain based zones'& link at
27433 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
27434 with these lists. You can change the name that is looked up in a DNS list by
27435 listing it after the domain name, introduced by a slash. For example,
27436 .code
27437 deny  message  = Sender's domain is listed at $dnslist_domain
27438       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
27439 .endd
27440 This particular example is useful only in ACLs that are obeyed after the
27441 RCPT or DATA commands, when a sender address is available. If (for
27442 example) the message's sender is &'user@tld.example'& the name that is looked
27443 up by this example is
27444 .code
27445 tld.example.dsn.rfc-ignorant.org
27446 .endd
27447 A single &%dnslists%& condition can contain entries for both names and IP
27448 addresses. For example:
27449 .code
27450 deny dnslists = sbl.spamhaus.org : \
27451                 dsn.rfc-ignorant.org/$sender_address_domain
27452 .endd
27453 The first item checks the sending host's IP address; the second checks a domain
27454 name. The whole condition is true if either of the DNS lookups succeeds.
27455
27456
27457
27458
27459 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
27460 .cindex "DNS list" "multiple keys for"
27461 The syntax described above for looking up explicitly-defined values (either
27462 names or IP addresses) in a DNS blacklist is a simplification. After the domain
27463 name for the DNS list, what follows the slash can in fact be a list of items.
27464 As with all lists in Exim, the default separator is a colon. However, because
27465 this is a sublist within the list of DNS blacklist domains, it is necessary
27466 either to double the separators like this:
27467 .code
27468 dnslists = black.list.tld/name.1::name.2
27469 .endd
27470 or to change the separator character, like this:
27471 .code
27472 dnslists = black.list.tld/<;name.1;name.2
27473 .endd
27474 If an item in the list is an IP address, it is inverted before the DNS
27475 blacklist domain is appended. If it is not an IP address, no inversion
27476 occurs. Consider this condition:
27477 .code
27478 dnslists = black.list.tld/<;192.168.1.2;a.domain
27479 .endd
27480 The DNS lookups that occur are:
27481 .code
27482 2.1.168.192.black.list.tld
27483 a.domain.black.list.tld
27484 .endd
27485 Once a DNS record has been found (that matches a specific IP return
27486 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
27487 are done. If there is a temporary DNS error, the rest of the sublist of domains
27488 or IP addresses is tried. A temporary error for the whole dnslists item occurs
27489 only if no other DNS lookup in this sublist succeeds. In other words, a
27490 successful lookup for any of the items in the sublist overrides a temporary
27491 error for a previous item.
27492
27493 The ability to supply a list of items after the slash is in some sense just a
27494 syntactic convenience. These two examples have the same effect:
27495 .code
27496 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
27497 dnslists = black.list.tld/a.domain::b.domain
27498 .endd
27499 However, when the data for the list is obtained from a lookup, the second form
27500 is usually much more convenient. Consider this example:
27501 .code
27502 deny message  = The mail servers for the domain \
27503                 $sender_address_domain \
27504                 are listed at $dnslist_domain ($dnslist_value); \
27505                 see $dnslist_text.
27506      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
27507                                    ${lookup dnsdb {>|mxh=\
27508                                    $sender_address_domain} }} }
27509 .endd
27510 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
27511 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
27512 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
27513 of expanding the condition might be something like this:
27514 .code
27515 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
27516 .endd
27517 Thus, this example checks whether or not the IP addresses of the sender
27518 domain's mail servers are on the Spamhaus black list.
27519
27520 The key that was used for a successful DNS list lookup is put into the variable
27521 &$dnslist_matched$& (see section &<<SECID204>>&).
27522
27523
27524
27525
27526 .section "Data returned by DNS lists" "SECID203"
27527 .cindex "DNS list" "data returned from"
27528 DNS lists are constructed using address records in the DNS. The original RBL
27529 just used the address 127.0.0.1 on the right hand side of each record, but the
27530 RBL+ list and some other lists use a number of values with different meanings.
27531 The values used on the RBL+ list are:
27532 .display
27533 127.1.0.1  RBL
27534 127.1.0.2  DUL
27535 127.1.0.3  DUL and RBL
27536 127.1.0.4  RSS
27537 127.1.0.5  RSS and RBL
27538 127.1.0.6  RSS and DUL
27539 127.1.0.7  RSS and DUL and RBL
27540 .endd
27541 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
27542 different values. Some DNS lists may return more than one address record;
27543 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
27544
27545
27546 .section "Variables set from DNS lists" "SECID204"
27547 .cindex "expansion" "variables, set from DNS list"
27548 .cindex "DNS list" "variables set from"
27549 .vindex "&$dnslist_domain$&"
27550 .vindex "&$dnslist_matched$&"
27551 .vindex "&$dnslist_text$&"
27552 .vindex "&$dnslist_value$&"
27553 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
27554 the name of the overall domain that matched (for example,
27555 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
27556 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
27557 the DNS record. When the key is an IP address, it is not reversed in
27558 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
27559 cases, for example:
27560 .code
27561 deny dnslists = spamhaus.example
27562 .endd
27563 the key is also available in another variable (in this case,
27564 &$sender_host_address$&). In more complicated cases, however, this is not true.
27565 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
27566 might generate a dnslists lookup like this:
27567 .code
27568 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
27569 .endd
27570 If this condition succeeds, the value in &$dnslist_matched$& might be
27571 &`192.168.6.7`& (for example).
27572
27573 If more than one address record is returned by the DNS lookup, all the IP
27574 addresses are included in &$dnslist_value$&, separated by commas and spaces.
27575 The variable &$dnslist_text$& contains the contents of any associated TXT
27576 record. For lists such as RBL+ the TXT record for a merged entry is often not
27577 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
27578 information.
27579
27580 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
27581 &-- although these appear before the condition in the ACL, they are not
27582 expanded until after it has failed. For example:
27583 .code
27584 deny    hosts = !+local_networks
27585         message = $sender_host_address is listed \
27586                   at $dnslist_domain
27587         dnslists = rbl-plus.mail-abuse.example
27588 .endd
27589
27590
27591
27592 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
27593 .cindex "DNS list" "matching specific returned data"
27594 You can add an equals sign and an IP address after a &%dnslists%& domain name
27595 in order to restrict its action to DNS records with a matching right hand side.
27596 For example,
27597 .code
27598 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
27599 .endd
27600 rejects only those hosts that yield 127.0.0.2. Without this additional data,
27601 any address record is considered to be a match. For the moment, we assume
27602 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
27603 describes how multiple records are handled.
27604
27605 More than one IP address may be given for checking, using a comma as a
27606 separator. These are alternatives &-- if any one of them matches, the
27607 &%dnslists%& condition is true. For example:
27608 .code
27609 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27610 .endd
27611 If you want to specify a constraining address list and also specify names or IP
27612 addresses to be looked up, the constraining address list must be specified
27613 first. For example:
27614 .code
27615 deny dnslists = dsn.rfc-ignorant.org\
27616                 =127.0.0.2/$sender_address_domain
27617 .endd
27618
27619 If the character &`&&`& is used instead of &`=`&, the comparison for each
27620 listed IP address is done by a bitwise &"and"& instead of by an equality test.
27621 In other words, the listed addresses are used as bit masks. The comparison is
27622 true if all the bits in the mask are present in the address that is being
27623 tested. For example:
27624 .code
27625 dnslists = a.b.c&0.0.0.3
27626 .endd
27627 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
27628 want to test whether one bit or another bit is present (as opposed to both
27629 being present), you must use multiple values. For example:
27630 .code
27631 dnslists = a.b.c&0.0.0.1,0.0.0.2
27632 .endd
27633 matches if the final component of the address is an odd number or two times
27634 an odd number.
27635
27636
27637
27638 .section "Negated DNS matching conditions" "SECID205"
27639 You can supply a negative list of IP addresses as part of a &%dnslists%&
27640 condition. Whereas
27641 .code
27642 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27643 .endd
27644 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27645 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
27646 .code
27647 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
27648 .endd
27649 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27650 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
27651 words, the result of the test is inverted if an exclamation mark appears before
27652 the &`=`& (or the &`&&`&) sign.
27653
27654 &*Note*&: This kind of negation is not the same as negation in a domain,
27655 host, or address list (which is why the syntax is different).
27656
27657 If you are using just one list, the negation syntax does not gain you much. The
27658 previous example is precisely equivalent to
27659 .code
27660 deny  dnslists = a.b.c
27661      !dnslists = a.b.c=127.0.0.2,127.0.0.3
27662 .endd
27663 However, if you are using multiple lists, the negation syntax is clearer.
27664 Consider this example:
27665 .code
27666 deny  dnslists = sbl.spamhaus.org : \
27667                  list.dsbl.org : \
27668                  dnsbl.njabl.org!=127.0.0.3 : \
27669                  relays.ordb.org
27670 .endd
27671 Using only positive lists, this would have to be:
27672 .code
27673 deny  dnslists = sbl.spamhaus.org : \
27674                  list.dsbl.org
27675 deny  dnslists = dnsbl.njabl.org
27676      !dnslists = dnsbl.njabl.org=127.0.0.3
27677 deny  dnslists = relays.ordb.org
27678 .endd
27679 which is less clear, and harder to maintain.
27680
27681
27682
27683
27684 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
27685 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
27686 thereby providing more than one IP address. When an item in a &%dnslists%& list
27687 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
27688 the match to specific results from the DNS lookup, there are two ways in which
27689 the checking can be handled. For example, consider the condition:
27690 .code
27691 dnslists = a.b.c=127.0.0.1
27692 .endd
27693 What happens if the DNS lookup for the incoming IP address yields both
27694 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
27695 condition true because at least one given value was found, or is it false
27696 because at least one of the found values was not listed? And how does this
27697 affect negated conditions? Both possibilities are provided for with the help of
27698 additional separators &`==`& and &`=&&`&.
27699
27700 .ilist
27701 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
27702 IP addresses matches one of the listed addresses. For the example above, the
27703 condition is true because 127.0.0.1 matches.
27704 .next
27705 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
27706 looked up IP addresses matches one of the listed addresses. If the condition is
27707 changed to:
27708 .code
27709 dnslists = a.b.c==127.0.0.1
27710 .endd
27711 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27712 false because 127.0.0.2 is not listed. You would need to have:
27713 .code
27714 dnslists = a.b.c==127.0.0.1,127.0.0.2
27715 .endd
27716 for the condition to be true.
27717 .endlist
27718
27719 When &`!`& is used to negate IP address matching, it inverts the result, giving
27720 the precise opposite of the behaviour above. Thus:
27721 .ilist
27722 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
27723 addresses matches one of the listed addresses. Consider:
27724 .code
27725 dnslists = a.b.c!&0.0.0.1
27726 .endd
27727 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27728 false because 127.0.0.1 matches.
27729 .next
27730 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
27731 looked up IP address that does not match. Consider:
27732 .code
27733 dnslists = a.b.c!=&0.0.0.1
27734 .endd
27735 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27736 true, because 127.0.0.2 does not match. You would need to have:
27737 .code
27738 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
27739 .endd
27740 for the condition to be false.
27741 .endlist
27742 When the DNS lookup yields only a single IP address, there is no difference
27743 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
27744
27745
27746
27747
27748 .section "Detailed information from merged DNS lists" "SECTmordetinf"
27749 .cindex "DNS list" "information from merged"
27750 When the facility for restricting the matching IP values in a DNS list is used,
27751 the text from the TXT record that is set in &$dnslist_text$& may not reflect
27752 the true reason for rejection. This happens when lists are merged and the IP
27753 address in the A record is used to distinguish them; unfortunately there is
27754 only one TXT record. One way round this is not to use merged lists, but that
27755 can be inefficient because it requires multiple DNS lookups where one would do
27756 in the vast majority of cases when the host of interest is not on any of the
27757 lists.
27758
27759 A less inefficient way of solving this problem is available. If
27760 two domain names, comma-separated, are given, the second is used first to
27761 do an initial check, making use of any IP value restrictions that are set.
27762 If there is a match, the first domain is used, without any IP value
27763 restrictions, to get the TXT record. As a byproduct of this, there is also
27764 a check that the IP being tested is indeed on the first list. The first
27765 domain is the one that is put in &$dnslist_domain$&. For example:
27766 .code
27767 reject message  = \
27768          rejected because $sender_host_address is blacklisted \
27769          at $dnslist_domain\n$dnslist_text
27770        dnslists = \
27771          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
27772          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27773 .endd
27774 For the first blacklist item, this starts by doing a lookup in
27775 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
27776 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
27777 value, and as long as something is found, it looks for the corresponding TXT
27778 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
27779 The second blacklist item is processed similarly.
27780
27781 If you are interested in more than one merged list, the same list must be
27782 given several times, but because the results of the DNS lookups are cached,
27783 the DNS calls themselves are not repeated. For example:
27784 .code
27785 reject dnslists = \
27786          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27787          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27788          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27789          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27790 .endd
27791 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27792 values matches (or if no record is found), this is the only lookup that is
27793 done. Only if there is a match is one of the more specific lists consulted.
27794
27795
27796
27797 .section "DNS lists and IPv6" "SECTmorednslistslast"
27798 .cindex "IPv6" "DNS black lists"
27799 .cindex "DNS list" "IPv6 usage"
27800 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27801 nibble by nibble. For example, if the calling host's IP address is
27802 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27803 .code
27804 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27805   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27806 .endd
27807 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27808 lists contain wildcard records, intended for IPv4, that interact badly with
27809 IPv6. For example, the DNS entry
27810 .code
27811 *.3.some.list.example.    A    127.0.0.1
27812 .endd
27813 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27814 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27815
27816 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27817 &%condition%& condition, as in this example:
27818 .code
27819 deny   condition = ${if isip4{$sender_host_address}}
27820        dnslists  = some.list.example
27821 .endd
27822
27823 .section "Rate limiting incoming messages" "SECTratelimiting"
27824 .cindex "rate limiting" "client sending"
27825 .cindex "limiting client sending rates"
27826 .oindex "&%smtp_ratelimit_*%&"
27827 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27828 which clients can send email. This is more powerful than the
27829 &%smtp_ratelimit_*%& options, because those options control the rate of
27830 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27831 works across all connections (concurrent and sequential) from the same client
27832 host. The syntax of the &%ratelimit%& condition is:
27833 .display
27834 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27835 .endd
27836 If the average client sending rate is less than &'m'& messages per time
27837 period &'p'& then the condition is false; otherwise it is true.
27838
27839 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27840 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27841 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27842 of &'p'&.
27843
27844 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27845 time interval, for example, &`8h`& for eight hours. A larger time constant
27846 means that it takes Exim longer to forget a client's past behaviour. The
27847 parameter &'m'& is the maximum number of messages that a client is permitted to
27848 send in each time interval. It also specifies the number of messages permitted
27849 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27850 constant, you can allow a client to send more messages in a burst without
27851 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27852 both small, messages must be sent at an even rate.
27853
27854 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27855 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27856 when deploying the &%ratelimit%& ACL condition. The script prints usage
27857 instructions when it is run with no arguments.
27858
27859 The key is used to look up the data for calculating the client's average
27860 sending rate. This data is stored in Exim's spool directory, alongside the
27861 retry and other hints databases. The default key is &$sender_host_address$&,
27862 which means Exim computes the sending rate of each client host IP address.
27863 By changing the key you can change how Exim identifies clients for the purpose
27864 of ratelimiting. For example, to limit the sending rate of each authenticated
27865 user, independent of the computer they are sending from, set the key to
27866 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27867 example, &$authenticated_id$& is only meaningful if the client has
27868 authenticated (which you can check with the &%authenticated%& ACL condition).
27869
27870 The lookup key does not have to identify clients: If you want to limit the
27871 rate at which a recipient receives messages, you can use the key
27872 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27873 ACL.
27874
27875 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
27876 specifies what Exim measures the rate of, for example messages or recipients
27877 or bytes. You can adjust the measurement using the &%unique=%& and/or
27878 &%count=%& options. You can also control when Exim updates the recorded rate
27879 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
27880 separated by a slash, like the other parameters. They may appear in any order.
27881
27882 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
27883 any options that alter the meaning of the stored data. The limit &'m'& is not
27884 stored, so you can alter the configured maximum rate and Exim will still
27885 remember clients' past behaviour. If you change the &%per_*%& mode or add or
27886 remove the &%unique=%& option, the lookup key changes so Exim will forget past
27887 behaviour. The lookup key is not affected by changes to the update mode and
27888 the &%count=%& option.
27889
27890
27891 .section "Ratelimit options for what is being measured" "ratoptmea"
27892 .cindex "rate limiting" "per_* options"
27893 The &%per_conn%& option limits the client's connection rate. It is not
27894 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
27895 &%acl_not_smtp_start%& ACLs.
27896
27897 The &%per_mail%& option limits the client's rate of sending messages. This is
27898 the default if none of the &%per_*%& options is specified. It can be used in
27899 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
27900 &%acl_smtp_data%&, or &%acl_not_smtp%&.
27901
27902 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
27903 the same ACLs as the &%per_mail%& option, though it is best to use this option
27904 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
27905 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
27906 in its MAIL command, which may be inaccurate or completely missing. You can
27907 follow the limit &'m'& in the configuration with K, M, or G to specify limits
27908 in kilobytes, megabytes, or gigabytes, respectively.
27909
27910 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
27911 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27912 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
27913 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
27914 ACLs the rate is updated with the total recipient count in one go. Note that
27915 in either case the rate limiting engine will see a message with many
27916 recipients as a large high-speed burst.
27917
27918 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
27919 number of different recipients that the client has sent messages to in the
27920 last time period. That is, if the client repeatedly sends messages to the same
27921 recipient, its measured rate is not increased. This option can only be used in
27922 &%acl_smtp_rcpt%&.
27923
27924 The &%per_cmd%& option causes Exim to recompute the rate every time the
27925 condition is processed. This can be used to limit the rate of any SMTP
27926 command. If it is used in multiple ACLs it can limit the aggregate rate of
27927 multiple different commands.
27928
27929 The &%count=%& option can be used to alter how much Exim adds to the client's
27930 measured rate. For example, the &%per_byte%& option is equivalent to
27931 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
27932 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
27933 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
27934
27935 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
27936
27937
27938 .section "Ratelimit update modes" "ratoptupd"
27939 .cindex "rate limiting" "reading data without updating"
27940 You can specify one of three options with the &%ratelimit%& condition to
27941 control when its database is updated. This section describes the &%readonly%&
27942 mode, and the next section describes the &%strict%& and &%leaky%& modes.
27943
27944 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
27945 previously-computed rate to check against the limit.
27946
27947 For example, you can test the client's sending rate and deny it access (when
27948 it is too fast) in the connect ACL. If the client passes this check then it
27949 can go on to send a message, in which case its recorded rate will be updated
27950 in the MAIL ACL. Subsequent connections from the same client will check this
27951 new rate.
27952 .code
27953 acl_check_connect:
27954  deny ratelimit = 100 / 5m / readonly
27955     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
27956                   (max $sender_rate_limit)
27957 # ...
27958 acl_check_mail:
27959  warn ratelimit = 100 / 5m / strict
27960     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
27961                   (max $sender_rate_limit)
27962 .endd
27963
27964 If Exim encounters multiple &%ratelimit%& conditions with the same key when
27965 processing a message then it may increase the client's measured rate more than
27966 it should. For example, this will happen if you check the &%per_rcpt%& option
27967 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
27968 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
27969 multiple update problems by using the &%readonly%& option on later ratelimit
27970 checks.
27971
27972 The &%per_*%& options described above do not make sense in some ACLs. If you
27973 use a &%per_*%& option in an ACL where it is not normally permitted then the
27974 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
27975 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
27976 next section) so you must specify the &%readonly%& option explicitly.
27977
27978
27979 .section "Ratelimit options for handling fast clients" "ratoptfast"
27980 .cindex "rate limiting" "strict and leaky modes"
27981 If a client's average rate is greater than the maximum, the rate limiting
27982 engine can react in two possible ways, depending on the presence of the
27983 &%strict%& or &%leaky%& update modes. This is independent of the other
27984 counter-measures (such as rejecting the message) that may be specified by the
27985 rest of the ACL.
27986
27987 The &%leaky%& (default) option means that the client's recorded rate is not
27988 updated if it is above the limit. The effect of this is that Exim measures the
27989 client's average rate of successfully sent email, which cannot be greater than
27990 the maximum allowed. If the client is over the limit it may suffer some
27991 counter-measures (as specified in the ACL), but it will still be able to send
27992 email at the configured maximum rate, whatever the rate of its attempts. This
27993 is generally the better choice if you have clients that retry automatically.
27994 For example, it does not prevent a sender with an over-aggressive retry rate
27995 from getting any email through.
27996
27997 The &%strict%& option means that the client's recorded rate is always
27998 updated. The effect of this is that Exim measures the client's average rate
27999 of attempts to send email, which can be much higher than the maximum it is
28000 actually allowed. If the client is over the limit it may be subjected to
28001 counter-measures by the ACL. It must slow down and allow sufficient time to
28002 pass that its computed rate falls below the maximum before it can send email
28003 again. The time (the number of smoothing periods) it must wait and not
28004 attempt to send mail can be calculated with this formula:
28005 .code
28006         ln(peakrate/maxrate)
28007 .endd
28008
28009
28010 .section "Limiting the rate of different events" "ratoptuniq"
28011 .cindex "rate limiting" "counting unique events"
28012 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28013 rate of different events. For example, the &%per_addr%& option uses this
28014 mechanism to count the number of different recipients that the client has
28015 sent messages to in the last time period; it is equivalent to
28016 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28017 measure the rate that a client uses different sender addresses with the
28018 options &`per_mail/unique=$sender_address`&.
28019
28020 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28021 has seen for that key. The whole set is thrown away when it is older than the
28022 rate smoothing period &'p'&, so each different event is counted at most once
28023 per period. In the &%leaky%& update mode, an event that causes the client to
28024 go over the limit is not added to the set, in the same way that the client's
28025 recorded rate is not updated in the same situation.
28026
28027 When you combine the &%unique=%& and &%readonly%& options, the specific
28028 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28029 rate.
28030
28031 The &%unique=%& mechanism needs more space in the ratelimit database than the
28032 other &%ratelimit%& options in order to store the event set. The number of
28033 unique values is potentially as large as the rate limit, so the extra space
28034 required increases with larger limits.
28035
28036 The uniqueification is not perfect: there is a small probability that Exim
28037 will think a new event has happened before. If the sender's rate is less than
28038 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28039 the measured rate can go above the limit, in which case Exim may under-count
28040 events by a significant margin. Fortunately, if the rate is high enough (2.7
28041 times the limit) that the false positive rate goes above 9%, then Exim will
28042 throw away the over-full event set before the measured rate falls below the
28043 limit. Therefore the only harm should be that exceptionally high sending rates
28044 are logged incorrectly; any countermeasures you configure will be as effective
28045 as intended.
28046
28047
28048 .section "Using rate limiting" "useratlim"
28049 Exim's other ACL facilities are used to define what counter-measures are taken
28050 when the rate limit is exceeded. This might be anything from logging a warning
28051 (for example, while measuring existing sending rates in order to define
28052 policy), through time delays to slow down fast senders, up to rejecting the
28053 message. For example:
28054 .code
28055 # Log all senders' rates
28056 warn ratelimit = 0 / 1h / strict
28057      log_message = Sender rate $sender_rate / $sender_rate_period
28058
28059 # Slow down fast senders; note the need to truncate $sender_rate
28060 # at the decimal point.
28061 warn ratelimit = 100 / 1h / per_rcpt / strict
28062      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28063                    $sender_rate_limit }s
28064
28065 # Keep authenticated users under control
28066 deny authenticated = *
28067      ratelimit = 100 / 1d / strict / $authenticated_id
28068
28069 # System-wide rate limit
28070 defer message = Sorry, too busy. Try again later.
28071      ratelimit = 10 / 1s / $primary_hostname
28072
28073 # Restrict incoming rate from each host, with a default
28074 # set using a macro and special cases looked up in a table.
28075 defer message = Sender rate exceeds $sender_rate_limit \
28076                messages per $sender_rate_period
28077      ratelimit = ${lookup {$sender_host_address} \
28078                    cdb {DB/ratelimits.cdb} \
28079                    {$value} {RATELIMIT} }
28080 .endd
28081 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28082 especially with the &%per_rcpt%& option, you may suffer from a performance
28083 bottleneck caused by locking on the ratelimit hints database. Apart from
28084 making your ACLs less complicated, you can reduce the problem by using a
28085 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28086 this means that Exim will lose its hints data after a reboot (including retry
28087 hints, the callout cache, and ratelimit data).
28088
28089
28090
28091 .section "Address verification" "SECTaddressverification"
28092 .cindex "verifying address" "options for"
28093 .cindex "policy control" "address verification"
28094 Several of the &%verify%& conditions described in section
28095 &<<SECTaclconditions>>& cause addresses to be verified. Section
28096 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28097 The verification conditions can be followed by options that modify the
28098 verification process. The options are separated from the keyword and from each
28099 other by slashes, and some of them contain parameters. For example:
28100 .code
28101 verify = sender/callout
28102 verify = recipient/defer_ok/callout=10s,defer_ok
28103 .endd
28104 The first stage of address verification, which always happens, is to run the
28105 address through the routers, in &"verify mode"&. Routers can detect the
28106 difference between verification and routing for delivery, and their actions can
28107 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28108 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28109 The available options are as follows:
28110
28111 .ilist
28112 If the &%callout%& option is specified, successful routing to one or more
28113 remote hosts is followed by a &"callout"& to those hosts as an additional
28114 check. Callouts and their sub-options are discussed in the next section.
28115 .next
28116 If there is a defer error while doing verification routing, the ACL
28117 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28118 options, the condition is forced to be true instead. Note that this is a main
28119 verification option as well as a suboption for callouts.
28120 .next
28121 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28122 discusses the reporting of sender address verification failures.
28123 .next
28124 The &%success_on_redirect%& option causes verification always to succeed
28125 immediately after a successful redirection. By default, if a redirection
28126 generates just one address, that address is also verified. See further
28127 discussion in section &<<SECTredirwhilveri>>&.
28128 .endlist
28129
28130 .cindex "verifying address" "differentiating failures"
28131 .vindex "&$recipient_verify_failure$&"
28132 .vindex "&$sender_verify_failure$&"
28133 .vindex "&$acl_verify_message$&"
28134 After an address verification failure, &$acl_verify_message$& contains the
28135 error message that is associated with the failure. It can be preserved by
28136 coding like this:
28137 .code
28138 warn  !verify = sender
28139        set acl_m0 = $acl_verify_message
28140 .endd
28141 If you are writing your own custom rejection message or log message when
28142 denying access, you can use this variable to include information about the
28143 verification failure.
28144
28145 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28146 appropriate) contains one of the following words:
28147
28148 .ilist
28149 &%qualify%&: The address was unqualified (no domain), and the message
28150 was neither local nor came from an exempted host.
28151 .next
28152 &%route%&: Routing failed.
28153 .next
28154 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28155 occurred at or before the MAIL command (that is, on initial
28156 connection, HELO, or MAIL).
28157 .next
28158 &%recipient%&: The RCPT command in a callout was rejected.
28159 .next
28160 &%postmaster%&: The postmaster check in a callout was rejected.
28161 .endlist
28162
28163 The main use of these variables is expected to be to distinguish between
28164 rejections of MAIL and rejections of RCPT in callouts.
28165
28166
28167
28168
28169 .section "Callout verification" "SECTcallver"
28170 .cindex "verifying address" "by callout"
28171 .cindex "callout" "verification"
28172 .cindex "SMTP" "callout verification"
28173 For non-local addresses, routing verifies the domain, but is unable to do any
28174 checking of the local part. There are situations where some means of verifying
28175 the local part is desirable. One way this can be done is to make an SMTP
28176 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28177 a subsequent host for a recipient address, to see if the host accepts the
28178 address. We use the term &'callout'& to cover both cases. Note that for a
28179 sender address, the callback is not to the client host that is trying to
28180 deliver the message, but to one of the hosts that accepts incoming mail for the
28181 sender's domain.
28182
28183 Exim does not do callouts by default. If you want them to happen, you must
28184 request them by setting appropriate options on the &%verify%& condition, as
28185 described below. This facility should be used with care, because it can add a
28186 lot of resource usage to the cost of verifying an address. However, Exim does
28187 cache the results of callouts, which helps to reduce the cost. Details of
28188 caching are in section &<<SECTcallvercache>>&.
28189
28190 Recipient callouts are usually used only between hosts that are controlled by
28191 the same administration. For example, a corporate gateway host could use
28192 callouts to check for valid recipients on an internal mailserver. A successful
28193 callout does not guarantee that a real delivery to the address would succeed;
28194 on the other hand, a failing callout does guarantee that a delivery would fail.
28195
28196 If the &%callout%& option is present on a condition that verifies an address, a
28197 second stage of verification occurs if the address is successfully routed to
28198 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28199 &(manualroute)& router, where the router specifies the hosts. However, if a
28200 router that does not set up hosts routes to an &(smtp)& transport with a
28201 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28202 &%hosts_override%& set, its hosts are always used, whether or not the router
28203 supplies a host list.
28204
28205 The port that is used is taken from the transport, if it is specified and is a
28206 remote transport. (For routers that do verification only, no transport need be
28207 specified.) Otherwise, the default SMTP port is used. If a remote transport
28208 specifies an outgoing interface, this is used; otherwise the interface is not
28209 specified. Likewise, the text that is used for the HELO command is taken from
28210 the transport's &%helo_data%& option; if there is no transport, the value of
28211 &$smtp_active_hostname$& is used.
28212
28213 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28214 test whether a bounce message could be delivered to the sender address. The
28215 following SMTP commands are sent:
28216 .display
28217 &`HELO `&<&'local host name'&>
28218 &`MAIL FROM:<>`&
28219 &`RCPT TO:`&<&'the address to be tested'&>
28220 &`QUIT`&
28221 .endd
28222 LHLO is used instead of HELO if the transport's &%protocol%& option is
28223 set to &"lmtp"&.
28224
28225 A recipient callout check is similar. By default, it also uses an empty address
28226 for the sender. This default is chosen because most hosts do not make use of
28227 the sender address when verifying a recipient. Using the same address means
28228 that a single cache entry can be used for each recipient. Some sites, however,
28229 do make use of the sender address when verifying. These are catered for by the
28230 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28231
28232 If the response to the RCPT command is a 2&'xx'& code, the verification
28233 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28234 Exim tries the next host, if any. If there is a problem with all the remote
28235 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28236 &%callout%& option is given, in which case the condition is forced to succeed.
28237
28238 .cindex "SMTP" "output flushing, disabling for callout"
28239 A callout may take a little time. For this reason, Exim normally flushes SMTP
28240 output before performing a callout in an ACL, to avoid unexpected timeouts in
28241 clients when the SMTP PIPELINING extension is in use. The flushing can be
28242 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28243
28244
28245
28246
28247 .section "Additional parameters for callouts" "CALLaddparcall"
28248 .cindex "callout" "additional parameters for"
28249 The &%callout%& option can be followed by an equals sign and a number of
28250 optional parameters, separated by commas. For example:
28251 .code
28252 verify = recipient/callout=10s,defer_ok
28253 .endd
28254 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28255 separate verify options, is retained for backwards compatibility, but is now
28256 deprecated. The additional parameters for &%callout%& are as follows:
28257
28258
28259 .vlist
28260 .vitem <&'a&~time&~interval'&>
28261 .cindex "callout" "timeout, specifying"
28262 This specifies the timeout that applies for the callout attempt to each host.
28263 For example:
28264 .code
28265 verify = sender/callout=5s
28266 .endd
28267 The default is 30 seconds. The timeout is used for each response from the
28268 remote host. It is also used for the initial connection, unless overridden by
28269 the &%connect%& parameter.
28270
28271
28272 .vitem &*connect&~=&~*&<&'time&~interval'&>
28273 .cindex "callout" "connection timeout, specifying"
28274 This parameter makes it possible to set a different (usually smaller) timeout
28275 for making the SMTP connection. For example:
28276 .code
28277 verify = sender/callout=5s,connect=1s
28278 .endd
28279 If not specified, this timeout defaults to the general timeout value.
28280
28281 .vitem &*defer_ok*&
28282 .cindex "callout" "defer, action on"
28283 When this parameter is present, failure to contact any host, or any other kind
28284 of temporary error, is treated as success by the ACL. However, the cache is not
28285 updated in this circumstance.
28286
28287 .vitem &*fullpostmaster*&
28288 .cindex "callout" "full postmaster check"
28289 This operates like the &%postmaster%& option (see below), but if the check for
28290 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28291 accordance with the specification in RFC 2821. The RFC states that the
28292 unqualified address &'postmaster'& should be accepted.
28293
28294
28295 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28296 .cindex "callout" "sender when verifying header"
28297 When verifying addresses in header lines using the &%header_sender%&
28298 verification option, Exim behaves by default as if the addresses are envelope
28299 sender addresses from a message. Callout verification therefore tests to see
28300 whether a bounce message could be delivered, by using an empty address in the
28301 MAIL command. However, it is arguable that these addresses might never be used
28302 as envelope senders, and could therefore justifiably reject bounce messages
28303 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28304 address to use in the MAIL command. For example:
28305 .code
28306 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28307 .endd
28308 This parameter is available only for the &%header_sender%& verification option.
28309
28310
28311 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28312 .cindex "callout" "overall timeout, specifying"
28313 This parameter sets an overall timeout for performing a callout verification.
28314 For example:
28315 .code
28316 verify = sender/callout=5s,maxwait=30s
28317 .endd
28318 This timeout defaults to four times the callout timeout for individual SMTP
28319 commands. The overall timeout applies when there is more than one host that can
28320 be tried. The timeout is checked before trying the next host. This prevents
28321 very long delays if there are a large number of hosts and all are timing out
28322 (for example, when network connections are timing out).
28323
28324
28325 .vitem &*no_cache*&
28326 .cindex "callout" "cache, suppressing"
28327 .cindex "caching callout, suppressing"
28328 When this parameter is given, the callout cache is neither read nor updated.
28329
28330 .vitem &*postmaster*&
28331 .cindex "callout" "postmaster; checking"
28332 When this parameter is set, a successful callout check is followed by a similar
28333 check for the local part &'postmaster'& at the same domain. If this address is
28334 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28335 the postmaster check is recorded in a cache record; if it is a failure, this is
28336 used to fail subsequent callouts for the domain without a connection being
28337 made, until the cache record expires.
28338
28339 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
28340 The postmaster check uses an empty sender in the MAIL command by default.
28341 You can use this parameter to do a postmaster check using a different address.
28342 For example:
28343 .code
28344 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
28345 .endd
28346 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
28347 one overrides. The &%postmaster%& parameter is equivalent to this example:
28348 .code
28349 require  verify = sender/callout=postmaster_mailfrom=
28350 .endd
28351 &*Warning*&: The caching arrangements for postmaster checking do not take
28352 account of the sender address. It is assumed that either the empty address or
28353 a fixed non-empty address will be used. All that Exim remembers is that the
28354 postmaster check for the domain succeeded or failed.
28355
28356
28357 .vitem &*random*&
28358 .cindex "callout" "&""random""& check"
28359 When this parameter is set, before doing the normal callout check, Exim does a
28360 check for a &"random"& local part at the same domain. The local part is not
28361 really random &-- it is defined by the expansion of the option
28362 &%callout_random_local_part%&, which defaults to
28363 .code
28364 $primary_hostname-$tod_epoch-testing
28365 .endd
28366 The idea here is to try to determine whether the remote host accepts all local
28367 parts without checking. If it does, there is no point in doing callouts for
28368 specific local parts. If the &"random"& check succeeds, the result is saved in
28369 a cache record, and used to force the current and subsequent callout checks to
28370 succeed without a connection being made, until the cache record expires.
28371
28372 .vitem &*use_postmaster*&
28373 .cindex "callout" "sender for recipient check"
28374 This parameter applies to recipient callouts only. For example:
28375 .code
28376 deny  !verify = recipient/callout=use_postmaster
28377 .endd
28378 .vindex "&$qualify_domain$&"
28379 It causes a non-empty postmaster address to be used in the MAIL command when
28380 performing the callout for the recipient, and also for a &"random"& check if
28381 that is configured. The local part of the address is &`postmaster`& and the
28382 domain is the contents of &$qualify_domain$&.
28383
28384 .vitem &*use_sender*&
28385 This option applies to recipient callouts only. For example:
28386 .code
28387 require  verify = recipient/callout=use_sender
28388 .endd
28389 It causes the message's actual sender address to be used in the MAIL
28390 command when performing the callout, instead of an empty address. There is no
28391 need to use this option unless you know that the called hosts make use of the
28392 sender when checking recipients. If used indiscriminately, it reduces the
28393 usefulness of callout caching.
28394 .endlist
28395
28396 If you use any of the parameters that set a non-empty sender for the MAIL
28397 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
28398 &%use_sender%&), you should think about possible loops. Recipient checking is
28399 usually done between two hosts that are under the same management, and the host
28400 that receives the callouts is not normally configured to do callouts itself.
28401 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
28402 these circumstances.
28403
28404 However, if you use a non-empty sender address for a callout to an arbitrary
28405 host, there is the likelihood that the remote host will itself initiate a
28406 callout check back to your host. As it is checking what appears to be a message
28407 sender, it is likely to use an empty address in MAIL, thus avoiding a
28408 callout loop. However, to be on the safe side it would be best to set up your
28409 own ACLs so that they do not do sender verification checks when the recipient
28410 is the address you use for header sender or postmaster callout checking.
28411
28412 Another issue to think about when using non-empty senders for callouts is
28413 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
28414 by the sender/recipient combination; thus, for any given recipient, many more
28415 actual callouts are performed than when an empty sender or postmaster is used.
28416
28417
28418
28419
28420 .section "Callout caching" "SECTcallvercache"
28421 .cindex "hints database" "callout cache"
28422 .cindex "callout" "cache, description of"
28423 .cindex "caching" "callout"
28424 Exim caches the results of callouts in order to reduce the amount of resources
28425 used, unless you specify the &%no_cache%& parameter with the &%callout%&
28426 option. A hints database called &"callout"& is used for the cache. Two
28427 different record types are used: one records the result of a callout check for
28428 a specific address, and the other records information that applies to the
28429 entire domain (for example, that it accepts the local part &'postmaster'&).
28430
28431 When an original callout fails, a detailed SMTP error message is given about
28432 the failure. However, for subsequent failures use the cache data, this message
28433 is not available.
28434
28435 The expiry times for negative and positive address cache records are
28436 independent, and can be set by the global options &%callout_negative_expire%&
28437 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
28438
28439 If a host gives a negative response to an SMTP connection, or rejects any
28440 commands up to and including
28441 .code
28442 MAIL FROM:<>
28443 .endd
28444 (but not including the MAIL command with a non-empty address),
28445 any callout attempt is bound to fail. Exim remembers such failures in a
28446 domain cache record, which it uses to fail callouts for the domain without
28447 making new connections, until the domain record times out. There are two
28448 separate expiry times for domain cache records:
28449 &%callout_domain_negative_expire%& (default 3h) and
28450 &%callout_domain_positive_expire%& (default 7d).
28451
28452 Domain records expire when the negative expiry time is reached if callouts
28453 cannot be made for the domain, or if the postmaster check failed.
28454 Otherwise, they expire when the positive expiry time is reached. This
28455 ensures that, for example, a host that stops accepting &"random"& local parts
28456 will eventually be noticed.
28457
28458 The callout caching mechanism is based on the domain of the address that is
28459 being tested. If the domain routes to several hosts, it is assumed that their
28460 behaviour will be the same.
28461
28462
28463
28464 .section "Sender address verification reporting" "SECTsenaddver"
28465 .cindex "verifying" "suppressing error details"
28466 See section &<<SECTaddressverification>>& for a general discussion of
28467 verification. When sender verification fails in an ACL, the details of the
28468 failure are given as additional output lines before the 550 response to the
28469 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
28470 you might see:
28471 .code
28472 MAIL FROM:<xyz@abc.example>
28473 250 OK
28474 RCPT TO:<pqr@def.example>
28475 550-Verification failed for <xyz@abc.example>
28476 550-Called:   192.168.34.43
28477 550-Sent:     RCPT TO:<xyz@abc.example>
28478 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
28479 550 Sender verification failed
28480 .endd
28481 If more than one RCPT command fails in the same way, the details are given
28482 only for the first of them. However, some administrators do not want to send
28483 out this much information. You can suppress the details by adding
28484 &`/no_details`& to the ACL statement that requests sender verification. For
28485 example:
28486 .code
28487 verify = sender/no_details
28488 .endd
28489
28490 .section "Redirection while verifying" "SECTredirwhilveri"
28491 .cindex "verifying" "redirection while"
28492 .cindex "address redirection" "while verifying"
28493 A dilemma arises when a local address is redirected by aliasing or forwarding
28494 during verification: should the generated addresses themselves be verified,
28495 or should the successful expansion of the original address be enough to verify
28496 it? By default, Exim takes the following pragmatic approach:
28497
28498 .ilist
28499 When an incoming address is redirected to just one child address, verification
28500 continues with the child address, and if that fails to verify, the original
28501 verification also fails.
28502 .next
28503 When an incoming address is redirected to more than one child address,
28504 verification does not continue. A success result is returned.
28505 .endlist
28506
28507 This seems the most reasonable behaviour for the common use of aliasing as a
28508 way of redirecting different local parts to the same mailbox. It means, for
28509 example, that a pair of alias entries of the form
28510 .code
28511 A.Wol:   aw123
28512 aw123:   :fail: Gone away, no forwarding address
28513 .endd
28514 work as expected, with both local parts causing verification failure. When a
28515 redirection generates more than one address, the behaviour is more like a
28516 mailing list, where the existence of the alias itself is sufficient for
28517 verification to succeed.
28518
28519 It is possible, however, to change the default behaviour so that all successful
28520 redirections count as successful verifications, however many new addresses are
28521 generated. This is specified by the &%success_on_redirect%& verification
28522 option. For example:
28523 .code
28524 require verify = recipient/success_on_redirect/callout=10s
28525 .endd
28526 In this example, verification succeeds if a router generates a new address, and
28527 the callout does not occur, because no address was routed to a remote host.
28528
28529 When verification is being tested via the &%-bv%& option, the treatment of
28530 redirections is as just described, unless the &%-v%& or any debugging option is
28531 also specified. In that case, full verification is done for every generated
28532 address and a report is output for each of them.
28533
28534
28535
28536 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
28537 .cindex "CSA" "verifying"
28538 Client SMTP Authorization is a system that allows a site to advertise
28539 which machines are and are not permitted to send email. This is done by placing
28540 special SRV records in the DNS; these are looked up using the client's HELO
28541 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
28542 Authorization checks in Exim are performed by the ACL condition:
28543 .code
28544 verify = csa
28545 .endd
28546 This fails if the client is not authorized. If there is a DNS problem, or if no
28547 valid CSA SRV record is found, or if the client is authorized, the condition
28548 succeeds. These three cases can be distinguished using the expansion variable
28549 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
28550 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
28551 be likely to cause problems for legitimate email.
28552
28553 The error messages produced by the CSA code include slightly more
28554 detail. If &$csa_status$& is &"defer"&, this may be because of problems
28555 looking up the CSA SRV record, or problems looking up the CSA target
28556 address record. There are four reasons for &$csa_status$& being &"fail"&:
28557
28558 .ilist
28559 The client's host name is explicitly not authorized.
28560 .next
28561 The client's IP address does not match any of the CSA target IP addresses.
28562 .next
28563 The client's host name is authorized but it has no valid target IP addresses
28564 (for example, the target's addresses are IPv6 and the client is using IPv4).
28565 .next
28566 The client's host name has no CSA SRV record but a parent domain has asserted
28567 that all subdomains must be explicitly authorized.
28568 .endlist
28569
28570 The &%csa%& verification condition can take an argument which is the domain to
28571 use for the DNS query. The default is:
28572 .code
28573 verify = csa/$sender_helo_name
28574 .endd
28575 This implementation includes an extension to CSA. If the query domain
28576 is an address literal such as [192.0.2.95], or if it is a bare IP
28577 address, Exim searches for CSA SRV records in the reverse DNS as if
28578 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
28579 meaningful to say:
28580 .code
28581 verify = csa/$sender_host_address
28582 .endd
28583 In fact, this is the check that Exim performs if the client does not say HELO.
28584 This extension can be turned off by setting the main configuration option
28585 &%dns_csa_use_reverse%& to be false.
28586
28587 If a CSA SRV record is not found for the domain itself, a search
28588 is performed through its parent domains for a record which might be
28589 making assertions about subdomains. The maximum depth of this search is limited
28590 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
28591 default. Exim does not look for CSA SRV records in a top level domain, so the
28592 default settings handle HELO domains as long as seven
28593 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
28594 of legitimate HELO domains.
28595
28596 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
28597 direct SRV lookups, this is not sufficient because of the extra parent domain
28598 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
28599 addresses into lookups in the reverse DNS space. The result of a successful
28600 lookup such as:
28601 .code
28602 ${lookup dnsdb {csa=$sender_helo_name}}
28603 .endd
28604 has two space-separated fields: an authorization code and a target host name.
28605 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
28606 authorization required but absent, or &"?"& for unknown.
28607
28608
28609
28610
28611 .section "Bounce address tag validation" "SECTverifyPRVS"
28612 .cindex "BATV, verifying"
28613 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
28614 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
28615 Genuine incoming bounce messages should therefore always be addressed to
28616 recipients that have a valid tag. This scheme is a way of detecting unwanted
28617 bounce messages caused by sender address forgeries (often called &"collateral
28618 spam"&), because the recipients of such messages do not include valid tags.
28619
28620 There are two expansion items to help with the implementation of the BATV
28621 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
28622 the original envelope sender address by using a simple key to add a hash of the
28623 address and some time-based randomizing information. The &%prvs%& expansion
28624 item creates a signed address, and the &%prvscheck%& expansion item checks one.
28625 The syntax of these expansion items is described in section
28626 &<<SECTexpansionitems>>&.
28627
28628 As an example, suppose the secret per-address keys are stored in an MySQL
28629 database. A query to look up the key for an address could be defined as a macro
28630 like this:
28631 .code
28632 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
28633                 WHERE sender='${quote_mysql:$prvscheck_address}'\
28634                 }{$value}}
28635 .endd
28636 Suppose also that the senders who make use of BATV are defined by an address
28637 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
28638 use this:
28639 .code
28640 # Bounces: drop unsigned addresses for BATV senders
28641 deny message = This address does not send an unsigned reverse path
28642      senders = :
28643      recipients = +batv_senders
28644
28645 # Bounces: In case of prvs-signed address, check signature.
28646 deny message = Invalid reverse path signature.
28647      senders = :
28648      condition  = ${prvscheck {$local_part@$domain}\
28649                   {PRVSCHECK_SQL}{1}}
28650      !condition = $prvscheck_result
28651 .endd
28652 The first statement rejects recipients for bounce messages that are addressed
28653 to plain BATV sender addresses, because it is known that BATV senders do not
28654 send out messages with plain sender addresses. The second statement rejects
28655 recipients that are prvs-signed, but with invalid signatures (either because
28656 the key is wrong, or the signature has timed out).
28657
28658 A non-prvs-signed address is not rejected by the second statement, because the
28659 &%prvscheck%& expansion yields an empty string if its first argument is not a
28660 prvs-signed address, thus causing the &%condition%& condition to be false. If
28661 the first argument is a syntactically valid prvs-signed address, the yield is
28662 the third string (in this case &"1"&), whether or not the cryptographic and
28663 timeout checks succeed. The &$prvscheck_result$& variable contains the result
28664 of the checks (empty for failure, &"1"& for success).
28665
28666 There is one more issue you must consider when implementing prvs-signing:
28667 you have to ensure that the routers accept prvs-signed addresses and
28668 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
28669 router to remove the signature with a configuration along these lines:
28670 .code
28671 batv_redirect:
28672   driver = redirect
28673   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
28674 .endd
28675 This works because, if the third argument of &%prvscheck%& is empty, the result
28676 of the expansion of a prvs-signed address is the decoded value of the original
28677 address. This router should probably be the first of your routers that handles
28678 local addresses.
28679
28680 To create BATV-signed addresses in the first place, a transport of this form
28681 can be used:
28682 .code
28683 external_smtp_batv:
28684   driver = smtp
28685   return_path = ${prvs {$return_path} \
28686                        {${lookup mysql{SELECT \
28687                        secret FROM batv_prvs WHERE \
28688                        sender='${quote_mysql:$sender_address}'} \
28689                        {$value}fail}}}
28690 .endd
28691 If no key can be found for the existing return path, no signing takes place.
28692
28693
28694
28695 .section "Using an ACL to control relaying" "SECTrelaycontrol"
28696 .cindex "&ACL;" "relay control"
28697 .cindex "relaying" "control by ACL"
28698 .cindex "policy control" "relay control"
28699 An MTA is said to &'relay'& a message if it receives it from some host and
28700 delivers it directly to another host as a result of a remote address contained
28701 within it. Redirecting a local address via an alias or forward file and then
28702 passing the message on to another host is not relaying,
28703 .cindex "&""percent hack""&"
28704 but a redirection as a result of the &"percent hack"& is.
28705
28706 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
28707 A host which is acting as a gateway or an MX backup is concerned with incoming
28708 relaying from arbitrary hosts to a specific set of domains. On the other hand,
28709 a host which is acting as a smart host for a number of clients is concerned
28710 with outgoing relaying from those clients to the Internet at large. Often the
28711 same host is fulfilling both functions,
28712 . ///
28713 . as illustrated in the diagram below,
28714 . ///
28715 but in principle these two kinds of relaying are entirely independent. What is
28716 not wanted is the transmission of mail from arbitrary remote hosts through your
28717 system to arbitrary domains.
28718
28719
28720 You can implement relay control by means of suitable statements in the ACL that
28721 runs for each RCPT command. For convenience, it is often easiest to use
28722 Exim's named list facility to define the domains and hosts involved. For
28723 example, suppose you want to do the following:
28724
28725 .ilist
28726 Deliver a number of domains to mailboxes on the local host (or process them
28727 locally in some other way). Let's say these are &'my.dom1.example'& and
28728 &'my.dom2.example'&.
28729 .next
28730 Relay mail for a number of other domains for which you are the secondary MX.
28731 These might be &'friend1.example'& and &'friend2.example'&.
28732 .next
28733 Relay mail from the hosts on your local LAN, to whatever domains are involved.
28734 Suppose your LAN is 192.168.45.0/24.
28735 .endlist
28736
28737
28738 In the main part of the configuration, you put the following definitions:
28739 .code
28740 domainlist local_domains = my.dom1.example : my.dom2.example
28741 domainlist relay_domains = friend1.example : friend2.example
28742 hostlist   relay_hosts   = 192.168.45.0/24
28743 .endd
28744 Now you can use these definitions in the ACL that is run for every RCPT
28745 command:
28746 .code
28747 acl_check_rcpt:
28748   accept domains = +local_domains : +relay_domains
28749   accept hosts   = +relay_hosts
28750 .endd
28751 The first statement accepts any RCPT command that contains an address in
28752 the local or relay domains. For any other domain, control passes to the second
28753 statement, which accepts the command only if it comes from one of the relay
28754 hosts. In practice, you will probably want to make your ACL more sophisticated
28755 than this, for example, by including sender and recipient verification. The
28756 default configuration includes a more comprehensive example, which is described
28757 in chapter &<<CHAPdefconfil>>&.
28758
28759
28760
28761 .section "Checking a relay configuration" "SECTcheralcon"
28762 .cindex "relaying" "checking control of"
28763 You can check the relay characteristics of your configuration in the same way
28764 that you can test any ACL behaviour for an incoming SMTP connection, by using
28765 the &%-bh%& option to run a fake SMTP session with which you interact.
28766
28767 For specifically testing for unwanted relaying, the host
28768 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
28769 host from the host on which Exim is running, using the normal telnet port, you
28770 will see a normal telnet connection message and then quite a long delay. Be
28771 patient. The remote host is making an SMTP connection back to your host, and
28772 trying a number of common probes to test for open relay vulnerability. The
28773 results of the tests will eventually appear on your terminal.
28774 .ecindex IIDacl
28775
28776
28777
28778 . ////////////////////////////////////////////////////////////////////////////
28779 . ////////////////////////////////////////////////////////////////////////////
28780
28781 .chapter "Content scanning at ACL time" "CHAPexiscan"
28782 .scindex IIDcosca "content scanning" "at ACL time"
28783 The extension of Exim to include content scanning at ACL time, formerly known
28784 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
28785 was integrated into the main source for Exim release 4.50, and Tom continues to
28786 maintain it. Most of the wording of this chapter is taken from Tom's
28787 specification.
28788
28789 It is also possible to scan the content of messages at other times. The
28790 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
28791 scanning after all the ACLs have run. A transport filter can be used to scan
28792 messages at delivery time (see the &%transport_filter%& option, described in
28793 chapter &<<CHAPtransportgeneric>>&).
28794
28795 If you want to include the ACL-time content-scanning features when you compile
28796 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
28797 &_Local/Makefile_&. When you do that, the Exim binary is built with:
28798
28799 .ilist
28800 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
28801 for all MIME parts for SMTP and non-SMTP messages, respectively.
28802 .next
28803 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
28804 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
28805 run at the end of message reception (the &%acl_smtp_data%& ACL).
28806 .next
28807 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
28808 of messages, or parts of messages, for debugging purposes.
28809 .next
28810 Additional expansion variables that are set in the new ACL and by the new
28811 conditions.
28812 .next
28813 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
28814 .endlist
28815
28816 There is another content-scanning configuration option for &_Local/Makefile_&,
28817 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
28818 condition is compiled, in addition to all the other content-scanning features.
28819
28820 Content-scanning is continually evolving, and new features are still being
28821 added. While such features are still unstable and liable to incompatible
28822 changes, they are made available in Exim by setting options whose names begin
28823 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
28824 this manual. You can find out about them by reading the file called
28825 &_doc/experimental.txt_&.
28826
28827 All the content-scanning facilities work on a MBOX copy of the message that is
28828 temporarily created in a file called:
28829 .display
28830 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
28831 .endd
28832 The &_.eml_& extension is a friendly hint to virus scanners that they can
28833 expect an MBOX-like structure inside that file. The file is created when the
28834 first content scanning facility is called. Subsequent calls to content
28835 scanning conditions open the same file again. The directory is recursively
28836 removed when the &%acl_smtp_data%& ACL has finished running, unless
28837 .code
28838 control = no_mbox_unspool
28839 .endd
28840 has been encountered. When the MIME ACL decodes files, they are put into the
28841 same directory by default.
28842
28843
28844
28845 .section "Scanning for viruses" "SECTscanvirus"
28846 .cindex "virus scanning"
28847 .cindex "content scanning" "for viruses"
28848 .cindex "content scanning" "the &%malware%& condition"
28849 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
28850 It supports a &"generic"& interface to scanners called via the shell, and
28851 specialized interfaces for &"daemon"& type virus scanners, which are resident
28852 in memory and thus are much faster.
28853
28854
28855 .oindex "&%av_scanner%&"
28856 You can set the &%av_scanner%& option in first part of the Exim configuration
28857 file to specify which scanner to use, together with any additional options that
28858 are needed. The basic syntax is as follows:
28859 .display
28860 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28861 .endd
28862 If you do not set &%av_scanner%&, it defaults to
28863 .code
28864 av_scanner = sophie:/var/run/sophie
28865 .endd
28866 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28867 before use. The following scanner types are supported in this release:
28868
28869 .vlist
28870 .vitem &%aveserver%&
28871 .cindex "virus scanners" "Kaspersky"
28872 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28873 at &url(http://www.kaspersky.com). This scanner type takes one option,
28874 which is the path to the daemon's UNIX socket. The default is shown in this
28875 example:
28876 .code
28877 av_scanner = aveserver:/var/run/aveserver
28878 .endd
28879
28880
28881 .vitem &%clamd%&
28882 .cindex "virus scanners" "clamd"
28883 This daemon-type scanner is GPL and free. You can get it at
28884 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28885 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28886 in the MIME ACL. This no longer believed to be necessary. One option is
28887 required: either the path and name of a UNIX socket file, or a hostname or IP
28888 number, and a port, separated by space, as in the second of these examples:
28889 .code
28890 av_scanner = clamd:/opt/clamd/socket
28891 av_scanner = clamd:192.0.2.3 1234
28892 av_scanner = clamd:192.0.2.3 1234:local
28893 .endd
28894 If the value of av_scanner points to a UNIX socket file or contains the local
28895 keyword, then the ClamAV interface will pass a filename containing the data
28896 to be scanned, which will should normally result in less I/O happening and be
28897 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28898 Exim does not assume that there is a common filesystem with the remote host.
28899 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28900 you be running a version of ClamAV prior to 0.95.
28901 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28902 contributing the code for this scanner.
28903
28904 .vitem &%cmdline%&
28905 .cindex "virus scanners" "command line interface"
28906 This is the keyword for the generic command line scanner interface. It can be
28907 used to attach virus scanners that are invoked from the shell. This scanner
28908 type takes 3 mandatory options:
28909
28910 .olist
28911 The full path and name of the scanner binary, with all command line options,
28912 and a placeholder (&`%s`&) for the directory to scan.
28913
28914 .next
28915 A regular expression to match against the STDOUT and STDERR output of the
28916 virus scanner. If the expression matches, a virus was found. You must make
28917 absolutely sure that this expression matches on &"virus found"&. This is called
28918 the &"trigger"& expression.
28919
28920 .next
28921 Another regular expression, containing exactly one pair of parentheses, to
28922 match the name of the virus found in the scanners output. This is called the
28923 &"name"& expression.
28924 .endlist olist
28925
28926 For example, Sophos Sweep reports a virus on a line like this:
28927 .code
28928 Virus 'W32/Magistr-B' found in file ./those.bat
28929 .endd
28930 For the trigger expression, we can match the phrase &"found in file"&. For the
28931 name expression, we want to extract the W32/Magistr-B string, so we can match
28932 for the single quotes left and right of it. Altogether, this makes the
28933 configuration setting:
28934 .code
28935 av_scanner = cmdline:\
28936              /path/to/sweep -ss -all -rec -archive %s:\
28937              found in file:'(.+)'
28938 .endd
28939 .vitem &%drweb%&
28940 .cindex "virus scanners" "DrWeb"
28941 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28942 argument, either a full path to a UNIX socket, or an IP address and port
28943 separated by white space, as in these examples:
28944 .code
28945 av_scanner = drweb:/var/run/drwebd.sock
28946 av_scanner = drweb:192.168.2.20 31337
28947 .endd
28948 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28949 is used. Thanks to Alex Miller for contributing the code for this scanner.
28950
28951 .vitem &%fsecure%&
28952 .cindex "virus scanners" "F-Secure"
28953 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28954 argument which is the path to a UNIX socket. For example:
28955 .code
28956 av_scanner = fsecure:/path/to/.fsav
28957 .endd
28958 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28959 Thelmen for contributing the code for this scanner.
28960
28961 .vitem &%kavdaemon%&
28962 .cindex "virus scanners" "Kaspersky"
28963 This is the scanner daemon of Kaspersky Version 4. This version of the
28964 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28965 scanner type takes one option, which is the path to the daemon's UNIX socket.
28966 For example:
28967 .code
28968 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28969 .endd
28970 The default path is &_/var/run/AvpCtl_&.
28971
28972 .vitem &%mksd%&
28973 .cindex "virus scanners" "mksd"
28974 This is a daemon type scanner that is aimed mainly at Polish users, though some
28975 parts of documentation are now available in English. You can get it at
28976 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28977 the maximum number of processes used simultaneously to scan the attachments,
28978 provided that the demime facility is employed and also provided that mksd has
28979 been run with at least the same number of child processes. For example:
28980 .code
28981 av_scanner = mksd:2
28982 .endd
28983 You can safely omit this option (the default value is 1).
28984
28985 .vitem &%sophie%&
28986 .cindex "virus scanners" "Sophos and Sophie"
28987 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28988 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28989 for this scanner type is the path to the UNIX socket that Sophie uses for
28990 client communication. For example:
28991 .code
28992 av_scanner = sophie:/tmp/sophie
28993 .endd
28994 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28995 the option.
28996 .endlist
28997
28998 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28999 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29000 ACL.
29001
29002 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29003 makes it possible to use different scanners. See further below for an example.
29004 The &%malware%& condition caches its results, so when you use it multiple times
29005 for the same message, the actual scanning process is only carried out once.
29006 However, using expandable items in &%av_scanner%& disables this caching, in
29007 which case each use of the &%malware%& condition causes a new scan of the
29008 message.
29009
29010 The &%malware%& condition takes a right-hand argument that is expanded before
29011 use. It can then be one of
29012
29013 .ilist
29014 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29015 The condition succeeds if a virus was found, and fail otherwise. This is the
29016 recommended usage.
29017 .next
29018 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29019 the condition fails immediately.
29020 .next
29021 A regular expression, in which case the message is scanned for viruses. The
29022 condition succeeds if a virus is found and its name matches the regular
29023 expression. This allows you to take special actions on certain types of virus.
29024 .endlist
29025
29026 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29027 even if there is a problem with the virus scanner. Otherwise, such a problem
29028 causes the ACL to defer.
29029
29030 .vindex "&$malware_name$&"
29031 When a virus is found, the condition sets up an expansion variable called
29032 &$malware_name$& that contains the name of the virus. You can use it in a
29033 &%message%& modifier that specifies the error returned to the sender, and/or in
29034 logging data.
29035
29036 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29037 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29038 &%malware%& condition.
29039
29040 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29041 imposed by your anti-virus scanner.
29042
29043 Here is a very simple scanning example:
29044 .code
29045 deny message = This message contains malware ($malware_name)
29046      demime = *
29047      malware = *
29048 .endd
29049 The next example accepts messages when there is a problem with the scanner:
29050 .code
29051 deny message = This message contains malware ($malware_name)
29052      demime = *
29053      malware = */defer_ok
29054 .endd
29055 The next example shows how to use an ACL variable to scan with both sophie and
29056 aveserver. It assumes you have set:
29057 .code
29058 av_scanner = $acl_m0
29059 .endd
29060 in the main Exim configuration.
29061 .code
29062 deny message = This message contains malware ($malware_name)
29063      set acl_m0 = sophie
29064      malware = *
29065
29066 deny message = This message contains malware ($malware_name)
29067      set acl_m0 = aveserver
29068      malware = *
29069 .endd
29070
29071
29072 .section "Scanning with SpamAssassin" "SECTscanspamass"
29073 .cindex "content scanning" "for spam"
29074 .cindex "spam scanning"
29075 .cindex "SpamAssassin"
29076 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29077 score and a report for the message. You can get SpamAssassin at
29078 &url(http://www.spamassassin.org), or, if you have a working Perl
29079 installation, you can use CPAN by running:
29080 .code
29081 perl -MCPAN -e 'install Mail::SpamAssassin'
29082 .endd
29083 SpamAssassin has its own set of configuration files. Please review its
29084 documentation to see how you can tweak it. The default installation should work
29085 nicely, however.
29086
29087 .oindex "&%spamd_address%&"
29088 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29089 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29090 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29091 part of the Exim configuration as follows (example):
29092 .code
29093 spamd_address = 192.168.99.45 387
29094 .endd
29095 You do not need to set this option if you use the default. As of version 2.60,
29096 &%spamd%& also supports communication over UNIX sockets. If you want to use
29097 these, supply &%spamd_address%& with an absolute file name instead of a
29098 address/port pair:
29099 .code
29100 spamd_address = /var/run/spamd_socket
29101 .endd
29102 You can have multiple &%spamd%& servers to improve scalability. These can
29103 reside on other hardware reachable over the network. To specify multiple
29104 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29105 option, separated with colons:
29106 .code
29107 spamd_address = 192.168.2.10 783 : \
29108                 192.168.2.11 783 : \
29109                 192.168.2.12 783
29110 .endd
29111 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29112 fashion. When a server fails to respond to the connection attempt, all other
29113 servers are tried until one succeeds. If no server responds, the &%spam%&
29114 condition defers.
29115
29116 &*Warning*&: It is not possible to use the UNIX socket connection method with
29117 multiple &%spamd%& servers.
29118
29119 The &%spamd_address%& variable is expanded before use if it starts with
29120 a dollar sign. In this case, the expansion may return a string that is
29121 used as the list so that multiple spamd servers can be the result of an
29122 expansion.
29123
29124 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29125 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29126 .code
29127 deny message = This message was classified as SPAM
29128      spam = joe
29129 .endd
29130 The right-hand side of the &%spam%& condition specifies a name. This is
29131 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29132 to scan using a specific profile, but rather use the SpamAssassin system-wide
29133 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29134 However, you must put something on the right-hand side.
29135
29136 The name allows you to use per-domain or per-user antispam profiles in
29137 principle, but this is not straightforward in practice, because a message may
29138 have multiple recipients, not necessarily all in the same domain. Because the
29139 &%spam%& condition has to be called from a DATA ACL in order to be able to
29140 read the contents of the message, the variables &$local_part$& and &$domain$&
29141 are not set.
29142
29143 The right-hand side of the &%spam%& condition is expanded before being used, so
29144 you can put lookups or conditions there. When the right-hand side evaluates to
29145 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29146
29147
29148 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29149 large ones may cause significant performance degradation. As most spam messages
29150 are quite small, it is recommended that you do not scan the big ones. For
29151 example:
29152 .code
29153 deny message = This message was classified as SPAM
29154      condition = ${if < {$message_size}{10K}}
29155      spam = nobody
29156 .endd
29157
29158 The &%spam%& condition returns true if the threshold specified in the user's
29159 SpamAssassin profile has been matched or exceeded. If you want to use the
29160 &%spam%& condition for its side effects (see the variables below), you can make
29161 it always return &"true"& by appending &`:true`& to the username.
29162
29163 .cindex "spam scanning" "returned variables"
29164 When the &%spam%& condition is run, it sets up a number of expansion
29165 variables. These variables are saved with the received message, thus they are
29166 available for use at delivery time.
29167
29168 .vlist
29169 .vitem &$spam_score$&
29170 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29171 for inclusion in log or reject messages.
29172
29173 .vitem &$spam_score_int$&
29174 The spam score of the message, multiplied by ten, as an integer value. For
29175 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29176 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29177 The integer value is useful for numeric comparisons in conditions.
29178
29179 .vitem &$spam_bar$&
29180 A string consisting of a number of &"+"& or &"-"& characters, representing the
29181 integer part of the spam score value. A spam score of 4.4 would have a
29182 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29183 headers, since MUAs can match on such strings.
29184
29185 .vitem &$spam_report$&
29186 A multiline text table, containing the full SpamAssassin report for the
29187 message. Useful for inclusion in headers or reject messages.
29188 .endlist
29189
29190 The &%spam%& condition caches its results unless expansion in
29191 spamd_address was used. If you call it again with the same user name, it
29192 does not scan again, but rather returns the same values as before.
29193
29194 The &%spam%& condition returns DEFER if there is any error while running
29195 the message through SpamAssassin or if the expansion of spamd_address
29196 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29197 statement block), append &`/defer_ok`& to the right-hand side of the
29198 spam condition, like this:
29199 .code
29200 deny message = This message was classified as SPAM
29201      spam    = joe/defer_ok
29202 .endd
29203 This causes messages to be accepted even if there is a problem with &%spamd%&.
29204
29205 Here is a longer, commented example of the use of the &%spam%&
29206 condition:
29207 .code
29208 # put headers in all messages (no matter if spam or not)
29209 warn  spam = nobody:true
29210       add_header = X-Spam-Score: $spam_score ($spam_bar)
29211       add_header = X-Spam-Report: $spam_report
29212
29213 # add second subject line with *SPAM* marker when message
29214 # is over threshold
29215 warn  spam = nobody
29216       add_header = Subject: *SPAM* $h_Subject:
29217
29218 # reject spam at high scores (> 12)
29219 deny  message = This message scored $spam_score spam points.
29220       spam = nobody:true
29221       condition = ${if >{$spam_score_int}{120}{1}{0}}
29222 .endd
29223
29224
29225
29226 .section "Scanning MIME parts" "SECTscanmimepart"
29227 .cindex "content scanning" "MIME parts"
29228 .cindex "MIME content scanning"
29229 .oindex "&%acl_smtp_mime%&"
29230 .oindex "&%acl_not_smtp_mime%&"
29231 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29232 each MIME part of an SMTP message, including multipart types, in the sequence
29233 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29234 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29235 options may both refer to the same ACL if you want the same processing in both
29236 cases.
29237
29238 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29239 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29240 the case of a non-SMTP message. However, a MIME ACL is called only if the
29241 message contains a &'Content-Type:'& header line. When a call to a MIME
29242 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29243 result code is sent to the client. In the case of an SMTP message, the
29244 &%acl_smtp_data%& ACL is not called when this happens.
29245
29246 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29247 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29248 condition to match against the raw MIME part. You can also use the
29249 &%mime_regex%& condition to match against the decoded MIME part (see section
29250 &<<SECTscanregex>>&).
29251
29252 At the start of a MIME ACL, a number of variables are set from the header
29253 information for the relevant MIME part. These are described below. The contents
29254 of the MIME part are not by default decoded into a disk file except for MIME
29255 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29256 part into a disk file, you can use the &%decode%& condition. The general
29257 syntax is:
29258 .display
29259 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29260 .endd
29261 The right hand side is expanded before use. After expansion,
29262 the value can be:
29263
29264 .olist
29265 &"0"& or &"false"&, in which case no decoding is done.
29266 .next
29267 The string &"default"&. In that case, the file is put in the temporary
29268 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29269 a sequential file name consisting of the message id and a sequence number. The
29270 full path and name is available in &$mime_decoded_filename$& after decoding.
29271 .next
29272 A full path name starting with a slash. If the full name is an existing
29273 directory, it is used as a replacement for the default directory. The filename
29274 is then sequentially assigned. If the path does not exist, it is used as
29275 the full path and file name.
29276 .next
29277 If the string does not start with a slash, it is used as the
29278 filename, and the default path is then used.
29279 .endlist
29280 The &%decode%& condition normally succeeds. It is only false for syntax
29281 errors or unusual circumstances such as memory shortages. You can easily decode
29282 a file with its original, proposed filename using
29283 .code
29284 decode = $mime_filename
29285 .endd
29286 However, you should keep in mind that &$mime_filename$& might contain
29287 anything. If you place files outside of the default path, they are not
29288 automatically unlinked.
29289
29290 For RFC822 attachments (these are messages attached to messages, with a
29291 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29292 as for the primary message, only that the &$mime_is_rfc822$& expansion
29293 variable is set (see below). Attached messages are always decoded to disk
29294 before being checked, and the files are unlinked once the check is done.
29295
29296 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29297 used to match regular expressions against raw and decoded MIME parts,
29298 respectively. They are described in section &<<SECTscanregex>>&.
29299
29300 .cindex "MIME content scanning" "returned variables"
29301 The following list describes all expansion variables that are
29302 available in the MIME ACL:
29303
29304 .vlist
29305 .vitem &$mime_boundary$&
29306 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29307 have a boundary string, which is stored in this variable. If the current part
29308 has no boundary parameter in the &'Content-Type:'& header, this variable
29309 contains the empty string.
29310
29311 .vitem &$mime_charset$&
29312 This variable contains the character set identifier, if one was found in the
29313 &'Content-Type:'& header. Examples for charset identifiers are:
29314 .code
29315 us-ascii
29316 gb2312 (Chinese)
29317 iso-8859-1
29318 .endd
29319 Please note that this value is not normalized, so you should do matches
29320 case-insensitively.
29321
29322 .vitem &$mime_content_description$&
29323 This variable contains the normalized content of the &'Content-Description:'&
29324 header. It can contain a human-readable description of the parts content. Some
29325 implementations repeat the filename for attachments here, but they are usually
29326 only used for display purposes.
29327
29328 .vitem &$mime_content_disposition$&
29329 This variable contains the normalized content of the &'Content-Disposition:'&
29330 header. You can expect strings like &"attachment"& or &"inline"& here.
29331
29332 .vitem &$mime_content_id$&
29333 This variable contains the normalized content of the &'Content-ID:'& header.
29334 This is a unique ID that can be used to reference a part from another part.
29335
29336 .vitem &$mime_content_size$&
29337 This variable is set only after the &%decode%& modifier (see above) has been
29338 successfully run. It contains the size of the decoded part in kilobytes. The
29339 size is always rounded up to full kilobytes, so only a completely empty part
29340 has a &$mime_content_size$& of zero.
29341
29342 .vitem &$mime_content_transfer_encoding$&
29343 This variable contains the normalized content of the
29344 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
29345 type. Typical values are &"base64"& and &"quoted-printable"&.
29346
29347 .vitem &$mime_content_type$&
29348 If the MIME part has a &'Content-Type:'& header, this variable contains its
29349 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
29350 are some examples of popular MIME types, as they may appear in this variable:
29351 .code
29352 text/plain
29353 text/html
29354 application/octet-stream
29355 image/jpeg
29356 audio/midi
29357 .endd
29358 If the MIME part has no &'Content-Type:'& header, this variable contains the
29359 empty string.
29360
29361 .vitem &$mime_decoded_filename$&
29362 This variable is set only after the &%decode%& modifier (see above) has been
29363 successfully run. It contains the full path and file name of the file
29364 containing the decoded data.
29365 .endlist
29366
29367 .cindex "RFC 2047"
29368 .vlist
29369 .vitem &$mime_filename$&
29370 This is perhaps the most important of the MIME variables. It contains a
29371 proposed filename for an attachment, if one was found in either the
29372 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
29373 RFC2047 decoded, but no additional sanity checks are done. If no filename was
29374 found, this variable contains the empty string.
29375
29376 .vitem &$mime_is_coverletter$&
29377 This variable attempts to differentiate the &"cover letter"& of an e-mail from
29378 attached data. It can be used to clamp down on flashy or unnecessarily encoded
29379 content in the cover letter, while not restricting attachments at all.
29380
29381 The variable contains 1 (true) for a MIME part believed to be part of the
29382 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
29383 follows:
29384
29385 .olist
29386 The outermost MIME part of a message is always a cover letter.
29387
29388 .next
29389 If a multipart/alternative or multipart/related MIME part is a cover letter,
29390 so are all MIME subparts within that multipart.
29391
29392 .next
29393 If any other multipart is a cover letter, the first subpart is a cover letter,
29394 and the rest are attachments.
29395
29396 .next
29397 All parts contained within an attachment multipart are attachments.
29398 .endlist olist
29399
29400 As an example, the following will ban &"HTML mail"& (including that sent with
29401 alternative plain text), while allowing HTML files to be attached. HTML
29402 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
29403 .code
29404 deny message = HTML mail is not accepted here
29405 !condition = $mime_is_rfc822
29406 condition = $mime_is_coverletter
29407 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
29408 .endd
29409 .vitem &$mime_is_multipart$&
29410 This variable has the value 1 (true) when the current part has the main type
29411 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
29412 Since multipart entities only serve as containers for other parts, you may not
29413 want to carry out specific actions on them.
29414
29415 .vitem &$mime_is_rfc822$&
29416 This variable has the value 1 (true) if the current part is not a part of the
29417 checked message itself, but part of an attached message. Attached message
29418 decoding is fully recursive.
29419
29420 .vitem &$mime_part_count$&
29421 This variable is a counter that is raised for each processed MIME part. It
29422 starts at zero for the very first part (which is usually a multipart). The
29423 counter is per-message, so it is reset when processing RFC822 attachments (see
29424 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
29425 complete, so you can use it in the DATA ACL to determine the number of MIME
29426 parts of a message. For non-MIME messages, this variable contains the value -1.
29427 .endlist
29428
29429
29430
29431 .section "Scanning with regular expressions" "SECTscanregex"
29432 .cindex "content scanning" "with regular expressions"
29433 .cindex "regular expressions" "content scanning with"
29434 You can specify your own custom regular expression matches on the full body of
29435 the message, or on individual MIME parts.
29436
29437 The &%regex%& condition takes one or more regular expressions as arguments and
29438 matches them against the full message (when called in the DATA ACL) or a raw
29439 MIME part (when called in the MIME ACL). The &%regex%& condition matches
29440 linewise, with a maximum line length of 32K characters. That means you cannot
29441 have multiline matches with the &%regex%& condition.
29442
29443 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
29444 to 32K of decoded content (the whole content at once, not linewise). If the
29445 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
29446 is decoded automatically when &%mime_regex%& is executed (using default path
29447 and filename values). If the decoded data is larger than  32K, only the first
29448 32K characters are checked.
29449
29450 The regular expressions are passed as a colon-separated list. To include a
29451 literal colon, you must double it. Since the whole right-hand side string is
29452 expanded before being used, you must also escape dollar signs and backslashes
29453 with more backslashes, or use the &`\N`& facility to disable expansion.
29454 Here is a simple example that contains two regular expressions:
29455 .code
29456 deny message = contains blacklisted regex ($regex_match_string)
29457      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
29458 .endd
29459 The conditions returns true if any one of the regular expressions matches. The
29460 &$regex_match_string$& expansion variable is then set up and contains the
29461 matching regular expression.
29462
29463 &*Warning*&: With large messages, these conditions can be fairly
29464 CPU-intensive.
29465
29466
29467
29468
29469 .section "The demime condition" "SECTdemimecond"
29470 .cindex "content scanning" "MIME checking"
29471 .cindex "MIME content scanning"
29472 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
29473 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
29474 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
29475 ACL functionality, but provides no additional facilities. Please note that this
29476 condition is deprecated and kept only for backward compatibility. You must set
29477 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
29478 use the &%demime%& condition.
29479
29480 The &%demime%& condition unpacks MIME containers in the message. It detects
29481 errors in MIME containers and can match file extensions found in the message
29482 against a list. Using this facility produces files containing the unpacked MIME
29483 parts of the message in the temporary scan directory. If you do antivirus
29484 scanning, it is recommended that you use the &%demime%& condition before the
29485 antivirus (&%malware%&) condition.
29486
29487 On the right-hand side of the &%demime%& condition you can pass a
29488 colon-separated list of file extensions that it should match against. For
29489 example:
29490 .code
29491 deny message = Found blacklisted file attachment
29492      demime  = vbs:com:bat:pif:prf:lnk
29493 .endd
29494 If one of the file extensions is found, the condition is true, otherwise it is
29495 false. If there is a temporary error while demimeing (for example, &"disk
29496 full"&), the condition defers, and the message is temporarily rejected (unless
29497 the condition is on a &%warn%& verb).
29498
29499 The right-hand side is expanded before being treated as a list, so you can have
29500 conditions and lookups there. If it expands to an empty string, &"false"&, or
29501 zero (&"0"&), no demimeing is done and the condition is false.
29502
29503 The &%demime%& condition set the following variables:
29504
29505 .vlist
29506 .vitem &$demime_errorlevel$&
29507 .vindex "&$demime_errorlevel$&"
29508 When an error is detected in a MIME container, this variable contains the
29509 severity of the error, as an integer number. The higher the value, the more
29510 severe the error (the current maximum value is 3). If this variable is unset or
29511 zero, no error occurred.
29512
29513 .vitem &$demime_reason$&
29514 .vindex "&$demime_reason$&"
29515 When &$demime_errorlevel$& is greater than zero, this variable contains a
29516 human-readable text string describing the MIME error that occurred.
29517 .endlist
29518
29519 .vlist
29520 .vitem &$found_extension$&
29521 .vindex "&$found_extension$&"
29522 When the &%demime%& condition is true, this variable contains the file
29523 extension it found.
29524 .endlist
29525
29526 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
29527 the &%demime%& condition, and are not changed on subsequent calls.
29528
29529 If you do not want to check for file extensions, but rather use the &%demime%&
29530 condition for unpacking or error checking purposes, pass &"*"& as the
29531 right-hand side value. Here is a more elaborate example of how to use this
29532 facility:
29533 .code
29534 # Reject messages with serious MIME container errors
29535 deny  message = Found MIME error ($demime_reason).
29536       demime = *
29537       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
29538
29539 # Reject known virus spreading file extensions.
29540 # Accepting these is pretty much braindead.
29541 deny  message = contains $found_extension file (blacklisted).
29542       demime  = com:vbs:bat:pif:scr
29543
29544 # Freeze .exe and .doc files. Postmaster can
29545 # examine them and eventually thaw them.
29546 deny  log_message = Another $found_extension file.
29547       demime = exe:doc
29548       control = freeze
29549 .endd
29550 .ecindex IIDcosca
29551
29552
29553
29554
29555 . ////////////////////////////////////////////////////////////////////////////
29556 . ////////////////////////////////////////////////////////////////////////////
29557
29558 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
29559          "Local scan function"
29560 .scindex IIDlosca "&[local_scan()]& function" "description of"
29561 .cindex "customizing" "input scan using C function"
29562 .cindex "policy control" "by local scan function"
29563 In these days of email worms, viruses, and ever-increasing spam, some sites
29564 want to apply a lot of checking to messages before accepting them.
29565
29566 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
29567 passing messages to external virus and spam scanning software. You can also do
29568 a certain amount in Exim itself through string expansions and the &%condition%&
29569 condition in the ACL that runs after the SMTP DATA command or the ACL for
29570 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
29571
29572 To allow for further customization to a site's own requirements, there is the
29573 possibility of linking Exim with a private message scanning function, written
29574 in C. If you want to run code that is written in something other than C, you
29575 can of course use a little C stub to call it.
29576
29577 The local scan function is run once for every incoming message, at the point
29578 when Exim is just about to accept the message.
29579 It can therefore be used to control non-SMTP messages from local processes as
29580 well as messages arriving via SMTP.
29581
29582 Exim applies a timeout to calls of the local scan function, and there is an
29583 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
29584 Zero means &"no timeout"&.
29585 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
29586 before calling the local scan function, so that the most common types of crash
29587 are caught. If the timeout is exceeded or one of those signals is caught, the
29588 incoming message is rejected with a temporary error if it is an SMTP message.
29589 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
29590 code. The incident is logged on the main and reject logs.
29591
29592
29593
29594 .section "Building Exim to use a local scan function" "SECID207"
29595 .cindex "&[local_scan()]& function" "building Exim to use"
29596 To make use of the local scan function feature, you must tell Exim where your
29597 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
29598 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
29599 directory, so you might set
29600 .code
29601 LOCAL_SCAN_SOURCE=Local/local_scan.c
29602 .endd
29603 for example. The function must be called &[local_scan()]&. It is called by
29604 Exim after it has received a message, when the success return code is about to
29605 be sent. This is after all the ACLs have been run. The return code from your
29606 function controls whether the message is actually accepted or not. There is a
29607 commented template function (that just accepts the message) in the file
29608 _src/local_scan.c_.
29609
29610 If you want to make use of Exim's run time configuration file to set options
29611 for your &[local_scan()]& function, you must also set
29612 .code
29613 LOCAL_SCAN_HAS_OPTIONS=yes
29614 .endd
29615 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
29616
29617
29618
29619
29620 .section "API for local_scan()" "SECTapiforloc"
29621 .cindex "&[local_scan()]& function" "API description"
29622 You must include this line near the start of your code:
29623 .code
29624 #include "local_scan.h"
29625 .endd
29626 This header file defines a number of variables and other values, and the
29627 prototype for the function itself. Exim is coded to use unsigned char values
29628 almost exclusively, and one of the things this header defines is a shorthand
29629 for &`unsigned char`& called &`uschar`&.
29630 It also contains the following macro definitions, to simplify casting character
29631 strings and pointers to character strings:
29632 .code
29633 #define CS   (char *)
29634 #define CCS  (const char *)
29635 #define CSS  (char **)
29636 #define US   (unsigned char *)
29637 #define CUS  (const unsigned char *)
29638 #define USS  (unsigned char **)
29639 .endd
29640 The function prototype for &[local_scan()]& is:
29641 .code
29642 extern int local_scan(int fd, uschar **return_text);
29643 .endd
29644 The arguments are as follows:
29645
29646 .ilist
29647 &%fd%& is a file descriptor for the file that contains the body of the message
29648 (the -D file). The file is open for reading and writing, but updating it is not
29649 recommended. &*Warning*&: You must &'not'& close this file descriptor.
29650
29651 The descriptor is positioned at character 19 of the file, which is the first
29652 character of the body itself, because the first 19 characters are the message
29653 id followed by &`-D`& and a newline. If you rewind the file, you should use the
29654 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
29655 case this changes in some future version.
29656 .next
29657 &%return_text%& is an address which you can use to return a pointer to a text
29658 string at the end of the function. The value it points to on entry is NULL.
29659 .endlist
29660
29661 The function must return an &%int%& value which is one of the following macros:
29662
29663 .vlist
29664 .vitem &`LOCAL_SCAN_ACCEPT`&
29665 .vindex "&$local_scan_data$&"
29666 The message is accepted. If you pass back a string of text, it is saved with
29667 the message, and made available in the variable &$local_scan_data$&. No
29668 newlines are permitted (if there are any, they are turned into spaces) and the
29669 maximum length of text is 1000 characters.
29670
29671 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
29672 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29673 queued without immediate delivery, and is frozen.
29674
29675 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
29676 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29677 queued without immediate delivery.
29678
29679 .vitem &`LOCAL_SCAN_REJECT`&
29680 The message is rejected; the returned text is used as an error message which is
29681 passed back to the sender and which is also logged. Newlines are permitted &--
29682 they cause a multiline response for SMTP rejections, but are converted to
29683 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
29684 used.
29685
29686 .vitem &`LOCAL_SCAN_TEMPREJECT`&
29687 The message is temporarily rejected; the returned text is used as an error
29688 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
29689 problem"& is used.
29690
29691 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
29692 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
29693 message is not written to the reject log. It has the effect of unsetting the
29694 &%rejected_header%& log selector for just this rejection. If
29695 &%rejected_header%& is already unset (see the discussion of the
29696 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
29697 same as LOCAL_SCAN_REJECT.
29698
29699 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
29700 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
29701 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
29702 .endlist
29703
29704 If the message is not being received by interactive SMTP, rejections are
29705 reported by writing to &%stderr%& or by sending an email, as configured by the
29706 &%-oe%& command line options.
29707
29708
29709
29710 .section "Configuration options for local_scan()" "SECTconoptloc"
29711 .cindex "&[local_scan()]& function" "configuration options"
29712 It is possible to have option settings in the main configuration file
29713 that set values in static variables in the &[local_scan()]& module. If you
29714 want to do this, you must have the line
29715 .code
29716 LOCAL_SCAN_HAS_OPTIONS=yes
29717 .endd
29718 in your &_Local/Makefile_& when you build Exim. (This line is in
29719 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
29720 file, you must define static variables to hold the option values, and a table
29721 to define them.
29722
29723 The table must be a vector called &%local_scan_options%&, of type
29724 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
29725 and a pointer to the variable that holds the value. The entries must appear in
29726 alphabetical order. Following &%local_scan_options%& you must also define a
29727 variable called &%local_scan_options_count%& that contains the number of
29728 entries in the table. Here is a short example, showing two kinds of option:
29729 .code
29730 static int my_integer_option = 42;
29731 static uschar *my_string_option = US"a default string";
29732
29733 optionlist local_scan_options[] = {
29734   { "my_integer", opt_int,       &my_integer_option },
29735   { "my_string",  opt_stringptr, &my_string_option }
29736 };
29737
29738 int local_scan_options_count =
29739   sizeof(local_scan_options)/sizeof(optionlist);
29740 .endd
29741 The values of the variables can now be changed from Exim's runtime
29742 configuration file by including a local scan section as in this example:
29743 .code
29744 begin local_scan
29745 my_integer = 99
29746 my_string = some string of text...
29747 .endd
29748 The available types of option data are as follows:
29749
29750 .vlist
29751 .vitem &*opt_bool*&
29752 This specifies a boolean (true/false) option. The address should point to a
29753 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
29754 that are defined as &"1"& and &"0"&, respectively. If you want to detect
29755 whether such a variable has been set at all, you can initialize it to
29756 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
29757 values.)
29758
29759 .vitem &*opt_fixed*&
29760 This specifies a fixed point number, such as is used for load averages.
29761 The address should point to a variable of type &`int`&. The value is stored
29762 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
29763
29764 .vitem &*opt_int*&
29765 This specifies an integer; the address should point to a variable of type
29766 &`int`&. The value may be specified in any of the integer formats accepted by
29767 Exim.
29768
29769 .vitem &*opt_mkint*&
29770 This is the same as &%opt_int%&, except that when such a value is output in a
29771 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
29772 printed with the suffix K or M.
29773
29774 .vitem &*opt_octint*&
29775 This also specifies an integer, but the value is always interpreted as an
29776 octal integer, whether or not it starts with the digit zero, and it is
29777 always output in octal.
29778
29779 .vitem &*opt_stringptr*&
29780 This specifies a string value; the address must be a pointer to a
29781 variable that points to a string (for example, of type &`uschar *`&).
29782
29783 .vitem &*opt_time*&
29784 This specifies a time interval value. The address must point to a variable of
29785 type &`int`&. The value that is placed there is a number of seconds.
29786 .endlist
29787
29788 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
29789 out the values of all the &[local_scan()]& options.
29790
29791
29792
29793 .section "Available Exim variables" "SECID208"
29794 .cindex "&[local_scan()]& function" "available Exim variables"
29795 The header &_local_scan.h_& gives you access to a number of C variables. These
29796 are the only ones that are guaranteed to be maintained from release to release.
29797 Note, however, that you can obtain the value of any Exim expansion variable,
29798 including &$recipients$&, by calling &'expand_string()'&. The exported
29799 C variables are as follows:
29800
29801 .vlist
29802 .vitem &*int&~body_linecount*&
29803 This variable contains the number of lines in the message's body.
29804
29805 .vitem &*int&~body_zerocount*&
29806 This variable contains the number of binary zero bytes in the message's body.
29807
29808 .vitem &*unsigned&~int&~debug_selector*&
29809 This variable is set to zero when no debugging is taking place. Otherwise, it
29810 is a bitmap of debugging selectors. Two bits are identified for use in
29811 &[local_scan()]&; they are defined as macros:
29812
29813 .ilist
29814 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
29815 testing option that is not privileged &-- any caller may set it. All the
29816 other selector bits can be set only by admin users.
29817
29818 .next
29819 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
29820 by the &`+local_scan`& debug selector. It is not included in the default set
29821 of debugging bits.
29822 .endlist ilist
29823
29824 Thus, to write to the debugging output only when &`+local_scan`& has been
29825 selected, you should use code like this:
29826 .code
29827 if ((debug_selector & D_local_scan) != 0)
29828   debug_printf("xxx", ...);
29829 .endd
29830 .vitem &*uschar&~*expand_string_message*&
29831 After a failing call to &'expand_string()'& (returned value NULL), the
29832 variable &%expand_string_message%& contains the error message, zero-terminated.
29833
29834 .vitem &*header_line&~*header_list*&
29835 A pointer to a chain of header lines. The &%header_line%& structure is
29836 discussed below.
29837
29838 .vitem &*header_line&~*header_last*&
29839 A pointer to the last of the header lines.
29840
29841 .vitem &*uschar&~*headers_charset*&
29842 The value of the &%headers_charset%& configuration option.
29843
29844 .vitem &*BOOL&~host_checking*&
29845 This variable is TRUE during a host checking session that is initiated by the
29846 &%-bh%& command line option.
29847
29848 .vitem &*uschar&~*interface_address*&
29849 The IP address of the interface that received the message, as a string. This
29850 is NULL for locally submitted messages.
29851
29852 .vitem &*int&~interface_port*&
29853 The port on which this message was received. When testing with the &%-bh%&
29854 command line option, the value of this variable is -1 unless a port has been
29855 specified via the &%-oMi%& option.
29856
29857 .vitem &*uschar&~*message_id*&
29858 This variable contains Exim's message id for the incoming message (the value of
29859 &$message_exim_id$&) as a zero-terminated string.
29860
29861 .vitem &*uschar&~*received_protocol*&
29862 The name of the protocol by which the message was received.
29863
29864 .vitem &*int&~recipients_count*&
29865 The number of accepted recipients.
29866
29867 .vitem &*recipient_item&~*recipients_list*&
29868 .cindex "recipient" "adding in local scan"
29869 .cindex "recipient" "removing in local scan"
29870 The list of accepted recipients, held in a vector of length
29871 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29872 can add additional recipients by calling &'receive_add_recipient()'& (see
29873 below). You can delete recipients by removing them from the vector and
29874 adjusting the value in &%recipients_count%&. In particular, by setting
29875 &%recipients_count%& to zero you remove all recipients. If you then return the
29876 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29877 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29878 and then call &'receive_add_recipient()'& as often as needed.
29879
29880 .vitem &*uschar&~*sender_address*&
29881 The envelope sender address. For bounce messages this is the empty string.
29882
29883 .vitem &*uschar&~*sender_host_address*&
29884 The IP address of the sending host, as a string. This is NULL for
29885 locally-submitted messages.
29886
29887 .vitem &*uschar&~*sender_host_authenticated*&
29888 The name of the authentication mechanism that was used, or NULL if the message
29889 was not received over an authenticated SMTP connection.
29890
29891 .vitem &*uschar&~*sender_host_name*&
29892 The name of the sending host, if known.
29893
29894 .vitem &*int&~sender_host_port*&
29895 The port on the sending host.
29896
29897 .vitem &*BOOL&~smtp_input*&
29898 This variable is TRUE for all SMTP input, including BSMTP.
29899
29900 .vitem &*BOOL&~smtp_batched_input*&
29901 This variable is TRUE for BSMTP input.
29902
29903 .vitem &*int&~store_pool*&
29904 The contents of this variable control which pool of memory is used for new
29905 requests. See section &<<SECTmemhanloc>>& for details.
29906 .endlist
29907
29908
29909 .section "Structure of header lines" "SECID209"
29910 The &%header_line%& structure contains the members listed below.
29911 You can add additional header lines by calling the &'header_add()'& function
29912 (see below). You can cause header lines to be ignored (deleted) by setting
29913 their type to *.
29914
29915
29916 .vlist
29917 .vitem &*struct&~header_line&~*next*&
29918 A pointer to the next header line, or NULL for the last line.
29919
29920 .vitem &*int&~type*&
29921 A code identifying certain headers that Exim recognizes. The codes are printing
29922 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29923 Notice in particular that any header line whose type is * is not transmitted
29924 with the message. This flagging is used for header lines that have been
29925 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29926 lines.) Effectively, * means &"deleted"&.
29927
29928 .vitem &*int&~slen*&
29929 The number of characters in the header line, including the terminating and any
29930 internal newlines.
29931
29932 .vitem &*uschar&~*text*&
29933 A pointer to the text of the header. It always ends with a newline, followed by
29934 a zero byte. Internal newlines are preserved.
29935 .endlist
29936
29937
29938
29939 .section "Structure of recipient items" "SECID210"
29940 The &%recipient_item%& structure contains these members:
29941
29942 .vlist
29943 .vitem &*uschar&~*address*&
29944 This is a pointer to the recipient address as it was received.
29945
29946 .vitem &*int&~pno*&
29947 This is used in later Exim processing when top level addresses are created by
29948 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29949 and must always contain -1 at this stage.
29950
29951 .vitem &*uschar&~*errors_to*&
29952 If this value is not NULL, bounce messages caused by failing to deliver to the
29953 recipient are sent to the address it contains. In other words, it overrides the
29954 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29955 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29956 an unqualified address, Exim qualifies it using the domain from
29957 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29958 is NULL for all recipients.
29959 .endlist
29960
29961
29962
29963 .section "Available Exim functions" "SECID211"
29964 .cindex "&[local_scan()]& function" "available Exim functions"
29965 The header &_local_scan.h_& gives you access to a number of Exim functions.
29966 These are the only ones that are guaranteed to be maintained from release to
29967 release:
29968
29969 .vlist
29970 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29971        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29972
29973 This function creates a child process that runs the command specified by
29974 &%argv%&. The environment for the process is specified by &%envp%&, which can
29975 be NULL if no environment variables are to be passed. A new umask is supplied
29976 for the process in &%newumask%&.
29977
29978 Pipes to the standard input and output of the new process are set up
29979 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29980 standard error is cloned to the standard output. If there are any file
29981 descriptors &"in the way"& in the new process, they are closed. If the final
29982 argument is TRUE, the new process is made into a process group leader.
29983
29984 The function returns the pid of the new process, or -1 if things go wrong.
29985
29986 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29987 This function waits for a child process to terminate, or for a timeout (in
29988 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29989 return value is as follows:
29990
29991 .ilist
29992 >= 0
29993
29994 The process terminated by a normal exit and the value is the process
29995 ending status.
29996
29997 .next
29998 < 0 and > &--256
29999
30000 The process was terminated by a signal and the value is the negation of the
30001 signal number.
30002
30003 .next
30004 &--256
30005
30006 The process timed out.
30007 .next
30008 &--257
30009
30010 The was some other error in wait(); &%errno%& is still set.
30011 .endlist
30012
30013 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30014 This function provide you with a means of submitting a new message to
30015 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30016 want, but this packages it all up for you.) The function creates a pipe,
30017 forks a subprocess that is running
30018 .code
30019 exim -t -oem -oi -f <>
30020 .endd
30021 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30022 that is connected to the standard input. The yield of the function is the PID
30023 of the subprocess. You can then write a message to the file descriptor, with
30024 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30025
30026 When you have finished, call &'child_close()'& to wait for the process to
30027 finish and to collect its ending status. A timeout value of zero is usually
30028 fine in this circumstance. Unless you have made a mistake with the recipient
30029 addresses, you should get a return code of zero.
30030
30031
30032 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30033        *sender_authentication)*&
30034 This function is a more sophisticated version of &'child_open()'&. The command
30035 that it runs is:
30036 .display
30037 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30038 .endd
30039 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30040
30041
30042 .vitem &*void&~debug_printf(char&~*,&~...)*&
30043 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30044 output is written to the standard error stream. If no debugging is selected,
30045 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30046 conditional on the &`local_scan`& debug selector by coding like this:
30047 .code
30048 if ((debug_selector & D_local_scan) != 0)
30049   debug_printf("xxx", ...);
30050 .endd
30051
30052 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30053 This is an interface to Exim's string expansion code. The return value is the
30054 expanded string, or NULL if there was an expansion failure.
30055 The C variable &%expand_string_message%& contains an error message after an
30056 expansion failure. If expansion does not change the string, the return value is
30057 the pointer to the input string. Otherwise, the return value points to a new
30058 block of memory that was obtained by a call to &'store_get()'&. See section
30059 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30060
30061 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30062 This function allows you to an add additional header line at the end of the
30063 existing ones. The first argument is the type, and should normally be a space
30064 character. The second argument is a format string and any number of
30065 substitution arguments as for &[sprintf()]&. You may include internal newlines
30066 if you want, and you must ensure that the string ends with a newline.
30067
30068 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30069         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30070 This function adds a new header line at a specified point in the header
30071 chain. The header itself is specified as for &'header_add()'&.
30072
30073 If &%name%& is NULL, the new header is added at the end of the chain if
30074 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30075 NULL, the header lines are searched for the first non-deleted header that
30076 matches the name. If one is found, the new header is added before it if
30077 &%after%& is false. If &%after%& is true, the new header is added after the
30078 found header and any adjacent subsequent ones with the same name (even if
30079 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30080 option controls where the header is added. If it is true, addition is at the
30081 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30082 headers, or at the top if there are no &'Received:'& headers, you could use
30083 .code
30084 header_add_at_position(TRUE, US"Received", TRUE,
30085   ' ', "X-xxx: ...");
30086 .endd
30087 Normally, there is always at least one non-deleted &'Received:'& header, but
30088 there may not be if &%received_header_text%& expands to an empty string.
30089
30090
30091 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30092 This function removes header lines. If &%occurrence%& is zero or negative, all
30093 occurrences of the header are removed. If occurrence is greater than zero, that
30094 particular instance of the header is removed. If no header(s) can be found that
30095 match the specification, the function does nothing.
30096
30097
30098 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30099         int&~length,&~BOOL&~notdel)*&"
30100 This function tests whether the given header has the given name. It is not just
30101 a string comparison, because white space is permitted between the name and the
30102 colon. If the &%notdel%& argument is true, a false return is forced for all
30103 &"deleted"& headers; otherwise they are not treated specially. For example:
30104 .code
30105 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30106 .endd
30107 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30108 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30109 This function base64-encodes a string, which is passed by address and length.
30110 The text may contain bytes of any value, including zero. The result is passed
30111 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30112 zero-terminated.
30113
30114 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30115 This function decodes a base64-encoded string. Its arguments are a
30116 zero-terminated base64-encoded string and the address of a variable that is set
30117 to point to the result, which is in dynamic memory. The length of the decoded
30118 string is the yield of the function. If the input is invalid base64 data, the
30119 yield is -1. A zero byte is added to the end of the output string to make it
30120 easy to interpret as a C string (assuming it contains no zeros of its own). The
30121 added zero byte is not included in the returned count.
30122
30123 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30124 This function checks for a match in a domain list. Domains are always
30125 matched caselessly. The return value is one of the following:
30126 .display
30127 &`OK     `& match succeeded
30128 &`FAIL   `& match failed
30129 &`DEFER  `& match deferred
30130 .endd
30131 DEFER is usually caused by some kind of lookup defer, such as the
30132 inability to contact a database.
30133
30134 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30135         BOOL&~caseless)*&"
30136 This function checks for a match in a local part list. The third argument
30137 controls case-sensitivity. The return values are as for
30138 &'lss_match_domain()'&.
30139
30140 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30141         BOOL&~caseless)*&"
30142 This function checks for a match in an address list. The third argument
30143 controls the case-sensitivity of the local part match. The domain is always
30144 matched caselessly. The return values are as for &'lss_match_domain()'&.
30145
30146 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30147         uschar&~*list)*&"
30148 This function checks for a match in a host list. The most common usage is
30149 expected to be
30150 .code
30151 lss_match_host(sender_host_name, sender_host_address, ...)
30152 .endd
30153 .vindex "&$sender_host_address$&"
30154 An empty address field matches an empty item in the host list. If the host name
30155 is NULL, the name corresponding to &$sender_host_address$& is automatically
30156 looked up if a host name is required to match an item in the list. The return
30157 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30158 returns ERROR in the case when it had to look up a host name, but the lookup
30159 failed.
30160
30161 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30162         *format,&~...)*&"
30163 This function writes to Exim's log files. The first argument should be zero (it
30164 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30165 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30166 them. It specifies to which log or logs the message is written. The remaining
30167 arguments are a format and relevant insertion arguments. The string should not
30168 contain any newlines, not even at the end.
30169
30170
30171 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30172 This function adds an additional recipient to the message. The first argument
30173 is the recipient address. If it is unqualified (has no domain), it is qualified
30174 with the &%qualify_recipient%& domain. The second argument must always be -1.
30175
30176 This function does not allow you to specify a private &%errors_to%& address (as
30177 described with the structure of &%recipient_item%& above), because it pre-dates
30178 the addition of that field to the structure. However, it is easy to add such a
30179 value afterwards. For example:
30180 .code
30181  receive_add_recipient(US"monitor@mydom.example", -1);
30182  recipients_list[recipients_count-1].errors_to =
30183    US"postmaster@mydom.example";
30184 .endd
30185
30186 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30187 This is a convenience function to remove a named recipient from the list of
30188 recipients. It returns true if a recipient was removed, and false if no
30189 matching recipient could be found. The argument must be a complete email
30190 address.
30191 .endlist
30192
30193
30194 .cindex "RFC 2047"
30195 .vlist
30196 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30197   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30198 This function decodes strings that are encoded according to RFC 2047. Typically
30199 these are the contents of header lines. First, each &"encoded word"& is decoded
30200 from the Q or B encoding into a byte-string. Then, if provided with the name of
30201 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30202 made  to translate the result to the named character set. If this fails, the
30203 binary string is returned with an error message.
30204
30205 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30206 maximum MIME word length is enforced. The third argument is the target
30207 encoding, or NULL if no translation is wanted.
30208
30209 .cindex "binary zero" "in RFC 2047 decoding"
30210 .cindex "RFC 2047" "binary zero in"
30211 If a binary zero is encountered in the decoded string, it is replaced by the
30212 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30213 not be 0 because header lines are handled as zero-terminated strings.
30214
30215 The function returns the result of processing the string, zero-terminated; if
30216 &%lenptr%& is not NULL, the length of the result is set in the variable to
30217 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30218
30219 If an error is encountered, the function returns NULL and uses the &%error%&
30220 argument to return an error message. The variable pointed to by &%error%& is
30221 set to NULL if there is no error; it may be set non-NULL even when the function
30222 returns a non-NULL value if decoding was successful, but there was a problem
30223 with translation.
30224
30225
30226 .vitem &*int&~smtp_fflush(void)*&
30227 This function is used in conjunction with &'smtp_printf()'&, as described
30228 below.
30229
30230 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30231 The arguments of this function are like &[printf()]&; it writes to the SMTP
30232 output stream. You should use this function only when there is an SMTP output
30233 stream, that is, when the incoming message is being received via interactive
30234 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30235 is FALSE. If you want to test for an incoming message from another host (as
30236 opposed to a local process that used the &%-bs%& command line option), you can
30237 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30238 is involved.
30239
30240 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30241 output function, so it can be used for all forms of SMTP connection.
30242
30243 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30244 must start with an appropriate response code: 550 if you are going to return
30245 LOCAL_SCAN_REJECT, 451 if you are going to return
30246 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30247 initial lines of a multi-line response, the code must be followed by a hyphen
30248 to indicate that the line is not the final response line. You must also ensure
30249 that the lines you write terminate with CRLF. For example:
30250 .code
30251 smtp_printf("550-this is some extra info\r\n");
30252 return LOCAL_SCAN_REJECT;
30253 .endd
30254 Note that you can also create multi-line responses by including newlines in
30255 the data returned via the &%return_text%& argument. The added value of using
30256 &'smtp_printf()'& is that, for instance, you could introduce delays between
30257 multiple output lines.
30258
30259 The &'smtp_printf()'& function does not return any error indication, because it
30260 does not automatically flush pending output, and therefore does not test
30261 the state of the stream. (In the main code of Exim, flushing and error
30262 detection is done when Exim is ready for the next SMTP input command.) If
30263 you want to flush the output and check for an error (for example, the
30264 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30265 arguments. It flushes the output stream, and returns a non-zero value if there
30266 is an error.
30267
30268 .vitem &*void&~*store_get(int)*&
30269 This function accesses Exim's internal store (memory) manager. It gets a new
30270 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30271 runs out of memory. See the next section for a discussion of memory handling.
30272
30273 .vitem &*void&~*store_get_perm(int)*&
30274 This function is like &'store_get()'&, but it always gets memory from the
30275 permanent pool. See the next section for a discussion of memory handling.
30276
30277 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30278 See below.
30279
30280 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30281 See below.
30282
30283 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30284 These three functions create strings using Exim's dynamic memory facilities.
30285 The first makes a copy of an entire string. The second copies up to a maximum
30286 number of characters, indicated by the second argument. The third uses a format
30287 and insertion arguments to create a new string. In each case, the result is a
30288 pointer to a new string in the current memory pool. See the next section for
30289 more discussion.
30290 .endlist
30291
30292
30293
30294 .section "More about Exim's memory handling" "SECTmemhanloc"
30295 .cindex "&[local_scan()]& function" "memory handling"
30296 No function is provided for freeing memory, because that is never needed.
30297 The dynamic memory that Exim uses when receiving a message is automatically
30298 recycled if another message is received by the same process (this applies only
30299 to incoming SMTP connections &-- other input methods can supply only one
30300 message at a time). After receiving the last message, a reception process
30301 terminates.
30302
30303 Because it is recycled, the normal dynamic memory cannot be used for holding
30304 data that must be preserved over a number of incoming messages on the same SMTP
30305 connection. However, Exim in fact uses two pools of dynamic memory; the second
30306 one is not recycled, and can be used for this purpose.
30307
30308 If you want to allocate memory that remains available for subsequent messages
30309 in the same SMTP connection, you should set
30310 .code
30311 store_pool = POOL_PERM
30312 .endd
30313 before calling the function that does the allocation. There is no need to
30314 restore the value if you do not need to; however, if you do want to revert to
30315 the normal pool, you can either restore the previous value of &%store_pool%& or
30316 set it explicitly to POOL_MAIN.
30317
30318 The pool setting applies to all functions that get dynamic memory, including
30319 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30320 There is also a convenience function called &'store_get_perm()'& that gets a
30321 block of memory from the permanent pool while preserving the value of
30322 &%store_pool%&.
30323 .ecindex IIDlosca
30324
30325
30326
30327
30328 . ////////////////////////////////////////////////////////////////////////////
30329 . ////////////////////////////////////////////////////////////////////////////
30330
30331 .chapter "System-wide message filtering" "CHAPsystemfilter"
30332 .scindex IIDsysfil1 "filter" "system filter"
30333 .scindex IIDsysfil2 "filtering all mail"
30334 .scindex IIDsysfil3 "system filter"
30335 The previous chapters (on ACLs and the local scan function) describe checks
30336 that can be applied to messages before they are accepted by a host. There is
30337 also a mechanism for checking messages once they have been received, but before
30338 they are delivered. This is called the &'system filter'&.
30339
30340 The system filter operates in a similar manner to users' filter files, but it
30341 is run just once per message (however many recipients the message has).
30342 It should not normally be used as a substitute for routing, because &%deliver%&
30343 commands in a system router provide new envelope recipient addresses.
30344 The system filter must be an Exim filter. It cannot be a Sieve filter.
30345
30346 The system filter is run at the start of a delivery attempt, before any routing
30347 is done. If a message fails to be completely delivered at the first attempt,
30348 the system filter is run again at the start of every retry.
30349 If you want your filter to do something only once per message, you can make use
30350 of the &%first_delivery%& condition in an &%if%& command in the filter to
30351 prevent it happening on retries.
30352
30353 .vindex "&$domain$&"
30354 .vindex "&$local_part$&"
30355 &*Warning*&: Because the system filter runs just once, variables that are
30356 specific to individual recipient addresses, such as &$local_part$& and
30357 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
30358 you want to run a centrally-specified filter for each recipient address
30359 independently, you can do so by setting up a suitable &(redirect)& router, as
30360 described in section &<<SECTperaddfil>>& below.
30361
30362
30363 .section "Specifying a system filter" "SECID212"
30364 .cindex "uid (user id)" "system filter"
30365 .cindex "gid (group id)" "system filter"
30366 The name of the file that contains the system filter must be specified by
30367 setting &%system_filter%&. If you want the filter to run under a uid and gid
30368 other than root, you must also set &%system_filter_user%& and
30369 &%system_filter_group%& as appropriate. For example:
30370 .code
30371 system_filter = /etc/mail/exim.filter
30372 system_filter_user = exim
30373 .endd
30374 If a system filter generates any deliveries directly to files or pipes (via the
30375 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
30376 specified by setting &%system_filter_file_transport%& and
30377 &%system_filter_pipe_transport%&, respectively. Similarly,
30378 &%system_filter_reply_transport%& must be set to handle any messages generated
30379 by the &%reply%& command.
30380
30381
30382 .section "Testing a system filter" "SECID213"
30383 You can run simple tests of a system filter in the same way as for a user
30384 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
30385 are permitted only in system filters are recognized.
30386
30387 If you want to test the combined effect of a system filter and a user filter,
30388 you can use both &%-bF%& and &%-bf%& on the same command line.
30389
30390
30391
30392 .section "Contents of a system filter" "SECID214"
30393 The language used to specify system filters is the same as for users' filter
30394 files. It is described in the separate end-user document &'Exim's interface to
30395 mail filtering'&. However, there are some additional features that are
30396 available only in system filters; these are described in subsequent sections.
30397 If they are encountered in a user's filter file or when testing with &%-bf%&,
30398 they cause errors.
30399
30400 .cindex "frozen messages" "manual thaw; testing in filter"
30401 There are two special conditions which, though available in users' filter
30402 files, are designed for use in system filters. The condition &%first_delivery%&
30403 is true only for the first attempt at delivering a message, and
30404 &%manually_thawed%& is true only if the message has been frozen, and
30405 subsequently thawed by an admin user. An explicit forced delivery counts as a
30406 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
30407
30408 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
30409 specify an &"unseen"& (non-significant) delivery, and that delivery does not
30410 succeed, it will not be tried again.
30411 If you want Exim to retry an unseen delivery until it succeeds, you should
30412 arrange to set it up every time the filter runs.
30413
30414 When a system filter finishes running, the values of the variables &$n0$& &--
30415 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
30416 users' filter files. Thus a system filter can, for example, set up &"scores"&
30417 to which users' filter files can refer.
30418
30419
30420
30421 .section "Additional variable for system filters" "SECID215"
30422 .vindex "&$recipients$&"
30423 The expansion variable &$recipients$&, containing a list of all the recipients
30424 of the message (separated by commas and white space), is available in system
30425 filters. It is not available in users' filters for privacy reasons.
30426
30427
30428
30429 .section "Defer, freeze, and fail commands for system filters" "SECID216"
30430 .cindex "freezing messages"
30431 .cindex "message" "freezing"
30432 .cindex "message" "forced failure"
30433 .cindex "&%fail%&" "in system filter"
30434 .cindex "&%freeze%& in system filter"
30435 .cindex "&%defer%& in system filter"
30436 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
30437 always available in system filters, but are not normally enabled in users'
30438 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
30439 for the &(redirect)& router.) These commands can optionally be followed by the
30440 word &%text%& and a string containing an error message, for example:
30441 .code
30442 fail text "this message looks like spam to me"
30443 .endd
30444 The keyword &%text%& is optional if the next character is a double quote.
30445
30446 The &%defer%& command defers delivery of the original recipients of the
30447 message. The &%fail%& command causes all the original recipients to be failed,
30448 and a bounce message to be created. The &%freeze%& command suspends all
30449 delivery attempts for the original recipients. In all cases, any new deliveries
30450 that are specified by the filter are attempted as normal after the filter has
30451 run.
30452
30453 The &%freeze%& command is ignored if the message has been manually unfrozen and
30454 not manually frozen since. This means that automatic freezing by a system
30455 filter can be used as a way of checking out suspicious messages. If a message
30456 is found to be all right, manually unfreezing it allows it to be delivered.
30457
30458 .cindex "log" "&%fail%& command log line"
30459 .cindex "&%fail%&" "log line; reducing"
30460 The text given with a fail command is used as part of the bounce message as
30461 well as being written to the log. If the message is quite long, this can fill
30462 up a lot of log space when such failures are common. To reduce the size of the
30463 log message, Exim interprets the text in a special way if it starts with the
30464 two characters &`<<`& and contains &`>>`& later. The text between these two
30465 strings is written to the log, and the rest of the text is used in the bounce
30466 message. For example:
30467 .code
30468 fail "<<filter test 1>>Your message is rejected \
30469      because it contains attachments that we are \
30470      not prepared to receive."
30471 .endd
30472
30473 .cindex "loop" "caused by &%fail%&"
30474 Take great care with the &%fail%& command when basing the decision to fail on
30475 the contents of the message, because the bounce message will of course include
30476 the contents of the original message and will therefore trigger the &%fail%&
30477 command again (causing a mail loop) unless steps are taken to prevent this.
30478 Testing the &%error_message%& condition is one way to prevent this. You could
30479 use, for example
30480 .code
30481 if $message_body contains "this is spam" and not error_message
30482 then fail text "spam is not wanted here" endif
30483 .endd
30484 though of course that might let through unwanted bounce messages. The
30485 alternative is clever checking of the body and/or headers to detect bounces
30486 generated by the filter.
30487
30488 The interpretation of a system filter file ceases after a
30489 &%defer%&,
30490 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
30491 set up earlier in the filter file are honoured, so you can use a sequence such
30492 as
30493 .code
30494 mail ...
30495 freeze
30496 .endd
30497 to send a specified message when the system filter is freezing (or deferring or
30498 failing) a message. The normal deliveries for the message do not, of course,
30499 take place.
30500
30501
30502
30503 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
30504 .cindex "header lines" "adding; in system filter"
30505 .cindex "header lines" "removing; in system filter"
30506 .cindex "filter" "header lines; adding/removing"
30507 Two filter commands that are available only in system filters are:
30508 .code
30509 headers add <string>
30510 headers remove <string>
30511 .endd
30512 The argument for the &%headers add%& is a string that is expanded and then
30513 added to the end of the message's headers. It is the responsibility of the
30514 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
30515 space is ignored, and if the string is otherwise empty, or if the expansion is
30516 forced to fail, the command has no effect.
30517
30518 You can use &"\n"& within the string, followed by white space, to specify
30519 continued header lines. More than one header may be added in one command by
30520 including &"\n"& within the string without any following white space. For
30521 example:
30522 .code
30523 headers add "X-header-1: ....\n  \
30524              continuation of X-header-1 ...\n\
30525              X-header-2: ...."
30526 .endd
30527 Note that the header line continuation white space after the first newline must
30528 be placed before the backslash that continues the input string, because white
30529 space after input continuations is ignored.
30530
30531 The argument for &%headers remove%& is a colon-separated list of header names.
30532 This command applies only to those headers that are stored with the message;
30533 those that are added at delivery time (such as &'Envelope-To:'& and
30534 &'Return-Path:'&) cannot be removed by this means. If there is more than one
30535 header with the same name, they are all removed.
30536
30537 The &%headers%& command in a system filter makes an immediate change to the set
30538 of header lines that was received with the message (with possible additions
30539 from ACL processing). Subsequent commands in the system filter operate on the
30540 modified set, which also forms the basis for subsequent message delivery.
30541 Unless further modified during routing or transporting, this set of headers is
30542 used for all recipients of the message.
30543
30544 During routing and transporting, the variables that refer to the contents of
30545 header lines refer only to those lines that are in this set. Thus, header lines
30546 that are added by a system filter are visible to users' filter files and to all
30547 routers and transports. This contrasts with the manipulation of header lines by
30548 routers and transports, which is not immediate, but which instead is saved up
30549 until the message is actually being written (see section
30550 &<<SECTheadersaddrem>>&).
30551
30552 If the message is not delivered at the first attempt, header lines that were
30553 added by the system filter are stored with the message, and so are still
30554 present at the next delivery attempt. Header lines that were removed are still
30555 present, but marked &"deleted"& so that they are not transported with the
30556 message. For this reason, it is usual to make the &%headers%& command
30557 conditional on &%first_delivery%& so that the set of header lines is not
30558 modified more than once.
30559
30560 Because header modification in a system filter acts immediately, you have to
30561 use an indirect approach if you want to modify the contents of a header line.
30562 For example:
30563 .code
30564 headers add "Old-Subject: $h_subject:"
30565 headers remove "Subject"
30566 headers add "Subject: new subject (was: $h_old-subject:)"
30567 headers remove "Old-Subject"
30568 .endd
30569
30570
30571
30572 .section "Setting an errors address in a system filter" "SECID217"
30573 .cindex "envelope sender"
30574 In a system filter, if a &%deliver%& command is followed by
30575 .code
30576 errors_to <some address>
30577 .endd
30578 in order to change the envelope sender (and hence the error reporting) for that
30579 delivery, any address may be specified. (In a user filter, only the current
30580 user's address can be set.) For example, if some mail is being monitored, you
30581 might use
30582 .code
30583 unseen deliver monitor@spying.example errors_to root@local.example
30584 .endd
30585 to take a copy which would not be sent back to the normal error reporting
30586 address if its delivery failed.
30587
30588
30589
30590 .section "Per-address filtering" "SECTperaddfil"
30591 .vindex "&$domain$&"
30592 .vindex "&$local_part$&"
30593 In contrast to the system filter, which is run just once per message for each
30594 delivery attempt, it is also possible to set up a system-wide filtering
30595 operation that runs once for each recipient address. In this case, variables
30596 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
30597 filter file could be made dependent on them. This is an example of a router
30598 which implements such a filter:
30599 .code
30600 central_filter:
30601   check_local_user
30602   driver = redirect
30603   domains = +local_domains
30604   file = /central/filters/$local_part
30605   no_verify
30606   allow_filter
30607   allow_freeze
30608 .endd
30609 The filter is run in a separate process under its own uid. Therefore, either
30610 &%check_local_user%& must be set (as above), in which case the filter is run as
30611 the local user, or the &%user%& option must be used to specify which user to
30612 use. If both are set, &%user%& overrides.
30613
30614 Care should be taken to ensure that none of the commands in the filter file
30615 specify a significant delivery if the message is to go on to be delivered to
30616 its intended recipient. The router will not then claim to have dealt with the
30617 address, so it will be passed on to subsequent routers to be delivered in the
30618 normal way.
30619 .ecindex IIDsysfil1
30620 .ecindex IIDsysfil2
30621 .ecindex IIDsysfil3
30622
30623
30624
30625
30626
30627
30628 . ////////////////////////////////////////////////////////////////////////////
30629 . ////////////////////////////////////////////////////////////////////////////
30630
30631 .chapter "Message processing" "CHAPmsgproc"
30632 .scindex IIDmesproc "message" "general processing"
30633 Exim performs various transformations on the sender and recipient addresses of
30634 all messages that it handles, and also on the messages' header lines. Some of
30635 these are optional and configurable, while others always take place. All of
30636 this processing, except rewriting as a result of routing, and the addition or
30637 removal of header lines while delivering, happens when a message is received,
30638 before it is placed on Exim's queue.
30639
30640 Some of the automatic processing takes place by default only for
30641 &"locally-originated"& messages. This adjective is used to describe messages
30642 that are not received over TCP/IP, but instead are passed to an Exim process on
30643 its standard input. This includes the interactive &"local SMTP"& case that is
30644 set up by the &%-bs%& command line option.
30645
30646 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
30647 or ::1) are not considered to be locally-originated. Exim does not treat the
30648 loopback interface specially in any way.
30649
30650 If you want the loopback interface to be treated specially, you must ensure
30651 that there are appropriate entries in your ACLs.
30652
30653
30654
30655
30656 .section "Submission mode for non-local messages" "SECTsubmodnon"
30657 .cindex "message" "submission"
30658 .cindex "submission mode"
30659 Processing that happens automatically for locally-originated messages (unless
30660 &%suppress_local_fixups%& is set) can also be requested for messages that are
30661 received over TCP/IP. The term &"submission mode"& is used to describe this
30662 state. Submission mode is set by the modifier
30663 .code
30664 control = submission
30665 .endd
30666 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
30667 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
30668 a local submission, and is normally used when the source of the message is
30669 known to be an MUA running on a client host (as opposed to an MTA). For
30670 example, to set submission mode for messages originating on the IPv4 loopback
30671 interface, you could include the following in the MAIL ACL:
30672 .code
30673 warn  hosts = 127.0.0.1
30674       control = submission
30675 .endd
30676 .cindex "&%sender_retain%& submission option"
30677 There are some options that can be used when setting submission mode. A slash
30678 is used to separate options. For example:
30679 .code
30680 control = submission/sender_retain
30681 .endd
30682 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
30683 true and &%local_from_check%& false for the current incoming message. The first
30684 of these allows an existing &'Sender:'& header in the message to remain, and
30685 the second suppresses the check to ensure that &'From:'& matches the
30686 authenticated sender. With this setting, Exim still fixes up messages by adding
30687 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
30688 attempt to check sender authenticity in header lines.
30689
30690 When &%sender_retain%& is not set, a submission mode setting may specify a
30691 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
30692 example:
30693 .code
30694 control = submission/domain=some.domain
30695 .endd
30696 The domain may be empty. How this value is used is described in sections
30697 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
30698 that allows you to specify the user's full name for inclusion in a created
30699 &'Sender:'& or &'From:'& header line. For example:
30700 .code
30701 accept authenticated = *
30702        control = submission/domain=wonderland.example/\
30703                             name=${lookup {$authenticated_id} \
30704                                    lsearch {/etc/exim/namelist}}
30705 .endd
30706 Because the name may contain any characters, including slashes, the &%name%&
30707 option must be given last. The remainder of the string is used as the name. For
30708 the example above, if &_/etc/exim/namelist_& contains:
30709 .code
30710 bigegg:  Humpty Dumpty
30711 .endd
30712 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
30713 line would be:
30714 .code
30715 Sender: Humpty Dumpty <bigegg@wonderland.example>
30716 .endd
30717 .cindex "return path" "in submission mode"
30718 By default, submission mode forces the return path to the same address as is
30719 used to create the &'Sender:'& header. However, if &%sender_retain%& is
30720 specified, the return path is also left unchanged.
30721
30722 &*Note*&: The changes caused by submission mode take effect after the predata
30723 ACL. This means that any sender checks performed before the fix-ups use the
30724 untrusted sender address specified by the user, not the trusted sender address
30725 specified by submission mode. Although this might be slightly unexpected, it
30726 does mean that you can configure ACL checks to spot that a user is trying to
30727 spoof another's address.
30728
30729 .section "Line endings" "SECTlineendings"
30730 .cindex "line endings"
30731 .cindex "carriage return"
30732 .cindex "linefeed"
30733 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
30734 linefeed) is the line ending for messages transmitted over the Internet using
30735 SMTP over TCP/IP. However, within individual operating systems, different
30736 conventions are used. For example, Unix-like systems use just LF, but others
30737 use CRLF or just CR.
30738
30739 Exim was designed for Unix-like systems, and internally, it stores messages
30740 using the system's convention of a single LF as a line terminator. When
30741 receiving a message, all line endings are translated to this standard format.
30742 Originally, it was thought that programs that passed messages directly to an
30743 MTA within an operating system would use that system's convention. Experience
30744 has shown that this is not the case; for example, there are Unix applications
30745 that use CRLF in this circumstance. For this reason, and for compatibility with
30746 other MTAs, the way Exim handles line endings for all messages is now as
30747 follows:
30748
30749 .ilist
30750 LF not preceded by CR is treated as a line ending.
30751 .next
30752 CR is treated as a line ending; if it is immediately followed by LF, the LF
30753 is ignored.
30754 .next
30755 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
30756 nor a local message in the state where a line containing only a dot is a
30757 terminator.
30758 .next
30759 If a bare CR is encountered within a header line, an extra space is added after
30760 the line terminator so as not to end the header line. The reasoning behind this
30761 is that bare CRs in header lines are most likely either to be mistakes, or
30762 people trying to play silly games.
30763 .next
30764 If the first header line received in a message ends with CRLF, a subsequent
30765 bare LF in a header line is treated in the same way as a bare CR in a header
30766 line.
30767 .endlist
30768
30769
30770
30771
30772
30773 .section "Unqualified addresses" "SECID218"
30774 .cindex "unqualified addresses"
30775 .cindex "address" "qualification"
30776 By default, Exim expects every envelope address it receives from an external
30777 host to be fully qualified. Unqualified addresses cause negative responses to
30778 SMTP commands. However, because SMTP is used as a means of transporting
30779 messages from MUAs running on personal workstations, there is sometimes a
30780 requirement to accept unqualified addresses from specific hosts or IP networks.
30781
30782 Exim has two options that separately control which hosts may send unqualified
30783 sender or recipient addresses in SMTP commands, namely
30784 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
30785 cases, if an unqualified address is accepted, it is qualified by adding the
30786 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
30787
30788 .oindex "&%qualify_domain%&"
30789 .oindex "&%qualify_recipient%&"
30790 Unqualified addresses in header lines are automatically qualified for messages
30791 that are locally originated, unless the &%-bnq%& option is given on the command
30792 line. For messages received over SMTP, unqualified addresses in header lines
30793 are qualified only if unqualified addresses are permitted in SMTP commands. In
30794 other words, such qualification is also controlled by
30795 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
30796
30797
30798
30799
30800 .section "The UUCP From line" "SECID219"
30801 .cindex "&""From""& line"
30802 .cindex "UUCP" "&""From""& line"
30803 .cindex "sender" "address"
30804 .oindex "&%uucp_from_pattern%&"
30805 .oindex "&%uucp_from_sender%&"
30806 .cindex "envelope sender"
30807 .cindex "Sendmail compatibility" "&""From""& line"
30808 Messages that have come from UUCP (and some other applications) often begin
30809 with a line containing the envelope sender and a timestamp, following the word
30810 &"From"&. Examples of two common formats are:
30811 .code
30812 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
30813 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
30814 .endd
30815 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
30816 Exim recognizes such lines at the start of messages that are submitted to it
30817 via the command line (that is, on the standard input). It does not recognize
30818 such lines in incoming SMTP messages, unless the sending host matches
30819 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
30820 and &%ignore_fromline_local%& is set. The recognition is controlled by a
30821 regular expression that is defined by the &%uucp_from_pattern%& option, whose
30822 default value matches the two common cases shown above and puts the address
30823 that follows &"From"& into &$1$&.
30824
30825 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
30826 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
30827 a trusted user, the message's sender address is constructed by expanding the
30828 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
30829 then parsed as an RFC 2822 address. If there is no domain, the local part is
30830 qualified with &%qualify_domain%& unless it is the empty string. However, if
30831 the command line &%-f%& option is used, it overrides the &"From"& line.
30832
30833 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
30834 sender address is not changed. This is also the case for incoming SMTP messages
30835 that are permitted to contain &"From"& lines.
30836
30837 Only one &"From"& line is recognized. If there is more than one, the second is
30838 treated as a data line that starts the body of the message, as it is not valid
30839 as a header line. This also happens if a &"From"& line is present in an
30840 incoming SMTP message from a source that is not permitted to send them.
30841
30842
30843
30844 .section "Resent- header lines" "SECID220"
30845 .cindex "&%Resent-%& header lines"
30846 RFC 2822 makes provision for sets of header lines starting with the string
30847 &`Resent-`& to be added to a message when it is resent by the original
30848 recipient to somebody else. These headers are &'Resent-Date:'&,
30849 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
30850 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
30851
30852 .blockquote
30853 &'Resent fields are strictly informational. They MUST NOT be used in the normal
30854 processing of replies or other such automatic actions on messages.'&
30855 .endblockquote
30856
30857 This leaves things a bit vague as far as other processing actions such as
30858 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30859 follows:
30860
30861 .ilist
30862 A &'Resent-From:'& line that just contains the login id of the submitting user
30863 is automatically rewritten in the same way as &'From:'& (see below).
30864 .next
30865 If there's a rewriting rule for a particular header line, it is also applied to
30866 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30867 &'From:'& also rewrites &'Resent-From:'&.
30868 .next
30869 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30870 also removed.
30871 .next
30872 For a locally-submitted message,
30873 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30874 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30875 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30876 included in log lines in this case.
30877 .next
30878 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30879 &%Resent-%& header lines are present.
30880 .endlist
30881
30882
30883
30884
30885 .section "The Auto-Submitted: header line" "SECID221"
30886 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30887 includes the header line:
30888 .code
30889 Auto-Submitted: auto-replied
30890 .endd
30891
30892 .section "The Bcc: header line" "SECID222"
30893 .cindex "&'Bcc:'& header line"
30894 If Exim is called with the &%-t%& option, to take recipient addresses from a
30895 message's header, it removes any &'Bcc:'& header line that may exist (after
30896 extracting its addresses). If &%-t%& is not present on the command line, any
30897 existing &'Bcc:'& is not removed.
30898
30899
30900 .section "The Date: header line" "SECID223"
30901 .cindex "&'Date:'& header line"
30902 If a locally-generated or submission-mode message has no &'Date:'& header line,
30903 Exim adds one, using the current date and time, unless the
30904 &%suppress_local_fixups%& control has been specified.
30905
30906 .section "The Delivery-date: header line" "SECID224"
30907 .cindex "&'Delivery-date:'& header line"
30908 .oindex "&%delivery_date_remove%&"
30909 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30910 set. Exim can be configured to add them to the final delivery of messages. (See
30911 the generic &%delivery_date_add%& transport option.) They should not be present
30912 in messages in transit. If the &%delivery_date_remove%& configuration option is
30913 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30914 messages.
30915
30916
30917 .section "The Envelope-to: header line" "SECID225"
30918 .cindex "&'Envelope-to:'& header line"
30919 .oindex "&%envelope_to_remove%&"
30920 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30921 Exim can be configured to add them to the final delivery of messages. (See the
30922 generic &%envelope_to_add%& transport option.) They should not be present in
30923 messages in transit. If the &%envelope_to_remove%& configuration option is set
30924 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30925 messages.
30926
30927
30928 .section "The From: header line" "SECTthefrohea"
30929 .cindex "&'From:'& header line"
30930 .cindex "Sendmail compatibility" "&""From""& line"
30931 .cindex "message" "submission"
30932 .cindex "submission mode"
30933 If a submission-mode message does not contain a &'From:'& header line, Exim
30934 adds one if either of the following conditions is true:
30935
30936 .ilist
30937 The envelope sender address is not empty (that is, this is not a bounce
30938 message). The added header line copies the envelope sender address.
30939 .next
30940 .vindex "&$authenticated_id$&"
30941 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30942 .olist
30943 .vindex "&$qualify_domain$&"
30944 If no domain is specified by the submission control, the local part is
30945 &$authenticated_id$& and the domain is &$qualify_domain$&.
30946 .next
30947 If a non-empty domain is specified by the submission control, the local
30948 part is &$authenticated_id$&, and the domain is the specified domain.
30949 .next
30950 If an empty domain is specified by the submission control,
30951 &$authenticated_id$& is assumed to be the complete address.
30952 .endlist
30953 .endlist
30954
30955 A non-empty envelope sender takes precedence.
30956
30957 If a locally-generated incoming message does not contain a &'From:'& header
30958 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30959 containing the sender's address. The calling user's login name and full name
30960 are used to construct the address, as described in section &<<SECTconstr>>&.
30961 They are obtained from the password data by calling &[getpwuid()]& (but see the
30962 &%unknown_login%& configuration option). The address is qualified with
30963 &%qualify_domain%&.
30964
30965 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30966 &'From:'& header line containing just the unqualified login name of the calling
30967 user, this is replaced by an address containing the user's login name and full
30968 name as described in section &<<SECTconstr>>&.
30969
30970
30971 .section "The Message-ID: header line" "SECID226"
30972 .cindex "&'Message-ID:'& header line"
30973 .cindex "message" "submission"
30974 .oindex "&%message_id_header_text%&"
30975 If a locally-generated or submission-mode incoming message does not contain a
30976 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30977 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30978 to the message. If there are any &'Resent-:'& headers in the message, it
30979 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30980 message id, preceded by the letter E to ensure it starts with a letter, and
30981 followed by @ and the primary host name. Additional information can be included
30982 in this header line by setting the &%message_id_header_text%& and/or
30983 &%message_id_header_domain%& options.
30984
30985
30986 .section "The Received: header line" "SECID227"
30987 .cindex "&'Received:'& header line"
30988 A &'Received:'& header line is added at the start of every message. The
30989 contents are defined by the &%received_header_text%& configuration option, and
30990 Exim automatically adds a semicolon and a timestamp to the configured string.
30991
30992 The &'Received:'& header is generated as soon as the message's header lines
30993 have been received. At this stage, the timestamp in the &'Received:'& header
30994 line is the time that the message started to be received. This is the value
30995 that is seen by the DATA ACL and by the &[local_scan()]& function.
30996
30997 Once a message is accepted, the timestamp in the &'Received:'& header line is
30998 changed to the time of acceptance, which is (apart from a small delay while the
30999 -H spool file is written) the earliest time at which delivery could start.
31000
31001
31002 .section "The References: header line" "SECID228"
31003 .cindex "&'References:'& header line"
31004 Messages created by the &(autoreply)& transport include a &'References:'&
31005 header line. This is constructed according to the rules that are described in
31006 section 3.64 of RFC 2822 (which states that replies should contain such a
31007 header line), and section 3.14 of RFC 3834 (which states that automatic
31008 responses are not different in this respect). However, because some mail
31009 processing software does not cope well with very long header lines, no more
31010 than 12 message IDs are copied from the &'References:'& header line in the
31011 incoming message. If there are more than 12, the first one and then the final
31012 11 are copied, before adding the message ID of the incoming message.
31013
31014
31015
31016 .section "The Return-path: header line" "SECID229"
31017 .cindex "&'Return-path:'& header line"
31018 .oindex "&%return_path_remove%&"
31019 &'Return-path:'& header lines are defined as something an MTA may insert when
31020 it does the final delivery of messages. (See the generic &%return_path_add%&
31021 transport option.) Therefore, they should not be present in messages in
31022 transit. If the &%return_path_remove%& configuration option is set (the
31023 default), Exim removes &'Return-path:'& header lines from incoming messages.
31024
31025
31026
31027 .section "The Sender: header line" "SECTthesenhea"
31028 .cindex "&'Sender:'& header line"
31029 .cindex "message" "submission"
31030 For a locally-originated message from an untrusted user, Exim may remove an
31031 existing &'Sender:'& header line, and it may add a new one. You can modify
31032 these actions by setting the &%local_sender_retain%& option true, the
31033 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31034 control setting.
31035
31036 When a local message is received from an untrusted user and
31037 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31038 control has not been set, a check is made to see if the address given in the
31039 &'From:'& header line is the correct (local) sender of the message. The address
31040 that is expected has the login name as the local part and the value of
31041 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31042 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31043 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31044 line is added to the message.
31045
31046 If you set &%local_from_check%& false, this checking does not occur. However,
31047 the removal of an existing &'Sender:'& line still happens, unless you also set
31048 &%local_sender_retain%& to be true. It is not possible to set both of these
31049 options true at the same time.
31050
31051 .cindex "submission mode"
31052 By default, no processing of &'Sender:'& header lines is done for messages
31053 received over TCP/IP or for messages submitted by trusted users. However, when
31054 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31055 not specified on the submission control, the following processing takes place:
31056
31057 .vindex "&$authenticated_id$&"
31058 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31059 authenticated, and &$authenticated_id$& is not empty, a sender address is
31060 created as follows:
31061
31062 .ilist
31063 .vindex "&$qualify_domain$&"
31064 If no domain is specified by the submission control, the local part is
31065 &$authenticated_id$& and the domain is &$qualify_domain$&.
31066 .next
31067 If a non-empty domain is specified by the submission control, the local part
31068 is &$authenticated_id$&, and the domain is the specified domain.
31069 .next
31070 If an empty domain is specified by the submission control,
31071 &$authenticated_id$& is assumed to be the complete address.
31072 .endlist
31073
31074 This address is compared with the address in the &'From:'& header line. If they
31075 are different, a &'Sender:'& header line containing the created address is
31076 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31077 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31078
31079 .cindex "return path" "created from &'Sender:'&"
31080 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31081 the message (the envelope sender address) is changed to be the same address,
31082 except in the case of submission mode when &%sender_retain%& is specified.
31083
31084
31085
31086 .section "Adding and removing header lines in routers and transports" &&&
31087          "SECTheadersaddrem"
31088 .cindex "header lines" "adding; in router or transport"
31089 .cindex "header lines" "removing; in router or transport"
31090 When a message is delivered, the addition and removal of header lines can be
31091 specified in a system filter, or on any of the routers and transports that
31092 process the message. Section &<<SECTaddremheasys>>& contains details about
31093 modifying headers in a system filter. Header lines can also be added in an ACL
31094 as a message is received (see section &<<SECTaddheadacl>>&).
31095
31096 In contrast to what happens in a system filter, header modifications that are
31097 specified on routers and transports apply only to the particular recipient
31098 addresses that are being processed by those routers and transports. These
31099 changes do not actually take place until a copy of the message is being
31100 transported. Therefore, they do not affect the basic set of header lines, and
31101 they do not affect the values of the variables that refer to header lines.
31102
31103 &*Note*&: In particular, this means that any expansions in the configuration of
31104 the transport cannot refer to the modified header lines, because such
31105 expansions all occur before the message is actually transported.
31106
31107 For both routers and transports, the result of expanding a &%headers_add%&
31108 option must be in the form of one or more RFC 2822 header lines, separated by
31109 newlines (coded as &"\n"&). For example:
31110 .code
31111 headers_add = X-added-header: added by $primary_hostname\n\
31112               X-added-second: another added header line
31113 .endd
31114 Exim does not check the syntax of these added header lines.
31115
31116 The result of expanding &%headers_remove%& must consist of a colon-separated
31117 list of header names. This is confusing, because header names themselves are
31118 often terminated by colons. In this case, the colons are the list separators,
31119 not part of the names. For example:
31120 .code
31121 headers_remove = return-receipt-to:acknowledge-to
31122 .endd
31123 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31124 is expanded at routing time, and then associated with all addresses that are
31125 accepted by that router, and also with any new addresses that it generates. If
31126 an address passes through several routers as a result of aliasing or
31127 forwarding, the changes are cumulative.
31128
31129 .oindex "&%unseen%&"
31130 However, this does not apply to multiple routers that result from the use of
31131 the &%unseen%& option. Any header modifications that were specified by the
31132 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31133
31134 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31135 settings cannot be delivered together in a batch, so a transport is always
31136 dealing with a set of addresses that have the same header-processing
31137 requirements.
31138
31139 The transport starts by writing the original set of header lines that arrived
31140 with the message, possibly modified by the system filter. As it writes out
31141 these lines, it consults the list of header names that were attached to the
31142 recipient address(es) by &%headers_remove%& options in routers, and it also
31143 consults the transport's own &%headers_remove%& option. Header lines whose
31144 names are on either of these lists are not written out. If there are multiple
31145 instances of any listed header, they are all skipped.
31146
31147 After the remaining original header lines have been written, new header
31148 lines that were specified by routers' &%headers_add%& options are written, in
31149 the order in which they were attached to the address. These are followed by any
31150 header lines specified by the transport's &%headers_add%& option.
31151
31152 This way of handling header line modifications in routers and transports has
31153 the following consequences:
31154
31155 .ilist
31156 The original set of header lines, possibly modified by the system filter,
31157 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31158 to it, at all times.
31159 .next
31160 Header lines that are added by a router's
31161 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31162 expansion syntax in subsequent routers or the transport.
31163 .next
31164 Conversely, header lines that are specified for removal by &%headers_remove%&
31165 in a router remain visible to subsequent routers and the transport.
31166 .next
31167 Headers added to an address by &%headers_add%& in a router cannot be removed by
31168 a later router or by a transport.
31169 .next
31170 An added header can refer to the contents of an original header that is to be
31171 removed, even it has the same name as the added header. For example:
31172 .code
31173 headers_remove = subject
31174 headers_add = Subject: new subject (was: $h_subject:)
31175 .endd
31176 .endlist
31177
31178 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31179 for a &(redirect)& router that has the &%one_time%& option set.
31180
31181
31182
31183
31184
31185 .section "Constructed addresses" "SECTconstr"
31186 .cindex "address" "constructed"
31187 .cindex "constructed address"
31188 When Exim constructs a sender address for a locally-generated message, it uses
31189 the form
31190 .display
31191 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31192 .endd
31193 For example:
31194 .code
31195 Zaphod Beeblebrox <zaphod@end.univ.example>
31196 .endd
31197 The user name is obtained from the &%-F%& command line option if set, or
31198 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31199 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31200 ampersand character, this is replaced by the login name with the first letter
31201 upper cased, as is conventional in a number of operating systems. See the
31202 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31203 The &%unknown_username%& option can be used to specify user names in cases when
31204 there is no password file entry.
31205
31206 .cindex "RFC 2047"
31207 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31208 parts of it if necessary. In addition, if it contains any non-printing
31209 characters, it is encoded as described in RFC 2047, which defines a way of
31210 including non-ASCII characters in header lines. The value of the
31211 &%headers_charset%& option specifies the name of the encoding that is used (the
31212 characters are assumed to be in this encoding). The setting of
31213 &%print_topbitchars%& controls whether characters with the top bit set (that
31214 is, with codes greater than 127) count as printing characters or not.
31215
31216
31217
31218 .section "Case of local parts" "SECID230"
31219 .cindex "case of local parts"
31220 .cindex "local part" "case of"
31221 RFC 2822 states that the case of letters in the local parts of addresses cannot
31222 be assumed to be non-significant. Exim preserves the case of local parts of
31223 addresses, but by default it uses a lower-cased form when it is routing,
31224 because on most Unix systems, usernames are in lower case and case-insensitive
31225 routing is required. However, any particular router can be made to use the
31226 original case for local parts by setting the &%caseful_local_part%& generic
31227 router option.
31228
31229 .cindex "mixed-case login names"
31230 If you must have mixed-case user names on your system, the best way to proceed,
31231 assuming you want case-independent handling of incoming email, is to set up
31232 your first router to convert incoming local parts in your domains to the
31233 correct case by means of a file lookup. For example:
31234 .code
31235 correct_case:
31236   driver = redirect
31237   domains = +local_domains
31238   data = ${lookup{$local_part}cdb\
31239               {/etc/usercased.cdb}{$value}fail}\
31240               @$domain
31241 .endd
31242 For this router, the local part is forced to lower case by the default action
31243 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31244 up a new local part in the correct case. If you then set &%caseful_local_part%&
31245 on any subsequent routers which process your domains, they will operate on
31246 local parts with the correct case in a case-sensitive manner.
31247
31248
31249
31250 .section "Dots in local parts" "SECID231"
31251 .cindex "dot" "in local part"
31252 .cindex "local part" "dots in"
31253 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31254 part may not begin or end with a dot, nor have two consecutive dots in the
31255 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31256 empty components for compatibility.
31257
31258
31259
31260 .section "Rewriting addresses" "SECID232"
31261 .cindex "rewriting" "addresses"
31262 Rewriting of sender and recipient addresses, and addresses in headers, can
31263 happen automatically, or as the result of configuration options, as described
31264 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31265 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31266
31267 Automatic rewriting includes qualification, as mentioned above. The other case
31268 in which it can happen is when an incomplete non-local domain is given. The
31269 routing process may cause this to be expanded into the full domain name. For
31270 example, a header such as
31271 .code
31272 To: hare@teaparty
31273 .endd
31274 might get rewritten as
31275 .code
31276 To: hare@teaparty.wonderland.fict.example
31277 .endd
31278 Rewriting as a result of routing is the one kind of message processing that
31279 does not happen at input time, as it cannot be done until the address has
31280 been routed.
31281
31282 Strictly, one should not do &'any'& deliveries of a message until all its
31283 addresses have been routed, in case any of the headers get changed as a
31284 result of routing. However, doing this in practice would hold up many
31285 deliveries for unreasonable amounts of time, just because one address could not
31286 immediately be routed. Exim therefore does not delay other deliveries when
31287 routing of one or more addresses is deferred.
31288 .ecindex IIDmesproc
31289
31290
31291
31292 . ////////////////////////////////////////////////////////////////////////////
31293 . ////////////////////////////////////////////////////////////////////////////
31294
31295 .chapter "SMTP processing" "CHAPSMTP"
31296 .scindex IIDsmtpproc1 "SMTP" "processing details"
31297 .scindex IIDsmtpproc2 "LMTP" "processing details"
31298 Exim supports a number of different ways of using the SMTP protocol, and its
31299 LMTP variant, which is an interactive protocol for transferring messages into a
31300 closed mail store application. This chapter contains details of how SMTP is
31301 processed. For incoming mail, the following are available:
31302
31303 .ilist
31304 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31305 .next
31306 SMTP over the standard input and output (the &%-bs%& option);
31307 .next
31308 Batched SMTP on the standard input (the &%-bS%& option).
31309 .endlist
31310
31311 For mail delivery, the following are available:
31312
31313 .ilist
31314 SMTP over TCP/IP (the &(smtp)& transport);
31315 .next
31316 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31317 &"lmtp"&);
31318 .next
31319 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31320 transport);
31321 .next
31322 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31323 the &%use_bsmtp%& option set).
31324 .endlist
31325
31326 &'Batched SMTP'& is the name for a process in which batches of messages are
31327 stored in or read from files (or pipes), in a format in which SMTP commands are
31328 used to contain the envelope information.
31329
31330
31331
31332 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
31333 .cindex "SMTP" "outgoing over TCP/IP"
31334 .cindex "outgoing SMTP over TCP/IP"
31335 .cindex "LMTP" "over TCP/IP"
31336 .cindex "outgoing LMTP over TCP/IP"
31337 .cindex "EHLO"
31338 .cindex "HELO"
31339 .cindex "SIZE option on MAIL command"
31340 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
31341 The &%protocol%& option selects which protocol is to be used, but the actual
31342 processing is the same in both cases.
31343
31344 If, in response to its EHLO command, Exim is told that the SIZE
31345 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
31346 command. The value of <&'n'&> is the message size plus the value of the
31347 &%size_addition%& option (default 1024) to allow for additions to the message
31348 such as per-transport header lines, or changes made in a
31349 .cindex "transport" "filter"
31350 .cindex "filter" "transport filter"
31351 transport filter. If &%size_addition%& is set negative, the use of SIZE is
31352 suppressed.
31353
31354 If the remote server advertises support for PIPELINING, Exim uses the
31355 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
31356 required for the transaction.
31357
31358 If the remote server advertises support for the STARTTLS command, and Exim
31359 was built to support TLS encryption, it tries to start a TLS session unless the
31360 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
31361
31362 If the remote server advertises support for the AUTH command, Exim scans
31363 the authenticators configuration for any suitable client settings, as described
31364 in chapter &<<CHAPSMTPAUTH>>&.
31365
31366 .cindex "carriage return"
31367 .cindex "linefeed"
31368 Responses from the remote host are supposed to be terminated by CR followed by
31369 LF. However, there are known to be hosts that do not send CR characters, so in
31370 order to be able to interwork with such hosts, Exim treats LF on its own as a
31371 line terminator.
31372
31373 If a message contains a number of different addresses, all those with the same
31374 characteristics (for example, the same envelope sender) that resolve to the
31375 same set of hosts, in the same order, are sent in a single SMTP transaction,
31376 even if they are for different domains, unless there are more than the setting
31377 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
31378 they are split into groups containing no more than &%max_rcpt%&s addresses
31379 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
31380 in parallel sessions. The order of hosts with identical MX values is not
31381 significant when checking whether addresses can be batched in this way.
31382
31383 When the &(smtp)& transport suffers a temporary failure that is not
31384 message-related, Exim updates its transport-specific database, which contains
31385 records indexed by host name that remember which messages are waiting for each
31386 particular host. It also updates the retry database with new retry times.
31387
31388 .cindex "hints database" "retry keys"
31389 Exim's retry hints are based on host name plus IP address, so if one address of
31390 a multi-homed host is broken, it will soon be skipped most of the time.
31391 See the next section for more detail about error handling.
31392
31393 .cindex "SMTP" "passed connection"
31394 .cindex "SMTP" "batching over TCP/IP"
31395 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
31396 looks in the hints database for the transport to see if there are any queued
31397 messages waiting for the host to which it is connected. If it finds one, it
31398 creates a new Exim process using the &%-MC%& option (which can only be used by
31399 a process running as root or the Exim user) and passes the TCP/IP socket to it
31400 so that it can deliver another message using the same socket. The new process
31401 does only those deliveries that are routed to the connected host, and may in
31402 turn pass the socket on to a third process, and so on.
31403
31404 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
31405 limit the number of messages sent down a single TCP/IP connection.
31406
31407 .cindex "asterisk" "after IP address"
31408 The second and subsequent messages delivered down an existing connection are
31409 identified in the main log by the addition of an asterisk after the closing
31410 square bracket of the IP address.
31411
31412
31413
31414
31415 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
31416 .cindex "error" "in outgoing SMTP"
31417 .cindex "SMTP" "errors in outgoing"
31418 .cindex "host" "error"
31419 Three different kinds of error are recognized for outgoing SMTP: host errors,
31420 message errors, and recipient errors.
31421
31422 .vlist
31423 .vitem "&*Host errors*&"
31424 A host error is not associated with a particular message or with a
31425 particular recipient of a message. The host errors are:
31426
31427 .ilist
31428 Connection refused or timed out,
31429 .next
31430 Any error response code on connection,
31431 .next
31432 Any error response code to EHLO or HELO,
31433 .next
31434 Loss of connection at any time, except after &"."&,
31435 .next
31436 I/O errors at any time,
31437 .next
31438 Timeouts during the session, other than in response to MAIL, RCPT or
31439 the &"."& at the end of the data.
31440 .endlist ilist
31441
31442 For a host error, a permanent error response on connection, or in response to
31443 EHLO, causes all addresses routed to the host to be failed. Any other host
31444 error causes all addresses to be deferred, and retry data to be created for the
31445 host. It is not tried again, for any message, until its retry time arrives. If
31446 the current set of addresses are not all delivered in this run (to some
31447 alternative host), the message is added to the list of those waiting for this
31448 host, so if it is still undelivered when a subsequent successful delivery is
31449 made to the host, it will be sent down the same SMTP connection.
31450
31451 .vitem "&*Message errors*&"
31452 .cindex "message" "error"
31453 A message error is associated with a particular message when sent to a
31454 particular host, but not with a particular recipient of the message. The
31455 message errors are:
31456
31457 .ilist
31458 Any error response code to MAIL, DATA, or the &"."& that terminates
31459 the data,
31460 .next
31461 Timeout after MAIL,
31462 .next
31463 Timeout or loss of connection after the &"."& that terminates the data. A
31464 timeout after the DATA command itself is treated as a host error, as is loss of
31465 connection at any other time.
31466 .endlist ilist
31467
31468 For a message error, a permanent error response (5&'xx'&) causes all addresses
31469 to be failed, and a delivery error report to be returned to the sender. A
31470 temporary error response (4&'xx'&), or one of the timeouts, causes all
31471 addresses to be deferred. Retry data is not created for the host, but instead,
31472 a retry record for the combination of host plus message id is created. The
31473 message is not added to the list of those waiting for this host. This ensures
31474 that the failing message will not be sent to this host again until the retry
31475 time arrives. However, other messages that are routed to the host are not
31476 affected, so if it is some property of the message that is causing the error,
31477 it will not stop the delivery of other mail.
31478
31479 If the remote host specified support for the SIZE parameter in its response
31480 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
31481 over-large message will cause a message error because the error arrives as a
31482 response to MAIL.
31483
31484 .vitem "&*Recipient errors*&"
31485 .cindex "recipient" "error"
31486 A recipient error is associated with a particular recipient of a message. The
31487 recipient errors are:
31488
31489 .ilist
31490 Any error response to RCPT,
31491 .next
31492 Timeout after RCPT.
31493 .endlist
31494
31495 For a recipient error, a permanent error response (5&'xx'&) causes the
31496 recipient address to be failed, and a bounce message to be returned to the
31497 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
31498 address to be deferred, and routing retry data to be created for it. This is
31499 used to delay processing of the address in subsequent queue runs, until its
31500 routing retry time arrives. This applies to all messages, but because it
31501 operates only in queue runs, one attempt will be made to deliver a new message
31502 to the failing address before the delay starts to operate. This ensures that,
31503 if the failure is really related to the message rather than the recipient
31504 (&"message too big for this recipient"& is a possible example), other messages
31505 have a chance of getting delivered. If a delivery to the address does succeed,
31506 the retry information gets cleared, so all stuck messages get tried again, and
31507 the retry clock is reset.
31508
31509 The message is not added to the list of those waiting for this host. Use of the
31510 host for other messages is unaffected, and except in the case of a timeout,
31511 other recipients are processed independently, and may be successfully delivered
31512 in the current SMTP session. After a timeout it is of course impossible to
31513 proceed with the session, so all addresses get deferred. However, those other
31514 than the one that failed do not suffer any subsequent retry delays. Therefore,
31515 if one recipient is causing trouble, the others have a chance of getting
31516 through when a subsequent delivery attempt occurs before the failing
31517 recipient's retry time.
31518 .endlist
31519
31520 In all cases, if there are other hosts (or IP addresses) available for the
31521 current set of addresses (for example, from multiple MX records), they are
31522 tried in this run for any undelivered addresses, subject of course to their
31523 own retry data. In other words, recipient error retry data does not take effect
31524 until the next delivery attempt.
31525
31526 Some hosts have been observed to give temporary error responses to every
31527 MAIL command at certain times (&"insufficient space"& has been seen). It
31528 would be nice if such circumstances could be recognized, and defer data for the
31529 host itself created, but this is not possible within the current Exim design.
31530 What actually happens is that retry data for every (host, message) combination
31531 is created.
31532
31533 The reason that timeouts after MAIL and RCPT are treated specially is that
31534 these can sometimes arise as a result of the remote host's verification
31535 procedures. Exim makes this assumption, and treats them as if a temporary error
31536 response had been received. A timeout after &"."& is treated specially because
31537 it is known that some broken implementations fail to recognize the end of the
31538 message if the last character of the last line is a binary zero. Thus, it is
31539 helpful to treat this case as a message error.
31540
31541 Timeouts at other times are treated as host errors, assuming a problem with the
31542 host, or the connection to it. If a timeout after MAIL, RCPT,
31543 or &"."& is really a connection problem, the assumption is that at the next try
31544 the timeout is likely to occur at some other point in the dialogue, causing it
31545 then to be treated as a host error.
31546
31547 There is experimental evidence that some MTAs drop the connection after the
31548 terminating &"."& if they do not like the contents of the message for some
31549 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
31550 should be given. That is why Exim treats this case as a message rather than a
31551 host error, in order not to delay other messages to the same host.
31552
31553
31554
31555
31556 .section "Incoming SMTP messages over TCP/IP" "SECID233"
31557 .cindex "SMTP" "incoming over TCP/IP"
31558 .cindex "incoming SMTP over TCP/IP"
31559 .cindex "inetd"
31560 .cindex "daemon"
31561 Incoming SMTP messages can be accepted in one of two ways: by running a
31562 listening daemon, or by using &'inetd'&. In the latter case, the entry in
31563 &_/etc/inetd.conf_& should be like this:
31564 .code
31565 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
31566 .endd
31567 Exim distinguishes between this case and the case of a locally running user
31568 agent using the &%-bs%& option by checking whether or not the standard input is
31569 a socket. When it is, either the port must be privileged (less than 1024), or
31570 the caller must be root or the Exim user. If any other user passes a socket
31571 with an unprivileged port number, Exim prints a message on the standard error
31572 stream and exits with an error code.
31573
31574 By default, Exim does not make a log entry when a remote host connects or
31575 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
31576 unexpected. It can be made to write such log entries by setting the
31577 &%smtp_connection%& log selector.
31578
31579 .cindex "carriage return"
31580 .cindex "linefeed"
31581 Commands from the remote host are supposed to be terminated by CR followed by
31582 LF. However, there are known to be hosts that do not send CR characters. In
31583 order to be able to interwork with such hosts, Exim treats LF on its own as a
31584 line terminator.
31585 Furthermore, because common code is used for receiving messages from all
31586 sources, a CR on its own is also interpreted as a line terminator. However, the
31587 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
31588
31589 .cindex "EHLO" "invalid data"
31590 .cindex "HELO" "invalid data"
31591 One area that sometimes gives rise to problems concerns the EHLO or
31592 HELO commands. Some clients send syntactically invalid versions of these
31593 commands, which Exim rejects by default. (This is nothing to do with verifying
31594 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
31595 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
31596 match the broken hosts that send invalid commands.
31597
31598 .cindex "SIZE option on MAIL command"
31599 .cindex "MAIL" "SIZE option"
31600 The amount of disk space available is checked whenever SIZE is received on
31601 a MAIL command, independently of whether &%message_size_limit%& or
31602 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
31603 false. A temporary error is given if there is not enough space. If
31604 &%check_spool_space%& is set, the check is for that amount of space plus the
31605 value given with SIZE, that is, it checks that the addition of the incoming
31606 message will not reduce the space below the threshold.
31607
31608 When a message is successfully received, Exim includes the local message id in
31609 its response to the final &"."& that terminates the data. If the remote host
31610 logs this text it can help with tracing what has happened to a message.
31611
31612 The Exim daemon can limit the number of simultaneous incoming connections it is
31613 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
31614 number of simultaneous incoming connections from a single remote host (see the
31615 &%smtp_accept_max_per_host%& option). Additional connection attempts are
31616 rejected using the SMTP temporary error code 421.
31617
31618 The Exim daemon does not rely on the SIGCHLD signal to detect when a
31619 subprocess has finished, as this can get lost at busy times. Instead, it looks
31620 for completed subprocesses every time it wakes up. Provided there are other
31621 things happening (new incoming calls, starts of queue runs), completed
31622 processes will be noticed and tidied away. On very quiet systems you may
31623 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
31624 it will be noticed when the daemon next wakes up.
31625
31626 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
31627 and can also be set up to reject SMTP calls from non-reserved hosts at times of
31628 high system load &-- for details see the &%smtp_accept_reserve%&,
31629 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
31630 applies in both the daemon and &'inetd'& cases.
31631
31632 Exim normally starts a delivery process for each message received, though this
31633 can be varied by means of the &%-odq%& command line option and the
31634 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
31635 number of simultaneously running delivery processes started in this way from
31636 SMTP input can be limited by the &%smtp_accept_queue%& and
31637 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
31638 subsequently received messages are just put on the input queue without starting
31639 a delivery process.
31640
31641 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
31642 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
31643 started up from the &'inetd'& daemon, because in that case each connection is
31644 handled by an entirely independent Exim process. Control by load average is,
31645 however, available with &'inetd'&.
31646
31647 Exim can be configured to verify addresses in incoming SMTP commands as they
31648 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
31649 to rewrite addresses at this time &-- before any syntax checking is done. See
31650 section &<<SECTrewriteS>>&.
31651
31652 Exim can also be configured to limit the rate at which a client host submits
31653 MAIL and RCPT commands in a single SMTP session. See the
31654 &%smtp_ratelimit_hosts%& option.
31655
31656
31657
31658 .section "Unrecognized SMTP commands" "SECID234"
31659 .cindex "SMTP" "unrecognized commands"
31660 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
31661 commands during a single SMTP connection, it drops the connection after sending
31662 the error response to the last command. The default value for
31663 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
31664 abuse that subvert web servers into making connections to SMTP ports; in these
31665 circumstances, a number of non-SMTP lines are sent first.
31666
31667
31668 .section "Syntax and protocol errors in SMTP commands" "SECID235"
31669 .cindex "SMTP" "syntax errors"
31670 .cindex "SMTP" "protocol errors"
31671 A syntax error is detected if an SMTP command is recognized, but there is
31672 something syntactically wrong with its data, for example, a malformed email
31673 address in a RCPT command. Protocol errors include invalid command
31674 sequencing such as RCPT before MAIL. If Exim receives more than
31675 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
31676 drops the connection after sending the error response to the last command. The
31677 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
31678 broken clients that loop sending bad commands (yes, it has been seen).
31679
31680
31681
31682 .section "Use of non-mail SMTP commands" "SECID236"
31683 .cindex "SMTP" "non-mail commands"
31684 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
31685 DATA. Exim counts such commands, and drops the connection if there are too
31686 many of them in a single SMTP session. This action catches some
31687 denial-of-service attempts and things like repeated failing AUTHs, or a mad
31688 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
31689 defines what &"too many"& means. Its default value is 10.
31690
31691 When a new message is expected, one occurrence of RSET is not counted. This
31692 allows a client to send one RSET between messages (this is not necessary,
31693 but some clients do it). Exim also allows one uncounted occurrence of HELO
31694 or EHLO, and one occurrence of STARTTLS between messages. After
31695 starting up a TLS session, another EHLO is expected, and so it too is not
31696 counted.
31697
31698 The first occurrence of AUTH in a connection, or immediately following
31699 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
31700 RCPT, DATA, and QUIT are counted.
31701
31702 You can control which hosts are subject to the limit set by
31703 &%smtp_accept_max_nonmail%& by setting
31704 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
31705 the limit apply to all hosts. This option means that you can exclude any
31706 specific badly-behaved hosts that you have to live with.
31707
31708
31709
31710
31711 .section "The VRFY and EXPN commands" "SECID237"
31712 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
31713 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
31714 appropriate) in order to decide whether the command should be accepted or not.
31715 If no ACL is defined, the command is rejected.
31716
31717 .cindex "VRFY" "processing"
31718 When VRFY is accepted, it runs exactly the same code as when Exim is
31719 called with the &%-bv%& option.
31720
31721 .cindex "EXPN" "processing"
31722 When EXPN is accepted, a single-level expansion of the address is done.
31723 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
31724 than a verification (the &%-bv%& option). If an unqualified local part is given
31725 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
31726 of VRFY and EXPN commands are logged on the main and reject logs, and
31727 VRFY verification failures are logged on the main log for consistency with
31728 RCPT failures.
31729
31730
31731
31732 .section "The ETRN command" "SECTETRN"
31733 .cindex "ETRN" "processing"
31734 RFC 1985 describes an SMTP command called ETRN that is designed to
31735 overcome the security problems of the TURN command (which has fallen into
31736 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
31737 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
31738 should be accepted or not. If no ACL is defined, the command is rejected.
31739
31740 The ETRN command is concerned with &"releasing"& messages that are awaiting
31741 delivery to certain hosts. As Exim does not organize its message queue by host,
31742 the only form of ETRN that is supported by default is the one where the
31743 text starts with the &"#"& prefix, in which case the remainder of the text is
31744 specific to the SMTP server. A valid ETRN command causes a run of Exim with
31745 the &%-R%& option to happen, with the remainder of the ETRN text as its
31746 argument. For example,
31747 .code
31748 ETRN #brigadoon
31749 .endd
31750 runs the command
31751 .code
31752 exim -R brigadoon
31753 .endd
31754 which causes a delivery attempt on all messages with undelivered addresses
31755 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
31756 default), Exim prevents the simultaneous execution of more than one queue run
31757 for the same argument string as a result of an ETRN command. This stops
31758 a misbehaving client from starting more than one queue runner at once.
31759
31760 .cindex "hints database" "ETRN serialization"
31761 Exim implements the serialization by means of a hints database in which a
31762 record is written whenever a process is started by ETRN, and deleted when
31763 the process completes. However, Exim does not keep the SMTP session waiting for
31764 the ETRN process to complete. Once ETRN is accepted, the client is sent
31765 a &"success"& return code. Obviously there is scope for hints records to get
31766 left lying around if there is a system or program crash. To guard against this,
31767 Exim ignores any records that are more than six hours old.
31768
31769 .oindex "&%smtp_etrn_command%&"
31770 For more control over what ETRN does, the &%smtp_etrn_command%& option can
31771 used. This specifies a command that is run whenever ETRN is received,
31772 whatever the form of its argument. For
31773 example:
31774 .code
31775 smtp_etrn_command = /etc/etrn_command $domain \
31776                     $sender_host_address
31777 .endd
31778 .vindex "&$domain$&"
31779 The string is split up into arguments which are independently expanded. The
31780 expansion variable &$domain$& is set to the argument of the ETRN command,
31781 and no syntax checking is done on the contents of this argument. Exim does not
31782 wait for the command to complete, so its status code is not checked. Exim runs
31783 under its own uid and gid when receiving incoming SMTP, so it is not possible
31784 for it to change them before running the command.
31785
31786
31787
31788 .section "Incoming local SMTP" "SECID238"
31789 .cindex "SMTP" "local incoming"
31790 Some user agents use SMTP to pass messages to their local MTA using the
31791 standard input and output, as opposed to passing the envelope on the command
31792 line and writing the message to the standard input. This is supported by the
31793 &%-bs%& option. This form of SMTP is handled in the same way as incoming
31794 messages over TCP/IP (including the use of ACLs), except that the envelope
31795 sender given in a MAIL command is ignored unless the caller is trusted. In
31796 an ACL you can detect this form of SMTP input by testing for an empty host
31797 identification. It is common to have this as the first line in the ACL that
31798 runs for RCPT commands:
31799 .code
31800 accept hosts = :
31801 .endd
31802 This accepts SMTP messages from local processes without doing any other tests.
31803
31804
31805
31806 .section "Outgoing batched SMTP" "SECTbatchSMTP"
31807 .cindex "SMTP" "batched outgoing"
31808 .cindex "batched SMTP output"
31809 Both the &(appendfile)& and &(pipe)& transports can be used for handling
31810 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
31811 be output in BSMTP format. No SMTP responses are possible for this form of
31812 delivery. All it is doing is using SMTP commands as a way of transmitting the
31813 envelope along with the message.
31814
31815 The message is written to the file or pipe preceded by the SMTP commands
31816 MAIL and RCPT, and followed by a line containing a single dot. Lines in
31817 the message that start with a dot have an extra dot added. The SMTP command
31818 HELO is not normally used. If it is required, the &%message_prefix%& option
31819 can be used to specify it.
31820
31821 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
31822 one recipient address at a time by default. However, you can arrange for them
31823 to handle several addresses at once by setting the &%batch_max%& option. When
31824 this is done for BSMTP, messages may contain multiple RCPT commands. See
31825 chapter &<<CHAPbatching>>& for more details.
31826
31827 .vindex "&$host$&"
31828 When one or more addresses are routed to a BSMTP transport by a router that
31829 sets up a host list, the name of the first host on the list is available to the
31830 transport in the variable &$host$&. Here is an example of such a transport and
31831 router:
31832 .code
31833 begin routers
31834 route_append:
31835   driver = manualroute
31836   transport = smtp_appendfile
31837   route_list = domain.example  batch.host.example
31838
31839 begin transports
31840 smtp_appendfile:
31841   driver = appendfile
31842   directory = /var/bsmtp/$host
31843   batch_max = 1000
31844   use_bsmtp
31845   user = exim
31846 .endd
31847 This causes messages addressed to &'domain.example'& to be written in BSMTP
31848 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
31849 message (unless there are more than 1000 recipients).
31850
31851
31852
31853 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
31854 .cindex "SMTP" "batched incoming"
31855 .cindex "batched SMTP input"
31856 The &%-bS%& command line option causes Exim to accept one or more messages by
31857 reading SMTP on the standard input, but to generate no responses. If the caller
31858 is trusted, the senders in the MAIL commands are believed; otherwise the
31859 sender is always the caller of Exim. Unqualified senders and receivers are not
31860 rejected (there seems little point) but instead just get qualified. HELO
31861 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31862 as NOOP; QUIT quits.
31863
31864 Minimal policy checking is done for BSMTP input. Only the non-SMTP
31865 ACL is run in the same way as for non-SMTP local input.
31866
31867 If an error is detected while reading a message, including a missing &"."& at
31868 the end, Exim gives up immediately. It writes details of the error to the
31869 standard output in a stylized way that the calling program should be able to
31870 make some use of automatically, for example:
31871 .code
31872 554 Unexpected end of file
31873 Transaction started in line 10
31874 Error detected in line 14
31875 .endd
31876 It writes a more verbose version, for human consumption, to the standard error
31877 file, for example:
31878 .code
31879 An error was detected while processing a file of BSMTP input.
31880 The error message was:
31881
31882 501 '>' missing at end of address
31883
31884 The SMTP transaction started in line 10.
31885 The error was detected in line 12.
31886 The SMTP command at fault was:
31887
31888 rcpt to:<malformed@in.com.plete
31889
31890 1 previous message was successfully processed.
31891 The rest of the batch was abandoned.
31892 .endd
31893 The return code from Exim is zero only if there were no errors. It is 1 if some
31894 messages were accepted before an error was detected, and 2 if no messages were
31895 accepted.
31896 .ecindex IIDsmtpproc1
31897 .ecindex IIDsmtpproc2
31898
31899
31900
31901 . ////////////////////////////////////////////////////////////////////////////
31902 . ////////////////////////////////////////////////////////////////////////////
31903
31904 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31905          "Customizing messages"
31906 When a message fails to be delivered, or remains on the queue for more than a
31907 configured amount of time, Exim sends a message to the original sender, or
31908 to an alternative configured address. The text of these messages is built into
31909 the code of Exim, but it is possible to change it, either by adding a single
31910 string, or by replacing each of the paragraphs by text supplied in a file.
31911
31912 The &'From:'& and &'To:'& header lines are automatically generated; you can
31913 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31914 option. Exim also adds the line
31915 .code
31916 Auto-Submitted: auto-generated
31917 .endd
31918 to all warning and bounce messages,
31919
31920
31921 .section "Customizing bounce messages" "SECID239"
31922 .cindex "customizing" "bounce message"
31923 .cindex "bounce message" "customizing"
31924 If &%bounce_message_text%& is set, its contents are included in the default
31925 message immediately after &"This message was created automatically by mail
31926 delivery software."& The string is not expanded. It is not used if
31927 &%bounce_message_file%& is set.
31928
31929 When &%bounce_message_file%& is set, it must point to a template file for
31930 constructing error messages. The file consists of a series of text items,
31931 separated by lines consisting of exactly four asterisks. If the file cannot be
31932 opened, default text is used and a message is written to the main and panic
31933 logs. If any text item in the file is empty, default text is used for that
31934 item.
31935
31936 .vindex "&$bounce_recipient$&"
31937 .vindex "&$bounce_return_size_limit$&"
31938 Each item of text that is read from the file is expanded, and there are two
31939 expansion variables which can be of use here: &$bounce_recipient$& is set to
31940 the recipient of an error message while it is being created, and
31941 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31942 option, rounded to a whole number.
31943
31944 The items must appear in the file in the following order:
31945
31946 .ilist
31947 The first item is included in the headers, and should include at least a
31948 &'Subject:'& header. Exim does not check the syntax of these headers.
31949 .next
31950 The second item forms the start of the error message. After it, Exim lists the
31951 failing addresses with their error messages.
31952 .next
31953 The third item is used to introduce any text from pipe transports that is to be
31954 returned to the sender. It is omitted if there is no such text.
31955 .next
31956 The fourth item is used to introduce the copy of the message that is returned
31957 as part of the error report.
31958 .next
31959 The fifth item is added after the fourth one if the returned message is
31960 truncated because it is bigger than &%return_size_limit%&.
31961 .next
31962 The sixth item is added after the copy of the original message.
31963 .endlist
31964
31965 The default state (&%bounce_message_file%& unset) is equivalent to the
31966 following file, in which the sixth item is empty. The &'Subject:'& and some
31967 other lines have been split in order to fit them on the page:
31968 .code
31969 Subject: Mail delivery failed
31970   ${if eq{$sender_address}{$bounce_recipient}
31971   {: returning message to sender}}
31972 ****
31973 This message was created automatically by mail delivery software.
31974
31975 A message ${if eq{$sender_address}{$bounce_recipient}
31976   {that you sent }{sent by
31977
31978 <$sender_address>
31979
31980 }}could not be delivered to all of its recipients.
31981 This is a permanent error. The following address(es) failed:
31982 ****
31983 The following text was generated during the delivery attempt(s):
31984 ****
31985 ------ This is a copy of the message, including all the headers.
31986   ------
31987 ****
31988 ------ The body of the message is $message_size characters long;
31989   only the first
31990 ------ $bounce_return_size_limit or so are included here.
31991 ****
31992 .endd
31993 .section "Customizing warning messages" "SECTcustwarn"
31994 .cindex "customizing" "warning message"
31995 .cindex "warning of delay" "customizing the message"
31996 The option &%warn_message_file%& can be pointed at a template file for use when
31997 warnings about message delays are created. In this case there are only three
31998 text sections:
31999
32000 .ilist
32001 The first item is included in the headers, and should include at least a
32002 &'Subject:'& header. Exim does not check the syntax of these headers.
32003 .next
32004 The second item forms the start of the warning message. After it, Exim lists
32005 the delayed addresses.
32006 .next
32007 The third item then ends the message.
32008 .endlist
32009
32010 The default state is equivalent to the following file, except that some lines
32011 have been split here, in order to fit them on the page:
32012 .code
32013 Subject: Warning: message $message_exim_id delayed
32014   $warn_message_delay
32015 ****
32016 This message was created automatically by mail delivery software.
32017
32018 A message ${if eq{$sender_address}{$warn_message_recipients}
32019 {that you sent }{sent by
32020
32021 <$sender_address>
32022
32023 }}has not been delivered to all of its recipients after
32024 more than $warn_message_delay on the queue on $primary_hostname.
32025
32026 The message identifier is:     $message_exim_id
32027 The subject of the message is: $h_subject
32028 The date of the message is:    $h_date
32029
32030 The following address(es) have not yet been delivered:
32031 ****
32032 No action is required on your part. Delivery attempts will
32033 continue for some time, and this warning may be repeated at
32034 intervals if the message remains undelivered. Eventually the
32035 mail delivery software will give up, and when that happens,
32036 the message will be returned to you.
32037 .endd
32038 .vindex "&$warn_message_delay$&"
32039 .vindex "&$warn_message_recipients$&"
32040 However, in the default state the subject and date lines are omitted if no
32041 appropriate headers exist. During the expansion of this file,
32042 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32043 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32044 of recipients for the warning message. There may be more than one if there are
32045 multiple addresses with different &%errors_to%& settings on the routers that
32046 handled them.
32047
32048
32049
32050
32051 . ////////////////////////////////////////////////////////////////////////////
32052 . ////////////////////////////////////////////////////////////////////////////
32053
32054 .chapter "Some common configuration settings" "CHAPcomconreq"
32055 This chapter discusses some configuration settings that seem to be fairly
32056 common. More examples and discussion can be found in the Exim book.
32057
32058
32059
32060 .section "Sending mail to a smart host" "SECID240"
32061 .cindex "smart host" "example router"
32062 If you want to send all mail for non-local domains to a &"smart host"&, you
32063 should replace the default &(dnslookup)& router with a router which does the
32064 routing explicitly:
32065 .code
32066 send_to_smart_host:
32067   driver = manualroute
32068   route_list = !+local_domains smart.host.name
32069   transport = remote_smtp
32070 .endd
32071 You can use the smart host's IP address instead of the name if you wish.
32072 If you are using Exim only to submit messages to a smart host, and not for
32073 receiving incoming messages, you can arrange for it to do the submission
32074 synchronously by setting the &%mua_wrapper%& option (see chapter
32075 &<<CHAPnonqueueing>>&).
32076
32077
32078
32079
32080 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32081 .cindex "mailing lists"
32082 Exim can be used to run simple mailing lists, but for large and/or complicated
32083 requirements, the use of additional specialized mailing list software such as
32084 Majordomo or Mailman is recommended.
32085
32086 The &(redirect)& router can be used to handle mailing lists where each list
32087 is maintained in a separate file, which can therefore be managed by an
32088 independent manager. The &%domains%& router option can be used to run these
32089 lists in a separate domain from normal mail. For example:
32090 .code
32091 lists:
32092   driver = redirect
32093   domains = lists.example
32094   file = /usr/lists/$local_part
32095   forbid_pipe
32096   forbid_file
32097   errors_to = $local_part-request@lists.example
32098   no_more
32099 .endd
32100 This router is skipped for domains other than &'lists.example'&. For addresses
32101 in that domain, it looks for a file that matches the local part. If there is no
32102 such file, the router declines, but because &%no_more%& is set, no subsequent
32103 routers are tried, and so the whole delivery fails.
32104
32105 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32106 expanded into a file name or a pipe delivery, which is usually inappropriate in
32107 a mailing list.
32108
32109 .oindex "&%errors_to%&"
32110 The &%errors_to%& option specifies that any delivery errors caused by addresses
32111 taken from a mailing list are to be sent to the given address rather than the
32112 original sender of the message. However, before acting on this, Exim verifies
32113 the error address, and ignores it if verification fails.
32114
32115 For example, using the configuration above, mail sent to
32116 &'dicts@lists.example'& is passed on to those addresses contained in
32117 &_/usr/lists/dicts_&, with error reports directed to
32118 &'dicts-request@lists.example'&, provided that this address can be verified.
32119 There could be a file called &_/usr/lists/dicts-request_& containing
32120 the address(es) of this particular list's manager(s), but other approaches,
32121 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32122 or &%local_part_suffix%& options) to handle addresses of the form
32123 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32124
32125
32126
32127 .section "Syntax errors in mailing lists" "SECID241"
32128 .cindex "mailing lists" "syntax errors in"
32129 If an entry in redirection data contains a syntax error, Exim normally defers
32130 delivery of the original address. That means that a syntax error in a mailing
32131 list holds up all deliveries to the list. This may not be appropriate when a
32132 list is being maintained automatically from data supplied by users, and the
32133 addresses are not rigorously checked.
32134
32135 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32136 entries that fail to parse, noting the incident in the log. If in addition
32137 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32138 whenever a broken address is skipped. It is usually appropriate to set
32139 &%syntax_errors_to%& to the same address as &%errors_to%&.
32140
32141
32142
32143 .section "Re-expansion of mailing lists" "SECID242"
32144 .cindex "mailing lists" "re-expansion of"
32145 Exim remembers every individual address to which a message has been delivered,
32146 in order to avoid duplication, but it normally stores only the original
32147 recipient addresses with a message. If all the deliveries to a mailing list
32148 cannot be done at the first attempt, the mailing list is re-expanded when the
32149 delivery is next tried. This means that alterations to the list are taken into
32150 account at each delivery attempt, so addresses that have been added to
32151 the list since the message arrived will therefore receive a copy of the
32152 message, even though it pre-dates their subscription.
32153
32154 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32155 on the &(redirect)& router. If this is done, any addresses generated by the
32156 router that fail to deliver at the first attempt are added to the message as
32157 &"top level"& addresses, and the parent address that generated them is marked
32158 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32159 subsequent delivery attempts. The disadvantage of this is that if any of the
32160 failing addresses are incorrect, correcting them in the file has no effect on
32161 pre-existing messages.
32162
32163 The original top-level address is remembered with each of the generated
32164 addresses, and is output in any log messages. However, any intermediate parent
32165 addresses are not recorded. This makes a difference to the log only if the
32166 &%all_parents%& selector is set, but for mailing lists there is normally only
32167 one level of expansion anyway.
32168
32169
32170
32171 .section "Closed mailing lists" "SECID243"
32172 .cindex "mailing lists" "closed"
32173 The examples so far have assumed open mailing lists, to which anybody may
32174 send mail. It is also possible to set up closed lists, where mail is accepted
32175 from specified senders only. This is done by making use of the generic
32176 &%senders%& option to restrict the router that handles the list.
32177
32178 The following example uses the same file as a list of recipients and as a list
32179 of permitted senders. It requires three routers:
32180 .code
32181 lists_request:
32182   driver = redirect
32183   domains = lists.example
32184   local_part_suffix = -request
32185   file = /usr/lists/$local_part$local_part_suffix
32186   no_more
32187
32188 lists_post:
32189   driver = redirect
32190   domains = lists.example
32191   senders = ${if exists {/usr/lists/$local_part}\
32192              {lsearch;/usr/lists/$local_part}{*}}
32193   file = /usr/lists/$local_part
32194   forbid_pipe
32195   forbid_file
32196   errors_to = $local_part-request@lists.example
32197   no_more
32198
32199 lists_closed:
32200   driver = redirect
32201   domains = lists.example
32202   allow_fail
32203   data = :fail: $local_part@lists.example is a closed mailing list
32204 .endd
32205 All three routers have the same &%domains%& setting, so for any other domains,
32206 they are all skipped. The first router runs only if the local part ends in
32207 &%-request%&. It handles messages to the list manager(s) by means of an open
32208 mailing list.
32209
32210 The second router runs only if the &%senders%& precondition is satisfied. It
32211 checks for the existence of a list that corresponds to the local part, and then
32212 checks that the sender is on the list by means of a linear search. It is
32213 necessary to check for the existence of the file before trying to search it,
32214 because otherwise Exim thinks there is a configuration error. If the file does
32215 not exist, the expansion of &%senders%& is *, which matches all senders. This
32216 means that the router runs, but because there is no list, declines, and
32217 &%no_more%& ensures that no further routers are run. The address fails with an
32218 &"unrouteable address"& error.
32219
32220 The third router runs only if the second router is skipped, which happens when
32221 a mailing list exists, but the sender is not on it. This router forcibly fails
32222 the address, giving a suitable error message.
32223
32224
32225
32226
32227 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32228 .cindex "VERP"
32229 .cindex "Variable Envelope Return Paths"
32230 .cindex "envelope sender"
32231 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32232 are a way of helping mailing list administrators discover which subscription
32233 address is the cause of a particular delivery failure. The idea is to encode
32234 the original recipient address in the outgoing envelope sender address, so that
32235 if the message is forwarded by another host and then subsequently bounces, the
32236 original recipient can be extracted from the recipient address of the bounce.
32237
32238 .oindex &%errors_to%&
32239 .oindex &%return_path%&
32240 Envelope sender addresses can be modified by Exim using two different
32241 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32242 list examples), or the &%return_path%& option on a transport. The second of
32243 these is effective only if the message is successfully delivered to another
32244 host; it is not used for errors detected on the local host (see the description
32245 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32246 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32247 .code
32248 verp_smtp:
32249   driver = smtp
32250   max_rcpt = 1
32251   return_path = \
32252     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32253       {$1-request+$local_part=$domain@your.dom.example}fail}
32254 .endd
32255 This has the effect of rewriting the return path (envelope sender) on outgoing
32256 SMTP messages, if the local part of the original return path ends in
32257 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32258 local part and domain of the recipient into the return path. Suppose, for
32259 example, that a message whose return path has been set to
32260 &'somelist-request@your.dom.example'& is sent to
32261 &'subscriber@other.dom.example'&. In the transport, the return path is
32262 rewritten as
32263 .code
32264 somelist-request+subscriber=other.dom.example@your.dom.example
32265 .endd
32266 .vindex "&$local_part$&"
32267 For this to work, you must tell Exim to send multiple copies of messages that
32268 have more than one recipient, so that each copy has just one recipient. This is
32269 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32270 might be sent to several different recipients in the same domain, in which case
32271 &$local_part$& is not available in the transport, because it is not unique.
32272
32273 Unless your host is doing nothing but mailing list deliveries, you should
32274 probably use a separate transport for the VERP deliveries, so as not to use
32275 extra resources in making one-per-recipient copies for other deliveries. This
32276 can easily be done by expanding the &%transport%& option in the router:
32277 .code
32278 dnslookup:
32279   driver = dnslookup
32280   domains = ! +local_domains
32281   transport = \
32282     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32283       {verp_smtp}{remote_smtp}}
32284   no_more
32285 .endd
32286 If you want to change the return path using &%errors_to%& in a router instead
32287 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32288 routers that handle mailing list addresses. This will ensure that all delivery
32289 errors, including those detected on the local host, are sent to the VERP
32290 address.
32291
32292 On a host that does no local deliveries and has no manual routing, only the
32293 &(dnslookup)& router needs to be changed. A special transport is not needed for
32294 SMTP deliveries. Every mailing list recipient has its own return path value,
32295 and so Exim must hand them to the transport one at a time. Here is an example
32296 of a &(dnslookup)& router that implements VERP:
32297 .code
32298 verp_dnslookup:
32299   driver = dnslookup
32300   domains = ! +local_domains
32301   transport = remote_smtp
32302   errors_to = \
32303     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32304      {$1-request+$local_part=$domain@your.dom.example}fail}
32305   no_more
32306 .endd
32307 Before you start sending out messages with VERPed return paths, you must also
32308 configure Exim to accept the bounce messages that come back to those paths.
32309 Typically this is done by setting a &%local_part_suffix%& option for a
32310 router, and using this to route the messages to wherever you want to handle
32311 them.
32312
32313 The overhead incurred in using VERP depends very much on the size of the
32314 message, the number of recipient addresses that resolve to the same remote
32315 host, and the speed of the connection over which the message is being sent. If
32316 a lot of addresses resolve to the same host and the connection is slow, sending
32317 a separate copy of the message for each address may take substantially longer
32318 than sending a single copy with many recipients (for which VERP cannot be
32319 used).
32320
32321
32322
32323
32324
32325
32326 .section "Virtual domains" "SECTvirtualdomains"
32327 .cindex "virtual domains"
32328 .cindex "domain" "virtual"
32329 The phrase &'virtual domain'& is unfortunately used with two rather different
32330 meanings:
32331
32332 .ilist
32333 A domain for which there are no real mailboxes; all valid local parts are
32334 aliases for other email addresses. Common examples are organizational
32335 top-level domains and &"vanity"& domains.
32336 .next
32337 One of a number of independent domains that are all handled by the same host,
32338 with mailboxes on that host, but where the mailbox owners do not necessarily
32339 have login accounts on that host.
32340 .endlist
32341
32342 The first usage is probably more common, and does seem more &"virtual"& than
32343 the second. This kind of domain can be handled in Exim with a straightforward
32344 aliasing router. One approach is to create a separate alias file for each
32345 virtual domain. Exim can test for the existence of the alias file to determine
32346 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
32347 to a router of this form:
32348 .code
32349 virtual:
32350   driver = redirect
32351   domains = dsearch;/etc/mail/virtual
32352   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
32353   no_more
32354 .endd
32355 The &%domains%& option specifies that the router is to be skipped, unless there
32356 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
32357 domain that is being processed. When the router runs, it looks up the local
32358 part in the file to find a new address (or list of addresses). The &%no_more%&
32359 setting ensures that if the lookup fails (leading to &%data%& being an empty
32360 string), Exim gives up on the address without trying any subsequent routers.
32361
32362 This one router can handle all the virtual domains because the alias file names
32363 follow a fixed pattern. Permissions can be arranged so that appropriate people
32364 can edit the different alias files. A successful aliasing operation results in
32365 a new envelope recipient address, which is then routed from scratch.
32366
32367 The other kind of &"virtual"& domain can also be handled in a straightforward
32368 way. One approach is to create a file for each domain containing a list of
32369 valid local parts, and use it in a router like this:
32370 .code
32371 my_domains:
32372   driver = accept
32373   domains = dsearch;/etc/mail/domains
32374   local_parts = lsearch;/etc/mail/domains/$domain
32375   transport = my_mailboxes
32376 .endd
32377 The address is accepted if there is a file for the domain, and the local part
32378 can be found in the file. The &%domains%& option is used to check for the
32379 file's existence because &%domains%& is tested before the &%local_parts%&
32380 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
32381 because that option is tested after &%local_parts%&. The transport is as
32382 follows:
32383 .code
32384 my_mailboxes:
32385   driver = appendfile
32386   file = /var/mail/$domain/$local_part
32387   user = mail
32388 .endd
32389 This uses a directory of mailboxes for each domain. The &%user%& setting is
32390 required, to specify which uid is to be used for writing to the mailboxes.
32391
32392 The configuration shown here is just one example of how you might support this
32393 requirement. There are many other ways this kind of configuration can be set
32394 up, for example, by using a database instead of separate files to hold all the
32395 information about the domains.
32396
32397
32398
32399 .section "Multiple user mailboxes" "SECTmulbox"
32400 .cindex "multiple mailboxes"
32401 .cindex "mailbox" "multiple"
32402 .cindex "local part" "prefix"
32403 .cindex "local part" "suffix"
32404 Heavy email users often want to operate with multiple mailboxes, into which
32405 incoming mail is automatically sorted. A popular way of handling this is to
32406 allow users to use multiple sender addresses, so that replies can easily be
32407 identified. Users are permitted to add prefixes or suffixes to their local
32408 parts for this purpose. The wildcard facility of the generic router options
32409 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
32410 example, consider this router:
32411 .code
32412 userforward:
32413   driver = redirect
32414   check_local_user
32415   file = $home/.forward
32416   local_part_suffix = -*
32417   local_part_suffix_optional
32418   allow_filter
32419 .endd
32420 .vindex "&$local_part_suffix$&"
32421 It runs a user's &_.forward_& file for all local parts of the form
32422 &'username-*'&. Within the filter file the user can distinguish different
32423 cases by testing the variable &$local_part_suffix$&. For example:
32424 .code
32425 if $local_part_suffix contains -special then
32426 save /home/$local_part/Mail/special
32427 endif
32428 .endd
32429 If the filter file does not exist, or does not deal with such addresses, they
32430 fall through to subsequent routers, and, assuming no subsequent use of the
32431 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
32432 control over which suffixes are valid.
32433
32434 Alternatively, a suffix can be used to trigger the use of a different
32435 &_.forward_& file &-- which is the way a similar facility is implemented in
32436 another MTA:
32437 .code
32438 userforward:
32439   driver = redirect
32440   check_local_user
32441   file = $home/.forward$local_part_suffix
32442   local_part_suffix = -*
32443   local_part_suffix_optional
32444   allow_filter
32445 .endd
32446 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
32447 example, &_.forward-special_& is used. Once again, if the appropriate file
32448 does not exist, or does not deal with the address, it is passed on to
32449 subsequent routers, which could, if required, look for an unqualified
32450 &_.forward_& file to use as a default.
32451
32452
32453
32454 .section "Simplified vacation processing" "SECID244"
32455 .cindex "vacation processing"
32456 The traditional way of running the &'vacation'& program is for a user to set up
32457 a pipe command in a &_.forward_& file
32458 (see section &<<SECTspecitredli>>& for syntax details).
32459 This is prone to error by inexperienced users. There are two features of Exim
32460 that can be used to make this process simpler for users:
32461
32462 .ilist
32463 A local part prefix such as &"vacation-"& can be specified on a router which
32464 can cause the message to be delivered directly to the &'vacation'& program, or
32465 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
32466 &_.forward_& file are then much simpler. For example:
32467 .code
32468 spqr, vacation-spqr
32469 .endd
32470 .next
32471 The &%require_files%& generic router option can be used to trigger a
32472 vacation delivery by checking for the existence of a certain file in the
32473 user's home directory. The &%unseen%& generic option should also be used, to
32474 ensure that the original delivery also proceeds. In this case, all the user has
32475 to do is to create a file called, say, &_.vacation_&, containing a vacation
32476 message.
32477 .endlist
32478
32479 Another advantage of both these methods is that they both work even when the
32480 use of arbitrary pipes by users is locked out.
32481
32482
32483
32484 .section "Taking copies of mail" "SECID245"
32485 .cindex "message" "copying every"
32486 Some installations have policies that require archive copies of all messages to
32487 be made. A single copy of each message can easily be taken by an appropriate
32488 command in a system filter, which could, for example, use a different file for
32489 each day's messages.
32490
32491 There is also a shadow transport mechanism that can be used to take copies of
32492 messages that are successfully delivered by local transports, one copy per
32493 delivery. This could be used, &'inter alia'&, to implement automatic
32494 notification of delivery by sites that insist on doing such things.
32495
32496
32497
32498 .section "Intermittently connected hosts" "SECID246"
32499 .cindex "intermittently connected hosts"
32500 It has become quite common (because it is cheaper) for hosts to connect to the
32501 Internet periodically rather than remain connected all the time. The normal
32502 arrangement is that mail for such hosts accumulates on a system that is
32503 permanently connected.
32504
32505 Exim was designed for use on permanently connected hosts, and so it is not
32506 particularly well-suited to use in an intermittently connected environment.
32507 Nevertheless there are some features that can be used.
32508
32509
32510 .section "Exim on the upstream server host" "SECID247"
32511 It is tempting to arrange for incoming mail for the intermittently connected
32512 host to remain on Exim's queue until the client connects. However, this
32513 approach does not scale very well. Two different kinds of waiting message are
32514 being mixed up in the same queue &-- those that cannot be delivered because of
32515 some temporary problem, and those that are waiting for their destination host
32516 to connect. This makes it hard to manage the queue, as well as wasting
32517 resources, because each queue runner scans the entire queue.
32518
32519 A better approach is to separate off those messages that are waiting for an
32520 intermittently connected host. This can be done by delivering these messages
32521 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
32522 format, from where they are transmitted by other software when their
32523 destination connects. This makes it easy to collect all the mail for one host
32524 in a single directory, and to apply local timeout rules on a per-message basis
32525 if required.
32526
32527 On a very small scale, leaving the mail on Exim's queue can be made to work. If
32528 you are doing this, you should configure Exim with a long retry period for the
32529 intermittent host. For example:
32530 .code
32531 cheshire.wonderland.fict.example    *   F,5d,24h
32532 .endd
32533 This stops a lot of failed delivery attempts from occurring, but Exim remembers
32534 which messages it has queued up for that host. Once the intermittent host comes
32535 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
32536 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
32537 causes all the queued up messages to be delivered, often down a single SMTP
32538 connection. While the host remains connected, any new messages get delivered
32539 immediately.
32540
32541 If the connecting hosts do not have fixed IP addresses, that is, if a host is
32542 issued with a different IP address each time it connects, Exim's retry
32543 mechanisms on the holding host get confused, because the IP address is normally
32544 used as part of the key string for holding retry information. This can be
32545 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
32546 Since this has disadvantages for permanently connected hosts, it is best to
32547 arrange a separate transport for the intermittently connected ones.
32548
32549
32550
32551 .section "Exim on the intermittently connected client host" "SECID248"
32552 The value of &%smtp_accept_queue_per_connection%& should probably be
32553 increased, or even set to zero (that is, disabled) on the intermittently
32554 connected host, so that all incoming messages down a single connection get
32555 delivered immediately.
32556
32557 .cindex "SMTP" "passed connection"
32558 .cindex "SMTP" "multiple deliveries"
32559 .cindex "multiple SMTP deliveries"
32560 Mail waiting to be sent from an intermittently connected host will probably
32561 not have been routed, because without a connection DNS lookups are not
32562 possible. This means that if a normal queue run is done at connection time,
32563 each message is likely to be sent in a separate SMTP session. This can be
32564 avoided by starting the queue run with a command line option beginning with
32565 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
32566 first pass, routing is done but no deliveries take place. The second pass is a
32567 normal queue run; since all the messages have been previously routed, those
32568 destined for the same host are likely to get sent as multiple deliveries in a
32569 single SMTP connection.
32570
32571
32572
32573 . ////////////////////////////////////////////////////////////////////////////
32574 . ////////////////////////////////////////////////////////////////////////////
32575
32576 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
32577          "Exim as a non-queueing client"
32578 .cindex "client, non-queueing"
32579 .cindex "smart host" "suppressing queueing"
32580 On a personal computer, it is a common requirement for all
32581 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
32582 configured to operate that way, for all the popular operating systems.
32583 However, there are some MUAs for Unix-like systems that cannot be so
32584 configured: they submit messages using the command line interface of
32585 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
32586 messages this way.
32587
32588 If the personal computer runs continuously, there is no problem, because it can
32589 run a conventional MTA that handles delivery to the smart host, and deal with
32590 any delays via its queueing mechanism. However, if the computer does not run
32591 continuously or runs different operating systems at different times, queueing
32592 email is not desirable.
32593
32594 There is therefore a requirement for something that can provide the
32595 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
32596 any queueing or retrying facilities. Furthermore, the delivery to the smart
32597 host should be synchronous, so that if it fails, the sending MUA is immediately
32598 informed. In other words, we want something that extends an MUA that submits
32599 to a local MTA via the command line so that it behaves like one that submits
32600 to a remote smart host using TCP/SMTP.
32601
32602 There are a number of applications (for example, there is one called &'ssmtp'&)
32603 that do this job. However, people have found them to be lacking in various
32604 ways. For instance, you might want to allow aliasing and forwarding to be done
32605 before sending a message to the smart host.
32606
32607 Exim already had the necessary infrastructure for doing this job. Just a few
32608 tweaks were needed to make it behave as required, though it is somewhat of an
32609 overkill to use a fully-featured MTA for this purpose.
32610
32611 .oindex "&%mua_wrapper%&"
32612 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
32613 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
32614 assumes that it is being used to &"wrap"& a command-line MUA in the manner
32615 just described. As well as setting &%mua_wrapper%&, you also need to provide a
32616 compatible router and transport configuration. Typically there will be just one
32617 router and one transport, sending everything to a smart host.
32618
32619 When run in MUA wrapping mode, the behaviour of Exim changes in the
32620 following ways:
32621
32622 .ilist
32623 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
32624 In other words, the only way to submit messages is via the command line.
32625 .next
32626 Each message is synchronously delivered as soon as it is received (&%-odi%& is
32627 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
32628 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
32629 does not finish until the delivery attempt is complete. If the delivery is
32630 successful, a zero return code is given.
32631 .next
32632 Address redirection is permitted, but the final routing for all addresses must
32633 be to the same remote transport, and to the same list of hosts. Furthermore,
32634 the return address (envelope sender) must be the same for all recipients, as
32635 must any added or deleted header lines. In other words, it must be possible to
32636 deliver the message in a single SMTP transaction, however many recipients there
32637 are.
32638 .next
32639 If these conditions are not met, or if routing any address results in a
32640 failure or defer status, or if Exim is unable to deliver all the recipients
32641 successfully to one of the smart hosts, delivery of the entire message fails.
32642 .next
32643 Because no queueing is allowed, all failures are treated as permanent; there
32644 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
32645 smart host. Furthermore, because only a single yes/no response can be given to
32646 the caller, it is not possible to deliver to some recipients and not others. If
32647 there is an error (temporary or permanent) for any recipient, all are failed.
32648 .next
32649 If more than one smart host is listed, Exim will try another host after a
32650 connection failure or a timeout, in the normal way. However, if this kind of
32651 failure happens for all the hosts, the delivery fails.
32652 .next
32653 When delivery fails, an error message is written to the standard error stream
32654 (as well as to Exim's log), and Exim exits to the caller with a return code
32655 value 1. The message is expunged from Exim's spool files. No bounce messages
32656 are ever generated.
32657 .next
32658 No retry data is maintained, and any retry rules are ignored.
32659 .next
32660 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
32661 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
32662 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
32663 .endlist
32664
32665 The overall effect is that Exim makes a single synchronous attempt to deliver
32666 the message, failing if there is any kind of problem. Because no local
32667 deliveries are done and no daemon can be run, Exim does not need root
32668 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
32669 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
32670 the advantages and disadvantages of running without root privilege.
32671
32672
32673
32674
32675 . ////////////////////////////////////////////////////////////////////////////
32676 . ////////////////////////////////////////////////////////////////////////////
32677
32678 .chapter "Log files" "CHAPlog"
32679 .scindex IIDloggen "log" "general description"
32680 .cindex "log" "types of"
32681 Exim writes three different logs, referred to as the main log, the reject log,
32682 and the panic log:
32683
32684 .ilist
32685 .cindex "main log"
32686 The main log records the arrival of each message and each delivery in a single
32687 line in each case. The format is as compact as possible, in an attempt to keep
32688 down the size of log files. Two-character flag sequences make it easy to pick
32689 out these lines. A number of other events are recorded in the main log. Some of
32690 them are optional, in which case the &%log_selector%& option controls whether
32691 they are included or not. A Perl script called &'eximstats'&, which does simple
32692 analysis of main log files, is provided in the Exim distribution (see section
32693 &<<SECTmailstat>>&).
32694 .next
32695 .cindex "reject log"
32696 The reject log records information from messages that are rejected as a result
32697 of a configuration option (that is, for policy reasons).
32698 The first line of each rejection is a copy of the line that is also written to
32699 the main log. Then, if the message's header has been read at the time the log
32700 is written, its contents are written to this log. Only the original header
32701 lines are available; header lines added by ACLs are not logged. You can use the
32702 reject log to check that your policy controls are working correctly; on a busy
32703 host this may be easier than scanning the main log for rejection messages. You
32704 can suppress the writing of the reject log by setting &%write_rejectlog%&
32705 false.
32706 .next
32707 .cindex "panic log"
32708 .cindex "system log"
32709 When certain serious errors occur, Exim writes entries to its panic log. If the
32710 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
32711 are usually written to the main log as well, but can get lost amid the mass of
32712 other entries. The panic log should be empty under normal circumstances. It is
32713 therefore a good idea to check it (or to have a &'cron'& script check it)
32714 regularly, in order to become aware of any problems. When Exim cannot open its
32715 panic log, it tries as a last resort to write to the system log (syslog). This
32716 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
32717 message itself is written at priority LOG_CRIT.
32718 .endlist
32719
32720 Every log line starts with a timestamp, in the format shown in the following
32721 example. Note that many of the examples shown in this chapter are line-wrapped.
32722 In the log file, this would be all on one line:
32723 .code
32724 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
32725   by QUIT
32726 .endd
32727 By default, the timestamps are in the local timezone. There are two
32728 ways of changing this:
32729
32730 .ilist
32731 You can set the &%timezone%& option to a different time zone; in particular, if
32732 you set
32733 .code
32734 timezone = UTC
32735 .endd
32736 the timestamps will be in UTC (aka GMT).
32737 .next
32738 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
32739 example:
32740 .code
32741 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
32742 .endd
32743 .endlist
32744
32745 .cindex "log" "process ids in"
32746 .cindex "pid (process id)" "in log lines"
32747 Exim does not include its process id in log lines by default, but you can
32748 request that it does so by specifying the &`pid`& log selector (see section
32749 &<<SECTlogselector>>&). When this is set, the process id is output, in square
32750 brackets, immediately after the time and date.
32751
32752
32753
32754
32755 .section "Where the logs are written" "SECTwhelogwri"
32756 .cindex "log" "destination"
32757 .cindex "log" "to file"
32758 .cindex "log" "to syslog"
32759 .cindex "syslog"
32760 The logs may be written to local files, or to syslog, or both. However, it
32761 should be noted that many syslog implementations use UDP as a transport, and
32762 are therefore unreliable in the sense that messages are not guaranteed to
32763 arrive at the loghost, nor is the ordering of messages necessarily maintained.
32764 It has also been reported that on large log files (tens of megabytes) you may
32765 need to tweak syslog to prevent it syncing the file with each write &-- on
32766 Linux this has been seen to make syslog take 90% plus of CPU time.
32767
32768 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
32769 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
32770 configuration. This latter string is expanded, so it can contain, for example,
32771 references to the host name:
32772 .code
32773 log_file_path = /var/log/$primary_hostname/exim_%slog
32774 .endd
32775 It is generally advisable, however, to set the string in &_Local/Makefile_&
32776 rather than at run time, because then the setting is available right from the
32777 start of Exim's execution. Otherwise, if there's something it wants to log
32778 before it has read the configuration file (for example, an error in the
32779 configuration file) it will not use the path you want, and may not be able to
32780 log at all.
32781
32782 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
32783 list, currently limited to at most two items. This is one option where the
32784 facility for changing a list separator may not be used. The list must always be
32785 colon-separated. If an item in the list is &"syslog"& then syslog is used;
32786 otherwise the item must either be an absolute path, containing &`%s`& at the
32787 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
32788 implying the use of a default path.
32789
32790 When Exim encounters an empty item in the list, it searches the list defined by
32791 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
32792 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
32793 mean &"use the path specified at build time"&. It no such item exists, log
32794 files are written in the &_log_& subdirectory of the spool directory. This is
32795 equivalent to the setting:
32796 .code
32797 log_file_path = $spool_directory/log/%slog
32798 .endd
32799 If you do not specify anything at build time or run time, that is where the
32800 logs are written.
32801
32802 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
32803 are in use &-- see section &<<SECTdatlogfil>>& below.
32804
32805 Here are some examples of possible settings:
32806 .display
32807 &`LOG_FILE_PATH=syslog                    `& syslog only
32808 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
32809 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
32810 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
32811 .endd
32812 If there are more than two paths in the list, the first is used and a panic
32813 error is logged.
32814
32815
32816
32817 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
32818 .cindex "log" "cycling local files"
32819 .cindex "cycling logs"
32820 .cindex "&'exicyclog'&"
32821 .cindex "log" "local files; writing to"
32822 Some operating systems provide centralized and standardized methods for cycling
32823 log files. For those that do not, a utility script called &'exicyclog'& is
32824 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
32825 main and reject logs each time it is called. The maximum number of old logs to
32826 keep can be set. It is suggested this script is run as a daily &'cron'& job.
32827
32828 An Exim delivery process opens the main log when it first needs to write to it,
32829 and it keeps the file open in case subsequent entries are required &-- for
32830 example, if a number of different deliveries are being done for the same
32831 message. However, remote SMTP deliveries can take a long time, and this means
32832 that the file may be kept open long after it is renamed if &'exicyclog'& or
32833 something similar is being used to rename log files on a regular basis. To
32834 ensure that a switch of log files is noticed as soon as possible, Exim calls
32835 &[stat()]& on the main log's name before reusing an open file, and if the file
32836 does not exist, or its inode has changed, the old file is closed and Exim
32837 tries to open the main log from scratch. Thus, an old log file may remain open
32838 for quite some time, but no Exim processes should write to it once it has been
32839 renamed.
32840
32841
32842
32843 .section "Datestamped log files" "SECTdatlogfil"
32844 .cindex "log" "datestamped files"
32845 Instead of cycling the main and reject log files by renaming them
32846 periodically, some sites like to use files whose names contain a datestamp,
32847 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
32848 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
32849 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
32850 point where the datestamp is required. For example:
32851 .code
32852 log_file_path = /var/spool/exim/log/%slog-%D
32853 log_file_path = /var/log/exim-%s-%D.log
32854 log_file_path = /var/spool/exim/log/%D-%slog
32855 log_file_path = /var/log/exim/%s.%M
32856 .endd
32857 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32858 examples of names generated by the above examples:
32859 .code
32860 /var/spool/exim/log/mainlog-20021225
32861 /var/log/exim-reject-20021225.log
32862 /var/spool/exim/log/20021225-mainlog
32863 /var/log/exim/main.200212
32864 .endd
32865 When this form of log file is specified, Exim automatically switches to new
32866 files at midnight. It does not make any attempt to compress old logs; you
32867 will need to write your own script if you require this. You should not
32868 run &'exicyclog'& with this form of logging.
32869
32870 The location of the panic log is also determined by &%log_file_path%&, but it
32871 is not datestamped, because rotation of the panic log does not make sense.
32872 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
32873 the string. In addition, if it immediately follows a slash, a following
32874 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
32875 character is removed. Thus, the four examples above would give these panic
32876 log names:
32877 .code
32878 /var/spool/exim/log/paniclog
32879 /var/log/exim-panic.log
32880 /var/spool/exim/log/paniclog
32881 /var/log/exim/panic
32882 .endd
32883
32884
32885 .section "Logging to syslog" "SECID249"
32886 .cindex "log" "syslog; writing to"
32887 The use of syslog does not change what Exim logs or the format of its messages,
32888 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32889 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32890 that, the same strings are written to syslog as to log files. The syslog
32891 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32892 by default, but you can change these by setting the &%syslog_facility%& and
32893 &%syslog_processname%& options, respectively. If Exim was compiled with
32894 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32895 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32896 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32897 the time and host name to each line.
32898 The three log streams are mapped onto syslog priorities as follows:
32899
32900 .ilist
32901 &'mainlog'& is mapped to LOG_INFO
32902 .next
32903 &'rejectlog'& is mapped to LOG_NOTICE
32904 .next
32905 &'paniclog'& is mapped to LOG_ALERT
32906 .endlist
32907
32908 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32909 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32910 these are routed by syslog to the same place. You can suppress this duplication
32911 by setting &%syslog_duplication%& false.
32912
32913 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32914 entries contain multiple lines when headers are included. To cope with both
32915 these cases, entries written to syslog are split into separate &[syslog()]&
32916 calls at each internal newline, and also after a maximum of
32917 870 data characters. (This allows for a total syslog line length of 1024, when
32918 additions such as timestamps are added.) If you are running a syslog
32919 replacement that can handle lines longer than the 1024 characters allowed by
32920 RFC 3164, you should set
32921 .code
32922 SYSLOG_LONG_LINES=yes
32923 .endd
32924 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32925 lines, but it still splits at internal newlines in &'reject'& log entries.
32926
32927 To make it easy to re-assemble split lines later, each component of a split
32928 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32929 where <&'n'&> is the component number and <&'m'&> is the total number of
32930 components in the entry. The / delimiter is used when the line was split
32931 because it was too long; if it was split because of an internal newline, the \
32932 delimiter is used. For example, supposing the length limit to be 50 instead of
32933 870, the following would be the result of a typical rejection message to
32934 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32935 name, and pid as added by syslog:
32936 .code
32937 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32938 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32939 [3/5]  when scanning for sender: missing or malformed lo
32940 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32941 [5/5] mple>)
32942 .endd
32943 The same error might cause the following lines to be written to &"rejectlog"&
32944 (LOG_NOTICE):
32945 .code
32946 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32947 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32948 [3/18] er when scanning for sender: missing or malformed
32949 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32950 [5\18] .example>)
32951 [6\18] Recipients: ph10@some.domain.cam.example
32952 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32953 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32954 [9\18]        id 16RdAL-0006pc-00
32955 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32956 [11\18] 09:43 +0100
32957 [12\18] F From: <>
32958 [13\18]   Subject: this is a test header
32959 [18\18]   X-something: this is another header
32960 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32961 [16\18] le>
32962 [17\18] B Bcc:
32963 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32964 .endd
32965 Log lines that are neither too long nor contain newlines are written to syslog
32966 without modification.
32967
32968 If only syslog is being used, the Exim monitor is unable to provide a log tail
32969 display, unless syslog is routing &'mainlog'& to a file on the local host and
32970 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32971 where it is.
32972
32973
32974
32975 .section "Log line flags" "SECID250"
32976 One line is written to the main log for each message received, and for each
32977 successful, unsuccessful, and delayed delivery. These lines can readily be
32978 picked out by the distinctive two-character flags that immediately follow the
32979 timestamp. The flags are:
32980 .display
32981 &`<=`&     message arrival
32982 &`=>`&     normal message delivery
32983 &`->`&     additional address in same delivery
32984 &`*>`&     delivery suppressed by &%-N%&
32985 &`**`&     delivery failed; address bounced
32986 &`==`&     delivery deferred; temporary problem
32987 .endd
32988
32989
32990 .section "Logging message reception" "SECID251"
32991 .cindex "log" "reception line"
32992 The format of the single-line entry in the main log that is written for every
32993 message received is shown in the basic example below, which is split over
32994 several lines in order to fit it on the page:
32995 .code
32996 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32997   H=mailer.fict.example [192.168.123.123] U=exim
32998   P=smtp S=5678 id=<incoming message id>
32999 .endd
33000 The address immediately following &"<="& is the envelope sender address. A
33001 bounce message is shown with the sender address &"<>"&, and if it is locally
33002 generated, this is followed by an item of the form
33003 .code
33004 R=<message id>
33005 .endd
33006 which is a reference to the message that caused the bounce to be sent.
33007
33008 .cindex "HELO"
33009 .cindex "EHLO"
33010 For messages from other hosts, the H and U fields identify the remote host and
33011 record the RFC 1413 identity of the user that sent the message, if one was
33012 received. The number given in square brackets is the IP address of the sending
33013 host. If there is a single, unparenthesized  host name in the H field, as
33014 above, it has been verified to correspond to the IP address (see the
33015 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33016 by the remote host in the SMTP HELO or EHLO command, and has not been
33017 verified. If verification yields a different name to that given for HELO or
33018 EHLO, the verified name appears first, followed by the HELO or EHLO
33019 name in parentheses.
33020
33021 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33022 without brackets, in the HELO or EHLO command, leading to entries in
33023 the log containing text like these examples:
33024 .code
33025 H=(10.21.32.43) [192.168.8.34]
33026 H=([10.21.32.43]) [192.168.8.34]
33027 .endd
33028 This can be confusing. Only the final address in square brackets can be relied
33029 on.
33030
33031 For locally generated messages (that is, messages not received over TCP/IP),
33032 the H field is omitted, and the U field contains the login name of the caller
33033 of Exim.
33034
33035 .cindex "authentication" "logging"
33036 .cindex "AUTH" "logging"
33037 For all messages, the P field specifies the protocol used to receive the
33038 message. This is the value that is stored in &$received_protocol$&. In the case
33039 of incoming SMTP messages, the value indicates whether or not any SMTP
33040 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33041 session was encrypted, there is an additional X field that records the cipher
33042 suite that was used.
33043
33044 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33045 hosts that have authenticated themselves using the SMTP AUTH command. The first
33046 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33047 there is an additional item A= followed by the name of the authenticator that
33048 was used. If an authenticated identification was set up by the authenticator's
33049 &%server_set_id%& option, this is logged too, separated by a colon from the
33050 authenticator name.
33051
33052 .cindex "size" "of message"
33053 The id field records the existing message id, if present. The size of the
33054 received message is given by the S field. When the message is delivered,
33055 headers may be removed or added, so that the size of delivered copies of the
33056 message may not correspond with this value (and indeed may be different to each
33057 other).
33058
33059 The &%log_selector%& option can be used to request the logging of additional
33060 data when a message is received. See section &<<SECTlogselector>>& below.
33061
33062
33063
33064 .section "Logging deliveries" "SECID252"
33065 .cindex "log" "delivery line"
33066 The format of the single-line entry in the main log that is written for every
33067 delivery is shown in one of the examples below, for local and remote
33068 deliveries, respectively. Each example has been split into two lines in order
33069 to fit it on the page:
33070 .code
33071 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33072   <marv@hitch.fict.example> R=localuser T=local_delivery
33073 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33074   monk@holistic.fict.example R=dnslookup T=remote_smtp
33075   H=holistic.fict.example [192.168.234.234]
33076 .endd
33077 For ordinary local deliveries, the original address is given in angle brackets
33078 after the final delivery address, which might be a pipe or a file. If
33079 intermediate address(es) exist between the original and the final address, the
33080 last of these is given in parentheses after the final address. The R and T
33081 fields record the router and transport that were used to process the address.
33082
33083 If a shadow transport was run after a successful local delivery, the log line
33084 for the successful delivery has an item added on the end, of the form
33085 .display
33086 &`ST=<`&&'shadow transport name'&&`>`&
33087 .endd
33088 If the shadow transport did not succeed, the error message is put in
33089 parentheses afterwards.
33090
33091 .cindex "asterisk" "after IP address"
33092 When more than one address is included in a single delivery (for example, two
33093 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33094 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33095 down a single SMTP connection, an asterisk follows the IP address in the log
33096 lines for the second and subsequent messages.
33097
33098 The generation of a reply message by a filter file gets logged as a
33099 &"delivery"& to the addressee, preceded by &">"&.
33100
33101 The &%log_selector%& option can be used to request the logging of additional
33102 data when a message is delivered. See section &<<SECTlogselector>>& below.
33103
33104
33105 .section "Discarded deliveries" "SECID253"
33106 .cindex "discarded messages"
33107 .cindex "message" "discarded"
33108 .cindex "delivery" "discarded; logging"
33109 When a message is discarded as a result of the command &"seen finish"& being
33110 obeyed in a filter file which generates no deliveries, a log entry of the form
33111 .code
33112 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33113   <low.club@bridge.example> R=userforward
33114 .endd
33115 is written, to record why no deliveries are logged. When a message is discarded
33116 because it is aliased to &":blackhole:"& the log line is like this:
33117 .code
33118 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33119   <hole@nowhere.example> R=blackhole_router
33120 .endd
33121
33122
33123 .section "Deferred deliveries" "SECID254"
33124 When a delivery is deferred, a line of the following form is logged:
33125 .code
33126 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33127   R=dnslookup T=smtp defer (146): Connection refused
33128 .endd
33129 In the case of remote deliveries, the error is the one that was given for the
33130 last IP address that was tried. Details of individual SMTP failures are also
33131 written to the log, so the above line would be preceded by something like
33132 .code
33133 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33134   mail1.endrest.example [192.168.239.239]: Connection refused
33135 .endd
33136 When a deferred address is skipped because its retry time has not been reached,
33137 a message is written to the log, but this can be suppressed by setting an
33138 appropriate value in &%log_selector%&.
33139
33140
33141
33142 .section "Delivery failures" "SECID255"
33143 .cindex "delivery" "failure; logging"
33144 If a delivery fails because an address cannot be routed, a line of the
33145 following form is logged:
33146 .code
33147 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33148   <jim@trek99.example>: unknown mail domain
33149 .endd
33150 If a delivery fails at transport time, the router and transport are shown, and
33151 the response from the remote host is included, as in this example:
33152 .code
33153 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33154   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33155   after pipelined RCPT TO:<ace400@pb.example>: host
33156   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33157   <ace400@pb.example>...Addressee unknown
33158 .endd
33159 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33160 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33161 disabling PIPELINING. The log lines for all forms of delivery failure are
33162 flagged with &`**`&.
33163
33164
33165
33166 .section "Fake deliveries" "SECID256"
33167 .cindex "delivery" "fake; logging"
33168 If a delivery does not actually take place because the &%-N%& option has been
33169 used to suppress it, a normal delivery line is written to the log, except that
33170 &"=>"& is replaced by &"*>"&.
33171
33172
33173
33174 .section "Completion" "SECID257"
33175 A line of the form
33176 .code
33177 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33178 .endd
33179 is written to the main log when a message is about to be removed from the spool
33180 at the end of its processing.
33181
33182
33183
33184
33185 .section "Summary of Fields in Log Lines" "SECID258"
33186 .cindex "log" "summary of fields"
33187 A summary of the field identifiers that are used in log lines is shown in
33188 the following table:
33189 .display
33190 &`A   `&        authenticator name (and optional id)
33191 &`C   `&        SMTP confirmation on delivery
33192 &`    `&        command list for &"no mail in SMTP session"&
33193 &`CV  `&        certificate verification status
33194 &`D   `&        duration of &"no mail in SMTP session"&
33195 &`DN  `&        distinguished name from peer certificate
33196 &`DT  `&        on &`=>`& lines: time taken for a delivery
33197 &`F   `&        sender address (on delivery lines)
33198 &`H   `&        host name and IP address
33199 &`I   `&        local interface used
33200 &`id  `&        message id for incoming message
33201 &`P   `&        on &`<=`& lines: protocol used
33202 &`    `&        on &`=>`& and &`**`& lines: return path
33203 &`QT  `&        on &`=>`& lines: time spent on queue so far
33204 &`    `&        on &"Completed"& lines: time spent on queue
33205 &`R   `&        on &`<=`& lines: reference for local bounce
33206 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33207 &`S   `&        size of message
33208 &`ST  `&        shadow transport name
33209 &`T   `&        on &`<=`& lines: message subject (topic)
33210 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33211 &`U   `&        local user or RFC 1413 identity
33212 &`X   `&        TLS cipher suite
33213 .endd
33214
33215
33216 .section "Other log entries" "SECID259"
33217 Various other types of log entry are written from time to time. Most should be
33218 self-explanatory. Among the more common are:
33219
33220 .ilist
33221 .cindex "retry" "time not reached"
33222 &'retry time not reached'&&~&~An address previously suffered a temporary error
33223 during routing or local delivery, and the time to retry has not yet arrived.
33224 This message is not written to an individual message log file unless it happens
33225 during the first delivery attempt.
33226 .next
33227 &'retry time not reached for any host'&&~&~An address previously suffered
33228 temporary errors during remote delivery, and the retry time has not yet arrived
33229 for any of the hosts to which it is routed.
33230 .next
33231 .cindex "spool directory" "file locked"
33232 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33233 some other Exim process is already working on the message. This can be quite
33234 common if queue running processes are started at frequent intervals. The
33235 &'exiwhat'& utility script can be used to find out what Exim processes are
33236 doing.
33237 .next
33238 .cindex "error" "ignored"
33239 &'error ignored'&&~&~There are several circumstances that give rise to this
33240 message:
33241 .olist
33242 Exim failed to deliver a bounce message whose age was greater than
33243 &%ignore_bounce_errors_after%&. The bounce was discarded.
33244 .next
33245 A filter file set up a delivery using the &"noerror"& option, and the delivery
33246 failed. The delivery was discarded.
33247 .next
33248 A delivery set up by a router configured with
33249 . ==== As this is a nested list, any displays it contains must be indented
33250 . ==== as otherwise they are too far to the left.
33251 .code
33252     errors_to = <>
33253 .endd
33254 failed. The delivery was discarded.
33255 .endlist olist
33256 .endlist ilist
33257
33258
33259
33260
33261
33262 .section "Reducing or increasing what is logged" "SECTlogselector"
33263 .cindex "log" "selectors"
33264 By setting the &%log_selector%& global option, you can disable some of Exim's
33265 default logging, or you can request additional logging. The value of
33266 &%log_selector%& is made up of names preceded by plus or minus characters. For
33267 example:
33268 .code
33269 log_selector = +arguments -retry_defer
33270 .endd
33271 The list of optional log items is in the following table, with the default
33272 selection marked by asterisks:
33273 .display
33274 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33275 &` address_rewrite            `&  address rewriting
33276 &` all_parents                `&  all parents in => lines
33277 &` arguments                  `&  command line arguments
33278 &`*connection_reject          `&  connection rejections
33279 &`*delay_delivery             `&  immediate delivery delayed
33280 &` deliver_time               `&  time taken to perform delivery
33281 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33282 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33283 &`*etrn                       `&  ETRN commands
33284 &`*host_lookup_failed         `&  as it says
33285 &` ident_timeout              `&  timeout for ident connection
33286 &` incoming_interface         `&  incoming interface on <= lines
33287 &` incoming_port              `&  incoming port on <= lines
33288 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33289 &` outgoing_port              `&  add remote port to => lines
33290 &`*queue_run                  `&  start and end queue runs
33291 &` queue_time                 `&  time on queue for one recipient
33292 &` queue_time_overall         `&  time on queue for whole message
33293 &` pid                        `&  Exim process id
33294 &` received_recipients        `&  recipients on <= lines
33295 &` received_sender            `&  sender on <= lines
33296 &`*rejected_header            `&  header contents on reject log
33297 &`*retry_defer                `&  &"retry time not reached"&
33298 &` return_path_on_delivery    `&  put return path on => and ** lines
33299 &` sender_on_delivery         `&  add sender to => lines
33300 &`*sender_verify_fail         `&  sender verification failures
33301 &`*size_reject                `&  rejection because too big
33302 &`*skip_delivery              `&  delivery skipped in a queue run
33303 &` smtp_confirmation          `&  SMTP confirmation on => lines
33304 &` smtp_connection            `&  SMTP connections
33305 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33306 &` smtp_no_mail               `&  session with no MAIL commands
33307 &` smtp_protocol_error        `&  SMTP protocol errors
33308 &` smtp_syntax_error          `&  SMTP syntax errors
33309 &` subject                    `&  contents of &'Subject:'& on <= lines
33310 &` tls_certificate_verified   `&  certificate verification status
33311 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
33312 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
33313 &` tls_sni                    `&  TLS SNI on <= lines
33314 &` unknown_in_list            `&  DNS lookup failed in list match
33315
33316 &` all                        `&  all of the above
33317 .endd
33318 More details on each of these items follows:
33319
33320 .ilist
33321 .cindex "&%warn%& ACL verb" "log when skipping"
33322 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
33323 its conditions cannot be evaluated, a log line to this effect is written if
33324 this log selector is set.
33325 .next
33326 .cindex "log" "rewriting"
33327 .cindex "rewriting" "logging"
33328 &%address_rewrite%&: This applies both to global rewrites and per-transport
33329 rewrites, but not to rewrites in filters run as an unprivileged user (because
33330 such users cannot access the log).
33331 .next
33332 .cindex "log" "full parentage"
33333 &%all_parents%&: Normally only the original and final addresses are logged on
33334 delivery lines; with this selector, intermediate parents are given in
33335 parentheses between them.
33336 .next
33337 .cindex "log" "Exim arguments"
33338 .cindex "Exim arguments, logging"
33339 &%arguments%&: This causes Exim to write the arguments with which it was called
33340 to the main log, preceded by the current working directory. This is a debugging
33341 feature, added to make it easier to find out how certain MUAs call
33342 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
33343 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
33344 that are empty or that contain white space are quoted. Non-printing characters
33345 are shown as escape sequences. This facility cannot log unrecognized arguments,
33346 because the arguments are checked before the configuration file is read. The
33347 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
33348 between the caller and Exim.
33349 .next
33350 .cindex "log" "connection rejections"
33351 &%connection_reject%&: A log entry is written whenever an incoming SMTP
33352 connection is rejected, for whatever reason.
33353 .next
33354 .cindex "log" "delayed delivery"
33355 .cindex "delayed delivery, logging"
33356 &%delay_delivery%&: A log entry is written whenever a delivery process is not
33357 started for an incoming message because the load is too high or too many
33358 messages were received on one connection. Logging does not occur if no delivery
33359 process is started because &%queue_only%& is set or &%-odq%& was used.
33360 .next
33361 .cindex "log" "delivery duration"
33362 &%deliver_time%&: For each delivery, the amount of real time it has taken to
33363 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
33364 .next
33365 .cindex "log" "message size on delivery"
33366 .cindex "size" "of message"
33367 &%delivery_size%&: For each delivery, the size of message delivered is added to
33368 the &"=>"& line, tagged with S=.
33369 .next
33370 .cindex "log" "dnslist defer"
33371 .cindex "DNS list" "logging defer"
33372 .cindex "black list (DNS)"
33373 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
33374 DNS black list suffers a temporary error.
33375 .next
33376 .cindex "log" "ETRN commands"
33377 .cindex "ETRN" "logging"
33378 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
33379 is run to determine whether or not it is actually accepted. An invalid ETRN
33380 command, or one received within a message transaction is not logged by this
33381 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
33382 .next
33383 .cindex "log" "host lookup failure"
33384 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
33385 any addresses, or when a lookup of an IP address fails to find a host name, a
33386 log line is written. This logging does not apply to direct DNS lookups when
33387 routing email addresses, but it does apply to &"byname"& lookups.
33388 .next
33389 .cindex "log" "ident timeout"
33390 .cindex "RFC 1413" "logging timeout"
33391 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
33392 client's ident port times out.
33393 .next
33394 .cindex "log" "incoming interface"
33395 .cindex "interface" "logging"
33396 &%incoming_interface%&: The interface on which a message was received is added
33397 to the &"<="& line as an IP address in square brackets, tagged by I= and
33398 followed by a colon and the port number. The local interface and port are also
33399 added to other SMTP log lines, for example &"SMTP connection from"&, and to
33400 rejection lines.
33401 .next
33402 .cindex "log" "incoming remote port"
33403 .cindex "port" "logging remote"
33404 .cindex "TCP/IP" "logging incoming remote port"
33405 .vindex "&$sender_fullhost$&"
33406 .vindex "&$sender_rcvhost$&"
33407 &%incoming_port%&: The remote port number from which a message was received is
33408 added to log entries and &'Received:'& header lines, following the IP address
33409 in square brackets, and separated from it by a colon. This is implemented by
33410 changing the value that is put in the &$sender_fullhost$& and
33411 &$sender_rcvhost$& variables. Recording the remote port number has become more
33412 important with the widening use of NAT (see RFC 2505).
33413 .next
33414 .cindex "log" "dropped connection"
33415 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
33416 connection is unexpectedly dropped.
33417 .next
33418 .cindex "log" "outgoing remote port"
33419 .cindex "port" "logging outgoint remote"
33420 .cindex "TCP/IP" "logging ougtoing remote port"
33421 &%outgoing_port%&: The remote port number is added to delivery log lines (those
33422 containing => tags) following the IP address. This option is not included in
33423 the default setting, because for most ordinary configurations, the remote port
33424 number is always 25 (the SMTP port).
33425 .next
33426 .cindex "log" "process ids in"
33427 .cindex "pid (process id)" "in log lines"
33428 &%pid%&: The current process id is added to every log line, in square brackets,
33429 immediately after the time and date.
33430 .next
33431 .cindex "log" "queue run"
33432 .cindex "queue runner" "logging"
33433 &%queue_run%&: The start and end of every queue run are logged.
33434 .next
33435 .cindex "log" "queue time"
33436 &%queue_time%&: The amount of time the message has been in the queue on the
33437 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
33438 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
33439 includes reception time as well as the delivery time for the current address.
33440 This means that it may be longer than the difference between the arrival and
33441 delivery log line times, because the arrival log line is not written until the
33442 message has been successfully received.
33443 .next
33444 &%queue_time_overall%&: The amount of time the message has been in the queue on
33445 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
33446 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
33447 message, so it includes reception time as well as the total delivery time.
33448 .next
33449 .cindex "log" "recipients"
33450 &%received_recipients%&: The recipients of a message are listed in the main log
33451 as soon as the message is received. The list appears at the end of the log line
33452 that is written when a message is received, preceded by the word &"for"&. The
33453 addresses are listed after they have been qualified, but before any rewriting
33454 has taken place.
33455 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
33456 in the list.
33457 .next
33458 .cindex "log" "sender reception"
33459 &%received_sender%&: The unrewritten original sender of a message is added to
33460 the end of the log line that records the message's arrival, after the word
33461 &"from"& (before the recipients if &%received_recipients%& is also set).
33462 .next
33463 .cindex "log" "header lines for rejection"
33464 &%rejected_header%&: If a message's header has been received at the time a
33465 rejection is written to the reject log, the complete header is added to the
33466 log. Header logging can be turned off individually for messages that are
33467 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
33468 .next
33469 .cindex "log" "retry defer"
33470 &%retry_defer%&: A log line is written if a delivery is deferred because a
33471 retry time has not yet been reached. However, this &"retry time not reached"&
33472 message is always omitted from individual message logs after the first delivery
33473 attempt.
33474 .next
33475 .cindex "log" "return path"
33476 &%return_path_on_delivery%&: The return path that is being transmitted with
33477 the message is included in delivery and bounce lines, using the tag P=.
33478 This is omitted if no delivery actually happens, for example, if routing fails,
33479 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
33480 .next
33481 .cindex "log" "sender on delivery"
33482 &%sender_on_delivery%&: The message's sender address is added to every delivery
33483 and bounce line, tagged by F= (for &"from"&).
33484 This is the original sender that was received with the message; it is not
33485 necessarily the same as the outgoing return path.
33486 .next
33487 .cindex "log" "sender verify failure"
33488 &%sender_verify_fail%&: If this selector is unset, the separate log line that
33489 gives details of a sender verification failure is not written. Log lines for
33490 the rejection of SMTP commands contain just &"sender verify failed"&, so some
33491 detail is lost.
33492 .next
33493 .cindex "log" "size rejection"
33494 &%size_reject%&: A log line is written whenever a message is rejected because
33495 it is too big.
33496 .next
33497 .cindex "log" "frozen messages; skipped"
33498 .cindex "frozen messages" "logging skipping"
33499 &%skip_delivery%&: A log line is written whenever a message is skipped during a
33500 queue run because it is frozen or because another process is already delivering
33501 it.
33502 .cindex "&""spool file is locked""&"
33503 The message that is written is &"spool file is locked"&.
33504 .next
33505 .cindex "log" "smtp confirmation"
33506 .cindex "SMTP" "logging confirmation"
33507 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
33508 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
33509 A number of MTAs (including Exim) return an identifying string in this
33510 response.
33511 .next
33512 .cindex "log" "SMTP connections"
33513 .cindex "SMTP" "logging connections"
33514 &%smtp_connection%&: A log line is written whenever an SMTP connection is
33515 established or closed, unless the connection is from a host that matches
33516 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
33517 only when the closure is unexpected.) This applies to connections from local
33518 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
33519 dropped in the middle of a message, a log line is always written, whether or
33520 not this selector is set, but otherwise nothing is written at the start and end
33521 of connections unless this selector is enabled.
33522
33523 For TCP/IP connections to an Exim daemon, the current number of connections is
33524 included in the log message for each new connection, but note that the count is
33525 reset if the daemon is restarted.
33526 Also, because connections are closed (and the closure is logged) in
33527 subprocesses, the count may not include connections that have been closed but
33528 whose termination the daemon has not yet noticed. Thus, while it is possible to
33529 match up the opening and closing of connections in the log, the value of the
33530 logged counts may not be entirely accurate.
33531 .next
33532 .cindex "log" "SMTP transaction; incomplete"
33533 .cindex "SMTP" "logging incomplete transactions"
33534 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
33535 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
33536 and the message sender plus any accepted recipients are included in the log
33537 line. This can provide evidence of dictionary attacks.
33538 .next
33539 .cindex "log" "non-MAIL SMTP sessions"
33540 .cindex "MAIL" "logging session without"
33541 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
33542 connection terminates without having issued a MAIL command. This includes both
33543 the case when the connection is dropped, and the case when QUIT is used. It
33544 does not include cases where the connection is rejected right at the start (by
33545 an ACL, or because there are too many connections, or whatever). These cases
33546 already have their own log lines.
33547
33548 The log line that is written contains the identity of the client in the usual
33549 way, followed by D= and a time, which records the duration of the connection.
33550 If the connection was authenticated, this fact is logged exactly as it is for
33551 an incoming message, with an A= item. If the connection was encrypted, CV=,
33552 DN=, and X= items may appear as they do for an incoming message, controlled by
33553 the same logging options.
33554
33555 Finally, if any SMTP commands were issued during the connection, a C= item
33556 is added to the line, listing the commands that were used. For example,
33557 .code
33558 C=EHLO,QUIT
33559 .endd
33560 shows that the client issued QUIT straight after EHLO. If there were fewer
33561 than 20 commands, they are all listed. If there were more than 20 commands,
33562 the last 20 are listed, preceded by &"..."&. However, with the default
33563 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
33564 have been aborted before 20 non-mail commands are processed.
33565 .next
33566 .cindex "log" "SMTP protocol error"
33567 .cindex "SMTP" "logging protocol error"
33568 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
33569 encountered. Exim does not have perfect detection of all protocol errors
33570 because of transmission delays and the use of pipelining. If PIPELINING has
33571 been advertised to a client, an Exim server assumes that the client will use
33572 it, and therefore it does not count &"expected"& errors (for example, RCPT
33573 received after rejecting MAIL) as protocol errors.
33574 .next
33575 .cindex "SMTP" "logging syntax errors"
33576 .cindex "SMTP" "syntax errors; logging"
33577 .cindex "SMTP" "unknown command; logging"
33578 .cindex "log" "unknown SMTP command"
33579 .cindex "log" "SMTP syntax error"
33580 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
33581 encountered. An unrecognized command is treated as a syntax error. For an
33582 external connection, the host identity is given; for an internal connection
33583 using &%-bs%& the sender identification (normally the calling user) is given.
33584 .next
33585 .cindex "log" "subject"
33586 .cindex "subject, logging"
33587 &%subject%&: The subject of the message is added to the arrival log line,
33588 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
33589 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
33590 specifies whether characters with values greater than 127 should be logged
33591 unchanged, or whether they should be rendered as escape sequences.
33592 .next
33593 .cindex "log" "certificate verification"
33594 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
33595 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
33596 verified, and &`CV=no`& if not.
33597 .next
33598 .cindex "log" "TLS cipher"
33599 .cindex "TLS" "logging cipher"
33600 &%tls_cipher%&: When a message is sent or received over an encrypted
33601 connection, the cipher suite used is added to the log line, preceded by X=.
33602 .next
33603 .cindex "log" "TLS peer DN"
33604 .cindex "TLS" "logging peer DN"
33605 &%tls_peerdn%&: When a message is sent or received over an encrypted
33606 connection, and a certificate is supplied by the remote host, the peer DN is
33607 added to the log line, preceded by DN=.
33608 .next
33609 .cindex "log" "TLS SNI"
33610 .cindex "TLS" "logging SNI"
33611 &%tls_sni%&: When a message is received over an encrypted connection, and
33612 the remote host provided the Server Name Indication extension, the SNI is
33613 added to the log line, preceded by SNI=.
33614 .next
33615 .cindex "log" "DNS failure in list"
33616 &%unknown_in_list%&: This setting causes a log entry to be written when the
33617 result of a list match is failure because a DNS lookup failed.
33618 .endlist
33619
33620
33621 .section "Message log" "SECID260"
33622 .cindex "message" "log file for"
33623 .cindex "log" "message log; description of"
33624 .cindex "&_msglog_& directory"
33625 .oindex "&%preserve_message_logs%&"
33626 In addition to the general log files, Exim writes a log file for each message
33627 that it handles. The names of these per-message logs are the message ids, and
33628 they are kept in the &_msglog_& sub-directory of the spool directory. Each
33629 message log contains copies of the log lines that apply to the message. This
33630 makes it easier to inspect the status of an individual message without having
33631 to search the main log. A message log is deleted when processing of the message
33632 is complete, unless &%preserve_message_logs%& is set, but this should be used
33633 only with great care because they can fill up your disk very quickly.
33634
33635 On a heavily loaded system, it may be desirable to disable the use of
33636 per-message logs, in order to reduce disk I/O. This can be done by setting the
33637 &%message_logs%& option false.
33638 .ecindex IIDloggen
33639
33640
33641
33642
33643 . ////////////////////////////////////////////////////////////////////////////
33644 . ////////////////////////////////////////////////////////////////////////////
33645
33646 .chapter "Exim utilities" "CHAPutils"
33647 .scindex IIDutils "utilities"
33648 A number of utility scripts and programs are supplied with Exim and are
33649 described in this chapter. There is also the Exim Monitor, which is covered in
33650 the next chapter. The utilities described here are:
33651
33652 .itable none 0 0 3  7* left  15* left  40* left
33653 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
33654   "list what Exim processes are doing"
33655 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
33656 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
33657 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
33658 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
33659                                                 various criteria"
33660 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
33661 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
33662   "extract statistics from the log"
33663 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
33664   "check address acceptance from given IP"
33665 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
33666 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
33667 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
33668 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
33669 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
33670 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
33671 .endtable
33672
33673 Another utility that might be of use to sites with many MTAs is Tom Kistner's
33674 &'exilog'&. It provides log visualizations across multiple Exim servers. See
33675 &url(http://duncanthrax.net/exilog/) for details.
33676
33677
33678
33679
33680 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
33681 .cindex "&'exiwhat'&"
33682 .cindex "process, querying"
33683 .cindex "SIGUSR1"
33684 On operating systems that can restart a system call after receiving a signal
33685 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
33686 a line describing what it is doing to the file &_exim-process.info_& in the
33687 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
33688 processes it can find, having first emptied the file. It then waits for one
33689 second to allow the Exim processes to react before displaying the results. In
33690 order to run &'exiwhat'& successfully you have to have sufficient privilege to
33691 send the signal to the Exim processes, so it is normally run as root.
33692
33693 &*Warning*&: This is not an efficient process. It is intended for occasional
33694 use by system administrators. It is not sensible, for example, to set up a
33695 script that sends SIGUSR1 signals to Exim processes at short intervals.
33696
33697
33698 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
33699 varies in different operating systems. Not only are different options used,
33700 but the format of the output is different. For this reason, there are some
33701 system configuration options that configure exactly how &'exiwhat'& works. If
33702 it doesn't seem to be working for you, check the following compile-time
33703 options:
33704 .display
33705 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
33706 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
33707 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
33708 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
33709 .endd
33710 An example of typical output from &'exiwhat'& is
33711 .code
33712 164 daemon: -q1h, listening on port 25
33713 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
33714 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
33715   [10.19.42.42] (editor@ref.example)
33716 10592 handling incoming call from [192.168.243.242]
33717 10628 accepting a local non-SMTP message
33718 .endd
33719 The first number in the output line is the process number. The third line has
33720 been split here, in order to fit it on the page.
33721
33722
33723
33724 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
33725 .cindex "&'exiqgrep'&"
33726 .cindex "queue" "grepping"
33727 This utility is a Perl script contributed by Matt Hubbard. It runs
33728 .code
33729 exim -bpu
33730 .endd
33731 to obtain a queue listing with undelivered recipients only, and then greps the
33732 output to select messages that match given criteria. The following selection
33733 options are available:
33734
33735 .vlist
33736 .vitem &*-f*&&~<&'regex'&>
33737 Match the sender address. The field that is tested is enclosed in angle
33738 brackets, so you can test for bounce messages with
33739 .code
33740 exiqgrep -f '^<>$'
33741 .endd
33742 .vitem &*-r*&&~<&'regex'&>
33743 Match a recipient address. The field that is tested is not enclosed in angle
33744 brackets.
33745
33746 .vitem &*-s*&&~<&'regex'&>
33747 Match against the size field.
33748
33749 .vitem &*-y*&&~<&'seconds'&>
33750 Match messages that are younger than the given time.
33751
33752 .vitem &*-o*&&~<&'seconds'&>
33753 Match messages that are older than the given time.
33754
33755 .vitem &*-z*&
33756 Match only frozen messages.
33757
33758 .vitem &*-x*&
33759 Match only non-frozen messages.
33760 .endlist
33761
33762 The following options control the format of the output:
33763
33764 .vlist
33765 .vitem &*-c*&
33766 Display only the count of matching messages.
33767
33768 .vitem &*-l*&
33769 Long format &-- display the full message information as output by Exim. This is
33770 the default.
33771
33772 .vitem &*-i*&
33773 Display message ids only.
33774
33775 .vitem &*-b*&
33776 Brief format &-- one line per message.
33777
33778 .vitem &*-R*&
33779 Display messages in reverse order.
33780 .endlist
33781
33782 There is one more option, &%-h%&, which outputs a list of options.
33783
33784
33785
33786 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
33787 .cindex "&'exiqsumm'&"
33788 .cindex "queue" "summary"
33789 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
33790 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
33791 running a command such as
33792 .code
33793 exim -bp | exiqsumm
33794 .endd
33795 The output consists of one line for each domain that has messages waiting for
33796 it, as in the following example:
33797 .code
33798 3   2322   74m   66m  msn.com.example
33799 .endd
33800 Each line lists the number of pending deliveries for a domain, their total
33801 volume, and the length of time that the oldest and the newest messages have
33802 been waiting. Note that the number of pending deliveries is greater than the
33803 number of messages when messages have more than one recipient.
33804
33805 A summary line is output at the end. By default the output is sorted on the
33806 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
33807 the output to be sorted by oldest message and by count of messages,
33808 respectively. There are also three options that split the messages for each
33809 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
33810 separates frozen messages, and &%-s%& separates messages according to their
33811 sender.
33812
33813 The output of &'exim -bp'& contains the original addresses in the message, so
33814 this also applies to the output from &'exiqsumm'&. No domains from addresses
33815 generated by aliasing or forwarding are included (unless the &%one_time%&
33816 option of the &(redirect)& router has been used to convert them into &"top
33817 level"& addresses).
33818
33819
33820
33821
33822 .section "Extracting specific information from the log (exigrep)" &&&
33823          "SECTextspeinf"
33824 .cindex "&'exigrep'&"
33825 .cindex "log" "extracts; grepping for"
33826 The &'exigrep'& utility is a Perl script that searches one or more main log
33827 files for entries that match a given pattern. When it finds a match, it
33828 extracts all the log entries for the relevant message, not just those that
33829 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
33830 given message, or all mail for a given user, or for a given host, for example.
33831 The input files can be in Exim log format or syslog format.
33832 If a matching log line is not associated with a specific message, it is
33833 included in &'exigrep'&'s output without any additional lines. The usage is:
33834 .display
33835 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
33836 .endd
33837 If no log file names are given on the command line, the standard input is read.
33838
33839 The &%-t%& argument specifies a number of seconds. It adds an additional
33840 condition for message selection. Messages that are complete are shown only if
33841 they spent more than <&'n'&> seconds on the queue.
33842
33843 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
33844 makes it case-sensitive. This may give a performance improvement when searching
33845 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
33846 option; with &%-I%& they do not. In both cases it is possible to change the
33847 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
33848
33849 The &%-l%& option means &"literal"&, that is, treat all characters in the
33850 pattern as standing for themselves. Otherwise the pattern must be a Perl
33851 regular expression.
33852
33853 The &%-v%& option inverts the matching condition. That is, a line is selected
33854 if it does &'not'& match the pattern.
33855
33856 If the location of a &'zcat'& command is known from the definition of
33857 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
33858 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
33859
33860
33861 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
33862 .cindex "&'exipick'&"
33863 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
33864 lists messages from the queue according to a variety of criteria. For details
33865 of &'exipick'&'s facilities, visit the web page at
33866 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33867 the &%--help%& option.
33868
33869
33870 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33871 .cindex "log" "cycling local files"
33872 .cindex "cycling logs"
33873 .cindex "&'exicyclog'&"
33874 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33875 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33876 you are using log files with datestamps in their names (see section
33877 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33878 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33879 There are two command line options for &'exicyclog'&:
33880 .ilist
33881 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33882 default that is set when Exim is built. The default default is 10.
33883 .next
33884 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33885 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33886 overriding the script's default, which is to find the setting from Exim's
33887 configuration.
33888 .endlist
33889
33890 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33891 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33892 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33893 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33894 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33895 logs are handled similarly.
33896
33897 If the limit is greater than 99, the script uses 3-digit numbers such as
33898 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33899 to one that is greater, or &'vice versa'&, you will have to fix the names of
33900 any existing log files.
33901
33902 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33903 the end are deleted. All files with numbers greater than 01 are compressed,
33904 using a compression command which is configured by the COMPRESS_COMMAND
33905 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33906 root &%crontab%& entry of the form
33907 .code
33908 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33909 .endd
33910 assuming you have used the name &"exim"& for the Exim user. You can run
33911 &'exicyclog'& as root if you wish, but there is no need.
33912
33913
33914
33915 .section "Mail statistics (eximstats)" "SECTmailstat"
33916 .cindex "statistics"
33917 .cindex "&'eximstats'&"
33918 A Perl script called &'eximstats'& is provided for extracting statistical
33919 information from log files. The output is either plain text, or HTML.
33920 Exim log files are also supported by the &'Lire'& system produced by the
33921 LogReport Foundation &url(http://www.logreport.org).
33922
33923 The &'eximstats'& script has been hacked about quite a bit over time. The
33924 latest version is the result of some extensive revision by Steve Campbell. A
33925 lot of information is given by default, but there are options for suppressing
33926 various parts of it. Following any options, the arguments to the script are a
33927 list of files, which should be main log files. For example:
33928 .code
33929 eximstats -nr /var/spool/exim/log/mainlog.01
33930 .endd
33931 By default, &'eximstats'& extracts information about the number and volume of
33932 messages received from or delivered to various hosts. The information is sorted
33933 both by message count and by volume, and the top fifty hosts in each category
33934 are listed on the standard output. Similar information, based on email
33935 addresses or domains instead of hosts can be requested by means of various
33936 options. For messages delivered and received locally, similar statistics are
33937 also produced per user.
33938
33939 The output also includes total counts and statistics about delivery errors, and
33940 histograms showing the number of messages received and deliveries made in each
33941 hour of the day. A delivery with more than one address in its envelope (for
33942 example, an SMTP transaction with more than one RCPT command) is counted
33943 as a single delivery by &'eximstats'&.
33944
33945 Though normally more deliveries than receipts are reported (as messages may
33946 have multiple recipients), it is possible for &'eximstats'& to report more
33947 messages received than delivered, even though the queue is empty at the start
33948 and end of the period in question. If an incoming message contains no valid
33949 recipients, no deliveries are recorded for it. A bounce message is handled as
33950 an entirely separate message.
33951
33952 &'eximstats'& always outputs a grand total summary giving the volume and number
33953 of messages received and deliveries made, and the number of hosts involved in
33954 each case. It also outputs the number of messages that were delayed (that is,
33955 not completely delivered at the first attempt), and the number that had at
33956 least one address that failed.
33957
33958 The remainder of the output is in sections that can be independently disabled
33959 or modified by various options. It consists of a summary of deliveries by
33960 transport, histograms of messages received and delivered per time interval
33961 (default per hour), information about the time messages spent on the queue,
33962 a list of relayed messages, lists of the top fifty sending hosts, local
33963 senders, destination hosts, and destination local users by count and by volume,
33964 and a list of delivery errors that occurred.
33965
33966 The relay information lists messages that were actually relayed, that is, they
33967 came from a remote host and were directly delivered to some other remote host,
33968 without being processed (for example, for aliasing or forwarding) locally.
33969
33970 There are quite a few options for &'eximstats'& to control exactly what it
33971 outputs. These are documented in the Perl script itself, and can be extracted
33972 by running the command &(perldoc)& on the script. For example:
33973 .code
33974 perldoc /usr/exim/bin/eximstats
33975 .endd
33976
33977 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33978 .cindex "&'exim_checkaccess'&"
33979 .cindex "policy control" "checking access"
33980 .cindex "checking access"
33981 The &%-bh%& command line argument allows you to run a fake SMTP session with
33982 debugging output, in order to check what Exim is doing when it is applying
33983 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33984 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33985 sometimes you just want to answer the question &"Does this address have
33986 access?"& without bothering with any further details.
33987
33988 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33989 two arguments, an IP address and an email address:
33990 .code
33991 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33992 .endd
33993 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33994 given email address would be accepted in a RCPT command in a TCP/IP
33995 connection from the host with the given IP address. The output of the utility
33996 is either the word &"accepted"&, or the SMTP error response, for example:
33997 .code
33998 Rejected:
33999 550 Relay not permitted
34000 .endd
34001 When running this test, the utility uses &`<>`& as the envelope sender address
34002 for the MAIL command, but you can change this by providing additional
34003 options. These are passed directly to the Exim command. For example, to specify
34004 that the test is to be run with the sender address &'himself@there.example'&
34005 you can use:
34006 .code
34007 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34008                  -f himself@there.example
34009 .endd
34010 Note that these additional Exim command line items must be given after the two
34011 mandatory arguments.
34012
34013 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34014 while running its checks. You can run checks that include callouts by using
34015 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34016
34017
34018
34019 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34020 .cindex "DBM" "building dbm files"
34021 .cindex "building DBM files"
34022 .cindex "&'exim_dbmbuild'&"
34023 .cindex "lower casing"
34024 .cindex "binary zero" "in lookup key"
34025 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34026 the format used by the &(lsearch)& lookup (see section
34027 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34028 names as keys and the remainder of the information as data. The lower-casing
34029 can be prevented by calling the program with the &%-nolc%& option.
34030
34031 A terminating zero is included as part of the key string. This is expected by
34032 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34033 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34034 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34035 files.
34036
34037 The program requires two arguments: the name of the input file (which can be a
34038 single hyphen to indicate the standard input), and the name of the output file.
34039 It creates the output under a temporary name, and then renames it if all went
34040 well.
34041
34042 .cindex "USE_DB"
34043 If the native DB interface is in use (USE_DB is set in a compile-time
34044 configuration file &-- this is common in free versions of Unix) the two file
34045 names must be different, because in this mode the Berkeley DB functions create
34046 a single output file using exactly the name given. For example,
34047 .code
34048 exim_dbmbuild /etc/aliases /etc/aliases.db
34049 .endd
34050 reads the system alias file and creates a DBM version of it in
34051 &_/etc/aliases.db_&.
34052
34053 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34054 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34055 environment, the suffixes are added to the second argument of
34056 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34057 when the Berkeley functions are used in compatibility mode (though this is not
34058 recommended), because in that case it adds a &_.db_& suffix to the file name.
34059
34060 If a duplicate key is encountered, the program outputs a warning, and when it
34061 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34062 option is used. By default, only the first of a set of duplicates is used &--
34063 this makes it compatible with &(lsearch)& lookups. There is an option
34064 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34065 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34066 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34067 return code is 2.
34068
34069
34070
34071
34072 .section "Finding individual retry times (exinext)" "SECTfinindret"
34073 .cindex "retry" "times"
34074 .cindex "&'exinext'&"
34075 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34076 fish specific information out of the retry database. Given a mail domain (or a
34077 complete address), it looks up the hosts for that domain, and outputs any retry
34078 information for the hosts or for the domain. At present, the retry information
34079 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34080 output. For example:
34081 .code
34082 $ exinext piglet@milne.fict.example
34083 kanga.milne.example:192.168.8.1 error 146: Connection refused
34084   first failed: 21-Feb-1996 14:57:34
34085   last tried:   21-Feb-1996 14:57:34
34086   next try at:  21-Feb-1996 15:02:34
34087 roo.milne.example:192.168.8.3 error 146: Connection refused
34088   first failed: 20-Jan-1996 13:12:08
34089   last tried:   21-Feb-1996 11:42:03
34090   next try at:  21-Feb-1996 19:42:03
34091   past final cutoff time
34092 .endd
34093 You can also give &'exinext'& a local part, without a domain, and it
34094 will give any retry information for that local part in your default domain.
34095 A message id can be used to obtain retry information pertaining to a specific
34096 message. This exists only when an attempt to deliver a message to a remote host
34097 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34098 &'exinext'& is not particularly efficient, but then it is not expected to be
34099 run very often.
34100
34101 The &'exinext'& utility calls Exim to find out information such as the location
34102 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34103 passed on to the &'exim'& commands. The first specifies an alternate Exim
34104 configuration file, and the second sets macros for use within the configuration
34105 file. These features are mainly to help in testing, but might also be useful in
34106 environments where more than one configuration file is in use.
34107
34108
34109
34110 .section "Hints database maintenance" "SECThindatmai"
34111 .cindex "hints database" "maintenance"
34112 .cindex "maintaining Exim's hints database"
34113 Three utility programs are provided for maintaining the DBM files that Exim
34114 uses to contain its delivery hint information. Each program requires two
34115 arguments. The first specifies the name of Exim's spool directory, and the
34116 second is the name of the database it is to operate on. These are as follows:
34117
34118 .ilist
34119 &'retry'&: the database of retry information
34120 .next
34121 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34122 for remote hosts
34123 .next
34124 &'callout'&: the callout cache
34125 .next
34126 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34127 .next
34128 &'misc'&: other hints data
34129 .endlist
34130
34131 The &'misc'& database is used for
34132
34133 .ilist
34134 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34135 .next
34136 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34137 &(smtp)& transport)
34138 .endlist
34139
34140
34141
34142 .section "exim_dumpdb" "SECID261"
34143 .cindex "&'exim_dumpdb'&"
34144 The entire contents of a database are written to the standard output by the
34145 &'exim_dumpdb'& program, which has no options or arguments other than the
34146 spool and database names. For example, to dump the retry database:
34147 .code
34148 exim_dumpdb /var/spool/exim retry
34149 .endd
34150 Two lines of output are produced for each entry:
34151 .code
34152 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34153 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34154 .endd
34155 The first item on the first line is the key of the record. It starts with one
34156 of the letters R, or T, depending on whether it refers to a routing or
34157 transport retry. For a local delivery, the next part is the local address; for
34158 a remote delivery it is the name of the remote host, followed by its failing IP
34159 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34160 transport). If the remote port is not the standard one (port 25), it is added
34161 to the IP address. Then there follows an error code, an additional error code,
34162 and a textual description of the error.
34163
34164 The three times on the second line are the time of first failure, the time of
34165 the last delivery attempt, and the computed time for the next attempt. The line
34166 ends with an asterisk if the cutoff time for the last retry rule has been
34167 exceeded.
34168
34169 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34170 consists of a host name followed by a list of ids for messages that are or were
34171 waiting to be delivered to that host. If there are a very large number for any
34172 one host, continuation records, with a sequence number added to the host name,
34173 may be seen. The data in these records is often out of date, because a message
34174 may be routed to several alternative hosts, and Exim makes no effort to keep
34175 cross-references.
34176
34177
34178
34179 .section "exim_tidydb" "SECID262"
34180 .cindex "&'exim_tidydb'&"
34181 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34182 database. If run with no options, it removes all records that are more than 30
34183 days old. The age is calculated from the date and time that the record was last
34184 updated. Note that, in the case of the retry database, it is &'not'& the time
34185 since the first delivery failure. Information about a host that has been down
34186 for more than 30 days will remain in the database, provided that the record is
34187 updated sufficiently often.
34188
34189 The cutoff date can be altered by means of the &%-t%& option, which must be
34190 followed by a time. For example, to remove all records older than a week from
34191 the retry database:
34192 .code
34193 exim_tidydb -t 7d /var/spool/exim retry
34194 .endd
34195 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34196 message ids. In the former these appear as data in records keyed by host &--
34197 they were messages that were waiting for that host &-- and in the latter they
34198 are the keys for retry information for messages that have suffered certain
34199 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34200 message ids in database records are those of messages that are still on the
34201 queue. Message ids for messages that no longer exist are removed from
34202 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34203 For the &'retry'& database, records whose keys are non-existent message ids are
34204 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34205 whenever it removes information from the database.
34206
34207 Certain records are automatically removed by Exim when they are no longer
34208 needed, but others are not. For example, if all the MX hosts for a domain are
34209 down, a retry record is created for each one. If the primary MX host comes back
34210 first, its record is removed when Exim successfully delivers to it, but the
34211 records for the others remain because Exim has not tried to use those hosts.
34212
34213 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34214 hints databases. You should do this at a quiet time of day, because it requires
34215 a database to be locked (and therefore inaccessible to Exim) while it does its
34216 work. Removing records from a DBM file does not normally make the file smaller,
34217 but all the common DBM libraries are able to re-use the space that is released.
34218 After an initial phase of increasing in size, the databases normally reach a
34219 point at which they no longer get any bigger, as long as they are regularly
34220 tidied.
34221
34222 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34223 databases is likely to keep on increasing.
34224
34225
34226
34227
34228 .section "exim_fixdb" "SECID263"
34229 .cindex "&'exim_fixdb'&"
34230 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34231 Its main use is for testing Exim, but it might also be occasionally useful for
34232 getting round problems in a live system. It has no options, and its interface
34233 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34234 key of a database record can then be entered, and the data for that record is
34235 displayed.
34236
34237 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34238 except the &'retry'& database, that is the only operation that can be carried
34239 out. For the &'retry'& database, each field is output preceded by a number, and
34240 data for individual fields can be changed by typing the field number followed
34241 by new data, for example:
34242 .code
34243 > 4 951102:1000
34244 .endd
34245 resets the time of the next delivery attempt. Time values are given as a
34246 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34247 used as optional separators.
34248
34249
34250
34251
34252 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34253 .cindex "mailbox" "maintenance"
34254 .cindex "&'exim_lock'&"
34255 .cindex "locking mailboxes"
34256 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34257 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34258 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34259 a user agent while investigating a problem. The utility requires the name of
34260 the file as its first argument. If the locking is successful, the second
34261 argument is run as a command (using C's &[system()]& function); if there is no
34262 second argument, the value of the SHELL environment variable is used; if this
34263 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34264 is unlocked and the utility ends. The following options are available:
34265
34266 .vlist
34267 .vitem &%-fcntl%&
34268 Use &[fcntl()]& locking on the open mailbox.
34269
34270 .vitem &%-flock%&
34271 Use &[flock()]& locking on the open mailbox, provided the operating system
34272 supports it.
34273
34274 .vitem &%-interval%&
34275 This must be followed by a number, which is a number of seconds; it sets the
34276 interval to sleep between retries (default 3).
34277
34278 .vitem &%-lockfile%&
34279 Create a lock file before opening the mailbox.
34280
34281 .vitem &%-mbx%&
34282 Lock the mailbox using MBX rules.
34283
34284 .vitem &%-q%&
34285 Suppress verification output.
34286
34287 .vitem &%-retries%&
34288 This must be followed by a number; it sets the number of times to try to get
34289 the lock (default 10).
34290
34291 .vitem &%-restore_time%&
34292 This option causes &%exim_lock%& to restore the modified and read times to the
34293 locked file before exiting. This allows you to access a locked mailbox (for
34294 example, to take a backup copy) without disturbing the times that the user
34295 subsequently sees.
34296
34297 .vitem &%-timeout%&
34298 This must be followed by a number, which is a number of seconds; it sets a
34299 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
34300 default), a non-blocking call is used.
34301
34302 .vitem &%-v%&
34303 Generate verbose output.
34304 .endlist
34305
34306 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
34307 default is to create a lock file and also to use &[fcntl()]& locking on the
34308 mailbox, which is the same as Exim's default. The use of &%-flock%& or
34309 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
34310 requires that the directory containing the file be writeable. Locking by lock
34311 file does not last for ever; Exim assumes that a lock file is expired if it is
34312 more than 30 minutes old.
34313
34314 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
34315 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
34316 to be taken out on the open mailbox, and an exclusive lock on the file
34317 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
34318 number of the mailbox file. When the locking is released, if an exclusive lock
34319 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
34320
34321 The default output contains verification of the locking that takes place. The
34322 &%-v%& option causes some additional information to be given. The &%-q%& option
34323 suppresses all output except error messages.
34324
34325 A command such as
34326 .code
34327 exim_lock /var/spool/mail/spqr
34328 .endd
34329 runs an interactive shell while the file is locked, whereas
34330 .display
34331 &`exim_lock -q /var/spool/mail/spqr <<End`&
34332 <&'some commands'&>
34333 &`End`&
34334 .endd
34335 runs a specific non-interactive sequence of commands while the file is locked,
34336 suppressing all verification output. A single command can be run by a command
34337 such as
34338 .code
34339 exim_lock -q /var/spool/mail/spqr \
34340   "cp /var/spool/mail/spqr /some/where"
34341 .endd
34342 Note that if a command is supplied, it must be entirely contained within the
34343 second argument &-- hence the quotes.
34344 .ecindex IIDutils
34345
34346
34347 . ////////////////////////////////////////////////////////////////////////////
34348 . ////////////////////////////////////////////////////////////////////////////
34349
34350 .chapter "The Exim monitor" "CHAPeximon"
34351 .scindex IIDeximon "Exim monitor" "description"
34352 .cindex "X-windows"
34353 .cindex "&'eximon'&"
34354 .cindex "Local/eximon.conf"
34355 .cindex "&_exim_monitor/EDITME_&"
34356 The Exim monitor is an application which displays in an X window information
34357 about the state of Exim's queue and what Exim is doing. An admin user can
34358 perform certain operations on messages from this GUI interface; however all
34359 such facilities are also available from the command line, and indeed, the
34360 monitor itself makes use of the command line to perform any actions requested.
34361
34362
34363
34364 .section "Running the monitor" "SECID264"
34365 The monitor is started by running the script called &'eximon'&. This is a shell
34366 script that sets up a number of environment variables, and then runs the
34367 binary called &_eximon.bin_&. The default appearance of the monitor window can
34368 be changed by editing the &_Local/eximon.conf_& file created by editing
34369 &_exim_monitor/EDITME_&. Comments in that file describe what the various
34370 parameters are for.
34371
34372 The parameters that get built into the &'eximon'& script can be overridden for
34373 a particular invocation by setting up environment variables of the same names,
34374 preceded by &`EXIMON_`&. For example, a shell command such as
34375 .code
34376 EXIMON_LOG_DEPTH=400 eximon
34377 .endd
34378 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
34379 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
34380 overrides the Exim log file configuration. This makes it possible to have
34381 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
34382 syslog messages are routed to a file on the local host.
34383
34384 X resources can be used to change the appearance of the window in the normal
34385 way. For example, a resource setting of the form
34386 .code
34387 Eximon*background: gray94
34388 .endd
34389 changes the colour of the background to light grey rather than white. The
34390 stripcharts are drawn with both the data lines and the reference lines in
34391 black. This means that the reference lines are not visible when on top of the
34392 data. However, their colour can be changed by setting a resource called
34393 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
34394 For example, if your X server is running Unix, you could set up lighter
34395 reference lines in the stripcharts by obeying
34396 .code
34397 xrdb -merge <<End
34398 Eximon*highlight: gray
34399 End
34400 .endd
34401 .cindex "admin user"
34402 In order to see the contents of messages on the queue, and to operate on them,
34403 &'eximon'& must either be run as root or by an admin user.
34404
34405 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
34406 contain X11 resource parameters interpreted by the X11 library.  In addition,
34407 if the first parameter starts with the string "gdb" then it is removed and the
34408 binary is invoked under gdb (the parameter is used as the gdb command-name, so
34409 versioned variants of gdb can be invoked).
34410
34411 The monitor's window is divided into three parts. The first contains one or
34412 more stripcharts and two action buttons, the second contains a &"tail"& of the
34413 main log file, and the third is a display of the queue of messages awaiting
34414 delivery, with two more action buttons. The following sections describe these
34415 different parts of the display.
34416
34417
34418
34419
34420 .section "The stripcharts" "SECID265"
34421 .cindex "stripchart"
34422 The first stripchart is always a count of messages on the queue. Its name can
34423 be configured by setting QUEUE_STRIPCHART_NAME in the
34424 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
34425 configuration script by regular expression matches on log file entries, making
34426 it possible to display, for example, counts of messages delivered to certain
34427 hosts or using certain transports. The supplied defaults display counts of
34428 received and delivered messages, and of local and SMTP deliveries. The default
34429 period between stripchart updates is one minute; this can be adjusted by a
34430 parameter in the &_Local/eximon.conf_& file.
34431
34432 The stripchart displays rescale themselves automatically as the value they are
34433 displaying changes. There are always 10 horizontal lines in each chart; the
34434 title string indicates the value of each division when it is greater than one.
34435 For example, &"x2"& means that each division represents a value of 2.
34436
34437 It is also possible to have a stripchart which shows the percentage fullness of
34438 a particular disk partition, which is useful when local deliveries are confined
34439 to a single partition.
34440
34441 .cindex "&%statvfs%& function"
34442 This relies on the availability of the &[statvfs()]& function or equivalent in
34443 the operating system. Most, but not all versions of Unix that support Exim have
34444 this. For this particular stripchart, the top of the chart always represents
34445 100%, and the scale is given as &"x10%"&. This chart is configured by setting
34446 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
34447 &_Local/eximon.conf_& file.
34448
34449
34450
34451
34452 .section "Main action buttons" "SECID266"
34453 .cindex "size" "of monitor window"
34454 .cindex "Exim monitor" "window size"
34455 .cindex "window size"
34456 Below the stripcharts there is an action button for quitting the monitor. Next
34457 to this is another button marked &"Size"&. They are placed here so that
34458 shrinking the window to its default minimum size leaves just the queue count
34459 stripchart and these two buttons visible. Pressing the &"Size"& button causes
34460 the window to expand to its maximum size, unless it is already at the maximum,
34461 in which case it is reduced to its minimum.
34462
34463 When expanding to the maximum, if the window cannot be fully seen where it
34464 currently is, it is moved back to where it was the last time it was at full
34465 size. When it is expanding from its minimum size, the old position is
34466 remembered, and next time it is reduced to the minimum it is moved back there.
34467
34468 The idea is that you can keep a reduced window just showing one or two
34469 stripcharts at a convenient place on your screen, easily expand it to show
34470 the full window when required, and just as easily put it back to what it was.
34471 The idea is copied from what the &'twm'& window manager does for its
34472 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
34473 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
34474
34475 Normally, the monitor starts up with the window at its full size, but it can be
34476 built so that it starts up with the window at its smallest size, by setting
34477 START_SMALL=yes in &_Local/eximon.conf_&.
34478
34479
34480
34481 .section "The log display" "SECID267"
34482 .cindex "log" "tail of; in monitor"
34483 The second section of the window is an area in which a display of the tail of
34484 the main log is maintained.
34485 To save space on the screen, the timestamp on each log line is shortened by
34486 removing the date and, if &%log_timezone%& is set, the timezone.
34487 The log tail is not available when the only destination for logging data is
34488 syslog, unless the syslog lines are routed to a local file whose name is passed
34489 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
34490
34491 The log sub-window has a scroll bar at its lefthand side which can be used to
34492 move back to look at earlier text, and the up and down arrow keys also have a
34493 scrolling effect. The amount of log that is kept depends on the setting of
34494 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
34495 to use. When this is full, the earlier 50% of data is discarded &-- this is
34496 much more efficient than throwing it away line by line. The sub-window also has
34497 a horizontal scroll bar for accessing the ends of long log lines. This is the
34498 only means of horizontal scrolling; the right and left arrow keys are not
34499 available. Text can be cut from this part of the window using the mouse in the
34500 normal way. The size of this subwindow is controlled by parameters in the
34501 configuration file &_Local/eximon.conf_&.
34502
34503 Searches of the text in the log window can be carried out by means of the ^R
34504 and ^S keystrokes, which default to a reverse and a forward search,
34505 respectively. The search covers only the text that is displayed in the window.
34506 It cannot go further back up the log.
34507
34508 The point from which the search starts is indicated by a caret marker. This is
34509 normally at the end of the text in the window, but can be positioned explicitly
34510 by pointing and clicking with the left mouse button, and is moved automatically
34511 by a successful search. If new text arrives in the window when it is scrolled
34512 back, the caret remains where it is, but if the window is not scrolled back,
34513 the caret is moved to the end of the new text.
34514
34515 Pressing ^R or ^S pops up a window into which the search text can be typed.
34516 There are buttons for selecting forward or reverse searching, for carrying out
34517 the search, and for cancelling. If the &"Search"& button is pressed, the search
34518 happens and the window remains so that further searches can be done. If the
34519 &"Return"& key is pressed, a single search is done and the window is closed. If
34520 ^C is typed the search is cancelled.
34521
34522 The searching facility is implemented using the facilities of the Athena text
34523 widget. By default this pops up a window containing both &"search"& and
34524 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
34525 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
34526 However, the linkers in BSDI and HP-UX seem unable to handle an externally
34527 provided version of &%TextPop%& when the remaining parts of the text widget
34528 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
34529 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
34530 on these systems, at the expense of having unwanted items in the search popup
34531 window.
34532
34533
34534
34535 .section "The queue display" "SECID268"
34536 .cindex "queue" "display in monitor"
34537 The bottom section of the monitor window contains a list of all messages that
34538 are on the queue, which includes those currently being received or delivered,
34539 as well as those awaiting delivery. The size of this subwindow is controlled by
34540 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
34541 at which it is updated is controlled by another parameter in the same file &--
34542 the default is 5 minutes, since queue scans can be quite expensive. However,
34543 there is an &"Update"& action button just above the display which can be used
34544 to force an update of the queue display at any time.
34545
34546 When a host is down for some time, a lot of pending mail can build up for it,
34547 and this can make it hard to deal with other messages on the queue. To help
34548 with this situation there is a button next to &"Update"& called &"Hide"&. If
34549 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
34550 type anything in here and press &"Return"&, the text is added to a chain of
34551 such texts, and if every undelivered address in a message matches at least one
34552 of the texts, the message is not displayed.
34553
34554 If there is an address that does not match any of the texts, all the addresses
34555 are displayed as normal. The matching happens on the ends of addresses so, for
34556 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
34557 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
34558 has been set up, a button called &"Unhide"& is displayed. If pressed, it
34559 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
34560 a hide request is automatically cancelled after one hour.
34561
34562 While the dialogue box is displayed, you can't press any buttons or do anything
34563 else to the monitor window. For this reason, if you want to cut text from the
34564 queue display to use in the dialogue box, you have to do the cutting before
34565 pressing the &"Hide"& button.
34566
34567 The queue display contains, for each unhidden queued message, the length of
34568 time it has been on the queue, the size of the message, the message id, the
34569 message sender, and the first undelivered recipient, all on one line. If it is
34570 a bounce message, the sender is shown as &"<>"&. If there is more than one
34571 recipient to which the message has not yet been delivered, subsequent ones are
34572 listed on additional lines, up to a maximum configured number, following which
34573 an ellipsis is displayed. Recipients that have already received the message are
34574 not shown.
34575
34576 .cindex "frozen messages" "display"
34577 If a message is frozen, an asterisk is displayed at the left-hand side.
34578
34579 The queue display has a vertical scroll bar, and can also be scrolled by means
34580 of the arrow keys. Text can be cut from it using the mouse in the normal way.
34581 The text searching facilities, as described above for the log window, are also
34582 available, but the caret is always moved to the end of the text when the queue
34583 display is updated.
34584
34585
34586
34587 .section "The queue menu" "SECID269"
34588 .cindex "queue" "menu in monitor"
34589 If the &%shift%& key is held down and the left button is clicked when the mouse
34590 pointer is over the text for any message, an action menu pops up, and the first
34591 line of the queue display for the message is highlighted. This does not affect
34592 any selected text.
34593
34594 If you want to use some other event for popping up the menu, you can set the
34595 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
34596 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
34597 value set in this parameter is a standard X event description. For example, to
34598 run eximon using &%ctrl%& rather than &%shift%& you could use
34599 .code
34600 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
34601 .endd
34602 The title of the menu is the message id, and it contains entries which act as
34603 follows:
34604
34605 .ilist
34606 &'message log'&: The contents of the message log for the message are displayed
34607 in a new text window.
34608 .next
34609 &'headers'&: Information from the spool file that contains the envelope
34610 information and headers is displayed in a new text window. See chapter
34611 &<<CHAPspool>>& for a description of the format of spool files.
34612 .next
34613 &'body'&: The contents of the spool file containing the body of the message are
34614 displayed in a new text window. There is a default limit of 20,000 bytes to the
34615 amount of data displayed. This can be changed by setting the BODY_MAX
34616 option at compile time, or the EXIMON_BODY_MAX option at run time.
34617 .next
34618 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
34619 delivery of the message. This causes an automatic thaw if the message is
34620 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
34621 a new text window. The delivery is run in a separate process, to avoid holding
34622 up the monitor while the delivery proceeds.
34623 .next
34624 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
34625 that the message be frozen.
34626 .next
34627 .cindex "thawing messages"
34628 .cindex "unfreezing messages"
34629 .cindex "frozen messages" "thawing"
34630 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
34631 that the message be thawed.
34632 .next
34633 .cindex "delivery" "forcing failure"
34634 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
34635 that Exim gives up trying to deliver the message. A bounce message is generated
34636 for any remaining undelivered addresses.
34637 .next
34638 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
34639 that the message be deleted from the system without generating a bounce
34640 message.
34641 .next
34642 &'add recipient'&: A dialog box is displayed into which a recipient address can
34643 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34644 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34645 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34646 causes a call to Exim to be made using the &%-Mar%& option to request that an
34647 additional recipient be added to the message, unless the entry box is empty, in
34648 which case no action is taken.
34649 .next
34650 &'mark delivered'&: A dialog box is displayed into which a recipient address
34651 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34652 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34653 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34654 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
34655 recipient address as already delivered, unless the entry box is empty, in which
34656 case no action is taken.
34657 .next
34658 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
34659 mark all recipient addresses as already delivered.
34660 .next
34661 &'edit sender'&: A dialog box is displayed initialized with the current
34662 sender's address. Pressing RETURN causes a call to Exim to be made using the
34663 &%-Mes%& option to replace the sender address, unless the entry box is empty,
34664 in which case no action is taken. If you want to set an empty sender (as in
34665 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
34666 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
34667 the address is qualified with that domain.
34668 .endlist
34669
34670 When a delivery is forced, a window showing the &%-v%& output is displayed. In
34671 other cases when a call to Exim is made, if there is any output from Exim (in
34672 particular, if the command fails) a window containing the command and the
34673 output is displayed. Otherwise, the results of the action are normally apparent
34674 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
34675 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
34676 if no output is generated.
34677
34678 The queue display is automatically updated for actions such as freezing and
34679 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
34680 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
34681 force an update of the display after one of these actions.
34682
34683 In any text window that is displayed as result of a menu action, the normal
34684 cut-and-paste facility is available, and searching can be carried out using ^R
34685 and ^S, as described above for the log tail window.
34686 .ecindex IIDeximon
34687
34688
34689
34690
34691
34692 . ////////////////////////////////////////////////////////////////////////////
34693 . ////////////////////////////////////////////////////////////////////////////
34694
34695 .chapter "Security considerations" "CHAPsecurity"
34696 .scindex IIDsecurcon "security" "discussion of"
34697 This chapter discusses a number of issues concerned with security, some of
34698 which are also covered in other parts of this manual.
34699
34700 For reasons that this author does not understand, some people have promoted
34701 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
34702 existence of this chapter in the documentation. However, the intent of the
34703 chapter is simply to describe the way Exim works in relation to certain
34704 security concerns, not to make any specific claims about the effectiveness of
34705 its security as compared with other MTAs.
34706
34707 What follows is a description of the way Exim is supposed to be. Best efforts
34708 have been made to try to ensure that the code agrees with the theory, but an
34709 absence of bugs can never be guaranteed. Any that are reported will get fixed
34710 as soon as possible.
34711
34712
34713 .section "Building a more &""hardened""& Exim" "SECID286"
34714 .cindex "security" "build-time features"
34715 There are a number of build-time options that can be set in &_Local/Makefile_&
34716 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
34717 Exim administrator who does not have the root password, or by someone who has
34718 penetrated the Exim (but not the root) account. These options are as follows:
34719
34720 .ilist
34721 ALT_CONFIG_PREFIX can be set to a string that is required to match the
34722 start of any file names used with the &%-C%& option. When it is set, these file
34723 names are also not allowed to contain the sequence &"/../"&. (However, if the
34724 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
34725 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
34726 default setting for &%ALT_CONFIG_PREFIX%&.
34727
34728 If the permitted configuration files are confined to a directory to
34729 which only root has access, this guards against someone who has broken
34730 into the Exim account from running a privileged Exim with an arbitrary
34731 configuration file, and using it to break into other accounts.
34732 .next
34733
34734 If a non-trusted configuration file (i.e. not the default configuration file
34735 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
34736 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
34737 the next item), then root privilege is retained only if the caller of Exim is
34738 root. This locks out the possibility of testing a configuration using &%-C%&
34739 right through message reception and delivery, even if the caller is root. The
34740 reception works, but by that time, Exim is running as the Exim user, so when
34741 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
34742 privilege to be lost. However, root can test reception and delivery using two
34743 separate commands.
34744
34745 .next
34746 The WHITELIST_D_MACROS build option declares some macros to be safe to override
34747 with &%-D%& if the real uid is one of root, the Exim run-time user or the
34748 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
34749 requiring the run-time value supplied to &%-D%& to match a regex that errs on
34750 the restrictive side.  Requiring build-time selection of safe macros is onerous
34751 but this option is intended solely as a transition mechanism to permit
34752 previously-working configurations to continue to work after release 4.73.
34753 .next
34754 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
34755 is disabled.
34756 .next
34757 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
34758 never to be used for any deliveries. This is like the &%never_users%& runtime
34759 option, but it cannot be overridden; the runtime option adds additional users
34760 to the list. The default setting is &"root"&; this prevents a non-root user who
34761 is permitted to modify the runtime file from using Exim as a way to get root.
34762 .endlist
34763
34764
34765
34766 .section "Root privilege" "SECID270"
34767 .cindex "setuid"
34768 .cindex "root privilege"
34769 The Exim binary is normally setuid to root, which means that it gains root
34770 privilege (runs as root) when it starts execution. In some special cases (for
34771 example, when the daemon is not in use and there are no local deliveries), it
34772 may be possible to run Exim setuid to some user other than root. This is
34773 discussed in the next section. However, in most installations, root privilege
34774 is required for two things:
34775
34776 .ilist
34777 To set up a socket connected to the standard SMTP port (25) when initialising
34778 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
34779 not required.
34780 .next
34781 To be able to change uid and gid in order to read users' &_.forward_& files and
34782 perform local deliveries as the receiving user or as specified in the
34783 configuration.
34784 .endlist
34785
34786 It is not necessary to be root to do any of the other things Exim does, such as
34787 receiving messages and delivering them externally over SMTP, and it is
34788 obviously more secure if Exim does not run as root except when necessary.
34789 For this reason, a user and group for Exim to use must be defined in
34790 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
34791 group"&. Their values can be changed by the run time configuration, though this
34792 is not recommended. Often a user called &'exim'& is used, but some sites use
34793 &'mail'& or another user name altogether.
34794
34795 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
34796 abdication; the process cannot regain root afterwards. Prior to release 4.00,
34797 &[seteuid()]& was used in some circumstances, but this is no longer the case.
34798
34799 After a new Exim process has interpreted its command line options, it changes
34800 uid and gid in the following cases:
34801
34802 .ilist
34803 .oindex "&%-C%&"
34804 .oindex "&%-D%&"
34805 If the &%-C%& option is used to specify an alternate configuration file, or if
34806 the &%-D%& option is used to define macro values for the configuration, and the
34807 calling process is not running as root, the uid and gid are changed to those of
34808 the calling process.
34809 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
34810 option may not be used at all.
34811 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
34812 can be supplied if the calling process is running as root, the Exim run-time
34813 user or CONFIGURE_OWNER, if defined.
34814 .next
34815 .oindex "&%-be%&"
34816 .oindex "&%-bf%&"
34817 .oindex "&%-bF%&"
34818 If the expansion test option (&%-be%&) or one of the filter testing options
34819 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
34820 calling process.
34821 .next
34822 If the process is not a daemon process or a queue runner process or a delivery
34823 process or a process for testing address routing (started with &%-bt%&), the
34824 uid and gid are changed to the Exim user and group. This means that Exim always
34825 runs under its own uid and gid when receiving messages. This also applies when
34826 testing address verification
34827 .oindex "&%-bv%&"
34828 .oindex "&%-bh%&"
34829 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
34830 option).
34831 .next
34832 For a daemon, queue runner, delivery, or address testing process, the uid
34833 remains as root at this stage, but the gid is changed to the Exim group.
34834 .endlist
34835
34836 The processes that initially retain root privilege behave as follows:
34837
34838 .ilist
34839 A daemon process changes the gid to the Exim group and the uid to the Exim
34840 user after setting up one or more listening sockets. The &[initgroups()]&
34841 function is called, so that if the Exim user is in any additional groups, they
34842 will be used during message reception.
34843 .next
34844 A queue runner process retains root privilege throughout its execution. Its
34845 job is to fork a controlled sequence of delivery processes.
34846 .next
34847 A delivery process retains root privilege throughout most of its execution,
34848 but any actual deliveries (that is, the transports themselves) are run in
34849 subprocesses which always change to a non-root uid and gid. For local
34850 deliveries this is typically the uid and gid of the owner of the mailbox; for
34851 remote deliveries, the Exim uid and gid are used. Once all the delivery
34852 subprocesses have been run, a delivery process changes to the Exim uid and gid
34853 while doing post-delivery tidying up such as updating the retry database and
34854 generating bounce and warning messages.
34855
34856 While the recipient addresses in a message are being routed, the delivery
34857 process runs as root. However, if a user's filter file has to be processed,
34858 this is done in a subprocess that runs under the individual user's uid and
34859 gid. A system filter is run as root unless &%system_filter_user%& is set.
34860 .next
34861 A process that is testing addresses (the &%-bt%& option) runs as root so that
34862 the routing is done in the same environment as a message delivery.
34863 .endlist
34864
34865
34866
34867
34868 .section "Running Exim without privilege" "SECTrunexiwitpri"
34869 .cindex "privilege, running without"
34870 .cindex "unprivileged running"
34871 .cindex "root privilege" "running without"
34872 Some installations like to run Exim in an unprivileged state for more of its
34873 operation, for added security. Support for this mode of operation is provided
34874 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34875 gid are changed to the Exim user and group at the start of a delivery process
34876 (and also queue runner and address testing processes). This means that address
34877 routing is no longer run as root, and the deliveries themselves cannot change
34878 to any other uid.
34879
34880 .cindex SIGHUP
34881 .cindex "daemon" "restarting"
34882 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34883 that the daemon can still be started in the usual way, and it can respond
34884 correctly to SIGHUP because the re-invocation regains root privilege.
34885
34886 An alternative approach is to make Exim setuid to the Exim user and also setgid
34887 to the Exim group. If you do this, the daemon must be started from a root
34888 process. (Calling Exim from a root process makes it behave in the way it does
34889 when it is setuid root.) However, the daemon cannot restart itself after a
34890 SIGHUP signal because it cannot regain privilege.
34891
34892 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34893 stops Exim from trying to re-invoke itself to do a delivery after a message has
34894 been received. Such a re-invocation is a waste of resources because it has no
34895 effect.
34896
34897 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34898 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34899 to the Exim user seems a clean approach, but there is one complication:
34900
34901 In this style of operation, Exim is running with the real uid and gid set to
34902 those of the calling process, and the effective uid/gid set to Exim's values.
34903 Ideally, any association with the calling process' uid/gid should be dropped,
34904 that is, the real uid/gid should be reset to the effective values so as to
34905 discard any privileges that the caller may have. While some operating systems
34906 have a function that permits this action for a non-root effective uid, quite a
34907 number of them do not. Because of this lack of standardization, Exim does not
34908 address this problem at this time.
34909
34910 For this reason, the recommended approach for &"mostly unprivileged"& running
34911 is to keep the Exim binary setuid to root, and to set
34912 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34913 be used in the most straightforward way.
34914
34915 If you configure Exim not to run delivery processes as root, there are a
34916 number of restrictions on what you can do:
34917
34918 .ilist
34919 You can deliver only as the Exim user/group. You should  explicitly use the
34920 &%user%& and &%group%& options to override routers or local transports that
34921 normally deliver as the recipient. This makes sure that configurations that
34922 work in this mode function the same way in normal mode. Any implicit or
34923 explicit specification of another user causes an error.
34924 .next
34925 Use of &_.forward_& files is severely restricted, such that it is usually
34926 not worthwhile to include them in the configuration.
34927 .next
34928 Users who wish to use &_.forward_& would have to make their home directory and
34929 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34930 and their equivalents in Exim filters, cannot be used. While they could be
34931 enabled in the Exim user's name, that would be insecure and not very useful.
34932 .next
34933 Unless the local user mailboxes are all owned by the Exim user (possible in
34934 some POP3 or IMAP-only environments):
34935
34936 .olist
34937 They must be owned by the Exim group and be writeable by that group. This
34938 implies you must set &%mode%& in the appendfile configuration, as well as the
34939 mode of the mailbox files themselves.
34940 .next
34941 You must set &%no_check_owner%&, since most or all of the files will not be
34942 owned by the Exim user.
34943 .next
34944 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34945 on a newly created mailbox when unprivileged. This also implies that new
34946 mailboxes need to be created manually.
34947 .endlist olist
34948 .endlist ilist
34949
34950
34951 These restrictions severely restrict what can be done in local deliveries.
34952 However, there are no restrictions on remote deliveries. If you are running a
34953 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34954 gives more security at essentially no cost.
34955
34956 If you are using the &%mua_wrapper%& facility (see chapter
34957 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34958
34959
34960
34961
34962 .section "Delivering to local files" "SECID271"
34963 Full details of the checks applied by &(appendfile)& before it writes to a file
34964 are given in chapter &<<CHAPappendfile>>&.
34965
34966
34967
34968 .section "IPv4 source routing" "SECID272"
34969 .cindex "source routing" "in IP packets"
34970 .cindex "IP source routing"
34971 Many operating systems suppress IP source-routed packets in the kernel, but
34972 some cannot be made to do this, so Exim does its own check. It logs incoming
34973 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34974 IPv6. No special checking is currently done.
34975
34976
34977
34978 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34979 Support for these SMTP commands is disabled by default. If required, they can
34980 be enabled by defining suitable ACLs.
34981
34982
34983
34984
34985 .section "Privileged users" "SECID274"
34986 .cindex "trusted users"
34987 .cindex "admin user"
34988 .cindex "privileged user"
34989 .cindex "user" "trusted"
34990 .cindex "user" "admin"
34991 Exim recognizes two sets of users with special privileges. Trusted users are
34992 able to submit new messages to Exim locally, but supply their own sender
34993 addresses and information about a sending host. For other users submitting
34994 local messages, Exim sets up the sender address from the uid, and doesn't
34995 permit a remote host to be specified.
34996
34997 .oindex "&%-f%&"
34998 However, an untrusted user is permitted to use the &%-f%& command line option
34999 in the special form &%-f <>%& to indicate that a delivery failure for the
35000 message should not cause an error report. This affects the message's envelope,
35001 but it does not affect the &'Sender:'& header. Untrusted users may also be
35002 permitted to use specific forms of address with the &%-f%& option by setting
35003 the &%untrusted_set_sender%& option.
35004
35005 Trusted users are used to run processes that receive mail messages from some
35006 other mail domain and pass them on to Exim for delivery either locally, or over
35007 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35008 as any user listed in the &%trusted_users%& configuration option, or under any
35009 group listed in the &%trusted_groups%& option.
35010
35011 Admin users are permitted to do things to the messages on Exim's queue. They
35012 can freeze or thaw messages, cause them to be returned to their senders, remove
35013 them entirely, or modify them in various ways. In addition, admin users can run
35014 the Exim monitor and see all the information it is capable of providing, which
35015 includes the contents of files on the spool.
35016
35017 .oindex "&%-M%&"
35018 .oindex "&%-q%&"
35019 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35020 delivery of messages on its queue is restricted to admin users. This
35021 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35022 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35023 queue is also restricted to admin users. This restriction can be relaxed by
35024 setting &%no_queue_list_requires_admin%&.
35025
35026 Exim recognizes an admin user if the calling process is running as root or as
35027 the Exim user or if any of the groups associated with the calling process is
35028 the Exim group. It is not necessary actually to be running under the Exim
35029 group. However, if admin users who are not root or the Exim user are to access
35030 the contents of files on the spool via the Exim monitor (which runs
35031 unprivileged), Exim must be built to allow group read access to its spool
35032 files.
35033
35034
35035
35036 .section "Spool files" "SECID275"
35037 .cindex "spool directory" "files"
35038 Exim's spool directory and everything it contains is owned by the Exim user and
35039 set to the Exim group. The mode for spool files is defined in the
35040 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35041 any user who is a member of the Exim group can access these files.
35042
35043
35044
35045 .section "Use of argv[0]" "SECID276"
35046 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35047 of specific strings, Exim assumes certain options. For example, calling Exim
35048 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35049 to calling it with the option &%-bS%&. There are no security implications in
35050 this.
35051
35052
35053
35054 .section "Use of %f formatting" "SECID277"
35055 The only use made of &"%f"& by Exim is in formatting load average values. These
35056 are actually stored in integer variables as 1000 times the load average.
35057 Consequently, their range is limited and so therefore is the length of the
35058 converted output.
35059
35060
35061
35062 .section "Embedded Exim path" "SECID278"
35063 Exim uses its own path name, which is embedded in the code, only when it needs
35064 to re-exec in order to regain root privilege. Therefore, it is not root when it
35065 does so. If some bug allowed the path to get overwritten, it would lead to an
35066 arbitrary program's being run as exim, not as root.
35067
35068
35069
35070 .section "Dynamic module directory" "SECTdynmoddir"
35071 Any dynamically loadable modules must be installed into the directory
35072 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35073 loading it.
35074
35075
35076 .section "Use of sprintf()" "SECID279"
35077 .cindex "&[sprintf()]&"
35078 A large number of occurrences of &"sprintf"& in the code are actually calls to
35079 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35080 The intermediate formatting is done into a large fixed buffer by a function
35081 that runs through the format string itself, and checks the length of each
35082 conversion before performing it, thus preventing buffer overruns.
35083
35084 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35085 the output buffer is known to be sufficiently long to contain the converted
35086 string.
35087
35088
35089
35090 .section "Use of debug_printf() and log_write()" "SECID280"
35091 Arbitrary strings are passed to both these functions, but they do their
35092 formatting by calling the function &'string_vformat()'&, which runs through
35093 the format string itself, and checks the length of each conversion.
35094
35095
35096
35097 .section "Use of strcat() and strcpy()" "SECID281"
35098 These are used only in cases where the output buffer is known to be large
35099 enough to hold the result.
35100 .ecindex IIDsecurcon
35101
35102
35103
35104
35105 . ////////////////////////////////////////////////////////////////////////////
35106 . ////////////////////////////////////////////////////////////////////////////
35107
35108 .chapter "Format of spool files" "CHAPspool"
35109 .scindex IIDforspo1 "format" "spool files"
35110 .scindex IIDforspo2 "spool directory" "format of files"
35111 .scindex IIDforspo3 "spool files" "format of"
35112 .cindex "spool files" "editing"
35113 A message on Exim's queue consists of two files, whose names are the message id
35114 followed by -D and -H, respectively. The data portion of the message is kept in
35115 the -D file on its own. The message's envelope, status, and headers are all
35116 kept in the -H file, whose format is described in this chapter. Each of these
35117 two files contains the final component of its own name as its first line. This
35118 is insurance against disk crashes where the directory is lost but the files
35119 themselves are recoverable.
35120
35121 Some people are tempted into editing -D files in order to modify messages. You
35122 need to be extremely careful if you do this; it is not recommended and you are
35123 on your own if you do it. Here are some of the pitfalls:
35124
35125 .ilist
35126 You must ensure that Exim does not try to deliver the message while you are
35127 fiddling with it. The safest way is to take out a write lock on the -D file,
35128 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35129 place, the lock will be retained. If you write a new file and rename it, the
35130 lock will be lost at the instant of rename.
35131 .next
35132 .vindex "&$body_linecount$&"
35133 If you change the number of lines in the file, the value of
35134 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35135 present, this value is not used by Exim, but there is no guarantee that this
35136 will always be the case.
35137 .next
35138 If the message is in MIME format, you must take care not to break it.
35139 .next
35140 If the message is cryptographically signed, any change will invalidate the
35141 signature.
35142 .endlist
35143 All in all, modifying -D files is fraught with danger.
35144
35145 Files whose names end with -J may also be seen in the &_input_& directory (or
35146 its subdirectories when &%split_spool_directory%& is set). These are journal
35147 files, used to record addresses to which the message has been delivered during
35148 the course of a delivery attempt. If there are still undelivered recipients at
35149 the end, the -H file is updated, and the -J file is deleted. If, however, there
35150 is some kind of crash (for example, a power outage) before this happens, the -J
35151 file remains in existence. When Exim next processes the message, it notices the
35152 -J file and uses it to update the -H file before starting the next delivery
35153 attempt.
35154
35155 .section "Format of the -H file" "SECID282"
35156 .cindex "uid (user id)" "in spool file"
35157 .cindex "gid (group id)" "in spool file"
35158 The second line of the -H file contains the login name for the uid of the
35159 process that called Exim to read the message, followed by the numerical uid and
35160 gid. For a locally generated message, this is normally the user who sent the
35161 message. For a message received over TCP/IP via the daemon, it is
35162 normally the Exim user.
35163
35164 The third line of the file contains the address of the message's sender as
35165 transmitted in the envelope, contained in angle brackets. The sender address is
35166 empty for bounce messages. For incoming SMTP mail, the sender address is given
35167 in the MAIL command. For locally generated mail, the sender address is
35168 created by Exim from the login name of the current user and the configured
35169 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35170 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35171 &"<>"& or an address that matches &%untrusted_set_senders%&.
35172
35173 The fourth line contains two numbers. The first is the time that the message
35174 was received, in the conventional Unix form &-- the number of seconds since the
35175 start of the epoch. The second number is a count of the number of messages
35176 warning of delayed delivery that have been sent to the sender.
35177
35178 There follow a number of lines starting with a hyphen. These can appear in any
35179 order, and are omitted when not relevant:
35180
35181 .vlist
35182 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35183 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35184 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35185 recognized, to provide backward compatibility. In the old format, a line of
35186 this form is present for every ACL variable that is not empty. The number
35187 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35188 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35189 the data string for the variable. The string itself starts at the beginning of
35190 the next line, and is followed by a newline character. It may contain internal
35191 newlines.
35192
35193 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35194 A line of this form is present for every ACL connection variable that is
35195 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35196 The length is the length of the data string for the variable. The string itself
35197 starts at the beginning of the next line, and is followed by a newline
35198 character. It may contain internal newlines.
35199
35200 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35201 A line of this form is present for every ACL message variable that is defined.
35202 Note that there is a space between &%-aclm%& and the rest of the name. The
35203 length is the length of the data string for the variable. The string itself
35204 starts at the beginning of the next line, and is followed by a newline
35205 character. It may contain internal newlines.
35206
35207 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35208 This is present if, when the message was received over SMTP, the value of
35209 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35210
35211 .vitem &%-allow_unqualified_recipient%&
35212 This is present if unqualified recipient addresses are permitted in header
35213 lines (to stop such addresses from being qualified if rewriting occurs at
35214 transport time). Local messages that were input using &%-bnq%& and remote
35215 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35216
35217 .vitem &%-allow_unqualified_sender%&
35218 This is present if unqualified sender addresses are permitted in header lines
35219 (to stop such addresses from being qualified if rewriting occurs at transport
35220 time). Local messages that were input using &%-bnq%& and remote messages from
35221 hosts that match &%sender_unqualified_hosts%& set this flag.
35222
35223 .vitem "&%-auth_id%&&~<&'text'&>"
35224 The id information for a message received on an authenticated SMTP connection
35225 &-- the value of the &$authenticated_id$& variable.
35226
35227 .vitem "&%-auth_sender%&&~<&'address'&>"
35228 The address of an authenticated sender &-- the value of the
35229 &$authenticated_sender$& variable.
35230
35231 .vitem "&%-body_linecount%&&~<&'number'&>"
35232 This records the number of lines in the body of the message, and is always
35233 present.
35234
35235 .vitem "&%-body_zerocount%&&~<&'number'&>"
35236 This records the number of binary zero bytes in the body of the message, and is
35237 present if the number is greater than zero.
35238
35239 .vitem &%-deliver_firsttime%&
35240 This is written when a new message is first added to the spool. When the spool
35241 file is updated after a deferral, it is omitted.
35242
35243 .vitem "&%-frozen%&&~<&'time'&>"
35244 .cindex "frozen messages" "spool data"
35245 The message is frozen, and the freezing happened at <&'time'&>.
35246
35247 .vitem "&%-helo_name%&&~<&'text'&>"
35248 This records the host name as specified by a remote host in a HELO or EHLO
35249 command.
35250
35251 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35252 This records the IP address of the host from which the message was received and
35253 the remote port number that was used. It is omitted for locally generated
35254 messages.
35255
35256 .vitem "&%-host_auth%&&~<&'text'&>"
35257 If the message was received on an authenticated SMTP connection, this records
35258 the name of the authenticator &-- the value of the
35259 &$sender_host_authenticated$& variable.
35260
35261 .vitem &%-host_lookup_failed%&
35262 This is present if an attempt to look up the sending host's name from its IP
35263 address failed. It corresponds to the &$host_lookup_failed$& variable.
35264
35265 .vitem "&%-host_name%&&~<&'text'&>"
35266 .cindex "reverse DNS lookup"
35267 .cindex "DNS" "reverse lookup"
35268 This records the name of the remote host from which the message was received,
35269 if the host name was looked up from the IP address when the message was being
35270 received. It is not present if no reverse lookup was done.
35271
35272 .vitem "&%-ident%&&~<&'text'&>"
35273 For locally submitted messages, this records the login of the originating user,
35274 unless it was a trusted user and the &%-oMt%& option was used to specify an
35275 ident value. For messages received over TCP/IP, this records the ident string
35276 supplied by the remote host, if any.
35277
35278 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
35279 This records the IP address of the local interface and the port number through
35280 which a message was received from a remote host. It is omitted for locally
35281 generated messages.
35282
35283 .vitem &%-local%&
35284 The message is from a local sender.
35285
35286 .vitem &%-localerror%&
35287 The message is a locally-generated bounce message.
35288
35289 .vitem "&%-local_scan%&&~<&'string'&>"
35290 This records the data string that was returned by the &[local_scan()]& function
35291 when the message was received &-- the value of the &$local_scan_data$&
35292 variable. It is omitted if no data was returned.
35293
35294 .vitem &%-manual_thaw%&
35295 The message was frozen but has been thawed manually, that is, by an explicit
35296 Exim command rather than via the auto-thaw process.
35297
35298 .vitem &%-N%&
35299 A testing delivery process was started using the &%-N%& option to suppress any
35300 actual deliveries, but delivery was deferred. At any further delivery attempts,
35301 &%-N%& is assumed.
35302
35303 .vitem &%-received_protocol%&
35304 This records the value of the &$received_protocol$& variable, which contains
35305 the name of the protocol by which the message was received.
35306
35307 .vitem &%-sender_set_untrusted%&
35308 The envelope sender of this message was set by an untrusted local caller (used
35309 to ensure that the caller is displayed in queue listings).
35310
35311 .vitem "&%-spam_score_int%&&~<&'number'&>"
35312 If a message was scanned by SpamAssassin, this is present. It records the value
35313 of &$spam_score_int$&.
35314
35315 .vitem &%-tls_certificate_verified%&
35316 A TLS certificate was received from the client that sent this message, and the
35317 certificate was verified by the server.
35318
35319 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
35320 When the message was received over an encrypted connection, this records the
35321 name of the cipher suite that was used.
35322
35323 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
35324 When the message was received over an encrypted connection, and a certificate
35325 was received from the client, this records the Distinguished Name from that
35326 certificate.
35327 .endlist
35328
35329 Following the options there is a list of those addresses to which the message
35330 is not to be delivered. This set of addresses is initialized from the command
35331 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
35332 is set; otherwise it starts out empty. Whenever a successful delivery is made,
35333 the address is added to this set. The addresses are kept internally as a
35334 balanced binary tree, and it is a representation of that tree which is written
35335 to the spool file. If an address is expanded via an alias or forward file, the
35336 original address is added to the tree when deliveries to all its child
35337 addresses are complete.
35338
35339 If the tree is empty, there is a single line in the spool file containing just
35340 the text &"XX"&. Otherwise, each line consists of two letters, which are either
35341 Y or N, followed by an address. The address is the value for the node of the
35342 tree, and the letters indicate whether the node has a left branch and/or a
35343 right branch attached to it, respectively. If branches exist, they immediately
35344 follow. Here is an example of a three-node tree:
35345 .code
35346 YY darcy@austen.fict.example
35347 NN alice@wonderland.fict.example
35348 NN editor@thesaurus.ref.example
35349 .endd
35350 After the non-recipients tree, there is a list of the message's recipients.
35351 This is a simple list, preceded by a count. It includes all the original
35352 recipients of the message, including those to whom the message has already been
35353 delivered. In the simplest case, the list contains one address per line. For
35354 example:
35355 .code
35356 4
35357 editor@thesaurus.ref.example
35358 darcy@austen.fict.example
35359 rdo@foundation
35360 alice@wonderland.fict.example
35361 .endd
35362 However, when a child address has been added to the top-level addresses as a
35363 result of the use of the &%one_time%& option on a &(redirect)& router, each
35364 line is of the following form:
35365 .display
35366 <&'top-level address'&> <&'errors_to address'&> &&&
35367   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
35368 .endd
35369 The 01 flag bit indicates the presence of the three other fields that follow
35370 the top-level address. Other bits may be used in future to support additional
35371 fields. The <&'parent number'&> is the offset in the recipients list of the
35372 original parent of the &"one time"& address. The first two fields are the
35373 envelope sender that is associated with this address and its length. If the
35374 length is zero, there is no special envelope sender (there are then two space
35375 characters in the line). A non-empty field can arise from a &(redirect)& router
35376 that has an &%errors_to%& setting.
35377
35378
35379 A blank line separates the envelope and status information from the headers
35380 which follow. A header may occupy several lines of the file, and to save effort
35381 when reading it in, each header is preceded by a number and an identifying
35382 character. The number is the number of characters in the header, including any
35383 embedded newlines and the terminating newline. The character is one of the
35384 following:
35385
35386 .table2 50pt
35387 .row <&'blank'&>         "header in which Exim has no special interest"
35388 .row &`B`&               "&'Bcc:'& header"
35389 .row &`C`&               "&'Cc:'& header"
35390 .row &`F`&               "&'From:'& header"
35391 .row &`I`&               "&'Message-id:'& header"
35392 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
35393 .row &`R`&               "&'Reply-To:'& header"
35394 .row &`S`&               "&'Sender:'& header"
35395 .row &`T`&               "&'To:'& header"
35396 .row &`*`&               "replaced or deleted header"
35397 .endtable
35398
35399 Deleted or replaced (rewritten) headers remain in the spool file for debugging
35400 purposes. They are not transmitted when the message is delivered. Here is a
35401 typical set of headers:
35402 .code
35403 111P Received: by hobbit.fict.example with local (Exim 4.00)
35404 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
35405 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
35406 038* X-rewrote-sender: bb@hobbit.fict.example
35407 042* From: Bilbo Baggins <bb@hobbit.fict.example>
35408 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
35409 099* To: alice@wonderland.fict.example, rdo@foundation,
35410 darcy@austen.fict.example, editor@thesaurus.ref.example
35411 104T To: alice@wonderland.fict.example, rdo@foundation.example,
35412 darcy@austen.fict.example, editor@thesaurus.ref.example
35413 038  Date: Fri, 11 May 2001 10:28:59 +0100
35414 .endd
35415 The asterisked headers indicate that the envelope sender, &'From:'& header, and
35416 &'To:'& header have been rewritten, the last one because routing expanded the
35417 unqualified domain &'foundation'&.
35418 .ecindex IIDforspo1
35419 .ecindex IIDforspo2
35420 .ecindex IIDforspo3
35421
35422 . ////////////////////////////////////////////////////////////////////////////
35423 . ////////////////////////////////////////////////////////////////////////////
35424
35425 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHID12" &&&
35426          "DKIM Support"
35427 .cindex "DKIM"
35428
35429 DKIM is a mechanism by which messages sent by some entity can be provably
35430 linked to a domain which that entity controls.  It permits reputation to
35431 be tracked on a per-domain basis, rather than merely upon source IP address.
35432 DKIM is documented in RFC 4871.
35433
35434 Since version 4.70, DKIM support is compiled into Exim by default. It can be
35435 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
35436
35437 Exim's DKIM implementation allows to
35438 .olist
35439 Sign outgoing messages: This function is implemented in the SMTP transport.
35440 It can co-exist with all other Exim features, including transport filters.
35441 .next
35442 Verify signatures in incoming messages: This is implemented by an additional
35443 ACL (acl_smtp_dkim), which can be called several times per message, with
35444 different signature contexts.
35445 .endlist
35446
35447 In typical Exim style, the verification implementation does not include any
35448 default "policy". Instead it enables you to build your own policy using
35449 Exim's standard controls.
35450
35451 Please note that verification of DKIM signatures in incoming mail is turned
35452 on by default for logging purposes. For each signature in incoming email,
35453 exim will log a line displaying the most important signature details, and the
35454 signature status. Here is an example (with line-breaks added for clarity):
35455 .code
35456 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
35457     d=facebookmail.com s=q1-2009b
35458     c=relaxed/relaxed a=rsa-sha1
35459     i=@facebookmail.com t=1252484542 [verification succeeded]
35460 .endd
35461 You might want to turn off DKIM verification processing entirely for internal
35462 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
35463 control modifier. This should typically be done in the RCPT ACL, at points
35464 where you accept mail from relay sources (internal hosts or authenticated
35465 senders).
35466
35467
35468 .section "Signing outgoing messages" "SECID513"
35469 .cindex "DKIM" "signing"
35470
35471 Signing is implemented by setting private options on the SMTP transport.
35472 These options take (expandable) strings as arguments.
35473
35474 .option dkim_domain smtp string&!! unset
35475 MANDATORY:
35476 The domain you want to sign with. The result of this expanded
35477 option is put into the &%$dkim_domain%& expansion variable.
35478
35479 .option dkim_selector smtp string&!! unset
35480 MANDATORY:
35481 This sets the key selector string. You can use the &%$dkim_domain%& expansion
35482 variable to look up a matching selector. The result is put in the expansion
35483 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
35484 option along with &%$dkim_domain%&.
35485
35486 .option dkim_private_key smtp string&!! unset
35487 MANDATORY:
35488 This sets the private key to use. You can use the &%$dkim_domain%& and
35489 &%$dkim_selector%& expansion variables to determine the private key to use.
35490 The result can either
35491 .ilist
35492 be a valid RSA private key in ASCII armor, including line breaks.
35493 .next
35494 start with a slash, in which case it is treated as a file that contains
35495 the private key.
35496 .next
35497 be "0", "false" or the empty string, in which case the message will not
35498 be signed. This case will not result in an error, even if &%dkim_strict%&
35499 is set.
35500 .endlist
35501
35502 .option dkim_canon smtp string&!! unset
35503 OPTIONAL:
35504 This option sets the canonicalization method used when signing a message.
35505 The DKIM RFC currently supports two methods: "simple" and "relaxed".
35506 The option defaults to "relaxed" when unset. Note: the current implementation
35507 only supports using the same canonicalization method for both headers and body.
35508
35509 .option dkim_strict smtp string&!! unset
35510 OPTIONAL:
35511 This  option  defines  how  Exim  behaves  when  signing a message that
35512 should be signed fails for some reason.  When the expansion evaluates to
35513 either "1" or "true", Exim will defer. Otherwise Exim will send the message
35514 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
35515 variables here.
35516
35517 .option dkim_sign_headers smtp string&!! unset
35518 OPTIONAL:
35519 When set, this option must expand to (or be specified as) a colon-separated
35520 list of header names. Headers with these names will be included in the message
35521 signature. When unspecified, the header names recommended in RFC4871 will be
35522 used.
35523
35524
35525 .section "Verifying DKIM signatures in incoming mail" "SECID514"
35526 .cindex "DKIM" "verification"
35527
35528 Verification of DKIM signatures in incoming email is implemented via the
35529 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
35530 syntactically(!) correct signature in the incoming message.
35531
35532 To evaluate the signature in the ACL a large number of expansion variables
35533 containing the signature status and its details are set up during the
35534 runtime of the ACL.
35535
35536 Calling the ACL only for existing signatures is not sufficient to build
35537 more advanced policies. For that reason, the global option
35538 &%dkim_verify_signers%&, and a global expansion variable
35539 &%$dkim_signers%& exist.
35540
35541 The global option &%dkim_verify_signers%& can be set to a colon-separated
35542 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
35543 called. It is expanded when the message has been received. At this point,
35544 the expansion variable &%$dkim_signers%& already contains a colon-separated
35545 list of signer domains and identities for the message. When
35546 &%dkim_verify_signers%& is not specified in the main configuration,
35547 it defaults as:
35548 .code
35549 dkim_verify_signers = $dkim_signers
35550 .endd
35551 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
35552 DKIM signature in the message. Current DKIM verifiers may want to explicitly
35553 call the ACL for known domains or identities. This would be achieved as follows:
35554 .code
35555 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
35556 .endd
35557 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
35558 and "ebay.com", plus all domains and identities that have signatures in the message.
35559 You can also be more creative in constructing your policy. For example:
35560 .code
35561 dkim_verify_signers = $sender_address_domain:$dkim_signers
35562 .endd
35563
35564 If a domain or identity is listed several times in the (expanded) value of
35565 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
35566
35567
35568 Inside the &%acl_smtp_dkim%&, the following expansion variables are
35569 available (from most to least important):
35570
35571
35572 .vlist
35573 .vitem &%$dkim_cur_signer%&
35574 The signer that is being evaluated in this ACL run. This can be a domain or
35575 an identity. This is one of the list items from the expanded main option
35576 &%dkim_verify_signers%& (see above).
35577 .vitem &%$dkim_verify_status%&
35578 A string describing the general status of the signature. One of
35579 .ilist
35580 &%none%&: There is no signature in the message for the current domain or
35581 identity (as reflected by &%$dkim_cur_signer%&).
35582 .next
35583 &%invalid%&: The signature could not be verified due to a processing error.
35584 More detail is available in &%$dkim_verify_reason%&.
35585 .next
35586 &%fail%&: Verification of the signature failed.  More detail is
35587 available in &%$dkim_verify_reason%&.
35588 .next
35589 &%pass%&: The signature passed verification. It is valid.
35590 .endlist
35591 .vitem &%$dkim_verify_reason%&
35592 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
35593 "fail" or "invalid". One of
35594 .ilist
35595 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
35596 key for the domain could not be retrieved. This may be a temporary problem.
35597 .next
35598 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
35599 record for the domain is syntactically invalid.
35600 .next
35601 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
35602 body hash does not match the one specified in the signature header. This
35603 means that the message body was modified in transit.
35604 .next
35605 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
35606 could not be verified. This may mean that headers were modified,
35607 re-written or otherwise changed in a way which is incompatible with
35608 DKIM verification. It may of course also mean that the signature is forged.
35609 .endlist
35610 .vitem &%$dkim_domain%&
35611 The signing domain. IMPORTANT: This variable is only populated if there is
35612 an actual signature in the message for the current domain or identity (as
35613 reflected by &%$dkim_cur_signer%&).
35614 .vitem &%$dkim_identity%&
35615 The signing identity, if present. IMPORTANT: This variable is only populated
35616 if there is an actual signature in the message for the current domain or
35617 identity (as reflected by &%$dkim_cur_signer%&).
35618 .vitem &%$dkim_selector%&
35619 The key record selector string.
35620 .vitem &%$dkim_algo%&
35621 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
35622 .vitem &%$dkim_canon_body%&
35623 The body canonicalization method. One of 'relaxed' or 'simple'.
35624 .vitem &%dkim_canon_headers%&
35625 The header canonicalization method. One of 'relaxed' or 'simple'.
35626 .vitem &%$dkim_copiedheaders%&
35627 A transcript of headers and their values which are included in the signature
35628 (copied from the 'z=' tag of the signature).
35629 .vitem &%$dkim_bodylength%&
35630 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
35631 limit was set by the signer, "9999999999999" is returned. This makes sure
35632 that this variable always expands to an integer value.
35633 .vitem &%$dkim_created%&
35634 UNIX timestamp reflecting the date and time when the signature was created.
35635 When this was not specified by the signer, "0" is returned.
35636 .vitem &%$dkim_expires%&
35637 UNIX timestamp reflecting the date and time when the signer wants the
35638 signature to be treated as "expired". When this was not specified by the
35639 signer, "9999999999999" is returned. This makes it possible to do useful
35640 integer size comparisons against this value.
35641 .vitem &%$dkim_headernames%&
35642 A colon-separated list of names of headers included in the signature.
35643 .vitem &%$dkim_key_testing%&
35644 "1" if the key record has the "testing" flag set, "0" if not.
35645 .vitem &%$nosubdomains%&
35646 "1" if the key record forbids subdomaining, "0" otherwise.
35647 .vitem &%$dkim_key_srvtype%&
35648 Service type (tag s=) from the key record. Defaults to "*" if not specified
35649 in the key record.
35650 .vitem &%$dkim_key_granularity%&
35651 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
35652 in the key record.
35653 .vitem &%$dkim_key_notes%&
35654 Notes from the key record (tag n=).
35655 .endlist
35656
35657 In addition, two ACL conditions are provided:
35658
35659 .vlist
35660 .vitem &%dkim_signers%&
35661 ACL condition that checks a colon-separated list of domains or identities
35662 for a match against the domain or identity that the ACL is currently verifying
35663 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
35664 verb to a group of domains or identities. For example:
35665
35666 .code
35667 # Warn when Mail purportedly from GMail has no signature at all
35668 warn log_message = GMail sender without DKIM signature
35669      sender_domains = gmail.com
35670      dkim_signers = gmail.com
35671      dkim_status = none
35672 .endd
35673
35674 .vitem &%dkim_status%&
35675 ACL condition that checks a colon-separated list of possible DKIM verification
35676 results agains the actual result of verification. This is typically used
35677 to restrict an ACL verb to a list of verification outcomes, for example:
35678
35679 .code
35680 deny message = Mail from Paypal with invalid/missing signature
35681      sender_domains = paypal.com:paypal.de
35682      dkim_signers = paypal.com:paypal.de
35683      dkim_status = none:invalid:fail
35684 .endd
35685
35686 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
35687 see the documentation of the &%$dkim_verify_status%& expansion variable above
35688 for more information of what they mean.
35689 .endlist
35690
35691 . ////////////////////////////////////////////////////////////////////////////
35692 . ////////////////////////////////////////////////////////////////////////////
35693
35694 .chapter "Adding new drivers or lookup types" "CHID13" &&&
35695          "Adding drivers or lookups"
35696 .cindex "adding drivers"
35697 .cindex "new drivers, adding"
35698 .cindex "drivers" "adding new"
35699 The following actions have to be taken in order to add a new router, transport,
35700 authenticator, or lookup type to Exim:
35701
35702 .olist
35703 Choose a name for the driver or lookup type that does not conflict with any
35704 existing name; I will use &"newdriver"& in what follows.
35705 .next
35706 Add to &_src/EDITME_& the line:
35707 .display
35708 <&'type'&>&`_NEWDRIVER=yes`&
35709 .endd
35710 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
35711 code is not to be included in the binary by default, comment this line out. You
35712 should also add any relevant comments about the driver or lookup type.
35713 .next
35714 Add to &_src/config.h.defaults_& the line:
35715 .code
35716 #define <type>_NEWDRIVER
35717 .endd
35718 .next
35719 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
35720 and create a table entry as is done for all the other drivers and lookup types.
35721 .next
35722 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
35723 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
35724 driver or lookup type and add it to the definition of OBJ.
35725 .next
35726 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
35727 &_src_&.
35728 .next
35729 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
35730 as for other drivers and lookups.
35731 .endlist
35732
35733 Then all you need to do is write the code! A good way to start is to make a
35734 proforma by copying an existing module of the same type, globally changing all
35735 occurrences of the name, and cutting out most of the code. Note that any
35736 options you create must be listed in alphabetical order, because the tables are
35737 searched using a binary chop procedure.
35738
35739 There is a &_README_& file in each of the sub-directories of &_src_& describing
35740 the interface that is expected.
35741
35742
35743
35744
35745 . ////////////////////////////////////////////////////////////////////////////
35746 . ////////////////////////////////////////////////////////////////////////////
35747
35748 . /////////////////////////////////////////////////////////////////////////////
35749 . These lines are processing instructions for the Simple DocBook Processor that
35750 . Philip Hazel has developed as a less cumbersome way of making PostScript and
35751 . PDFs than using xmlto and fop. They will be ignored by all other XML
35752 . processors.
35753 . /////////////////////////////////////////////////////////////////////////////
35754
35755 .literal xml
35756 <?sdop
35757   format="newpage"
35758   foot_right_recto="&chaptertitle;"
35759   foot_right_verso="&chaptertitle;"
35760 ?>
35761 .literal off
35762
35763 .makeindex "Options index"   "option"
35764 .makeindex "Variables index" "variable"
35765 .makeindex "Concept index"   "concept"
35766
35767
35768 . /////////////////////////////////////////////////////////////////////////////
35769 . /////////////////////////////////////////////////////////////////////////////