0555672ddcd04ddb9874aa85c627d617b1c5faf1
[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 .section "PCRE library" "SECTpcre"
1651 .cindex "PCRE library"
1652 Exim no longer has an embedded PCRE library as the vast majority of
1653 modern systems include PCRE as a system library, although you may need
1654 to install the PCRE or PCRE development package for your operating
1655 system. If your system has a normal PCRE installation the Exim build
1656 process will need no further configuration. If the library or the
1657 headers are in an unusual location you will need to set the PCRE_LIBS
1658 and INCLUDE directives appropriately. If your operating system has no
1659 PCRE support then you will need to obtain and build the current PCRE
1660 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1661
1662 .section "DBM libraries" "SECTdb"
1663 .cindex "DBM libraries" "discussion of"
1664 .cindex "hints database" "DBM files used for"
1665 Even if you do not use any DBM files in your configuration, Exim still needs a
1666 DBM library in order to operate, because it uses indexed files for its hints
1667 databases. Unfortunately, there are a number of DBM libraries in existence, and
1668 different operating systems often have different ones installed.
1669
1670 .cindex "Solaris" "DBM library for"
1671 .cindex "IRIX, DBM library for"
1672 .cindex "BSD, DBM library for"
1673 .cindex "Linux, DBM library for"
1674 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1675 Linux distribution, the DBM configuration should happen automatically, and you
1676 may be able to ignore this section. Otherwise, you may have to learn more than
1677 you would like about DBM libraries from what follows.
1678
1679 .cindex "&'ndbm'& DBM library"
1680 Licensed versions of Unix normally contain a library of DBM functions operating
1681 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1682 versions of Unix seem to vary in what they contain as standard. In particular,
1683 some early versions of Linux have no default DBM library, and different
1684 distributors have chosen to bundle different libraries with their packaged
1685 versions. However, the more recent releases seem to have standardized on the
1686 Berkeley DB library.
1687
1688 Different DBM libraries have different conventions for naming the files they
1689 use. When a program opens a file called &_dbmfile_&, there are several
1690 possibilities:
1691
1692 .olist
1693 A traditional &'ndbm'& implementation, such as that supplied as part of
1694 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1695 .next
1696 .cindex "&'gdbm'& DBM library"
1697 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1698 compatibility interface it makes two different hard links to it with names
1699 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1700 file name is used unmodified.
1701 .next
1702 .cindex "Berkeley DB library"
1703 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1704 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1705 programmer exactly the same as the traditional &'ndbm'& implementation.
1706 .next
1707 If the Berkeley package is used in its native mode, it operates on a single
1708 file called &_dbmfile_&; the programmer's interface is somewhat different to
1709 the traditional &'ndbm'& interface.
1710 .next
1711 To complicate things further, there are several very different versions of the
1712 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1713 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1714 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1715 versions of Berkeley DB can be obtained from
1716 &url(http://www.sleepycat.com/).
1717 .next
1718 .cindex "&'tdb'& DBM library"
1719 Yet another DBM library, called &'tdb'&, is available from
1720 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1721 operates on a single file.
1722 .endlist
1723
1724 .cindex "USE_DB"
1725 .cindex "DBM libraries" "configuration for building"
1726 Exim and its utilities can be compiled to use any of these interfaces. In order
1727 to use any version of the Berkeley DB package in native mode, you must set
1728 USE_DB in an appropriate configuration file (typically
1729 &_Local/Makefile_&). For example:
1730 .code
1731 USE_DB=yes
1732 .endd
1733 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1734 error is diagnosed if you set more than one of these.
1735
1736 At the lowest level, the build-time configuration sets none of these options,
1737 thereby assuming an interface of type (1). However, some operating system
1738 configuration files (for example, those for the BSD operating systems and
1739 Linux) assume type (4) by setting USE_DB as their default, and the
1740 configuration files for Cygwin set USE_GDBM. Anything you set in
1741 &_Local/Makefile_&, however, overrides these system defaults.
1742
1743 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1744 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1745 in one of these lines:
1746 .code
1747 DBMLIB = -ldb
1748 DBMLIB = -ltdb
1749 .endd
1750 Settings like that will work if the DBM library is installed in the standard
1751 place. Sometimes it is not, and the library's header file may also not be in
1752 the default path. You may need to set INCLUDE to specify where the header
1753 file is, and to specify the path to the library more fully in DBMLIB, as in
1754 this example:
1755 .code
1756 INCLUDE=-I/usr/local/include/db-4.1
1757 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1758 .endd
1759 There is further detailed discussion about the various DBM libraries in the
1760 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1761
1762
1763
1764 .section "Pre-building configuration" "SECID25"
1765 .cindex "building Exim" "pre-building configuration"
1766 .cindex "configuration for building Exim"
1767 .cindex "&_Local/Makefile_&"
1768 .cindex "&_src/EDITME_&"
1769 Before building Exim, a local configuration file that specifies options
1770 independent of any operating system has to be created with the name
1771 &_Local/Makefile_&. A template for this file is supplied as the file
1772 &_src/EDITME_&, and it contains full descriptions of all the option settings
1773 therein. These descriptions are therefore not repeated here. If you are
1774 building Exim for the first time, the simplest thing to do is to copy
1775 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1776
1777 There are three settings that you must supply, because Exim will not build
1778 without them. They are the location of the run time configuration file
1779 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1780 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1781 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1782 a colon-separated list of file names; Exim uses the first of them that exists.
1783
1784 There are a few other parameters that can be specified either at build time or
1785 at run time, to enable the same binary to be used on a number of different
1786 machines. However, if the locations of Exim's spool directory and log file
1787 directory (if not within the spool directory) are fixed, it is recommended that
1788 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1789 detected early in Exim's execution (such as a malformed configuration file) can
1790 be logged.
1791
1792 .cindex "content scanning" "specifying at build time"
1793 Exim's interfaces for calling virus and spam scanning software directly from
1794 access control lists are not compiled by default. If you want to include these
1795 facilities, you need to set
1796 .code
1797 WITH_CONTENT_SCAN=yes
1798 .endd
1799 in your &_Local/Makefile_&. For details of the facilities themselves, see
1800 chapter &<<CHAPexiscan>>&.
1801
1802
1803 .cindex "&_Local/eximon.conf_&"
1804 .cindex "&_exim_monitor/EDITME_&"
1805 If you are going to build the Exim monitor, a similar configuration process is
1806 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1807 your installation and saved under the name &_Local/eximon.conf_&. If you are
1808 happy with the default settings described in &_exim_monitor/EDITME_&,
1809 &_Local/eximon.conf_& can be empty, but it must exist.
1810
1811 This is all the configuration that is needed in straightforward cases for known
1812 operating systems. However, the building process is set up so that it is easy
1813 to override options that are set by default or by operating-system-specific
1814 configuration files, for example to change the name of the C compiler, which
1815 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1816 do this.
1817
1818
1819
1820 .section "Support for iconv()" "SECID26"
1821 .cindex "&[iconv()]& support"
1822 .cindex "RFC 2047"
1823 The contents of header lines in messages may be encoded according to the rules
1824 described RFC 2047. This makes it possible to transmit characters that are not
1825 in the ASCII character set, and to label them as being in a particular
1826 character set. When Exim is inspecting header lines by means of the &%$h_%&
1827 mechanism, it decodes them, and translates them into a specified character set
1828 (default ISO-8859-1). The translation is possible only if the operating system
1829 supports the &[iconv()]& function.
1830
1831 However, some of the operating systems that supply &[iconv()]& do not support
1832 very many conversions. The GNU &%libiconv%& library (available from
1833 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1834 systems to remedy this deficiency, as well as on systems that do not supply
1835 &[iconv()]& at all. After installing &%libiconv%&, you should add
1836 .code
1837 HAVE_ICONV=yes
1838 .endd
1839 to your &_Local/Makefile_& and rebuild Exim.
1840
1841
1842
1843 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1844 .cindex "TLS" "including support for TLS"
1845 .cindex "encryption" "including support for"
1846 .cindex "SUPPORT_TLS"
1847 .cindex "OpenSSL" "building Exim with"
1848 .cindex "GnuTLS" "building Exim with"
1849 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1850 command as per RFC 2487. It can also support legacy clients that expect to
1851 start a TLS session immediately on connection to a non-standard port (see the
1852 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1853 line option).
1854
1855 If you want to build Exim with TLS support, you must first install either the
1856 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1857 implementing SSL.
1858
1859 If OpenSSL is installed, you should set
1860 .code
1861 SUPPORT_TLS=yes
1862 TLS_LIBS=-lssl -lcrypto
1863 .endd
1864 in &_Local/Makefile_&. You may also need to specify the locations of the
1865 OpenSSL library and include files. For example:
1866 .code
1867 SUPPORT_TLS=yes
1868 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1869 TLS_INCLUDE=-I/usr/local/openssl/include/
1870 .endd
1871 .new
1872 .cindex "pkg-config" "OpenSSL"
1873 If you have &'pkg-config'& available, then instead you can just use:
1874 .code
1875 SUPPORT_TLS=yes
1876 USE_OPENSSL_PC=openssl
1877 .endd
1878 .wen
1879 .cindex "USE_GNUTLS"
1880 If GnuTLS is installed, you should set
1881 .code
1882 SUPPORT_TLS=yes
1883 USE_GNUTLS=yes
1884 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1885 .endd
1886 in &_Local/Makefile_&, and again you may need to specify the locations of the
1887 library and include files. For example:
1888 .code
1889 SUPPORT_TLS=yes
1890 USE_GNUTLS=yes
1891 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1892 TLS_INCLUDE=-I/usr/gnu/include
1893 .endd
1894 .new
1895 .cindex "pkg-config" "GnuTLS"
1896 If you have &'pkg-config'& available, then instead you can just use:
1897 .code
1898 SUPPORT_TLS=yes
1899 USE_GNUTLS=yes
1900 USE_GNUTLS_PC=gnutls
1901 .endd
1902 .wen
1903
1904 You do not need to set TLS_INCLUDE if the relevant directory is already
1905 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1906 given in chapter &<<CHAPTLS>>&.
1907
1908
1909
1910
1911 .section "Use of tcpwrappers" "SECID27"
1912
1913 .cindex "tcpwrappers, building Exim to support"
1914 .cindex "USE_TCP_WRAPPERS"
1915 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1916 .cindex "tcp_wrappers_daemon_name"
1917 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1918 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1919 alternative to Exim's own checking facilities for installations that are
1920 already making use of &'tcpwrappers'& for other purposes. To do this, you
1921 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1922 &_tcpd.h_& to be available at compile time, and also ensure that the library
1923 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1924 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1925 you might have
1926 .code
1927 USE_TCP_WRAPPERS=yes
1928 CFLAGS=-O -I/usr/local/include
1929 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1930 .endd
1931 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1932 files is &"exim"&. For example, the line
1933 .code
1934 exim : LOCAL  192.168.1.  .friendly.domain.example
1935 .endd
1936 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1937 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1938 All other connections are denied. The daemon name used by &'tcpwrappers'&
1939 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1940 in &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1941 configure file. Consult the &'tcpwrappers'& documentation for
1942 further details.
1943
1944
1945 .section "Including support for IPv6" "SECID28"
1946 .cindex "IPv6" "including support for"
1947 Exim contains code for use on systems that have IPv6 support. Setting
1948 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1949 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1950 where the IPv6 support is not fully integrated into the normal include and
1951 library files.
1952
1953 Two different types of DNS record for handling IPv6 addresses have been
1954 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1955 currently seen as the mainstream. Another record type called A6 was proposed
1956 as better than AAAA because it had more flexibility. However, it was felt to be
1957 over-complex, and its status was reduced to &"experimental"&. It is not known
1958 if anyone is actually using A6 records. Exim has support for A6 records, but
1959 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1960 support has not been tested for some time.
1961
1962
1963
1964 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1965 .cindex "lookup modules"
1966 .cindex "dynamic modules"
1967 .cindex ".so building"
1968 On some platforms, Exim supports not compiling all lookup types directly into
1969 the main binary, instead putting some into external modules which can be loaded
1970 on demand.
1971 This permits packagers to build Exim with support for lookups with extensive
1972 library dependencies without requiring all users to install all of those
1973 dependencies.
1974 Most, but not all, lookup types can be built this way.
1975
1976 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1977 installed; Exim will only load modules from that directory, as a security
1978 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1979 for your OS; see &_OS/Makefile-Linux_& for an example.
1980 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1981 see &_src/EDITME_& for details.
1982
1983 Then, for each module to be loaded dynamically, define the relevant
1984 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1985 For example, this will build in lsearch but load sqlite and mysql support
1986 on demand:
1987 .code
1988 LOOKUP_LSEARCH=yes
1989 LOOKUP_SQLITE=2
1990 LOOKUP_MYSQL=2
1991 .endd
1992
1993
1994 .section "The building process" "SECID29"
1995 .cindex "build directory"
1996 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1997 created, run &'make'& at the top level. It determines the architecture and
1998 operating system types, and creates a build directory if one does not exist.
1999 For example, on a Sun system running Solaris 8, the directory
2000 &_build-SunOS5-5.8-sparc_& is created.
2001 .cindex "symbolic link" "to source files"
2002 Symbolic links to relevant source files are installed in the build directory.
2003
2004 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2005 building process fails if it is set.
2006
2007 If this is the first time &'make'& has been run, it calls a script that builds
2008 a make file inside the build directory, using the configuration files from the
2009 &_Local_& directory. The new make file is then passed to another instance of
2010 &'make'&. This does the real work, building a number of utility scripts, and
2011 then compiling and linking the binaries for the Exim monitor (if configured), a
2012 number of utility programs, and finally Exim itself. The command &`make
2013 makefile`& can be used to force a rebuild of the make file in the build
2014 directory, should this ever be necessary.
2015
2016 If you have problems building Exim, check for any comments there may be in the
2017 &_README_& file concerning your operating system, and also take a look at the
2018 FAQ, where some common problems are covered.
2019
2020
2021
2022 .section 'Output from &"make"&' "SECID283"
2023 The output produced by the &'make'& process for compile lines is often very
2024 unreadable, because these lines can be very long. For this reason, the normal
2025 output is suppressed by default, and instead output similar to that which
2026 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2027 each module that is being compiled or linked. However, it is still possible to
2028 get the full output, by calling &'make'& like this:
2029 .code
2030 FULLECHO='' make -e
2031 .endd
2032 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2033 command reflection in &'make'&. When you ask for the full output, it is
2034 given in addition to the short output.
2035
2036
2037
2038 .section "Overriding build-time options for Exim" "SECToverride"
2039 .cindex "build-time options, overriding"
2040 The main make file that is created at the beginning of the building process
2041 consists of the concatenation of a number of files which set configuration
2042 values, followed by a fixed set of &'make'& instructions. If a value is set
2043 more than once, the last setting overrides any previous ones. This provides a
2044 convenient way of overriding defaults. The files that are concatenated are, in
2045 order:
2046 .display
2047 &_OS/Makefile-Default_&
2048 &_OS/Makefile-_&<&'ostype'&>
2049 &_Local/Makefile_&
2050 &_Local/Makefile-_&<&'ostype'&>
2051 &_Local/Makefile-_&<&'archtype'&>
2052 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2053 &_OS/Makefile-Base_&
2054 .endd
2055 .cindex "&_Local/Makefile_&"
2056 .cindex "building Exim" "operating system type"
2057 .cindex "building Exim" "architecture type"
2058 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2059 architecture type. &_Local/Makefile_& is required to exist, and the building
2060 process fails if it is absent. The other three &_Local_& files are optional,
2061 and are often not needed.
2062
2063 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2064 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2065 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2066 values are used, thereby providing a means of forcing particular settings.
2067 Otherwise, the scripts try to get values from the &%uname%& command. If this
2068 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2069 of &'ad hoc'& transformations are then applied, to produce the standard names
2070 that Exim expects. You can run these scripts directly from the shell in order
2071 to find out what values are being used on your system.
2072
2073
2074 &_OS/Makefile-Default_& contains comments about the variables that are set
2075 therein. Some (but not all) are mentioned below. If there is something that
2076 needs changing, review the contents of this file and the contents of the make
2077 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2078 default values are.
2079
2080
2081 .cindex "building Exim" "overriding default settings"
2082 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2083 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2084 need to change the original files. Instead, you should make the changes by
2085 putting the new values in an appropriate &_Local_& file. For example,
2086 .cindex "Tru64-Unix build-time settings"
2087 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2088 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2089 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2090 called with the option &%-std1%&, to make it recognize some of the features of
2091 Standard C that Exim uses. (Most other compilers recognize Standard C by
2092 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2093 containing the lines
2094 .code
2095 CC=cc
2096 CFLAGS=-std1
2097 .endd
2098 If you are compiling for just one operating system, it may be easier to put
2099 these lines directly into &_Local/Makefile_&.
2100
2101 Keeping all your local configuration settings separate from the distributed
2102 files makes it easy to transfer them to new versions of Exim simply by copying
2103 the contents of the &_Local_& directory.
2104
2105
2106 .cindex "NIS lookup type" "including support for"
2107 .cindex "NIS+ lookup type" "including support for"
2108 .cindex "LDAP" "including support for"
2109 .cindex "lookup" "inclusion in binary"
2110 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2111 lookup, but not all systems have these components installed, so the default is
2112 not to include the relevant code in the binary. All the different kinds of file
2113 and database lookup that Exim supports are implemented as separate code modules
2114 which are included only if the relevant compile-time options are set. In the
2115 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2116 .code
2117 LOOKUP_LDAP=yes
2118 LOOKUP_NIS=yes
2119 LOOKUP_NISPLUS=yes
2120 .endd
2121 and similar settings apply to the other lookup types. They are all listed in
2122 &_src/EDITME_&. In many cases the relevant include files and interface
2123 libraries need to be installed before compiling Exim.
2124 .cindex "cdb" "including support for"
2125 However, there are some optional lookup types (such as cdb) for which
2126 the code is entirely contained within Exim, and no external include
2127 files or libraries are required. When a lookup type is not included in the
2128 binary, attempts to configure Exim to use it cause run time configuration
2129 errors.
2130
2131 .new
2132 .cindex "pkg-config" "lookups"
2133 .cindex "pkg-config" "authenticators"
2134 Many systems now use a tool called &'pkg-config'& to encapsulate information
2135 about how to compile against a library; Exim has some initial support for
2136 being able to use pkg-config for lookups and authenticators.  For any given
2137 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2138 variable with the &`_PC`& suffix in the name and assign as the value the
2139 name of the package to be queried.  The results of querying via the
2140 &'pkg-config'& command will be added to the appropriate Makefile variables
2141 with &`+=`& directives, so your version of &'make'& will need to support that
2142 syntax.  For instance:
2143 .code
2144 LOOKUP_SQLITE=yes
2145 LOOKUP_SQLITE_PC=sqlite3
2146 AUTH_GSASL=yes
2147 AUTH_GSASL_PC=libgsasl
2148 AUTH_HEIMDAL_GSSAPI=yes
2149 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2150 .endd
2151 .wen
2152
2153 .cindex "Perl" "including support for"
2154 Exim can be linked with an embedded Perl interpreter, allowing Perl
2155 subroutines to be called during string expansion. To enable this facility,
2156 .code
2157 EXIM_PERL=perl.o
2158 .endd
2159 must be defined in &_Local/Makefile_&. Details of this facility are given in
2160 chapter &<<CHAPperl>>&.
2161
2162 .cindex "X11 libraries, location of"
2163 The location of the X11 libraries is something that varies a lot between
2164 operating systems, and there may be different versions of X11 to cope
2165 with. Exim itself makes no use of X11, but if you are compiling the Exim
2166 monitor, the X11 libraries must be available.
2167 The following three variables are set in &_OS/Makefile-Default_&:
2168 .code
2169 X11=/usr/X11R6
2170 XINCLUDE=-I$(X11)/include
2171 XLFLAGS=-L$(X11)/lib
2172 .endd
2173 These are overridden in some of the operating-system configuration files. For
2174 example, in &_OS/Makefile-SunOS5_& there is
2175 .code
2176 X11=/usr/openwin
2177 XINCLUDE=-I$(X11)/include
2178 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2179 .endd
2180 If you need to override the default setting for your operating system, place a
2181 definition of all three of these variables into your
2182 &_Local/Makefile-<ostype>_& file.
2183
2184 .cindex "EXTRALIBS"
2185 If you need to add any extra libraries to the link steps, these can be put in a
2186 variable called EXTRALIBS, which appears in all the link commands, but by
2187 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2188 command for linking the main Exim binary, and not for any associated utilities.
2189
2190 .cindex "DBM libraries" "configuration for building"
2191 There is also DBMLIB, which appears in the link commands for binaries that
2192 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2193 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2194 binary, and which can be used, for example, to include additional X11
2195 libraries.
2196
2197 .cindex "configuration file" "editing"
2198 The make file copes with rebuilding Exim correctly if any of the configuration
2199 files are edited. However, if an optional configuration file is deleted, it is
2200 necessary to touch the associated non-optional file (that is,
2201 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2202
2203
2204 .section "OS-specific header files" "SECID30"
2205 .cindex "&_os.h_&"
2206 .cindex "building Exim" "OS-specific C header files"
2207 The &_OS_& directory contains a number of files with names of the form
2208 &_os.h-<ostype>_&. These are system-specific C header files that should not
2209 normally need to be changed. There is a list of macro settings that are
2210 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2211 are porting Exim to a new operating system.
2212
2213
2214
2215 .section "Overriding build-time options for the monitor" "SECID31"
2216 .cindex "building Eximon"
2217 A similar process is used for overriding things when building the Exim monitor,
2218 where the files that are involved are
2219 .display
2220 &_OS/eximon.conf-Default_&
2221 &_OS/eximon.conf-_&<&'ostype'&>
2222 &_Local/eximon.conf_&
2223 &_Local/eximon.conf-_&<&'ostype'&>
2224 &_Local/eximon.conf-_&<&'archtype'&>
2225 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2226 .endd
2227 .cindex "&_Local/eximon.conf_&"
2228 As with Exim itself, the final three files need not exist, and in this case the
2229 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2230 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2231 variables of the same name, preceded by EXIMON_. For example, setting
2232 EXIMON_LOG_DEPTH in the environment overrides the value of
2233 LOG_DEPTH at run time.
2234 .ecindex IIDbuex
2235
2236
2237 .section "Installing Exim binaries and scripts" "SECID32"
2238 .cindex "installing Exim"
2239 .cindex "BIN_DIRECTORY"
2240 The command &`make install`& runs the &(exim_install)& script with no
2241 arguments. The script copies binaries and utility scripts into the directory
2242 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2243 .cindex "setuid" "installing Exim with"
2244 The install script copies files only if they are newer than the files they are
2245 going to replace. The Exim binary is required to be owned by root and have the
2246 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2247 install`& as root so that it can set up the Exim binary in this way. However, in
2248 some special situations (for example, if a host is doing no local deliveries)
2249 it may be possible to run Exim without making the binary setuid root (see
2250 chapter &<<CHAPsecurity>>& for details).
2251
2252 .cindex "CONFIGURE_FILE"
2253 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2254 in &_Local/Makefile_&. If this names a single file, and the file does not
2255 exist, the default configuration file &_src/configure.default_& is copied there
2256 by the installation script. If a run time configuration file already exists, it
2257 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2258 alternative files, no default is installed.
2259
2260 .cindex "system aliases file"
2261 .cindex "&_/etc/aliases_&"
2262 One change is made to the default configuration file when it is installed: the
2263 default configuration contains a router that references a system aliases file.
2264 The path to this file is set to the value specified by
2265 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2266 If the system aliases file does not exist, the installation script creates it,
2267 and outputs a comment to the user.
2268
2269 The created file contains no aliases, but it does contain comments about the
2270 aliases a site should normally have. Mail aliases have traditionally been
2271 kept in &_/etc/aliases_&. However, some operating systems are now using
2272 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2273 Exim's configuration if necessary.
2274
2275 The default configuration uses the local host's name as the only local domain,
2276 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2277 running as the local user. System aliases and &_.forward_& files in users' home
2278 directories are supported, but no NIS or NIS+ support is configured. Domains
2279 other than the name of the local host are routed using the DNS, with delivery
2280 over SMTP.
2281
2282 It is possible to install Exim for special purposes (such as building a binary
2283 distribution) in a private part of the file system. You can do this by a
2284 command such as
2285 .code
2286 make DESTDIR=/some/directory/ install
2287 .endd
2288 This has the effect of pre-pending the specified directory to all the file
2289 paths, except the name of the system aliases file that appears in the default
2290 configuration. (If a default alias file is created, its name &'is'& modified.)
2291 For backwards compatibility, ROOT is used if DESTDIR is not set,
2292 but this usage is deprecated.
2293
2294 .cindex "installing Exim" "what is not installed"
2295 Running &'make install'& does not copy the Exim 4 conversion script
2296 &'convert4r4'&. You will probably run this only once if you are
2297 upgrading from Exim 3. None of the documentation files in the &_doc_&
2298 directory are copied, except for the info files when you have set
2299 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2300
2301 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2302 to their names. The Exim binary itself, however, is handled differently. It is
2303 installed under a name that includes the version number and the compile number,
2304 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2305 called &_exim_& to point to the binary. If you are updating a previous version
2306 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2307 from the directory (as seen by other processes).
2308
2309 .cindex "installing Exim" "testing the script"
2310 If you want to see what the &'make install'& will do before running it for
2311 real, you can pass the &%-n%& option to the installation script by this
2312 command:
2313 .code
2314 make INSTALL_ARG=-n install
2315 .endd
2316 The contents of the variable INSTALL_ARG are passed to the installation
2317 script. You do not need to be root to run this test. Alternatively, you can run
2318 the installation script directly, but this must be from within the build
2319 directory. For example, from the top-level Exim directory you could use this
2320 command:
2321 .code
2322 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2323 .endd
2324 .cindex "installing Exim" "install script options"
2325 There are two other options that can be supplied to the installation script.
2326
2327 .ilist
2328 &%-no_chown%& bypasses the call to change the owner of the installed binary
2329 to root, and the call to make it a setuid binary.
2330 .next
2331 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2332 installed binary.
2333 .endlist
2334
2335 INSTALL_ARG can be used to pass these options to the script. For example:
2336 .code
2337 make INSTALL_ARG=-no_symlink install
2338 .endd
2339 The installation script can also be given arguments specifying which files are
2340 to be copied. For example, to install just the Exim binary, and nothing else,
2341 without creating the symbolic link, you could use:
2342 .code
2343 make INSTALL_ARG='-no_symlink exim' install
2344 .endd
2345
2346
2347
2348 .section "Installing info documentation" "SECTinsinfdoc"
2349 .cindex "installing Exim" "&'info'& documentation"
2350 Not all systems use the GNU &'info'& system for documentation, and for this
2351 reason, the Texinfo source of Exim's documentation is not included in the main
2352 distribution. Instead it is available separately from the ftp site (see section
2353 &<<SECTavail>>&).
2354
2355 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2356 source of the documentation is found in the source tree, running &`make
2357 install`& automatically builds the info files and installs them.
2358
2359
2360
2361 .section "Setting up the spool directory" "SECID33"
2362 .cindex "spool directory" "creating"
2363 When it starts up, Exim tries to create its spool directory if it does not
2364 exist. The Exim uid and gid are used for the owner and group of the spool
2365 directory. Sub-directories are automatically created in the spool directory as
2366 necessary.
2367
2368
2369
2370
2371 .section "Testing" "SECID34"
2372 .cindex "testing" "installation"
2373 Having installed Exim, you can check that the run time configuration file is
2374 syntactically valid by running the following command, which assumes that the
2375 Exim binary directory is within your PATH environment variable:
2376 .code
2377 exim -bV
2378 .endd
2379 If there are any errors in the configuration file, Exim outputs error messages.
2380 Otherwise it outputs the version number and build date,
2381 the DBM library that is being used, and information about which drivers and
2382 other optional code modules are included in the binary.
2383 Some simple routing tests can be done by using the address testing option. For
2384 example,
2385 .display
2386 &`exim -bt`& <&'local username'&>
2387 .endd
2388 should verify that it recognizes a local mailbox, and
2389 .display
2390 &`exim -bt`& <&'remote address'&>
2391 .endd
2392 a remote one. Then try getting it to deliver mail, both locally and remotely.
2393 This can be done by passing messages directly to Exim, without going through a
2394 user agent. For example:
2395 .code
2396 exim -v postmaster@your.domain.example
2397 From: user@your.domain.example
2398 To: postmaster@your.domain.example
2399 Subject: Testing Exim
2400
2401 This is a test message.
2402 ^D
2403 .endd
2404 The &%-v%& option causes Exim to output some verification of what it is doing.
2405 In this case you should see copies of three log lines, one for the message's
2406 arrival, one for its delivery, and one containing &"Completed"&.
2407
2408 .cindex "delivery" "problems with"
2409 If you encounter problems, look at Exim's log files (&'mainlog'& and
2410 &'paniclog'&) to see if there is any relevant information there. Another source
2411 of information is running Exim with debugging turned on, by specifying the
2412 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2413 with debugging turned on by a command of the form
2414 .display
2415 &`exim -d -M`& <&'exim-message-id'&>
2416 .endd
2417 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2418 produces rather a lot of output, but you can cut this down to specific areas.
2419 For example, if you use &%-d-all+route%& only the debugging information
2420 relevant to routing is included. (See the &%-d%& option in chapter
2421 &<<CHAPcommandline>>& for more details.)
2422
2423 .cindex '&"sticky"& bit'
2424 .cindex "lock files"
2425 One specific problem that has shown up on some sites is the inability to do
2426 local deliveries into a shared mailbox directory, because it does not have the
2427 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2428 writing to a mailbox file, and if it cannot create the lock file, the delivery
2429 is deferred. You can get round this either by setting the &"sticky bit"& on the
2430 directory, or by setting a specific group for local deliveries and allowing
2431 that group to create files in the directory (see the comments above the
2432 &(local_delivery)& transport in the default configuration file). Another
2433 approach is to configure Exim not to use lock files, but just to rely on
2434 &[fcntl()]& locking instead. However, you should do this only if all user
2435 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2436 see chapter &<<CHAPappendfile>>&.
2437
2438 One thing that cannot be tested on a system that is already running an MTA is
2439 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2440 &%-oX%& option can be used to run an Exim daemon that listens on some other
2441 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2442 &'exim_checkaccess'& utility can be used to check out policy controls on
2443 incoming SMTP mail.
2444
2445 Testing a new version on a system that is already running Exim can most easily
2446 be done by building a binary with a different CONFIGURE_FILE setting. From
2447 within the run time configuration, all other file and directory names
2448 that Exim uses can be altered, in order to keep it entirely clear of the
2449 production version.
2450
2451
2452 .section "Replacing another MTA with Exim" "SECID35"
2453 .cindex "replacing another MTA"
2454 Building and installing Exim for the first time does not of itself put it in
2455 general use. The name by which the system's MTA is called by mail user agents
2456 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2457 operating system), and it is necessary to make this name point to the &'exim'&
2458 binary in order to get the user agents to pass messages to Exim. This is
2459 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2460 or &_/usr/lib/sendmail_&
2461 .cindex "symbolic link" "to &'exim'& binary"
2462 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2463 privilege and executable status from the old MTA. It is then necessary to stop
2464 and restart the mailer daemon, if one is running.
2465
2466 .cindex "FreeBSD, MTA indirection"
2467 .cindex "&_/etc/mail/mailer.conf_&"
2468 Some operating systems have introduced alternative ways of switching MTAs. For
2469 example, if you are running FreeBSD, you need to edit the file
2470 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2471 described. A typical example of the contents of this file for running Exim is
2472 as follows:
2473 .code
2474 sendmail            /usr/exim/bin/exim
2475 send-mail           /usr/exim/bin/exim
2476 mailq               /usr/exim/bin/exim -bp
2477 newaliases          /usr/bin/true
2478 .endd
2479 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2480 your Exim installation is &"live"&. Check it by sending a message from your
2481 favourite user agent.
2482
2483 You should consider what to tell your users about the change of MTA. Exim may
2484 have different capabilities to what was previously running, and there are
2485 various operational differences such as the text of messages produced by
2486 command line options and in bounce messages. If you allow your users to make
2487 use of Exim's filtering capabilities, you should make the document entitled
2488 &'Exim's interface to mail filtering'& available to them.
2489
2490
2491
2492 .section "Upgrading Exim" "SECID36"
2493 .cindex "upgrading Exim"
2494 If you are already running Exim on your host, building and installing a new
2495 version automatically makes it available to MUAs, or any other programs that
2496 call the MTA directly. However, if you are running an Exim daemon, you do need
2497 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2498 new binary. You do not need to stop processing mail in order to install a new
2499 version of Exim. The install script does not modify an existing runtime
2500 configuration file.
2501
2502
2503
2504
2505 .section "Stopping the Exim daemon on Solaris" "SECID37"
2506 .cindex "Solaris" "stopping Exim on"
2507 The standard command for stopping the mailer daemon on Solaris is
2508 .code
2509 /etc/init.d/sendmail stop
2510 .endd
2511 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2512 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2513 for the text &"sendmail"&; this is not present because the actual program name
2514 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2515 solution is to replace the line that finds the process id with something like
2516 .code
2517 pid=`cat /var/spool/exim/exim-daemon.pid`
2518 .endd
2519 to obtain the daemon's pid directly from the file that Exim saves it in.
2520
2521 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2522 still be received from local processes, and if automatic delivery is configured
2523 (the normal case), deliveries will still occur.
2524
2525
2526
2527
2528 . ////////////////////////////////////////////////////////////////////////////
2529 . ////////////////////////////////////////////////////////////////////////////
2530
2531 .chapter "The Exim command line" "CHAPcommandline"
2532 .scindex IIDclo1 "command line" "options"
2533 .scindex IIDclo2 "options" "command line"
2534 Exim's command line takes the standard Unix form of a sequence of options,
2535 each starting with a hyphen character, followed by a number of arguments. The
2536 options are compatible with the main options of Sendmail, and there are also
2537 some additional options, some of which are compatible with Smail 3. Certain
2538 combinations of options do not make sense, and provoke an error if used.
2539 The form of the arguments depends on which options are set.
2540
2541
2542 .section "Setting options by program name" "SECID38"
2543 .cindex "&'mailq'&"
2544 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2545 were present before any other options.
2546 The &%-bp%& option requests a listing of the contents of the mail queue on the
2547 standard output.
2548 This feature is for compatibility with some systems that contain a command of
2549 that name in one of the standard libraries, symbolically linked to
2550 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2551
2552 .cindex "&'rsmtp'&"
2553 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2554 were present before any other options, for compatibility with Smail. The
2555 &%-bS%& option is used for reading in a number of messages in batched SMTP
2556 format.
2557
2558 .cindex "&'rmail'&"
2559 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2560 &%-oee%& options were present before any other options, for compatibility with
2561 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2562
2563 .cindex "&'runq'&"
2564 .cindex "queue runner"
2565 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2566 were present before any other options, for compatibility with Smail. The &%-q%&
2567 option causes a single queue runner process to be started.
2568
2569 .cindex "&'newaliases'&"
2570 .cindex "alias file" "building"
2571 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2572 If Exim is called under the name &'newaliases'& it behaves as if the option
2573 &%-bi%& were present before any other options, for compatibility with Sendmail.
2574 This option is used for rebuilding Sendmail's alias file. Exim does not have
2575 the concept of a single alias file, but can be configured to run a given
2576 command if called with the &%-bi%& option.
2577
2578
2579 .section "Trusted and admin users" "SECTtrustedadmin"
2580 Some Exim options are available only to &'trusted users'& and others are
2581 available only to &'admin users'&. In the description below, the phrases &"Exim
2582 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2583 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2584 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2585
2586 .ilist
2587 .cindex "trusted users" "definition of"
2588 .cindex "user" "trusted definition of"
2589 The trusted users are root, the Exim user, any user listed in the
2590 &%trusted_users%& configuration option, and any user whose current group or any
2591 supplementary group is one of those listed in the &%trusted_groups%&
2592 configuration option. Note that the Exim group is not automatically trusted.
2593
2594 .cindex '&"From"& line'
2595 .cindex "envelope sender"
2596 Trusted users are always permitted to use the &%-f%& option or a leading
2597 &"From&~"& line to specify the envelope sender of a message that is passed to
2598 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2599 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2600 users to set envelope senders.
2601
2602 .cindex "&'From:'& header line"
2603 .cindex "&'Sender:'& header line"
2604 For a trusted user, there is never any check on the contents of the &'From:'&
2605 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2606 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2607
2608 Trusted users may also specify a host name, host address, interface address,
2609 protocol name, ident value, and authentication data when submitting a message
2610 locally. Thus, they are able to insert messages into Exim's queue locally that
2611 have the characteristics of messages received from a remote host. Untrusted
2612 users may in some circumstances use &%-f%&, but can never set the other values
2613 that are available to trusted users.
2614 .next
2615 .cindex "user" "admin definition of"
2616 .cindex "admin user" "definition of"
2617 The admin users are root, the Exim user, and any user that is a member of the
2618 Exim group or of any group listed in the &%admin_groups%& configuration option.
2619 The current group does not have to be one of these groups.
2620
2621 Admin users are permitted to list the queue, and to carry out certain
2622 operations on messages, for example, to force delivery failures. It is also
2623 necessary to be an admin user in order to see the full information provided by
2624 the Exim monitor, and full debugging output.
2625
2626 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2627 Exim to attempt delivery of messages on its queue is restricted to admin users.
2628 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2629 option false (that is, specifying &%no_prod_requires_admin%&).
2630
2631 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2632 is restricted to admin users unless &%queue_list_requires_admin%& is set
2633 false.
2634 .endlist
2635
2636
2637 &*Warning*&: If you configure your system so that admin users are able to
2638 edit Exim's configuration file, you are giving those users an easy way of
2639 getting root. There is further discussion of this issue at the start of chapter
2640 &<<CHAPconf>>&.
2641
2642
2643
2644
2645 .section "Command line options" "SECID39"
2646 Exim's command line options are described in alphabetical order below. If none
2647 of the options that specifies a specific action (such as starting the daemon or
2648 a queue runner, or testing an address, or receiving a message in a specific
2649 format, or listing the queue) are present, and there is at least one argument
2650 on the command line, &%-bm%& (accept a local message on the standard input,
2651 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2652 outputs a brief message about itself and exits.
2653
2654 . ////////////////////////////////////////////////////////////////////////////
2655 . Insert a stylized XML comment here, to identify the start of the command line
2656 . options. This is for the benefit of the Perl script that automatically
2657 . creates a man page for the options.
2658 . ////////////////////////////////////////////////////////////////////////////
2659
2660 .literal xml
2661 <!-- === Start of command line options === -->
2662 .literal off
2663
2664
2665 .vlist
2666 .vitem &%--%&
2667 .oindex "--"
2668 .cindex "options" "command line; terminating"
2669 This is a pseudo-option whose only purpose is to terminate the options and
2670 therefore to cause subsequent command line items to be treated as arguments
2671 rather than options, even if they begin with hyphens.
2672
2673 .vitem &%--help%&
2674 .oindex "&%--help%&"
2675 This option causes Exim to output a few sentences stating what it is.
2676 The same output is generated if the Exim binary is called with no options and
2677 no arguments.
2678
2679 .vitem &%--version%&
2680 .oindex "&%--version%&"
2681 This option is an alias for &%-bV%& and causes version information to be
2682 displayed.
2683
2684 .vitem &%-B%&<&'type'&>
2685 .oindex "&%-B%&"
2686 .cindex "8-bit characters"
2687 .cindex "Sendmail compatibility" "8-bit characters"
2688 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2689 clean; it ignores this option.
2690
2691 .vitem &%-bd%&
2692 .oindex "&%-bd%&"
2693 .cindex "daemon"
2694 .cindex "SMTP" "listener"
2695 .cindex "queue runner"
2696 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2697 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2698 that the daemon should also initiate periodic queue runs.
2699
2700 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2701 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2702 disconnect from the controlling terminal. When running this way, it can be
2703 stopped by pressing ctrl-C.
2704
2705 By default, Exim listens for incoming connections to the standard SMTP port on
2706 all the host's running interfaces. However, it is possible to listen on other
2707 ports, on multiple ports, and only on specific interfaces. Chapter
2708 &<<CHAPinterfaces>>& contains a description of the options that control this.
2709
2710 When a listening daemon
2711 .cindex "daemon" "process id (pid)"
2712 .cindex "pid (process id)" "of daemon"
2713 is started without the use of &%-oX%& (that is, without overriding the normal
2714 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2715 in Exim's spool directory. This location can be overridden by setting
2716 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2717 running as root.
2718
2719 When &%-oX%& is used on the command line to start a listening daemon, the
2720 process id is not written to the normal pid file path. However, &%-oP%& can be
2721 used to specify a path on the command line if a pid file is required.
2722
2723 The SIGHUP signal
2724 .cindex "SIGHUP"
2725 .cindex "daemon" "restarting"
2726 can be used to cause the daemon to re-execute itself. This should be done
2727 whenever Exim's configuration file, or any file that is incorporated into it by
2728 means of the &%.include%& facility, is changed, and also whenever a new version
2729 of Exim is installed. It is not necessary to do this when other files that are
2730 referenced from the configuration (for example, alias files) are changed,
2731 because these are reread each time they are used.
2732
2733 .vitem &%-bdf%&
2734 .oindex "&%-bdf%&"
2735 This option has the same effect as &%-bd%& except that it never disconnects
2736 from the controlling terminal, even when no debugging is specified.
2737
2738 .vitem &%-be%&
2739 .oindex "&%-be%&"
2740 .cindex "testing" "string expansion"
2741 .cindex "expansion" "testing"
2742 Run Exim in expansion testing mode. Exim discards its root privilege, to
2743 prevent ordinary users from using this mode to read otherwise inaccessible
2744 files. If no arguments are given, Exim runs interactively, prompting for lines
2745 of data. Otherwise, it processes each argument in turn.
2746
2747 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2748 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2749 used without command line arguments. If successful, it uses the &[readline()]&
2750 function, which provides extensive line-editing facilities, for reading the
2751 test data. A line history is supported.
2752
2753 Long expansion expressions can be split over several lines by using backslash
2754 continuations. As in Exim's run time configuration, white space at the start of
2755 continuation lines is ignored. Each argument or data line is passed through the
2756 string expansion mechanism, and the result is output. Variable values from the
2757 configuration file (for example, &$qualify_domain$&) are available, but no
2758 message-specific values (such as &$sender_domain$&) are set, because no message
2759 is being processed (but see &%-bem%& and &%-Mset%&).
2760
2761 &*Note*&: If you use this mechanism to test lookups, and you change the data
2762 files or databases you are using, you must exit and restart Exim before trying
2763 the same lookup again. Otherwise, because each Exim process caches the results
2764 of lookups, you will just get the same result as before.
2765
2766 .vitem &%-bem%&&~<&'filename'&>
2767 .oindex "&%-bem%&"
2768 .cindex "testing" "string expansion"
2769 .cindex "expansion" "testing"
2770 This option operates like &%-be%& except that it must be followed by the name
2771 of a file. For example:
2772 .code
2773 exim -bem /tmp/testmessage
2774 .endd
2775 The file is read as a message (as if receiving a locally-submitted non-SMTP
2776 message) before any of the test expansions are done. Thus, message-specific
2777 variables such as &$message_size$& and &$header_from:$& are available. However,
2778 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2779 recipients are read from the headers in the normal way, and are shown in the
2780 &$recipients$& variable. Note that recipients cannot be given on the command
2781 line, because further arguments are taken as strings to expand (just like
2782 &%-be%&).
2783
2784 .vitem &%-bF%&&~<&'filename'&>
2785 .oindex "&%-bF%&"
2786 .cindex "system filter" "testing"
2787 .cindex "testing" "system filter"
2788 This option is the same as &%-bf%& except that it assumes that the filter being
2789 tested is a system filter. The additional commands that are available only in
2790 system filters are recognized.
2791
2792 .vitem &%-bf%&&~<&'filename'&>
2793 .oindex "&%-bf%&"
2794 .cindex "filter" "testing"
2795 .cindex "testing" "filter file"
2796 .cindex "forward file" "testing"
2797 .cindex "testing" "forward file"
2798 .cindex "Sieve filter" "testing"
2799 This option runs Exim in user filter testing mode; the file is the filter file
2800 to be tested, and a test message must be supplied on the standard input. If
2801 there are no message-dependent tests in the filter, an empty file can be
2802 supplied.
2803
2804 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2805 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2806 filter and a user filter in the same run. For example:
2807 .code
2808 exim -bF /system/filter -bf /user/filter </test/message
2809 .endd
2810 This is helpful when the system filter adds header lines or sets filter
2811 variables that are used by the user filter.
2812
2813 If the test filter file does not begin with one of the special lines
2814 .code
2815 # Exim filter
2816 # Sieve filter
2817 .endd
2818 it is taken to be a normal &_.forward_& file, and is tested for validity under
2819 that interpretation. See sections &<<SECTitenonfilred>>& to
2820 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2821 redirection lists.
2822
2823 The result of an Exim command that uses &%-bf%&, provided no errors are
2824 detected, is a list of the actions that Exim would try to take if presented
2825 with the message for real. More details of filter testing are given in the
2826 separate document entitled &'Exim's interfaces to mail filtering'&.
2827
2828 When testing a filter file,
2829 .cindex "&""From""& line"
2830 .cindex "envelope sender"
2831 .oindex "&%-f%&" "for filter testing"
2832 the envelope sender can be set by the &%-f%& option,
2833 or by a &"From&~"& line at the start of the test message. Various parameters
2834 that would normally be taken from the envelope recipient address of the message
2835 can be set by means of additional command line options (see the next four
2836 options).
2837
2838 .vitem &%-bfd%&&~<&'domain'&>
2839 .oindex "&%-bfd%&"
2840 .vindex "&$qualify_domain$&"
2841 This sets the domain of the recipient address when a filter file is being
2842 tested by means of the &%-bf%& option. The default is the value of
2843 &$qualify_domain$&.
2844
2845 .vitem &%-bfl%&&~<&'local&~part'&>
2846 .oindex "&%-bfl%&"
2847 This sets the local part of the recipient address when a filter file is being
2848 tested by means of the &%-bf%& option. The default is the username of the
2849 process that calls Exim. A local part should be specified with any prefix or
2850 suffix stripped, because that is how it appears to the filter when a message is
2851 actually being delivered.
2852
2853 .vitem &%-bfp%&&~<&'prefix'&>
2854 .oindex "&%-bfp%&"
2855 This sets the prefix of the local part of the recipient address when a filter
2856 file is being tested by means of the &%-bf%& option. The default is an empty
2857 prefix.
2858
2859 .vitem &%-bfs%&&~<&'suffix'&>
2860 .oindex "&%-bfs%&"
2861 This sets the suffix of the local part of the recipient address when a filter
2862 file is being tested by means of the &%-bf%& option. The default is an empty
2863 suffix.
2864
2865 .vitem &%-bh%&&~<&'IP&~address'&>
2866 .oindex "&%-bh%&"
2867 .cindex "testing" "incoming SMTP"
2868 .cindex "SMTP" "testing incoming"
2869 .cindex "testing" "relay control"
2870 .cindex "relaying" "testing configuration"
2871 .cindex "policy control" "testing"
2872 .cindex "debugging" "&%-bh%& option"
2873 This option runs a fake SMTP session as if from the given IP address, using the
2874 standard input and output. The IP address may include a port number at the end,
2875 after a full stop. For example:
2876 .code
2877 exim -bh 10.9.8.7.1234
2878 exim -bh fe80::a00:20ff:fe86:a061.5678
2879 .endd
2880 When an IPv6 address is given, it is converted into canonical form. In the case
2881 of the second example above, the value of &$sender_host_address$& after
2882 conversion to the canonical form is
2883 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2884
2885 Comments as to what is going on are written to the standard error file. These
2886 include lines beginning with &"LOG"& for anything that would have been logged.
2887 This facility is provided for testing configuration options for incoming
2888 messages, to make sure they implement the required policy. For example, you can
2889 test your relay controls using &%-bh%&.
2890
2891 &*Warning 1*&:
2892 .cindex "RFC 1413"
2893 You can test features of the configuration that rely on ident (RFC 1413)
2894 information by using the &%-oMt%& option. However, Exim cannot actually perform
2895 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2896 connection.
2897
2898 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2899 are also skipped when testing using &%-bh%&. If you want these callouts to
2900 occur, use &%-bhc%& instead.
2901
2902 Messages supplied during the testing session are discarded, and nothing is
2903 written to any of the real log files. There may be pauses when DNS (and other)
2904 lookups are taking place, and of course these may time out. The &%-oMi%& option
2905 can be used to specify a specific IP interface and port if this is important,
2906 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2907 session were authenticated.
2908
2909 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2910 output just states whether a given recipient address from a given host is
2911 acceptable or not. See section &<<SECTcheckaccess>>&.
2912
2913 Features such as authentication and encryption, where the client input is not
2914 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2915 specialized SMTP test program such as
2916 &url(http://jetmore.org/john/code/#swaks,swaks).
2917
2918 .vitem &%-bhc%&&~<&'IP&~address'&>
2919 .oindex "&%-bhc%&"
2920 This option operates in the same way as &%-bh%&, except that address
2921 verification callouts are performed if required. This includes consulting and
2922 updating the callout cache database.
2923
2924 .vitem &%-bi%&
2925 .oindex "&%-bi%&"
2926 .cindex "alias file" "building"
2927 .cindex "building alias file"
2928 .cindex "Sendmail compatibility" "&%-bi%& option"
2929 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2930 Exim does not have the concept of a single alias file, and so it cannot mimic
2931 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2932 tend to appear in various scripts such as NIS make files, so the option must be
2933 recognized.
2934
2935 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2936 configuration option is run, under the uid and gid of the caller of Exim. If
2937 the &%-oA%& option is used, its value is passed to the command as an argument.
2938 The command set by &%bi_command%& may not contain arguments. The command can
2939 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2940 if this is required. If the &%bi_command%& option is not set, calling Exim with
2941 &%-bi%& is a no-op.
2942
2943 .vitem &%-bm%&
2944 .oindex "&%-bm%&"
2945 .cindex "local message reception"
2946 This option runs an Exim receiving process that accepts an incoming,
2947 locally-generated message on the current input. The recipients are given as the
2948 command arguments (except when &%-t%& is also present &-- see below). Each
2949 argument can be a comma-separated list of RFC 2822 addresses. This is the
2950 default option for selecting the overall action of an Exim call; it is assumed
2951 if no other conflicting option is present.
2952
2953 If any addresses in the message are unqualified (have no domain), they are
2954 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2955 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2956 suppressing this for special cases.
2957
2958 Policy checks on the contents of local messages can be enforced by means of
2959 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2960
2961 .cindex "return code" "for &%-bm%&"
2962 The return code is zero if the message is successfully accepted. Otherwise, the
2963 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2964
2965 The format
2966 .cindex "message" "format"
2967 .cindex "format" "message"
2968 .cindex "&""From""& line"
2969 .cindex "UUCP" "&""From""& line"
2970 .cindex "Sendmail compatibility" "&""From""& line"
2971 of the message must be as defined in RFC 2822, except that, for
2972 compatibility with Sendmail and Smail, a line in one of the forms
2973 .code
2974 From sender Fri Jan  5 12:55 GMT 1997
2975 From sender Fri, 5 Jan 97 12:55:01
2976 .endd
2977 (with the weekday optional, and possibly with additional text after the date)
2978 is permitted to appear at the start of the message. There appears to be no
2979 authoritative specification of the format of this line. Exim recognizes it by
2980 matching against the regular expression defined by the &%uucp_from_pattern%&
2981 option, which can be changed if necessary.
2982
2983 .oindex "&%-f%&" "overriding &""From""& line"
2984 The specified sender is treated as if it were given as the argument to the
2985 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2986 preference to the address taken from the message. The caller of Exim must be a
2987 trusted user for the sender of a message to be set in this way.
2988
2989 .vitem &%-bnq%&
2990 .oindex "&%-bnq%&"
2991 .cindex "address qualification, suppressing"
2992 By default, Exim automatically qualifies unqualified addresses (those
2993 without domains) that appear in messages that are submitted locally (that
2994 is, not over TCP/IP). This qualification applies both to addresses in
2995 envelopes, and addresses in header lines. Sender addresses are qualified using
2996 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
2997 defaults to the value of &%qualify_domain%&).
2998
2999 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3000 being used to re-submit messages that originally came from remote hosts after
3001 content scanning, you probably do not want to qualify unqualified addresses in
3002 header lines. (Such lines will be present only if you have not enabled a header
3003 syntax check in the appropriate ACL.)
3004
3005 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3006 messages that originate on the local host. When this is used, unqualified
3007 addresses in the envelope provoke errors (causing message rejection) and
3008 unqualified addresses in header lines are left alone.
3009
3010
3011 .vitem &%-bP%&
3012 .oindex "&%-bP%&"
3013 .cindex "configuration options" "extracting"
3014 .cindex "options" "configuration &-- extracting"
3015 If this option is given with no arguments, it causes the values of all Exim's
3016 main configuration options to be written to the standard output. The values
3017 of one or more specific options can be requested by giving their names as
3018 arguments, for example:
3019 .code
3020 exim -bP qualify_domain hold_domains
3021 .endd
3022 .cindex "hiding configuration option values"
3023 .cindex "configuration options" "hiding value of"
3024 .cindex "options" "hiding value of"
3025 However, any option setting that is preceded by the word &"hide"& in the
3026 configuration file is not shown in full, except to an admin user. For other
3027 users, the output is as in this example:
3028 .code
3029 mysql_servers = <value not displayable>
3030 .endd
3031 If &%configure_file%& is given as an argument, the name of the run time
3032 configuration file is output.
3033 If a list of configuration files was supplied, the value that is output here
3034 is the name of the file that was actually used.
3035
3036 .cindex "daemon" "process id (pid)"
3037 .cindex "pid (process id)" "of daemon"
3038 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3039 directories where log files and daemon pid files are written are output,
3040 respectively. If these values are unset, log files are written in a
3041 sub-directory of the spool directory called &%log%&, and the pid file is
3042 written directly into the spool directory.
3043
3044 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3045 .code
3046 exim -bP +local_domains
3047 .endd
3048 it searches for a matching named list of any type (domain, host, address, or
3049 local part) and outputs what it finds.
3050
3051 .cindex "options" "router &-- extracting"
3052 .cindex "options" "transport &-- extracting"
3053 .cindex "options" "authenticator &-- extracting"
3054 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3055 followed by the name of an appropriate driver instance, the option settings for
3056 that driver are output. For example:
3057 .code
3058 exim -bP transport local_delivery
3059 .endd
3060 The generic driver options are output first, followed by the driver's private
3061 options. A list of the names of drivers of a particular type can be obtained by
3062 using one of the words &%router_list%&, &%transport_list%&, or
3063 &%authenticator_list%&, and a complete list of all drivers with their option
3064 settings can be obtained by using &%routers%&, &%transports%&, or
3065 &%authenticators%&.
3066
3067 .cindex "options" "macro &-- extracting"
3068 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3069 are available, similarly to the drivers.  Because macros are sometimes used
3070 for storing passwords, this option is restricted.
3071 The output format is one item per line.
3072
3073 .vitem &%-bp%&
3074 .oindex "&%-bp%&"
3075 .cindex "queue" "listing messages on"
3076 .cindex "listing" "messages on the queue"
3077 This option requests a listing of the contents of the mail queue on the
3078 standard output. If the &%-bp%& option is followed by a list of message ids,
3079 just those messages are listed. By default, this option can be used only by an
3080 admin user. However, the &%queue_list_requires_admin%& option can be set false
3081 to allow any user to see the queue.
3082
3083 Each message on the queue is displayed as in the following example:
3084 .code
3085 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3086           red.king@looking-glass.fict.example
3087           <other addresses>
3088 .endd
3089 .cindex "message" "size in queue listing"
3090 .cindex "size" "of message"
3091 The first line contains the length of time the message has been on the queue
3092 (in this case 25 minutes), the size of the message (2.9K), the unique local
3093 identifier for the message, and the message sender, as contained in the
3094 envelope. For bounce messages, the sender address is empty, and appears as
3095 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3096 the default sender address, the user's login name is shown in parentheses
3097 before the sender address.
3098
3099 .cindex "frozen messages" "in queue listing"
3100 If the message is frozen (attempts to deliver it are suspended) then the text
3101 &"*** frozen ***"& is displayed at the end of this line.
3102
3103 The recipients of the message (taken from the envelope, not the headers) are
3104 displayed on subsequent lines. Those addresses to which the message has already
3105 been delivered are marked with the letter D. If an original address gets
3106 expanded into several addresses via an alias or forward file, the original is
3107 displayed with a D only when deliveries for all of its child addresses are
3108 complete.
3109
3110
3111 .vitem &%-bpa%&
3112 .oindex "&%-bpa%&"
3113 This option operates like &%-bp%&, but in addition it shows delivered addresses
3114 that were generated from the original top level address(es) in each message by
3115 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3116 of just &"D"&.
3117
3118
3119 .vitem &%-bpc%&
3120 .oindex "&%-bpc%&"
3121 .cindex "queue" "count of messages on"
3122 This option counts the number of messages on the queue, and writes the total
3123 to the standard output. It is restricted to admin users, unless
3124 &%queue_list_requires_admin%& is set false.
3125
3126
3127 .vitem &%-bpr%&
3128 .oindex "&%-bpr%&"
3129 This option operates like &%-bp%&, but the output is not sorted into
3130 chronological order of message arrival. This can speed it up when there are
3131 lots of messages on the queue, and is particularly useful if the output is
3132 going to be post-processed in a way that doesn't need the sorting.
3133
3134 .vitem &%-bpra%&
3135 .oindex "&%-bpra%&"
3136 This option is a combination of &%-bpr%& and &%-bpa%&.
3137
3138 .vitem &%-bpru%&
3139 .oindex "&%-bpru%&"
3140 This option is a combination of &%-bpr%& and &%-bpu%&.
3141
3142
3143 .vitem &%-bpu%&
3144 .oindex "&%-bpu%&"
3145 This option operates like &%-bp%& but shows only undelivered top-level
3146 addresses for each message displayed. Addresses generated by aliasing or
3147 forwarding are not shown, unless the message was deferred after processing by a
3148 router with the &%one_time%& option set.
3149
3150
3151 .vitem &%-brt%&
3152 .oindex "&%-brt%&"
3153 .cindex "testing" "retry configuration"
3154 .cindex "retry" "configuration testing"
3155 This option is for testing retry rules, and it must be followed by up to three
3156 arguments. It causes Exim to look for a retry rule that matches the values
3157 and to write it to the standard output. For example:
3158 .code
3159 exim -brt bach.comp.mus.example
3160 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3161 .endd
3162 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3163 argument, which is required, can be a complete address in the form
3164 &'local_part@domain'&, or it can be just a domain name. If the second argument
3165 contains a dot, it is interpreted as an optional second domain name; if no
3166 retry rule is found for the first argument, the second is tried. This ties in
3167 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3168 rule is found that matches the host, one that matches the mail domain is
3169 sought. Finally, an argument that is the name of a specific delivery error, as
3170 used in setting up retry rules, can be given. For example:
3171 .code
3172 exim -brt haydn.comp.mus.example quota_3d
3173 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3174 .endd
3175
3176 .vitem &%-brw%&
3177 .oindex "&%-brw%&"
3178 .cindex "testing" "rewriting"
3179 .cindex "rewriting" "testing"
3180 This option is for testing address rewriting rules, and it must be followed by
3181 a single argument, consisting of either a local part without a domain, or a
3182 complete address with a fully qualified domain. Exim outputs how this address
3183 would be rewritten for each possible place it might appear. See chapter
3184 &<<CHAPrewrite>>& for further details.
3185
3186 .vitem &%-bS%&
3187 .oindex "&%-bS%&"
3188 .cindex "SMTP" "batched incoming"
3189 .cindex "batched SMTP input"
3190 This option is used for batched SMTP input, which is an alternative interface
3191 for non-interactive local message submission. A number of messages can be
3192 submitted in a single run. However, despite its name, this is not really SMTP
3193 input. Exim reads each message's envelope from SMTP commands on the standard
3194 input, but generates no responses. If the caller is trusted, or
3195 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3196 believed; otherwise the sender is always the caller of Exim.
3197
3198 The message itself is read from the standard input, in SMTP format (leading
3199 dots doubled), terminated by a line containing just a single dot. An error is
3200 provoked if the terminating dot is missing. A further message may then follow.
3201
3202 As for other local message submissions, the contents of incoming batch SMTP
3203 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3204 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3205 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3206
3207 Some other SMTP commands are recognized in the input. HELO and EHLO act
3208 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3209 QUIT quits, ignoring the rest of the standard input.
3210
3211 .cindex "return code" "for &%-bS%&"
3212 If any error is encountered, reports are written to the standard output and
3213 error streams, and Exim gives up immediately. The return code is 0 if no error
3214 was detected; it is 1 if one or more messages were accepted before the error
3215 was detected; otherwise it is 2.
3216
3217 More details of input using batched SMTP are given in section
3218 &<<SECTincomingbatchedSMTP>>&.
3219
3220 .vitem &%-bs%&
3221 .oindex "&%-bs%&"
3222 .cindex "SMTP" "local input"
3223 .cindex "local SMTP input"
3224 This option causes Exim to accept one or more messages by reading SMTP commands
3225 on the standard input, and producing SMTP replies on the standard output. SMTP
3226 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3227 Some user agents use this interface as a way of passing locally-generated
3228 messages to the MTA.
3229
3230 In
3231 .cindex "sender" "source of"
3232 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3233 set, the senders of messages are taken from the SMTP MAIL commands.
3234 Otherwise the content of these commands is ignored and the sender is set up as
3235 the calling user. Unqualified addresses are automatically qualified using
3236 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3237 &%-bnq%& option is used.
3238
3239 .cindex "inetd"
3240 The
3241 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3242 using a listening daemon. Exim can distinguish the two cases by checking
3243 whether the standard input is a TCP/IP socket. When Exim is called from
3244 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3245 above concerning senders and qualification do not apply. In this situation,
3246 Exim behaves in exactly the same way as it does when receiving a message via
3247 the listening daemon.
3248
3249 .vitem &%-bmalware%&&~<&'filename'&>
3250 .oindex "&%-bmalware%&"
3251 .cindex "testing", "malware"
3252 .cindex "malware scan test"
3253 This debugging option causes Exim to scan the given file,
3254 using the malware scanning framework.  The option of &%av_scanner%& influences
3255 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3256 the expansion should have defaults which apply to this invocation.  ACLs are
3257 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3258 will never be populated and &%-bmalware%& will fail.
3259
3260 Exim will have changed working directory before resolving the filename, so
3261 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3262 user when it tries to open the file, rather than as the invoking user.
3263 This option requires admin privileges.
3264
3265 The &%-bmalware%& option will not be extended to be more generally useful,
3266 there are better tools for file-scanning.  This option exists to help
3267 administrators verify their Exim and AV scanner configuration.
3268
3269 .vitem &%-bt%&
3270 .oindex "&%-bt%&"
3271 .cindex "testing" "addresses"
3272 .cindex "address" "testing"
3273 This option runs Exim in address testing mode, in which each argument is taken
3274 as a recipient address to be tested for deliverability. The results are
3275 written to the standard output. If a test fails, and the caller is not an admin
3276 user, no details of the failure are output, because these might contain
3277 sensitive information such as usernames and passwords for database lookups.
3278
3279 If no arguments are given, Exim runs in an interactive manner, prompting with a
3280 right angle bracket for addresses to be tested.
3281
3282 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3283 &[readline()]& function, because it is running as &'root'& and there are
3284 security issues.
3285
3286 Each address is handled as if it were the recipient address of a message
3287 (compare the &%-bv%& option). It is passed to the routers and the result is
3288 written to the standard output. However, any router that has
3289 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3290 genuine routing tests if your first router passes everything to a scanner
3291 program.
3292
3293 .cindex "return code" "for &%-bt%&"
3294 The return code is 2 if any address failed outright; it is 1 if no address
3295 failed outright but at least one could not be resolved for some reason. Return
3296 code 0 is given only when all addresses succeed.
3297
3298 .cindex "duplicate addresses"
3299 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3300 addresses after routing is complete, so that only one delivery takes place.
3301 This does not happen when testing with &%-bt%&; the full results of routing are
3302 always shown.
3303
3304 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3305 routers in the configuration makes any tests on the sender address of a
3306 message,
3307 .oindex "&%-f%&" "for address testing"
3308 you can use the &%-f%& option to set an appropriate sender when running
3309 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3310 default qualifying domain. However, if you have set up (for example) routers
3311 whose behaviour depends on the contents of an incoming message, you cannot test
3312 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3313 doing such tests.
3314
3315 .vitem &%-bV%&
3316 .oindex "&%-bV%&"
3317 .cindex "version number of Exim"
3318 This option causes Exim to write the current version number, compilation
3319 number, and compilation date of the &'exim'& binary to the standard output.
3320 It also lists the DBM library that is being used, the optional modules (such as
3321 specific lookup types), the drivers that are included in the binary, and the
3322 name of the run time configuration file that is in use.
3323
3324 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3325 configuration file. However, this is a static check only. It cannot check
3326 values that are to be expanded. For example, although a misspelt ACL verb is
3327 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3328 alone to discover (for example) all the typos in the configuration; some
3329 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3330 dynamic testing facilities.
3331
3332 .vitem &%-bv%&
3333 .oindex "&%-bv%&"
3334 .cindex "verifying address" "using &%-bv%&"
3335 .cindex "address" "verification"
3336 This option runs Exim in address verification mode, in which each argument is
3337 taken as a recipient address to be verified by the routers. (This does
3338 not involve any verification callouts). During normal operation, verification
3339 happens mostly as a consequence processing a &%verify%& condition in an ACL
3340 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3341 including callouts, see the &%-bh%& and &%-bhc%& options.
3342
3343 If verification fails, and the caller is not an admin user, no details of the
3344 failure are output, because these might contain sensitive information such as
3345 usernames and passwords for database lookups.
3346
3347 If no arguments are given, Exim runs in an interactive manner, prompting with a
3348 right angle bracket for addresses to be verified.
3349
3350 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3351 &[readline()]& function, because it is running as &'exim'& and there are
3352 security issues.
3353
3354 Verification differs from address testing (the &%-bt%& option) in that routers
3355 that have &%no_verify%& set are skipped, and if the address is accepted by a
3356 router that has &%fail_verify%& set, verification fails. The address is
3357 verified as a recipient if &%-bv%& is used; to test verification for a sender
3358 address, &%-bvs%& should be used.
3359
3360 If the &%-v%& option is not set, the output consists of a single line for each
3361 address, stating whether it was verified or not, and giving a reason in the
3362 latter case. Without &%-v%&, generating more than one address by redirection
3363 causes verification to end successfully, without considering the generated
3364 addresses. However, if just one address is generated, processing continues,
3365 and the generated address must verify successfully for the overall verification
3366 to succeed.
3367
3368 When &%-v%& is set, more details are given of how the address has been handled,
3369 and in the case of address redirection, all the generated addresses are also
3370 considered. Verification may succeed for some and fail for others.
3371
3372 The
3373 .cindex "return code" "for &%-bv%&"
3374 return code is 2 if any address failed outright; it is 1 if no address
3375 failed outright but at least one could not be resolved for some reason. Return
3376 code 0 is given only when all addresses succeed.
3377
3378 If any of the routers in the configuration makes any tests on the sender
3379 address of a message, you should use the &%-f%& option to set an appropriate
3380 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3381 calling user at the default qualifying domain.
3382
3383 .vitem &%-bvs%&
3384 .oindex "&%-bvs%&"
3385 This option acts like &%-bv%&, but verifies the address as a sender rather
3386 than a recipient address. This affects any rewriting and qualification that
3387 might happen.
3388
3389 .vitem &%-C%&&~<&'filelist'&>
3390 .oindex "&%-C%&"
3391 .cindex "configuration file" "alternate"
3392 .cindex "CONFIGURE_FILE"
3393 .cindex "alternate configuration file"
3394 This option causes Exim to find the run time configuration file from the given
3395 list instead of from the list specified by the CONFIGURE_FILE
3396 compile-time setting. Usually, the list will consist of just a single file
3397 name, but it can be a colon-separated list of names. In this case, the first
3398 file that exists is used. Failure to open an existing file stops Exim from
3399 proceeding any further along the list, and an error is generated.
3400
3401 When this option is used by a caller other than root, and the list is different
3402 from the compiled-in list, Exim gives up its root privilege immediately, and
3403 runs with the real and effective uid and gid set to those of the caller.
3404 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3405 file contains a list of full pathnames, one per line, for configuration files
3406 which are trusted. Root privilege is retained for any configuration file so
3407 listed, as long as the caller is the Exim user (or the user specified in the
3408 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3409 not writeable by inappropriate users or groups.
3410
3411 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3412 configuration using &%-C%& right through message reception and delivery,
3413 even if the caller is root. The reception works, but by that time, Exim is
3414 running as the Exim user, so when it re-executes to regain privilege for the
3415 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3416 test reception and delivery using two separate commands (one to put a message
3417 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3418
3419 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3420 prefix string with which any file named in a &%-C%& command line option
3421 must start. In addition, the file name must not contain the sequence &`/../`&.
3422 However, if the value of the &%-C%& option is identical to the value of
3423 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3424 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3425 unset, any file name can be used with &%-C%&.
3426
3427 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3428 to a directory to which only root has access. This prevents someone who has
3429 broken into the Exim account from running a privileged Exim with an arbitrary
3430 configuration file.
3431
3432 The &%-C%& facility is useful for ensuring that configuration files are
3433 syntactically correct, but cannot be used for test deliveries, unless the
3434 caller is privileged, or unless it is an exotic configuration that does not
3435 require privilege. No check is made on the owner or group of the files
3436 specified by this option.
3437
3438
3439 .vitem &%-D%&<&'macro'&>=<&'value'&>
3440 .oindex "&%-D%&"
3441 .cindex "macro" "setting on command line"
3442 This option can be used to override macro definitions in the configuration file
3443 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3444 unprivileged caller, it causes Exim to give up its root privilege.
3445 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3446 completely disabled, and its use causes an immediate error exit.
3447
3448 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3449 colon-separated list of macros which are considered safe and, if &%-D%& only
3450 supplies macros from this list, and the values are acceptable, then Exim will
3451 not give up root privilege if the caller is root, the Exim run-time user, or
3452 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3453 to be removed in the future.  Acceptable values for the macros satisfy the
3454 regexp: &`^[A-Za-z0-9_/.-]*$`&
3455
3456 The entire option (including equals sign if present) must all be within one
3457 command line item. &%-D%& can be used to set the value of a macro to the empty
3458 string, in which case the equals sign is optional. These two commands are
3459 synonymous:
3460 .code
3461 exim -DABC  ...
3462 exim -DABC= ...
3463 .endd
3464 To include spaces in a macro definition item, quotes must be used. If you use
3465 quotes, spaces are permitted around the macro name and the equals sign. For
3466 example:
3467 .code
3468 exim '-D ABC = something' ...
3469 .endd
3470 &%-D%& may be repeated up to 10 times on a command line.
3471
3472
3473 .vitem &%-d%&<&'debug&~options'&>
3474 .oindex "&%-d%&"
3475 .cindex "debugging" "list of selectors"
3476 .cindex "debugging" "&%-d%& option"
3477 This option causes debugging information to be written to the standard
3478 error stream. It is restricted to admin users because debugging output may show
3479 database queries that contain password information. Also, the details of users'
3480 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3481 writes an error message to the standard error stream and exits with a non-zero
3482 return code.
3483
3484 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3485 standard debugging data is output. This can be reduced, or increased to include
3486 some more rarely needed information, by directly following &%-d%& with a string
3487 made up of names preceded by plus or minus characters. These add or remove sets
3488 of debugging data, respectively. For example, &%-d+filter%& adds filter
3489 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3490 no spaces are allowed in the debug setting. The available debugging categories
3491 are:
3492 .display
3493 &`acl            `& ACL interpretation
3494 &`auth           `& authenticators
3495 &`deliver        `& general delivery logic
3496 &`dns            `& DNS lookups (see also resolver)
3497 &`dnsbl          `& DNS black list (aka RBL) code
3498 &`exec           `& arguments for &[execv()]& calls
3499 &`expand         `& detailed debugging for string expansions
3500 &`filter         `& filter handling
3501 &`hints_lookup   `& hints data lookups
3502 &`host_lookup    `& all types of name-to-IP address handling
3503 &`ident          `& ident lookup
3504 &`interface      `& lists of local interfaces
3505 &`lists          `& matching things in lists
3506 &`load           `& system load checks
3507 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3508                     &<<CHAPlocalscan>>&)
3509 &`lookup         `& general lookup code and all lookups
3510 &`memory         `& memory handling
3511 &`pid            `& add pid to debug output lines
3512 &`process_info   `& setting info for the process log
3513 &`queue_run      `& queue runs
3514 &`receive        `& general message reception logic
3515 &`resolver       `& turn on the DNS resolver's debugging output
3516 &`retry          `& retry handling
3517 &`rewrite        `& address rewriting
3518 &`route          `& address routing
3519 &`timestamp      `& add timestamp to debug output lines
3520 &`tls            `& TLS logic
3521 &`transport      `& transports
3522 &`uid            `& changes of uid/gid and looking up uid/gid
3523 &`verify         `& address verification logic
3524 &`all            `& almost all of the above (see below), and also &%-v%&
3525 .endd
3526 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3527 for &`-all`&. The reason for this is that &`+all`& is something that people
3528 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3529 is included, an awful lot of output that is very rarely of interest is
3530 generated, so it now has to be explicitly requested. However, &`-all`& does
3531 turn everything off.
3532
3533 .cindex "resolver, debugging output"
3534 .cindex "DNS resolver, debugging output"
3535 The &`resolver`& option produces output only if the DNS resolver was compiled
3536 with DEBUG enabled. This is not the case in some operating systems. Also,
3537 unfortunately, debugging output from the DNS resolver is written to stdout
3538 rather than stderr.
3539
3540 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3541 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3542 However, the &`pid`& selector is forced when debugging is turned on for a
3543 daemon, which then passes it on to any re-executed Exims. Exim also
3544 automatically adds the pid to debug lines when several remote deliveries are
3545 run in parallel.
3546
3547 The &`timestamp`& selector causes the current time to be inserted at the start
3548 of all debug output lines. This can be useful when trying to track down delays
3549 in processing.
3550
3551 If the &%debug_print%& option is set in any driver, it produces output whenever
3552 any debugging is selected, or if &%-v%& is used.
3553
3554 .vitem &%-dd%&<&'debug&~options'&>
3555 .oindex "&%-dd%&"
3556 This option behaves exactly like &%-d%& except when used on a command that
3557 starts a daemon process. In that case, debugging is turned off for the
3558 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3559 behaviour of the daemon without creating as much output as full debugging does.
3560
3561 .vitem &%-dropcr%&
3562 .oindex "&%-dropcr%&"
3563 This is an obsolete option that is now a no-op. It used to affect the way Exim
3564 handled CR and LF characters in incoming messages. What happens now is
3565 described in section &<<SECTlineendings>>&.
3566
3567 .vitem &%-E%&
3568 .oindex "&%-E%&"
3569 .cindex "bounce message" "generating"
3570 This option specifies that an incoming message is a locally-generated delivery
3571 failure report. It is used internally by Exim when handling delivery failures
3572 and is not intended for external use. Its only effect is to stop Exim
3573 generating certain messages to the postmaster, as otherwise message cascades
3574 could occur in some situations. As part of the same option, a message id may
3575 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3576 new message contains the id, following &"R="&, as a cross-reference.
3577
3578 .vitem &%-e%&&'x'&
3579 .oindex "&%-e%&&'x'&"
3580 There are a number of Sendmail options starting with &%-oe%& which seem to be
3581 called by various programs without the leading &%o%& in the option. For
3582 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3583 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3584
3585 .vitem &%-F%&&~<&'string'&>
3586 .oindex "&%-F%&"
3587 .cindex "sender" "name"
3588 .cindex "name" "of sender"
3589 This option sets the sender's full name for use when a locally-generated
3590 message is being accepted. In the absence of this option, the user's &'gecos'&
3591 entry from the password data is used. As users are generally permitted to alter
3592 their &'gecos'& entries, no security considerations are involved. White space
3593 between &%-F%& and the <&'string'&> is optional.
3594
3595 .vitem &%-f%&&~<&'address'&>
3596 .oindex "&%-f%&"
3597 .cindex "sender" "address"
3598 .cindex "address" "sender"
3599 .cindex "trusted users"
3600 .cindex "envelope sender"
3601 .cindex "user" "trusted"
3602 This option sets the address of the envelope sender of a locally-generated
3603 message (also known as the return path). The option can normally be used only
3604 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3605 users to use it.
3606
3607 Processes running as root or the Exim user are always trusted. Other
3608 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3609 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3610 of a local message is set to the caller's login name at the default qualify
3611 domain.
3612
3613 There is one exception to the restriction on the use of &%-f%&: an empty sender
3614 can be specified by any user, trusted or not, to create a message that can
3615 never provoke a bounce. An empty sender can be specified either as an empty
3616 string, or as a pair of angle brackets with nothing between them, as in these
3617 examples of shell commands:
3618 .code
3619 exim -f '<>' user@domain
3620 exim -f "" user@domain
3621 .endd
3622 In addition, the use of &%-f%& is not restricted when testing a filter file
3623 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3624 &%-bv%& options.
3625
3626 Allowing untrusted users to change the sender address does not of itself make
3627 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3628 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3629 though this can be overridden by setting &%no_local_from_check%&.
3630
3631 White
3632 .cindex "&""From""& line"
3633 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3634 given as two arguments or one combined argument). The sender of a
3635 locally-generated message can also be set (when permitted) by an initial
3636 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3637 if &%-f%& is also present, it overrides &"From&~"&.
3638
3639 .vitem &%-G%&
3640 .oindex "&%-G%&"
3641 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3642 This is a Sendmail option which is ignored by Exim.
3643
3644 .vitem &%-h%&&~<&'number'&>
3645 .oindex "&%-h%&"
3646 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3647 This option is accepted for compatibility with Sendmail, but has no effect. (In
3648 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3649 headers.)
3650
3651 .vitem &%-i%&
3652 .oindex "&%-i%&"
3653 .cindex "Solaris" "&'mail'& command"
3654 .cindex "dot" "in incoming non-SMTP message"
3655 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3656 line by itself should not terminate an incoming, non-SMTP message. I can find
3657 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3658 command in Solaris 2.4 uses it. See also &%-ti%&.
3659
3660 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3661 .oindex "&%-M%&"
3662 .cindex "forcing delivery"
3663 .cindex "delivery" "forcing attempt"
3664 .cindex "frozen messages" "forcing delivery"
3665 This option requests Exim to run a delivery attempt on each message in turn. If
3666 any of the messages are frozen, they are automatically thawed before the
3667 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3668 and &%hold_domains%& are ignored.
3669
3670 Retry
3671 .cindex "hints database" "overriding retry hints"
3672 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3673 the normal retry time has not yet been reached. This option requires the caller
3674 to be an admin user. However, there is an option called &%prod_requires_admin%&
3675 which can be set false to relax this restriction (and also the same requirement
3676 for the &%-q%&, &%-R%&, and &%-S%& options).
3677
3678 The deliveries happen synchronously, that is, the original Exim process does
3679 not terminate until all the delivery attempts have finished. No output is
3680 produced unless there is a serious error. If you want to see what is happening,
3681 use the &%-v%& option as well, or inspect Exim's main log.
3682
3683 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3684 .oindex "&%-Mar%&"
3685 .cindex "message" "adding recipients"
3686 .cindex "recipient" "adding"
3687 This option requests Exim to add the addresses to the list of recipients of the
3688 message (&"ar"& for &"add recipients"&). The first argument must be a message
3689 id, and the remaining ones must be email addresses. However, if the message is
3690 active (in the middle of a delivery attempt), it is not altered. This option
3691 can be used only by an admin user.
3692
3693 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3694         &~<&'message&~id'&>"
3695 .oindex "&%-MC%&"
3696 .cindex "SMTP" "passed connection"
3697 .cindex "SMTP" "multiple deliveries"
3698 .cindex "multiple SMTP deliveries"
3699 This option is not intended for use by external callers. It is used internally
3700 by Exim to invoke another instance of itself to deliver a waiting message using
3701 an existing SMTP connection, which is passed as the standard input. Details are
3702 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3703 must be root or the Exim user in order to use it.
3704
3705 .vitem &%-MCA%&
3706 .oindex "&%-MCA%&"
3707 This option is not intended for use by external callers. It is used internally
3708 by Exim in conjunction with the &%-MC%& option. It signifies that the
3709 connection to the remote host has been authenticated.
3710
3711 .vitem &%-MCP%&
3712 .oindex "&%-MCP%&"
3713 This option is not intended for use by external callers. It is used internally
3714 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3715 which Exim is connected supports pipelining.
3716
3717 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3718 .oindex "&%-MCQ%&"
3719 This option is not intended for use by external callers. It is used internally
3720 by Exim in conjunction with the &%-MC%& option when the original delivery was
3721 started by a queue runner. It passes on the process id of the queue runner,
3722 together with the file descriptor number of an open pipe. Closure of the pipe
3723 signals the final completion of the sequence of processes that are passing
3724 messages through the same SMTP connection.
3725
3726 .vitem &%-MCS%&
3727 .oindex "&%-MCS%&"
3728 This option is not intended for use by external callers. It is used internally
3729 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3730 SMTP SIZE option should be used on messages delivered down the existing
3731 connection.
3732
3733 .vitem &%-MCT%&
3734 .oindex "&%-MCT%&"
3735 This option is not intended for use by external callers. It is used internally
3736 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3737 host to which Exim is connected supports TLS encryption.
3738
3739 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3740 .oindex "&%-Mc%&"
3741 .cindex "hints database" "not overridden by &%-Mc%&"
3742 .cindex "delivery" "manually started &-- not forced"
3743 This option requests Exim to run a delivery attempt on each message in turn,
3744 but unlike the &%-M%& option, it does check for retry hints, and respects any
3745 that are found. This option is not very useful to external callers. It is
3746 provided mainly for internal use by Exim when it needs to re-invoke itself in
3747 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3748 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3749 respects retry times and other options such as &%hold_domains%& that are
3750 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3751 If you want to run a specific delivery as if in a queue run, you should use
3752 &%-q%& with a message id argument. A distinction between queue run deliveries
3753 and other deliveries is made in one or two places.
3754
3755 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3756 .oindex "&%-Mes%&"
3757 .cindex "message" "changing sender"
3758 .cindex "sender" "changing"
3759 This option requests Exim to change the sender address in the message to the
3760 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3761 &"edit sender"&). There must be exactly two arguments. The first argument must
3762 be a message id, and the second one an email address. However, if the message
3763 is active (in the middle of a delivery attempt), its status is not altered.
3764 This option can be used only by an admin user.
3765
3766 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3767 .oindex "&%-Mf%&"
3768 .cindex "freezing messages"
3769 .cindex "message" "manually freezing"
3770 This option requests Exim to mark each listed message as &"frozen"&. This
3771 prevents any delivery attempts taking place until the message is &"thawed"&,
3772 either manually or as a result of the &%auto_thaw%& configuration option.
3773 However, if any of the messages are active (in the middle of a delivery
3774 attempt), their status is not altered. This option can be used only by an admin
3775 user.
3776
3777 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3778 .oindex "&%-Mg%&"
3779 .cindex "giving up on messages"
3780 .cindex "message" "abandoning delivery attempts"
3781 .cindex "delivery" "abandoning further attempts"
3782 This option requests Exim to give up trying to deliver the listed messages,
3783 including any that are frozen. However, if any of the messages are active,
3784 their status is not altered. For non-bounce messages, a delivery error message
3785 is sent to the sender, containing the text &"cancelled by administrator"&.
3786 Bounce messages are just discarded. This option can be used only by an admin
3787 user.
3788
3789 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3790 .oindex "&%-Mmad%&"
3791 .cindex "delivery" "cancelling all"
3792 This option requests Exim to mark all the recipient addresses in the messages
3793 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3794 message is active (in the middle of a delivery attempt), its status is not
3795 altered. This option can be used only by an admin user.
3796
3797 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3798 .oindex "&%-Mmd%&"
3799 .cindex "delivery" "cancelling by address"
3800 .cindex "recipient" "removing"
3801 .cindex "removing recipients"
3802 This option requests Exim to mark the given addresses as already delivered
3803 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3804 the remaining ones must be email addresses. These are matched to recipient
3805 addresses in the message in a case-sensitive manner. If the message is active
3806 (in the middle of a delivery attempt), its status is not altered. This option
3807 can be used only by an admin user.
3808
3809 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3810 .oindex "&%-Mrm%&"
3811 .cindex "removing messages"
3812 .cindex "abandoning mail"
3813 .cindex "message" "manually discarding"
3814 This option requests Exim to remove the given messages from the queue. No
3815 bounce messages are sent; each message is simply forgotten. However, if any of
3816 the messages are active, their status is not altered. This option can be used
3817 only by an admin user or by the user who originally caused the message to be
3818 placed on the queue.
3819
3820 .vitem &%-Mset%&&~<&'message&~id'&>
3821 .oindex "&%-Mset%&
3822 .cindex "testing" "string expansion"
3823 .cindex "expansion" "testing"
3824 This option is useful only in conjunction with &%-be%& (that is, when testing
3825 string expansions). Exim loads the given message from its spool before doing
3826 the test expansions, thus setting message-specific variables such as
3827 &$message_size$& and the header variables. The &$recipients$& variable is made
3828 available. This feature is provided to make it easier to test expansions that
3829 make use of these variables. However, this option can be used only by an admin
3830 user. See also &%-bem%&.
3831
3832 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3833 .oindex "&%-Mt%&"
3834 .cindex "thawing messages"
3835 .cindex "unfreezing messages"
3836 .cindex "frozen messages" "thawing"
3837 .cindex "message" "thawing frozen"
3838 This option requests Exim to &"thaw"& any of the listed messages that are
3839 &"frozen"&, so that delivery attempts can resume. However, if any of the
3840 messages are active, their status is not altered. This option can be used only
3841 by an admin user.
3842
3843 .vitem &%-Mvb%&&~<&'message&~id'&>
3844 .oindex "&%-Mvb%&"
3845 .cindex "listing" "message body"
3846 .cindex "message" "listing body of"
3847 This option causes the contents of the message body (-D) spool file to be
3848 written to the standard output. This option can be used only by an admin user.
3849
3850 .vitem &%-Mvc%&&~<&'message&~id'&>
3851 .oindex "&%-Mvc%&"
3852 .cindex "message" "listing in RFC 2822 format"
3853 .cindex "listing" "message in RFC 2822 format"
3854 This option causes a copy of the complete message (header lines plus body) to
3855 be written to the standard output in RFC 2822 format. This option can be used
3856 only by an admin user.
3857
3858 .vitem &%-Mvh%&&~<&'message&~id'&>
3859 .oindex "&%-Mvh%&"
3860 .cindex "listing" "message headers"
3861 .cindex "header lines" "listing"
3862 .cindex "message" "listing header lines"
3863 This option causes the contents of the message headers (-H) spool file to be
3864 written to the standard output. This option can be used only by an admin user.
3865
3866 .vitem &%-Mvl%&&~<&'message&~id'&>
3867 .oindex "&%-Mvl%&"
3868 .cindex "listing" "message log"
3869 .cindex "message" "listing message log"
3870 This option causes the contents of the message log spool file to be written to
3871 the standard output. This option can be used only by an admin user.
3872
3873 .vitem &%-m%&
3874 .oindex "&%-m%&"
3875 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3876 treats it that way too.
3877
3878 .vitem &%-N%&
3879 .oindex "&%-N%&"
3880 .cindex "debugging" "&%-N%& option"
3881 .cindex "debugging" "suppressing delivery"
3882 This is a debugging option that inhibits delivery of a message at the transport
3883 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3884 it just doesn't actually transport the message, but instead behaves as if it
3885 had successfully done so. However, it does not make any updates to the retry
3886 database, and the log entries for deliveries are flagged with &"*>"& rather
3887 than &"=>"&.
3888
3889 Because &%-N%& discards any message to which it applies, only root or the Exim
3890 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3891 words, an ordinary user can use it only when supplying an incoming message to
3892 which it will apply. Although transportation never fails when &%-N%& is set, an
3893 address may be deferred because of a configuration problem on a transport, or a
3894 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3895 the message, and applies to any subsequent delivery attempts that may happen
3896 for that message.
3897
3898 .vitem &%-n%&
3899 .oindex "&%-n%&"
3900 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3901 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3902 by Exim.
3903
3904 .vitem &%-O%&&~<&'data'&>
3905 .oindex "&%-O%&"
3906 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3907 Exim.
3908
3909 .vitem &%-oA%&&~<&'file&~name'&>
3910 .oindex "&%-oA%&"
3911 .cindex "Sendmail compatibility" "&%-oA%& option"
3912 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3913 alternative alias file name. Exim handles &%-bi%& differently; see the
3914 description above.
3915
3916 .vitem &%-oB%&&~<&'n'&>
3917 .oindex "&%-oB%&"
3918 .cindex "SMTP" "passed connection"
3919 .cindex "SMTP" "multiple deliveries"
3920 .cindex "multiple SMTP deliveries"
3921 This is a debugging option which limits the maximum number of messages that can
3922 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3923 transport. If <&'n'&> is omitted, the limit is set to 1.
3924
3925 .vitem &%-odb%&
3926 .oindex "&%-odb%&"
3927 .cindex "background delivery"
3928 .cindex "delivery" "in the background"
3929 This option applies to all modes in which Exim accepts incoming messages,
3930 including the listening daemon. It requests &"background"& delivery of such
3931 messages, which means that the accepting process automatically starts a
3932 delivery process for each message received, but does not wait for the delivery
3933 processes to finish.
3934
3935 When all the messages have been received, the reception process exits,
3936 leaving the delivery processes to finish in their own time. The standard output
3937 and error streams are closed at the start of each delivery process.
3938 This is the default action if none of the &%-od%& options are present.
3939
3940 If one of the queueing options in the configuration file
3941 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3942 overrides it if &%queue_only_override%& is set true, which is the default
3943 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3944
3945 .vitem &%-odf%&
3946 .oindex "&%-odf%&"
3947 .cindex "foreground delivery"
3948 .cindex "delivery" "in the foreground"
3949 This option requests &"foreground"& (synchronous) delivery when Exim has
3950 accepted a locally-generated message. (For the daemon it is exactly the same as
3951 &%-odb%&.) A delivery process is automatically started to deliver the message,
3952 and Exim waits for it to complete before proceeding.
3953
3954 The original Exim reception process does not finish until the delivery
3955 process for the final message has ended. The standard error stream is left open
3956 during deliveries.
3957
3958 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3959 false and one of the queueing options in the configuration file is in effect.
3960
3961 If there is a temporary delivery error during foreground delivery, the
3962 message is left on the queue for later delivery, and the original reception
3963 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3964 restricted configuration that never queues messages.
3965
3966
3967 .vitem &%-odi%&
3968 .oindex "&%-odi%&"
3969 This option is synonymous with &%-odf%&. It is provided for compatibility with
3970 Sendmail.
3971
3972 .vitem &%-odq%&
3973 .oindex "&%-odq%&"
3974 .cindex "non-immediate delivery"
3975 .cindex "delivery" "suppressing immediate"
3976 .cindex "queueing incoming messages"
3977 This option applies to all modes in which Exim accepts incoming messages,
3978 including the listening daemon. It specifies that the accepting process should
3979 not automatically start a delivery process for each message received. Messages
3980 are placed on the queue, and remain there until a subsequent queue runner
3981 process encounters them. There are several configuration options (such as
3982 &%queue_only%&) that can be used to queue incoming messages under certain
3983 conditions. This option overrides all of them and also &%-odqs%&. It always
3984 forces queueing.
3985
3986 .vitem &%-odqs%&
3987 .oindex "&%-odqs%&"
3988 .cindex "SMTP" "delaying delivery"
3989 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
3990 However, like &%-odb%& and &%-odi%&, this option has no effect if
3991 &%queue_only_override%& is false and one of the queueing options in the
3992 configuration file is in effect.
3993
3994 When &%-odqs%& does operate, a delivery process is started for each incoming
3995 message, in the background by default, but in the foreground if &%-odi%& is
3996 also present. The recipient addresses are routed, and local deliveries are done
3997 in the normal way. However, if any SMTP deliveries are required, they are not
3998 done at this time, so the message remains on the queue until a subsequent queue
3999 runner process encounters it. Because routing was done, Exim knows which
4000 messages are waiting for which hosts, and so a number of messages for the same
4001 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4002 configuration option has the same effect for specific domains. See also the
4003 &%-qq%& option.
4004
4005 .vitem &%-oee%&
4006 .oindex "&%-oee%&"
4007 .cindex "error" "reporting"
4008 If an error is detected while a non-SMTP message is being received (for
4009 example, a malformed address), the error is reported to the sender in a mail
4010 message.
4011
4012 .cindex "return code" "for &%-oee%&"
4013 Provided
4014 this error message is successfully sent, the Exim receiving process
4015 exits with a return code of zero. If not, the return code is 2 if the problem
4016 is that the original message has no recipients, or 1 any other error. This is
4017 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4018
4019 .vitem &%-oem%&
4020 .oindex "&%-oem%&"
4021 .cindex "error" "reporting"
4022 .cindex "return code" "for &%-oem%&"
4023 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4024 return code, whether or not the error message was successfully sent.
4025 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4026
4027 .vitem &%-oep%&
4028 .oindex "&%-oep%&"
4029 .cindex "error" "reporting"
4030 If an error is detected while a non-SMTP message is being received, the
4031 error is reported by writing a message to the standard error file (stderr).
4032 .cindex "return code" "for &%-oep%&"
4033 The return code is 1 for all errors.
4034
4035 .vitem &%-oeq%&
4036 .oindex "&%-oeq%&"
4037 .cindex "error" "reporting"
4038 This option is supported for compatibility with Sendmail, but has the same
4039 effect as &%-oep%&.
4040
4041 .vitem &%-oew%&
4042 .oindex "&%-oew%&"
4043 .cindex "error" "reporting"
4044 This option is supported for compatibility with Sendmail, but has the same
4045 effect as &%-oem%&.
4046
4047 .vitem &%-oi%&
4048 .oindex "&%-oi%&"
4049 .cindex "dot" "in incoming non-SMTP message"
4050 This option, which has the same effect as &%-i%&, specifies that a dot on a
4051 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4052 single dot does terminate, though Exim does no special processing for other
4053 lines that start with a dot. This option is set by default if Exim is called as
4054 &'rmail'&. See also &%-ti%&.
4055
4056 .vitem &%-oitrue%&
4057 .oindex "&%-oitrue%&"
4058 This option is treated as synonymous with &%-oi%&.
4059
4060 .vitem &%-oMa%&&~<&'host&~address'&>
4061 .oindex "&%-oMa%&"
4062 .cindex "sender" "host address, specifying for local message"
4063 A number of options starting with &%-oM%& can be used to set values associated
4064 with remote hosts on locally-submitted messages (that is, messages not received
4065 over TCP/IP). These options can be used by any caller in conjunction with the
4066 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4067 other circumstances, they are ignored unless the caller is trusted.
4068
4069 The &%-oMa%& option sets the sender host address. This may include a port
4070 number at the end, after a full stop (period). For example:
4071 .code
4072 exim -bs -oMa 10.9.8.7.1234
4073 .endd
4074 An alternative syntax is to enclose the IP address in square brackets,
4075 followed by a colon and the port number:
4076 .code
4077 exim -bs -oMa [10.9.8.7]:1234
4078 .endd
4079 The IP address is placed in the &$sender_host_address$& variable, and the
4080 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4081 are present on the command line, the sender host IP address is taken from
4082 whichever one is last.
4083
4084 .vitem &%-oMaa%&&~<&'name'&>
4085 .oindex "&%-oMaa%&"
4086 .cindex "authentication" "name, specifying for local message"
4087 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4088 option sets the value of &$sender_host_authenticated$& (the authenticator
4089 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4090 This option can be used with &%-bh%& and &%-bs%& to set up an
4091 authenticated SMTP session without actually using the SMTP AUTH command.
4092
4093 .vitem &%-oMai%&&~<&'string'&>
4094 .oindex "&%-oMai%&"
4095 .cindex "authentication" "id, specifying for local message"
4096 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4097 option sets the value of &$authenticated_id$& (the id that was authenticated).
4098 This overrides the default value (the caller's login id, except with &%-bh%&,
4099 where there is no default) for messages from local sources. See chapter
4100 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4101
4102 .vitem &%-oMas%&&~<&'address'&>
4103 .oindex "&%-oMas%&"
4104 .cindex "authentication" "sender, specifying for local message"
4105 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4106 option sets the authenticated sender value in &$authenticated_sender$&. It
4107 overrides the sender address that is created from the caller's login id for
4108 messages from local sources, except when &%-bh%& is used, when there is no
4109 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4110 specified on a MAIL command overrides this value. See chapter
4111 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4112
4113 .vitem &%-oMi%&&~<&'interface&~address'&>
4114 .oindex "&%-oMi%&"
4115 .cindex "interface" "address, specifying for local message"
4116 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4117 option sets the IP interface address value. A port number may be included,
4118 using the same syntax as for &%-oMa%&. The interface address is placed in
4119 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4120
4121 .vitem &%-oMr%&&~<&'protocol&~name'&>
4122 .oindex "&%-oMr%&"
4123 .cindex "protocol, specifying for local message"
4124 .vindex "&$received_protocol$&"
4125 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4126 option sets the received protocol value that is stored in
4127 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4128 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4129 SMTP protocol names (see the description of &$received_protocol$& in section
4130 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4131 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4132 be set by &%-oMr%&.
4133
4134 .vitem &%-oMs%&&~<&'host&~name'&>
4135 .oindex "&%-oMs%&"
4136 .cindex "sender" "host name, specifying for local message"
4137 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4138 option sets the sender host name in &$sender_host_name$&. When this option is
4139 present, Exim does not attempt to look up a host name from an IP address; it
4140 uses the name it is given.
4141
4142 .vitem &%-oMt%&&~<&'ident&~string'&>
4143 .oindex "&%-oMt%&"
4144 .cindex "sender" "ident string, specifying for local message"
4145 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4146 option sets the sender ident value in &$sender_ident$&. The default setting for
4147 local callers is the login id of the calling process, except when &%-bh%& is
4148 used, when there is no default.
4149
4150 .vitem &%-om%&
4151 .oindex "&%-om%&"
4152 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4153 In Sendmail, this option means &"me too"&, indicating that the sender of a
4154 message should receive a copy of the message if the sender appears in an alias
4155 expansion. Exim always does this, so the option does nothing.
4156
4157 .vitem &%-oo%&
4158 .oindex "&%-oo%&"
4159 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4160 This option is ignored. In Sendmail it specifies &"old style headers"&,
4161 whatever that means.
4162
4163 .vitem &%-oP%&&~<&'path'&>
4164 .oindex "&%-oP%&"
4165 .cindex "pid (process id)" "of daemon"
4166 .cindex "daemon" "process id (pid)"
4167 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4168 value. The option specifies the file to which the process id of the daemon is
4169 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4170 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4171 because in those cases, the normal pid file is not used.
4172
4173 .vitem &%-or%&&~<&'time'&>
4174 .oindex "&%-or%&"
4175 .cindex "timeout" "for non-SMTP input"
4176 This option sets a timeout value for incoming non-SMTP messages. If it is not
4177 set, Exim will wait forever for the standard input. The value can also be set
4178 by the &%receive_timeout%& option. The format used for specifying times is
4179 described in section &<<SECTtimeformat>>&.
4180
4181 .vitem &%-os%&&~<&'time'&>
4182 .oindex "&%-os%&"
4183 .cindex "timeout" "for SMTP input"
4184 .cindex "SMTP" "input timeout"
4185 This option sets a timeout value for incoming SMTP messages. The timeout
4186 applies to each SMTP command and block of data. The value can also be set by
4187 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4188 for specifying times is described in section &<<SECTtimeformat>>&.
4189
4190 .vitem &%-ov%&
4191 .oindex "&%-ov%&"
4192 This option has exactly the same effect as &%-v%&.
4193
4194 .vitem &%-oX%&&~<&'number&~or&~string'&>
4195 .oindex "&%-oX%&"
4196 .cindex "TCP/IP" "setting listening ports"
4197 .cindex "TCP/IP" "setting listening interfaces"
4198 .cindex "port" "receiving TCP/IP"
4199 This option is relevant only when the &%-bd%& (start listening daemon) option
4200 is also given. It controls which ports and interfaces the daemon uses. Details
4201 of the syntax, and how it interacts with configuration file options, are given
4202 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4203 file is written unless &%-oP%& is also present to specify a pid file name.
4204
4205 .vitem &%-pd%&
4206 .oindex "&%-pd%&"
4207 .cindex "Perl" "starting the interpreter"
4208 This option applies when an embedded Perl interpreter is linked with Exim (see
4209 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4210 option, forcing the starting of the interpreter to be delayed until it is
4211 needed.
4212
4213 .vitem &%-ps%&
4214 .oindex "&%-ps%&"
4215 .cindex "Perl" "starting the interpreter"
4216 This option applies when an embedded Perl interpreter is linked with Exim (see
4217 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4218 option, forcing the starting of the interpreter to occur as soon as Exim is
4219 started.
4220
4221 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4222 .oindex "&%-p%&"
4223 For compatibility with Sendmail, this option is equivalent to
4224 .display
4225 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4226 .endd
4227 It sets the incoming protocol and host name (for trusted callers). The
4228 host name and its colon can be omitted when only the protocol is to be set.
4229 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4230 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4231 or &`s`& using this option (but that does not seem a real limitation).
4232
4233 .vitem &%-q%&
4234 .oindex "&%-q%&"
4235 .cindex "queue runner" "starting manually"
4236 This option is normally restricted to admin users. However, there is a
4237 configuration option called &%prod_requires_admin%& which can be set false to
4238 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4239 and &%-S%& options).
4240
4241 .cindex "queue runner" "description of operation"
4242 The &%-q%& option starts one queue runner process. This scans the queue of
4243 waiting messages, and runs a delivery process for each one in turn. It waits
4244 for each delivery process to finish before starting the next one. A delivery
4245 process may not actually do any deliveries if the retry times for the addresses
4246 have not been reached. Use &%-qf%& (see below) if you want to override this.
4247
4248 If
4249 .cindex "SMTP" "passed connection"
4250 .cindex "SMTP" "multiple deliveries"
4251 .cindex "multiple SMTP deliveries"
4252 the delivery process spawns other processes to deliver other messages down
4253 passed SMTP connections, the queue runner waits for these to finish before
4254 proceeding.
4255
4256 When all the queued messages have been considered, the original queue runner
4257 process terminates. In other words, a single pass is made over the waiting
4258 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4259 this to be repeated periodically.
4260
4261 Exim processes the waiting messages in an unpredictable order. It isn't very
4262 random, but it is likely to be different each time, which is all that matters.
4263 If one particular message screws up a remote MTA, other messages to the same
4264 MTA have a chance of getting through if they get tried first.
4265
4266 It is possible to cause the messages to be processed in lexical message id
4267 order, which is essentially the order in which they arrived, by setting the
4268 &%queue_run_in_order%& option, but this is not recommended for normal use.
4269
4270 .vitem &%-q%&<&'qflags'&>
4271 The &%-q%& option may be followed by one or more flag letters that change its
4272 behaviour. They are all optional, but if more than one is present, they must
4273 appear in the correct order. Each flag is described in a separate item below.
4274
4275 .vitem &%-qq...%&
4276 .oindex "&%-qq%&"
4277 .cindex "queue" "double scanning"
4278 .cindex "queue" "routing"
4279 .cindex "routing" "whole queue before delivery"
4280 An option starting with &%-qq%& requests a two-stage queue run. In the first
4281 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4282 every domain. Addresses are routed, local deliveries happen, but no remote
4283 transports are run.
4284
4285 .cindex "hints database" "remembering routing"
4286 The hints database that remembers which messages are waiting for specific hosts
4287 is updated, as if delivery to those hosts had been deferred. After this is
4288 complete, a second, normal queue scan happens, with routing and delivery taking
4289 place as normal. Messages that are routed to the same host should mostly be
4290 delivered down a single SMTP
4291 .cindex "SMTP" "passed connection"
4292 .cindex "SMTP" "multiple deliveries"
4293 .cindex "multiple SMTP deliveries"
4294 connection because of the hints that were set up during the first queue scan.
4295 This option may be useful for hosts that are connected to the Internet
4296 intermittently.
4297
4298 .vitem &%-q[q]i...%&
4299 .oindex "&%-qi%&"
4300 .cindex "queue" "initial delivery"
4301 If the &'i'& flag is present, the queue runner runs delivery processes only for
4302 those messages that haven't previously been tried. (&'i'& stands for &"initial
4303 delivery"&.) This can be helpful if you are putting messages on the queue using
4304 &%-odq%& and want a queue runner just to process the new messages.
4305
4306 .vitem &%-q[q][i]f...%&
4307 .oindex "&%-qf%&"
4308 .cindex "queue" "forcing delivery"
4309 .cindex "delivery" "forcing in queue run"
4310 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4311 message, whereas without &'f'& only those non-frozen addresses that have passed
4312 their retry times are tried.
4313
4314 .vitem &%-q[q][i]ff...%&
4315 .oindex "&%-qff%&"
4316 .cindex "frozen messages" "forcing delivery"
4317 If &'ff'& is present, a delivery attempt is forced for every message, whether
4318 frozen or not.
4319
4320 .vitem &%-q[q][i][f[f]]l%&
4321 .oindex "&%-ql%&"
4322 .cindex "queue" "local deliveries only"
4323 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4324 be done. If a message requires any remote deliveries, it remains on the queue
4325 for later delivery.
4326
4327 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4328 .cindex "queue" "delivering specific messages"
4329 When scanning the queue, Exim can be made to skip over messages whose ids are
4330 lexically less than a given value by following the &%-q%& option with a
4331 starting message id. For example:
4332 .code
4333 exim -q 0t5C6f-0000c8-00
4334 .endd
4335 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4336 second message id is given, messages whose ids are lexically greater than it
4337 are also skipped. If the same id is given twice, for example,
4338 .code
4339 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4340 .endd
4341 just one delivery process is started, for that message. This differs from
4342 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4343 that it counts as a delivery from a queue run. Note that the selection
4344 mechanism does not affect the order in which the messages are scanned. There
4345 are also other ways of selecting specific sets of messages for delivery in a
4346 queue run &-- see &%-R%& and &%-S%&.
4347
4348 .vitem &%-q%&<&'qflags'&><&'time'&>
4349 .cindex "queue runner" "starting periodically"
4350 .cindex "periodic queue running"
4351 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4352 starting a queue runner process at intervals specified by the given time value
4353 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4354 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4355 single daemon process handles both functions. A common way of starting up a
4356 combined daemon at system boot time is to use a command such as
4357 .code
4358 /usr/exim/bin/exim -bd -q30m
4359 .endd
4360 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4361 process every 30 minutes.
4362
4363 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4364 pid file is written unless one is explicitly requested by the &%-oP%& option.
4365
4366 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4367 .oindex "&%-qR%&"
4368 This option is synonymous with &%-R%&. It is provided for Sendmail
4369 compatibility.
4370
4371 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4372 .oindex "&%-qS%&"
4373 This option is synonymous with &%-S%&.
4374
4375 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4376 .oindex "&%-R%&"
4377 .cindex "queue runner" "for specific recipients"
4378 .cindex "delivery" "to given domain"
4379 .cindex "domain" "delivery to"
4380 The <&'rsflags'&> may be empty, in which case the white space before the string
4381 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4382 which are the possible values for <&'rsflags'&>. White space is required if
4383 <&'rsflags'&> is not empty.
4384
4385 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4386 perform a single queue run, except that, when scanning the messages on the
4387 queue, Exim processes only those that have at least one undelivered recipient
4388 address containing the given string, which is checked in a case-independent
4389 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4390 regular expression; otherwise it is a literal string.
4391
4392 If you want to do periodic queue runs for messages with specific recipients,
4393 you can combine &%-R%& with &%-q%& and a time value. For example:
4394 .code
4395 exim -q25m -R @special.domain.example
4396 .endd
4397 This example does a queue run for messages with recipients in the given domain
4398 every 25 minutes. Any additional flags that are specified with &%-q%& are
4399 applied to each queue run.
4400
4401 Once a message is selected for delivery by this mechanism, all its addresses
4402 are processed. For the first selected message, Exim overrides any retry
4403 information and forces a delivery attempt for each undelivered address. This
4404 means that if delivery of any address in the first message is successful, any
4405 existing retry information is deleted, and so delivery attempts for that
4406 address in subsequently selected messages (which are processed without forcing)
4407 will run. However, if delivery of any address does not succeed, the retry
4408 information is updated, and in subsequently selected messages, the failing
4409 address will be skipped.
4410
4411 .cindex "frozen messages" "forcing delivery"
4412 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4413 all selected messages, not just the first; frozen messages are included when
4414 &'ff'& is present.
4415
4416 The &%-R%& option makes it straightforward to initiate delivery of all messages
4417 to a given domain after a host has been down for some time. When the SMTP
4418 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4419 effect is to run Exim with the &%-R%& option, but it can be configured to run
4420 an arbitrary command instead.
4421
4422 .vitem &%-r%&
4423 .oindex "&%-r%&"
4424 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4425
4426 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4427 .oindex "&%-S%&"
4428 .cindex "delivery" "from given sender"
4429 .cindex "queue runner" "for specific senders"
4430 This option acts like &%-R%& except that it checks the string against each
4431 message's sender instead of against the recipients. If &%-R%& is also set, both
4432 conditions must be met for a message to be selected. If either of the options
4433 has &'f'& or &'ff'& in its flags, the associated action is taken.
4434
4435 .vitem &%-Tqt%&&~<&'times'&>
4436 .oindex "&%-Tqt%&"
4437 This an option that is exclusively for use by the Exim testing suite. It is not
4438 recognized when Exim is run normally. It allows for the setting up of explicit
4439 &"queue times"& so that various warning/retry features can be tested.
4440
4441 .vitem &%-t%&
4442 .oindex "&%-t%&"
4443 .cindex "recipient" "extracting from header lines"
4444 .cindex "&'Bcc:'& header line"
4445 .cindex "&'Cc:'& header line"
4446 .cindex "&'To:'& header line"
4447 When Exim is receiving a locally-generated, non-SMTP message on its standard
4448 input, the &%-t%& option causes the recipients of the message to be obtained
4449 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4450 from the command arguments. The addresses are extracted before any rewriting
4451 takes place and the &'Bcc:'& header line, if present, is then removed.
4452
4453 .cindex "Sendmail compatibility" "&%-t%& option"
4454 If the command has any arguments, they specify addresses to which the message
4455 is &'not'& to be delivered. That is, the argument addresses are removed from
4456 the recipients list obtained from the headers. This is compatible with Smail 3
4457 and in accordance with the documented behaviour of several versions of
4458 Sendmail, as described in man pages on a number of operating systems (e.g.
4459 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4460 argument addresses to those obtained from the headers, and the O'Reilly
4461 Sendmail book documents it that way. Exim can be made to add argument addresses
4462 instead of subtracting them by setting the option
4463 &%extract_addresses_remove_arguments%& false.
4464
4465 .cindex "&%Resent-%& header lines" "with &%-t%&"
4466 If there are any &%Resent-%& header lines in the message, Exim extracts
4467 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4468 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4469 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4470 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4471
4472 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4473 message is resent several times). The RFC also specifies that they should be
4474 added at the front of the message, and separated by &'Received:'& lines. It is
4475 not at all clear how &%-t%& should operate in the present of multiple sets,
4476 nor indeed exactly what constitutes a &"set"&.
4477 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4478 are often added at the end of the header, and if a message is resent more than
4479 once, it is common for the original set of &%Resent-%& headers to be renamed as
4480 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4481
4482 .vitem &%-ti%&
4483 .oindex "&%-ti%&"
4484 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4485 compatibility with Sendmail.
4486
4487 .vitem &%-tls-on-connect%&
4488 .oindex "&%-tls-on-connect%&"
4489 .cindex "TLS" "use without STARTTLS"
4490 .cindex "TLS" "automatic start"
4491 This option is available when Exim is compiled with TLS support. It forces all
4492 incoming SMTP connections to behave as if the incoming port is listed in the
4493 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4494 &<<CHAPTLS>>& for further details.
4495
4496
4497 .vitem &%-U%&
4498 .oindex "&%-U%&"
4499 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4500 Sendmail uses this option for &"initial message submission"&, and its
4501 documentation states that in future releases, it may complain about
4502 syntactically invalid messages rather than fixing them when this flag is not
4503 set. Exim ignores this option.
4504
4505 .vitem &%-v%&
4506 .oindex "&%-v%&"
4507 This option causes Exim to write information to the standard error stream,
4508 describing what it is doing. In particular, it shows the log lines for
4509 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4510 dialogue is shown. Some of the log lines shown may not actually be written to
4511 the log if the setting of &%log_selector%& discards them. Any relevant
4512 selectors are shown with each log line. If none are shown, the logging is
4513 unconditional.
4514
4515 .vitem &%-x%&
4516 .oindex "&%-x%&"
4517 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4518 National Language Support extended characters in the body of the mail item"&).
4519 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4520 this option.
4521 .endlist
4522
4523 .ecindex IIDclo1
4524 .ecindex IIDclo2
4525
4526
4527 . ////////////////////////////////////////////////////////////////////////////
4528 . Insert a stylized DocBook comment here, to identify the end of the command
4529 . line options. This is for the benefit of the Perl script that automatically
4530 . creates a man page for the options.
4531 . ////////////////////////////////////////////////////////////////////////////
4532
4533 .literal xml
4534 <!-- === End of command line options === -->
4535 .literal off
4536
4537
4538
4539
4540
4541 . ////////////////////////////////////////////////////////////////////////////
4542 . ////////////////////////////////////////////////////////////////////////////
4543
4544
4545 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4546          "The runtime configuration file"
4547
4548 .cindex "run time configuration"
4549 .cindex "configuration file" "general description"
4550 .cindex "CONFIGURE_FILE"
4551 .cindex "configuration file" "errors in"
4552 .cindex "error" "in configuration file"
4553 .cindex "return code" "for bad configuration"
4554 Exim uses a single run time configuration file that is read whenever an Exim
4555 binary is executed. Note that in normal operation, this happens frequently,
4556 because Exim is designed to operate in a distributed manner, without central
4557 control.
4558
4559 If a syntax error is detected while reading the configuration file, Exim
4560 writes a message on the standard error, and exits with a non-zero return code.
4561 The message is also written to the panic log. &*Note*&: Only simple syntax
4562 errors can be detected at this time. The values of any expanded options are
4563 not checked until the expansion happens, even when the expansion does not
4564 actually alter the string.
4565
4566 The name of the configuration file is compiled into the binary for security
4567 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4568 most configurations, this specifies a single file. However, it is permitted to
4569 give a colon-separated list of file names, in which case Exim uses the first
4570 existing file in the list.
4571
4572 .cindex "EXIM_USER"
4573 .cindex "EXIM_GROUP"
4574 .cindex "CONFIGURE_OWNER"
4575 .cindex "CONFIGURE_GROUP"
4576 .cindex "configuration file" "ownership"
4577 .cindex "ownership" "configuration file"
4578 The run time configuration file must be owned by root or by the user that is
4579 specified at compile time by the CONFIGURE_OWNER option (if set). The
4580 configuration file must not be world-writeable, or group-writeable unless its
4581 group is the root group or the one specified at compile time by the
4582 CONFIGURE_GROUP option.
4583
4584 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4585 to root, anybody who is able to edit the run time configuration file has an
4586 easy way to run commands as root. If you specify a user or group in the
4587 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4588 who are members of that group will trivially be able to obtain root privileges.
4589
4590 Up to Exim version 4.72, the run time configuration file was also permitted to
4591 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4592 since it offered a simple privilege escalation for any attacker who managed to
4593 compromise the Exim user account.
4594
4595 A default configuration file, which will work correctly in simple situations,
4596 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4597 defines just one file name, the installation process copies the default
4598 configuration to a new file of that name if it did not previously exist. If
4599 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4600 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4601 configuration.
4602
4603
4604
4605 .section "Using a different configuration file" "SECID40"
4606 .cindex "configuration file" "alternate"
4607 A one-off alternate configuration can be specified by the &%-C%& command line
4608 option, which may specify a single file or a list of files. However, when
4609 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4610 unless the argument for &%-C%& is identical to the built-in value from
4611 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4612 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4613 is useful mainly for checking the syntax of configuration files before
4614 installing them. No owner or group checks are done on a configuration file
4615 specified by &%-C%&, if root privilege has been dropped.
4616
4617 Even the Exim user is not trusted to specify an arbitrary configuration file
4618 with the &%-C%& option to be used with root privileges, unless that file is
4619 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4620 testing a configuration using &%-C%& right through message reception and
4621 delivery, even if the caller is root. The reception works, but by that time,
4622 Exim is running as the Exim user, so when it re-execs to regain privilege for
4623 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4624 can test reception and delivery using two separate commands (one to put a
4625 message on the queue, using &%-odq%&, and another to do the delivery, using
4626 &%-M%&).
4627
4628 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4629 prefix string with which any file named in a &%-C%& command line option must
4630 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4631 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4632 name can be used with &%-C%&.
4633
4634 One-off changes to a configuration can be specified by the &%-D%& command line
4635 option, which defines and overrides values for macros used inside the
4636 configuration file. However, like &%-C%&, the use of this option by a
4637 non-privileged user causes Exim to discard its root privilege.
4638 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4639 completely disabled, and its use causes an immediate error exit.
4640
4641 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4642 to declare certain macro names trusted, such that root privilege will not
4643 necessarily be discarded.
4644 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4645 considered safe and, if &%-D%& only supplies macros from this list, and the
4646 values are acceptable, then Exim will not give up root privilege if the caller
4647 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4648 transition mechanism and is expected to be removed in the future.  Acceptable
4649 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4650
4651 Some sites may wish to use the same Exim binary on different machines that
4652 share a file system, but to use different configuration files on each machine.
4653 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4654 looks for a file whose name is the configuration file name followed by a dot
4655 and the machine's node name, as obtained from the &[uname()]& function. If this
4656 file does not exist, the standard name is tried. This processing occurs for
4657 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4658
4659 In some esoteric situations different versions of Exim may be run under
4660 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4661 help with this. See the comments in &_src/EDITME_& for details.
4662
4663
4664
4665 .section "Configuration file format" "SECTconffilfor"
4666 .cindex "configuration file" "format of"
4667 .cindex "format" "configuration file"
4668 Exim's configuration file is divided into a number of different parts. General
4669 option settings must always appear at the start of the file. The other parts
4670 are all optional, and may appear in any order. Each part other than the first
4671 is introduced by the word &"begin"& followed by the name of the part. The
4672 optional parts are:
4673
4674 .ilist
4675 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4676 &<<CHAPACL>>&).
4677 .next
4678 .cindex "AUTH" "configuration"
4679 &'authenticators'&: Configuration settings for the authenticator drivers. These
4680 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4681 .next
4682 &'routers'&: Configuration settings for the router drivers. Routers process
4683 addresses and determine how the message is to be delivered (see chapters
4684 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4685 .next
4686 &'transports'&: Configuration settings for the transport drivers. Transports
4687 define mechanisms for copying messages to destinations (see chapters
4688 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4689 .next
4690 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4691 If there is no retry section, or if it is empty (that is, no retry rules are
4692 defined), Exim will not retry deliveries. In this situation, temporary errors
4693 are treated the same as permanent errors. Retry rules are discussed in chapter
4694 &<<CHAPretry>>&.
4695 .next
4696 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4697 when new addresses are generated during delivery. Rewriting is discussed in
4698 chapter &<<CHAPrewrite>>&.
4699 .next
4700 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4701 want to use this feature, you must set
4702 .code
4703 LOCAL_SCAN_HAS_OPTIONS=yes
4704 .endd
4705 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4706 facility are given in chapter &<<CHAPlocalscan>>&.
4707 .endlist
4708
4709 .cindex "configuration file" "leading white space in"
4710 .cindex "configuration file" "trailing white space in"
4711 .cindex "white space" "in configuration file"
4712 Leading and trailing white space in configuration lines is always ignored.
4713
4714 Blank lines in the file, and lines starting with a # character (ignoring
4715 leading white space) are treated as comments and are ignored. &*Note*&: A
4716 # character other than at the beginning of a line is not treated specially,
4717 and does not introduce a comment.
4718
4719 Any non-comment line can be continued by ending it with a backslash. Note that
4720 the general rule for white space means that trailing white space after the
4721 backslash and leading white space at the start of continuation
4722 lines is ignored. Comment lines beginning with # (but not empty lines) may
4723 appear in the middle of a sequence of continuation lines.
4724
4725 A convenient way to create a configuration file is to start from the
4726 default, which is supplied in &_src/configure.default_&, and add, delete, or
4727 change settings as required.
4728
4729 The ACLs, retry rules, and rewriting rules have their own syntax which is
4730 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4731 respectively. The other parts of the configuration file have some syntactic
4732 items in common, and these are described below, from section &<<SECTcos>>&
4733 onwards. Before that, the inclusion, macro, and conditional facilities are
4734 described.
4735
4736
4737
4738 .section "File inclusions in the configuration file" "SECID41"
4739 .cindex "inclusions in configuration file"
4740 .cindex "configuration file" "including other files"
4741 .cindex "&`.include`& in configuration file"
4742 .cindex "&`.include_if_exists`& in configuration file"
4743 You can include other files inside Exim's run time configuration file by
4744 using this syntax:
4745 .display
4746 &`.include`& <&'file name'&>
4747 &`.include_if_exists`& <&'file name'&>
4748 .endd
4749 on a line by itself. Double quotes round the file name are optional. If you use
4750 the first form, a configuration error occurs if the file does not exist; the
4751 second form does nothing for non-existent files. In all cases, an absolute file
4752 name is required.
4753
4754 Includes may be nested to any depth, but remember that Exim reads its
4755 configuration file often, so it is a good idea to keep them to a minimum.
4756 If you change the contents of an included file, you must HUP the daemon,
4757 because an included file is read only when the configuration itself is read.
4758
4759 The processing of inclusions happens early, at a physical line level, so, like
4760 comment lines, an inclusion can be used in the middle of an option setting,
4761 for example:
4762 .code
4763 hosts_lookup = a.b.c \
4764                .include /some/file
4765 .endd
4766 Include processing happens after macro processing (see below). Its effect is to
4767 process the lines of the included file as if they occurred inline where the
4768 inclusion appears.
4769
4770
4771
4772 .section "Macros in the configuration file" "SECTmacrodefs"
4773 .cindex "macro" "description of"
4774 .cindex "configuration file" "macros"
4775 If a line in the main part of the configuration (that is, before the first
4776 &"begin"& line) begins with an upper case letter, it is taken as a macro
4777 definition, and must be of the form
4778 .display
4779 <&'name'&> = <&'rest of line'&>
4780 .endd
4781 The name must consist of letters, digits, and underscores, and need not all be
4782 in upper case, though that is recommended. The rest of the line, including any
4783 continuations, is the replacement text, and has leading and trailing white
4784 space removed. Quotes are not removed. The replacement text can never end with
4785 a backslash character, but this doesn't seem to be a serious limitation.
4786
4787 Macros may also be defined between router, transport, authenticator, or ACL
4788 definitions. They may not, however, be defined within an individual driver or
4789 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4790
4791 .section "Macro substitution" "SECID42"
4792 Once a macro is defined, all subsequent lines in the file (and any included
4793 files) are scanned for the macro name; if there are several macros, the line is
4794 scanned for each in turn, in the order in which the macros are defined. The
4795 replacement text is not re-scanned for the current macro, though it is scanned
4796 for subsequently defined macros. For this reason, a macro name may not contain
4797 the name of a previously defined macro as a substring. You could, for example,
4798 define
4799 .display
4800 &`ABCD_XYZ = `&<&'something'&>
4801 &`ABCD = `&<&'something else'&>
4802 .endd
4803 but putting the definitions in the opposite order would provoke a configuration
4804 error. Macro expansion is applied to individual physical lines from the file,
4805 before checking for line continuation or file inclusion (see above). If a line
4806 consists solely of a macro name, and the expansion of the macro is empty, the
4807 line is ignored. A macro at the start of a line may turn the line into a
4808 comment line or a &`.include`& line.
4809
4810
4811 .section "Redefining macros" "SECID43"
4812 Once defined, the value of a macro can be redefined later in the configuration
4813 (or in an included file). Redefinition is specified by using &'=='& instead of
4814 &'='&. For example:
4815 .code
4816 MAC =  initial value
4817 ...
4818 MAC == updated value
4819 .endd
4820 Redefinition does not alter the order in which the macros are applied to the
4821 subsequent lines of the configuration file. It is still the same order in which
4822 the macros were originally defined. All that changes is the macro's value.
4823 Redefinition makes it possible to accumulate values. For example:
4824 .code
4825 MAC =  initial value
4826 ...
4827 MAC == MAC and something added
4828 .endd
4829 This can be helpful in situations where the configuration file is built
4830 from a number of other files.
4831
4832 .section "Overriding macro values" "SECID44"
4833 The values set for macros in the configuration file can be overridden by the
4834 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4835 used, unless called by root or the Exim user. A definition on the command line
4836 using the &%-D%& option causes all definitions and redefinitions within the
4837 file to be ignored.
4838
4839
4840
4841 .section "Example of macro usage" "SECID45"
4842 As an example of macro usage, consider a configuration where aliases are looked
4843 up in a MySQL database. It helps to keep the file less cluttered if long
4844 strings such as SQL statements are defined separately as macros, for example:
4845 .code
4846 ALIAS_QUERY = select mailbox from user where \
4847               login='${quote_mysql:$local_part}';
4848 .endd
4849 This can then be used in a &(redirect)& router setting like this:
4850 .code
4851 data = ${lookup mysql{ALIAS_QUERY}}
4852 .endd
4853 In earlier versions of Exim macros were sometimes used for domain, host, or
4854 address lists. In Exim 4 these are handled better by named lists &-- see
4855 section &<<SECTnamedlists>>&.
4856
4857
4858 .section "Conditional skips in the configuration file" "SECID46"
4859 .cindex "configuration file" "conditional skips"
4860 .cindex "&`.ifdef`&"
4861 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4862 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4863 portions of the configuration file. The processing happens whenever the file is
4864 read (that is, when an Exim binary starts to run).
4865
4866 The implementation is very simple. Instances of the first four directives must
4867 be followed by text that includes the names of one or macros. The condition
4868 that is tested is whether or not any macro substitution has taken place in the
4869 line. Thus:
4870 .code
4871 .ifdef AAA
4872 message_size_limit = 50M
4873 .else
4874 message_size_limit = 100M
4875 .endif
4876 .endd
4877 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4878 otherwise. If there is more than one macro named on the line, the condition
4879 is true if any of them are defined. That is, it is an &"or"& condition. To
4880 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4881
4882 Although you can use a macro expansion to generate one of these directives,
4883 it is not very useful, because the condition &"there was a macro substitution
4884 in this line"& will always be true.
4885
4886 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4887 to clarify complicated nestings.
4888
4889
4890
4891 .section "Common option syntax" "SECTcos"
4892 .cindex "common option syntax"
4893 .cindex "syntax of common options"
4894 .cindex "configuration file" "common option syntax"
4895 For the main set of options, driver options, and &[local_scan()]& options,
4896 each setting is on a line by itself, and starts with a name consisting of
4897 lower-case letters and underscores. Many options require a data value, and in
4898 these cases the name must be followed by an equals sign (with optional white
4899 space) and then the value. For example:
4900 .code
4901 qualify_domain = mydomain.example.com
4902 .endd
4903 .cindex "hiding configuration option values"
4904 .cindex "configuration options" "hiding value of"
4905 .cindex "options" "hiding value of"
4906 Some option settings may contain sensitive data, for example, passwords for
4907 accessing databases. To stop non-admin users from using the &%-bP%& command
4908 line option to read these values, you can precede the option settings with the
4909 word &"hide"&. For example:
4910 .code
4911 hide mysql_servers = localhost/users/admin/secret-password
4912 .endd
4913 For non-admin users, such options are displayed like this:
4914 .code
4915 mysql_servers = <value not displayable>
4916 .endd
4917 If &"hide"& is used on a driver option, it hides the value of that option on
4918 all instances of the same driver.
4919
4920 The following sections describe the syntax used for the different data types
4921 that are found in option settings.
4922
4923
4924 .section "Boolean options" "SECID47"
4925 .cindex "format" "boolean"
4926 .cindex "boolean configuration values"
4927 .oindex "&%no_%&&'xxx'&"
4928 .oindex "&%not_%&&'xxx'&"
4929 Options whose type is given as boolean are on/off switches. There are two
4930 different ways of specifying such options: with and without a data value. If
4931 the option name is specified on its own without data, the switch is turned on;
4932 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4933 boolean options may be followed by an equals sign and one of the words
4934 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4935 the following two settings have exactly the same effect:
4936 .code
4937 queue_only
4938 queue_only = true
4939 .endd
4940 The following two lines also have the same (opposite) effect:
4941 .code
4942 no_queue_only
4943 queue_only = false
4944 .endd
4945 You can use whichever syntax you prefer.
4946
4947
4948
4949
4950 .section "Integer values" "SECID48"
4951 .cindex "integer configuration values"
4952 .cindex "format" "integer"
4953 If an option's type is given as &"integer"&, the value can be given in decimal,
4954 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4955 number is assumed. Otherwise, it is treated as an octal number unless it starts
4956 with the characters &"0x"&, in which case the remainder is interpreted as a
4957 hexadecimal number.
4958
4959 If an integer value is followed by the letter K, it is multiplied by 1024; if
4960 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4961 of integer option settings are output, values which are an exact multiple of
4962 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4963 and M. The printing style is independent of the actual input format that was
4964 used.
4965
4966
4967 .section "Octal integer values" "SECID49"
4968 .cindex "integer format"
4969 .cindex "format" "octal integer"
4970 If an option's type is given as &"octal integer"&, its value is always
4971 interpreted as an octal number, whether or not it starts with the digit zero.
4972 Such options are always output in octal.
4973
4974
4975 .section "Fixed point numbers" "SECID50"
4976 .cindex "fixed point configuration values"
4977 .cindex "format" "fixed point"
4978 If an option's type is given as &"fixed-point"&, its value must be a decimal
4979 integer, optionally followed by a decimal point and up to three further digits.
4980
4981
4982
4983 .section "Time intervals" "SECTtimeformat"
4984 .cindex "time interval" "specifying in configuration"
4985 .cindex "format" "time interval"
4986 A time interval is specified as a sequence of numbers, each followed by one of
4987 the following letters, with no intervening white space:
4988
4989 .table2 30pt
4990 .irow &%s%& seconds
4991 .irow &%m%& minutes
4992 .irow &%h%& hours
4993 .irow &%d%& days
4994 .irow &%w%& weeks
4995 .endtable
4996
4997 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
4998 intervals are output in the same format. Exim does not restrict the values; it
4999 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5000
5001
5002
5003 .section "String values" "SECTstrings"
5004 .cindex "string" "format of configuration values"
5005 .cindex "format" "string"
5006 If an option's type is specified as &"string"&, the value can be specified with
5007 or without double-quotes. If it does not start with a double-quote, the value
5008 consists of the remainder of the line plus any continuation lines, starting at
5009 the first character after any leading white space, with trailing white space
5010 removed, and with no interpretation of the characters in the string. Because
5011 Exim removes comment lines (those beginning with #) at an early stage, they can
5012 appear in the middle of a multi-line string. The following two settings are
5013 therefore equivalent:
5014 .code
5015 trusted_users = uucp:mail
5016 trusted_users = uucp:\
5017                 # This comment line is ignored
5018                 mail
5019 .endd
5020 .cindex "string" "quoted"
5021 .cindex "escape characters in quoted strings"
5022 If a string does start with a double-quote, it must end with a closing
5023 double-quote, and any backslash characters other than those used for line
5024 continuation are interpreted as escape characters, as follows:
5025
5026 .table2 100pt
5027 .irow &`\\`&                     "single backslash"
5028 .irow &`\n`&                     "newline"
5029 .irow &`\r`&                     "carriage return"
5030 .irow &`\t`&                     "tab"
5031 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5032 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5033                                    character"
5034 .endtable
5035
5036 If a backslash is followed by some other character, including a double-quote
5037 character, that character replaces the pair.
5038
5039 Quoting is necessary only if you want to make use of the backslash escapes to
5040 insert special characters, or if you need to specify a value with leading or
5041 trailing spaces. These cases are rare, so quoting is almost never needed in
5042 current versions of Exim. In versions of Exim before 3.14, quoting was required
5043 in order to continue lines, so you may come across older configuration files
5044 and examples that apparently quote unnecessarily.
5045
5046
5047 .section "Expanded strings" "SECID51"
5048 .cindex "expansion" "definition of"
5049 Some strings in the configuration file are subjected to &'string expansion'&,
5050 by which means various parts of the string may be changed according to the
5051 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5052 is as just described; in particular, the handling of backslashes in quoted
5053 strings is done as part of the input process, before expansion takes place.
5054 However, backslash is also an escape character for the expander, so any
5055 backslashes that are required for that reason must be doubled if they are
5056 within a quoted configuration string.
5057
5058
5059 .section "User and group names" "SECID52"
5060 .cindex "user name" "format of"
5061 .cindex "format" "user name"
5062 .cindex "groups" "name format"
5063 .cindex "format" "group name"
5064 User and group names are specified as strings, using the syntax described
5065 above, but the strings are interpreted specially. A user or group name must
5066 either consist entirely of digits, or be a name that can be looked up using the
5067 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5068
5069
5070 .section "List construction" "SECTlistconstruct"
5071 .cindex "list" "syntax of in configuration"
5072 .cindex "format" "list item in configuration"
5073 .cindex "string" "list, definition of"
5074 The data for some configuration options is a list of items, with colon as the
5075 default separator. Many of these options are shown with type &"string list"& in
5076 the descriptions later in this document. Others are listed as &"domain list"&,
5077 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5078 are all the same; however, those other than &"string list"& are subject to
5079 particular kinds of interpretation, as described in chapter
5080 &<<CHAPdomhosaddlists>>&.
5081
5082 In all these cases, the entire list is treated as a single string as far as the
5083 input syntax is concerned. The &%trusted_users%& setting in section
5084 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5085 in a list, it must be entered as two colons. Leading and trailing white space
5086 on each item in a list is ignored. This makes it possible to include items that
5087 start with a colon, and in particular, certain forms of IPv6 address. For
5088 example, the list
5089 .code
5090 local_interfaces = 127.0.0.1 : ::::1
5091 .endd
5092 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5093
5094 &*Note*&: Although leading and trailing white space is ignored in individual
5095 list items, it is not ignored when parsing the list. The space after the first
5096 colon in the example above is necessary. If it were not there, the list would
5097 be interpreted as the two items 127.0.0.1:: and 1.
5098
5099 .section "Changing list separators" "SECID53"
5100 .cindex "list separator" "changing"
5101 .cindex "IPv6" "addresses in lists"
5102 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5103 introduced to allow the separator character to be changed. If a list begins
5104 with a left angle bracket, followed by any punctuation character, that
5105 character is used instead of colon as the list separator. For example, the list
5106 above can be rewritten to use a semicolon separator like this:
5107 .code
5108 local_interfaces = <; 127.0.0.1 ; ::1
5109 .endd
5110 This facility applies to all lists, with the exception of the list in
5111 &%log_file_path%&. It is recommended that the use of non-colon separators be
5112 confined to circumstances where they really are needed.
5113
5114 .cindex "list separator" "newline as"
5115 .cindex "newline" "as list separator"
5116 It is also possible to use newline and other control characters (those with
5117 code values less than 32, plus DEL) as separators in lists. Such separators
5118 must be provided literally at the time the list is processed. For options that
5119 are string-expanded, you can write the separator using a normal escape
5120 sequence. This will be processed by the expander before the string is
5121 interpreted as a list. For example, if a newline-separated list of domains is
5122 generated by a lookup, you can process it directly by a line such as this:
5123 .code
5124 domains = <\n ${lookup mysql{.....}}
5125 .endd
5126 This avoids having to change the list separator in such data. You are unlikely
5127 to want to use a control character as a separator in an option that is not
5128 expanded, because the value is literal text. However, it can be done by giving
5129 the value in quotes. For example:
5130 .code
5131 local_interfaces = "<\n 127.0.0.1 \n ::1"
5132 .endd
5133 Unlike printing character separators, which can be included in list items by
5134 doubling, it is not possible to include a control character as data when it is
5135 set as the separator. Two such characters in succession are interpreted as
5136 enclosing an empty list item.
5137
5138
5139
5140 .section "Empty items in lists" "SECTempitelis"
5141 .cindex "list" "empty item in"
5142 An empty item at the end of a list is always ignored. In other words, trailing
5143 separator characters are ignored. Thus, the list in
5144 .code
5145 senders = user@domain :
5146 .endd
5147 contains only a single item. If you want to include an empty string as one item
5148 in a list, it must not be the last item. For example, this list contains three
5149 items, the second of which is empty:
5150 .code
5151 senders = user1@domain : : user2@domain
5152 .endd
5153 &*Note*&: There must be white space between the two colons, as otherwise they
5154 are interpreted as representing a single colon data character (and the list
5155 would then contain just one item). If you want to specify a list that contains
5156 just one, empty item, you can do it as in this example:
5157 .code
5158 senders = :
5159 .endd
5160 In this case, the first item is empty, and the second is discarded because it
5161 is at the end of the list.
5162
5163
5164
5165
5166 .section "Format of driver configurations" "SECTfordricon"
5167 .cindex "drivers" "configuration format"
5168 There are separate parts in the configuration for defining routers, transports,
5169 and authenticators. In each part, you are defining a number of driver
5170 instances, each with its own set of options. Each driver instance is defined by
5171 a sequence of lines like this:
5172 .display
5173 <&'instance name'&>:
5174   <&'option'&>
5175   ...
5176   <&'option'&>
5177 .endd
5178 In the following example, the instance name is &(localuser)&, and it is
5179 followed by three options settings:
5180 .code
5181 localuser:
5182   driver = accept
5183   check_local_user
5184   transport = local_delivery
5185 .endd
5186 For each driver instance, you specify which Exim code module it uses &-- by the
5187 setting of the &%driver%& option &-- and (optionally) some configuration
5188 settings. For example, in the case of transports, if you want a transport to
5189 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5190 a local file you would use the &(appendfile)& driver. Each of the drivers is
5191 described in detail in its own separate chapter later in this manual.
5192
5193 You can have several routers, transports, or authenticators that are based on
5194 the same underlying driver (each must have a different instance name).
5195
5196 The order in which routers are defined is important, because addresses are
5197 passed to individual routers one by one, in order. The order in which
5198 transports are defined does not matter at all. The order in which
5199 authenticators are defined is used only when Exim, as a client, is searching
5200 them to find one that matches an authentication mechanism offered by the
5201 server.
5202
5203 .cindex "generic options"
5204 .cindex "options" "generic &-- definition of"
5205 Within a driver instance definition, there are two kinds of option: &'generic'&
5206 and &'private'&. The generic options are those that apply to all drivers of the
5207 same type (that is, all routers, all transports or all authenticators). The
5208 &%driver%& option is a generic option that must appear in every definition.
5209 .cindex "private options"
5210 The private options are special for each driver, and none need appear, because
5211 they all have default values.
5212
5213 The options may appear in any order, except that the &%driver%& option must
5214 precede any private options, since these depend on the particular driver. For
5215 this reason, it is recommended that &%driver%& always be the first option.
5216
5217 Driver instance names, which are used for reference in log entries and
5218 elsewhere, can be any sequence of letters, digits, and underscores (starting
5219 with a letter) and must be unique among drivers of the same type. A router and
5220 a transport (for example) can each have the same name, but no two router
5221 instances can have the same name. The name of a driver instance should not be
5222 confused with the name of the underlying driver module. For example, the
5223 configuration lines:
5224 .code
5225 remote_smtp:
5226   driver = smtp
5227 .endd
5228 create an instance of the &(smtp)& transport driver whose name is
5229 &(remote_smtp)&. The same driver code can be used more than once, with
5230 different instance names and different option settings each time. A second
5231 instance of the &(smtp)& transport, with different options, might be defined
5232 thus:
5233 .code
5234 special_smtp:
5235   driver = smtp
5236   port = 1234
5237   command_timeout = 10s
5238 .endd
5239 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5240 these transport instances from routers, and these names would appear in log
5241 lines.
5242
5243 Comment lines may be present in the middle of driver specifications. The full
5244 list of option settings for any particular driver instance, including all the
5245 defaulted values, can be extracted by making use of the &%-bP%& command line
5246 option.
5247
5248
5249
5250
5251
5252
5253 . ////////////////////////////////////////////////////////////////////////////
5254 . ////////////////////////////////////////////////////////////////////////////
5255
5256 .chapter "The default configuration file" "CHAPdefconfil"
5257 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5258 .cindex "default" "configuration file &""walk through""&"
5259 The default configuration file supplied with Exim as &_src/configure.default_&
5260 is sufficient for a host with simple mail requirements. As an introduction to
5261 the way Exim is configured, this chapter &"walks through"& the default
5262 configuration, giving brief explanations of the settings. Detailed descriptions
5263 of the options are given in subsequent chapters. The default configuration file
5264 itself contains extensive comments about ways you might want to modify the
5265 initial settings. However, note that there are many options that are not
5266 mentioned at all in the default configuration.
5267
5268
5269
5270 .section "Main configuration settings" "SECTdefconfmain"
5271 The main (global) configuration option settings must always come first in the
5272 file. The first thing you'll see in the file, after some initial comments, is
5273 the line
5274 .code
5275 # primary_hostname =
5276 .endd
5277 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5278 to know the official, fully qualified name of your host, and this is where you
5279 can specify it. However, in most cases you do not need to set this option. When
5280 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5281
5282 The first three non-comment configuration lines are as follows:
5283 .code
5284 domainlist local_domains = @
5285 domainlist relay_to_domains =
5286 hostlist   relay_from_hosts = 127.0.0.1
5287 .endd
5288 These are not, in fact, option settings. They are definitions of two named
5289 domain lists and one named host list. Exim allows you to give names to lists of
5290 domains, hosts, and email addresses, in order to make it easier to manage the
5291 configuration file (see section &<<SECTnamedlists>>&).
5292
5293 The first line defines a domain list called &'local_domains'&; this is used
5294 later in the configuration to identify domains that are to be delivered
5295 on the local host.
5296
5297 .cindex "@ in a domain list"
5298 There is just one item in this list, the string &"@"&. This is a special form
5299 of entry which means &"the name of the local host"&. Thus, if the local host is
5300 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5301 be delivered locally. Because the local host's name is referenced indirectly,
5302 the same configuration file can be used on different hosts.
5303
5304 The second line defines a domain list called &'relay_to_domains'&, but the
5305 list itself is empty. Later in the configuration we will come to the part that
5306 controls mail relaying through the local host; it allows relaying to any
5307 domains in this list. By default, therefore, no relaying on the basis of a mail
5308 domain is permitted.
5309
5310 The third line defines a host list called &'relay_from_hosts'&. This list is
5311 used later in the configuration to permit relaying from any host or IP address
5312 that matches the list. The default contains just the IP address of the IPv4
5313 loopback interface, which means that processes on the local host are able to
5314 submit mail for relaying by sending it over TCP/IP to that interface. No other
5315 hosts are permitted to submit messages for relaying.
5316
5317 Just to be sure there's no misunderstanding: at this point in the configuration
5318 we aren't actually setting up any controls. We are just defining some domains
5319 and hosts that will be used in the controls that are specified later.
5320
5321 The next two configuration lines are genuine option settings:
5322 .code
5323 acl_smtp_rcpt = acl_check_rcpt
5324 acl_smtp_data = acl_check_data
5325 .endd
5326 These options specify &'Access Control Lists'& (ACLs) that are to be used
5327 during an incoming SMTP session for every recipient of a message (every RCPT
5328 command), and after the contents of the message have been received,
5329 respectively. The names of the lists are &'acl_check_rcpt'& and
5330 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5331 section of the configuration. The RCPT ACL controls which recipients are
5332 accepted for an incoming message &-- if a configuration does not provide an ACL
5333 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5334 contents of a message to be checked.
5335
5336 Two commented-out option settings are next:
5337 .code
5338 # av_scanner = clamd:/tmp/clamd
5339 # spamd_address = 127.0.0.1 783
5340 .endd
5341 These are example settings that can be used when Exim is compiled with the
5342 content-scanning extension. The first specifies the interface to the virus
5343 scanner, and the second specifies the interface to SpamAssassin. Further
5344 details are given in chapter &<<CHAPexiscan>>&.
5345
5346 Three more commented-out option settings follow:
5347 .code
5348 # tls_advertise_hosts = *
5349 # tls_certificate = /etc/ssl/exim.crt
5350 # tls_privatekey = /etc/ssl/exim.pem
5351 .endd
5352 These are example settings that can be used when Exim is compiled with
5353 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5354 first one specifies the list of clients that are allowed to use TLS when
5355 connecting to this server; in this case the wildcard means all clients. The
5356 other options specify where Exim should find its TLS certificate and private
5357 key, which together prove the server's identity to any clients that connect.
5358 More details are given in chapter &<<CHAPTLS>>&.
5359
5360 Another two commented-out option settings follow:
5361 .code
5362 # daemon_smtp_ports = 25 : 465 : 587
5363 # tls_on_connect_ports = 465
5364 .endd
5365 .cindex "port" "465 and 587"
5366 .cindex "port" "for message submission"
5367 .cindex "message" "submission, ports for"
5368 .cindex "ssmtp protocol"
5369 .cindex "smtps protocol"
5370 .cindex "SMTP" "ssmtp protocol"
5371 .cindex "SMTP" "smtps protocol"
5372 These options provide better support for roaming users who wish to use this
5373 server for message submission. They are not much use unless you have turned on
5374 TLS (as described in the previous paragraph) and authentication (about which
5375 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5376 on end-user networks, so RFC 4409 specifies that message submission should use
5377 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5378 configured to use port 587 correctly, so these settings also enable the
5379 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5380 &<<SECTsupobssmt>>&).
5381
5382 Two more commented-out options settings follow:
5383 .code
5384 # qualify_domain =
5385 # qualify_recipient =
5386 .endd
5387 The first of these specifies a domain that Exim uses when it constructs a
5388 complete email address from a local login name. This is often needed when Exim
5389 receives a message from a local process. If you do not set &%qualify_domain%&,
5390 the value of &%primary_hostname%& is used. If you set both of these options,
5391 you can have different qualification domains for sender and recipient
5392 addresses. If you set only the first one, its value is used in both cases.
5393
5394 .cindex "domain literal" "recognizing format"
5395 The following line must be uncommented if you want Exim to recognize
5396 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5397 (an IP address within square brackets) instead of a named domain.
5398 .code
5399 # allow_domain_literals
5400 .endd
5401 The RFCs still require this form, but many people think that in the modern
5402 Internet it makes little sense to permit mail to be sent to specific hosts by
5403 quoting their IP addresses. This ancient format has been used by people who
5404 try to abuse hosts by using them for unwanted relaying. However, some
5405 people believe there are circumstances (for example, messages addressed to
5406 &'postmaster'&) where domain literals are still useful.
5407
5408 The next configuration line is a kind of trigger guard:
5409 .code
5410 never_users = root
5411 .endd
5412 It specifies that no delivery must ever be run as the root user. The normal
5413 convention is to set up &'root'& as an alias for the system administrator. This
5414 setting is a guard against slips in the configuration.
5415 The list of users specified by &%never_users%& is not, however, the complete
5416 list; the build-time configuration in &_Local/Makefile_& has an option called
5417 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5418 contents of &%never_users%& are added to this list. By default
5419 FIXED_NEVER_USERS also specifies root.
5420
5421 When a remote host connects to Exim in order to send mail, the only information
5422 Exim has about the host's identity is its IP address. The next configuration
5423 line,
5424 .code
5425 host_lookup = *
5426 .endd
5427 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5428 in order to get a host name. This improves the quality of the logging
5429 information, but if you feel it is too expensive, you can remove it entirely,
5430 or restrict the lookup to hosts on &"nearby"& networks.
5431 Note that it is not always possible to find a host name from an IP address,
5432 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5433 unreachable.
5434
5435 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5436 1413 (hence their names):
5437 .code
5438 rfc1413_hosts = *
5439 rfc1413_query_timeout = 5s
5440 .endd
5441 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5442 You can limit the hosts to which these calls are made, or change the timeout
5443 that is used. If you set the timeout to zero, all ident calls are disabled.
5444 Although they are cheap and can provide useful information for tracing problem
5445 messages, some hosts and firewalls have problems with ident calls. This can
5446 result in a timeout instead of an immediate refused connection, leading to
5447 delays on starting up an incoming SMTP session.
5448
5449 When Exim receives messages over SMTP connections, it expects all addresses to
5450 be fully qualified with a domain, as required by the SMTP definition. However,
5451 if you are running a server to which simple clients submit messages, you may
5452 find that they send unqualified addresses. The two commented-out options:
5453 .code
5454 # sender_unqualified_hosts =
5455 # recipient_unqualified_hosts =
5456 .endd
5457 show how you can specify hosts that are permitted to send unqualified sender
5458 and recipient addresses, respectively.
5459
5460 The &%percent_hack_domains%& option is also commented out:
5461 .code
5462 # percent_hack_domains =
5463 .endd
5464 It provides a list of domains for which the &"percent hack"& is to operate.
5465 This is an almost obsolete form of explicit email routing. If you do not know
5466 anything about it, you can safely ignore this topic.
5467
5468 The last two settings in the main part of the default configuration are
5469 concerned with messages that have been &"frozen"& on Exim's queue. When a
5470 message is frozen, Exim no longer continues to try to deliver it. Freezing
5471 occurs when a bounce message encounters a permanent failure because the sender
5472 address of the original message that caused the bounce is invalid, so the
5473 bounce cannot be delivered. This is probably the most common case, but there
5474 are also other conditions that cause freezing, and frozen messages are not
5475 always bounce messages.
5476 .code
5477 ignore_bounce_errors_after = 2d
5478 timeout_frozen_after = 7d
5479 .endd
5480 The first of these options specifies that failing bounce messages are to be
5481 discarded after 2 days on the queue. The second specifies that any frozen
5482 message (whether a bounce message or not) is to be timed out (and discarded)
5483 after a week. In this configuration, the first setting ensures that no failing
5484 bounce message ever lasts a week.
5485
5486
5487
5488 .section "ACL configuration" "SECID54"
5489 .cindex "default" "ACLs"
5490 .cindex "&ACL;" "default configuration"
5491 In the default configuration, the ACL section follows the main configuration.
5492 It starts with the line
5493 .code
5494 begin acl
5495 .endd
5496 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5497 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5498 and &%acl_smtp_data%& above.
5499
5500 .cindex "RCPT" "ACL for"
5501 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5502 RCPT command specifies one of the message's recipients. The ACL statements
5503 are considered in order, until the recipient address is either accepted or
5504 rejected. The RCPT command is then accepted or rejected, according to the
5505 result of the ACL processing.
5506 .code
5507 acl_check_rcpt:
5508 .endd
5509 This line, consisting of a name terminated by a colon, marks the start of the
5510 ACL, and names it.
5511 .code
5512 accept  hosts = :
5513 .endd
5514 This ACL statement accepts the recipient if the sending host matches the list.
5515 But what does that strange list mean? It doesn't actually contain any host
5516 names or IP addresses. The presence of the colon puts an empty item in the
5517 list; Exim matches this only if the incoming message did not come from a remote
5518 host, because in that case, the remote hostname is empty. The colon is
5519 important. Without it, the list itself is empty, and can never match anything.
5520
5521 What this statement is doing is to accept unconditionally all recipients in
5522 messages that are submitted by SMTP from local processes using the standard
5523 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5524 manner.
5525 .code
5526 deny    message       = Restricted characters in address
5527         domains       = +local_domains
5528         local_parts   = ^[.] : ^.*[@%!/|]
5529
5530 deny    message       = Restricted characters in address
5531         domains       = !+local_domains
5532         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5533 .endd
5534 These statements are concerned with local parts that contain any of the
5535 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5536 Although these characters are entirely legal in local parts (in the case of
5537 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5538 in Internet mail addresses.
5539
5540 The first three have in the past been associated with explicitly routed
5541 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5542 option). Addresses containing these characters are regularly tried by spammers
5543 in an attempt to bypass relaying restrictions, and also by open relay testing
5544 programs. Unless you really need them it is safest to reject these characters
5545 at this early stage. This configuration is heavy-handed in rejecting these
5546 characters for all messages it accepts from remote hosts. This is a deliberate
5547 policy of being as safe as possible.
5548
5549 The first rule above is stricter, and is applied to messages that are addressed
5550 to one of the local domains handled by this host. This is implemented by the
5551 first condition, which restricts it to domains that are listed in the
5552 &'local_domains'& domain list. The &"+"& character is used to indicate a
5553 reference to a named list. In this configuration, there is just one domain in
5554 &'local_domains'&, but in general there may be many.
5555
5556 The second condition on the first statement uses two regular expressions to
5557 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5558 or &"|"&. If you have local accounts that include these characters, you will
5559 have to modify this rule.
5560
5561 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5562 allows them because they have been encountered in practice. (Consider the
5563 common convention of local parts constructed as
5564 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5565 the author of Exim, who has no second initial.) However, a local part starting
5566 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5567 file name (for example, for a mailing list). This is also true for local parts
5568 that contain slashes. A pipe symbol can also be troublesome if the local part
5569 is incorporated unthinkingly into a shell command line.
5570
5571 The second rule above applies to all other domains, and is less strict. This
5572 allows your own users to send outgoing messages to sites that use slashes
5573 and vertical bars in their local parts. It blocks local parts that begin
5574 with a dot, slash, or vertical bar, but allows these characters within the
5575 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5576 and &"!"& is blocked, as before. The motivation here is to prevent your users
5577 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5578 .code
5579 accept  local_parts   = postmaster
5580         domains       = +local_domains
5581 .endd
5582 This statement, which has two conditions, accepts an incoming address if the
5583 local part is &'postmaster'& and the domain is one of those listed in the
5584 &'local_domains'& domain list. The &"+"& character is used to indicate a
5585 reference to a named list. In this configuration, there is just one domain in
5586 &'local_domains'&, but in general there may be many.
5587
5588 The presence of this statement means that mail to postmaster is never blocked
5589 by any of the subsequent tests. This can be helpful while sorting out problems
5590 in cases where the subsequent tests are incorrectly denying access.
5591 .code
5592 require verify        = sender
5593 .endd
5594 This statement requires the sender address to be verified before any subsequent
5595 ACL statement can be used. If verification fails, the incoming recipient
5596 address is refused. Verification consists of trying to route the address, to
5597 see if a bounce message could be delivered to it. In the case of remote
5598 addresses, basic verification checks only the domain, but &'callouts'& can be
5599 used for more verification if required. Section &<<SECTaddressverification>>&
5600 discusses the details of address verification.
5601 .code
5602 accept  hosts         = +relay_from_hosts
5603         control       = submission
5604 .endd
5605 This statement accepts the address if the message is coming from one of the
5606 hosts that are defined as being allowed to relay through this host. Recipient
5607 verification is omitted here, because in many cases the clients are dumb MUAs
5608 that do not cope well with SMTP error responses. For the same reason, the
5609 second line specifies &"submission mode"& for messages that are accepted. This
5610 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5611 messages that are deficient in some way, for example, because they lack a
5612 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5613 probably add recipient verification here, and disable submission mode.
5614 .code
5615 accept  authenticated = *
5616         control       = submission
5617 .endd
5618 This statement accepts the address if the client host has authenticated itself.
5619 Submission mode is again specified, on the grounds that such messages are most
5620 likely to come from MUAs. The default configuration does not define any
5621 authenticators, though it does include some nearly complete commented-out
5622 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5623 fact authenticate until you complete the authenticator definitions.
5624 .code
5625 require message = relay not permitted
5626         domains = +local_domains : +relay_domains
5627 .endd
5628 This statement rejects the address if its domain is neither a local domain nor
5629 one of the domains for which this host is a relay.
5630 .code
5631 require verify = recipient
5632 .endd
5633 This statement requires the recipient address to be verified; if verification
5634 fails, the address is rejected.
5635 .code
5636 # deny    message     = rejected because $sender_host_address \
5637 #                       is in a black list at $dnslist_domain\n\
5638 #                       $dnslist_text
5639 #         dnslists    = black.list.example
5640 #
5641 # warn    dnslists    = black.list.example
5642 #         add_header  = X-Warning: $sender_host_address is in \
5643 #                       a black list at $dnslist_domain
5644 #         log_message = found in $dnslist_domain
5645 .endd
5646 These commented-out lines are examples of how you could configure Exim to check
5647 sending hosts against a DNS black list. The first statement rejects messages
5648 from blacklisted hosts, whereas the second just inserts a warning header
5649 line.
5650 .code
5651 # require verify = csa
5652 .endd
5653 This commented-out line is an example of how you could turn on client SMTP
5654 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5655 records.
5656 .code
5657 accept
5658 .endd
5659 The final statement in the first ACL unconditionally accepts any recipient
5660 address that has successfully passed all the previous tests.
5661 .code
5662 acl_check_data:
5663 .endd
5664 This line marks the start of the second ACL, and names it. Most of the contents
5665 of this ACL are commented out:
5666 .code
5667 # deny    malware   = *
5668 #         message   = This message contains a virus \
5669 #                     ($malware_name).
5670 .endd
5671 These lines are examples of how to arrange for messages to be scanned for
5672 viruses when Exim has been compiled with the content-scanning extension, and a
5673 suitable virus scanner is installed. If the message is found to contain a
5674 virus, it is rejected with the given custom error message.
5675 .code
5676 # warn    spam      = nobody
5677 #         message   = X-Spam_score: $spam_score\n\
5678 #                     X-Spam_score_int: $spam_score_int\n\
5679 #                     X-Spam_bar: $spam_bar\n\
5680 #                     X-Spam_report: $spam_report
5681 .endd
5682 These lines are an example of how to arrange for messages to be scanned by
5683 SpamAssassin when Exim has been compiled with the content-scanning extension,
5684 and SpamAssassin has been installed. The SpamAssassin check is run with
5685 &`nobody`& as its user parameter, and the results are added to the message as a
5686 series of extra header line. In this case, the message is not rejected,
5687 whatever the spam score.
5688 .code
5689 accept
5690 .endd
5691 This final line in the DATA ACL accepts the message unconditionally.
5692
5693
5694 .section "Router configuration" "SECID55"
5695 .cindex "default" "routers"
5696 .cindex "routers" "default"
5697 The router configuration comes next in the default configuration, introduced
5698 by the line
5699 .code
5700 begin routers
5701 .endd
5702 Routers are the modules in Exim that make decisions about where to send
5703 messages. An address is passed to each router in turn, until it is either
5704 accepted, or failed. This means that the order in which you define the routers
5705 matters. Each router is fully described in its own chapter later in this
5706 manual. Here we give only brief overviews.
5707 .code
5708 # domain_literal:
5709 #   driver = ipliteral
5710 #   domains = !+local_domains
5711 #   transport = remote_smtp
5712 .endd
5713 .cindex "domain literal" "default router"
5714 This router is commented out because the majority of sites do not want to
5715 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5716 you uncomment this router, you also need to uncomment the setting of
5717 &%allow_domain_literals%& in the main part of the configuration.
5718 .code
5719 dnslookup:
5720   driver = dnslookup
5721   domains = ! +local_domains
5722   transport = remote_smtp
5723   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5724   no_more
5725 .endd
5726 The first uncommented router handles addresses that do not involve any local
5727 domains. This is specified by the line
5728 .code
5729 domains = ! +local_domains
5730 .endd
5731 The &%domains%& option lists the domains to which this router applies, but the
5732 exclamation mark is a negation sign, so the router is used only for domains
5733 that are not in the domain list called &'local_domains'& (which was defined at
5734 the start of the configuration). The plus sign before &'local_domains'&
5735 indicates that it is referring to a named list. Addresses in other domains are
5736 passed on to the following routers.
5737
5738 The name of the router driver is &(dnslookup)&,
5739 and is specified by the &%driver%& option. Do not be confused by the fact that
5740 the name of this router instance is the same as the name of the driver. The
5741 instance name is arbitrary, but the name set in the &%driver%& option must be
5742 one of the driver modules that is in the Exim binary.
5743
5744 The &(dnslookup)& router routes addresses by looking up their domains in the
5745 DNS in order to obtain a list of hosts to which the address is routed. If the
5746 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5747 specified by the &%transport%& option. If the router does not find the domain
5748 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5749 the address fails and is bounced.
5750
5751 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5752 be entirely ignored. This option is present because a number of cases have been
5753 encountered where MX records in the DNS point to host names
5754 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5755 Completely ignoring these IP addresses causes Exim to fail to route the
5756 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5757 continue to try to deliver the message periodically until the address timed
5758 out.
5759 .code
5760 system_aliases:
5761   driver = redirect
5762   allow_fail
5763   allow_defer
5764   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5765 # user = exim
5766   file_transport = address_file
5767   pipe_transport = address_pipe
5768 .endd
5769 Control reaches this and subsequent routers only for addresses in the local
5770 domains. This router checks to see whether the local part is defined as an
5771 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5772 data that it looks up from that file. If no data is found for the local part,
5773 the value of the &%data%& option is empty, causing the address to be passed to
5774 the next router.
5775
5776 &_/etc/aliases_& is a conventional name for the system aliases file that is
5777 often used. That is why it is referenced by from the default configuration
5778 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5779 &_Local/Makefile_& before building Exim.
5780 .code
5781 userforward:
5782   driver = redirect
5783   check_local_user
5784 # local_part_suffix = +* : -*
5785 # local_part_suffix_optional
5786   file = $home/.forward
5787 # allow_filter
5788   no_verify
5789   no_expn
5790   check_ancestor
5791   file_transport = address_file
5792   pipe_transport = address_pipe
5793   reply_transport = address_reply
5794 .endd
5795 This is the most complicated router in the default configuration. It is another
5796 redirection router, but this time it is looking for forwarding data set up by
5797 individual users. The &%check_local_user%& setting specifies a check that the
5798 local part of the address is the login name of a local user. If it is not, the
5799 router is skipped. The two commented options that follow &%check_local_user%&,
5800 namely:
5801 .code
5802 # local_part_suffix = +* : -*
5803 # local_part_suffix_optional
5804 .endd
5805 .vindex "&$local_part_suffix$&"
5806 show how you can specify the recognition of local part suffixes. If the first
5807 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5808 by any sequence of characters, is removed from the local part and placed in the
5809 variable &$local_part_suffix$&. The second suffix option specifies that the
5810 presence of a suffix in the local part is optional. When a suffix is present,
5811 the check for a local login uses the local part with the suffix removed.
5812
5813 When a local user account is found, the file called &_.forward_& in the user's
5814 home directory is consulted. If it does not exist, or is empty, the router
5815 declines. Otherwise, the contents of &_.forward_& are interpreted as
5816 redirection data (see chapter &<<CHAPredirect>>& for more details).
5817
5818 .cindex "Sieve filter" "enabling in default router"
5819 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5820 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5821 is commented out by default), the contents of the file are interpreted as a set
5822 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5823 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5824 separate document entitled &'Exim's interfaces to mail filtering'&.
5825
5826 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5827 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5828 There are two reasons for doing this:
5829
5830 .olist
5831 Whether or not a local user has a &_.forward_& file is not really relevant when
5832 checking an address for validity; it makes sense not to waste resources doing
5833 unnecessary work.
5834 .next
5835 More importantly, when Exim is verifying addresses or handling an EXPN
5836 command during an SMTP session, it is running as the Exim user, not as root.
5837 The group is the Exim group, and no additional groups are set up.
5838 It may therefore not be possible for Exim to read users' &_.forward_& files at
5839 this time.
5840 .endlist
5841
5842 The setting of &%check_ancestor%& prevents the router from generating a new
5843 address that is the same as any previous address that was redirected. (This
5844 works round a problem concerning a bad interaction between aliasing and
5845 forwarding &-- see section &<<SECTredlocmai>>&).
5846
5847 The final three option settings specify the transports that are to be used when
5848 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5849 auto-reply, respectively. For example, if a &_.forward_& file contains
5850 .code
5851 a.nother@elsewhere.example, /home/spqr/archive
5852 .endd
5853 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5854 transport.
5855 .code
5856 localuser:
5857   driver = accept
5858   check_local_user
5859 # local_part_suffix = +* : -*
5860 # local_part_suffix_optional
5861   transport = local_delivery
5862 .endd
5863 The final router sets up delivery into local mailboxes, provided that the local
5864 part is the name of a local login, by accepting the address and assigning it to
5865 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5866 routers, so the address is bounced. The commented suffix settings fulfil the
5867 same purpose as they do for the &(userforward)& router.
5868
5869
5870 .section "Transport configuration" "SECID56"
5871 .cindex "default" "transports"
5872 .cindex "transports" "default"
5873 Transports define mechanisms for actually delivering messages. They operate
5874 only when referenced from routers, so the order in which they are defined does
5875 not matter. The transports section of the configuration starts with
5876 .code
5877 begin transports
5878 .endd
5879 One remote transport and four local transports are defined.
5880 .code
5881 remote_smtp:
5882   driver = smtp
5883 .endd
5884 This transport is used for delivering messages over SMTP connections. All its
5885 options are defaulted. The list of remote hosts comes from the router.
5886 .code
5887 local_delivery:
5888   driver = appendfile
5889   file = /var/mail/$local_part
5890   delivery_date_add
5891   envelope_to_add
5892   return_path_add
5893 # group = mail
5894 # mode = 0660
5895 .endd
5896 This &(appendfile)& transport is used for local delivery to user mailboxes in
5897 traditional BSD mailbox format. By default it runs under the uid and gid of the
5898 local user, which requires the sticky bit to be set on the &_/var/mail_&
5899 directory. Some systems use the alternative approach of running mail deliveries
5900 under a particular group instead of using the sticky bit. The commented options
5901 show how this can be done.
5902
5903 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5904 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5905 similarly-named options above.
5906 .code
5907 address_pipe:
5908   driver = pipe
5909   return_output
5910 .endd
5911 This transport is used for handling deliveries to pipes that are generated by
5912 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5913 option specifies that any output generated by the pipe is to be returned to the
5914 sender.
5915 .code
5916 address_file:
5917   driver = appendfile
5918   delivery_date_add
5919   envelope_to_add
5920   return_path_add
5921 .endd
5922 This transport is used for handling deliveries to files that are generated by
5923 redirection. The name of the file is not specified in this instance of
5924 &(appendfile)&, because it comes from the &(redirect)& router.
5925 .code
5926 address_reply:
5927   driver = autoreply
5928 .endd
5929 This transport is used for handling automatic replies generated by users'
5930 filter files.
5931
5932
5933
5934 .section "Default retry rule" "SECID57"
5935 .cindex "retry" "default rule"
5936 .cindex "default" "retry rule"
5937 The retry section of the configuration file contains rules which affect the way
5938 Exim retries deliveries that cannot be completed at the first attempt. It is
5939 introduced by the line
5940 .code
5941 begin retry
5942 .endd
5943 In the default configuration, there is just one rule, which applies to all
5944 errors:
5945 .code
5946 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5947 .endd
5948 This causes any temporarily failing address to be retried every 15 minutes for
5949 2 hours, then at intervals starting at one hour and increasing by a factor of
5950 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5951 is not delivered after 4 days of temporary failure, it is bounced.
5952
5953 If the retry section is removed from the configuration, or is empty (that is,
5954 if no retry rules are defined), Exim will not retry deliveries. This turns
5955 temporary errors into permanent errors.
5956
5957
5958 .section "Rewriting configuration" "SECID58"
5959 The rewriting section of the configuration, introduced by
5960 .code
5961 begin rewrite
5962 .endd
5963 contains rules for rewriting addresses in messages as they arrive. There are no
5964 rewriting rules in the default configuration file.
5965
5966
5967
5968 .section "Authenticators configuration" "SECTdefconfauth"
5969 .cindex "AUTH" "configuration"
5970 The authenticators section of the configuration, introduced by
5971 .code
5972 begin authenticators
5973 .endd
5974 defines mechanisms for the use of the SMTP AUTH command. The default
5975 configuration file contains two commented-out example authenticators
5976 which support plaintext username/password authentication using the
5977 standard PLAIN mechanism and the traditional but non-standard LOGIN
5978 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
5979 to support most MUA software.
5980
5981 The example PLAIN authenticator looks like this:
5982 .code
5983 #PLAIN:
5984 #  driver                  = plaintext
5985 #  server_set_id           = $auth2
5986 #  server_prompts          = :
5987 #  server_condition        = Authentication is not yet configured
5988 #  server_advertise_condition = ${if def:tls_cipher }
5989 .endd
5990 And the example LOGIN authenticator looks like this:
5991 .code
5992 #LOGIN:
5993 #  driver                  = plaintext
5994 #  server_set_id           = $auth1
5995 #  server_prompts          = <| Username: | Password:
5996 #  server_condition        = Authentication is not yet configured
5997 #  server_advertise_condition = ${if def:tls_cipher }
5998 .endd
5999
6000 The &%server_set_id%& option makes Exim remember the authenticated username
6001 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6002 &%server_prompts%& option configures the &(plaintext)& authenticator so
6003 that it implements the details of the specific authentication mechanism,
6004 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6005 when Exim offers authentication to clients; in the examples, this is only
6006 when TLS or SSL has been started, so to enable the authenticators you also
6007 need to add support for TLS as described in &<<SECTdefconfmain>>&.
6008
6009 The &%server_condition%& setting defines how to verify that the username and
6010 password are correct. In the examples it just produces an error message.
6011 To make the authenticators work, you can use a string expansion
6012 expression like one of the examples in &<<CHAPplaintext>>&.
6013
6014 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6015 usercode and password are in different positions.  &<<CHAPplaintext>>&
6016 covers both.
6017
6018 .ecindex IIDconfiwal
6019
6020
6021
6022 . ////////////////////////////////////////////////////////////////////////////
6023 . ////////////////////////////////////////////////////////////////////////////
6024
6025 .chapter "Regular expressions" "CHAPregexp"
6026
6027 .cindex "regular expressions" "library"
6028 .cindex "PCRE"
6029 Exim supports the use of regular expressions in many of its options. It
6030 uses the PCRE regular expression library; this provides regular expression
6031 matching that is compatible with Perl 5. The syntax and semantics of
6032 regular expressions is discussed in many Perl reference books, and also in
6033 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6034 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6035
6036 The documentation for the syntax and semantics of the regular expressions that
6037 are supported by PCRE is included in the PCRE distribution, and no further
6038 description is included here. The PCRE functions are called from Exim using
6039 the default option settings (that is, with no PCRE options set), except that
6040 the PCRE_CASELESS option is set when the matching is required to be
6041 case-insensitive.
6042
6043 In most cases, when a regular expression is required in an Exim configuration,
6044 it has to start with a circumflex, in order to distinguish it from plain text
6045 or an &"ends with"& wildcard. In this example of a configuration setting, the
6046 second item in the colon-separated list is a regular expression.
6047 .code
6048 domains = a.b.c : ^\\d{3} : *.y.z : ...
6049 .endd
6050 The doubling of the backslash is required because of string expansion that
6051 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6052 of this issue, and a way of avoiding the need for doubling backslashes. The
6053 regular expression that is eventually used in this example contains just one
6054 backslash. The circumflex is included in the regular expression, and has the
6055 normal effect of &"anchoring"& it to the start of the string that is being
6056 matched.
6057
6058 There are, however, two cases where a circumflex is not required for the
6059 recognition of a regular expression: these are the &%match%& condition in a
6060 string expansion, and the &%matches%& condition in an Exim filter file. In
6061 these cases, the relevant string is always treated as a regular expression; if
6062 it does not start with a circumflex, the expression is not anchored, and can
6063 match anywhere in the subject string.
6064
6065 In all cases, if you want a regular expression to match at the end of a string,
6066 you must code the $ metacharacter to indicate this. For example:
6067 .code
6068 domains = ^\\d{3}\\.example
6069 .endd
6070 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6071 You need to use:
6072 .code
6073 domains = ^\\d{3}\\.example\$
6074 .endd
6075 if you want &'example'& to be the top-level domain. The backslash before the
6076 $ is needed because string expansion also interprets dollar characters.
6077
6078
6079
6080 . ////////////////////////////////////////////////////////////////////////////
6081 . ////////////////////////////////////////////////////////////////////////////
6082
6083 .chapter "File and database lookups" "CHAPfdlookup"
6084 .scindex IIDfidalo1 "file" "lookups"
6085 .scindex IIDfidalo2 "database" "lookups"
6086 .cindex "lookup" "description of"
6087 Exim can be configured to look up data in files or databases as it processes
6088 messages. Two different kinds of syntax are used:
6089
6090 .olist
6091 A string that is to be expanded may contain explicit lookup requests. These
6092 cause parts of the string to be replaced by data that is obtained from the
6093 lookup. Lookups of this type are conditional expansion items. Different results
6094 can be defined for the cases of lookup success and failure. See chapter
6095 &<<CHAPexpand>>&, where string expansions are described in detail.
6096 .next
6097 Lists of domains, hosts, and email addresses can contain lookup requests as a
6098 way of avoiding excessively long linear lists. In this case, the data that is
6099 returned by the lookup is often (but not always) discarded; whether the lookup
6100 succeeds or fails is what really counts. These kinds of list are described in
6101 chapter &<<CHAPdomhosaddlists>>&.
6102 .endlist
6103
6104 String expansions, lists, and lookups interact with each other in such a way
6105 that there is no order in which to describe any one of them that does not
6106 involve references to the others. Each of these three chapters makes more sense
6107 if you have read the other two first. If you are reading this for the first
6108 time, be aware that some of it will make a lot more sense after you have read
6109 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6110
6111 .section "Examples of different lookup syntax" "SECID60"
6112 It is easy to confuse the two different kinds of lookup, especially as the
6113 lists that may contain the second kind are always expanded before being
6114 processed as lists. Therefore, they may also contain lookups of the first kind.
6115 Be careful to distinguish between the following two examples:
6116 .code
6117 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6118 domains = lsearch;/some/file
6119 .endd
6120 The first uses a string expansion, the result of which must be a domain list.
6121 No strings have been specified for a successful or a failing lookup; the
6122 defaults in this case are the looked-up data and an empty string, respectively.
6123 The expansion takes place before the string is processed as a list, and the
6124 file that is searched could contain lines like this:
6125 .code
6126 192.168.3.4: domain1:domain2:...
6127 192.168.1.9: domain3:domain4:...
6128 .endd
6129 When the lookup succeeds, the result of the expansion is a list of domains (and
6130 possibly other types of item that are allowed in domain lists).
6131
6132 In the second example, the lookup is a single item in a domain list. It causes
6133 Exim to use a lookup to see if the domain that is being processed can be found
6134 in the file. The file could contains lines like this:
6135 .code
6136 domain1:
6137 domain2:
6138 .endd
6139 Any data that follows the keys is not relevant when checking that the domain
6140 matches the list item.
6141
6142 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6143 Consider a file containing lines like this:
6144 .code
6145 192.168.5.6: lsearch;/another/file
6146 .endd
6147 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6148 first &%domains%& setting above generates the second setting, which therefore
6149 causes a second lookup to occur.
6150
6151 The rest of this chapter describes the different lookup types that are
6152 available. Any of them can be used in any part of the configuration where a
6153 lookup is permitted.
6154
6155
6156 .section "Lookup types" "SECID61"
6157 .cindex "lookup" "types of"
6158 .cindex "single-key lookup" "definition of"
6159 Two different types of data lookup are implemented:
6160
6161 .ilist
6162 The &'single-key'& type requires the specification of a file in which to look,
6163 and a single key to search for. The key must be a non-empty string for the
6164 lookup to succeed. The lookup type determines how the file is searched.
6165 .next
6166 .cindex "query-style lookup" "definition of"
6167 The &'query-style'& type accepts a generalized database query. No particular
6168 key value is assumed by Exim for query-style lookups. You can use whichever
6169 Exim variables you need to construct the database query.
6170 .endlist
6171
6172 The code for each lookup type is in a separate source file that is included in
6173 the binary of Exim only if the corresponding compile-time option is set. The
6174 default settings in &_src/EDITME_& are:
6175 .code
6176 LOOKUP_DBM=yes
6177 LOOKUP_LSEARCH=yes
6178 .endd
6179 which means that only linear searching and DBM lookups are included by default.
6180 For some types of lookup (e.g. SQL databases), you need to install appropriate
6181 libraries and header files before building Exim.
6182
6183
6184
6185
6186 .section "Single-key lookup types" "SECTsinglekeylookups"
6187 .cindex "lookup" "single-key types"
6188 .cindex "single-key lookup" "list of types"
6189 The following single-key lookup types are implemented:
6190
6191 .ilist
6192 .cindex "cdb" "description of"
6193 .cindex "lookup" "cdb"
6194 .cindex "binary zero" "in lookup key"
6195 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6196 string without a terminating binary zero. The cdb format is designed for
6197 indexed files that are read frequently and never updated, except by total
6198 re-creation. As such, it is particularly suitable for large files containing
6199 aliases or other indexed data referenced by an MTA. Information about cdb can
6200 be found in several places:
6201 .display
6202 &url(http://www.pobox.com/~djb/cdb.html)
6203 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6204 &url(http://packages.debian.org/stable/utils/freecdb.html)
6205 .endd
6206 A cdb distribution is not needed in order to build Exim with cdb support,
6207 because the code for reading cdb files is included directly in Exim itself.
6208 However, no means of building or testing cdb files is provided with Exim, so
6209 you need to obtain a cdb distribution in order to do this.
6210 .next
6211 .cindex "DBM" "lookup type"
6212 .cindex "lookup" "dbm"
6213 .cindex "binary zero" "in lookup key"
6214 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6215 DBM file by looking up the record with the given key. A terminating binary
6216 zero is included in the key that is passed to the DBM library. See section
6217 &<<SECTdb>>& for a discussion of DBM libraries.
6218
6219 .cindex "Berkeley DB library" "file format"
6220 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6221 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6222 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6223 the DB_UNKNOWN option. This enables it to handle any of the types of database
6224 that the library supports, and can be useful for accessing DBM files created by
6225 other applications. (For earlier DB versions, DB_HASH is always used.)
6226 .new
6227 .next
6228 .cindex "lookup" "dbmjz"
6229 .cindex "lookup" "dbm &-- embedded NULs"
6230 .cindex "sasldb2"
6231 .cindex "dbmjz lookup type"
6232 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6233 interpreted as an Exim list; the elements of the list are joined together with
6234 ASCII NUL characters to form the lookup key.  An example usage would be to
6235 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6236 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6237 &(cram_md5)& authenticator.
6238 .wen
6239 .next
6240 .cindex "lookup" "dbmnz"
6241 .cindex "lookup" "dbm &-- terminating zero"
6242 .cindex "binary zero" "in lookup key"
6243 .cindex "Courier"
6244 .cindex "&_/etc/userdbshadow.dat_&"
6245 .cindex "dbmnz lookup type"
6246 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6247 is not included in the key that is passed to the DBM library. You may need this
6248 if you want to look up data in files that are created by or shared with some
6249 other application that does not use terminating zeros. For example, you need to
6250 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6251 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6252 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6253 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6254 .next
6255 .cindex "lookup" "dsearch"
6256 .cindex "dsearch lookup type"
6257 &(dsearch)&: The given file must be a directory; this is searched for an entry
6258 whose name is the key by calling the &[lstat()]& function. The key may not
6259 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6260 the lookup is the name of the entry, which may be a file, directory,
6261 symbolic link, or any other kind of directory entry. An example of how this
6262 lookup can be used to support virtual domains is given in section
6263 &<<SECTvirtualdomains>>&.
6264 .next
6265 .cindex "lookup" "iplsearch"
6266 .cindex "iplsearch lookup type"
6267 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6268 terminated by a colon or white space or the end of the line. The keys in the
6269 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6270 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6271 being interpreted as a key terminator. For example:
6272 .code
6273 1.2.3.4:           data for 1.2.3.4
6274 192.168.0.0/16:    data for 192.168.0.0/16
6275 "abcd::cdab":      data for abcd::cdab
6276 "abcd:abcd::/32"   data for abcd:abcd::/32
6277 .endd
6278 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6279 file is searched linearly, using the CIDR masks where present, until a matching
6280 key is found. The first key that matches is used; there is no attempt to find a
6281 &"best"& match. Apart from the way the keys are matched, the processing for
6282 &(iplsearch)& is the same as for &(lsearch)&.
6283
6284 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6285 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6286 lookup types support only literal keys.
6287
6288 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6289 the implicit key is the host's IP address rather than its name (see section
6290 &<<SECThoslispatsikey>>&).
6291 .next
6292 .cindex "linear search"
6293 .cindex "lookup" "lsearch"
6294 .cindex "lsearch lookup type"
6295 .cindex "case sensitivity" "in lsearch lookup"
6296 &(lsearch)&: The given file is a text file that is searched linearly for a
6297 line beginning with the search key, terminated by a colon or white space or the
6298 end of the line. The search is case-insensitive; that is, upper and lower case
6299 letters are treated as the same. The first occurrence of the key that is found
6300 in the file is used.
6301
6302 White space between the key and the colon is permitted. The remainder of the
6303 line, with leading and trailing white space removed, is the data. This can be
6304 continued onto subsequent lines by starting them with any amount of white
6305 space, but only a single space character is included in the data at such a
6306 junction. If the data begins with a colon, the key must be terminated by a
6307 colon, for example:
6308 .code
6309 baduser:  :fail:
6310 .endd
6311 Empty lines and lines beginning with # are ignored, even if they occur in the
6312 middle of an item. This is the traditional textual format of alias files. Note
6313 that the keys in an &(lsearch)& file are literal strings. There is no
6314 wildcarding of any kind.
6315
6316 .cindex "lookup" "lsearch &-- colons in keys"
6317 .cindex "white space" "in lsearch key"
6318 In most &(lsearch)& files, keys are not required to contain colons or #
6319 characters, or white space. However, if you need this feature, it is available.
6320 If a key begins with a doublequote character, it is terminated only by a
6321 matching quote (or end of line), and the normal escaping rules apply to its
6322 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6323 quoted keys (exactly as for unquoted keys). There is no special handling of
6324 quotes for the data part of an &(lsearch)& line.
6325
6326 .next
6327 .cindex "NIS lookup type"
6328 .cindex "lookup" "NIS"
6329 .cindex "binary zero" "in lookup key"
6330 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6331 the given key, without a terminating binary zero. There is a variant called
6332 &(nis0)& which does include the terminating binary zero in the key. This is
6333 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6334 aliases; the full map names must be used.
6335
6336 .next
6337 .cindex "wildlsearch lookup type"
6338 .cindex "lookup" "wildlsearch"
6339 .cindex "nwildlsearch lookup type"
6340 .cindex "lookup" "nwildlsearch"
6341 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6342 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6343 the file may be wildcarded. The difference between these two lookup types is
6344 that for &(wildlsearch)&, each key in the file is string-expanded before being
6345 used, whereas for &(nwildlsearch)&, no expansion takes place.
6346
6347 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6348 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6349 file that are regular expressions can be made case-sensitive by the use of
6350 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6351
6352 . ==== As this is a nested list, any displays it contains must be indented
6353 . ==== as otherwise they are too far to the left.
6354
6355 .olist
6356 The string may begin with an asterisk to mean &"ends with"&. For example:
6357 .code
6358     *.a.b.c       data for anything.a.b.c
6359     *fish         data for anythingfish
6360 .endd
6361 .next
6362 The string may begin with a circumflex to indicate a regular expression. For
6363 example, for &(wildlsearch)&:
6364 .code
6365     ^\N\d+\.a\.b\N    data for <digits>.a.b
6366 .endd
6367 Note the use of &`\N`& to disable expansion of the contents of the regular
6368 expression. If you are using &(nwildlsearch)&, where the keys are not
6369 string-expanded, the equivalent entry is:
6370 .code
6371     ^\d+\.a\.b        data for <digits>.a.b
6372 .endd
6373 The case-insensitive flag is set at the start of compiling the regular
6374 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6375 For example, to make the entire pattern case-sensitive:
6376 .code
6377     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6378 .endd
6379
6380 If the regular expression contains white space or colon characters, you must
6381 either quote it (see &(lsearch)& above), or represent these characters in other
6382 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6383 colon. This may be easier than quoting, because if you quote, you have to
6384 escape all the backslashes inside the quotes.
6385
6386 &*Note*&: It is not possible to capture substrings in a regular expression
6387 match for later use, because the results of all lookups are cached. If a lookup
6388 is repeated, the result is taken from the cache, and no actual pattern matching
6389 takes place. The values of all the numeric variables are unset after a
6390 &((n)wildlsearch)& match.
6391
6392 .next
6393 Although I cannot see it being of much use, the general matching function that
6394 is used to implement &((n)wildlsearch)& means that the string may begin with a
6395 lookup name terminated by a semicolon, and followed by lookup data. For
6396 example:
6397 .code
6398     cdb;/some/file  data for keys that match the file
6399 .endd
6400 The data that is obtained from the nested lookup is discarded.
6401 .endlist olist
6402
6403 Keys that do not match any of these patterns are interpreted literally. The
6404 continuation rules for the data are the same as for &(lsearch)&, and keys may
6405 be followed by optional colons.
6406
6407 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6408 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6409 lookup types support only literal keys.
6410 .endlist ilist
6411
6412
6413 .section "Query-style lookup types" "SECID62"
6414 .cindex "lookup" "query-style types"
6415 .cindex "query-style lookup" "list of types"
6416 The supported query-style lookup types are listed below. Further details about
6417 many of them are given in later sections.
6418
6419 .ilist
6420 .cindex "DNS" "as a lookup type"
6421 .cindex "lookup" "DNS"
6422 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6423 are given in the supplied query. The resulting data is the contents of the
6424 records. See section &<<SECTdnsdb>>&.
6425 .next
6426 .cindex "InterBase lookup type"
6427 .cindex "lookup" "InterBase"
6428 &(ibase)&: This does a lookup in an InterBase database.
6429 .next
6430 .cindex "LDAP" "lookup type"
6431 .cindex "lookup" "LDAP"
6432 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6433 returns attributes from a single entry. There is a variant called &(ldapm)&
6434 that permits values from multiple entries to be returned. A third variant
6435 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6436 any attribute values. See section &<<SECTldap>>&.
6437 .next
6438 .cindex "MySQL" "lookup type"
6439 .cindex "lookup" "MySQL"
6440 &(mysql)&: The format of the query is an SQL statement that is passed to a
6441 MySQL database. See section &<<SECTsql>>&.
6442 .next
6443 .cindex "NIS+ lookup type"
6444 .cindex "lookup" "NIS+"
6445 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6446 the field to be returned. See section &<<SECTnisplus>>&.
6447 .next
6448 .cindex "Oracle" "lookup type"
6449 .cindex "lookup" "Oracle"
6450 &(oracle)&: The format of the query is an SQL statement that is passed to an
6451 Oracle database. See section &<<SECTsql>>&.
6452 .next
6453 .cindex "lookup" "passwd"
6454 .cindex "passwd lookup type"
6455 .cindex "&_/etc/passwd_&"
6456 &(passwd)& is a query-style lookup with queries that are just user names. The
6457 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6458 success, the result string is the same as you would get from an &(lsearch)&
6459 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6460 password value. For example:
6461 .code
6462 *:42:42:King Rat:/home/kr:/bin/bash
6463 .endd
6464 .next
6465 .cindex "PostgreSQL lookup type"
6466 .cindex "lookup" "PostgreSQL"
6467 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6468 PostgreSQL database. See section &<<SECTsql>>&.
6469
6470 .next
6471 .cindex "sqlite lookup type"
6472 .cindex "lookup" "sqlite"
6473 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6474 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6475
6476 .next
6477 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6478 not likely to be useful in normal operation.
6479 .next
6480 .cindex "whoson lookup type"
6481 .cindex "lookup" "whoson"
6482 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6483 allows a server to check whether a particular (dynamically allocated) IP
6484 address is currently allocated to a known (trusted) user and, optionally, to
6485 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6486 at one time for &"POP before SMTP"& authentication, but that approach has been
6487 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6488 &"POP before SMTP"& checking using ACL statements such as
6489 .code
6490 require condition = \
6491   ${lookup whoson {$sender_host_address}{yes}{no}}
6492 .endd
6493 The query consists of a single IP address. The value returned is the name of
6494 the authenticated user, which is stored in the variable &$value$&. However, in
6495 this example, the data in &$value$& is not used; the result of the lookup is
6496 one of the fixed strings &"yes"& or &"no"&.
6497 .endlist
6498
6499
6500
6501 .section "Temporary errors in lookups" "SECID63"
6502 .cindex "lookup" "temporary error in"
6503 Lookup functions can return temporary error codes if the lookup cannot be
6504 completed. For example, an SQL or LDAP database might be unavailable. For this
6505 reason, it is not advisable to use a lookup that might do this for critical
6506 options such as a list of local domains.
6507
6508 When a lookup cannot be completed in a router or transport, delivery
6509 of the message (to the relevant address) is deferred, as for any other
6510 temporary error. In other circumstances Exim may assume the lookup has failed,
6511 or may give up altogether.
6512
6513
6514
6515 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6516 .cindex "wildcard lookups"
6517 .cindex "lookup" "default values"
6518 .cindex "lookup" "wildcard"
6519 .cindex "lookup" "* added to type"
6520 .cindex "default" "in single-key lookups"
6521 In this context, a &"default value"& is a value specified by the administrator
6522 that is to be used if a lookup fails.
6523
6524 &*Note:*& This section applies only to single-key lookups. For query-style
6525 lookups, the facilities of the query language must be used. An attempt to
6526 specify a default for a query-style lookup provokes an error.
6527
6528 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6529 and the initial lookup fails, the key &"*"& is looked up in the file to
6530 provide a default value. See also the section on partial matching below.
6531
6532 .cindex "*@ with single-key lookup"
6533 .cindex "lookup" "*@ added to type"
6534 .cindex "alias file" "per-domain default"
6535 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6536 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6537 character, a second lookup is done with everything before the last @ replaced
6538 by *. This makes it possible to provide per-domain defaults in alias files
6539 that include the domains in the keys. If the second lookup fails (or doesn't
6540 take place because there is no @ in the key), &"*"& is looked up.
6541 For example, a &(redirect)& router might contain:
6542 .code
6543 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6544 .endd
6545 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6546 looks up these keys, in this order:
6547 .code
6548 jane@eyre.example
6549 *@eyre.example
6550 *
6551 .endd
6552 The data is taken from whichever key it finds first. &*Note*&: In an
6553 &(lsearch)& file, this does not mean the first of these keys in the file. A
6554 complete scan is done for each key, and only if it is not found at all does
6555 Exim move on to try the next key.
6556
6557
6558
6559 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6560 .cindex "partial matching"
6561 .cindex "wildcard lookups"
6562 .cindex "lookup" "partial matching"
6563 .cindex "lookup" "wildcard"
6564 .cindex "asterisk" "in search type"
6565 The normal operation of a single-key lookup is to search the file for an exact
6566 match with the given key. However, in a number of situations where domains are
6567 being looked up, it is useful to be able to do partial matching. In this case,
6568 information in the file that has a key starting with &"*."& is matched by any
6569 domain that ends with the components that follow the full stop. For example, if
6570 a key in a DBM file is
6571 .code
6572 *.dates.fict.example
6573 .endd
6574 then when partial matching is enabled this is matched by (amongst others)
6575 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6576 by &'dates.fict.example'&, if that does not appear as a separate key in the
6577 file.
6578
6579 &*Note*&: Partial matching is not available for query-style lookups. It is
6580 also not available for any lookup items in address lists (see section
6581 &<<SECTaddresslist>>&).
6582
6583 Partial matching is implemented by doing a series of separate lookups using
6584 keys constructed by modifying the original subject key. This means that it can
6585 be used with any of the single-key lookup types, provided that
6586 partial matching keys
6587 beginning with a special prefix (default &"*."&) are included in the data file.
6588 Keys in the file that do not begin with the prefix are matched only by
6589 unmodified subject keys when partial matching is in use.
6590
6591 Partial matching is requested by adding the string &"partial-"& to the front of
6592 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6593 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6594 is added at the start of the subject key, and it is looked up again. If that
6595 fails, further lookups are tried with dot-separated components removed from the
6596 start of the subject key, one-by-one, and &"*."& added on the front of what
6597 remains.
6598
6599 A minimum number of two non-* components are required. This can be adjusted
6600 by including a number before the hyphen in the search type. For example,
6601 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6602 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6603 subject key is &'2250.dates.fict.example'& then the following keys are looked
6604 up when the minimum number of non-* components is two:
6605 .code
6606 2250.dates.fict.example
6607 *.2250.dates.fict.example
6608 *.dates.fict.example
6609 *.fict.example
6610 .endd
6611 As soon as one key in the sequence is successfully looked up, the lookup
6612 finishes.
6613
6614 .cindex "lookup" "partial matching &-- changing prefix"
6615 .cindex "prefix" "for partial matching"
6616 The use of &"*."& as the partial matching prefix is a default that can be
6617 changed. The motivation for this feature is to allow Exim to operate with file
6618 formats that are used by other MTAs. A different prefix can be supplied in
6619 parentheses instead of the hyphen after &"partial"&. For example:
6620 .code
6621 domains = partial(.)lsearch;/some/file
6622 .endd
6623 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6624 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6625 components is unchanged). The prefix may consist of any punctuation characters
6626 other than a closing parenthesis. It may be empty, for example:
6627 .code
6628 domains = partial1()cdb;/some/file
6629 .endd
6630 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6631 &`a.b.c`&, &`b.c`&, and &`c`&.
6632
6633 If &"partial0"& is specified, what happens at the end (when the lookup with
6634 just one non-wild component has failed, and the original key is shortened right
6635 down to the null string) depends on the prefix:
6636
6637 .ilist
6638 If the prefix has zero length, the whole lookup fails.
6639 .next
6640 If the prefix has length 1, a lookup for just the prefix is done. For
6641 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6642 .next
6643 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6644 remainder is looked up. With the default prefix, therefore, the final lookup is
6645 for &"*"& on its own.
6646 .next
6647 Otherwise, the whole prefix is looked up.
6648 .endlist
6649
6650
6651 If the search type ends in &"*"& or &"*@"& (see section
6652 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6653 this implies happens after all partial lookups have failed. If &"partial0"& is
6654 specified, adding &"*"& to the search type has no effect with the default
6655 prefix, because the &"*"& key is already included in the sequence of partial
6656 lookups. However, there might be a use for lookup types such as
6657 &"partial0(.)lsearch*"&.
6658
6659 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6660 in domain lists and the like. Partial matching works only in terms of
6661 dot-separated components; a key such as &`*fict.example`&
6662 in a database file is useless, because the asterisk in a partial matching
6663 subject key is always followed by a dot.
6664
6665
6666
6667
6668 .section "Lookup caching" "SECID64"
6669 .cindex "lookup" "caching"
6670 .cindex "caching" "lookup data"
6671 Exim caches all lookup results in order to avoid needless repetition of
6672 lookups. However, because (apart from the daemon) Exim operates as a collection
6673 of independent, short-lived processes, this caching applies only within a
6674 single Exim process. There is no inter-process lookup caching facility.
6675
6676 For single-key lookups, Exim keeps the relevant files open in case there is
6677 another lookup that needs them. In some types of configuration this can lead to
6678 many files being kept open for messages with many recipients. To avoid hitting
6679 the operating system limit on the number of simultaneously open files, Exim
6680 closes the least recently used file when it needs to open more files than its
6681 own internal limit, which can be changed via the &%lookup_open_max%& option.
6682
6683 The single-key lookup files are closed and the lookup caches are flushed at
6684 strategic points during delivery &-- for example, after all routing is
6685 complete.
6686
6687
6688
6689
6690 .section "Quoting lookup data" "SECID65"
6691 .cindex "lookup" "quoting"
6692 .cindex "quoting" "in lookups"
6693 When data from an incoming message is included in a query-style lookup, there
6694 is the possibility of special characters in the data messing up the syntax of
6695 the query. For example, a NIS+ query that contains
6696 .code
6697 [name=$local_part]
6698 .endd
6699 will be broken if the local part happens to contain a closing square bracket.
6700 For NIS+, data can be enclosed in double quotes like this:
6701 .code
6702 [name="$local_part"]
6703 .endd
6704 but this still leaves the problem of a double quote in the data. The rule for
6705 NIS+ is that double quotes must be doubled. Other lookup types have different
6706 rules, and to cope with the differing requirements, an expansion operator
6707 of the following form is provided:
6708 .code
6709 ${quote_<lookup-type>:<string>}
6710 .endd
6711 For example, the safest way to write the NIS+ query is
6712 .code
6713 [name="${quote_nisplus:$local_part}"]
6714 .endd
6715 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6716 operator can be used for all lookup types, but has no effect for single-key
6717 lookups, since no quoting is ever needed in their key strings.
6718
6719
6720
6721
6722 .section "More about dnsdb" "SECTdnsdb"
6723 .cindex "dnsdb lookup"
6724 .cindex "lookup" "dnsdb"
6725 .cindex "DNS" "as a lookup type"
6726 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6727 of a record type and a domain name, separated by an equals sign. For example,
6728 an expansion string could contain:
6729 .code
6730 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6731 .endd
6732 If the lookup succeeds, the result is placed in &$value$&, which in this case
6733 is used on its own as the result. If the lookup does not succeed, the
6734 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6735 &<<SECTforexpfai>>& for an explanation of what this means.
6736
6737 The supported DNS record types are A, CNAME, MX, NS, PTR, SRV, and TXT, and,
6738 when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6739 configured). If no type is given, TXT is assumed. When the type is PTR,
6740 the data can be an IP address, written as normal; inversion and the addition of
6741 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6742 .code
6743 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6744 .endd
6745 If the data for a PTR record is not a syntactically valid IP address, it is not
6746 altered and nothing is added.
6747
6748 .cindex "MX record" "in &(dnsdb)& lookup"
6749 .cindex "SRV record" "in &(dnsdb)& lookup"
6750 For an MX lookup, both the preference value and the host name are returned for
6751 each record, separated by a space. For an SRV lookup, the priority, weight,
6752 port, and host name are returned for each record, separated by spaces.
6753
6754 For any record type, if multiple records are found (or, for A6 lookups, if a
6755 single record leads to multiple addresses), the data is returned as a
6756 concatenation, with newline as the default separator. The order, of course,
6757 depends on the DNS resolver. You can specify a different separator character
6758 between multiple records by putting a right angle-bracket followed immediately
6759 by the new separator at the start of the query. For example:
6760 .code
6761 ${lookup dnsdb{>: a=host1.example}}
6762 .endd
6763 It is permitted to specify a space as the separator character. Further
6764 white space is ignored.
6765
6766 .cindex "TXT record" "in &(dnsdb)& lookup"
6767 For TXT records with multiple items of data, only the first item is returned,
6768 unless a separator for them is specified using a comma after the separator
6769 character followed immediately by the TXT record item separator. To concatenate
6770 items without a separator, use a semicolon instead.
6771 .code
6772 ${lookup dnsdb{>\n,: txt=a.b.example}}
6773 ${lookup dnsdb{>\n; txt=a.b.example}}
6774 .endd
6775 It is permitted to specify a space as the separator character. Further
6776 white space is ignored.
6777
6778 .section "Pseudo dnsdb record types" "SECID66"
6779 .cindex "MX record" "in &(dnsdb)& lookup"
6780 By default, both the preference value and the host name are returned for
6781 each MX record, separated by a space. If you want only host names, you can use
6782 the pseudo-type MXH:
6783 .code
6784 ${lookup dnsdb{mxh=a.b.example}}
6785 .endd
6786 In this case, the preference values are omitted, and just the host names are
6787 returned.
6788
6789 .cindex "name server for enclosing domain"
6790 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6791 records on the given domain, but if none are found, it removes the first
6792 component of the domain name, and tries again. This process continues until NS
6793 records are found or there are no more components left (or there is a DNS
6794 error). In other words, it may return the name servers for a top-level domain,
6795 but it never returns the root name servers. If there are no NS records for the
6796 top-level domain, the lookup fails. Consider these examples:
6797 .code
6798 ${lookup dnsdb{zns=xxx.quercite.com}}
6799 ${lookup dnsdb{zns=xxx.edu}}
6800 .endd
6801 Assuming that in each case there are no NS records for the full domain name,
6802 the first returns the name servers for &%quercite.com%&, and the second returns
6803 the name servers for &%edu%&.
6804
6805 You should be careful about how you use this lookup because, unless the
6806 top-level domain does not exist, the lookup always returns some host names. The
6807 sort of use to which this might be put is for seeing if the name servers for a
6808 given domain are on a blacklist. You can probably assume that the name servers
6809 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6810 such a list.
6811
6812 .cindex "CSA" "in &(dnsdb)& lookup"
6813 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6814 records according to the CSA rules, which are described in section
6815 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6816 not sufficient because of the extra parent domain search behaviour of CSA. The
6817 result of a successful lookup such as:
6818 .code
6819 ${lookup dnsdb {csa=$sender_helo_name}}
6820 .endd
6821 has two space-separated fields: an authorization code and a target host name.
6822 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6823 authorization required but absent, or &"?"& for unknown.
6824
6825
6826 .section "Multiple dnsdb lookups" "SECID67"
6827 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6828 However, you can specify a list of domains or IP addresses in a single
6829 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6830 the default separator, but with the ability to change this. For example:
6831 .code
6832 ${lookup dnsdb{one.domain.com:two.domain.com}}
6833 ${lookup dnsdb{a=one.host.com:two.host.com}}
6834 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6835 .endd
6836 In order to retain backwards compatibility, there is one special case: if
6837 the lookup type is PTR and no change of separator is specified, Exim looks
6838 to see if the rest of the string is precisely one IPv6 address. In this
6839 case, it does not treat it as a list.
6840
6841 The data from each lookup is concatenated, with newline separators by default,
6842 in the same way that multiple DNS records for a single item are handled. A
6843 different separator can be specified, as described above.
6844
6845 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6846 temporary DNS error for any of them, the behaviour is controlled by
6847 an optional keyword followed by a comma that may appear before the record
6848 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6849 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6850 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6851 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6852 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6853 error causes the whole lookup to defer only if none of the other lookups
6854 succeed. The default is &"lax"&, so the following lookups are equivalent:
6855 .code
6856 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6857 ${lookup dnsdb{a=one.host.com:two.host.com}}
6858 .endd
6859 Thus, in the default case, as long as at least one of the DNS lookups
6860 yields some data, the lookup succeeds.
6861
6862
6863
6864
6865 .section "More about LDAP" "SECTldap"
6866 .cindex "LDAP" "lookup, more about"
6867 .cindex "lookup" "LDAP"
6868 .cindex "Solaris" "LDAP"
6869 The original LDAP implementation came from the University of Michigan; this has
6870 become &"Open LDAP"&, and there are now two different releases. Another
6871 implementation comes from Netscape, and Solaris 7 and subsequent releases
6872 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6873 the lookup function level, their error handling is different. For this reason
6874 it is necessary to set a compile-time variable when building Exim with LDAP, to
6875 indicate which LDAP library is in use. One of the following should appear in
6876 your &_Local/Makefile_&:
6877 .code
6878 LDAP_LIB_TYPE=UMICHIGAN
6879 LDAP_LIB_TYPE=OPENLDAP1
6880 LDAP_LIB_TYPE=OPENLDAP2
6881 LDAP_LIB_TYPE=NETSCAPE
6882 LDAP_LIB_TYPE=SOLARIS
6883 .endd
6884 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6885 same interface as the University of Michigan version.
6886
6887 There are three LDAP lookup types in Exim. These behave slightly differently in
6888 the way they handle the results of a query:
6889
6890 .ilist
6891 &(ldap)& requires the result to contain just one entry; if there are more, it
6892 gives an error.
6893 .next
6894 &(ldapdn)& also requires the result to contain just one entry, but it is the
6895 Distinguished Name that is returned rather than any attribute values.
6896 .next
6897 &(ldapm)& permits the result to contain more than one entry; the attributes
6898 from all of them are returned.
6899 .endlist
6900
6901
6902 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6903 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6904 the data returned by a successful lookup is described in the next section.
6905 First we explain how LDAP queries are coded.
6906
6907
6908 .section "Format of LDAP queries" "SECTforldaque"
6909 .cindex "LDAP" "query format"
6910 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6911 the configuration of a &(redirect)& router one might have this setting:
6912 .code
6913 data = ${lookup ldap \
6914   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6915   c=UK?mailbox?base?}}
6916 .endd
6917 .cindex "LDAP" "with TLS"
6918 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6919 secure (encrypted) LDAP connections. The second of these ensures that an
6920 encrypted TLS connection is used.
6921
6922 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
6923 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
6924 See the &%ldap_start_tls%& option.
6925
6926
6927 .section "LDAP quoting" "SECID68"
6928 .cindex "LDAP" "quoting"
6929 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6930 and the second because the LDAP query is represented as a URL. Furthermore,
6931 within an LDAP query, two different kinds of quoting are required. For this
6932 reason, there are two different LDAP-specific quoting operators.
6933
6934 The &%quote_ldap%& operator is designed for use on strings that are part of
6935 filter specifications. Conceptually, it first does the following conversions on
6936 the string:
6937 .code
6938 *   =>   \2A
6939 (   =>   \28
6940 )   =>   \29
6941 \   =>   \5C
6942 .endd
6943 in accordance with RFC 2254. The resulting string is then quoted according
6944 to the rules for URLs, that is, all non-alphanumeric characters except
6945 .code
6946 ! $ ' - . _ ( ) * +
6947 .endd
6948 are converted to their hex values, preceded by a percent sign. For example:
6949 .code
6950 ${quote_ldap: a(bc)*, a<yz>; }
6951 .endd
6952 yields
6953 .code
6954 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6955 .endd
6956 Removing the URL quoting, this is (with a leading and a trailing space):
6957 .code
6958 a\28bc\29\2A, a<yz>;
6959 .endd
6960 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6961 base DN specifications in queries. Conceptually, it first converts the string
6962 by inserting a backslash in front of any of the following characters:
6963 .code
6964 , + " \ < > ;
6965 .endd
6966 It also inserts a backslash before any leading spaces or # characters, and
6967 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6968 is then quoted according to the rules for URLs. For example:
6969 .code
6970 ${quote_ldap_dn: a(bc)*, a<yz>; }
6971 .endd
6972 yields
6973 .code
6974 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
6975 .endd
6976 Removing the URL quoting, this is (with a trailing space):
6977 .code
6978 \ a(bc)*\, a\<yz\>\;\
6979 .endd
6980 There are some further comments about quoting in the section on LDAP
6981 authentication below.
6982
6983
6984 .section "LDAP connections" "SECID69"
6985 .cindex "LDAP" "connections"
6986 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
6987 is in use, via a Unix domain socket. The example given above does not specify
6988 an LDAP server. A server that is reached by TCP/IP can be specified in a query
6989 by starting it with
6990 .code
6991 ldap://<hostname>:<port>/...
6992 .endd
6993 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
6994 used. When no server is specified in a query, a list of default servers is
6995 taken from the &%ldap_default_servers%& configuration option. This supplies a
6996 colon-separated list of servers which are tried in turn until one successfully
6997 handles a query, or there is a serious error. Successful handling either
6998 returns the requested data, or indicates that it does not exist. Serious errors
6999 are syntactical, or multiple values when only a single value is expected.
7000 Errors which cause the next server to be tried are connection failures, bind
7001 failures, and timeouts.
7002
7003 For each server name in the list, a port number can be given. The standard way
7004 of specifying a host and port is to use a colon separator (RFC 1738). Because
7005 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7006 doubled. For example
7007 .code
7008 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7009 .endd
7010 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7011 to the LDAP library with no server name, and the library's default (normally
7012 the local host) is used.
7013
7014 If you are using the OpenLDAP library, you can connect to an LDAP server using
7015 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7016 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7017 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7018 not available.
7019
7020 For this type of connection, instead of a host name for the server, a pathname
7021 for the socket is required, and the port number is not relevant. The pathname
7022 can be specified either as an item in &%ldap_default_servers%&, or inline in
7023 the query. In the former case, you can have settings such as
7024 .code
7025 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7026 .endd
7027 When the pathname is given in the query, you have to escape the slashes as
7028 &`%2F`& to fit in with the LDAP URL syntax. For example:
7029 .code
7030 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7031 .endd
7032 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7033 a pathname, it uses the Unix domain socket code, even if the query actually
7034 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7035 socket connection. This behaviour means that you can use a setting of
7036 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7037 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7038 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7039 backup host.
7040
7041 If an explicit &`ldapi`& type is given in a query when a host name is
7042 specified, an error is diagnosed. However, if there are more items in
7043 &%ldap_default_servers%&, they are tried. In other words:
7044
7045 .ilist
7046 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7047 interface.
7048 .next
7049 Using &`ldapi`& with a host name causes an error.
7050 .endlist
7051
7052
7053 Using &`ldapi`& with no host or path in the query, and no setting of
7054 &%ldap_default_servers%&, does whatever the library does by default.
7055
7056
7057
7058 .section "LDAP authentication and control information" "SECID70"
7059 .cindex "LDAP" "authentication"
7060 The LDAP URL syntax provides no way of passing authentication and other control
7061 information to the server. To make this possible, the URL in an LDAP query may
7062 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7063 spaces. If a value contains spaces it must be enclosed in double quotes, and
7064 when double quotes are used, backslash is interpreted in the usual way inside
7065 them. The following names are recognized:
7066 .display
7067 &`DEREFERENCE`&  set the dereferencing parameter
7068 &`NETTIME    `&  set a timeout for a network operation
7069 &`USER       `&  set the DN, for authenticating the LDAP bind
7070 &`PASS       `&  set the password, likewise
7071 &`REFERRALS  `&  set the referrals parameter
7072 &`SIZE       `&  set the limit for the number of entries returned
7073 &`TIME       `&  set the maximum waiting time for a query
7074 .endd
7075 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7076 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7077 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7078 library from trying to follow referrals issued by the LDAP server.
7079
7080 The name CONNECT is an obsolete name for NETTIME, retained for
7081 backwards compatibility. This timeout (specified as a number of seconds) is
7082 enforced from the client end for operations that can be carried out over a
7083 network. Specifically, it applies to network connections and calls to the
7084 &'ldap_result()'& function. If the value is greater than zero, it is used if
7085 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7086 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7087 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7088 Netscape SDK; for OpenLDAP no action is taken.
7089
7090 The TIME parameter (also a number of seconds) is passed to the server to
7091 set a server-side limit on the time taken to complete a search.
7092
7093
7094 Here is an example of an LDAP query in an Exim lookup that uses some of these
7095 values. This is a single line, folded to fit on the page:
7096 .code
7097 ${lookup ldap
7098   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7099   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7100   {$value}fail}
7101 .endd
7102 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7103 any of the auxiliary data. Exim configuration settings that include lookups
7104 which contain password information should be preceded by &"hide"& to prevent
7105 non-admin users from using the &%-bP%& option to see their values.
7106
7107 The auxiliary data items may be given in any order. The default is no
7108 connection timeout (the system timeout is used), no user or password, no limit
7109 on the number of entries returned, and no time limit on queries.
7110
7111 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7112 removes any URL quoting that it may contain before passing it LDAP. Apparently
7113 some libraries do this for themselves, but some do not. Removing the URL
7114 quoting has two advantages:
7115
7116 .ilist
7117 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7118 DNs as with DNs inside actual queries.
7119 .next
7120 It permits spaces inside USER= DNs.
7121 .endlist
7122
7123 For example, a setting such as
7124 .code
7125 USER=cn=${quote_ldap_dn:$1}
7126 .endd
7127 should work even if &$1$& contains spaces.
7128
7129 Expanded data for the PASS= value should be quoted using the &%quote%&
7130 expansion operator, rather than the LDAP quote operators. The only reason this
7131 field needs quoting is to ensure that it conforms to the Exim syntax, which
7132 does not allow unquoted spaces. For example:
7133 .code
7134 PASS=${quote:$3}
7135 .endd
7136 The LDAP authentication mechanism can be used to check passwords as part of
7137 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7138 &<<CHAPexpand>>&.
7139
7140
7141
7142 .section "Format of data returned by LDAP" "SECID71"
7143 .cindex "LDAP" "returned data formats"
7144 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7145 as a sequence of values, for example
7146 .code
7147 cn=manager, o=University of Cambridge, c=UK
7148 .endd
7149 The &(ldap)& lookup type generates an error if more than one entry matches the
7150 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7151 the result between the data from different entries. It is possible for multiple
7152 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7153 you know that whatever values are returned all came from a single entry in the
7154 directory.
7155
7156 In the common case where you specify a single attribute in your LDAP query, the
7157 result is not quoted, and does not contain the attribute name. If the attribute
7158 has multiple values, they are separated by commas.
7159
7160 If you specify multiple attributes, the result contains space-separated, quoted
7161 strings, each preceded by the attribute name and an equals sign. Within the
7162 quotes, the quote character, backslash, and newline are escaped with
7163 backslashes, and commas are used to separate multiple values for the attribute.
7164 Apart from the escaping, the string within quotes takes the same form as the
7165 output when a single attribute is requested. Specifying no attributes is the
7166 same as specifying all of an entry's attributes.
7167
7168 Here are some examples of the output format. The first line of each pair is an
7169 LDAP query, and the second is the data that is returned. The attribute called
7170 &%attr1%& has two values, whereas &%attr2%& has only one value:
7171 .code
7172 ldap:///o=base?attr1?sub?(uid=fred)
7173 value1.1, value1.2
7174
7175 ldap:///o=base?attr2?sub?(uid=fred)
7176 value two
7177
7178 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7179 attr1="value1.1, value1.2" attr2="value two"
7180
7181 ldap:///o=base??sub?(uid=fred)
7182 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7183 .endd
7184 The &%extract%& operator in string expansions can be used to pick out
7185 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7186 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7187 results of LDAP lookups.
7188
7189
7190
7191
7192 .section "More about NIS+" "SECTnisplus"
7193 .cindex "NIS+ lookup type"
7194 .cindex "lookup" "NIS+"
7195 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7196 and field name. If this is given, the result of a successful query is the
7197 contents of the named field; otherwise the result consists of a concatenation
7198 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7199 values containing spaces are quoted. For example, the query
7200 .code
7201 [name=mg1456],passwd.org_dir
7202 .endd
7203 might return the string
7204 .code
7205 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7206 home=/home/mg1456 shell=/bin/bash shadow=""
7207 .endd
7208 (split over two lines here to fit on the page), whereas
7209 .code
7210 [name=mg1456],passwd.org_dir:gcos
7211 .endd
7212 would just return
7213 .code
7214 Martin Guerre
7215 .endd
7216 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7217 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7218 operator is to double any quote characters within the text.
7219
7220
7221
7222 .section "SQL lookups" "SECTsql"
7223 .cindex "SQL lookup types"
7224 .cindex "MySQL" "lookup type"
7225 .cindex "PostgreSQL lookup type"
7226 .cindex "lookup" "MySQL"
7227 .cindex "lookup" "PostgreSQL"
7228 .cindex "Oracle" "lookup type"
7229 .cindex "lookup" "Oracle"
7230 .cindex "InterBase lookup type"
7231 .cindex "lookup" "InterBase"
7232 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7233 databases. Queries for these databases contain SQL statements, so an example
7234 might be
7235 .code
7236 ${lookup mysql{select mailbox from users where id='userx'}\
7237   {$value}fail}
7238 .endd
7239 If the result of the query contains more than one field, the data for each
7240 field in the row is returned, preceded by its name, so the result of
7241 .code
7242 ${lookup pgsql{select home,name from users where id='userx'}\
7243   {$value}}
7244 .endd
7245 might be
7246 .code
7247 home=/home/userx name="Mister X"
7248 .endd
7249 Empty values and values containing spaces are double quoted, with embedded
7250 quotes escaped by a backslash. If the result of the query contains just one
7251 field, the value is passed back verbatim, without a field name, for example:
7252 .code
7253 Mister X
7254 .endd
7255 If the result of the query yields more than one row, it is all concatenated,
7256 with a newline between the data for each row.
7257
7258
7259 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7260 .cindex "MySQL" "lookup type"
7261 .cindex "PostgreSQL lookup type"
7262 .cindex "lookup" "MySQL"
7263 .cindex "lookup" "PostgreSQL"
7264 .cindex "Oracle" "lookup type"
7265 .cindex "lookup" "Oracle"
7266 .cindex "InterBase lookup type"
7267 .cindex "lookup" "InterBase"
7268 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7269 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7270 option (as appropriate) must be set to a colon-separated list of server
7271 information.
7272 (For MySQL and PostgreSQL only, the global option need not be set if all
7273 queries contain their own server information &-- see section
7274 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7275 items: host name, database name, user name, and password. In the case of
7276 Oracle, the host name field is used for the &"service name"&, and the database
7277 name field is not used and should be empty. For example:
7278 .code
7279 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7280 .endd
7281 Because password data is sensitive, you should always precede the setting with
7282 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7283 option. Here is an example where two MySQL servers are listed:
7284 .code
7285 hide mysql_servers = localhost/users/root/secret:\
7286                      otherhost/users/root/othersecret
7287 .endd
7288 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7289 because this is a colon-separated list, the colon has to be doubled. For each
7290 query, these parameter groups are tried in order until a connection is made and
7291 a query is successfully processed. The result of a query may be that no data is
7292 found, but that is still a successful query. In other words, the list of
7293 servers provides a backup facility, not a list of different places to look.
7294
7295 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7296 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7297 respectively, and the characters single-quote, double-quote, and backslash
7298 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7299 addition, escapes the percent and underscore characters. This cannot be done
7300 for MySQL because these escapes are not recognized in contexts where these
7301 characters are not special.
7302
7303 .section "Specifying the server in the query" "SECTspeserque"
7304 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7305 it is possible to specify a list of servers with an individual query. This is
7306 done by starting the query with
7307 .display
7308 &`servers=`&&'server1:server2:server3:...'&&`;`&
7309 .endd
7310 Each item in the list may take one of two forms:
7311 .olist
7312 If it contains no slashes it is assumed to be just a host name. The appropriate
7313 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7314 of the same name, and the remaining parameters (database, user, password) are
7315 taken from there.
7316 .next
7317 If it contains any slashes, it is taken as a complete parameter set.
7318 .endlist
7319 The list of servers is used in exactly the same way as the global list.
7320 Once a connection to a server has happened and a query has been
7321 successfully executed, processing of the lookup ceases.
7322
7323 This feature is intended for use in master/slave situations where updates
7324 are occurring and you want to update the master rather than a slave. If the
7325 master is in the list as a backup for reading, you might have a global setting
7326 like this:
7327 .code
7328 mysql_servers = slave1/db/name/pw:\
7329                 slave2/db/name/pw:\
7330                 master/db/name/pw
7331 .endd
7332 In an updating lookup, you could then write:
7333 .code
7334 ${lookup mysql{servers=master; UPDATE ...} }
7335 .endd
7336 That query would then be sent only to the master server. If, on the other hand,
7337 the master is not to be used for reading, and so is not present in the global
7338 option, you can still update it by a query of this form:
7339 .code
7340 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7341 .endd
7342
7343
7344 .section "Special MySQL features" "SECID73"
7345 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7346 causes a connection to the server on the local host by means of a Unix domain
7347 socket. An alternate socket can be specified in parentheses. The full syntax of
7348 each item in &%mysql_servers%& is:
7349 .display
7350 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7351   <&'user'&>/<&'password'&>
7352 .endd
7353 Any of the three sub-parts of the first field can be omitted. For normal use on
7354 the local host it can be left blank or set to just &"localhost"&.
7355
7356 No database need be supplied &-- but if it is absent here, it must be given in
7357 the queries.
7358
7359 If a MySQL query is issued that does not request any data (an insert, update,
7360 or delete command), the result of the lookup is the number of rows affected.
7361
7362 &*Warning*&: This can be misleading. If an update does not actually change
7363 anything (for example, setting a field to the value it already has), the result
7364 is zero because no rows are affected.
7365
7366
7367 .section "Special PostgreSQL features" "SECID74"
7368 PostgreSQL lookups can also use Unix domain socket connections to the database.
7369 This is usually faster and costs less CPU time than a TCP/IP connection.
7370 However it can be used only if the mail server runs on the same machine as the
7371 database server. A configuration line for PostgreSQL via Unix domain sockets
7372 looks like this:
7373 .code
7374 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7375 .endd
7376 In other words, instead of supplying a host name, a path to the socket is
7377 given. The path name is enclosed in parentheses so that its slashes aren't
7378 visually confused with the delimiters for the other server parameters.
7379
7380 If a PostgreSQL query is issued that does not request any data (an insert,
7381 update, or delete command), the result of the lookup is the number of rows
7382 affected.
7383
7384 .section "More about SQLite" "SECTsqlite"
7385 .cindex "lookup" "SQLite"
7386 .cindex "sqlite lookup type"
7387 SQLite is different to the other SQL lookups because a file name is required in
7388 addition to the SQL query. An SQLite database is a single file, and there is no
7389 daemon as in the other SQL databases. The interface to Exim requires the name
7390 of the file, as an absolute path, to be given at the start of the query. It is
7391 separated from the query by white space. This means that the path name cannot
7392 contain white space. Here is a lookup expansion example:
7393 .code
7394 ${lookup sqlite {/some/thing/sqlitedb \
7395   select name from aliases where id='userx';}}
7396 .endd
7397 In a list, the syntax is similar. For example:
7398 .code
7399 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7400    select * from relays where ip='$sender_host_address';
7401 .endd
7402 The only character affected by the &%quote_sqlite%& operator is a single
7403 quote, which it doubles.
7404
7405 The SQLite library handles multiple simultaneous accesses to the database
7406 internally. Multiple readers are permitted, but only one process can
7407 update at once. Attempts to access the database while it is being updated
7408 are rejected after a timeout period, during which the SQLite library
7409 waits for the lock to be released. In Exim, the default timeout is set
7410 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7411 option.
7412 .ecindex IIDfidalo1
7413 .ecindex IIDfidalo2
7414
7415
7416 . ////////////////////////////////////////////////////////////////////////////
7417 . ////////////////////////////////////////////////////////////////////////////
7418
7419 .chapter "Domain, host, address, and local part lists" &&&
7420          "CHAPdomhosaddlists" &&&
7421          "Domain, host, and address lists"
7422 .scindex IIDdohoadli "lists of domains; hosts; etc."
7423 A number of Exim configuration options contain lists of domains, hosts,
7424 email addresses, or local parts. For example, the &%hold_domains%& option
7425 contains a list of domains whose delivery is currently suspended. These lists
7426 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7427 arguments to expansion conditions such as &%match_domain%&.
7428
7429 Each item in one of these lists is a pattern to be matched against a domain,
7430 host, email address, or local part, respectively. In the sections below, the
7431 different types of pattern for each case are described, but first we cover some
7432 general facilities that apply to all four kinds of list.
7433
7434
7435
7436 .section "Expansion of lists" "SECID75"
7437 .cindex "expansion" "of lists"
7438 Each list is expanded as a single string before it is used. The result of
7439 expansion must be a list, possibly containing empty items, which is split up
7440 into separate items for matching. By default, colon is the separator character,
7441 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7442 &<<SECTempitelis>>& for details of the list syntax; the second of these
7443 discusses the way to specify empty list items.
7444
7445
7446 If the string expansion is forced to fail, Exim behaves as if the item it is
7447 testing (domain, host, address, or local part) is not in the list. Other
7448 expansion failures cause temporary errors.
7449
7450 If an item in a list is a regular expression, backslashes, dollars and possibly
7451 other special characters in the expression must be protected against
7452 misinterpretation by the string expander. The easiest way to do this is to use
7453 the &`\N`& expansion feature to indicate that the contents of the regular
7454 expression should not be expanded. For example, in an ACL you might have:
7455 .code
7456 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7457                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7458 .endd
7459 The first item is a regular expression that is protected from expansion by
7460 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7461 senders based on the receiving domain.
7462
7463
7464
7465
7466 .section "Negated items in lists" "SECID76"
7467 .cindex "list" "negation"
7468 .cindex "negation" "in lists"
7469 Items in a list may be positive or negative. Negative items are indicated by a
7470 leading exclamation mark, which may be followed by optional white space. A list
7471 defines a set of items (domains, etc). When Exim processes one of these lists,
7472 it is trying to find out whether a domain, host, address, or local part
7473 (respectively) is in the set that is defined by the list. It works like this:
7474
7475 The list is scanned from left to right. If a positive item is matched, the
7476 subject that is being checked is in the set; if a negative item is matched, the
7477 subject is not in the set. If the end of the list is reached without the
7478 subject having matched any of the patterns, it is in the set if the last item
7479 was a negative one, but not if it was a positive one. For example, the list in
7480 .code
7481 domainlist relay_domains = !a.b.c : *.b.c
7482 .endd
7483 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7484 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7485 list is positive. However, if the setting were
7486 .code
7487 domainlist relay_domains = !a.b.c
7488 .endd
7489 then all domains other than &'a.b.c'& would match because the last item in the
7490 list is negative. In other words, a list that ends with a negative item behaves
7491 as if it had an extra item &`:*`& on the end.
7492
7493 Another way of thinking about positive and negative items in lists is to read
7494 the connector as &"or"& after a positive item and as &"and"& after a negative
7495 item.
7496
7497
7498
7499 .section "File names in lists" "SECTfilnamlis"
7500 .cindex "list" "file name in"
7501 If an item in a domain, host, address, or local part list is an absolute file
7502 name (beginning with a slash character), each line of the file is read and
7503 processed as if it were an independent item in the list, except that further
7504 file names are not allowed,
7505 and no expansion of the data from the file takes place.
7506 Empty lines in the file are ignored, and the file may also contain comment
7507 lines:
7508
7509 .ilist
7510 For domain and host lists, if a # character appears anywhere in a line of the
7511 file, it and all following characters are ignored.
7512 .next
7513 Because local parts may legitimately contain # characters, a comment in an
7514 address list or local part list file is recognized only if # is preceded by
7515 white space or the start of the line. For example:
7516 .code
7517 not#comment@x.y.z   # but this is a comment
7518 .endd
7519 .endlist
7520
7521 Putting a file name in a list has the same effect as inserting each line of the
7522 file as an item in the list (blank lines and comments excepted). However, there
7523 is one important difference: the file is read each time the list is processed,
7524 so if its contents vary over time, Exim's behaviour changes.
7525
7526 If a file name is preceded by an exclamation mark, the sense of any match
7527 within the file is inverted. For example, if
7528 .code
7529 hold_domains = !/etc/nohold-domains
7530 .endd
7531 and the file contains the lines
7532 .code
7533 !a.b.c
7534 *.b.c
7535 .endd
7536 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7537 any domain matching &`*.b.c`& is not.
7538
7539
7540
7541 .section "An lsearch file is not an out-of-line list" "SECID77"
7542 As will be described in the sections that follow, lookups can be used in lists
7543 to provide indexed methods of checking list membership. There has been some
7544 confusion about the way &(lsearch)& lookups work in lists. Because
7545 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7546 sometimes thought that it is allowed to contain wild cards and other kinds of
7547 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7548 always fixed strings, just as for any other single-key lookup type.
7549
7550 If you want to use a file to contain wild-card patterns that form part of a
7551 list, just give the file name on its own, without a search type, as described
7552 in the previous section. You could also use the &(wildlsearch)& or
7553 &(nwildlsearch)&, but there is no advantage in doing this.
7554
7555
7556
7557
7558 .section "Named lists" "SECTnamedlists"
7559 .cindex "named lists"
7560 .cindex "list" "named"
7561 A list of domains, hosts, email addresses, or local parts can be given a name
7562 which is then used to refer to the list elsewhere in the configuration. This is
7563 particularly convenient if the same list is required in several different
7564 places. It also allows lists to be given meaningful names, which can improve
7565 the readability of the configuration. For example, it is conventional to define
7566 a domain list called &'local_domains'& for all the domains that are handled
7567 locally on a host, using a configuration line such as
7568 .code
7569 domainlist local_domains = localhost:my.dom.example
7570 .endd
7571 Named lists are referenced by giving their name preceded by a plus sign, so,
7572 for example, a router that is intended to handle local domains would be
7573 configured with the line
7574 .code
7575 domains = +local_domains
7576 .endd
7577 The first router in a configuration is often one that handles all domains
7578 except the local ones, using a configuration with a negated item like this:
7579 .code
7580 dnslookup:
7581   driver = dnslookup
7582   domains = ! +local_domains
7583   transport = remote_smtp
7584   no_more
7585 .endd
7586 The four kinds of named list are created by configuration lines starting with
7587 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7588 respectively. Then there follows the name that you are defining, followed by an
7589 equals sign and the list itself. For example:
7590 .code
7591 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7592 addresslist bad_senders = cdb;/etc/badsenders
7593 .endd
7594 A named list may refer to other named lists:
7595 .code
7596 domainlist  dom1 = first.example : second.example
7597 domainlist  dom2 = +dom1 : third.example
7598 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7599 .endd
7600 &*Warning*&: If the last item in a referenced list is a negative one, the
7601 effect may not be what you intended, because the negation does not propagate
7602 out to the higher level. For example, consider:
7603 .code
7604 domainlist  dom1 = !a.b
7605 domainlist  dom2 = +dom1 : *.b
7606 .endd
7607 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7608 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7609 means it matches the second list as well. The effect is not the same as
7610 .code
7611 domainlist  dom2 = !a.b : *.b
7612 .endd
7613 where &'x.y'& does not match. It's best to avoid negation altogether in
7614 referenced lists if you can.
7615
7616 Named lists may have a performance advantage. When Exim is routing an
7617 address or checking an incoming message, it caches the result of tests on named
7618 lists. So, if you have a setting such as
7619 .code
7620 domains = +local_domains
7621 .endd
7622 on several of your routers
7623 or in several ACL statements,
7624 the actual test is done only for the first one. However, the caching works only
7625 if there are no expansions within the list itself or any sublists that it
7626 references. In other words, caching happens only for lists that are known to be
7627 the same each time they are referenced.
7628
7629 By default, there may be up to 16 named lists of each type. This limit can be
7630 extended by changing a compile-time variable. The use of domain and host lists
7631 is recommended for concepts such as local domains, relay domains, and relay
7632 hosts. The default configuration is set up like this.
7633
7634
7635
7636 .section "Named lists compared with macros" "SECID78"
7637 .cindex "list" "named compared with macro"
7638 .cindex "macro" "compared with named list"
7639 At first sight, named lists might seem to be no different from macros in the
7640 configuration file. However, macros are just textual substitutions. If you
7641 write
7642 .code
7643 ALIST = host1 : host2
7644 auth_advertise_hosts = !ALIST
7645 .endd
7646 it probably won't do what you want, because that is exactly the same as
7647 .code
7648 auth_advertise_hosts = !host1 : host2
7649 .endd
7650 Notice that the second host name is not negated. However, if you use a host
7651 list, and write
7652 .code
7653 hostlist alist = host1 : host2
7654 auth_advertise_hosts = ! +alist
7655 .endd
7656 the negation applies to the whole list, and so that is equivalent to
7657 .code
7658 auth_advertise_hosts = !host1 : !host2
7659 .endd
7660
7661
7662 .section "Named list caching" "SECID79"
7663 .cindex "list" "caching of named"
7664 .cindex "caching" "named lists"
7665 While processing a message, Exim caches the result of checking a named list if
7666 it is sure that the list is the same each time. In practice, this means that
7667 the cache operates only if the list contains no $ characters, which guarantees
7668 that it will not change when it is expanded. Sometimes, however, you may have
7669 an expanded list that you know will be the same each time within a given
7670 message. For example:
7671 .code
7672 domainlist special_domains = \
7673            ${lookup{$sender_host_address}cdb{/some/file}}
7674 .endd
7675 This provides a list of domains that depends only on the sending host's IP
7676 address. If this domain list is referenced a number of times (for example,
7677 in several ACL lines, or in several routers) the result of the check is not
7678 cached by default, because Exim does not know that it is going to be the
7679 same list each time.
7680
7681 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7682 cache the result anyway. For example:
7683 .code
7684 domainlist_cache special_domains = ${lookup{...
7685 .endd
7686 If you do this, you should be absolutely sure that caching is going to do
7687 the right thing in all cases. When in doubt, leave it out.
7688
7689
7690
7691 .section "Domain lists" "SECTdomainlist"
7692 .cindex "domain list" "patterns for"
7693 .cindex "list" "domain list"
7694 Domain lists contain patterns that are to be matched against a mail domain.
7695 The following types of item may appear in domain lists:
7696
7697 .ilist
7698 .cindex "primary host name"
7699 .cindex "host name" "matched in domain list"
7700 .oindex "&%primary_hostname%&"
7701 .cindex "domain list" "matching primary host name"
7702 .cindex "@ in a domain list"
7703 If a pattern consists of a single @ character, it matches the local host name,
7704 as set by the &%primary_hostname%& option (or defaulted). This makes it
7705 possible to use the same configuration file on several different hosts that
7706 differ only in their names.
7707 .next
7708 .cindex "@[] in a domain list"
7709 .cindex "domain list" "matching local IP interfaces"
7710 .cindex "domain literal"
7711 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7712 in square brackets (as in an email address that contains a domain literal), but
7713 only if that IP address is recognized as local for email routing purposes. The
7714 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7715 control which of a host's several IP addresses are treated as local.
7716 In today's Internet, the use of domain literals is controversial.
7717 .next
7718 .cindex "@mx_any"
7719 .cindex "@mx_primary"
7720 .cindex "@mx_secondary"
7721 .cindex "domain list" "matching MX pointers to local host"
7722 If a pattern consists of the string &`@mx_any`& it matches any domain that
7723 has an MX record pointing to the local host or to any host that is listed in
7724 .oindex "&%hosts_treat_as_local%&"
7725 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7726 are similar, except that the first matches only when a primary MX target is the
7727 local host, and the second only when no primary MX target is the local host,
7728 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7729 preference value &-- there may of course be more than one of them.
7730
7731 The MX lookup that takes place when matching a pattern of this type is
7732 performed with the resolver options for widening names turned off. Thus, for
7733 example, a single-component domain will &'not'& be expanded by adding the
7734 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7735 options of the &(dnslookup)& router for a discussion of domain widening.
7736
7737 Sometimes you may want to ignore certain IP addresses when using one of these
7738 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7739 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7740 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7741 on a router). For example:
7742 .code
7743 domains = @mx_any/ignore=127.0.0.1
7744 .endd
7745 This example matches any domain that has an MX record pointing to one of
7746 the local host's IP addresses other than 127.0.0.1.
7747
7748 The list of IP addresses is in fact processed by the same code that processes
7749 host lists, so it may contain CIDR-coded network specifications and it may also
7750 contain negative items.
7751
7752 Because the list of IP addresses is a sublist within a domain list, you have to
7753 be careful about delimiters if there is more than one address. Like any other
7754 list, the default delimiter can be changed. Thus, you might have:
7755 .code
7756 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7757           an.other.domain : ...
7758 .endd
7759 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7760 involved, it is easiest to change the delimiter for the main list as well:
7761 .code
7762 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7763           an.other.domain ? ...
7764 .endd
7765 .next
7766 .cindex "asterisk" "in domain list"
7767 .cindex "domain list" "asterisk in"
7768 .cindex "domain list" "matching &""ends with""&"
7769 If a pattern starts with an asterisk, the remaining characters of the pattern
7770 are compared with the terminating characters of the domain. The use of &"*"& in
7771 domain lists differs from its use in partial matching lookups. In a domain
7772 list, the character following the asterisk need not be a dot, whereas partial
7773 matching works only in terms of dot-separated components. For example, a domain
7774 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7775 &'cipher.key.ex'&.
7776
7777 .next
7778 .cindex "regular expressions" "in domain list"
7779 .cindex "domain list" "matching regular expression"
7780 If a pattern starts with a circumflex character, it is treated as a regular
7781 expression, and matched against the domain using a regular expression matching
7782 function. The circumflex is treated as part of the regular expression.
7783 Email domains are case-independent, so this regular expression match is by
7784 default case-independent, but you can make it case-dependent by starting it
7785 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7786 are given in chapter &<<CHAPregexp>>&.
7787
7788 &*Warning*&: Because domain lists are expanded before being processed, you
7789 must escape any backslash and dollar characters in the regular expression, or
7790 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7791 it is not to be expanded (unless you really do want to build a regular
7792 expression by expansion, of course).
7793 .next
7794 .cindex "lookup" "in domain list"
7795 .cindex "domain list" "matching by lookup"
7796 If a pattern starts with the name of a single-key lookup type followed by a
7797 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7798 must be a file name in a suitable format for the lookup type. For example, for
7799 &"cdb;"& it must be an absolute path:
7800 .code
7801 domains = cdb;/etc/mail/local_domains.cdb
7802 .endd
7803 The appropriate type of lookup is done on the file using the domain name as the
7804 key. In most cases, the data that is looked up is not used; Exim is interested
7805 only in whether or not the key is present in the file. However, when a lookup
7806 is used for the &%domains%& option on a router
7807 or a &%domains%& condition in an ACL statement, the data is preserved in the
7808 &$domain_data$& variable and can be referred to in other router options or
7809 other statements in the same ACL.
7810
7811 .next
7812 Any of the single-key lookup type names may be preceded by
7813 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7814 .code
7815 domains = partial-dbm;/partial/domains
7816 .endd
7817 This causes partial matching logic to be invoked; a description of how this
7818 works is given in section &<<SECTpartiallookup>>&.
7819
7820 .next
7821 .cindex "asterisk" "in lookup type"
7822 Any of the single-key lookup types may be followed by an asterisk. This causes
7823 a default lookup for a key consisting of a single asterisk to be done if the
7824 original lookup fails. This is not a useful feature when using a domain list to
7825 select particular domains (because any domain would match), but it might have
7826 value if the result of the lookup is being used via the &$domain_data$&
7827 expansion variable.
7828 .next
7829 If the pattern starts with the name of a query-style lookup type followed by a
7830 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7831 pattern must be an appropriate query for the lookup type, as described in
7832 chapter &<<CHAPfdlookup>>&. For example:
7833 .code
7834 hold_domains = mysql;select domain from holdlist \
7835   where domain = '${quote_mysql:$domain}';
7836 .endd
7837 In most cases, the data that is looked up is not used (so for an SQL query, for
7838 example, it doesn't matter what field you select). Exim is interested only in
7839 whether or not the query succeeds. However, when a lookup is used for the
7840 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7841 variable and can be referred to in other options.
7842 .next
7843 .cindex "domain list" "matching literal domain name"
7844 If none of the above cases apply, a caseless textual comparison is made
7845 between the pattern and the domain.
7846 .endlist
7847
7848 Here is an example that uses several different kinds of pattern:
7849 .code
7850 domainlist funny_domains = \
7851   @ : \
7852   lib.unseen.edu : \
7853   *.foundation.fict.example : \
7854   \N^[1-2]\d{3}\.fict\.example$\N : \
7855   partial-dbm;/opt/data/penguin/book : \
7856   nis;domains.byname : \
7857   nisplus;[name=$domain,status=local],domains.org_dir
7858 .endd
7859 There are obvious processing trade-offs among the various matching modes. Using
7860 an asterisk is faster than a regular expression, and listing a few names
7861 explicitly probably is too. The use of a file or database lookup is expensive,
7862 but may be the only option if hundreds of names are required. Because the
7863 patterns are tested in order, it makes sense to put the most commonly matched
7864 patterns earlier.
7865
7866
7867
7868 .section "Host lists" "SECThostlist"
7869 .cindex "host list" "patterns in"
7870 .cindex "list" "host list"
7871 Host lists are used to control what remote hosts are allowed to do. For
7872 example, some hosts may be allowed to use the local host as a relay, and some
7873 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7874 two different ways, by name or by IP address. In a host list, some types of
7875 pattern are matched to a host name, and some are matched to an IP address.
7876 You need to be particularly careful with this when single-key lookups are
7877 involved, to ensure that the right value is being used as the key.
7878
7879
7880 .section "Special host list patterns" "SECID80"
7881 .cindex "empty item in hosts list"
7882 .cindex "host list" "empty string in"
7883 If a host list item is the empty string, it matches only when no remote host is
7884 involved. This is the case when a message is being received from a local
7885 process using SMTP on the standard input, that is, when a TCP/IP connection is
7886 not used.
7887
7888 .cindex "asterisk" "in host list"
7889 The special pattern &"*"& in a host list matches any host or no host. Neither
7890 the IP address nor the name is actually inspected.
7891
7892
7893
7894 .section "Host list patterns that match by IP address" "SECThoslispatip"
7895 .cindex "host list" "matching IP addresses"
7896 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7897 the incoming address actually appears in the IPv6 host as
7898 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7899 list, it is converted into a traditional IPv4 address first. (Not all operating
7900 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7901 concerns.)
7902
7903 The following types of pattern in a host list check the remote host by
7904 inspecting its IP address:
7905
7906 .ilist
7907 If the pattern is a plain domain name (not a regular expression, not starting
7908 with *, not a lookup of any kind), Exim calls the operating system function
7909 to find the associated IP address(es). Exim uses the newer
7910 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7911 This typically causes a forward DNS lookup of the name. The result is compared
7912 with the IP address of the subject host.
7913
7914 If there is a temporary problem (such as a DNS timeout) with the host name
7915 lookup, a temporary error occurs. For example, if the list is being used in an
7916 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7917 temporary SMTP error code. If no IP address can be found for the host name,
7918 what happens is described in section &<<SECTbehipnot>>& below.
7919
7920 .next
7921 .cindex "@ in a host list"
7922 If the pattern is &"@"&, the primary host name is substituted and used as a
7923 domain name, as just described.
7924
7925 .next
7926 If the pattern is an IP address, it is matched against the IP address of the
7927 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7928 IPv6 addresses can be given in colon-separated format, but the colons have to
7929 be doubled so as not to be taken as item separators when the default list
7930 separator is used. IPv6 addresses are recognized even when Exim is compiled
7931 without IPv6 support. This means that if they appear in a host list on an
7932 IPv4-only host, Exim will not treat them as host names. They are just addresses
7933 that can never match a client host.
7934
7935 .next
7936 .cindex "@[] in a host list"
7937 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7938 the local host. For example, if the local host is an IPv4 host with one
7939 interface address 10.45.23.56, these two ACL statements have the same effect:
7940 .code
7941 accept hosts = 127.0.0.1 : 10.45.23.56
7942 accept hosts = @[]
7943 .endd
7944 .next
7945 .cindex "CIDR notation"
7946 If the pattern is an IP address followed by a slash and a mask length (for
7947 example 10.11.42.0/24), it is matched against the IP address of the subject
7948 host under the given mask. This allows, an entire network of hosts to be
7949 included (or excluded) by a single item. The mask uses CIDR notation; it
7950 specifies the number of address bits that must match, starting from the most
7951 significant end of the address.
7952
7953 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7954 of a range of addresses. It is the number of bits in the network portion of the
7955 address. The above example specifies a 24-bit netmask, so it matches all 256
7956 addresses in the 10.11.42.0 network. An item such as
7957 .code
7958 192.168.23.236/31
7959 .endd
7960 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7961 32 for an IPv4 address is the same as no mask at all; just a single address
7962 matches.
7963
7964 Here is another example which shows an IPv4 and an IPv6 network:
7965 .code
7966 recipient_unqualified_hosts = 192.168.0.0/16: \
7967                               3ffe::ffff::836f::::/48
7968 .endd
7969 The doubling of list separator characters applies only when these items
7970 appear inline in a host list. It is not required when indirecting via a file.
7971 For example:
7972 .code
7973 recipient_unqualified_hosts = /opt/exim/unqualnets
7974 .endd
7975 could make use of a file containing
7976 .code
7977 172.16.0.0/12
7978 3ffe:ffff:836f::/48
7979 .endd
7980 to have exactly the same effect as the previous example. When listing IPv6
7981 addresses inline, it is usually more convenient to use the facility for
7982 changing separator characters. This list contains the same two networks:
7983 .code
7984 recipient_unqualified_hosts = <; 172.16.0.0/12; \
7985                                  3ffe:ffff:836f::/48
7986 .endd
7987 The separator is changed to semicolon by the leading &"<;"& at the start of the
7988 list.
7989 .endlist
7990
7991
7992
7993 .section "Host list patterns for single-key lookups by host address" &&&
7994          "SECThoslispatsikey"
7995 .cindex "host list" "lookup of IP address"
7996 When a host is to be identified by a single-key lookup of its complete IP
7997 address, the pattern takes this form:
7998 .display
7999 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8000 .endd
8001 For example:
8002 .code
8003 hosts_lookup = net-cdb;/hosts-by-ip.db
8004 .endd
8005 The text form of the IP address of the subject host is used as the lookup key.
8006 IPv6 addresses are converted to an unabbreviated form, using lower case
8007 letters, with dots as separators because colon is the key terminator in
8008 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8009 quoting the keys, but this is a facility that was added later.] The data
8010 returned by the lookup is not used.
8011
8012 .cindex "IP address" "masking"
8013 .cindex "host list" "masked IP address"
8014 Single-key lookups can also be performed using masked IP addresses, using
8015 patterns of this form:
8016 .display
8017 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8018 .endd
8019 For example:
8020 .code
8021 net24-dbm;/networks.db
8022 .endd
8023 The IP address of the subject host is masked using <&'number'&> as the mask
8024 length. A textual string is constructed from the masked value, followed by the
8025 mask, and this is used as the lookup key. For example, if the host's IP address
8026 is 192.168.34.6, the key that is looked up for the above example is
8027 &"192.168.34.0/24"&.
8028
8029 When an IPv6 address is converted to a string, dots are normally used instead
8030 of colons, so that keys in &(lsearch)& files need not contain colons (which
8031 terminate &(lsearch)& keys). This was implemented some time before the ability
8032 to quote keys was made available in &(lsearch)& files. However, the more
8033 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8034 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8035 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8036 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8037 addresses are always used.
8038
8039 Ideally, it would be nice to tidy up this anomalous situation by changing to
8040 colons in all cases, given that quoting is now available for &(lsearch)&.
8041 However, this would be an incompatible change that might break some existing
8042 configurations.
8043
8044 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8045 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8046 the former case the key strings include the mask value, whereas in the latter
8047 case the IP address is used on its own.
8048
8049
8050
8051 .section "Host list patterns that match by host name" "SECThoslispatnam"
8052 .cindex "host" "lookup failures"
8053 .cindex "unknown host name"
8054 .cindex "host list" "matching host name"
8055 There are several types of pattern that require Exim to know the name of the
8056 remote host. These are either wildcard patterns or lookups by name. (If a
8057 complete hostname is given without any wildcarding, it is used to find an IP
8058 address to match against, as described in the section &<<SECThoslispatip>>&
8059 above.)
8060
8061 If the remote host name is not already known when Exim encounters one of these
8062 patterns, it has to be found from the IP address.
8063 Although many sites on the Internet are conscientious about maintaining reverse
8064 DNS data for their hosts, there are also many that do not do this.
8065 Consequently, a name cannot always be found, and this may lead to unwanted
8066 effects. Take care when configuring host lists with wildcarded name patterns.
8067 Consider what will happen if a name cannot be found.
8068
8069 Because of the problems of determining host names from IP addresses, matching
8070 against host names is not as common as matching against IP addresses.
8071
8072 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8073 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8074 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8075 are done can be changed by setting the &%host_lookup_order%& option. For
8076 security, once Exim has found one or more names, it looks up the IP addresses
8077 for these names and compares them with the IP address that it started with.
8078 Only those names whose IP addresses match are accepted. Any other names are
8079 discarded. If no names are left, Exim behaves as if the host name cannot be
8080 found. In the most common case there is only one name and one IP address.
8081
8082 There are some options that control what happens if a host name cannot be
8083 found. These are described in section &<<SECTbehipnot>>& below.
8084
8085 .cindex "host" "alias for"
8086 .cindex "alias for host"
8087 As a result of aliasing, hosts may have more than one name. When processing any
8088 of the following types of pattern, all the host's names are checked:
8089
8090 .ilist
8091 .cindex "asterisk" "in host list"
8092 If a pattern starts with &"*"& the remainder of the item must match the end of
8093 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8094 &'.b.c'&. This special simple form is provided because this is a very common
8095 requirement. Other kinds of wildcarding require the use of a regular
8096 expression.
8097 .next
8098 .cindex "regular expressions" "in host list"
8099 .cindex "host list" "regular expression in"
8100 If the item starts with &"^"& it is taken to be a regular expression which is
8101 matched against the host name. Host names are case-independent, so this regular
8102 expression match is by default case-independent, but you can make it
8103 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8104 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8105 example,
8106 .code
8107 ^(a|b)\.c\.d$
8108 .endd
8109 is a regular expression that matches either of the two hosts &'a.c.d'& or
8110 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8111 that backslash and dollar characters are not misinterpreted as part of the
8112 string expansion. The simplest way to do this is to use &`\N`& to mark that
8113 part of the string as non-expandable. For example:
8114 .code
8115 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8116 .endd
8117 &*Warning*&: If you want to match a complete host name, you must include the
8118 &`$`& terminating metacharacter in the regular expression, as in the above
8119 example. Without it, a match at the start of the host name is all that is
8120 required.
8121 .endlist
8122
8123
8124
8125
8126 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8127 .cindex "host" "lookup failures, permanent"
8128 While processing a host list, Exim may need to look up an IP address from a
8129 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8130 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8131 behaviour when it fails to find the information it is seeking is the same.
8132
8133 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8134 apply to temporary DNS errors, whose handling is described in the next section.
8135
8136 .cindex "&`+include_unknown`&"
8137 .cindex "&`+ignore_unknown`&"
8138 By default, Exim behaves as if the host does not match the list. This may not
8139 always be what you want to happen. To change Exim's behaviour, the special
8140 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8141 top level &-- they are not recognized in an indirected file).
8142
8143 .ilist
8144 If any item that follows &`+include_unknown`& requires information that
8145 cannot found, Exim behaves as if the host does match the list. For example,
8146 .code
8147 host_reject_connection = +include_unknown:*.enemy.ex
8148 .endd
8149 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8150 any hosts whose name it cannot find.
8151
8152 .next
8153 If any item that follows &`+ignore_unknown`& requires information that cannot
8154 be found, Exim ignores that item and proceeds to the rest of the list. For
8155 example:
8156 .code
8157 accept hosts = +ignore_unknown : friend.example : \
8158                192.168.4.5
8159 .endd
8160 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8161 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8162 name can be found for 192.168.4.5, it is rejected.
8163 .endlist
8164
8165 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8166 list. The effect of each one lasts until the next, or until the end of the
8167 list.
8168
8169
8170 .section "Temporary DNS errors when looking up host information" &&&
8171          "SECTtemdnserr"
8172 .cindex "host" "lookup failures, temporary"
8173 .cindex "&`+include_defer`&"
8174 .cindex "&`+ignore_defer`&"
8175 A temporary DNS lookup failure normally causes a defer action (except when
8176 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8177 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8178 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8179 section. These options should be used with care, probably only in non-critical
8180 host lists such as whitelists.
8181
8182
8183
8184 .section "Host list patterns for single-key lookups by host name" &&&
8185          "SECThoslispatnamsk"
8186 .cindex "unknown host name"
8187 .cindex "host list" "matching host name"
8188 If a pattern is of the form
8189 .display
8190 <&'single-key-search-type'&>;<&'search-data'&>
8191 .endd
8192 for example
8193 .code
8194 dbm;/host/accept/list
8195 .endd
8196 a single-key lookup is performed, using the host name as its key. If the
8197 lookup succeeds, the host matches the item. The actual data that is looked up
8198 is not used.
8199
8200 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8201 keys in the file, not IP addresses. If you want to do lookups based on IP
8202 addresses, you must precede the search type with &"net-"& (see section
8203 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8204 two items in the same list, one doing an address lookup and one doing a name
8205 lookup, both using the same file.
8206
8207
8208
8209 .section "Host list patterns for query-style lookups" "SECID81"
8210 If a pattern is of the form
8211 .display
8212 <&'query-style-search-type'&>;<&'query'&>
8213 .endd
8214 the query is obeyed, and if it succeeds, the host matches the item. The actual
8215 data that is looked up is not used. The variables &$sender_host_address$& and
8216 &$sender_host_name$& can be used in the query. For example:
8217 .code
8218 hosts_lookup = pgsql;\
8219   select ip from hostlist where ip='$sender_host_address'
8220 .endd
8221 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8222 can use the &%sg%& expansion item to change this if you need to. If you want to
8223 use masked IP addresses in database queries, you can use the &%mask%& expansion
8224 operator.
8225
8226 If the query contains a reference to &$sender_host_name$&, Exim automatically
8227 looks up the host name if has not already done so. (See section
8228 &<<SECThoslispatnam>>& for comments on finding host names.)
8229
8230 Historical note: prior to release 4.30, Exim would always attempt to find a
8231 host name before running the query, unless the search type was preceded by
8232 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8233 still recognized for query-style lookups, but its presence or absence has no
8234 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8235 See section &<<SECThoslispatsikey>>&.)
8236
8237
8238
8239 .section "Mixing wildcarded host names and addresses in host lists" &&&
8240          "SECTmixwilhos"
8241 .cindex "host list" "mixing names and addresses in"
8242 If you have name lookups or wildcarded host names and IP addresses in the same
8243 host list, you should normally put the IP addresses first. For example, in an
8244 ACL you could have:
8245 .code
8246 accept hosts = 10.9.8.7 : *.friend.example
8247 .endd
8248 The reason for this lies in the left-to-right way that Exim processes lists.
8249 It can test IP addresses without doing any DNS lookups, but when it reaches an
8250 item that requires a host name, it fails if it cannot find a host name to
8251 compare with the pattern. If the above list is given in the opposite order, the
8252 &%accept%& statement fails for a host whose name cannot be found, even if its
8253 IP address is 10.9.8.7.
8254
8255 If you really do want to do the name check first, and still recognize the IP
8256 address, you can rewrite the ACL like this:
8257 .code
8258 accept hosts = *.friend.example
8259 accept hosts = 10.9.8.7
8260 .endd
8261 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8262 &<<CHAPACL>>& for details of ACLs.
8263
8264
8265
8266
8267
8268 .section "Address lists" "SECTaddresslist"
8269 .cindex "list" "address list"
8270 .cindex "address list" "empty item"
8271 .cindex "address list" "patterns"
8272 Address lists contain patterns that are matched against mail addresses. There
8273 is one special case to be considered: the sender address of a bounce message is
8274 always empty. You can test for this by providing an empty item in an address
8275 list. For example, you can set up a router to process bounce messages by
8276 using this option setting:
8277 .code
8278 senders = :
8279 .endd
8280 The presence of the colon creates an empty item. If you do not provide any
8281 data, the list is empty and matches nothing. The empty sender can also be
8282 detected by a regular expression that matches an empty string,
8283 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8284
8285 Non-empty items in an address list can be straightforward email addresses. For
8286 example:
8287 .code
8288 senders = jbc@askone.example : hs@anacreon.example
8289 .endd
8290 A certain amount of wildcarding is permitted. If a pattern contains an @
8291 character, but is not a regular expression and does not begin with a
8292 semicolon-terminated lookup type (described below), the local part of the
8293 subject address is compared with the local part of the pattern, which may start
8294 with an asterisk. If the local parts match, the domain is checked in exactly
8295 the same way as for a pattern in a domain list. For example, the domain can be
8296 wildcarded, refer to a named list, or be a lookup:
8297 .code
8298 deny senders = *@*.spamming.site:\
8299                *@+hostile_domains:\
8300                bozo@partial-lsearch;/list/of/dodgy/sites:\
8301                *@dbm;/bad/domains.db
8302 .endd
8303 .cindex "local part" "starting with !"
8304 .cindex "address list" "local part starting with !"
8305 If a local part that begins with an exclamation mark is required, it has to be
8306 specified using a regular expression, because otherwise the exclamation mark is
8307 treated as a sign of negation, as is standard in lists.
8308
8309 If a non-empty pattern that is not a regular expression or a lookup does not
8310 contain an @ character, it is matched against the domain part of the subject
8311 address. The only two formats that are recognized this way are a literal
8312 domain, or a domain pattern that starts with *. In both these cases, the effect
8313 is the same as if &`*@`& preceded the pattern. For example:
8314 .code
8315 deny senders = enemy.domain : *.enemy.domain
8316 .endd
8317
8318 The following kinds of more complicated address list pattern can match any
8319 address, including the empty address that is characteristic of bounce message
8320 senders:
8321
8322 .ilist
8323 .cindex "regular expressions" "in address list"
8324 .cindex "address list" "regular expression in"
8325 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8326 done against the complete address, with the pattern as the regular expression.
8327 You must take care that backslash and dollar characters are not misinterpreted
8328 as part of the string expansion. The simplest way to do this is to use &`\N`&
8329 to mark that part of the string as non-expandable. For example:
8330 .code
8331 deny senders = \N^.*this.*@example\.com$\N : \
8332                \N^\d{8}.+@spamhaus.example$\N : ...
8333 .endd
8334 The &`\N`& sequences are removed by the expansion, so these items do indeed
8335 start with &"^"& by the time they are being interpreted as address patterns.
8336
8337 .next
8338 .cindex "address list" "lookup for complete address"
8339 Complete addresses can be looked up by using a pattern that starts with a
8340 lookup type terminated by a semicolon, followed by the data for the lookup. For
8341 example:
8342 .code
8343 deny senders = cdb;/etc/blocked.senders : \
8344   mysql;select address from blocked where \
8345   address='${quote_mysql:$sender_address}'
8346 .endd
8347 Both query-style and single-key lookup types can be used. For a single-key
8348 lookup type, Exim uses the complete address as the key. However, empty keys are
8349 not supported for single-key lookups, so a match against the empty address
8350 always fails. This restriction does not apply to query-style lookups.
8351
8352 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8353 cannot be used, and is ignored if specified, with an entry being written to the
8354 panic log.
8355 .cindex "*@ with single-key lookup"
8356 However, you can configure lookup defaults, as described in section
8357 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8358 default. For example, with this lookup:
8359 .code
8360 accept senders = lsearch*@;/some/file
8361 .endd
8362 the file could contains lines like this:
8363 .code
8364 user1@domain1.example
8365 *@domain2.example
8366 .endd
8367 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8368 that are tried is:
8369 .code
8370 nimrod@jaeger.example
8371 *@jaeger.example
8372 *
8373 .endd
8374 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8375 would mean that every address matches, thus rendering the test useless.
8376
8377 &*Warning 2*&: Do not confuse these two kinds of item:
8378 .code
8379 deny recipients = dbm*@;/some/file
8380 deny recipients = *@dbm;/some/file
8381 .endd
8382 The first does a whole address lookup, with defaulting, as just described,
8383 because it starts with a lookup type. The second matches the local part and
8384 domain independently, as described in a bullet point below.
8385 .endlist
8386
8387
8388 The following kinds of address list pattern can match only non-empty addresses.
8389 If the subject address is empty, a match against any of these pattern types
8390 always fails.
8391
8392
8393 .ilist
8394 .cindex "@@ with single-key lookup"
8395 .cindex "address list" "@@ lookup type"
8396 .cindex "address list" "split local part and domain"
8397 If a pattern starts with &"@@"& followed by a single-key lookup item
8398 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8399 split into a local part and a domain. The domain is looked up in the file. If
8400 it is not found, there is no match. If it is found, the data that is looked up
8401 from the file is treated as a colon-separated list of local part patterns, each
8402 of which is matched against the subject local part in turn.
8403
8404 .cindex "asterisk" "in address list"
8405 The lookup may be a partial one, and/or one involving a search for a default
8406 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8407 patterns that are looked up can be regular expressions or begin with &"*"&, or
8408 even be further lookups. They may also be independently negated. For example,
8409 with
8410 .code
8411 deny senders = @@dbm;/etc/reject-by-domain
8412 .endd
8413 the data from which the DBM file is built could contain lines like
8414 .code
8415 baddomain.com:  !postmaster : *
8416 .endd
8417 to reject all senders except &%postmaster%& from that domain.
8418
8419 .cindex "local part" "starting with !"
8420 If a local part that actually begins with an exclamation mark is required, it
8421 has to be specified using a regular expression. In &(lsearch)& files, an entry
8422 may be split over several lines by indenting the second and subsequent lines,
8423 but the separating colon must still be included at line breaks. White space
8424 surrounding the colons is ignored. For example:
8425 .code
8426 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8427 spammer3 : spammer4
8428 .endd
8429 As in all colon-separated lists in Exim, a colon can be included in an item by
8430 doubling.
8431
8432 If the last item in the list starts with a right angle-bracket, the remainder
8433 of the item is taken as a new key to look up in order to obtain a continuation
8434 list of local parts. The new key can be any sequence of characters. Thus one
8435 might have entries like
8436 .code
8437 aol.com: spammer1 : spammer 2 : >*
8438 xyz.com: spammer3 : >*
8439 *:       ^\d{8}$
8440 .endd
8441 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8442 local parts for all domains, in addition to the specific local parts listed for
8443 each domain. Of course, using this feature costs another lookup each time a
8444 chain is followed, but the effort needed to maintain the data is reduced.
8445
8446 .cindex "loop" "in lookups"
8447 It is possible to construct loops using this facility, and in order to catch
8448 them, the chains may be no more than fifty items long.
8449
8450 .next
8451 The @@<&'lookup'&> style of item can also be used with a query-style
8452 lookup, but in this case, the chaining facility is not available. The lookup
8453 can only return a single list of local parts.
8454 .endlist
8455
8456 &*Warning*&: There is an important difference between the address list items
8457 in these two examples:
8458 .code
8459 senders = +my_list
8460 senders = *@+my_list
8461 .endd
8462 In the first one, &`my_list`& is a named address list, whereas in the second
8463 example it is a named domain list.
8464
8465
8466
8467
8468 .section "Case of letters in address lists" "SECTcasletadd"
8469 .cindex "case of local parts"
8470 .cindex "address list" "case forcing"
8471 .cindex "case forcing in address lists"
8472 Domains in email addresses are always handled caselessly, but for local parts
8473 case may be significant on some systems (see &%caseful_local_part%& for how
8474 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8475 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8476 blocking lists should be done in a case-independent manner. Since most address
8477 lists in Exim are used for this kind of control, Exim attempts to do this by
8478 default.
8479
8480 The domain portion of an address is always lowercased before matching it to an
8481 address list. The local part is lowercased by default, and any string
8482 comparisons that take place are done caselessly. This means that the data in
8483 the address list itself, in files included as plain file names, and in any file
8484 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8485 keys in files that are looked up by a search type other than &(lsearch)& (which
8486 works caselessly) must be in lower case, because these lookups are not
8487 case-independent.
8488
8489 .cindex "&`+caseful`&"
8490 To allow for the possibility of caseful address list matching, if an item in
8491 an address list is the string &"+caseful"&, the original case of the local
8492 part is restored for any comparisons that follow, and string comparisons are no
8493 longer case-independent. This does not affect the domain, which remains in
8494 lower case. However, although independent matches on the domain alone are still
8495 performed caselessly, regular expressions that match against an entire address
8496 become case-sensitive after &"+caseful"& has been seen.
8497
8498
8499
8500 .section "Local part lists" "SECTlocparlis"
8501 .cindex "list" "local part list"
8502 .cindex "local part" "list"
8503 Case-sensitivity in local part lists is handled in the same way as for address
8504 lists, as just described. The &"+caseful"& item can be used if required. In a
8505 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8506 set false, the subject is lowercased and the matching is initially
8507 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8508 matching in the local part list, but not elsewhere in the router. If
8509 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8510 option is case-sensitive from the start.
8511
8512 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8513 comments are handled in the same way as address lists &-- they are recognized
8514 only if the # is preceded by white space or the start of the line.
8515 Otherwise, local part lists are matched in the same way as domain lists, except
8516 that the special items that refer to the local host (&`@`&, &`@[]`&,
8517 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8518 Refer to section &<<SECTdomainlist>>& for details of the other available item
8519 types.
8520 .ecindex IIDdohoadli
8521
8522
8523
8524
8525 . ////////////////////////////////////////////////////////////////////////////
8526 . ////////////////////////////////////////////////////////////////////////////
8527
8528 .chapter "String expansions" "CHAPexpand"
8529 .scindex IIDstrexp "expansion" "of strings"
8530 Many strings in Exim's run time configuration are expanded before use. Some of
8531 them are expanded every time they are used; others are expanded only once.
8532
8533 When a string is being expanded it is copied verbatim from left to right except
8534 when a dollar or backslash character is encountered. A dollar specifies the
8535 start of a portion of the string that is interpreted and replaced as described
8536 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8537 escape character, as described in the following section.
8538
8539 Whether a string is expanded depends upon the context.  Usually this is solely
8540 dependent upon the option for which a value is sought; in this documentation,
8541 options for which string expansion is performed are marked with &dagger; after
8542 the data type.  ACL rules always expand strings.  A couple of expansion
8543 conditions do not expand some of the brace-delimited branches, for security
8544 reasons.
8545
8546
8547
8548 .section "Literal text in expanded strings" "SECTlittext"
8549 .cindex "expansion" "including literal text"
8550 An uninterpreted dollar can be included in an expanded string by putting a
8551 backslash in front of it. A backslash can be used to prevent any special
8552 character being treated specially in an expansion, including backslash itself.
8553 If the string appears in quotes in the configuration file, two backslashes are
8554 required because the quotes themselves cause interpretation of backslashes when
8555 the string is read in (see section &<<SECTstrings>>&).
8556
8557 .cindex "expansion" "non-expandable substrings"
8558 A portion of the string can specified as non-expandable by placing it between
8559 two occurrences of &`\N`&. This is particularly useful for protecting regular
8560 expressions, which often contain backslashes and dollar signs. For example:
8561 .code
8562 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8563 .endd
8564 On encountering the first &`\N`&, the expander copies subsequent characters
8565 without interpretation until it reaches the next &`\N`& or the end of the
8566 string.
8567
8568
8569
8570 .section "Character escape sequences in expanded strings" "SECID82"
8571 .cindex "expansion" "escape sequences"
8572 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8573 expanded string is recognized as an escape sequence for the character newline,
8574 carriage return, or tab, respectively. A backslash followed by up to three
8575 octal digits is recognized as an octal encoding for a single character, and a
8576 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8577 encoding.
8578
8579 These escape sequences are also recognized in quoted strings when they are read
8580 in. Their interpretation in expansions as well is useful for unquoted strings,
8581 and for other cases such as looked-up strings that are then expanded.
8582
8583
8584 .section "Testing string expansions" "SECID83"
8585 .cindex "expansion" "testing"
8586 .cindex "testing" "string expansion"
8587 .oindex "&%-be%&"
8588 Many expansions can be tested by calling Exim with the &%-be%& option. This
8589 takes the command arguments, or lines from the standard input if there are no
8590 arguments, runs them through the string expansion code, and writes the results
8591 to the standard output. Variables based on configuration values are set up, but
8592 since no message is being processed, variables such as &$local_part$& have no
8593 value. Nevertheless the &%-be%& option can be useful for checking out file and
8594 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8595 and &%nhash%&.
8596
8597 Exim gives up its root privilege when it is called with the &%-be%& option, and
8598 instead runs under the uid and gid it was called with, to prevent users from
8599 using &%-be%& for reading files to which they do not have access.
8600
8601 .oindex "&%-bem%&"
8602 If you want to test expansions that include variables whose values are taken
8603 from a message, there are two other options that can be used. The &%-bem%&
8604 option is like &%-be%& except that it is followed by a file name. The file is
8605 read as a message before doing the test expansions. For example:
8606 .code
8607 exim -bem /tmp/test.message '$h_subject:'
8608 .endd
8609 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8610 Exim message identifier. For example:
8611 .code
8612 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8613 .endd
8614 This loads the message from Exim's spool before doing the test expansions, and
8615 is therefore restricted to admin users.
8616
8617
8618 .section "Forced expansion failure" "SECTforexpfai"
8619 .cindex "expansion" "forced failure"
8620 A number of expansions that are described in the following section have
8621 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8622 (which are sometimes called &"curly brackets"&). Which of the two strings is
8623 used depends on some condition that is evaluated as part of the expansion. If,
8624 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8625 the entire string expansion fails in a way that can be detected by the code
8626 that requested the expansion. This is called &"forced expansion failure"&, and
8627 its consequences depend on the circumstances. In some cases it is no different
8628 from any other expansion failure, but in others a different action may be
8629 taken. Such variations are mentioned in the documentation of the option that is
8630 being expanded.
8631
8632
8633
8634
8635 .section "Expansion items" "SECTexpansionitems"
8636 The following items are recognized in expanded strings. White space may be used
8637 between sub-items that are keywords or substrings enclosed in braces inside an
8638 outer set of braces, to improve readability. &*Warning*&: Within braces,
8639 white space is significant.
8640
8641 .vlist
8642 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8643 .cindex "expansion" "variables"
8644 Substitute the contents of the named variable, for example:
8645 .code
8646 $local_part
8647 ${domain}
8648 .endd
8649 The second form can be used to separate the name from subsequent alphanumeric
8650 characters. This form (using braces) is available only for variables; it does
8651 &'not'& apply to message headers. The names of the variables are given in
8652 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8653 given, the expansion fails.
8654
8655 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8656 .cindex "expansion" "operators"
8657 The string is first itself expanded, and then the operation specified by
8658 <&'op'&> is applied to it. For example:
8659 .code
8660 ${lc:$local_part}
8661 .endd
8662 The string starts with the first character after the colon, which may be
8663 leading white space. A list of operators is given in section &<<SECTexpop>>&
8664 below. The operator notation is used for simple expansion items that have just
8665 one argument, because it reduces the number of braces and therefore makes the
8666 string easier to understand.
8667
8668 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8669 This item inserts &"basic"& header lines. It is described with the &%header%&
8670 expansion item below.
8671
8672 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8673        {*&<&'arg'&>&*}...}*&"
8674 .cindex &%dlfunc%&
8675 This expansion dynamically loads and then calls a locally-written C function.
8676 This functionality is available only if Exim is compiled with
8677 .code
8678 EXPAND_DLFUNC=yes
8679 .endd
8680 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8681 object so that it doesn't reload the same object file in the same Exim process
8682 (but of course Exim does start new processes frequently).
8683
8684 There may be from zero to eight arguments to the function. When compiling
8685 a local function that is to be called in this way, &_local_scan.h_& should be
8686 included. The Exim variables and functions that are defined by that API
8687 are also available for dynamically loaded functions. The function itself
8688 must have the following type:
8689 .code
8690 int dlfunction(uschar **yield, int argc, uschar *argv[])
8691 .endd
8692 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8693 function should return one of the following values:
8694
8695 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8696 into the expanded string that is being built.
8697
8698 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8699 from &'yield'&, if it is set.
8700
8701 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8702 taken from &'yield'& if it is set.
8703
8704 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8705
8706 When compiling a function that is to be used in this way with gcc,
8707 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8708 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8709
8710 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8711        {*&<&'string3'&>&*}}*&"
8712 .cindex "expansion" "extracting substrings by key"
8713 .cindex "&%extract%&" "substrings by key"
8714 The key and <&'string1'&> are first expanded separately. Leading and trailing
8715 white space is removed from the key (but not from any of the strings). The key
8716 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8717 form:
8718 .display
8719 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8720 .endd
8721 .vindex "&$value$&"
8722 where the equals signs and spaces (but not both) are optional. If any of the
8723 values contain white space, they must be enclosed in double quotes, and any
8724 values that are enclosed in double quotes are subject to escape processing as
8725 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8726 for the value that corresponds to the key. The search is case-insensitive. If
8727 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8728 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8729 variable &$value$& contains the value that has been extracted. Afterwards, it
8730 is restored to any previous value it might have had.
8731
8732 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8733 key is not found. If {<&'string2'&>} is also omitted, the value that was
8734 extracted is used. Thus, for example, these two expansions are identical, and
8735 yield &"2001"&:
8736 .code
8737 ${extract{gid}{uid=1984 gid=2001}}
8738 ${extract{gid}{uid=1984 gid=2001}{$value}}
8739 .endd
8740 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8741 appear, for example:
8742 .code
8743 ${extract{Z}{A=... B=...}{$value} fail }
8744 .endd
8745 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8746 {<&'string2'&>} must be present for &"fail"& to be recognized.
8747
8748
8749 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8750         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8751 .cindex "expansion" "extracting substrings by number"
8752 .cindex "&%extract%&" "substrings by number"
8753 The <&'number'&> argument must consist entirely of decimal digits,
8754 apart from leading and trailing white space, which is ignored.
8755 This is what distinguishes this form of &%extract%& from the previous kind. It
8756 behaves in the same way, except that, instead of extracting a named field, it
8757 extracts from <&'string1'&> the field whose number is given as the first
8758 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8759 <&'string3'&> as before.
8760
8761 The fields in the string are separated by any one of the characters in the
8762 separator string. These may include space or tab characters.
8763 The first field is numbered one. If the number is negative, the fields are
8764 counted from the end of the string, with the rightmost one numbered -1. If the
8765 number given is zero, the entire string is returned. If the modulus of the
8766 number is greater than the number of fields in the string, the result is the
8767 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8768 provided. For example:
8769 .code
8770 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8771 .endd
8772 yields &"42"&, and
8773 .code
8774 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8775 .endd
8776 yields &"99"&. Two successive separators mean that the field between them is
8777 empty (for example, the fifth field above).
8778
8779
8780 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8781 .cindex "list" "selecting by condition"
8782 .cindex "expansion" "selecting from list by condition"
8783 .vindex "&$item$&"
8784 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8785 default, but the separator can be changed in the usual way. For each item
8786 in this list, its value is place in &$item$&, and then the condition is
8787 evaluated. If the condition is true, &$item$& is added to the output as an
8788 item in a new list; if the condition is false, the item is discarded. The
8789 separator used for the output list is the same as the one used for the
8790 input, but a separator setting is not included in the output. For example:
8791 .code
8792 ${filter{a:b:c}{!eq{$item}{b}}
8793 .endd
8794 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8795 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8796
8797
8798 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8799 .cindex "hash function" "textual"
8800 .cindex "expansion" "textual hash"
8801 This is a textual hashing function, and was the first to be implemented in
8802 early versions of Exim. In current releases, there are other hashing functions
8803 (numeric, MD5, and SHA-1), which are described below.
8804
8805 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8806 <&'n'&>. If you are using fixed values for these numbers, that is, if
8807 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8808 use the simpler operator notation that avoids some of the braces:
8809 .code
8810 ${hash_<n>_<m>:<string>}
8811 .endd
8812 The second number is optional (in both notations). If <&'n'&> is greater than
8813 or equal to the length of the string, the expansion item returns the string.
8814 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8815 function to the string. The new string consists of characters taken from the
8816 first <&'m'&> characters of the string
8817 .code
8818 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8819 .endd
8820 If <&'m'&> is not present the value 26 is used, so that only lower case
8821 letters appear. For example:
8822 .display
8823 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8824 &`$hash{5}{monty}}           `&   yields  &`monty`&
8825 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8826 .endd
8827
8828 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8829         &*$h_*&<&'header&~name'&>&*:*&" &&&
8830        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8831         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8832        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8833         &*$rh_*&<&'header&~name'&>&*:*&"
8834 .cindex "expansion" "header insertion"
8835 .vindex "&$header_$&"
8836 .vindex "&$bheader_$&"
8837 .vindex "&$rheader_$&"
8838 .cindex "header lines" "in expansion strings"
8839 .cindex "header lines" "character sets"
8840 .cindex "header lines" "decoding"
8841 Substitute the contents of the named message header line, for example
8842 .code
8843 $header_reply-to:
8844 .endd
8845 The newline that terminates a header line is not included in the expansion, but
8846 internal newlines (caused by splitting the header line over several physical
8847 lines) may be present.
8848
8849 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8850 the data in the header line is interpreted.
8851
8852 .ilist
8853 .cindex "white space" "in header lines"
8854 &%rheader%& gives the original &"raw"& content of the header line, with no
8855 processing at all, and without the removal of leading and trailing white space.
8856
8857 .next
8858 .cindex "base64 encoding" "in header lines"
8859 &%bheader%& removes leading and trailing white space, and then decodes base64
8860 or quoted-printable MIME &"words"& within the header text, but does no
8861 character set translation. If decoding of what looks superficially like a MIME
8862 &"word"& fails, the raw string is returned. If decoding
8863 .cindex "binary zero" "in header line"
8864 produces a binary zero character, it is replaced by a question mark &-- this is
8865 what Exim does for binary zeros that are actually received in header lines.
8866
8867 .next
8868 &%header%& tries to translate the string as decoded by &%bheader%& to a
8869 standard character set. This is an attempt to produce the same string as would
8870 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8871 returned. Translation is attempted only on operating systems that support the
8872 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8873 a system Makefile or in &_Local/Makefile_&.
8874 .endlist ilist
8875
8876 In a filter file, the target character set for &%header%& can be specified by a
8877 command of the following form:
8878 .code
8879 headers charset "UTF-8"
8880 .endd
8881 This command affects all references to &$h_$& (or &$header_$&) expansions in
8882 subsequently obeyed filter commands. In the absence of this command, the target
8883 character set in a filter is taken from the setting of the &%headers_charset%&
8884 option in the runtime configuration. The value of this option defaults to the
8885 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8886 ISO-8859-1.
8887
8888 Header names follow the syntax of RFC 2822, which states that they may contain
8889 any printing characters except space and colon. Consequently, curly brackets
8890 &'do not'& terminate header names, and should not be used to enclose them as
8891 if they were variables. Attempting to do so causes a syntax error.
8892
8893 Only header lines that are common to all copies of a message are visible to
8894 this mechanism. These are the original header lines that are received with the
8895 message, and any that are added by an ACL statement or by a system
8896 filter. Header lines that are added to a particular copy of a message by a
8897 router or transport are not accessible.
8898
8899 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8900 before the DATA ACL, because the header structure is not set up until the
8901 message is received. Header lines that are added in a RCPT ACL (for example)
8902 are saved until the message's incoming header lines are available, at which
8903 point they are added. When a DATA ACL is running, however, header lines added
8904 by earlier ACLs are visible.
8905
8906 Upper case and lower case letters are synonymous in header names. If the
8907 following character is white space, the terminating colon may be omitted, but
8908 this is not recommended, because you may then forget it when it is needed. When
8909 white space terminates the header name, it is included in the expanded string.
8910 If the message does not contain the given header, the expansion item is
8911 replaced by an empty string. (See the &%def%& condition in section
8912 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8913
8914 If there is more than one header with the same name, they are all concatenated
8915 to form the substitution string, up to a maximum length of 64K. Unless
8916 &%rheader%& is being used, leading and trailing white space is removed from
8917 each header before concatenation, and a completely empty header is ignored. A
8918 newline character is then inserted between non-empty headers, but there is no
8919 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8920 those headers that contain lists of addresses, a comma is also inserted at the
8921 junctions between headers. This does not happen for the &%rheader%& expansion.
8922
8923
8924 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8925 .cindex "expansion" "hmac hashing"
8926 .cindex &%hmac%&
8927 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8928 shared secret and some text into a message authentication code, as specified in
8929 RFC 2104. This differs from &`${md5:secret_text...}`& or
8930 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8931 cryptographic hash, allowing for authentication that is not possible with MD5
8932 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8933 present. For example:
8934 .code
8935 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8936 .endd
8937 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8938 produces:
8939 .code
8940 dd97e3ba5d1a61b5006108f8c8252953
8941 .endd
8942 As an example of how this might be used, you might put in the main part of
8943 an Exim configuration:
8944 .code
8945 SPAMSCAN_SECRET=cohgheeLei2thahw
8946 .endd
8947 In a router or a transport you could then have:
8948 .code
8949 headers_add = \
8950   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8951   ${hmac{md5}{SPAMSCAN_SECRET}\
8952   {${primary_hostname},${message_exim_id},$h_message-id:}}
8953 .endd
8954 Then given a message, you can check where it was scanned by looking at the
8955 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8956 this header line is authentic by recomputing the authentication code from the
8957 host name, message ID and the &'Message-id:'& header line. This can be done
8958 using Exim's &%-be%& option, or by other means, for example by using the
8959 &'hmac_md5_hex()'& function in Perl.
8960
8961
8962 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8963 .cindex "expansion" "conditional"
8964 .cindex "&%if%&, expansion item"
8965 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8966 item; otherwise <&'string2'&> is used. The available conditions are described
8967 in section &<<SECTexpcond>>& below. For example:
8968 .code
8969 ${if eq {$local_part}{postmaster} {yes}{no} }
8970 .endd
8971 The second string need not be present; if it is not and the condition is not
8972 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
8973 be present instead of the second string (without any curly brackets). In this
8974 case, the expansion is forced to fail if the condition is not true (see section
8975 &<<SECTforexpfai>>&).
8976
8977 If both strings are omitted, the result is the string &`true`& if the condition
8978 is true, and the empty string if the condition is false. This makes it less
8979 cumbersome to write custom ACL and router conditions. For example, instead of
8980 .code
8981 condition = ${if >{$acl_m4}{3}{true}{false}}
8982 .endd
8983 you can use
8984 .code
8985 condition = ${if >{$acl_m4}{3}}
8986 .endd
8987
8988 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8989 .cindex "expansion" "string truncation"
8990 .cindex "&%length%& expansion item"
8991 The &%length%& item is used to extract the initial portion of a string. Both
8992 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
8993 you are using a fixed value for the number, that is, if <&'string1'&> does not
8994 change when expanded, you can use the simpler operator notation that avoids
8995 some of the braces:
8996 .code
8997 ${length_<n>:<string>}
8998 .endd
8999 The result of this item is either the first <&'n'&> characters or the whole
9000 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9001 &%strlen%&, which gives the length of a string.
9002
9003
9004 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9005         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9006 This is the first of one of two different types of lookup item, which are both
9007 described in the next item.
9008
9009 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9010         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9011 .cindex "expansion" "lookup in"
9012 .cindex "file" "lookups"
9013 .cindex "lookup" "in expanded string"
9014 The two forms of lookup item specify data lookups in files and databases, as
9015 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9016 lookups, and the second is used for query-style lookups. The <&'key'&>,
9017 <&'file'&>, and <&'query'&> strings are expanded before use.
9018
9019 If there is any white space in a lookup item which is part of a filter command,
9020 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9021 other place where white space is significant, the lookup item must be enclosed
9022 in double quotes. The use of data lookups in users' filter files may be locked
9023 out by the system administrator.
9024
9025 .vindex "&$value$&"
9026 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9027 During its expansion, the variable &$value$& contains the data returned by the
9028 lookup. Afterwards it reverts to the value it had previously (at the outer
9029 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9030 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9031 string on failure. If <&'string2'&> is provided, it can itself be a nested
9032 lookup, thus providing a mechanism for looking up a default value when the
9033 original lookup fails.
9034
9035 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9036 data for the outer lookup while the parameters of the second lookup are
9037 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9038 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9039 appear, and in this case, if the lookup fails, the entire expansion is forced
9040 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9041 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9042 successful lookup, and nothing in the case of failure.
9043
9044 For single-key lookups, the string &"partial"& is permitted to precede the
9045 search type in order to do partial matching, and * or *@ may follow a search
9046 type to request default lookups if the key does not match (see sections
9047 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9048
9049 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9050 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9051 and non-wild parts of the key during the expansion of the replacement text.
9052 They return to their previous values at the end of the lookup item.
9053
9054 This example looks up the postmaster alias in the conventional alias file:
9055 .code
9056 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9057 .endd
9058 This example uses NIS+ to look up the full name of the user corresponding to
9059 the local part of an address, forcing the expansion to fail if it is not found:
9060 .code
9061 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9062   {$value}fail}
9063 .endd
9064
9065
9066 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9067 .cindex "expansion" "list creation"
9068 .vindex "&$item$&"
9069 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9070 default, but the separator can be changed in the usual way. For each item
9071 in this list, its value is place in &$item$&, and then <&'string2'&> is
9072 expanded and added to the output as an item in a new list. The separator used
9073 for the output list is the same as the one used for the input, but a separator
9074 setting is not included in the output. For example:
9075 .code
9076 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9077 .endd
9078 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9079 value of &$item$& is restored to what it was before. See also the &*filter*&
9080 and &*reduce*& expansion items.
9081
9082 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9083 .cindex "expansion" "numeric hash"
9084 .cindex "hash function" "numeric"
9085 The three strings are expanded; the first two must yield numbers. Call them
9086 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9087 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9088 can use the simpler operator notation that avoids some of the braces:
9089 .code
9090 ${nhash_<n>_<m>:<string>}
9091 .endd
9092 The second number is optional (in both notations). If there is only one number,
9093 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9094 processed by a div/mod hash function that returns two numbers, separated by a
9095 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9096 example,
9097 .code
9098 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9099 .endd
9100 returns the string &"6/33"&.
9101
9102
9103
9104 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9105 .cindex "Perl" "use in expanded string"
9106 .cindex "expansion" "calling Perl from"
9107 This item is available only if Exim has been built to include an embedded Perl
9108 interpreter. The subroutine name and the arguments are first separately
9109 expanded, and then the Perl subroutine is called with those arguments. No
9110 additional arguments need be given; the maximum number permitted, including the
9111 name of the subroutine, is nine.
9112
9113 The return value of the subroutine is inserted into the expanded string, unless
9114 the return value is &%undef%&. In that case, the expansion fails in the same
9115 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9116 Whatever you return is evaluated in a scalar context. For example, if you
9117 return the name of a Perl vector, the return value is the size of the vector,
9118 not its contents.
9119
9120 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9121 with the error message that was passed to &%die%&. More details of the embedded
9122 Perl facility are given in chapter &<<CHAPperl>>&.
9123
9124 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9125 out the use of this expansion item in filter files.
9126
9127
9128 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9129 .cindex "&%prvs%& expansion item"
9130 The first argument is a complete email address and the second is secret
9131 keystring. The third argument, specifying a key number, is optional. If absent,
9132 it defaults to 0. The result of the expansion is a prvs-signed email address,
9133 to be typically used with the &%return_path%& option on an &(smtp)& transport
9134 as part of a bounce address tag validation (BATV) scheme. For more discussion
9135 and an example, see section &<<SECTverifyPRVS>>&.
9136
9137 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9138         {*&<&'string'&>&*}}*&"
9139 .cindex "&%prvscheck%& expansion item"
9140 This expansion item is the complement of the &%prvs%& item. It is used for
9141 checking prvs-signed addresses. If the expansion of the first argument does not
9142 yield a syntactically valid prvs-signed address, the whole item expands to the
9143 empty string. When the first argument does expand to a syntactically valid
9144 prvs-signed address, the second argument is expanded, with the prvs-decoded
9145 version of the address and the key number extracted from the address in the
9146 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9147
9148 These two variables can be used in the expansion of the second argument to
9149 retrieve the secret. The validity of the prvs-signed address is then checked
9150 against the secret. The result is stored in the variable &$prvscheck_result$&,
9151 which is empty for failure or &"1"& for success.
9152
9153 The third argument is optional; if it is missing, it defaults to an empty
9154 string. This argument is now expanded. If the result is an empty string, the
9155 result of the expansion is the decoded version of the address. This is the case
9156 whether or not the signature was valid. Otherwise, the result of the expansion
9157 is the expansion of the third argument.
9158
9159 All three variables can be used in the expansion of the third argument.
9160 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9161 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9162
9163 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9164 .cindex "expansion" "inserting an entire file"
9165 .cindex "file" "inserting into expansion"
9166 .cindex "&%readfile%& expansion item"
9167 The file name and end-of-line string are first expanded separately. The file is
9168 then read, and its contents replace the entire item. All newline characters in
9169 the file are replaced by the end-of-line string if it is present. Otherwise,
9170 newlines are left in the string.
9171 String expansion is not applied to the contents of the file. If you want this,
9172 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9173 the string expansion fails.
9174
9175 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9176 locks out the use of this expansion item in filter files.
9177
9178
9179
9180 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9181         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9182 .cindex "expansion" "inserting from a socket"
9183 .cindex "socket, use of in expansion"
9184 .cindex "&%readsocket%& expansion item"
9185 This item inserts data from a Unix domain or Internet socket into the expanded
9186 string. The minimal way of using it uses just two arguments, as in these
9187 examples:
9188 .code
9189 ${readsocket{/socket/name}{request string}}
9190 ${readsocket{inet:some.host:1234}{request string}}
9191 .endd
9192 For a Unix domain socket, the first substring must be the path to the socket.
9193 For an Internet socket, the first substring must contain &`inet:`& followed by
9194 a host name or IP address, followed by a colon and a port, which can be a
9195 number or the name of a TCP port in &_/etc/services_&. An IP address may
9196 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9197 example:
9198 .code
9199 ${readsocket{inet:[::1]:1234}{request string}}
9200 .endd
9201 Only a single host name may be given, but if looking it up yields more than
9202 one IP address, they are each tried in turn until a connection is made. For
9203 both kinds of socket, Exim makes a connection, writes the request string
9204 (unless it is an empty string) and reads from the socket until an end-of-file
9205 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9206 extend what can be done. Firstly, you can vary the timeout. For example:
9207 .code
9208 ${readsocket{/socket/name}{request string}{3s}}
9209 .endd
9210 A fourth argument allows you to change any newlines that are in the data
9211 that is read, in the same way as for &%readfile%& (see above). This example
9212 turns them into spaces:
9213 .code
9214 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9215 .endd
9216 As with all expansions, the substrings are expanded before the processing
9217 happens. Errors in these sub-expansions cause the expansion to fail. In
9218 addition, the following errors can occur:
9219
9220 .ilist
9221 Failure to create a socket file descriptor;
9222 .next
9223 Failure to connect the socket;
9224 .next
9225 Failure to write the request string;
9226 .next
9227 Timeout on reading from the socket.
9228 .endlist
9229
9230 By default, any of these errors causes the expansion to fail. However, if
9231 you supply a fifth substring, it is expanded and used when any of the above
9232 errors occurs. For example:
9233 .code
9234 ${readsocket{/socket/name}{request string}{3s}{\n}\
9235   {socket failure}}
9236 .endd
9237 You can test for the existence of a Unix domain socket by wrapping this
9238 expansion in &`${if exists`&, but there is a race condition between that test
9239 and the actual opening of the socket, so it is safer to use the fifth argument
9240 if you want to be absolutely sure of avoiding an expansion error for a
9241 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9242
9243 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9244 locks out the use of this expansion item in filter files.
9245
9246
9247 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9248 .cindex "expansion" "reducing a list to a scalar"
9249 .cindex "list" "reducing to a scalar"
9250 .vindex "&$value$&"
9251 .vindex "&$item$&"
9252 This operation reduces a list to a single, scalar string. After expansion,
9253 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9254 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9255 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9256 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9257 them. The result of that expansion is assigned to &$value$& before the next
9258 iteration. When the end of the list is reached, the final value of &$value$& is
9259 added to the expansion output. The &*reduce*& expansion item can be used in a
9260 number of ways. For example, to add up a list of numbers:
9261 .code
9262 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9263 .endd
9264 The result of that expansion would be &`6`&. The maximum of a list of numbers
9265 can be found:
9266 .code
9267 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9268 .endd
9269 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9270 restored to what they were before. See also the &*filter*& and &*map*&
9271 expansion items.
9272
9273 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9274 This item inserts &"raw"& header lines. It is described with the &%header%&
9275 expansion item above.
9276
9277 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9278         {*&<&'string2'&>&*}}*&"
9279 .cindex "expansion" "running a command"
9280 .cindex "&%run%& expansion item"
9281 The command and its arguments are first expanded separately, and then the
9282 command is run in a separate process, but under the same uid and gid. As in
9283 other command executions from Exim, a shell is not used by default. If you want
9284 a shell, you must explicitly code it.
9285
9286 The standard input for the command exists, but is empty. The standard output
9287 and standard error are set to the same file descriptor.
9288 .cindex "return code" "from &%run%& expansion"
9289 .vindex "&$value$&"
9290 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9291 and replaces the entire item; during this expansion, the standard output/error
9292 from the command is in the variable &$value$&. If the command fails,
9293 <&'string2'&>, if present, is expanded and used. Once again, during the
9294 expansion, the standard output/error from the command is in the variable
9295 &$value$&.
9296
9297 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9298 can be the word &"fail"& (not in braces) to force expansion failure if the
9299 command does not succeed. If both strings are omitted, the result is contents
9300 of the standard output/error on success, and nothing on failure.
9301
9302 .vindex "&$runrc$&"
9303 The return code from the command is put in the variable &$runrc$&, and this
9304 remains set afterwards, so in a filter file you can do things like this:
9305 .code
9306 if "${run{x y z}{}}$runrc" is 1 then ...
9307   elif $runrc is 2 then ...
9308   ...
9309 endif
9310 .endd
9311 If execution of the command fails (for example, the command does not exist),
9312 the return code is 127 &-- the same code that shells use for non-existent
9313 commands.
9314
9315 &*Warning*&: In a router or transport, you cannot assume the order in which
9316 option values are expanded, except for those preconditions whose order of
9317 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9318 by the expansion of one option, and use it in another.
9319
9320 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9321 out the use of this expansion item in filter files.
9322
9323
9324 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9325 .cindex "expansion" "string substitution"
9326 .cindex "&%sg%& expansion item"
9327 This item works like Perl's substitution operator (s) with the global (/g)
9328 option; hence its name. However, unlike the Perl equivalent, Exim does not
9329 modify the subject string; instead it returns the modified string for insertion
9330 into the overall expansion. The item takes three arguments: the subject string,
9331 a regular expression, and a substitution string. For example:
9332 .code
9333 ${sg{abcdefabcdef}{abc}{xyz}}
9334 .endd
9335 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9336 if any $ or \ characters are required in the regular expression or in the
9337 substitution string, they have to be escaped. For example:
9338 .code
9339 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9340 .endd
9341 yields &"defabc"&, and
9342 .code
9343 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9344 .endd
9345 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9346 the regular expression from string expansion.
9347
9348
9349
9350 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9351 .cindex "&%substr%& expansion item"
9352 .cindex "substring extraction"
9353 .cindex "expansion" "substring extraction"
9354 The three strings are expanded; the first two must yield numbers. Call them
9355 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9356 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9357 can use the simpler operator notation that avoids some of the braces:
9358 .code
9359 ${substr_<n>_<m>:<string>}
9360 .endd
9361 The second number is optional (in both notations).
9362 If it is absent in the simpler format, the preceding underscore must also be
9363 omitted.
9364
9365 The &%substr%& item can be used to extract more general substrings than
9366 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9367 length required. For example
9368 .code
9369 ${substr{3}{2}{$local_part}}
9370 .endd
9371 If the starting offset is greater than the string length the result is the
9372 null string; if the length plus starting offset is greater than the string
9373 length, the result is the right-hand part of the string, starting from the
9374 given offset. The first character in the string has offset zero.
9375
9376 The &%substr%& expansion item can take negative offset values to count
9377 from the right-hand end of its operand. The last character is offset -1, the
9378 second-last is offset -2, and so on. Thus, for example,
9379 .code
9380 ${substr{-5}{2}{1234567}}
9381 .endd
9382 yields &"34"&. If the absolute value of a negative offset is greater than the
9383 length of the string, the substring starts at the beginning of the string, and
9384 the length is reduced by the amount of overshoot. Thus, for example,
9385 .code
9386 ${substr{-5}{2}{12}}
9387 .endd
9388 yields an empty string, but
9389 .code
9390 ${substr{-3}{2}{12}}
9391 .endd
9392 yields &"1"&.
9393
9394 When the second number is omitted from &%substr%&, the remainder of the string
9395 is taken if the offset is positive. If it is negative, all characters in the
9396 string preceding the offset point are taken. For example, an offset of -1 and
9397 no length, as in these semantically identical examples:
9398 .code
9399 ${substr_-1:abcde}
9400 ${substr{-1}{abcde}}
9401 .endd
9402 yields all but the last character of the string, that is, &"abcd"&.
9403
9404
9405
9406 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9407         {*&<&'replacements'&>&*}}*&"
9408 .cindex "expansion" "character translation"
9409 .cindex "&%tr%& expansion item"
9410 This item does single-character translation on its subject string. The second
9411 argument is a list of characters to be translated in the subject string. Each
9412 matching character is replaced by the corresponding character from the
9413 replacement list. For example
9414 .code
9415 ${tr{abcdea}{ac}{13}}
9416 .endd
9417 yields &`1b3de1`&. If there are duplicates in the second character string, the
9418 last occurrence is used. If the third string is shorter than the second, its
9419 last character is replicated. However, if it is empty, no translation takes
9420 place.
9421 .endlist
9422
9423
9424
9425 .section "Expansion operators" "SECTexpop"
9426 .cindex "expansion" "operators"
9427 For expansion items that perform transformations on a single argument string,
9428 the &"operator"& notation is used because it is simpler and uses fewer braces.
9429 The substring is first expanded before the operation is applied to it. The
9430 following operations can be performed:
9431
9432 .vlist
9433 .vitem &*${address:*&<&'string'&>&*}*&
9434 .cindex "expansion" "RFC 2822 address handling"
9435 .cindex "&%address%& expansion item"
9436 The string is interpreted as an RFC 2822 address, as it might appear in a
9437 header line, and the effective address is extracted from it. If the string does
9438 not parse successfully, the result is empty.
9439
9440
9441 .vitem &*${addresses:*&<&'string'&>&*}*&
9442 .cindex "expansion" "RFC 2822 address handling"
9443 .cindex "&%addresses%& expansion item"
9444 The string (after expansion) is interpreted as a list of addresses in RFC
9445 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9446 operative address (&'local-part@domain'&) is extracted from each item, and the
9447 result of the expansion is a colon-separated list, with appropriate
9448 doubling of colons should any happen to be present in the email addresses.
9449 Syntactically invalid RFC2822 address items are omitted from the output.
9450
9451 It is possible to specify a character other than colon for the output
9452 separator by starting the string with > followed by the new separator
9453 character. For example:
9454 .code
9455 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9456 .endd
9457 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9458 expansion item, which extracts the working address from a single RFC2822
9459 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9460 processing lists.
9461
9462
9463 .vitem &*${base62:*&<&'digits'&>&*}*&
9464 .cindex "&%base62%& expansion item"
9465 .cindex "expansion" "conversion to base 62"
9466 The string must consist entirely of decimal digits. The number is converted to
9467 base 62 and output as a string of six characters, including leading zeros. In
9468 the few operating environments where Exim uses base 36 instead of base 62 for
9469 its message identifiers (because those systems do not have case-sensitive file
9470 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9471 be absolutely clear: this is &'not'& base64 encoding.
9472
9473 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9474 .cindex "&%base62d%& expansion item"
9475 .cindex "expansion" "conversion to base 62"
9476 The string must consist entirely of base-62 digits, or, in operating
9477 environments where Exim uses base 36 instead of base 62 for its message
9478 identifiers, base-36 digits. The number is converted to decimal and output as a
9479 string.
9480
9481 .vitem &*${domain:*&<&'string'&>&*}*&
9482 .cindex "domain" "extraction"
9483 .cindex "expansion" "domain extraction"
9484 The string is interpreted as an RFC 2822 address and the domain is extracted
9485 from it. If the string does not parse successfully, the result is empty.
9486
9487
9488 .vitem &*${escape:*&<&'string'&>&*}*&
9489 .cindex "expansion" "escaping non-printing characters"
9490 .cindex "&%escape%& expansion item"
9491 If the string contains any non-printing characters, they are converted to
9492 escape sequences starting with a backslash. Whether characters with the most
9493 significant bit set (so-called &"8-bit characters"&) count as printing or not
9494 is controlled by the &%print_topbitchars%& option.
9495
9496
9497 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9498 .cindex "expansion" "expression evaluation"
9499 .cindex "expansion" "arithmetic expression"
9500 .cindex "&%eval%& expansion item"
9501 These items supports simple arithmetic and bitwise logical operations in
9502 expansion strings. The string (after expansion) must be a conventional
9503 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9504 logical operators, and parentheses. All operations are carried out using
9505 integer arithmetic. The operator priorities are as follows (the same as in the
9506 C programming language):
9507 .table2 70pt 300pt
9508 .irow &'highest:'& "not (~), negate (-)"
9509 .irow ""   "multiply (*), divide (/), remainder (%)"
9510 .irow ""   "plus (+), minus (-)"
9511 .irow ""   "shift-left (<<), shift-right (>>)"
9512 .irow ""   "and (&&)"
9513 .irow ""   "xor (^)"
9514 .irow &'lowest:'&  "or (|)"
9515 .endtable
9516 Binary operators with the same priority are evaluated from left to right. White
9517 space is permitted before or after operators.
9518
9519 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9520 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9521 decimal, even if they start with a leading zero; hexadecimal numbers are not
9522 permitted. This can be useful when processing numbers extracted from dates or
9523 times, which often do have leading zeros.
9524
9525 A number may be followed by &"K"& or &"M"& to multiply it by 1024 or 1024*1024,
9526 respectively. Negative numbers are supported. The result of the computation is
9527 a decimal representation of the answer (without &"K"& or &"M"&). For example:
9528
9529 .display
9530 &`${eval:1+1}            `&  yields 2
9531 &`${eval:1+2*3}          `&  yields 7
9532 &`${eval:(1+2)*3}        `&  yields 9
9533 &`${eval:2+42%5}         `&  yields 4
9534 &`${eval:0xc&amp;5}          `&  yields 4
9535 &`${eval:0xc|5}          `&  yields 13
9536 &`${eval:0xc^5}          `&  yields 9
9537 &`${eval:0xc>>1}         `&  yields 6
9538 &`${eval:0xc<<1}         `&  yields 24
9539 &`${eval:~255&amp;0x1234}    `&  yields 4608
9540 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9541 .endd
9542
9543 As a more realistic example, in an ACL you might have
9544 .code
9545 deny   message = Too many bad recipients
9546        condition =                    \
9547          ${if and {                   \
9548            {>{$rcpt_count}{10}}       \
9549            {                          \
9550            <                          \
9551              {$recipients_count}      \
9552              {${eval:$rcpt_count/2}}  \
9553            }                          \
9554          }{yes}{no}}
9555 .endd
9556 The condition is true if there have been more than 10 RCPT commands and
9557 fewer than half of them have resulted in a valid recipient.
9558
9559
9560 .vitem &*${expand:*&<&'string'&>&*}*&
9561 .cindex "expansion" "re-expansion of substring"
9562 The &%expand%& operator causes a string to be expanded for a second time. For
9563 example,
9564 .code
9565 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9566 .endd
9567 first looks up a string in a file while expanding the operand for &%expand%&,
9568 and then re-expands what it has found.
9569
9570
9571 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9572 .cindex "Unicode"
9573 .cindex "UTF-8" "conversion from"
9574 .cindex "expansion" "UTF-8 conversion"
9575 .cindex "&%from_utf8%& expansion item"
9576 The world is slowly moving towards Unicode, although there are no standards for
9577 email yet. However, other applications (including some databases) are starting
9578 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9579 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9580 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9581 the result is an undefined sequence of bytes.
9582
9583 Unicode code points with values less than 256 are compatible with ASCII and
9584 ISO-8859-1 (also known as Latin-1).
9585 For example, character 169 is the copyright symbol in both cases, though the
9586 way it is encoded is different. In UTF-8, more than one byte is needed for
9587 characters with code values greater than 127, whereas ISO-8859-1 is a
9588 single-byte encoding (but thereby limited to 256 characters). This makes
9589 translation from UTF-8 to ISO-8859-1 straightforward.
9590
9591
9592 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9593 .cindex "hash function" "textual"
9594 .cindex "expansion" "textual hash"
9595 The &%hash%& operator is a simpler interface to the hashing function that can
9596 be used when the two parameters are fixed numbers (as opposed to strings that
9597 change when expanded). The effect is the same as
9598 .code
9599 ${hash{<n>}{<m>}{<string>}}
9600 .endd
9601 See the description of the general &%hash%& item above for details. The
9602 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9603
9604
9605
9606 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9607 .cindex "base64 encoding" "conversion from hex"
9608 .cindex "expansion" "hex to base64"
9609 .cindex "&%hex2b64%& expansion item"
9610 This operator converts a hex string into one that is base64 encoded. This can
9611 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9612
9613
9614 .vitem &*${lc:*&<&'string'&>&*}*&
9615 .cindex "case forcing in strings"
9616 .cindex "string" "case forcing"
9617 .cindex "lower casing"
9618 .cindex "expansion" "case forcing"
9619 .cindex "&%lc%& expansion item"
9620 This forces the letters in the string into lower-case, for example:
9621 .code
9622 ${lc:$local_part}
9623 .endd
9624
9625 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9626 .cindex "expansion" "string truncation"
9627 .cindex "&%length%& expansion item"
9628 The &%length%& operator is a simpler interface to the &%length%& function that
9629 can be used when the parameter is a fixed number (as opposed to a string that
9630 changes when expanded). The effect is the same as
9631 .code
9632 ${length{<number>}{<string>}}
9633 .endd
9634 See the description of the general &%length%& item above for details. Note that
9635 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9636 when &%length%& is used as an operator.
9637
9638
9639 .vitem &*${local_part:*&<&'string'&>&*}*&
9640 .cindex "expansion" "local part extraction"
9641 .cindex "&%local_part%& expansion item"
9642 The string is interpreted as an RFC 2822 address and the local part is
9643 extracted from it. If the string does not parse successfully, the result is
9644 empty.
9645
9646
9647 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9648 .cindex "masked IP address"
9649 .cindex "IP address" "masking"
9650 .cindex "CIDR notation"
9651 .cindex "expansion" "IP address masking"
9652 .cindex "&%mask%& expansion item"
9653 If the form of the string to be operated on is not an IP address followed by a
9654 slash and an integer (that is, a network address in CIDR notation), the
9655 expansion fails. Otherwise, this operator converts the IP address to binary,
9656 masks off the least significant bits according to the bit count, and converts
9657 the result back to text, with mask appended. For example,
9658 .code
9659 ${mask:10.111.131.206/28}
9660 .endd
9661 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9662 be mostly used for looking up masked addresses in files, the result for an IPv6
9663 address uses dots to separate components instead of colons, because colon
9664 terminates a key string in lsearch files. So, for example,
9665 .code
9666 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9667 .endd
9668 returns the string
9669 .code
9670 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9671 .endd
9672 Letters in IPv6 addresses are always output in lower case.
9673
9674
9675 .vitem &*${md5:*&<&'string'&>&*}*&
9676 .cindex "MD5 hash"
9677 .cindex "expansion" "MD5 hash"
9678 .cindex "&%md5%& expansion item"
9679 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9680 as a 32-digit hexadecimal number, in which any letters are in lower case.
9681
9682
9683 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9684 .cindex "expansion" "numeric hash"
9685 .cindex "hash function" "numeric"
9686 The &%nhash%& operator is a simpler interface to the numeric hashing function
9687 that can be used when the two parameters are fixed numbers (as opposed to
9688 strings that change when expanded). The effect is the same as
9689 .code
9690 ${nhash{<n>}{<m>}{<string>}}
9691 .endd
9692 See the description of the general &%nhash%& item above for details.
9693
9694
9695 .vitem &*${quote:*&<&'string'&>&*}*&
9696 .cindex "quoting" "in string expansions"
9697 .cindex "expansion" "quoting"
9698 .cindex "&%quote%& expansion item"
9699 The &%quote%& operator puts its argument into double quotes if it
9700 is an empty string or
9701 contains anything other than letters, digits, underscores, dots, and hyphens.
9702 Any occurrences of double quotes and backslashes are escaped with a backslash.
9703 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9704 respectively For example,
9705 .code
9706 ${quote:ab"*"cd}
9707 .endd
9708 becomes
9709 .code
9710 "ab\"*\"cd"
9711 .endd
9712 The place where this is useful is when the argument is a substitution from a
9713 variable or a message header.
9714
9715 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9716 .cindex "&%quote_local_part%& expansion item"
9717 This operator is like &%quote%&, except that it quotes the string only if
9718 required to do so by the rules of RFC 2822 for quoting local parts. For
9719 example, a plus sign would not cause quoting (but it would for &%quote%&).
9720 If you are creating a new email address from the contents of &$local_part$&
9721 (or any other unknown data), you should always use this operator.
9722
9723
9724 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9725 .cindex "quoting" "lookup-specific"
9726 This operator applies lookup-specific quoting rules to the string. Each
9727 query-style lookup type has its own quoting rules which are described with
9728 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9729 .code
9730 ${quote_ldap:two * two}
9731 .endd
9732 returns
9733 .code
9734 two%20%5C2A%20two
9735 .endd
9736 For single-key lookup types, no quoting is ever necessary and this operator
9737 yields an unchanged string.
9738
9739
9740 .vitem &*${randint:*&<&'n'&>&*}*&
9741 .cindex "random number"
9742 This operator returns a somewhat random number which is less than the
9743 supplied number and is at least 0.  The quality of this randomness depends
9744 on how Exim was built; the values are not suitable for keying material.
9745 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9746 Otherwise, the implementation may be arc4random(), random() seeded by
9747 srandomdev() or srandom(), or a custom implementation even weaker than
9748 random().
9749
9750
9751 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9752 .cindex "expansion" "IP address"
9753 This operator reverses an IP address; for IPv4 addresses, the result is in
9754 dotted-quad decimal form, while for IPv6 addreses the result is in
9755 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9756 for DNS.  For example,
9757 .code
9758 ${reverse_ip:192.0.2.4}
9759 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9760 .endd
9761 returns
9762 .code
9763 4.2.0.192
9764 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
9765 .endd
9766
9767
9768 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9769 .cindex "expansion" "RFC 2047"
9770 .cindex "RFC 2047" "expansion operator"
9771 .cindex "&%rfc2047%& expansion item"
9772 This operator encodes text according to the rules of RFC 2047. This is an
9773 encoding that is used in header lines to encode non-ASCII characters. It is
9774 assumed that the input string is in the encoding specified by the
9775 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9776 contains only characters in the range 33&--126, and no instances of the
9777 characters
9778 .code
9779 ? = ( ) < > @ , ; : \ " . [ ] _
9780 .endd
9781 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9782 string, using as many &"encoded words"& as necessary to encode all the
9783 characters.
9784
9785
9786 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9787 .cindex "expansion" "RFC 2047"
9788 .cindex "RFC 2047" "decoding"
9789 .cindex "&%rfc2047d%& expansion item"
9790 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9791 bytes are replaced by question marks. Characters are converted into the
9792 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9793 not recognized unless &%check_rfc2047_length%& is set false.
9794
9795 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9796 access a header line, RFC 2047 decoding is done automatically. You do not need
9797 to use this operator as well.
9798
9799
9800
9801 .vitem &*${rxquote:*&<&'string'&>&*}*&
9802 .cindex "quoting" "in regular expressions"
9803 .cindex "regular expressions" "quoting"
9804 .cindex "&%rxquote%& expansion item"
9805 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9806 characters in its argument. This is useful when substituting the values of
9807 variables or headers inside regular expressions.
9808
9809
9810 .vitem &*${sha1:*&<&'string'&>&*}*&
9811 .cindex "SHA-1 hash"
9812 .cindex "expansion" "SHA-1 hashing"
9813 .cindex "&%sha2%& expansion item"
9814 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9815 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9816
9817
9818 .vitem &*${stat:*&<&'string'&>&*}*&
9819 .cindex "expansion" "statting a file"
9820 .cindex "file" "extracting characteristics"
9821 .cindex "&%stat%& expansion item"
9822 The string, after expansion, must be a file path. A call to the &[stat()]&
9823 function is made for this path. If &[stat()]& fails, an error occurs and the
9824 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9825 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9826 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9827 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9828 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9829 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9830 can extract individual fields using the &%extract%& expansion item.
9831
9832 The use of the &%stat%& expansion in users' filter files can be locked out by
9833 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9834 systems for files larger than 2GB.
9835
9836 .vitem &*${str2b64:*&<&'string'&>&*}*&
9837 .cindex "expansion" "base64 encoding"
9838 .cindex "base64 encoding" "in string expansion"
9839 .cindex "&%str2b64%& expansion item"
9840 This operator converts a string into one that is base64 encoded.
9841
9842
9843
9844 .vitem &*${strlen:*&<&'string'&>&*}*&
9845 .cindex "expansion" "string length"
9846 .cindex "string" "length in expansion"
9847 .cindex "&%strlen%& expansion item"
9848 The item is replace by the length of the expanded string, expressed as a
9849 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9850
9851
9852 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9853 .cindex "&%substr%& expansion item"
9854 .cindex "substring extraction"
9855 .cindex "expansion" "substring expansion"
9856 The &%substr%& operator is a simpler interface to the &%substr%& function that
9857 can be used when the two parameters are fixed numbers (as opposed to strings
9858 that change when expanded). The effect is the same as
9859 .code
9860 ${substr{<start>}{<length>}{<string>}}
9861 .endd
9862 See the description of the general &%substr%& item above for details. The
9863 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9864
9865 .vitem &*${time_eval:*&<&'string'&>&*}*&
9866 .cindex "&%time_eval%& expansion item"
9867 .cindex "time interval" "decoding"
9868 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9869 seconds.
9870
9871 .vitem &*${time_interval:*&<&'string'&>&*}*&
9872 .cindex "&%time_interval%& expansion item"
9873 .cindex "time interval" "formatting"
9874 The argument (after sub-expansion) must be a sequence of decimal digits that
9875 represents an interval of time as a number of seconds. It is converted into a
9876 number of larger units and output in Exim's normal time format, for example,
9877 &`1w3d4h2m6s`&.
9878
9879 .vitem &*${uc:*&<&'string'&>&*}*&
9880 .cindex "case forcing in strings"
9881 .cindex "string" "case forcing"
9882 .cindex "upper casing"
9883 .cindex "expansion" "case forcing"
9884 .cindex "&%uc%& expansion item"
9885 This forces the letters in the string into upper-case.
9886 .endlist
9887
9888
9889
9890
9891
9892
9893 .section "Expansion conditions" "SECTexpcond"
9894 .scindex IIDexpcond "expansion" "conditions"
9895 The following conditions are available for testing by the &%${if%& construct
9896 while expanding strings:
9897
9898 .vlist
9899 .vitem &*!*&<&'condition'&>
9900 .cindex "expansion" "negating a condition"
9901 .cindex "negation" "in expansion condition"
9902 Preceding any condition with an exclamation mark negates the result of the
9903 condition.
9904
9905 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9906 .cindex "numeric comparison"
9907 .cindex "expansion" "numeric comparison"
9908 There are a number of symbolic operators for doing numeric comparisons. They
9909 are:
9910 .display
9911 &`=   `&   equal
9912 &`==  `&   equal
9913 &`>   `&   greater
9914 &`>=  `&   greater or equal
9915 &`<   `&   less
9916 &`<=  `&   less or equal
9917 .endd
9918 For example:
9919 .code
9920 ${if >{$message_size}{10M} ...
9921 .endd
9922 Note that the general negation operator provides for inequality testing. The
9923 two strings must take the form of optionally signed decimal integers,
9924 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9925 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9926 As a special case, the numerical value of an empty string is taken as
9927 zero.
9928
9929 In all cases, a relative comparator OP is testing if <&'string1'&> OP
9930 <&'string2'&>; the above example is checking if &$message_size$& is larger than
9931 10M, not if 10M is larger than &$message_size$&.
9932
9933
9934 .vitem &*bool&~{*&<&'string'&>&*}*&
9935 .cindex "expansion" "boolean parsing"
9936 .cindex "&%bool%& expansion condition"
9937 This condition turns a string holding a true or false representation into
9938 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9939 (case-insensitively); also positive integer numbers map to true if non-zero,
9940 false if zero.
9941 An empty string is treated as false.
9942 Leading and trailing whitespace is ignored;
9943 thus a string consisting only of whitespace is false.
9944 All other string values will result in expansion failure.
9945
9946 When combined with ACL variables, this expansion condition will let you
9947 make decisions in one place and act on those decisions in another place.
9948 For example:
9949 .code
9950 ${if bool{$acl_m_privileged_sender} ...
9951 .endd
9952
9953
9954 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9955 .cindex "expansion" "boolean parsing"
9956 .cindex "&%bool_lax%& expansion condition"
9957 Like &%bool%&, this condition turns a string into a boolean state.  But
9958 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9959 loose definition that the Router &%condition%& option uses.  The empty string
9960 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9961 true.  Leading and trailing whitespace is ignored.
9962
9963 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9964
9965 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9966 .cindex "expansion" "encrypted comparison"
9967 .cindex "encrypted strings, comparing"
9968 .cindex "&%crypteq%& expansion condition"
9969 This condition is included in the Exim binary if it is built to support any
9970 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9971 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9972 included in the binary.
9973
9974 The &%crypteq%& condition has two arguments. The first is encrypted and
9975 compared against the second, which is already encrypted. The second string may
9976 be in the LDAP form for storing encrypted strings, which starts with the
9977 encryption type in curly brackets, followed by the data. If the second string
9978 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
9979 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
9980 Typically this will be a field from a password file. An example of an encrypted
9981 string in LDAP form is:
9982 .code
9983 {md5}CY9rzUYh03PK3k6DJie09g==
9984 .endd
9985 If such a string appears directly in an expansion, the curly brackets have to
9986 be quoted, because they are part of the expansion syntax. For example:
9987 .code
9988 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
9989 .endd
9990 The following encryption types (whose names are matched case-independently) are
9991 supported:
9992
9993 .ilist
9994 .cindex "MD5 hash"
9995 .cindex "base64 encoding" "in encrypted password"
9996 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
9997 printable characters to compare with the remainder of the second string. If the
9998 length of the comparison string is 24, Exim assumes that it is base64 encoded
9999 (as in the above example). If the length is 32, Exim assumes that it is a
10000 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10001 comparison fails.
10002
10003 .next
10004 .cindex "SHA-1 hash"
10005 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10006 printable characters to compare with the remainder of the second string. If the
10007 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10008 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10009 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10010
10011 .next
10012 .cindex "&[crypt()]&"
10013 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10014 only the first eight characters of the password. However, in modern operating
10015 systems this is no longer true, and in many cases the entire password is used,
10016 whatever its length.
10017
10018 .next
10019 .cindex "&[crypt16()]&"
10020 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10021 use up to 16 characters of the password in some operating systems. Again, in
10022 modern operating systems, more characters may be used.
10023 .endlist
10024 Exim has its own version of &[crypt16()]&, which is just a double call to
10025 &[crypt()]&. For operating systems that have their own version, setting
10026 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10027 operating system version instead of its own. This option is set by default in
10028 the OS-dependent &_Makefile_& for those operating systems that are known to
10029 support &[crypt16()]&.
10030
10031 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10032 it was not using the same algorithm as some operating systems' versions. It
10033 turns out that as well as &[crypt16()]& there is a function called
10034 &[bigcrypt()]& in some operating systems. This may or may not use the same
10035 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10036
10037 However, since there is now a move away from the traditional &[crypt()]&
10038 functions towards using SHA1 and other algorithms, tidying up this area of
10039 Exim is seen as very low priority.
10040
10041 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10042 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10043 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10044 default is &`{crypt}`&. Whatever the default, you can always use either
10045 function by specifying it explicitly in curly brackets.
10046
10047 .vitem &*def:*&<&'variable&~name'&>
10048 .cindex "expansion" "checking for empty variable"
10049 .cindex "&%def%& expansion condition"
10050 The &%def%& condition must be followed by the name of one of the expansion
10051 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10052 variable does not contain the empty string. For example:
10053 .code
10054 ${if def:sender_ident {from $sender_ident}}
10055 .endd
10056 Note that the variable name is given without a leading &%$%& character. If the
10057 variable does not exist, the expansion fails.
10058
10059 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10060         &~&*def:h_*&<&'header&~name'&>&*:*&"
10061 .cindex "expansion" "checking header line existence"
10062 This condition is true if a message is being processed and the named header
10063 exists in the message. For example,
10064 .code
10065 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10066 .endd
10067 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10068 the header name must be terminated by a colon if white space does not follow.
10069
10070 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10071        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10072 .cindex "string" "comparison"
10073 .cindex "expansion" "string comparison"
10074 .cindex "&%eq%& expansion condition"
10075 .cindex "&%eqi%& expansion condition"
10076 The two substrings are first expanded. The condition is true if the two
10077 resulting strings are identical. For &%eq%& the comparison includes the case of
10078 letters, whereas for &%eqi%& the comparison is case-independent.
10079
10080 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10081 .cindex "expansion" "file existence test"
10082 .cindex "file" "existence test"
10083 .cindex "&%exists%&, expansion condition"
10084 The substring is first expanded and then interpreted as an absolute path. The
10085 condition is true if the named file (or directory) exists. The existence test
10086 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10087 users' filter files may be locked out by the system administrator.
10088
10089 .vitem &*first_delivery*&
10090 .cindex "delivery" "first"
10091 .cindex "first delivery"
10092 .cindex "expansion" "first delivery test"
10093 .cindex "&%first_delivery%& expansion condition"
10094 This condition, which has no data, is true during a message's first delivery
10095 attempt. It is false during any subsequent delivery attempts.
10096
10097
10098 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10099        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10100 .cindex "list" "iterative conditions"
10101 .cindex "expansion" "&*forall*& condition"
10102 .cindex "expansion" "&*forany*& condition"
10103 .vindex "&$item$&"
10104 These conditions iterate over a list. The first argument is expanded to form
10105 the list. By default, the list separator is a colon, but it can be changed by
10106 the normal method. The second argument is interpreted as a condition that is to
10107 be applied to each item in the list in turn. During the interpretation of the
10108 condition, the current list item is placed in a variable called &$item$&.
10109 .ilist
10110 For &*forany*&, interpretation stops if the condition is true for any item, and
10111 the result of the whole condition is true. If the condition is false for all
10112 items in the list, the overall condition is false.
10113 .next
10114 For &*forall*&, interpretation stops if the condition is false for any item,
10115 and the result of the whole condition is false. If the condition is true for
10116 all items in the list, the overall condition is true.
10117 .endlist
10118 Note that negation of &*forany*& means that the condition must be false for all
10119 items for the overall condition to succeed, and negation of &*forall*& means
10120 that the condition must be false for at least one item. In this example, the
10121 list separator is changed to a comma:
10122 .code
10123 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10124 .endd
10125 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10126 being processed, to enable these expansion items to be nested.
10127
10128
10129 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10130        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10131 .cindex "string" "comparison"
10132 .cindex "expansion" "string comparison"
10133 .cindex "&%ge%& expansion condition"
10134 .cindex "&%gei%& expansion condition"
10135 The two substrings are first expanded. The condition is true if the first
10136 string is lexically greater than or equal to the second string. For &%ge%& the
10137 comparison includes the case of letters, whereas for &%gei%& the comparison is
10138 case-independent.
10139
10140 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10141        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10142 .cindex "string" "comparison"
10143 .cindex "expansion" "string comparison"
10144 .cindex "&%gt%& expansion condition"
10145 .cindex "&%gti%& expansion condition"
10146 The two substrings are first expanded. The condition is true if the first
10147 string is lexically greater than the second string. For &%gt%& the comparison
10148 includes the case of letters, whereas for &%gti%& the comparison is
10149 case-independent.
10150
10151 .new
10152 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10153        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10154 .cindex "string" "comparison"
10155 .cindex "list" "iterative conditions"
10156 Both strings are expanded; the second string is treated as a list of simple
10157 strings; if the first string is a member of the second, then the condition
10158 is true.
10159
10160 These are simpler to use versions of the more powerful &*forany*& condition.
10161 Examples, and the &*forany*& equivalents:
10162 .code
10163 ${if inlist{needle}{foo:needle:bar}}
10164   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10165 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10166   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10167 .endd
10168 .wen
10169
10170 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10171        &*isip4&~{*&<&'string'&>&*}*& &&&
10172        &*isip6&~{*&<&'string'&>&*}*&
10173 .cindex "IP address" "testing string format"
10174 .cindex "string" "testing for IP address"
10175 .cindex "&%isip%& expansion condition"
10176 .cindex "&%isip4%& expansion condition"
10177 .cindex "&%isip6%& expansion condition"
10178 The substring is first expanded, and then tested to see if it has the form of
10179 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10180 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10181
10182 For an IPv4 address, the test is for four dot-separated components, each of
10183 which consists of from one to three digits. For an IPv6 address, up to eight
10184 colon-separated components are permitted, each containing from one to four
10185 hexadecimal digits. There may be fewer than eight components if an empty
10186 component (adjacent colons) is present. Only one empty component is permitted.
10187
10188 &*Note*&: The checks are just on the form of the address; actual numerical
10189 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10190 check. The main use of these tests is to distinguish between IP addresses and
10191 host names, or between IPv4 and IPv6 addresses. For example, you could use
10192 .code
10193 ${if isip4{$sender_host_address}...
10194 .endd
10195 to test which IP version an incoming SMTP connection is using.
10196
10197 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10198 .cindex "LDAP" "use for authentication"
10199 .cindex "expansion" "LDAP authentication test"
10200 .cindex "&%ldapauth%& expansion condition"
10201 This condition supports user authentication using LDAP. See section
10202 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10203 queries. For this use, the query must contain a user name and password. The
10204 query itself is not used, and can be empty. The condition is true if the
10205 password is not empty, and the user name and password are accepted by the LDAP
10206 server. An empty password is rejected without calling LDAP because LDAP binds
10207 with an empty password are considered anonymous regardless of the username, and
10208 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10209 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10210 this can be used.
10211
10212
10213 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10214        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10215 .cindex "string" "comparison"
10216 .cindex "expansion" "string comparison"
10217 .cindex "&%le%& expansion condition"
10218 .cindex "&%lei%& expansion condition"
10219 The two substrings are first expanded. The condition is true if the first
10220 string is lexically less than or equal to the second string. For &%le%& the
10221 comparison includes the case of letters, whereas for &%lei%& the comparison is
10222 case-independent.
10223
10224 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10225        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10226 .cindex "string" "comparison"
10227 .cindex "expansion" "string comparison"
10228 .cindex "&%lt%& expansion condition"
10229 .cindex "&%lti%& expansion condition"
10230 The two substrings are first expanded. The condition is true if the first
10231 string is lexically less than the second string. For &%lt%& the comparison
10232 includes the case of letters, whereas for &%lti%& the comparison is
10233 case-independent.
10234
10235
10236 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10237 .cindex "expansion" "regular expression comparison"
10238 .cindex "regular expressions" "match in expanded string"
10239 .cindex "&%match%& expansion condition"
10240 The two substrings are first expanded. The second is then treated as a regular
10241 expression and applied to the first. Because of the pre-expansion, if the
10242 regular expression contains dollar, or backslash characters, they must be
10243 escaped. Care must also be taken if the regular expression contains braces
10244 (curly brackets). A closing brace must be escaped so that it is not taken as a
10245 premature termination of <&'string2'&>. The easiest approach is to use the
10246 &`\N`& feature to disable expansion of the regular expression.
10247 For example,
10248 .code
10249 ${if match {$local_part}{\N^\d{3}\N} ...
10250 .endd
10251 If the whole expansion string is in double quotes, further escaping of
10252 backslashes is also required.
10253
10254 The condition is true if the regular expression match succeeds.
10255 The regular expression is not required to begin with a circumflex
10256 metacharacter, but if there is no circumflex, the expression is not anchored,
10257 and it may match anywhere in the subject, not just at the start. If you want
10258 the pattern to match at the end of the subject, you must include the &`$`&
10259 metacharacter at an appropriate point.
10260
10261 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10262 At the start of an &%if%& expansion the values of the numeric variable
10263 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10264 succeeds causes them to be reset to the substrings of that condition and they
10265 will have these values during the expansion of the success string. At the end
10266 of the &%if%& expansion, the previous values are restored. After testing a
10267 combination of conditions using &%or%&, the subsequent values of the numeric
10268 variables are those of the condition that succeeded.
10269
10270 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10271 .cindex "&%match_address%& expansion condition"
10272 See &*match_local_part*&.
10273
10274 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10275 .cindex "&%match_domain%& expansion condition"
10276 See &*match_local_part*&.
10277
10278 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10279 .cindex "&%match_ip%& expansion condition"
10280 .new
10281 This condition matches an IP address to a list of IP address patterns. It must
10282 be followed by two argument strings. The first (after expansion) must be an IP
10283 address or an empty string. The second (not expanded) is a restricted host
10284 list that can match only an IP address, not a host name. For example:
10285 .wen
10286 .code
10287 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10288 .endd
10289 The specific types of host list item that are permitted in the list are:
10290
10291 .ilist
10292 An IP address, optionally with a CIDR mask.
10293 .next
10294 A single asterisk, which matches any IP address.
10295 .next
10296 An empty item, which matches only if the IP address is empty. This could be
10297 useful for testing for a locally submitted message or one from specific hosts
10298 in a single test such as
10299 . ==== As this is a nested list, any displays it contains must be indented
10300 . ==== as otherwise they are too far to the left. This comment applies to
10301 . ==== the use of xmlto plus fop. There's no problem when formatting with
10302 . ==== sdop, with or without the extra indent.
10303 .code
10304   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10305 .endd
10306 where the first item in the list is the empty string.
10307 .next
10308 The item @[] matches any of the local host's interface addresses.
10309 .next
10310 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10311 even if &`net-`& is not specified. There is never any attempt to turn the IP
10312 address into a host name. The most common type of linear search for
10313 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10314 masks. For example:
10315 .code
10316   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10317 .endd
10318 It is of course possible to use other kinds of lookup, and in such a case, you
10319 do need to specify the &`net-`& prefix if you want to specify a specific
10320 address mask, for example:
10321 .code
10322   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10323 .endd
10324 However, unless you are combining a &%match_ip%& condition with others, it is
10325 just as easy to use the fact that a lookup is itself a condition, and write:
10326 .code
10327   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10328 .endd
10329 .endlist ilist
10330
10331 .new
10332 Note that <&'string2'&> is not itself subject to string expansion, unless
10333 Exim was built with the EXPAND_LISTMATCH_RHS option.
10334 .wen
10335
10336 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10337
10338 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10339 .cindex "domain list" "in expansion condition"
10340 .cindex "address list" "in expansion condition"
10341 .cindex "local part" "list, in expansion condition"
10342 .cindex "&%match_local_part%& expansion condition"
10343 This condition, together with &%match_address%& and &%match_domain%&, make it
10344 possible to test domain, address, and local part lists within expansions. Each
10345 condition requires two arguments: an item and a list to match. A trivial
10346 example is:
10347 .code
10348 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10349 .endd
10350 In each case, the second argument may contain any of the allowable items for a
10351 list of the appropriate type. Also, because the second argument (after
10352 expansion) is a standard form of list, it is possible to refer to a named list.
10353 Thus, you can use conditions like this:
10354 .code
10355 ${if match_domain{$domain}{+local_domains}{...
10356 .endd
10357 .cindex "&`+caseful`&"
10358 For address lists, the matching starts off caselessly, but the &`+caseful`&
10359 item can be used, as in all address lists, to cause subsequent items to
10360 have their local parts matched casefully. Domains are always matched
10361 caselessly.
10362
10363 .new
10364 Note that <&'string2'&> is not itself subject to string expansion, unless
10365 Exim was built with the EXPAND_LISTMATCH_RHS option.
10366 .wen
10367
10368 &*Note*&: Host lists are &'not'& supported in this way. This is because
10369 hosts have two identities: a name and an IP address, and it is not clear
10370 how to specify cleanly how such a test would work. However, IP addresses can be
10371 matched using &%match_ip%&.
10372
10373 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10374 .cindex "PAM authentication"
10375 .cindex "AUTH" "with PAM"
10376 .cindex "Solaris" "PAM support"
10377 .cindex "expansion" "PAM authentication test"
10378 .cindex "&%pam%& expansion condition"
10379 &'Pluggable Authentication Modules'&
10380 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10381 available in the latest releases of Solaris and in some GNU/Linux
10382 distributions. The Exim support, which is intended for use in conjunction with
10383 the SMTP AUTH command, is available only if Exim is compiled with
10384 .code
10385 SUPPORT_PAM=yes
10386 .endd
10387 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10388 in some releases of GNU/Linux &%-ldl%& is also needed.
10389
10390 The argument string is first expanded, and the result must be a
10391 colon-separated list of strings. Leading and trailing white space is ignored.
10392 The PAM module is initialized with the service name &"exim"& and the user name
10393 taken from the first item in the colon-separated data string (<&'string1'&>).
10394 The remaining items in the data string are passed over in response to requests
10395 from the authentication function. In the simple case there will only be one
10396 request, for a password, so the data consists of just two strings.
10397
10398 There can be problems if any of the strings are permitted to contain colon
10399 characters. In the usual way, these have to be doubled to avoid being taken as
10400 separators. If the data is being inserted from a variable, the &%sg%& expansion
10401 item can be used to double any existing colons. For example, the configuration
10402 of a LOGIN authenticator might contain this setting:
10403 .code
10404 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10405 .endd
10406 For a PLAIN authenticator you could use:
10407 .code
10408 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10409 .endd
10410 In some operating systems, PAM authentication can be done only from a process
10411 running as root. Since Exim is running as the Exim user when receiving
10412 messages, this means that PAM cannot be used directly in those systems.
10413 A patched version of the &'pam_unix'& module that comes with the
10414 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10415 The patched module allows one special uid/gid combination, in addition to root,
10416 to authenticate. If you build the patched module to allow the Exim user and
10417 group, PAM can then be used from an Exim authenticator.
10418
10419
10420 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10421 .cindex "&'pwcheck'& daemon"
10422 .cindex "Cyrus"
10423 .cindex "expansion" "&'pwcheck'& authentication test"
10424 .cindex "&%pwcheck%& expansion condition"
10425 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10426 This is one way of making it possible for passwords to be checked by a process
10427 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10428 deprecated. Its replacement is &'saslauthd'& (see below).
10429
10430 The pwcheck support is not included in Exim by default. You need to specify
10431 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10432 building Exim. For example:
10433 .code
10434 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10435 .endd
10436 You do not need to install the full Cyrus software suite in order to use
10437 the pwcheck daemon. You can compile and install just the daemon alone
10438 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10439 access to the &_/var/pwcheck_& directory.
10440
10441 The &%pwcheck%& condition takes one argument, which must be the user name and
10442 password, separated by a colon. For example, in a LOGIN authenticator
10443 configuration, you might have this:
10444 .code
10445 server_condition = ${if pwcheck{$auth1:$auth2}}
10446 .endd
10447 Again, for a PLAIN authenticator configuration, this would be:
10448 .code
10449 server_condition = ${if pwcheck{$auth2:$auth3}}
10450 .endd
10451 .vitem &*queue_running*&
10452 .cindex "queue runner" "detecting when delivering from"
10453 .cindex "expansion" "queue runner test"
10454 .cindex "&%queue_running%& expansion condition"
10455 This condition, which has no data, is true during delivery attempts that are
10456 initiated by queue runner processes, and false otherwise.
10457
10458
10459 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10460 .cindex "Radius"
10461 .cindex "expansion" "Radius authentication"
10462 .cindex "&%radius%& expansion condition"
10463 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10464 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10465 the Radius client configuration file in order to build Exim with Radius
10466 support.
10467
10468 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10469 library, using the original API. If you are using release 0.4.0 or later of
10470 this library, you need to set
10471 .code
10472 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10473 .endd
10474 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10475 &%libradius%& library that comes with FreeBSD. To do this, set
10476 .code
10477 RADIUS_LIB_TYPE=RADLIB
10478 .endd
10479 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10480 You may also have to supply a suitable setting in EXTRALIBS so that the
10481 Radius library can be found when Exim is linked.
10482
10483 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10484 Radius client library, which calls the Radius server. The condition is true if
10485 the authentication is successful. For example:
10486 .code
10487 server_condition = ${if radius{<arguments>}}
10488 .endd
10489
10490
10491 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10492         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10493 .cindex "&'saslauthd'& daemon"
10494 .cindex "Cyrus"
10495 .cindex "expansion" "&'saslauthd'& authentication test"
10496 .cindex "&%saslauthd%& expansion condition"
10497 This condition supports user authentication using the Cyrus &'saslauthd'&
10498 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10499 Using this daemon is one way of making it possible for passwords to be checked
10500 by a process that is not running as root.
10501
10502 The saslauthd support is not included in Exim by default. You need to specify
10503 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10504 building Exim. For example:
10505 .code
10506 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10507 .endd
10508 You do not need to install the full Cyrus software suite in order to use
10509 the saslauthd daemon. You can compile and install just the daemon alone
10510 from the Cyrus SASL library.
10511
10512 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10513 two are mandatory. For example:
10514 .code
10515 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10516 .endd
10517 The service and the realm are optional (which is why the arguments are enclosed
10518 in their own set of braces). For details of the meaning of the service and
10519 realm, and how to run the daemon, consult the Cyrus documentation.
10520 .endlist vlist
10521
10522
10523
10524 .section "Combining expansion conditions" "SECID84"
10525 .cindex "expansion" "combining conditions"
10526 Several conditions can be tested at once by combining them using the &%and%&
10527 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10528 conditions on their own, and precede their lists of sub-conditions. Each
10529 sub-condition must be enclosed in braces within the overall braces that contain
10530 the list. No repetition of &%if%& is used.
10531
10532
10533 .vlist
10534 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10535 .cindex "&""or""& expansion condition"
10536 .cindex "expansion" "&""or""& of conditions"
10537 The sub-conditions are evaluated from left to right. The condition is true if
10538 any one of the sub-conditions is true.
10539 For example,
10540 .code
10541 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10542 .endd
10543 When a true sub-condition is found, the following ones are parsed but not
10544 evaluated. If there are several &"match"& sub-conditions the values of the
10545 numeric variables afterwards are taken from the first one that succeeds.
10546
10547 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10548 .cindex "&""and""& expansion condition"
10549 .cindex "expansion" "&""and""& of conditions"
10550 The sub-conditions are evaluated from left to right. The condition is true if
10551 all of the sub-conditions are true. If there are several &"match"&
10552 sub-conditions, the values of the numeric variables afterwards are taken from
10553 the last one. When a false sub-condition is found, the following ones are
10554 parsed but not evaluated.
10555 .endlist
10556 .ecindex IIDexpcond
10557
10558
10559
10560
10561 .section "Expansion variables" "SECTexpvar"
10562 .cindex "expansion" "variables, list of"
10563 This section contains an alphabetical list of all the expansion variables. Some
10564 of them are available only when Exim is compiled with specific options such as
10565 support for TLS or the content scanning extension.
10566
10567 .vlist
10568 .vitem "&$0$&, &$1$&, etc"
10569 .cindex "numerical variables (&$1$& &$2$& etc)"
10570 When a &%match%& expansion condition succeeds, these variables contain the
10571 captured substrings identified by the regular expression during subsequent
10572 processing of the success string of the containing &%if%& expansion item.
10573 However, they do not retain their values afterwards; in fact, their previous
10574 values are restored at the end of processing an &%if%& item. The numerical
10575 variables may also be set externally by some other matching process which
10576 precedes the expansion of the string. For example, the commands available in
10577 Exim filter files include an &%if%& command with its own regular expression
10578 matching condition.
10579
10580 .vitem "&$acl_c...$&"
10581 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10582 can be given any name that starts with &$acl_c$& and is at least six characters
10583 long, but the sixth character must be either a digit or an underscore. For
10584 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10585 variables persist throughout the lifetime of an SMTP connection. They can be
10586 used to pass information between ACLs and between different invocations of the
10587 same ACL. When a message is received, the values of these variables are saved
10588 with the message, and can be accessed by filters, routers, and transports
10589 during subsequent delivery.
10590
10591 .vitem "&$acl_m...$&"
10592 These variables are like the &$acl_c...$& variables, except that their values
10593 are reset after a message has been received. Thus, if several messages are
10594 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10595 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10596 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10597 message is received, the values of these variables are saved with the message,
10598 and can be accessed by filters, routers, and transports during subsequent
10599 delivery.
10600
10601 .vitem &$acl_verify_message$&
10602 .vindex "&$acl_verify_message$&"
10603 After an address verification has failed, this variable contains the failure
10604 message. It retains its value for use in subsequent modifiers. The message can
10605 be preserved by coding like this:
10606 .code
10607 warn !verify = sender
10608      set acl_m0 = $acl_verify_message
10609 .endd
10610 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10611 &%log_message%& modifiers, to include information about the verification
10612 failure.
10613
10614 .vitem &$address_data$&
10615 .vindex "&$address_data$&"
10616 This variable is set by means of the &%address_data%& option in routers. The
10617 value then remains with the address while it is processed by subsequent routers
10618 and eventually a transport. If the transport is handling multiple addresses,
10619 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10620 for more details. &*Note*&: The contents of &$address_data$& are visible in
10621 user filter files.
10622
10623 If &$address_data$& is set when the routers are called from an ACL to verify
10624 a recipient address, the final value is still in the variable for subsequent
10625 conditions and modifiers of the ACL statement. If routing the address caused it
10626 to be redirected to just one address, the child address is also routed as part
10627 of the verification, and in this case the final value of &$address_data$& is
10628 from the child's routing.
10629
10630 If &$address_data$& is set when the routers are called from an ACL to verify a
10631 sender address, the final value is also preserved, but this time in
10632 &$sender_address_data$&, to distinguish it from data from a recipient
10633 address.
10634
10635 In both cases (recipient and sender verification), the value does not persist
10636 after the end of the current ACL statement. If you want to preserve
10637 these values for longer, you can save them in ACL variables.
10638
10639 .vitem &$address_file$&
10640 .vindex "&$address_file$&"
10641 When, as a result of aliasing, forwarding, or filtering, a message is directed
10642 to a specific file, this variable holds the name of the file when the transport
10643 is running. At other times, the variable is empty. For example, using the
10644 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10645 .code
10646 /home/r2d2/savemail
10647 .endd
10648 then when the &(address_file)& transport is running, &$address_file$&
10649 contains the text string &`/home/r2d2/savemail`&.
10650 .cindex "Sieve filter" "value of &$address_file$&"
10651 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10652 then up to the transport configuration to generate an appropriate absolute path
10653 to the relevant file.
10654
10655 .vitem &$address_pipe$&
10656 .vindex "&$address_pipe$&"
10657 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10658 this variable holds the pipe command when the transport is running.
10659
10660 .vitem "&$auth1$& &-- &$auth3$&"
10661 .vindex "&$auth1$&, &$auth2$&, etc"
10662 These variables are used in SMTP authenticators (see chapters
10663 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10664
10665 .vitem &$authenticated_id$&
10666 .cindex "authentication" "id"
10667 .vindex "&$authenticated_id$&"
10668 When a server successfully authenticates a client it may be configured to
10669 preserve some of the authentication information in the variable
10670 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10671 user/password authenticator configuration might preserve the user name for use
10672 in the routers. Note that this is not the same information that is saved in
10673 &$sender_host_authenticated$&.
10674 When a message is submitted locally (that is, not over a TCP connection)
10675 the value of &$authenticated_id$& is normally the login name of the calling
10676 process. However, a trusted user can override this by means of the &%-oMai%&
10677 command line option.
10678
10679
10680
10681
10682 .vitem &$authenticated_sender$&
10683 .cindex "sender" "authenticated"
10684 .cindex "authentication" "sender"
10685 .cindex "AUTH" "on MAIL command"
10686 .vindex "&$authenticated_sender$&"
10687 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10688 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10689 described in section &<<SECTauthparamail>>&. Unless the data is the string
10690 &"<>"&, it is set as the authenticated sender of the message, and the value is
10691 available during delivery in the &$authenticated_sender$& variable. If the
10692 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10693
10694 .vindex "&$qualify_domain$&"
10695 When a message is submitted locally (that is, not over a TCP connection), the
10696 value of &$authenticated_sender$& is an address constructed from the login
10697 name of the calling process and &$qualify_domain$&, except that a trusted user
10698 can override this by means of the &%-oMas%& command line option.
10699
10700
10701 .vitem &$authentication_failed$&
10702 .cindex "authentication" "failure"
10703 .vindex "&$authentication_failed$&"
10704 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10705 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10706 possible to distinguish between &"did not try to authenticate"&
10707 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10708 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10709 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10710 negative response to an AUTH command, including (for example) an attempt to use
10711 an undefined mechanism.
10712
10713 .new
10714 .vitem &$av_failed$&
10715 .cindex "content scanning" "AV scanner failure"
10716 This variable is available when Exim is compiled with the content-scanning
10717 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10718 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10719 the ACL malware condition.
10720 .wen
10721
10722 .vitem &$body_linecount$&
10723 .cindex "message body" "line count"
10724 .cindex "body of message" "line count"
10725 .vindex "&$body_linecount$&"
10726 When a message is being received or delivered, this variable contains the
10727 number of lines in the message's body. See also &$message_linecount$&.
10728
10729 .vitem &$body_zerocount$&
10730 .cindex "message body" "binary zero count"
10731 .cindex "body of message" "binary zero count"
10732 .cindex "binary zero" "in message body"
10733 .vindex "&$body_zerocount$&"
10734 When a message is being received or delivered, this variable contains the
10735 number of binary zero bytes (ASCII NULs) in the message's body.
10736
10737 .vitem &$bounce_recipient$&
10738 .vindex "&$bounce_recipient$&"
10739 This is set to the recipient address of a bounce message while Exim is creating
10740 it. It is useful if a customized bounce message text file is in use (see
10741 chapter &<<CHAPemsgcust>>&).
10742
10743 .vitem &$bounce_return_size_limit$&
10744 .vindex "&$bounce_return_size_limit$&"
10745 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10746 up to a multiple of 1000. It is useful when a customized error message text
10747 file is in use (see chapter &<<CHAPemsgcust>>&).
10748
10749 .vitem &$caller_gid$&
10750 .cindex "gid (group id)" "caller"
10751 .vindex "&$caller_gid$&"
10752 The real group id under which the process that called Exim was running. This is
10753 not the same as the group id of the originator of a message (see
10754 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10755 incarnation normally contains the Exim gid.
10756
10757 .vitem &$caller_uid$&
10758 .cindex "uid (user id)" "caller"
10759 .vindex "&$caller_uid$&"
10760 The real user id under which the process that called Exim was running. This is
10761 not the same as the user id of the originator of a message (see
10762 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10763 incarnation normally contains the Exim uid.
10764
10765 .vitem &$compile_date$&
10766 .vindex "&$compile_date$&"
10767 The date on which the Exim binary was compiled.
10768
10769 .vitem &$compile_number$&
10770 .vindex "&$compile_number$&"
10771 The building process for Exim keeps a count of the number
10772 of times it has been compiled. This serves to distinguish different
10773 compilations of the same version of the program.
10774
10775 .vitem &$demime_errorlevel$&
10776 .vindex "&$demime_errorlevel$&"
10777 This variable is available when Exim is compiled with
10778 the content-scanning extension and the obsolete &%demime%& condition. For
10779 details, see section &<<SECTdemimecond>>&.
10780
10781 .vitem &$demime_reason$&
10782 .vindex "&$demime_reason$&"
10783 This variable is available when Exim is compiled with the
10784 content-scanning extension and the obsolete &%demime%& condition. For details,
10785 see section &<<SECTdemimecond>>&.
10786
10787 .vitem &$dnslist_domain$& &&&
10788        &$dnslist_matched$& &&&
10789        &$dnslist_text$& &&&
10790        &$dnslist_value$&
10791 .vindex "&$dnslist_domain$&"
10792 .vindex "&$dnslist_matched$&"
10793 .vindex "&$dnslist_text$&"
10794 .vindex "&$dnslist_value$&"
10795 .cindex "black list (DNS)"
10796 When a DNS (black) list lookup succeeds, these variables are set to contain
10797 the following data from the lookup: the list's domain name, the key that was
10798 looked up, the contents of any associated TXT record, and the value from the
10799 main A record. See section &<<SECID204>>& for more details.
10800
10801 .vitem &$domain$&
10802 .vindex "&$domain$&"
10803 When an address is being routed, or delivered on its own, this variable
10804 contains the domain. Uppercase letters in the domain are converted into lower
10805 case for &$domain$&.
10806
10807 Global address rewriting happens when a message is received, so the value of
10808 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10809 is set during user filtering, but not during system filtering, because a
10810 message may have many recipients and the system filter is called just once.
10811
10812 When more than one address is being delivered at once (for example, several
10813 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10814 have the same domain. Transports can be restricted to handling only one domain
10815 at a time if the value of &$domain$& is required at transport time &-- this is
10816 the default for local transports. For further details of the environment in
10817 which local transports are run, see chapter &<<CHAPenvironment>>&.
10818
10819 .oindex "&%delay_warning_condition%&"
10820 At the end of a delivery, if all deferred addresses have the same domain, it is
10821 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10822
10823 The &$domain$& variable is also used in some other circumstances:
10824
10825 .ilist
10826 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10827 the recipient address. The domain of the &'sender'& address is in
10828 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10829 normally set during the running of the MAIL ACL. However, if the sender address
10830 is verified with a callout during the MAIL ACL, the sender domain is placed in
10831 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10832 the &(smtp)& transport.
10833
10834 .next
10835 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10836 &$domain$& contains the domain portion of the address that is being rewritten;
10837 it can be used in the expansion of the replacement address, for example, to
10838 rewrite domains by file lookup.
10839
10840 .next
10841 With one important exception, whenever a domain list is being scanned,
10842 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10843 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10844 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10845 that, in a RCPT ACL, the sender domain list can be dependent on the
10846 recipient domain (which is what is in &$domain$& at this time).
10847
10848 .next
10849 .cindex "ETRN" "value of &$domain$&"
10850 .oindex "&%smtp_etrn_command%&"
10851 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10852 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10853 .endlist
10854
10855
10856 .vitem &$domain_data$&
10857 .vindex "&$domain_data$&"
10858 When the &%domains%& option on a router matches a domain by
10859 means of a lookup, the data read by the lookup is available during the running
10860 of the router as &$domain_data$&. In addition, if the driver routes the
10861 address to a transport, the value is available in that transport. If the
10862 transport is handling multiple addresses, the value from the first address is
10863 used.
10864
10865 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10866 domain by means of a lookup. The data read by the lookup is available during
10867 the rest of the ACL statement. In all other situations, this variable expands
10868 to nothing.
10869
10870 .vitem &$exim_gid$&
10871 .vindex "&$exim_gid$&"
10872 This variable contains the numerical value of the Exim group id.
10873
10874 .vitem &$exim_path$&
10875 .vindex "&$exim_path$&"
10876 This variable contains the path to the Exim binary.
10877
10878 .vitem &$exim_uid$&
10879 .vindex "&$exim_uid$&"
10880 This variable contains the numerical value of the Exim user id.
10881
10882 .vitem &$found_extension$&
10883 .vindex "&$found_extension$&"
10884 This variable is available when Exim is compiled with the
10885 content-scanning extension and the obsolete &%demime%& condition. For details,
10886 see section &<<SECTdemimecond>>&.
10887
10888 .vitem &$header_$&<&'name'&>
10889 This is not strictly an expansion variable. It is expansion syntax for
10890 inserting the message header line with the given name. Note that the name must
10891 be terminated by colon or white space, because it may contain a wide variety of
10892 characters. Note also that braces must &'not'& be used.
10893
10894 .vitem &$home$&
10895 .vindex "&$home$&"
10896 When the &%check_local_user%& option is set for a router, the user's home
10897 directory is placed in &$home$& when the check succeeds. In particular, this
10898 means it is set during the running of users' filter files. A router may also
10899 explicitly set a home directory for use by a transport; this can be overridden
10900 by a setting on the transport itself.
10901
10902 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10903 of the environment variable HOME.
10904
10905 .vitem &$host$&
10906 .vindex "&$host$&"
10907 If a router assigns an address to a transport (any transport), and passes a
10908 list of hosts with the address, the value of &$host$& when the transport starts
10909 to run is the name of the first host on the list. Note that this applies both
10910 to local and remote transports.
10911
10912 .cindex "transport" "filter"
10913 .cindex "filter" "transport filter"
10914 For the &(smtp)& transport, if there is more than one host, the value of
10915 &$host$& changes as the transport works its way through the list. In
10916 particular, when the &(smtp)& transport is expanding its options for encryption
10917 using TLS, or for specifying a transport filter (see chapter
10918 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10919 is connected.
10920
10921 When used in the client part of an authenticator configuration (see chapter
10922 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10923 client is connected.
10924
10925
10926 .vitem &$host_address$&
10927 .vindex "&$host_address$&"
10928 This variable is set to the remote host's IP address whenever &$host$& is set
10929 for a remote connection. It is also set to the IP address that is being checked
10930 when the &%ignore_target_hosts%& option is being processed.
10931
10932 .vitem &$host_data$&
10933 .vindex "&$host_data$&"
10934 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10935 result of the lookup is made available in the &$host_data$& variable. This
10936 allows you, for example, to do things like this:
10937 .code
10938 deny  hosts = net-lsearch;/some/file
10939 message = $host_data
10940 .endd
10941 .vitem &$host_lookup_deferred$&
10942 .cindex "host name" "lookup, failure of"
10943 .vindex "&$host_lookup_deferred$&"
10944 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10945 message comes from a remote host and there is an attempt to look up the host's
10946 name from its IP address, and the attempt is not successful, one of these
10947 variables is set to &"1"&.
10948
10949 .ilist
10950 If the lookup receives a definite negative response (for example, a DNS lookup
10951 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10952
10953 .next
10954 If there is any kind of problem during the lookup, such that Exim cannot
10955 tell whether or not the host name is defined (for example, a timeout for a DNS
10956 lookup), &$host_lookup_deferred$& is set to &"1"&.
10957 .endlist ilist
10958
10959 Looking up a host's name from its IP address consists of more than just a
10960 single reverse lookup. Exim checks that a forward lookup of at least one of the
10961 names it receives from a reverse lookup yields the original IP address. If this
10962 is not the case, Exim does not accept the looked up name(s), and
10963 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10964 IP address (for example, the existence of a PTR record in the DNS) is not
10965 sufficient on its own for the success of a host name lookup. If the reverse
10966 lookup succeeds, but there is a lookup problem such as a timeout when checking
10967 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10968 &"1"&. See also &$sender_host_name$&.
10969
10970 .vitem &$host_lookup_failed$&
10971 .vindex "&$host_lookup_failed$&"
10972 See &$host_lookup_deferred$&.
10973
10974
10975 .vitem &$inode$&
10976 .vindex "&$inode$&"
10977 The only time this variable is set is while expanding the &%directory_file%&
10978 option in the &(appendfile)& transport. The variable contains the inode number
10979 of the temporary file which is about to be renamed. It can be used to construct
10980 a unique name for the file.
10981
10982 .vitem &$interface_address$&
10983 .vindex "&$interface_address$&"
10984 This is an obsolete name for &$received_ip_address$&.
10985
10986 .vitem &$interface_port$&
10987 .vindex "&$interface_port$&"
10988 This is an obsolete name for &$received_port$&.
10989
10990 .vitem &$item$&
10991 .vindex "&$item$&"
10992 This variable is used during the expansion of &*forall*& and &*forany*&
10993 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
10994 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
10995 empty.
10996
10997 .vitem &$ldap_dn$&
10998 .vindex "&$ldap_dn$&"
10999 This variable, which is available only when Exim is compiled with LDAP support,
11000 contains the DN from the last entry in the most recently successful LDAP
11001 lookup.
11002
11003 .vitem &$load_average$&
11004 .vindex "&$load_average$&"
11005 This variable contains the system load average, multiplied by 1000 so that it
11006 is an integer. For example, if the load average is 0.21, the value of the
11007 variable is 210. The value is recomputed every time the variable is referenced.
11008
11009 .vitem &$local_part$&
11010 .vindex "&$local_part$&"
11011 When an address is being routed, or delivered on its own, this
11012 variable contains the local part. When a number of addresses are being
11013 delivered together (for example, multiple RCPT commands in an SMTP
11014 session), &$local_part$& is not set.
11015
11016 Global address rewriting happens when a message is received, so the value of
11017 &$local_part$& during routing and delivery is the value after rewriting.
11018 &$local_part$& is set during user filtering, but not during system filtering,
11019 because a message may have many recipients and the system filter is called just
11020 once.
11021
11022 .vindex "&$local_part_prefix$&"
11023 .vindex "&$local_part_suffix$&"
11024 If a local part prefix or suffix has been recognized, it is not included in the
11025 value of &$local_part$& during routing and subsequent delivery. The values of
11026 any prefix or suffix are in &$local_part_prefix$& and
11027 &$local_part_suffix$&, respectively.
11028
11029 When a message is being delivered to a file, pipe, or autoreply transport as a
11030 result of aliasing or forwarding, &$local_part$& is set to the local part of
11031 the parent address, not to the file name or command (see &$address_file$& and
11032 &$address_pipe$&).
11033
11034 When an ACL is running for a RCPT command, &$local_part$& contains the
11035 local part of the recipient address.
11036
11037 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11038 &$local_part$& contains the local part of the address that is being rewritten;
11039 it can be used in the expansion of the replacement address, for example.
11040
11041 In all cases, all quoting is removed from the local part. For example, for both
11042 the addresses
11043 .code
11044 "abc:xyz"@test.example
11045 abc\:xyz@test.example
11046 .endd
11047 the value of &$local_part$& is
11048 .code
11049 abc:xyz
11050 .endd
11051 If you use &$local_part$& to create another address, you should always wrap it
11052 inside a quoting operator. For example, in a &(redirect)& router you could
11053 have:
11054 .code
11055 data = ${quote_local_part:$local_part}@new.domain.example
11056 .endd
11057 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11058 to process local parts in a case-dependent manner in a router, you can set the
11059 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11060
11061 .vitem &$local_part_data$&
11062 .vindex "&$local_part_data$&"
11063 When the &%local_parts%& option on a router matches a local part by means of a
11064 lookup, the data read by the lookup is available during the running of the
11065 router as &$local_part_data$&. In addition, if the driver routes the address
11066 to a transport, the value is available in that transport. If the transport is
11067 handling multiple addresses, the value from the first address is used.
11068
11069 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11070 matches a local part by means of a lookup. The data read by the lookup is
11071 available during the rest of the ACL statement. In all other situations, this
11072 variable expands to nothing.
11073
11074 .vitem &$local_part_prefix$&
11075 .vindex "&$local_part_prefix$&"
11076 When an address is being routed or delivered, and a
11077 specific prefix for the local part was recognized, it is available in this
11078 variable, having been removed from &$local_part$&.
11079
11080 .vitem &$local_part_suffix$&
11081 .vindex "&$local_part_suffix$&"
11082 When an address is being routed or delivered, and a
11083 specific suffix for the local part was recognized, it is available in this
11084 variable, having been removed from &$local_part$&.
11085
11086 .vitem &$local_scan_data$&
11087 .vindex "&$local_scan_data$&"
11088 This variable contains the text returned by the &[local_scan()]& function when
11089 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11090
11091 .vitem &$local_user_gid$&
11092 .vindex "&$local_user_gid$&"
11093 See &$local_user_uid$&.
11094
11095 .vitem &$local_user_uid$&
11096 .vindex "&$local_user_uid$&"
11097 This variable and &$local_user_gid$& are set to the uid and gid after the
11098 &%check_local_user%& router precondition succeeds. This means that their values
11099 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11100 and &%condition%&), for the &%address_data%& expansion, and for any
11101 router-specific expansions. At all other times, the values in these variables
11102 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11103
11104 .vitem &$localhost_number$&
11105 .vindex "&$localhost_number$&"
11106 This contains the expanded value of the
11107 &%localhost_number%& option. The expansion happens after the main options have
11108 been read.
11109
11110 .vitem &$log_inodes$&
11111 .vindex "&$log_inodes$&"
11112 The number of free inodes in the disk partition where Exim's
11113 log files are being written. The value is recalculated whenever the variable is
11114 referenced. If the relevant file system does not have the concept of inodes,
11115 the value of is -1. See also the &%check_log_inodes%& option.
11116
11117 .vitem &$log_space$&
11118 .vindex "&$log_space$&"
11119 The amount of free space (as a number of kilobytes) in the disk
11120 partition where Exim's log files are being written. The value is recalculated
11121 whenever the variable is referenced. If the operating system does not have the
11122 ability to find the amount of free space (only true for experimental systems),
11123 the space value is -1. See also the &%check_log_space%& option.
11124
11125
11126 .vitem &$mailstore_basename$&
11127 .vindex "&$mailstore_basename$&"
11128 This variable is set only when doing deliveries in &"mailstore"& format in the
11129 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11130 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11131 contains the basename of the files that are being written, that is, the name
11132 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11133 variable is empty.
11134
11135 .vitem &$malware_name$&
11136 .vindex "&$malware_name$&"
11137 This variable is available when Exim is compiled with the
11138 content-scanning extension. It is set to the name of the virus that was found
11139 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11140
11141 .vitem &$max_received_linelength$&
11142 .vindex "&$max_received_linelength$&"
11143 .cindex "maximum" "line length"
11144 .cindex "line length" "maximum"
11145 This variable contains the number of bytes in the longest line that was
11146 received as part of the message, not counting the line termination
11147 character(s).
11148
11149 .vitem &$message_age$&
11150 .cindex "message" "age of"
11151 .vindex "&$message_age$&"
11152 This variable is set at the start of a delivery attempt to contain the number
11153 of seconds since the message was received. It does not change during a single
11154 delivery attempt.
11155
11156 .vitem &$message_body$&
11157 .cindex "body of message" "expansion variable"
11158 .cindex "message body" "in expansion"
11159 .cindex "binary zero" "in message body"
11160 .vindex "&$message_body$&"
11161 .oindex "&%message_body_visible%&"
11162 This variable contains the initial portion of a message's body while it is
11163 being delivered, and is intended mainly for use in filter files. The maximum
11164 number of characters of the body that are put into the variable is set by the
11165 &%message_body_visible%& configuration option; the default is 500.
11166
11167 .oindex "&%message_body_newlines%&"
11168 By default, newlines are converted into spaces in &$message_body$&, to make it
11169 easier to search for phrases that might be split over a line break. However,
11170 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11171 zeros are always converted into spaces.
11172
11173 .vitem &$message_body_end$&
11174 .cindex "body of message" "expansion variable"
11175 .cindex "message body" "in expansion"
11176 .vindex "&$message_body_end$&"
11177 This variable contains the final portion of a message's
11178 body while it is being delivered. The format and maximum size are as for
11179 &$message_body$&.
11180
11181 .vitem &$message_body_size$&
11182 .cindex "body of message" "size"
11183 .cindex "message body" "size"
11184 .vindex "&$message_body_size$&"
11185 When a message is being delivered, this variable contains the size of the body
11186 in bytes. The count starts from the character after the blank line that
11187 separates the body from the header. Newlines are included in the count. See
11188 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11189
11190 .vitem &$message_exim_id$&
11191 .vindex "&$message_exim_id$&"
11192 When a message is being received or delivered, this variable contains the
11193 unique message id that is generated and used by Exim to identify the message.
11194 An id is not created for a message until after its header has been successfully
11195 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11196 line; it is the local id that Exim assigns to the message, for example:
11197 &`1BXTIK-0001yO-VA`&.
11198
11199 .vitem &$message_headers$&
11200 .vindex &$message_headers$&
11201 This variable contains a concatenation of all the header lines when a message
11202 is being processed, except for lines added by routers or transports. The header
11203 lines are separated by newline characters. Their contents are decoded in the
11204 same way as a header line that is inserted by &%bheader%&.
11205
11206 .vitem &$message_headers_raw$&
11207 .vindex &$message_headers_raw$&
11208 This variable is like &$message_headers$& except that no processing of the
11209 contents of header lines is done.
11210
11211 .vitem &$message_id$&
11212 This is an old name for &$message_exim_id$&, which is now deprecated.
11213
11214 .vitem &$message_linecount$&
11215 .vindex "&$message_linecount$&"
11216 This variable contains the total number of lines in the header and body of the
11217 message. Compare &$body_linecount$&, which is the count for the body only.
11218 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11219 number of lines received. Before delivery happens (that is, before filters,
11220 routers, and transports run) the count is increased to include the
11221 &'Received:'& header line that Exim standardly adds, and also any other header
11222 lines that are added by ACLs. The blank line that separates the message header
11223 from the body is not counted.
11224
11225 As with the special case of &$message_size$&, during the expansion of the
11226 appendfile transport's maildir_tag option in maildir format, the value of
11227 &$message_linecount$& is the precise size of the number of newlines in the
11228 file that has been written (minus one for the blank line between the
11229 header and the body).
11230
11231 Here is an example of the use of this variable in a DATA ACL:
11232 .code
11233 deny message   = Too many lines in message header
11234      condition = \
11235       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11236 .endd
11237 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11238 message has not yet been received.
11239
11240 .vitem &$message_size$&
11241 .cindex "size" "of message"
11242 .cindex "message" "size"
11243 .vindex "&$message_size$&"
11244 When a message is being processed, this variable contains its size in bytes. In
11245 most cases, the size includes those headers that were received with the
11246 message, but not those (such as &'Envelope-to:'&) that are added to individual
11247 deliveries as they are written. However, there is one special case: during the
11248 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11249 doing a delivery in maildir format, the value of &$message_size$& is the
11250 precise size of the file that has been written. See also
11251 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11252
11253 .cindex "RCPT" "value of &$message_size$&"
11254 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11255 contains the size supplied on the MAIL command, or -1 if no size was given. The
11256 value may not, of course, be truthful.
11257
11258 .vitem &$mime_$&&'xxx'&
11259 A number of variables whose names start with &$mime$& are
11260 available when Exim is compiled with the content-scanning extension. For
11261 details, see section &<<SECTscanmimepart>>&.
11262
11263 .vitem "&$n0$& &-- &$n9$&"
11264 These variables are counters that can be incremented by means
11265 of the &%add%& command in filter files.
11266
11267 .vitem &$original_domain$&
11268 .vindex "&$domain$&"
11269 .vindex "&$original_domain$&"
11270 When a top-level address is being processed for delivery, this contains the
11271 same value as &$domain$&. However, if a &"child"& address (for example,
11272 generated by an alias, forward, or filter file) is being processed, this
11273 variable contains the domain of the original address (lower cased). This
11274 differs from &$parent_domain$& only when there is more than one level of
11275 aliasing or forwarding. When more than one address is being delivered in a
11276 single transport run, &$original_domain$& is not set.
11277
11278 If a new address is created by means of a &%deliver%& command in a system
11279 filter, it is set up with an artificial &"parent"& address. This has the local
11280 part &'system-filter'& and the default qualify domain.
11281
11282 .vitem &$original_local_part$&
11283 .vindex "&$local_part$&"
11284 .vindex "&$original_local_part$&"
11285 When a top-level address is being processed for delivery, this contains the
11286 same value as &$local_part$&, unless a prefix or suffix was removed from the
11287 local part, because &$original_local_part$& always contains the full local
11288 part. When a &"child"& address (for example, generated by an alias, forward, or
11289 filter file) is being processed, this variable contains the full local part of
11290 the original address.
11291
11292 If the router that did the redirection processed the local part
11293 case-insensitively, the value in &$original_local_part$& is in lower case.
11294 This variable differs from &$parent_local_part$& only when there is more than
11295 one level of aliasing or forwarding. When more than one address is being
11296 delivered in a single transport run, &$original_local_part$& is not set.
11297
11298 If a new address is created by means of a &%deliver%& command in a system
11299 filter, it is set up with an artificial &"parent"& address. This has the local
11300 part &'system-filter'& and the default qualify domain.
11301
11302 .vitem &$originator_gid$&
11303 .cindex "gid (group id)" "of originating user"
11304 .cindex "sender" "gid"
11305 .vindex "&$caller_gid$&"
11306 .vindex "&$originator_gid$&"
11307 This variable contains the value of &$caller_gid$& that was set when the
11308 message was received. For messages received via the command line, this is the
11309 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11310 normally the gid of the Exim user.
11311
11312 .vitem &$originator_uid$&
11313 .cindex "uid (user id)" "of originating user"
11314 .cindex "sender" "uid"
11315 .vindex "&$caller_uid$&"
11316 .vindex "&$originaltor_uid$&"
11317 The value of &$caller_uid$& that was set when the message was received. For
11318 messages received via the command line, this is the uid of the sending user.
11319 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11320 user.
11321
11322 .vitem &$parent_domain$&
11323 .vindex "&$parent_domain$&"
11324 This variable is similar to &$original_domain$& (see
11325 above), except that it refers to the immediately preceding parent address.
11326
11327 .vitem &$parent_local_part$&
11328 .vindex "&$parent_local_part$&"
11329 This variable is similar to &$original_local_part$&
11330 (see above), except that it refers to the immediately preceding parent address.
11331
11332 .vitem &$pid$&
11333 .cindex "pid (process id)" "of current process"
11334 .vindex "&$pid$&"
11335 This variable contains the current process id.
11336
11337 .vitem &$pipe_addresses$&
11338 .cindex "filter" "transport filter"
11339 .cindex "transport" "filter"
11340 .vindex "&$pipe_addresses$&"
11341 This is not an expansion variable, but is mentioned here because the string
11342 &`$pipe_addresses`& is handled specially in the command specification for the
11343 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11344 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11345 It cannot be used in general expansion strings, and provokes an &"unknown
11346 variable"& error if encountered.
11347
11348 .vitem &$primary_hostname$&
11349 .vindex "&$primary_hostname$&"
11350 This variable contains the value set by &%primary_hostname%& in the
11351 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11352 a single-component name, Exim calls &[gethostbyname()]& (or
11353 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11354 qualified host name. See also &$smtp_active_hostname$&.
11355
11356
11357 .vitem &$prvscheck_address$&
11358 This variable is used in conjunction with the &%prvscheck%& expansion item,
11359 which is described in sections &<<SECTexpansionitems>>& and
11360 &<<SECTverifyPRVS>>&.
11361
11362 .vitem &$prvscheck_keynum$&
11363 This variable is used in conjunction with the &%prvscheck%& expansion item,
11364 which is described in sections &<<SECTexpansionitems>>& and
11365 &<<SECTverifyPRVS>>&.
11366
11367 .vitem &$prvscheck_result$&
11368 This variable is used in conjunction with the &%prvscheck%& expansion item,
11369 which is described in sections &<<SECTexpansionitems>>& and
11370 &<<SECTverifyPRVS>>&.
11371
11372 .vitem &$qualify_domain$&
11373 .vindex "&$qualify_domain$&"
11374 The value set for the &%qualify_domain%& option in the configuration file.
11375
11376 .vitem &$qualify_recipient$&
11377 .vindex "&$qualify_recipient$&"
11378 The value set for the &%qualify_recipient%& option in the configuration file,
11379 or if not set, the value of &$qualify_domain$&.
11380
11381 .vitem &$rcpt_count$&
11382 .vindex "&$rcpt_count$&"
11383 When a message is being received by SMTP, this variable contains the number of
11384 RCPT commands received for the current message. If this variable is used in a
11385 RCPT ACL, its value includes the current command.
11386
11387 .vitem &$rcpt_defer_count$&
11388 .vindex "&$rcpt_defer_count$&"
11389 .cindex "4&'xx'& responses" "count of"
11390 When a message is being received by SMTP, this variable contains the number of
11391 RCPT commands in the current message that have previously been rejected with a
11392 temporary (4&'xx'&) response.
11393
11394 .vitem &$rcpt_fail_count$&
11395 .vindex "&$rcpt_fail_count$&"
11396 When a message is being received by SMTP, this variable contains the number of
11397 RCPT commands in the current message that have previously been rejected with a
11398 permanent (5&'xx'&) response.
11399
11400 .vitem &$received_count$&
11401 .vindex "&$received_count$&"
11402 This variable contains the number of &'Received:'& header lines in the message,
11403 including the one added by Exim (so its value is always greater than zero). It
11404 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11405 delivering.
11406
11407 .vitem &$received_for$&
11408 .vindex "&$received_for$&"
11409 If there is only a single recipient address in an incoming message, this
11410 variable contains that address when the &'Received:'& header line is being
11411 built. The value is copied after recipient rewriting has happened, but before
11412 the &[local_scan()]& function is run.
11413
11414 .vitem &$received_ip_address$&
11415 .vindex "&$received_ip_address$&"
11416 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11417 variable is set to the address of the local IP interface, and &$received_port$&
11418 is set to the local port number. (The remote IP address and port are in
11419 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11420 the port value is -1 unless it has been set using the &%-oMi%& command line
11421 option.
11422
11423 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11424 could be used, for example, to make the file name for a TLS certificate depend
11425 on which interface and/or port is being used for the incoming connection. The
11426 values of &$received_ip_address$& and &$received_port$& are saved with any
11427 messages that are received, thus making these variables available at delivery
11428 time.
11429
11430 &*Note:*& There are no equivalent variables for outgoing connections, because
11431 the values are unknown (unless they are explicitly set by options of the
11432 &(smtp)& transport).
11433
11434 .vitem &$received_port$&
11435 .vindex "&$received_port$&"
11436 See &$received_ip_address$&.
11437
11438 .vitem &$received_protocol$&
11439 .vindex "&$received_protocol$&"
11440 When a message is being processed, this variable contains the name of the
11441 protocol by which it was received. Most of the names used by Exim are defined
11442 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11443 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11444 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11445 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11446 connection and the client was successfully authenticated.
11447
11448 Exim uses the protocol name &"smtps"& for the case when encryption is
11449 automatically set up on connection without the use of STARTTLS (see
11450 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11451 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11452 where the client initially uses EHLO, sets up an encrypted connection using
11453 STARTTLS, and then uses HELO afterwards.
11454
11455 The &%-oMr%& option provides a way of specifying a custom protocol name for
11456 messages that are injected locally by trusted callers. This is commonly used to
11457 identify messages that are being re-injected after some kind of scanning.
11458
11459 .vitem &$received_time$&
11460 .vindex "&$received_time$&"
11461 This variable contains the date and time when the current message was received,
11462 as a number of seconds since the start of the Unix epoch.
11463
11464 .vitem &$recipient_data$&
11465 .vindex "&$recipient_data$&"
11466 This variable is set after an indexing lookup success in an ACL &%recipients%&
11467 condition. It contains the data from the lookup, and the value remains set
11468 until the next &%recipients%& test. Thus, you can do things like this:
11469 .display
11470 &`require recipients  = cdb*@;/some/file`&
11471 &`deny    `&&'some further test involving'& &`$recipient_data`&
11472 .endd
11473 &*Warning*&: This variable is set only when a lookup is used as an indexing
11474 method in the address list, using the semicolon syntax as in the example above.
11475 The variable is not set for a lookup that is used as part of the string
11476 expansion that all such lists undergo before being interpreted.
11477
11478 .vitem &$recipient_verify_failure$&
11479 .vindex "&$recipient_verify_failure$&"
11480 In an ACL, when a recipient verification fails, this variable contains
11481 information about the failure. It is set to one of the following words:
11482
11483 .ilist
11484 &"qualify"&: The address was unqualified (no domain), and the message
11485 was neither local nor came from an exempted host.
11486
11487 .next
11488 &"route"&: Routing failed.
11489
11490 .next
11491 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11492 or before the MAIL command (that is, on initial connection, HELO, or
11493 MAIL).
11494
11495 .next
11496 &"recipient"&: The RCPT command in a callout was rejected.
11497 .next
11498
11499 &"postmaster"&: The postmaster check in a callout was rejected.
11500 .endlist
11501
11502 The main use of this variable is expected to be to distinguish between
11503 rejections of MAIL and rejections of RCPT.
11504
11505 .vitem &$recipients$&
11506 .vindex "&$recipients$&"
11507 This variable contains a list of envelope recipients for a message. A comma and
11508 a space separate the addresses in the replacement text. However, the variable
11509 is not generally available, to prevent exposure of Bcc recipients in
11510 unprivileged users' filter files. You can use &$recipients$& only in these
11511 cases:
11512
11513 .olist
11514 In a system filter file.
11515 .next
11516 In the ACLs associated with the DATA command and with non-SMTP messages, that
11517 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11518 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11519 &%acl_not_smtp_mime%&.
11520 .next
11521 From within a &[local_scan()]& function.
11522 .endlist
11523
11524
11525 .vitem &$recipients_count$&
11526 .vindex "&$recipients_count$&"
11527 When a message is being processed, this variable contains the number of
11528 envelope recipients that came with the message. Duplicates are not excluded
11529 from the count. While a message is being received over SMTP, the number
11530 increases for each accepted recipient. It can be referenced in an ACL.
11531
11532
11533 .vitem &$regex_match_string$&
11534 .vindex "&$regex_match_string$&"
11535 This variable is set to contain the matching regular expression after a
11536 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11537
11538
11539 .vitem &$reply_address$&
11540 .vindex "&$reply_address$&"
11541 When a message is being processed, this variable contains the contents of the
11542 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11543 contents of the &'From:'& header line. Apart from the removal of leading
11544 white space, the value is not processed in any way. In particular, no RFC 2047
11545 decoding or character code translation takes place.
11546
11547 .vitem &$return_path$&
11548 .vindex "&$return_path$&"
11549 When a message is being delivered, this variable contains the return path &--
11550 the sender field that will be sent as part of the envelope. It is not enclosed
11551 in <> characters. At the start of routing an address, &$return_path$& has the
11552 same value as &$sender_address$&, but if, for example, an incoming message to a
11553 mailing list has been expanded by a router which specifies a different address
11554 for bounce messages, &$return_path$& subsequently contains the new bounce
11555 address, whereas &$sender_address$& always contains the original sender address
11556 that was received with the message. In other words, &$sender_address$& contains
11557 the incoming envelope sender, and &$return_path$& contains the outgoing
11558 envelope sender.
11559
11560 .vitem &$return_size_limit$&
11561 .vindex "&$return_size_limit$&"
11562 This is an obsolete name for &$bounce_return_size_limit$&.
11563
11564 .vitem &$runrc$&
11565 .cindex "return code" "from &%run%& expansion"
11566 .vindex "&$runrc$&"
11567 This variable contains the return code from a command that is run by the
11568 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11569 assume the order in which option values are expanded, except for those
11570 preconditions whose order of testing is documented. Therefore, you cannot
11571 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11572 another.
11573
11574 .vitem &$self_hostname$&
11575 .oindex "&%self%&" "value of host name"
11576 .vindex "&$self_hostname$&"
11577 When an address is routed to a supposedly remote host that turns out to be the
11578 local host, what happens is controlled by the &%self%& generic router option.
11579 One of its values causes the address to be passed to another router. When this
11580 happens, &$self_hostname$& is set to the name of the local host that the
11581 original router encountered. In other circumstances its contents are null.
11582
11583 .vitem &$sender_address$&
11584 .vindex "&$sender_address$&"
11585 When a message is being processed, this variable contains the sender's address
11586 that was received in the message's envelope. The case of letters in the address
11587 is retained, in both the local part and the domain. For bounce messages, the
11588 value of this variable is the empty string. See also &$return_path$&.
11589
11590 .vitem &$sender_address_data$&
11591 .vindex "&$address_data$&"
11592 .vindex "&$sender_address_data$&"
11593 If &$address_data$& is set when the routers are called from an ACL to verify a
11594 sender address, the final value is preserved in &$sender_address_data$&, to
11595 distinguish it from data from a recipient address. The value does not persist
11596 after the end of the current ACL statement. If you want to preserve it for
11597 longer, you can save it in an ACL variable.
11598
11599 .vitem &$sender_address_domain$&
11600 .vindex "&$sender_address_domain$&"
11601 The domain portion of &$sender_address$&.
11602
11603 .vitem &$sender_address_local_part$&
11604 .vindex "&$sender_address_local_part$&"
11605 The local part portion of &$sender_address$&.
11606
11607 .vitem &$sender_data$&
11608 .vindex "&$sender_data$&"
11609 This variable is set after a lookup success in an ACL &%senders%& condition or
11610 in a router &%senders%& option. It contains the data from the lookup, and the
11611 value remains set until the next &%senders%& test. Thus, you can do things like
11612 this:
11613 .display
11614 &`require senders      = cdb*@;/some/file`&
11615 &`deny    `&&'some further test involving'& &`$sender_data`&
11616 .endd
11617 &*Warning*&: This variable is set only when a lookup is used as an indexing
11618 method in the address list, using the semicolon syntax as in the example above.
11619 The variable is not set for a lookup that is used as part of the string
11620 expansion that all such lists undergo before being interpreted.
11621
11622 .vitem &$sender_fullhost$&
11623 .vindex "&$sender_fullhost$&"
11624 When a message is received from a remote host, this variable contains the host
11625 name and IP address in a single string. It ends with the IP address in square
11626 brackets, followed by a colon and a port number if the logging of ports is
11627 enabled. The format of the rest of the string depends on whether the host
11628 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11629 looking up its IP address. (Looking up the IP address can be forced by the
11630 &%host_lookup%& option, independent of verification.) A plain host name at the
11631 start of the string is a verified host name; if this is not present,
11632 verification either failed or was not requested. A host name in parentheses is
11633 the argument of a HELO or EHLO command. This is omitted if it is identical to
11634 the verified host name or to the host's IP address in square brackets.
11635
11636 .vitem &$sender_helo_name$&
11637 .vindex "&$sender_helo_name$&"
11638 When a message is received from a remote host that has issued a HELO or EHLO
11639 command, the argument of that command is placed in this variable. It is also
11640 set if HELO or EHLO is used when a message is received using SMTP locally via
11641 the &%-bs%& or &%-bS%& options.
11642
11643 .vitem &$sender_host_address$&
11644 .vindex "&$sender_host_address$&"
11645 When a message is received from a remote host, this variable contains that
11646 host's IP address. For locally submitted messages, it is empty.
11647
11648 .vitem &$sender_host_authenticated$&
11649 .vindex "&$sender_host_authenticated$&"
11650 This variable contains the name (not the public name) of the authenticator
11651 driver that successfully authenticated the client from which the message was
11652 received. It is empty if there was no successful authentication. See also
11653 &$authenticated_id$&.
11654
11655 .vitem &$sender_host_name$&
11656 .vindex "&$sender_host_name$&"
11657 When a message is received from a remote host, this variable contains the
11658 host's name as obtained by looking up its IP address. For messages received by
11659 other means, this variable is empty.
11660
11661 .vindex "&$host_lookup_failed$&"
11662 If the host name has not previously been looked up, a reference to
11663 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11664 A looked up name is accepted only if it leads back to the original IP address
11665 via a forward lookup. If either the reverse or the forward lookup fails to find
11666 any data, or if the forward lookup does not yield the original IP address,
11667 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11668
11669 .vindex "&$host_lookup_deferred$&"
11670 However, if either of the lookups cannot be completed (for example, there is a
11671 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11672 &$host_lookup_failed$& remains set to &"0"&.
11673
11674 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11675 host name again if there is a subsequent reference to &$sender_host_name$&
11676 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11677 is set to &"1"&.
11678
11679 Exim does not automatically look up every calling host's name. If you want
11680 maximum efficiency, you should arrange your configuration so that it avoids
11681 these lookups altogether. The lookup happens only if one or more of the
11682 following are true:
11683
11684 .ilist
11685 A string containing &$sender_host_name$& is expanded.
11686 .next
11687 The calling host matches the list in &%host_lookup%&. In the default
11688 configuration, this option is set to *, so it must be changed if lookups are
11689 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11690 .next
11691 Exim needs the host name in order to test an item in a host list. The items
11692 that require this are described in sections &<<SECThoslispatnam>>& and
11693 &<<SECThoslispatnamsk>>&.
11694 .next
11695 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11696 In this case, the host name is required to compare with the name quoted in any
11697 EHLO or HELO commands that the client issues.
11698 .next
11699 The remote host issues a EHLO or HELO command that quotes one of the
11700 domains in &%helo_lookup_domains%&. The default value of this option is
11701 . ==== As this is a nested list, any displays it contains must be indented
11702 . ==== as otherwise they are too far to the left.
11703 .code
11704   helo_lookup_domains = @ : @[]
11705 .endd
11706 which causes a lookup if a remote host (incorrectly) gives the server's name or
11707 IP address in an EHLO or HELO command.
11708 .endlist
11709
11710
11711 .vitem &$sender_host_port$&
11712 .vindex "&$sender_host_port$&"
11713 When a message is received from a remote host, this variable contains the port
11714 number that was used on the remote host.
11715
11716 .vitem &$sender_ident$&
11717 .vindex "&$sender_ident$&"
11718 When a message is received from a remote host, this variable contains the
11719 identification received in response to an RFC 1413 request. When a message has
11720 been received locally, this variable contains the login name of the user that
11721 called Exim.
11722
11723 .vitem &$sender_rate_$&&'xxx'&
11724 A number of variables whose names begin &$sender_rate_$& are set as part of the
11725 &%ratelimit%& ACL condition. Details are given in section
11726 &<<SECTratelimiting>>&.
11727
11728 .vitem &$sender_rcvhost$&
11729 .cindex "DNS" "reverse lookup"
11730 .cindex "reverse DNS lookup"
11731 .vindex "&$sender_rcvhost$&"
11732 This is provided specifically for use in &'Received:'& headers. It starts with
11733 either the verified host name (as obtained from a reverse DNS lookup) or, if
11734 there is no verified host name, the IP address in square brackets. After that
11735 there may be text in parentheses. When the first item is a verified host name,
11736 the first thing in the parentheses is the IP address in square brackets,
11737 followed by a colon and a port number if port logging is enabled. When the
11738 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11739 the parentheses.
11740
11741 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11742 was used and its argument was not identical to the real host name or IP
11743 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11744 all three items are present in the parentheses, a newline and tab are inserted
11745 into the string, to improve the formatting of the &'Received:'& header.
11746
11747 .vitem &$sender_verify_failure$&
11748 .vindex "&$sender_verify_failure$&"
11749 In an ACL, when a sender verification fails, this variable contains information
11750 about the failure. The details are the same as for
11751 &$recipient_verify_failure$&.
11752
11753 .vitem &$sending_ip_address$&
11754 .vindex "&$sending_ip_address$&"
11755 This variable is set whenever an outgoing SMTP connection to another host has
11756 been set up. It contains the IP address of the local interface that is being
11757 used. This is useful if a host that has more than one IP address wants to take
11758 on different personalities depending on which one is being used. For incoming
11759 connections, see &$received_ip_address$&.
11760
11761 .vitem &$sending_port$&
11762 .vindex "&$sending_port$&"
11763 This variable is set whenever an outgoing SMTP connection to another host has
11764 been set up. It contains the local port that is being used. For incoming
11765 connections, see &$received_port$&.
11766
11767 .vitem &$smtp_active_hostname$&
11768 .vindex "&$smtp_active_hostname$&"
11769 During an incoming SMTP session, this variable contains the value of the active
11770 host name, as specified by the &%smtp_active_hostname%& option. The value of
11771 &$smtp_active_hostname$& is saved with any message that is received, so its
11772 value can be consulted during routing and delivery.
11773
11774 .vitem &$smtp_command$&
11775 .vindex "&$smtp_command$&"
11776 During the processing of an incoming SMTP command, this variable contains the
11777 entire command. This makes it possible to distinguish between HELO and EHLO in
11778 the HELO ACL, and also to distinguish between commands such as these:
11779 .code
11780 MAIL FROM:<>
11781 MAIL FROM: <>
11782 .endd
11783 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11784 command, the address in &$smtp_command$& is the original address before any
11785 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11786 the address after SMTP-time rewriting.
11787
11788 .vitem &$smtp_command_argument$&
11789 .cindex "SMTP" "command, argument for"
11790 .vindex "&$smtp_command_argument$&"
11791 While an ACL is running to check an SMTP command, this variable contains the
11792 argument, that is, the text that follows the command name, with leading white
11793 space removed. Following the introduction of &$smtp_command$&, this variable is
11794 somewhat redundant, but is retained for backwards compatibility.
11795
11796 .vitem &$smtp_count_at_connection_start$&
11797 .vindex "&$smtp_count_at_connection_start$&"
11798 This variable is set greater than zero only in processes spawned by the Exim
11799 daemon for handling incoming SMTP connections. The name is deliberately long,
11800 in order to emphasize what the contents are. When the daemon accepts a new
11801 connection, it increments this variable. A copy of the variable is passed to
11802 the child process that handles the connection, but its value is fixed, and
11803 never changes. It is only an approximation of how many incoming connections
11804 there actually are, because many other connections may come and go while a
11805 single connection is being processed. When a child process terminates, the
11806 daemon decrements its copy of the variable.
11807
11808 .vitem "&$sn0$& &-- &$sn9$&"
11809 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11810 that were current at the end of the system filter file. This allows a system
11811 filter file to set values that can be tested in users' filter files. For
11812 example, a system filter could set a value indicating how likely it is that a
11813 message is junk mail.
11814
11815 .vitem &$spam_$&&'xxx'&
11816 A number of variables whose names start with &$spam$& are available when Exim
11817 is compiled with the content-scanning extension. For details, see section
11818 &<<SECTscanspamass>>&.
11819
11820
11821 .vitem &$spool_directory$&
11822 .vindex "&$spool_directory$&"
11823 The name of Exim's spool directory.
11824
11825 .vitem &$spool_inodes$&
11826 .vindex "&$spool_inodes$&"
11827 The number of free inodes in the disk partition where Exim's spool files are
11828 being written. The value is recalculated whenever the variable is referenced.
11829 If the relevant file system does not have the concept of inodes, the value of
11830 is -1. See also the &%check_spool_inodes%& option.
11831
11832 .vitem &$spool_space$&
11833 .vindex "&$spool_space$&"
11834 The amount of free space (as a number of kilobytes) in the disk partition where
11835 Exim's spool files are being written. The value is recalculated whenever the
11836 variable is referenced. If the operating system does not have the ability to
11837 find the amount of free space (only true for experimental systems), the space
11838 value is -1. For example, to check in an ACL that there is at least 50
11839 megabytes free on the spool, you could write:
11840 .code
11841 condition = ${if > {$spool_space}{50000}}
11842 .endd
11843 See also the &%check_spool_space%& option.
11844
11845
11846 .vitem &$thisaddress$&
11847 .vindex "&$thisaddress$&"
11848 This variable is set only during the processing of the &%foranyaddress%&
11849 command in a filter file. Its use is explained in the description of that
11850 command, which can be found in the separate document entitled &'Exim's
11851 interfaces to mail filtering'&.
11852
11853 .new
11854 .vitem &$tls_bits$&
11855 .vindex "&$tls_bits$&"
11856 Contains an approximation of the TLS cipher's bit-strength; the meaning of
11857 this depends upon the TLS implementation used.
11858 If TLS has not been negotiated, the value will be 0.
11859 The value of this is automatically fed into the Cyrus SASL authenticator
11860 when acting as a server, to specify the "external SSF" (a SASL term).
11861 .wen
11862
11863 .vitem &$tls_certificate_verified$&
11864 .vindex "&$tls_certificate_verified$&"
11865 This variable is set to &"1"& if a TLS certificate was verified when the
11866 message was received, and &"0"& otherwise.
11867
11868 .vitem &$tls_cipher$&
11869 .vindex "&$tls_cipher$&"
11870 When a message is received from a remote host over an encrypted SMTP
11871 connection, this variable is set to the cipher suite that was negotiated, for
11872 example DES-CBC3-SHA. In other circumstances, in particular, for message
11873 received over unencrypted connections, the variable is empty. Testing
11874 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11875 non-encrypted connections during ACL processing.
11876
11877 The &$tls_cipher$& variable retains its value during message delivery, except
11878 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11879 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11880 and then set to the outgoing cipher suite if one is negotiated. See chapter
11881 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11882 details of the &(smtp)& transport.
11883
11884 .vitem &$tls_peerdn$&
11885 .vindex "&$tls_peerdn$&"
11886 When a message is received from a remote host over an encrypted SMTP
11887 connection, and Exim is configured to request a certificate from the client,
11888 the value of the Distinguished Name of the certificate is made available in the
11889 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11890 value is retained during message delivery, except during outbound SMTP
11891 deliveries.
11892
11893 .new
11894 .vitem &$tls_sni$&
11895 .vindex "&$tls_sni$&"
11896 .cindex "TLS" "Server Name Indication"
11897 When a TLS session is being established, if the client sends the Server
11898 Name Indication extension, the value will be placed in this variable.
11899 If the variable appears in &%tls_certificate%& then this option and
11900 some others, described in &<<SECTtlssni>>&,
11901 will be re-expanded early in the TLS session, to permit
11902 a different certificate to be presented (and optionally a different key to be
11903 used) to the client, based upon the value of the SNI extension.
11904
11905 The value will be retained for the lifetime of the message.  During outbound
11906 SMTP deliveries, it reflects the value of the &%tls_sni%& option on
11907 the transport.
11908
11909 This is currently only available when using OpenSSL, built with support for
11910 SNI.
11911 .wen
11912
11913 .vitem &$tod_bsdinbox$&
11914 .vindex "&$tod_bsdinbox$&"
11915 The time of day and the date, in the format required for BSD-style mailbox
11916 files, for example: Thu Oct 17 17:14:09 1995.
11917
11918 .vitem &$tod_epoch$&
11919 .vindex "&$tod_epoch$&"
11920 The time and date as a number of seconds since the start of the Unix epoch.
11921
11922 .vitem &$tod_full$&
11923 .vindex "&$tod_full$&"
11924 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11925 +0100. The timezone is always given as a numerical offset from UTC, with
11926 positive values used for timezones that are ahead (east) of UTC, and negative
11927 values for those that are behind (west).
11928
11929 .vitem &$tod_log$&
11930 .vindex "&$tod_log$&"
11931 The time and date in the format used for writing Exim's log files, for example:
11932 1995-10-12 15:32:29, but without a timezone.
11933
11934 .vitem &$tod_logfile$&
11935 .vindex "&$tod_logfile$&"
11936 This variable contains the date in the format yyyymmdd. This is the format that
11937 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11938 flag.
11939
11940 .vitem &$tod_zone$&
11941 .vindex "&$tod_zone$&"
11942 This variable contains the numerical value of the local timezone, for example:
11943 -0500.
11944
11945 .vitem &$tod_zulu$&
11946 .vindex "&$tod_zulu$&"
11947 This variable contains the UTC date and time in &"Zulu"& format, as specified
11948 by ISO 8601, for example: 20030221154023Z.
11949
11950 .vitem &$value$&
11951 .vindex "&$value$&"
11952 This variable contains the result of an expansion lookup, extraction operation,
11953 or external command, as described above. It is also used during a
11954 &*reduce*& expansion.
11955
11956 .vitem &$version_number$&
11957 .vindex "&$version_number$&"
11958 The version number of Exim.
11959
11960 .vitem &$warn_message_delay$&
11961 .vindex "&$warn_message_delay$&"
11962 This variable is set only during the creation of a message warning about a
11963 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11964
11965 .vitem &$warn_message_recipients$&
11966 .vindex "&$warn_message_recipients$&"
11967 This variable is set only during the creation of a message warning about a
11968 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11969 .endlist
11970 .ecindex IIDstrexp
11971
11972
11973
11974 . ////////////////////////////////////////////////////////////////////////////
11975 . ////////////////////////////////////////////////////////////////////////////
11976
11977 .chapter "Embedded Perl" "CHAPperl"
11978 .scindex IIDperl "Perl" "calling from Exim"
11979 Exim can be built to include an embedded Perl interpreter. When this is done,
11980 Perl subroutines can be called as part of the string expansion process. To make
11981 use of the Perl support, you need version 5.004 or later of Perl installed on
11982 your system. To include the embedded interpreter in the Exim binary, include
11983 the line
11984 .code
11985 EXIM_PERL = perl.o
11986 .endd
11987 in your &_Local/Makefile_& and then build Exim in the normal way.
11988
11989
11990 .section "Setting up so Perl can be used" "SECID85"
11991 .oindex "&%perl_startup%&"
11992 Access to Perl subroutines is via a global configuration option called
11993 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
11994 no &%perl_startup%& option in the Exim configuration file then no Perl
11995 interpreter is started and there is almost no overhead for Exim (since none of
11996 the Perl library will be paged in unless used). If there is a &%perl_startup%&
11997 option then the associated value is taken to be Perl code which is executed in
11998 a newly created Perl interpreter.
11999
12000 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12001 need backslashes before any characters to escape special meanings. The option
12002 should usually be something like
12003 .code
12004 perl_startup = do '/etc/exim.pl'
12005 .endd
12006 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12007 use from Exim. Exim can be configured either to start up a Perl interpreter as
12008 soon as it is entered, or to wait until the first time it is needed. Starting
12009 the interpreter at the beginning ensures that it is done while Exim still has
12010 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12011 fact used in a particular run. Also, note that this does not mean that Exim is
12012 necessarily running as root when Perl is called at a later time. By default,
12013 the interpreter is started only when it is needed, but this can be changed in
12014 two ways:
12015
12016 .ilist
12017 .oindex "&%perl_at_start%&"
12018 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12019 a startup when Exim is entered.
12020 .next
12021 The command line option &%-ps%& also requests a startup when Exim is entered,
12022 overriding the setting of &%perl_at_start%&.
12023 .endlist
12024
12025 There is also a command line option &%-pd%& (for delay) which suppresses the
12026 initial startup, even if &%perl_at_start%& is set.
12027
12028
12029 .section "Calling Perl subroutines" "SECID86"
12030 When the configuration file includes a &%perl_startup%& option you can make use
12031 of the string expansion item to call the Perl subroutines that are defined
12032 by the &%perl_startup%& code. The operator is used in any of the following
12033 forms:
12034 .code
12035 ${perl{foo}}
12036 ${perl{foo}{argument}}
12037 ${perl{foo}{argument1}{argument2} ... }
12038 .endd
12039 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12040 arguments may be passed. Passing more than this results in an expansion failure
12041 with an error message of the form
12042 .code
12043 Too many arguments passed to Perl subroutine "foo" (max is 8)
12044 .endd
12045 The return value of the Perl subroutine is evaluated in a scalar context before
12046 it is passed back to Exim to be inserted into the expanded string. If the
12047 return value is &'undef'&, the expansion is forced to fail in the same way as
12048 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12049 by obeying Perl's &%die%& function, the expansion fails with the error message
12050 that was passed to &%die%&.
12051
12052
12053 .section "Calling Exim functions from Perl" "SECID87"
12054 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12055 is available to call back into Exim's string expansion function. For example,
12056 the Perl code
12057 .code
12058 my $lp = Exim::expand_string('$local_part');
12059 .endd
12060 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12061 Note those are single quotes and not double quotes to protect against
12062 &$local_part$& being interpolated as a Perl variable.
12063
12064 If the string expansion is forced to fail by a &"fail"& item, the result of
12065 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12066 expansion string, the Perl call from the original expansion string fails with
12067 an appropriate error message, in the same way as if &%die%& were used.
12068
12069 .cindex "debugging" "from embedded Perl"
12070 .cindex "log" "writing from embedded Perl"
12071 Two other Exim functions are available for use from within Perl code.
12072 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12073 debugging is enabled. If you want a newline at the end, you must supply it.
12074 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12075 timestamp. In this case, you should not supply a terminating newline.
12076
12077
12078 .section "Use of standard output and error by Perl" "SECID88"
12079 .cindex "Perl" "standard output and error"
12080 You should not write to the standard error or output streams from within your
12081 Perl code, as it is not defined how these are set up. In versions of Exim
12082 before 4.50, it is possible for the standard output or error to refer to the
12083 SMTP connection during message reception via the daemon. Writing to this stream
12084 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12085 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12086 avoided, but the output is lost.
12087
12088 .cindex "Perl" "use of &%warn%&"
12089 The Perl &%warn%& statement writes to the standard error stream by default.
12090 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12091 you have no control. When Exim starts up the Perl interpreter, it arranges for
12092 output from the &%warn%& statement to be written to the Exim main log. You can
12093 change this by including appropriate Perl magic somewhere in your Perl code.
12094 For example, to discard &%warn%& output completely, you need this:
12095 .code
12096 $SIG{__WARN__} = sub { };
12097 .endd
12098 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12099 example, the code for the subroutine is empty, so it does nothing, but you can
12100 include any Perl code that you like. The text of the &%warn%& message is passed
12101 as the first subroutine argument.
12102 .ecindex IIDperl
12103
12104
12105 . ////////////////////////////////////////////////////////////////////////////
12106 . ////////////////////////////////////////////////////////////////////////////
12107
12108 .chapter "Starting the daemon and the use of network interfaces" &&&
12109          "CHAPinterfaces" &&&
12110          "Starting the daemon"
12111 .cindex "daemon" "starting"
12112 .cindex "interface" "listening"
12113 .cindex "network interface"
12114 .cindex "interface" "network"
12115 .cindex "IP address" "for listening"
12116 .cindex "daemon" "listening IP addresses"
12117 .cindex "TCP/IP" "setting listening interfaces"
12118 .cindex "TCP/IP" "setting listening ports"
12119 A host that is connected to a TCP/IP network may have one or more physical
12120 hardware network interfaces. Each of these interfaces may be configured as one
12121 or more &"logical"& interfaces, which are the entities that a program actually
12122 works with. Each of these logical interfaces is associated with an IP address.
12123 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12124 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12125 knowledge about the host's interfaces for use in three different circumstances:
12126
12127 .olist
12128 When a listening daemon is started, Exim needs to know which interfaces
12129 and ports to listen on.
12130 .next
12131 When Exim is routing an address, it needs to know which IP addresses
12132 are associated with local interfaces. This is required for the correct
12133 processing of MX lists by removing the local host and others with the
12134 same or higher priority values. Also, Exim needs to detect cases
12135 when an address is routed to an IP address that in fact belongs to the
12136 local host. Unless the &%self%& router option or the &%allow_localhost%&
12137 option of the smtp transport is set (as appropriate), this is treated
12138 as an error situation.
12139 .next
12140 When Exim connects to a remote host, it may need to know which interface to use
12141 for the outgoing connection.
12142 .endlist
12143
12144
12145 Exim's default behaviour is likely to be appropriate in the vast majority
12146 of cases. If your host has only one interface, and you want all its IP
12147 addresses to be treated in the same way, and you are using only the
12148 standard SMTP port, you should not need to take any special action. The
12149 rest of this chapter does not apply to you.
12150
12151 In a more complicated situation you may want to listen only on certain
12152 interfaces, or on different ports, and for this reason there are a number of
12153 options that can be used to influence Exim's behaviour. The rest of this
12154 chapter describes how they operate.
12155
12156 When a message is received over TCP/IP, the interface and port that were
12157 actually used are set in &$received_ip_address$& and &$received_port$&.
12158
12159
12160
12161 .section "Starting a listening daemon" "SECID89"
12162 When a listening daemon is started (by means of the &%-bd%& command line
12163 option), the interfaces and ports on which it listens are controlled by the
12164 following options:
12165
12166 .ilist
12167 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12168 compatibility, this option can also be specified in the singular.)
12169 .next
12170 &%local_interfaces%& contains list of interface IP addresses on which to
12171 listen. Each item may optionally also specify a port.
12172 .endlist
12173
12174 The default list separator in both cases is a colon, but this can be changed as
12175 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12176 it is usually best to change the separator to avoid having to double all the
12177 colons. For example:
12178 .code
12179 local_interfaces = <; 127.0.0.1 ; \
12180                       192.168.23.65 ; \
12181                       ::1 ; \
12182                       3ffe:ffff:836f::fe86:a061
12183 .endd
12184 There are two different formats for specifying a port along with an IP address
12185 in &%local_interfaces%&:
12186
12187 .olist
12188 The port is added onto the address with a dot separator. For example, to listen
12189 on port 1234 on two different IP addresses:
12190 .code
12191 local_interfaces = <; 192.168.23.65.1234 ; \
12192                       3ffe:ffff:836f::fe86:a061.1234
12193 .endd
12194 .next
12195 The IP address is enclosed in square brackets, and the port is added
12196 with a colon separator, for example:
12197 .code
12198 local_interfaces = <; [192.168.23.65]:1234 ; \
12199                       [3ffe:ffff:836f::fe86:a061]:1234
12200 .endd
12201 .endlist
12202
12203 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12204 default setting contains just one port:
12205 .code
12206 daemon_smtp_ports = smtp
12207 .endd
12208 If more than one port is listed, each interface that does not have its own port
12209 specified listens on all of them. Ports that are listed in
12210 &%daemon_smtp_ports%& can be identified either by name (defined in
12211 &_/etc/services_&) or by number. However, when ports are given with individual
12212 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12213
12214
12215
12216 .section "Special IP listening addresses" "SECID90"
12217 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12218 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12219 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12220 instead of setting up separate listening sockets for each interface. The
12221 default value of &%local_interfaces%& is
12222 .code
12223 local_interfaces = 0.0.0.0
12224 .endd
12225 when Exim is built without IPv6 support; otherwise it is:
12226 .code
12227 local_interfaces = <; ::0 ; 0.0.0.0
12228 .endd
12229 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12230
12231
12232
12233 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12234 The &%-oX%& command line option can be used to override the values of
12235 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12236 instance. Another way of doing this would be to use macros and the &%-D%&
12237 option. However, &%-oX%& can be used by any admin user, whereas modification of
12238 the runtime configuration by &%-D%& is allowed only when the caller is root or
12239 exim.
12240
12241 The value of &%-oX%& is a list of items. The default colon separator can be
12242 changed in the usual way if required. If there are any items that do not
12243 contain dots or colons (that is, are not IP addresses), the value of
12244 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12245 items that do contain dots or colons, the value of &%local_interfaces%& is
12246 replaced by those items. Thus, for example,
12247 .code
12248 -oX 1225
12249 .endd
12250 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12251 whereas
12252 .code
12253 -oX 192.168.34.5.1125
12254 .endd
12255 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12256 (However, since &%local_interfaces%& now contains no items without ports, the
12257 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12258
12259
12260
12261 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12262 .cindex "ssmtp protocol"
12263 .cindex "smtps protocol"
12264 .cindex "SMTP" "ssmtp protocol"
12265 .cindex "SMTP" "smtps protocol"
12266 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12267 before the STARTTLS command was standardized for SMTP. Some legacy clients
12268 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12269 list of port numbers, connections to those ports must use SSMTP. The most
12270 common use of this option is expected to be
12271 .code
12272 tls_on_connect_ports = 465
12273 .endd
12274 because 465 is the usual port number used by the legacy clients. There is also
12275 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12276 this way when a daemon is started.
12277
12278 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12279 daemon to listen on those ports. You must still specify them in
12280 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12281 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12282 connections via the daemon.)
12283
12284
12285
12286
12287 .section "IPv6 address scopes" "SECID92"
12288 .cindex "IPv6" "address scopes"
12289 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12290 can, in principle, have the same link-local IPv6 address on different
12291 interfaces. Thus, additional information is needed, over and above the IP
12292 address, to distinguish individual interfaces. A convention of using a
12293 percent sign followed by something (often the interface name) has been
12294 adopted in some cases, leading to addresses like this:
12295 .code
12296 fe80::202:b3ff:fe03:45c1%eth0
12297 .endd
12298 To accommodate this usage, a percent sign followed by an arbitrary string is
12299 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12300 to convert a textual IPv6 address for actual use. This function recognizes the
12301 percent convention in operating systems that support it, and it processes the
12302 address appropriately. Unfortunately, some older libraries have problems with
12303 &[getaddrinfo()]&. If
12304 .code
12305 IPV6_USE_INET_PTON=yes
12306 .endd
12307 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12308 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12309 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12310 function.) Of course, this means that the additional functionality of
12311 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12312
12313 .section "Disabling IPv6" "SECID93"
12314 .cindex "IPv6" "disabling"
12315 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12316 run on a host whose kernel does not support IPv6. The binary will fall back to
12317 using IPv4, but it may waste resources looking up AAAA records, and trying to
12318 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12319 .oindex "&%disable_ipv6%&"
12320 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12321 activities take place. AAAA records are never looked up, and any IPv6 addresses
12322 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12323 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12324 to handle IPv6 literal addresses.
12325
12326 On the other hand, when IPv6 is in use, there may be times when you want to
12327 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12328 option to globally suppress the lookup of AAAA records for specified domains,
12329 and you can use the &%ignore_target_hosts%& generic router option to ignore
12330 IPv6 addresses in an individual router.
12331
12332
12333
12334 .section "Examples of starting a listening daemon" "SECID94"
12335 The default case in an IPv6 environment is
12336 .code
12337 daemon_smtp_ports = smtp
12338 local_interfaces = <; ::0 ; 0.0.0.0
12339 .endd
12340 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12341 Either one or two sockets may be used, depending on the characteristics of
12342 the TCP/IP stack. (This is complicated and messy; for more information,
12343 read the comments in the &_daemon.c_& source file.)
12344
12345 To specify listening on ports 25 and 26 on all interfaces:
12346 .code
12347 daemon_smtp_ports = 25 : 26
12348 .endd
12349 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12350 .code
12351 local_interfaces = <; ::0.25     ; ::0.26 \
12352                       0.0.0.0.25 ; 0.0.0.0.26
12353 .endd
12354 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12355 IPv4 loopback address only:
12356 .code
12357 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12358 .endd
12359 To specify listening on the default port on specific interfaces only:
12360 .code
12361 local_interfaces = 192.168.34.67 : 192.168.34.67
12362 .endd
12363 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12364
12365
12366
12367 .section "Recognizing the local host" "SECTreclocipadd"
12368 The &%local_interfaces%& option is also used when Exim needs to determine
12369 whether or not an IP address refers to the local host. That is, the IP
12370 addresses of all the interfaces on which a daemon is listening are always
12371 treated as local.
12372
12373 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12374 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12375 available interfaces from the operating system, and extracts the relevant
12376 (that is, IPv4 or IPv6) addresses to use for checking.
12377
12378 Some systems set up large numbers of virtual interfaces in order to provide
12379 many virtual web servers. In this situation, you may want to listen for
12380 email on only a few of the available interfaces, but nevertheless treat all
12381 interfaces as local when routing. You can do this by setting
12382 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12383 &"all"& wildcard values. These addresses are recognized as local, but are not
12384 used for listening. Consider this example:
12385 .code
12386 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12387                       192.168.53.235 ; \
12388                       3ffe:2101:12:1:a00:20ff:fe86:a061
12389
12390 extra_local_interfaces = <; ::0 ; 0.0.0.0
12391 .endd
12392 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12393 address, but all available interface addresses are treated as local when
12394 Exim is routing.
12395
12396 In some environments the local host name may be in an MX list, but with an IP
12397 address that is not assigned to any local interface. In other cases it may be
12398 desirable to treat other host names as if they referred to the local host. Both
12399 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12400 This contains host names rather than IP addresses. When a host is referenced
12401 during routing, either via an MX record or directly, it is treated as the local
12402 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12403 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12404
12405
12406
12407 .section "Delivering to a remote host" "SECID95"
12408 Delivery to a remote host is handled by the smtp transport. By default, it
12409 allows the system's TCP/IP functions to choose which interface to use (if
12410 there is more than one) when connecting to a remote host. However, the
12411 &%interface%& option can be set to specify which interface is used. See the
12412 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12413 details.
12414
12415
12416
12417
12418 . ////////////////////////////////////////////////////////////////////////////
12419 . ////////////////////////////////////////////////////////////////////////////
12420
12421 .chapter "Main configuration" "CHAPmainconfig"
12422 .scindex IIDconfima "configuration file" "main section"
12423 .scindex IIDmaiconf "main configuration"
12424 The first part of the run time configuration file contains three types of item:
12425
12426 .ilist
12427 Macro definitions: These lines start with an upper case letter. See section
12428 &<<SECTmacrodefs>>& for details of macro processing.
12429 .next
12430 Named list definitions: These lines start with one of the words &"domainlist"&,
12431 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12432 section &<<SECTnamedlists>>&.
12433 .next
12434 Main configuration settings: Each setting occupies one line of the file
12435 (with possible continuations). If any setting is preceded by the word
12436 &"hide"&, the &%-bP%& command line option displays its value to admin users
12437 only. See section &<<SECTcos>>& for a description of the syntax of these option
12438 settings.
12439 .endlist
12440
12441 This chapter specifies all the main configuration options, along with their
12442 types and default values. For ease of finding a particular option, they appear
12443 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12444 are now so many options, they are first listed briefly in functional groups, as
12445 an aid to finding the name of the option you are looking for. Some options are
12446 listed in more than one group.
12447
12448 .section "Miscellaneous" "SECID96"
12449 .table2
12450 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12451 .row &%disable_ipv6%&                "do no IPv6 processing"
12452 .row &%keep_malformed%&              "for broken files &-- should not happen"
12453 .row &%localhost_number%&            "for unique message ids in clusters"
12454 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12455 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12456 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12457 .row &%print_topbitchars%&           "top-bit characters are printing"
12458 .row &%timezone%&                    "force time zone"
12459 .endtable
12460
12461
12462 .section "Exim parameters" "SECID97"
12463 .table2
12464 .row &%exim_group%&                  "override compiled-in value"
12465 .row &%exim_path%&                   "override compiled-in value"
12466 .row &%exim_user%&                   "override compiled-in value"
12467 .row &%primary_hostname%&            "default from &[uname()]&"
12468 .row &%split_spool_directory%&       "use multiple directories"
12469 .row &%spool_directory%&             "override compiled-in value"
12470 .endtable
12471
12472
12473
12474 .section "Privilege controls" "SECID98"
12475 .table2
12476 .row &%admin_groups%&                "groups that are Exim admin users"
12477 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12478 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12479 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12480 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12481 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12482 .row &%never_users%&                 "do not run deliveries as these"
12483 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12484 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12485 .row &%trusted_groups%&              "groups that are trusted"
12486 .row &%trusted_users%&               "users that are trusted"
12487 .endtable
12488
12489
12490
12491 .section "Logging" "SECID99"
12492 .table2
12493 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12494 .row &%log_file_path%&               "override compiled-in value"
12495 .row &%log_selector%&                "set/unset optional logging"
12496 .row &%log_timezone%&                "add timezone to log lines"
12497 .row &%message_logs%&                "create per-message logs"
12498 .row &%preserve_message_logs%&       "after message completion"
12499 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12500 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12501 .row &%syslog_facility%&             "set syslog &""facility""& field"
12502 .row &%syslog_processname%&          "set syslog &""ident""& field"
12503 .row &%syslog_timestamp%&            "timestamp syslog lines"
12504 .row &%write_rejectlog%&             "control use of message log"
12505 .endtable
12506
12507
12508
12509 .section "Frozen messages" "SECID100"
12510 .table2
12511 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12512 .row &%freeze_tell%&                 "send message when freezing"
12513 .row &%move_frozen_messages%&        "to another directory"
12514 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12515 .endtable
12516
12517
12518
12519 .section "Data lookups" "SECID101"
12520 .table2
12521 .row &%ibase_servers%&               "InterBase servers"
12522 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12523 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12524 .row &%ldap_cert_file%&              "client cert file for LDAP"
12525 .row &%ldap_cert_key%&               "client key file for LDAP"
12526 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12527 .row &%ldap_default_servers%&        "used if no server in query"
12528 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12529 .row &%ldap_start_tls%&              "require TLS within LDAP"
12530 .row &%ldap_version%&                "set protocol version"
12531 .row &%lookup_open_max%&             "lookup files held open"
12532 .row &%mysql_servers%&               "default MySQL servers"
12533 .row &%oracle_servers%&              "Oracle servers"
12534 .row &%pgsql_servers%&               "default PostgreSQL servers"
12535 .row &%sqlite_lock_timeout%&         "as it says"
12536 .endtable
12537
12538
12539
12540 .section "Message ids" "SECID102"
12541 .table2
12542 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12543 .row &%message_id_header_text%&      "ditto"
12544 .endtable
12545
12546
12547
12548 .section "Embedded Perl Startup" "SECID103"
12549 .table2
12550 .row &%perl_at_start%&               "always start the interpreter"
12551 .row &%perl_startup%&                "code to obey when starting Perl"
12552 .endtable
12553
12554
12555
12556 .section "Daemon" "SECID104"
12557 .table2
12558 .row &%daemon_smtp_ports%&           "default ports"
12559 .row &%daemon_startup_retries%&      "number of times to retry"
12560 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12561 .row &%extra_local_interfaces%&      "not necessarily listened on"
12562 .row &%local_interfaces%&            "on which to listen, with optional ports"
12563 .row &%pid_file_path%&               "override compiled-in value"
12564 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12565 .endtable
12566
12567
12568
12569 .section "Resource control" "SECID105"
12570 .table2
12571 .row &%check_log_inodes%&            "before accepting a message"
12572 .row &%check_log_space%&             "before accepting a message"
12573 .row &%check_spool_inodes%&          "before accepting a message"
12574 .row &%check_spool_space%&           "before accepting a message"
12575 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12576 .row &%queue_only_load%&             "queue incoming if load high"
12577 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12578 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12579 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12580 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12581 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12582 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12583 .row &%smtp_accept_max_per_connection%& "messages per connection"
12584 .row &%smtp_accept_max_per_host%&    "connections from one host"
12585 .row &%smtp_accept_queue%&           "queue mail if more connections"
12586 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12587                                            connection"
12588 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12589 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12590 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12591 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12592 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12593 .endtable
12594
12595
12596
12597 .section "Policy controls" "SECID106"
12598 .table2
12599 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12600 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12601 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12602 .row &%acl_smtp_auth%&               "ACL for AUTH"
12603 .row &%acl_smtp_connect%&            "ACL for connection"
12604 .row &%acl_smtp_data%&               "ACL for DATA"
12605 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12606 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12607 .row &%acl_smtp_expn%&               "ACL for EXPN"
12608 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12609 .row &%acl_smtp_mail%&               "ACL for MAIL"
12610 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12611 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12612 .row &%acl_smtp_predata%&            "ACL for start of data"
12613 .row &%acl_smtp_quit%&               "ACL for QUIT"
12614 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12615 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12616 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12617 .row &%av_scanner%&                  "specify virus scanner"
12618 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12619                                       words""&"
12620 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12621 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12622 .row &%header_maxsize%&              "total size of message header"
12623 .row &%header_line_maxsize%&         "individual header line limit"
12624 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12625 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12626 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12627 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12628 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12629 .row &%host_lookup%&                 "host name looked up for these hosts"
12630 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12631 .row &%host_reject_connection%&      "reject connection from these hosts"
12632 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12633 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12634 .row &%message_size_limit%&          "for all messages"
12635 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12636 .row &%spamd_address%&               "set interface to SpamAssassin"
12637 .row &%strict_acl_vars%&             "object to unset ACL variables"
12638 .endtable
12639
12640
12641
12642 .section "Callout cache" "SECID107"
12643 .table2
12644 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12645                                          item"
12646 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12647                                          item"
12648 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12649 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12650 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12651 .endtable
12652
12653
12654
12655 .section "TLS" "SECID108"
12656 .table2
12657 .row &%gnutls_require_kx%&           "control GnuTLS key exchanges"
12658 .row &%gnutls_require_mac%&          "control GnuTLS MAC algorithms"
12659 .row &%gnutls_require_protocols%&    "control GnuTLS protocols"
12660 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12661 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12662 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12663 .row &%tls_certificate%&             "location of server certificate"
12664 .row &%tls_crl%&                     "certificate revocation list"
12665 .row &%tls_dhparam%&                 "DH parameters for server"
12666 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12667 .row &%tls_privatekey%&              "location of server private key"
12668 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12669 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12670 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12671 .row &%tls_verify_certificates%&     "expected client certificates"
12672 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12673 .endtable
12674
12675
12676
12677 .section "Local user handling" "SECID109"
12678 .table2
12679 .row &%finduser_retries%&            "useful in NIS environments"
12680 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12681 .row &%gecos_pattern%&               "ditto"
12682 .row &%max_username_length%&         "for systems that truncate"
12683 .row &%unknown_login%&               "used when no login name found"
12684 .row &%unknown_username%&            "ditto"
12685 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12686 .row &%uucp_from_sender%&            "ditto"
12687 .endtable
12688
12689
12690
12691 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12692 .table2
12693 .row &%header_maxsize%&              "total size of message header"
12694 .row &%header_line_maxsize%&         "individual header line limit"
12695 .row &%message_size_limit%&          "applies to all messages"
12696 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12697 .row &%received_header_text%&        "expanded to make &'Received:'&"
12698 .row &%received_headers_max%&        "for mail loop detection"
12699 .row &%recipients_max%&              "limit per message"
12700 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12701 .endtable
12702
12703
12704
12705
12706 .section "Non-SMTP incoming messages" "SECID111"
12707 .table2
12708 .row &%receive_timeout%&             "for non-SMTP messages"
12709 .endtable
12710
12711
12712
12713
12714
12715 .section "Incoming SMTP messages" "SECID112"
12716 See also the &'Policy controls'& section above.
12717
12718 .table2
12719 .row &%host_lookup%&                 "host name looked up for these hosts"
12720 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12721 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12722 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12723 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12724 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12725 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12726 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12727 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12728 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12729 .row &%smtp_accept_max_per_connection%& "messages per connection"
12730 .row &%smtp_accept_max_per_host%&    "connections from one host"
12731 .row &%smtp_accept_queue%&           "queue mail if more connections"
12732 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12733                                            connection"
12734 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12735 .row &%smtp_active_hostname%&        "host name to use in messages"
12736 .row &%smtp_banner%&                 "text for welcome banner"
12737 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12738 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12739 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12740 .row &%smtp_etrn_command%&           "what to run for ETRN"
12741 .row &%smtp_etrn_serialize%&         "only one at once"
12742 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12743 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12744 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12745 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12746 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12747 .row &%smtp_receive_timeout%&        "per command or data line"
12748 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12749 .row &%smtp_return_error_details%&   "give detail on rejections"
12750 .endtable
12751
12752
12753
12754 .section "SMTP extensions" "SECID113"
12755 .table2
12756 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12757 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12758 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12759 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12760 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12761 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12762 .endtable
12763
12764
12765
12766 .section "Processing messages" "SECID114"
12767 .table2
12768 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12769 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12770 .row &%allow_utf8_domains%&          "in addresses"
12771 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12772                                       words""&"
12773 .row &%delivery_date_remove%&        "from incoming messages"
12774 .row &%envelope_to_remove%&          "from incoming messages"
12775 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12776 .row &%headers_charset%&             "default for translations"
12777 .row &%qualify_domain%&              "default for senders"
12778 .row &%qualify_recipient%&           "default for recipients"
12779 .row &%return_path_remove%&          "from incoming messages"
12780 .row &%strip_excess_angle_brackets%& "in addresses"
12781 .row &%strip_trailing_dot%&          "at end of addresses"
12782 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12783 .endtable
12784
12785
12786
12787 .section "System filter" "SECID115"
12788 .table2
12789 .row &%system_filter%&               "locate system filter"
12790 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12791                                             directory"
12792 .row &%system_filter_file_transport%& "transport for delivery to a file"
12793 .row &%system_filter_group%&         "group for filter running"
12794 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12795 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12796 .row &%system_filter_user%&          "user for filter running"
12797 .endtable
12798
12799
12800
12801 .section "Routing and delivery" "SECID116"
12802 .table2
12803 .row &%disable_ipv6%&                "do no IPv6 processing"
12804 .row &%dns_again_means_nonexist%&    "for broken domains"
12805 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12806 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12807 .row &%dns_retrans%&                 "parameter for resolver"
12808 .row &%dns_retry%&                   "parameter for resolver"
12809 .row &%dns_use_edns0%&               "parameter for resolver"
12810 .row &%hold_domains%&                "hold delivery for these domains"
12811 .row &%local_interfaces%&            "for routing checks"
12812 .row &%queue_domains%&               "no immediate delivery for these"
12813 .row &%queue_only%&                  "no immediate delivery at all"
12814 .row &%queue_only_file%&             "no immediate delivery if file exists"
12815 .row &%queue_only_load%&             "no immediate delivery if load is high"
12816 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12817 .row &%queue_only_override%&         "allow command line to override"
12818 .row &%queue_run_in_order%&          "order of arrival"
12819 .row &%queue_run_max%&               "of simultaneous queue runners"
12820 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12821 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12822 .row &%remote_sort_domains%&         "order of remote deliveries"
12823 .row &%retry_data_expire%&           "timeout for retry data"
12824 .row &%retry_interval_max%&          "safety net for retry rules"
12825 .endtable
12826
12827
12828
12829 .section "Bounce and warning messages" "SECID117"
12830 .table2
12831 .row &%bounce_message_file%&         "content of bounce"
12832 .row &%bounce_message_text%&         "content of bounce"
12833 .row &%bounce_return_body%&          "include body if returning message"
12834 .row &%bounce_return_message%&       "include original message in bounce"
12835 .row &%bounce_return_size_limit%&    "limit on returned message"
12836 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12837 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12838 .row &%errors_copy%&                 "copy bounce messages"
12839 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12840 .row &%delay_warning%&               "time schedule"
12841 .row &%delay_warning_condition%&     "condition for warning messages"
12842 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12843 .row &%smtp_return_error_details%&   "give detail on rejections"
12844 .row &%warn_message_file%&           "content of warning message"
12845 .endtable
12846
12847
12848
12849 .section "Alphabetical list of main options" "SECTalomo"
12850 Those options that undergo string expansion before use are marked with
12851 &dagger;.
12852
12853 .option accept_8bitmime main boolean false
12854 .cindex "8BITMIME"
12855 .cindex "8-bit characters"
12856 This option causes Exim to send 8BITMIME in its response to an SMTP
12857 EHLO command, and to accept the BODY= parameter on MAIL commands.
12858 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12859 takes no steps to do anything special with messages received by this route.
12860 Consequently, this option is turned off by default.
12861
12862 .option acl_not_smtp main string&!! unset
12863 .cindex "&ACL;" "for non-SMTP messages"
12864 .cindex "non-SMTP messages" "ACLs for"
12865 This option defines the ACL that is run when a non-SMTP message has been
12866 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12867 further details.
12868
12869 .option acl_not_smtp_mime main string&!! unset
12870 This option defines the ACL that is run for individual MIME parts of non-SMTP
12871 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12872 SMTP messages.
12873
12874 .option acl_not_smtp_start main string&!! unset
12875 .cindex "&ACL;" "at start of non-SMTP message"
12876 .cindex "non-SMTP messages" "ACLs for"
12877 This option defines the ACL that is run before Exim starts reading a
12878 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12879
12880 .option acl_smtp_auth main string&!! unset
12881 .cindex "&ACL;" "setting up for SMTP commands"
12882 .cindex "AUTH" "ACL for"
12883 This option defines the ACL that is run when an SMTP AUTH command is
12884 received. See chapter &<<CHAPACL>>& for further details.
12885
12886 .option acl_smtp_connect main string&!! unset
12887 .cindex "&ACL;" "on SMTP connection"
12888 This option defines the ACL that is run when an SMTP connection is received.
12889 See chapter &<<CHAPACL>>& for further details.
12890
12891 .option acl_smtp_data main string&!! unset
12892 .cindex "DATA" "ACL for"
12893 This option defines the ACL that is run after an SMTP DATA command has been
12894 processed and the message itself has been received, but before the final
12895 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12896
12897 .option acl_smtp_etrn main string&!! unset
12898 .cindex "ETRN" "ACL for"
12899 This option defines the ACL that is run when an SMTP ETRN command is
12900 received. See chapter &<<CHAPACL>>& for further details.
12901
12902 .option acl_smtp_expn main string&!! unset
12903 .cindex "EXPN" "ACL for"
12904 This option defines the ACL that is run when an SMTP EXPN command is
12905 received. See chapter &<<CHAPACL>>& for further details.
12906
12907 .option acl_smtp_helo main string&!! unset
12908 .cindex "EHLO" "ACL for"
12909 .cindex "HELO" "ACL for"
12910 This option defines the ACL that is run when an SMTP EHLO or HELO
12911 command is received. See chapter &<<CHAPACL>>& for further details.
12912
12913
12914 .option acl_smtp_mail main string&!! unset
12915 .cindex "MAIL" "ACL for"
12916 This option defines the ACL that is run when an SMTP MAIL command is
12917 received. See chapter &<<CHAPACL>>& for further details.
12918
12919 .option acl_smtp_mailauth main string&!! unset
12920 .cindex "AUTH" "on MAIL command"
12921 This option defines the ACL that is run when there is an AUTH parameter on
12922 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12923 &<<CHAPSMTPAUTH>>& for details of authentication.
12924
12925 .option acl_smtp_mime main string&!! unset
12926 .cindex "MIME content scanning" "ACL for"
12927 This option is available when Exim is built with the content-scanning
12928 extension. It defines the ACL that is run for each MIME part in a message. See
12929 section &<<SECTscanmimepart>>& for details.
12930
12931 .option acl_smtp_predata main string&!! unset
12932 This option defines the ACL that is run when an SMTP DATA command is
12933 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12934 further details.
12935
12936 .option acl_smtp_quit main string&!! unset
12937 .cindex "QUIT, ACL for"
12938 This option defines the ACL that is run when an SMTP QUIT command is
12939 received. See chapter &<<CHAPACL>>& for further details.
12940
12941 .option acl_smtp_rcpt main string&!! unset
12942 .cindex "RCPT" "ACL for"
12943 This option defines the ACL that is run when an SMTP RCPT command is
12944 received. See chapter &<<CHAPACL>>& for further details.
12945
12946 .option acl_smtp_starttls main string&!! unset
12947 .cindex "STARTTLS, ACL for"
12948 This option defines the ACL that is run when an SMTP STARTTLS command is
12949 received. See chapter &<<CHAPACL>>& for further details.
12950
12951 .option acl_smtp_vrfy main string&!! unset
12952 .cindex "VRFY" "ACL for"
12953 This option defines the ACL that is run when an SMTP VRFY command is
12954 received. See chapter &<<CHAPACL>>& for further details.
12955
12956 .option admin_groups main "string list&!!" unset
12957 .cindex "admin user"
12958 This option is expanded just once, at the start of Exim's processing. If the
12959 current group or any of the supplementary groups of an Exim caller is in this
12960 colon-separated list, the caller has admin privileges. If all your system
12961 programmers are in a specific group, for example, you can give them all Exim
12962 admin privileges by putting that group in &%admin_groups%&. However, this does
12963 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12964 To permit this, you have to add individuals to the Exim group.
12965
12966 .option allow_domain_literals main boolean false
12967 .cindex "domain literal"
12968 If this option is set, the RFC 2822 domain literal format is permitted in
12969 email addresses. The option is not set by default, because the domain literal
12970 format is not normally required these days, and few people know about it. It
12971 has, however, been exploited by mail abusers.
12972
12973 Unfortunately, it seems that some DNS black list maintainers are using this
12974 format to report black listing to postmasters. If you want to accept messages
12975 addressed to your hosts by IP address, you need to set
12976 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
12977 domains (defined in the named domain list &%local_domains%& in the default
12978 configuration). This &"magic string"& matches the domain literal form of all
12979 the local host's IP addresses.
12980
12981
12982 .option allow_mx_to_ip main boolean false
12983 .cindex "MX record" "pointing to IP address"
12984 It appears that more and more DNS zone administrators are breaking the rules
12985 and putting domain names that look like IP addresses on the right hand side of
12986 MX records. Exim follows the rules and rejects this, giving an error message
12987 that explains the mis-configuration. However, some other MTAs support this
12988 practice, so to avoid &"Why can't Exim do this?"& complaints,
12989 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
12990 recommended, except when you have no other choice.
12991
12992 .option allow_utf8_domains main boolean false
12993 .cindex "domain" "UTF-8 characters in"
12994 .cindex "UTF-8" "in domain name"
12995 Lots of discussion is going on about internationalized domain names. One
12996 camp is strongly in favour of just using UTF-8 characters, and it seems
12997 that at least two other MTAs permit this. This option allows Exim users to
12998 experiment if they wish.
12999
13000 If it is set true, Exim's domain parsing function allows valid
13001 UTF-8 multicharacters to appear in domain name components, in addition to
13002 letters, digits, and hyphens. However, just setting this option is not
13003 enough; if you want to look up these domain names in the DNS, you must also
13004 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13005 suitable setting is:
13006 .code
13007 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13008   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13009 .endd
13010 Alternatively, you can just disable this feature by setting
13011 .code
13012 dns_check_names_pattern =
13013 .endd
13014 That is, set the option to an empty string so that no check is done.
13015
13016
13017 .option auth_advertise_hosts main "host list&!!" *
13018 .cindex "authentication" "advertising"
13019 .cindex "AUTH" "advertising"
13020 If any server authentication mechanisms are configured, Exim advertises them in
13021 response to an EHLO command only if the calling host matches this list.
13022 Otherwise, Exim does not advertise AUTH.
13023 Exim does not accept AUTH commands from clients to which it has not
13024 advertised the availability of AUTH. The advertising of individual
13025 authentication mechanisms can be controlled by the use of the
13026 &%server_advertise_condition%& generic authenticator option on the individual
13027 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13028
13029 Certain mail clients (for example, Netscape) require the user to provide a name
13030 and password for authentication if AUTH is advertised, even though it may
13031 not be needed (the host may accept messages from hosts on its local LAN without
13032 authentication, for example). The &%auth_advertise_hosts%& option can be used
13033 to make these clients more friendly by excluding them from the set of hosts to
13034 which Exim advertises AUTH.
13035
13036 .cindex "AUTH" "advertising when encrypted"
13037 If you want to advertise the availability of AUTH only when the connection
13038 is encrypted using TLS, you can make use of the fact that the value of this
13039 option is expanded, with a setting like this:
13040 .code
13041 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
13042 .endd
13043 .vindex "&$tls_cipher$&"
13044 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
13045 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13046 expansion is *, which matches all hosts.
13047
13048
13049 .option auto_thaw main time 0s
13050 .cindex "thawing messages"
13051 .cindex "unfreezing messages"
13052 If this option is set to a time greater than zero, a queue runner will try a
13053 new delivery attempt on any frozen message, other than a bounce message, if
13054 this much time has passed since it was frozen. This may result in the message
13055 being re-frozen if nothing has changed since the last attempt. It is a way of
13056 saying &"keep on trying, even though there are big problems"&.
13057
13058 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13059 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13060 thought to be very useful any more, and its use should probably be avoided.
13061
13062
13063 .option av_scanner main string "see below"
13064 This option is available if Exim is built with the content-scanning extension.
13065 It specifies which anti-virus scanner to use. The default value is:
13066 .code
13067 sophie:/var/run/sophie
13068 .endd
13069 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13070 before use. See section &<<SECTscanvirus>>& for further details.
13071
13072
13073 .option bi_command main string unset
13074 .oindex "&%-bi%&"
13075 This option supplies the name of a command that is run when Exim is called with
13076 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13077 just the command name, it is not a complete command line. If an argument is
13078 required, it must come from the &%-oA%& command line option.
13079
13080
13081 .option bounce_message_file main string unset
13082 .cindex "bounce message" "customizing"
13083 .cindex "customizing" "bounce message"
13084 This option defines a template file containing paragraphs of text to be used
13085 for constructing bounce messages.  Details of the file's contents are given in
13086 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13087
13088
13089 .option bounce_message_text main string unset
13090 When this option is set, its contents are included in the default bounce
13091 message immediately after &"This message was created automatically by mail
13092 delivery software."& It is not used if &%bounce_message_file%& is set.
13093
13094 .option bounce_return_body main boolean true
13095 .cindex "bounce message" "including body"
13096 This option controls whether the body of an incoming message is included in a
13097 bounce message when &%bounce_return_message%& is true. The default setting
13098 causes the entire message, both header and body, to be returned (subject to the
13099 value of &%bounce_return_size_limit%&). If this option is false, only the
13100 message header is included. In the case of a non-SMTP message containing an
13101 error that is detected during reception, only those header lines preceding the
13102 point at which the error was detected are returned.
13103 .cindex "bounce message" "including original"
13104
13105 .option bounce_return_message main boolean true
13106 If this option is set false, none of the original message is included in
13107 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13108 &%bounce_return_body%&.
13109
13110
13111 .option bounce_return_size_limit main integer 100K
13112 .cindex "size" "of bounce, limit"
13113 .cindex "bounce message" "size limit"
13114 .cindex "limit" "bounce message size"
13115 This option sets a limit in bytes on the size of messages that are returned to
13116 senders as part of bounce messages when &%bounce_return_message%& is true. The
13117 limit should be less than the value of the global &%message_size_limit%& and of
13118 any &%message_size_limit%& settings on transports, to allow for the bounce text
13119 that Exim generates. If this option is set to zero there is no limit.
13120
13121 When the body of any message that is to be included in a bounce message is
13122 greater than the limit, it is truncated, and a comment pointing this out is
13123 added at the top. The actual cutoff may be greater than the value given, owing
13124 to the use of buffering for transferring the message in chunks (typically 8K in
13125 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13126 messages.
13127
13128 .option bounce_sender_authentication main string unset
13129 .cindex "bounce message" "sender authentication"
13130 .cindex "authentication" "bounce message"
13131 .cindex "AUTH" "on bounce message"
13132 This option provides an authenticated sender address that is sent with any
13133 bounce messages generated by Exim that are sent over an authenticated SMTP
13134 connection. A typical setting might be:
13135 .code
13136 bounce_sender_authentication = mailer-daemon@my.domain.example
13137 .endd
13138 which would cause bounce messages to be sent using the SMTP command:
13139 .code
13140 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13141 .endd
13142 The value of &%bounce_sender_authentication%& must always be a complete email
13143 address.
13144
13145 .option callout_domain_negative_expire main time 3h
13146 .cindex "caching" "callout timeouts"
13147 .cindex "callout" "caching timeouts"
13148 This option specifies the expiry time for negative callout cache data for a
13149 domain. See section &<<SECTcallver>>& for details of callout verification, and
13150 section &<<SECTcallvercache>>& for details of the caching.
13151
13152
13153 .option callout_domain_positive_expire main time 7d
13154 This option specifies the expiry time for positive callout cache data for a
13155 domain. See section &<<SECTcallver>>& for details of callout verification, and
13156 section &<<SECTcallvercache>>& for details of the caching.
13157
13158
13159 .option callout_negative_expire main time 2h
13160 This option specifies the expiry time for negative callout cache data for an
13161 address. See section &<<SECTcallver>>& for details of callout verification, and
13162 section &<<SECTcallvercache>>& for details of the caching.
13163
13164
13165 .option callout_positive_expire main time 24h
13166 This option specifies the expiry time for positive callout cache data for an
13167 address. See section &<<SECTcallver>>& for details of callout verification, and
13168 section &<<SECTcallvercache>>& for details of the caching.
13169
13170
13171 .option callout_random_local_part main string&!! "see below"
13172 This option defines the &"random"& local part that can be used as part of
13173 callout verification. The default value is
13174 .code
13175 $primary_hostname-$tod_epoch-testing
13176 .endd
13177 See section &<<CALLaddparcall>>& for details of how this value is used.
13178
13179
13180 .option check_log_inodes main integer 0
13181 See &%check_spool_space%& below.
13182
13183
13184 .option check_log_space main integer 0
13185 See &%check_spool_space%& below.
13186
13187 .oindex "&%check_rfc2047_length%&"
13188 .cindex "RFC 2047" "disabling length check"
13189 .option check_rfc2047_length main boolean true
13190 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13191 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13192 word; strings to be encoded that exceed this length are supposed to use
13193 multiple encoded words. By default, Exim does not recognize encoded words that
13194 exceed the maximum length. However, it seems that some software, in violation
13195 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13196 set false, Exim recognizes encoded words of any length.
13197
13198
13199 .option check_spool_inodes main integer 0
13200 See &%check_spool_space%& below.
13201
13202
13203 .option check_spool_space main integer 0
13204 .cindex "checking disk space"
13205 .cindex "disk space, checking"
13206 .cindex "spool directory" "checking space"
13207 The four &%check_...%& options allow for checking of disk resources before a
13208 message is accepted.
13209
13210 .vindex "&$log_inodes$&"
13211 .vindex "&$log_space$&"
13212 .vindex "&$spool_inodes$&"
13213 .vindex "&$spool_space$&"
13214 When any of these options are set, they apply to all incoming messages. If you
13215 want to apply different checks to different kinds of message, you can do so by
13216 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13217 &$spool_space$& in an ACL with appropriate additional conditions.
13218
13219
13220 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13221 either value is greater than zero, for example:
13222 .code
13223 check_spool_space = 10M
13224 check_spool_inodes = 100
13225 .endd
13226 The spool partition is the one that contains the directory defined by
13227 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13228 transit.
13229
13230 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13231 files are written if either is greater than zero. These should be set only if
13232 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13233
13234 If there is less space or fewer inodes than requested, Exim refuses to accept
13235 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13236 error response to the MAIL command. If ESMTP is in use and there was a
13237 SIZE parameter on the MAIL command, its value is added to the
13238 &%check_spool_space%& value, and the check is performed even if
13239 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13240
13241 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13242 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13243
13244 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13245 failure a message is written to stderr and Exim exits with a non-zero code, as
13246 it obviously cannot send an error message of any kind.
13247
13248 .option daemon_smtp_ports main string &`smtp`&
13249 .cindex "port" "for daemon"
13250 .cindex "TCP/IP" "setting listening ports"
13251 This option specifies one or more default SMTP ports on which the Exim daemon
13252 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13253 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13254
13255 .option daemon_startup_retries main integer 9
13256 .cindex "daemon startup, retrying"
13257 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13258 the daemon at startup when it cannot immediately bind a listening socket
13259 (typically because the socket is already in use): &%daemon_startup_retries%&
13260 defines the number of retries after the first failure, and
13261 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13262
13263 .option daemon_startup_sleep main time 30s
13264 See &%daemon_startup_retries%&.
13265
13266 .option delay_warning main "time list" 24h
13267 .cindex "warning of delay"
13268 .cindex "delay warning, specifying"
13269 When a message is delayed, Exim sends a warning message to the sender at
13270 intervals specified by this option. The data is a colon-separated list of times
13271 after which to send warning messages. If the value of the option is an empty
13272 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13273 message has been on the queue for longer than the last time, the last interval
13274 between the times is used to compute subsequent warning times. For example,
13275 with
13276 .code
13277 delay_warning = 4h:8h:24h
13278 .endd
13279 the first message is sent after 4 hours, the second after 8 hours, and
13280 the third one after 24 hours. After that, messages are sent every 16 hours,
13281 because that is the interval between the last two times on the list. If you set
13282 just one time, it specifies the repeat interval. For example, with:
13283 .code
13284 delay_warning = 6h
13285 .endd
13286 messages are repeated every six hours. To stop warnings after a given time, set
13287 a very large time at the end of the list. For example:
13288 .code
13289 delay_warning = 2h:12h:99d
13290 .endd
13291
13292 .option delay_warning_condition main string&!! "see below"
13293 .vindex "&$domain$&"
13294 The string is expanded at the time a warning message might be sent. If all the
13295 deferred addresses have the same domain, it is set in &$domain$& during the
13296 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13297 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13298 &"false"& (the comparison being done caselessly) then the warning message is
13299 not sent. The default is:
13300 .code
13301 delay_warning_condition = ${if or {\
13302   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13303   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13304   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13305   } {no}{yes}}
13306 .endd
13307 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13308 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13309 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13310 &"auto-replied"& in an &'Auto-Submitted:'& header.
13311
13312 .option deliver_drop_privilege main boolean false
13313 .cindex "unprivileged delivery"
13314 .cindex "delivery" "unprivileged"
13315 If this option is set true, Exim drops its root privilege at the start of a
13316 delivery process, and runs as the Exim user throughout. This severely restricts
13317 the kinds of local delivery that are possible, but is viable in certain types
13318 of configuration. There is a discussion about the use of root privilege in
13319 chapter &<<CHAPsecurity>>&.
13320
13321 .option deliver_queue_load_max main fixed-point unset
13322 .cindex "load average"
13323 .cindex "queue runner" "abandoning"
13324 When this option is set, a queue run is abandoned if the system load average
13325 becomes greater than the value of the option. The option has no effect on
13326 ancient operating systems on which Exim cannot determine the load average.
13327 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13328
13329
13330 .option delivery_date_remove main boolean true
13331 .cindex "&'Delivery-date:'& header line"
13332 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13333 message when it is delivered, in exactly the same way as &'Return-path:'& is
13334 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13335 should not be present in incoming messages, and this option causes them to be
13336 removed at the time the message is received, to avoid any problems that might
13337 occur when a delivered message is subsequently sent on to some other recipient.
13338
13339 .option disable_fsync main boolean false
13340 .cindex "&[fsync()]&, disabling"
13341 This option is available only if Exim was built with the compile-time option
13342 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13343 a runtime configuration generates an &"unknown option"& error. You should not
13344 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13345 really, really, really understand what you are doing. &'No pre-compiled
13346 distributions of Exim should ever make this option available.'&
13347
13348 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13349 updated files' data to be written to disc before continuing. Unexpected events
13350 such as crashes and power outages may cause data to be lost or scrambled.
13351 Here be Dragons. &*Beware.*&
13352
13353
13354 .option disable_ipv6 main boolean false
13355 .cindex "IPv6" "disabling"
13356 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13357 activities take place. AAAA records are never looked up, and any IPv6 addresses
13358 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13359 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13360 to handle IPv6 literal addresses.
13361
13362
13363 .option dns_again_means_nonexist main "domain list&!!" unset
13364 .cindex "DNS" "&""try again""& response; overriding"
13365 DNS lookups give a &"try again"& response for the DNS errors
13366 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13367 keep trying to deliver a message, or to give repeated temporary errors to
13368 incoming mail. Sometimes the effect is caused by a badly set up name server and
13369 may persist for a long time. If a domain which exhibits this problem matches
13370 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13371 This option should be used with care. You can make it apply to reverse lookups
13372 by a setting such as this:
13373 .code
13374 dns_again_means_nonexist = *.in-addr.arpa
13375 .endd
13376 This option applies to all DNS lookups that Exim does. It also applies when the
13377 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13378 since these are most likely to be caused by DNS lookup problems. The
13379 &(dnslookup)& router has some options of its own for controlling what happens
13380 when lookups for MX or SRV records give temporary errors. These more specific
13381 options are applied after this global option.
13382
13383 .option dns_check_names_pattern main string "see below"
13384 .cindex "DNS" "pre-check of name syntax"
13385 When this option is set to a non-empty string, it causes Exim to check domain
13386 names for characters that are not allowed in host names before handing them to
13387 the DNS resolver, because some resolvers give temporary errors for names that
13388 contain unusual characters. If a domain name contains any unwanted characters,
13389 a &"not found"& result is forced, and the resolver is not called. The check is
13390 done by matching the domain name against a regular expression, which is the
13391 value of this option. The default pattern is
13392 .code
13393 dns_check_names_pattern = \
13394   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13395 .endd
13396 which permits only letters, digits, slashes, and hyphens in components, but
13397 they must start and end with a letter or digit. Slashes are not, in fact,
13398 permitted in host names, but they are found in certain NS records (which can be
13399 accessed in Exim by using a &%dnsdb%& lookup). If you set
13400 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13401 empty string.
13402
13403 .option dns_csa_search_limit main integer 5
13404 This option controls the depth of parental searching for CSA SRV records in the
13405 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13406
13407 .option dns_csa_use_reverse main boolean true
13408 This option controls whether or not an IP address, given as a CSA domain, is
13409 reversed and looked up in the reverse DNS, as described in more detail in
13410 section &<<SECTverifyCSA>>&.
13411
13412 .option dns_ipv4_lookup main "domain list&!!" unset
13413 .cindex "IPv6" "DNS lookup for AAAA records"
13414 .cindex "DNS" "IPv6 lookup for AAAA records"
13415 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13416 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13417 (A records) when trying to find IP addresses for hosts, unless the host's
13418 domain matches this list.
13419
13420 This is a fudge to help with name servers that give big delays or otherwise do
13421 not work for the AAAA record type. In due course, when the world's name
13422 servers have all been upgraded, there should be no need for this option.
13423
13424
13425 .option dns_retrans main time 0s
13426 .cindex "DNS" "resolver options"
13427 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13428 retransmission and retry parameters for DNS lookups. Values of zero (the
13429 defaults) leave the system default settings unchanged. The first value is the
13430 time between retries, and the second is the number of retries. It isn't
13431 totally clear exactly how these settings affect the total time a DNS lookup may
13432 take. I haven't found any documentation about timeouts on DNS lookups; these
13433 parameter values are available in the external resolver interface structure,
13434 but nowhere does it seem to describe how they are used or what you might want
13435 to set in them.
13436
13437
13438 .option dns_retry main integer 0
13439 See &%dns_retrans%& above.
13440
13441
13442 .new
13443 .option dns_use_edns0 main integer -1
13444 .cindex "DNS" "resolver options"
13445 .cindex "DNS" "EDNS0"
13446 If this option is set to a non-negative number then Exim will initialise the
13447 DNS resolver library to either use or not use EDNS0 extensions, overriding
13448 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13449 on.
13450
13451 If the resolver library does not support EDNS0 then this option has no effect.
13452 .wen
13453
13454
13455 .option drop_cr main boolean false
13456 This is an obsolete option that is now a no-op. It used to affect the way Exim
13457 handled CR and LF characters in incoming messages. What happens now is
13458 described in section &<<SECTlineendings>>&.
13459
13460 .option dsn_from main "string&!!" "see below"
13461 .cindex "&'From:'& header line" "in bounces"
13462 .cindex "bounce messages" "&'From:'& line, specifying"
13463 This option can be used to vary the contents of &'From:'& header lines in
13464 bounces and other automatically generated messages (&"Delivery Status
13465 Notifications"& &-- hence the name of the option). The default setting is:
13466 .code
13467 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13468 .endd
13469 The value is expanded every time it is needed. If the expansion fails, a
13470 panic is logged, and the default value is used.
13471
13472 .option envelope_to_remove main boolean true
13473 .cindex "&'Envelope-to:'& header line"
13474 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13475 message when it is delivered, in exactly the same way as &'Return-path:'& is
13476 handled. &'Envelope-to:'& records the original recipient address from the
13477 messages's envelope that caused the delivery to happen. Such headers should not
13478 be present in incoming messages, and this option causes them to be removed at
13479 the time the message is received, to avoid any problems that might occur when a
13480 delivered message is subsequently sent on to some other recipient.
13481
13482
13483 .option errors_copy main "string list&!!" unset
13484 .cindex "bounce message" "copy to other address"
13485 .cindex "copy of bounce message"
13486 Setting this option causes Exim to send bcc copies of bounce messages that it
13487 generates to other addresses. &*Note*&: This does not apply to bounce messages
13488 coming from elsewhere. The value of the option is a colon-separated list of
13489 items. Each item consists of a pattern, terminated by white space, followed by
13490 a comma-separated list of email addresses. If a pattern contains spaces, it
13491 must be enclosed in double quotes.
13492
13493 Each pattern is processed in the same way as a single item in an address list
13494 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13495 the bounce message, the message is copied to the addresses on the list. The
13496 items are scanned in order, and once a matching one is found, no further items
13497 are examined. For example:
13498 .code
13499 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13500               rqps@mydomain   hostmaster@mydomain.example,\
13501                               postmaster@mydomain.example
13502 .endd
13503 .vindex "&$domain$&"
13504 .vindex "&$local_part$&"
13505 The address list is expanded before use. The expansion variables &$local_part$&
13506 and &$domain$& are set from the original recipient of the error message, and if
13507 there was any wildcard matching in the pattern, the expansion
13508 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13509 variables &$0$&, &$1$&, etc. are set in the normal way.
13510
13511
13512 .option errors_reply_to main string unset
13513 .cindex "bounce message" "&'Reply-to:'& in"
13514 By default, Exim's bounce and delivery warning messages contain the header line
13515 .display
13516 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13517 .endd
13518 .oindex &%quota_warn_message%&
13519 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13520 A warning message that is generated by the &%quota_warn_message%& option in an
13521 &(appendfile)& transport may contain its own &'From:'& header line that
13522 overrides the default.
13523
13524 Experience shows that people reply to bounce messages. If the
13525 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13526 and warning messages. For example:
13527 .code
13528 errors_reply_to = postmaster@my.domain.example
13529 .endd
13530 The value of the option is not expanded. It must specify a valid RFC 2822
13531 address. However, if a warning message that is generated by the
13532 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13533 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13534 not used.
13535
13536
13537 .option exim_group main string "compile-time configured"
13538 .cindex "gid (group id)" "Exim's own"
13539 .cindex "Exim group"
13540 This option changes the gid under which Exim runs when it gives up root
13541 privilege. The default value is compiled into the binary. The value of this
13542 option is used only when &%exim_user%& is also set. Unless it consists entirely
13543 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13544 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13545 security issues.
13546
13547
13548 .option exim_path main string "see below"
13549 .cindex "Exim binary, path name"
13550 This option specifies the path name of the Exim binary, which is used when Exim
13551 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13552 the directory configured at compile time by the BIN_DIRECTORY setting. It
13553 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13554 other place.
13555 &*Warning*&: Do not use a macro to define the value of this option, because
13556 you will break those Exim utilities that scan the configuration file to find
13557 where the binary is. (They then use the &%-bP%& option to extract option
13558 settings such as the value of &%spool_directory%&.)
13559
13560
13561 .option exim_user main string "compile-time configured"
13562 .cindex "uid (user id)" "Exim's own"
13563 .cindex "Exim user"
13564 This option changes the uid under which Exim runs when it gives up root
13565 privilege. The default value is compiled into the binary. Ownership of the run
13566 time configuration file and the use of the &%-C%& and &%-D%& command line
13567 options is checked against the values in the binary, not what is set here.
13568
13569 Unless it consists entirely of digits, the string is looked up using
13570 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13571 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13572 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13573
13574
13575 .option extra_local_interfaces main "string list" unset
13576 This option defines network interfaces that are to be considered local when
13577 routing, but which are not used for listening by the daemon. See section
13578 &<<SECTreclocipadd>>& for details.
13579
13580
13581 . Allow this long option name to split; give it unsplit as a fifth argument
13582 . for the automatic .oindex that is generated by .option.
13583
13584 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13585          extract_addresses_remove_arguments
13586 .oindex "&%-t%&"
13587 .cindex "command line" "addresses with &%-t%&"
13588 .cindex "Sendmail compatibility" "&%-t%& option"
13589 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13590 are present on the command line when the &%-t%& option is used to build an
13591 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13592 line addresses are removed from the recipients list. This is also how Smail
13593 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13594 command line addresses are added to those obtained from the header lines. When
13595 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13596 argument headers. If it is set false, Exim adds rather than removes argument
13597 addresses.
13598
13599
13600 .option finduser_retries main integer 0
13601 .cindex "NIS, retrying user lookups"
13602 On systems running NIS or other schemes in which user and group information is
13603 distributed from a remote system, there can be times when &[getpwnam()]& and
13604 related functions fail, even when given valid data, because things time out.
13605 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13606 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13607 many extra times to find a user or a group, waiting for one second between
13608 retries.
13609
13610 .cindex "&_/etc/passwd_&" "multiple reading of"
13611 You should not set this option greater than zero if your user information is in
13612 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13613 search the file multiple times for non-existent users, and also cause delay.
13614
13615
13616
13617 .option freeze_tell main "string list, comma separated" unset
13618 .cindex "freezing messages" "sending a message when freezing"
13619 On encountering certain errors, or when configured to do so in a system filter,
13620 ACL, or special router, Exim freezes a message. This means that no further
13621 delivery attempts take place until an administrator thaws the message, or the
13622 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13623 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13624 warning message whenever it freezes something, unless the message it is
13625 freezing is a locally-generated bounce message. (Without this exception there
13626 is the possibility of looping.) The warning message is sent to the addresses
13627 supplied as the comma-separated value of this option. If several of the
13628 message's addresses cause freezing, only a single message is sent. If the
13629 freezing was automatic, the reason(s) for freezing can be found in the message
13630 log. If you configure freezing in a filter or ACL, you must arrange for any
13631 logging that you require.
13632
13633
13634 .option gecos_name main string&!! unset
13635 .cindex "HP-UX"
13636 .cindex "&""gecos""& field, parsing"
13637 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13638 password file to hold other information in addition to users' real names. Exim
13639 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13640 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13641 of the field are used unchanged, except that, if an ampersand is encountered,
13642 it is replaced by the user's login name with the first character forced to
13643 upper case, since this is a convention that is observed on many systems.
13644
13645 When these options are set, &%gecos_pattern%& is treated as a regular
13646 expression that is to be applied to the field (again with && replaced by the
13647 login name), and if it matches, &%gecos_name%& is expanded and used as the
13648 user's name.
13649
13650 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13651 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13652 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13653 name terminates at the first comma, the following can be used:
13654 .code
13655 gecos_pattern = ([^,]*)
13656 gecos_name = $1
13657 .endd
13658
13659 .option gecos_pattern main string unset
13660 See &%gecos_name%& above.
13661
13662
13663 .option gnutls_require_kx main string unset
13664 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13665 server. For details, see section &<<SECTreqciphgnu>>&.
13666
13667 .option gnutls_require_mac main string unset
13668 This option controls the MAC algorithms when GnuTLS is used in an Exim
13669 server. For details, see section &<<SECTreqciphgnu>>&.
13670
13671 .option gnutls_require_protocols main string unset
13672 This option controls the protocols when GnuTLS is used in an Exim
13673 server. For details, see section &<<SECTreqciphgnu>>&.
13674
13675 .option gnutls_compat_mode main boolean unset
13676 This option controls whether GnuTLS is used in compatibility mode in an Exim
13677 server. This reduces security slightly, but improves interworking with older
13678 implementations of TLS.
13679
13680 .option headers_charset main string "see below"
13681 This option sets a default character set for translating from encoded MIME
13682 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13683 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13684 ultimate default is ISO-8859-1. For more details see the description of header
13685 insertions in section &<<SECTexpansionitems>>&.
13686
13687
13688
13689 .option header_maxsize main integer "see below"
13690 .cindex "header section" "maximum size of"
13691 .cindex "limit" "size of message header section"
13692 This option controls the overall maximum size of a message's header
13693 section. The default is the value of HEADER_MAXSIZE in
13694 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13695 sections are rejected.
13696
13697
13698 .option header_line_maxsize main integer 0
13699 .cindex "header lines" "maximum size of"
13700 .cindex "limit" "size of one header line"
13701 This option limits the length of any individual header line in a message, after
13702 all the continuations have been joined together. Messages with individual
13703 header lines that are longer than the limit are rejected. The default value of
13704 zero means &"no limit"&.
13705
13706
13707
13708
13709 .option helo_accept_junk_hosts main "host list&!!" unset
13710 .cindex "HELO" "accepting junk data"
13711 .cindex "EHLO" "accepting junk data"
13712 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13713 mail, and gives an error response for invalid data. Unfortunately, there are
13714 some SMTP clients that send syntactic junk. They can be accommodated by setting
13715 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13716 if you want to do semantic checking.
13717 See also &%helo_allow_chars%& for a way of extending the permitted character
13718 set.
13719
13720
13721 .option helo_allow_chars main string unset
13722 .cindex "HELO" "underscores in"
13723 .cindex "EHLO" "underscores in"
13724 .cindex "underscore in EHLO/HELO"
13725 This option can be set to a string of rogue characters that are permitted in
13726 all EHLO and HELO names in addition to the standard letters, digits,
13727 hyphens, and dots. If you really must allow underscores, you can set
13728 .code
13729 helo_allow_chars = _
13730 .endd
13731 Note that the value is one string, not a list.
13732
13733
13734 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13735 .cindex "HELO" "forcing reverse lookup"
13736 .cindex "EHLO" "forcing reverse lookup"
13737 If the domain given by a client in a HELO or EHLO command matches this
13738 list, a reverse lookup is done in order to establish the host's true name. The
13739 default forces a lookup if the client host gives the server's name or any of
13740 its IP addresses (in brackets), something that broken clients have been seen to
13741 do.
13742
13743
13744 .option helo_try_verify_hosts main "host list&!!" unset
13745 .cindex "HELO verifying" "optional"
13746 .cindex "EHLO" "verifying, optional"
13747 By default, Exim just checks the syntax of HELO and EHLO commands (see
13748 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13749 to do more extensive checking of the data supplied by these commands. The ACL
13750 condition &`verify = helo`& is provided to make this possible.
13751 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13752 to force the check to occur. From release 4.53 onwards, this is no longer
13753 necessary. If the check has not been done before &`verify = helo`& is
13754 encountered, it is done at that time. Consequently, this option is obsolete.
13755 Its specification is retained here for backwards compatibility.
13756
13757 When an EHLO or HELO command is received, if the calling host matches
13758 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13759 EHLO command either:
13760
13761 .ilist
13762 is an IP literal matching the calling address of the host, or
13763 .next
13764 .cindex "DNS" "reverse lookup"
13765 .cindex "reverse DNS lookup"
13766 matches the host name that Exim obtains by doing a reverse lookup of the
13767 calling host address, or
13768 .next
13769 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13770 available) yields the calling host address.
13771 .endlist
13772
13773 However, the EHLO or HELO command is not rejected if any of the checks
13774 fail. Processing continues, but the result of the check is remembered, and can
13775 be detected later in an ACL by the &`verify = helo`& condition.
13776
13777 .option helo_verify_hosts main "host list&!!" unset
13778 .cindex "HELO verifying" "mandatory"
13779 .cindex "EHLO" "verifying, mandatory"
13780 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13781 backwards compatibility. For hosts that match this option, Exim checks the host
13782 name given in the HELO or EHLO in the same way as for
13783 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13784 rejected with a 550 error, and entries are written to the main and reject logs.
13785 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13786 error.
13787
13788 .option hold_domains main "domain list&!!" unset
13789 .cindex "domain" "delaying delivery"
13790 .cindex "delivery" "delaying certain domains"
13791 This option allows mail for particular domains to be held on the queue
13792 manually. The option is overridden if a message delivery is forced with the
13793 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13794 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13795 item in &%hold_domains%&, no routing or delivery for that address is done, and
13796 it is deferred every time the message is looked at.
13797
13798 This option is intended as a temporary operational measure for delaying the
13799 delivery of mail while some problem is being sorted out, or some new
13800 configuration tested. If you just want to delay the processing of some
13801 domains until a queue run occurs, you should use &%queue_domains%& or
13802 &%queue_smtp_domains%&, not &%hold_domains%&.
13803
13804 A setting of &%hold_domains%& does not override Exim's code for removing
13805 messages from the queue if they have been there longer than the longest retry
13806 time in any retry rule. If you want to hold messages for longer than the normal
13807 retry times, insert a dummy retry rule with a long retry time.
13808
13809
13810 .option host_lookup main "host list&!!" unset
13811 .cindex "host name" "lookup, forcing"
13812 Exim does not look up the name of a calling host from its IP address unless it
13813 is required to compare against some host list, or the host matches
13814 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13815 option (which normally contains IP addresses rather than host names). The
13816 default configuration file contains
13817 .code
13818 host_lookup = *
13819 .endd
13820 which causes a lookup to happen for all hosts. If the expense of these lookups
13821 is felt to be too great, the setting can be changed or removed.
13822
13823 After a successful reverse lookup, Exim does a forward lookup on the name it
13824 has obtained, to verify that it yields the IP address that it started with. If
13825 this check fails, Exim behaves as if the name lookup failed.
13826
13827 .vindex "&$host_lookup_failed$&"
13828 .vindex "&$sender_host_name$&"
13829 After any kind of failure, the host name (in &$sender_host_name$&) remains
13830 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13831 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13832 &`verify = reverse_host_lookup`& in ACLs.
13833
13834
13835 .option host_lookup_order main "string list" &`bydns:byaddr`&
13836 This option specifies the order of different lookup methods when Exim is trying
13837 to find a host name from an IP address. The default is to do a DNS lookup
13838 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13839 if that fails. You can change the order of these lookups, or omit one entirely,
13840 if you want.
13841
13842 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13843 multiple PTR records in the DNS and the IP address is not listed in
13844 &_/etc/hosts_&. Different operating systems give different results in this
13845 case. That is why the default tries a DNS lookup first.
13846
13847
13848
13849 .option host_reject_connection main "host list&!!" unset
13850 .cindex "host" "rejecting connections from"
13851 If this option is set, incoming SMTP calls from the hosts listed are rejected
13852 as soon as the connection is made.
13853 This option is obsolete, and retained only for backward compatibility, because
13854 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13855 connections immediately.
13856
13857 The ability to give an immediate rejection (either by this option or using an
13858 ACL) is provided for use in unusual cases. Many hosts will just try again,
13859 sometimes without much delay. Normally, it is better to use an ACL to reject
13860 incoming messages at a later stage, such as after RCPT commands. See
13861 chapter &<<CHAPACL>>&.
13862
13863
13864 .option hosts_connection_nolog main "host list&!!" unset
13865 .cindex "host" "not logging connections from"
13866 This option defines a list of hosts for which connection logging does not
13867 happen, even though the &%smtp_connection%& log selector is set. For example,
13868 you might want not to log SMTP connections from local processes, or from
13869 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13870 the daemon; you should therefore strive to restrict its value to a short inline
13871 list of IP addresses and networks. To disable logging SMTP connections from
13872 local processes, you must create a host list with an empty item. For example:
13873 .code
13874 hosts_connection_nolog = :
13875 .endd
13876 If the &%smtp_connection%& log selector is not set, this option has no effect.
13877
13878
13879
13880 .option hosts_treat_as_local main "domain list&!!" unset
13881 .cindex "local host" "domains treated as"
13882 .cindex "host" "treated as local"
13883 If this option is set, any host names that match the domain list are treated as
13884 if they were the local host when Exim is scanning host lists obtained from MX
13885 records
13886 or other sources. Note that the value of this option is a domain list, not a
13887 host list, because it is always used to check host names, not IP addresses.
13888
13889 This option also applies when Exim is matching the special items
13890 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13891 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13892 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13893 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13894 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13895 interfaces and recognizing the local host.
13896
13897
13898 .option ibase_servers main "string list" unset
13899 .cindex "InterBase" "server list"
13900 This option provides a list of InterBase servers and associated connection data,
13901 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13902 The option is available only if Exim has been built with InterBase support.
13903
13904
13905
13906 .option ignore_bounce_errors_after main time 10w
13907 .cindex "bounce message" "discarding"
13908 .cindex "discarding bounce message"
13909 This option affects the processing of bounce messages that cannot be delivered,
13910 that is, those that suffer a permanent delivery failure. (Bounce messages that
13911 suffer temporary delivery failures are of course retried in the usual way.)
13912
13913 After a permanent delivery failure, bounce messages are frozen,
13914 because there is no sender to whom they can be returned. When a frozen bounce
13915 message has been on the queue for more than the given time, it is unfrozen at
13916 the next queue run, and a further delivery is attempted. If delivery fails
13917 again, the bounce message is discarded. This makes it possible to keep failed
13918 bounce messages around for a shorter time than the normal maximum retry time
13919 for frozen messages. For example,
13920 .code
13921 ignore_bounce_errors_after = 12h
13922 .endd
13923 retries failed bounce message deliveries after 12 hours, discarding any further
13924 failures. If the value of this option is set to a zero time period, bounce
13925 failures are discarded immediately. Setting a very long time (as in the default
13926 value) has the effect of disabling this option. For ways of automatically
13927 dealing with other kinds of frozen message, see &%auto_thaw%& and
13928 &%timeout_frozen_after%&.
13929
13930
13931 .option ignore_fromline_hosts main "host list&!!" unset
13932 .cindex "&""From""& line"
13933 .cindex "UUCP" "&""From""& line"
13934 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13935 the headers of a message. By default this is treated as the start of the
13936 message's body, which means that any following headers are not recognized as
13937 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13938 match those hosts that insist on sending it. If the sender is actually a local
13939 process rather than a remote host, and is using &%-bs%& to inject the messages,
13940 &%ignore_fromline_local%& must be set to achieve this effect.
13941
13942
13943 .option ignore_fromline_local main boolean false
13944 See &%ignore_fromline_hosts%& above.
13945
13946
13947 .option keep_malformed main time 4d
13948 This option specifies the length of time to keep messages whose spool files
13949 have been corrupted in some way. This should, of course, never happen. At the
13950 next attempt to deliver such a message, it gets removed. The incident is
13951 logged.
13952
13953
13954 .option ldap_ca_cert_dir main string unset
13955 .cindex "LDAP", "TLS CA certificate directory"
13956 This option indicates which directory contains CA certificates for verifying
13957 a TLS certificate presented by an LDAP server.
13958 While Exim does not provide a default value, your SSL library may.
13959 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13960 and constrained to be a directory.
13961
13962
13963 .option ldap_ca_cert_file main string unset
13964 .cindex "LDAP", "TLS CA certificate file"
13965 This option indicates which file contains CA certificates for verifying
13966 a TLS certificate presented by an LDAP server.
13967 While Exim does not provide a default value, your SSL library may.
13968 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13969 and constrained to be a file.
13970
13971
13972 .option ldap_cert_file main string unset
13973 .cindex "LDAP" "TLS client certificate file"
13974 This option indicates which file contains an TLS client certificate which
13975 Exim should present to the LDAP server during TLS negotiation.
13976 Should be used together with &%ldap_cert_key%&.
13977
13978
13979 .option ldap_cert_key main string unset
13980 .cindex "LDAP" "TLS client key file"
13981 This option indicates which file contains the secret/private key to use
13982 to prove identity to the LDAP server during TLS negotiation.
13983 Should be used together with &%ldap_cert_file%&, which contains the
13984 identity to be proven.
13985
13986
13987 .option ldap_cipher_suite main string unset
13988 .cindex "LDAP" "TLS cipher suite"
13989 This controls the TLS cipher-suite negotiation during TLS negotiation with
13990 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
13991 cipher-suite options with OpenSSL (as used by LDAP client libraries).
13992
13993
13994 .option ldap_default_servers main "string list" unset
13995 .cindex "LDAP" "default servers"
13996 This option provides a list of LDAP servers which are tried in turn when an
13997 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
13998 details of LDAP queries. This option is available only when Exim has been built
13999 with LDAP support.
14000
14001
14002 .option ldap_require_cert main string unset.
14003 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14004 This should be one of the values "hard", "demand", "allow", "try" or "never".
14005 A value other than one of these is interpreted as "never".
14006 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14007 Although Exim does not set a default, the LDAP library probably defaults
14008 to hard/demand.
14009
14010
14011 .option ldap_start_tls main boolean false
14012 .cindex "LDAP" "whether or not to negotiate TLS"
14013 If set, Exim will attempt to negotiate TLS with the LDAP server when
14014 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14015 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14016 of SSL-on-connect.
14017 In the event of failure to negotiate TLS, the action taken is controlled
14018 by &%ldap_require_cert%&.
14019
14020
14021 .option ldap_version main integer unset
14022 .cindex "LDAP" "protocol version, forcing"
14023 This option can be used to force Exim to set a specific protocol version for
14024 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14025 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14026 the LDAP headers; otherwise it is 2. This option is available only when Exim
14027 has been built with LDAP support.
14028
14029
14030
14031 .option local_from_check main boolean true
14032 .cindex "&'Sender:'& header line" "disabling addition of"
14033 .cindex "&'From:'& header line" "disabling checking of"
14034 When a message is submitted locally (that is, not over a TCP/IP connection) by
14035 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14036 checks that the &'From:'& header line matches the login of the calling user and
14037 the domain specified by &%qualify_domain%&.
14038
14039 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14040 locally submitted message is automatically qualified by Exim, unless the
14041 &%-bnq%& command line option is used.
14042
14043 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14044 on the local part. If the &'From:'& header line does not match, Exim adds a
14045 &'Sender:'& header with an address constructed from the calling user's login
14046 and the default qualify domain.
14047
14048 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14049 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14050 &'Sender:'& header lines supplied by untrusted users, you must also set
14051 &%local_sender_retain%& to be true.
14052
14053 .cindex "envelope sender"
14054 These options affect only the header lines in the message. The envelope sender
14055 is still forced to be the login id at the qualify domain unless
14056 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14057
14058 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14059 request similar header line checking. See section &<<SECTthesenhea>>&, which
14060 has more details about &'Sender:'& processing.
14061
14062
14063
14064
14065 .option local_from_prefix main string unset
14066 When Exim checks the &'From:'& header line of locally submitted messages for
14067 matching the login id (see &%local_from_check%& above), it can be configured to
14068 ignore certain prefixes and suffixes in the local part of the address. This is
14069 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14070 appropriate lists, in the same form as the &%local_part_prefix%& and
14071 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14072 example, if
14073 .code
14074 local_from_prefix = *-
14075 .endd
14076 is set, a &'From:'& line containing
14077 .code
14078 From: anything-user@your.domain.example
14079 .endd
14080 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14081 matches the actual sender address that is constructed from the login name and
14082 qualify domain.
14083
14084
14085 .option local_from_suffix main string unset
14086 See &%local_from_prefix%& above.
14087
14088
14089 .option local_interfaces main "string list" "see below"
14090 This option controls which network interfaces are used by the daemon for
14091 listening; they are also used to identify the local host when routing. Chapter
14092 &<<CHAPinterfaces>>& contains a full description of this option and the related
14093 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14094 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14095 &%local_interfaces%& is
14096 .code
14097 local_interfaces = 0.0.0.0
14098 .endd
14099 when Exim is built without IPv6 support; otherwise it is
14100 .code
14101 local_interfaces = <; ::0 ; 0.0.0.0
14102 .endd
14103
14104 .option local_scan_timeout main time 5m
14105 .cindex "timeout" "for &[local_scan()]& function"
14106 .cindex "&[local_scan()]& function" "timeout"
14107 This timeout applies to the &[local_scan()]& function (see chapter
14108 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14109 the incoming message is rejected with a temporary error if it is an SMTP
14110 message. For a non-SMTP message, the message is dropped and Exim ends with a
14111 non-zero code. The incident is logged on the main and reject logs.
14112
14113
14114
14115 .option local_sender_retain main boolean false
14116 .cindex "&'Sender:'& header line" "retaining from local submission"
14117 When a message is submitted locally (that is, not over a TCP/IP connection) by
14118 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14119 do not want this to happen, you must set &%local_sender_retain%&, and you must
14120 also set &%local_from_check%& to be false (Exim will complain if you do not).
14121 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14122 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14123
14124
14125
14126
14127 .option localhost_number main string&!! unset
14128 .cindex "host" "locally unique number for"
14129 .cindex "message ids" "with multiple hosts"
14130 .vindex "&$localhost_number$&"
14131 Exim's message ids are normally unique only within the local host. If
14132 uniqueness among a set of hosts is required, each host must set a different
14133 value for the &%localhost_number%& option. The string is expanded immediately
14134 after reading the configuration file (so that a number can be computed from the
14135 host name, for example) and the result of the expansion must be a number in the
14136 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14137 systems). This is available in subsequent string expansions via the variable
14138 &$localhost_number$&. When &%localhost_number is set%&, the final two
14139 characters of the message id, instead of just being a fractional part of the
14140 time, are computed from the time and the local host number as described in
14141 section &<<SECTmessiden>>&.
14142
14143
14144
14145 .option log_file_path main "string list&!!" "set at compile time"
14146 .cindex "log" "file path for"
14147 This option sets the path which is used to determine the names of Exim's log
14148 files, or indicates that logging is to be to syslog, or both. It is expanded
14149 when Exim is entered, so it can, for example, contain a reference to the host
14150 name. If no specific path is set for the log files at compile or run time, they
14151 are written in a sub-directory called &_log_& in Exim's spool directory.
14152 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14153 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14154 used. If this string is fixed at your installation (contains no expansion
14155 variables) it is recommended that you do not set this option in the
14156 configuration file, but instead supply the path using LOG_FILE_PATH in
14157 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14158 early on &-- in particular, failure to read the configuration file.
14159
14160
14161 .option log_selector main string unset
14162 .cindex "log" "selectors"
14163 This option can be used to reduce or increase the number of things that Exim
14164 writes to its log files. Its argument is made up of names preceded by plus or
14165 minus characters. For example:
14166 .code
14167 log_selector = +arguments -retry_defer
14168 .endd
14169 A list of possible names and what they control is given in the chapter on
14170 logging, in section &<<SECTlogselector>>&.
14171
14172
14173 .option log_timezone main boolean false
14174 .cindex "log" "timezone for entries"
14175 .vindex "&$tod_log$&"
14176 .vindex "&$tod_zone$&"
14177 By default, the timestamps on log lines are in local time without the
14178 timezone. This means that if your timezone changes twice a year, the timestamps
14179 in log lines are ambiguous for an hour when the clocks go back. One way of
14180 avoiding this problem is to set the timezone to UTC. An alternative is to set
14181 &%log_timezone%& true. This turns on the addition of the timezone offset to
14182 timestamps in log lines. Turning on this option can add quite a lot to the size
14183 of log files because each line is extended by 6 characters. Note that the
14184 &$tod_log$& variable contains the log timestamp without the zone, but there is
14185 another variable called &$tod_zone$& that contains just the timezone offset.
14186
14187
14188 .option lookup_open_max main integer 25
14189 .cindex "too many open files"
14190 .cindex "open files, too many"
14191 .cindex "file" "too many open"
14192 .cindex "lookup" "maximum open files"
14193 .cindex "limit" "open files for lookups"
14194 This option limits the number of simultaneously open files for single-key
14195 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14196 Exim normally keeps these files open during routing, because often the same
14197 file is required several times. If the limit is reached, Exim closes the least
14198 recently used file. Note that if you are using the &'ndbm'& library, it
14199 actually opens two files for each logical DBM database, though it still counts
14200 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14201 open files"& errors with NDBM, you need to reduce the value of
14202 &%lookup_open_max%&.
14203
14204
14205 .option max_username_length main integer 0
14206 .cindex "length of login name"
14207 .cindex "user name" "maximum length"
14208 .cindex "limit" "user name length"
14209 Some operating systems are broken in that they truncate long arguments to
14210 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14211 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14212 an argument that is longer behaves as if &[getpwnam()]& failed.
14213
14214
14215 .option message_body_newlines main bool false
14216 .cindex "message body" "newlines in variables"
14217 .cindex "newline" "in message body variables"
14218 .vindex "&$message_body$&"
14219 .vindex "&$message_body_end$&"
14220 By default, newlines in the message body are replaced by spaces when setting
14221 the &$message_body$& and &$message_body_end$& expansion variables. If this
14222 option is set true, this no longer happens.
14223
14224
14225 .option message_body_visible main integer 500
14226 .cindex "body of message" "visible size"
14227 .cindex "message body" "visible size"
14228 .vindex "&$message_body$&"
14229 .vindex "&$message_body_end$&"
14230 This option specifies how much of a message's body is to be included in the
14231 &$message_body$& and &$message_body_end$& expansion variables.
14232
14233
14234 .option message_id_header_domain main string&!! unset
14235 .cindex "&'Message-ID:'& header line"
14236 If this option is set, the string is expanded and used as the right hand side
14237 (domain) of the &'Message-ID:'& header that Exim creates if a
14238 locally-originated incoming message does not have one. &"Locally-originated"&
14239 means &"not received over TCP/IP."&
14240 Otherwise, the primary host name is used.
14241 Only letters, digits, dot and hyphen are accepted; any other characters are
14242 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14243 empty string, the option is ignored.
14244
14245
14246 .option message_id_header_text main string&!! unset
14247 If this variable is set, the string is expanded and used to augment the text of
14248 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14249 message does not have one. The text of this header is required by RFC 2822 to
14250 take the form of an address. By default, Exim uses its internal message id as
14251 the local part, and the primary host name as the domain. If this option is set,
14252 it is expanded, and provided the expansion is not forced to fail, and does not
14253 yield an empty string, the result is inserted into the header immediately
14254 before the @, separated from the internal message id by a dot. Any characters
14255 that are illegal in an address are automatically converted into hyphens. This
14256 means that variables such as &$tod_log$& can be used, because the spaces and
14257 colons will become hyphens.
14258
14259
14260 .option message_logs main boolean true
14261 .cindex "message logs" "disabling"
14262 .cindex "log" "message log; disabling"
14263 If this option is turned off, per-message log files are not created in the
14264 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14265 Exim, by reducing the number of files involved in handling a message from a
14266 minimum of four (header spool file, body spool file, delivery journal, and
14267 per-message log) to three. The other major I/O activity is Exim's main log,
14268 which is not affected by this option.
14269
14270
14271 .option message_size_limit main string&!! 50M
14272 .cindex "message" "size limit"
14273 .cindex "limit" "message size"
14274 .cindex "size" "of message, limit"
14275 This option limits the maximum size of message that Exim will process. The
14276 value is expanded for each incoming connection so, for example, it can be made
14277 to depend on the IP address of the remote host for messages arriving via
14278 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14279 optionally followed by K or M.
14280
14281 &*Note*&: This limit cannot be made to depend on a message's sender or any
14282 other properties of an individual message, because it has to be advertised in
14283 the server's response to EHLO. String expansion failure causes a temporary
14284 error. A value of zero means no limit, but its use is not recommended. See also
14285 &%bounce_return_size_limit%&.
14286
14287 Incoming SMTP messages are failed with a 552 error if the limit is
14288 exceeded; locally-generated messages either get a stderr message or a delivery
14289 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14290 an oversized message is logged in both the main and the reject logs. See also
14291 the generic transport option &%message_size_limit%&, which limits the size of
14292 message that an individual transport can process.
14293
14294 If you use a virus-scanner and set this option to to a value larger than the
14295 maximum size that your virus-scanner is configured to support, you may get
14296 failures triggered by large mails.  The right size to configure for the
14297 virus-scanner depends upon what data is passed and the options in use but it's
14298 probably safest to just set it to a little larger than this value.  Eg, with a
14299 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14300 some problems may result.
14301
14302 A value of 0 will disable size limit checking; Exim will still advertise the
14303 SIZE extension in an EHLO response, but without a limit, so as to permit
14304 SMTP clients to still indicate the message size along with the MAIL verb.
14305
14306
14307 .option move_frozen_messages main boolean false
14308 .cindex "frozen messages" "moving"
14309 This option, which is available only if Exim has been built with the setting
14310 .code
14311 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14312 .endd
14313 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14314 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14315 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14316 standard utilities for handling such moved messages, and they do not show up in
14317 lists generated by &%-bp%& or by the Exim monitor.
14318
14319
14320 .option mua_wrapper main boolean false
14321 Setting this option true causes Exim to run in a very restrictive mode in which
14322 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14323 contains a full description of this facility.
14324
14325
14326
14327 .option mysql_servers main "string list" unset
14328 .cindex "MySQL" "server list"
14329 This option provides a list of MySQL servers and associated connection data, to
14330 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14331 option is available only if Exim has been built with MySQL support.
14332
14333
14334 .option never_users main "string list&!!" unset
14335 This option is expanded just once, at the start of Exim's processing. Local
14336 message deliveries are normally run in processes that are setuid to the
14337 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14338 It is usually desirable to prevent any deliveries from running as root, as a
14339 safety precaution.
14340
14341 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14342 list of users that must not be used for local deliveries. This list is fixed in
14343 the binary and cannot be overridden by the configuration file. By default, it
14344 contains just the single user name &"root"&. The &%never_users%& runtime option
14345 can be used to add more users to the fixed list.
14346
14347 If a message is to be delivered as one of the users on the fixed list or the
14348 &%never_users%& list, an error occurs, and delivery is deferred. A common
14349 example is
14350 .code
14351 never_users = root:daemon:bin
14352 .endd
14353 Including root is redundant if it is also on the fixed list, but it does no
14354 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14355 transport driver.
14356
14357
14358 .option openssl_options main "string list" unset
14359 .cindex "OpenSSL "compatibility options"
14360 This option allows an administrator to adjust the SSL options applied
14361 by OpenSSL to connections.  It is given as a space-separated list of items,
14362 each one to be +added or -subtracted from the current value.
14363
14364 This option is only available if Exim is built against OpenSSL.  The values
14365 available for this option vary according to the age of your OpenSSL install.
14366 The &"all"& value controls a subset of flags which are available, typically
14367 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14368 list the values known on your system and Exim should support all the
14369 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14370 names lose the leading &"SSL_OP_"& and are lower-cased.
14371
14372 Note that adjusting the options can have severe impact upon the security of
14373 SSL as used by Exim.  It is possible to disable safety checks and shoot
14374 yourself in the foot in various unpleasant ways.  This option should not be
14375 adjusted lightly.  An unrecognised item will be detected at startup, by
14376 invoking Exim with the &%-bV%& flag.
14377
14378 .new
14379 Historical note: prior to release 4.78, Exim defaulted this value to
14380 "+dont_insert_empty_fragments", which may still be needed for compatibility
14381 with some clients, but which lowers security by increasing exposure to
14382 some now infamous attacks.
14383 .wen
14384
14385 An example:
14386 .code
14387 # Make both old MS and old Eudora happy:
14388 openssl_options = -all +microsoft_big_sslv3_buffer \
14389                        +dont_insert_empty_fragments
14390 .endd
14391
14392 Possible options may include:
14393 .ilist
14394 &`all`&
14395 .next
14396 &`allow_unsafe_legacy_renegotiation`&
14397 .next
14398 &`cipher_server_preference`&
14399 .next
14400 &`dont_insert_empty_fragments`&
14401 .next
14402 &`ephemeral_rsa`&
14403 .next
14404 &`legacy_server_connect`&
14405 .next
14406 &`microsoft_big_sslv3_buffer`&
14407 .next
14408 &`microsoft_sess_id_bug`&
14409 .next
14410 &`msie_sslv2_rsa_padding`&
14411 .next
14412 &`netscape_challenge_bug`&
14413 .next
14414 &`netscape_reuse_cipher_change_bug`&
14415 .next
14416 &`no_compression`&
14417 .next
14418 &`no_session_resumption_on_renegotiation`&
14419 .next
14420 &`no_sslv2`&
14421 .next
14422 &`no_sslv3`&
14423 .next
14424 &`no_ticket`&
14425 .next
14426 &`no_tlsv1`&
14427 .next
14428 &`no_tlsv1_1`&
14429 .next
14430 &`no_tlsv1_2`&
14431 .next
14432 &`single_dh_use`&
14433 .next
14434 &`single_ecdh_use`&
14435 .next
14436 &`ssleay_080_client_dh_bug`&
14437 .next
14438 &`sslref2_reuse_cert_type_bug`&
14439 .next
14440 &`tls_block_padding_bug`&
14441 .next
14442 &`tls_d5_bug`&
14443 .next
14444 &`tls_rollback_bug`&
14445 .endlist
14446
14447
14448 .option oracle_servers main "string list" unset
14449 .cindex "Oracle" "server list"
14450 This option provides a list of Oracle servers and associated connection data,
14451 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14452 The option is available only if Exim has been built with Oracle support.
14453
14454
14455 .option percent_hack_domains main "domain list&!!" unset
14456 .cindex "&""percent hack""&"
14457 .cindex "source routing" "in email address"
14458 .cindex "address" "source-routed"
14459 The &"percent hack"& is the convention whereby a local part containing a
14460 percent sign is re-interpreted as a new email address, with the percent
14461 replaced by @. This is sometimes called &"source routing"&, though that term is
14462 also applied to RFC 2822 addresses that begin with an @ character. If this
14463 option is set, Exim implements the percent facility for those domains listed,
14464 but no others. This happens before an incoming SMTP address is tested against
14465 an ACL.
14466
14467 &*Warning*&: The &"percent hack"& has often been abused by people who are
14468 trying to get round relaying restrictions. For this reason, it is best avoided
14469 if at all possible. Unfortunately, a number of less security-conscious MTAs
14470 implement it unconditionally. If you are running Exim on a gateway host, and
14471 routing mail through to internal MTAs without processing the local parts, it is
14472 a good idea to reject recipient addresses with percent characters in their
14473 local parts. Exim's default configuration does this.
14474
14475
14476 .option perl_at_start main boolean false
14477 This option is available only when Exim is built with an embedded Perl
14478 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14479
14480
14481 .option perl_startup main string unset
14482 This option is available only when Exim is built with an embedded Perl
14483 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14484
14485
14486 .option pgsql_servers main "string list" unset
14487 .cindex "PostgreSQL lookup type" "server list"
14488 This option provides a list of PostgreSQL servers and associated connection
14489 data, to be used in conjunction with &(pgsql)& lookups (see section
14490 &<<SECID72>>&). The option is available only if Exim has been built with
14491 PostgreSQL support.
14492
14493
14494 .option pid_file_path main string&!! "set at compile time"
14495 .cindex "daemon" "pid file path"
14496 .cindex "pid file, path for"
14497 This option sets the name of the file to which the Exim daemon writes its
14498 process id. The string is expanded, so it can contain, for example, references
14499 to the host name:
14500 .code
14501 pid_file_path = /var/log/$primary_hostname/exim.pid
14502 .endd
14503 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14504 spool directory.
14505 The value set by the option can be overridden by the &%-oP%& command line
14506 option. A pid file is not written if a &"non-standard"& daemon is run by means
14507 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14508
14509
14510 .option pipelining_advertise_hosts main "host list&!!" *
14511 .cindex "PIPELINING" "suppressing advertising"
14512 This option can be used to suppress the advertisement of the SMTP
14513 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14514 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14515 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14516 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14517 that clients will use it; &"out of order"& commands that are &"expected"& do
14518 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14519
14520
14521 .option preserve_message_logs main boolean false
14522 .cindex "message logs" "preserving"
14523 If this option is set, message log files are not deleted when messages are
14524 completed. Instead, they are moved to a sub-directory of the spool directory
14525 called &_msglog.OLD_&, where they remain available for statistical or debugging
14526 purposes. This is a dangerous option to set on systems with any appreciable
14527 volume of mail. Use with care!
14528
14529
14530 .option primary_hostname main string "see below"
14531 .cindex "name" "of local host"
14532 .cindex "host" "name of local"
14533 .cindex "local host" "name of"
14534 .vindex "&$primary_hostname$&"
14535 This specifies the name of the current host. It is used in the default EHLO or
14536 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14537 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14538 The value is also used by default in some SMTP response messages from an Exim
14539 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14540
14541 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14542 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14543 contains only one component, Exim passes it to &[gethostbyname()]& (or
14544 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14545 version. The variable &$primary_hostname$& contains the host name, whether set
14546 explicitly by this option, or defaulted.
14547
14548
14549 .option print_topbitchars main boolean false
14550 .cindex "printing characters"
14551 .cindex "8-bit characters"
14552 By default, Exim considers only those characters whose codes lie in the range
14553 32&--126 to be printing characters. In a number of circumstances (for example,
14554 when writing log entries) non-printing characters are converted into escape
14555 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14556 is set, code values of 128 and above are also considered to be printing
14557 characters.
14558
14559 This option also affects the header syntax checks performed by the
14560 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14561 the user's full name when constructing From: and Sender: addresses (as
14562 described in section &<<SECTconstr>>&). Setting this option can cause
14563 Exim to generate eight bit message headers that do not conform to the
14564 standards.
14565
14566
14567 .option process_log_path main string unset
14568 .cindex "process log path"
14569 .cindex "log" "process log"
14570 .cindex "&'exiwhat'&"
14571 This option sets the name of the file to which an Exim process writes its
14572 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14573 utility script. If this option is unset, the file called &_exim-process.info_&
14574 in Exim's spool directory is used. The ability to specify the name explicitly
14575 can be useful in environments where two different Exims are running, using
14576 different spool directories.
14577
14578
14579 .option prod_requires_admin main boolean true
14580 .oindex "&%-M%&"
14581 .oindex "&%-R%&"
14582 .oindex "&%-q%&"
14583 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14584 admin user unless &%prod_requires_admin%& is set false. See also
14585 &%queue_list_requires_admin%&.
14586
14587
14588 .option qualify_domain main string "see below"
14589 .cindex "domain" "for qualifying addresses"
14590 .cindex "address" "qualification"
14591 This option specifies the domain name that is added to any envelope sender
14592 addresses that do not have a domain qualification. It also applies to
14593 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14594 are accepted by default only for locally-generated messages. Qualification is
14595 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14596 locally-generated messages, unless the &%-bnq%& command line option is used.
14597
14598 Messages from external sources must always contain fully qualified addresses,
14599 unless the sending host matches &%sender_unqualified_hosts%& or
14600 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14601 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14602 necessary. Internally, Exim always works with fully qualified envelope
14603 addresses. If &%qualify_domain%& is not set, it defaults to the
14604 &%primary_hostname%& value.
14605
14606
14607 .option qualify_recipient main string "see below"
14608 This option allows you to specify a different domain for qualifying recipient
14609 addresses to the one that is used for senders. See &%qualify_domain%& above.
14610
14611
14612
14613 .option queue_domains main "domain list&!!" unset
14614 .cindex "domain" "specifying non-immediate delivery"
14615 .cindex "queueing incoming messages"
14616 .cindex "message" "queueing certain domains"
14617 This option lists domains for which immediate delivery is not required.
14618 A delivery process is started whenever a message is received, but only those
14619 domains that do not match are processed. All other deliveries wait until the
14620 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14621
14622
14623 .option queue_list_requires_admin main boolean true
14624 .oindex "&%-bp%&"
14625 The &%-bp%& command-line option, which lists the messages that are on the
14626 queue, requires the caller to be an admin user unless
14627 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14628
14629
14630 .option queue_only main boolean false
14631 .cindex "queueing incoming messages"
14632 .cindex "message" "queueing unconditionally"
14633 If &%queue_only%& is set, a delivery process is not automatically started
14634 whenever a message is received. Instead, the message waits on the queue for the
14635 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14636 delivered immediately when certain conditions (such as heavy load) occur.
14637
14638 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14639 and &%-odi%& command line options override &%queue_only%& unless
14640 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14641 &%queue_only_load%&, and &%smtp_accept_queue%&.
14642
14643
14644 .option queue_only_file main string unset
14645 .cindex "queueing incoming messages"
14646 .cindex "message" "queueing by file existence"
14647 This option can be set to a colon-separated list of absolute path names, each
14648 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14649 it tests for the existence of each listed path using a call to &[stat()]&. For
14650 each path that exists, the corresponding queueing option is set.
14651 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14652 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14653 .code
14654 queue_only_file = smtp/some/file
14655 .endd
14656 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14657 &_/some/file_& exists.
14658
14659
14660 .option queue_only_load main fixed-point unset
14661 .cindex "load average"
14662 .cindex "queueing incoming messages"
14663 .cindex "message" "queueing by load"
14664 If the system load average is higher than this value, incoming messages from
14665 all sources are queued, and no automatic deliveries are started. If this
14666 happens during local or remote SMTP input, all subsequent messages received on
14667 the same SMTP connection are queued by default, whatever happens to the load in
14668 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14669 false.
14670
14671 Deliveries will subsequently be performed by queue runner processes. This
14672 option has no effect on ancient operating systems on which Exim cannot
14673 determine the load average. See also &%deliver_queue_load_max%& and
14674 &%smtp_load_reserve%&.
14675
14676
14677 .option queue_only_load_latch main boolean true
14678 .cindex "load average" "re-evaluating per message"
14679 When this option is true (the default), once one message has been queued
14680 because the load average is higher than the value set by &%queue_only_load%&,
14681 all subsequent messages received on the same SMTP connection are also queued.
14682 This is a deliberate choice; even though the load average may fall below the
14683 threshold, it doesn't seem right to deliver later messages on the same
14684 connection when not delivering earlier ones. However, there are special
14685 circumstances such as very long-lived connections from scanning appliances
14686 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14687 should be set false. This causes the value of the load average to be
14688 re-evaluated for each message.
14689
14690
14691 .option queue_only_override main boolean true
14692 .cindex "queueing incoming messages"
14693 When this option is true, the &%-od%&&'x'& command line options override the
14694 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14695 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14696 to override; they are accepted, but ignored.
14697
14698
14699 .option queue_run_in_order main boolean false
14700 .cindex "queue runner" "processing messages in order"
14701 If this option is set, queue runs happen in order of message arrival instead of
14702 in an arbitrary order. For this to happen, a complete list of the entire queue
14703 must be set up before the deliveries start. When the queue is all held in a
14704 single directory (the default), a single list is created for both the ordered
14705 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14706 single list is not created when &%queue_run_in_order%& is false. In this case,
14707 the sub-directories are processed one at a time (in a random order), and this
14708 avoids setting up one huge list for the whole queue. Thus, setting
14709 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14710 when the queue is large, because of the extra work in setting up the single,
14711 large list. In most situations, &%queue_run_in_order%& should not be set.
14712
14713
14714
14715 .option queue_run_max main integer 5
14716 .cindex "queue runner" "maximum number of"
14717 This controls the maximum number of queue runner processes that an Exim daemon
14718 can run simultaneously. This does not mean that it starts them all at once,
14719 but rather that if the maximum number are still running when the time comes to
14720 start another one, it refrains from starting another one. This can happen with
14721 very large queues and/or very sluggish deliveries. This option does not,
14722 however, interlock with other processes, so additional queue runners can be
14723 started by other means, or by killing and restarting the daemon.
14724
14725 Setting this option to zero does not suppress queue runs; rather, it disables
14726 the limit, allowing any number of simultaneous queue runner processes to be
14727 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14728 the daemon's command line.
14729
14730 .option queue_smtp_domains main "domain list&!!" unset
14731 .cindex "queueing incoming messages"
14732 .cindex "message" "queueing remote deliveries"
14733 When this option is set, a delivery process is started whenever a message is
14734 received, routing is performed, and local deliveries take place.
14735 However, if any SMTP deliveries are required for domains that match
14736 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14737 message waits on the queue for the next queue run. Since routing of the message
14738 has taken place, Exim knows to which remote hosts it must be delivered, and so
14739 when the queue run happens, multiple messages for the same host are delivered
14740 over a single SMTP connection. The &%-odqs%& command line option causes all
14741 SMTP deliveries to be queued in this way, and is equivalent to setting
14742 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14743 &%queue_domains%&.
14744
14745
14746 .option receive_timeout main time 0s
14747 .cindex "timeout" "for non-SMTP input"
14748 This option sets the timeout for accepting a non-SMTP message, that is, the
14749 maximum time that Exim waits when reading a message on the standard input. If
14750 the value is zero, it will wait for ever. This setting is overridden by the
14751 &%-or%& command line option. The timeout for incoming SMTP messages is
14752 controlled by &%smtp_receive_timeout%&.
14753
14754 .option received_header_text main string&!! "see below"
14755 .cindex "customizing" "&'Received:'& header"
14756 .cindex "&'Received:'& header line" "customizing"
14757 This string defines the contents of the &'Received:'& message header that is
14758 added to each message, except for the timestamp, which is automatically added
14759 on at the end (preceded by a semicolon). The string is expanded each time it is
14760 used. If the expansion yields an empty string, no &'Received:'& header line is
14761 added to the message. Otherwise, the string should start with the text
14762 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14763 header lines. The default setting is:
14764
14765 .code
14766 received_header_text = Received: \
14767   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14768   {${if def:sender_ident \
14769   {from ${quote_local_part:$sender_ident} }}\
14770   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14771   by $primary_hostname \
14772   ${if def:received_protocol {with $received_protocol}} \
14773   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14774   (Exim $version_number)\n\t\
14775   ${if def:sender_address \
14776   {(envelope-from <$sender_address>)\n\t}}\
14777   id $message_exim_id\
14778   ${if def:received_for {\n\tfor $received_for}}
14779 .endd
14780
14781 The reference to the TLS cipher is omitted when Exim is built without TLS
14782 support. The use of conditional expansions ensures that this works for both
14783 locally generated messages and messages received from remote hosts, giving
14784 header lines such as the following:
14785 .code
14786 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14787 by marley.carol.example with esmtp (Exim 4.00)
14788 (envelope-from <bob@carol.example>)
14789 id 16IOWa-00019l-00
14790 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14791 Received: by scrooge.carol.example with local (Exim 4.00)
14792 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14793 .endd
14794 Until the body of the message has been received, the timestamp is the time when
14795 the message started to be received. Once the body has arrived, and all policy
14796 checks have taken place, the timestamp is updated to the time at which the
14797 message was accepted.
14798
14799
14800 .option received_headers_max main integer 30
14801 .cindex "loop" "prevention"
14802 .cindex "mail loop prevention"
14803 .cindex "&'Received:'& header line" "counting"
14804 When a message is to be delivered, the number of &'Received:'& headers is
14805 counted, and if it is greater than this parameter, a mail loop is assumed to
14806 have occurred, the delivery is abandoned, and an error message is generated.
14807 This applies to both local and remote deliveries.
14808
14809
14810 .option recipient_unqualified_hosts main "host list&!!" unset
14811 .cindex "unqualified addresses"
14812 .cindex "host" "unqualified addresses from"
14813 This option lists those hosts from which Exim is prepared to accept unqualified
14814 recipient addresses in message envelopes. The addresses are made fully
14815 qualified by the addition of the &%qualify_recipient%& value. This option also
14816 affects message header lines. Exim does not reject unqualified recipient
14817 addresses in headers, but it qualifies them only if the message came from a
14818 host that matches &%recipient_unqualified_hosts%&,
14819 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14820 option was not set.
14821
14822
14823 .option recipients_max main integer 0
14824 .cindex "limit" "number of recipients"
14825 .cindex "recipient" "maximum number"
14826 If this option is set greater than zero, it specifies the maximum number of
14827 original recipients for any message. Additional recipients that are generated
14828 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14829 all recipients over the limit; earlier recipients are delivered as normal.
14830 Non-SMTP messages with too many recipients are failed, and no deliveries are
14831 done.
14832
14833 .cindex "RCPT" "maximum number of incoming"
14834 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14835 RCPT commands in a single message.
14836
14837
14838 .option recipients_max_reject main boolean false
14839 If this option is set true, Exim rejects SMTP messages containing too many
14840 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14841 error to the eventual DATA command. Otherwise (the default) it gives a 452
14842 error to the surplus RCPT commands and accepts the message on behalf of the
14843 initial set of recipients. The remote server should then re-send the message
14844 for the remaining recipients at a later time.
14845
14846
14847 .option remote_max_parallel main integer 2
14848 .cindex "delivery" "parallelism for remote"
14849 This option controls parallel delivery of one message to a number of remote
14850 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14851 does all the remote deliveries for a message one by one. Otherwise, if a single
14852 message has to be delivered to more than one remote host, or if several copies
14853 have to be sent to the same remote host, up to &%remote_max_parallel%&
14854 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14855 deliveries are required, the maximum number of processes are started, and as
14856 each one finishes, another is begun. The order of starting processes is the
14857 same as if sequential delivery were being done, and can be controlled by the
14858 &%remote_sort_domains%& option. If parallel delivery takes place while running
14859 with debugging turned on, the debugging output from each delivery process is
14860 tagged with its process id.
14861
14862 This option controls only the maximum number of parallel deliveries for one
14863 message in one Exim delivery process. Because Exim has no central queue
14864 manager, there is no way of controlling the total number of simultaneous
14865 deliveries if the configuration allows a delivery attempt as soon as a message
14866 is received.
14867
14868 .cindex "number of deliveries"
14869 .cindex "delivery" "maximum number of"
14870 If you want to control the total number of deliveries on the system, you
14871 need to set the &%queue_only%& option. This ensures that all incoming messages
14872 are added to the queue without starting a delivery process. Then set up an Exim
14873 daemon to start queue runner processes at appropriate intervals (probably
14874 fairly often, for example, every minute), and limit the total number of queue
14875 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14876 delivers only one message at a time, the maximum number of deliveries that can
14877 then take place at once is &%queue_run_max%& multiplied by
14878 &%remote_max_parallel%&.
14879
14880 If it is purely remote deliveries you want to control, use
14881 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14882 doing the SMTP routing before queueing, so that several messages for the same
14883 host will eventually get delivered down the same connection.
14884
14885
14886 .option remote_sort_domains main "domain list&!!" unset
14887 .cindex "sorting remote deliveries"
14888 .cindex "delivery" "sorting remote"
14889 When there are a number of remote deliveries for a message, they are sorted by
14890 domain into the order given by this list. For example,
14891 .code
14892 remote_sort_domains = *.cam.ac.uk:*.uk
14893 .endd
14894 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14895 then to those in the &%uk%& domain, then to any others.
14896
14897
14898 .option retry_data_expire main time 7d
14899 .cindex "hints database" "data expiry"
14900 This option sets a &"use before"& time on retry information in Exim's hints
14901 database. Any older retry data is ignored. This means that, for example, once a
14902 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14903 past failures.
14904
14905
14906 .option retry_interval_max main time 24h
14907 .cindex "retry" "limit on interval"
14908 .cindex "limit" "on retry interval"
14909 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14910 intervals between delivery attempts for messages that cannot be delivered
14911 straight away. This option sets an overall limit to the length of time between
14912 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14913 the default value.
14914
14915
14916 .option return_path_remove main boolean true
14917 .cindex "&'Return-path:'& header line" "removing"
14918 RFC 2821, section 4.4, states that an SMTP server must insert a
14919 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14920 The &'Return-path:'& header preserves the sender address as received in the
14921 MAIL command. This description implies that this header should not be present
14922 in an incoming message. If &%return_path_remove%& is true, any existing
14923 &'Return-path:'& headers are removed from messages at the time they are
14924 received. Exim's transports have options for adding &'Return-path:'& headers at
14925 the time of delivery. They are normally used only for final local deliveries.
14926
14927
14928 .option return_size_limit main integer 100K
14929 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14930
14931
14932 .option rfc1413_hosts main "host list&!!" *
14933 .cindex "RFC 1413"
14934 .cindex "host" "for RFC 1413 calls"
14935 RFC 1413 identification calls are made to any client host which matches an item
14936 in the list.
14937
14938 .option rfc1413_query_timeout main time 5s
14939 .cindex "RFC 1413" "query timeout"
14940 .cindex "timeout" "for RFC 1413 call"
14941 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14942 no RFC 1413 calls are ever made.
14943
14944
14945 .option sender_unqualified_hosts main "host list&!!" unset
14946 .cindex "unqualified addresses"
14947 .cindex "host" "unqualified addresses from"
14948 This option lists those hosts from which Exim is prepared to accept unqualified
14949 sender addresses. The addresses are made fully qualified by the addition of
14950 &%qualify_domain%&. This option also affects message header lines. Exim does
14951 not reject unqualified addresses in headers that contain sender addresses, but
14952 it qualifies them only if the message came from a host that matches
14953 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14954 using TCP/IP), and the &%-bnq%& option was not set.
14955
14956
14957 .option smtp_accept_keepalive main boolean true
14958 .cindex "keepalive" "on incoming connection"
14959 This option controls the setting of the SO_KEEPALIVE option on incoming
14960 TCP/IP socket connections. When set, it causes the kernel to probe idle
14961 connections periodically, by sending packets with &"old"& sequence numbers. The
14962 other end of the connection should send an acknowledgment if the connection is
14963 still okay or a reset if the connection has been aborted. The reason for doing
14964 this is that it has the beneficial effect of freeing up certain types of
14965 connection that can get stuck when the remote host is disconnected without
14966 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14967 hours to detect unreachable hosts.
14968
14969
14970
14971 .option smtp_accept_max main integer 20
14972 .cindex "limit" "incoming SMTP connections"
14973 .cindex "SMTP" "incoming connection count"
14974 .cindex "inetd"
14975 This option specifies the maximum number of simultaneous incoming SMTP calls
14976 that Exim will accept. It applies only to the listening daemon; there is no
14977 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14978 value is set to zero, no limit is applied. However, it is required to be
14979 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14980 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14981
14982 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14983 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14984 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14985 and &%smtp_load_reserve%& are then checked before accepting the connection.
14986
14987
14988 .option smtp_accept_max_nonmail main integer 10
14989 .cindex "limit" "non-mail SMTP commands"
14990 .cindex "SMTP" "limiting non-mail commands"
14991 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
14992 the connection if there are too many. This option defines &"too many"&. The
14993 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
14994 client looping sending EHLO, for example. The check is applied only if the
14995 client host matches &%smtp_accept_max_nonmail_hosts%&.
14996
14997 When a new message is expected, one occurrence of RSET is not counted. This
14998 allows a client to send one RSET between messages (this is not necessary,
14999 but some clients do it). Exim also allows one uncounted occurrence of HELO
15000 or EHLO, and one occurrence of STARTTLS between messages. After
15001 starting up a TLS session, another EHLO is expected, and so it too is not
15002 counted. The first occurrence of AUTH in a connection, or immediately
15003 following STARTTLS is not counted. Otherwise, all commands other than
15004 MAIL, RCPT, DATA, and QUIT are counted.
15005
15006
15007 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15008 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15009 check by setting this option. The default value makes it apply to all hosts. By
15010 changing the value, you can exclude any badly-behaved hosts that you have to
15011 live with.
15012
15013
15014 . Allow this long option name to split; give it unsplit as a fifth argument
15015 . for the automatic .oindex that is generated by .option.
15016
15017 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
15018          smtp_accept_max_per_connection
15019 .cindex "SMTP" "limiting incoming message count"
15020 .cindex "limit" "messages per SMTP connection"
15021 The value of this option limits the number of MAIL commands that Exim is
15022 prepared to accept over a single SMTP connection, whether or not each command
15023 results in the transfer of a message. After the limit is reached, a 421
15024 response is given to subsequent MAIL commands. This limit is a safety
15025 precaution against a client that goes mad (incidents of this type have been
15026 seen).
15027
15028
15029 .option smtp_accept_max_per_host main string&!! unset
15030 .cindex "limit" "SMTP connections from one host"
15031 .cindex "host" "limiting SMTP connections from"
15032 This option restricts the number of simultaneous IP connections from a single
15033 host (strictly, from a single IP address) to the Exim daemon. The option is
15034 expanded, to enable different limits to be applied to different hosts by
15035 reference to &$sender_host_address$&. Once the limit is reached, additional
15036 connection attempts from the same host are rejected with error code 421. This
15037 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15038 of zero imposes no limit. If this option is set greater than zero, it is
15039 required that &%smtp_accept_max%& be non-zero.
15040
15041 &*Warning*&: When setting this option you should not use any expansion
15042 constructions that take an appreciable amount of time. The expansion and test
15043 happen in the main daemon loop, in order to reject additional connections
15044 without forking additional processes (otherwise a denial-of-service attack
15045 could cause a vast number or processes to be created). While the daemon is
15046 doing this processing, it cannot accept any other incoming connections.
15047
15048
15049
15050 .option smtp_accept_queue main integer 0
15051 .cindex "SMTP" "incoming connection count"
15052 .cindex "queueing incoming messages"
15053 .cindex "message" "queueing by SMTP connection count"
15054 If the number of simultaneous incoming SMTP connections being handled via the
15055 listening daemon exceeds this value, messages received by SMTP are just placed
15056 on the queue; no delivery processes are started automatically. The count is
15057 fixed at the start of an SMTP connection. It cannot be updated in the
15058 subprocess that receives messages, and so the queueing or not queueing applies
15059 to all messages received in the same connection.
15060
15061 A value of zero implies no limit, and clearly any non-zero value is useful only
15062 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15063 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15064 various &%-od%&&'x'& command line options.
15065
15066
15067 . Allow this long option name to split; give it unsplit as a fifth argument
15068 . for the automatic .oindex that is generated by .option.
15069
15070 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15071          smtp_accept_queue_per_connection
15072 .cindex "queueing incoming messages"
15073 .cindex "message" "queueing by message count"
15074 This option limits the number of delivery processes that Exim starts
15075 automatically when receiving messages via SMTP, whether via the daemon or by
15076 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15077 and the number of messages received in a single SMTP session exceeds this
15078 number, subsequent messages are placed on the queue, but no delivery processes
15079 are started. This helps to limit the number of Exim processes when a server
15080 restarts after downtime and there is a lot of mail waiting for it on other
15081 systems. On large systems, the default should probably be increased, and on
15082 dial-in client systems it should probably be set to zero (that is, disabled).
15083
15084
15085 .option smtp_accept_reserve main integer 0
15086 .cindex "SMTP" "incoming call count"
15087 .cindex "host" "reserved"
15088 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15089 number of SMTP connections that are reserved for connections from the hosts
15090 that are specified in &%smtp_reserve_hosts%&. The value set in
15091 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15092 restricted to this number of connections; the option specifies a minimum number
15093 of connection slots for them, not a maximum. It is a guarantee that this group
15094 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15095 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15096 individual host.
15097
15098 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15099 set to 5, once there are 45 active connections (from any hosts), new
15100 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15101 provided the other criteria for acceptance are met.
15102
15103
15104 .option smtp_active_hostname main string&!! unset
15105 .cindex "host" "name in SMTP responses"
15106 .cindex "SMTP" "host name in responses"
15107 .vindex "&$primary_hostname$&"
15108 This option is provided for multi-homed servers that want to masquerade as
15109 several different hosts. At the start of an incoming SMTP connection, its value
15110 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15111 responses. For example, it is used as domain name in the response to an
15112 incoming HELO or EHLO command.
15113
15114 .vindex "&$smtp_active_hostname$&"
15115 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15116 is saved with any messages that are received. It is therefore available for use
15117 in routers and transports when the message is later delivered.
15118
15119 If this option is unset, or if its expansion is forced to fail, or if the
15120 expansion results in an empty string, the value of &$primary_hostname$& is
15121 used. Other expansion failures cause a message to be written to the main and
15122 panic logs, and the SMTP command receives a temporary error. Typically, the
15123 value of &%smtp_active_hostname%& depends on the incoming interface address.
15124 For example:
15125 .code
15126 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15127   {cox.mydomain}{box.mydomain}}
15128 .endd
15129
15130 Although &$smtp_active_hostname$& is primarily concerned with incoming
15131 messages, it is also used as the default for HELO commands in callout
15132 verification if there is no remote transport from which to obtain a
15133 &%helo_data%& value.
15134
15135 .option smtp_banner main string&!! "see below"
15136 .cindex "SMTP" "welcome banner"
15137 .cindex "banner for SMTP"
15138 .cindex "welcome banner for SMTP"
15139 .cindex "customizing" "SMTP banner"
15140 This string, which is expanded every time it is used, is output as the initial
15141 positive response to an SMTP connection. The default setting is:
15142 .code
15143 smtp_banner = $smtp_active_hostname ESMTP Exim \
15144   $version_number $tod_full
15145 .endd
15146 Failure to expand the string causes a panic error. If you want to create a
15147 multiline response to the initial SMTP connection, use &"\n"& in the string at
15148 appropriate points, but not at the end. Note that the 220 code is not included
15149 in this string. Exim adds it automatically (several times in the case of a
15150 multiline response).
15151
15152
15153 .option smtp_check_spool_space main boolean true
15154 .cindex "checking disk space"
15155 .cindex "disk space, checking"
15156 .cindex "spool directory" "checking space"
15157 When this option is set, if an incoming SMTP session encounters the SIZE
15158 option on a MAIL command, it checks that there is enough space in the
15159 spool directory's partition to accept a message of that size, while still
15160 leaving free the amount specified by &%check_spool_space%& (even if that value
15161 is zero). If there isn't enough space, a temporary error code is returned.
15162
15163
15164 .option smtp_connect_backlog main integer 20
15165 .cindex "connection backlog"
15166 .cindex "SMTP" "connection backlog"
15167 .cindex "backlog of connections"
15168 This option specifies a maximum number of waiting SMTP connections. Exim passes
15169 this value to the TCP/IP system when it sets up its listener. Once this number
15170 of connections are waiting for the daemon's attention, subsequent connection
15171 attempts are refused at the TCP/IP level. At least, that is what the manuals
15172 say; in some circumstances such connection attempts have been observed to time
15173 out instead. For large systems it is probably a good idea to increase the
15174 value (to 50, say). It also gives some protection against denial-of-service
15175 attacks by SYN flooding.
15176
15177
15178 .option smtp_enforce_sync main boolean true
15179 .cindex "SMTP" "synchronization checking"
15180 .cindex "synchronization checking in SMTP"
15181 The SMTP protocol specification requires the client to wait for a response from
15182 the server at certain points in the dialogue. Without PIPELINING these
15183 synchronization points are after every command; with PIPELINING they are
15184 fewer, but they still exist.
15185
15186 Some spamming sites send out a complete set of SMTP commands without waiting
15187 for any response. Exim protects against this by rejecting a message if the
15188 client has sent further input when it should not have. The error response &"554
15189 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15190 for this error cannot be perfect because of transmission delays (unexpected
15191 input may be on its way but not yet received when Exim checks). However, it
15192 does detect many instances.
15193
15194 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15195 If you want to disable the check selectively (for example, only for certain
15196 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15197 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15198
15199
15200
15201 .option smtp_etrn_command main string&!! unset
15202 .cindex "ETRN" "command to be run"
15203 .vindex "&$domain$&"
15204 If this option is set, the given command is run whenever an SMTP ETRN
15205 command is received from a host that is permitted to issue such commands (see
15206 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15207 are independently expanded. The expansion variable &$domain$& is set to the
15208 argument of the ETRN command, and no syntax checking is done on it. For
15209 example:
15210 .code
15211 smtp_etrn_command = /etc/etrn_command $domain \
15212                     $sender_host_address
15213 .endd
15214 A new process is created to run the command, but Exim does not wait for it to
15215 complete. Consequently, its status cannot be checked. If the command cannot be
15216 run, a line is written to the panic log, but the ETRN caller still receives
15217 a 250 success response. Exim is normally running under its own uid when
15218 receiving SMTP, so it is not possible for it to change the uid before running
15219 the command.
15220
15221
15222 .option smtp_etrn_serialize main boolean true
15223 .cindex "ETRN" "serializing"
15224 When this option is set, it prevents the simultaneous execution of more than
15225 one identical command as a result of ETRN in an SMTP connection. See
15226 section &<<SECTETRN>>& for details.
15227
15228
15229 .option smtp_load_reserve main fixed-point unset
15230 .cindex "load average"
15231 If the system load average ever gets higher than this, incoming SMTP calls are
15232 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15233 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15234 the load is over the limit. The option has no effect on ancient operating
15235 systems on which Exim cannot determine the load average. See also
15236 &%deliver_queue_load_max%& and &%queue_only_load%&.
15237
15238
15239
15240 .option smtp_max_synprot_errors main integer 3
15241 .cindex "SMTP" "limiting syntax and protocol errors"
15242 .cindex "limit" "SMTP syntax and protocol errors"
15243 Exim rejects SMTP commands that contain syntax or protocol errors. In
15244 particular, a syntactically invalid email address, as in this command:
15245 .code
15246 RCPT TO:<abc xyz@a.b.c>
15247 .endd
15248 causes immediate rejection of the command, before any other tests are done.
15249 (The ACL cannot be run if there is no valid address to set up for it.) An
15250 example of a protocol error is receiving RCPT before MAIL. If there are
15251 too many syntax or protocol errors in one SMTP session, the connection is
15252 dropped. The limit is set by this option.
15253
15254 .cindex "PIPELINING" "expected errors"
15255 When the PIPELINING extension to SMTP is in use, some protocol errors are
15256 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15257 Exim assumes that PIPELINING will be used if it advertises it (see
15258 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15259 not count towards the limit.
15260
15261
15262
15263 .option smtp_max_unknown_commands main integer 3
15264 .cindex "SMTP" "limiting unknown commands"
15265 .cindex "limit" "unknown SMTP commands"
15266 If there are too many unrecognized commands in an incoming SMTP session, an
15267 Exim server drops the connection. This is a defence against some kinds of abuse
15268 that subvert web
15269 clients
15270 into making connections to SMTP ports; in these circumstances, a number of
15271 non-SMTP command lines are sent first.
15272
15273
15274
15275 .option smtp_ratelimit_hosts main "host list&!!" unset
15276 .cindex "SMTP" "rate limiting"
15277 .cindex "limit" "rate of message arrival"
15278 .cindex "RCPT" "rate limiting"
15279 Some sites find it helpful to be able to limit the rate at which certain hosts
15280 can send them messages, and the rate at which an individual message can specify
15281 recipients.
15282
15283 Exim has two rate-limiting facilities. This section describes the older
15284 facility, which can limit rates within a single connection. The newer
15285 &%ratelimit%& ACL condition can limit rates across all connections. See section
15286 &<<SECTratelimiting>>& for details of the newer facility.
15287
15288 When a host matches &%smtp_ratelimit_hosts%&, the values of
15289 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15290 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15291 respectively. Each option, if set, must contain a set of four comma-separated
15292 values:
15293
15294 .ilist
15295 A threshold, before which there is no rate limiting.
15296 .next
15297 An initial time delay. Unlike other times in Exim, numbers with decimal
15298 fractional parts are allowed here.
15299 .next
15300 A factor by which to increase the delay each time.
15301 .next
15302 A maximum value for the delay. This should normally be less than 5 minutes,
15303 because after that time, the client is liable to timeout the SMTP command.
15304 .endlist
15305
15306 For example, these settings have been used successfully at the site which
15307 first suggested this feature, for controlling mail from their customers:
15308 .code
15309 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15310 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15311 .endd
15312 The first setting specifies delays that are applied to MAIL commands after
15313 two have been received over a single connection. The initial delay is 0.5
15314 seconds, increasing by a factor of 1.05 each time. The second setting applies
15315 delays to RCPT commands when more than four occur in a single message.
15316
15317
15318 .option smtp_ratelimit_mail main string unset
15319 See &%smtp_ratelimit_hosts%& above.
15320
15321
15322 .option smtp_ratelimit_rcpt main string unset
15323 See &%smtp_ratelimit_hosts%& above.
15324
15325
15326 .option smtp_receive_timeout main time 5m
15327 .cindex "timeout" "for SMTP input"
15328 .cindex "SMTP" "input timeout"
15329 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15330 input, including batch SMTP. If a line of input (either an SMTP command or a
15331 data line) is not received within this time, the SMTP connection is dropped and
15332 the message is abandoned.
15333 A line is written to the log containing one of the following messages:
15334 .code
15335 SMTP command timeout on connection from...
15336 SMTP data timeout on connection from...
15337 .endd
15338 The former means that Exim was expecting to read an SMTP command; the latter
15339 means that it was in the DATA phase, reading the contents of a message.
15340
15341
15342 .oindex "&%-os%&"
15343 The value set by this option can be overridden by the
15344 &%-os%& command-line option. A setting of zero time disables the timeout, but
15345 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15346 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15347 timeout is controlled by &%receive_timeout%& and &%-or%&.
15348
15349
15350 .option smtp_reserve_hosts main "host list&!!" unset
15351 This option defines hosts for which SMTP connections are reserved; see
15352 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15353
15354
15355 .option smtp_return_error_details main boolean false
15356 .cindex "SMTP" "details policy failures"
15357 .cindex "policy control" "rejection, returning details"
15358 In the default state, Exim uses bland messages such as
15359 &"Administrative prohibition"& when it rejects SMTP commands for policy
15360 reasons. Many sysadmins like this because it gives away little information
15361 to spammers. However, some other sysadmins who are applying strict checking
15362 policies want to give out much fuller information about failures. Setting
15363 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15364 example, instead of &"Administrative prohibition"&, it might give:
15365 .code
15366 550-Rejected after DATA: '>' missing at end of address:
15367 550 failing address in "From" header is: <user@dom.ain
15368 .endd
15369
15370 .option spamd_address main string "see below"
15371 This option is available when Exim is compiled with the content-scanning
15372 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15373 The default value is
15374 .code
15375 127.0.0.1 783
15376 .endd
15377 See section &<<SECTscanspamass>>& for more details.
15378
15379
15380
15381 .option split_spool_directory main boolean false
15382 .cindex "multiple spool directories"
15383 .cindex "spool directory" "split"
15384 .cindex "directories, multiple"
15385 If this option is set, it causes Exim to split its input directory into 62
15386 subdirectories, each with a single alphanumeric character as its name. The
15387 sixth character of the message id is used to allocate messages to
15388 subdirectories; this is the least significant base-62 digit of the time of
15389 arrival of the message.
15390
15391 Splitting up the spool in this way may provide better performance on systems
15392 where there are long mail queues, by reducing the number of files in any one
15393 directory. The msglog directory is also split up in a similar way to the input
15394 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15395 are still placed in the single directory &_msglog.OLD_&.
15396
15397 It is not necessary to take any special action for existing messages when
15398 changing &%split_spool_directory%&. Exim notices messages that are in the
15399 &"wrong"& place, and continues to process them. If the option is turned off
15400 after a period of being on, the subdirectories will eventually empty and be
15401 automatically deleted.
15402
15403 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15404 changes. Instead of creating a list of all messages in the queue, and then
15405 trying to deliver each one in turn, it constructs a list of those in one
15406 sub-directory and tries to deliver them, before moving on to the next
15407 sub-directory. The sub-directories are processed in a random order. This
15408 spreads out the scanning of the input directories, and uses less memory. It is
15409 particularly beneficial when there are lots of messages on the queue. However,
15410 if &%queue_run_in_order%& is set, none of this new processing happens. The
15411 entire queue has to be scanned and sorted before any deliveries can start.
15412
15413
15414 .option spool_directory main string&!! "set at compile time"
15415 .cindex "spool directory" "path to"
15416 This defines the directory in which Exim keeps its spool, that is, the messages
15417 it is waiting to deliver. The default value is taken from the compile-time
15418 configuration setting, if there is one. If not, this option must be set. The
15419 string is expanded, so it can contain, for example, a reference to
15420 &$primary_hostname$&.
15421
15422 If the spool directory name is fixed on your installation, it is recommended
15423 that you set it at build time rather than from this option, particularly if the
15424 log files are being written to the spool directory (see &%log_file_path%&).
15425 Otherwise log files cannot be used for errors that are detected early on, such
15426 as failures in the configuration file.
15427
15428 By using this option to override the compiled-in path, it is possible to run
15429 tests of Exim without using the standard spool.
15430
15431 .option sqlite_lock_timeout main time 5s
15432 .cindex "sqlite lookup type" "lock timeout"
15433 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15434 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15435
15436 .option strict_acl_vars main boolean false
15437 .cindex "&ACL;" "variables, handling unset"
15438 This option controls what happens if a syntactically valid but undefined ACL
15439 variable is referenced. If it is false (the default), an empty string
15440 is substituted; if it is true, an error is generated. See section
15441 &<<SECTaclvariables>>& for details of ACL variables.
15442
15443 .option strip_excess_angle_brackets main boolean false
15444 .cindex "angle brackets, excess"
15445 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15446 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15447 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15448 passed on to another MTA, the excess angle brackets are not passed on. If this
15449 option is not set, multiple pairs of angle brackets cause a syntax error.
15450
15451
15452 .option strip_trailing_dot main boolean false
15453 .cindex "trailing dot on domain"
15454 .cindex "dot" "trailing on domain"
15455 If this option is set, a trailing dot at the end of a domain in an address is
15456 ignored. If this is in the envelope and the message is passed on to another
15457 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15458 domain causes a syntax error.
15459 However, addresses in header lines are checked only when an ACL requests header
15460 syntax checking.
15461
15462
15463 .option syslog_duplication main boolean true
15464 .cindex "syslog" "duplicate log lines; suppressing"
15465 When Exim is logging to syslog, it writes the log lines for its three
15466 separate logs at different syslog priorities so that they can in principle
15467 be separated on the logging hosts. Some installations do not require this
15468 separation, and in those cases, the duplication of certain log lines is a
15469 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15470 particular log line is written to syslog. For lines that normally go to
15471 both the main log and the reject log, the reject log version (possibly
15472 containing message header lines) is written, at LOG_NOTICE priority.
15473 Lines that normally go to both the main and the panic log are written at
15474 the LOG_ALERT priority.
15475
15476
15477 .option syslog_facility main string unset
15478 .cindex "syslog" "facility; setting"
15479 This option sets the syslog &"facility"& name, used when Exim is logging to
15480 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15481 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15482 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15483 details of Exim's logging.
15484
15485
15486
15487 .option syslog_processname main string &`exim`&
15488 .cindex "syslog" "process name; setting"
15489 This option sets the syslog &"ident"& name, used when Exim is logging to
15490 syslog. The value must be no longer than 32 characters. See chapter
15491 &<<CHAPlog>>& for details of Exim's logging.
15492
15493
15494
15495 .option syslog_timestamp main boolean true
15496 .cindex "syslog" "timestamps"
15497 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15498 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15499 details of Exim's logging.
15500
15501
15502 .option system_filter main string&!! unset
15503 .cindex "filter" "system filter"
15504 .cindex "system filter" "specifying"
15505 .cindex "Sieve filter" "not available for system filter"
15506 This option specifies an Exim filter file that is applied to all messages at
15507 the start of each delivery attempt, before any routing is done. System filters
15508 must be Exim filters; they cannot be Sieve filters. If the system filter
15509 generates any deliveries to files or pipes, or any new mail messages, the
15510 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15511 which transports are to be used. Details of this facility are given in chapter
15512 &<<CHAPsystemfilter>>&.
15513
15514
15515 .option system_filter_directory_transport main string&!! unset
15516 .vindex "&$address_file$&"
15517 This sets the name of the transport driver that is to be used when the
15518 &%save%& command in a system message filter specifies a path ending in &"/"&,
15519 implying delivery of each message into a separate file in some directory.
15520 During the delivery, the variable &$address_file$& contains the path name.
15521
15522
15523 .option system_filter_file_transport main string&!! unset
15524 .cindex "file" "transport for system filter"
15525 This sets the name of the transport driver that is to be used when the &%save%&
15526 command in a system message filter specifies a path not ending in &"/"&. During
15527 the delivery, the variable &$address_file$& contains the path name.
15528
15529 .option system_filter_group main string unset
15530 .cindex "gid (group id)" "system filter"
15531 This option is used only when &%system_filter_user%& is also set. It sets the
15532 gid under which the system filter is run, overriding any gid that is associated
15533 with the user. The value may be numerical or symbolic.
15534
15535 .option system_filter_pipe_transport main string&!! unset
15536 .cindex "&(pipe)& transport" "for system filter"
15537 .vindex "&$address_pipe$&"
15538 This specifies the transport driver that is to be used when a &%pipe%& command
15539 is used in a system filter. During the delivery, the variable &$address_pipe$&
15540 contains the pipe command.
15541
15542
15543 .option system_filter_reply_transport main string&!! unset
15544 .cindex "&(autoreply)& transport" "for system filter"
15545 This specifies the transport driver that is to be used when a &%mail%& command
15546 is used in a system filter.
15547
15548
15549 .option system_filter_user main string unset
15550 .cindex "uid (user id)" "system filter"
15551 If this option is set to root, the system filter is run in the main Exim
15552 delivery process, as root.  Otherwise, the system filter runs in a separate
15553 process, as the given user, defaulting to the Exim run-time user.
15554 Unless the string consists entirely of digits, it
15555 is looked up in the password data. Failure to find the named user causes a
15556 configuration error. The gid is either taken from the password data, or
15557 specified by &%system_filter_group%&. When the uid is specified numerically,
15558 &%system_filter_group%& is required to be set.
15559
15560 If the system filter generates any pipe, file, or reply deliveries, the uid
15561 under which the filter is run is used when transporting them, unless a
15562 transport option overrides.
15563
15564
15565 .option tcp_nodelay main boolean true
15566 .cindex "daemon" "TCP_NODELAY on sockets"
15567 .cindex "Nagle algorithm"
15568 .cindex "TCP_NODELAY on listening sockets"
15569 If this option is set false, it stops the Exim daemon setting the
15570 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15571 turns off the &"Nagle algorithm"&, which is a way of improving network
15572 performance in interactive (character-by-character) situations. Turning it off
15573 should improve Exim's performance a bit, so that is what happens by default.
15574 However, it appears that some broken clients cannot cope, and time out. Hence
15575 this option. It affects only those sockets that are set up for listening by the
15576 daemon. Sockets created by the smtp transport for delivering mail always set
15577 TCP_NODELAY.
15578
15579
15580 .option timeout_frozen_after main time 0s
15581 .cindex "frozen messages" "timing out"
15582 .cindex "timeout" "frozen messages"
15583 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15584 message of any kind that has been on the queue for longer than the given time
15585 is automatically cancelled at the next queue run. If the frozen message is a
15586 bounce message, it is just discarded; otherwise, a bounce is sent to the
15587 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15588 If you want to timeout frozen bounce messages earlier than other kinds of
15589 frozen message, see &%ignore_bounce_errors_after%&.
15590
15591 &*Note:*& the default value of zero means no timeouts; with this setting,
15592 frozen messages remain on the queue forever (except for any frozen bounce
15593 messages that are released by &%ignore_bounce_errors_after%&).
15594
15595
15596 .option timezone main string unset
15597 .cindex "timezone, setting"
15598 The value of &%timezone%& is used to set the environment variable TZ while
15599 running Exim (if it is different on entry). This ensures that all timestamps
15600 created by Exim are in the required timezone. If you want all your timestamps
15601 to be in UTC (aka GMT) you should set
15602 .code
15603 timezone = UTC
15604 .endd
15605 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15606 or, if that is not set, from the value of the TZ environment variable when Exim
15607 is built. If &%timezone%& is set to the empty string, either at build or run
15608 time, any existing TZ variable is removed from the environment when Exim
15609 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15610 unfortunately not all, operating systems.
15611
15612
15613 .option tls_advertise_hosts main "host list&!!" unset
15614 .cindex "TLS" "advertising"
15615 .cindex "encryption" "on SMTP connection"
15616 .cindex "SMTP" "encrypted connection"
15617 When Exim is built with support for TLS encrypted connections, the availability
15618 of the STARTTLS command to set up an encrypted session is advertised in
15619 response to EHLO only to those client hosts that match this option. See
15620 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15621
15622
15623 .option tls_certificate main string&!! unset
15624 .cindex "TLS" "server certificate; location of"
15625 .cindex "certificate" "server, location of"
15626 The value of this option is expanded, and must then be the absolute path to a
15627 file which contains the server's certificates. The server's private key is also
15628 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15629 &<<CHAPTLS>>& for further details.
15630
15631 &*Note*&: The certificates defined by this option are used only when Exim is
15632 receiving incoming messages as a server. If you want to supply certificates for
15633 use when sending messages as a client, you must set the &%tls_certificate%&
15634 option in the relevant &(smtp)& transport.
15635
15636 .new
15637 If the option contains &$tls_sni$& and Exim is built against OpenSSL, then
15638 if the OpenSSL build supports TLS extensions and the TLS client sends the
15639 Server Name Indication extension, then this option and others documented in
15640 &<<SECTtlssni>>& will be re-expanded.
15641 .wen
15642
15643 .option tls_crl main string&!! unset
15644 .cindex "TLS" "server certificate revocation list"
15645 .cindex "certificate" "revocation list for server"
15646 This option specifies a certificate revocation list. The expanded value must
15647 be the name of a file that contains a CRL in PEM format.
15648
15649 .new
15650 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15651 .wen
15652
15653
15654 .option tls_dhparam main string&!! unset
15655 .cindex "TLS" "D-H parameters for server"
15656 The value of this option is expanded, and must then be the absolute path to
15657 a file which contains the server's DH parameter values.
15658 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15659 ignored. See section &<<SECTopenvsgnu>>& for further details.
15660
15661
15662 .option tls_on_connect_ports main "string list" unset
15663 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15664 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15665 set up without waiting for the client to issue a STARTTLS command. For
15666 further details, see section &<<SECTsupobssmt>>&.
15667
15668
15669
15670 .option tls_privatekey main string&!! unset
15671 .cindex "TLS" "server private key; location of"
15672 The value of this option is expanded, and must then be the absolute path to a
15673 file which contains the server's private key. If this option is unset, or if
15674 the expansion is forced to fail, or the result is an empty string, the private
15675 key is assumed to be in the same file as the server's certificates. See chapter
15676 &<<CHAPTLS>>& for further details.
15677
15678 .new
15679 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15680 .wen
15681
15682
15683 .option tls_remember_esmtp main boolean false
15684 .cindex "TLS" "esmtp state; remembering"
15685 .cindex "TLS" "broken clients"
15686 If this option is set true, Exim violates the RFCs by remembering that it is in
15687 &"esmtp"& state after successfully negotiating a TLS session. This provides
15688 support for broken clients that fail to send a new EHLO after starting a
15689 TLS session.
15690
15691
15692 .option tls_require_ciphers main string&!! unset
15693 .cindex "TLS" "requiring specific ciphers"
15694 .cindex "cipher" "requiring specific"
15695 This option controls which ciphers can be used for incoming TLS connections.
15696 The &(smtp)& transport has an option of the same name for controlling outgoing
15697 connections. This option is expanded for each connection, so can be varied for
15698 different clients if required. The value of this option must be a list of
15699 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15700 in somewhat different ways. If GnuTLS is being used, the client controls the
15701 preference order of the available ciphers. Details are given in sections
15702 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15703
15704
15705 .option tls_try_verify_hosts main "host list&!!" unset
15706 .cindex "TLS" "client certificate verification"
15707 .cindex "certificate" "verification of client"
15708 See &%tls_verify_hosts%& below.
15709
15710
15711 .option tls_verify_certificates main string&!! unset
15712 .cindex "TLS" "client certificate verification"
15713 .cindex "certificate" "verification of client"
15714 The value of this option is expanded, and must then be the absolute path to
15715 a file containing permitted certificates for clients that
15716 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15717 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15718 directory containing certificate files. This does not work with GnuTLS; the
15719 option must be set to the name of a single file if you are using GnuTLS.
15720
15721 These certificates should be for the certificate authorities trusted, rather
15722 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
15723 the value is a file then the certificates are sent by Exim as a server to
15724 connecting clients, defining the list of accepted certificate authorities.
15725 Thus the values defined should be considered public data.  To avoid this,
15726 use OpenSSL with a directory.
15727
15728 .new
15729 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15730 .wen
15731
15732
15733 .option tls_verify_hosts main "host list&!!" unset
15734 .cindex "TLS" "client certificate verification"
15735 .cindex "certificate" "verification of client"
15736 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15737 certificates from clients. The expected certificates are defined by
15738 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15739 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15740 &%tls_verify_certificates%& is not set.
15741
15742 Any client that matches &%tls_verify_hosts%& is constrained by
15743 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15744 present one of the listed certificates. If it does not, the connection is
15745 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15746 the host to use TLS. It can still send SMTP commands through unencrypted
15747 connections. Forcing a client to use TLS has to be done separately using an
15748 ACL to reject inappropriate commands when the connection is not encrypted.
15749
15750 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15751 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15752 certificate and checks it against &%tls_verify_certificates%&, but does not
15753 abort the connection if there is no certificate or if it does not match. This
15754 state can be detected in an ACL, which makes it possible to implement policies
15755 such as &"accept for relay only if a verified certificate has been received,
15756 but accept for local delivery if encrypted, even without a verified
15757 certificate"&.
15758
15759 Client hosts that match neither of these lists are not asked to present
15760 certificates.
15761
15762
15763 .option trusted_groups main "string list&!!" unset
15764 .cindex "trusted groups"
15765 .cindex "groups" "trusted"
15766 This option is expanded just once, at the start of Exim's processing. If this
15767 option is set, any process that is running in one of the listed groups, or
15768 which has one of them as a supplementary group, is trusted. The groups can be
15769 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15770 details of what trusted callers are permitted to do. If neither
15771 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15772 are trusted.
15773
15774 .option trusted_users main "string list&!!" unset
15775 .cindex "trusted users"
15776 .cindex "user" "trusted"
15777 This option is expanded just once, at the start of Exim's processing. If this
15778 option is set, any process that is running as one of the listed users is
15779 trusted. The users can be specified numerically or by name. See section
15780 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15781 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15782 Exim user are trusted.
15783
15784 .option unknown_login main string&!! unset
15785 .cindex "uid (user id)" "unknown caller"
15786 .vindex "&$caller_uid$&"
15787 This is a specialized feature for use in unusual configurations. By default, if
15788 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15789 gives up. The &%unknown_login%& option can be used to set a login name to be
15790 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15791 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15792 is used for the user's real name (gecos field), unless this has been set by the
15793 &%-F%& option.
15794
15795 .option unknown_username main string unset
15796 See &%unknown_login%&.
15797
15798 .option untrusted_set_sender main "address list&!!" unset
15799 .cindex "trusted users"
15800 .cindex "sender" "setting by untrusted user"
15801 .cindex "untrusted user setting sender"
15802 .cindex "user" "untrusted setting sender"
15803 .cindex "envelope sender"
15804 When an untrusted user submits a message to Exim using the standard input, Exim
15805 normally creates an envelope sender address from the user's login and the
15806 default qualification domain. Data from the &%-f%& option (for setting envelope
15807 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15808 is used) is ignored.
15809
15810 However, untrusted users are permitted to set an empty envelope sender address,
15811 to declare that a message should never generate any bounces. For example:
15812 .code
15813 exim -f '<>' user@domain.example
15814 .endd
15815 .vindex "&$sender_ident$&"
15816 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15817 other envelope sender addresses in a controlled way. When it is set, untrusted
15818 users are allowed to set envelope sender addresses that match any of the
15819 patterns in the list. Like all address lists, the string is expanded. The
15820 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15821 users to setting senders that start with their login ids
15822 followed by a hyphen
15823 by a setting like this:
15824 .code
15825 untrusted_set_sender = ^$sender_ident-
15826 .endd
15827 If you want to allow untrusted users to set envelope sender addresses without
15828 restriction, you can use
15829 .code
15830 untrusted_set_sender = *
15831 .endd
15832 The &%untrusted_set_sender%& option applies to all forms of local input, but
15833 only to the setting of the envelope sender. It does not permit untrusted users
15834 to use the other options which trusted user can use to override message
15835 parameters. Furthermore, it does not stop Exim from removing an existing
15836 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15837 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15838 overriding these actions. The handling of the &'Sender:'& header is also
15839 described in section &<<SECTthesenhea>>&.
15840
15841 The log line for a message's arrival shows the envelope sender following
15842 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15843 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15844 envelope sender address, the user's login is shown in parentheses after the
15845 sender address.
15846
15847
15848 .option uucp_from_pattern main string "see below"
15849 .cindex "&""From""& line"
15850 .cindex "UUCP" "&""From""& line"
15851 Some applications that pass messages to an MTA via a command line interface use
15852 an initial line starting with &"From&~"& to pass the envelope sender. In
15853 particular, this is used by UUCP software. Exim recognizes such a line by means
15854 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15855 matches, the sender address is constructed by expanding the contents of
15856 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15857 default pattern recognizes lines in the following two forms:
15858 .code
15859 From ph10 Fri Jan  5 12:35 GMT 1996
15860 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15861 .endd
15862 The pattern can be seen by running
15863 .code
15864 exim -bP uucp_from_pattern
15865 .endd
15866 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15867 year in the second case. The first word after &"From&~"& is matched in the
15868 regular expression by a parenthesized subpattern. The default value for
15869 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15870 (&"ph10"& in the example above) as the message's sender. See also
15871 &%ignore_fromline_hosts%&.
15872
15873
15874 .option uucp_from_sender main string&!! &`$1`&
15875 See &%uucp_from_pattern%& above.
15876
15877
15878 .option warn_message_file main string unset
15879 .cindex "warning of delay" "customizing the message"
15880 .cindex "customizing" "warning message"
15881 This option defines a template file containing paragraphs of text to be used
15882 for constructing the warning message which is sent by Exim when a message has
15883 been on the queue for a specified amount of time, as specified by
15884 &%delay_warning%&. Details of the file's contents are given in chapter
15885 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15886
15887
15888 .option write_rejectlog main boolean true
15889 .cindex "reject log" "disabling"
15890 If this option is set false, Exim no longer writes anything to the reject log.
15891 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15892 .ecindex IIDconfima
15893 .ecindex IIDmaiconf
15894
15895
15896
15897
15898 . ////////////////////////////////////////////////////////////////////////////
15899 . ////////////////////////////////////////////////////////////////////////////
15900
15901 .chapter "Generic options for routers" "CHAProutergeneric"
15902 .scindex IIDgenoprou1 "options" "generic; for routers"
15903 .scindex IIDgenoprou2 "generic options" "router"
15904 This chapter describes the generic options that apply to all routers.
15905 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15906
15907 For a general description of how a router operates, see sections
15908 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15909 which the preconditions are tested. The order of expansion of the options that
15910 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15911 &%headers_remove%&, &%transport%&.
15912
15913
15914
15915 .option address_data routers string&!! unset
15916 .cindex "router" "data attached to address"
15917 The string is expanded just before the router is run, that is, after all the
15918 precondition tests have succeeded. If the expansion is forced to fail, the
15919 router declines, the value of &%address_data%& remains unchanged, and the
15920 &%more%& option controls what happens next. Other expansion failures cause
15921 delivery of the address to be deferred.
15922
15923 .vindex "&$address_data$&"
15924 When the expansion succeeds, the value is retained with the address, and can be
15925 accessed using the variable &$address_data$& in the current router, subsequent
15926 routers, and the eventual transport.
15927
15928 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15929 that runs a user's filter file, the contents of &$address_data$& are accessible
15930 in the filter. This is not normally a problem, because such data is usually
15931 either not confidential or it &"belongs"& to the current user, but if you do
15932 put confidential data into &$address_data$& you need to remember this point.
15933
15934 Even if the router declines or passes, the value of &$address_data$& remains
15935 with the address, though it can be changed by another &%address_data%& setting
15936 on a subsequent router. If a router generates child addresses, the value of
15937 &$address_data$& propagates to them. This also applies to the special kind of
15938 &"child"& that is generated by a router with the &%unseen%& option.
15939
15940 The idea of &%address_data%& is that you can use it to look up a lot of data
15941 for the address once, and then pick out parts of the data later. For example,
15942 you could use a single LDAP lookup to return a string of the form
15943 .code
15944 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15945 .endd
15946 In the transport you could pick out the mailbox by a setting such as
15947 .code
15948 file = ${extract{mailbox}{$address_data}}
15949 .endd
15950 This makes the configuration file less messy, and also reduces the number of
15951 lookups (though Exim does cache lookups).
15952
15953 .vindex "&$sender_address_data$&"
15954 .vindex "&$address_data$&"
15955 The &%address_data%& facility is also useful as a means of passing information
15956 from one router to another, and from a router to a transport. In addition, if
15957 &$address_data$& is set by a router when verifying a recipient address from an
15958 ACL, it remains available for use in the rest of the ACL statement. After
15959 verifying a sender, the value is transferred to &$sender_address_data$&.
15960
15961
15962
15963 .option address_test routers&!? boolean true
15964 .oindex "&%-bt%&"
15965 .cindex "router" "skipping when address testing"
15966 If this option is set false, the router is skipped when routing is being tested
15967 by means of the &%-bt%& command line option. This can be a convenience when
15968 your first router sends messages to an external scanner, because it saves you
15969 having to set the &"already scanned"& indicator when testing real address
15970 routing.
15971
15972
15973
15974 .option cannot_route_message routers string&!! unset
15975 .cindex "router" "customizing &""cannot route""& message"
15976 .cindex "customizing" "&""cannot route""& message"
15977 This option specifies a text message that is used when an address cannot be
15978 routed because Exim has run out of routers. The default message is
15979 &"Unrouteable address"&. This option is useful only on routers that have
15980 &%more%& set false, or on the very last router in a configuration, because the
15981 value that is used is taken from the last router that is considered. This
15982 includes a router that is skipped because its preconditions are not met, as
15983 well as a router that declines. For example, using the default configuration,
15984 you could put:
15985 .code
15986 cannot_route_message = Remote domain not found in DNS
15987 .endd
15988 on the first router, which is a &(dnslookup)& router with &%more%& set false,
15989 and
15990 .code
15991 cannot_route_message = Unknown local user
15992 .endd
15993 on the final router that checks for local users. If string expansion fails for
15994 this option, the default message is used. Unless the expansion failure was
15995 explicitly forced, a message about the failure is written to the main and panic
15996 logs, in addition to the normal message about the routing failure.
15997
15998
15999 .option caseful_local_part routers boolean false
16000 .cindex "case of local parts"
16001 .cindex "router" "case of local parts"
16002 By default, routers handle the local parts of addresses in a case-insensitive
16003 manner, though the actual case is preserved for transmission with the message.
16004 If you want the case of letters to be significant in a router, you must set
16005 this option true. For individual router options that contain address or local
16006 part lists (for example, &%local_parts%&), case-sensitive matching can be
16007 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16008 more details.
16009
16010 .vindex "&$local_part$&"
16011 .vindex "&$original_local_part$&"
16012 .vindex "&$parent_local_part$&"
16013 The value of the &$local_part$& variable is forced to lower case while a
16014 router is running unless &%caseful_local_part%& is set. When a router assigns
16015 an address to a transport, the value of &$local_part$& when the transport runs
16016 is the same as it was in the router. Similarly, when a router generates child
16017 addresses by aliasing or forwarding, the values of &$original_local_part$&
16018 and &$parent_local_part$& are those that were used by the redirecting router.
16019
16020 This option applies to the processing of an address by a router. When a
16021 recipient address is being processed in an ACL, there is a separate &%control%&
16022 modifier that can be used to specify case-sensitive processing within the ACL
16023 (see section &<<SECTcontrols>>&).
16024
16025
16026
16027 .option check_local_user routers&!? boolean false
16028 .cindex "local user, checking in router"
16029 .cindex "router" "checking for local user"
16030 .cindex "&_/etc/passwd_&"
16031 .vindex "&$home$&"
16032 When this option is true, Exim checks that the local part of the recipient
16033 address (with affixes removed if relevant) is the name of an account on the
16034 local system. The check is done by calling the &[getpwnam()]& function rather
16035 than trying to read &_/etc/passwd_& directly. This means that other methods of
16036 holding password data (such as NIS) are supported. If the local part is a local
16037 user, &$home$& is set from the password data, and can be tested in other
16038 preconditions that are evaluated after this one (the order of evaluation is
16039 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16040 overridden by &%router_home_directory%&. If the local part is not a local user,
16041 the router is skipped.
16042
16043 If you want to check that the local part is either the name of a local user
16044 or matches something else, you cannot combine &%check_local_user%& with a
16045 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16046 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16047 setting to achieve this. For example:
16048 .code
16049 local_parts = passwd;$local_part : lsearch;/etc/other/users
16050 .endd
16051 Note, however, that the side effects of &%check_local_user%& (such as setting
16052 up a home directory) do not occur when a &(passwd)& lookup is used in a
16053 &%local_parts%& (or any other) precondition.
16054
16055
16056
16057 .option condition routers&!? string&!! unset
16058 .cindex "router" "customized precondition"
16059 This option specifies a general precondition test that has to succeed for the
16060 router to be called. The &%condition%& option is the last precondition to be
16061 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16062 result is a forced failure, or an empty string, or one of the strings &"0"& or
16063 &"no"& or &"false"& (checked without regard to the case of the letters), the
16064 router is skipped, and the address is offered to the next one.
16065
16066 If the result is any other value, the router is run (as this is the last
16067 precondition to be evaluated, all the other preconditions must be true).
16068
16069 This option is unique in that multiple &%condition%& options may be present.
16070 All &%condition%& options must succeed.
16071
16072 The &%condition%& option provides a means of applying custom conditions to the
16073 running of routers. Note that in the case of a simple conditional expansion,
16074 the default expansion values are exactly what is wanted. For example:
16075 .code
16076 condition = ${if >{$message_age}{600}}
16077 .endd
16078 Because of the default behaviour of the string expansion, this is equivalent to
16079 .code
16080 condition = ${if >{$message_age}{600}{true}{}}
16081 .endd
16082
16083 A multiple condition example, which succeeds:
16084 .code
16085 condition = ${if >{$message_age}{600}}
16086 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16087 condition = foobar
16088 .endd
16089
16090 If the expansion fails (other than forced failure) delivery is deferred. Some
16091 of the other precondition options are common special cases that could in fact
16092 be specified using &%condition%&.
16093
16094
16095 .option debug_print routers string&!! unset
16096 .cindex "testing" "variables in drivers"
16097 If this option is set and debugging is enabled (see the &%-d%& command line
16098 option), the string is expanded and included in the debugging output.
16099 If expansion of the string fails, the error message is written to the debugging
16100 output, and Exim carries on processing.
16101 This option is provided to help with checking out the values of variables and
16102 so on when debugging router configurations. For example, if a &%condition%&
16103 option appears not to be working, &%debug_print%& can be used to output the
16104 variables it references. The output happens after checks for &%domains%&,
16105 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16106 are tested. A newline is added to the text if it does not end with one.
16107
16108
16109
16110 .option disable_logging routers boolean false
16111 If this option is set true, nothing is logged for any routing errors
16112 or for any deliveries caused by this router. You should not set this option
16113 unless you really, really know what you are doing. See also the generic
16114 transport option of the same name.
16115
16116
16117 .option domains routers&!? "domain list&!!" unset
16118 .cindex "router" "restricting to specific domains"
16119 .vindex "&$domain_data$&"
16120 If this option is set, the router is skipped unless the current domain matches
16121 the list. If the match is achieved by means of a file lookup, the data that the
16122 lookup returned for the domain is placed in &$domain_data$& for use in string
16123 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16124 a list of the order in which preconditions are evaluated.
16125
16126
16127
16128 .option driver routers string unset
16129 This option must always be set. It specifies which of the available routers is
16130 to be used.
16131
16132
16133
16134 .option errors_to routers string&!! unset
16135 .cindex "envelope sender"
16136 .cindex "router" "changing address for errors"
16137 If a router successfully handles an address, it may assign the address to a
16138 transport for delivery or it may generate child addresses. In both cases, if
16139 there is a delivery problem during later processing, the resulting bounce
16140 message is sent to the address that results from expanding this string,
16141 provided that the address verifies successfully. The &%errors_to%& option is
16142 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16143
16144 The &%errors_to%& setting associated with an address can be overridden if it
16145 subsequently passes through other routers that have their own &%errors_to%&
16146 settings, or if the message is delivered by a transport with a &%return_path%&
16147 setting.
16148
16149 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16150 the expansion fails to verify, the errors address associated with the incoming
16151 address is used. At top level, this is the envelope sender. A non-forced
16152 expansion failure causes delivery to be deferred.
16153
16154 If an address for which &%errors_to%& has been set ends up being delivered over
16155 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16156 any bounces that are generated by other MTAs on the delivery route are also
16157 sent there. You can set &%errors_to%& to the empty string by either of these
16158 settings:
16159 .code
16160 errors_to =
16161 errors_to = ""
16162 .endd
16163 An expansion item that yields an empty string has the same effect. If you do
16164 this, a locally detected delivery error for addresses processed by this router
16165 no longer gives rise to a bounce message; the error is discarded. If the
16166 address is delivered to a remote host, the return path is set to &`<>`&, unless
16167 overridden by the &%return_path%& option on the transport.
16168
16169 .vindex "&$address_data$&"
16170 If for some reason you want to discard local errors, but use a non-empty
16171 MAIL command for remote delivery, you can preserve the original return
16172 path in &$address_data$& in the router, and reinstate it in the transport by
16173 setting &%return_path%&.
16174
16175 The most common use of &%errors_to%& is to direct mailing list bounces to the
16176 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16177 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16178
16179
16180
16181 .option expn routers&!? boolean true
16182 .cindex "address" "testing"
16183 .cindex "testing" "addresses"
16184 .cindex "EXPN" "router skipping"
16185 .cindex "router" "skipping for EXPN"
16186 If this option is turned off, the router is skipped when testing an address
16187 as a result of processing an SMTP EXPN command. You might, for example,
16188 want to turn it off on a router for users' &_.forward_& files, while leaving it
16189 on for the system alias file.
16190 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16191 are evaluated.
16192
16193 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16194 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16195 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16196
16197
16198
16199 .option fail_verify routers boolean false
16200 .cindex "router" "forcing verification failure"
16201 Setting this option has the effect of setting both &%fail_verify_sender%& and
16202 &%fail_verify_recipient%& to the same value.
16203
16204
16205
16206 .option fail_verify_recipient routers boolean false
16207 If this option is true and an address is accepted by this router when
16208 verifying a recipient, verification fails.
16209
16210
16211
16212 .option fail_verify_sender routers boolean false
16213 If this option is true and an address is accepted by this router when
16214 verifying a sender, verification fails.
16215
16216
16217
16218 .option fallback_hosts routers "string list" unset
16219 .cindex "router" "fallback hosts"
16220 .cindex "fallback" "hosts specified on router"
16221 String expansion is not applied to this option. The argument must be a
16222 colon-separated list of host names or IP addresses. The list separator can be
16223 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16224 each name or address. In fact, the format of each item is exactly the same as
16225 defined for the list of hosts in a &(manualroute)& router (see section
16226 &<<SECTformatonehostitem>>&).
16227
16228 If a router queues an address for a remote transport, this host list is
16229 associated with the address, and used instead of the transport's fallback host
16230 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16231 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16232 transport for further details.
16233
16234
16235 .option group routers string&!! "see below"
16236 .cindex "gid (group id)" "local delivery"
16237 .cindex "local transports" "uid and gid"
16238 .cindex "transport" "local"
16239 .cindex "router" "setting group"
16240 When a router queues an address for a transport, and the transport does not
16241 specify a group, the group given here is used when running the delivery
16242 process.
16243 The group may be specified numerically or by name. If expansion fails, the
16244 error is logged and delivery is deferred.
16245 The default is unset, unless &%check_local_user%& is set, when the default
16246 is taken from the password information. See also &%initgroups%& and &%user%&
16247 and the discussion in chapter &<<CHAPenvironment>>&.
16248
16249
16250
16251 .option headers_add routers string&!! unset
16252 .cindex "header lines" "adding"
16253 .cindex "router" "adding header lines"
16254 This option specifies a string of text that is expanded at routing time, and
16255 associated with any addresses that are accepted by the router. However, this
16256 option has no effect when an address is just being verified. The way in which
16257 the text is used to add header lines at transport time is described in section
16258 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16259 message is in the process of being transported. This means that references to
16260 header lines in string expansions in the transport's configuration do not
16261 &"see"& the added header lines.
16262
16263 The &%headers_add%& option is expanded after &%errors_to%&, but before
16264 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16265 the expansion is forced to fail, the option has no effect. Other expansion
16266 failures are treated as configuration errors.
16267
16268 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16269 router that has the &%one_time%& option set.
16270
16271 .cindex "duplicate addresses"
16272 .oindex "&%unseen%&"
16273 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16274 additions are deleted when the address is passed on to subsequent routers.
16275 For a &%redirect%& router, if a generated address is the same as the incoming
16276 address, this can lead to duplicate addresses with different header
16277 modifications. Exim does not do duplicate deliveries (except, in certain
16278 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16279 which of the duplicates is discarded, so this ambiguous situation should be
16280 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16281
16282
16283
16284 .option headers_remove routers string&!! unset
16285 .cindex "header lines" "removing"
16286 .cindex "router" "removing header lines"
16287 This option specifies a string of text that is expanded at routing time, and
16288 associated with any addresses that are accepted by the router. However, this
16289 option has no effect when an address is just being verified. The way in which
16290 the text is used to remove header lines at transport time is described in
16291 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16292 the message is in the process of being transported. This means that references
16293 to header lines in string expansions in the transport's configuration still
16294 &"see"& the original header lines.
16295
16296 The &%headers_remove%& option is expanded after &%errors_to%& and
16297 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16298 the option has no effect. Other expansion failures are treated as configuration
16299 errors.
16300
16301 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16302 router that has the &%one_time%& option set.
16303
16304 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16305 removal requests are deleted when the address is passed on to subsequent
16306 routers, and this can lead to problems with duplicates -- see the similar
16307 warning for &%headers_add%& above.
16308
16309
16310 .option ignore_target_hosts routers "host list&!!" unset
16311 .cindex "IP address" "discarding"
16312 .cindex "router" "discarding IP addresses"
16313 Although this option is a host list, it should normally contain IP address
16314 entries rather than names. If any host that is looked up by the router has an
16315 IP address that matches an item in this list, Exim behaves as if that IP
16316 address did not exist. This option allows you to cope with rogue DNS entries
16317 like
16318 .code
16319 remote.domain.example.  A  127.0.0.1
16320 .endd
16321 by setting
16322 .code
16323 ignore_target_hosts = 127.0.0.1
16324 .endd
16325 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16326 discarded in this way, the router declines. In a conventional configuration, an
16327 attempt to mail to such a domain would normally provoke the &"unrouteable
16328 domain"& error, and an attempt to verify an address in the domain would fail.
16329 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16330 router declines if presented with one of the listed addresses.
16331
16332 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16333 means of the first or the second of the following settings, respectively:
16334 .code
16335 ignore_target_hosts = 0.0.0.0/0
16336 ignore_target_hosts = <; 0::0/0
16337 .endd
16338 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16339 in the second line matches all IPv6 addresses.
16340
16341 This option may also be useful for ignoring link-local and site-local IPv6
16342 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16343 is expanded before use as a list, it is possible to make it dependent on the
16344 domain that is being routed.
16345
16346 .vindex "&$host_address$&"
16347 During its expansion, &$host_address$& is set to the IP address that is being
16348 checked.
16349
16350 .option initgroups routers boolean false
16351 .cindex "additional groups"
16352 .cindex "groups" "additional"
16353 .cindex "local transports" "uid and gid"
16354 .cindex "transport" "local"
16355 If the router queues an address for a transport, and this option is true, and
16356 the uid supplied by the router is not overridden by the transport, the
16357 &[initgroups()]& function is called when running the transport to ensure that
16358 any additional groups associated with the uid are set up. See also &%group%&
16359 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16360
16361
16362
16363 .option local_part_prefix routers&!? "string list" unset
16364 .cindex "router" "prefix for local part"
16365 .cindex "prefix" "for local part, used in router"
16366 If this option is set, the router is skipped unless the local part starts with
16367 one of the given strings, or &%local_part_prefix_optional%& is true. See
16368 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16369 evaluated.
16370
16371 The list is scanned from left to right, and the first prefix that matches is
16372 used. A limited form of wildcard is available; if the prefix begins with an
16373 asterisk, it matches the longest possible sequence of arbitrary characters at
16374 the start of the local part. An asterisk should therefore always be followed by
16375 some character that does not occur in normal local parts.
16376 .cindex "multiple mailboxes"
16377 .cindex "mailbox" "multiple"
16378 Wildcarding can be used to set up multiple user mailboxes, as described in
16379 section &<<SECTmulbox>>&.
16380
16381 .vindex "&$local_part$&"
16382 .vindex "&$local_part_prefix$&"
16383 During the testing of the &%local_parts%& option, and while the router is
16384 running, the prefix is removed from the local part, and is available in the
16385 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16386 the router accepts the address, this remains true during subsequent delivery by
16387 a transport. In particular, the local part that is transmitted in the RCPT
16388 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16389 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16390 the relevant transport.
16391
16392 When an address is being verified, &%local_part_prefix%& affects only the
16393 behaviour of the router. If the callout feature of verification is in use, this
16394 means that the full address, including the prefix, will be used during the
16395 callout.
16396
16397 The prefix facility is commonly used to handle local parts of the form
16398 &%owner-something%&. Another common use is to support local parts of the form
16399 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16400 to tell a user their forwarding is broken &-- by placing a router like this one
16401 immediately before the router that handles &_.forward_& files:
16402 .code
16403 real_localuser:
16404   driver = accept
16405   local_part_prefix = real-
16406   check_local_user
16407   transport = local_delivery
16408 .endd
16409 For security, it would probably be a good idea to restrict the use of this
16410 router to locally-generated messages, using a condition such as this:
16411 .code
16412   condition = ${if match {$sender_host_address}\
16413                          {\N^(|127\.0\.0\.1)$\N}}
16414 .endd
16415
16416 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16417 both conditions must be met if not optional. Care must be taken if wildcards
16418 are used in both a prefix and a suffix on the same router. Different
16419 separator characters must be used to avoid ambiguity.
16420
16421
16422 .option local_part_prefix_optional routers boolean false
16423 See &%local_part_prefix%& above.
16424
16425
16426
16427 .option local_part_suffix routers&!? "string list" unset
16428 .cindex "router" "suffix for local part"
16429 .cindex "suffix for local part" "used in router"
16430 This option operates in the same way as &%local_part_prefix%&, except that the
16431 local part must end (rather than start) with the given string, the
16432 &%local_part_suffix_optional%& option determines whether the suffix is
16433 mandatory, and the wildcard * character, if present, must be the last
16434 character of the suffix. This option facility is commonly used to handle local
16435 parts of the form &%something-request%& and multiple user mailboxes of the form
16436 &%username-foo%&.
16437
16438
16439 .option local_part_suffix_optional routers boolean false
16440 See &%local_part_suffix%& above.
16441
16442
16443
16444 .option local_parts routers&!? "local part list&!!" unset
16445 .cindex "router" "restricting to specific local parts"
16446 .cindex "local part" "checking in router"
16447 The router is run only if the local part of the address matches the list.
16448 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16449 are evaluated, and
16450 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16451 string is expanded, it is possible to make it depend on the domain, for
16452 example:
16453 .code
16454 local_parts = dbm;/usr/local/specials/$domain
16455 .endd
16456 .vindex "&$local_part_data$&"
16457 If the match is achieved by a lookup, the data that the lookup returned
16458 for the local part is placed in the variable &$local_part_data$& for use in
16459 expansions of the router's private options. You might use this option, for
16460 example, if you have a large number of local virtual domains, and you want to
16461 send all postmaster mail to the same place without having to set up an alias in
16462 each virtual domain:
16463 .code
16464 postmaster:
16465   driver = redirect
16466   local_parts = postmaster
16467   data = postmaster@real.domain.example
16468 .endd
16469
16470
16471 .option log_as_local routers boolean "see below"
16472 .cindex "log" "delivery line"
16473 .cindex "delivery" "log line format"
16474 Exim has two logging styles for delivery, the idea being to make local
16475 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16476 recipient address is given just as the local part, without a domain. The use of
16477 this style is controlled by this option. It defaults to true for the &(accept)&
16478 router, and false for all the others. This option applies only when a
16479 router assigns an address to a transport. It has no effect on routers that
16480 redirect addresses.
16481
16482
16483
16484 .option more routers boolean&!! true
16485 The result of string expansion for this option must be a valid boolean value,
16486 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16487 result causes an error, and delivery is deferred. If the expansion is forced to
16488 fail, the default value for the option (true) is used. Other failures cause
16489 delivery to be deferred.
16490
16491 If this option is set false, and the router declines to handle the address, no
16492 further routers are tried, routing fails, and the address is bounced.
16493 .oindex "&%self%&"
16494 However, if the router explicitly passes an address to the following router by
16495 means of the setting
16496 .code
16497 self = pass
16498 .endd
16499 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16500 does not affect the behaviour if one of the precondition tests fails. In that
16501 case, the address is always passed to the next router.
16502
16503 Note that &%address_data%& is not considered to be a precondition. If its
16504 expansion is forced to fail, the router declines, and the value of &%more%&
16505 controls what happens next.
16506
16507
16508 .option pass_on_timeout routers boolean false
16509 .cindex "timeout" "of router"
16510 .cindex "router" "timeout"
16511 If a router times out during a host lookup, it normally causes deferral of the
16512 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16513 router, overriding &%no_more%&. This may be helpful for systems that are
16514 intermittently connected to the Internet, or those that want to pass to a smart
16515 host any messages that cannot immediately be delivered.
16516
16517 There are occasional other temporary errors that can occur while doing DNS
16518 lookups. They are treated in the same way as a timeout, and this option
16519 applies to all of them.
16520
16521
16522
16523 .option pass_router routers string unset
16524 .cindex "router" "go to after &""pass""&"
16525 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16526 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16527 routing to continue, and overriding a false setting of &%more%&. When one of
16528 these routers returns &"pass"&, the address is normally handed on to the next
16529 router in sequence. This can be changed by setting &%pass_router%& to the name
16530 of another router. However (unlike &%redirect_router%&) the named router must
16531 be below the current router, to avoid loops. Note that this option applies only
16532 to the special case of &"pass"&. It does not apply when a router returns
16533 &"decline"& because it cannot handle an address.
16534
16535
16536
16537 .option redirect_router routers string unset
16538 .cindex "router" "start at after redirection"
16539 Sometimes an administrator knows that it is pointless to reprocess addresses
16540 generated from alias or forward files with the same router again. For
16541 example, if an alias file translates real names into login ids there is no
16542 point searching the alias file a second time, especially if it is a large file.
16543
16544 The &%redirect_router%& option can be set to the name of any router instance.
16545 It causes the routing of any generated addresses to start at the named router
16546 instead of at the first router. This option has no effect if the router in
16547 which it is set does not generate new addresses.
16548
16549
16550
16551 .option require_files routers&!? "string list&!!" unset
16552 .cindex "file" "requiring for router"
16553 .cindex "router" "requiring file existence"
16554 This option provides a general mechanism for predicating the running of a
16555 router on the existence or non-existence of certain files or directories.
16556 Before running a router, as one of its precondition tests, Exim works its way
16557 through the &%require_files%& list, expanding each item separately.
16558
16559 Because the list is split before expansion, any colons in expansion items must
16560 be doubled, or the facility for using a different list separator must be used.
16561 If any expansion is forced to fail, the item is ignored. Other expansion
16562 failures cause routing of the address to be deferred.
16563
16564 If any expanded string is empty, it is ignored. Otherwise, except as described
16565 below, each string must be a fully qualified file path, optionally preceded by
16566 &"!"&. The paths are passed to the &[stat()]& function to test for the
16567 existence of the files or directories. The router is skipped if any paths not
16568 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16569
16570 .cindex "NFS"
16571 If &[stat()]& cannot determine whether a file exists or not, delivery of
16572 the message is deferred. This can happen when NFS-mounted filesystems are
16573 unavailable.
16574
16575 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16576 options, so you cannot use it to check for the existence of a file in which to
16577 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16578 full list of the order in which preconditions are evaluated.) However, as
16579 these options are all expanded, you can use the &%exists%& expansion condition
16580 to make such tests. The &%require_files%& option is intended for checking files
16581 that the router may be going to use internally, or which are needed by a
16582 transport (for example &_.procmailrc_&).
16583
16584 During delivery, the &[stat()]& function is run as root, but there is a
16585 facility for some checking of the accessibility of a file by another user.
16586 This is not a proper permissions check, but just a &"rough"& check that
16587 operates as follows:
16588
16589 If an item in a &%require_files%& list does not contain any forward slash
16590 characters, it is taken to be the user (and optional group, separated by a
16591 comma) to be checked for subsequent files in the list. If no group is specified
16592 but the user is specified symbolically, the gid associated with the uid is
16593 used. For example:
16594 .code
16595 require_files = mail:/some/file
16596 require_files = $local_part:$home/.procmailrc
16597 .endd
16598 If a user or group name in a &%require_files%& list does not exist, the
16599 &%require_files%& condition fails.
16600
16601 Exim performs the check by scanning along the components of the file path, and
16602 checking the access for the given uid and gid. It checks for &"x"& access on
16603 directories, and &"r"& access on the final file. Note that this means that file
16604 access control lists, if the operating system has them, are ignored.
16605
16606 &*Warning 1*&: When the router is being run to verify addresses for an
16607 incoming SMTP message, Exim is not running as root, but under its own uid. This
16608 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16609 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16610 user is not permitted to read one of the directories on the file's path.
16611
16612 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16613 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16614 without root access. In this case, if a check for access by a particular user
16615 is requested, Exim creates a subprocess that runs as that user, and tries the
16616 check again in that process.
16617
16618 The default action for handling an unresolved EACCES is to consider it to
16619 be caused by a configuration error, and routing is deferred because the
16620 existence or non-existence of the file cannot be determined. However, in some
16621 circumstances it may be desirable to treat this condition as if the file did
16622 not exist. If the file name (or the exclamation mark that precedes the file
16623 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16624 as if the file did not exist. For example:
16625 .code
16626 require_files = +/some/file
16627 .endd
16628 If the router is not an essential part of verification (for example, it
16629 handles users' &_.forward_& files), another solution is to set the &%verify%&
16630 option false so that the router is skipped when verifying.
16631
16632
16633
16634 .option retry_use_local_part routers boolean "see below"
16635 .cindex "hints database" "retry keys"
16636 .cindex "local part" "in retry keys"
16637 When a delivery suffers a temporary routing failure, a retry record is created
16638 in Exim's hints database. For addresses whose routing depends only on the
16639 domain, the key for the retry record should not involve the local part, but for
16640 other addresses, both the domain and the local part should be included.
16641 Usually, remote routing is of the former kind, and local routing is of the
16642 latter kind.
16643
16644 This option controls whether the local part is used to form the key for retry
16645 hints for addresses that suffer temporary errors while being handled by this
16646 router. The default value is true for any router that has &%check_local_user%&
16647 set, and false otherwise. Note that this option does not apply to hints keys
16648 for transport delays; they are controlled by a generic transport option of the
16649 same name.
16650
16651 The setting of &%retry_use_local_part%& applies only to the router on which it
16652 appears. If the router generates child addresses, they are routed
16653 independently; this setting does not become attached to them.
16654
16655
16656
16657 .option router_home_directory routers string&!! unset
16658 .cindex "router" "home directory for"
16659 .cindex "home directory" "for router"
16660 .vindex "&$home$&"
16661 This option sets a home directory for use while the router is running. (Compare
16662 &%transport_home_directory%&, which sets a home directory for later
16663 transporting.) In particular, if used on a &(redirect)& router, this option
16664 sets a value for &$home$& while a filter is running. The value is expanded;
16665 forced expansion failure causes the option to be ignored &-- other failures
16666 cause the router to defer.
16667
16668 Expansion of &%router_home_directory%& happens immediately after the
16669 &%check_local_user%& test (if configured), before any further expansions take
16670 place.
16671 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16672 are evaluated.)
16673 While the router is running, &%router_home_directory%& overrides the value of
16674 &$home$& that came from &%check_local_user%&.
16675
16676 When a router accepts an address and assigns it to a local transport (including
16677 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16678 delivery), the home directory setting for the transport is taken from the first
16679 of these values that is set:
16680
16681 .ilist
16682 The &%home_directory%& option on the transport;
16683 .next
16684 The &%transport_home_directory%& option on the router;
16685 .next
16686 The password data if &%check_local_user%& is set on the router;
16687 .next
16688 The &%router_home_directory%& option on the router.
16689 .endlist
16690
16691 In other words, &%router_home_directory%& overrides the password data for the
16692 router, but not for the transport.
16693
16694
16695
16696 .option self routers string freeze
16697 .cindex "MX record" "pointing to local host"
16698 .cindex "local host" "MX pointing to"
16699 This option applies to those routers that use a recipient address to find a
16700 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16701 and &(manualroute)& routers.
16702 Certain configurations of the &(queryprogram)& router can also specify a list
16703 of remote hosts.
16704 Usually such routers are configured to send the message to a remote host via an
16705 &(smtp)& transport. The &%self%& option specifies what happens when the first
16706 host on the list turns out to be the local host.
16707 The way in which Exim checks for the local host is described in section
16708 &<<SECTreclocipadd>>&.
16709
16710 Normally this situation indicates either an error in Exim's configuration (for
16711 example, the router should be configured not to process this domain), or an
16712 error in the DNS (for example, the MX should not point to this host). For this
16713 reason, the default action is to log the incident, defer the address, and
16714 freeze the message. The following alternatives are provided for use in special
16715 cases:
16716
16717 .vlist
16718 .vitem &%defer%&
16719 Delivery of the message is tried again later, but the message is not frozen.
16720
16721 .vitem "&%reroute%&: <&'domain'&>"
16722 The domain is changed to the given domain, and the address is passed back to
16723 be reprocessed by the routers. No rewriting of headers takes place. This
16724 behaviour is essentially a redirection.
16725
16726 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16727 The domain is changed to the given domain, and the address is passed back to be
16728 reprocessed by the routers. Any headers that contain the original domain are
16729 rewritten.
16730
16731 .vitem &%pass%&
16732 .oindex "&%more%&"
16733 .vindex "&$self_hostname$&"
16734 The router passes the address to the next router, or to the router named in the
16735 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16736 subsequent routing and delivery, the variable &$self_hostname$& contains the
16737 name of the local host that the router encountered. This can be used to
16738 distinguish between different cases for hosts with multiple names. The
16739 combination
16740 .code
16741 self = pass
16742 no_more
16743 .endd
16744 ensures that only those addresses that routed to the local host are passed on.
16745 Without &%no_more%&, addresses that were declined for other reasons would also
16746 be passed to the next router.
16747
16748 .vitem &%fail%&
16749 Delivery fails and an error report is generated.
16750
16751 .vitem &%send%&
16752 .cindex "local host" "sending to"
16753 The anomaly is ignored and the address is queued for the transport. This
16754 setting should be used with extreme caution. For an &(smtp)& transport, it
16755 makes sense only in cases where the program that is listening on the SMTP port
16756 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16757 different configuration file that handles the domain in another way.
16758 .endlist
16759
16760
16761
16762 .option senders routers&!? "address list&!!" unset
16763 .cindex "router" "checking senders"
16764 If this option is set, the router is skipped unless the message's sender
16765 address matches something on the list.
16766 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16767 are evaluated.
16768
16769 There are issues concerning verification when the running of routers is
16770 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16771 setting, it sets the sender to the null string. When using the &%-bt%& option
16772 to check a configuration file, it is necessary also to use the &%-f%& option to
16773 set an appropriate sender. For incoming mail, the sender is unset when
16774 verifying the sender, but is available when verifying any recipients. If the
16775 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16776 matters.
16777
16778
16779 .option translate_ip_address routers string&!! unset
16780 .cindex "IP address" "translating"
16781 .cindex "packet radio"
16782 .cindex "router" "IP address translation"
16783 There exist some rare networking situations (for example, packet radio) where
16784 it is helpful to be able to translate IP addresses generated by normal routing
16785 mechanisms into other IP addresses, thus performing a kind of manual IP
16786 routing. This should be done only if the normal IP routing of the TCP/IP stack
16787 is inadequate or broken. Because this is an extremely uncommon requirement, the
16788 code to support this option is not included in the Exim binary unless
16789 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16790
16791 .vindex "&$host_address$&"
16792 The &%translate_ip_address%& string is expanded for every IP address generated
16793 by the router, with the generated address set in &$host_address$&. If the
16794 expansion is forced to fail, no action is taken.
16795 For any other expansion error, delivery of the message is deferred.
16796 If the result of the expansion is an IP address, that replaces the original
16797 address; otherwise the result is assumed to be a host name &-- this is looked
16798 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16799 produce one or more replacement IP addresses. For example, to subvert all IP
16800 addresses in some specific networks, this could be added to a router:
16801 .code
16802 translate_ip_address = \
16803   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16804     {$value}fail}}
16805 .endd
16806 The file would contain lines like
16807 .code
16808 10.2.3.128/26    some.host
16809 10.8.4.34/26     10.44.8.15
16810 .endd
16811 You should not make use of this facility unless you really understand what you
16812 are doing.
16813
16814
16815
16816 .option transport routers string&!! unset
16817 This option specifies the transport to be used when a router accepts an address
16818 and sets it up for delivery. A transport is never needed if a router is used
16819 only for verification. The value of the option is expanded at routing time,
16820 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16821 and result must be the name of one of the configured transports. If it is not,
16822 delivery is deferred.
16823
16824 The &%transport%& option is not used by the &(redirect)& router, but it does
16825 have some private options that set up transports for pipe and file deliveries
16826 (see chapter &<<CHAPredirect>>&).
16827
16828
16829
16830 .option transport_current_directory routers string&!! unset
16831 .cindex "current directory for local transport"
16832 This option associates a current directory with any address that is routed
16833 to a local transport. This can happen either because a transport is
16834 explicitly configured for the router, or because it generates a delivery to a
16835 file or a pipe. During the delivery process (that is, at transport time), this
16836 option string is expanded and is set as the current directory, unless
16837 overridden by a setting on the transport.
16838 If the expansion fails for any reason, including forced failure, an error is
16839 logged, and delivery is deferred.
16840 See chapter &<<CHAPenvironment>>& for details of the local delivery
16841 environment.
16842
16843
16844
16845
16846 .option transport_home_directory routers string&!! "see below"
16847 .cindex "home directory" "for local transport"
16848 This option associates a home directory with any address that is routed to a
16849 local transport. This can happen either because a transport is explicitly
16850 configured for the router, or because it generates a delivery to a file or a
16851 pipe. During the delivery process (that is, at transport time), the option
16852 string is expanded and is set as the home directory, unless overridden by a
16853 setting of &%home_directory%& on the transport.
16854 If the expansion fails for any reason, including forced failure, an error is
16855 logged, and delivery is deferred.
16856
16857 If the transport does not specify a home directory, and
16858 &%transport_home_directory%& is not set for the router, the home directory for
16859 the transport is taken from the password data if &%check_local_user%& is set for
16860 the router. Otherwise it is taken from &%router_home_directory%& if that option
16861 is set; if not, no home directory is set for the transport.
16862
16863 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16864 environment.
16865
16866
16867
16868
16869 .option unseen routers boolean&!! false
16870 .cindex "router" "carrying on after success"
16871 The result of string expansion for this option must be a valid boolean value,
16872 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16873 result causes an error, and delivery is deferred. If the expansion is forced to
16874 fail, the default value for the option (false) is used. Other failures cause
16875 delivery to be deferred.
16876
16877 When this option is set true, routing does not cease if the router accepts the
16878 address. Instead, a copy of the incoming address is passed to the next router,
16879 overriding a false setting of &%more%&. There is little point in setting
16880 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16881 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16882 sometimes true and sometimes false).
16883
16884 .cindex "copy of message (&%unseen%& option)"
16885 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16886 qualifier in filter files. It can be used to cause copies of messages to be
16887 delivered to some other destination, while also carrying out a normal delivery.
16888 In effect, the current address is made into a &"parent"& that has two children
16889 &-- one that is delivered as specified by this router, and a clone that goes on
16890 to be routed further. For this reason, &%unseen%& may not be combined with the
16891 &%one_time%& option in a &(redirect)& router.
16892
16893 &*Warning*&: Header lines added to the address (or specified for removal) by
16894 this router or by previous routers affect the &"unseen"& copy of the message
16895 only. The clone that continues to be processed by further routers starts with
16896 no added headers and none specified for removal. For a &%redirect%& router, if
16897 a generated address is the same as the incoming address, this can lead to
16898 duplicate addresses with different header modifications. Exim does not do
16899 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16900 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16901 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16902 &%redirect%& router may be of help.
16903
16904 Unlike the handling of header modifications, any data that was set by the
16905 &%address_data%& option in the current or previous routers &'is'& passed on to
16906 subsequent routers.
16907
16908
16909 .option user routers string&!! "see below"
16910 .cindex "uid (user id)" "local delivery"
16911 .cindex "local transports" "uid and gid"
16912 .cindex "transport" "local"
16913 .cindex "router" "user for filter processing"
16914 .cindex "filter" "user for processing"
16915 When a router queues an address for a transport, and the transport does not
16916 specify a user, the user given here is used when running the delivery process.
16917 The user may be specified numerically or by name. If expansion fails, the
16918 error is logged and delivery is deferred.
16919 This user is also used by the &(redirect)& router when running a filter file.
16920 The default is unset, except when &%check_local_user%& is set. In this case,
16921 the default is taken from the password information. If the user is specified as
16922 a name, and &%group%& is not set, the group associated with the user is used.
16923 See also &%initgroups%& and &%group%& and the discussion in chapter
16924 &<<CHAPenvironment>>&.
16925
16926
16927
16928 .option verify routers&!? boolean true
16929 Setting this option has the effect of setting &%verify_sender%& and
16930 &%verify_recipient%& to the same value.
16931
16932
16933 .option verify_only routers&!? boolean false
16934 .cindex "EXPN" "with &%verify_only%&"
16935 .oindex "&%-bv%&"
16936 .cindex "router" "used only when verifying"
16937 If this option is set, the router is used only when verifying an address or
16938 testing with the &%-bv%& option, not when actually doing a delivery, testing
16939 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16940 restricted to verifying only senders or recipients by means of
16941 &%verify_sender%& and &%verify_recipient%&.
16942
16943 &*Warning*&: When the router is being run to verify addresses for an incoming
16944 SMTP message, Exim is not running as root, but under its own uid. If the router
16945 accesses any files, you need to make sure that they are accessible to the Exim
16946 user or group.
16947
16948
16949 .option verify_recipient routers&!? boolean true
16950 If this option is false, the router is skipped when verifying recipient
16951 addresses
16952 or testing recipient verification using &%-bv%&.
16953 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16954 are evaluated.
16955
16956
16957 .option verify_sender routers&!? boolean true
16958 If this option is false, the router is skipped when verifying sender addresses
16959 or testing sender verification using &%-bvs%&.
16960 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16961 are evaluated.
16962 .ecindex IIDgenoprou1
16963 .ecindex IIDgenoprou2
16964
16965
16966
16967
16968
16969
16970 . ////////////////////////////////////////////////////////////////////////////
16971 . ////////////////////////////////////////////////////////////////////////////
16972
16973 .chapter "The accept router" "CHID4"
16974 .cindex "&(accept)& router"
16975 .cindex "routers" "&(accept)&"
16976 The &(accept)& router has no private options of its own. Unless it is being
16977 used purely for verification (see &%verify_only%&) a transport is required to
16978 be defined by the generic &%transport%& option. If the preconditions that are
16979 specified by generic options are met, the router accepts the address and queues
16980 it for the given transport. The most common use of this router is for setting
16981 up deliveries to local mailboxes. For example:
16982 .code
16983 localusers:
16984   driver = accept
16985   domains = mydomain.example
16986   check_local_user
16987   transport = local_delivery
16988 .endd
16989 The &%domains%& condition in this example checks the domain of the address, and
16990 &%check_local_user%& checks that the local part is the login of a local user.
16991 When both preconditions are met, the &(accept)& router runs, and queues the
16992 address for the &(local_delivery)& transport.
16993
16994
16995
16996
16997
16998
16999 . ////////////////////////////////////////////////////////////////////////////
17000 . ////////////////////////////////////////////////////////////////////////////
17001
17002 .chapter "The dnslookup router" "CHAPdnslookup"
17003 .scindex IIDdnsrou1 "&(dnslookup)& router"
17004 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17005 The &(dnslookup)& router looks up the hosts that handle mail for the
17006 recipient's domain in the DNS. A transport must always be set for this router,
17007 unless &%verify_only%& is set.
17008
17009 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17010 SRV records. If none are found, or if SRV support is not configured,
17011 MX records are looked up. If no MX records exist, address records are sought.
17012 However, &%mx_domains%& can be set to disable the direct use of address
17013 records.
17014
17015 MX records of equal priority are sorted by Exim into a random order. Exim then
17016 looks for address records for the host names obtained from MX or SRV records.
17017 When a host has more than one IP address, they are sorted into a random order,
17018 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17019 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17020 generic option, the router declines.
17021
17022 Unless they have the highest priority (lowest MX value), MX records that point
17023 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17024 are discarded, together with any other MX records of equal or lower priority.
17025
17026 .cindex "MX record" "pointing to local host"
17027 .cindex "local host" "MX pointing to"
17028 .oindex "&%self%&" "in &(dnslookup)& router"
17029 If the host pointed to by the highest priority MX record, or looked up as an
17030 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17031 happens is controlled by the generic &%self%& option.
17032
17033
17034 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17035 There have been problems with DNS servers when SRV records are looked up.
17036 Some mis-behaving servers return a DNS error or timeout when a non-existent
17037 SRV record is sought. Similar problems have in the past been reported for
17038 MX records. The global &%dns_again_means_nonexist%& option can help with this
17039 problem, but it is heavy-handed because it is a global option.
17040
17041 For this reason, there are two options, &%srv_fail_domains%& and
17042 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17043 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17044 an attempt to look up an SRV or MX record causes one of these results, and the
17045 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17046 such record"&. In the case of an SRV lookup, this means that the router
17047 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17048 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17049 case routing fails.
17050
17051
17052
17053
17054 .section "Private options for dnslookup" "SECID118"
17055 .cindex "options" "&(dnslookup)& router"
17056 The private options for the &(dnslookup)& router are as follows:
17057
17058 .option check_secondary_mx dnslookup boolean false
17059 .cindex "MX record" "checking for secondary"
17060 If this option is set, the router declines unless the local host is found in
17061 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17062 process domains for which the local host is a secondary mail exchanger
17063 differently to other domains. The way in which Exim decides whether a host is
17064 the local host is described in section &<<SECTreclocipadd>>&.
17065
17066
17067 .option check_srv dnslookup string&!! unset
17068 .cindex "SRV record" "enabling use of"
17069 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17070 addition to MX and address records. The support is disabled by default. To
17071 enable SRV support, set the &%check_srv%& option to the name of the service
17072 required. For example,
17073 .code
17074 check_srv = smtp
17075 .endd
17076 looks for SRV records that refer to the normal smtp service. The option is
17077 expanded, so the service name can vary from message to message or address
17078 to address. This might be helpful if SRV records are being used for a
17079 submission service. If the expansion is forced to fail, the &%check_srv%&
17080 option is ignored, and the router proceeds to look for MX records in the
17081 normal way.
17082
17083 When the expansion succeeds, the router searches first for SRV records for
17084 the given service (it assumes TCP protocol). A single SRV record with a
17085 host name that consists of just a single dot indicates &"no such service for
17086 this domain"&; if this is encountered, the router declines. If other kinds of
17087 SRV record are found, they are used to construct a host list for delivery
17088 according to the rules of RFC 2782. MX records are not sought in this case.
17089
17090 When no SRV records are found, MX records (and address records) are sought in
17091 the traditional way. In other words, SRV records take precedence over MX
17092 records, just as MX records take precedence over address records. Note that
17093 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17094 defined it. It is apparently believed that MX records are sufficient for email
17095 and that SRV records should not be used for this purpose. However, SRV records
17096 have an additional &"weight"& feature which some people might find useful when
17097 trying to split an SMTP load between hosts of different power.
17098
17099 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17100 when there is a DNS lookup error.
17101
17102
17103
17104 .option mx_domains dnslookup "domain list&!!" unset
17105 .cindex "MX record" "required to exist"
17106 .cindex "SRV record" "required to exist"
17107 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17108 record in order to be recognized. (The name of this option could be improved.)
17109 For example, if all the mail hosts in &'fict.example'& are known to have MX
17110 records, except for those in &'discworld.fict.example'&, you could use this
17111 setting:
17112 .code
17113 mx_domains = ! *.discworld.fict.example : *.fict.example
17114 .endd
17115 This specifies that messages addressed to a domain that matches the list but
17116 has no MX record should be bounced immediately instead of being routed using
17117 the address record.
17118
17119
17120 .option mx_fail_domains dnslookup "domain list&!!" unset
17121 If the DNS lookup for MX records for one of the domains in this list causes a
17122 DNS lookup error, Exim behaves as if no MX records were found. See section
17123 &<<SECTprowitdnsloo>>& for more discussion.
17124
17125
17126
17127
17128 .option qualify_single dnslookup boolean true
17129 .cindex "DNS" "resolver options"
17130 .cindex "DNS" "qualifying single-component names"
17131 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17132 lookups. Typically, but not standardly, this causes the resolver to qualify
17133 single-component names with the default domain. For example, on a machine
17134 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17135 &'thesaurus.ref.example'& inside the resolver. For details of what your
17136 resolver actually does, consult your man pages for &'resolver'& and
17137 &'resolv.conf'&.
17138
17139
17140
17141 .option rewrite_headers dnslookup boolean true
17142 .cindex "rewriting" "header lines"
17143 .cindex "header lines" "rewriting"
17144 If the domain name in the address that is being processed is not fully
17145 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17146 an address is specified as &'dormouse@teaparty'&, the domain might be
17147 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17148 occur as a result of setting the &%widen_domains%& option. If
17149 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17150 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17151 header lines of the message are rewritten with the full domain name.
17152
17153 This option should be turned off only when it is known that no message is
17154 ever going to be sent outside an environment where the abbreviation makes
17155 sense.
17156
17157 When an MX record is looked up in the DNS and matches a wildcard record, name
17158 servers normally return a record containing the name that has been looked up,
17159 making it impossible to detect whether a wildcard was present or not. However,
17160 some name servers have recently been seen to return the wildcard entry. If the
17161 name returned by a DNS lookup begins with an asterisk, it is not used for
17162 header rewriting.
17163
17164
17165 .option same_domain_copy_routing dnslookup boolean false
17166 .cindex "address" "copying routing"
17167 Addresses with the same domain are normally routed by the &(dnslookup)& router
17168 to the same list of hosts. However, this cannot be presumed, because the router
17169 options and preconditions may refer to the local part of the address. By
17170 default, therefore, Exim routes each address in a message independently. DNS
17171 servers run caches, so repeated DNS lookups are not normally expensive, and in
17172 any case, personal messages rarely have more than a few recipients.
17173
17174 If you are running mailing lists with large numbers of subscribers at the same
17175 domain, and you are using a &(dnslookup)& router which is independent of the
17176 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17177 lookups for identical domains in one message. In this case, when &(dnslookup)&
17178 routes an address to a remote transport, any other unrouted addresses in the
17179 message that have the same domain are automatically given the same routing
17180 without processing them independently,
17181 provided the following conditions are met:
17182
17183 .ilist
17184 No router that processed the address specified &%headers_add%& or
17185 &%headers_remove%&.
17186 .next
17187 The router did not change the address in any way, for example, by &"widening"&
17188 the domain.
17189 .endlist
17190
17191
17192
17193
17194 .option search_parents dnslookup boolean false
17195 .cindex "DNS" "resolver options"
17196 When this option is true, the resolver option RES_DNSRCH is set for DNS
17197 lookups. This is different from the &%qualify_single%& option in that it
17198 applies to domains containing dots. Typically, but not standardly, it causes
17199 the resolver to search for the name in the current domain and in parent
17200 domains. For example, on a machine in the &'fict.example'& domain, if looking
17201 up &'teaparty.wonderland'& failed, the resolver would try
17202 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17203 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17204
17205 Setting this option true can cause problems in domains that have a wildcard MX
17206 record, because any domain that does not have its own MX record matches the
17207 local wildcard.
17208
17209
17210
17211 .option srv_fail_domains dnslookup "domain list&!!" unset
17212 If the DNS lookup for SRV records for one of the domains in this list causes a
17213 DNS lookup error, Exim behaves as if no SRV records were found. See section
17214 &<<SECTprowitdnsloo>>& for more discussion.
17215
17216
17217
17218
17219 .option widen_domains dnslookup "string list" unset
17220 .cindex "domain" "partial; widening"
17221 If a DNS lookup fails and this option is set, each of its strings in turn is
17222 added onto the end of the domain, and the lookup is tried again. For example,
17223 if
17224 .code
17225 widen_domains = fict.example:ref.example
17226 .endd
17227 is set and a lookup of &'klingon.dictionary'& fails,
17228 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17229 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17230 and &%search_parents%& options can cause some widening to be undertaken inside
17231 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17232 when verifying, unless &%rewrite_headers%& is false (not the default).
17233
17234
17235 .section "Effect of qualify_single and search_parents" "SECID119"
17236 When a domain from an envelope recipient is changed by the resolver as a result
17237 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17238 corresponding address in the message's header lines unless &%rewrite_headers%&
17239 is set false. Exim then re-routes the address, using the full domain.
17240
17241 These two options affect only the DNS lookup that takes place inside the router
17242 for the domain of the address that is being routed. They do not affect lookups
17243 such as that implied by
17244 .code
17245 domains = @mx_any
17246 .endd
17247 that may happen while processing a router precondition before the router is
17248 entered. No widening ever takes place for these lookups.
17249 .ecindex IIDdnsrou1
17250 .ecindex IIDdnsrou2
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260 . ////////////////////////////////////////////////////////////////////////////
17261 . ////////////////////////////////////////////////////////////////////////////
17262
17263 .chapter "The ipliteral router" "CHID5"
17264 .cindex "&(ipliteral)& router"
17265 .cindex "domain literal" "routing"
17266 .cindex "routers" "&(ipliteral)&"
17267 This router has no private options. Unless it is being used purely for
17268 verification (see &%verify_only%&) a transport is required to be defined by the
17269 generic &%transport%& option. The router accepts the address if its domain part
17270 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17271 router handles the address
17272 .code
17273 root@[192.168.1.1]
17274 .endd
17275 by setting up delivery to the host with that IP address. IPv4 domain literals
17276 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17277 are similar, but the address is preceded by &`ipv6:`&. For example:
17278 .code
17279 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17280 .endd
17281 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17282 grounds that sooner or later somebody will try it.
17283
17284 .oindex "&%self%&" "in &(ipliteral)& router"
17285 If the IP address matches something in &%ignore_target_hosts%&, the router
17286 declines. If an IP literal turns out to refer to the local host, the generic
17287 &%self%& option determines what happens.
17288
17289 The RFCs require support for domain literals; however, their use is
17290 controversial in today's Internet. If you want to use this router, you must
17291 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17292 Exim will not recognize the domain literal syntax in addresses.
17293
17294
17295
17296 . ////////////////////////////////////////////////////////////////////////////
17297 . ////////////////////////////////////////////////////////////////////////////
17298
17299 .chapter "The iplookup router" "CHID6"
17300 .cindex "&(iplookup)& router"
17301 .cindex "routers" "&(iplookup)&"
17302 The &(iplookup)& router was written to fulfil a specific requirement in
17303 Cambridge University (which in fact no longer exists). For this reason, it is
17304 not included in the binary of Exim by default. If you want to include it, you
17305 must set
17306 .code
17307 ROUTER_IPLOOKUP=yes
17308 .endd
17309 in your &_Local/Makefile_& configuration file.
17310
17311 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17312 connection to one or more specific hosts. The host can then return the same or
17313 a different address &-- in effect rewriting the recipient address in the
17314 message's envelope. The new address is then passed on to subsequent routers. If
17315 this process fails, the address can be passed on to other routers, or delivery
17316 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17317 must not be specified for it.
17318
17319 .cindex "options" "&(iplookup)& router"
17320 .option hosts iplookup string unset
17321 This option must be supplied. Its value is a colon-separated list of host
17322 names. The hosts are looked up using &[gethostbyname()]&
17323 (or &[getipnodebyname()]& when available)
17324 and are tried in order until one responds to the query. If none respond, what
17325 happens is controlled by &%optional%&.
17326
17327
17328 .option optional iplookup boolean false
17329 If &%optional%& is true, if no response is obtained from any host, the address
17330 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17331 delivery to the address is deferred.
17332
17333
17334 .option port iplookup integer 0
17335 .cindex "port" "&(iplookup)& router"
17336 This option must be supplied. It specifies the port number for the TCP or UDP
17337 call.
17338
17339
17340 .option protocol iplookup string udp
17341 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17342 protocols is to be used.
17343
17344
17345 .option query iplookup string&!! "see below"
17346 This defines the content of the query that is sent to the remote hosts. The
17347 default value is:
17348 .code
17349 $local_part@$domain $local_part@$domain
17350 .endd
17351 The repetition serves as a way of checking that a response is to the correct
17352 query in the default case (see &%response_pattern%& below).
17353
17354
17355 .option reroute iplookup string&!! unset
17356 If this option is not set, the rerouted address is precisely the byte string
17357 returned by the remote host, up to the first white space, if any. If set, the
17358 string is expanded to form the rerouted address. It can include parts matched
17359 in the response by &%response_pattern%& by means of numeric variables such as
17360 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17361 whether or not a pattern is in use. In all cases, the rerouted address must end
17362 up in the form &'local_part@domain'&.
17363
17364
17365 .option response_pattern iplookup string unset
17366 This option can be set to a regular expression that is applied to the string
17367 returned from the remote host. If the pattern does not match the response, the
17368 router declines. If &%response_pattern%& is not set, no checking of the
17369 response is done, unless the query was defaulted, in which case there is a
17370 check that the text returned after the first white space is the original
17371 address. This checks that the answer that has been received is in response to
17372 the correct question. For example, if the response is just a new domain, the
17373 following could be used:
17374 .code
17375 response_pattern = ^([^@]+)$
17376 reroute = $local_part@$1
17377 .endd
17378
17379 .option timeout iplookup time 5s
17380 This specifies the amount of time to wait for a response from the remote
17381 machine. The same timeout is used for the &[connect()]& function for a TCP
17382 call. It does not apply to UDP.
17383
17384
17385
17386
17387 . ////////////////////////////////////////////////////////////////////////////
17388 . ////////////////////////////////////////////////////////////////////////////
17389
17390 .chapter "The manualroute router" "CHID7"
17391 .scindex IIDmanrou1 "&(manualroute)& router"
17392 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17393 .cindex "domain" "manually routing"
17394 The &(manualroute)& router is so-called because it provides a way of manually
17395 routing an address according to its domain. It is mainly used when you want to
17396 route addresses to remote hosts according to your own rules, bypassing the
17397 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17398 route to local transports, a facility that may be useful if you want to save
17399 messages for dial-in hosts in local files.
17400
17401 The &(manualroute)& router compares a list of domain patterns with the domain
17402 it is trying to route. If there is no match, the router declines. Each pattern
17403 has associated with it a list of hosts and some other optional data, which may
17404 include a transport. The combination of a pattern and its data is called a
17405 &"routing rule"&. For patterns that do not have an associated transport, the
17406 generic &%transport%& option must specify a transport, unless the router is
17407 being used purely for verification (see &%verify_only%&).
17408
17409 .vindex "&$host$&"
17410 In the case of verification, matching the domain pattern is sufficient for the
17411 router to accept the address. When actually routing an address for delivery,
17412 an address that matches a domain pattern is queued for the associated
17413 transport. If the transport is not a local one, a host list must be associated
17414 with the pattern; IP addresses are looked up for the hosts, and these are
17415 passed to the transport along with the mail address. For local transports, a
17416 host list is optional. If it is present, it is passed in &$host$& as a single
17417 text string.
17418
17419 The list of routing rules can be provided as an inline string in
17420 &%route_list%&, or the data can be obtained by looking up the domain in a file
17421 or database by setting &%route_data%&. Only one of these settings may appear in
17422 any one instance of &(manualroute)&. The format of routing rules is described
17423 below, following the list of private options.
17424
17425
17426 .section "Private options for manualroute" "SECTprioptman"
17427
17428 .cindex "options" "&(manualroute)& router"
17429 The private options for the &(manualroute)& router are as follows:
17430
17431 .option host_all_ignored manualroute string defer
17432 See &%host_find_failed%&.
17433
17434 .option host_find_failed manualroute string freeze
17435 This option controls what happens when &(manualroute)& tries to find an IP
17436 address for a host, and the host does not exist. The option can be set to one
17437 of the following values:
17438 .code
17439 decline
17440 defer
17441 fail
17442 freeze
17443 ignore
17444 pass
17445 .endd
17446 The default (&"freeze"&) assumes that this state is a serious configuration
17447 error. The difference between &"pass"& and &"decline"& is that the former
17448 forces the address to be passed to the next router (or the router defined by
17449 &%pass_router%&),
17450 .oindex "&%more%&"
17451 overriding &%no_more%&, whereas the latter passes the address to the next
17452 router only if &%more%& is true.
17453
17454 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17455 cannot be found. If all the hosts in the list are ignored, the behaviour is
17456 controlled by the &%host_all_ignored%& option. This takes the same values
17457 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17458
17459 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17460 state; if a host lookup gets a temporary error, delivery is deferred unless the
17461 generic &%pass_on_timeout%& option is set.
17462
17463
17464 .option hosts_randomize manualroute boolean false
17465 .cindex "randomized host list"
17466 .cindex "host" "list of; randomized"
17467 If this option is set, the order of the items in a host list in a routing rule
17468 is randomized each time the list is used, unless an option in the routing rule
17469 overrides (see below). Randomizing the order of a host list can be used to do
17470 crude load sharing. However, if more than one mail address is routed by the
17471 same router to the same host list, the host lists are considered to be the same
17472 (even though they may be randomized into different orders) for the purpose of
17473 deciding whether to batch the deliveries into a single SMTP transaction.
17474
17475 When &%hosts_randomize%& is true, a host list may be split
17476 into groups whose order is separately randomized. This makes it possible to
17477 set up MX-like behaviour. The boundaries between groups are indicated by an
17478 item that is just &`+`& in the host list. For example:
17479 .code
17480 route_list = * host1:host2:host3:+:host4:host5
17481 .endd
17482 The order of the first three hosts and the order of the last two hosts is
17483 randomized for each use, but the first three always end up before the last two.
17484 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17485 randomized host list is passed to an &(smtp)& transport that also has
17486 &%hosts_randomize set%&, the list is not re-randomized.
17487
17488
17489 .option route_data manualroute string&!! unset
17490 If this option is set, it must expand to yield the data part of a routing rule.
17491 Typically, the expansion string includes a lookup based on the domain. For
17492 example:
17493 .code
17494 route_data = ${lookup{$domain}dbm{/etc/routes}}
17495 .endd
17496 If the expansion is forced to fail, or the result is an empty string, the
17497 router declines. Other kinds of expansion failure cause delivery to be
17498 deferred.
17499
17500
17501 .option route_list manualroute "string list" unset
17502 This string is a list of routing rules, in the form defined below. Note that,
17503 unlike most string lists, the items are separated by semicolons. This is so
17504 that they may contain colon-separated host lists.
17505
17506
17507 .option same_domain_copy_routing manualroute boolean false
17508 .cindex "address" "copying routing"
17509 Addresses with the same domain are normally routed by the &(manualroute)&
17510 router to the same list of hosts. However, this cannot be presumed, because the
17511 router options and preconditions may refer to the local part of the address. By
17512 default, therefore, Exim routes each address in a message independently. DNS
17513 servers run caches, so repeated DNS lookups are not normally expensive, and in
17514 any case, personal messages rarely have more than a few recipients.
17515
17516 If you are running mailing lists with large numbers of subscribers at the same
17517 domain, and you are using a &(manualroute)& router which is independent of the
17518 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17519 lookups for identical domains in one message. In this case, when
17520 &(manualroute)& routes an address to a remote transport, any other unrouted
17521 addresses in the message that have the same domain are automatically given the
17522 same routing without processing them independently. However, this is only done
17523 if &%headers_add%& and &%headers_remove%& are unset.
17524
17525
17526
17527
17528 .section "Routing rules in route_list" "SECID120"
17529 The value of &%route_list%& is a string consisting of a sequence of routing
17530 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17531 entered as two semicolons. Alternatively, the list separator can be changed as
17532 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17533 Empty rules are ignored. The format of each rule is
17534 .display
17535 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17536 .endd
17537 The following example contains two rules, each with a simple domain pattern and
17538 no options:
17539 .code
17540 route_list = \
17541   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17542   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17543 .endd
17544 The three parts of a rule are separated by white space. The pattern and the
17545 list of hosts can be enclosed in quotes if necessary, and if they are, the
17546 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17547 single domain pattern, which is the only mandatory item in the rule. The
17548 pattern is in the same format as one item in a domain list (see section
17549 &<<SECTdomainlist>>&),
17550 except that it may not be the name of an interpolated file.
17551 That is, it may be wildcarded, or a regular expression, or a file or database
17552 lookup (with semicolons doubled, because of the use of semicolon as a separator
17553 in a &%route_list%&).
17554
17555 The rules in &%route_list%& are searched in order until one of the patterns
17556 matches the domain that is being routed. The list of hosts and then options are
17557 then used as described below. If there is no match, the router declines. When
17558 &%route_list%& is set, &%route_data%& must not be set.
17559
17560
17561
17562 .section "Routing rules in route_data" "SECID121"
17563 The use of &%route_list%& is convenient when there are only a small number of
17564 routing rules. For larger numbers, it is easier to use a file or database to
17565 hold the routing information, and use the &%route_data%& option instead.
17566 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17567 Most commonly, &%route_data%& is set as a string that contains an
17568 expansion lookup. For example, suppose we place two routing rules in a file
17569 like this:
17570 .code
17571 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17572 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17573 .endd
17574 This data can be accessed by setting
17575 .code
17576 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17577 .endd
17578 Failure of the lookup results in an empty string, causing the router to
17579 decline. However, you do not have to use a lookup in &%route_data%&. The only
17580 requirement is that the result of expanding the string is a list of hosts,
17581 possibly followed by options, separated by white space. The list of hosts must
17582 be enclosed in quotes if it contains white space.
17583
17584
17585
17586
17587 .section "Format of the list of hosts" "SECID122"
17588 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17589 always separately expanded before use. If the expansion fails, the router
17590 declines. The result of the expansion must be a colon-separated list of names
17591 and/or IP addresses, optionally also including ports. The format of each item
17592 in the list is described in the next section. The list separator can be changed
17593 as described in section &<<SECTlistconstruct>>&.
17594
17595 If the list of hosts was obtained from a &%route_list%& item, the following
17596 variables are set during its expansion:
17597
17598 .ilist
17599 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17600 If the domain was matched against a regular expression, the numeric variables
17601 &$1$&, &$2$&, etc. may be set. For example:
17602 .code
17603 route_list = ^domain(\d+)   host-$1.text.example
17604 .endd
17605 .next
17606 &$0$& is always set to the entire domain.
17607 .next
17608 &$1$& is also set when partial matching is done in a file lookup.
17609
17610 .next
17611 .vindex "&$value$&"
17612 If the pattern that matched the domain was a lookup item, the data that was
17613 looked up is available in the expansion variable &$value$&. For example:
17614 .code
17615 route_list = lsearch;;/some/file.routes  $value
17616 .endd
17617 .endlist
17618
17619 Note the doubling of the semicolon in the pattern that is necessary because
17620 semicolon is the default route list separator.
17621
17622
17623
17624 .section "Format of one host item" "SECTformatonehostitem"
17625 Each item in the list of hosts is either a host name or an IP address,
17626 optionally with an attached port number. When no port is given, an IP address
17627 is not enclosed in brackets. When a port is specified, it overrides the port
17628 specification on the transport. The port is separated from the name or address
17629 by a colon. This leads to some complications:
17630
17631 .ilist
17632 Because colon is the default separator for the list of hosts, either
17633 the colon that specifies a port must be doubled, or the list separator must
17634 be changed. The following two examples have the same effect:
17635 .code
17636 route_list = * "host1.tld::1225 : host2.tld::1226"
17637 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17638 .endd
17639 .next
17640 When IPv6 addresses are involved, it gets worse, because they contain
17641 colons of their own. To make this case easier, it is permitted to
17642 enclose an IP address (either v4 or v6) in square brackets if a port
17643 number follows. For example:
17644 .code
17645 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17646 .endd
17647 .endlist
17648
17649 .section "How the list of hosts is used" "SECThostshowused"
17650 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17651 the hosts is tried, in the order specified, when carrying out the SMTP
17652 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17653 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17654 transport.
17655
17656 Hosts may be listed by name or by IP address. An unadorned name in the list of
17657 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17658 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17659 records in the DNS. For example:
17660 .code
17661 route_list = *  x.y.z:p.q.r/MX:e.f.g
17662 .endd
17663 If this feature is used with a port specifier, the port must come last. For
17664 example:
17665 .code
17666 route_list = *  dom1.tld/mx::1225
17667 .endd
17668 If the &%hosts_randomize%& option is set, the order of the items in the list is
17669 randomized before any lookups are done. Exim then scans the list; for any name
17670 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17671 be an interface on the local host and the item is not the first in the list,
17672 Exim discards it and any subsequent items. If it is the first item, what
17673 happens is controlled by the
17674 .oindex "&%self%&" "in &(manualroute)& router"
17675 &%self%& option of the router.
17676
17677 A name on the list that is followed by &`/MX`& is replaced with the list of
17678 hosts obtained by looking up MX records for the name. This is always a DNS
17679 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17680 below) are not relevant here. The order of these hosts is determined by the
17681 preference values in the MX records, according to the usual rules. Because
17682 randomizing happens before the MX lookup, it does not affect the order that is
17683 defined by MX preferences.
17684
17685 If the local host is present in the sublist obtained from MX records, but is
17686 not the most preferred host in that list, it and any equally or less
17687 preferred hosts are removed before the sublist is inserted into the main list.
17688
17689 If the local host is the most preferred host in the MX list, what happens
17690 depends on where in the original list of hosts the &`/MX`& item appears. If it
17691 is not the first item (that is, there are previous hosts in the main list),
17692 Exim discards this name and any subsequent items in the main list.
17693
17694 If the MX item is first in the list of hosts, and the local host is the
17695 most preferred host, what happens is controlled by the &%self%& option of the
17696 router.
17697
17698 DNS failures when lookup up the MX records are treated in the same way as DNS
17699 failures when looking up IP addresses: &%pass_on_timeout%& and
17700 &%host_find_failed%& are used when relevant.
17701
17702 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17703 whether obtained from an MX lookup or not.
17704
17705
17706
17707 .section "How the options are used" "SECThowoptused"
17708 The options are a sequence of words; in practice no more than three are ever
17709 present. One of the words can be the name of a transport; this overrides the
17710 &%transport%& option on the router for this particular routing rule only. The
17711 other words (if present) control randomization of the list of hosts on a
17712 per-rule basis, and how the IP addresses of the hosts are to be found when
17713 routing to a remote transport. These options are as follows:
17714
17715 .ilist
17716 &%randomize%&: randomize the order of the hosts in this list, overriding the
17717 setting of &%hosts_randomize%& for this routing rule only.
17718 .next
17719 &%no_randomize%&: do not randomize the order of the hosts in this list,
17720 overriding the setting of &%hosts_randomize%& for this routing rule only.
17721 .next
17722 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17723 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17724 also look in &_/etc/hosts_& or other sources of information.
17725 .next
17726 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17727 no address records are found. If there is a temporary DNS error (such as a
17728 timeout), delivery is deferred.
17729 .endlist
17730
17731 For example:
17732 .code
17733 route_list = domain1  host1:host2:host3  randomize bydns;\
17734              domain2  host4:host5
17735 .endd
17736 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17737 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17738 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17739 or &[gethostbyname()]&, and the result of the lookup is the result of that
17740 call.
17741
17742 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17743 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17744 instead of TRY_AGAIN. That is why the default action is to try a DNS
17745 lookup first. Only if that gives a definite &"no such host"& is the local
17746 function called.
17747
17748
17749
17750 If no IP address for a host can be found, what happens is controlled by the
17751 &%host_find_failed%& option.
17752
17753 .vindex "&$host$&"
17754 When an address is routed to a local transport, IP addresses are not looked up.
17755 The host list is passed to the transport in the &$host$& variable.
17756
17757
17758
17759 .section "Manualroute examples" "SECID123"
17760 In some of the examples that follow, the presence of the &%remote_smtp%&
17761 transport, as defined in the default configuration file, is assumed:
17762
17763 .ilist
17764 .cindex "smart host" "example router"
17765 The &(manualroute)& router can be used to forward all external mail to a
17766 &'smart host'&. If you have set up, in the main part of the configuration, a
17767 named domain list that contains your local domains, for example:
17768 .code
17769 domainlist local_domains = my.domain.example
17770 .endd
17771 You can arrange for all other domains to be routed to a smart host by making
17772 your first router something like this:
17773 .code
17774 smart_route:
17775   driver = manualroute
17776   domains = !+local_domains
17777   transport = remote_smtp
17778   route_list = * smarthost.ref.example
17779 .endd
17780 This causes all non-local addresses to be sent to the single host
17781 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17782 they are tried in order
17783 (but you can use &%hosts_randomize%& to vary the order each time).
17784 Another way of configuring the same thing is this:
17785 .code
17786 smart_route:
17787   driver = manualroute
17788   transport = remote_smtp
17789   route_list = !+local_domains  smarthost.ref.example
17790 .endd
17791 There is no difference in behaviour between these two routers as they stand.
17792 However, they behave differently if &%no_more%& is added to them. In the first
17793 example, the router is skipped if the domain does not match the &%domains%&
17794 precondition; the following router is always tried. If the router runs, it
17795 always matches the domain and so can never decline. Therefore, &%no_more%&
17796 would have no effect. In the second case, the router is never skipped; it
17797 always runs. However, if it doesn't match the domain, it declines. In this case
17798 &%no_more%& would prevent subsequent routers from running.
17799
17800 .next
17801 .cindex "mail hub example"
17802 A &'mail hub'& is a host which receives mail for a number of domains via MX
17803 records in the DNS and delivers it via its own private routing mechanism. Often
17804 the final destinations are behind a firewall, with the mail hub being the one
17805 machine that can connect to machines both inside and outside the firewall. The
17806 &(manualroute)& router is usually used on a mail hub to route incoming messages
17807 to the correct hosts. For a small number of domains, the routing can be inline,
17808 using the &%route_list%& option, but for a larger number a file or database
17809 lookup is easier to manage.
17810
17811 If the domain names are in fact the names of the machines to which the mail is
17812 to be sent by the mail hub, the configuration can be quite simple. For
17813 example:
17814 .code
17815 hub_route:
17816   driver = manualroute
17817   transport = remote_smtp
17818   route_list = *.rhodes.tvs.example  $domain
17819 .endd
17820 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17821 whose names are the same as the mail domains. A similar approach can be taken
17822 if the host name can be obtained from the domain name by a string manipulation
17823 that the expansion facilities can handle. Otherwise, a lookup based on the
17824 domain can be used to find the host:
17825 .code
17826 through_firewall:
17827   driver = manualroute
17828   transport = remote_smtp
17829   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17830 .endd
17831 The result of the lookup must be the name or IP address of the host (or
17832 hosts) to which the address is to be routed. If the lookup fails, the route
17833 data is empty, causing the router to decline. The address then passes to the
17834 next router.
17835
17836 .next
17837 .cindex "batched SMTP output example"
17838 .cindex "SMTP" "batched outgoing; example"
17839 You can use &(manualroute)& to deliver messages to pipes or files in batched
17840 SMTP format for onward transportation by some other means. This is one way of
17841 storing mail for a dial-up host when it is not connected. The route list entry
17842 can be as simple as a single domain name in a configuration like this:
17843 .code
17844 save_in_file:
17845   driver = manualroute
17846   transport = batchsmtp_appendfile
17847   route_list = saved.domain.example
17848 .endd
17849 though often a pattern is used to pick up more than one domain. If there are
17850 several domains or groups of domains with different transport requirements,
17851 different transports can be listed in the routing information:
17852 .code
17853 save_in_file:
17854   driver = manualroute
17855   route_list = \
17856     *.saved.domain1.example  $domain  batch_appendfile; \
17857     *.saved.domain2.example  \
17858       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17859       batch_pipe
17860 .endd
17861 .vindex "&$domain$&"
17862 .vindex "&$host$&"
17863 The first of these just passes the domain in the &$host$& variable, which
17864 doesn't achieve much (since it is also in &$domain$&), but the second does a
17865 file lookup to find a value to pass, causing the router to decline to handle
17866 the address if the lookup fails.
17867
17868 .next
17869 .cindex "UUCP" "example of router for"
17870 Routing mail directly to UUCP software is a specific case of the use of
17871 &(manualroute)& in a gateway to another mail environment. This is an example of
17872 one way it can be done:
17873 .code
17874 # Transport
17875 uucp:
17876   driver = pipe
17877   user = nobody
17878   command = /usr/local/bin/uux -r - \
17879     ${substr_-5:$host}!rmail ${local_part}
17880   return_fail_output = true
17881
17882 # Router
17883 uucphost:
17884   transport = uucp
17885   driver = manualroute
17886   route_data = \
17887     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17888 .endd
17889 The file &_/usr/local/exim/uucphosts_& contains entries like
17890 .code
17891 darksite.ethereal.example:           darksite.UUCP
17892 .endd
17893 It can be set up more simply without adding and removing &".UUCP"& but this way
17894 makes clear the distinction between the domain name
17895 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17896 .endlist
17897 .ecindex IIDmanrou1
17898 .ecindex IIDmanrou2
17899
17900
17901
17902
17903
17904
17905
17906
17907 . ////////////////////////////////////////////////////////////////////////////
17908 . ////////////////////////////////////////////////////////////////////////////
17909
17910 .chapter "The queryprogram router" "CHAPdriverlast"
17911 .scindex IIDquerou1 "&(queryprogram)& router"
17912 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17913 .cindex "routing" "by external program"
17914 The &(queryprogram)& router routes an address by running an external command
17915 and acting on its output. This is an expensive way to route, and is intended
17916 mainly for use in lightly-loaded systems, or for performing experiments.
17917 However, if it is possible to use the precondition options (&%domains%&,
17918 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17919 be used in special cases, even on a busy host. There are the following private
17920 options:
17921 .cindex "options" "&(queryprogram)& router"
17922
17923 .option command queryprogram string&!! unset
17924 This option must be set. It specifies the command that is to be run. The
17925 command is split up into a command name and arguments, and then each is
17926 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17927 &<<CHAPpipetransport>>&).
17928
17929
17930 .option command_group queryprogram string unset
17931 .cindex "gid (group id)" "in &(queryprogram)& router"
17932 This option specifies a gid to be set when running the command while routing an
17933 address for deliver. It must be set if &%command_user%& specifies a numerical
17934 uid. If it begins with a digit, it is interpreted as the numerical value of the
17935 gid. Otherwise it is looked up using &[getgrnam()]&.
17936
17937
17938 .option command_user queryprogram string unset
17939 .cindex "uid (user id)" "for &(queryprogram)&"
17940 This option must be set. It specifies the uid which is set when running the
17941 command while routing an address for delivery. If the value begins with a digit,
17942 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17943 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17944 not set, a value for the gid also.
17945
17946 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17947 root, which it does during a normal delivery in a conventional configuration.
17948 However, when an address is being verified during message reception, Exim is
17949 usually running as the Exim user, not as root. If the &(queryprogram)& router
17950 is called from a non-root process, Exim cannot change uid or gid before running
17951 the command. In this circumstance the command runs under the current uid and
17952 gid.
17953
17954
17955 .option current_directory queryprogram string /
17956 This option specifies an absolute path which is made the current directory
17957 before running the command.
17958
17959
17960 .option timeout queryprogram time 1h
17961 If the command does not complete within the timeout period, its process group
17962 is killed and the message is frozen. A value of zero time specifies no
17963 timeout.
17964
17965
17966 The standard output of the command is connected to a pipe, which is read when
17967 the command terminates. It should consist of a single line of output,
17968 containing up to five fields, separated by white space. The maximum length of
17969 the line is 1023 characters. Longer lines are silently truncated. The first
17970 field is one of the following words (case-insensitive):
17971
17972 .ilist
17973 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
17974 below).
17975 .next
17976 &'Decline'&: the router declines; pass the address to the next router, unless
17977 &%no_more%& is set.
17978 .next
17979 &'Fail'&: routing failed; do not pass the address to any more routers. Any
17980 subsequent text on the line is an error message. If the router is run as part
17981 of address verification during an incoming SMTP message, the message is
17982 included in the SMTP response.
17983 .next
17984 &'Defer'&: routing could not be completed at this time; try again later. Any
17985 subsequent text on the line is an error message which is logged. It is not
17986 included in any SMTP response.
17987 .next
17988 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
17989 .next
17990 &'Pass'&: pass the address to the next router (or the router specified by
17991 &%pass_router%&), overriding &%no_more%&.
17992 .next
17993 &'Redirect'&: the message is redirected. The remainder of the line is a list of
17994 new addresses, which are routed independently, starting with the first router,
17995 or the router specified by &%redirect_router%&, if set.
17996 .endlist
17997
17998 When the first word is &'accept'&, the remainder of the line consists of a
17999 number of keyed data values, as follows (split into two lines here, to fit on
18000 the page):
18001 .code
18002 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18003 LOOKUP=byname|bydns DATA=<text>
18004 .endd
18005 The data items can be given in any order, and all are optional. If no transport
18006 is included, the transport specified by the generic &%transport%& option is
18007 used. The list of hosts and the lookup type are needed only if the transport is
18008 an &(smtp)& transport that does not itself supply a list of hosts.
18009
18010 The format of the list of hosts is the same as for the &(manualroute)& router.
18011 As well as host names and IP addresses with optional port numbers, as described
18012 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18013 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18014 (see section &<<SECThostshowused>>&).
18015
18016 If the lookup type is not specified, Exim behaves as follows when trying to
18017 find an IP address for each host: First, a DNS lookup is done. If this yields
18018 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18019 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18020 result of the lookup is the result of that call.
18021
18022 .vindex "&$address_data$&"
18023 If the DATA field is set, its value is placed in the &$address_data$&
18024 variable. For example, this return line
18025 .code
18026 accept hosts=x1.y.example:x2.y.example data="rule1"
18027 .endd
18028 routes the address to the default transport, passing a list of two hosts. When
18029 the transport runs, the string &"rule1"& is in &$address_data$&.
18030 .ecindex IIDquerou1
18031 .ecindex IIDquerou2
18032
18033
18034
18035
18036 . ////////////////////////////////////////////////////////////////////////////
18037 . ////////////////////////////////////////////////////////////////////////////
18038
18039 .chapter "The redirect router" "CHAPredirect"
18040 .scindex IIDredrou1 "&(redirect)& router"
18041 .scindex IIDredrou2 "routers" "&(redirect)&"
18042 .cindex "alias file" "in a &(redirect)& router"
18043 .cindex "address redirection" "&(redirect)& router"
18044 The &(redirect)& router handles several kinds of address redirection. Its most
18045 common uses are for resolving local part aliases from a central alias file
18046 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18047 files, but it has many other potential uses. The incoming address can be
18048 redirected in several different ways:
18049
18050 .ilist
18051 It can be replaced by one or more new addresses which are themselves routed
18052 independently.
18053 .next
18054 It can be routed to be delivered to a given file or directory.
18055 .next
18056 It can be routed to be delivered to a specified pipe command.
18057 .next
18058 It can cause an automatic reply to be generated.
18059 .next
18060 It can be forced to fail, optionally with a custom error message.
18061 .next
18062 It can be temporarily deferred, optionally with a custom message.
18063 .next
18064 It can be discarded.
18065 .endlist
18066
18067 The generic &%transport%& option must not be set for &(redirect)& routers.
18068 However, there are some private options which define transports for delivery to
18069 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18070 &%pipe_transport%& and &%reply_transport%& descriptions below.
18071
18072
18073
18074 .section "Redirection data" "SECID124"
18075 The router operates by interpreting a text string which it obtains either by
18076 expanding the contents of the &%data%& option, or by reading the entire
18077 contents of a file whose name is given in the &%file%& option. These two
18078 options are mutually exclusive. The first is commonly used for handling system
18079 aliases, in a configuration like this:
18080 .code
18081 system_aliases:
18082   driver = redirect
18083   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18084 .endd
18085 If the lookup fails, the expanded string in this example is empty. When the
18086 expansion of &%data%& results in an empty string, the router declines. A forced
18087 expansion failure also causes the router to decline; other expansion failures
18088 cause delivery to be deferred.
18089
18090 A configuration using &%file%& is commonly used for handling users'
18091 &_.forward_& files, like this:
18092 .code
18093 userforward:
18094   driver = redirect
18095   check_local_user
18096   file = $home/.forward
18097   no_verify
18098 .endd
18099 If the file does not exist, or causes no action to be taken (for example, it is
18100 empty or consists only of comments), the router declines. &*Warning*&: This
18101 is not the case when the file contains syntactically valid items that happen to
18102 yield empty addresses, for example, items containing only RFC 2822 address
18103 comments.
18104
18105
18106
18107 .section "Forward files and address verification" "SECID125"
18108 .cindex "address redirection" "while verifying"
18109 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18110 &_.forward_& files, as in the example above. There are two reasons for this:
18111
18112 .ilist
18113 When Exim is receiving an incoming SMTP message from a remote host, it is
18114 running under the Exim uid, not as root. Exim is unable to change uid to read
18115 the file as the user, and it may not be able to read it as the Exim user. So in
18116 practice the router may not be able to operate.
18117 .next
18118 However, even when the router can operate, the existence of a &_.forward_& file
18119 is unimportant when verifying an address. What should be checked is whether the
18120 local part is a valid user name or not. Cutting out the redirection processing
18121 saves some resources.
18122 .endlist
18123
18124
18125
18126
18127
18128
18129 .section "Interpreting redirection data" "SECID126"
18130 .cindex "Sieve filter" "specifying in redirection data"
18131 .cindex "filter" "specifying in redirection data"
18132 The contents of the data string, whether obtained from &%data%& or &%file%&,
18133 can be interpreted in two different ways:
18134
18135 .ilist
18136 If the &%allow_filter%& option is set true, and the data begins with the text
18137 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18138 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18139 respectively. Details of the syntax and semantics of filter files are described
18140 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18141 document is intended for use by end users.
18142 .next
18143 Otherwise, the data must be a comma-separated list of redirection items, as
18144 described in the next section.
18145 .endlist
18146
18147 When a message is redirected to a file (a &"mail folder"&), the file name given
18148 in a non-filter redirection list must always be an absolute path. A filter may
18149 generate a relative path &-- how this is handled depends on the transport's
18150 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18151 for the &(appendfile)& transport.
18152
18153
18154
18155 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18156 .cindex "address redirection" "non-filter list items"
18157 When the redirection data is not an Exim or Sieve filter, for example, if it
18158 comes from a conventional alias or forward file, it consists of a list of
18159 addresses, file names, pipe commands, or certain special items (see section
18160 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18161 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18162 depending on their default values. The items in the list are separated by
18163 commas or newlines.
18164 If a comma is required in an item, the entire item must be enclosed in double
18165 quotes.
18166
18167 Lines starting with a # character are comments, and are ignored, and # may
18168 also appear following a comma, in which case everything between the # and the
18169 next newline character is ignored.
18170
18171 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18172 double quotes are retained because some forms of mail address require their use
18173 (but never to enclose the entire address). In the following description,
18174 &"item"& refers to what remains after any surrounding double quotes have been
18175 removed.
18176
18177 .vindex "&$local_part$&"
18178 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18179 and the expansion contains a reference to &$local_part$&, you should make use
18180 of the &%quote_local_part%& expansion operator, in case the local part contains
18181 special characters. For example, to redirect all mail for the domain
18182 &'obsolete.example'&, retaining the existing local part, you could use this
18183 setting:
18184 .code
18185 data = ${quote_local_part:$local_part}@newdomain.example
18186 .endd
18187
18188
18189 .section "Redirecting to a local mailbox" "SECTredlocmai"
18190 .cindex "routing" "loops in"
18191 .cindex "loop" "while routing, avoidance of"
18192 .cindex "address redirection" "to local mailbox"
18193 A redirection item may safely be the same as the address currently under
18194 consideration. This does not cause a routing loop, because a router is
18195 automatically skipped if any ancestor of the address that is being processed
18196 is the same as the current address and was processed by the current router.
18197 Such an address is therefore passed to the following routers, so it is handled
18198 as if there were no redirection. When making this loop-avoidance test, the
18199 complete local part, including any prefix or suffix, is used.
18200
18201 .cindex "address redirection" "local part without domain"
18202 Specifying the same local part without a domain is a common usage in personal
18203 filter files when the user wants to have messages delivered to the local
18204 mailbox and also forwarded elsewhere. For example, the user whose login is
18205 &'cleo'& might have a &_.forward_& file containing this:
18206 .code
18207 cleo, cleopatra@egypt.example
18208 .endd
18209 .cindex "backslash in alias file"
18210 .cindex "alias file" "backslash in"
18211 For compatibility with other MTAs, such unqualified local parts may be
18212 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18213 it does make a difference if more than one domain is being handled
18214 synonymously.
18215
18216 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18217 2822 address that does not include a domain, the item is qualified using the
18218 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18219 addresses are qualified using the value in &%qualify_recipient%&, but you can
18220 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18221
18222 Care must be taken if there are alias names for local users.
18223 Consider an MTA handling a single local domain where the system alias file
18224 contains:
18225 .code
18226 Sam.Reman: spqr
18227 .endd
18228 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18229 messages in the local mailbox, and also forward copies elsewhere. He creates
18230 this forward file:
18231 .code
18232 Sam.Reman, spqr@reme.elsewhere.example
18233 .endd
18234 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18235 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18236 second time round, because it has previously routed it,
18237 and the following routers presumably cannot handle the alias. The forward file
18238 should really contain
18239 .code
18240 spqr, spqr@reme.elsewhere.example
18241 .endd
18242 but because this is such a common error, the &%check_ancestor%& option (see
18243 below) exists to provide a way to get round it. This is normally set on a
18244 &(redirect)& router that is handling users' &_.forward_& files.
18245
18246
18247
18248 .section "Special items in redirection lists" "SECTspecitredli"
18249 In addition to addresses, the following types of item may appear in redirection
18250 lists (that is, in non-filter redirection data):
18251
18252 .ilist
18253 .cindex "pipe" "in redirection list"
18254 .cindex "address redirection" "to pipe"
18255 An item is treated as a pipe command if it begins with &"|"& and does not parse
18256 as a valid RFC 2822 address that includes a domain. A transport for running the
18257 command must be specified by the &%pipe_transport%& option.
18258 Normally, either the router or the transport specifies a user and a group under
18259 which to run the delivery. The default is to use the Exim user and group.
18260
18261 Single or double quotes can be used for enclosing the individual arguments of
18262 the pipe command; no interpretation of escapes is done for single quotes. If
18263 the command contains a comma character, it is necessary to put the whole item
18264 in double quotes, for example:
18265 .code
18266 "|/some/command ready,steady,go"
18267 .endd
18268 since items in redirection lists are terminated by commas. Do not, however,
18269 quote just the command. An item such as
18270 .code
18271 |"/some/command ready,steady,go"
18272 .endd
18273 is interpreted as a pipe with a rather strange command name, and no arguments.
18274
18275 .next
18276 .cindex "file" "in redirection list"
18277 .cindex "address redirection" "to file"
18278 An item is interpreted as a path name if it begins with &"/"& and does not
18279 parse as a valid RFC 2822 address that includes a domain. For example,
18280 .code
18281 /home/world/minbari
18282 .endd
18283 is treated as a file name, but
18284 .code
18285 /s=molari/o=babylon/@x400gate.way
18286 .endd
18287 is treated as an address. For a file name, a transport must be specified using
18288 the &%file_transport%& option. However, if the generated path name ends with a
18289 forward slash character, it is interpreted as a directory name rather than a
18290 file name, and &%directory_transport%& is used instead.
18291
18292 Normally, either the router or the transport specifies a user and a group under
18293 which to run the delivery. The default is to use the Exim user and group.
18294
18295 .cindex "&_/dev/null_&"
18296 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18297 bypassed at a high level, and the log entry shows &"**bypassed**"&
18298 instead of a transport name. In this case the user and group are not used.
18299
18300 .next
18301 .cindex "included address list"
18302 .cindex "address redirection" "included external list"
18303 If an item is of the form
18304 .code
18305 :include:<path name>
18306 .endd
18307 a list of further items is taken from the given file and included at that
18308 point. &*Note*&: Such a file can not be a filter file; it is just an
18309 out-of-line addition to the list. The items in the included list are separated
18310 by commas or newlines and are not subject to expansion. If this is the first
18311 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18312 the alias name. This example is incorrect:
18313 .code
18314 list1    :include:/opt/lists/list1
18315 .endd
18316 It must be given as
18317 .code
18318 list1:   :include:/opt/lists/list1
18319 .endd
18320 .next
18321 .cindex "address redirection" "to black hole"
18322 Sometimes you want to throw away mail to a particular local part. Making the
18323 &%data%& option expand to an empty string does not work, because that causes
18324 the router to decline. Instead, the alias item
18325 .cindex "black hole"
18326 .cindex "abandoning mail"
18327 &':blackhole:'& can be used. It does what its name implies. No delivery is
18328 done, and no error message is generated. This has the same effect as specifing
18329 &_/dev/null_& as a destination, but it can be independently disabled.
18330
18331 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18332 delivery is done for the original local part, even if other redirection items
18333 are present. If you are generating a multi-item list (for example, by reading a
18334 database) and need the ability to provide a no-op item, you must use
18335 &_/dev/null_&.
18336
18337 .next
18338 .cindex "delivery" "forcing failure"
18339 .cindex "delivery" "forcing deferral"
18340 .cindex "failing delivery" "forcing"
18341 .cindex "deferred delivery, forcing"
18342 .cindex "customizing" "failure message"
18343 An attempt to deliver a particular address can be deferred or forced to fail by
18344 redirection items of the form
18345 .code
18346 :defer:
18347 :fail:
18348 .endd
18349 respectively. When a redirection list contains such an item, it applies
18350 to the entire redirection; any other items in the list are ignored. Any
18351 text following &':fail:'& or &':defer:'& is placed in the error text
18352 associated with the failure. For example, an alias file might contain:
18353 .code
18354 X.Employee:  :fail: Gone away, no forwarding address
18355 .endd
18356 In the case of an address that is being verified from an ACL or as the subject
18357 of a
18358 .cindex "VRFY" "error text, display of"
18359 VRFY command, the text is included in the SMTP error response by
18360 default.
18361 .cindex "EXPN" "error text, display of"
18362 The text is not included in the response to an EXPN command. In non-SMTP cases
18363 the text is included in the error message that Exim generates.
18364
18365 .cindex "SMTP" "error codes"
18366 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18367 &':fail:'&. However, if the message starts with three digits followed by a
18368 space, optionally followed by an extended code of the form &'n.n.n'&, also
18369 followed by a space, and the very first digit is the same as the default error
18370 code, the code from the message is used instead. If the very first digit is
18371 incorrect, a panic error is logged, and the default code is used. You can
18372 suppress the use of the supplied code in a redirect router by setting the
18373 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18374 ignored.
18375
18376 .vindex "&$acl_verify_message$&"
18377 In an ACL, an explicitly provided message overrides the default, but the
18378 default message is available in the variable &$acl_verify_message$& and can
18379 therefore be included in a custom message if this is desired.
18380
18381 Normally the error text is the rest of the redirection list &-- a comma does
18382 not terminate it &-- but a newline does act as a terminator. Newlines are not
18383 normally present in alias expansions. In &(lsearch)& lookups they are removed
18384 as part of the continuation process, but they may exist in other kinds of
18385 lookup and in &':include:'& files.
18386
18387 During routing for message delivery (as opposed to verification), a redirection
18388 containing &':fail:'& causes an immediate failure of the incoming address,
18389 whereas &':defer:'& causes the message to remain on the queue so that a
18390 subsequent delivery attempt can happen at a later time. If an address is
18391 deferred for too long, it will ultimately fail, because the normal retry
18392 rules still apply.
18393
18394 .next
18395 .cindex "alias file" "exception to default"
18396 Sometimes it is useful to use a single-key search type with a default (see
18397 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18398 for exceptions to the default. These can be handled by aliasing them to
18399 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18400 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18401 results in an empty redirection list has the same effect.
18402 .endlist
18403
18404
18405 .section "Duplicate addresses" "SECTdupaddr"
18406 .cindex "duplicate addresses"
18407 .cindex "address duplicate, discarding"
18408 .cindex "pipe" "duplicated"
18409 Exim removes duplicate addresses from the list to which it is delivering, so as
18410 to deliver just one copy to each address. This does not apply to deliveries
18411 routed to pipes by different immediate parent addresses, but an indirect
18412 aliasing scheme of the type
18413 .code
18414 pipe:       |/some/command $local_part
18415 localpart1: pipe
18416 localpart2: pipe
18417 .endd
18418 does not work with a message that is addressed to both local parts, because
18419 when the second is aliased to the intermediate local part &"pipe"& it gets
18420 discarded as being the same as a previously handled address. However, a scheme
18421 such as
18422 .code
18423 localpart1: |/some/command $local_part
18424 localpart2: |/some/command $local_part
18425 .endd
18426 does result in two different pipe deliveries, because the immediate parents of
18427 the pipes are distinct.
18428
18429
18430
18431 .section "Repeated redirection expansion" "SECID128"
18432 .cindex "repeated redirection expansion"
18433 .cindex "address redirection" "repeated for each delivery attempt"
18434 When a message cannot be delivered to all of its recipients immediately,
18435 leading to two or more delivery attempts, redirection expansion is carried out
18436 afresh each time for those addresses whose children were not all previously
18437 delivered. If redirection is being used as a mailing list, this can lead to new
18438 members of the list receiving copies of old messages. The &%one_time%& option
18439 can be used to avoid this.
18440
18441
18442 .section "Errors in redirection lists" "SECID129"
18443 .cindex "address redirection" "errors"
18444 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18445 error is skipped, and an entry is written to the main log. This may be useful
18446 for mailing lists that are automatically managed. Otherwise, if an error is
18447 detected while generating the list of new addresses, the original address is
18448 deferred. See also &%syntax_errors_to%&.
18449
18450
18451
18452 .section "Private options for the redirect router" "SECID130"
18453
18454 .cindex "options" "&(redirect)& router"
18455 The private options for the &(redirect)& router are as follows:
18456
18457
18458 .option allow_defer redirect boolean false
18459 Setting this option allows the use of &':defer:'& in non-filter redirection
18460 data, or the &%defer%& command in an Exim filter file.
18461
18462
18463 .option allow_fail redirect boolean false
18464 .cindex "failing delivery" "from filter"
18465 If this option is true, the &':fail:'& item can be used in a redirection list,
18466 and the &%fail%& command may be used in an Exim filter file.
18467
18468
18469 .option allow_filter redirect boolean false
18470 .cindex "filter" "enabling use of"
18471 .cindex "Sieve filter" "enabling use of"
18472 Setting this option allows Exim to interpret redirection data that starts with
18473 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18474 are some features of Exim filter files that some administrators may wish to
18475 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18476
18477 It is also possible to lock out Exim filters or Sieve filters while allowing
18478 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18479
18480
18481 The filter is run using the uid and gid set by the generic &%user%& and
18482 &%group%& options. These take their defaults from the password data if
18483 &%check_local_user%& is set, so in the normal case of users' personal filter
18484 files, the filter is run as the relevant user. When &%allow_filter%& is set
18485 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18486
18487
18488
18489 .option allow_freeze redirect boolean false
18490 .cindex "freezing messages" "allowing in filter"
18491 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18492 This command is more normally encountered in system filters, and is disabled by
18493 default for redirection filters because it isn't something you usually want to
18494 let ordinary users do.
18495
18496
18497
18498 .option check_ancestor redirect boolean false
18499 This option is concerned with handling generated addresses that are the same
18500 as some address in the list of redirection ancestors of the current address.
18501 Although it is turned off by default in the code, it is set in the default
18502 configuration file for handling users' &_.forward_& files. It is recommended
18503 for this use of the &(redirect)& router.
18504
18505 When &%check_ancestor%& is set, if a generated address (including the domain)
18506 is the same as any ancestor of the current address, it is replaced by a copy of
18507 the current address. This helps in the case where local part A is aliased to B,
18508 and B has a &_.forward_& file pointing back to A. For example, within a single
18509 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18510 &_&~jb/.forward_& contains:
18511 .code
18512 \Joe.Bloggs, <other item(s)>
18513 .endd
18514 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18515 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18516 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18517 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18518 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18519 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18520 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18521 original address. See also the &%repeat_use%& option below.
18522
18523
18524 .option check_group redirect boolean "see below"
18525 When the &%file%& option is used, the group owner of the file is checked only
18526 when this option is set. The permitted groups are those listed in the
18527 &%owngroups%& option, together with the user's default group if
18528 &%check_local_user%& is set. If the file has the wrong group, routing is
18529 deferred. The default setting for this option is true if &%check_local_user%&
18530 is set and the &%modemask%& option permits the group write bit, or if the
18531 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18532
18533
18534
18535 .option check_owner redirect boolean "see below"
18536 When the &%file%& option is used, the owner of the file is checked only when
18537 this option is set. If &%check_local_user%& is set, the local user is
18538 permitted; otherwise the owner must be one of those listed in the &%owners%&
18539 option. The default value for this option is true if &%check_local_user%& or
18540 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18541
18542
18543 .option data redirect string&!! unset
18544 This option is mutually exclusive with &%file%&. One or other of them must be
18545 set, but not both. The contents of &%data%& are expanded, and then used as the
18546 list of forwarding items, or as a set of filtering instructions. If the
18547 expansion is forced to fail, or the result is an empty string or a string that
18548 has no effect (consists entirely of comments), the router declines.
18549
18550 When filtering instructions are used, the string must begin with &"#Exim
18551 filter"&, and all comments in the string, including this initial one, must be
18552 terminated with newline characters. For example:
18553 .code
18554 data = #Exim filter\n\
18555        if $h_to: contains Exim then save $home/mail/exim endif
18556 .endd
18557 If you are reading the data from a database where newlines cannot be included,
18558 you can use the &${sg}$& expansion item to turn the escape string of your
18559 choice into a newline.
18560
18561
18562 .option directory_transport redirect string&!! unset
18563 A &(redirect)& router sets up a direct delivery to a directory when a path name
18564 ending with a slash is specified as a new &"address"&. The transport used is
18565 specified by this option, which, after expansion, must be the name of a
18566 configured transport. This should normally be an &(appendfile)& transport.
18567
18568
18569 .option file redirect string&!! unset
18570 This option specifies the name of a file that contains the redirection data. It
18571 is mutually exclusive with the &%data%& option. The string is expanded before
18572 use; if the expansion is forced to fail, the router declines. Other expansion
18573 failures cause delivery to be deferred. The result of a successful expansion
18574 must be an absolute path. The entire file is read and used as the redirection
18575 data. If the data is an empty string or a string that has no effect (consists
18576 entirely of comments), the router declines.
18577
18578 .cindex "NFS" "checking for file existence"
18579 If the attempt to open the file fails with a &"does not exist"& error, Exim
18580 runs a check on the containing directory,
18581 unless &%ignore_enotdir%& is true (see below).
18582 If the directory does not appear to exist, delivery is deferred. This can
18583 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18584 is a mount problem. If the containing directory does exist, but the file does
18585 not, the router declines.
18586
18587
18588 .option file_transport redirect string&!! unset
18589 .vindex "&$address_file$&"
18590 A &(redirect)& router sets up a direct delivery to a file when a path name not
18591 ending in a slash is specified as a new &"address"&. The transport used is
18592 specified by this option, which, after expansion, must be the name of a
18593 configured transport. This should normally be an &(appendfile)& transport. When
18594 it is running, the file name is in &$address_file$&.
18595
18596
18597 .option filter_prepend_home redirect boolean true
18598 When this option is true, if a &(save)& command in an Exim filter specifies a
18599 relative path, and &$home$& is defined, it is automatically prepended to the
18600 relative path. If this option is set false, this action does not happen. The
18601 relative path is then passed to the transport unmodified.
18602
18603
18604 .option forbid_blackhole redirect boolean false
18605 If this option is true, the &':blackhole:'& item may not appear in a
18606 redirection list.
18607
18608
18609 .option forbid_exim_filter redirect boolean false
18610 If this option is set true, only Sieve filters are permitted when
18611 &%allow_filter%& is true.
18612
18613
18614
18615
18616 .option forbid_file redirect boolean false
18617 .cindex "delivery" "to file; forbidding"
18618 .cindex "Sieve filter" "forbidding delivery to a file"
18619 .cindex "Sieve filter" "&""keep""& facility; disabling"
18620 If this option is true, this router may not generate a new address that
18621 specifies delivery to a local file or directory, either from a filter or from a
18622 conventional forward file. This option is forced to be true if &%one_time%& is
18623 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18624 locks out the Sieve's &"keep"& facility.
18625
18626
18627 .option forbid_filter_dlfunc redirect boolean false
18628 .cindex "filter" "locking out certain features"
18629 If this option is true, string expansions in Exim filters are not allowed to
18630 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18631 functions.
18632
18633 .option forbid_filter_existstest redirect boolean false
18634 .cindex "expansion" "statting a file"
18635 If this option is true, string expansions in Exim filters are not allowed to
18636 make use of the &%exists%& condition or the &%stat%& expansion item.
18637
18638 .option forbid_filter_logwrite redirect boolean false
18639 If this option is true, use of the logging facility in Exim filters is not
18640 permitted. Logging is in any case available only if the filter is being run
18641 under some unprivileged uid (which is normally the case for ordinary users'
18642 &_.forward_& files).
18643
18644
18645 .option forbid_filter_lookup redirect boolean false
18646 If this option is true, string expansions in Exim filter files are not allowed
18647 to make use of &%lookup%& items.
18648
18649
18650 .option forbid_filter_perl redirect boolean false
18651 This option has an effect only if Exim is built with embedded Perl support. If
18652 it is true, string expansions in Exim filter files are not allowed to make use
18653 of the embedded Perl support.
18654
18655
18656 .option forbid_filter_readfile redirect boolean false
18657 If this option is true, string expansions in Exim filter files are not allowed
18658 to make use of &%readfile%& items.
18659
18660
18661 .option forbid_filter_readsocket redirect boolean false
18662 If this option is true, string expansions in Exim filter files are not allowed
18663 to make use of &%readsocket%& items.
18664
18665
18666 .option forbid_filter_reply redirect boolean false
18667 If this option is true, this router may not generate an automatic reply
18668 message. Automatic replies can be generated only from Exim or Sieve filter
18669 files, not from traditional forward files. This option is forced to be true if
18670 &%one_time%& is set.
18671
18672
18673 .option forbid_filter_run redirect boolean false
18674 If this option is true, string expansions in Exim filter files are not allowed
18675 to make use of &%run%& items.
18676
18677
18678 .option forbid_include redirect boolean false
18679 If this option is true, items of the form
18680 .code
18681 :include:<path name>
18682 .endd
18683 are not permitted in non-filter redirection lists.
18684
18685
18686 .option forbid_pipe redirect boolean false
18687 .cindex "delivery" "to pipe; forbidding"
18688 If this option is true, this router may not generate a new address which
18689 specifies delivery to a pipe, either from an Exim filter or from a conventional
18690 forward file. This option is forced to be true if &%one_time%& is set.
18691
18692
18693 .option forbid_sieve_filter redirect boolean false
18694 If this option is set true, only Exim filters are permitted when
18695 &%allow_filter%& is true.
18696
18697
18698 .cindex "SMTP" "error codes"
18699 .option forbid_smtp_code redirect boolean false
18700 If this option is set true, any SMTP error codes that are present at the start
18701 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18702 the default codes (451 and 550, respectively) are always used.
18703
18704
18705
18706
18707 .option hide_child_in_errmsg redirect boolean false
18708 .cindex "bounce message" "redirection details; suppressing"
18709 If this option is true, it prevents Exim from quoting a child address if it
18710 generates a bounce or delay message for it. Instead it says &"an address
18711 generated from <&'the top level address'&>"&. Of course, this applies only to
18712 bounces generated locally. If a message is forwarded to another host, &'its'&
18713 bounce may well quote the generated address.
18714
18715
18716 .option ignore_eacces redirect boolean false
18717 .cindex "EACCES"
18718 If this option is set and an attempt to open a redirection file yields the
18719 EACCES error (permission denied), the &(redirect)& router behaves as if the
18720 file did not exist.
18721
18722
18723 .option ignore_enotdir redirect boolean false
18724 .cindex "ENOTDIR"
18725 If this option is set and an attempt to open a redirection file yields the
18726 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18727 router behaves as if the file did not exist.
18728
18729 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18730 router that has the &%file%& option set discovers that the file does not exist
18731 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18732 against unmounted NFS directories. If the parent can not be statted, delivery
18733 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18734 is set, because that option tells Exim to ignore &"something on the path is not
18735 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18736 that some operating systems give ENOENT where others give ENOTDIR.
18737
18738
18739
18740 .option include_directory redirect string unset
18741 If this option is set, the path names of any &':include:'& items in a
18742 redirection list must start with this directory.
18743
18744
18745 .option modemask redirect "octal integer" 022
18746 This specifies mode bits which must not be set for a file specified by the
18747 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18748
18749
18750 .option one_time redirect boolean false
18751 .cindex "one-time aliasing/forwarding expansion"
18752 .cindex "alias file" "one-time expansion"
18753 .cindex "forward file" "one-time expansion"
18754 .cindex "mailing lists" "one-time expansion"
18755 .cindex "address redirection" "one-time expansion"
18756 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18757 files each time it tries to deliver a message causes a problem when one or more
18758 of the generated addresses fails be delivered at the first attempt. The problem
18759 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18760 but of what happens when the redirection list changes during the time that the
18761 message is on Exim's queue. This is particularly true in the case of mailing
18762 lists, where new subscribers might receive copies of messages that were posted
18763 before they subscribed.
18764
18765 If &%one_time%& is set and any addresses generated by the router fail to
18766 deliver at the first attempt, the failing addresses are added to the message as
18767 &"top level"& addresses, and the parent address that generated them is marked
18768 &"delivered"&. Thus, redirection does not happen again at the next delivery
18769 attempt.
18770
18771 &*Warning 1*&: Any header line addition or removal that is specified by this
18772 router would be lost if delivery did not succeed at the first attempt. For this
18773 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18774 permitted when &%one_time%& is set.
18775
18776 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18777 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18778 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18779
18780 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18781 &%one_time%&.
18782
18783 The original top-level address is remembered with each of the generated
18784 addresses, and is output in any log messages. However, any intermediate parent
18785 addresses are not recorded. This makes a difference to the log only if
18786 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18787 typically be used for mailing lists, where there is normally just one level of
18788 expansion.
18789
18790
18791 .option owners redirect "string list" unset
18792 .cindex "ownership" "alias file"
18793 .cindex "ownership" "forward file"
18794 .cindex "alias file" "ownership"
18795 .cindex "forward file" "ownership"
18796 This specifies a list of permitted owners for the file specified by &%file%&.
18797 This list is in addition to the local user when &%check_local_user%& is set.
18798 See &%check_owner%& above.
18799
18800
18801 .option owngroups redirect "string list" unset
18802 This specifies a list of permitted groups for the file specified by &%file%&.
18803 The list is in addition to the local user's primary group when
18804 &%check_local_user%& is set. See &%check_group%& above.
18805
18806
18807 .option pipe_transport redirect string&!! unset
18808 .vindex "&$address_pipe$&"
18809 A &(redirect)& router sets up a direct delivery to a pipe when a string
18810 starting with a vertical bar character is specified as a new &"address"&. The
18811 transport used is specified by this option, which, after expansion, must be the
18812 name of a configured transport. This should normally be a &(pipe)& transport.
18813 When the transport is run, the pipe command is in &$address_pipe$&.
18814
18815
18816 .option qualify_domain redirect string&!! unset
18817 .vindex "&$qualify_recipient$&"
18818 If this option is set, and an unqualified address (one without a domain) is
18819 generated, and that address would normally be qualified by the global setting
18820 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18821 expanding this string. If the expansion fails, the router declines. If you want
18822 to revert to the default, you can have the expansion generate
18823 &$qualify_recipient$&.
18824
18825 This option applies to all unqualified addresses generated by Exim filters,
18826 but for traditional &_.forward_& files, it applies only to addresses that are
18827 not preceded by a backslash. Sieve filters cannot generate unqualified
18828 addresses.
18829
18830 .option qualify_preserve_domain redirect boolean false
18831 .cindex "domain" "in redirection; preserving"
18832 .cindex "preserving domain in redirection"
18833 .cindex "address redirection" "domain; preserving"
18834 If this option is set, the router's local &%qualify_domain%& option must not be
18835 set (a configuration error occurs if it is). If an unqualified address (one
18836 without a domain) is generated, it is qualified with the domain of the parent
18837 address (the immediately preceding ancestor) instead of the global
18838 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18839 this applies whether or not the address is preceded by a backslash.
18840
18841
18842 .option repeat_use redirect boolean true
18843 If this option is set false, the router is skipped for a child address that has
18844 any ancestor that was routed by this router. This test happens before any of
18845 the other preconditions are tested. Exim's default anti-looping rules skip
18846 only when the ancestor is the same as the current address. See also
18847 &%check_ancestor%& above and the generic &%redirect_router%& option.
18848
18849
18850 .option reply_transport redirect string&!! unset
18851 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18852 &%vacation%& command is used in a filter file. The transport used is specified
18853 by this option, which, after expansion, must be the name of a configured
18854 transport. This should normally be an &(autoreply)& transport. Other transports
18855 are unlikely to do anything sensible or useful.
18856
18857
18858 .option rewrite redirect boolean true
18859 .cindex "address redirection" "disabling rewriting"
18860 If this option is set false, addresses generated by the router are not
18861 subject to address rewriting. Otherwise, they are treated like new addresses
18862 and are rewritten according to the global rewriting rules.
18863
18864
18865 .option sieve_subaddress redirect string&!! unset
18866 The value of this option is passed to a Sieve filter to specify the
18867 :subaddress part of an address.
18868
18869 .option sieve_useraddress redirect string&!! unset
18870 The value of this option is passed to a Sieve filter to specify the :user part
18871 of an address. However, if it is unset, the entire original local part
18872 (including any prefix or suffix) is used for :user.
18873
18874
18875 .option sieve_vacation_directory redirect string&!! unset
18876 .cindex "Sieve filter" "vacation directory"
18877 To enable the &"vacation"& extension for Sieve filters, you must set
18878 &%sieve_vacation_directory%& to the directory where vacation databases are held
18879 (do not put anything else in that directory), and ensure that the
18880 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18881 needs their own directory; Exim will create it if necessary.
18882
18883
18884
18885 .option skip_syntax_errors redirect boolean false
18886 .cindex "forward file" "broken"
18887 .cindex "address redirection" "broken files"
18888 .cindex "alias file" "broken"
18889 .cindex "broken alias or forward files"
18890 .cindex "ignoring faulty addresses"
18891 .cindex "skipping faulty addresses"
18892 .cindex "error" "skipping bad syntax"
18893 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18894 non-filter redirection data are skipped, and each failing address is logged. If
18895 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18896 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18897 are expanded and placed at the head of the error message generated by
18898 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18899 be the same address as the generic &%errors_to%& option. The
18900 &%skip_syntax_errors%& option is often used when handling mailing lists.
18901
18902 If all the addresses in a redirection list are skipped because of syntax
18903 errors, the router declines to handle the original address, and it is passed to
18904 the following routers.
18905
18906 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18907 error in the filter causes filtering to be abandoned without any action being
18908 taken. The incident is logged, and the router declines to handle the address,
18909 so it is passed to the following routers.
18910
18911 .cindex "Sieve filter" "syntax errors in"
18912 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18913 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18914 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18915
18916 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18917 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18918 option, used with an address that does not get redirected, can be used to
18919 notify users of these errors, by means of a router like this:
18920 .code
18921 userforward:
18922   driver = redirect
18923   allow_filter
18924   check_local_user
18925   file = $home/.forward
18926   file_transport = address_file
18927   pipe_transport = address_pipe
18928   reply_transport = address_reply
18929   no_verify
18930   skip_syntax_errors
18931   syntax_errors_to = real-$local_part@$domain
18932   syntax_errors_text = \
18933    This is an automatically generated message. An error has\n\
18934    been found in your .forward file. Details of the error are\n\
18935    reported below. While this error persists, you will receive\n\
18936    a copy of this message for every message that is addressed\n\
18937    to you. If your .forward file is a filter file, or if it is\n\
18938    a non-filter file containing no valid forwarding addresses,\n\
18939    a copy of each incoming message will be put in your normal\n\
18940    mailbox. If a non-filter file contains at least one valid\n\
18941    forwarding address, forwarding to the valid addresses will\n\
18942    happen, and those will be the only deliveries that occur.
18943 .endd
18944 You also need a router to ensure that local addresses that are prefixed by
18945 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18946 put this immediately before the &(userforward)& router:
18947 .code
18948 real_localuser:
18949   driver = accept
18950   check_local_user
18951   local_part_prefix = real-
18952   transport = local_delivery
18953 .endd
18954 For security, it would probably be a good idea to restrict the use of this
18955 router to locally-generated messages, using a condition such as this:
18956 .code
18957   condition = ${if match {$sender_host_address}\
18958                          {\N^(|127\.0\.0\.1)$\N}}
18959 .endd
18960
18961
18962 .option syntax_errors_text redirect string&!! unset
18963 See &%skip_syntax_errors%& above.
18964
18965
18966 .option syntax_errors_to redirect string unset
18967 See &%skip_syntax_errors%& above.
18968 .ecindex IIDredrou1
18969 .ecindex IIDredrou2
18970
18971
18972
18973
18974
18975
18976 . ////////////////////////////////////////////////////////////////////////////
18977 . ////////////////////////////////////////////////////////////////////////////
18978
18979 .chapter "Environment for running local transports" "CHAPenvironment" &&&
18980          "Environment for local transports"
18981 .scindex IIDenvlotra1 "local transports" "environment for"
18982 .scindex IIDenvlotra2 "environment for local transports"
18983 .scindex IIDenvlotra3 "transport" "local; environment for"
18984 Local transports handle deliveries to files and pipes. (The &(autoreply)&
18985 transport can be thought of as similar to a pipe.) Exim always runs transports
18986 in subprocesses, under specified uids and gids. Typical deliveries to local
18987 mailboxes run under the uid and gid of the local user.
18988
18989 Exim also sets a specific current directory while running the transport; for
18990 some transports a home directory setting is also relevant. The &(pipe)&
18991 transport is the only one that sets up environment variables; see section
18992 &<<SECTpipeenv>>& for details.
18993
18994 The values used for the uid, gid, and the directories may come from several
18995 different places. In many cases, the router that handles the address associates
18996 settings with that address as a result of its &%check_local_user%&, &%group%&,
18997 or &%user%& options. However, values may also be given in the transport's own
18998 configuration, and these override anything that comes from the router.
18999
19000
19001
19002 .section "Concurrent deliveries" "SECID131"
19003 .cindex "concurrent deliveries"
19004 .cindex "simultaneous deliveries"
19005 If two different messages for the same local recipient arrive more or less
19006 simultaneously, the two delivery processes are likely to run concurrently. When
19007 the &(appendfile)& transport is used to write to a file, Exim applies locking
19008 rules to stop concurrent processes from writing to the same file at the same
19009 time.
19010
19011 However, when you use a &(pipe)& transport, it is up to you to arrange any
19012 locking that is needed. Here is a silly example:
19013 .code
19014 my_transport:
19015   driver = pipe
19016   command = /bin/sh -c 'cat >>/some/file'
19017 .endd
19018 This is supposed to write the message at the end of the file. However, if two
19019 messages arrive at the same time, the file will be scrambled. You can use the
19020 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19021 file using the same algorithm that Exim itself uses.
19022
19023
19024
19025
19026 .section "Uids and gids" "SECTenvuidgid"
19027 .cindex "local transports" "uid and gid"
19028 .cindex "transport" "local; uid and gid"
19029 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19030 overrides any group that the router set in the address, even if &%user%& is not
19031 set for the transport. This makes it possible, for example, to run local mail
19032 delivery under the uid of the recipient (set by the router), but in a special
19033 group (set by the transport). For example:
19034 .code
19035 # Routers ...
19036 # User/group are set by check_local_user in this router
19037 local_users:
19038   driver = accept
19039   check_local_user
19040   transport = group_delivery
19041
19042 # Transports ...
19043 # This transport overrides the group
19044 group_delivery:
19045   driver = appendfile
19046   file = /var/spool/mail/$local_part
19047   group = mail
19048 .endd
19049 If &%user%& is set for a transport, its value overrides what is set in the
19050 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19051 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19052 set.
19053
19054 .oindex "&%initgroups%&"
19055 When the uid is taken from the transport's configuration, the &[initgroups()]&
19056 function is called for the groups associated with that uid if the
19057 &%initgroups%& option is set for the transport. When the uid is not specified
19058 by the transport, but is associated with the address by a router, the option
19059 for calling &[initgroups()]& is taken from the router configuration.
19060
19061 .cindex "&(pipe)& transport" "uid for"
19062 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19063 is set and &%user%& is not set, the uid of the process that called Exim to
19064 receive the message is used, and if &%group%& is not set, the corresponding
19065 original gid is also used.
19066
19067 This is the detailed preference order for obtaining a gid; the first of the
19068 following that is set is used:
19069
19070 .ilist
19071 A &%group%& setting of the transport;
19072 .next
19073 A &%group%& setting of the router;
19074 .next
19075 A gid associated with a user setting of the router, either as a result of
19076 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19077 .next
19078 The group associated with a non-numeric &%user%& setting of the transport;
19079 .next
19080 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19081 the uid is the creator's uid;
19082 .next
19083 The Exim gid if the Exim uid is being used as a default.
19084 .endlist
19085
19086 If, for example, the user is specified numerically on the router and there are
19087 no group settings, no gid is available. In this situation, an error occurs.
19088 This is different for the uid, for which there always is an ultimate default.
19089 The first of the following that is set is used:
19090
19091 .ilist
19092 A &%user%& setting of the transport;
19093 .next
19094 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19095 .next
19096 A &%user%& setting of the router;
19097 .next
19098 A &%check_local_user%& setting of the router;
19099 .next
19100 The Exim uid.
19101 .endlist
19102
19103 Of course, an error will still occur if the uid that is chosen is on the
19104 &%never_users%& list.
19105
19106
19107
19108
19109
19110 .section "Current and home directories" "SECID132"
19111 .cindex "current directory for local transport"
19112 .cindex "home directory" "for local transport"
19113 .cindex "transport" "local; home directory for"
19114 .cindex "transport" "local; current directory for"
19115 Routers may set current and home directories for local transports by means of
19116 the &%transport_current_directory%& and &%transport_home_directory%& options.
19117 However, if the transport's &%current_directory%& or &%home_directory%& options
19118 are set, they override the router's values. In detail, the home directory
19119 for a local transport is taken from the first of these values that is set:
19120
19121 .ilist
19122 The &%home_directory%& option on the transport;
19123 .next
19124 The &%transport_home_directory%& option on the router;
19125 .next
19126 The password data if &%check_local_user%& is set on the router;
19127 .next
19128 The &%router_home_directory%& option on the router.
19129 .endlist
19130
19131 The current directory is taken from the first of these values that is set:
19132
19133 .ilist
19134 The &%current_directory%& option on the transport;
19135 .next
19136 The &%transport_current_directory%& option on the router.
19137 .endlist
19138
19139
19140 If neither the router nor the transport sets a current directory, Exim uses the
19141 value of the home directory, if it is set. Otherwise it sets the current
19142 directory to &_/_& before running a local transport.
19143
19144
19145
19146 .section "Expansion variables derived from the address" "SECID133"
19147 .vindex "&$domain$&"
19148 .vindex "&$local_part$&"
19149 .vindex "&$original_domain$&"
19150 Normally a local delivery is handling a single address, and in that case the
19151 variables such as &$domain$& and &$local_part$& are set during local
19152 deliveries. However, in some circumstances more than one address may be handled
19153 at once (for example, while writing batch SMTP for onward transmission by some
19154 other means). In this case, the variables associated with the local part are
19155 never set, &$domain$& is set only if all the addresses have the same domain,
19156 and &$original_domain$& is never set.
19157 .ecindex IIDenvlotra1
19158 .ecindex IIDenvlotra2
19159 .ecindex IIDenvlotra3
19160
19161
19162
19163
19164
19165
19166
19167 . ////////////////////////////////////////////////////////////////////////////
19168 . ////////////////////////////////////////////////////////////////////////////
19169
19170 .chapter "Generic options for transports" "CHAPtransportgeneric"
19171 .scindex IIDgenoptra1 "generic options" "transport"
19172 .scindex IIDgenoptra2 "options" "generic; for transports"
19173 .scindex IIDgenoptra3 "transport" "generic options for"
19174 The following generic options apply to all transports:
19175
19176
19177 .option body_only transports boolean false
19178 .cindex "transport" "body only"
19179 .cindex "message" "transporting body only"
19180 .cindex "body of message" "transporting"
19181 If this option is set, the message's headers are not transported. It is
19182 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19183 or &(pipe)& transports, the settings of &%message_prefix%& and
19184 &%message_suffix%& should be checked, because this option does not
19185 automatically suppress them.
19186
19187
19188 .option current_directory transports string&!! unset
19189 .cindex "transport" "current directory for"
19190 This specifies the current directory that is to be set while running the
19191 transport, overriding any value that may have been set by the router.
19192 If the expansion fails for any reason, including forced failure, an error is
19193 logged, and delivery is deferred.
19194
19195
19196 .option disable_logging transports boolean false
19197 If this option is set true, nothing is logged for any
19198 deliveries by the transport or for any
19199 transport errors. You should not set this option unless you really, really know
19200 what you are doing.
19201
19202
19203 .option debug_print transports string&!! unset
19204 .cindex "testing" "variables in drivers"
19205 If this option is set and debugging is enabled (see the &%-d%& command line
19206 option), the string is expanded and included in the debugging output when the
19207 transport is run.
19208 If expansion of the string fails, the error message is written to the debugging
19209 output, and Exim carries on processing.
19210 This facility is provided to help with checking out the values of variables and
19211 so on when debugging driver configurations. For example, if a &%headers_add%&
19212 option is not working properly, &%debug_print%& could be used to output the
19213 variables it references. A newline is added to the text if it does not end with
19214 one.
19215
19216
19217 .option delivery_date_add transports boolean false
19218 .cindex "&'Delivery-date:'& header line"
19219 If this option is true, a &'Delivery-date:'& header is added to the message.
19220 This gives the actual time the delivery was made. As this is not a standard
19221 header, Exim has a configuration option (&%delivery_date_remove%&) which
19222 requests its removal from incoming messages, so that delivered messages can
19223 safely be resent to other recipients.
19224
19225
19226 .option driver transports string unset
19227 This specifies which of the available transport drivers is to be used.
19228 There is no default, and this option must be set for every transport.
19229
19230
19231 .option envelope_to_add transports boolean false
19232 .cindex "&'Envelope-to:'& header line"
19233 If this option is true, an &'Envelope-to:'& header is added to the message.
19234 This gives the original address(es) in the incoming envelope that caused this
19235 delivery to happen. More than one address may be present if the transport is
19236 configured to handle several addresses at once, or if more than one original
19237 address was redirected to the same final address. As this is not a standard
19238 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19239 its removal from incoming messages, so that delivered messages can safely be
19240 resent to other recipients.
19241
19242
19243 .option group transports string&!! "Exim group"
19244 .cindex "transport" "group; specifying"
19245 This option specifies a gid for running the transport process, overriding any
19246 value that the router supplies, and also overriding any value associated with
19247 &%user%& (see below).
19248
19249
19250 .option headers_add transports string&!! unset
19251 .cindex "header lines" "adding in transport"
19252 .cindex "transport" "header lines; adding"
19253 This option specifies a string of text that is expanded and added to the header
19254 portion of a message as it is transported, as described in section
19255 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19256 routers. If the result of the expansion is an empty string, or if the expansion
19257 is forced to fail, no action is taken. Other expansion failures are treated as
19258 errors and cause the delivery to be deferred.
19259
19260
19261
19262 .option headers_only transports boolean false
19263 .cindex "transport" "header lines only"
19264 .cindex "message" "transporting headers only"
19265 .cindex "header lines" "transporting"
19266 If this option is set, the message's body is not transported. It is mutually
19267 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19268 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19269 checked, since this option does not automatically suppress them.
19270
19271
19272 .option headers_remove transports string&!! unset
19273 .cindex "header lines" "removing"
19274 .cindex "transport" "header lines; removing"
19275 This option specifies a string that is expanded into a list of header names;
19276 these headers are omitted from the message as it is transported, as described
19277 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19278 routers. If the result of the expansion is an empty string, or if the expansion
19279 is forced to fail, no action is taken. Other expansion failures are treated as
19280 errors and cause the delivery to be deferred.
19281
19282
19283
19284 .option headers_rewrite transports string unset
19285 .cindex "transport" "header lines; rewriting"
19286 .cindex "rewriting" "at transport time"
19287 This option allows addresses in header lines to be rewritten at transport time,
19288 that is, as the message is being copied to its destination. The contents of the
19289 option are a colon-separated list of rewriting rules. Each rule is in exactly
19290 the same form as one of the general rewriting rules that are applied when a
19291 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19292 example,
19293 .code
19294 headers_rewrite = a@b c@d f : \
19295                   x@y w@z
19296 .endd
19297 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19298 &'w@z'& in all address-bearing header lines. The rules are applied to the
19299 header lines just before they are written out at transport time, so they affect
19300 only those copies of the message that pass through the transport. However, only
19301 the message's original header lines, and any that were added by a system
19302 filter, are rewritten. If a router or transport adds header lines, they are not
19303 affected by this option. These rewriting rules are &'not'& applied to the
19304 envelope. You can change the return path using &%return_path%&, but you cannot
19305 change envelope recipients at this time.
19306
19307
19308 .option home_directory transports string&!! unset
19309 .cindex "transport" "home directory for"
19310 .vindex "&$home$&"
19311 This option specifies a home directory setting for a local transport,
19312 overriding any value that may be set by the router. The home directory is
19313 placed in &$home$& while expanding the transport's private options. It is also
19314 used as the current directory if no current directory is set by the
19315 &%current_directory%& option on the transport or the
19316 &%transport_current_directory%& option on the router. If the expansion fails
19317 for any reason, including forced failure, an error is logged, and delivery is
19318 deferred.
19319
19320
19321 .option initgroups transports boolean false
19322 .cindex "additional groups"
19323 .cindex "groups" "additional"
19324 .cindex "transport" "group; additional"
19325 If this option is true and the uid for the delivery process is provided by the
19326 transport, the &[initgroups()]& function is called when running the transport
19327 to ensure that any additional groups associated with the uid are set up.
19328
19329
19330 .option message_size_limit transports string&!! 0
19331 .cindex "limit" "message size per transport"
19332 .cindex "size" "of message, limit"
19333 .cindex "transport" "message size; limiting"
19334 This option controls the size of messages passed through the transport. It is
19335 expanded before use; the result of the expansion must be a sequence of decimal
19336 digits, optionally followed by K or M. If the expansion fails for any reason,
19337 including forced failure, or if the result is not of the required form,
19338 delivery is deferred. If the value is greater than zero and the size of a
19339 message exceeds this limit, the address is failed. If there is any chance that
19340 the resulting bounce message could be routed to the same transport, you should
19341 ensure that &%return_size_limit%& is less than the transport's
19342 &%message_size_limit%&, as otherwise the bounce message will fail to get
19343 delivered.
19344
19345
19346
19347 .option rcpt_include_affixes transports boolean false
19348 .cindex "prefix" "for local part, including in envelope"
19349 .cindex "suffix for local part" "including in envelope"
19350 .cindex "local part" "prefix"
19351 .cindex "local part" "suffix"
19352 When this option is false (the default), and an address that has had any
19353 affixes (prefixes or suffixes) removed from the local part is delivered by any
19354 form of SMTP or LMTP, the affixes are not included. For example, if a router
19355 that contains
19356 .code
19357 local_part_prefix = *-
19358 .endd
19359 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19360 is delivered with
19361 .code
19362 RCPT TO:<xyz@some.domain>
19363 .endd
19364 This is also the case when an ACL-time callout is being used to verify a
19365 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19366 whole local part is included in the RCPT command. This option applies to BSMTP
19367 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19368 &(lmtp)& and &(smtp)& transports.
19369
19370
19371 .option retry_use_local_part transports boolean "see below"
19372 .cindex "hints database" "retry keys"
19373 When a delivery suffers a temporary failure, a retry record is created
19374 in Exim's hints database. For remote deliveries, the key for the retry record
19375 is based on the name and/or IP address of the failing remote host. For local
19376 deliveries, the key is normally the entire address, including both the local
19377 part and the domain. This is suitable for most common cases of local delivery
19378 temporary failure &-- for example, exceeding a mailbox quota should delay only
19379 deliveries to that mailbox, not to the whole domain.
19380
19381 However, in some special cases you may want to treat a temporary local delivery
19382 as a failure associated with the domain, and not with a particular local part.
19383 (For example, if you are storing all mail for some domain in files.) You can do
19384 this by setting &%retry_use_local_part%& false.
19385
19386 For all the local transports, its default value is true. For remote transports,
19387 the default value is false for tidiness, but changing the value has no effect
19388 on a remote transport in the current implementation.
19389
19390
19391 .option return_path transports string&!! unset
19392 .cindex "envelope sender"
19393 .cindex "transport" "return path; changing"
19394 .cindex "return path" "changing in transport"
19395 If this option is set, the string is expanded at transport time and replaces
19396 the existing return path (envelope sender) value in the copy of the message
19397 that is being delivered. An empty return path is permitted. This feature is
19398 designed for remote deliveries, where the value of this option is used in the
19399 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19400 only effect is to change the address that is placed in the &'Return-path:'&
19401 header line, if one is added to the message (see the next option).
19402
19403 &*Note:*& A changed return path is not logged unless you add
19404 &%return_path_on_delivery%& to the log selector.
19405
19406 .vindex "&$return_path$&"
19407 The expansion can refer to the existing value via &$return_path$&. This is
19408 either the message's envelope sender, or an address set by the
19409 &%errors_to%& option on a router. If the expansion is forced to fail, no
19410 replacement occurs; if it fails for another reason, delivery is deferred. This
19411 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19412 section &<<SECTverp>>&.
19413
19414 &*Note*&: If a delivery error is detected locally, including the case when a
19415 remote server rejects a message at SMTP time, the bounce message is not sent to
19416 the value of this option. It is sent to the previously set errors address.
19417 This defaults to the incoming sender address, but can be changed by setting
19418 &%errors_to%& in a router.
19419
19420
19421
19422 .option return_path_add transports boolean false
19423 .cindex "&'Return-path:'& header line"
19424 If this option is true, a &'Return-path:'& header is added to the message.
19425 Although the return path is normally available in the prefix line of BSD
19426 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19427 have easy access to it.
19428
19429 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19430 the delivery SMTP server makes the final delivery"&. This implies that this
19431 header should not be present in incoming messages. Exim has a configuration
19432 option, &%return_path_remove%&, which requests removal of this header from
19433 incoming messages, so that delivered messages can safely be resent to other
19434 recipients.
19435
19436
19437 .option shadow_condition transports string&!! unset
19438 See &%shadow_transport%& below.
19439
19440
19441 .option shadow_transport transports string unset
19442 .cindex "shadow transport"
19443 .cindex "transport" "shadow"
19444 A local transport may set the &%shadow_transport%& option to the name of
19445 another local transport. Shadow remote transports are not supported.
19446
19447 Whenever a delivery to the main transport succeeds, and either
19448 &%shadow_condition%& is unset, or its expansion does not result in the empty
19449 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19450 passed to the shadow transport, with the same delivery address or addresses. If
19451 expansion fails, no action is taken except that non-forced expansion failures
19452 cause a log line to be written.
19453
19454 The result of the shadow transport is discarded and does not affect the
19455 subsequent processing of the message. Only a single level of shadowing is
19456 provided; the &%shadow_transport%& option is ignored on any transport when it
19457 is running as a shadow. Options concerned with output from pipes are also
19458 ignored. The log line for the successful delivery has an item added on the end,
19459 of the form
19460 .code
19461 ST=<shadow transport name>
19462 .endd
19463 If the shadow transport did not succeed, the error message is put in
19464 parentheses afterwards. Shadow transports can be used for a number of different
19465 purposes, including keeping more detailed log information than Exim normally
19466 provides, and implementing automatic acknowledgment policies based on message
19467 headers that some sites insist on.
19468
19469
19470 .option transport_filter transports string&!! unset
19471 .cindex "transport" "filter"
19472 .cindex "filter" "transport filter"
19473 This option sets up a filtering (in the Unix shell sense) process for messages
19474 at transport time. It should not be confused with mail filtering as set up by
19475 individual users or via a system filter.
19476
19477 When the message is about to be written out, the command specified by
19478 &%transport_filter%& is started up in a separate, parallel process, and
19479 the entire message, including the header lines, is passed to it on its standard
19480 input (this in fact is done from a third process, to avoid deadlock). The
19481 command must be specified as an absolute path.
19482
19483 The lines of the message that are written to the transport filter are
19484 terminated by newline (&"\n"&). The message is passed to the filter before any
19485 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19486 lines beginning with a dot, and also before any processing implied by the
19487 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19488 &(pipe)& transports.
19489
19490 The standard error for the filter process is set to the same destination as its
19491 standard output; this is read and written to the message's ultimate
19492 destination. The process that writes the message to the filter, the
19493 filter itself, and the original process that reads the result and delivers it
19494 are all run in parallel, like a shell pipeline.
19495
19496 The filter can perform any transformations it likes, but of course should take
19497 care not to break RFC 2822 syntax. Exim does not check the result, except to
19498 test for a final newline when SMTP is in use. All messages transmitted over
19499 SMTP must end with a newline, so Exim supplies one if it is missing.
19500
19501 .cindex "content scanning" "per user"
19502 A transport filter can be used to provide content-scanning on a per-user basis
19503 at delivery time if the only required effect of the scan is to modify the
19504 message. For example, a content scan could insert a new header line containing
19505 a spam score. This could be interpreted by a filter in the user's MUA. It is
19506 not possible to discard a message at this stage.
19507
19508 .cindex "SMTP" "SIZE"
19509 A problem might arise if the filter increases the size of a message that is
19510 being sent down an SMTP connection. If the receiving SMTP server has indicated
19511 support for the SIZE parameter, Exim will have sent the size of the message
19512 at the start of the SMTP session. If what is actually sent is substantially
19513 more, the server might reject the message. This can be worked round by setting
19514 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19515 additions to the message, or to disable the use of SIZE altogether.
19516
19517 .vindex "&$pipe_addresses$&"
19518 The value of the &%transport_filter%& option is the command string for starting
19519 the filter, which is run directly from Exim, not under a shell. The string is
19520 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19521 Exim breaks it up into arguments and then expands each argument separately (see
19522 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19523 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19524 of arguments, one for each address that applies to this delivery. (This isn't
19525 an ideal name for this feature here, but as it was already implemented for the
19526 &(pipe)& transport, it seemed sensible not to change it.)
19527
19528 .vindex "&$host$&"
19529 .vindex "&$host_address$&"
19530 The expansion variables &$host$& and &$host_address$& are available when the
19531 transport is a remote one. They contain the name and IP address of the host to
19532 which the message is being sent. For example:
19533 .code
19534 transport_filter = /some/directory/transport-filter.pl \
19535   $host $host_address $sender_address $pipe_addresses
19536 .endd
19537
19538 Two problems arise if you want to use more complicated expansion items to
19539 generate transport filter commands, both of which due to the fact that the
19540 command is split up &'before'& expansion.
19541 .ilist
19542 If an expansion item contains white space, you must quote it, so that it is all
19543 part of the same command item. If the entire option setting is one such
19544 expansion item, you have to take care what kind of quoting you use. For
19545 example:
19546 .code
19547 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19548 .endd
19549 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19550 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19551 stripped by Exim when it read the option's value. When the value is used, if
19552 the single quotes were missing, the line would be split into two items,
19553 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19554 Exim tried to expand the first one.
19555 .next
19556 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19557 expansion cannot generate multiple arguments, or a command name followed by
19558 arguments. Consider this example:
19559 .code
19560 transport_filter = ${lookup{$host}lsearch{/a/file}\
19561                     {$value}{/bin/cat}}
19562 .endd
19563 The result of the lookup is interpreted as the name of the command, even
19564 if it contains white space. The simplest way round this is to use a shell:
19565 .code
19566 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19567                                {$value}{/bin/cat}}
19568 .endd
19569 .endlist
19570
19571 The filter process is run under the same uid and gid as the normal delivery.
19572 For remote deliveries this is the Exim uid/gid by default. The command should
19573 normally yield a zero return code. Transport filters are not supposed to fail.
19574 A non-zero code is taken to mean that the transport filter encountered some
19575 serious problem. Delivery of the message is deferred; the message remains on
19576 the queue and is tried again later. It is not possible to cause a message to be
19577 bounced from a transport filter.
19578
19579 If a transport filter is set on an autoreply transport, the original message is
19580 passed through the filter as it is being copied into the newly generated
19581 message, which happens if the &%return_message%& option is set.
19582
19583
19584 .option transport_filter_timeout transports time 5m
19585 .cindex "transport" "filter, timeout"
19586 When Exim is reading the output of a transport filter, it a applies a timeout
19587 that can be set by this option. Exceeding the timeout is normally treated as a
19588 temporary delivery failure. However, if a transport filter is used with a
19589 &(pipe)& transport, a timeout in the transport filter is treated in the same
19590 way as a timeout in the pipe command itself. By default, a timeout is a hard
19591 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19592 becomes a temporary error.
19593
19594
19595 .option user transports string&!! "Exim user"
19596 .cindex "uid (user id)" "local delivery"
19597 .cindex "transport" "user, specifying"
19598 This option specifies the user under whose uid the delivery process is to be
19599 run, overriding any uid that may have been set by the router. If the user is
19600 given as a name, the uid is looked up from the password data, and the
19601 associated group is taken as the value of the gid to be used if the &%group%&
19602 option is not set.
19603
19604 For deliveries that use local transports, a user and group are normally
19605 specified explicitly or implicitly (for example, as a result of
19606 &%check_local_user%&) by the router or transport.
19607
19608 .cindex "hints database" "access by remote transport"
19609 For remote transports, you should leave this option unset unless you really are
19610 sure you know what you are doing. When a remote transport is running, it needs
19611 to be able to access Exim's hints databases, because each host may have its own
19612 retry data.
19613 .ecindex IIDgenoptra1
19614 .ecindex IIDgenoptra2
19615 .ecindex IIDgenoptra3
19616
19617
19618
19619
19620
19621
19622 . ////////////////////////////////////////////////////////////////////////////
19623 . ////////////////////////////////////////////////////////////////////////////
19624
19625 .chapter "Address batching in local transports" "CHAPbatching" &&&
19626          "Address batching"
19627 .cindex "transport" "local; address batching in"
19628 The only remote transport (&(smtp)&) is normally configured to handle more than
19629 one address at a time, so that when several addresses are routed to the same
19630 remote host, just one copy of the message is sent. Local transports, however,
19631 normally handle one address at a time. That is, a separate instance of the
19632 transport is run for each address that is routed to the transport. A separate
19633 copy of the message is delivered each time.
19634
19635 .cindex "batched local delivery"
19636 .oindex "&%batch_max%&"
19637 .oindex "&%batch_id%&"
19638 In special cases, it may be desirable to handle several addresses at once in a
19639 local transport, for example:
19640
19641 .ilist
19642 In an &(appendfile)& transport, when storing messages in files for later
19643 delivery by some other means, a single copy of the message with multiple
19644 recipients saves space.
19645 .next
19646 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19647 a single copy saves time, and is the normal way LMTP is expected to work.
19648 .next
19649 In a &(pipe)& transport, when passing the message
19650 to a scanner program or
19651 to some other delivery mechanism such as UUCP, multiple recipients may be
19652 acceptable.
19653 .endlist
19654
19655 These three local transports all have the same options for controlling multiple
19656 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19657 repeating the information for each transport, these options are described here.
19658
19659 The &%batch_max%& option specifies the maximum number of addresses that can be
19660 delivered together in a single run of the transport. Its default value is one
19661 (no batching). When more than one address is routed to a transport that has a
19662 &%batch_max%& value greater than one, the addresses are delivered in a batch
19663 (that is, in a single run of the transport with multiple recipients), subject
19664 to certain conditions:
19665
19666 .ilist
19667 .vindex "&$local_part$&"
19668 If any of the transport's options contain a reference to &$local_part$&, no
19669 batching is possible.
19670 .next
19671 .vindex "&$domain$&"
19672 If any of the transport's options contain a reference to &$domain$&, only
19673 addresses with the same domain are batched.
19674 .next
19675 .cindex "customizing" "batching condition"
19676 If &%batch_id%& is set, it is expanded for each address, and only those
19677 addresses with the same expanded value are batched. This allows you to specify
19678 customized batching conditions. Failure of the expansion for any reason,
19679 including forced failure, disables batching, but it does not stop the delivery
19680 from taking place.
19681 .next
19682 Batched addresses must also have the same errors address (where to send
19683 delivery errors), the same header additions and removals, the same user and
19684 group for the transport, and if a host list is present, the first host must
19685 be the same.
19686 .endlist
19687
19688 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19689 both when the file or pipe command is specified in the transport, and when it
19690 is specified by a &(redirect)& router, but all the batched addresses must of
19691 course be routed to the same file or pipe command. These two transports have an
19692 option called &%use_bsmtp%&, which causes them to deliver the message in
19693 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19694 &%check_string%& and &%escape_string%& options are forced to the values
19695 .code
19696 check_string = "."
19697 escape_string = ".."
19698 .endd
19699 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19700 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19701 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19702
19703 .cindex "&'Envelope-to:'& header line"
19704 If the generic &%envelope_to_add%& option is set for a batching transport, the
19705 &'Envelope-to:'& header that is added to the message contains all the addresses
19706 that are being processed together. If you are using a batching &(appendfile)&
19707 transport without &%use_bsmtp%&, the only way to preserve the recipient
19708 addresses is to set the &%envelope_to_add%& option.
19709
19710 .cindex "&(pipe)& transport" "with multiple addresses"
19711 .vindex "&$pipe_addresses$&"
19712 If you are using a &(pipe)& transport without BSMTP, and setting the
19713 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19714 the command. This is not a true variable; it is a bit of magic that causes each
19715 of the recipient addresses to be inserted into the command as a separate
19716 argument. This provides a way of accessing all the addresses that are being
19717 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19718 are specified by a &(redirect)& router.
19719
19720
19721
19722
19723 . ////////////////////////////////////////////////////////////////////////////
19724 . ////////////////////////////////////////////////////////////////////////////
19725
19726 .chapter "The appendfile transport" "CHAPappendfile"
19727 .scindex IIDapptra1 "&(appendfile)& transport"
19728 .scindex IIDapptra2 "transports" "&(appendfile)&"
19729 .cindex "directory creation"
19730 .cindex "creating directories"
19731 The &(appendfile)& transport delivers a message by appending it to an existing
19732 file, or by creating an entirely new file in a specified directory. Single
19733 files to which messages are appended can be in the traditional Unix mailbox
19734 format, or optionally in the MBX format supported by the Pine MUA and
19735 University of Washington IMAP daemon, &'inter alia'&. When each message is
19736 being delivered as a separate file, &"maildir"& format can optionally be used
19737 to give added protection against failures that happen part-way through the
19738 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19739 supported. For all file formats, Exim attempts to create as many levels of
19740 directory as necessary, provided that &%create_directory%& is set.
19741
19742 The code for the optional formats is not included in the Exim binary by
19743 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19744 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19745 included.
19746
19747 .cindex "quota" "system"
19748 Exim recognizes system quota errors, and generates an appropriate message. Exim
19749 also supports its own quota control within the transport, for use when the
19750 system facility is unavailable or cannot be used for some reason.
19751
19752 If there is an error while appending to a file (for example, quota exceeded or
19753 partition filled), Exim attempts to reset the file's length and last
19754 modification time back to what they were before. If there is an error while
19755 creating an entirely new file, the new file is removed.
19756
19757 Before appending to a file, a number of security checks are made, and the
19758 file is locked. A detailed description is given below, after the list of
19759 private options.
19760
19761 The &(appendfile)& transport is most commonly used for local deliveries to
19762 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19763 putting messages into files for remote delivery by some means other than Exim.
19764 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19765 option).
19766
19767
19768
19769 .section "The file and directory options" "SECTfildiropt"
19770 The &%file%& option specifies a single file, to which the message is appended;
19771 the &%directory%& option specifies a directory, in which a new file containing
19772 the message is created. Only one of these two options can be set, and for
19773 normal deliveries to mailboxes, one of them &'must'& be set.
19774
19775 .vindex "&$address_file$&"
19776 .vindex "&$local_part$&"
19777 However, &(appendfile)& is also used for delivering messages to files or
19778 directories whose names (or parts of names) are obtained from alias,
19779 forwarding, or filtering operations (for example, a &%save%& command in a
19780 user's Exim filter). When such a transport is running, &$local_part$& contains
19781 the local part that was aliased or forwarded, and &$address_file$& contains the
19782 name (or partial name) of the file or directory generated by the redirection
19783 operation. There are two cases:
19784
19785 .ilist
19786 If neither &%file%& nor &%directory%& is set, the redirection operation
19787 must specify an absolute path (one that begins with &`/`&). This is the most
19788 common case when users with local accounts use filtering to sort mail into
19789 different folders. See for example, the &(address_file)& transport in the
19790 default configuration. If the path ends with a slash, it is assumed to be the
19791 name of a directory. A delivery to a directory can also be forced by setting
19792 &%maildir_format%& or &%mailstore_format%&.
19793 .next
19794 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19795 used to determine the file or directory name for the delivery. Normally, the
19796 contents of &$address_file$& are used in some way in the string expansion.
19797 .endlist
19798
19799
19800 .cindex "Sieve filter" "configuring &(appendfile)&"
19801 .cindex "Sieve filter" "relative mailbox path handling"
19802 As an example of the second case, consider an environment where users do not
19803 have home directories. They may be permitted to use Exim filter commands of the
19804 form:
19805 .code
19806 save folder23
19807 .endd
19808 or Sieve filter commands of the form:
19809 .code
19810 require "fileinto";
19811 fileinto "folder23";
19812 .endd
19813 In this situation, the expansion of &%file%& or &%directory%& in the transport
19814 must transform the relative path into an appropriate absolute file name. In the
19815 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19816 is used as a result of a &"keep"& action in the filter. This example shows one
19817 way of handling this requirement:
19818 .code
19819 file = ${if eq{$address_file}{inbox} \
19820             {/var/mail/$local_part} \
19821             {${if eq{${substr_0_1:$address_file}}{/} \
19822                   {$address_file} \
19823                   {$home/mail/$address_file} \
19824             }} \
19825        }
19826 .endd
19827 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19828 location, absolute paths are used without change, and other folders are in the
19829 &_mail_& directory within the home directory.
19830
19831 &*Note 1*&: While processing an Exim filter, a relative path such as
19832 &_folder23_& is turned into an absolute path if a home directory is known to
19833 the router. In particular, this is the case if &%check_local_user%& is set. If
19834 you want to prevent this happening at routing time, you can set
19835 &%router_home_directory%& empty. This forces the router to pass the relative
19836 path to the transport.
19837
19838 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19839 the &%file%& or &%directory%& option is still used if it is set.
19840
19841
19842
19843
19844 .section "Private options for appendfile" "SECID134"
19845 .cindex "options" "&(appendfile)& transport"
19846
19847
19848
19849 .option allow_fifo appendfile boolean false
19850 .cindex "fifo (named pipe)"
19851 .cindex "named pipe (fifo)"
19852 .cindex "pipe" "named (fifo)"
19853 Setting this option permits delivery to named pipes (FIFOs) as well as to
19854 regular files. If no process is reading the named pipe at delivery time, the
19855 delivery is deferred.
19856
19857
19858 .option allow_symlink appendfile boolean false
19859 .cindex "symbolic link" "to mailbox"
19860 .cindex "mailbox" "symbolic link"
19861 By default, &(appendfile)& will not deliver if the path name for the file is
19862 that of a symbolic link. Setting this option relaxes that constraint, but there
19863 are security issues involved in the use of symbolic links. Be sure you know
19864 what you are doing if you set this. Details of exactly what this option affects
19865 are included in the discussion which follows this list of options.
19866
19867
19868 .option batch_id appendfile string&!! unset
19869 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19870 However, batching is automatically disabled for &(appendfile)& deliveries that
19871 happen as a result of forwarding or aliasing or other redirection directly to a
19872 file.
19873
19874
19875 .option batch_max appendfile integer 1
19876 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19877
19878
19879 .option check_group appendfile boolean false
19880 When this option is set, the group owner of the file defined by the &%file%&
19881 option is checked to see that it is the same as the group under which the
19882 delivery process is running. The default setting is false because the default
19883 file mode is 0600, which means that the group is irrelevant.
19884
19885
19886 .option check_owner appendfile boolean true
19887 When this option is set, the owner of the file defined by the &%file%& option
19888 is checked to ensure that it is the same as the user under which the delivery
19889 process is running.
19890
19891
19892 .option check_string appendfile string "see below"
19893 .cindex "&""From""& line"
19894 As &(appendfile)& writes the message, the start of each line is tested for
19895 matching &%check_string%&, and if it does, the initial matching characters are
19896 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19897 a literal string, not a regular expression, and the case of any letters it
19898 contains is significant.
19899
19900 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19901 are forced to &"."& and &".."& respectively, and any settings in the
19902 configuration are ignored. Otherwise, they default to &"From&~"& and
19903 &">From&~"& when the &%file%& option is set, and unset when any of the
19904 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19905
19906 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19907 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19908 &"From&~"& indicates the start of a new message. All four options need changing
19909 if another format is used. For example, to deliver to mailboxes in MMDF format:
19910 .cindex "MMDF format mailbox"
19911 .cindex "mailbox" "MMDF format"
19912 .code
19913 check_string = "\1\1\1\1\n"
19914 escape_string = "\1\1\1\1 \n"
19915 message_prefix = "\1\1\1\1\n"
19916 message_suffix = "\1\1\1\1\n"
19917 .endd
19918 .option create_directory appendfile boolean true
19919 .cindex "directory creation"
19920 When this option is true, Exim attempts to create any missing superior
19921 directories for the file that it is about to write. A created directory's mode
19922 is given by the &%directory_mode%& option.
19923
19924 The group ownership of a newly created directory is highly dependent on the
19925 operating system (and possibly the file system) that is being used. For
19926 example, in Solaris, if the parent directory has the setgid bit set, its group
19927 is propagated to the child; if not, the currently set group is used. However,
19928 in FreeBSD, the parent's group is always used.
19929
19930
19931
19932 .option create_file appendfile string anywhere
19933 This option constrains the location of files and directories that are created
19934 by this transport. It applies to files defined by the &%file%& option and
19935 directories defined by the &%directory%& option. In the case of maildir
19936 delivery, it applies to the top level directory, not the maildir directories
19937 beneath.
19938
19939 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19940 &"belowhome"&. In the second and third cases, a home directory must have been
19941 set for the transport. This option is not useful when an explicit file name is
19942 given for normal mailbox deliveries. It is intended for the case when file
19943 names are generated from users' &_.forward_& files. These are usually handled
19944 by an &(appendfile)& transport called &%address_file%&. See also
19945 &%file_must_exist%&.
19946
19947
19948 .option directory appendfile string&!! unset
19949 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19950 or &%directory%& must be set, unless the delivery is the direct result of a
19951 redirection (see section &<<SECTfildiropt>>&).
19952
19953 When &%directory%& is set, the string is expanded, and the message is delivered
19954 into a new file or files in or below the given directory, instead of being
19955 appended to a single mailbox file. A number of different formats are provided
19956 (see &%maildir_format%& and &%mailstore_format%&), and see section
19957 &<<SECTopdir>>& for further details of this form of delivery.
19958
19959
19960 .option directory_file appendfile string&!! "see below"
19961 .cindex "base62"
19962 .vindex "&$inode$&"
19963 When &%directory%& is set, but neither &%maildir_format%& nor
19964 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19965 whose name is obtained by expanding this string. The default value is:
19966 .code
19967 q${base62:$tod_epoch}-$inode
19968 .endd
19969 This generates a unique name from the current time, in base 62 form, and the
19970 inode of the file. The variable &$inode$& is available only when expanding this
19971 option.
19972
19973
19974 .option directory_mode appendfile "octal integer" 0700
19975 If &(appendfile)& creates any directories as a result of the
19976 &%create_directory%& option, their mode is specified by this option.
19977
19978
19979 .option escape_string appendfile string "see description"
19980 See &%check_string%& above.
19981
19982
19983 .option file appendfile string&!! unset
19984 This option is mutually exclusive with the &%directory%& option, but one of
19985 &%file%& or &%directory%& must be set, unless the delivery is the direct result
19986 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
19987 specifies a single file, to which the message is appended. One or more of
19988 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
19989 &%file%&.
19990
19991 .cindex "NFS" "lock file"
19992 .cindex "locking files"
19993 .cindex "lock files"
19994 If you are using more than one host to deliver over NFS into the same
19995 mailboxes, you should always use lock files.
19996
19997 The string value is expanded for each delivery, and must yield an absolute
19998 path. The most common settings of this option are variations on one of these
19999 examples:
20000 .code
20001 file = /var/spool/mail/$local_part
20002 file = /home/$local_part/inbox
20003 file = $home/inbox
20004 .endd
20005 .cindex "&""sticky""& bit"
20006 In the first example, all deliveries are done into the same directory. If Exim
20007 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20008 create a file in the directory, so the &"sticky"& bit must be turned on for
20009 deliveries to be possible, or alternatively the &%group%& option can be used to
20010 run the delivery under a group id which has write access to the directory.
20011
20012
20013
20014 .option file_format appendfile string unset
20015 .cindex "file" "mailbox; checking existing format"
20016 This option requests the transport to check the format of an existing file
20017 before adding to it. The check consists of matching a specific string at the
20018 start of the file. The value of the option consists of an even number of
20019 colon-separated strings. The first of each pair is the test string, and the
20020 second is the name of a transport. If the transport associated with a matched
20021 string is not the current transport, control is passed over to the other
20022 transport. For example, suppose the standard &(local_delivery)& transport has
20023 this added to it:
20024 .code
20025 file_format = "From       : local_delivery :\
20026                \1\1\1\1\n : local_mmdf_delivery"
20027 .endd
20028 Mailboxes that begin with &"From"& are still handled by this transport, but if
20029 a mailbox begins with four binary ones followed by a newline, control is passed
20030 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20031 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20032 is assumed to match the current transport. If the start of a mailbox doesn't
20033 match any string, or if the transport named for a given string is not defined,
20034 delivery is deferred.
20035
20036
20037 .option file_must_exist appendfile boolean false
20038 If this option is true, the file specified by the &%file%& option must exist.
20039 A temporary error occurs if it does not, causing delivery to be deferred.
20040 If this option is false, the file is created if it does not exist.
20041
20042
20043 .option lock_fcntl_timeout appendfile time 0s
20044 .cindex "timeout" "mailbox locking"
20045 .cindex "mailbox" "locking, blocking and non-blocking"
20046 .cindex "locking files"
20047 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20048 when locking an open mailbox file. If the call fails, the delivery process
20049 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20050 Non-blocking calls are used so that the file is not kept open during the wait
20051 for the lock; the reason for this is to make it as safe as possible for
20052 deliveries over NFS in the case when processes might be accessing an NFS
20053 mailbox without using a lock file. This should not be done, but
20054 misunderstandings and hence misconfigurations are not unknown.
20055
20056 On a busy system, however, the performance of a non-blocking lock approach is
20057 not as good as using a blocking lock with a timeout. In this case, the waiting
20058 is done inside the system call, and Exim's delivery process acquires the lock
20059 and can proceed as soon as the previous lock holder releases it.
20060
20061 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20062 timeout, are used. There may still be some retrying: the maximum number of
20063 retries is
20064 .code
20065 (lock_retries * lock_interval) / lock_fcntl_timeout
20066 .endd
20067 rounded up to the next whole number. In other words, the total time during
20068 which &(appendfile)& is trying to get a lock is roughly the same, unless
20069 &%lock_fcntl_timeout%& is set very large.
20070
20071 You should consider setting this option if you are getting a lot of delayed
20072 local deliveries because of errors of the form
20073 .code
20074 failed to lock mailbox /some/file (fcntl)
20075 .endd
20076
20077 .option lock_flock_timeout appendfile time 0s
20078 This timeout applies to file locking when using &[flock()]& (see
20079 &%use_flock%&); the timeout operates in a similar manner to
20080 &%lock_fcntl_timeout%&.
20081
20082
20083 .option lock_interval appendfile time 3s
20084 This specifies the time to wait between attempts to lock the file. See below
20085 for details of locking.
20086
20087
20088 .option lock_retries appendfile integer 10
20089 This specifies the maximum number of attempts to lock the file. A value of zero
20090 is treated as 1. See below for details of locking.
20091
20092
20093 .option lockfile_mode appendfile "octal integer" 0600
20094 This specifies the mode of the created lock file, when a lock file is being
20095 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20096
20097
20098 .option lockfile_timeout appendfile time 30m
20099 .cindex "timeout" "mailbox locking"
20100 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20101 exists and is older than this value, it is assumed to have been left behind by
20102 accident, and Exim attempts to remove it.
20103
20104
20105 .option mailbox_filecount appendfile string&!! unset
20106 .cindex "mailbox" "specifying size of"
20107 .cindex "size" "of mailbox"
20108 If this option is set, it is expanded, and the result is taken as the current
20109 number of files in the mailbox. It must be a decimal number, optionally
20110 followed by K or M. This provides a way of obtaining this information from an
20111 external source that maintains the data.
20112
20113
20114 .option mailbox_size appendfile string&!! unset
20115 .cindex "mailbox" "specifying size of"
20116 .cindex "size" "of mailbox"
20117 If this option is set, it is expanded, and the result is taken as the current
20118 size the mailbox. It must be a decimal number, optionally followed by K or M.
20119 This provides a way of obtaining this information from an external source that
20120 maintains the data. This is likely to be helpful for maildir deliveries where
20121 it is computationally expensive to compute the size of a mailbox.
20122
20123
20124
20125 .option maildir_format appendfile boolean false
20126 .cindex "maildir format" "specifying"
20127 If this option is set with the &%directory%& option, the delivery is into a new
20128 file, in the &"maildir"& format that is used by other mail software. When the
20129 transport is activated directly from a &(redirect)& router (for example, the
20130 &(address_file)& transport in the default configuration), setting
20131 &%maildir_format%& causes the path received from the router to be treated as a
20132 directory, whether or not it ends with &`/`&. This option is available only if
20133 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20134 &<<SECTmaildirdelivery>>& below for further details.
20135
20136
20137 .option maildir_quota_directory_regex appendfile string "See below"
20138 .cindex "maildir format" "quota; directories included in"
20139 .cindex "quota" "maildir; directories included in"
20140 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20141 a regular expression for specifying directories, relative to the quota
20142 directory (see &%quota_directory%&), that should be included in the quota
20143 calculation. The default value is:
20144 .code
20145 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20146 .endd
20147 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20148 (directories whose names begin with a dot). If you want to exclude the
20149 &_Trash_&
20150 folder from the count (as some sites do), you need to change this setting to
20151 .code
20152 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20153 .endd
20154 This uses a negative lookahead in the regular expression to exclude the
20155 directory whose name is &_.Trash_&. When a directory is excluded from quota
20156 calculations, quota processing is bypassed for any messages that are delivered
20157 directly into that directory.
20158
20159
20160 .option maildir_retries appendfile integer 10
20161 This option specifies the number of times to retry when writing a file in
20162 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20163
20164
20165 .option maildir_tag appendfile string&!! unset
20166 This option applies only to deliveries in maildir format, and is described in
20167 section &<<SECTmaildirdelivery>>& below.
20168
20169
20170 .new
20171 .option maildir_use_size_file appendfile&!! boolean false
20172 .cindex "maildir format" "&_maildirsize_& file"
20173 The result of string expansion for this option must be a valid boolean value.
20174 If it is true, it enables support for &_maildirsize_& files. Exim
20175 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20176 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20177 value is zero. See &%maildir_quota_directory_regex%& above and section
20178 &<<SECTmaildirdelivery>>& below for further details.
20179 .wen
20180
20181 .option maildirfolder_create_regex appendfile string unset
20182 .cindex "maildir format" "&_maildirfolder_& file"
20183 .cindex "&_maildirfolder_&, creating"
20184 The value of this option is a regular expression. If it is unset, it has no
20185 effect. Otherwise, before a maildir delivery takes place, the pattern is
20186 matched against the name of the maildir directory, that is, the directory
20187 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20188 delivery. If there is a match, Exim checks for the existence of a file called
20189 &_maildirfolder_& in the directory, and creates it if it does not exist.
20190 See section &<<SECTmaildirdelivery>>& for more details.
20191
20192
20193 .option mailstore_format appendfile boolean false
20194 .cindex "mailstore format" "specifying"
20195 If this option is set with the &%directory%& option, the delivery is into two
20196 new files in  &"mailstore"& format. The option is available only if
20197 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20198 below for further details.
20199
20200
20201 .option mailstore_prefix appendfile string&!! unset
20202 This option applies only to deliveries in mailstore format, and is described in
20203 section &<<SECTopdir>>& below.
20204
20205
20206 .option mailstore_suffix appendfile string&!! unset
20207 This option applies only to deliveries in mailstore format, and is described in
20208 section &<<SECTopdir>>& below.
20209
20210
20211 .option mbx_format appendfile boolean false
20212 .cindex "locking files"
20213 .cindex "file" "locking"
20214 .cindex "file" "MBX format"
20215 .cindex "MBX format, specifying"
20216 This option is available only if Exim has been compiled with SUPPORT_MBX
20217 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20218 the message is appended to the mailbox file in MBX format instead of
20219 traditional Unix format. This format is supported by Pine4 and its associated
20220 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20221
20222 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20223 automatically changed by the use of &%mbx_format%&. They should normally be set
20224 empty when using MBX format, so this option almost always appears in this
20225 combination:
20226 .code
20227 mbx_format = true
20228 message_prefix =
20229 message_suffix =
20230 .endd
20231 If none of the locking options are mentioned in the configuration,
20232 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20233 is possible to specify the other kinds of locking with &%mbx_format%&, but
20234 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20235 interworks with &'c-client'&, providing for shared access to the mailbox. It
20236 should not be used if any program that does not use this form of locking is
20237 going to access the mailbox, nor should it be used if the mailbox file is NFS
20238 mounted, because it works only when the mailbox is accessed from a single host.
20239
20240 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20241 the standard version of &'c-client'&, because as long as it has a mailbox open
20242 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20243 append messages to it.
20244
20245
20246 .option message_prefix appendfile string&!! "see below"
20247 .cindex "&""From""& line"
20248 The string specified here is expanded and output at the start of every message.
20249 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20250 in which case it is:
20251 .code
20252 message_prefix = "From ${if def:return_path{$return_path}\
20253   {MAILER-DAEMON}} $tod_bsdinbox\n"
20254 .endd
20255 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20256 &`\n`& to &`\r\n`& in &%message_prefix%&.
20257
20258 .option message_suffix appendfile string&!! "see below"
20259 The string specified here is expanded and output at the end of every message.
20260 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20261 in which case it is a single newline character. The suffix can be suppressed by
20262 setting
20263 .code
20264 message_suffix =
20265 .endd
20266 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20267 &`\n`& to &`\r\n`& in &%message_suffix%&.
20268
20269 .option mode appendfile "octal integer" 0600
20270 If the output file is created, it is given this mode. If it already exists and
20271 has wider permissions, they are reduced to this mode. If it has narrower
20272 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20273 if the delivery is the result of a &%save%& command in a filter file specifying
20274 a particular mode, the mode of the output file is always forced to take that
20275 value, and this option is ignored.
20276
20277
20278 .option mode_fail_narrower appendfile boolean true
20279 This option applies in the case when an existing mailbox file has a narrower
20280 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20281 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20282 continues with the delivery attempt, using the existing mode of the file.
20283
20284
20285 .option notify_comsat appendfile boolean false
20286 If this option is true, the &'comsat'& daemon is notified after every
20287 successful delivery to a user mailbox. This is the daemon that notifies logged
20288 on users about incoming mail.
20289
20290
20291 .option quota appendfile string&!! unset
20292 .cindex "quota" "imposed by Exim"
20293 This option imposes a limit on the size of the file to which Exim is appending,
20294 or to the total space used in the directory tree when the &%directory%& option
20295 is set. In the latter case, computation of the space used is expensive, because
20296 all the files in the directory (and any sub-directories) have to be
20297 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20298 &%maildir_use_size_file%& for ways to avoid this in environments where users
20299 have no shell access to their mailboxes).
20300
20301 As there is no interlock against two simultaneous deliveries into a
20302 multi-file mailbox, it is possible for the quota to be overrun in this case.
20303 For single-file mailboxes, of course, an interlock is a necessity.
20304
20305 A file's size is taken as its &'used'& value. Because of blocking effects, this
20306 may be a lot less than the actual amount of disk space allocated to the file.
20307 If the sizes of a number of files are being added up, the rounding effect can
20308 become quite noticeable, especially on systems that have large block sizes.
20309 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20310 the obvious value which users understand most easily.
20311
20312 The value of the option is expanded, and must then be a numerical value
20313 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20314 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20315 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20316 be handled.
20317
20318 &*Note*&: A value of zero is interpreted as &"no quota"&.
20319
20320 The expansion happens while Exim is running as root, before it changes uid for
20321 the delivery. This means that files that are inaccessible to the end user can
20322 be used to hold quota values that are looked up in the expansion. When delivery
20323 fails because this quota is exceeded, the handling of the error is as for
20324 system quota failures.
20325
20326 By default, Exim's quota checking mimics system quotas, and restricts the
20327 mailbox to the specified maximum size, though the value is not accurate to the
20328 last byte, owing to separator lines and additional headers that may get added
20329 during message delivery. When a mailbox is nearly full, large messages may get
20330 refused even though small ones are accepted, because the size of the current
20331 message is added to the quota when the check is made. This behaviour can be
20332 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20333 for exceeding the quota does not include the current message. Thus, deliveries
20334 continue until the quota has been exceeded; thereafter, no further messages are
20335 delivered. See also &%quota_warn_threshold%&.
20336
20337
20338 .option quota_directory appendfile string&!! unset
20339 This option defines the directory to check for quota purposes when delivering
20340 into individual files. The default is the delivery directory, or, if a file
20341 called &_maildirfolder_& exists in a maildir directory, the parent of the
20342 delivery directory.
20343
20344
20345 .option quota_filecount appendfile string&!! 0
20346 This option applies when the &%directory%& option is set. It limits the total
20347 number of files in the directory (compare the inode limit in system quotas). It
20348 can only be used if &%quota%& is also set. The value is expanded; an expansion
20349 failure causes delivery to be deferred. A value of zero is interpreted as
20350 &"no quota"&.
20351
20352
20353 .option quota_is_inclusive appendfile boolean true
20354 See &%quota%& above.
20355
20356
20357 .option quota_size_regex appendfile string unset
20358 This option applies when one of the delivery modes that writes a separate file
20359 for each message is being used. When Exim wants to find the size of one of
20360 these files in order to test the quota, it first checks &%quota_size_regex%&.
20361 If this is set to a regular expression that matches the file name, and it
20362 captures one string, that string is interpreted as a representation of the
20363 file's size. The value of &%quota_size_regex%& is not expanded.
20364
20365 This feature is useful only when users have no shell access to their mailboxes
20366 &-- otherwise they could defeat the quota simply by renaming the files. This
20367 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20368 the file length to the file name. For example:
20369 .code
20370 maildir_tag = ,S=$message_size
20371 quota_size_regex = ,S=(\d+)
20372 .endd
20373 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20374 number of lines in the message.
20375
20376 The regular expression should not assume that the length is at the end of the
20377 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20378 sometimes add other information onto the ends of message file names.
20379
20380 Section &<<SECID136>>& contains further information.
20381
20382
20383 .option quota_warn_message appendfile string&!! "see below"
20384 See below for the use of this option. If it is not set when
20385 &%quota_warn_threshold%& is set, it defaults to
20386 .code
20387 quota_warn_message = "\
20388   To: $local_part@$domain\n\
20389   Subject: Your mailbox\n\n\
20390   This message is automatically created \
20391   by mail delivery software.\n\n\
20392   The size of your mailbox has exceeded \
20393   a warning threshold that is\n\
20394   set by the system administrator.\n"
20395 .endd
20396
20397
20398 .option quota_warn_threshold appendfile string&!! 0
20399 .cindex "quota" "warning threshold"
20400 .cindex "mailbox" "size warning"
20401 .cindex "size" "of mailbox"
20402 This option is expanded in the same way as &%quota%& (see above). If the
20403 resulting value is greater than zero, and delivery of the message causes the
20404 size of the file or total space in the directory tree to cross the given
20405 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20406 may be specified as a percentage of it by following the value with a percent
20407 sign. For example:
20408 .code
20409 quota = 10M
20410 quota_warn_threshold = 75%
20411 .endd
20412 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20413 percent sign is ignored.
20414
20415 The warning message itself is specified by the &%quota_warn_message%& option,
20416 and it must start with a &'To:'& header line containing the recipient(s) of the
20417 warning message. These do not necessarily have to include the recipient(s) of
20418 the original message. A &'Subject:'& line should also normally be supplied. You
20419 can include any other header lines that you want. If you do not include a
20420 &'From:'& line, the default is:
20421 .code
20422 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20423 .endd
20424 .oindex &%errors_reply_to%&
20425 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20426 option.
20427
20428 The &%quota%& option does not have to be set in order to use this option; they
20429 are independent of one another except when the threshold is specified as a
20430 percentage.
20431
20432
20433 .option use_bsmtp appendfile boolean false
20434 .cindex "envelope sender"
20435 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20436 format, with the envelope sender and recipient(s) included as SMTP commands. If
20437 you want to include a leading HELO command with such messages, you can do
20438 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20439 for details of batch SMTP.
20440
20441
20442 .option use_crlf appendfile boolean false
20443 .cindex "carriage return"
20444 .cindex "linefeed"
20445 This option causes lines to be terminated with the two-character CRLF sequence
20446 (carriage return, linefeed) instead of just a linefeed character. In the case
20447 of batched SMTP, the byte sequence written to the file is then an exact image
20448 of what would be sent down a real SMTP connection.
20449
20450 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20451 (which are used to supply the traditional &"From&~"& and blank line separators
20452 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20453 carriage return characters if these are needed. In cases where these options
20454 have non-empty defaults, the values end with a single linefeed, so they must be
20455 changed to end with &`\r\n`& if &%use_crlf%& is set.
20456
20457
20458 .option use_fcntl_lock appendfile boolean "see below"
20459 This option controls the use of the &[fcntl()]& function to lock a file for
20460 exclusive use when a message is being appended. It is set by default unless
20461 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20462 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20463 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20464
20465
20466 .option use_flock_lock appendfile boolean false
20467 This option is provided to support the use of &[flock()]& for file locking, for
20468 the few situations where it is needed. Most modern operating systems support
20469 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20470 each other. Exim uses &[fcntl()]& locking by default.
20471
20472 This option is required only if you are using an operating system where
20473 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20474 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20475 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20476
20477 .cindex "Solaris" "&[flock()]& support"
20478 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20479 have it (and some, I think, provide a not quite right version built on top of
20480 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20481 the ability to use it, and any attempt to do so will cause a configuration
20482 error.
20483
20484 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20485 is just being mapped onto &[fcntl()]& by the OS).
20486
20487
20488 .option use_lockfile appendfile boolean "see below"
20489 If this option is turned off, Exim does not attempt to create a lock file when
20490 appending to a mailbox file. In this situation, the only locking is by
20491 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20492 sure that every MUA that is ever going to look at your users' mailboxes uses
20493 &[fcntl()]& rather than a lock file, and even then only when you are not
20494 delivering over NFS from more than one host.
20495
20496 .cindex "NFS" "lock file"
20497 In order to append to an NFS file safely from more than one host, it is
20498 necessary to take out a lock &'before'& opening the file, and the lock file
20499 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20500 file corruption.
20501
20502 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20503 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20504 except when &%mbx_format%& is set.
20505
20506
20507 .option use_mbx_lock appendfile boolean "see below"
20508 This option is available only if Exim has been compiled with SUPPORT_MBX
20509 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20510 locking rules be used. It is set by default if &%mbx_format%& is set and none
20511 of the locking options are mentioned in the configuration. The locking rules
20512 are the same as are used by the &'c-client'& library that underlies Pine and
20513 the IMAP4 and POP daemons that come with it (see the discussion below). The
20514 rules allow for shared access to the mailbox. However, this kind of locking
20515 does not work when the mailbox is NFS mounted.
20516
20517 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20518 &%use_flock_lock%& to control what kind of locking is used in implementing the
20519 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20520 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20521
20522
20523
20524
20525 .section "Operational details for appending" "SECTopappend"
20526 .cindex "appending to a file"
20527 .cindex "file" "appending"
20528 Before appending to a file, the following preparations are made:
20529
20530 .ilist
20531 If the name of the file is &_/dev/null_&, no action is taken, and a success
20532 return is given.
20533
20534 .next
20535 .cindex "directory creation"
20536 If any directories on the file's path are missing, Exim creates them if the
20537 &%create_directory%& option is set. A created directory's mode is given by the
20538 &%directory_mode%& option.
20539
20540 .next
20541 If &%file_format%& is set, the format of an existing file is checked. If this
20542 indicates that a different transport should be used, control is passed to that
20543 transport.
20544
20545 .next
20546 .cindex "file" "locking"
20547 .cindex "locking files"
20548 .cindex "NFS" "lock file"
20549 If &%use_lockfile%& is set, a lock file is built in a way that will work
20550 reliably over NFS, as follows:
20551
20552 .olist
20553 Create a &"hitching post"& file whose name is that of the lock file with the
20554 current time, primary host name, and process id added, by opening for writing
20555 as a new file. If this fails with an access error, delivery is deferred.
20556 .next
20557 Close the hitching post file, and hard link it to the lock file name.
20558 .next
20559 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20560 Unlink the hitching post name.
20561 .next
20562 Otherwise, use &[stat()]& to get information about the hitching post file, and
20563 then unlink hitching post name. If the number of links is exactly two, creation
20564 of the lock file succeeded but something (for example, an NFS server crash and
20565 restart) caused this fact not to be communicated to the &[link()]& call.
20566 .next
20567 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20568 up to &%lock_retries%& times. However, since any program that writes to a
20569 mailbox should complete its task very quickly, it is reasonable to time out old
20570 lock files that are normally the result of user agent and system crashes. If an
20571 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20572 it before trying again.
20573 .endlist olist
20574
20575 .next
20576 A call is made to &[lstat()]& to discover whether the main file exists, and if
20577 so, what its characteristics are. If &[lstat()]& fails for any reason other
20578 than non-existence, delivery is deferred.
20579
20580 .next
20581 .cindex "symbolic link" "to mailbox"
20582 .cindex "mailbox" "symbolic link"
20583 If the file does exist and is a symbolic link, delivery is deferred, unless the
20584 &%allow_symlink%& option is set, in which case the ownership of the link is
20585 checked, and then &[stat()]& is called to find out about the real file, which
20586 is then subjected to the checks below. The check on the top-level link
20587 ownership prevents one user creating a link for another's mailbox in a sticky
20588 directory, though allowing symbolic links in this case is definitely not a good
20589 idea. If there is a chain of symbolic links, the intermediate ones are not
20590 checked.
20591
20592 .next
20593 If the file already exists but is not a regular file, or if the file's owner
20594 and group (if the group is being checked &-- see &%check_group%& above) are
20595 different from the user and group under which the delivery is running,
20596 delivery is deferred.
20597
20598 .next
20599 If the file's permissions are more generous than specified, they are reduced.
20600 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20601 is set false, in which case the delivery is tried using the existing
20602 permissions.
20603
20604 .next
20605 The file's inode number is saved, and the file is then opened for appending.
20606 If this fails because the file has vanished, &(appendfile)& behaves as if it
20607 hadn't existed (see below). For any other failures, delivery is deferred.
20608
20609 .next
20610 If the file is opened successfully, check that the inode number hasn't
20611 changed, that it is still a regular file, and that the owner and permissions
20612 have not changed. If anything is wrong, defer delivery and freeze the message.
20613
20614 .next
20615 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20616 option is set. Otherwise, check that the file is being created in a permitted
20617 directory if the &%create_file%& option is set (deferring on failure), and then
20618 open for writing as a new file, with the O_EXCL and O_CREAT options,
20619 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20620 set). In this case, which can happen if the link points to a non-existent file,
20621 the file is opened for writing using O_CREAT but not O_EXCL, because
20622 that prevents link following.
20623
20624 .next
20625 .cindex "loop" "while file testing"
20626 If opening fails because the file exists, obey the tests given above for
20627 existing files. However, to avoid looping in a situation where the file is
20628 being continuously created and destroyed, the exists/not-exists loop is broken
20629 after 10 repetitions, and the message is then frozen.
20630
20631 .next
20632 If opening fails with any other error, defer delivery.
20633
20634 .next
20635 .cindex "file" "locking"
20636 .cindex "locking files"
20637 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20638 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20639 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20640 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20641 file, and an exclusive lock on the file whose name is
20642 .code
20643 /tmp/.<device-number>.<inode-number>
20644 .endd
20645 using the device and inode numbers of the open mailbox file, in accordance with
20646 the MBX locking rules. This file is created with a mode that is specified by
20647 the &%lockfile_mode%& option.
20648
20649 If Exim fails to lock the file, there are two possible courses of action,
20650 depending on the value of the locking timeout. This is obtained from
20651 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20652
20653 If the timeout value is zero, the file is closed, Exim waits for
20654 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20655 to lock it again. This happens up to &%lock_retries%& times, after which the
20656 delivery is deferred.
20657
20658 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20659 &[flock()]& are used (with the given timeout), so there has already been some
20660 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20661 immediately. It retries up to
20662 .code
20663 (lock_retries * lock_interval) / <timeout>
20664 .endd
20665 times (rounded up).
20666 .endlist
20667
20668 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20669 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20670
20671
20672 .section "Operational details for delivery to a new file" "SECTopdir"
20673 .cindex "delivery" "to single file"
20674 .cindex "&""From""& line"
20675 When the &%directory%& option is set instead of &%file%&, each message is
20676 delivered into a newly-created file or set of files. When &(appendfile)& is
20677 activated directly from a &(redirect)& router, neither &%file%& nor
20678 &%directory%& is normally set, because the path for delivery is supplied by the
20679 router. (See for example, the &(address_file)& transport in the default
20680 configuration.) In this case, delivery is to a new file if either the path name
20681 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20682
20683 No locking is required while writing the message to a new file, so the various
20684 locking options of the transport are ignored. The &"From"& line that by default
20685 separates messages in a single file is not normally needed, nor is the escaping
20686 of message lines that start with &"From"&, and there is no need to ensure a
20687 newline at the end of each message. Consequently, the default values for
20688 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20689 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20690
20691 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20692 the files in the delivery directory by default. However, you can specify a
20693 different directory by setting &%quota_directory%&. Also, for maildir
20694 deliveries (see below) the &_maildirfolder_& convention is honoured.
20695
20696
20697 .cindex "maildir format"
20698 .cindex "mailstore format"
20699 There are three different ways in which delivery to individual files can be
20700 done, controlled by the settings of the &%maildir_format%& and
20701 &%mailstore_format%& options. Note that code to support maildir or mailstore
20702 formats is not included in the binary unless SUPPORT_MAILDIR or
20703 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20704
20705 .cindex "directory creation"
20706 In all three cases an attempt is made to create the directory and any necessary
20707 sub-directories if they do not exist, provided that the &%create_directory%&
20708 option is set (the default). The location of a created directory can be
20709 constrained by setting &%create_file%&. A created directory's mode is given by
20710 the &%directory_mode%& option. If creation fails, or if the
20711 &%create_directory%& option is not set when creation is required, delivery is
20712 deferred.
20713
20714
20715
20716 .section "Maildir delivery" "SECTmaildirdelivery"
20717 .cindex "maildir format" "description of"
20718 If the &%maildir_format%& option is true, Exim delivers each message by writing
20719 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20720 directory that is defined by the &%directory%& option (the &"delivery
20721 directory"&). If the delivery is successful, the file is renamed into the
20722 &_new_& subdirectory.
20723
20724 In the file name, <&'stime'&> is the current time of day in seconds, and
20725 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20726 Exim checks that the time-of-day clock has moved on by at least one microsecond
20727 before terminating the delivery process. This guarantees uniqueness for the
20728 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20729 opening it. If any response other than ENOENT (does not exist) is given,
20730 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20731
20732 Before Exim carries out a maildir delivery, it ensures that subdirectories
20733 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20734 do not exist, Exim tries to create them and any superior directories in their
20735 path, subject to the &%create_directory%& and &%create_file%& options. If the
20736 &%maildirfolder_create_regex%& option is set, and the regular expression it
20737 contains matches the delivery directory, Exim also ensures that a file called
20738 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20739 &_maildirfolder_& file cannot be created, delivery is deferred.
20740
20741 These features make it possible to use Exim to create all the necessary files
20742 and directories in a maildir mailbox, including subdirectories for maildir++
20743 folders. Consider this example:
20744 .code
20745 maildir_format = true
20746 directory = /var/mail/$local_part\
20747            ${if eq{$local_part_suffix}{}{}\
20748            {/.${substr_1:$local_part_suffix}}}
20749 maildirfolder_create_regex = /\.[^/]+$
20750 .endd
20751 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20752 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20753 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20754 not match this name, so Exim will not look for or create the file
20755 &_/var/mail/pimbo/maildirfolder_&, though it will create
20756 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20757
20758 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20759 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20760 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20761 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20762 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20763
20764 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20765 not inadvertently match the toplevel maildir directory, because a
20766 &_maildirfolder_& file at top level would completely break quota calculations.
20767
20768 .cindex "quota" "in maildir delivery"
20769 .cindex "maildir++"
20770 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20771 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20772 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20773 Exim assumes the directory is a maildir++ folder directory, which is one level
20774 down from the user's top level mailbox directory. This causes it to start at
20775 the parent directory instead of the current directory when calculating the
20776 amount of space used.
20777
20778 One problem with delivering into a multi-file mailbox is that it is
20779 computationally expensive to compute the size of the mailbox for quota
20780 checking. Various approaches have been taken to reduce the amount of work
20781 needed. The next two sections describe two of them. A third alternative is to
20782 use some external process for maintaining the size data, and use the expansion
20783 of the &%mailbox_size%& option as a way of importing it into Exim.
20784
20785
20786
20787
20788 .section "Using tags to record message sizes" "SECID135"
20789 If &%maildir_tag%& is set, the string is expanded for each delivery.
20790 When the maildir file is renamed into the &_new_& sub-directory, the
20791 tag is added to its name. However, if adding the tag takes the length of the
20792 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20793 the tag is dropped and the maildir file is created with no tag.
20794
20795
20796 .vindex "&$message_size$&"
20797 Tags can be used to encode the size of files in their names; see
20798 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20799 happens after the message has been written. The value of the &$message_size$&
20800 variable is set to the number of bytes actually written. If the expansion is
20801 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20802 be deferred. The expanded tag may contain any printing characters except &"/"&.
20803 Non-printing characters in the string are ignored; if the resulting string is
20804 empty, it is ignored. If it starts with an alphanumeric character, a leading
20805 colon is inserted; this default has not proven to be the path that popular
20806 maildir implementations have chosen (but changing it in Exim would break
20807 backwards compatibility).
20808
20809 For one common implementation, you might set:
20810 .code
20811 maildir_tag = ,S=${message_size}
20812 .endd
20813 but you should check the documentation of the other software to be sure.
20814
20815 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
20816 as this allows Exim to extract the size from your tag, instead of having to
20817 &[stat()]& each message file.
20818
20819
20820 .section "Using a maildirsize file" "SECID136"
20821 .cindex "quota" "in maildir delivery"
20822 .cindex "maildir format" "&_maildirsize_& file"
20823 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20824 storing quota and message size information in a file called &_maildirsize_&
20825 within the toplevel maildir directory. If this file does not exist, Exim
20826 creates it, setting the quota from the &%quota%& option of the transport. If
20827 the maildir directory itself does not exist, it is created before any attempt
20828 to write a &_maildirsize_& file.
20829
20830 The &_maildirsize_& file is used to hold information about the sizes of
20831 messages in the maildir, thus speeding up quota calculations. The quota value
20832 in the file is just a cache; if the quota is changed in the transport, the new
20833 value overrides the cached value when the next message is delivered. The cache
20834 is maintained for the benefit of other programs that access the maildir and
20835 need to know the quota.
20836
20837 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20838 file is maintained (with a zero quota setting), but no quota is imposed.
20839
20840 A regular expression is available for controlling which directories in the
20841 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20842 See the description of the &%maildir_quota_directory_regex%& option above for
20843 details.
20844
20845
20846 .section "Mailstore delivery" "SECID137"
20847 .cindex "mailstore format" "description of"
20848 If the &%mailstore_format%& option is true, each message is written as two
20849 files in the given directory. A unique base name is constructed from the
20850 message id and the current delivery process, and the files that are written use
20851 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20852 contains the message's envelope, and the &_.msg_& file contains the message
20853 itself. The base name is placed in the variable &$mailstore_basename$&.
20854
20855 During delivery, the envelope is first written to a file with the suffix
20856 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20857 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20858 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20859 file before accessing either of them. An alternative approach is to wait for
20860 the absence of a &_.tmp_& file.
20861
20862 The envelope file starts with any text defined by the &%mailstore_prefix%&
20863 option, expanded and terminated by a newline if there isn't one. Then follows
20864 the sender address on one line, then all the recipient addresses, one per line.
20865 There can be more than one recipient only if the &%batch_max%& option is set
20866 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20867 appended to the file, followed by a newline if it does not end with one.
20868
20869 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20870 failure, it is ignored. Other expansion errors are treated as serious
20871 configuration errors, and delivery is deferred. The variable
20872 &$mailstore_basename$& is available for use during these expansions.
20873
20874
20875 .section "Non-special new file delivery" "SECID138"
20876 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20877 file is created directly in the named directory. For example, when delivering
20878 messages into files in batched SMTP format for later delivery to some host (see
20879 section &<<SECTbatchSMTP>>&), a setting such as
20880 .code
20881 directory = /var/bsmtp/$host
20882 .endd
20883 might be used. A message is written to a file with a temporary name, which is
20884 then renamed when the delivery is complete. The final name is obtained by
20885 expanding the contents of the &%directory_file%& option.
20886 .ecindex IIDapptra1
20887 .ecindex IIDapptra2
20888
20889
20890
20891
20892
20893
20894 . ////////////////////////////////////////////////////////////////////////////
20895 . ////////////////////////////////////////////////////////////////////////////
20896
20897 .chapter "The autoreply transport" "CHID8"
20898 .scindex IIDauttra1 "transports" "&(autoreply)&"
20899 .scindex IIDauttra2 "&(autoreply)& transport"
20900 The &(autoreply)& transport is not a true transport in that it does not cause
20901 the message to be transmitted. Instead, it generates a new mail message as an
20902 automatic reply to the incoming message. &'References:'& and
20903 &'Auto-Submitted:'& header lines are included. These are constructed according
20904 to the rules in RFCs 2822 and 3834, respectively.
20905
20906 If the router that passes the message to this transport does not have the
20907 &%unseen%& option set, the original message (for the current recipient) is not
20908 delivered anywhere. However, when the &%unseen%& option is set on the router
20909 that passes the message to this transport, routing of the address continues, so
20910 another router can set up a normal message delivery.
20911
20912
20913 The &(autoreply)& transport is usually run as the result of mail filtering, a
20914 &"vacation"& message being the standard example. However, it can also be run
20915 directly from a router like any other transport. To reduce the possibility of
20916 message cascades, messages created by the &(autoreply)& transport always have
20917 empty envelope sender addresses, like bounce messages.
20918
20919 The parameters of the message to be sent can be specified in the configuration
20920 by options described below. However, these are used only when the address
20921 passed to the transport does not contain its own reply information. When the
20922 transport is run as a consequence of a
20923 &%mail%&
20924 or &%vacation%& command in a filter file, the parameters of the message are
20925 supplied by the filter, and passed with the address. The transport's options
20926 that define the message are then ignored (so they are not usually set in this
20927 case). The message is specified entirely by the filter or by the transport; it
20928 is never built from a mixture of options. However, the &%file_optional%&,
20929 &%mode%&, and &%return_message%& options apply in all cases.
20930
20931 &(Autoreply)& is implemented as a local transport. When used as a result of a
20932 command in a user's filter file, &(autoreply)& normally runs under the uid and
20933 gid of the user, and with appropriate current and home directories (see chapter
20934 &<<CHAPenvironment>>&).
20935
20936 There is a subtle difference between routing a message to a &(pipe)& transport
20937 that generates some text to be returned to the sender, and routing it to an
20938 &(autoreply)& transport. This difference is noticeable only if more than one
20939 address from the same message is so handled. In the case of a pipe, the
20940 separate outputs from the different addresses are gathered up and returned to
20941 the sender in a single message, whereas if &(autoreply)& is used, a separate
20942 message is generated for each address that is passed to it.
20943
20944 Non-printing characters are not permitted in the header lines generated for the
20945 message that &(autoreply)& creates, with the exception of newlines that are
20946 immediately followed by white space. If any non-printing characters are found,
20947 the transport defers.
20948 Whether characters with the top bit set count as printing characters or not is
20949 controlled by the &%print_topbitchars%& global option.
20950
20951 If any of the generic options for manipulating headers (for example,
20952 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20953 of the original message that is included in the generated message when
20954 &%return_message%& is set. They do not apply to the generated message itself.
20955
20956 .vindex "&$sender_address$&"
20957 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20958 the message, indicating that there were no recipients, it does not treat this
20959 as an error. This means that autoreplies sent to &$sender_address$& when this
20960 is empty (because the incoming message is a bounce message) do not cause
20961 problems. They are just discarded.
20962
20963
20964
20965 .section "Private options for autoreply" "SECID139"
20966 .cindex "options" "&(autoreply)& transport"
20967
20968 .option bcc autoreply string&!! unset
20969 This specifies the addresses that are to receive &"blind carbon copies"& of the
20970 message when the message is specified by the transport.
20971
20972
20973 .option cc autoreply string&!! unset
20974 This specifies recipients of the message and the contents of the &'Cc:'& header
20975 when the message is specified by the transport.
20976
20977
20978 .option file autoreply string&!! unset
20979 The contents of the file are sent as the body of the message when the message
20980 is specified by the transport. If both &%file%& and &%text%& are set, the text
20981 string comes first.
20982
20983
20984 .option file_expand autoreply boolean false
20985 If this is set, the contents of the file named by the &%file%& option are
20986 subjected to string expansion as they are added to the message.
20987
20988
20989 .option file_optional autoreply boolean false
20990 If this option is true, no error is generated if the file named by the &%file%&
20991 option or passed with the address does not exist or cannot be read.
20992
20993
20994 .option from autoreply string&!! unset
20995 This specifies the contents of the &'From:'& header when the message is
20996 specified by the transport.
20997
20998
20999 .option headers autoreply string&!! unset
21000 This specifies additional RFC 2822 headers that are to be added to the message
21001 when the message is specified by the transport. Several can be given by using
21002 &"\n"& to separate them. There is no check on the format.
21003
21004
21005 .option log autoreply string&!! unset
21006 This option names a file in which a record of every message sent is logged when
21007 the message is specified by the transport.
21008
21009
21010 .option mode autoreply "octal integer" 0600
21011 If either the log file or the &"once"& file has to be created, this mode is
21012 used.
21013
21014
21015 .option never_mail autoreply "address list&!!" unset
21016 If any run of the transport creates a message with a recipient that matches any
21017 item in the list, that recipient is quietly discarded. If all recipients are
21018 discarded, no message is created. This applies both when the recipients are
21019 generated by a filter and when they are specified in the transport.
21020
21021
21022
21023 .option once autoreply string&!! unset
21024 This option names a file or DBM database in which a record of each &'To:'&
21025 recipient is kept when the message is specified by the transport. &*Note*&:
21026 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21027
21028 If &%once%& is unset, or is set to an empty string, the message is always sent.
21029 By default, if &%once%& is set to a non-empty file name, the message
21030 is not sent if a potential recipient is already listed in the database.
21031 However, if the &%once_repeat%& option specifies a time greater than zero, the
21032 message is sent if that much time has elapsed since a message was last sent to
21033 this recipient. A setting of zero time for &%once_repeat%& (the default)
21034 prevents a message from being sent a second time &-- in this case, zero means
21035 infinity.
21036
21037 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21038 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21039 greater than zero, it changes the way Exim implements the &%once%& option.
21040 Instead of using a DBM file to record every recipient it sends to, it uses a
21041 regular file, whose size will never get larger than the given value.
21042
21043 In the file, Exim keeps a linear list of recipient addresses and the times at
21044 which they were sent messages. If the file is full when a new address needs to
21045 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21046 means that a given recipient may receive multiple messages, but at
21047 unpredictable intervals that depend on the rate of turnover of addresses in the
21048 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21049
21050
21051 .option once_file_size autoreply integer 0
21052 See &%once%& above.
21053
21054
21055 .option once_repeat autoreply time&!! 0s
21056 See &%once%& above.
21057 After expansion, the value of this option must be a valid time value.
21058
21059
21060 .option reply_to autoreply string&!! unset
21061 This specifies the contents of the &'Reply-To:'& header when the message is
21062 specified by the transport.
21063
21064
21065 .option return_message autoreply boolean false
21066 If this is set, a copy of the original message is returned with the new
21067 message, subject to the maximum size set in the &%return_size_limit%& global
21068 configuration option.
21069
21070
21071 .option subject autoreply string&!! unset
21072 This specifies the contents of the &'Subject:'& header when the message is
21073 specified by the transport. It is tempting to quote the original subject in
21074 automatic responses. For example:
21075 .code
21076 subject = Re: $h_subject:
21077 .endd
21078 There is a danger in doing this, however. It may allow a third party to
21079 subscribe your users to an opt-in mailing list, provided that the list accepts
21080 bounce messages as subscription confirmations. Well-managed lists require a
21081 non-bounce message to confirm a subscription, so the danger is relatively
21082 small.
21083
21084
21085
21086 .option text autoreply string&!! unset
21087 This specifies a single string to be used as the body of the message when the
21088 message is specified by the transport. If both &%text%& and &%file%& are set,
21089 the text comes first.
21090
21091
21092 .option to autoreply string&!! unset
21093 This specifies recipients of the message and the contents of the &'To:'& header
21094 when the message is specified by the transport.
21095 .ecindex IIDauttra1
21096 .ecindex IIDauttra2
21097
21098
21099
21100
21101 . ////////////////////////////////////////////////////////////////////////////
21102 . ////////////////////////////////////////////////////////////////////////////
21103
21104 .chapter "The lmtp transport" "CHAPLMTP"
21105 .cindex "transports" "&(lmtp)&"
21106 .cindex "&(lmtp)& transport"
21107 .cindex "LMTP" "over a pipe"
21108 .cindex "LMTP" "over a socket"
21109 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21110 specified command
21111 or by interacting with a Unix domain socket.
21112 This transport is something of a cross between the &(pipe)& and &(smtp)&
21113 transports. Exim also has support for using LMTP over TCP/IP; this is
21114 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21115 to be of minority interest, the default build-time configure in &_src/EDITME_&
21116 has it commented out. You need to ensure that
21117 .code
21118 TRANSPORT_LMTP=yes
21119 .endd
21120 .cindex "options" "&(lmtp)& transport"
21121 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21122 included in the Exim binary. The private options of the &(lmtp)& transport are
21123 as follows:
21124
21125 .option batch_id lmtp string&!! unset
21126 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21127
21128
21129 .option batch_max lmtp integer 1
21130 This limits the number of addresses that can be handled in a single delivery.
21131 Most LMTP servers can handle several addresses at once, so it is normally a
21132 good idea to increase this value. See the description of local delivery
21133 batching in chapter &<<CHAPbatching>>&.
21134
21135
21136 .option command lmtp string&!! unset
21137 This option must be set if &%socket%& is not set. The string is a command which
21138 is run in a separate process. It is split up into a command name and list of
21139 arguments, each of which is separately expanded (so expansion cannot change the
21140 number of arguments). The command is run directly, not via a shell. The message
21141 is passed to the new process using the standard input and output to operate the
21142 LMTP protocol.
21143
21144 .option ignore_quota lmtp boolean false
21145 .cindex "LMTP" "ignoring quota errors"
21146 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21147 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21148 in its response to the LHLO command.
21149
21150 .option socket lmtp string&!! unset
21151 This option must be set if &%command%& is not set. The result of expansion must
21152 be the name of a Unix domain socket. The transport connects to the socket and
21153 delivers the message to it using the LMTP protocol.
21154
21155
21156 .option timeout lmtp time 5m
21157 The transport is aborted if the created process or Unix domain socket does not
21158 respond to LMTP commands or message input within this timeout. Delivery
21159 is deferred, and will be tried again later. Here is an example of a typical
21160 LMTP transport:
21161 .code
21162 lmtp:
21163   driver = lmtp
21164   command = /some/local/lmtp/delivery/program
21165   batch_max = 20
21166   user = exim
21167 .endd
21168 This delivers up to 20 addresses at a time, in a mixture of domains if
21169 necessary, running as the user &'exim'&.
21170
21171
21172
21173 . ////////////////////////////////////////////////////////////////////////////
21174 . ////////////////////////////////////////////////////////////////////////////
21175
21176 .chapter "The pipe transport" "CHAPpipetransport"
21177 .scindex IIDpiptra1 "transports" "&(pipe)&"
21178 .scindex IIDpiptra2 "&(pipe)& transport"
21179 The &(pipe)& transport is used to deliver messages via a pipe to a command
21180 running in another process. One example is the use of &(pipe)& as a
21181 pseudo-remote transport for passing messages to some other delivery mechanism
21182 (such as UUCP). Another is the use by individual users to automatically process
21183 their incoming messages. The &(pipe)& transport can be used in one of the
21184 following ways:
21185
21186 .ilist
21187 .vindex "&$local_part$&"
21188 A router routes one address to a transport in the normal way, and the
21189 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21190 contains the local part of the address (as usual), and the command that is run
21191 is specified by the &%command%& option on the transport.
21192 .next
21193 .vindex "&$pipe_addresses$&"
21194 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21195 transport can handle more than one address in a single run. In this case, when
21196 more than one address is routed to the transport, &$local_part$& is not set
21197 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21198 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21199 that are routed to the transport.
21200 .next
21201 .vindex "&$address_pipe$&"
21202 A router redirects an address directly to a pipe command (for example, from an
21203 alias or forward file). In this case, &$address_pipe$& contains the text of the
21204 pipe command, and the &%command%& option on the transport is ignored. If only
21205 one address is being transported (&%batch_max%& is not greater than one, or
21206 only one address was redirected to this pipe command), &$local_part$& contains
21207 the local part that was redirected.
21208 .endlist
21209
21210
21211 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21212 deliver messages over pipes using the LMTP interactive protocol. This is
21213 implemented by the &(lmtp)& transport.
21214
21215 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21216 &_.forward_& file, the command runs under the uid and gid of that user. In
21217 other cases, the uid and gid have to be specified explicitly, either on the
21218 transport or on the router that handles the address. Current and &"home"&
21219 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21220 details of the local delivery environment and chapter &<<CHAPbatching>>&
21221 for a discussion of local delivery batching.
21222
21223
21224 .section "Concurrent delivery" "SECID140"
21225 If two messages arrive at almost the same time, and both are routed to a pipe
21226 delivery, the two pipe transports may be run concurrently. You must ensure that
21227 any pipe commands you set up are robust against this happening. If the commands
21228 write to a file, the &%exim_lock%& utility might be of use.
21229
21230
21231
21232
21233 .section "Returned status and data" "SECID141"
21234 .cindex "&(pipe)& transport" "returned data"
21235 If the command exits with a non-zero return code, the delivery is deemed to
21236 have failed, unless either the &%ignore_status%& option is set (in which case
21237 the return code is treated as zero), or the return code is one of those listed
21238 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21239 later"&. In this case, delivery is deferred. Details of a permanent failure are
21240 logged, but are not included in the bounce message, which merely contains
21241 &"local delivery failed"&.
21242
21243 If the command exits on a signal and the &%freeze_signal%& option is set then
21244 the message will be frozen in the queue. If that option is not set, a bounce
21245 will be sent as normal.
21246
21247 If the return code is greater than 128 and the command being run is a shell
21248 script, it normally means that the script was terminated by a signal whose
21249 value is the return code minus 128. The &%freeze_signal%& option does not
21250 apply in this case.
21251
21252 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21253 return code is set to 127. This is the value that a shell returns if it is
21254 asked to run a non-existent command. The wording for the log line suggests that
21255 a non-existent command may be the problem.
21256
21257 The &%return_output%& option can affect the result of a pipe delivery. If it is
21258 set and the command produces any output on its standard output or standard
21259 error streams, the command is considered to have failed, even if it gave a zero
21260 return code or if &%ignore_status%& is set. The output from the command is
21261 included as part of the bounce message. The &%return_fail_output%& option is
21262 similar, except that output is returned only when the command exits with a
21263 failure return code, that is, a value other than zero or a code that matches
21264 &%temp_errors%&.
21265
21266
21267
21268 .section "How the command is run" "SECThowcommandrun"
21269 .cindex "&(pipe)& transport" "path for command"
21270 The command line is (by default) broken down into a command name and arguments
21271 by the &(pipe)& transport itself. The &%allow_commands%& and
21272 &%restrict_to_path%& options can be used to restrict the commands that may be
21273 run.
21274
21275 .cindex "quoting" "in pipe command"
21276 Unquoted arguments are delimited by white space. If an argument appears in
21277 double quotes, backslash is interpreted as an escape character in the usual
21278 way. If an argument appears in single quotes, no escaping is done.
21279
21280 String expansion is applied to the command line except when it comes from a
21281 traditional &_.forward_& file (commands from a filter file are expanded). The
21282 expansion is applied to each argument in turn rather than to the whole line.
21283 For this reason, any string expansion item that contains white space must be
21284 quoted so as to be contained within a single argument. A setting such as
21285 .code
21286 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21287 .endd
21288 will not work, because the expansion item gets split between several
21289 arguments. You have to write
21290 .code
21291 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21292 .endd
21293 to ensure that it is all in one argument. The expansion is done in this way,
21294 argument by argument, so that the number of arguments cannot be changed as a
21295 result of expansion, and quotes or backslashes in inserted variables do not
21296 interact with external quoting. However, this leads to problems if you want to
21297 generate multiple arguments (or the command name plus arguments) from a single
21298 expansion. In this situation, the simplest solution is to use a shell. For
21299 example:
21300 .code
21301 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21302 .endd
21303
21304 .cindex "transport" "filter"
21305 .cindex "filter" "transport filter"
21306 .vindex "&$pipe_addresses$&"
21307 Special handling takes place when an argument consists of precisely the text
21308 &`$pipe_addresses`&. This is not a general expansion variable; the only
21309 place this string is recognized is when it appears as an argument for a pipe or
21310 transport filter command. It causes each address that is being handled to be
21311 inserted in the argument list at that point &'as a separate argument'&. This
21312 avoids any problems with spaces or shell metacharacters, and is of use when a
21313 &(pipe)& transport is handling groups of addresses in a batch.
21314
21315 After splitting up into arguments and expansion, the resulting command is run
21316 in a subprocess directly from the transport, &'not'& under a shell. The
21317 message that is being delivered is supplied on the standard input, and the
21318 standard output and standard error are both connected to a single pipe that is
21319 read by Exim. The &%max_output%& option controls how much output the command
21320 may produce, and the &%return_output%& and &%return_fail_output%& options
21321 control what is done with it.
21322
21323 Not running the command under a shell (by default) lessens the security risks
21324 in cases when a command from a user's filter file is built out of data that was
21325 taken from an incoming message. If a shell is required, it can of course be
21326 explicitly specified as the command to be run. However, there are circumstances
21327 where existing commands (for example, in &_.forward_& files) expect to be run
21328 under a shell and cannot easily be modified. To allow for these cases, there is
21329 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21330 works. Instead of breaking up the command line as just described, it expands it
21331 as a single string and passes the result to &_/bin/sh_&. The
21332 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21333 with &%use_shell%&, and the whole mechanism is inherently less secure.
21334
21335
21336
21337 .section "Environment variables" "SECTpipeenv"
21338 .cindex "&(pipe)& transport" "environment for command"
21339 .cindex "environment for pipe transport"
21340 The environment variables listed below are set up when the command is invoked.
21341 This list is a compromise for maximum compatibility with other MTAs. Note that
21342 the &%environment%& option can be used to add additional variables to this
21343 environment.
21344 .display
21345 &`DOMAIN            `&   the domain of the address
21346 &`HOME              `&   the home directory, if set
21347 &`HOST              `&   the host name when called from a router (see below)
21348 &`LOCAL_PART        `&   see below
21349 &`LOCAL_PART_PREFIX `&   see below
21350 &`LOCAL_PART_SUFFIX `&   see below
21351 &`LOGNAME           `&   see below
21352 &`MESSAGE_ID        `&   Exim's local ID for the message
21353 &`PATH              `&   as specified by the &%path%& option below
21354 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21355 &`RECIPIENT         `&   the complete recipient address
21356 &`SENDER            `&   the sender of the message (empty if a bounce)
21357 &`SHELL             `&   &`/bin/sh`&
21358 &`TZ                `&   the value of the &%timezone%& option, if set
21359 &`USER              `&   see below
21360 .endd
21361 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21362 router, LOCAL_PART is set to the local part of the address. When it is
21363 called as a result of a forward or alias expansion, LOCAL_PART is set to
21364 the local part of the address that was expanded. In both cases, any affixes are
21365 removed from the local part, and made available in LOCAL_PART_PREFIX and
21366 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21367 same value as LOCAL_PART for compatibility with other MTAs.
21368
21369 .cindex "HOST"
21370 HOST is set only when a &(pipe)& transport is called from a router that
21371 associates hosts with an address, typically when using &(pipe)& as a
21372 pseudo-remote transport. HOST is set to the first host name specified by
21373 the router.
21374
21375 .cindex "HOME"
21376 If the transport's generic &%home_directory%& option is set, its value is used
21377 for the HOME environment variable. Otherwise, a home directory may be set
21378 by the router's &%transport_home_directory%& option, which defaults to the
21379 user's home directory if &%check_local_user%& is set.
21380
21381
21382 .section "Private options for pipe" "SECID142"
21383 .cindex "options" "&(pipe)& transport"
21384
21385
21386
21387 .option allow_commands pipe "string list&!!" unset
21388 .cindex "&(pipe)& transport" "permitted commands"
21389 The string is expanded, and is then interpreted as a colon-separated list of
21390 permitted commands. If &%restrict_to_path%& is not set, the only commands
21391 permitted are those in the &%allow_commands%& list. They need not be absolute
21392 paths; the &%path%& option is still used for relative paths. If
21393 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21394 in the &%allow_commands%& list, or a name without any slashes that is found on
21395 the path. In other words, if neither &%allow_commands%& nor
21396 &%restrict_to_path%& is set, there is no restriction on the command, but
21397 otherwise only commands that are permitted by one or the other are allowed. For
21398 example, if
21399 .code
21400 allow_commands = /usr/bin/vacation
21401 .endd
21402 and &%restrict_to_path%& is not set, the only permitted command is
21403 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21404 &%use_shell%& is set.
21405
21406
21407 .option batch_id pipe string&!! unset
21408 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21409
21410
21411 .option batch_max pipe integer 1
21412 This limits the number of addresses that can be handled in a single delivery.
21413 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21414
21415
21416 .option check_string pipe string unset
21417 As &(pipe)& writes the message, the start of each line is tested for matching
21418 &%check_string%&, and if it does, the initial matching characters are replaced
21419 by the contents of &%escape_string%&, provided both are set. The value of
21420 &%check_string%& is a literal string, not a regular expression, and the case of
21421 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21422 of &%check_string%& and &%escape_string%& are forced to values that implement
21423 the SMTP escaping protocol. Any settings made in the configuration file are
21424 ignored.
21425
21426
21427 .option command pipe string&!! unset
21428 This option need not be set when &(pipe)& is being used to deliver to pipes
21429 obtained directly from address redirections. In other cases, the option must be
21430 set, to provide a command to be run. It need not yield an absolute path (see
21431 the &%path%& option below). The command is split up into separate arguments by
21432 Exim, and each argument is separately expanded, as described in section
21433 &<<SECThowcommandrun>>& above.
21434
21435
21436 .option environment pipe string&!! unset
21437 .cindex "&(pipe)& transport" "environment for command"
21438 .cindex "environment for &(pipe)& transport"
21439 This option is used to add additional variables to the environment in which the
21440 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21441 a string which is expanded, and then interpreted as a colon-separated list of
21442 environment settings of the form <&'name'&>=<&'value'&>.
21443
21444
21445 .option escape_string pipe string unset
21446 See &%check_string%& above.
21447
21448
21449 .option freeze_exec_fail pipe boolean false
21450 .cindex "exec failure"
21451 .cindex "failure of exec"
21452 .cindex "&(pipe)& transport" "failure of exec"
21453 Failure to exec the command in a pipe transport is by default treated like
21454 any other failure while running the command. However, if &%freeze_exec_fail%&
21455 is set, failure to exec is treated specially, and causes the message to be
21456 frozen, whatever the setting of &%ignore_status%&.
21457
21458
21459 .option freeze_signal pipe boolean false
21460 .cindex "signal exit"
21461 .cindex "&(pipe)& transport", "signal exit"
21462 Normally if the process run by a command in a pipe transport exits on a signal,
21463 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21464 frozen in Exim's queue instead.
21465
21466
21467 .option ignore_status pipe boolean false
21468 If this option is true, the status returned by the subprocess that is set up to
21469 run the command is ignored, and Exim behaves as if zero had been returned.
21470 Otherwise, a non-zero status or termination by signal causes an error return
21471 from the transport unless the status value is one of those listed in
21472 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21473
21474 &*Note*&: This option does not apply to timeouts, which do not return a status.
21475 See the &%timeout_defer%& option for how timeouts are handled.
21476
21477 .option log_defer_output pipe boolean false
21478 .cindex "&(pipe)& transport" "logging output"
21479 If this option is set, and the status returned by the command is
21480 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21481 and any output was produced, the first line of it is written to the main log.
21482
21483
21484 .option log_fail_output pipe boolean false
21485 If this option is set, and the command returns any output, and also ends with a
21486 return code that is neither zero nor one of the return codes listed in
21487 &%temp_errors%& (that is, the delivery failed), the first line of output is
21488 written to the main log. This option and &%log_output%& are mutually exclusive.
21489 Only one of them may be set.
21490
21491
21492
21493 .option log_output pipe boolean false
21494 If this option is set and the command returns any output, the first line of
21495 output is written to the main log, whatever the return code. This option and
21496 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21497
21498
21499
21500 .option max_output pipe integer 20K
21501 This specifies the maximum amount of output that the command may produce on its
21502 standard output and standard error file combined. If the limit is exceeded, the
21503 process running the command is killed. This is intended as a safety measure to
21504 catch runaway processes. The limit is applied independently of the settings of
21505 the options that control what is done with such output (for example,
21506 &%return_output%&). Because of buffering effects, the amount of output may
21507 exceed the limit by a small amount before Exim notices.
21508
21509
21510 .option message_prefix pipe string&!! "see below"
21511 The string specified here is expanded and output at the start of every message.
21512 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21513 .code
21514 message_prefix = \
21515   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21516   ${tod_bsdinbox}\n
21517 .endd
21518 .cindex "Cyrus"
21519 .cindex "&%tmail%&"
21520 .cindex "&""From""& line"
21521 This is required by the commonly used &_/usr/bin/vacation_& program.
21522 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21523 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21524 setting
21525 .code
21526 message_prefix =
21527 .endd
21528 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21529 &`\n`& to &`\r\n`& in &%message_prefix%&.
21530
21531
21532 .option message_suffix pipe string&!! "see below"
21533 The string specified here is expanded and output at the end of every message.
21534 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21535 The suffix can be suppressed by setting
21536 .code
21537 message_suffix =
21538 .endd
21539 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21540 &`\n`& to &`\r\n`& in &%message_suffix%&.
21541
21542
21543 .option path pipe string "see below"
21544 This option specifies the string that is set up in the PATH environment
21545 variable of the subprocess. The default is:
21546 .code
21547 /bin:/usr/bin
21548 .endd
21549 If the &%command%& option does not yield an absolute path name, the command is
21550 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21551 apply to a command specified as a transport filter.
21552
21553
21554 .option permit_coredump pipe boolean false
21555 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21556 a core-dump of a pipe command, enable this command.  This enables core-dumps
21557 during delivery and affects both the Exim binary and the pipe command run.
21558 It is recommended that this option remain off unless and until you have a need
21559 for it and that this only be enabled when needed, as the risk of excessive
21560 resource consumption can be quite high.  Note also that Exim is typically
21561 installed as a setuid binary and most operating systems will inhibit coredumps
21562 of these by default, so further OS-specific action may be required.
21563
21564
21565 .option pipe_as_creator pipe boolean false
21566 .cindex "uid (user id)" "local delivery"
21567 If the generic &%user%& option is not set and this option is true, the delivery
21568 process is run under the uid that was in force when Exim was originally called
21569 to accept the message. If the group id is not otherwise set (via the generic
21570 &%group%& option), the gid that was in force when Exim was originally called to
21571 accept the message is used.
21572
21573
21574 .option restrict_to_path pipe boolean false
21575 When this option is set, any command name not listed in &%allow_commands%& must
21576 contain no slashes. The command is searched for only in the directories listed
21577 in the &%path%& option. This option is intended for use in the case when a pipe
21578 command has been generated from a user's &_.forward_& file. This is usually
21579 handled by a &(pipe)& transport called &%address_pipe%&.
21580
21581
21582 .option return_fail_output pipe boolean false
21583 If this option is true, and the command produced any output and ended with a
21584 return code other than zero or one of the codes listed in &%temp_errors%& (that
21585 is, the delivery failed), the output is returned in the bounce message.
21586 However, if the message has a null sender (that is, it is itself a bounce
21587 message), output from the command is discarded. This option and
21588 &%return_output%& are mutually exclusive. Only one of them may be set.
21589
21590
21591
21592 .option return_output pipe boolean false
21593 If this option is true, and the command produced any output, the delivery is
21594 deemed to have failed whatever the return code from the command, and the output
21595 is returned in the bounce message. Otherwise, the output is just discarded.
21596 However, if the message has a null sender (that is, it is a bounce message),
21597 output from the command is always discarded, whatever the setting of this
21598 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21599 of them may be set.
21600
21601
21602
21603 .option temp_errors pipe "string list" "see below"
21604 .cindex "&(pipe)& transport" "temporary failure"
21605 This option contains either a colon-separated list of numbers, or a single
21606 asterisk. If &%ignore_status%& is false
21607 and &%return_output%& is not set,
21608 and the command exits with a non-zero return code, the failure is treated as
21609 temporary and the delivery is deferred if the return code matches one of the
21610 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21611 codes are treated as permanent errors. The default setting contains the codes
21612 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21613 compiled on a system that does not define these macros, it assumes values of 75
21614 and 73, respectively.
21615
21616
21617 .option timeout pipe time 1h
21618 If the command fails to complete within this time, it is killed. This normally
21619 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21620 specifies no timeout. In order to ensure that any subprocesses created by the
21621 command are also killed, Exim makes the initial process a process group leader,
21622 and kills the whole process group on a timeout. However, this can be defeated
21623 if one of the processes starts a new process group.
21624
21625 .option timeout_defer pipe boolean false
21626 A timeout in a &(pipe)& transport, either in the command that the transport
21627 runs, or in a transport filter that is associated with it, is by default
21628 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21629 is set true, both kinds of timeout become temporary errors, causing the
21630 delivery to be deferred.
21631
21632 .option umask pipe "octal integer" 022
21633 This specifies the umask setting for the subprocess that runs the command.
21634
21635
21636 .option use_bsmtp pipe boolean false
21637 .cindex "envelope sender"
21638 If this option is set true, the &(pipe)& transport writes messages in &"batch
21639 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21640 commands. If you want to include a leading HELO command with such messages,
21641 you can do so by setting the &%message_prefix%& option. See section
21642 &<<SECTbatchSMTP>>& for details of batch SMTP.
21643
21644 .option use_classresources pipe boolean false
21645 .cindex "class resources (BSD)"
21646 This option is available only when Exim is running on FreeBSD, NetBSD, or
21647 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21648 resource limits when a &(pipe)& transport is run to perform a delivery. The
21649 limits for the uid under which the pipe is to run are obtained from the login
21650 class database.
21651
21652
21653 .option use_crlf pipe boolean false
21654 .cindex "carriage return"
21655 .cindex "linefeed"
21656 This option causes lines to be terminated with the two-character CRLF sequence
21657 (carriage return, linefeed) instead of just a linefeed character. In the case
21658 of batched SMTP, the byte sequence written to the pipe is then an exact image
21659 of what would be sent down a real SMTP connection.
21660
21661 The contents of the &%message_prefix%& and &%message_suffix%& options are
21662 written verbatim, so must contain their own carriage return characters if these
21663 are needed. When &%use_bsmtp%& is not set, the default values for both
21664 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21665 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21666
21667
21668 .option use_shell pipe boolean false
21669 .vindex "&$pipe_addresses$&"
21670 If this option is set, it causes the command to be passed to &_/bin/sh_&
21671 instead of being run directly from the transport, as described in section
21672 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21673 where the command is expected to be run under a shell and cannot easily be
21674 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21675 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21676 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21677 its &%-c%& option.
21678
21679
21680
21681 .section "Using an external local delivery agent" "SECID143"
21682 .cindex "local delivery" "using an external agent"
21683 .cindex "&'procmail'&"
21684 .cindex "external local delivery"
21685 .cindex "delivery" "&'procmail'&"
21686 .cindex "delivery" "by external agent"
21687 The &(pipe)& transport can be used to pass all messages that require local
21688 delivery to a separate local delivery agent such as &%procmail%&. When doing
21689 this, care must be taken to ensure that the pipe is run under an appropriate
21690 uid and gid. In some configurations one wants this to be a uid that is trusted
21691 by the delivery agent to supply the correct sender of the message. It may be
21692 necessary to recompile or reconfigure the delivery agent so that it trusts an
21693 appropriate user. The following is an example transport and router
21694 configuration for &%procmail%&:
21695 .code
21696 # transport
21697 procmail_pipe:
21698   driver = pipe
21699   command = /usr/local/bin/procmail -d $local_part
21700   return_path_add
21701   delivery_date_add
21702   envelope_to_add
21703   check_string = "From "
21704   escape_string = ">From "
21705   umask = 077
21706   user = $local_part
21707   group = mail
21708
21709 # router
21710 procmail:
21711   driver = accept
21712   check_local_user
21713   transport = procmail_pipe
21714 .endd
21715 In this example, the pipe is run as the local user, but with the group set to
21716 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21717 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21718 user to supply a correct sender address. If you do not specify either a
21719 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21720 home directory is the user's home directory by default.
21721
21722 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21723 .code
21724 IFS=" "
21725 .endd
21726 as shown in some &%procmail%& documentation, because Exim does not by default
21727 use a shell to run pipe commands.
21728
21729 .cindex "Cyrus"
21730 The next example shows a transport and a router for a system where local
21731 deliveries are handled by the Cyrus IMAP server.
21732 .code
21733 # transport
21734 local_delivery_cyrus:
21735   driver = pipe
21736   command = /usr/cyrus/bin/deliver \
21737             -m ${substr_1:$local_part_suffix} -- $local_part
21738   user = cyrus
21739   group = mail
21740   return_output
21741   log_output
21742   message_prefix =
21743   message_suffix =
21744
21745 # router
21746 local_user_cyrus:
21747   driver = accept
21748   check_local_user
21749   local_part_suffix = .*
21750   transport = local_delivery_cyrus
21751 .endd
21752 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21753 &%return_output%& to cause any text written by Cyrus to be returned to the
21754 sender.
21755 .ecindex IIDpiptra1
21756 .ecindex IIDpiptra2
21757
21758
21759 . ////////////////////////////////////////////////////////////////////////////
21760 . ////////////////////////////////////////////////////////////////////////////
21761
21762 .chapter "The smtp transport" "CHAPsmtptrans"
21763 .scindex IIDsmttra1 "transports" "&(smtp)&"
21764 .scindex IIDsmttra2 "&(smtp)& transport"
21765 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21766 or LMTP protocol. The list of hosts to try can either be taken from the address
21767 that is being processed (having been set up by the router), or specified
21768 explicitly for the transport. Timeout and retry processing (see chapter
21769 &<<CHAPretry>>&) is applied to each IP address independently.
21770
21771
21772 .section "Multiple messages on a single connection" "SECID144"
21773 The sending of multiple messages over a single TCP/IP connection can arise in
21774 two ways:
21775
21776 .ilist
21777 If a message contains more than &%max_rcpt%& (see below) addresses that are
21778 routed to the same host, more than one copy of the message has to be sent to
21779 that host. In this situation, multiple copies may be sent in a single run of
21780 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21781 does when it has too many addresses to send in one message also depends on the
21782 value of the global &%remote_max_parallel%& option. Details are given in
21783 section &<<SECToutSMTPTCP>>&.)
21784 .next
21785 .cindex "hints database" "remembering routing"
21786 When a message has been successfully delivered over a TCP/IP connection, Exim
21787 looks in its hints database to see if there are any other messages awaiting a
21788 connection to the same host. If there are, a new delivery process is started
21789 for one of them, and the current TCP/IP connection is passed on to it. The new
21790 process may in turn send multiple copies and possibly create yet another
21791 process.
21792 .endlist
21793
21794
21795 For each copy sent over the same TCP/IP connection, a sequence counter is
21796 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21797 no further messages are sent over that connection.
21798
21799
21800
21801 .section "Use of the $host and $host_address variables" "SECID145"
21802 .vindex "&$host$&"
21803 .vindex "&$host_address$&"
21804 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21805 &$host_address$& are the name and IP address of the first host on the host list
21806 passed by the router. However, when the transport is about to connect to a
21807 specific host, and while it is connected to that host, &$host$& and
21808 &$host_address$& are set to the values for that host. These are the values
21809 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21810 &%serialize_hosts%&, and the various TLS options are expanded.
21811
21812
21813 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21814 .vindex &$tls_bits$&
21815 .vindex &$tls_cipher$&
21816 .vindex &$tls_peerdn$&
21817 .vindex &$tls_sni$&
21818 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
21819 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
21820 are the values that were set when the message was received.
21821 These are the values that are used for options that are expanded before any
21822 SMTP connections are made. Just before each connection is made, these four
21823 variables are emptied. If TLS is subsequently started, they are set to the
21824 appropriate values for the outgoing connection, and these are the values that
21825 are in force when any authenticators are run and when the
21826 &%authenticated_sender%& option is expanded.
21827
21828
21829 .section "Private options for smtp" "SECID146"
21830 .cindex "options" "&(smtp)& transport"
21831 The private options of the &(smtp)& transport are as follows:
21832
21833
21834 .option address_retry_include_sender smtp boolean true
21835 .cindex "4&'xx'& responses" "retrying after"
21836 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21837 is the combination of sender and recipient that is delayed in subsequent queue
21838 runs until the retry time is reached. You can delay the recipient without
21839 reference to the sender (which is what earlier versions of Exim did), by
21840 setting &%address_retry_include_sender%& false. However, this can lead to
21841 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21842
21843 .option allow_localhost smtp boolean false
21844 .cindex "local host" "sending to"
21845 .cindex "fallback" "hosts specified on transport"
21846 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21847 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21848 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21849 the delivery anyway. This should be used only in special cases when the
21850 configuration ensures that no looping will result (for example, a differently
21851 configured Exim is listening on the port to which the message is sent).
21852
21853
21854 .option authenticated_sender smtp string&!! unset
21855 .cindex "Cyrus"
21856 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21857 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21858 overriding any existing authenticated sender value. If the string expansion is
21859 forced to fail, the option is ignored. Other expansion failures cause delivery
21860 to be deferred. If the result of expansion is an empty string, that is also
21861 ignored.
21862
21863 The expansion happens after the outgoing connection has been made and TLS
21864 started, if required. This means that the &$host$&, &$host_address$&,
21865 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21866 particular connection.
21867
21868 If the SMTP session is not authenticated, the expansion of
21869 &%authenticated_sender%& still happens (and can cause the delivery to be
21870 deferred if it fails), but no AUTH= item is added to MAIL commands
21871 unless &%authenticated_sender_force%& is true.
21872
21873 This option allows you to use the &(smtp)& transport in LMTP mode to
21874 deliver mail to Cyrus IMAP and provide the proper local part as the
21875 &"authenticated sender"&, via a setting such as:
21876 .code
21877 authenticated_sender = $local_part
21878 .endd
21879 This removes the need for IMAP subfolders to be assigned special ACLs to
21880 allow direct delivery to those subfolders.
21881
21882 Because of expected uses such as that just described for Cyrus (when no
21883 domain is involved), there is no checking on the syntax of the provided
21884 value.
21885
21886
21887 .option authenticated_sender_force smtp boolean false
21888 If this option is set true, the &%authenticated_sender%& option's value
21889 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21890 authenticated as a client.
21891
21892
21893 .option command_timeout smtp time 5m
21894 This sets a timeout for receiving a response to an SMTP command that has been
21895 sent out. It is also used when waiting for the initial banner line from the
21896 remote host. Its value must not be zero.
21897
21898
21899 .option connect_timeout smtp time 5m
21900 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21901 to a remote host. A setting of zero allows the system timeout (typically
21902 several minutes) to act. To have any effect, the value of this option must be
21903 less than the system timeout. However, it has been observed that on some
21904 systems there is no system timeout, which is why the default value for this
21905 option is 5 minutes, a value recommended by RFC 1123.
21906
21907
21908 .option connection_max_messages smtp integer 500
21909 .cindex "SMTP" "passed connection"
21910 .cindex "SMTP" "multiple deliveries"
21911 .cindex "multiple SMTP deliveries"
21912 This controls the maximum number of separate message deliveries that are sent
21913 over a single TCP/IP connection. If the value is zero, there is no limit.
21914 For testing purposes, this value can be overridden by the &%-oB%& command line
21915 option.
21916
21917
21918 .option data_timeout smtp time 5m
21919 This sets a timeout for the transmission of each block in the data portion of
21920 the message. As a result, the overall timeout for a message depends on the size
21921 of the message. Its value must not be zero. See also &%final_timeout%&.
21922
21923
21924 .option delay_after_cutoff smtp boolean true
21925 This option controls what happens when all remote IP addresses for a given
21926 domain have been inaccessible for so long that they have passed their retry
21927 cutoff times.
21928
21929 In the default state, if the next retry time has not been reached for any of
21930 them, the address is bounced without trying any deliveries. In other words,
21931 Exim delays retrying an IP address after the final cutoff time until a new
21932 retry time is reached, and can therefore bounce an address without ever trying
21933 a delivery, when machines have been down for a long time. Some people are
21934 unhappy at this prospect, so...
21935
21936 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21937 addresses are past their final cutoff time, Exim tries to deliver to those
21938 IP addresses that have not been tried since the message arrived. If there are
21939 none, of if they all fail, the address is bounced. In other words, it does not
21940 delay when a new message arrives, but immediately tries those expired IP
21941 addresses that haven't been tried since the message arrived. If there is a
21942 continuous stream of messages for the dead hosts, unsetting
21943 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21944 to them.
21945
21946
21947 .option dns_qualify_single smtp boolean true
21948 If the &%hosts%& or &%fallback_hosts%& option is being used,
21949 and the &%gethostbyname%& option is false,
21950 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21951 in chapter &<<CHAPdnslookup>>& for more details.
21952
21953
21954 .option dns_search_parents smtp boolean false
21955 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21956 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21957 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21958 details.
21959
21960
21961
21962 .option fallback_hosts smtp "string list" unset
21963 .cindex "fallback" "hosts specified on transport"
21964 String expansion is not applied to this option. The argument must be a
21965 colon-separated list of host names or IP addresses, optionally also including
21966 port numbers, though the separator can be changed, as described in section
21967 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21968 item in a &%route_list%& setting for the &(manualroute)& router, as described
21969 in section &<<SECTformatonehostitem>>&.
21970
21971 Fallback hosts can also be specified on routers, which associate them with the
21972 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
21973 &%fallback_hosts%& specified on the transport is used only if the address does
21974 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
21975 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
21976 However, &%hosts_randomize%& does apply to fallback host lists.
21977
21978 If Exim is unable to deliver to any of the hosts for a particular address, and
21979 the errors are not permanent rejections, the address is put on a separate
21980 transport queue with its host list replaced by the fallback hosts, unless the
21981 address was routed via MX records and the current host was in the original MX
21982 list. In that situation, the fallback host list is not used.
21983
21984 Once normal deliveries are complete, the fallback queue is delivered by
21985 re-running the same transports with the new host lists. If several failing
21986 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
21987 copy of the message is sent.
21988
21989 The resolution of the host names on the fallback list is controlled by the
21990 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
21991 both to cases when the host list comes with the address and when it is taken
21992 from &%hosts%&. This option provides a &"use a smart host only if delivery
21993 fails"& facility.
21994
21995
21996 .option final_timeout smtp time 10m
21997 This is the timeout that applies while waiting for the response to the final
21998 line containing just &"."& that terminates a message. Its value must not be
21999 zero.
22000
22001 .option gethostbyname smtp boolean false
22002 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22003 being used, names are looked up using &[gethostbyname()]&
22004 (or &[getipnodebyname()]& when available)
22005 instead of using the DNS. Of course, that function may in fact use the DNS, but
22006 it may also consult other sources of information such as &_/etc/hosts_&.
22007
22008 .option gnutls_require_kx smtp string unset
22009 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
22010 client. For details, see section &<<SECTreqciphgnu>>&.
22011
22012 .option gnutls_require_mac smtp string unset
22013 This option controls the MAC algorithms when GnuTLS is used in an Exim
22014 client. For details, see section &<<SECTreqciphgnu>>&.
22015
22016 .option gnutls_require_protocols smtp string unset
22017 This option controls the protocols when GnuTLS is used in an Exim
22018 client. For details, see section &<<SECTreqciphgnu>>&.
22019
22020 .option gnutls_compat_mode smtp boolean unset
22021 This option controls whether GnuTLS is used in compatibility mode in an Exim
22022 server. This reduces security slightly, but improves interworking with older
22023 implementations of TLS.
22024
22025 .option helo_data smtp string&!! "see below"
22026 .cindex "HELO" "argument, setting"
22027 .cindex "EHLO" "argument, setting"
22028 .cindex "LHLO argument setting"
22029 The value of this option is expanded after a connection to a another host has
22030 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22031 command that starts the outgoing SMTP or LMTP session. The default value of the
22032 option is:
22033 .code
22034 $primary_hostname
22035 .endd
22036 During the expansion, the variables &$host$& and &$host_address$& are set to
22037 the identity of the remote host, and the variables &$sending_ip_address$& and
22038 &$sending_port$& are set to the local IP address and port number that are being
22039 used. These variables can be used to generate different values for different
22040 servers or different local IP addresses. For example, if you want the string
22041 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22042 interface address, you could use this:
22043 .code
22044 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22045   {$primary_hostname}}
22046 .endd
22047 The use of &%helo_data%& applies both to sending messages and when doing
22048 callouts.
22049
22050 .option hosts smtp "string list&!!" unset
22051 Hosts are associated with an address by a router such as &(dnslookup)&, which
22052 finds the hosts by looking up the address domain in the DNS, or by
22053 &(manualroute)&, which has lists of hosts in its configuration. However,
22054 email addresses can be passed to the &(smtp)& transport by any router, and not
22055 all of them can provide an associated list of hosts.
22056
22057 The &%hosts%& option specifies a list of hosts to be used if the address being
22058 processed does not have any hosts associated with it. The hosts specified by
22059 &%hosts%& are also used, whether or not the address has its own hosts, if
22060 &%hosts_override%& is set.
22061
22062 The string is first expanded, before being interpreted as a colon-separated
22063 list of host names or IP addresses, possibly including port numbers. The
22064 separator may be changed to something other than colon, as described in section
22065 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22066 item in a &%route_list%& setting for the &(manualroute)& router, as described
22067 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22068 of the &(manualroute)& router is not available here.
22069
22070 If the expansion fails, delivery is deferred. Unless the failure was caused by
22071 the inability to complete a lookup, the error is logged to the panic log as
22072 well as the main log. Host names are looked up either by searching directly for
22073 address records in the DNS or by calling &[gethostbyname()]& (or
22074 &[getipnodebyname()]& when available), depending on the setting of the
22075 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22076 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22077 address are used.
22078
22079 During delivery, the hosts are tried in order, subject to their retry status,
22080 unless &%hosts_randomize%& is set.
22081
22082
22083 .option hosts_avoid_esmtp smtp "host list&!!" unset
22084 .cindex "ESMTP, avoiding use of"
22085 .cindex "HELO" "forcing use of"
22086 .cindex "EHLO" "avoiding use of"
22087 .cindex "PIPELINING" "avoiding the use of"
22088 This option is for use with broken hosts that announce ESMTP facilities (for
22089 example, PIPELINING) and then fail to implement them properly. When a host
22090 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22091 start of the SMTP session. This means that it cannot use any of the ESMTP
22092 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22093
22094
22095 .option hosts_avoid_pipelining smtp "host list&!!" unset
22096 .cindex "PIPELINING" "avoiding the use of"
22097 Exim will not use the SMTP PIPELINING extension when delivering to any host
22098 that matches this list, even if the server host advertises PIPELINING support.
22099
22100
22101 .option hosts_avoid_tls smtp "host list&!!" unset
22102 .cindex "TLS" "avoiding for certain hosts"
22103 Exim will not try to start a TLS session when delivering to any host that
22104 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22105
22106
22107 .option hosts_max_try smtp integer 5
22108 .cindex "host" "maximum number to try"
22109 .cindex "limit" "number of hosts tried"
22110 .cindex "limit" "number of MX tried"
22111 .cindex "MX record" "maximum tried"
22112 This option limits the number of IP addresses that are tried for any one
22113 delivery in cases where there are temporary delivery errors. Section
22114 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22115
22116
22117 .option hosts_max_try_hardlimit smtp integer 50
22118 This is an additional check on the maximum number of IP addresses that Exim
22119 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22120 why it exists.
22121
22122
22123
22124 .option hosts_nopass_tls smtp "host list&!!" unset
22125 .cindex "TLS" "passing connection"
22126 .cindex "multiple SMTP deliveries"
22127 .cindex "TLS" "multiple message deliveries"
22128 For any host that matches this list, a connection on which a TLS session has
22129 been started will not be passed to a new delivery process for sending another
22130 message on the same connection. See section &<<SECTmulmessam>>& for an
22131 explanation of when this might be needed.
22132
22133
22134 .option hosts_override smtp boolean false
22135 If this option is set and the &%hosts%& option is also set, any hosts that are
22136 attached to the address are ignored, and instead the hosts specified by the
22137 &%hosts%& option are always used. This option does not apply to
22138 &%fallback_hosts%&.
22139
22140
22141 .option hosts_randomize smtp boolean false
22142 .cindex "randomized host list"
22143 .cindex "host" "list of; randomized"
22144 .cindex "fallback" "randomized hosts"
22145 If this option is set, and either the list of hosts is taken from the
22146 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22147 were not obtained from MX records (this includes fallback hosts from the
22148 router), and were not randomized by the router, the order of trying the hosts
22149 is randomized each time the transport runs. Randomizing the order of a host
22150 list can be used to do crude load sharing.
22151
22152 When &%hosts_randomize%& is true, a host list may be split into groups whose
22153 order is separately randomized. This makes it possible to set up MX-like
22154 behaviour. The boundaries between groups are indicated by an item that is just
22155 &`+`& in the host list. For example:
22156 .code
22157 hosts = host1:host2:host3:+:host4:host5
22158 .endd
22159 The order of the first three hosts and the order of the last two hosts is
22160 randomized for each use, but the first three always end up before the last two.
22161 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22162
22163 .option hosts_require_auth smtp "host list&!!" unset
22164 .cindex "authentication" "required by client"
22165 This option provides a list of servers for which authentication must succeed
22166 before Exim will try to transfer a message. If authentication fails for
22167 servers which are not in this list, Exim tries to send unauthenticated. If
22168 authentication fails for one of these servers, delivery is deferred. This
22169 temporary error is detectable in the retry rules, so it can be turned into a
22170 hard failure if required. See also &%hosts_try_auth%&, and chapter
22171 &<<CHAPSMTPAUTH>>& for details of authentication.
22172
22173
22174 .option hosts_require_tls smtp "host list&!!" unset
22175 .cindex "TLS" "requiring for certain servers"
22176 Exim will insist on using a TLS session when delivering to any host that
22177 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22178 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22179 incoming messages, use an appropriate ACL.
22180
22181 .option hosts_try_auth smtp "host list&!!" unset
22182 .cindex "authentication" "optional in client"
22183 This option provides a list of servers to which, provided they announce
22184 authentication support, Exim will attempt to authenticate as a client when it
22185 connects. If authentication fails, Exim will try to transfer the message
22186 unauthenticated. See also &%hosts_require_auth%&, and chapter
22187 &<<CHAPSMTPAUTH>>& for details of authentication.
22188
22189 .option interface smtp "string list&!!" unset
22190 .cindex "bind IP address"
22191 .cindex "IP address" "binding"
22192 .vindex "&$host$&"
22193 .vindex "&$host_address$&"
22194 This option specifies which interface to bind to when making an outgoing SMTP
22195 call. The value is an IP address, not an interface name such as
22196 &`eth0`&. Do not confuse this with the interface address that was used when a
22197 message was received, which is in &$received_ip_address$&, formerly known as
22198 &$interface_address$&. The name was changed to minimize confusion with the
22199 outgoing interface address. There is no variable that contains an outgoing
22200 interface address because, unless it is set by this option, its value is
22201 unknown.
22202
22203 During the expansion of the &%interface%& option the variables &$host$& and
22204 &$host_address$& refer to the host to which a connection is about to be made
22205 during the expansion of the string. Forced expansion failure, or an empty
22206 string result causes the option to be ignored. Otherwise, after expansion, the
22207 string must be a list of IP addresses, colon-separated by default, but the
22208 separator can be changed in the usual way. For example:
22209 .code
22210 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22211 .endd
22212 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22213 connection. If none of them are the correct type, the option is ignored. If
22214 &%interface%& is not set, or is ignored, the system's IP functions choose which
22215 interface to use if the host has more than one.
22216
22217
22218 .option keepalive smtp boolean true
22219 .cindex "keepalive" "on outgoing connection"
22220 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22221 connections. When set, it causes the kernel to probe idle connections
22222 periodically, by sending packets with &"old"& sequence numbers. The other end
22223 of the connection should send a acknowledgment if the connection is still okay
22224 or a reset if the connection has been aborted. The reason for doing this is
22225 that it has the beneficial effect of freeing up certain types of connection
22226 that can get stuck when the remote host is disconnected without tidying up the
22227 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22228 unreachable hosts.
22229
22230
22231 .option lmtp_ignore_quota smtp boolean false
22232 .cindex "LMTP" "ignoring quota errors"
22233 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22234 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22235 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22236
22237 .option max_rcpt smtp integer 100
22238 .cindex "RCPT" "maximum number of outgoing"
22239 This option limits the number of RCPT commands that are sent in a single
22240 SMTP message transaction. Each set of addresses is treated independently, and
22241 so can cause parallel connections to the same host if &%remote_max_parallel%&
22242 permits this.
22243
22244
22245 .option multi_domain smtp boolean true
22246 .vindex "&$domain$&"
22247 When this option is set, the &(smtp)& transport can handle a number of
22248 addresses containing a mixture of different domains provided they all resolve
22249 to the same list of hosts. Turning the option off restricts the transport to
22250 handling only one domain at a time. This is useful if you want to use
22251 &$domain$& in an expansion for the transport, because it is set only when there
22252 is a single domain involved in a remote delivery.
22253
22254
22255 .option port smtp string&!! "see below"
22256 .cindex "port" "sending TCP/IP"
22257 .cindex "TCP/IP" "setting outgoing port"
22258 This option specifies the TCP/IP port on the server to which Exim connects.
22259 &*Note:*& Do not confuse this with the port that was used when a message was
22260 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22261 The name was changed to minimize confusion with the outgoing port. There is no
22262 variable that contains an outgoing port.
22263
22264 If the value of this option begins with a digit it is taken as a port number;
22265 otherwise it is looked up using &[getservbyname()]&. The default value is
22266 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22267 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22268 is deferred.
22269
22270
22271
22272 .option protocol smtp string smtp
22273 .cindex "LMTP" "over TCP/IP"
22274 .cindex "ssmtp protocol" "outbound"
22275 .cindex "TLS" "SSL-on-connect outbound"
22276 .vindex "&$port$&"
22277 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22278 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22279 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22280 deliveries into closed message stores. Exim also has support for running LMTP
22281 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22282
22283 .new
22284 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22285 changes to &"smtps"&, and the transport initiates TLS immediately after
22286 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22287 The Internet standards bodies strongly discourage use of this mode.
22288 .wen
22289
22290
22291 .option retry_include_ip_address smtp boolean true
22292 Exim normally includes both the host name and the IP address in the key it
22293 constructs for indexing retry data after a temporary delivery failure. This
22294 means that when one of several IP addresses for a host is failing, it gets
22295 tried periodically (controlled by the retry rules), but use of the other IP
22296 addresses is not affected.
22297
22298 However, in some dialup environments hosts are assigned a different IP address
22299 each time they connect. In this situation the use of the IP address as part of
22300 the retry key leads to undesirable behaviour. Setting this option false causes
22301 Exim to use only the host name. This should normally be done on a separate
22302 instance of the &(smtp)& transport, set up specially to handle the dialup
22303 hosts.
22304
22305
22306 .option serialize_hosts smtp "host list&!!" unset
22307 .cindex "serializing connections"
22308 .cindex "host" "serializing connections"
22309 Because Exim operates in a distributed manner, if several messages for the same
22310 host arrive at around the same time, more than one simultaneous connection to
22311 the remote host can occur. This is not usually a problem except when there is a
22312 slow link between the hosts. In that situation it may be helpful to restrict
22313 Exim to one connection at a time. This can be done by setting
22314 &%serialize_hosts%& to match the relevant hosts.
22315
22316 .cindex "hints database" "serializing deliveries to a host"
22317 Exim implements serialization by means of a hints database in which a record is
22318 written whenever a process connects to one of the restricted hosts. The record
22319 is deleted when the connection is completed. Obviously there is scope for
22320 records to get left lying around if there is a system or program crash. To
22321 guard against this, Exim ignores any records that are more than six hours old.
22322
22323 If you set up this kind of serialization, you should also arrange to delete the
22324 relevant hints database whenever your system reboots. The names of the files
22325 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22326 may be one or two files, depending on the type of DBM in use. The same files
22327 are used for ETRN serialization.
22328
22329
22330 .option size_addition smtp integer 1024
22331 .cindex "SMTP" "SIZE"
22332 .cindex "message" "size issue for transport filter"
22333 .cindex "size" "of message"
22334 .cindex "transport" "filter"
22335 .cindex "filter" "transport filter"
22336 If a remote SMTP server indicates that it supports the SIZE option of the
22337 MAIL command, Exim uses this to pass over the message size at the start of
22338 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22339 sends, to allow for headers and other text that may be added during delivery by
22340 configuration options or in a transport filter. It may be necessary to increase
22341 this if a lot of text is added to messages.
22342
22343 Alternatively, if the value of &%size_addition%& is set negative, it disables
22344 the use of the SIZE option altogether.
22345
22346
22347 .option tls_certificate smtp string&!! unset
22348 .cindex "TLS" "client certificate, location of"
22349 .cindex "certificate" "client, location of"
22350 .vindex "&$host$&"
22351 .vindex "&$host_address$&"
22352 The value of this option must be the absolute path to a file which contains the
22353 client's certificate, for possible use when sending a message over an encrypted
22354 connection. The values of &$host$& and &$host_address$& are set to the name and
22355 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22356 details of TLS.
22357
22358 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22359 certificate when sending messages as a client. The global option of the same
22360 name specifies the certificate for Exim as a server; it is not automatically
22361 assumed that the same certificate should be used when Exim is operating as a
22362 client.
22363
22364
22365 .option tls_crl smtp string&!! unset
22366 .cindex "TLS" "client certificate revocation list"
22367 .cindex "certificate" "revocation list for client"
22368 This option specifies a certificate revocation list. The expanded value must
22369 be the name of a file that contains a CRL in PEM format.
22370
22371
22372 .option tls_privatekey smtp string&!! unset
22373 .cindex "TLS" "client private key, location of"
22374 .vindex "&$host$&"
22375 .vindex "&$host_address$&"
22376 The value of this option must be the absolute path to a file which contains the
22377 client's private key. This is used when sending a message over an encrypted
22378 connection using a client certificate. The values of &$host$& and
22379 &$host_address$& are set to the name and address of the server during the
22380 expansion. If this option is unset, or the expansion is forced to fail, or the
22381 result is an empty string, the private key is assumed to be in the same file as
22382 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22383
22384
22385 .option tls_require_ciphers smtp string&!! unset
22386 .cindex "TLS" "requiring specific ciphers"
22387 .cindex "cipher" "requiring specific"
22388 .vindex "&$host$&"
22389 .vindex "&$host_address$&"
22390 The value of this option must be a list of permitted cipher suites, for use
22391 when setting up an outgoing encrypted connection. (There is a global option of
22392 the same name for controlling incoming connections.) The values of &$host$& and
22393 &$host_address$& are set to the name and address of the server during the
22394 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22395 is used in different ways by OpenSSL and GnuTLS (see sections
22396 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22397 ciphers is a preference order.
22398
22399
22400
22401 .new
22402 .option tls_sni smtp string&!! unset
22403 .cindex "TLS" "Server Name Indication"
22404 .vindex "&$tls_sni$&"
22405 If this option is set then it sets the $tls_sni variable and causes any
22406 TLS session to pass this value as the Server Name Indication extension to
22407 the remote side, which can be used by the remote side to select an appropriate
22408 certificate and private key for the session.
22409
22410 See &<<SECTtlssni>>& for more information.
22411
22412 OpenSSL only, also requiring a build of OpenSSL that supports TLS extensions.
22413 .wen
22414
22415
22416
22417 .option tls_tempfail_tryclear smtp boolean true
22418 .cindex "4&'xx'& responses" "to STARTTLS"
22419 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22420 setting up a TLS session, this option determines whether or not Exim should try
22421 to deliver the message unencrypted. If it is set false, delivery to the
22422 current host is deferred; if there are other hosts, they are tried. If this
22423 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22424 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22425 TLS negotiation fails, Exim closes the current connection (because it is in an
22426 unknown state), opens a new one to the same host, and then tries the delivery
22427 in clear.
22428
22429
22430 .option tls_verify_certificates smtp string&!! unset
22431 .cindex "TLS" "server certificate verification"
22432 .cindex "certificate" "verification of server"
22433 .vindex "&$host$&"
22434 .vindex "&$host_address$&"
22435 The value of this option must be the absolute path to a file containing
22436 permitted server certificates, for use when setting up an encrypted connection.
22437 Alternatively, if you are using OpenSSL, you can set
22438 &%tls_verify_certificates%& to the name of a directory containing certificate
22439 files. This does not work with GnuTLS; the option must be set to the name of a
22440 single file if you are using GnuTLS. The values of &$host$& and
22441 &$host_address$& are set to the name and address of the server during the
22442 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22443
22444
22445
22446
22447 .section "How the limits for the number of hosts to try are used" &&&
22448          "SECTvalhosmax"
22449 .cindex "host" "maximum number to try"
22450 .cindex "limit" "hosts; maximum number tried"
22451 There are two options that are concerned with the number of hosts that are
22452 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22453 &%hosts_max_try_hardlimit%&.
22454
22455
22456 The &%hosts_max_try%& option limits the number of hosts that are tried
22457 for a single delivery. However, despite the term &"host"& in its name, the
22458 option actually applies to each IP address independently. In other words, a
22459 multihomed host is treated as several independent hosts, just as it is for
22460 retrying.
22461
22462 Many of the larger ISPs have multiple MX records which often point to
22463 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22464 created as a result of routing one of these domains.
22465
22466 Trying every single IP address on such a long list does not seem sensible; if
22467 several at the top of the list fail, it is reasonable to assume there is some
22468 problem that is likely to affect all of them. Roughly speaking, the value of
22469 &%hosts_max_try%& is the maximum number that are tried before deferring the
22470 delivery. However, the logic cannot be quite that simple.
22471
22472 Firstly, IP addresses that are skipped because their retry times have not
22473 arrived do not count, and in addition, addresses that are past their retry
22474 limits are also not counted, even when they are tried. This means that when
22475 some IP addresses are past their retry limits, more than the value of
22476 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22477 that all IP addresses are considered before timing out an email address (but
22478 see below for an exception).
22479
22480 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22481 list to see if there is a subsequent host with a different (higher valued) MX.
22482 If there is, that host is considered next, and the current IP address is used
22483 but not counted. This behaviour helps in the case of a domain with a retry rule
22484 that hardly ever delays any hosts, as is now explained:
22485
22486 Consider the case of a long list of hosts with one MX value, and a few with a
22487 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22488 hosts at the top of the list are tried at first. With the default retry rule,
22489 which specifies increasing retry times, the higher MX hosts are eventually
22490 tried when those at the top of the list are skipped because they have not
22491 reached their retry times.
22492
22493 However, it is common practice to put a fixed short retry time on domains for
22494 large ISPs, on the grounds that their servers are rarely down for very long.
22495 Unfortunately, these are exactly the domains that tend to resolve to long lists
22496 of hosts. The short retry time means that the lowest MX hosts are tried every
22497 time. The attempts may be in a different order because of random sorting, but
22498 without the special MX check, the higher MX hosts would never be tried until
22499 all the lower MX hosts had timed out (which might be several days), because
22500 there are always some lower MX hosts that have reached their retry times. With
22501 the special check, Exim considers at least one IP address from each MX value at
22502 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22503 reached.
22504
22505 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22506 particular, Exim normally eventually tries all the IP addresses before timing
22507 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22508 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22509 been set up with hundreds of IP addresses for some domains. It can
22510 take a very long time indeed for an address to time out in these cases.
22511
22512 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22513 Exim never tries more than this number of IP addresses; if it hits this limit
22514 and they are all timed out, the email address is bounced, even though not all
22515 possible IP addresses have been tried.
22516 .ecindex IIDsmttra1
22517 .ecindex IIDsmttra2
22518
22519
22520
22521
22522
22523 . ////////////////////////////////////////////////////////////////////////////
22524 . ////////////////////////////////////////////////////////////////////////////
22525
22526 .chapter "Address rewriting" "CHAPrewrite"
22527 .scindex IIDaddrew "rewriting" "addresses"
22528 There are some circumstances in which Exim automatically rewrites domains in
22529 addresses. The two most common are when an address is given without a domain
22530 (referred to as an &"unqualified address"&) or when an address contains an
22531 abbreviated domain that is expanded by DNS lookup.
22532
22533 Unqualified envelope addresses are accepted only for locally submitted
22534 messages, or for messages that are received from hosts matching
22535 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22536 appropriate. Unqualified addresses in header lines are qualified if they are in
22537 locally submitted messages, or messages from hosts that are permitted to send
22538 unqualified envelope addresses. Otherwise, unqualified addresses in header
22539 lines are neither qualified nor rewritten.
22540
22541 One situation in which Exim does &'not'& automatically rewrite a domain is
22542 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22543 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22544 do this. The new RFCs do not contain this suggestion.
22545
22546
22547 .section "Explicitly configured address rewriting" "SECID147"
22548 This chapter describes the rewriting rules that can be used in the
22549 main rewrite section of the configuration file, and also in the generic
22550 &%headers_rewrite%& option that can be set on any transport.
22551
22552 Some people believe that configured address rewriting is a Mortal Sin.
22553 Others believe that life is not possible without it. Exim provides the
22554 facility; you do not have to use it.
22555
22556 The main rewriting rules that appear in the &"rewrite"& section of the
22557 configuration file are applied to addresses in incoming messages, both envelope
22558 addresses and addresses in header lines. Each rule specifies the types of
22559 address to which it applies.
22560
22561 Whether or not addresses in header lines are rewritten depends on the origin of
22562 the headers and the type of rewriting. Global rewriting, that is, rewriting
22563 rules from the rewrite section of the configuration file, is applied only to
22564 those headers that were received with the message. Header lines that are added
22565 by ACLs or by a system filter or by individual routers or transports (which
22566 are specific to individual recipient addresses) are not rewritten by the global
22567 rules.
22568
22569 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22570 applies all headers except those added by routers and transports. That is, as
22571 well as the headers that were received with the message, it also applies to
22572 headers that were added by an ACL or a system filter.
22573
22574
22575 In general, rewriting addresses from your own system or domain has some
22576 legitimacy. Rewriting other addresses should be done only with great care and
22577 in special circumstances. The author of Exim believes that rewriting should be
22578 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22579 Although it can sometimes be used as a routing tool, this is very strongly
22580 discouraged.
22581
22582 There are two commonly encountered circumstances where rewriting is used, as
22583 illustrated by these examples:
22584
22585 .ilist
22586 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22587 exchange mail with each other behind a firewall, but there is only a single
22588 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22589 &'hitch.fict.example'& when sending mail off-site.
22590 .next
22591 A host rewrites the local parts of its own users so that, for example,
22592 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22593 .endlist
22594
22595
22596
22597 .section "When does rewriting happen?" "SECID148"
22598 .cindex "rewriting" "timing of"
22599 .cindex "&ACL;" "rewriting addresses in"
22600 Configured address rewriting can take place at several different stages of a
22601 message's processing.
22602
22603 .vindex "&$sender_address$&"
22604 At the start of an ACL for MAIL, the sender address may have been rewritten
22605 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22606 ordinary rewrite rules have yet been applied. If, however, the sender address
22607 is verified in the ACL, it is rewritten before verification, and remains
22608 rewritten thereafter. The subsequent value of &$sender_address$& is the
22609 rewritten address. This also applies if sender verification happens in a
22610 RCPT ACL. Otherwise, when the sender address is not verified, it is
22611 rewritten as soon as a message's header lines have been received.
22612
22613 .vindex "&$domain$&"
22614 .vindex "&$local_part$&"
22615 Similarly, at the start of an ACL for RCPT, the current recipient's address
22616 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22617 rewrite rules have yet been applied to it. However, the behaviour is different
22618 from the sender address when a recipient is verified. The address is rewritten
22619 for the verification, but the rewriting is not remembered at this stage. The
22620 value of &$local_part$& and &$domain$& after verification are always the same
22621 as they were before (that is, they contain the unrewritten &-- except for
22622 SMTP-time rewriting &-- address).
22623
22624 As soon as a message's header lines have been received, all the envelope
22625 recipient addresses are permanently rewritten, and rewriting is also applied to
22626 the addresses in the header lines (if configured). This happens before adding
22627 any header lines that were specified in MAIL or RCPT ACLs, and
22628 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22629 before the DATA ACL and &[local_scan()]& functions are run.
22630
22631 When an address is being routed, either for delivery or for verification,
22632 rewriting is applied immediately to child addresses that are generated by
22633 redirection, unless &%no_rewrite%& is set on the router.
22634
22635 .cindex "envelope sender" "rewriting at transport time"
22636 .cindex "rewriting" "at transport time"
22637 .cindex "header lines" "rewriting at transport time"
22638 At transport time, additional rewriting of addresses in header lines can be
22639 specified by setting the generic &%headers_rewrite%& option on a transport.
22640 This option contains rules that are identical in form to those in the rewrite
22641 section of the configuration file. They are applied to the original message
22642 header lines and any that were added by ACLs or a system filter. They are not
22643 applied to header lines that are added by routers or the transport.
22644
22645 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22646 transport option. However, it is not possible to rewrite envelope recipients at
22647 transport time.
22648
22649
22650
22651
22652 .section "Testing the rewriting rules that apply on input" "SECID149"
22653 .cindex "rewriting" "testing"
22654 .cindex "testing" "rewriting"
22655 Exim's input rewriting configuration appears in a part of the run time
22656 configuration file headed by &"begin rewrite"&. It can be tested by the
22657 &%-brw%& command line option. This takes an address (which can be a full RFC
22658 2822 address) as its argument. The output is a list of how the address would be
22659 transformed by the rewriting rules for each of the different places it might
22660 appear in an incoming message, that is, for each different header and for the
22661 envelope sender and recipient fields. For example,
22662 .code
22663 exim -brw ph10@exim.workshop.example
22664 .endd
22665 might produce the output
22666 .code
22667 sender: Philip.Hazel@exim.workshop.example
22668 from: Philip.Hazel@exim.workshop.example
22669 to: ph10@exim.workshop.example
22670 cc: ph10@exim.workshop.example
22671 bcc: ph10@exim.workshop.example
22672 reply-to: Philip.Hazel@exim.workshop.example
22673 env-from: Philip.Hazel@exim.workshop.example
22674 env-to: ph10@exim.workshop.example
22675 .endd
22676 which shows that rewriting has been set up for that address when used in any of
22677 the source fields, but not when it appears as a recipient address. At the
22678 present time, there is no equivalent way of testing rewriting rules that are
22679 set for a particular transport.
22680
22681
22682 .section "Rewriting rules" "SECID150"
22683 .cindex "rewriting" "rules"
22684 The rewrite section of the configuration file consists of lines of rewriting
22685 rules in the form
22686 .display
22687 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22688 .endd
22689 Rewriting rules that are specified for the &%headers_rewrite%& generic
22690 transport option are given as a colon-separated list. Each item in the list
22691 takes the same form as a line in the main rewriting configuration (except that
22692 any colons must be doubled, of course).
22693
22694 The formats of source patterns and replacement strings are described below.
22695 Each is terminated by white space, unless enclosed in double quotes, in which
22696 case normal quoting conventions apply inside the quotes. The flags are single
22697 characters which may appear in any order. Spaces and tabs between them are
22698 ignored.
22699
22700 For each address that could potentially be rewritten, the rules are scanned in
22701 order, and replacements for the address from earlier rules can themselves be
22702 replaced by later rules (but see the &"q"& and &"R"& flags).
22703
22704 The order in which addresses are rewritten is undefined, may change between
22705 releases, and must not be relied on, with one exception: when a message is
22706 received, the envelope sender is always rewritten first, before any header
22707 lines are rewritten. For example, the replacement string for a rewrite of an
22708 address in &'To:'& must not assume that the message's address in &'From:'& has
22709 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22710 that the envelope sender has already been rewritten.
22711
22712 .vindex "&$domain$&"
22713 .vindex "&$local_part$&"
22714 The variables &$local_part$& and &$domain$& can be used in the replacement
22715 string to refer to the address that is being rewritten. Note that lookup-driven
22716 rewriting can be done by a rule of the form
22717 .code
22718 *@*   ${lookup ...
22719 .endd
22720 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22721 refer to the address that is being rewritten.
22722
22723
22724 .section "Rewriting patterns" "SECID151"
22725 .cindex "rewriting" "patterns"
22726 .cindex "address list" "in a rewriting pattern"
22727 The source pattern in a rewriting rule is any item which may appear in an
22728 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22729 single-item address list, which means that it is expanded before being tested
22730 against the address. As always, if you use a regular expression as a pattern,
22731 you must take care to escape dollar and backslash characters, or use the &`\N`&
22732 facility to suppress string expansion within the regular expression.
22733
22734 Domains in patterns should be given in lower case. Local parts in patterns are
22735 case-sensitive. If you want to do case-insensitive matching of local parts, you
22736 can use a regular expression that starts with &`^(?i)`&.
22737
22738 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22739 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22740 depending on the type of match which occurred. These can be used in the
22741 replacement string to insert portions of the incoming address. &$0$& always
22742 refers to the complete incoming address. When a regular expression is used, the
22743 numerical variables are set from its capturing subexpressions. For other types
22744 of pattern they are set as follows:
22745
22746 .ilist
22747 If a local part or domain starts with an asterisk, the numerical variables
22748 refer to the character strings matched by asterisks, with &$1$& associated with
22749 the first asterisk, and &$2$& with the second, if present. For example, if the
22750 pattern
22751 .code
22752 *queen@*.fict.example
22753 .endd
22754 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22755 .code
22756 $0 = hearts-queen@wonderland.fict.example
22757 $1 = hearts-
22758 $2 = wonderland
22759 .endd
22760 Note that if the local part does not start with an asterisk, but the domain
22761 does, it is &$1$& that contains the wild part of the domain.
22762
22763 .next
22764 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22765 of the domain are placed in the next available numerical variables. Suppose,
22766 for example, that the address &'foo@bar.baz.example'& is processed by a
22767 rewriting rule of the form
22768 .display
22769 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22770 .endd
22771 and the key in the file that matches the domain is &`*.baz.example`&. Then
22772 .code
22773 $1 = foo
22774 $2 = bar
22775 $3 = baz.example
22776 .endd
22777 If the address &'foo@baz.example'& is looked up, this matches the same
22778 wildcard file entry, and in this case &$2$& is set to the empty string, but
22779 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22780 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22781 whole domain. For non-partial domain lookups, no numerical variables are set.
22782 .endlist
22783
22784
22785 .section "Rewriting replacements" "SECID152"
22786 .cindex "rewriting" "replacements"
22787 If the replacement string for a rule is a single asterisk, addresses that
22788 match the pattern and the flags are &'not'& rewritten, and no subsequent
22789 rewriting rules are scanned. For example,
22790 .code
22791 hatta@lookingglass.fict.example  *  f
22792 .endd
22793 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22794 &'From:'& headers.
22795
22796 .vindex "&$domain$&"
22797 .vindex "&$local_part$&"
22798 If the replacement string is not a single asterisk, it is expanded, and must
22799 yield a fully qualified address. Within the expansion, the variables
22800 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22801 Any letters they contain retain their original case &-- they are not lower
22802 cased. The numerical variables are set up according to the type of pattern that
22803 matched the address, as described above. If the expansion is forced to fail by
22804 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22805 current rule is abandoned, but subsequent rules may take effect. Any other
22806 expansion failure causes the entire rewriting operation to be abandoned, and an
22807 entry written to the panic log.
22808
22809
22810
22811 .section "Rewriting flags" "SECID153"
22812 There are three different kinds of flag that may appear on rewriting rules:
22813
22814 .ilist
22815 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22816 c, f, h, r, s, t.
22817 .next
22818 A flag that specifies rewriting at SMTP time: S.
22819 .next
22820 Flags that control the rewriting process: Q, q, R, w.
22821 .endlist
22822
22823 For rules that are part of the &%headers_rewrite%& generic transport option,
22824 E, F, T, and S are not permitted.
22825
22826
22827
22828 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22829          "SECID154"
22830 .cindex "rewriting" "flags"
22831 If none of the following flag letters, nor the &"S"& flag (see section
22832 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22833 and to both the sender and recipient fields of the envelope, whereas a
22834 transport-time rewriting rule just applies to all headers. Otherwise, the
22835 rewriting rule is skipped unless the relevant addresses are being processed.
22836 .display
22837 &`E`&       rewrite all envelope fields
22838 &`F`&       rewrite the envelope From field
22839 &`T`&       rewrite the envelope To field
22840 &`b`&       rewrite the &'Bcc:'& header
22841 &`c`&       rewrite the &'Cc:'& header
22842 &`f`&       rewrite the &'From:'& header
22843 &`h`&       rewrite all headers
22844 &`r`&       rewrite the &'Reply-To:'& header
22845 &`s`&       rewrite the &'Sender:'& header
22846 &`t`&       rewrite the &'To:'& header
22847 .endd
22848 "All headers" means all of the headers listed above that can be selected
22849 individually, plus their &'Resent-'& versions. It does not include
22850 other headers such as &'Subject:'& etc.
22851
22852 You should be particularly careful about rewriting &'Sender:'& headers, and
22853 restrict this to special known cases in your own domains.
22854
22855
22856 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22857 .cindex "SMTP" "rewriting malformed addresses"
22858 .cindex "RCPT" "rewriting argument of"
22859 .cindex "MAIL" "rewriting argument of"
22860 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22861 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22862 before any other processing; even before syntax checking. The pattern is
22863 required to be a regular expression, and it is matched against the whole of the
22864 data for the command, including any surrounding angle brackets.
22865
22866 .vindex "&$domain$&"
22867 .vindex "&$local_part$&"
22868 This form of rewrite rule allows for the handling of addresses that are not
22869 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22870 input). Because the input is not required to be a syntactically valid address,
22871 the variables &$local_part$& and &$domain$& are not available during the
22872 expansion of the replacement string. The result of rewriting replaces the
22873 original address in the MAIL or RCPT command.
22874
22875
22876 .section "Flags controlling the rewriting process" "SECID155"
22877 There are four flags which control the way the rewriting process works. These
22878 take effect only when a rule is invoked, that is, when the address is of the
22879 correct type (matches the flags) and matches the pattern:
22880
22881 .ilist
22882 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22883 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22884 absence of &"Q"& the rewritten address must always include a domain.
22885 .next
22886 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22887 even if no rewriting actually takes place because of a &"fail"& in the
22888 expansion. The &"q"& flag is not effective if the address is of the wrong type
22889 (does not match the flags) or does not match the pattern.
22890 .next
22891 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22892 address, up to ten times. It can be combined with the &"q"& flag, to stop
22893 rewriting once it fails to match (after at least one successful rewrite).
22894 .next
22895 .cindex "rewriting" "whole addresses"
22896 When an address in a header is rewritten, the rewriting normally applies only
22897 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22898 left unchanged. For example, rewriting might change
22899 .code
22900 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22901 .endd
22902 into
22903 .code
22904 From: Ford Prefect <prefectf@hitch.fict.example>
22905 .endd
22906 .cindex "RFC 2047"
22907 Sometimes there is a need to replace the whole address item, and this can be
22908 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22909 causes an address in a header line to be rewritten, the entire address is
22910 replaced, not just the working part. The replacement must be a complete RFC
22911 2822 address, including the angle brackets if necessary. If text outside angle
22912 brackets contains a character whose value is greater than 126 or less than 32
22913 (except for tab), the text is encoded according to RFC 2047. The character set
22914 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22915
22916 When the &"w"& flag is set on a rule that causes an envelope address to be
22917 rewritten, all but the working part of the replacement address is discarded.
22918 .endlist
22919
22920
22921 .section "Rewriting examples" "SECID156"
22922 Here is an example of the two common rewriting paradigms:
22923 .code
22924 *@*.hitch.fict.example  $1@hitch.fict.example
22925 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22926                      {$value}fail}@hitch.fict.example bctfrF
22927 .endd
22928 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22929 the string expansion to fail if the lookup does not succeed. In this context it
22930 has the effect of leaving the original address unchanged, but Exim goes on to
22931 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22932 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22933 explicitly, which would cause the rewritten address to be the same as before,
22934 at the cost of a small bit of processing. Not supplying either of these is an
22935 error, since the rewritten address would then contain no local part.
22936
22937 The first example above replaces the domain with a superior, more general
22938 domain. This may not be desirable for certain local parts. If the rule
22939 .code
22940 root@*.hitch.fict.example  *
22941 .endd
22942 were inserted before the first rule, rewriting would be suppressed for the
22943 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22944
22945 Rewriting can be made conditional on a number of tests, by making use of
22946 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22947 messages that originate outside the local host:
22948 .code
22949 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22950                          {$1@hitch.fict.example}fail}"
22951 .endd
22952 The replacement string is quoted in this example because it contains white
22953 space.
22954
22955 .cindex "rewriting" "bang paths"
22956 .cindex "bang paths" "rewriting"
22957 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22958 an address it treats it as an unqualified local part which it qualifies with
22959 the local qualification domain (if the source of the message is local or if the
22960 remote host is permitted to send unqualified addresses). Rewriting can
22961 sometimes be used to handle simple bang paths with a fixed number of
22962 components. For example, the rule
22963 .code
22964 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22965 .endd
22966 rewrites a two-component bang path &'host.name!user'& as the domain address
22967 &'user@host.name'&. However, there is a security implication in using this as
22968 a global rewriting rule for envelope addresses. It can provide a backdoor
22969 method for using your system as a relay, because the incoming addresses appear
22970 to be local. If the bang path addresses are received via SMTP, it is safer to
22971 use the &"S"& flag to rewrite them as they are received, so that relay checking
22972 can be done on the rewritten addresses.
22973 .ecindex IIDaddrew
22974
22975
22976
22977
22978
22979 . ////////////////////////////////////////////////////////////////////////////
22980 . ////////////////////////////////////////////////////////////////////////////
22981
22982 .chapter "Retry configuration" "CHAPretry"
22983 .scindex IIDretconf1 "retry" "configuration, description of"
22984 .scindex IIDregconf2 "configuration file" "retry section"
22985 The &"retry"& section of the runtime configuration file contains a list of
22986 retry rules that control how often Exim tries to deliver messages that cannot
22987 be delivered at the first attempt. If there are no retry rules (the section is
22988 empty or not present), there are no retries. In this situation, temporary
22989 errors are treated as permanent. The default configuration contains a single,
22990 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
22991 line option can be used to test which retry rule will be used for a given
22992 address, domain and error.
22993
22994 The most common cause of retries is temporary failure to deliver to a remote
22995 host because the host is down, or inaccessible because of a network problem.
22996 Exim's retry processing in this case is applied on a per-host (strictly, per IP
22997 address) basis, not on a per-message basis. Thus, if one message has recently
22998 been delayed, delivery of a new message to the same host is not immediately
22999 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23000 log selector is set, the message
23001 .cindex "retry" "time not reached"
23002 &"retry time not reached"& is written to the main log whenever a delivery is
23003 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23004 the handling of errors during remote deliveries.
23005
23006 Retry processing applies to routing as well as to delivering, except as covered
23007 in the next paragraph. The retry rules do not distinguish between these
23008 actions. It is not possible, for example, to specify different behaviour for
23009 failures to route the domain &'snark.fict.example'& and failures to deliver to
23010 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23011 added complication, so did not implement it. However, although they share the
23012 same retry rule, the actual retry times for routing and transporting a given
23013 domain are maintained independently.
23014
23015 When a delivery is not part of a queue run (typically an immediate delivery on
23016 receipt of a message), the routers are always run, and local deliveries are
23017 always attempted, even if retry times are set for them. This makes for better
23018 behaviour if one particular message is causing problems (for example, causing
23019 quota overflow, or provoking an error in a filter file). If such a delivery
23020 suffers a temporary failure, the retry data is updated as normal, and
23021 subsequent delivery attempts from queue runs occur only when the retry time for
23022 the local address is reached.
23023
23024 .section "Changing retry rules" "SECID157"
23025 If you change the retry rules in your configuration, you should consider
23026 whether or not to delete the retry data that is stored in Exim's spool area in
23027 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23028 always safe; that is why they are called &"hints"&.
23029
23030 The hints retry data contains suggested retry times based on the previous
23031 rules. In the case of a long-running problem with a remote host, it might
23032 record the fact that the host has timed out. If your new rules increase the
23033 timeout time for such a host, you should definitely remove the old retry data
23034 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23035 messages that it should now be retaining.
23036
23037
23038
23039 .section "Format of retry rules" "SECID158"
23040 .cindex "retry" "rules"
23041 Each retry rule occupies one line and consists of three or four parts,
23042 separated by white space: a pattern, an error name, an optional list of sender
23043 addresses, and a list of retry parameters. The pattern and sender lists must be
23044 enclosed in double quotes if they contain white space. The rules are searched
23045 in order until one is found where the pattern, error name, and sender list (if
23046 present) match the failing host or address, the error that occurred, and the
23047 message's sender, respectively.
23048
23049
23050 The pattern is any single item that may appear in an address list (see section
23051 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23052 which means that it is expanded before being tested against the address that
23053 has been delayed. A negated address list item is permitted. Address
23054 list processing treats a plain domain name as if it were preceded by &"*@"&,
23055 which makes it possible for many retry rules to start with just a domain. For
23056 example,
23057 .code
23058 lookingglass.fict.example        *  F,24h,30m;
23059 .endd
23060 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23061 whereas
23062 .code
23063 alice@lookingglass.fict.example  *  F,24h,30m;
23064 .endd
23065 applies only to temporary failures involving the local part &%alice%&.
23066 In practice, almost all rules start with a domain name pattern without a local
23067 part.
23068
23069 .cindex "regular expressions" "in retry rules"
23070 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23071 must match a complete address, not just a domain, because that is how regular
23072 expressions work in address lists.
23073 .display
23074 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23075 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23076 .endd
23077
23078
23079 .section "Choosing which retry rule to use for address errors" "SECID159"
23080 When Exim is looking for a retry rule after a routing attempt has failed (for
23081 example, after a DNS timeout), each line in the retry configuration is tested
23082 against the complete address only if &%retry_use_local_part%& is set for the
23083 router. Otherwise, only the domain is used, except when matching against a
23084 regular expression, when the local part of the address is replaced with &"*"&.
23085 A domain on its own can match a domain pattern, or a pattern that starts with
23086 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23087 &%check_local_user%& is true, and false for other routers.
23088
23089 Similarly, when Exim is looking for a retry rule after a local delivery has
23090 failed (for example, after a mailbox full error), each line in the retry
23091 configuration is tested against the complete address only if
23092 &%retry_use_local_part%& is set for the transport (it defaults true for all
23093 local transports).
23094
23095 .cindex "4&'xx'& responses" "retry rules for"
23096 However, when Exim is looking for a retry rule after a remote delivery attempt
23097 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23098 whole address is always used as the key when searching the retry rules. The
23099 rule that is found is used to create a retry time for the combination of the
23100 failing address and the message's sender. It is the combination of sender and
23101 recipient that is delayed in subsequent queue runs until its retry time is
23102 reached. You can delay the recipient without regard to the sender by setting
23103 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23104 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23105 commands.
23106
23107
23108
23109 .section "Choosing which retry rule to use for host and message errors" &&&
23110          "SECID160"
23111 For a temporary error that is not related to an individual address (for
23112 example, a connection timeout), each line in the retry configuration is checked
23113 twice. First, the name of the remote host is used as a domain name (preceded by
23114 &"*@"& when matching a regular expression). If this does not match the line,
23115 the domain from the email address is tried in a similar fashion. For example,
23116 suppose the MX records for &'a.b.c.example'& are
23117 .code
23118 a.b.c.example  MX  5  x.y.z.example
23119                MX  6  p.q.r.example
23120                MX  7  m.n.o.example
23121 .endd
23122 and the retry rules are
23123 .code
23124 p.q.r.example    *      F,24h,30m;
23125 a.b.c.example    *      F,4d,45m;
23126 .endd
23127 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23128 first rule matches neither the host nor the domain, so Exim looks at the second
23129 rule. This does not match the host, but it does match the domain, so it is used
23130 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23131 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23132 first retry rule is used, because it matches the host.
23133
23134 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23135 first rule to determine retry times, but for all the other hosts for the domain
23136 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23137 routing to &'a.b.c.example'& suffers a temporary failure.
23138
23139 &*Note*&: The host name is used when matching the patterns, not its IP address.
23140 However, if a message is routed directly to an IP address without the use of a
23141 host name, for example, if a &(manualroute)& router contains a setting such as:
23142 .code
23143 route_list = *.a.example  192.168.34.23
23144 .endd
23145 then the &"host name"& that is used when searching for a retry rule is the
23146 textual form of the IP address.
23147
23148 .section "Retry rules for specific errors" "SECID161"
23149 .cindex "retry" "specific errors; specifying"
23150 The second field in a retry rule is the name of a particular error, or an
23151 asterisk, which matches any error. The errors that can be tested for are:
23152
23153 .vlist
23154 .vitem &%auth_failed%&
23155 Authentication failed when trying to send to a host in the
23156 &%hosts_require_auth%& list in an &(smtp)& transport.
23157
23158 .vitem &%data_4xx%&
23159 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23160 after the command, or after sending the message's data.
23161
23162 .vitem &%mail_4xx%&
23163 A 4&'xx'& error was received for an outgoing MAIL command.
23164
23165 .vitem &%rcpt_4xx%&
23166 A 4&'xx'& error was received for an outgoing RCPT command.
23167 .endlist
23168
23169 For the three 4&'xx'& errors, either the first or both of the x's can be given
23170 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23171 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23172 and have retries every ten minutes with a one-hour timeout, you could set up a
23173 retry rule of this form:
23174 .code
23175 the.domain.name  rcpt_452   F,1h,10m
23176 .endd
23177 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23178 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23179
23180 .vlist
23181 .vitem &%lost_connection%&
23182 A server unexpectedly closed the SMTP connection. There may, of course,
23183 legitimate reasons for this (host died, network died), but if it repeats a lot
23184 for the same host, it indicates something odd.
23185
23186 .vitem &%refused_MX%&
23187 A connection to a host obtained from an MX record was refused.
23188
23189 .vitem &%refused_A%&
23190 A connection to a host not obtained from an MX record was refused.
23191
23192 .vitem &%refused%&
23193 A connection was refused.
23194
23195 .vitem &%timeout_connect_MX%&
23196 A connection attempt to a host obtained from an MX record timed out.
23197
23198 .vitem &%timeout_connect_A%&
23199 A connection attempt to a host not obtained from an MX record timed out.
23200
23201 .vitem &%timeout_connect%&
23202 A connection attempt timed out.
23203
23204 .vitem &%timeout_MX%&
23205 There was a timeout while connecting or during an SMTP session with a host
23206 obtained from an MX record.
23207
23208 .vitem &%timeout_A%&
23209 There was a timeout while connecting or during an SMTP session with a host not
23210 obtained from an MX record.
23211
23212 .vitem &%timeout%&
23213 There was a timeout while connecting or during an SMTP session.
23214
23215 .vitem &%tls_required%&
23216 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23217 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23218 to STARTTLS, or there was a problem setting up the TLS connection.
23219
23220 .vitem &%quota%&
23221 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23222 transport.
23223
23224 .vitem &%quota_%&<&'time'&>
23225 .cindex "quota" "error testing in retry rule"
23226 .cindex "retry" "quota error testing"
23227 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23228 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23229 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23230 for four days.
23231 .endlist
23232
23233 .cindex "mailbox" "time of last read"
23234 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23235 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23236 it should be based on the last time that the user accessed the mailbox.
23237 However, it is not always possible to determine this. Exim uses the following
23238 heuristic rules:
23239
23240 .ilist
23241 If the mailbox is a single file, the time of last access (the &"atime"&) is
23242 used. As no new messages are being delivered (because the mailbox is over
23243 quota), Exim does not access the file, so this is the time of last user access.
23244 .next
23245 .cindex "maildir format" "time of last read"
23246 For a maildir delivery, the time of last modification of the &_new_&
23247 subdirectory is used. As the mailbox is over quota, no new files are created in
23248 the &_new_& subdirectory, because no new messages are being delivered. Any
23249 change to the &_new_& subdirectory is therefore assumed to be the result of an
23250 MUA moving a new message to the &_cur_& directory when it is first read. The
23251 time that is used is therefore the last time that the user read a new message.
23252 .next
23253 For other kinds of multi-file mailbox, the time of last access cannot be
23254 obtained, so a retry rule that uses this type of error field is never matched.
23255 .endlist
23256
23257 The quota errors apply both to system-enforced quotas and to Exim's own quota
23258 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23259 when a local delivery is deferred because a partition is full (the ENOSPC
23260 error).
23261
23262
23263
23264 .section "Retry rules for specified senders" "SECID162"
23265 .cindex "retry" "rules; sender-specific"
23266 You can specify retry rules that apply only when the failing message has a
23267 specific sender. In particular, this can be used to define retry rules that
23268 apply only to bounce messages. The third item in a retry rule can be of this
23269 form:
23270 .display
23271 &`senders=`&<&'address list'&>
23272 .endd
23273 The retry timings themselves are then the fourth item. For example:
23274 .code
23275 *   rcpt_4xx   senders=:   F,1h,30m
23276 .endd
23277 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23278 host. If the address list contains white space, it must be enclosed in quotes.
23279 For example:
23280 .code
23281 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23282 .endd
23283 &*Warning*&: This facility can be unhelpful if it is used for host errors
23284 (which do not depend on the recipient). The reason is that the sender is used
23285 only to match the retry rule. Once the rule has been found for a host error,
23286 its contents are used to set a retry time for the host, and this will apply to
23287 all messages, not just those with specific senders.
23288
23289 When testing retry rules using &%-brt%&, you can supply a sender using the
23290 &%-f%& command line option, like this:
23291 .code
23292 exim -f "" -brt user@dom.ain
23293 .endd
23294 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23295 list is never matched.
23296
23297
23298
23299
23300
23301 .section "Retry parameters" "SECID163"
23302 .cindex "retry" "parameters in rules"
23303 The third (or fourth, if a senders list is present) field in a retry rule is a
23304 sequence of retry parameter sets, separated by semicolons. Each set consists of
23305 .display
23306 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23307 .endd
23308 The letter identifies the algorithm for computing a new retry time; the cutoff
23309 time is the time beyond which this algorithm no longer applies, and the
23310 arguments vary the algorithm's action. The cutoff time is measured from the
23311 time that the first failure for the domain (combined with the local part if
23312 relevant) was detected, not from the time the message was received.
23313
23314 .cindex "retry" "algorithms"
23315 .cindex "retry" "fixed intervals"
23316 .cindex "retry" "increasing intervals"
23317 .cindex "retry" "random intervals"
23318 The available algorithms are:
23319
23320 .ilist
23321 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23322 the interval.
23323 .next
23324 &'G'&: retry at geometrically increasing intervals. The first argument
23325 specifies a starting value for the interval, and the second a multiplier, which
23326 is used to increase the size of the interval at each retry.
23327 .next
23328 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23329 retry, the previous interval is multiplied by the factor in order to get a
23330 maximum for the next interval. The minimum interval is the first argument of
23331 the parameter, and an actual interval is chosen randomly between them. Such a
23332 rule has been found to be helpful in cluster configurations when all the
23333 members of the cluster restart at once, and may therefore synchronize their
23334 queue processing times.
23335 .endlist
23336
23337 When computing the next retry time, the algorithm definitions are scanned in
23338 order until one whose cutoff time has not yet passed is reached. This is then
23339 used to compute a new retry time that is later than the current time. In the
23340 case of fixed interval retries, this simply means adding the interval to the
23341 current time. For geometrically increasing intervals, retry intervals are
23342 computed from the rule's parameters until one that is greater than the previous
23343 interval is found. The main configuration variable
23344 .cindex "limit" "retry interval"
23345 .cindex "retry" "interval, maximum"
23346 .oindex "&%retry_interval_max%&"
23347 &%retry_interval_max%& limits the maximum interval between retries. It
23348 cannot be set greater than &`24h`&, which is its default value.
23349
23350 A single remote domain may have a number of hosts associated with it, and each
23351 host may have more than one IP address. Retry algorithms are selected on the
23352 basis of the domain name, but are applied to each IP address independently. If,
23353 for example, a host has two IP addresses and one is unusable, Exim will
23354 generate retry times for it and will not try to use it until its next retry
23355 time comes. Thus the good IP address is likely to be tried first most of the
23356 time.
23357
23358 .cindex "hints database" "use for retrying"
23359 Retry times are hints rather than promises. Exim does not make any attempt to
23360 run deliveries exactly at the computed times. Instead, a queue runner process
23361 starts delivery processes for delayed messages periodically, and these attempt
23362 new deliveries only for those addresses that have passed their next retry time.
23363 If a new message arrives for a deferred address, an immediate delivery attempt
23364 occurs only if the address has passed its retry time. In the absence of new
23365 messages, the minimum time between retries is the interval between queue runner
23366 processes. There is not much point in setting retry times of five minutes if
23367 your queue runners happen only once an hour, unless there are a significant
23368 number of incoming messages (which might be the case on a system that is
23369 sending everything to a smart host, for example).
23370
23371 The data in the retry hints database can be inspected by using the
23372 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23373 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23374 &'exinext'& utility script can be used to find out what the next retry times
23375 are for the hosts associated with a particular mail domain, and also for local
23376 deliveries that have been deferred.
23377
23378
23379 .section "Retry rule examples" "SECID164"
23380 Here are some example retry rules:
23381 .code
23382 alice@wonderland.fict.example quota_5d  F,7d,3h
23383 wonderland.fict.example       quota_5d
23384 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23385 lookingglass.fict.example     *         F,24h,30m;
23386 *                 refused_A   F,2h,20m;
23387 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23388 .endd
23389 The first rule sets up special handling for mail to
23390 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23391 mailbox has not been read for at least 5 days. Retries continue every three
23392 hours for 7 days. The second rule handles over-quota errors for all other local
23393 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23394 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23395 fail are bounced immediately if the mailbox has not been read for at least 5
23396 days.
23397
23398 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23399 happen every 15 minutes for an hour, then with geometrically increasing
23400 intervals until two days have passed since a delivery first failed. After the
23401 first hour there is a delay of one hour, then two hours, then four hours, and
23402 so on (this is a rather extreme example).
23403
23404 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23405 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23406 all other domains, with special action for connection refusal from hosts that
23407 were not obtained from an MX record.
23408
23409 The final rule in a retry configuration should always have asterisks in the
23410 first two fields so as to provide a general catch-all for any addresses that do
23411 not have their own special handling. This example tries every 15 minutes for 2
23412 hours, then with intervals starting at one hour and increasing by a factor of
23413 1.5 up to 16 hours, then every 8 hours up to 5 days.
23414
23415
23416
23417 .section "Timeout of retry data" "SECID165"
23418 .cindex "timeout" "of retry data"
23419 .oindex "&%retry_data_expire%&"
23420 .cindex "hints database" "data expiry"
23421 .cindex "retry" "timeout of data"
23422 Exim timestamps the data that it writes to its retry hints database. When it
23423 consults the data during a delivery it ignores any that is older than the value
23424 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23425 been tried for 7 days, Exim will try to deliver to it immediately a message
23426 arrives, and if that fails, it will calculate a retry time as if it were
23427 failing for the first time.
23428
23429 This improves the behaviour for messages routed to rarely-used hosts such as MX
23430 backups. If such a host was down at one time, and happens to be down again when
23431 Exim tries a month later, using the old retry data would imply that it had been
23432 down all the time, which is not a justified assumption.
23433
23434 If a host really is permanently dead, this behaviour causes a burst of retries
23435 every now and again, but only if messages routed to it are rare. If there is a
23436 message at least once every 7 days the retry data never expires.
23437
23438
23439
23440
23441 .section "Long-term failures" "SECID166"
23442 .cindex "delivery failure, long-term"
23443 .cindex "retry" "after long-term failure"
23444 Special processing happens when an email address has been failing for so long
23445 that the cutoff time for the last algorithm is reached. For example, using the
23446 default retry rule:
23447 .code
23448 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23449 .endd
23450 the cutoff time is four days. Reaching the retry cutoff is independent of how
23451 long any specific message has been failing; it is the length of continuous
23452 failure for the recipient address that counts.
23453
23454 When the cutoff time is reached for a local delivery, or for all the IP
23455 addresses associated with a remote delivery, a subsequent delivery failure
23456 causes Exim to give up on the address, and a bounce message is generated.
23457 In order to cater for new messages that use the failing address, a next retry
23458 time is still computed from the final algorithm, and is used as follows:
23459
23460 For local deliveries, one delivery attempt is always made for any subsequent
23461 messages. If this delivery fails, the address fails immediately. The
23462 post-cutoff retry time is not used.
23463
23464 If the delivery is remote, there are two possibilities, controlled by the
23465 .oindex "&%delay_after_cutoff%&"
23466 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23467 default. Until the post-cutoff retry time for one of the IP addresses is
23468 reached, the failing email address is bounced immediately, without a delivery
23469 attempt taking place. After that time, one new delivery attempt is made to
23470 those IP addresses that are past their retry times, and if that still fails,
23471 the address is bounced and new retry times are computed.
23472
23473 In other words, when all the hosts for a given email address have been failing
23474 for a long time, Exim bounces rather then defers until one of the hosts' retry
23475 times is reached. Then it tries once, and bounces if that attempt fails. This
23476 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23477 to a broken destination, but if the host does recover, Exim will eventually
23478 notice.
23479
23480 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23481 addresses are past their final cutoff time, Exim tries to deliver to those IP
23482 addresses that have not been tried since the message arrived. If there are
23483 no suitable IP addresses, or if they all fail, the address is bounced. In other
23484 words, it does not delay when a new message arrives, but tries the expired
23485 addresses immediately, unless they have been tried since the message arrived.
23486 If there is a continuous stream of messages for the failing domains, setting
23487 &%delay_after_cutoff%& false means that there will be many more attempts to
23488 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23489 true.
23490
23491 .section "Deliveries that work intermittently" "SECID167"
23492 .cindex "retry" "intermittently working deliveries"
23493 Some additional logic is needed to cope with cases where a host is
23494 intermittently available, or when a message has some attribute that prevents
23495 its delivery when others to the same address get through. In this situation,
23496 because some messages are successfully delivered, the &"retry clock"& for the
23497 host or address keeps getting reset by the successful deliveries, and so
23498 failing messages remain on the queue for ever because the cutoff time is never
23499 reached.
23500
23501 Two exceptional actions are applied to prevent this happening. The first
23502 applies to errors that are related to a message rather than a remote host.
23503 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23504 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23505 commands, and quota failures. For this type of error, if a message's arrival
23506 time is earlier than the &"first failed"& time for the error, the earlier time
23507 is used when scanning the retry rules to decide when to try next and when to
23508 time out the address.
23509
23510 The exceptional second action applies in all cases. If a message has been on
23511 the queue for longer than the cutoff time of any applicable retry rule for a
23512 given address, a delivery is attempted for that address, even if it is not yet
23513 time, and if this delivery fails, the address is timed out. A new retry time is
23514 not computed in this case, so that other messages for the same address are
23515 considered immediately.
23516 .ecindex IIDretconf1
23517 .ecindex IIDregconf2
23518
23519
23520
23521
23522
23523
23524 . ////////////////////////////////////////////////////////////////////////////
23525 . ////////////////////////////////////////////////////////////////////////////
23526
23527 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23528 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23529 .scindex IIDauthconf2 "authentication"
23530 The &"authenticators"& section of Exim's run time configuration is concerned
23531 with SMTP authentication. This facility is an extension to the SMTP protocol,
23532 described in RFC 2554, which allows a client SMTP host to authenticate itself
23533 to a server. This is a common way for a server to recognize clients that are
23534 permitted to use it as a relay. SMTP authentication is not of relevance to the
23535 transfer of mail between servers that have no managerial connection with each
23536 other.
23537
23538 .cindex "AUTH" "description of"
23539 Very briefly, the way SMTP authentication works is as follows:
23540
23541 .ilist
23542 The server advertises a number of authentication &'mechanisms'& in response to
23543 the client's EHLO command.
23544 .next
23545 The client issues an AUTH command, naming a specific mechanism. The command
23546 may, optionally, contain some authentication data.
23547 .next
23548 The server may issue one or more &'challenges'&, to which the client must send
23549 appropriate responses. In simple authentication mechanisms, the challenges are
23550 just prompts for user names and passwords. The server does not have to issue
23551 any challenges &-- in some mechanisms the relevant data may all be transmitted
23552 with the AUTH command.
23553 .next
23554 The server either accepts or denies authentication.
23555 .next
23556 If authentication succeeds, the client may optionally make use of the AUTH
23557 option on the MAIL command to pass an authenticated sender in subsequent
23558 mail transactions. Authentication lasts for the remainder of the SMTP
23559 connection.
23560 .next
23561 If authentication fails, the client may give up, or it may try a different
23562 authentication mechanism, or it may try transferring mail over the
23563 unauthenticated connection.
23564 .endlist
23565
23566 If you are setting up a client, and want to know which authentication
23567 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23568 SMTP port) on the server, and issue an EHLO command. The response to this
23569 includes the list of supported mechanisms. For example:
23570 .display
23571 &`$ `&&*&`telnet server.example 25`&*&
23572 &`Trying 192.168.34.25...`&
23573 &`Connected to server.example.`&
23574 &`Escape character is &#x0027;^]&#x0027;.`&
23575 &`220 server.example ESMTP Exim 4.20 ...`&
23576 &*&`ehlo client.example`&*&
23577 &`250-server.example Hello client.example [10.8.4.5]`&
23578 &`250-SIZE 52428800`&
23579 &`250-PIPELINING`&
23580 &`250-AUTH PLAIN`&
23581 &`250 HELP`&
23582 .endd
23583 The second-last line of this example output shows that the server supports
23584 authentication using the PLAIN mechanism. In Exim, the different authentication
23585 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23586 routers and transports, which authenticators are included in the binary is
23587 controlled by build-time definitions. The following are currently available,
23588 included by setting
23589 .code
23590 AUTH_CRAM_MD5=yes
23591 AUTH_CYRUS_SASL=yes
23592 .new
23593 AUTH_DOVECOT=yes
23594 AUTH_GSASL=yes
23595 AUTH_HEIMDAL_GSSAPI=yes
23596 .wen
23597 AUTH_PLAINTEXT=yes
23598 AUTH_SPA=yes
23599 .endd
23600 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23601 authentication mechanism (RFC 2195), and the second provides an interface to
23602 the Cyrus SASL authentication library.
23603 .new
23604 The third is an interface to Dovecot's authentication system, delegating the
23605 work via a socket interface.
23606 The fourth provides an interface to the GNU SASL authentication library, which
23607 provides mechanisms but typically not data sources.
23608 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
23609 supporting setting a server keytab.
23610 The sixth can be configured to support
23611 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23612 not formally documented, but used by several MUAs. The seventh authenticator
23613 supports Microsoft's &'Secure Password Authentication'& mechanism.
23614 .wen
23615
23616 The authenticators are configured using the same syntax as other drivers (see
23617 section &<<SECTfordricon>>&). If no authenticators are required, no
23618 authentication section need be present in the configuration file. Each
23619 authenticator can in principle have both server and client functions. When Exim
23620 is receiving SMTP mail, it is acting as a server; when it is sending out
23621 messages over SMTP, it is acting as a client. Authenticator configuration
23622 options are provided for use in both these circumstances.
23623
23624 To make it clear which options apply to which situation, the prefixes
23625 &%server_%& and &%client_%& are used on option names that are specific to
23626 either the server or the client function, respectively. Server and client
23627 functions are disabled if none of their options are set. If an authenticator is
23628 to be used for both server and client functions, a single definition, using
23629 both sets of options, is required. For example:
23630 .code
23631 cram:
23632   driver = cram_md5
23633   public_name = CRAM-MD5
23634   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23635   client_name = ph10
23636   client_secret = secret2
23637 .endd
23638 The &%server_%& option is used when Exim is acting as a server, and the
23639 &%client_%& options when it is acting as a client.
23640
23641 Descriptions of the individual authenticators are given in subsequent chapters.
23642 The remainder of this chapter covers the generic options for the
23643 authenticators, followed by general discussion of the way authentication works
23644 in Exim.
23645
23646 .new
23647 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
23648 per-mechanism basis.  Please read carefully to determine which variables hold
23649 account labels such as usercodes and which hold passwords or other
23650 authenticating data.
23651
23652 Note that some mechanisms support two different identifiers for accounts: the
23653 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
23654 and &'authz'& are commonly encountered.  The American spelling is standard here.
23655 Conceptually, authentication data such as passwords are tied to the identifier
23656 used to authenticate; servers may have rules to permit one user to act as a
23657 second user, so that after login the session is treated as though that second
23658 user had logged in.  That second user is the &'authorization id'&.  A robust
23659 configuration might confirm that the &'authz'& field is empty or matches the
23660 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
23661 as verified data, the &'authz'& as an unverified request which the server might
23662 choose to honour.
23663
23664 A &'realm'& is a text string, typically a domain name, presented by a server
23665 to a client to help it select an account and credentials to use.  In some
23666 mechanisms, the client and server provably agree on the realm, but clients
23667 typically can not treat the realm as secure data to be blindly trusted.
23668 .wen
23669
23670
23671
23672 .section "Generic options for authenticators" "SECID168"
23673 .cindex "authentication" "generic options"
23674 .cindex "options" "generic; for authenticators"
23675
23676 .option client_condition authenticators string&!! unset
23677 When Exim is authenticating as a client, it skips any authenticator whose
23678 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23679 used, for example, to skip plain text authenticators when the connection is not
23680 encrypted by a setting such as:
23681 .code
23682 client_condition = ${if !eq{$tls_cipher}{}}
23683 .endd
23684 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23685 used for incoming messages. In fact, during SMTP delivery, it contains the
23686 cipher used for the delivery.)
23687
23688
23689 .option driver authenticators string unset
23690 This option must always be set. It specifies which of the available
23691 authenticators is to be used.
23692
23693
23694 .option public_name authenticators string unset
23695 This option specifies the name of the authentication mechanism that the driver
23696 implements, and by which it is known to the outside world. These names should
23697 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23698 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23699 defaults to the driver's instance name.
23700
23701
23702 .option server_advertise_condition authenticators string&!! unset
23703 When a server is about to advertise an authentication mechanism, the condition
23704 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23705 mechanism is not advertised.
23706 If the expansion fails, the mechanism is not advertised. If the failure was not
23707 forced, and was not caused by a lookup defer, the incident is logged.
23708 See section &<<SECTauthexiser>>& below for further discussion.
23709
23710
23711 .option server_condition authenticators string&!! unset
23712 This option must be set for a &%plaintext%& server authenticator, where it
23713 is used directly to control authentication. See section &<<SECTplainserver>>&
23714 for details.
23715
23716 .new
23717 For the &(gsasl)& authenticator, this option is required for various
23718 mechanisms; see chapter &<<CHAPgsasl>>& for details.
23719 .wen
23720
23721 For the other authenticators, &%server_condition%& can be used as an additional
23722 authentication or authorization mechanism that is applied after the other
23723 authenticator conditions succeed. If it is set, it is expanded when the
23724 authenticator would otherwise return a success code. If the expansion is forced
23725 to fail, authentication fails. Any other expansion failure causes a temporary
23726 error code to be returned. If the result of a successful expansion is an empty
23727 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23728 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23729 other result, a temporary error code is returned, with the expanded string as
23730 the error text.
23731
23732
23733 .option server_debug_print authenticators string&!! unset
23734 If this option is set and authentication debugging is enabled (see the &%-d%&
23735 command line option), the string is expanded and included in the debugging
23736 output when the authenticator is run as a server. This can help with checking
23737 out the values of variables.
23738 If expansion of the string fails, the error message is written to the debugging
23739 output, and Exim carries on processing.
23740
23741
23742 .option server_set_id authenticators string&!! unset
23743 .vindex "&$authenticated_id$&"
23744 When an Exim server successfully authenticates a client, this string is
23745 expanded using data from the authentication, and preserved for any incoming
23746 messages in the variable &$authenticated_id$&. It is also included in the log
23747 lines for incoming messages. For example, a user/password authenticator
23748 configuration might preserve the user name that was used to authenticate, and
23749 refer to it subsequently during delivery of the message.
23750 If expansion fails, the option is ignored.
23751
23752
23753 .option server_mail_auth_condition authenticators string&!! unset
23754 This option allows a server to discard authenticated sender addresses supplied
23755 as part of MAIL commands in SMTP connections that are authenticated by the
23756 driver on which &%server_mail_auth_condition%& is set. The option is not used
23757 as part of the authentication process; instead its (unexpanded) value is
23758 remembered for later use.
23759 How it is used is described in the following section.
23760
23761
23762
23763
23764
23765 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23766 .cindex "authentication" "sender; authenticated"
23767 .cindex "AUTH" "on MAIL command"
23768 When a client supplied an AUTH= item on a MAIL command, Exim applies
23769 the following checks before accepting it as the authenticated sender of the
23770 message:
23771
23772 .ilist
23773 If the connection is not using extended SMTP (that is, HELO was used rather
23774 than EHLO), the use of AUTH= is a syntax error.
23775 .next
23776 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23777 .next
23778 .vindex "&$authenticated_sender$&"
23779 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23780 running, the value of &$authenticated_sender$& is set to the value obtained
23781 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23782 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23783 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23784 given for the MAIL command.
23785 .next
23786 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23787 is accepted and placed in &$authenticated_sender$& only if the client has
23788 authenticated.
23789 .next
23790 If the AUTH= value was accepted by either of the two previous rules, and
23791 the client has authenticated, and the authenticator has a setting for the
23792 &%server_mail_auth_condition%&, the condition is checked at this point. The
23793 valued that was saved from the authenticator is expanded. If the expansion
23794 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23795 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23796 the value of &$authenticated_sender$& is retained and passed on with the
23797 message.
23798 .endlist
23799
23800
23801 When &$authenticated_sender$& is set for a message, it is passed on to other
23802 hosts to which Exim authenticates as a client. Do not confuse this value with
23803 &$authenticated_id$&, which is a string obtained from the authentication
23804 process, and which is not usually a complete email address.
23805
23806 .vindex "&$sender_address$&"
23807 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23808 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23809 therefore make use of &$authenticated_sender$&. The converse is not true: the
23810 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23811 ACL is run.
23812
23813
23814
23815 .section "Authentication on an Exim server" "SECTauthexiser"
23816 .cindex "authentication" "on an Exim server"
23817 When Exim receives an EHLO command, it advertises the public names of those
23818 authenticators that are configured as servers, subject to the following
23819 conditions:
23820
23821 .ilist
23822 The client host must match &%auth_advertise_hosts%& (default *).
23823 .next
23824 It the &%server_advertise_condition%& option is set, its expansion must not
23825 yield the empty string, &"0"&, &"no"&, or &"false"&.
23826 .endlist
23827
23828 The order in which the authenticators are defined controls the order in which
23829 the mechanisms are advertised.
23830
23831 Some mail clients (for example, some versions of Netscape) require the user to
23832 provide a name and password for authentication whenever AUTH is advertised,
23833 even though authentication may not in fact be needed (for example, Exim may be
23834 set up to allow unconditional relaying from the client by an IP address check).
23835 You can make such clients more friendly by not advertising AUTH to them.
23836 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23837 that runs for RCPT) to relay without authentication, you should set
23838 .code
23839 auth_advertise_hosts = ! 10.9.8.0/24
23840 .endd
23841 so that no authentication mechanisms are advertised to them.
23842
23843 The &%server_advertise_condition%& controls the advertisement of individual
23844 authentication mechanisms. For example, it can be used to restrict the
23845 advertisement of a particular mechanism to encrypted connections, by a setting
23846 such as:
23847 .code
23848 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23849 .endd
23850 .vindex "&$tls_cipher$&"
23851 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23852 yields &"yes"&, which allows the advertisement to happen.
23853
23854 When an Exim server receives an AUTH command from a client, it rejects it
23855 immediately if AUTH was not advertised in response to an earlier EHLO
23856 command. This is the case if
23857
23858 .ilist
23859 The client host does not match &%auth_advertise_hosts%&; or
23860 .next
23861 No authenticators are configured with server options; or
23862 .next
23863 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23864 server authenticators.
23865 .endlist
23866
23867
23868 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23869 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23870 AUTH is accepted from any client host.
23871
23872 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23873 server authentication mechanism that was advertised in response to EHLO and
23874 that matches the one named in the AUTH command. If it finds one, it runs
23875 the appropriate authentication protocol, and authentication either succeeds or
23876 fails. If there is no matching advertised mechanism, the AUTH command is
23877 rejected with a 504 error.
23878
23879 .vindex "&$received_protocol$&"
23880 .vindex "&$sender_host_authenticated$&"
23881 When a message is received from an authenticated host, the value of
23882 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23883 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23884 public name) of the authenticator driver that successfully authenticated the
23885 client from which the message was received. This variable is empty if there was
23886 no successful authentication.
23887
23888
23889
23890
23891 .section "Testing server authentication" "SECID169"
23892 .cindex "authentication" "testing a server"
23893 .cindex "AUTH" "testing a server"
23894 .cindex "base64 encoding" "creating authentication test data"
23895 Exim's &%-bh%& option can be useful for testing server authentication
23896 configurations. The data for the AUTH command has to be sent using base64
23897 encoding. A quick way to produce such data for testing is the following Perl
23898 script:
23899 .code
23900 use MIME::Base64;
23901 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23902 .endd
23903 .cindex "binary zero" "in authentication data"
23904 This interprets its argument as a Perl string, and then encodes it. The
23905 interpretation as a Perl string allows binary zeros, which are required for
23906 some kinds of authentication, to be included in the data. For example, a
23907 command line to run this script on such data might be
23908 .code
23909 encode '\0user\0password'
23910 .endd
23911 Note the use of single quotes to prevent the shell interpreting the
23912 backslashes, so that they can be interpreted by Perl to specify characters
23913 whose code value is zero.
23914
23915 &*Warning 1*&: If either of the user or password strings starts with an octal
23916 digit, you must use three zeros instead of one after the leading backslash. If
23917 you do not, the octal digit that starts your string will be incorrectly
23918 interpreted as part of the code for the first character.
23919
23920 &*Warning 2*&: If there are characters in the strings that Perl interprets
23921 specially, you must use a Perl escape to prevent them being misinterpreted. For
23922 example, a command such as
23923 .code
23924 encode '\0user@domain.com\0pas$$word'
23925 .endd
23926 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23927
23928 If you have the &%mimencode%& command installed, another way to do produce
23929 base64-encoded strings is to run the command
23930 .code
23931 echo -e -n `\0user\0password' | mimencode
23932 .endd
23933 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23934 in the argument, and the &%-n%& option specifies no newline at the end of its
23935 output. However, not all versions of &%echo%& recognize these options, so you
23936 should check your version before relying on this suggestion.
23937
23938
23939
23940 .section "Authentication by an Exim client" "SECID170"
23941 .cindex "authentication" "on an Exim client"
23942 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23943 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23944 announces support for authentication, and the host matches an entry in either
23945 of these options, Exim (as a client) tries to authenticate as follows:
23946
23947 .ilist
23948 For each authenticator that is configured as a client, in the order in which
23949 they are defined in the configuration, it searches the authentication
23950 mechanisms announced by the server for one whose name matches the public name
23951 of the authenticator.
23952 .next
23953 .vindex "&$host$&"
23954 .vindex "&$host_address$&"
23955 When it finds one that matches, it runs the authenticator's client code. The
23956 variables &$host$& and &$host_address$& are available for any string expansions
23957 that the client might do. They are set to the server's name and IP address. If
23958 any expansion is forced to fail, the authentication attempt is abandoned, and
23959 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23960 delivery to be deferred.
23961 .next
23962 If the result of the authentication attempt is a temporary error or a timeout,
23963 Exim abandons trying to send the message to the host for the moment. It will
23964 try again later. If there are any backup hosts available, they are tried in the
23965 usual way.
23966 .next
23967 If the response to authentication is a permanent error (5&'xx'& code), Exim
23968 carries on searching the list of authenticators and tries another one if
23969 possible. If all authentication attempts give permanent errors, or if there are
23970 no attempts because no mechanisms match (or option expansions force failure),
23971 what happens depends on whether the host matches &%hosts_require_auth%& or
23972 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
23973 delivery is deferred. The error can be detected in the retry rules, and thereby
23974 turned into a permanent error if you wish. In the second case, Exim tries to
23975 deliver the message unauthenticated.
23976 .endlist
23977
23978 .cindex "AUTH" "on MAIL command"
23979 When Exim has authenticated itself to a remote server, it adds the AUTH
23980 parameter to the MAIL commands it sends, if it has an authenticated sender for
23981 the message. If the message came from a remote host, the authenticated sender
23982 is the one that was receiving on an incoming MAIL command, provided that the
23983 incoming connection was authenticated and the &%server_mail_auth%& condition
23984 allowed the authenticated sender to be retained. If a local process calls Exim
23985 to send a message, the sender address that is built from the login name and
23986 &%qualify_domain%& is treated as authenticated. However, if the
23987 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
23988 the authenticated sender that was received with the message.
23989 .ecindex IIDauthconf1
23990 .ecindex IIDauthconf2
23991
23992
23993
23994
23995
23996
23997 . ////////////////////////////////////////////////////////////////////////////
23998 . ////////////////////////////////////////////////////////////////////////////
23999
24000 .chapter "The plaintext authenticator" "CHAPplaintext"
24001 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24002 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24003 The &(plaintext)& authenticator can be configured to support the PLAIN and
24004 LOGIN authentication mechanisms, both of which transfer authentication data as
24005 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24006 security risk; you are strongly advised to insist on the use of SMTP encryption
24007 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24008 use unencrypted plain text, you should not use the same passwords for SMTP
24009 connections as you do for login accounts.
24010
24011 .section "Plaintext options" "SECID171"
24012 .cindex "options" "&(plaintext)& authenticator (server)"
24013 When configured as a server, &(plaintext)& uses the following options:
24014
24015 .option server_condition authenticators string&!! unset
24016 This is actually a global authentication option, but it must be set in order to
24017 configure the &(plaintext)& driver as a server. Its use is described below.
24018
24019 .option server_prompts plaintext string&!! unset
24020 The contents of this option, after expansion, must be a colon-separated list of
24021 prompt strings. If expansion fails, a temporary authentication rejection is
24022 given.
24023
24024 .section "Using plaintext in a server" "SECTplainserver"
24025 .cindex "AUTH" "in &(plaintext)& authenticator"
24026 .cindex "binary zero" "in &(plaintext)& authenticator"
24027 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24028         "in &(plaintext)& authenticator"
24029 .vindex "&$auth1$&, &$auth2$&, etc"
24030 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24031
24032 When running as a server, &(plaintext)& performs the authentication test by
24033 expanding a string. The data sent by the client with the AUTH command, or in
24034 response to subsequent prompts, is base64 encoded, and so may contain any byte
24035 values when decoded. If any data is supplied with the command, it is treated as
24036 a list of strings, separated by NULs (binary zeros), the first three of which
24037 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24038 (neither LOGIN nor PLAIN uses more than three strings).
24039
24040 For compatibility with previous releases of Exim, the values are also placed in
24041 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24042 variables for this purpose is now deprecated, as it can lead to confusion in
24043 string expansions that also use them for other things.
24044
24045 If there are more strings in &%server_prompts%& than the number of strings
24046 supplied with the AUTH command, the remaining prompts are used to obtain more
24047 data. Each response from the client may be a list of NUL-separated strings.
24048
24049 .vindex "&$authenticated_id$&"
24050 Once a sufficient number of data strings have been received,
24051 &%server_condition%& is expanded. If the expansion is forced to fail,
24052 authentication fails. Any other expansion failure causes a temporary error code
24053 to be returned. If the result of a successful expansion is an empty string,
24054 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24055 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24056 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24057 For any other result, a temporary error code is returned, with the expanded
24058 string as the error text.
24059
24060 &*Warning*&: If you use a lookup in the expansion to find the user's
24061 password, be sure to make the authentication fail if the user is unknown.
24062 There are good and bad examples at the end of the next section.
24063
24064
24065
24066 .section "The PLAIN authentication mechanism" "SECID172"
24067 .cindex "PLAIN authentication mechanism"
24068 .cindex "authentication" "PLAIN mechanism"
24069 .cindex "binary zero" "in &(plaintext)& authenticator"
24070 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24071 sent as one item of data (that is, one combined string containing two NUL
24072 separators). The data is sent either as part of the AUTH command, or
24073 subsequently in response to an empty prompt from the server.
24074
24075 The second and third strings are a user name and a corresponding password.
24076 Using a single fixed user name and password as an example, this could be
24077 configured as follows:
24078 .code
24079 fixed_plain:
24080   driver = plaintext
24081   public_name = PLAIN
24082   server_prompts = :
24083   server_condition = \
24084     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24085   server_set_id = $auth2
24086 .endd
24087 Note that the default result strings from &%if%& (&"true"& or an empty string)
24088 are exactly what we want here, so they need not be specified. Obviously, if the
24089 password contains expansion-significant characters such as dollar, backslash,
24090 or closing brace, they have to be escaped.
24091
24092 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24093 the end of a string list are ignored). If all the data comes as part of the
24094 AUTH command, as is commonly the case, the prompt is not used. This
24095 authenticator is advertised in the response to EHLO as
24096 .code
24097 250-AUTH PLAIN
24098 .endd
24099 and a client host can authenticate itself by sending the command
24100 .code
24101 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24102 .endd
24103 As this contains three strings (more than the number of prompts), no further
24104 data is required from the client. Alternatively, the client may just send
24105 .code
24106 AUTH PLAIN
24107 .endd
24108 to initiate authentication, in which case the server replies with an empty
24109 prompt. The client must respond with the combined data string.
24110
24111 The data string is base64 encoded, as required by the RFC. This example,
24112 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24113 represents a zero byte. This is split up into three strings, the first of which
24114 is empty. The &%server_condition%& option in the authenticator checks that the
24115 second two are &`username`& and &`mysecret`& respectively.
24116
24117 Having just one fixed user name and password, as in this example, is not very
24118 realistic, though for a small organization with only a handful of
24119 authenticating clients it could make sense.
24120
24121 A more sophisticated instance of this authenticator could use the user name in
24122 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24123 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24124 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24125 This is an incorrect example:
24126 .code
24127 server_condition = \
24128   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24129 .endd
24130 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24131 which it then compares to the supplied password (&$auth3$&). Why is this example
24132 incorrect? It works fine for existing users, but consider what happens if a
24133 non-existent user name is given. The lookup fails, but as no success/failure
24134 strings are given for the lookup, it yields an empty string. Thus, to defeat
24135 the authentication, all a client has to do is to supply a non-existent user
24136 name and an empty password. The correct way of writing this test is:
24137 .code
24138 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24139   {${if eq{$value}{$auth3}}} {false}}
24140 .endd
24141 In this case, if the lookup succeeds, the result is checked; if the lookup
24142 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24143 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24144 always fails if its second argument is empty. However, the second way of
24145 writing the test makes the logic clearer.
24146
24147
24148 .section "The LOGIN authentication mechanism" "SECID173"
24149 .cindex "LOGIN authentication mechanism"
24150 .cindex "authentication" "LOGIN mechanism"
24151 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24152 in a number of programs. No data is sent with the AUTH command. Instead, a
24153 user name and password are supplied separately, in response to prompts. The
24154 plaintext authenticator can be configured to support this as in this example:
24155 .code
24156 fixed_login:
24157   driver = plaintext
24158   public_name = LOGIN
24159   server_prompts = User Name : Password
24160   server_condition = \
24161     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24162   server_set_id = $auth1
24163 .endd
24164 Because of the way plaintext operates, this authenticator accepts data supplied
24165 with the AUTH command (in contravention of the specification of LOGIN), but
24166 if the client does not supply it (as is the case for LOGIN clients), the prompt
24167 strings are used to obtain two data items.
24168
24169 Some clients are very particular about the precise text of the prompts. For
24170 example, Outlook Express is reported to recognize only &"Username:"& and
24171 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24172 strings. It uses the &%ldapauth%& expansion condition to check the user
24173 name and password by binding to an LDAP server:
24174 .code
24175 login:
24176   driver = plaintext
24177   public_name = LOGIN
24178   server_prompts = Username:: : Password::
24179   server_condition = ${if and{{ \
24180     !eq{}{$auth1} }{ \
24181     ldapauth{\
24182       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24183       pass=${quote:$auth2} \
24184       ldap://ldap.example.org/} }} }
24185   server_set_id = uid=$auth1,ou=people,o=example.org
24186 .endd
24187 We have to check that the username is not empty before using it, because LDAP
24188 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24189 operator to correctly quote the DN for authentication. However, the basic
24190 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24191 correct one to use for the password, because quoting is needed only to make
24192 the password conform to the Exim syntax. At the LDAP level, the password is an
24193 uninterpreted string.
24194
24195
24196 .section "Support for different kinds of authentication" "SECID174"
24197 A number of string expansion features are provided for the purpose of
24198 interfacing to different ways of user authentication. These include checking
24199 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24200 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24201 &<<SECTexpcond>>&.
24202
24203
24204
24205
24206 .section "Using plaintext in a client" "SECID175"
24207 .cindex "options" "&(plaintext)& authenticator (client)"
24208 The &(plaintext)& authenticator has two client options:
24209
24210 .option client_ignore_invalid_base64 plaintext boolean false
24211 If the client receives a server prompt that is not a valid base64 string,
24212 authentication is abandoned by default. However, if this option is set true,
24213 the error in the challenge is ignored and the client sends the response as
24214 usual.
24215
24216 .option client_send plaintext string&!! unset
24217 The string is a colon-separated list of authentication data strings. Each
24218 string is independently expanded before being sent to the server. The first
24219 string is sent with the AUTH command; any more strings are sent in response
24220 to prompts from the server. Before each string is expanded, the value of the
24221 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24222 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24223 way. Thus, the prompt that is received in response to sending the first string
24224 (with the AUTH command) can be used in the expansion of the second string, and
24225 so on. If an invalid base64 string is received when
24226 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24227 &$auth$&<&'n'&> variable.
24228
24229 &*Note*&: You cannot use expansion to create multiple strings, because
24230 splitting takes priority and happens first.
24231
24232 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24233 the data, further processing is applied to each string before it is sent. If
24234 there are any single circumflex characters in the string, they are converted to
24235 NULs. Should an actual circumflex be required as data, it must be doubled in
24236 the string.
24237
24238 This is an example of a client configuration that implements the PLAIN
24239 authentication mechanism with a fixed user name and password:
24240 .code
24241 fixed_plain:
24242   driver = plaintext
24243   public_name = PLAIN
24244   client_send = ^username^mysecret
24245 .endd
24246 The lack of colons means that the entire text is sent with the AUTH
24247 command, with the circumflex characters converted to NULs. A similar example
24248 that uses the LOGIN mechanism is:
24249 .code
24250 fixed_login:
24251   driver = plaintext
24252   public_name = LOGIN
24253   client_send = : username : mysecret
24254 .endd
24255 The initial colon means that the first string is empty, so no data is sent with
24256 the AUTH command itself. The remaining strings are sent in response to
24257 prompts.
24258 .ecindex IIDplaiauth1
24259 .ecindex IIDplaiauth2
24260
24261
24262
24263
24264 . ////////////////////////////////////////////////////////////////////////////
24265 . ////////////////////////////////////////////////////////////////////////////
24266
24267 .chapter "The cram_md5 authenticator" "CHID9"
24268 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24269 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24270 .cindex "CRAM-MD5 authentication mechanism"
24271 .cindex "authentication" "CRAM-MD5 mechanism"
24272 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24273 sends a challenge string to the client, and the response consists of a user
24274 name and the CRAM-MD5 digest of the challenge string combined with a secret
24275 string (password) which is known to both server and client. Thus, the secret
24276 is not sent over the network as plain text, which makes this authenticator more
24277 secure than &(plaintext)&. However, the downside is that the secret has to be
24278 available in plain text at either end.
24279
24280
24281 .section "Using cram_md5 as a server" "SECID176"
24282 .cindex "options" "&(cram_md5)& authenticator (server)"
24283 This authenticator has one server option, which must be set to configure the
24284 authenticator as a server:
24285
24286 .option server_secret cram_md5 string&!! unset
24287 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24288 When the server receives the client's response, the user name is placed in
24289 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24290 obtain the password for that user. The server then computes the CRAM-MD5 digest
24291 that the client should have sent, and checks that it received the correct
24292 string. If the expansion of &%server_secret%& is forced to fail, authentication
24293 fails. If the expansion fails for some other reason, a temporary error code is
24294 returned to the client.
24295
24296 For compatibility with previous releases of Exim, the user name is also placed
24297 in &$1$&. However, the use of this variables for this purpose is now
24298 deprecated, as it can lead to confusion in string expansions that also use
24299 numeric variables for other things.
24300
24301 For example, the following authenticator checks that the user name given by the
24302 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24303 user name, authentication fails.
24304 .code
24305 fixed_cram:
24306   driver = cram_md5
24307   public_name = CRAM-MD5
24308   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24309   server_set_id = $auth1
24310 .endd
24311 .vindex "&$authenticated_id$&"
24312 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24313 name in &$authenticated_id$&. A more typical configuration might look up the
24314 secret string in a file, using the user name as the key. For example:
24315 .code
24316 lookup_cram:
24317   driver = cram_md5
24318   public_name = CRAM-MD5
24319   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24320                   {$value}fail}
24321   server_set_id = $auth1
24322 .endd
24323 Note that this expansion explicitly forces failure if the lookup fails
24324 because &$auth1$& contains an unknown user name.
24325
24326 .new
24327 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24328 using the relevant libraries, you need to know the realm to specify in the
24329 lookup and then ask for the &"userPassword"& attribute for that user in that
24330 realm, with:
24331 .code
24332 cyrusless_crammd5:
24333   driver = cram_md5
24334   public_name = CRAM-MD5
24335   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24336                   dbmjz{/etc/sasldb2}}
24337   server_set_id = $auth1
24338 .endd
24339 .wen
24340
24341 .section "Using cram_md5 as a client" "SECID177"
24342 .cindex "options" "&(cram_md5)& authenticator (client)"
24343 When used as a client, the &(cram_md5)& authenticator has two options:
24344
24345
24346
24347 .option client_name cram_md5 string&!! "the primary host name"
24348 This string is expanded, and the result used as the user name data when
24349 computing the response to the server's challenge.
24350
24351
24352 .option client_secret cram_md5 string&!! unset
24353 This option must be set for the authenticator to work as a client. Its value is
24354 expanded and the result used as the secret string when computing the response.
24355
24356
24357 .vindex "&$host$&"
24358 .vindex "&$host_address$&"
24359 Different user names and secrets can be used for different servers by referring
24360 to &$host$& or &$host_address$& in the options. Forced failure of either
24361 expansion string is treated as an indication that this authenticator is not
24362 prepared to handle this case. Exim moves on to the next configured client
24363 authenticator. Any other expansion failure causes Exim to give up trying to
24364 send the message to the current server.
24365
24366 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24367 strings, is:
24368 .code
24369 fixed_cram:
24370   driver = cram_md5
24371   public_name = CRAM-MD5
24372   client_name = ph10
24373   client_secret = secret
24374 .endd
24375 .ecindex IIDcramauth1
24376 .ecindex IIDcramauth2
24377
24378
24379
24380 . ////////////////////////////////////////////////////////////////////////////
24381 . ////////////////////////////////////////////////////////////////////////////
24382
24383 .chapter "The cyrus_sasl authenticator" "CHID10"
24384 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24385 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24386 .cindex "Cyrus" "SASL library"
24387 .cindex "Kerberos"
24388 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24389 Digital Ltd (&url(http://www.aldigital.co.uk)).
24390
24391 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24392 library implementation of the RFC 2222 (&"Simple Authentication and Security
24393 Layer"&). This library supports a number of authentication mechanisms,
24394 including PLAIN and LOGIN, but also several others that Exim does not support
24395 directly. In particular, there is support for Kerberos authentication.
24396
24397 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24398 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24399 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24400 name of the driver to determine which mechanism to support.
24401
24402 Where access to some kind of secret file is required, for example in GSSAPI
24403 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24404 user, and that the Cyrus SASL library has no way of escalating privileges
24405 by default. You may also find you need to set environment variables,
24406 depending on the driver you are using.
24407
24408 The application name provided by Exim is &"exim"&, so various SASL options may
24409 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24410 Kerberos, note that because of limitations in the GSSAPI interface,
24411 changing the server keytab might need to be communicated down to the Kerberos
24412 layer independently. The mechanism for doing so is dependent upon the Kerberos
24413 implementation.
24414 .new
24415 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24416 may be set to point to an alternative keytab file. Exim will pass this
24417 variable through from its own inherited environment when started as root or the
24418 Exim user. The keytab file needs to be readable by the Exim user.
24419 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24420 environment variable.  In practice, for those releases, the Cyrus authenticator
24421 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24422 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24423 .wen
24424
24425
24426 .section "Using cyrus_sasl as a server" "SECID178"
24427 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24428 (on a successful authentication) into &$auth1$&. For compatibility with
24429 previous releases of Exim, the username is also placed in &$1$&. However, the
24430 use of this variable for this purpose is now deprecated, as it can lead to
24431 confusion in string expansions that also use numeric variables for other
24432 things.
24433
24434
24435 .option server_hostname cyrus_sasl string&!! "see below"
24436 This option selects the hostname that is used when communicating with the
24437 library. The default value is &`$primary_hostname`&. It is up to the underlying
24438 SASL plug-in what it does with this data.
24439
24440
24441 .option server_mech cyrus_sasl string "see below"
24442 This option selects the authentication mechanism this driver should use. The
24443 default is the value of the generic &%public_name%& option. This option allows
24444 you to use a different underlying mechanism from the advertised name. For
24445 example:
24446 .code
24447 sasl:
24448   driver = cyrus_sasl
24449   public_name = X-ANYTHING
24450   server_mech = CRAM-MD5
24451   server_set_id = $auth1
24452 .endd
24453
24454 .new
24455 .option server_realm cyrus_sasl string&!! unset
24456 This specifies the SASL realm that the server claims to be in.
24457 .wen
24458
24459
24460 .option server_service cyrus_sasl string &`smtp`&
24461 This is the SASL service that the server claims to implement.
24462
24463
24464 For straightforward cases, you do not need to set any of the authenticator's
24465 private options. All you need to do is to specify an appropriate mechanism as
24466 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24467 PLAIN, you could have two authenticators as follows:
24468 .code
24469 sasl_cram_md5:
24470   driver = cyrus_sasl
24471   public_name = CRAM-MD5
24472   server_set_id = $auth1
24473
24474 sasl_plain:
24475   driver = cyrus_sasl
24476   public_name = PLAIN
24477   server_set_id = $auth2
24478 .endd
24479 Cyrus SASL does implement the LOGIN authentication method, even though it is
24480 not a standard method. It is disabled by default in the source distribution,
24481 but it is present in many binary distributions.
24482 .ecindex IIDcyrauth1
24483 .ecindex IIDcyrauth2
24484
24485
24486
24487
24488 . ////////////////////////////////////////////////////////////////////////////
24489 . ////////////////////////////////////////////////////////////////////////////
24490 .chapter "The dovecot authenticator" "CHAPdovecot"
24491 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24492 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24493 This authenticator is an interface to the authentication facility of the
24494 Dovecot POP/IMAP server, which can support a number of authentication methods.
24495 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24496 to use the same mechanisms for SMTP authentication. This is a server
24497 authenticator only. There is only one option:
24498
24499 .option server_socket dovecot string unset
24500
24501 This option must specify the socket that is the interface to Dovecot
24502 authentication. The &%public_name%& option must specify an authentication
24503 mechanism that Dovecot is configured to support. You can have several
24504 authenticators for different mechanisms. For example:
24505 .code
24506 dovecot_plain:
24507   driver = dovecot
24508   public_name = PLAIN
24509   server_socket = /var/run/dovecot/auth-client
24510   server_set_id = $auth2
24511
24512 dovecot_ntlm:
24513   driver = dovecot
24514   public_name = NTLM
24515   server_socket = /var/run/dovecot/auth-client
24516   server_set_id = $auth1
24517 .endd
24518 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24519 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24520 option is passed in the Dovecot authentication command. If, for a TLS
24521 connection, a client certificate has been verified, the &"valid-client-cert"&
24522 option is passed. When authentication succeeds, the identity of the user
24523 who authenticated is placed in &$auth1$&.
24524 .ecindex IIDdcotauth1
24525 .ecindex IIDdcotauth2
24526
24527
24528 . ////////////////////////////////////////////////////////////////////////////
24529 . ////////////////////////////////////////////////////////////////////////////
24530 .new
24531 .chapter "The gsasl authenticator" "CHAPgsasl"
24532 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
24533 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
24534 .cindex "authentication" "GNU SASL"
24535 .cindex "authentication" "SASL"
24536 .cindex "authentication" "EXTERNAL"
24537 .cindex "authentication" "ANONYMOUS"
24538 .cindex "authentication" "PLAIN"
24539 .cindex "authentication" "LOGIN"
24540 .cindex "authentication" "DIGEST-MD5"
24541 .cindex "authentication" "CRAM-MD5"
24542 .cindex "authentication" "SCRAM-SHA-1"
24543 The &(gsasl)& authenticator provides server integration for the GNU SASL
24544 library and the mechanisms it provides.  This is new as of the 4.78 release
24545 and there are a few areas where the library does not let Exim smoothly
24546 scale to handle future authentication mechanisms, so no guarantee can be
24547 made that any particular new authentication mechanism will be supported
24548 without code changes in Exim.
24549
24550
24551 .option server_channelbinding gsasl bool false
24552 Some authentication mechanisms are able to use external context at both ends
24553 of the session to bind the authentication to that context, and fail the
24554 authentication process if that context differs.  Specifically, some TLS
24555 ciphersuites can provide identifying information about the cryptographic
24556 context.
24557
24558 This means that certificate identity and verification becomes a non-issue,
24559 as a man-in-the-middle attack will cause the correct client and server to
24560 see different identifiers and authentication will fail.
24561
24562 This is currently only supported when using the GnuTLS library.  This is
24563 only usable by mechanisms which support "channel binding"; at time of
24564 writing, that's the SCRAM family.
24565
24566 This defaults off to ensure smooth upgrade across Exim releases, in case
24567 this option causes some clients to start failing.  Some future release
24568 of Exim may switch the default to be true.
24569
24570
24571 .option server_hostname gsasl string&!! "see below"
24572 This option selects the hostname that is used when communicating with the
24573 library. The default value is &`$primary_hostname`&.
24574 Some mechanisms will use this data.
24575
24576
24577 .option server_mech gsasl string "see below"
24578 This option selects the authentication mechanism this driver should use. The
24579 default is the value of the generic &%public_name%& option. This option allows
24580 you to use a different underlying mechanism from the advertised name. For
24581 example:
24582 .code
24583 sasl:
24584   driver = gsasl
24585   public_name = X-ANYTHING
24586   server_mech = CRAM-MD5
24587   server_set_id = $auth1
24588 .endd
24589
24590
24591 .option server_password gsasl string&!! unset
24592 Various mechanisms need access to the cleartext password on the server, so
24593 that proof-of-possession can be demonstrated on the wire, without sending
24594 the password itself.
24595
24596 The data available for lookup varies per mechanism.
24597 In all cases, &$auth1$& is set to the &'authentication id'&.
24598 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
24599 if available, else the empty string.
24600 The &$auth3$& variable will always be the &'realm'& if available,
24601 else the empty string.
24602
24603 A forced failure will cause authentication to defer.
24604
24605 If using this option, it may make sense to set the &%server_condition%&
24606 option to be simply "true".
24607
24608
24609 .option server_realm gsasl string&!! unset
24610 This specifies the SASL realm that the server claims to be in.
24611 Some mechanisms will use this data.
24612
24613
24614 .option server_scram_iter gsasl string&!! unset
24615 This option provides data for the SCRAM family of mechanisms.
24616 &$auth1$& is not available at evaluation time.
24617 (This may change, as we receive feedback on use)
24618
24619
24620 .option server_scram_salt gsasl string&!! unset
24621 This option provides data for the SCRAM family of mechanisms.
24622 &$auth1$& is not available at evaluation time.
24623 (This may change, as we receive feedback on use)
24624
24625
24626 .option server_service gsasl string &`smtp`&
24627 This is the SASL service that the server claims to implement.
24628 Some mechanisms will use this data.
24629
24630
24631 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
24632 .vindex "&$auth1$&, &$auth2$&, etc"
24633 These may be set when evaluating specific options, as detailed above.
24634 They will also be set when evaluating &%server_condition%&.
24635
24636 Unless otherwise stated below, the &(gsasl)& integration will use the following
24637 meanings for these variables:
24638
24639 .ilist
24640 .vindex "&$auth1$&"
24641 &$auth1$&: the &'authentication id'&
24642 .next
24643 .vindex "&$auth2$&"
24644 &$auth2$&: the &'authorization id'&
24645 .next
24646 .vindex "&$auth3$&"
24647 &$auth3$&: the &'realm'&
24648 .endlist
24649
24650 On a per-mechanism basis:
24651
24652 .ilist
24653 .cindex "authentication" "EXTERNAL"
24654 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
24655 the &%server_condition%& option must be present.
24656 .next
24657 .cindex "authentication" "ANONYMOUS"
24658 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
24659 the &%server_condition%& option must be present.
24660 .next
24661 .cindex "authentication" "GSSAPI"
24662 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
24663 &$auth2$& will be set to the &'authorization id'&,
24664 the &%server_condition%& option must be present.
24665 .endlist
24666
24667 An &'anonymous token'& is something passed along as an unauthenticated
24668 identifier; this is analogous to FTP anonymous authentication passing an
24669 email address, or software-identifier@, as the "password".
24670
24671
24672 An example showing the password having the realm specified in the callback
24673 and demonstrating a Cyrus SASL to GSASL migration approach is:
24674 .code
24675 gsasl_cyrusless_crammd5:
24676   driver = gsasl
24677   public_name = CRAM-MD5
24678   server_realm = imap.example.org
24679   server_password = ${lookup{$auth1:$auth3:userPassword}\
24680                     dbmjz{/etc/sasldb2}{$value}fail}
24681   server_set_id = ${quote:$auth1}
24682   server_condition = yes
24683 .endd
24684
24685 .wen
24686
24687 . ////////////////////////////////////////////////////////////////////////////
24688 . ////////////////////////////////////////////////////////////////////////////
24689
24690 .new
24691 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
24692 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
24693 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
24694 .cindex "authentication" "GSSAPI"
24695 .cindex "authentication" "Kerberos"
24696 The &(heimdal_gssapi)& authenticator provides server integration for the
24697 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
24698 reliably.
24699
24700 .option server_hostname heimdal_gssapi string&!! "see below"
24701 This option selects the hostname that is used, with &%server_service%&,
24702 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
24703 identifier.  The default value is &`$primary_hostname`&.
24704
24705 .option server_keytab heimdal_gssapi string&!! unset
24706 If set, then Heimdal will not use the system default keytab (typically
24707 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
24708 The value should be a pathname, with no &"file:"& prefix.
24709
24710 .option server_service heimdal_gssapi string&!! "smtp"
24711 This option specifies the service identifier used, in conjunction with
24712 &%server_hostname%&, for building the identifer for finding credentials
24713 from the keytab.
24714
24715
24716 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
24717 Beware that these variables will typically include a realm, thus will appear
24718 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
24719 not verified, so a malicious client can set it to anything.
24720
24721 The &$auth1$& field should be safely trustable as a value from the Key
24722 Distribution Center.  Note that these are not quite email addresses.
24723 Each identifier is for a role, and so the left-hand-side may include a
24724 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
24725
24726 .vindex "&$auth1$&, &$auth2$&, etc"
24727 .ilist
24728 .vindex "&$auth1$&"
24729 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
24730 .next
24731 .vindex "&$auth2$&"
24732 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
24733 authentication.  If that was empty, this will also be set to the
24734 GSS Display Name.
24735 .endlist
24736
24737 .wen
24738
24739 . ////////////////////////////////////////////////////////////////////////////
24740 . ////////////////////////////////////////////////////////////////////////////
24741
24742 .chapter "The spa authenticator" "CHAPspa"
24743 .scindex IIDspaauth1 "&(spa)& authenticator"
24744 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24745 .cindex "authentication" "Microsoft Secure Password"
24746 .cindex "authentication" "NTLM"
24747 .cindex "Microsoft Secure Password Authentication"
24748 .cindex "NTLM authentication"
24749 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24750 Password Authentication'& mechanism,
24751 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24752 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24753 taken from the Samba project (&url(http://www.samba.org)). The code for the
24754 server side was subsequently contributed by Tom Kistner. The mechanism works as
24755 follows:
24756
24757 .ilist
24758 After the AUTH command has been accepted, the client sends an SPA
24759 authentication request based on the user name and optional domain.
24760 .next
24761 The server sends back a challenge.
24762 .next
24763 The client builds a challenge response which makes use of the user's password
24764 and sends it to the server, which then accepts or rejects it.
24765 .endlist
24766
24767 Encryption is used to protect the password in transit.
24768
24769
24770
24771 .section "Using spa as a server" "SECID179"
24772 .cindex "options" "&(spa)& authenticator (server)"
24773 The &(spa)& authenticator has just one server option:
24774
24775 .option server_password spa string&!! unset
24776 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24777 This option is expanded, and the result must be the cleartext password for the
24778 authenticating user, whose name is at this point in &$auth1$&. For
24779 compatibility with previous releases of Exim, the user name is also placed in
24780 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24781 it can lead to confusion in string expansions that also use numeric variables
24782 for other things. For example:
24783 .code
24784 spa:
24785   driver = spa
24786   public_name = NTLM
24787   server_password = \
24788     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24789 .endd
24790 If the expansion is forced to fail, authentication fails. Any other expansion
24791 failure causes a temporary error code to be returned.
24792
24793
24794
24795
24796
24797 .section "Using spa as a client" "SECID180"
24798 .cindex "options" "&(spa)& authenticator (client)"
24799 The &(spa)& authenticator has the following client options:
24800
24801
24802
24803 .option client_domain spa string&!! unset
24804 This option specifies an optional domain for the authentication.
24805
24806
24807 .option client_password spa string&!! unset
24808 This option specifies the user's password, and must be set.
24809
24810
24811 .option client_username spa string&!! unset
24812 This option specifies the user name, and must be set. Here is an example of a
24813 configuration of this authenticator for use with the mail servers at
24814 &'msn.com'&:
24815 .code
24816 msn:
24817   driver = spa
24818   public_name = MSN
24819   client_username = msn/msn_username
24820   client_password = msn_plaintext_password
24821   client_domain = DOMAIN_OR_UNSET
24822 .endd
24823 .ecindex IIDspaauth1
24824 .ecindex IIDspaauth2
24825
24826
24827
24828
24829
24830 . ////////////////////////////////////////////////////////////////////////////
24831 . ////////////////////////////////////////////////////////////////////////////
24832
24833 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24834          "Encrypted SMTP connections"
24835 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24836 .scindex IIDencsmtp2 "SMTP" "encryption"
24837 .cindex "TLS" "on SMTP connection"
24838 .cindex "OpenSSL"
24839 .cindex "GnuTLS"
24840 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24841 Sockets Layer), is implemented by making use of the OpenSSL library or the
24842 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24843 cryptographic code in the Exim distribution itself for implementing TLS. In
24844 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24845 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24846 You also need to understand the basic concepts of encryption at a managerial
24847 level, and in particular, the way that public keys, private keys, and
24848 certificates are used.
24849
24850 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24851 connection is established, the client issues a STARTTLS command. If the
24852 server accepts this, the client and the server negotiate an encryption
24853 mechanism. If the negotiation succeeds, the data that subsequently passes
24854 between them is encrypted.
24855
24856 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24857 and if so, what cipher suite is in use, whether the client supplied a
24858 certificate, and whether or not that certificate was verified. This makes it
24859 possible for an Exim server to deny or accept certain commands based on the
24860 encryption state.
24861
24862 &*Warning*&: Certain types of firewall and certain anti-virus products can
24863 disrupt TLS connections. You need to turn off SMTP scanning for these products
24864 in order to get TLS to work.
24865
24866
24867
24868 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24869          "SECID284"
24870 .cindex "ssmtp protocol"
24871 .cindex "smtps protocol"
24872 .cindex "SMTP" "ssmtp protocol"
24873 .cindex "SMTP" "smtps protocol"
24874 Early implementations of encrypted SMTP used a different TCP port from normal
24875 SMTP, and expected an encryption negotiation to start immediately, instead of
24876 waiting for a STARTTLS command from the client using the standard SMTP
24877 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24878 allocated for this purpose.
24879
24880 This approach was abandoned when encrypted SMTP was standardized, but there are
24881 still some legacy clients that use it. Exim supports these clients by means of
24882 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24883 numbers; the most common use is expected to be:
24884 .code
24885 tls_on_connect_ports = 465
24886 .endd
24887 The port numbers specified by this option apply to all SMTP connections, both
24888 via the daemon and via &'inetd'&. You still need to specify all the ports that
24889 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24890 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24891 an extra port &-- rather, it specifies different behaviour on a port that is
24892 defined elsewhere.
24893
24894 There is also a &%-tls-on-connect%& command line option. This overrides
24895 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24896
24897
24898
24899
24900
24901
24902 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24903 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24904 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24905 followed later, when the first versions of GnuTLS were released. To build Exim
24906 to use GnuTLS, you need to set
24907 .code
24908 USE_GNUTLS=yes
24909 .endd
24910 in Local/Makefile, in addition to
24911 .code
24912 SUPPORT_TLS=yes
24913 .endd
24914 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24915 include files and libraries for GnuTLS can be found.
24916
24917 There are some differences in usage when using GnuTLS instead of OpenSSL:
24918
24919 .ilist
24920 The &%tls_verify_certificates%& option must contain the name of a file, not the
24921 name of a directory (for OpenSSL it can be either).
24922 .next
24923 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24924 facility for varying its Diffie-Hellman parameters. I understand that this has
24925 changed, but Exim has not been updated to provide this facility.
24926 .next
24927 .vindex "&$tls_peerdn$&"
24928 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24929 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24930 affects the value of the &$tls_peerdn$& variable.
24931 .next
24932 OpenSSL identifies cipher suites using hyphens as separators, for example:
24933 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24934 more, OpenSSL complains if underscores are present in a cipher list. To make
24935 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24936 underscores for GnuTLS when processing lists of cipher suites in the
24937 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24938 option).
24939 .next
24940 The &%tls_require_ciphers%& options operate differently, as described in the
24941 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24942 .new
24943 .next
24944 Some other recently added features may only be available in one or the other.
24945 This should be documented with the feature.  If the documentation does not
24946 explicitly state that the feature is infeasible in the other TLS
24947 implementation, then patches are welcome.
24948 .wen
24949 .endlist
24950
24951
24952 .section "GnuTLS parameter computation" "SECID181"
24953 GnuTLS uses D-H parameters that may take a substantial amount of time
24954 to compute. It is unreasonable to re-compute them for every TLS session.
24955 Therefore, Exim keeps this data in a file in its spool directory, called
24956 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24957 its owner. Every Exim process that start up GnuTLS reads the D-H
24958 parameters from this file. If the file does not exist, the first Exim process
24959 that needs it computes the data and writes it to a temporary file which is
24960 renamed once it is complete. It does not matter if several Exim processes do
24961 this simultaneously (apart from wasting a few resources). Once a file is in
24962 place, new Exim processes immediately start using it.
24963
24964 For maximum security, the parameters that are stored in this file should be
24965 recalculated periodically, the frequency depending on your paranoia level.
24966 Arranging this is easy in principle; just delete the file when you want new
24967 values to be computed. However, there may be a problem. The calculation of new
24968 parameters needs random numbers, and these are obtained from &_/dev/random_&.
24969 If the system is not very active, &_/dev/random_& may delay returning data
24970 until enough randomness (entropy) is available. This may cause Exim to hang for
24971 a substantial amount of time, causing timeouts on incoming connections.
24972
24973 The solution is to generate the parameters externally to Exim. They are stored
24974 in &_gnutls-params_& in PEM format, which means that they can be generated
24975 externally using the &(certtool)& command that is part of GnuTLS.
24976
24977 To replace the parameters with new ones, instead of deleting the file
24978 and letting Exim re-create it, you can generate new parameters using
24979 &(certtool)& and, when this has been done, replace Exim's cache file by
24980 renaming. The relevant commands are something like this:
24981 .code
24982 # rm -f new-params
24983 # touch new-params
24984 # chown exim:exim new-params
24985 # chmod 0400 new-params
24986 # certtool --generate-privkey --bits 512 >new-params
24987 # echo "" >>new-params
24988 # certtool --generate-dh-params --bits 1024 >> new-params
24989 # mv new-params gnutls-params
24990 .endd
24991 If Exim never has to generate the parameters itself, the possibility of
24992 stalling is removed.
24993
24994
24995 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
24996 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
24997 .oindex "&%tls_require_ciphers%&" "OpenSSL"
24998 There is a function in the OpenSSL library that can be passed a list of cipher
24999 suites before the cipher negotiation takes place. This specifies which ciphers
25000 are acceptable. The list is colon separated and may contain names like
25001 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25002 directly to this function call. The following quotation from the OpenSSL
25003 documentation specifies what forms of item are allowed in the cipher string:
25004
25005 .ilist
25006 It can consist of a single cipher suite such as RC4-SHA.
25007 .next
25008 It can represent a list of cipher suites containing a certain algorithm,
25009 or cipher suites of a certain type. For example SHA1 represents all
25010 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25011 SSL v3 algorithms.
25012 .next
25013 Lists of cipher suites can be combined in a single cipher string using
25014 the + character. This is used as a logical and operation. For example
25015 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25016 algorithms.
25017 .endlist
25018
25019 Each cipher string can be optionally preceded by one of the characters &`!`&,
25020 &`-`& or &`+`&.
25021 .ilist
25022 If &`!`& is used, the ciphers are permanently deleted from the list. The
25023 ciphers deleted can never reappear in the list even if they are explicitly
25024 stated.
25025 .next
25026 If &`-`& is used, the ciphers are deleted from the list, but some or all
25027 of the ciphers can be added again by later options.
25028 .next
25029 If &`+`& is used, the ciphers are moved to the end of the list. This
25030 option does not add any new ciphers; it just moves matching existing ones.
25031 .endlist
25032
25033 If none of these characters is present, the string is interpreted as
25034 a list of ciphers to be appended to the current preference list. If the list
25035 includes any ciphers already present they will be ignored: that is, they will
25036 not be moved to the end of the list.
25037 .endlist
25038
25039
25040
25041 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25042          "SECTreqciphgnu"
25043 .cindex "GnuTLS" "specifying parameters for"
25044 .cindex "TLS" "specifying ciphers (GnuTLS)"
25045 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25046 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25047 .cindex "TLS" "specifying protocols (GnuTLS)"
25048 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25049 The GnuTLS library allows the caller to specify separate lists of permitted key
25050 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
25051 Unfortunately, these lists are numerical, and the library does not have a
25052 function for turning names into numbers. Consequently, lists of recognized
25053 names have to be built into the application. The permitted key exchange
25054 methods, ciphers, and MAC algorithms may be used in any combination to form a
25055 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
25056 passed to its control function.
25057
25058 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
25059 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
25060 option controls only the cipher algorithms. Exim searches each item in the
25061 list for the name of an available algorithm. For example, if the list
25062 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
25063 the same as if just AES were given.
25064
25065 .oindex "&%gnutls_require_kx%&"
25066 .oindex "&%gnutls_require_mac%&"
25067 .oindex "&%gnutls_require_protocols%&"
25068 There are additional options called &%gnutls_require_kx%&,
25069 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
25070 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
25071 These options are ignored if OpenSSL is in use.
25072
25073 All four options are available as global options, controlling how Exim
25074 behaves as a server, and also as options of the &(smtp)& transport, controlling
25075 how Exim behaves as a client. All the values are string expanded. After
25076 expansion, the values must be colon-separated lists, though the separator
25077 can be changed in the usual way.
25078
25079 Each of the four lists starts out with a default set of algorithms. If the
25080 first item in a list does &'not'& start with an exclamation mark, all the
25081 default items are deleted. In this case, only those that are explicitly
25082 specified can be used. If the first item in a list &'does'& start with an
25083 exclamation mark, the defaults are left on the list.
25084
25085 Then, any item that starts with an exclamation mark causes the relevant
25086 entry to be removed from the list, and any item that does not start with an
25087 exclamation mark causes a new entry to be added to the list. Unrecognized
25088 items in the list are ignored. Thus:
25089 .code
25090 tls_require_ciphers = !ARCFOUR
25091 .endd
25092 allows all the defaults except ARCFOUR, whereas
25093 .code
25094 tls_require_ciphers = AES : 3DES
25095 .endd
25096 allows only cipher suites that use AES or 3DES.
25097
25098 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
25099 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
25100 the preceding). The default list does not contain all of these; it just has
25101 AES_256, AES_128, 3DES, and ARCFOUR_128.
25102
25103 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
25104 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
25105 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
25106
25107 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
25108 MD5. The default list contains SHA, MD5.
25109
25110 .new
25111 For &%gnutls_require_protocols%&, the recognized names are TLS1.2, TLS1.1,
25112 TLS1.0, (TLS1) and SSL3.
25113 The default list contains TLS1.2, TLS1.1, TLS1.0, SSL3.
25114 TLS1 is an alias for TLS1.0, for backwards compatibility.
25115 For sufficiently old versions of the GnuTLS library, TLS1.2 or TLS1.1 might
25116 not be supported and will not be recognised by Exim.
25117 .wen
25118
25119 In a server, the order of items in these lists is unimportant. The server
25120 advertises the availability of all the relevant cipher suites. However, in a
25121 client, the order in the &%tls_require_ciphers%& list specifies a preference
25122 order for the cipher algorithms. The first one in the client's list that is
25123 also advertised by the server is tried first. The default order is as listed
25124 above.
25125
25126
25127
25128 .section "Configuring an Exim server to use TLS" "SECID182"
25129 .cindex "TLS" "configuring an Exim server"
25130 When Exim has been built with TLS support, it advertises the availability of
25131 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25132 but not to any others. The default value of this option is unset, which means
25133 that STARTTLS is not advertised at all. This default is chosen because you
25134 need to set some other options in order to make TLS available, and also it is
25135 sensible for systems that want to use TLS only as a client.
25136
25137 If a client issues a STARTTLS command and there is some configuration
25138 problem in the server, the command is rejected with a 454 error. If the client
25139 persists in trying to issue SMTP commands, all except QUIT are rejected
25140 with the error
25141 .code
25142 554 Security failure
25143 .endd
25144 If a STARTTLS command is issued within an existing TLS session, it is
25145 rejected with a 554 error code.
25146
25147 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25148 match some hosts. You can, of course, set it to * to match all hosts.
25149 However, this is not all you need to do. TLS sessions to a server won't work
25150 without some further configuration at the server end.
25151
25152 It is rumoured that all existing clients that support TLS/SSL use RSA
25153 encryption. To make this work you need to set, in the server,
25154 .code
25155 tls_certificate = /some/file/name
25156 tls_privatekey = /some/file/name
25157 .endd
25158 These options are, in fact, expanded strings, so you can make them depend on
25159 the identity of the client that is connected if you wish. The first file
25160 contains the server's X509 certificate, and the second contains the private key
25161 that goes with it. These files need to be readable by the Exim user, and must
25162 always be given as full path names. They can be the same file if both the
25163 certificate and the key are contained within it. If &%tls_privatekey%& is not
25164 set, or if its expansion is forced to fail or results in an empty string, this
25165 is assumed to be the case. The certificate file may also contain intermediate
25166 certificates that need to be sent to the client to enable it to authenticate
25167 the server's certificate.
25168
25169 If you do not understand about certificates and keys, please try to find a
25170 source of this background information, which is not Exim-specific. (There are a
25171 few comments below in section &<<SECTcerandall>>&.)
25172
25173 &*Note*&: These options do not apply when Exim is operating as a client &--
25174 they apply only in the case of a server. If you need to use a certificate in an
25175 Exim client, you must set the options of the same names in an &(smtp)&
25176 transport.
25177
25178 With just these options, an Exim server will be able to use TLS. It does not
25179 require the client to have a certificate (but see below for how to insist on
25180 this). There is one other option that may be needed in other situations. If
25181 .code
25182 tls_dhparam = /some/file/name
25183 .endd
25184 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25185 with the parameters contained in the file. This increases the set of cipher
25186 suites that the server supports. See the command
25187 .code
25188 openssl dhparam
25189 .endd
25190 for a way of generating this data. At present, &%tls_dhparam%& is used only
25191 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
25192
25193 The strings supplied for these three options are expanded every time a client
25194 host connects. It is therefore possible to use different certificates and keys
25195 for different hosts, if you so wish, by making use of the client's IP address
25196 in &$sender_host_address$& to control the expansion. If a string expansion is
25197 forced to fail, Exim behaves as if the option is not set.
25198
25199 .cindex "cipher" "logging"
25200 .cindex "log" "TLS cipher"
25201 .vindex "&$tls_cipher$&"
25202 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
25203 an incoming TLS connection. It is included in the &'Received:'& header of an
25204 incoming message (by default &-- you can, of course, change this), and it is
25205 also included in the log line that records a message's arrival, keyed by
25206 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25207 condition can be used to test for specific cipher suites in ACLs.
25208 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
25209 &<<SECID185>>&.)
25210
25211 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25212 can check the name of the cipher suite and vary their actions accordingly. The
25213 cipher suite names vary, depending on which TLS library is being used. For
25214 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25215 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25216 documentation for more details.
25217
25218
25219 .section "Requesting and verifying client certificates" "SECID183"
25220 .cindex "certificate" "verification of client"
25221 .cindex "TLS" "client certificate verification"
25222 If you want an Exim server to request a certificate when negotiating a TLS
25223 session with a client, you must set either &%tls_verify_hosts%& or
25224 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25225 apply to all TLS connections. For any host that matches one of these options,
25226 Exim requests a certificate as part of the setup of the TLS session. The
25227 contents of the certificate are verified by comparing it with a list of
25228 expected certificates. These must be available in a file or,
25229 for OpenSSL only (not GnuTLS), a directory, identified by
25230 &%tls_verify_certificates%&.
25231
25232 A file can contain multiple certificates, concatenated end to end. If a
25233 directory is used
25234 (OpenSSL only),
25235 each certificate must be in a separate file, with a name (or a symbolic link)
25236 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25237 certificate. You can compute the relevant hash by running the command
25238 .code
25239 openssl x509 -hash -noout -in /cert/file
25240 .endd
25241 where &_/cert/file_& contains a single certificate.
25242
25243 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25244 what happens if the client does not supply a certificate, or if the certificate
25245 does not match any of the certificates in the collection named by
25246 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25247 attempt to set up a TLS session is aborted, and the incoming connection is
25248 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25249 session continues. ACLs that run for subsequent SMTP commands can detect the
25250 fact that no certificate was verified, and vary their actions accordingly. For
25251 example, you can insist on a certificate before accepting a message for
25252 relaying, but not when the message is destined for local delivery.
25253
25254 .vindex "&$tls_peerdn$&"
25255 When a client supplies a certificate (whether it verifies or not), the value of
25256 the Distinguished Name of the certificate is made available in the variable
25257 &$tls_peerdn$& during subsequent processing of the message.
25258
25259 .cindex "log" "distinguished name"
25260 Because it is often a long text string, it is not included in the log line or
25261 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25262 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25263 &%received_header_text%& to change the &'Received:'& header. When no
25264 certificate is supplied, &$tls_peerdn$& is empty.
25265
25266
25267 .section "Revoked certificates" "SECID184"
25268 .cindex "TLS" "revoked certificates"
25269 .cindex "revocation list"
25270 .cindex "certificate" "revocation list"
25271 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25272 certificates are revoked. If you have such a list, you can pass it to an Exim
25273 server using the global option called &%tls_crl%& and to an Exim client using
25274 an identically named option for the &(smtp)& transport. In each case, the value
25275 of the option is expanded and must then be the name of a file that contains a
25276 CRL in PEM format.
25277
25278
25279 .section "Configuring an Exim client to use TLS" "SECID185"
25280 .cindex "cipher" "logging"
25281 .cindex "log" "TLS cipher"
25282 .cindex "log" "distinguished name"
25283 .cindex "TLS" "configuring an Exim client"
25284 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25285 deliveries as well as to incoming, the latter one causing logging of the
25286 server certificate's DN. The remaining client configuration for TLS is all
25287 within the &(smtp)& transport.
25288
25289 It is not necessary to set any options to have TLS work in the &(smtp)&
25290 transport. If Exim is built with TLS support, and TLS is advertised by a
25291 server, the &(smtp)& transport always tries to start a TLS session. However,
25292 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25293 transport) to a list of server hosts for which TLS should not be used.
25294
25295 If you do not want Exim to attempt to send messages unencrypted when an attempt
25296 to set up an encrypted connection fails in any way, you can set
25297 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25298 those hosts, delivery is always deferred if an encrypted connection cannot be
25299 set up. If there are any other hosts for the address, they are tried in the
25300 usual way.
25301
25302 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25303 the message unencrypted. It always does this if the response to STARTTLS is
25304 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25305 session after a success response code, what happens is controlled by the
25306 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25307 delivery to this host is deferred, and other hosts (if available) are tried. If
25308 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25309 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25310 negotiation fails, Exim closes the current connection (because it is in an
25311 unknown state), opens a new one to the same host, and then tries the delivery
25312 unencrypted.
25313
25314 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25315 transport provide the client with a certificate, which is passed to the server
25316 if it requests it. If the server is Exim, it will request a certificate only if
25317 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25318
25319 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25320 must name a file or,
25321 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25322 expected server certificates. The client verifies the server's certificate
25323 against this collection, taking into account any revoked certificates that are
25324 in the list defined by &%tls_crl%&.
25325
25326 If
25327 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25328 list of permitted cipher suites. If either of these checks fails, delivery to
25329 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25330 alternative hosts, if any.
25331
25332  &*Note*&:
25333 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25334 is operating as a client. Exim does not assume that a server certificate (set
25335 by the global options of the same name) should also be used when operating as a
25336 client.
25337
25338 .vindex "&$host$&"
25339 .vindex "&$host_address$&"
25340 All the TLS options in the &(smtp)& transport are expanded before use, with
25341 &$host$& and &$host_address$& containing the name and address of the server to
25342 which the client is connected. Forced failure of an expansion causes Exim to
25343 behave as if the relevant option were unset.
25344
25345 .vindex &$tls_bits$&
25346 .vindex &$tls_cipher$&
25347 .vindex &$tls_peerdn$&
25348 .vindex &$tls_sni$&
25349 Before an SMTP connection is established, the
25350 &$tls_bits$&, &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25351 variables are emptied. (Until the first connection, they contain the values
25352 that were set when the message was received.) If STARTTLS is subsequently
25353 successfully obeyed, these variables are set to the relevant values for the
25354 outgoing connection.
25355
25356
25357
25358 .new
25359 .section "Use of TLS Server Name Indication" "SECTtlssni"
25360 .cindex "TLS" "Server Name Indication"
25361 .vindex "&$tls_sni$&"
25362 .oindex "&%tls_sni%&"
25363 With TLS1.0 or above, there is an extension mechanism by which extra
25364 information can be included at various points in the protocol.  One of these
25365 extensions, documented in RFC 6066 (and before that RFC 4366) is
25366 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25367 client in the initial handshake, so that the server can examine the servername
25368 within and possibly choose to use different certificates and keys (and more)
25369 for this session.
25370
25371 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25372 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25373 address.
25374
25375 With SMTP to MX, there are the same problems here as in choosing the identity
25376 against which to validate a certificate: you can't rely on insecure DNS to
25377 provide the identity which you then cryptographically verify.  So this will
25378 be of limited use in that environment.
25379
25380 With SMTP to Submission, there is a well-defined hostname which clients are
25381 connecting to and can validate certificates against.  Thus clients &*can*&
25382 choose to include this information in the TLS negotiation.  If this becomes
25383 wide-spread, then hosters can choose to present different certificates to
25384 different clients.  Or even negotiate different cipher suites.
25385
25386 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25387 if not empty, will be sent on a TLS session as part of the handshake.  There's
25388 nothing more to it.  Choosing a sensible value not derived insecurely is the
25389 only point of caution.  The &$tls_sni$& variable will be set to this string
25390 for the lifetime of the client connection (including during authentication).
25391
25392 Except during SMTP client sessions, if &$tls_sni$& is set then it is a string
25393 received from a client.
25394 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25395
25396 If the string &`tls_sni`& appears in the main section's &%tls_certificate%&
25397 option (prior to expansion) then the following options will be re-expanded
25398 during TLS session handshake, to permit alternative values to be chosen:
25399
25400 .ilist
25401 .vindex "&%tls_certificate%&"
25402 &%tls_certificate%&
25403 .next
25404 .vindex "&%tls_crl%&"
25405 &%tls_crl%&
25406 .next
25407 .vindex "&%tls_privatekey%&"
25408 &%tls_privatekey%&
25409 .next
25410 .vindex "&%tls_verify_certificates%&"
25411 &%tls_verify_certificates%&
25412 .endlist
25413
25414 Great care should be taken to deal with matters of case, various injection
25415 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25416 can always be referenced; it is important to remember that &$tls_sni$& is
25417 arbitrary unverified data provided prior to authentication.
25418
25419 The Exim developers are proceeding cautiously and so far no other TLS options
25420 are re-expanded.
25421
25422 Currently SNI support is only available if using OpenSSL, with TLS Extensions
25423 support enabled therein.
25424 .wen
25425
25426
25427
25428 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25429          "SECTmulmessam"
25430 .cindex "multiple SMTP deliveries with TLS"
25431 .cindex "TLS" "multiple message deliveries"
25432 Exim sends multiple messages down the same TCP/IP connection by starting up
25433 an entirely new delivery process for each message, passing the socket from
25434 one process to the next. This implementation does not fit well with the use
25435 of TLS, because there is quite a lot of state information associated with a TLS
25436 connection, not just a socket identification. Passing all the state information
25437 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25438 session before passing the socket to a new process. The new process may then
25439 try to start a new TLS session, and if successful, may try to re-authenticate
25440 if AUTH is in use, before sending the next message.
25441
25442 The RFC is not clear as to whether or not an SMTP session continues in clear
25443 after TLS has been shut down, or whether TLS may be restarted again later, as
25444 just described. However, if the server is Exim, this shutdown and
25445 reinitialization works. It is not known which (if any) other servers operate
25446 successfully if the client closes a TLS session and continues with unencrypted
25447 SMTP, but there are certainly some that do not work. For such servers, Exim
25448 should not pass the socket to another process, because the failure of the
25449 subsequent attempt to use it would cause Exim to record a temporary host error,
25450 and delay other deliveries to that host.
25451
25452 To test for this case, Exim sends an EHLO command to the server after
25453 closing down the TLS session. If this fails in any way, the connection is
25454 closed instead of being passed to a new delivery process, but no retry
25455 information is recorded.
25456
25457 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25458 &(smtp)& transport to match those hosts for which Exim should not pass
25459 connections to new processes if TLS has been used.
25460
25461
25462
25463
25464 .section "Certificates and all that" "SECTcerandall"
25465 .cindex "certificate" "references to discussion"
25466 In order to understand fully how TLS works, you need to know about
25467 certificates, certificate signing, and certificate authorities. This is not the
25468 place to give a tutorial, especially as I do not know very much about it
25469 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25470 to Apache, currently at
25471 .display
25472 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25473 .endd
25474 Other parts of the &'modssl'& documentation are also helpful, and have
25475 links to further files.
25476 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25477 0-201-61598-3), contains both introductory and more in-depth descriptions.
25478 Some sample programs taken from the book are available from
25479 .display
25480 &url(http://www.rtfm.com/openssl-examples/)
25481 .endd
25482
25483
25484 .section "Certificate chains" "SECID186"
25485 The file named by &%tls_certificate%& may contain more than one
25486 certificate. This is useful in the case where the certificate that is being
25487 sent is validated by an intermediate certificate which the other end does
25488 not have. Multiple certificates must be in the correct order in the file.
25489 First the host's certificate itself, then the first intermediate
25490 certificate to validate the issuer of the host certificate, then the next
25491 intermediate certificate to validate the issuer of the first intermediate
25492 certificate, and so on, until finally (optionally) the root certificate.
25493 The root certificate must already be trusted by the recipient for
25494 validation to succeed, of course, but if it's not preinstalled, sending the
25495 root certificate along with the rest makes it available for the user to
25496 install if the receiving end is a client MUA that can interact with a user.
25497
25498
25499 .section "Self-signed certificates" "SECID187"
25500 .cindex "certificate" "self-signed"
25501 You can create a self-signed certificate using the &'req'& command provided
25502 with OpenSSL, like this:
25503 .code
25504 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
25505             -days 9999 -nodes
25506 .endd
25507 &_file1_& and &_file2_& can be the same file; the key and the certificate are
25508 delimited and so can be identified independently. The &%-days%& option
25509 specifies a period for which the certificate is valid. The &%-nodes%& option is
25510 important: if you do not set it, the key is encrypted with a passphrase
25511 that you are prompted for, and any use that is made of the key causes more
25512 prompting for the passphrase. This is not helpful if you are going to use
25513 this certificate and key in an MTA, where prompting is not possible.
25514
25515 A self-signed certificate made in this way is sufficient for testing, and
25516 may be adequate for all your requirements if you are mainly interested in
25517 encrypting transfers, and not in secure identification.
25518
25519 However, many clients require that the certificate presented by the server be a
25520 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
25521 certificate. In this situation, the self-signed certificate described above
25522 must be installed on the client host as a trusted root &'certification
25523 authority'& (CA), and the certificate used by Exim must be a user certificate
25524 signed with that self-signed certificate.
25525
25526 For information on creating self-signed CA certificates and using them to sign
25527 user certificates, see the &'General implementation overview'& chapter of the
25528 Open-source PKI book, available online at
25529 &url(http://ospkibook.sourceforge.net/).
25530 .ecindex IIDencsmtp1
25531 .ecindex IIDencsmtp2
25532
25533
25534
25535 . ////////////////////////////////////////////////////////////////////////////
25536 . ////////////////////////////////////////////////////////////////////////////
25537
25538 .chapter "Access control lists" "CHAPACL"
25539 .scindex IIDacl "&ACL;" "description"
25540 .cindex "control of incoming mail"
25541 .cindex "message" "controlling incoming"
25542 .cindex "policy control" "access control lists"
25543 Access Control Lists (ACLs) are defined in a separate section of the run time
25544 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
25545 name, terminated by a colon. Here is a complete ACL section that contains just
25546 one very small ACL:
25547 .code
25548 begin acl
25549 small_acl:
25550   accept   hosts = one.host.only
25551 .endd
25552 You can have as many lists as you like in the ACL section, and the order in
25553 which they appear does not matter. The lists are self-terminating.
25554
25555 The majority of ACLs are used to control Exim's behaviour when it receives
25556 certain SMTP commands. This applies both to incoming TCP/IP connections, and
25557 when a local process submits a message using SMTP by specifying the &%-bs%&
25558 option. The most common use is for controlling which recipients are accepted
25559 in incoming messages. In addition, you can define an ACL that is used to check
25560 local non-SMTP messages. The default configuration file contains an example of
25561 a realistic ACL for checking RCPT commands. This is discussed in chapter
25562 &<<CHAPdefconfil>>&.
25563
25564
25565 .section "Testing ACLs" "SECID188"
25566 The &%-bh%& command line option provides a way of testing your ACL
25567 configuration locally by running a fake SMTP session with which you interact.
25568 The host &'relay-test.mail-abuse.org'& provides a service for checking your
25569 relaying configuration (see section &<<SECTcheralcon>>& for more details).
25570
25571
25572
25573 .section "Specifying when ACLs are used" "SECID189"
25574 .cindex "&ACL;" "options for specifying"
25575 In order to cause an ACL to be used, you have to name it in one of the relevant
25576 options in the main part of the configuration. These options are:
25577 .cindex "AUTH" "ACL for"
25578 .cindex "DATA" "ACLs for"
25579 .cindex "ETRN" "ACL for"
25580 .cindex "EXPN" "ACL for"
25581 .cindex "HELO" "ACL for"
25582 .cindex "EHLO" "ACL for"
25583 .cindex "MAIL" "ACL for"
25584 .cindex "QUIT, ACL for"
25585 .cindex "RCPT" "ACL for"
25586 .cindex "STARTTLS, ACL for"
25587 .cindex "VRFY" "ACL for"
25588 .cindex "SMTP" "connection, ACL for"
25589 .cindex "non-SMTP messages" "ACLs for"
25590 .cindex "MIME content scanning" "ACL for"
25591
25592 .table2 140pt
25593 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
25594 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25595 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25596 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25597 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
25598 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
25599 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
25600 .irow &%acl_smtp_expn%&        "ACL for EXPN"
25601 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
25602 .irow &%acl_smtp_mail%&        "ACL for MAIL"
25603 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
25604 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
25605 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
25606 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
25607 .irow &%acl_smtp_quit%&        "ACL for QUIT"
25608 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
25609 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
25610 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
25611 .endtable
25612
25613 For example, if you set
25614 .code
25615 acl_smtp_rcpt = small_acl
25616 .endd
25617 the little ACL defined above is used whenever Exim receives a RCPT command
25618 in an SMTP dialogue. The majority of policy tests on incoming messages can be
25619 done when RCPT commands arrive. A rejection of RCPT should cause the
25620 sending MTA to give up on the recipient address contained in the RCPT
25621 command, whereas rejection at other times may cause the client MTA to keep on
25622 trying to deliver the message. It is therefore recommended that you do as much
25623 testing as possible at RCPT time.
25624
25625
25626 .section "The non-SMTP ACLs" "SECID190"
25627 .cindex "non-SMTP messages" "ACLs for"
25628 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
25629 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
25630 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
25631 the state of the SMTP connection such as encryption and authentication) are not
25632 relevant and are forbidden in these ACLs. However, the sender and recipients
25633 are known, so the &%senders%& and &%sender_domains%& conditions and the
25634 &$sender_address$& and &$recipients$& variables can be used. Variables such as
25635 &$authenticated_sender$& are also available. You can specify added header lines
25636 in any of these ACLs.
25637
25638 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
25639 non-SMTP message, before any of the message has been read. (This is the
25640 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
25641 batched SMTP input, it runs after the DATA command has been reached. The
25642 result of this ACL is ignored; it cannot be used to reject a message. If you
25643 really need to, you could set a value in an ACL variable here and reject based
25644 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
25645 controls, and in particular, it can be used to set
25646 .code
25647 control = suppress_local_fixups
25648 .endd
25649 This cannot be used in the other non-SMTP ACLs because by the time they are
25650 run, it is too late.
25651
25652 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
25653 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25654
25655 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
25656 kind of rejection is treated as permanent, because there is no way of sending a
25657 temporary error for these kinds of message.
25658
25659
25660 .section "The SMTP connect ACL" "SECID191"
25661 .cindex "SMTP" "connection, ACL for"
25662 .oindex &%smtp_banner%&
25663 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
25664 session, after the test specified by &%host_reject_connection%& (which is now
25665 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
25666 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
25667 the message override the banner message that is otherwise specified by the
25668 &%smtp_banner%& option.
25669
25670
25671 .section "The EHLO/HELO ACL" "SECID192"
25672 .cindex "EHLO" "ACL for"
25673 .cindex "HELO" "ACL for"
25674 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
25675 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
25676 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
25677 Note that a client may issue more than one EHLO or HELO command in an SMTP
25678 session, and indeed is required to issue a new EHLO or HELO after successfully
25679 setting up encryption following a STARTTLS command.
25680
25681 If the command is accepted by an &%accept%& verb that has a &%message%&
25682 modifier, the message may not contain more than one line (it will be truncated
25683 at the first newline and a panic logged if it does). Such a message cannot
25684 affect the EHLO options that are listed on the second and subsequent lines of
25685 an EHLO response.
25686
25687
25688 .section "The DATA ACLs" "SECID193"
25689 .cindex "DATA" "ACLs for"
25690 Two ACLs are associated with the DATA command, because it is two-stage
25691 command, with two responses being sent to the client.
25692 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
25693 is obeyed. This gives you control after all the RCPT commands, but before
25694 the message itself is received. It offers the opportunity to give a negative
25695 response to the DATA command before the data is transmitted. Header lines
25696 added by MAIL or RCPT ACLs are not visible at this time, but any that
25697 are defined here are visible when the &%acl_smtp_data%& ACL is run.
25698
25699 You cannot test the contents of the message, for example, to verify addresses
25700 in the headers, at RCPT time or when the DATA command is received. Such
25701 tests have to appear in the ACL that is run after the message itself has been
25702 received, before the final response to the DATA command is sent. This is
25703 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
25704 associated with the DATA command.
25705
25706 For both of these ACLs, it is not possible to reject individual recipients. An
25707 error response rejects the entire message. Unfortunately, it is known that some
25708 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
25709 before or after the data) correctly &-- they keep the message on their queues
25710 and try again later, but that is their problem, though it does waste some of
25711 your resources.
25712
25713
25714 .section "The SMTP DKIM ACL" "SECTDKIMACL"
25715 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
25716 enabled (which is the default).
25717
25718 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
25719 received, and is executed for each DKIM signature found in a message.  If not
25720 otherwise specified, the default action is to accept.
25721
25722 For details on the operation of DKIM, see chapter &<<CHID12>>&.
25723
25724
25725 .section "The SMTP MIME ACL" "SECID194"
25726 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
25727 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25728
25729
25730 .section "The QUIT ACL" "SECTQUITACL"
25731 .cindex "QUIT, ACL for"
25732 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
25733 does not affect the response code to QUIT, which is always 221. Thus, the ACL
25734 does not in fact control any access. For this reason, the only verbs that are
25735 permitted are &%accept%& and &%warn%&.
25736
25737 This ACL can be used for tasks such as custom logging at the end of an SMTP
25738 session. For example, you can use ACL variables in other ACLs to count
25739 messages, recipients, etc., and log the totals at QUIT time using one or
25740 more &%logwrite%& modifiers on a &%warn%& verb.
25741
25742 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
25743 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
25744
25745 You do not need to have a final &%accept%&, but if you do, you can use a
25746 &%message%& modifier to specify custom text that is sent as part of the 221
25747 response to QUIT.
25748
25749 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
25750 failure (for example, failure to open a log file, or when Exim is bombing out
25751 because it has detected an unrecoverable error), all SMTP commands from the
25752 client are given temporary error responses until QUIT is received or the
25753 connection is closed. In these special cases, the QUIT ACL does not run.
25754
25755
25756 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25757 .vindex &$acl_smtp_notquit$&
25758 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25759 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25760 trouble, such as being unable to write to its log files, this ACL is not run,
25761 because it might try to do things (such as write to log files) that make the
25762 situation even worse.
25763
25764 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25765 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25766 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25767 and &%warn%&.
25768
25769 .vindex &$smtp_notquit_reason$&
25770 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25771 to a string that indicates the reason for the termination of the SMTP
25772 connection. The possible values are:
25773 .table2
25774 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25775 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25776 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25777 .irow &`connection-lost`&          "The SMTP connection has been lost"
25778 .irow &`data-timeout`&             "Timeout while reading message data"
25779 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25780 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25781 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25782 .irow &`synchronization-error`&    "SMTP synchronization error"
25783 .irow &`tls-failed`&               "TLS failed to start"
25784 .endtable
25785 In most cases when an SMTP connection is closed without having received QUIT,
25786 Exim sends an SMTP response message before actually closing the connection.
25787 With the exception of the &`acl-drop`& case, the default message can be
25788 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25789 &%drop%& verb in another ACL, it is the message from the other ACL that is
25790 used.
25791
25792
25793 .section "Finding an ACL to use" "SECID195"
25794 .cindex "&ACL;" "finding which to use"
25795 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25796 you can use different ACLs in different circumstances. For example,
25797 .code
25798 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25799                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25800 .endd
25801 In the default configuration file there are some example settings for
25802 providing an RFC 4409 message submission service on port 587 and a
25803 non-standard &"smtps"& service on port 465. You can use a string
25804 expansion like this to choose an ACL for MUAs on these ports which is
25805 more appropriate for this purpose than the default ACL on port 25.
25806
25807 The expanded string does not have to be the name of an ACL in the
25808 configuration file; there are other possibilities. Having expanded the
25809 string, Exim searches for an ACL as follows:
25810
25811 .ilist
25812 If the string begins with a slash, Exim uses it as a file name, and reads its
25813 contents as an ACL. The lines are processed in the same way as lines in the
25814 Exim configuration file. In particular, continuation lines are supported, blank
25815 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25816 If the file does not exist or cannot be read, an error occurs (typically
25817 causing a temporary failure of whatever caused the ACL to be run). For example:
25818 .code
25819 acl_smtp_data = /etc/acls/\
25820   ${lookup{$sender_host_address}lsearch\
25821   {/etc/acllist}{$value}{default}}
25822 .endd
25823 This looks up an ACL file to use on the basis of the host's IP address, falling
25824 back to a default if the lookup fails. If an ACL is successfully read from a
25825 file, it is retained in memory for the duration of the Exim process, so that it
25826 can be re-used without having to re-read the file.
25827 .next
25828 If the string does not start with a slash, and does not contain any spaces,
25829 Exim searches the ACL section of the configuration for an ACL whose name
25830 matches the string.
25831 .next
25832 If no named ACL is found, or if the string contains spaces, Exim parses
25833 the string as an inline ACL. This can save typing in cases where you just
25834 want to have something like
25835 .code
25836 acl_smtp_vrfy = accept
25837 .endd
25838 in order to allow free use of the VRFY command. Such a string may contain
25839 newlines; it is processed in the same way as an ACL that is read from a file.
25840 .endlist
25841
25842
25843
25844
25845 .section "ACL return codes" "SECID196"
25846 .cindex "&ACL;" "return codes"
25847 Except for the QUIT ACL, which does not affect the SMTP return code (see
25848 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25849 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25850 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25851 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25852 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25853 This also causes a 4&'xx'& return code.
25854
25855 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25856 &"deny"&, because there is no mechanism for passing temporary errors to the
25857 submitters of non-SMTP messages.
25858
25859
25860 ACLs that are relevant to message reception may also return &"discard"&. This
25861 has the effect of &"accept"&, but causes either the entire message or an
25862 individual recipient address to be discarded. In other words, it is a
25863 blackholing facility. Use it with care.
25864
25865 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25866 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25867 RCPT ACL is to discard just the one recipient address. If there are no
25868 recipients left when the message's data is received, the DATA ACL is not
25869 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25870 remaining recipients. The &"discard"& return is not permitted for the
25871 &%acl_smtp_predata%& ACL.
25872
25873
25874 .cindex "&[local_scan()]& function" "when all recipients discarded"
25875 The &[local_scan()]& function is always run, even if there are no remaining
25876 recipients; it may create new recipients.
25877
25878
25879
25880 .section "Unset ACL options" "SECID197"
25881 .cindex "&ACL;" "unset options"
25882 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25883 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25884 not defined at all. For any defined ACL, the default action when control
25885 reaches the end of the ACL statements is &"deny"&.
25886
25887 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25888 these two are ACLs that are used only for their side effects. They cannot be
25889 used to accept or reject anything.
25890
25891 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25892 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25893 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25894 when the ACL is not defined is &"accept"&.
25895
25896 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25897 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25898 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25899 messages over an SMTP connection. For an example, see the ACL in the default
25900 configuration file.
25901
25902
25903
25904
25905 .section "Data for message ACLs" "SECID198"
25906 .cindex "&ACL;" "data for message ACL"
25907 .vindex &$domain$&
25908 .vindex &$local_part$&
25909 .vindex &$sender_address$&
25910 .vindex &$sender_host_address$&
25911 .vindex &$smtp_command$&
25912 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25913 that contain information about the host and the message's sender (for example,
25914 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25915 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25916 &$local_part$& are set from the argument address. The entire SMTP command
25917 is available in &$smtp_command$&.
25918
25919 When an ACL for the AUTH parameter of MAIL is running, the variables that
25920 contain information about the host are set, but &$sender_address$& is not yet
25921 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25922 how it is used.
25923
25924 .vindex "&$message_size$&"
25925 The &$message_size$& variable is set to the value of the SIZE parameter on
25926 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25927 that parameter is not given. The value is updated to the true message size by
25928 the time the final DATA ACL is run (after the message data has been
25929 received).
25930
25931 .vindex "&$rcpt_count$&"
25932 .vindex "&$recipients_count$&"
25933 The &$rcpt_count$& variable increases by one for each RCPT command received.
25934 The &$recipients_count$& variable increases by one each time a RCPT command is
25935 accepted, so while an ACL for RCPT is being processed, it contains the number
25936 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25937 &$rcpt_count$& contains the total number of RCPT commands, and
25938 &$recipients_count$& contains the total number of accepted recipients.
25939
25940
25941
25942
25943
25944 .section "Data for non-message ACLs" "SECTdatfornon"
25945 .cindex "&ACL;" "data for non-message ACL"
25946 .vindex &$smtp_command_argument$&
25947 .vindex &$smtp_command$&
25948 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25949 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25950 and the entire SMTP command is available in &$smtp_command$&.
25951 These variables can be tested using a &%condition%& condition. For example,
25952 here is an ACL for use with AUTH, which insists that either the session is
25953 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25954 does not permit authentication methods that use cleartext passwords on
25955 unencrypted connections.
25956 .code
25957 acl_check_auth:
25958   accept encrypted = *
25959   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25960                      {CRAM-MD5}}
25961   deny   message   = TLS encryption or CRAM-MD5 required
25962 .endd
25963 (Another way of applying this restriction is to arrange for the authenticators
25964 that use cleartext passwords not to be advertised when the connection is not
25965 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25966 option to do this.)
25967
25968
25969
25970 .section "Format of an ACL" "SECID199"
25971 .cindex "&ACL;" "format of"
25972 .cindex "&ACL;" "verbs, definition of"
25973 An individual ACL consists of a number of statements. Each statement starts
25974 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25975 Modifiers can change the way the verb operates, define error and log messages,
25976 set variables, insert delays, and vary the processing of accepted messages.
25977
25978 If all the conditions are met, the verb is obeyed. The same condition may be
25979 used (with different arguments) more than once in the same statement. This
25980 provides a means of specifying an &"and"& conjunction between conditions. For
25981 example:
25982 .code
25983 deny  dnslists = list1.example
25984 dnslists = list2.example
25985 .endd
25986 If there are no conditions, the verb is always obeyed. Exim stops evaluating
25987 the conditions and modifiers when it reaches a condition that fails. What
25988 happens then depends on the verb (and in one case, on a special modifier). Not
25989 all the conditions make sense at every testing point. For example, you cannot
25990 test a sender address in the ACL that is run for a VRFY command.
25991
25992
25993 .section "ACL verbs" "SECID200"
25994 The ACL verbs are as follows:
25995
25996 .ilist
25997 .cindex "&%accept%& ACL verb"
25998 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
25999 of the conditions are not met, what happens depends on whether &%endpass%&
26000 appears among the conditions (for syntax see below). If the failing condition
26001 is before &%endpass%&, control is passed to the next ACL statement; if it is
26002 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26003 check a RCPT command:
26004 .code
26005 accept domains = +local_domains
26006 endpass
26007 verify = recipient
26008 .endd
26009 If the recipient domain does not match the &%domains%& condition, control
26010 passes to the next statement. If it does match, the recipient is verified, and
26011 the command is accepted if verification succeeds. However, if verification
26012 fails, the ACL yields &"deny"&, because the failing condition is after
26013 &%endpass%&.
26014
26015 The &%endpass%& feature has turned out to be confusing to many people, so its
26016 use is not recommended nowadays. It is always possible to rewrite an ACL so
26017 that &%endpass%& is not needed, and it is no longer used in the default
26018 configuration.
26019
26020 .cindex "&%message%& ACL modifier" "with &%accept%&"
26021 If a &%message%& modifier appears on an &%accept%& statement, its action
26022 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26023 (when an &%accept%& verb either accepts or passes control to the next
26024 statement), &%message%& can be used to vary the message that is sent when an
26025 SMTP command is accepted. For example, in a RCPT ACL you could have:
26026 .display
26027 &`accept  `&<&'some conditions'&>
26028 &`        message = OK, I will allow you through today`&
26029 .endd
26030 You can specify an SMTP response code, optionally followed by an &"extended
26031 response code"& at the start of the message, but the first digit must be the
26032 same as would be sent by default, which is 2 for an &%accept%& verb.
26033
26034 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26035 an error message that is used when access is denied. This behaviour is retained
26036 for backward compatibility, but current &"best practice"& is to avoid the use
26037 of &%endpass%&.
26038
26039
26040 .next
26041 .cindex "&%defer%& ACL verb"
26042 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26043 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26044 &%defer%& is the same as &%deny%&, because there is no way of sending a
26045 temporary error. For a RCPT command, &%defer%& is much the same as using a
26046 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26047 be used in any ACL, and even for a recipient it might be a simpler approach.
26048
26049
26050 .next
26051 .cindex "&%deny%& ACL verb"
26052 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26053 the conditions are not met, control is passed to the next ACL statement. For
26054 example,
26055 .code
26056 deny dnslists = blackholes.mail-abuse.org
26057 .endd
26058 rejects commands from hosts that are on a DNS black list.
26059
26060
26061 .next
26062 .cindex "&%discard%& ACL verb"
26063 &%discard%&: This verb behaves like &%accept%&, except that it returns
26064 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26065 that are concerned with receiving messages. When all the conditions are true,
26066 the sending entity receives a &"success"& response. However, &%discard%& causes
26067 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26068 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26069 message's recipients are discarded. Recipients that are discarded before DATA
26070 do not appear in the log line when the &%received_recipients%& log selector is set.
26071
26072 If the &%log_message%& modifier is set when &%discard%& operates,
26073 its contents are added to the line that is automatically written to the log.
26074 The &%message%& modifier operates exactly as it does for &%accept%&.
26075
26076
26077 .next
26078 .cindex "&%drop%& ACL verb"
26079 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26080 forcibly closed after the 5&'xx'& error message has been sent. For example:
26081 .code
26082 drop   message   = I don't take more than 20 RCPTs
26083        condition = ${if > {$rcpt_count}{20}}
26084 .endd
26085 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26086 The connection is always dropped after sending a 550 response.
26087
26088 .next
26089 .cindex "&%require%& ACL verb"
26090 &%require%&: If all the conditions are met, control is passed to the next ACL
26091 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26092 example, when checking a RCPT command,
26093 .code
26094 require message = Sender did not verify
26095         verify  = sender
26096 .endd
26097 passes control to subsequent statements only if the message's sender can be
26098 verified. Otherwise, it rejects the command. Note the positioning of the
26099 &%message%& modifier, before the &%verify%& condition. The reason for this is
26100 discussed in section &<<SECTcondmodproc>>&.
26101
26102 .next
26103 .cindex "&%warn%& ACL verb"
26104 &%warn%&: If all the conditions are true, a line specified by the
26105 &%log_message%& modifier is written to Exim's main log. Control always passes
26106 to the next ACL statement. If any condition is false, the log line is not
26107 written. If an identical log line is requested several times in the same
26108 message, only one copy is actually written to the log. If you want to force
26109 duplicates to be written, use the &%logwrite%& modifier instead.
26110
26111 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26112 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26113 &%logwrite%&, and &%add_header%&) that appear before the first failing
26114 condition. There is more about adding header lines in section
26115 &<<SECTaddheadacl>>&.
26116
26117 If any condition on a &%warn%& statement cannot be completed (that is, there is
26118 some sort of defer), the log line specified by &%log_message%& is not written.
26119 This does not include the case of a forced failure from a lookup, which
26120 is considered to be a successful completion. After a defer, no further
26121 conditions or modifiers in the &%warn%& statement are processed. The incident
26122 is logged, and the ACL continues to be processed, from the next statement
26123 onwards.
26124
26125
26126 .vindex "&$acl_verify_message$&"
26127 When one of the &%warn%& conditions is an address verification that fails, the
26128 text of the verification failure message is in &$acl_verify_message$&. If you
26129 want this logged, you must set it up explicitly. For example:
26130 .code
26131 warn   !verify = sender
26132        log_message = sender verify failed: $acl_verify_message
26133 .endd
26134 .endlist
26135
26136 At the end of each ACL there is an implicit unconditional &%deny%&.
26137
26138 As you can see from the examples above, the conditions and modifiers are
26139 written one to a line, with the first one on the same line as the verb, and
26140 subsequent ones on following lines. If you have a very long condition, you can
26141 continue it onto several physical lines by the usual backslash continuation
26142 mechanism. It is conventional to align the conditions vertically.
26143
26144
26145
26146 .section "ACL variables" "SECTaclvariables"
26147 .cindex "&ACL;" "variables"
26148 There are some special variables that can be set during ACL processing. They
26149 can be used to pass information between different ACLs, different invocations
26150 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26151 transports, and filters that are used to deliver a message. The names of these
26152 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26153 an underscore, but the remainder of the name can be any sequence of
26154 alphanumeric characters and underscores that you choose. There is no limit on
26155 the number of ACL variables. The two sets act as follows:
26156 .ilist
26157 The values of those variables whose names begin with &$acl_c$& persist
26158 throughout an SMTP connection. They are never reset. Thus, a value that is set
26159 while receiving one message is still available when receiving the next message
26160 on the same SMTP connection.
26161 .next
26162 The values of those variables whose names begin with &$acl_m$& persist only
26163 while a message is being received. They are reset afterwards. They are also
26164 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26165 .endlist
26166
26167 When a message is accepted, the current values of all the ACL variables are
26168 preserved with the message and are subsequently made available at delivery
26169 time. The ACL variables are set by a modifier called &%set%&. For example:
26170 .code
26171 accept hosts = whatever
26172        set acl_m4 = some value
26173 accept authenticated = *
26174        set acl_c_auth = yes
26175 .endd
26176 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26177 be set. If you want to set a variable without taking any action, you can use a
26178 &%warn%& verb without any other modifiers or conditions.
26179
26180 .oindex &%strict_acl_vars%&
26181 What happens if a syntactically valid but undefined ACL variable is
26182 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26183 false (the default), an empty string is substituted; if it is true, an
26184 error is generated.
26185
26186 Versions of Exim before 4.64 have a limited set of numbered variables, but
26187 their names are compatible, so there is no problem with upgrading.
26188
26189
26190 .section "Condition and modifier processing" "SECTcondmodproc"
26191 .cindex "&ACL;" "conditions; processing"
26192 .cindex "&ACL;" "modifiers; processing"
26193 An exclamation mark preceding a condition negates its result. For example:
26194 .code
26195 deny   domains = *.dom.example
26196       !verify  = recipient
26197 .endd
26198 causes the ACL to return &"deny"& if the recipient domain ends in
26199 &'dom.example'& and the recipient address cannot be verified. Sometimes
26200 negation can be used on the right-hand side of a condition. For example, these
26201 two statements are equivalent:
26202 .code
26203 deny  hosts = !192.168.3.4
26204 deny !hosts =  192.168.3.4
26205 .endd
26206 However, for many conditions (&%verify%& being a good example), only left-hand
26207 side negation of the whole condition is possible.
26208
26209 The arguments of conditions and modifiers are expanded. A forced failure
26210 of an expansion causes a condition to be ignored, that is, it behaves as if the
26211 condition is true. Consider these two statements:
26212 .code
26213 accept  senders = ${lookup{$host_name}lsearch\
26214                   {/some/file}{$value}fail}
26215 accept  senders = ${lookup{$host_name}lsearch\
26216                   {/some/file}{$value}{}}
26217 .endd
26218 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26219 the returned list is searched, but if the lookup fails the behaviour is
26220 different in the two cases. The &%fail%& in the first statement causes the
26221 condition to be ignored, leaving no further conditions. The &%accept%& verb
26222 therefore succeeds. The second statement, however, generates an empty list when
26223 the lookup fails. No sender can match an empty list, so the condition fails,
26224 and therefore the &%accept%& also fails.
26225
26226 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26227 specify actions that are taken as the conditions for a statement are checked;
26228 others specify text for messages that are used when access is denied or a
26229 warning is generated. The &%control%& modifier affects the way an incoming
26230 message is handled.
26231
26232 The positioning of the modifiers in an ACL statement important, because the
26233 processing of a verb ceases as soon as its outcome is known. Only those
26234 modifiers that have already been encountered will take effect. For example,
26235 consider this use of the &%message%& modifier:
26236 .code
26237 require message = Can't verify sender
26238         verify  = sender
26239         message = Can't verify recipient
26240         verify  = recipient
26241         message = This message cannot be used
26242 .endd
26243 If sender verification fails, Exim knows that the result of the statement is
26244 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26245 so its text is used as the error message. If sender verification succeeds, but
26246 recipient verification fails, the second message is used. If recipient
26247 verification succeeds, the third message becomes &"current"&, but is never used
26248 because there are no more conditions to cause failure.
26249
26250 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26251 modifier that is used, because all the conditions must be true for rejection to
26252 happen. Specifying more than one &%message%& modifier does not make sense, and
26253 the message can even be specified after all the conditions. For example:
26254 .code
26255 deny   hosts = ...
26256       !senders = *@my.domain.example
26257        message = Invalid sender from client host
26258 .endd
26259 The &"deny"& result does not happen until the end of the statement is reached,
26260 by which time Exim has set up the message.
26261
26262
26263
26264 .section "ACL modifiers" "SECTACLmodi"
26265 .cindex "&ACL;" "modifiers; list of"
26266 The ACL modifiers are as follows:
26267
26268 .vlist
26269 .vitem &*add_header*&&~=&~<&'text'&>
26270 This modifier specifies one or more header lines that are to be added to an
26271 incoming message, assuming, of course, that the message is ultimately
26272 accepted. For details, see section &<<SECTaddheadacl>>&.
26273
26274 .vitem &*continue*&&~=&~<&'text'&>
26275 .cindex "&%continue%& ACL modifier"
26276 .cindex "database" "updating in ACL"
26277 This modifier does nothing of itself, and processing of the ACL always
26278 continues with the next condition or modifier. The value of &%continue%& is in
26279 the side effects of expanding its argument. Typically this could be used to
26280 update a database. It is really just a syntactic tidiness, to avoid having to
26281 write rather ugly lines like this:
26282 .display
26283 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26284 .endd
26285 Instead, all you need is
26286 .display
26287 &`continue = `&<&'some expansion'&>
26288 .endd
26289
26290 .vitem &*control*&&~=&~<&'text'&>
26291 .cindex "&%control%& ACL modifier"
26292 This modifier affects the subsequent processing of the SMTP connection or of an
26293 incoming message that is accepted. The effect of the first type of control
26294 lasts for the duration of the connection, whereas the effect of the second type
26295 lasts only until the current message has been received. The message-specific
26296 controls always apply to the whole message, not to individual recipients,
26297 even if the &%control%& modifier appears in a RCPT ACL.
26298
26299 As there are now quite a few controls that can be applied, they are described
26300 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26301 in several different ways. For example:
26302
26303 . ==== As this is a nested list, any displays it contains must be indented
26304 . ==== as otherwise they are too far to the left. That comment applies only
26305 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26306 . ==== way.
26307
26308 .ilist
26309 It can be at the end of an &%accept%& statement:
26310 .code
26311     accept  ...some conditions
26312             control = queue_only
26313 .endd
26314 In this case, the control is applied when this statement yields &"accept"&, in
26315 other words, when the conditions are all true.
26316
26317 .next
26318 It can be in the middle of an &%accept%& statement:
26319 .code
26320     accept  ...some conditions...
26321             control = queue_only
26322             ...some more conditions...
26323 .endd
26324 If the first set of conditions are true, the control is applied, even if the
26325 statement does not accept because one of the second set of conditions is false.
26326 In this case, some subsequent statement must yield &"accept"& for the control
26327 to be relevant.
26328
26329 .next
26330 It can be used with &%warn%& to apply the control, leaving the
26331 decision about accepting or denying to a subsequent verb. For
26332 example:
26333 .code
26334     warn    ...some conditions...
26335             control = freeze
26336     accept  ...
26337 .endd
26338 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26339 &%logwrite%&, so it does not add anything to the message and does not write a
26340 log entry.
26341
26342 .next
26343 If you want to apply a control unconditionally, you can use it with a
26344 &%require%& verb. For example:
26345 .code
26346     require  control = no_multiline_responses
26347 .endd
26348 .endlist
26349
26350 .vitem &*delay*&&~=&~<&'time'&>
26351 .cindex "&%delay%& ACL modifier"
26352 .oindex "&%-bh%&"
26353 This modifier may appear in any ACL. It causes Exim to wait for the time
26354 interval before proceeding. However, when testing Exim using the &%-bh%&
26355 option, the delay is not actually imposed (an appropriate message is output
26356 instead). The time is given in the usual Exim notation, and the delay happens
26357 as soon as the modifier is processed. In an SMTP session, pending output is
26358 flushed before the delay is imposed.
26359
26360 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26361 example:
26362 .code
26363 deny    ...some conditions...
26364         delay = 30s
26365 .endd
26366 The delay happens if all the conditions are true, before the statement returns
26367 &"deny"&. Compare this with:
26368 .code
26369 deny    delay = 30s
26370         ...some conditions...
26371 .endd
26372 which waits for 30s before processing the conditions. The &%delay%& modifier
26373 can also be used with &%warn%& and together with &%control%&:
26374 .code
26375 warn    ...some conditions...
26376         delay = 2m
26377         control = freeze
26378 accept  ...
26379 .endd
26380
26381 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26382 responses to several commands are no longer buffered and sent in one packet (as
26383 they would normally be) because all output is flushed before imposing the
26384 delay. This optimization is disabled so that a number of small delays do not
26385 appear to the client as one large aggregated delay that might provoke an
26386 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26387 using a &%control%& modifier to set &%no_delay_flush%&.
26388
26389
26390 .vitem &*endpass*&
26391 .cindex "&%endpass%& ACL modifier"
26392 This modifier, which has no argument, is recognized only in &%accept%& and
26393 &%discard%& statements. It marks the boundary between the conditions whose
26394 failure causes control to pass to the next statement, and the conditions whose
26395 failure causes the ACL to return &"deny"&. This concept has proved to be
26396 confusing to some people, so the use of &%endpass%& is no longer recommended as
26397 &"best practice"&. See the description of &%accept%& above for more details.
26398
26399
26400 .vitem &*log_message*&&~=&~<&'text'&>
26401 .cindex "&%log_message%& ACL modifier"
26402 This modifier sets up a message that is used as part of the log message if the
26403 ACL denies access or a &%warn%& statement's conditions are true. For example:
26404 .code
26405 require log_message = wrong cipher suite $tls_cipher
26406         encrypted   = DES-CBC3-SHA
26407 .endd
26408 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26409 example:
26410 .display
26411 &`discard `&<&'some conditions'&>
26412 &`        log_message = Discarded $local_part@$domain because...`&
26413 .endd
26414 When access is denied, &%log_message%& adds to any underlying error message
26415 that may exist because of a condition failure. For example, while verifying a
26416 recipient address, a &':fail:'& redirection might have already set up a
26417 message.
26418
26419 The message may be defined before the conditions to which it applies, because
26420 the string expansion does not happen until Exim decides that access is to be
26421 denied. This means that any variables that are set by the condition are
26422 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26423 variables are set after a DNS black list lookup succeeds. If the expansion of
26424 &%log_message%& fails, or if the result is an empty string, the modifier is
26425 ignored.
26426
26427 .vindex "&$acl_verify_message$&"
26428 If you want to use a &%warn%& statement to log the result of an address
26429 verification, you can use &$acl_verify_message$& to include the verification
26430 error message.
26431
26432 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26433 the start of the logged message. If the same warning log message is requested
26434 more than once while receiving  a single email message, only one copy is
26435 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26436 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26437 is logged for a successful &%warn%& statement.
26438
26439 If &%log_message%& is not present and there is no underlying error message (for
26440 example, from the failure of address verification), but &%message%& is present,
26441 the &%message%& text is used for logging rejections. However, if any text for
26442 logging contains newlines, only the first line is logged. In the absence of
26443 both &%log_message%& and &%message%&, a default built-in message is used for
26444 logging rejections.
26445
26446
26447 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26448 .cindex "&%log_reject_target%& ACL modifier"
26449 .cindex "logging in ACL" "specifying which log"
26450 This modifier makes it possible to specify which logs are used for messages
26451 about ACL rejections. Its argument is a colon-separated list of words that can
26452 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26453 may be empty, in which case a rejection is not logged at all. For example, this
26454 ACL fragment writes no logging information when access is denied:
26455 .display
26456 &`deny `&<&'some conditions'&>
26457 &`     log_reject_target =`&
26458 .endd
26459 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26460 permanent and temporary rejections. Its effect lasts for the rest of the
26461 current ACL.
26462
26463
26464 .vitem &*logwrite*&&~=&~<&'text'&>
26465 .cindex "&%logwrite%& ACL modifier"
26466 .cindex "logging in ACL" "immediate"
26467 This modifier writes a message to a log file as soon as it is encountered when
26468 processing an ACL. (Compare &%log_message%&, which, except in the case of
26469 &%warn%& and &%discard%&, is used only if the ACL statement denies
26470 access.) The &%logwrite%& modifier can be used to log special incidents in
26471 ACLs. For example:
26472 .display
26473 &`accept `&<&'some special conditions'&>
26474 &`       control  = freeze`&
26475 &`       logwrite = froze message because ...`&
26476 .endd
26477 By default, the message is written to the main log. However, it may begin
26478 with a colon, followed by a comma-separated list of log names, and then
26479 another colon, to specify exactly which logs are to be written. For
26480 example:
26481 .code
26482 logwrite = :main,reject: text for main and reject logs
26483 logwrite = :panic: text for panic log only
26484 .endd
26485
26486
26487 .vitem &*message*&&~=&~<&'text'&>
26488 .cindex "&%message%& ACL modifier"
26489 This modifier sets up a text string that is expanded and used as a response
26490 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
26491 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
26492 there is some complication if &%endpass%& is involved; see the description of
26493 &%accept%& for details.)
26494
26495 The expansion of the message happens at the time Exim decides that the ACL is
26496 to end, not at the time it processes &%message%&. If the expansion fails, or
26497 generates an empty string, the modifier is ignored. Here is an example where
26498 &%message%& must be specified first, because the ACL ends with a rejection if
26499 the &%hosts%& condition fails:
26500 .code
26501 require  message = Host not recognized
26502          hosts = 10.0.0.0/8
26503 .endd
26504 (Once a condition has failed, no further conditions or modifiers are
26505 processed.)
26506
26507 .cindex "SMTP" "error codes"
26508 .oindex "&%smtp_banner%&
26509 For ACLs that are triggered by SMTP commands, the message is returned as part
26510 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
26511 is meaningful only for SMTP, as no message is returned when a non-SMTP message
26512 is accepted. In the case of the connect ACL, accepting with a message modifier
26513 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
26514 accept message may not contain more than one line (otherwise it will be
26515 truncated at the first newline and a panic logged), and it cannot affect the
26516 EHLO options.
26517
26518 When SMTP is involved, the message may begin with an overriding response code,
26519 consisting of three digits optionally followed by an &"extended response code"&
26520 of the form &'n.n.n'&, each code being followed by a space. For example:
26521 .code
26522 deny  message = 599 1.2.3 Host not welcome
26523       hosts = 192.168.34.0/24
26524 .endd
26525 The first digit of the supplied response code must be the same as would be sent
26526 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
26527 access, but for the predata ACL, note that the default success code is 354, not
26528 2&'xx'&.
26529
26530 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
26531 the message modifier cannot override the 221 response code.
26532
26533 The text in a &%message%& modifier is literal; any quotes are taken as
26534 literals, but because the string is expanded, backslash escapes are processed
26535 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
26536 response.
26537
26538 .vindex "&$acl_verify_message$&"
26539 If &%message%& is used on a statement that verifies an address, the message
26540 specified overrides any message that is generated by the verification process.
26541 However, the original message is available in the variable
26542 &$acl_verify_message$&, so you can incorporate it into your message if you
26543 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
26544 routers to be passed back as part of the SMTP response, you should either not
26545 use a &%message%& modifier, or make use of &$acl_verify_message$&.
26546
26547 For compatibility with previous releases of Exim, a &%message%& modifier that
26548 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
26549 modifier, but this usage is now deprecated. However, &%message%& acts only when
26550 all the conditions are true, wherever it appears in an ACL command, whereas
26551 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
26552 &%warn%& in an ACL that is not concerned with receiving a message, it has no
26553 effect.
26554
26555
26556 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
26557 .cindex "&%set%& ACL modifier"
26558 This modifier puts a value into one of the ACL variables (see section
26559 &<<SECTaclvariables>>&).
26560 .endlist
26561
26562
26563
26564
26565
26566 .section "Use of the control modifier" "SECTcontrols"
26567 .cindex "&%control%& ACL modifier"
26568 The &%control%& modifier supports the following settings:
26569
26570 .vlist
26571 .vitem &*control&~=&~allow_auth_unadvertised*&
26572 This modifier allows a client host to use the SMTP AUTH command even when it
26573 has not been advertised in response to EHLO. Furthermore, because there are
26574 apparently some really broken clients that do this, Exim will accept AUTH after
26575 HELO (rather than EHLO) when this control is set. It should be used only if you
26576 really need it, and you should limit its use to those broken clients that do
26577 not work without it. For example:
26578 .code
26579 warn hosts   = 192.168.34.25
26580      control = allow_auth_unadvertised
26581 .endd
26582 Normally, when an Exim server receives an AUTH command, it checks the name of
26583 the authentication mechanism that is given in the command to ensure that it
26584 matches an advertised mechanism. When this control is set, the check that a
26585 mechanism has been advertised is bypassed. Any configured mechanism can be used
26586 by the client. This control is permitted only in the connection and HELO ACLs.
26587
26588
26589 .vitem &*control&~=&~caseful_local_part*& &&&
26590        &*control&~=&~caselower_local_part*&
26591 .cindex "&ACL;" "case of local part in"
26592 .cindex "case of local parts"
26593 .vindex "&$local_part$&"
26594 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
26595 (that is, during RCPT processing). By default, the contents of &$local_part$&
26596 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
26597 any uppercase letters in the original local part are restored in &$local_part$&
26598 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
26599 is encountered.
26600
26601 These controls affect only the current recipient. Moreover, they apply only to
26602 local part handling that takes place directly in the ACL (for example, as a key
26603 in lookups). If a test to verify the recipient is obeyed, the case-related
26604 handling of the local part during the verification is controlled by the router
26605 configuration (see the &%caseful_local_part%& generic router option).
26606
26607 This facility could be used, for example, to add a spam score to local parts
26608 containing upper case letters. For example, using &$acl_m4$& to accumulate the
26609 spam score:
26610 .code
26611 warn  control = caseful_local_part
26612       set acl_m4 = ${eval:\
26613                      $acl_m4 + \
26614                      ${if match{$local_part}{[A-Z]}{1}{0}}\
26615                     }
26616       control = caselower_local_part
26617 .endd
26618 Notice that we put back the lower cased version afterwards, assuming that
26619 is what is wanted for subsequent tests.
26620
26621
26622 .vitem &*control&~=&~debug/*&<&'options'&>
26623 .cindex "&ACL;" "enabling debug logging"
26624 .cindex "debugging" "enabling from an ACL"
26625 This control turns on debug logging, almost as though Exim had been invoked
26626 with &`-d`&, with the output going to a new logfile, by default called
26627 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
26628 may access any variables already defined.  The logging may be adjusted with
26629 the &'opts'& option, which takes the same values as the &`-d`& command-line
26630 option.  Some examples (which depend on variables that don't exist in all
26631 contexts):
26632 .code
26633       control = debug
26634       control = debug/tag=.$sender_host_address
26635       control = debug/opts=+expand+acl
26636       control = debug/tag=.$message_exim_id/opts=+expand
26637 .endd
26638
26639
26640 .vitem &*control&~=&~enforce_sync*& &&&
26641        &*control&~=&~no_enforce_sync*&
26642 .cindex "SMTP" "synchronization checking"
26643 .cindex "synchronization checking in SMTP"
26644 These controls make it possible to be selective about when SMTP synchronization
26645 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
26646 state of the switch (it is true by default). See the description of this option
26647 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
26648
26649 The effect of these two controls lasts for the remainder of the SMTP
26650 connection. They can appear in any ACL except the one for the non-SMTP
26651 messages. The most straightforward place to put them is in the ACL defined by
26652 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
26653 before the first synchronization check. The expected use is to turn off the
26654 synchronization checks for badly-behaved hosts that you nevertheless need to
26655 work with.
26656
26657
26658 .vitem &*control&~=&~fakedefer/*&<&'message'&>
26659 .cindex "fake defer"
26660 .cindex "defer, fake"
26661 This control works in exactly the same way as &%fakereject%& (described below)
26662 except that it causes an SMTP 450 response after the message data instead of a
26663 550 response. You must take care when using &%fakedefer%& because it causes the
26664 messages to be duplicated when the sender retries. Therefore, you should not
26665 use &%fakedefer%& if the message is to be delivered normally.
26666
26667 .vitem &*control&~=&~fakereject/*&<&'message'&>
26668 .cindex "fake rejection"
26669 .cindex "rejection, fake"
26670 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
26671 words, only when an SMTP message is being received. If Exim accepts the
26672 message, instead the final 250 response, a 550 rejection message is sent.
26673 However, Exim proceeds to deliver the message as normal. The control applies
26674 only to the current message, not to any subsequent ones that may be received in
26675 the same SMTP connection.
26676
26677 The text for the 550 response is taken from the &%control%& modifier. If no
26678 message is supplied, the following is used:
26679 .code
26680 550-Your message has been rejected but is being
26681 550-kept for evaluation.
26682 550-If it was a legitimate message, it may still be
26683 550 delivered to the target recipient(s).
26684 .endd
26685 This facility should be used with extreme caution.
26686
26687 .vitem &*control&~=&~freeze*&
26688 .cindex "frozen messages" "forcing in ACL"
26689 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26690 other words, only when a message is being received. If the message is accepted,
26691 it is placed on Exim's queue and frozen. The control applies only to the
26692 current message, not to any subsequent ones that may be received in the same
26693 SMTP connection.
26694
26695 This modifier can optionally be followed by &`/no_tell`&. If the global option
26696 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
26697 is told about the freezing), provided all the &*control=freeze*& modifiers that
26698 are obeyed for the current message have the &`/no_tell`& option.
26699
26700 .vitem &*control&~=&~no_delay_flush*&
26701 .cindex "SMTP" "output flushing, disabling for delay"
26702 Exim normally flushes SMTP output before implementing a delay in an ACL, to
26703 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26704 use. This control, as long as it is encountered before the &%delay%& modifier,
26705 disables such output flushing.
26706
26707 .vitem &*control&~=&~no_callout_flush*&
26708 .cindex "SMTP" "output flushing, disabling for callout"
26709 Exim normally flushes SMTP output before performing a callout in an ACL, to
26710 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26711 use. This control, as long as it is encountered before the &%verify%& condition
26712 that causes the callout, disables such output flushing.
26713
26714 .vitem &*control&~=&~no_mbox_unspool*&
26715 This control is available when Exim is compiled with the content scanning
26716 extension. Content scanning may require a copy of the current message, or parts
26717 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
26718 or spam scanner. Normally, such copies are deleted when they are no longer
26719 needed. If this control is set, the copies are not deleted. The control applies
26720 only to the current message, not to any subsequent ones that may be received in
26721 the same SMTP connection. It is provided for debugging purposes and is unlikely
26722 to be useful in production.
26723
26724 .vitem &*control&~=&~no_multiline_responses*&
26725 .cindex "multiline responses, suppressing"
26726 This control is permitted for any ACL except the one for non-SMTP messages.
26727 It seems that there are broken clients in use that cannot handle multiline
26728 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
26729
26730 If this control is set, multiline SMTP responses from ACL rejections are
26731 suppressed. One way of doing this would have been to put out these responses as
26732 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
26733 (&"use multiline responses for more"& it says &-- ha!), and some of the
26734 responses might get close to that. So this facility, which is after all only a
26735 sop to broken clients, is implemented by doing two very easy things:
26736
26737 .ilist
26738 Extra information that is normally output as part of a rejection caused by
26739 sender verification failure is omitted. Only the final line (typically &"sender
26740 verification failed"&) is sent.
26741 .next
26742 If a &%message%& modifier supplies a multiline response, only the first
26743 line is output.
26744 .endlist
26745
26746 The setting of the switch can, of course, be made conditional on the
26747 calling host. Its effect lasts until the end of the SMTP connection.
26748
26749 .vitem &*control&~=&~no_pipelining*&
26750 .cindex "PIPELINING" "suppressing advertising"
26751 This control turns off the advertising of the PIPELINING extension to SMTP in
26752 the current session. To be useful, it must be obeyed before Exim sends its
26753 response to an EHLO command. Therefore, it should normally appear in an ACL
26754 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26755 &%pipelining_advertise_hosts%&.
26756
26757 .vitem &*control&~=&~queue_only*&
26758 .oindex "&%queue_only%&"
26759 .cindex "queueing incoming messages"
26760 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26761 other words, only when a message is being received. If the message is accepted,
26762 it is placed on Exim's queue and left there for delivery by a subsequent queue
26763 runner. No immediate delivery process is started. In other words, it has the
26764 effect as the &%queue_only%& global option. However, the control applies only
26765 to the current message, not to any subsequent ones that may be received in the
26766 same SMTP connection.
26767
26768 .vitem &*control&~=&~submission/*&<&'options'&>
26769 .cindex "message" "submission"
26770 .cindex "submission mode"
26771 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26772 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26773 the current message is a submission from a local MUA. In this case, Exim
26774 operates in &"submission mode"&, and applies certain fixups to the message if
26775 necessary. For example, it adds a &'Date:'& header line if one is not present.
26776 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26777 late (the message has already been created).
26778
26779 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26780 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26781 submission mode; the available options for this control are described there.
26782 The control applies only to the current message, not to any subsequent ones
26783 that may be received in the same SMTP connection.
26784
26785 .vitem &*control&~=&~suppress_local_fixups*&
26786 .cindex "submission fixups, suppressing"
26787 This control applies to locally submitted (non TCP/IP) messages, and is the
26788 complement of &`control = submission`&. It disables the fixups that are
26789 normally applied to locally-submitted messages. Specifically:
26790
26791 .ilist
26792 Any &'Sender:'& header line is left alone (in this respect, it is a
26793 dynamic version of &%local_sender_retain%&).
26794 .next
26795 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26796 .next
26797 There is no check that &'From:'& corresponds to the actual sender.
26798 .endlist ilist
26799
26800 This control may be useful when a remotely-originated message is accepted,
26801 passed to some scanning program, and then re-submitted for delivery. It can be
26802 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26803 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26804 data is read.
26805
26806 &*Note:*& This control applies only to the current message, not to any others
26807 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26808 .endlist vlist
26809
26810
26811 .section "Summary of message fixup control" "SECTsummesfix"
26812 All four possibilities for message fixups can be specified:
26813
26814 .ilist
26815 Locally submitted, fixups applied: the default.
26816 .next
26817 Locally submitted, no fixups applied: use
26818 &`control = suppress_local_fixups`&.
26819 .next
26820 Remotely submitted, no fixups applied: the default.
26821 .next
26822 Remotely submitted, fixups applied: use &`control = submission`&.
26823 .endlist
26824
26825
26826
26827 .section "Adding header lines in ACLs" "SECTaddheadacl"
26828 .cindex "header lines" "adding in an ACL"
26829 .cindex "header lines" "position of added lines"
26830 .cindex "&%message%& ACL modifier"
26831 The &%add_header%& modifier can be used to add one or more extra header lines
26832 to an incoming message, as in this example:
26833 .code
26834 warn dnslists = sbl.spamhaus.org : \
26835                 dialup.mail-abuse.org
26836      add_header = X-blacklisted-at: $dnslist_domain
26837 .endd
26838 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26839 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26840 receiving a message). The message must ultimately be accepted for
26841 &%add_header%& to have any significant effect. You can use &%add_header%& with
26842 any ACL verb, including &%deny%& (though this is potentially useful only in a
26843 RCPT ACL).
26844
26845 If the data for the &%add_header%& modifier contains one or more newlines that
26846 are not followed by a space or a tab, it is assumed to contain multiple header
26847 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26848 front of any line that is not a valid header line.
26849
26850 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26851 They are added to the message before processing the DATA and MIME ACLs.
26852 However, if an identical header line is requested more than once, only one copy
26853 is actually added to the message. Further header lines may be accumulated
26854 during the DATA and MIME ACLs, after which they are added to the message, again
26855 with duplicates suppressed. Thus, it is possible to add two identical header
26856 lines to an SMTP message, but only if one is added before DATA and one after.
26857 In the case of non-SMTP messages, new headers are accumulated during the
26858 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26859 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26860 are included in the entry that is written to the reject log.
26861
26862 .cindex "header lines" "added; visibility of"
26863 Header lines are not visible in string expansions until they are added to the
26864 message. It follows that header lines defined in the MAIL, RCPT, and predata
26865 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26866 header lines that are added by the DATA or MIME ACLs are not visible in those
26867 ACLs. Because of this restriction, you cannot use header lines as a way of
26868 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26869 this, you can use ACL variables, as described in section
26870 &<<SECTaclvariables>>&.
26871
26872 The &%add_header%& modifier acts immediately it is encountered during the
26873 processing of an ACL. Notice the difference between these two cases:
26874 .display
26875 &`accept add_header = ADDED: some text`&
26876 &`       `&<&'some condition'&>
26877
26878 &`accept `&<&'some condition'&>
26879 &`       add_header = ADDED: some text`&
26880 .endd
26881 In the first case, the header line is always added, whether or not the
26882 condition is true. In the second case, the header line is added only if the
26883 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26884 ACL statement. All those that are encountered before a condition fails are
26885 honoured.
26886
26887 .cindex "&%warn%& ACL verb"
26888 For compatibility with previous versions of Exim, a &%message%& modifier for a
26889 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26890 effect only if all the conditions are true, even if it appears before some of
26891 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26892 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26893 are present on a &%warn%& verb, both are processed according to their
26894 specifications.
26895
26896 By default, new header lines are added to a message at the end of the existing
26897 header lines. However, you can specify that any particular header line should
26898 be added right at the start (before all the &'Received:'& lines), immediately
26899 after the first block of &'Received:'& lines, or immediately before any line
26900 that is not a &'Received:'& or &'Resent-something:'& header.
26901
26902 This is done by specifying &":at_start:"&, &":after_received:"&, or
26903 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26904 header line, respectively. (Header text cannot start with a colon, as there has
26905 to be a header name first.) For example:
26906 .code
26907 warn add_header = \
26908        :after_received:X-My-Header: something or other...
26909 .endd
26910 If more than one header line is supplied in a single &%add_header%& modifier,
26911 each one is treated independently and can therefore be placed differently. If
26912 you add more than one line at the start, or after the Received: block, they end
26913 up in reverse order.
26914
26915 &*Warning*&: This facility currently applies only to header lines that are
26916 added in an ACL. It does NOT work for header lines that are added in a
26917 system filter or in a router or transport.
26918
26919
26920
26921
26922 .section "ACL conditions" "SECTaclconditions"
26923 .cindex "&ACL;" "conditions; list of"
26924 Some of conditions listed in this section are available only when Exim is
26925 compiled with the content-scanning extension. They are included here briefly
26926 for completeness. More detailed descriptions can be found in the discussion on
26927 content scanning in chapter &<<CHAPexiscan>>&.
26928
26929 Not all conditions are relevant in all circumstances. For example, testing
26930 senders and recipients does not make sense in an ACL that is being run as the
26931 result of the arrival of an ETRN command, and checks on message headers can be
26932 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26933 can use the same condition (with different parameters) more than once in the
26934 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26935 The conditions are as follows:
26936
26937
26938 .vlist
26939 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26940 .cindex "&ACL;" "nested"
26941 .cindex "&ACL;" "indirect"
26942 .cindex "&%acl%& ACL condition"
26943 The possible values of the argument are the same as for the
26944 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26945 &"accept"& the condition is true; if it returns &"deny"& the condition is
26946 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26947 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26948 condition false. This means that further processing of the &%warn%& verb
26949 ceases, but processing of the ACL continues.
26950
26951 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26952 the connection is dropped. If it returns &"discard"&, the verb must be
26953 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26954 conditions are tested.
26955
26956 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26957 loops. This condition allows you to use different ACLs in different
26958 circumstances. For example, different ACLs can be used to handle RCPT commands
26959 for different local users or different local domains.
26960
26961 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26962 .cindex "&%authenticated%& ACL condition"
26963 .cindex "authentication" "ACL checking"
26964 .cindex "&ACL;" "testing for authentication"
26965 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26966 the name of the authenticator is tested against the list. To test for
26967 authentication by any authenticator, you can set
26968 .code
26969 authenticated = *
26970 .endd
26971
26972 .vitem &*condition&~=&~*&<&'string'&>
26973 .cindex "&%condition%& ACL condition"
26974 .cindex "customizing" "ACL condition"
26975 .cindex "&ACL;" "customized test"
26976 .cindex "&ACL;" "testing, customized"
26977 This feature allows you to make up custom conditions. If the result of
26978 expanding the string is an empty string, the number zero, or one of the strings
26979 &"no"& or &"false"&, the condition is false. If the result is any non-zero
26980 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
26981 any other value, some error is assumed to have occurred, and the ACL returns
26982 &"defer"&. However, if the expansion is forced to fail, the condition is
26983 ignored. The effect is to treat it as true, whether it is positive or
26984 negative.
26985
26986 .vitem &*decode&~=&~*&<&'location'&>
26987 .cindex "&%decode%& ACL condition"
26988 This condition is available only when Exim is compiled with the
26989 content-scanning extension, and it is allowed only in the ACL defined by
26990 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
26991 If all goes well, the condition is true. It is false only if there are
26992 problems such as a syntax error or a memory shortage. For more details, see
26993 chapter &<<CHAPexiscan>>&.
26994
26995 .vitem &*demime&~=&~*&<&'extension&~list'&>
26996 .cindex "&%demime%& ACL condition"
26997 This condition is available only when Exim is compiled with the
26998 content-scanning extension. Its use is described in section
26999 &<<SECTdemimecond>>&.
27000
27001 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27002 .cindex "&%dnslists%& ACL condition"
27003 .cindex "DNS list" "in ACL"
27004 .cindex "black list (DNS)"
27005 .cindex "&ACL;" "testing a DNS list"
27006 This condition checks for entries in DNS black lists. These are also known as
27007 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27008 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27009 different variants of this condition to describe briefly here. See sections
27010 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27011
27012 .vitem &*domains&~=&~*&<&'domain&~list'&>
27013 .cindex "&%domains%& ACL condition"
27014 .cindex "domain" "ACL checking"
27015 .cindex "&ACL;" "testing a recipient domain"
27016 .vindex "&$domain_data$&"
27017 This condition is relevant only after a RCPT command. It checks that the domain
27018 of the recipient address is in the domain list. If percent-hack processing is
27019 enabled, it is done before this test is done. If the check succeeds with a
27020 lookup, the result of the lookup is placed in &$domain_data$& until the next
27021 &%domains%& test.
27022
27023 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27024 use &%domains%& in a DATA ACL.
27025
27026
27027 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27028 .cindex "&%encrypted%& ACL condition"
27029 .cindex "encryption" "checking in an ACL"
27030 .cindex "&ACL;" "testing for encryption"
27031 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27032 name of the cipher suite in use is tested against the list. To test for
27033 encryption without testing for any specific cipher suite(s), set
27034 .code
27035 encrypted = *
27036 .endd
27037
27038
27039 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
27040 .cindex "&%hosts%& ACL condition"
27041 .cindex "host" "ACL checking"
27042 .cindex "&ACL;" "testing the client host"
27043 This condition tests that the calling host matches the host list. If you have
27044 name lookups or wildcarded host names and IP addresses in the same host list,
27045 you should normally put the IP addresses first. For example, you could have:
27046 .code
27047 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27048 .endd
27049 The lookup in this example uses the host name for its key. This is implied by
27050 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27051 and it wouldn't matter which way round you had these two items.)
27052
27053 The reason for the problem with host names lies in the left-to-right way that
27054 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27055 but when it reaches an item that requires a host name, it fails if it cannot
27056 find a host name to compare with the pattern. If the above list is given in the
27057 opposite order, the &%accept%& statement fails for a host whose name cannot be
27058 found, even if its IP address is 10.9.8.7.
27059
27060 If you really do want to do the name check first, and still recognize the IP
27061 address even if the name lookup fails, you can rewrite the ACL like this:
27062 .code
27063 accept hosts = dbm;/etc/friendly/hosts
27064 accept hosts = 10.9.8.7
27065 .endd
27066 The default action on failing to find the host name is to assume that the host
27067 is not in the list, so the first &%accept%& statement fails. The second
27068 statement can then check the IP address.
27069
27070 .vindex "&$host_data$&"
27071 If a &%hosts%& condition is satisfied by means of a lookup, the result
27072 of the lookup is made available in the &$host_data$& variable. This
27073 allows you, for example, to set up a statement like this:
27074 .code
27075 deny  hosts = net-lsearch;/some/file
27076 message = $host_data
27077 .endd
27078 which gives a custom error message for each denied host.
27079
27080 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27081 .cindex "&%local_parts%& ACL condition"
27082 .cindex "local part" "ACL checking"
27083 .cindex "&ACL;" "testing a local part"
27084 .vindex "&$local_part_data$&"
27085 This condition is relevant only after a RCPT command. It checks that the local
27086 part of the recipient address is in the list. If percent-hack processing is
27087 enabled, it is done before this test. If the check succeeds with a lookup, the
27088 result of the lookup is placed in &$local_part_data$&, which remains set until
27089 the next &%local_parts%& test.
27090
27091 .vitem &*malware&~=&~*&<&'option'&>
27092 .cindex "&%malware%& ACL condition"
27093 .cindex "&ACL;" "virus scanning"
27094 .cindex "&ACL;" "scanning for viruses"
27095 This condition is available only when Exim is compiled with the
27096 content-scanning extension. It causes the incoming message to be scanned for
27097 viruses. For details, see chapter &<<CHAPexiscan>>&.
27098
27099 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27100 .cindex "&%mime_regex%& ACL condition"
27101 .cindex "&ACL;" "testing by regex matching"
27102 This condition is available only when Exim is compiled with the
27103 content-scanning extension, and it is allowed only in the ACL defined by
27104 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27105 with any of the regular expressions. For details, see chapter
27106 &<<CHAPexiscan>>&.
27107
27108 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27109 .cindex "rate limiting"
27110 This condition can be used to limit the rate at which a user or host submits
27111 messages. Details are given in section &<<SECTratelimiting>>&.
27112
27113 .vitem &*recipients&~=&~*&<&'address&~list'&>
27114 .cindex "&%recipients%& ACL condition"
27115 .cindex "recipient" "ACL checking"
27116 .cindex "&ACL;" "testing a recipient"
27117 This condition is relevant only after a RCPT command. It checks the entire
27118 recipient address against a list of recipients.
27119
27120 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27121 .cindex "&%regex%& ACL condition"
27122 .cindex "&ACL;" "testing by regex matching"
27123 This condition is available only when Exim is compiled with the
27124 content-scanning extension, and is available only in the DATA, MIME, and
27125 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27126 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27127
27128 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27129 .cindex "&%sender_domains%& ACL condition"
27130 .cindex "sender" "ACL checking"
27131 .cindex "&ACL;" "testing a sender domain"
27132 .vindex "&$domain$&"
27133 .vindex "&$sender_address_domain$&"
27134 This condition tests the domain of the sender of the message against the given
27135 domain list. &*Note*&: The domain of the sender address is in
27136 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27137 of this condition. This is an exception to the general rule for testing domain
27138 lists. It is done this way so that, if this condition is used in an ACL for a
27139 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27140 influence the sender checking.
27141
27142 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27143 relaying, because sender addresses are easily, and commonly, forged.
27144
27145 .vitem &*senders&~=&~*&<&'address&~list'&>
27146 .cindex "&%senders%& ACL condition"
27147 .cindex "sender" "ACL checking"
27148 .cindex "&ACL;" "testing a sender"
27149 This condition tests the sender of the message against the given list. To test
27150 for a bounce message, which has an empty sender, set
27151 .code
27152 senders = :
27153 .endd
27154 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27155 relaying, because sender addresses are easily, and commonly, forged.
27156
27157 .vitem &*spam&~=&~*&<&'username'&>
27158 .cindex "&%spam%& ACL condition"
27159 .cindex "&ACL;" "scanning for spam"
27160 This condition is available only when Exim is compiled with the
27161 content-scanning extension. It causes the incoming message to be scanned by
27162 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27163
27164 .vitem &*verify&~=&~certificate*&
27165 .cindex "&%verify%& ACL condition"
27166 .cindex "TLS" "client certificate verification"
27167 .cindex "certificate" "verification of client"
27168 .cindex "&ACL;" "certificate verification"
27169 .cindex "&ACL;" "testing a TLS certificate"
27170 This condition is true in an SMTP session if the session is encrypted, and a
27171 certificate was received from the client, and the certificate was verified. The
27172 server requests a certificate only if the client matches &%tls_verify_hosts%&
27173 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27174
27175 .vitem &*verify&~=&~csa*&
27176 .cindex "CSA verification"
27177 This condition checks whether the sending host (the client) is authorized to
27178 send email. Details of how this works are given in section
27179 &<<SECTverifyCSA>>&.
27180
27181 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27182 .cindex "&%verify%& ACL condition"
27183 .cindex "&ACL;" "verifying sender in the header"
27184 .cindex "header lines" "verifying the sender in"
27185 .cindex "sender" "verifying in header"
27186 .cindex "verifying" "sender in header"
27187 This condition is relevant only in an ACL that is run after a message has been
27188 received, that is, in an ACL specified by &%acl_smtp_data%& or
27189 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27190 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27191 is loosely thought of as a &"sender"& address (hence the name of the test).
27192 However, an address that appears in one of these headers need not be an address
27193 that accepts bounce messages; only sender addresses in envelopes are required
27194 to accept bounces. Therefore, if you use the callout option on this check, you
27195 might want to arrange for a non-empty address in the MAIL command.
27196
27197 Details of address verification and the options are given later, starting at
27198 section &<<SECTaddressverification>>& (callouts are described in section
27199 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27200 condition to restrict it to bounce messages only:
27201 .code
27202 deny    senders = :
27203         message = A valid sender header is required for bounces
27204        !verify  = header_sender
27205 .endd
27206
27207 .vitem &*verify&~=&~header_syntax*&
27208 .cindex "&%verify%& ACL condition"
27209 .cindex "&ACL;" "verifying header syntax"
27210 .cindex "header lines" "verifying syntax"
27211 .cindex "verifying" "header syntax"
27212 This condition is relevant only in an ACL that is run after a message has been
27213 received, that is, in an ACL specified by &%acl_smtp_data%& or
27214 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27215 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27216 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27217 permitted only in locally generated messages and from hosts that match
27218 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27219 appropriate.
27220
27221 Note that this condition is a syntax check only. However, a common spamming
27222 ploy used to be to send syntactically invalid headers such as
27223 .code
27224 To: @
27225 .endd
27226 and this condition can be used to reject such messages, though they are not as
27227 common as they used to be.
27228
27229 .vitem &*verify&~=&~helo*&
27230 .cindex "&%verify%& ACL condition"
27231 .cindex "&ACL;" "verifying HELO/EHLO"
27232 .cindex "HELO" "verifying"
27233 .cindex "EHLO" "verifying"
27234 .cindex "verifying" "EHLO"
27235 .cindex "verifying" "HELO"
27236 This condition is true if a HELO or EHLO command has been received from the
27237 client host, and its contents have been verified. If there has been no previous
27238 attempt to verify the HELO/EHLO contents, it is carried out when this
27239 condition is encountered. See the description of the &%helo_verify_hosts%& and
27240 &%helo_try_verify_hosts%& options for details of how to request verification
27241 independently of this condition.
27242
27243 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27244 option), this condition is always true.
27245
27246
27247 .vitem &*verify&~=&~not_blind*&
27248 .cindex "verifying" "not blind"
27249 .cindex "bcc recipients, verifying none"
27250 This condition checks that there are no blind (bcc) recipients in the message.
27251 Every envelope recipient must appear either in a &'To:'& header line or in a
27252 &'Cc:'& header line for this condition to be true. Local parts are checked
27253 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27254 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27255 used only in a DATA or non-SMTP ACL.
27256
27257 There are, of course, many legitimate messages that make use of blind (bcc)
27258 recipients. This check should not be used on its own for blocking messages.
27259
27260
27261 .vitem &*verify&~=&~recipient/*&<&'options'&>
27262 .cindex "&%verify%& ACL condition"
27263 .cindex "&ACL;" "verifying recipient"
27264 .cindex "recipient" "verifying"
27265 .cindex "verifying" "recipient"
27266 .vindex "&$address_data$&"
27267 This condition is relevant only after a RCPT command. It verifies the current
27268 recipient. Details of address verification are given later, starting at section
27269 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27270 of &$address_data$& is the last value that was set while routing the address.
27271 This applies even if the verification fails. When an address that is being
27272 verified is redirected to a single address, verification continues with the new
27273 address, and in that case, the subsequent value of &$address_data$& is the
27274 value for the child address.
27275
27276 .vitem &*verify&~=&~reverse_host_lookup*&
27277 .cindex "&%verify%& ACL condition"
27278 .cindex "&ACL;" "verifying host reverse lookup"
27279 .cindex "host" "verifying reverse lookup"
27280 This condition ensures that a verified host name has been looked up from the IP
27281 address of the client host. (This may have happened already if the host name
27282 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27283 Verification ensures that the host name obtained from a reverse DNS lookup, or
27284 one of its aliases, does, when it is itself looked up in the DNS, yield the
27285 original IP address.
27286
27287 If this condition is used for a locally generated message (that is, when there
27288 is no client host involved), it always succeeds.
27289
27290 .vitem &*verify&~=&~sender/*&<&'options'&>
27291 .cindex "&%verify%& ACL condition"
27292 .cindex "&ACL;" "verifying sender"
27293 .cindex "sender" "verifying"
27294 .cindex "verifying" "sender"
27295 This condition is relevant only after a MAIL or RCPT command, or after a
27296 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27297 the message's sender is empty (that is, this is a bounce message), the
27298 condition is true. Otherwise, the sender address is verified.
27299
27300 .vindex "&$address_data$&"
27301 .vindex "&$sender_address_data$&"
27302 If there is data in the &$address_data$& variable at the end of routing, its
27303 value is placed in &$sender_address_data$& at the end of verification. This
27304 value can be used in subsequent conditions and modifiers in the same ACL
27305 statement. It does not persist after the end of the current statement. If you
27306 want to preserve the value for longer, you can save it in an ACL variable.
27307
27308 Details of verification are given later, starting at section
27309 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
27310 to avoid doing it more than once per message.
27311
27312 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
27313 .cindex "&%verify%& ACL condition"
27314 This is a variation of the previous option, in which a modified address is
27315 verified as a sender.
27316 .endlist
27317
27318
27319
27320 .section "Using DNS lists" "SECTmorednslists"
27321 .cindex "DNS list" "in ACL"
27322 .cindex "black list (DNS)"
27323 .cindex "&ACL;" "testing a DNS list"
27324 In its simplest form, the &%dnslists%& condition tests whether the calling host
27325 is on at least one of a number of DNS lists by looking up the inverted IP
27326 address in one or more DNS domains. (Note that DNS list domains are not mail
27327 domains, so the &`+`& syntax for named lists doesn't work - it is used for
27328 special options instead.) For example, if the calling host's IP
27329 address is 192.168.62.43, and the ACL statement is
27330 .code
27331 deny dnslists = blackholes.mail-abuse.org : \
27332                 dialups.mail-abuse.org
27333 .endd
27334 the following records are looked up:
27335 .code
27336 43.62.168.192.blackholes.mail-abuse.org
27337 43.62.168.192.dialups.mail-abuse.org
27338 .endd
27339 As soon as Exim finds an existing DNS record, processing of the list stops.
27340 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
27341 to test that a host is on more than one list (an &"and"& conjunction), you can
27342 use two separate conditions:
27343 .code
27344 deny dnslists = blackholes.mail-abuse.org
27345      dnslists = dialups.mail-abuse.org
27346 .endd
27347 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
27348 behaves as if the host does not match the list item, that is, as if the DNS
27349 record does not exist. If there are further items in the DNS list, they are
27350 processed.
27351
27352 This is usually the required action when &%dnslists%& is used with &%deny%&
27353 (which is the most common usage), because it prevents a DNS failure from
27354 blocking mail. However, you can change this behaviour by putting one of the
27355 following special items in the list:
27356 .display
27357 &`+include_unknown `&   behave as if the item is on the list
27358 &`+exclude_unknown `&   behave as if the item is not on the list (default)
27359 &`+defer_unknown   `&   give a temporary error
27360 .endd
27361 .cindex "&`+include_unknown`&"
27362 .cindex "&`+exclude_unknown`&"
27363 .cindex "&`+defer_unknown`&"
27364 Each of these applies to any subsequent items on the list. For example:
27365 .code
27366 deny dnslists = +defer_unknown : foo.bar.example
27367 .endd
27368 Testing the list of domains stops as soon as a match is found. If you want to
27369 warn for one list and block for another, you can use two different statements:
27370 .code
27371 deny  dnslists = blackholes.mail-abuse.org
27372 warn  message  = X-Warn: sending host is on dialups list
27373       dnslists = dialups.mail-abuse.org
27374 .endd
27375 DNS list lookups are cached by Exim for the duration of the SMTP session,
27376 so a lookup based on the IP address is done at most once for any incoming
27377 connection. Exim does not share information between multiple incoming
27378 connections (but your local name server cache should be active).
27379
27380
27381
27382 .section "Specifying the IP address for a DNS list lookup" "SECID201"
27383 .cindex "DNS list" "keyed by explicit IP address"
27384 By default, the IP address that is used in a DNS list lookup is the IP address
27385 of the calling host. However, you can specify another IP address by listing it
27386 after the domain name, introduced by a slash. For example:
27387 .code
27388 deny dnslists = black.list.tld/192.168.1.2
27389 .endd
27390 This feature is not very helpful with explicit IP addresses; it is intended for
27391 use with IP addresses that are looked up, for example, the IP addresses of the
27392 MX hosts or nameservers of an email sender address. For an example, see section
27393 &<<SECTmulkeyfor>>& below.
27394
27395
27396
27397
27398 .section "DNS lists keyed on domain names" "SECID202"
27399 .cindex "DNS list" "keyed by domain name"
27400 There are some lists that are keyed on domain names rather than inverted IP
27401 addresses (see for example the &'domain based zones'& link at
27402 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
27403 with these lists. You can change the name that is looked up in a DNS list by
27404 listing it after the domain name, introduced by a slash. For example,
27405 .code
27406 deny  message  = Sender's domain is listed at $dnslist_domain
27407       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
27408 .endd
27409 This particular example is useful only in ACLs that are obeyed after the
27410 RCPT or DATA commands, when a sender address is available. If (for
27411 example) the message's sender is &'user@tld.example'& the name that is looked
27412 up by this example is
27413 .code
27414 tld.example.dsn.rfc-ignorant.org
27415 .endd
27416 A single &%dnslists%& condition can contain entries for both names and IP
27417 addresses. For example:
27418 .code
27419 deny dnslists = sbl.spamhaus.org : \
27420                 dsn.rfc-ignorant.org/$sender_address_domain
27421 .endd
27422 The first item checks the sending host's IP address; the second checks a domain
27423 name. The whole condition is true if either of the DNS lookups succeeds.
27424
27425
27426
27427
27428 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
27429 .cindex "DNS list" "multiple keys for"
27430 The syntax described above for looking up explicitly-defined values (either
27431 names or IP addresses) in a DNS blacklist is a simplification. After the domain
27432 name for the DNS list, what follows the slash can in fact be a list of items.
27433 As with all lists in Exim, the default separator is a colon. However, because
27434 this is a sublist within the list of DNS blacklist domains, it is necessary
27435 either to double the separators like this:
27436 .code
27437 dnslists = black.list.tld/name.1::name.2
27438 .endd
27439 or to change the separator character, like this:
27440 .code
27441 dnslists = black.list.tld/<;name.1;name.2
27442 .endd
27443 If an item in the list is an IP address, it is inverted before the DNS
27444 blacklist domain is appended. If it is not an IP address, no inversion
27445 occurs. Consider this condition:
27446 .code
27447 dnslists = black.list.tld/<;192.168.1.2;a.domain
27448 .endd
27449 The DNS lookups that occur are:
27450 .code
27451 2.1.168.192.black.list.tld
27452 a.domain.black.list.tld
27453 .endd
27454 Once a DNS record has been found (that matches a specific IP return
27455 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
27456 are done. If there is a temporary DNS error, the rest of the sublist of domains
27457 or IP addresses is tried. A temporary error for the whole dnslists item occurs
27458 only if no other DNS lookup in this sublist succeeds. In other words, a
27459 successful lookup for any of the items in the sublist overrides a temporary
27460 error for a previous item.
27461
27462 The ability to supply a list of items after the slash is in some sense just a
27463 syntactic convenience. These two examples have the same effect:
27464 .code
27465 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
27466 dnslists = black.list.tld/a.domain::b.domain
27467 .endd
27468 However, when the data for the list is obtained from a lookup, the second form
27469 is usually much more convenient. Consider this example:
27470 .code
27471 deny message  = The mail servers for the domain \
27472                 $sender_address_domain \
27473                 are listed at $dnslist_domain ($dnslist_value); \
27474                 see $dnslist_text.
27475      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
27476                                    ${lookup dnsdb {>|mxh=\
27477                                    $sender_address_domain} }} }
27478 .endd
27479 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
27480 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
27481 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
27482 of expanding the condition might be something like this:
27483 .code
27484 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
27485 .endd
27486 Thus, this example checks whether or not the IP addresses of the sender
27487 domain's mail servers are on the Spamhaus black list.
27488
27489 The key that was used for a successful DNS list lookup is put into the variable
27490 &$dnslist_matched$& (see section &<<SECID204>>&).
27491
27492
27493
27494
27495 .section "Data returned by DNS lists" "SECID203"
27496 .cindex "DNS list" "data returned from"
27497 DNS lists are constructed using address records in the DNS. The original RBL
27498 just used the address 127.0.0.1 on the right hand side of each record, but the
27499 RBL+ list and some other lists use a number of values with different meanings.
27500 The values used on the RBL+ list are:
27501 .display
27502 127.1.0.1  RBL
27503 127.1.0.2  DUL
27504 127.1.0.3  DUL and RBL
27505 127.1.0.4  RSS
27506 127.1.0.5  RSS and RBL
27507 127.1.0.6  RSS and DUL
27508 127.1.0.7  RSS and DUL and RBL
27509 .endd
27510 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
27511 different values. Some DNS lists may return more than one address record;
27512 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
27513
27514
27515 .section "Variables set from DNS lists" "SECID204"
27516 .cindex "expansion" "variables, set from DNS list"
27517 .cindex "DNS list" "variables set from"
27518 .vindex "&$dnslist_domain$&"
27519 .vindex "&$dnslist_matched$&"
27520 .vindex "&$dnslist_text$&"
27521 .vindex "&$dnslist_value$&"
27522 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
27523 the name of the overall domain that matched (for example,
27524 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
27525 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
27526 the DNS record. When the key is an IP address, it is not reversed in
27527 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
27528 cases, for example:
27529 .code
27530 deny dnslists = spamhaus.example
27531 .endd
27532 the key is also available in another variable (in this case,
27533 &$sender_host_address$&). In more complicated cases, however, this is not true.
27534 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
27535 might generate a dnslists lookup like this:
27536 .code
27537 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
27538 .endd
27539 If this condition succeeds, the value in &$dnslist_matched$& might be
27540 &`192.168.6.7`& (for example).
27541
27542 If more than one address record is returned by the DNS lookup, all the IP
27543 addresses are included in &$dnslist_value$&, separated by commas and spaces.
27544 The variable &$dnslist_text$& contains the contents of any associated TXT
27545 record. For lists such as RBL+ the TXT record for a merged entry is often not
27546 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
27547 information.
27548
27549 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
27550 &-- although these appear before the condition in the ACL, they are not
27551 expanded until after it has failed. For example:
27552 .code
27553 deny    hosts = !+local_networks
27554         message = $sender_host_address is listed \
27555                   at $dnslist_domain
27556         dnslists = rbl-plus.mail-abuse.example
27557 .endd
27558
27559
27560
27561 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
27562 .cindex "DNS list" "matching specific returned data"
27563 You can add an equals sign and an IP address after a &%dnslists%& domain name
27564 in order to restrict its action to DNS records with a matching right hand side.
27565 For example,
27566 .code
27567 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
27568 .endd
27569 rejects only those hosts that yield 127.0.0.2. Without this additional data,
27570 any address record is considered to be a match. For the moment, we assume
27571 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
27572 describes how multiple records are handled.
27573
27574 More than one IP address may be given for checking, using a comma as a
27575 separator. These are alternatives &-- if any one of them matches, the
27576 &%dnslists%& condition is true. For example:
27577 .code
27578 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27579 .endd
27580 If you want to specify a constraining address list and also specify names or IP
27581 addresses to be looked up, the constraining address list must be specified
27582 first. For example:
27583 .code
27584 deny dnslists = dsn.rfc-ignorant.org\
27585                 =127.0.0.2/$sender_address_domain
27586 .endd
27587
27588 If the character &`&&`& is used instead of &`=`&, the comparison for each
27589 listed IP address is done by a bitwise &"and"& instead of by an equality test.
27590 In other words, the listed addresses are used as bit masks. The comparison is
27591 true if all the bits in the mask are present in the address that is being
27592 tested. For example:
27593 .code
27594 dnslists = a.b.c&0.0.0.3
27595 .endd
27596 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
27597 want to test whether one bit or another bit is present (as opposed to both
27598 being present), you must use multiple values. For example:
27599 .code
27600 dnslists = a.b.c&0.0.0.1,0.0.0.2
27601 .endd
27602 matches if the final component of the address is an odd number or two times
27603 an odd number.
27604
27605
27606
27607 .section "Negated DNS matching conditions" "SECID205"
27608 You can supply a negative list of IP addresses as part of a &%dnslists%&
27609 condition. Whereas
27610 .code
27611 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27612 .endd
27613 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27614 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
27615 .code
27616 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
27617 .endd
27618 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27619 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
27620 words, the result of the test is inverted if an exclamation mark appears before
27621 the &`=`& (or the &`&&`&) sign.
27622
27623 &*Note*&: This kind of negation is not the same as negation in a domain,
27624 host, or address list (which is why the syntax is different).
27625
27626 If you are using just one list, the negation syntax does not gain you much. The
27627 previous example is precisely equivalent to
27628 .code
27629 deny  dnslists = a.b.c
27630      !dnslists = a.b.c=127.0.0.2,127.0.0.3
27631 .endd
27632 However, if you are using multiple lists, the negation syntax is clearer.
27633 Consider this example:
27634 .code
27635 deny  dnslists = sbl.spamhaus.org : \
27636                  list.dsbl.org : \
27637                  dnsbl.njabl.org!=127.0.0.3 : \
27638                  relays.ordb.org
27639 .endd
27640 Using only positive lists, this would have to be:
27641 .code
27642 deny  dnslists = sbl.spamhaus.org : \
27643                  list.dsbl.org
27644 deny  dnslists = dnsbl.njabl.org
27645      !dnslists = dnsbl.njabl.org=127.0.0.3
27646 deny  dnslists = relays.ordb.org
27647 .endd
27648 which is less clear, and harder to maintain.
27649
27650
27651
27652
27653 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
27654 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
27655 thereby providing more than one IP address. When an item in a &%dnslists%& list
27656 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
27657 the match to specific results from the DNS lookup, there are two ways in which
27658 the checking can be handled. For example, consider the condition:
27659 .code
27660 dnslists = a.b.c=127.0.0.1
27661 .endd
27662 What happens if the DNS lookup for the incoming IP address yields both
27663 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
27664 condition true because at least one given value was found, or is it false
27665 because at least one of the found values was not listed? And how does this
27666 affect negated conditions? Both possibilities are provided for with the help of
27667 additional separators &`==`& and &`=&&`&.
27668
27669 .ilist
27670 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
27671 IP addresses matches one of the listed addresses. For the example above, the
27672 condition is true because 127.0.0.1 matches.
27673 .next
27674 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
27675 looked up IP addresses matches one of the listed addresses. If the condition is
27676 changed to:
27677 .code
27678 dnslists = a.b.c==127.0.0.1
27679 .endd
27680 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27681 false because 127.0.0.2 is not listed. You would need to have:
27682 .code
27683 dnslists = a.b.c==127.0.0.1,127.0.0.2
27684 .endd
27685 for the condition to be true.
27686 .endlist
27687
27688 When &`!`& is used to negate IP address matching, it inverts the result, giving
27689 the precise opposite of the behaviour above. Thus:
27690 .ilist
27691 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
27692 addresses matches one of the listed addresses. Consider:
27693 .code
27694 dnslists = a.b.c!&0.0.0.1
27695 .endd
27696 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27697 false because 127.0.0.1 matches.
27698 .next
27699 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
27700 looked up IP address that does not match. Consider:
27701 .code
27702 dnslists = a.b.c!=&0.0.0.1
27703 .endd
27704 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27705 true, because 127.0.0.2 does not match. You would need to have:
27706 .code
27707 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
27708 .endd
27709 for the condition to be false.
27710 .endlist
27711 When the DNS lookup yields only a single IP address, there is no difference
27712 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
27713
27714
27715
27716
27717 .section "Detailed information from merged DNS lists" "SECTmordetinf"
27718 .cindex "DNS list" "information from merged"
27719 When the facility for restricting the matching IP values in a DNS list is used,
27720 the text from the TXT record that is set in &$dnslist_text$& may not reflect
27721 the true reason for rejection. This happens when lists are merged and the IP
27722 address in the A record is used to distinguish them; unfortunately there is
27723 only one TXT record. One way round this is not to use merged lists, but that
27724 can be inefficient because it requires multiple DNS lookups where one would do
27725 in the vast majority of cases when the host of interest is not on any of the
27726 lists.
27727
27728 A less inefficient way of solving this problem is available. If
27729 two domain names, comma-separated, are given, the second is used first to
27730 do an initial check, making use of any IP value restrictions that are set.
27731 If there is a match, the first domain is used, without any IP value
27732 restrictions, to get the TXT record. As a byproduct of this, there is also
27733 a check that the IP being tested is indeed on the first list. The first
27734 domain is the one that is put in &$dnslist_domain$&. For example:
27735 .code
27736 reject message  = \
27737          rejected because $sender_host_address is blacklisted \
27738          at $dnslist_domain\n$dnslist_text
27739        dnslists = \
27740          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
27741          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27742 .endd
27743 For the first blacklist item, this starts by doing a lookup in
27744 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
27745 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
27746 value, and as long as something is found, it looks for the corresponding TXT
27747 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
27748 The second blacklist item is processed similarly.
27749
27750 If you are interested in more than one merged list, the same list must be
27751 given several times, but because the results of the DNS lookups are cached,
27752 the DNS calls themselves are not repeated. For example:
27753 .code
27754 reject dnslists = \
27755          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27756          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27757          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27758          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27759 .endd
27760 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27761 values matches (or if no record is found), this is the only lookup that is
27762 done. Only if there is a match is one of the more specific lists consulted.
27763
27764
27765
27766 .section "DNS lists and IPv6" "SECTmorednslistslast"
27767 .cindex "IPv6" "DNS black lists"
27768 .cindex "DNS list" "IPv6 usage"
27769 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27770 nibble by nibble. For example, if the calling host's IP address is
27771 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27772 .code
27773 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27774   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27775 .endd
27776 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27777 lists contain wildcard records, intended for IPv4, that interact badly with
27778 IPv6. For example, the DNS entry
27779 .code
27780 *.3.some.list.example.    A    127.0.0.1
27781 .endd
27782 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27783 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27784
27785 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27786 &%condition%& condition, as in this example:
27787 .code
27788 deny   condition = ${if isip4{$sender_host_address}}
27789        dnslists  = some.list.example
27790 .endd
27791
27792 .section "Rate limiting incoming messages" "SECTratelimiting"
27793 .cindex "rate limiting" "client sending"
27794 .cindex "limiting client sending rates"
27795 .oindex "&%smtp_ratelimit_*%&"
27796 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27797 which clients can send email. This is more powerful than the
27798 &%smtp_ratelimit_*%& options, because those options control the rate of
27799 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27800 works across all connections (concurrent and sequential) from the same client
27801 host. The syntax of the &%ratelimit%& condition is:
27802 .display
27803 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27804 .endd
27805 If the average client sending rate is less than &'m'& messages per time
27806 period &'p'& then the condition is false; otherwise it is true.
27807
27808 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27809 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27810 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27811 of &'p'&.
27812
27813 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27814 time interval, for example, &`8h`& for eight hours. A larger time constant
27815 means that it takes Exim longer to forget a client's past behaviour. The
27816 parameter &'m'& is the maximum number of messages that a client is permitted to
27817 send in each time interval. It also specifies the number of messages permitted
27818 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27819 constant, you can allow a client to send more messages in a burst without
27820 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27821 both small, messages must be sent at an even rate.
27822
27823 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27824 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27825 when deploying the &%ratelimit%& ACL condition. The script prints usage
27826 instructions when it is run with no arguments.
27827
27828 The key is used to look up the data for calculating the client's average
27829 sending rate. This data is stored in Exim's spool directory, alongside the
27830 retry and other hints databases. The default key is &$sender_host_address$&,
27831 which means Exim computes the sending rate of each client host IP address.
27832 By changing the key you can change how Exim identifies clients for the purpose
27833 of ratelimiting. For example, to limit the sending rate of each authenticated
27834 user, independent of the computer they are sending from, set the key to
27835 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27836 example, &$authenticated_id$& is only meaningful if the client has
27837 authenticated (which you can check with the &%authenticated%& ACL condition).
27838
27839 The lookup key does not have to identify clients: If you want to limit the
27840 rate at which a recipient receives messages, you can use the key
27841 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27842 ACL.
27843
27844 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
27845 specifies what Exim measures the rate of, for example messages or recipients
27846 or bytes. You can adjust the measurement using the &%unique=%& and/or
27847 &%count=%& options. You can also control when Exim updates the recorded rate
27848 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
27849 separated by a slash, like the other parameters. They may appear in any order.
27850
27851 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
27852 any options that alter the meaning of the stored data. The limit &'m'& is not
27853 stored, so you can alter the configured maximum rate and Exim will still
27854 remember clients' past behaviour. If you change the &%per_*%& mode or add or
27855 remove the &%unique=%& option, the lookup key changes so Exim will forget past
27856 behaviour. The lookup key is not affected by changes to the update mode and
27857 the &%count=%& option.
27858
27859
27860 .section "Ratelimit options for what is being measured" "ratoptmea"
27861 .cindex "rate limiting" "per_* options"
27862 The &%per_conn%& option limits the client's connection rate. It is not
27863 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
27864 &%acl_not_smtp_start%& ACLs.
27865
27866 The &%per_mail%& option limits the client's rate of sending messages. This is
27867 the default if none of the &%per_*%& options is specified. It can be used in
27868 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
27869 &%acl_smtp_data%&, or &%acl_not_smtp%&.
27870
27871 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
27872 the same ACLs as the &%per_mail%& option, though it is best to use this option
27873 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
27874 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
27875 in its MAIL command, which may be inaccurate or completely missing. You can
27876 follow the limit &'m'& in the configuration with K, M, or G to specify limits
27877 in kilobytes, megabytes, or gigabytes, respectively.
27878
27879 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
27880 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27881 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
27882 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
27883 ACLs the rate is updated with the total recipient count in one go. Note that
27884 in either case the rate limiting engine will see a message with many
27885 recipients as a large high-speed burst.
27886
27887 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
27888 number of different recipients that the client has sent messages to in the
27889 last time period. That is, if the client repeatedly sends messages to the same
27890 recipient, its measured rate is not increased. This option can only be used in
27891 &%acl_smtp_rcpt%&.
27892
27893 The &%per_cmd%& option causes Exim to recompute the rate every time the
27894 condition is processed. This can be used to limit the rate of any SMTP
27895 command. If it is used in multiple ACLs it can limit the aggregate rate of
27896 multiple different commands.
27897
27898 The &%count=%& option can be used to alter how much Exim adds to the client's
27899 measured rate. For example, the &%per_byte%& option is equivalent to
27900 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
27901 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
27902 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
27903
27904 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
27905
27906
27907 .section "Ratelimit update modes" "ratoptupd"
27908 .cindex "rate limiting" "reading data without updating"
27909 You can specify one of three options with the &%ratelimit%& condition to
27910 control when its database is updated. This section describes the &%readonly%&
27911 mode, and the next section describes the &%strict%& and &%leaky%& modes.
27912
27913 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
27914 previously-computed rate to check against the limit.
27915
27916 For example, you can test the client's sending rate and deny it access (when
27917 it is too fast) in the connect ACL. If the client passes this check then it
27918 can go on to send a message, in which case its recorded rate will be updated
27919 in the MAIL ACL. Subsequent connections from the same client will check this
27920 new rate.
27921 .code
27922 acl_check_connect:
27923  deny ratelimit = 100 / 5m / readonly
27924     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
27925                   (max $sender_rate_limit)
27926 # ...
27927 acl_check_mail:
27928  warn ratelimit = 100 / 5m / strict
27929     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
27930                   (max $sender_rate_limit)
27931 .endd
27932
27933 If Exim encounters multiple &%ratelimit%& conditions with the same key when
27934 processing a message then it may increase the client's measured rate more than
27935 it should. For example, this will happen if you check the &%per_rcpt%& option
27936 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
27937 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
27938 multiple update problems by using the &%readonly%& option on later ratelimit
27939 checks.
27940
27941 The &%per_*%& options described above do not make sense in some ACLs. If you
27942 use a &%per_*%& option in an ACL where it is not normally permitted then the
27943 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
27944 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
27945 next section) so you must specify the &%readonly%& option explicitly.
27946
27947
27948 .section "Ratelimit options for handling fast clients" "ratoptfast"
27949 .cindex "rate limiting" "strict and leaky modes"
27950 If a client's average rate is greater than the maximum, the rate limiting
27951 engine can react in two possible ways, depending on the presence of the
27952 &%strict%& or &%leaky%& update modes. This is independent of the other
27953 counter-measures (such as rejecting the message) that may be specified by the
27954 rest of the ACL.
27955
27956 The &%leaky%& (default) option means that the client's recorded rate is not
27957 updated if it is above the limit. The effect of this is that Exim measures the
27958 client's average rate of successfully sent email, which cannot be greater than
27959 the maximum allowed. If the client is over the limit it may suffer some
27960 counter-measures (as specified in the ACL), but it will still be able to send
27961 email at the configured maximum rate, whatever the rate of its attempts. This
27962 is generally the better choice if you have clients that retry automatically.
27963 For example, it does not prevent a sender with an over-aggressive retry rate
27964 from getting any email through.
27965
27966 The &%strict%& option means that the client's recorded rate is always
27967 updated. The effect of this is that Exim measures the client's average rate
27968 of attempts to send email, which can be much higher than the maximum it is
27969 actually allowed. If the client is over the limit it may be subjected to
27970 counter-measures by the ACL. It must slow down and allow sufficient time to
27971 pass that its computed rate falls below the maximum before it can send email
27972 again. The time (the number of smoothing periods) it must wait and not
27973 attempt to send mail can be calculated with this formula:
27974 .code
27975         ln(peakrate/maxrate)
27976 .endd
27977
27978
27979 .section "Limiting the rate of different events" "ratoptuniq"
27980 .cindex "rate limiting" "counting unique events"
27981 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
27982 rate of different events. For example, the &%per_addr%& option uses this
27983 mechanism to count the number of different recipients that the client has
27984 sent messages to in the last time period; it is equivalent to
27985 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
27986 measure the rate that a client uses different sender addresses with the
27987 options &`per_mail/unique=$sender_address`&.
27988
27989 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
27990 has seen for that key. The whole set is thrown away when it is older than the
27991 rate smoothing period &'p'&, so each different event is counted at most once
27992 per period. In the &%leaky%& update mode, an event that causes the client to
27993 go over the limit is not added to the set, in the same way that the client's
27994 recorded rate is not updated in the same situation.
27995
27996 When you combine the &%unique=%& and &%readonly%& options, the specific
27997 &%unique=%& value is ignored, and Exim just retrieves the client's stored
27998 rate.
27999
28000 The &%unique=%& mechanism needs more space in the ratelimit database than the
28001 other &%ratelimit%& options in order to store the event set. The number of
28002 unique values is potentially as large as the rate limit, so the extra space
28003 required increases with larger limits.
28004
28005 The uniqueification is not perfect: there is a small probability that Exim
28006 will think a new event has happened before. If the sender's rate is less than
28007 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28008 the measured rate can go above the limit, in which case Exim may under-count
28009 events by a significant margin. Fortunately, if the rate is high enough (2.7
28010 times the limit) that the false positive rate goes above 9%, then Exim will
28011 throw away the over-full event set before the measured rate falls below the
28012 limit. Therefore the only harm should be that exceptionally high sending rates
28013 are logged incorrectly; any countermeasures you configure will be as effective
28014 as intended.
28015
28016
28017 .section "Using rate limiting" "useratlim"
28018 Exim's other ACL facilities are used to define what counter-measures are taken
28019 when the rate limit is exceeded. This might be anything from logging a warning
28020 (for example, while measuring existing sending rates in order to define
28021 policy), through time delays to slow down fast senders, up to rejecting the
28022 message. For example:
28023 .code
28024 # Log all senders' rates
28025 warn ratelimit = 0 / 1h / strict
28026      log_message = Sender rate $sender_rate / $sender_rate_period
28027
28028 # Slow down fast senders; note the need to truncate $sender_rate
28029 # at the decimal point.
28030 warn ratelimit = 100 / 1h / per_rcpt / strict
28031      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28032                    $sender_rate_limit }s
28033
28034 # Keep authenticated users under control
28035 deny authenticated = *
28036      ratelimit = 100 / 1d / strict / $authenticated_id
28037
28038 # System-wide rate limit
28039 defer message = Sorry, too busy. Try again later.
28040      ratelimit = 10 / 1s / $primary_hostname
28041
28042 # Restrict incoming rate from each host, with a default
28043 # set using a macro and special cases looked up in a table.
28044 defer message = Sender rate exceeds $sender_rate_limit \
28045                messages per $sender_rate_period
28046      ratelimit = ${lookup {$sender_host_address} \
28047                    cdb {DB/ratelimits.cdb} \
28048                    {$value} {RATELIMIT} }
28049 .endd
28050 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28051 especially with the &%per_rcpt%& option, you may suffer from a performance
28052 bottleneck caused by locking on the ratelimit hints database. Apart from
28053 making your ACLs less complicated, you can reduce the problem by using a
28054 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28055 this means that Exim will lose its hints data after a reboot (including retry
28056 hints, the callout cache, and ratelimit data).
28057
28058
28059
28060 .section "Address verification" "SECTaddressverification"
28061 .cindex "verifying address" "options for"
28062 .cindex "policy control" "address verification"
28063 Several of the &%verify%& conditions described in section
28064 &<<SECTaclconditions>>& cause addresses to be verified. Section
28065 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28066 The verification conditions can be followed by options that modify the
28067 verification process. The options are separated from the keyword and from each
28068 other by slashes, and some of them contain parameters. For example:
28069 .code
28070 verify = sender/callout
28071 verify = recipient/defer_ok/callout=10s,defer_ok
28072 .endd
28073 The first stage of address verification, which always happens, is to run the
28074 address through the routers, in &"verify mode"&. Routers can detect the
28075 difference between verification and routing for delivery, and their actions can
28076 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28077 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28078 The available options are as follows:
28079
28080 .ilist
28081 If the &%callout%& option is specified, successful routing to one or more
28082 remote hosts is followed by a &"callout"& to those hosts as an additional
28083 check. Callouts and their sub-options are discussed in the next section.
28084 .next
28085 If there is a defer error while doing verification routing, the ACL
28086 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28087 options, the condition is forced to be true instead. Note that this is a main
28088 verification option as well as a suboption for callouts.
28089 .next
28090 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28091 discusses the reporting of sender address verification failures.
28092 .next
28093 The &%success_on_redirect%& option causes verification always to succeed
28094 immediately after a successful redirection. By default, if a redirection
28095 generates just one address, that address is also verified. See further
28096 discussion in section &<<SECTredirwhilveri>>&.
28097 .endlist
28098
28099 .cindex "verifying address" "differentiating failures"
28100 .vindex "&$recipient_verify_failure$&"
28101 .vindex "&$sender_verify_failure$&"
28102 .vindex "&$acl_verify_message$&"
28103 After an address verification failure, &$acl_verify_message$& contains the
28104 error message that is associated with the failure. It can be preserved by
28105 coding like this:
28106 .code
28107 warn  !verify = sender
28108        set acl_m0 = $acl_verify_message
28109 .endd
28110 If you are writing your own custom rejection message or log message when
28111 denying access, you can use this variable to include information about the
28112 verification failure.
28113
28114 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28115 appropriate) contains one of the following words:
28116
28117 .ilist
28118 &%qualify%&: The address was unqualified (no domain), and the message
28119 was neither local nor came from an exempted host.
28120 .next
28121 &%route%&: Routing failed.
28122 .next
28123 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28124 occurred at or before the MAIL command (that is, on initial
28125 connection, HELO, or MAIL).
28126 .next
28127 &%recipient%&: The RCPT command in a callout was rejected.
28128 .next
28129 &%postmaster%&: The postmaster check in a callout was rejected.
28130 .endlist
28131
28132 The main use of these variables is expected to be to distinguish between
28133 rejections of MAIL and rejections of RCPT in callouts.
28134
28135
28136
28137
28138 .section "Callout verification" "SECTcallver"
28139 .cindex "verifying address" "by callout"
28140 .cindex "callout" "verification"
28141 .cindex "SMTP" "callout verification"
28142 For non-local addresses, routing verifies the domain, but is unable to do any
28143 checking of the local part. There are situations where some means of verifying
28144 the local part is desirable. One way this can be done is to make an SMTP
28145 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28146 a subsequent host for a recipient address, to see if the host accepts the
28147 address. We use the term &'callout'& to cover both cases. Note that for a
28148 sender address, the callback is not to the client host that is trying to
28149 deliver the message, but to one of the hosts that accepts incoming mail for the
28150 sender's domain.
28151
28152 Exim does not do callouts by default. If you want them to happen, you must
28153 request them by setting appropriate options on the &%verify%& condition, as
28154 described below. This facility should be used with care, because it can add a
28155 lot of resource usage to the cost of verifying an address. However, Exim does
28156 cache the results of callouts, which helps to reduce the cost. Details of
28157 caching are in section &<<SECTcallvercache>>&.
28158
28159 Recipient callouts are usually used only between hosts that are controlled by
28160 the same administration. For example, a corporate gateway host could use
28161 callouts to check for valid recipients on an internal mailserver. A successful
28162 callout does not guarantee that a real delivery to the address would succeed;
28163 on the other hand, a failing callout does guarantee that a delivery would fail.
28164
28165 If the &%callout%& option is present on a condition that verifies an address, a
28166 second stage of verification occurs if the address is successfully routed to
28167 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28168 &(manualroute)& router, where the router specifies the hosts. However, if a
28169 router that does not set up hosts routes to an &(smtp)& transport with a
28170 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28171 &%hosts_override%& set, its hosts are always used, whether or not the router
28172 supplies a host list.
28173
28174 The port that is used is taken from the transport, if it is specified and is a
28175 remote transport. (For routers that do verification only, no transport need be
28176 specified.) Otherwise, the default SMTP port is used. If a remote transport
28177 specifies an outgoing interface, this is used; otherwise the interface is not
28178 specified. Likewise, the text that is used for the HELO command is taken from
28179 the transport's &%helo_data%& option; if there is no transport, the value of
28180 &$smtp_active_hostname$& is used.
28181
28182 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28183 test whether a bounce message could be delivered to the sender address. The
28184 following SMTP commands are sent:
28185 .display
28186 &`HELO `&<&'local host name'&>
28187 &`MAIL FROM:<>`&
28188 &`RCPT TO:`&<&'the address to be tested'&>
28189 &`QUIT`&
28190 .endd
28191 LHLO is used instead of HELO if the transport's &%protocol%& option is
28192 set to &"lmtp"&.
28193
28194 A recipient callout check is similar. By default, it also uses an empty address
28195 for the sender. This default is chosen because most hosts do not make use of
28196 the sender address when verifying a recipient. Using the same address means
28197 that a single cache entry can be used for each recipient. Some sites, however,
28198 do make use of the sender address when verifying. These are catered for by the
28199 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28200
28201 If the response to the RCPT command is a 2&'xx'& code, the verification
28202 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28203 Exim tries the next host, if any. If there is a problem with all the remote
28204 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28205 &%callout%& option is given, in which case the condition is forced to succeed.
28206
28207 .cindex "SMTP" "output flushing, disabling for callout"
28208 A callout may take a little time. For this reason, Exim normally flushes SMTP
28209 output before performing a callout in an ACL, to avoid unexpected timeouts in
28210 clients when the SMTP PIPELINING extension is in use. The flushing can be
28211 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28212
28213
28214
28215
28216 .section "Additional parameters for callouts" "CALLaddparcall"
28217 .cindex "callout" "additional parameters for"
28218 The &%callout%& option can be followed by an equals sign and a number of
28219 optional parameters, separated by commas. For example:
28220 .code
28221 verify = recipient/callout=10s,defer_ok
28222 .endd
28223 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28224 separate verify options, is retained for backwards compatibility, but is now
28225 deprecated. The additional parameters for &%callout%& are as follows:
28226
28227
28228 .vlist
28229 .vitem <&'a&~time&~interval'&>
28230 .cindex "callout" "timeout, specifying"
28231 This specifies the timeout that applies for the callout attempt to each host.
28232 For example:
28233 .code
28234 verify = sender/callout=5s
28235 .endd
28236 The default is 30 seconds. The timeout is used for each response from the
28237 remote host. It is also used for the initial connection, unless overridden by
28238 the &%connect%& parameter.
28239
28240
28241 .vitem &*connect&~=&~*&<&'time&~interval'&>
28242 .cindex "callout" "connection timeout, specifying"
28243 This parameter makes it possible to set a different (usually smaller) timeout
28244 for making the SMTP connection. For example:
28245 .code
28246 verify = sender/callout=5s,connect=1s
28247 .endd
28248 If not specified, this timeout defaults to the general timeout value.
28249
28250 .vitem &*defer_ok*&
28251 .cindex "callout" "defer, action on"
28252 When this parameter is present, failure to contact any host, or any other kind
28253 of temporary error, is treated as success by the ACL. However, the cache is not
28254 updated in this circumstance.
28255
28256 .vitem &*fullpostmaster*&
28257 .cindex "callout" "full postmaster check"
28258 This operates like the &%postmaster%& option (see below), but if the check for
28259 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28260 accordance with the specification in RFC 2821. The RFC states that the
28261 unqualified address &'postmaster'& should be accepted.
28262
28263
28264 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28265 .cindex "callout" "sender when verifying header"
28266 When verifying addresses in header lines using the &%header_sender%&
28267 verification option, Exim behaves by default as if the addresses are envelope
28268 sender addresses from a message. Callout verification therefore tests to see
28269 whether a bounce message could be delivered, by using an empty address in the
28270 MAIL command. However, it is arguable that these addresses might never be used
28271 as envelope senders, and could therefore justifiably reject bounce messages
28272 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28273 address to use in the MAIL command. For example:
28274 .code
28275 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28276 .endd
28277 This parameter is available only for the &%header_sender%& verification option.
28278
28279
28280 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28281 .cindex "callout" "overall timeout, specifying"
28282 This parameter sets an overall timeout for performing a callout verification.
28283 For example:
28284 .code
28285 verify = sender/callout=5s,maxwait=30s
28286 .endd
28287 This timeout defaults to four times the callout timeout for individual SMTP
28288 commands. The overall timeout applies when there is more than one host that can
28289 be tried. The timeout is checked before trying the next host. This prevents
28290 very long delays if there are a large number of hosts and all are timing out
28291 (for example, when network connections are timing out).
28292
28293
28294 .vitem &*no_cache*&
28295 .cindex "callout" "cache, suppressing"
28296 .cindex "caching callout, suppressing"
28297 When this parameter is given, the callout cache is neither read nor updated.
28298
28299 .vitem &*postmaster*&
28300 .cindex "callout" "postmaster; checking"
28301 When this parameter is set, a successful callout check is followed by a similar
28302 check for the local part &'postmaster'& at the same domain. If this address is
28303 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28304 the postmaster check is recorded in a cache record; if it is a failure, this is
28305 used to fail subsequent callouts for the domain without a connection being
28306 made, until the cache record expires.
28307
28308 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
28309 The postmaster check uses an empty sender in the MAIL command by default.
28310 You can use this parameter to do a postmaster check using a different address.
28311 For example:
28312 .code
28313 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
28314 .endd
28315 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
28316 one overrides. The &%postmaster%& parameter is equivalent to this example:
28317 .code
28318 require  verify = sender/callout=postmaster_mailfrom=
28319 .endd
28320 &*Warning*&: The caching arrangements for postmaster checking do not take
28321 account of the sender address. It is assumed that either the empty address or
28322 a fixed non-empty address will be used. All that Exim remembers is that the
28323 postmaster check for the domain succeeded or failed.
28324
28325
28326 .vitem &*random*&
28327 .cindex "callout" "&""random""& check"
28328 When this parameter is set, before doing the normal callout check, Exim does a
28329 check for a &"random"& local part at the same domain. The local part is not
28330 really random &-- it is defined by the expansion of the option
28331 &%callout_random_local_part%&, which defaults to
28332 .code
28333 $primary_hostname-$tod_epoch-testing
28334 .endd
28335 The idea here is to try to determine whether the remote host accepts all local
28336 parts without checking. If it does, there is no point in doing callouts for
28337 specific local parts. If the &"random"& check succeeds, the result is saved in
28338 a cache record, and used to force the current and subsequent callout checks to
28339 succeed without a connection being made, until the cache record expires.
28340
28341 .vitem &*use_postmaster*&
28342 .cindex "callout" "sender for recipient check"
28343 This parameter applies to recipient callouts only. For example:
28344 .code
28345 deny  !verify = recipient/callout=use_postmaster
28346 .endd
28347 .vindex "&$qualify_domain$&"
28348 It causes a non-empty postmaster address to be used in the MAIL command when
28349 performing the callout for the recipient, and also for a &"random"& check if
28350 that is configured. The local part of the address is &`postmaster`& and the
28351 domain is the contents of &$qualify_domain$&.
28352
28353 .vitem &*use_sender*&
28354 This option applies to recipient callouts only. For example:
28355 .code
28356 require  verify = recipient/callout=use_sender
28357 .endd
28358 It causes the message's actual sender address to be used in the MAIL
28359 command when performing the callout, instead of an empty address. There is no
28360 need to use this option unless you know that the called hosts make use of the
28361 sender when checking recipients. If used indiscriminately, it reduces the
28362 usefulness of callout caching.
28363 .endlist
28364
28365 If you use any of the parameters that set a non-empty sender for the MAIL
28366 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
28367 &%use_sender%&), you should think about possible loops. Recipient checking is
28368 usually done between two hosts that are under the same management, and the host
28369 that receives the callouts is not normally configured to do callouts itself.
28370 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
28371 these circumstances.
28372
28373 However, if you use a non-empty sender address for a callout to an arbitrary
28374 host, there is the likelihood that the remote host will itself initiate a
28375 callout check back to your host. As it is checking what appears to be a message
28376 sender, it is likely to use an empty address in MAIL, thus avoiding a
28377 callout loop. However, to be on the safe side it would be best to set up your
28378 own ACLs so that they do not do sender verification checks when the recipient
28379 is the address you use for header sender or postmaster callout checking.
28380
28381 Another issue to think about when using non-empty senders for callouts is
28382 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
28383 by the sender/recipient combination; thus, for any given recipient, many more
28384 actual callouts are performed than when an empty sender or postmaster is used.
28385
28386
28387
28388
28389 .section "Callout caching" "SECTcallvercache"
28390 .cindex "hints database" "callout cache"
28391 .cindex "callout" "cache, description of"
28392 .cindex "caching" "callout"
28393 Exim caches the results of callouts in order to reduce the amount of resources
28394 used, unless you specify the &%no_cache%& parameter with the &%callout%&
28395 option. A hints database called &"callout"& is used for the cache. Two
28396 different record types are used: one records the result of a callout check for
28397 a specific address, and the other records information that applies to the
28398 entire domain (for example, that it accepts the local part &'postmaster'&).
28399
28400 When an original callout fails, a detailed SMTP error message is given about
28401 the failure. However, for subsequent failures use the cache data, this message
28402 is not available.
28403
28404 The expiry times for negative and positive address cache records are
28405 independent, and can be set by the global options &%callout_negative_expire%&
28406 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
28407
28408 If a host gives a negative response to an SMTP connection, or rejects any
28409 commands up to and including
28410 .code
28411 MAIL FROM:<>
28412 .endd
28413 (but not including the MAIL command with a non-empty address),
28414 any callout attempt is bound to fail. Exim remembers such failures in a
28415 domain cache record, which it uses to fail callouts for the domain without
28416 making new connections, until the domain record times out. There are two
28417 separate expiry times for domain cache records:
28418 &%callout_domain_negative_expire%& (default 3h) and
28419 &%callout_domain_positive_expire%& (default 7d).
28420
28421 Domain records expire when the negative expiry time is reached if callouts
28422 cannot be made for the domain, or if the postmaster check failed.
28423 Otherwise, they expire when the positive expiry time is reached. This
28424 ensures that, for example, a host that stops accepting &"random"& local parts
28425 will eventually be noticed.
28426
28427 The callout caching mechanism is based on the domain of the address that is
28428 being tested. If the domain routes to several hosts, it is assumed that their
28429 behaviour will be the same.
28430
28431
28432
28433 .section "Sender address verification reporting" "SECTsenaddver"
28434 .cindex "verifying" "suppressing error details"
28435 See section &<<SECTaddressverification>>& for a general discussion of
28436 verification. When sender verification fails in an ACL, the details of the
28437 failure are given as additional output lines before the 550 response to the
28438 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
28439 you might see:
28440 .code
28441 MAIL FROM:<xyz@abc.example>
28442 250 OK
28443 RCPT TO:<pqr@def.example>
28444 550-Verification failed for <xyz@abc.example>
28445 550-Called:   192.168.34.43
28446 550-Sent:     RCPT TO:<xyz@abc.example>
28447 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
28448 550 Sender verification failed
28449 .endd
28450 If more than one RCPT command fails in the same way, the details are given
28451 only for the first of them. However, some administrators do not want to send
28452 out this much information. You can suppress the details by adding
28453 &`/no_details`& to the ACL statement that requests sender verification. For
28454 example:
28455 .code
28456 verify = sender/no_details
28457 .endd
28458
28459 .section "Redirection while verifying" "SECTredirwhilveri"
28460 .cindex "verifying" "redirection while"
28461 .cindex "address redirection" "while verifying"
28462 A dilemma arises when a local address is redirected by aliasing or forwarding
28463 during verification: should the generated addresses themselves be verified,
28464 or should the successful expansion of the original address be enough to verify
28465 it? By default, Exim takes the following pragmatic approach:
28466
28467 .ilist
28468 When an incoming address is redirected to just one child address, verification
28469 continues with the child address, and if that fails to verify, the original
28470 verification also fails.
28471 .next
28472 When an incoming address is redirected to more than one child address,
28473 verification does not continue. A success result is returned.
28474 .endlist
28475
28476 This seems the most reasonable behaviour for the common use of aliasing as a
28477 way of redirecting different local parts to the same mailbox. It means, for
28478 example, that a pair of alias entries of the form
28479 .code
28480 A.Wol:   aw123
28481 aw123:   :fail: Gone away, no forwarding address
28482 .endd
28483 work as expected, with both local parts causing verification failure. When a
28484 redirection generates more than one address, the behaviour is more like a
28485 mailing list, where the existence of the alias itself is sufficient for
28486 verification to succeed.
28487
28488 It is possible, however, to change the default behaviour so that all successful
28489 redirections count as successful verifications, however many new addresses are
28490 generated. This is specified by the &%success_on_redirect%& verification
28491 option. For example:
28492 .code
28493 require verify = recipient/success_on_redirect/callout=10s
28494 .endd
28495 In this example, verification succeeds if a router generates a new address, and
28496 the callout does not occur, because no address was routed to a remote host.
28497
28498 When verification is being tested via the &%-bv%& option, the treatment of
28499 redirections is as just described, unless the &%-v%& or any debugging option is
28500 also specified. In that case, full verification is done for every generated
28501 address and a report is output for each of them.
28502
28503
28504
28505 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
28506 .cindex "CSA" "verifying"
28507 Client SMTP Authorization is a system that allows a site to advertise
28508 which machines are and are not permitted to send email. This is done by placing
28509 special SRV records in the DNS; these are looked up using the client's HELO
28510 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
28511 Authorization checks in Exim are performed by the ACL condition:
28512 .code
28513 verify = csa
28514 .endd
28515 This fails if the client is not authorized. If there is a DNS problem, or if no
28516 valid CSA SRV record is found, or if the client is authorized, the condition
28517 succeeds. These three cases can be distinguished using the expansion variable
28518 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
28519 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
28520 be likely to cause problems for legitimate email.
28521
28522 The error messages produced by the CSA code include slightly more
28523 detail. If &$csa_status$& is &"defer"&, this may be because of problems
28524 looking up the CSA SRV record, or problems looking up the CSA target
28525 address record. There are four reasons for &$csa_status$& being &"fail"&:
28526
28527 .ilist
28528 The client's host name is explicitly not authorized.
28529 .next
28530 The client's IP address does not match any of the CSA target IP addresses.
28531 .next
28532 The client's host name is authorized but it has no valid target IP addresses
28533 (for example, the target's addresses are IPv6 and the client is using IPv4).
28534 .next
28535 The client's host name has no CSA SRV record but a parent domain has asserted
28536 that all subdomains must be explicitly authorized.
28537 .endlist
28538
28539 The &%csa%& verification condition can take an argument which is the domain to
28540 use for the DNS query. The default is:
28541 .code
28542 verify = csa/$sender_helo_name
28543 .endd
28544 This implementation includes an extension to CSA. If the query domain
28545 is an address literal such as [192.0.2.95], or if it is a bare IP
28546 address, Exim searches for CSA SRV records in the reverse DNS as if
28547 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
28548 meaningful to say:
28549 .code
28550 verify = csa/$sender_host_address
28551 .endd
28552 In fact, this is the check that Exim performs if the client does not say HELO.
28553 This extension can be turned off by setting the main configuration option
28554 &%dns_csa_use_reverse%& to be false.
28555
28556 If a CSA SRV record is not found for the domain itself, a search
28557 is performed through its parent domains for a record which might be
28558 making assertions about subdomains. The maximum depth of this search is limited
28559 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
28560 default. Exim does not look for CSA SRV records in a top level domain, so the
28561 default settings handle HELO domains as long as seven
28562 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
28563 of legitimate HELO domains.
28564
28565 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
28566 direct SRV lookups, this is not sufficient because of the extra parent domain
28567 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
28568 addresses into lookups in the reverse DNS space. The result of a successful
28569 lookup such as:
28570 .code
28571 ${lookup dnsdb {csa=$sender_helo_name}}
28572 .endd
28573 has two space-separated fields: an authorization code and a target host name.
28574 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
28575 authorization required but absent, or &"?"& for unknown.
28576
28577
28578
28579
28580 .section "Bounce address tag validation" "SECTverifyPRVS"
28581 .cindex "BATV, verifying"
28582 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
28583 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
28584 Genuine incoming bounce messages should therefore always be addressed to
28585 recipients that have a valid tag. This scheme is a way of detecting unwanted
28586 bounce messages caused by sender address forgeries (often called &"collateral
28587 spam"&), because the recipients of such messages do not include valid tags.
28588
28589 There are two expansion items to help with the implementation of the BATV
28590 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
28591 the original envelope sender address by using a simple key to add a hash of the
28592 address and some time-based randomizing information. The &%prvs%& expansion
28593 item creates a signed address, and the &%prvscheck%& expansion item checks one.
28594 The syntax of these expansion items is described in section
28595 &<<SECTexpansionitems>>&.
28596
28597 As an example, suppose the secret per-address keys are stored in an MySQL
28598 database. A query to look up the key for an address could be defined as a macro
28599 like this:
28600 .code
28601 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
28602                 WHERE sender='${quote_mysql:$prvscheck_address}'\
28603                 }{$value}}
28604 .endd
28605 Suppose also that the senders who make use of BATV are defined by an address
28606 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
28607 use this:
28608 .code
28609 # Bounces: drop unsigned addresses for BATV senders
28610 deny message = This address does not send an unsigned reverse path
28611      senders = :
28612      recipients = +batv_senders
28613
28614 # Bounces: In case of prvs-signed address, check signature.
28615 deny message = Invalid reverse path signature.
28616      senders = :
28617      condition  = ${prvscheck {$local_part@$domain}\
28618                   {PRVSCHECK_SQL}{1}}
28619      !condition = $prvscheck_result
28620 .endd
28621 The first statement rejects recipients for bounce messages that are addressed
28622 to plain BATV sender addresses, because it is known that BATV senders do not
28623 send out messages with plain sender addresses. The second statement rejects
28624 recipients that are prvs-signed, but with invalid signatures (either because
28625 the key is wrong, or the signature has timed out).
28626
28627 A non-prvs-signed address is not rejected by the second statement, because the
28628 &%prvscheck%& expansion yields an empty string if its first argument is not a
28629 prvs-signed address, thus causing the &%condition%& condition to be false. If
28630 the first argument is a syntactically valid prvs-signed address, the yield is
28631 the third string (in this case &"1"&), whether or not the cryptographic and
28632 timeout checks succeed. The &$prvscheck_result$& variable contains the result
28633 of the checks (empty for failure, &"1"& for success).
28634
28635 There is one more issue you must consider when implementing prvs-signing:
28636 you have to ensure that the routers accept prvs-signed addresses and
28637 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
28638 router to remove the signature with a configuration along these lines:
28639 .code
28640 batv_redirect:
28641   driver = redirect
28642   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
28643 .endd
28644 This works because, if the third argument of &%prvscheck%& is empty, the result
28645 of the expansion of a prvs-signed address is the decoded value of the original
28646 address. This router should probably be the first of your routers that handles
28647 local addresses.
28648
28649 To create BATV-signed addresses in the first place, a transport of this form
28650 can be used:
28651 .code
28652 external_smtp_batv:
28653   driver = smtp
28654   return_path = ${prvs {$return_path} \
28655                        {${lookup mysql{SELECT \
28656                        secret FROM batv_prvs WHERE \
28657                        sender='${quote_mysql:$sender_address}'} \
28658                        {$value}fail}}}
28659 .endd
28660 If no key can be found for the existing return path, no signing takes place.
28661
28662
28663
28664 .section "Using an ACL to control relaying" "SECTrelaycontrol"
28665 .cindex "&ACL;" "relay control"
28666 .cindex "relaying" "control by ACL"
28667 .cindex "policy control" "relay control"
28668 An MTA is said to &'relay'& a message if it receives it from some host and
28669 delivers it directly to another host as a result of a remote address contained
28670 within it. Redirecting a local address via an alias or forward file and then
28671 passing the message on to another host is not relaying,
28672 .cindex "&""percent hack""&"
28673 but a redirection as a result of the &"percent hack"& is.
28674
28675 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
28676 A host which is acting as a gateway or an MX backup is concerned with incoming
28677 relaying from arbitrary hosts to a specific set of domains. On the other hand,
28678 a host which is acting as a smart host for a number of clients is concerned
28679 with outgoing relaying from those clients to the Internet at large. Often the
28680 same host is fulfilling both functions,
28681 . ///
28682 . as illustrated in the diagram below,
28683 . ///
28684 but in principle these two kinds of relaying are entirely independent. What is
28685 not wanted is the transmission of mail from arbitrary remote hosts through your
28686 system to arbitrary domains.
28687
28688
28689 You can implement relay control by means of suitable statements in the ACL that
28690 runs for each RCPT command. For convenience, it is often easiest to use
28691 Exim's named list facility to define the domains and hosts involved. For
28692 example, suppose you want to do the following:
28693
28694 .ilist
28695 Deliver a number of domains to mailboxes on the local host (or process them
28696 locally in some other way). Let's say these are &'my.dom1.example'& and
28697 &'my.dom2.example'&.
28698 .next
28699 Relay mail for a number of other domains for which you are the secondary MX.
28700 These might be &'friend1.example'& and &'friend2.example'&.
28701 .next
28702 Relay mail from the hosts on your local LAN, to whatever domains are involved.
28703 Suppose your LAN is 192.168.45.0/24.
28704 .endlist
28705
28706
28707 In the main part of the configuration, you put the following definitions:
28708 .code
28709 domainlist local_domains = my.dom1.example : my.dom2.example
28710 domainlist relay_domains = friend1.example : friend2.example
28711 hostlist   relay_hosts   = 192.168.45.0/24
28712 .endd
28713 Now you can use these definitions in the ACL that is run for every RCPT
28714 command:
28715 .code
28716 acl_check_rcpt:
28717   accept domains = +local_domains : +relay_domains
28718   accept hosts   = +relay_hosts
28719 .endd
28720 The first statement accepts any RCPT command that contains an address in
28721 the local or relay domains. For any other domain, control passes to the second
28722 statement, which accepts the command only if it comes from one of the relay
28723 hosts. In practice, you will probably want to make your ACL more sophisticated
28724 than this, for example, by including sender and recipient verification. The
28725 default configuration includes a more comprehensive example, which is described
28726 in chapter &<<CHAPdefconfil>>&.
28727
28728
28729
28730 .section "Checking a relay configuration" "SECTcheralcon"
28731 .cindex "relaying" "checking control of"
28732 You can check the relay characteristics of your configuration in the same way
28733 that you can test any ACL behaviour for an incoming SMTP connection, by using
28734 the &%-bh%& option to run a fake SMTP session with which you interact.
28735
28736 For specifically testing for unwanted relaying, the host
28737 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
28738 host from the host on which Exim is running, using the normal telnet port, you
28739 will see a normal telnet connection message and then quite a long delay. Be
28740 patient. The remote host is making an SMTP connection back to your host, and
28741 trying a number of common probes to test for open relay vulnerability. The
28742 results of the tests will eventually appear on your terminal.
28743 .ecindex IIDacl
28744
28745
28746
28747 . ////////////////////////////////////////////////////////////////////////////
28748 . ////////////////////////////////////////////////////////////////////////////
28749
28750 .chapter "Content scanning at ACL time" "CHAPexiscan"
28751 .scindex IIDcosca "content scanning" "at ACL time"
28752 The extension of Exim to include content scanning at ACL time, formerly known
28753 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
28754 was integrated into the main source for Exim release 4.50, and Tom continues to
28755 maintain it. Most of the wording of this chapter is taken from Tom's
28756 specification.
28757
28758 It is also possible to scan the content of messages at other times. The
28759 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
28760 scanning after all the ACLs have run. A transport filter can be used to scan
28761 messages at delivery time (see the &%transport_filter%& option, described in
28762 chapter &<<CHAPtransportgeneric>>&).
28763
28764 If you want to include the ACL-time content-scanning features when you compile
28765 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
28766 &_Local/Makefile_&. When you do that, the Exim binary is built with:
28767
28768 .ilist
28769 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
28770 for all MIME parts for SMTP and non-SMTP messages, respectively.
28771 .next
28772 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
28773 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
28774 run at the end of message reception (the &%acl_smtp_data%& ACL).
28775 .next
28776 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
28777 of messages, or parts of messages, for debugging purposes.
28778 .next
28779 Additional expansion variables that are set in the new ACL and by the new
28780 conditions.
28781 .next
28782 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
28783 .endlist
28784
28785 There is another content-scanning configuration option for &_Local/Makefile_&,
28786 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
28787 condition is compiled, in addition to all the other content-scanning features.
28788
28789 Content-scanning is continually evolving, and new features are still being
28790 added. While such features are still unstable and liable to incompatible
28791 changes, they are made available in Exim by setting options whose names begin
28792 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
28793 this manual. You can find out about them by reading the file called
28794 &_doc/experimental.txt_&.
28795
28796 All the content-scanning facilities work on a MBOX copy of the message that is
28797 temporarily created in a file called:
28798 .display
28799 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
28800 .endd
28801 The &_.eml_& extension is a friendly hint to virus scanners that they can
28802 expect an MBOX-like structure inside that file. The file is created when the
28803 first content scanning facility is called. Subsequent calls to content
28804 scanning conditions open the same file again. The directory is recursively
28805 removed when the &%acl_smtp_data%& ACL has finished running, unless
28806 .code
28807 control = no_mbox_unspool
28808 .endd
28809 has been encountered. When the MIME ACL decodes files, they are put into the
28810 same directory by default.
28811
28812
28813
28814 .section "Scanning for viruses" "SECTscanvirus"
28815 .cindex "virus scanning"
28816 .cindex "content scanning" "for viruses"
28817 .cindex "content scanning" "the &%malware%& condition"
28818 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
28819 It supports a &"generic"& interface to scanners called via the shell, and
28820 specialized interfaces for &"daemon"& type virus scanners, which are resident
28821 in memory and thus are much faster.
28822
28823
28824 .oindex "&%av_scanner%&"
28825 You can set the &%av_scanner%& option in first part of the Exim configuration
28826 file to specify which scanner to use, together with any additional options that
28827 are needed. The basic syntax is as follows:
28828 .display
28829 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28830 .endd
28831 If you do not set &%av_scanner%&, it defaults to
28832 .code
28833 av_scanner = sophie:/var/run/sophie
28834 .endd
28835 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28836 before use. The following scanner types are supported in this release:
28837
28838 .vlist
28839 .vitem &%aveserver%&
28840 .cindex "virus scanners" "Kaspersky"
28841 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28842 at &url(http://www.kaspersky.com). This scanner type takes one option,
28843 which is the path to the daemon's UNIX socket. The default is shown in this
28844 example:
28845 .code
28846 av_scanner = aveserver:/var/run/aveserver
28847 .endd
28848
28849
28850 .vitem &%clamd%&
28851 .cindex "virus scanners" "clamd"
28852 This daemon-type scanner is GPL and free. You can get it at
28853 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28854 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28855 in the MIME ACL. This no longer believed to be necessary. One option is
28856 required: either the path and name of a UNIX socket file, or a hostname or IP
28857 number, and a port, separated by space, as in the second of these examples:
28858 .code
28859 av_scanner = clamd:/opt/clamd/socket
28860 av_scanner = clamd:192.0.2.3 1234
28861 av_scanner = clamd:192.0.2.3 1234:local
28862 .endd
28863 If the value of av_scanner points to a UNIX socket file or contains the local
28864 keyword, then the ClamAV interface will pass a filename containing the data
28865 to be scanned, which will should normally result in less I/O happening and be
28866 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28867 Exim does not assume that there is a common filesystem with the remote host.
28868 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28869 you be running a version of ClamAV prior to 0.95.
28870 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28871 contributing the code for this scanner.
28872
28873 .vitem &%cmdline%&
28874 .cindex "virus scanners" "command line interface"
28875 This is the keyword for the generic command line scanner interface. It can be
28876 used to attach virus scanners that are invoked from the shell. This scanner
28877 type takes 3 mandatory options:
28878
28879 .olist
28880 The full path and name of the scanner binary, with all command line options,
28881 and a placeholder (&`%s`&) for the directory to scan.
28882
28883 .next
28884 A regular expression to match against the STDOUT and STDERR output of the
28885 virus scanner. If the expression matches, a virus was found. You must make
28886 absolutely sure that this expression matches on &"virus found"&. This is called
28887 the &"trigger"& expression.
28888
28889 .next
28890 Another regular expression, containing exactly one pair of parentheses, to
28891 match the name of the virus found in the scanners output. This is called the
28892 &"name"& expression.
28893 .endlist olist
28894
28895 For example, Sophos Sweep reports a virus on a line like this:
28896 .code
28897 Virus 'W32/Magistr-B' found in file ./those.bat
28898 .endd
28899 For the trigger expression, we can match the phrase &"found in file"&. For the
28900 name expression, we want to extract the W32/Magistr-B string, so we can match
28901 for the single quotes left and right of it. Altogether, this makes the
28902 configuration setting:
28903 .code
28904 av_scanner = cmdline:\
28905              /path/to/sweep -ss -all -rec -archive %s:\
28906              found in file:'(.+)'
28907 .endd
28908 .vitem &%drweb%&
28909 .cindex "virus scanners" "DrWeb"
28910 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28911 argument, either a full path to a UNIX socket, or an IP address and port
28912 separated by white space, as in these examples:
28913 .code
28914 av_scanner = drweb:/var/run/drwebd.sock
28915 av_scanner = drweb:192.168.2.20 31337
28916 .endd
28917 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28918 is used. Thanks to Alex Miller for contributing the code for this scanner.
28919
28920 .vitem &%fsecure%&
28921 .cindex "virus scanners" "F-Secure"
28922 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28923 argument which is the path to a UNIX socket. For example:
28924 .code
28925 av_scanner = fsecure:/path/to/.fsav
28926 .endd
28927 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28928 Thelmen for contributing the code for this scanner.
28929
28930 .vitem &%kavdaemon%&
28931 .cindex "virus scanners" "Kaspersky"
28932 This is the scanner daemon of Kaspersky Version 4. This version of the
28933 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28934 scanner type takes one option, which is the path to the daemon's UNIX socket.
28935 For example:
28936 .code
28937 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28938 .endd
28939 The default path is &_/var/run/AvpCtl_&.
28940
28941 .vitem &%mksd%&
28942 .cindex "virus scanners" "mksd"
28943 This is a daemon type scanner that is aimed mainly at Polish users, though some
28944 parts of documentation are now available in English. You can get it at
28945 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28946 the maximum number of processes used simultaneously to scan the attachments,
28947 provided that the demime facility is employed and also provided that mksd has
28948 been run with at least the same number of child processes. For example:
28949 .code
28950 av_scanner = mksd:2
28951 .endd
28952 You can safely omit this option (the default value is 1).
28953
28954 .vitem &%sophie%&
28955 .cindex "virus scanners" "Sophos and Sophie"
28956 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28957 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28958 for this scanner type is the path to the UNIX socket that Sophie uses for
28959 client communication. For example:
28960 .code
28961 av_scanner = sophie:/tmp/sophie
28962 .endd
28963 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28964 the option.
28965 .endlist
28966
28967 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28968 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
28969 ACL.
28970
28971 The &%av_scanner%& option is expanded each time &%malware%& is called. This
28972 makes it possible to use different scanners. See further below for an example.
28973 The &%malware%& condition caches its results, so when you use it multiple times
28974 for the same message, the actual scanning process is only carried out once.
28975 However, using expandable items in &%av_scanner%& disables this caching, in
28976 which case each use of the &%malware%& condition causes a new scan of the
28977 message.
28978
28979 The &%malware%& condition takes a right-hand argument that is expanded before
28980 use. It can then be one of
28981
28982 .ilist
28983 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
28984 The condition succeeds if a virus was found, and fail otherwise. This is the
28985 recommended usage.
28986 .next
28987 &"false"& or &"0"& or an empty string, in which case no scanning is done and
28988 the condition fails immediately.
28989 .next
28990 A regular expression, in which case the message is scanned for viruses. The
28991 condition succeeds if a virus is found and its name matches the regular
28992 expression. This allows you to take special actions on certain types of virus.
28993 .endlist
28994
28995 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
28996 even if there is a problem with the virus scanner. Otherwise, such a problem
28997 causes the ACL to defer.
28998
28999 .vindex "&$malware_name$&"
29000 When a virus is found, the condition sets up an expansion variable called
29001 &$malware_name$& that contains the name of the virus. You can use it in a
29002 &%message%& modifier that specifies the error returned to the sender, and/or in
29003 logging data.
29004
29005 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29006 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29007 &%malware%& condition.
29008
29009 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29010 imposed by your anti-virus scanner.
29011
29012 Here is a very simple scanning example:
29013 .code
29014 deny message = This message contains malware ($malware_name)
29015      demime = *
29016      malware = *
29017 .endd
29018 The next example accepts messages when there is a problem with the scanner:
29019 .code
29020 deny message = This message contains malware ($malware_name)
29021      demime = *
29022      malware = */defer_ok
29023 .endd
29024 The next example shows how to use an ACL variable to scan with both sophie and
29025 aveserver. It assumes you have set:
29026 .code
29027 av_scanner = $acl_m0
29028 .endd
29029 in the main Exim configuration.
29030 .code
29031 deny message = This message contains malware ($malware_name)
29032      set acl_m0 = sophie
29033      malware = *
29034
29035 deny message = This message contains malware ($malware_name)
29036      set acl_m0 = aveserver
29037      malware = *
29038 .endd
29039
29040
29041 .section "Scanning with SpamAssassin" "SECTscanspamass"
29042 .cindex "content scanning" "for spam"
29043 .cindex "spam scanning"
29044 .cindex "SpamAssassin"
29045 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29046 score and a report for the message. You can get SpamAssassin at
29047 &url(http://www.spamassassin.org), or, if you have a working Perl
29048 installation, you can use CPAN by running:
29049 .code
29050 perl -MCPAN -e 'install Mail::SpamAssassin'
29051 .endd
29052 SpamAssassin has its own set of configuration files. Please review its
29053 documentation to see how you can tweak it. The default installation should work
29054 nicely, however.
29055
29056 .oindex "&%spamd_address%&"
29057 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29058 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29059 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29060 part of the Exim configuration as follows (example):
29061 .code
29062 spamd_address = 192.168.99.45 387
29063 .endd
29064 You do not need to set this option if you use the default. As of version 2.60,
29065 &%spamd%& also supports communication over UNIX sockets. If you want to use
29066 these, supply &%spamd_address%& with an absolute file name instead of a
29067 address/port pair:
29068 .code
29069 spamd_address = /var/run/spamd_socket
29070 .endd
29071 You can have multiple &%spamd%& servers to improve scalability. These can
29072 reside on other hardware reachable over the network. To specify multiple
29073 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29074 option, separated with colons:
29075 .code
29076 spamd_address = 192.168.2.10 783 : \
29077                 192.168.2.11 783 : \
29078                 192.168.2.12 783
29079 .endd
29080 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29081 fashion. When a server fails to respond to the connection attempt, all other
29082 servers are tried until one succeeds. If no server responds, the &%spam%&
29083 condition defers.
29084
29085 &*Warning*&: It is not possible to use the UNIX socket connection method with
29086 multiple &%spamd%& servers.
29087
29088 The &%spamd_address%& variable is expanded before use if it starts with
29089 a dollar sign. In this case, the expansion may return a string that is
29090 used as the list so that multiple spamd servers can be the result of an
29091 expansion.
29092
29093 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29094 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29095 .code
29096 deny message = This message was classified as SPAM
29097      spam = joe
29098 .endd
29099 The right-hand side of the &%spam%& condition specifies a name. This is
29100 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29101 to scan using a specific profile, but rather use the SpamAssassin system-wide
29102 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29103 However, you must put something on the right-hand side.
29104
29105 The name allows you to use per-domain or per-user antispam profiles in
29106 principle, but this is not straightforward in practice, because a message may
29107 have multiple recipients, not necessarily all in the same domain. Because the
29108 &%spam%& condition has to be called from a DATA ACL in order to be able to
29109 read the contents of the message, the variables &$local_part$& and &$domain$&
29110 are not set.
29111
29112 The right-hand side of the &%spam%& condition is expanded before being used, so
29113 you can put lookups or conditions there. When the right-hand side evaluates to
29114 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29115
29116
29117 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29118 large ones may cause significant performance degradation. As most spam messages
29119 are quite small, it is recommended that you do not scan the big ones. For
29120 example:
29121 .code
29122 deny message = This message was classified as SPAM
29123      condition = ${if < {$message_size}{10K}}
29124      spam = nobody
29125 .endd
29126
29127 The &%spam%& condition returns true if the threshold specified in the user's
29128 SpamAssassin profile has been matched or exceeded. If you want to use the
29129 &%spam%& condition for its side effects (see the variables below), you can make
29130 it always return &"true"& by appending &`:true`& to the username.
29131
29132 .cindex "spam scanning" "returned variables"
29133 When the &%spam%& condition is run, it sets up a number of expansion
29134 variables. These variables are saved with the received message, thus they are
29135 available for use at delivery time.
29136
29137 .vlist
29138 .vitem &$spam_score$&
29139 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29140 for inclusion in log or reject messages.
29141
29142 .vitem &$spam_score_int$&
29143 The spam score of the message, multiplied by ten, as an integer value. For
29144 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29145 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29146 The integer value is useful for numeric comparisons in conditions.
29147
29148 .vitem &$spam_bar$&
29149 A string consisting of a number of &"+"& or &"-"& characters, representing the
29150 integer part of the spam score value. A spam score of 4.4 would have a
29151 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29152 headers, since MUAs can match on such strings.
29153
29154 .vitem &$spam_report$&
29155 A multiline text table, containing the full SpamAssassin report for the
29156 message. Useful for inclusion in headers or reject messages.
29157 .endlist
29158
29159 The &%spam%& condition caches its results unless expansion in
29160 spamd_address was used. If you call it again with the same user name, it
29161 does not scan again, but rather returns the same values as before.
29162
29163 The &%spam%& condition returns DEFER if there is any error while running
29164 the message through SpamAssassin or if the expansion of spamd_address
29165 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29166 statement block), append &`/defer_ok`& to the right-hand side of the
29167 spam condition, like this:
29168 .code
29169 deny message = This message was classified as SPAM
29170      spam    = joe/defer_ok
29171 .endd
29172 This causes messages to be accepted even if there is a problem with &%spamd%&.
29173
29174 Here is a longer, commented example of the use of the &%spam%&
29175 condition:
29176 .code
29177 # put headers in all messages (no matter if spam or not)
29178 warn  spam = nobody:true
29179       add_header = X-Spam-Score: $spam_score ($spam_bar)
29180       add_header = X-Spam-Report: $spam_report
29181
29182 # add second subject line with *SPAM* marker when message
29183 # is over threshold
29184 warn  spam = nobody
29185       add_header = Subject: *SPAM* $h_Subject:
29186
29187 # reject spam at high scores (> 12)
29188 deny  message = This message scored $spam_score spam points.
29189       spam = nobody:true
29190       condition = ${if >{$spam_score_int}{120}{1}{0}}
29191 .endd
29192
29193
29194
29195 .section "Scanning MIME parts" "SECTscanmimepart"
29196 .cindex "content scanning" "MIME parts"
29197 .cindex "MIME content scanning"
29198 .oindex "&%acl_smtp_mime%&"
29199 .oindex "&%acl_not_smtp_mime%&"
29200 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29201 each MIME part of an SMTP message, including multipart types, in the sequence
29202 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29203 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29204 options may both refer to the same ACL if you want the same processing in both
29205 cases.
29206
29207 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29208 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29209 the case of a non-SMTP message. However, a MIME ACL is called only if the
29210 message contains a &'Content-Type:'& header line. When a call to a MIME
29211 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29212 result code is sent to the client. In the case of an SMTP message, the
29213 &%acl_smtp_data%& ACL is not called when this happens.
29214
29215 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29216 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29217 condition to match against the raw MIME part. You can also use the
29218 &%mime_regex%& condition to match against the decoded MIME part (see section
29219 &<<SECTscanregex>>&).
29220
29221 At the start of a MIME ACL, a number of variables are set from the header
29222 information for the relevant MIME part. These are described below. The contents
29223 of the MIME part are not by default decoded into a disk file except for MIME
29224 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29225 part into a disk file, you can use the &%decode%& condition. The general
29226 syntax is:
29227 .display
29228 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29229 .endd
29230 The right hand side is expanded before use. After expansion,
29231 the value can be:
29232
29233 .olist
29234 &"0"& or &"false"&, in which case no decoding is done.
29235 .next
29236 The string &"default"&. In that case, the file is put in the temporary
29237 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29238 a sequential file name consisting of the message id and a sequence number. The
29239 full path and name is available in &$mime_decoded_filename$& after decoding.
29240 .next
29241 A full path name starting with a slash. If the full name is an existing
29242 directory, it is used as a replacement for the default directory. The filename
29243 is then sequentially assigned. If the path does not exist, it is used as
29244 the full path and file name.
29245 .next
29246 If the string does not start with a slash, it is used as the
29247 filename, and the default path is then used.
29248 .endlist
29249 The &%decode%& condition normally succeeds. It is only false for syntax
29250 errors or unusual circumstances such as memory shortages. You can easily decode
29251 a file with its original, proposed filename using
29252 .code
29253 decode = $mime_filename
29254 .endd
29255 However, you should keep in mind that &$mime_filename$& might contain
29256 anything. If you place files outside of the default path, they are not
29257 automatically unlinked.
29258
29259 For RFC822 attachments (these are messages attached to messages, with a
29260 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29261 as for the primary message, only that the &$mime_is_rfc822$& expansion
29262 variable is set (see below). Attached messages are always decoded to disk
29263 before being checked, and the files are unlinked once the check is done.
29264
29265 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29266 used to match regular expressions against raw and decoded MIME parts,
29267 respectively. They are described in section &<<SECTscanregex>>&.
29268
29269 .cindex "MIME content scanning" "returned variables"
29270 The following list describes all expansion variables that are
29271 available in the MIME ACL:
29272
29273 .vlist
29274 .vitem &$mime_boundary$&
29275 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29276 have a boundary string, which is stored in this variable. If the current part
29277 has no boundary parameter in the &'Content-Type:'& header, this variable
29278 contains the empty string.
29279
29280 .vitem &$mime_charset$&
29281 This variable contains the character set identifier, if one was found in the
29282 &'Content-Type:'& header. Examples for charset identifiers are:
29283 .code
29284 us-ascii
29285 gb2312 (Chinese)
29286 iso-8859-1
29287 .endd
29288 Please note that this value is not normalized, so you should do matches
29289 case-insensitively.
29290
29291 .vitem &$mime_content_description$&
29292 This variable contains the normalized content of the &'Content-Description:'&
29293 header. It can contain a human-readable description of the parts content. Some
29294 implementations repeat the filename for attachments here, but they are usually
29295 only used for display purposes.
29296
29297 .vitem &$mime_content_disposition$&
29298 This variable contains the normalized content of the &'Content-Disposition:'&
29299 header. You can expect strings like &"attachment"& or &"inline"& here.
29300
29301 .vitem &$mime_content_id$&
29302 This variable contains the normalized content of the &'Content-ID:'& header.
29303 This is a unique ID that can be used to reference a part from another part.
29304
29305 .vitem &$mime_content_size$&
29306 This variable is set only after the &%decode%& modifier (see above) has been
29307 successfully run. It contains the size of the decoded part in kilobytes. The
29308 size is always rounded up to full kilobytes, so only a completely empty part
29309 has a &$mime_content_size$& of zero.
29310
29311 .vitem &$mime_content_transfer_encoding$&
29312 This variable contains the normalized content of the
29313 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
29314 type. Typical values are &"base64"& and &"quoted-printable"&.
29315
29316 .vitem &$mime_content_type$&
29317 If the MIME part has a &'Content-Type:'& header, this variable contains its
29318 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
29319 are some examples of popular MIME types, as they may appear in this variable:
29320 .code
29321 text/plain
29322 text/html
29323 application/octet-stream
29324 image/jpeg
29325 audio/midi
29326 .endd
29327 If the MIME part has no &'Content-Type:'& header, this variable contains the
29328 empty string.
29329
29330 .vitem &$mime_decoded_filename$&
29331 This variable is set only after the &%decode%& modifier (see above) has been
29332 successfully run. It contains the full path and file name of the file
29333 containing the decoded data.
29334 .endlist
29335
29336 .cindex "RFC 2047"
29337 .vlist
29338 .vitem &$mime_filename$&
29339 This is perhaps the most important of the MIME variables. It contains a
29340 proposed filename for an attachment, if one was found in either the
29341 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
29342 RFC2047 decoded, but no additional sanity checks are done. If no filename was
29343 found, this variable contains the empty string.
29344
29345 .vitem &$mime_is_coverletter$&
29346 This variable attempts to differentiate the &"cover letter"& of an e-mail from
29347 attached data. It can be used to clamp down on flashy or unnecessarily encoded
29348 content in the cover letter, while not restricting attachments at all.
29349
29350 The variable contains 1 (true) for a MIME part believed to be part of the
29351 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
29352 follows:
29353
29354 .olist
29355 The outermost MIME part of a message is always a cover letter.
29356
29357 .next
29358 If a multipart/alternative or multipart/related MIME part is a cover letter,
29359 so are all MIME subparts within that multipart.
29360
29361 .next
29362 If any other multipart is a cover letter, the first subpart is a cover letter,
29363 and the rest are attachments.
29364
29365 .next
29366 All parts contained within an attachment multipart are attachments.
29367 .endlist olist
29368
29369 As an example, the following will ban &"HTML mail"& (including that sent with
29370 alternative plain text), while allowing HTML files to be attached. HTML
29371 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
29372 .code
29373 deny message = HTML mail is not accepted here
29374 !condition = $mime_is_rfc822
29375 condition = $mime_is_coverletter
29376 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
29377 .endd
29378 .vitem &$mime_is_multipart$&
29379 This variable has the value 1 (true) when the current part has the main type
29380 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
29381 Since multipart entities only serve as containers for other parts, you may not
29382 want to carry out specific actions on them.
29383
29384 .vitem &$mime_is_rfc822$&
29385 This variable has the value 1 (true) if the current part is not a part of the
29386 checked message itself, but part of an attached message. Attached message
29387 decoding is fully recursive.
29388
29389 .vitem &$mime_part_count$&
29390 This variable is a counter that is raised for each processed MIME part. It
29391 starts at zero for the very first part (which is usually a multipart). The
29392 counter is per-message, so it is reset when processing RFC822 attachments (see
29393 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
29394 complete, so you can use it in the DATA ACL to determine the number of MIME
29395 parts of a message. For non-MIME messages, this variable contains the value -1.
29396 .endlist
29397
29398
29399
29400 .section "Scanning with regular expressions" "SECTscanregex"
29401 .cindex "content scanning" "with regular expressions"
29402 .cindex "regular expressions" "content scanning with"
29403 You can specify your own custom regular expression matches on the full body of
29404 the message, or on individual MIME parts.
29405
29406 The &%regex%& condition takes one or more regular expressions as arguments and
29407 matches them against the full message (when called in the DATA ACL) or a raw
29408 MIME part (when called in the MIME ACL). The &%regex%& condition matches
29409 linewise, with a maximum line length of 32K characters. That means you cannot
29410 have multiline matches with the &%regex%& condition.
29411
29412 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
29413 to 32K of decoded content (the whole content at once, not linewise). If the
29414 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
29415 is decoded automatically when &%mime_regex%& is executed (using default path
29416 and filename values). If the decoded data is larger than  32K, only the first
29417 32K characters are checked.
29418
29419 The regular expressions are passed as a colon-separated list. To include a
29420 literal colon, you must double it. Since the whole right-hand side string is
29421 expanded before being used, you must also escape dollar signs and backslashes
29422 with more backslashes, or use the &`\N`& facility to disable expansion.
29423 Here is a simple example that contains two regular expressions:
29424 .code
29425 deny message = contains blacklisted regex ($regex_match_string)
29426      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
29427 .endd
29428 The conditions returns true if any one of the regular expressions matches. The
29429 &$regex_match_string$& expansion variable is then set up and contains the
29430 matching regular expression.
29431
29432 &*Warning*&: With large messages, these conditions can be fairly
29433 CPU-intensive.
29434
29435
29436
29437
29438 .section "The demime condition" "SECTdemimecond"
29439 .cindex "content scanning" "MIME checking"
29440 .cindex "MIME content scanning"
29441 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
29442 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
29443 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
29444 ACL functionality, but provides no additional facilities. Please note that this
29445 condition is deprecated and kept only for backward compatibility. You must set
29446 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
29447 use the &%demime%& condition.
29448
29449 The &%demime%& condition unpacks MIME containers in the message. It detects
29450 errors in MIME containers and can match file extensions found in the message
29451 against a list. Using this facility produces files containing the unpacked MIME
29452 parts of the message in the temporary scan directory. If you do antivirus
29453 scanning, it is recommended that you use the &%demime%& condition before the
29454 antivirus (&%malware%&) condition.
29455
29456 On the right-hand side of the &%demime%& condition you can pass a
29457 colon-separated list of file extensions that it should match against. For
29458 example:
29459 .code
29460 deny message = Found blacklisted file attachment
29461      demime  = vbs:com:bat:pif:prf:lnk
29462 .endd
29463 If one of the file extensions is found, the condition is true, otherwise it is
29464 false. If there is a temporary error while demimeing (for example, &"disk
29465 full"&), the condition defers, and the message is temporarily rejected (unless
29466 the condition is on a &%warn%& verb).
29467
29468 The right-hand side is expanded before being treated as a list, so you can have
29469 conditions and lookups there. If it expands to an empty string, &"false"&, or
29470 zero (&"0"&), no demimeing is done and the condition is false.
29471
29472 The &%demime%& condition set the following variables:
29473
29474 .vlist
29475 .vitem &$demime_errorlevel$&
29476 .vindex "&$demime_errorlevel$&"
29477 When an error is detected in a MIME container, this variable contains the
29478 severity of the error, as an integer number. The higher the value, the more
29479 severe the error (the current maximum value is 3). If this variable is unset or
29480 zero, no error occurred.
29481
29482 .vitem &$demime_reason$&
29483 .vindex "&$demime_reason$&"
29484 When &$demime_errorlevel$& is greater than zero, this variable contains a
29485 human-readable text string describing the MIME error that occurred.
29486 .endlist
29487
29488 .vlist
29489 .vitem &$found_extension$&
29490 .vindex "&$found_extension$&"
29491 When the &%demime%& condition is true, this variable contains the file
29492 extension it found.
29493 .endlist
29494
29495 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
29496 the &%demime%& condition, and are not changed on subsequent calls.
29497
29498 If you do not want to check for file extensions, but rather use the &%demime%&
29499 condition for unpacking or error checking purposes, pass &"*"& as the
29500 right-hand side value. Here is a more elaborate example of how to use this
29501 facility:
29502 .code
29503 # Reject messages with serious MIME container errors
29504 deny  message = Found MIME error ($demime_reason).
29505       demime = *
29506       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
29507
29508 # Reject known virus spreading file extensions.
29509 # Accepting these is pretty much braindead.
29510 deny  message = contains $found_extension file (blacklisted).
29511       demime  = com:vbs:bat:pif:scr
29512
29513 # Freeze .exe and .doc files. Postmaster can
29514 # examine them and eventually thaw them.
29515 deny  log_message = Another $found_extension file.
29516       demime = exe:doc
29517       control = freeze
29518 .endd
29519 .ecindex IIDcosca
29520
29521
29522
29523
29524 . ////////////////////////////////////////////////////////////////////////////
29525 . ////////////////////////////////////////////////////////////////////////////
29526
29527 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
29528          "Local scan function"
29529 .scindex IIDlosca "&[local_scan()]& function" "description of"
29530 .cindex "customizing" "input scan using C function"
29531 .cindex "policy control" "by local scan function"
29532 In these days of email worms, viruses, and ever-increasing spam, some sites
29533 want to apply a lot of checking to messages before accepting them.
29534
29535 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
29536 passing messages to external virus and spam scanning software. You can also do
29537 a certain amount in Exim itself through string expansions and the &%condition%&
29538 condition in the ACL that runs after the SMTP DATA command or the ACL for
29539 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
29540
29541 To allow for further customization to a site's own requirements, there is the
29542 possibility of linking Exim with a private message scanning function, written
29543 in C. If you want to run code that is written in something other than C, you
29544 can of course use a little C stub to call it.
29545
29546 The local scan function is run once for every incoming message, at the point
29547 when Exim is just about to accept the message.
29548 It can therefore be used to control non-SMTP messages from local processes as
29549 well as messages arriving via SMTP.
29550
29551 Exim applies a timeout to calls of the local scan function, and there is an
29552 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
29553 Zero means &"no timeout"&.
29554 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
29555 before calling the local scan function, so that the most common types of crash
29556 are caught. If the timeout is exceeded or one of those signals is caught, the
29557 incoming message is rejected with a temporary error if it is an SMTP message.
29558 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
29559 code. The incident is logged on the main and reject logs.
29560
29561
29562
29563 .section "Building Exim to use a local scan function" "SECID207"
29564 .cindex "&[local_scan()]& function" "building Exim to use"
29565 To make use of the local scan function feature, you must tell Exim where your
29566 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
29567 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
29568 directory, so you might set
29569 .code
29570 LOCAL_SCAN_SOURCE=Local/local_scan.c
29571 .endd
29572 for example. The function must be called &[local_scan()]&. It is called by
29573 Exim after it has received a message, when the success return code is about to
29574 be sent. This is after all the ACLs have been run. The return code from your
29575 function controls whether the message is actually accepted or not. There is a
29576 commented template function (that just accepts the message) in the file
29577 _src/local_scan.c_.
29578
29579 If you want to make use of Exim's run time configuration file to set options
29580 for your &[local_scan()]& function, you must also set
29581 .code
29582 LOCAL_SCAN_HAS_OPTIONS=yes
29583 .endd
29584 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
29585
29586
29587
29588
29589 .section "API for local_scan()" "SECTapiforloc"
29590 .cindex "&[local_scan()]& function" "API description"
29591 You must include this line near the start of your code:
29592 .code
29593 #include "local_scan.h"
29594 .endd
29595 This header file defines a number of variables and other values, and the
29596 prototype for the function itself. Exim is coded to use unsigned char values
29597 almost exclusively, and one of the things this header defines is a shorthand
29598 for &`unsigned char`& called &`uschar`&.
29599 It also contains the following macro definitions, to simplify casting character
29600 strings and pointers to character strings:
29601 .code
29602 #define CS   (char *)
29603 #define CCS  (const char *)
29604 #define CSS  (char **)
29605 #define US   (unsigned char *)
29606 #define CUS  (const unsigned char *)
29607 #define USS  (unsigned char **)
29608 .endd
29609 The function prototype for &[local_scan()]& is:
29610 .code
29611 extern int local_scan(int fd, uschar **return_text);
29612 .endd
29613 The arguments are as follows:
29614
29615 .ilist
29616 &%fd%& is a file descriptor for the file that contains the body of the message
29617 (the -D file). The file is open for reading and writing, but updating it is not
29618 recommended. &*Warning*&: You must &'not'& close this file descriptor.
29619
29620 The descriptor is positioned at character 19 of the file, which is the first
29621 character of the body itself, because the first 19 characters are the message
29622 id followed by &`-D`& and a newline. If you rewind the file, you should use the
29623 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
29624 case this changes in some future version.
29625 .next
29626 &%return_text%& is an address which you can use to return a pointer to a text
29627 string at the end of the function. The value it points to on entry is NULL.
29628 .endlist
29629
29630 The function must return an &%int%& value which is one of the following macros:
29631
29632 .vlist
29633 .vitem &`LOCAL_SCAN_ACCEPT`&
29634 .vindex "&$local_scan_data$&"
29635 The message is accepted. If you pass back a string of text, it is saved with
29636 the message, and made available in the variable &$local_scan_data$&. No
29637 newlines are permitted (if there are any, they are turned into spaces) and the
29638 maximum length of text is 1000 characters.
29639
29640 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
29641 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29642 queued without immediate delivery, and is frozen.
29643
29644 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
29645 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29646 queued without immediate delivery.
29647
29648 .vitem &`LOCAL_SCAN_REJECT`&
29649 The message is rejected; the returned text is used as an error message which is
29650 passed back to the sender and which is also logged. Newlines are permitted &--
29651 they cause a multiline response for SMTP rejections, but are converted to
29652 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
29653 used.
29654
29655 .vitem &`LOCAL_SCAN_TEMPREJECT`&
29656 The message is temporarily rejected; the returned text is used as an error
29657 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
29658 problem"& is used.
29659
29660 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
29661 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
29662 message is not written to the reject log. It has the effect of unsetting the
29663 &%rejected_header%& log selector for just this rejection. If
29664 &%rejected_header%& is already unset (see the discussion of the
29665 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
29666 same as LOCAL_SCAN_REJECT.
29667
29668 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
29669 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
29670 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
29671 .endlist
29672
29673 If the message is not being received by interactive SMTP, rejections are
29674 reported by writing to &%stderr%& or by sending an email, as configured by the
29675 &%-oe%& command line options.
29676
29677
29678
29679 .section "Configuration options for local_scan()" "SECTconoptloc"
29680 .cindex "&[local_scan()]& function" "configuration options"
29681 It is possible to have option settings in the main configuration file
29682 that set values in static variables in the &[local_scan()]& module. If you
29683 want to do this, you must have the line
29684 .code
29685 LOCAL_SCAN_HAS_OPTIONS=yes
29686 .endd
29687 in your &_Local/Makefile_& when you build Exim. (This line is in
29688 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
29689 file, you must define static variables to hold the option values, and a table
29690 to define them.
29691
29692 The table must be a vector called &%local_scan_options%&, of type
29693 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
29694 and a pointer to the variable that holds the value. The entries must appear in
29695 alphabetical order. Following &%local_scan_options%& you must also define a
29696 variable called &%local_scan_options_count%& that contains the number of
29697 entries in the table. Here is a short example, showing two kinds of option:
29698 .code
29699 static int my_integer_option = 42;
29700 static uschar *my_string_option = US"a default string";
29701
29702 optionlist local_scan_options[] = {
29703   { "my_integer", opt_int,       &my_integer_option },
29704   { "my_string",  opt_stringptr, &my_string_option }
29705 };
29706
29707 int local_scan_options_count =
29708   sizeof(local_scan_options)/sizeof(optionlist);
29709 .endd
29710 The values of the variables can now be changed from Exim's runtime
29711 configuration file by including a local scan section as in this example:
29712 .code
29713 begin local_scan
29714 my_integer = 99
29715 my_string = some string of text...
29716 .endd
29717 The available types of option data are as follows:
29718
29719 .vlist
29720 .vitem &*opt_bool*&
29721 This specifies a boolean (true/false) option. The address should point to a
29722 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
29723 that are defined as &"1"& and &"0"&, respectively. If you want to detect
29724 whether such a variable has been set at all, you can initialize it to
29725 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
29726 values.)
29727
29728 .vitem &*opt_fixed*&
29729 This specifies a fixed point number, such as is used for load averages.
29730 The address should point to a variable of type &`int`&. The value is stored
29731 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
29732
29733 .vitem &*opt_int*&
29734 This specifies an integer; the address should point to a variable of type
29735 &`int`&. The value may be specified in any of the integer formats accepted by
29736 Exim.
29737
29738 .vitem &*opt_mkint*&
29739 This is the same as &%opt_int%&, except that when such a value is output in a
29740 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
29741 printed with the suffix K or M.
29742
29743 .vitem &*opt_octint*&
29744 This also specifies an integer, but the value is always interpreted as an
29745 octal integer, whether or not it starts with the digit zero, and it is
29746 always output in octal.
29747
29748 .vitem &*opt_stringptr*&
29749 This specifies a string value; the address must be a pointer to a
29750 variable that points to a string (for example, of type &`uschar *`&).
29751
29752 .vitem &*opt_time*&
29753 This specifies a time interval value. The address must point to a variable of
29754 type &`int`&. The value that is placed there is a number of seconds.
29755 .endlist
29756
29757 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
29758 out the values of all the &[local_scan()]& options.
29759
29760
29761
29762 .section "Available Exim variables" "SECID208"
29763 .cindex "&[local_scan()]& function" "available Exim variables"
29764 The header &_local_scan.h_& gives you access to a number of C variables. These
29765 are the only ones that are guaranteed to be maintained from release to release.
29766 Note, however, that you can obtain the value of any Exim expansion variable,
29767 including &$recipients$&, by calling &'expand_string()'&. The exported
29768 C variables are as follows:
29769
29770 .vlist
29771 .vitem &*int&~body_linecount*&
29772 This variable contains the number of lines in the message's body.
29773
29774 .vitem &*int&~body_zerocount*&
29775 This variable contains the number of binary zero bytes in the message's body.
29776
29777 .vitem &*unsigned&~int&~debug_selector*&
29778 This variable is set to zero when no debugging is taking place. Otherwise, it
29779 is a bitmap of debugging selectors. Two bits are identified for use in
29780 &[local_scan()]&; they are defined as macros:
29781
29782 .ilist
29783 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
29784 testing option that is not privileged &-- any caller may set it. All the
29785 other selector bits can be set only by admin users.
29786
29787 .next
29788 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
29789 by the &`+local_scan`& debug selector. It is not included in the default set
29790 of debugging bits.
29791 .endlist ilist
29792
29793 Thus, to write to the debugging output only when &`+local_scan`& has been
29794 selected, you should use code like this:
29795 .code
29796 if ((debug_selector & D_local_scan) != 0)
29797   debug_printf("xxx", ...);
29798 .endd
29799 .vitem &*uschar&~*expand_string_message*&
29800 After a failing call to &'expand_string()'& (returned value NULL), the
29801 variable &%expand_string_message%& contains the error message, zero-terminated.
29802
29803 .vitem &*header_line&~*header_list*&
29804 A pointer to a chain of header lines. The &%header_line%& structure is
29805 discussed below.
29806
29807 .vitem &*header_line&~*header_last*&
29808 A pointer to the last of the header lines.
29809
29810 .vitem &*uschar&~*headers_charset*&
29811 The value of the &%headers_charset%& configuration option.
29812
29813 .vitem &*BOOL&~host_checking*&
29814 This variable is TRUE during a host checking session that is initiated by the
29815 &%-bh%& command line option.
29816
29817 .vitem &*uschar&~*interface_address*&
29818 The IP address of the interface that received the message, as a string. This
29819 is NULL for locally submitted messages.
29820
29821 .vitem &*int&~interface_port*&
29822 The port on which this message was received. When testing with the &%-bh%&
29823 command line option, the value of this variable is -1 unless a port has been
29824 specified via the &%-oMi%& option.
29825
29826 .vitem &*uschar&~*message_id*&
29827 This variable contains Exim's message id for the incoming message (the value of
29828 &$message_exim_id$&) as a zero-terminated string.
29829
29830 .vitem &*uschar&~*received_protocol*&
29831 The name of the protocol by which the message was received.
29832
29833 .vitem &*int&~recipients_count*&
29834 The number of accepted recipients.
29835
29836 .vitem &*recipient_item&~*recipients_list*&
29837 .cindex "recipient" "adding in local scan"
29838 .cindex "recipient" "removing in local scan"
29839 The list of accepted recipients, held in a vector of length
29840 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29841 can add additional recipients by calling &'receive_add_recipient()'& (see
29842 below). You can delete recipients by removing them from the vector and
29843 adjusting the value in &%recipients_count%&. In particular, by setting
29844 &%recipients_count%& to zero you remove all recipients. If you then return the
29845 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29846 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29847 and then call &'receive_add_recipient()'& as often as needed.
29848
29849 .vitem &*uschar&~*sender_address*&
29850 The envelope sender address. For bounce messages this is the empty string.
29851
29852 .vitem &*uschar&~*sender_host_address*&
29853 The IP address of the sending host, as a string. This is NULL for
29854 locally-submitted messages.
29855
29856 .vitem &*uschar&~*sender_host_authenticated*&
29857 The name of the authentication mechanism that was used, or NULL if the message
29858 was not received over an authenticated SMTP connection.
29859
29860 .vitem &*uschar&~*sender_host_name*&
29861 The name of the sending host, if known.
29862
29863 .vitem &*int&~sender_host_port*&
29864 The port on the sending host.
29865
29866 .vitem &*BOOL&~smtp_input*&
29867 This variable is TRUE for all SMTP input, including BSMTP.
29868
29869 .vitem &*BOOL&~smtp_batched_input*&
29870 This variable is TRUE for BSMTP input.
29871
29872 .vitem &*int&~store_pool*&
29873 The contents of this variable control which pool of memory is used for new
29874 requests. See section &<<SECTmemhanloc>>& for details.
29875 .endlist
29876
29877
29878 .section "Structure of header lines" "SECID209"
29879 The &%header_line%& structure contains the members listed below.
29880 You can add additional header lines by calling the &'header_add()'& function
29881 (see below). You can cause header lines to be ignored (deleted) by setting
29882 their type to *.
29883
29884
29885 .vlist
29886 .vitem &*struct&~header_line&~*next*&
29887 A pointer to the next header line, or NULL for the last line.
29888
29889 .vitem &*int&~type*&
29890 A code identifying certain headers that Exim recognizes. The codes are printing
29891 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29892 Notice in particular that any header line whose type is * is not transmitted
29893 with the message. This flagging is used for header lines that have been
29894 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29895 lines.) Effectively, * means &"deleted"&.
29896
29897 .vitem &*int&~slen*&
29898 The number of characters in the header line, including the terminating and any
29899 internal newlines.
29900
29901 .vitem &*uschar&~*text*&
29902 A pointer to the text of the header. It always ends with a newline, followed by
29903 a zero byte. Internal newlines are preserved.
29904 .endlist
29905
29906
29907
29908 .section "Structure of recipient items" "SECID210"
29909 The &%recipient_item%& structure contains these members:
29910
29911 .vlist
29912 .vitem &*uschar&~*address*&
29913 This is a pointer to the recipient address as it was received.
29914
29915 .vitem &*int&~pno*&
29916 This is used in later Exim processing when top level addresses are created by
29917 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29918 and must always contain -1 at this stage.
29919
29920 .vitem &*uschar&~*errors_to*&
29921 If this value is not NULL, bounce messages caused by failing to deliver to the
29922 recipient are sent to the address it contains. In other words, it overrides the
29923 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29924 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29925 an unqualified address, Exim qualifies it using the domain from
29926 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29927 is NULL for all recipients.
29928 .endlist
29929
29930
29931
29932 .section "Available Exim functions" "SECID211"
29933 .cindex "&[local_scan()]& function" "available Exim functions"
29934 The header &_local_scan.h_& gives you access to a number of Exim functions.
29935 These are the only ones that are guaranteed to be maintained from release to
29936 release:
29937
29938 .vlist
29939 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29940        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29941
29942 This function creates a child process that runs the command specified by
29943 &%argv%&. The environment for the process is specified by &%envp%&, which can
29944 be NULL if no environment variables are to be passed. A new umask is supplied
29945 for the process in &%newumask%&.
29946
29947 Pipes to the standard input and output of the new process are set up
29948 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29949 standard error is cloned to the standard output. If there are any file
29950 descriptors &"in the way"& in the new process, they are closed. If the final
29951 argument is TRUE, the new process is made into a process group leader.
29952
29953 The function returns the pid of the new process, or -1 if things go wrong.
29954
29955 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29956 This function waits for a child process to terminate, or for a timeout (in
29957 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29958 return value is as follows:
29959
29960 .ilist
29961 >= 0
29962
29963 The process terminated by a normal exit and the value is the process
29964 ending status.
29965
29966 .next
29967 < 0 and > &--256
29968
29969 The process was terminated by a signal and the value is the negation of the
29970 signal number.
29971
29972 .next
29973 &--256
29974
29975 The process timed out.
29976 .next
29977 &--257
29978
29979 The was some other error in wait(); &%errno%& is still set.
29980 .endlist
29981
29982 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
29983 This function provide you with a means of submitting a new message to
29984 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
29985 want, but this packages it all up for you.) The function creates a pipe,
29986 forks a subprocess that is running
29987 .code
29988 exim -t -oem -oi -f <>
29989 .endd
29990 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
29991 that is connected to the standard input. The yield of the function is the PID
29992 of the subprocess. You can then write a message to the file descriptor, with
29993 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
29994
29995 When you have finished, call &'child_close()'& to wait for the process to
29996 finish and to collect its ending status. A timeout value of zero is usually
29997 fine in this circumstance. Unless you have made a mistake with the recipient
29998 addresses, you should get a return code of zero.
29999
30000
30001 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30002        *sender_authentication)*&
30003 This function is a more sophisticated version of &'child_open()'&. The command
30004 that it runs is:
30005 .display
30006 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30007 .endd
30008 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30009
30010
30011 .vitem &*void&~debug_printf(char&~*,&~...)*&
30012 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30013 output is written to the standard error stream. If no debugging is selected,
30014 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30015 conditional on the &`local_scan`& debug selector by coding like this:
30016 .code
30017 if ((debug_selector & D_local_scan) != 0)
30018   debug_printf("xxx", ...);
30019 .endd
30020
30021 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30022 This is an interface to Exim's string expansion code. The return value is the
30023 expanded string, or NULL if there was an expansion failure.
30024 The C variable &%expand_string_message%& contains an error message after an
30025 expansion failure. If expansion does not change the string, the return value is
30026 the pointer to the input string. Otherwise, the return value points to a new
30027 block of memory that was obtained by a call to &'store_get()'&. See section
30028 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30029
30030 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30031 This function allows you to an add additional header line at the end of the
30032 existing ones. The first argument is the type, and should normally be a space
30033 character. The second argument is a format string and any number of
30034 substitution arguments as for &[sprintf()]&. You may include internal newlines
30035 if you want, and you must ensure that the string ends with a newline.
30036
30037 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30038         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30039 This function adds a new header line at a specified point in the header
30040 chain. The header itself is specified as for &'header_add()'&.
30041
30042 If &%name%& is NULL, the new header is added at the end of the chain if
30043 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30044 NULL, the header lines are searched for the first non-deleted header that
30045 matches the name. If one is found, the new header is added before it if
30046 &%after%& is false. If &%after%& is true, the new header is added after the
30047 found header and any adjacent subsequent ones with the same name (even if
30048 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30049 option controls where the header is added. If it is true, addition is at the
30050 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30051 headers, or at the top if there are no &'Received:'& headers, you could use
30052 .code
30053 header_add_at_position(TRUE, US"Received", TRUE,
30054   ' ', "X-xxx: ...");
30055 .endd
30056 Normally, there is always at least one non-deleted &'Received:'& header, but
30057 there may not be if &%received_header_text%& expands to an empty string.
30058
30059
30060 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30061 This function removes header lines. If &%occurrence%& is zero or negative, all
30062 occurrences of the header are removed. If occurrence is greater than zero, that
30063 particular instance of the header is removed. If no header(s) can be found that
30064 match the specification, the function does nothing.
30065
30066
30067 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30068         int&~length,&~BOOL&~notdel)*&"
30069 This function tests whether the given header has the given name. It is not just
30070 a string comparison, because white space is permitted between the name and the
30071 colon. If the &%notdel%& argument is true, a false return is forced for all
30072 &"deleted"& headers; otherwise they are not treated specially. For example:
30073 .code
30074 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30075 .endd
30076 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30077 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30078 This function base64-encodes a string, which is passed by address and length.
30079 The text may contain bytes of any value, including zero. The result is passed
30080 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30081 zero-terminated.
30082
30083 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30084 This function decodes a base64-encoded string. Its arguments are a
30085 zero-terminated base64-encoded string and the address of a variable that is set
30086 to point to the result, which is in dynamic memory. The length of the decoded
30087 string is the yield of the function. If the input is invalid base64 data, the
30088 yield is -1. A zero byte is added to the end of the output string to make it
30089 easy to interpret as a C string (assuming it contains no zeros of its own). The
30090 added zero byte is not included in the returned count.
30091
30092 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30093 This function checks for a match in a domain list. Domains are always
30094 matched caselessly. The return value is one of the following:
30095 .display
30096 &`OK     `& match succeeded
30097 &`FAIL   `& match failed
30098 &`DEFER  `& match deferred
30099 .endd
30100 DEFER is usually caused by some kind of lookup defer, such as the
30101 inability to contact a database.
30102
30103 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30104         BOOL&~caseless)*&"
30105 This function checks for a match in a local part list. The third argument
30106 controls case-sensitivity. The return values are as for
30107 &'lss_match_domain()'&.
30108
30109 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30110         BOOL&~caseless)*&"
30111 This function checks for a match in an address list. The third argument
30112 controls the case-sensitivity of the local part match. The domain is always
30113 matched caselessly. The return values are as for &'lss_match_domain()'&.
30114
30115 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30116         uschar&~*list)*&"
30117 This function checks for a match in a host list. The most common usage is
30118 expected to be
30119 .code
30120 lss_match_host(sender_host_name, sender_host_address, ...)
30121 .endd
30122 .vindex "&$sender_host_address$&"
30123 An empty address field matches an empty item in the host list. If the host name
30124 is NULL, the name corresponding to &$sender_host_address$& is automatically
30125 looked up if a host name is required to match an item in the list. The return
30126 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30127 returns ERROR in the case when it had to look up a host name, but the lookup
30128 failed.
30129
30130 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30131         *format,&~...)*&"
30132 This function writes to Exim's log files. The first argument should be zero (it
30133 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30134 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30135 them. It specifies to which log or logs the message is written. The remaining
30136 arguments are a format and relevant insertion arguments. The string should not
30137 contain any newlines, not even at the end.
30138
30139
30140 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30141 This function adds an additional recipient to the message. The first argument
30142 is the recipient address. If it is unqualified (has no domain), it is qualified
30143 with the &%qualify_recipient%& domain. The second argument must always be -1.
30144
30145 This function does not allow you to specify a private &%errors_to%& address (as
30146 described with the structure of &%recipient_item%& above), because it pre-dates
30147 the addition of that field to the structure. However, it is easy to add such a
30148 value afterwards. For example:
30149 .code
30150  receive_add_recipient(US"monitor@mydom.example", -1);
30151  recipients_list[recipients_count-1].errors_to =
30152    US"postmaster@mydom.example";
30153 .endd
30154
30155 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30156 This is a convenience function to remove a named recipient from the list of
30157 recipients. It returns true if a recipient was removed, and false if no
30158 matching recipient could be found. The argument must be a complete email
30159 address.
30160 .endlist
30161
30162
30163 .cindex "RFC 2047"
30164 .vlist
30165 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30166   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30167 This function decodes strings that are encoded according to RFC 2047. Typically
30168 these are the contents of header lines. First, each &"encoded word"& is decoded
30169 from the Q or B encoding into a byte-string. Then, if provided with the name of
30170 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30171 made  to translate the result to the named character set. If this fails, the
30172 binary string is returned with an error message.
30173
30174 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30175 maximum MIME word length is enforced. The third argument is the target
30176 encoding, or NULL if no translation is wanted.
30177
30178 .cindex "binary zero" "in RFC 2047 decoding"
30179 .cindex "RFC 2047" "binary zero in"
30180 If a binary zero is encountered in the decoded string, it is replaced by the
30181 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30182 not be 0 because header lines are handled as zero-terminated strings.
30183
30184 The function returns the result of processing the string, zero-terminated; if
30185 &%lenptr%& is not NULL, the length of the result is set in the variable to
30186 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30187
30188 If an error is encountered, the function returns NULL and uses the &%error%&
30189 argument to return an error message. The variable pointed to by &%error%& is
30190 set to NULL if there is no error; it may be set non-NULL even when the function
30191 returns a non-NULL value if decoding was successful, but there was a problem
30192 with translation.
30193
30194
30195 .vitem &*int&~smtp_fflush(void)*&
30196 This function is used in conjunction with &'smtp_printf()'&, as described
30197 below.
30198
30199 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30200 The arguments of this function are like &[printf()]&; it writes to the SMTP
30201 output stream. You should use this function only when there is an SMTP output
30202 stream, that is, when the incoming message is being received via interactive
30203 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30204 is FALSE. If you want to test for an incoming message from another host (as
30205 opposed to a local process that used the &%-bs%& command line option), you can
30206 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30207 is involved.
30208
30209 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30210 output function, so it can be used for all forms of SMTP connection.
30211
30212 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30213 must start with an appropriate response code: 550 if you are going to return
30214 LOCAL_SCAN_REJECT, 451 if you are going to return
30215 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30216 initial lines of a multi-line response, the code must be followed by a hyphen
30217 to indicate that the line is not the final response line. You must also ensure
30218 that the lines you write terminate with CRLF. For example:
30219 .code
30220 smtp_printf("550-this is some extra info\r\n");
30221 return LOCAL_SCAN_REJECT;
30222 .endd
30223 Note that you can also create multi-line responses by including newlines in
30224 the data returned via the &%return_text%& argument. The added value of using
30225 &'smtp_printf()'& is that, for instance, you could introduce delays between
30226 multiple output lines.
30227
30228 The &'smtp_printf()'& function does not return any error indication, because it
30229 does not automatically flush pending output, and therefore does not test
30230 the state of the stream. (In the main code of Exim, flushing and error
30231 detection is done when Exim is ready for the next SMTP input command.) If
30232 you want to flush the output and check for an error (for example, the
30233 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30234 arguments. It flushes the output stream, and returns a non-zero value if there
30235 is an error.
30236
30237 .vitem &*void&~*store_get(int)*&
30238 This function accesses Exim's internal store (memory) manager. It gets a new
30239 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30240 runs out of memory. See the next section for a discussion of memory handling.
30241
30242 .vitem &*void&~*store_get_perm(int)*&
30243 This function is like &'store_get()'&, but it always gets memory from the
30244 permanent pool. See the next section for a discussion of memory handling.
30245
30246 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30247 See below.
30248
30249 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30250 See below.
30251
30252 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30253 These three functions create strings using Exim's dynamic memory facilities.
30254 The first makes a copy of an entire string. The second copies up to a maximum
30255 number of characters, indicated by the second argument. The third uses a format
30256 and insertion arguments to create a new string. In each case, the result is a
30257 pointer to a new string in the current memory pool. See the next section for
30258 more discussion.
30259 .endlist
30260
30261
30262
30263 .section "More about Exim's memory handling" "SECTmemhanloc"
30264 .cindex "&[local_scan()]& function" "memory handling"
30265 No function is provided for freeing memory, because that is never needed.
30266 The dynamic memory that Exim uses when receiving a message is automatically
30267 recycled if another message is received by the same process (this applies only
30268 to incoming SMTP connections &-- other input methods can supply only one
30269 message at a time). After receiving the last message, a reception process
30270 terminates.
30271
30272 Because it is recycled, the normal dynamic memory cannot be used for holding
30273 data that must be preserved over a number of incoming messages on the same SMTP
30274 connection. However, Exim in fact uses two pools of dynamic memory; the second
30275 one is not recycled, and can be used for this purpose.
30276
30277 If you want to allocate memory that remains available for subsequent messages
30278 in the same SMTP connection, you should set
30279 .code
30280 store_pool = POOL_PERM
30281 .endd
30282 before calling the function that does the allocation. There is no need to
30283 restore the value if you do not need to; however, if you do want to revert to
30284 the normal pool, you can either restore the previous value of &%store_pool%& or
30285 set it explicitly to POOL_MAIN.
30286
30287 The pool setting applies to all functions that get dynamic memory, including
30288 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30289 There is also a convenience function called &'store_get_perm()'& that gets a
30290 block of memory from the permanent pool while preserving the value of
30291 &%store_pool%&.
30292 .ecindex IIDlosca
30293
30294
30295
30296
30297 . ////////////////////////////////////////////////////////////////////////////
30298 . ////////////////////////////////////////////////////////////////////////////
30299
30300 .chapter "System-wide message filtering" "CHAPsystemfilter"
30301 .scindex IIDsysfil1 "filter" "system filter"
30302 .scindex IIDsysfil2 "filtering all mail"
30303 .scindex IIDsysfil3 "system filter"
30304 The previous chapters (on ACLs and the local scan function) describe checks
30305 that can be applied to messages before they are accepted by a host. There is
30306 also a mechanism for checking messages once they have been received, but before
30307 they are delivered. This is called the &'system filter'&.
30308
30309 The system filter operates in a similar manner to users' filter files, but it
30310 is run just once per message (however many recipients the message has).
30311 It should not normally be used as a substitute for routing, because &%deliver%&
30312 commands in a system router provide new envelope recipient addresses.
30313 The system filter must be an Exim filter. It cannot be a Sieve filter.
30314
30315 The system filter is run at the start of a delivery attempt, before any routing
30316 is done. If a message fails to be completely delivered at the first attempt,
30317 the system filter is run again at the start of every retry.
30318 If you want your filter to do something only once per message, you can make use
30319 of the &%first_delivery%& condition in an &%if%& command in the filter to
30320 prevent it happening on retries.
30321
30322 .vindex "&$domain$&"
30323 .vindex "&$local_part$&"
30324 &*Warning*&: Because the system filter runs just once, variables that are
30325 specific to individual recipient addresses, such as &$local_part$& and
30326 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
30327 you want to run a centrally-specified filter for each recipient address
30328 independently, you can do so by setting up a suitable &(redirect)& router, as
30329 described in section &<<SECTperaddfil>>& below.
30330
30331
30332 .section "Specifying a system filter" "SECID212"
30333 .cindex "uid (user id)" "system filter"
30334 .cindex "gid (group id)" "system filter"
30335 The name of the file that contains the system filter must be specified by
30336 setting &%system_filter%&. If you want the filter to run under a uid and gid
30337 other than root, you must also set &%system_filter_user%& and
30338 &%system_filter_group%& as appropriate. For example:
30339 .code
30340 system_filter = /etc/mail/exim.filter
30341 system_filter_user = exim
30342 .endd
30343 If a system filter generates any deliveries directly to files or pipes (via the
30344 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
30345 specified by setting &%system_filter_file_transport%& and
30346 &%system_filter_pipe_transport%&, respectively. Similarly,
30347 &%system_filter_reply_transport%& must be set to handle any messages generated
30348 by the &%reply%& command.
30349
30350
30351 .section "Testing a system filter" "SECID213"
30352 You can run simple tests of a system filter in the same way as for a user
30353 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
30354 are permitted only in system filters are recognized.
30355
30356 If you want to test the combined effect of a system filter and a user filter,
30357 you can use both &%-bF%& and &%-bf%& on the same command line.
30358
30359
30360
30361 .section "Contents of a system filter" "SECID214"
30362 The language used to specify system filters is the same as for users' filter
30363 files. It is described in the separate end-user document &'Exim's interface to
30364 mail filtering'&. However, there are some additional features that are
30365 available only in system filters; these are described in subsequent sections.
30366 If they are encountered in a user's filter file or when testing with &%-bf%&,
30367 they cause errors.
30368
30369 .cindex "frozen messages" "manual thaw; testing in filter"
30370 There are two special conditions which, though available in users' filter
30371 files, are designed for use in system filters. The condition &%first_delivery%&
30372 is true only for the first attempt at delivering a message, and
30373 &%manually_thawed%& is true only if the message has been frozen, and
30374 subsequently thawed by an admin user. An explicit forced delivery counts as a
30375 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
30376
30377 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
30378 specify an &"unseen"& (non-significant) delivery, and that delivery does not
30379 succeed, it will not be tried again.
30380 If you want Exim to retry an unseen delivery until it succeeds, you should
30381 arrange to set it up every time the filter runs.
30382
30383 When a system filter finishes running, the values of the variables &$n0$& &--
30384 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
30385 users' filter files. Thus a system filter can, for example, set up &"scores"&
30386 to which users' filter files can refer.
30387
30388
30389
30390 .section "Additional variable for system filters" "SECID215"
30391 .vindex "&$recipients$&"
30392 The expansion variable &$recipients$&, containing a list of all the recipients
30393 of the message (separated by commas and white space), is available in system
30394 filters. It is not available in users' filters for privacy reasons.
30395
30396
30397
30398 .section "Defer, freeze, and fail commands for system filters" "SECID216"
30399 .cindex "freezing messages"
30400 .cindex "message" "freezing"
30401 .cindex "message" "forced failure"
30402 .cindex "&%fail%&" "in system filter"
30403 .cindex "&%freeze%& in system filter"
30404 .cindex "&%defer%& in system filter"
30405 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
30406 always available in system filters, but are not normally enabled in users'
30407 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
30408 for the &(redirect)& router.) These commands can optionally be followed by the
30409 word &%text%& and a string containing an error message, for example:
30410 .code
30411 fail text "this message looks like spam to me"
30412 .endd
30413 The keyword &%text%& is optional if the next character is a double quote.
30414
30415 The &%defer%& command defers delivery of the original recipients of the
30416 message. The &%fail%& command causes all the original recipients to be failed,
30417 and a bounce message to be created. The &%freeze%& command suspends all
30418 delivery attempts for the original recipients. In all cases, any new deliveries
30419 that are specified by the filter are attempted as normal after the filter has
30420 run.
30421
30422 The &%freeze%& command is ignored if the message has been manually unfrozen and
30423 not manually frozen since. This means that automatic freezing by a system
30424 filter can be used as a way of checking out suspicious messages. If a message
30425 is found to be all right, manually unfreezing it allows it to be delivered.
30426
30427 .cindex "log" "&%fail%& command log line"
30428 .cindex "&%fail%&" "log line; reducing"
30429 The text given with a fail command is used as part of the bounce message as
30430 well as being written to the log. If the message is quite long, this can fill
30431 up a lot of log space when such failures are common. To reduce the size of the
30432 log message, Exim interprets the text in a special way if it starts with the
30433 two characters &`<<`& and contains &`>>`& later. The text between these two
30434 strings is written to the log, and the rest of the text is used in the bounce
30435 message. For example:
30436 .code
30437 fail "<<filter test 1>>Your message is rejected \
30438      because it contains attachments that we are \
30439      not prepared to receive."
30440 .endd
30441
30442 .cindex "loop" "caused by &%fail%&"
30443 Take great care with the &%fail%& command when basing the decision to fail on
30444 the contents of the message, because the bounce message will of course include
30445 the contents of the original message and will therefore trigger the &%fail%&
30446 command again (causing a mail loop) unless steps are taken to prevent this.
30447 Testing the &%error_message%& condition is one way to prevent this. You could
30448 use, for example
30449 .code
30450 if $message_body contains "this is spam" and not error_message
30451 then fail text "spam is not wanted here" endif
30452 .endd
30453 though of course that might let through unwanted bounce messages. The
30454 alternative is clever checking of the body and/or headers to detect bounces
30455 generated by the filter.
30456
30457 The interpretation of a system filter file ceases after a
30458 &%defer%&,
30459 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
30460 set up earlier in the filter file are honoured, so you can use a sequence such
30461 as
30462 .code
30463 mail ...
30464 freeze
30465 .endd
30466 to send a specified message when the system filter is freezing (or deferring or
30467 failing) a message. The normal deliveries for the message do not, of course,
30468 take place.
30469
30470
30471
30472 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
30473 .cindex "header lines" "adding; in system filter"
30474 .cindex "header lines" "removing; in system filter"
30475 .cindex "filter" "header lines; adding/removing"
30476 Two filter commands that are available only in system filters are:
30477 .code
30478 headers add <string>
30479 headers remove <string>
30480 .endd
30481 The argument for the &%headers add%& is a string that is expanded and then
30482 added to the end of the message's headers. It is the responsibility of the
30483 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
30484 space is ignored, and if the string is otherwise empty, or if the expansion is
30485 forced to fail, the command has no effect.
30486
30487 You can use &"\n"& within the string, followed by white space, to specify
30488 continued header lines. More than one header may be added in one command by
30489 including &"\n"& within the string without any following white space. For
30490 example:
30491 .code
30492 headers add "X-header-1: ....\n  \
30493              continuation of X-header-1 ...\n\
30494              X-header-2: ...."
30495 .endd
30496 Note that the header line continuation white space after the first newline must
30497 be placed before the backslash that continues the input string, because white
30498 space after input continuations is ignored.
30499
30500 The argument for &%headers remove%& is a colon-separated list of header names.
30501 This command applies only to those headers that are stored with the message;
30502 those that are added at delivery time (such as &'Envelope-To:'& and
30503 &'Return-Path:'&) cannot be removed by this means. If there is more than one
30504 header with the same name, they are all removed.
30505
30506 The &%headers%& command in a system filter makes an immediate change to the set
30507 of header lines that was received with the message (with possible additions
30508 from ACL processing). Subsequent commands in the system filter operate on the
30509 modified set, which also forms the basis for subsequent message delivery.
30510 Unless further modified during routing or transporting, this set of headers is
30511 used for all recipients of the message.
30512
30513 During routing and transporting, the variables that refer to the contents of
30514 header lines refer only to those lines that are in this set. Thus, header lines
30515 that are added by a system filter are visible to users' filter files and to all
30516 routers and transports. This contrasts with the manipulation of header lines by
30517 routers and transports, which is not immediate, but which instead is saved up
30518 until the message is actually being written (see section
30519 &<<SECTheadersaddrem>>&).
30520
30521 If the message is not delivered at the first attempt, header lines that were
30522 added by the system filter are stored with the message, and so are still
30523 present at the next delivery attempt. Header lines that were removed are still
30524 present, but marked &"deleted"& so that they are not transported with the
30525 message. For this reason, it is usual to make the &%headers%& command
30526 conditional on &%first_delivery%& so that the set of header lines is not
30527 modified more than once.
30528
30529 Because header modification in a system filter acts immediately, you have to
30530 use an indirect approach if you want to modify the contents of a header line.
30531 For example:
30532 .code
30533 headers add "Old-Subject: $h_subject:"
30534 headers remove "Subject"
30535 headers add "Subject: new subject (was: $h_old-subject:)"
30536 headers remove "Old-Subject"
30537 .endd
30538
30539
30540
30541 .section "Setting an errors address in a system filter" "SECID217"
30542 .cindex "envelope sender"
30543 In a system filter, if a &%deliver%& command is followed by
30544 .code
30545 errors_to <some address>
30546 .endd
30547 in order to change the envelope sender (and hence the error reporting) for that
30548 delivery, any address may be specified. (In a user filter, only the current
30549 user's address can be set.) For example, if some mail is being monitored, you
30550 might use
30551 .code
30552 unseen deliver monitor@spying.example errors_to root@local.example
30553 .endd
30554 to take a copy which would not be sent back to the normal error reporting
30555 address if its delivery failed.
30556
30557
30558
30559 .section "Per-address filtering" "SECTperaddfil"
30560 .vindex "&$domain$&"
30561 .vindex "&$local_part$&"
30562 In contrast to the system filter, which is run just once per message for each
30563 delivery attempt, it is also possible to set up a system-wide filtering
30564 operation that runs once for each recipient address. In this case, variables
30565 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
30566 filter file could be made dependent on them. This is an example of a router
30567 which implements such a filter:
30568 .code
30569 central_filter:
30570   check_local_user
30571   driver = redirect
30572   domains = +local_domains
30573   file = /central/filters/$local_part
30574   no_verify
30575   allow_filter
30576   allow_freeze
30577 .endd
30578 The filter is run in a separate process under its own uid. Therefore, either
30579 &%check_local_user%& must be set (as above), in which case the filter is run as
30580 the local user, or the &%user%& option must be used to specify which user to
30581 use. If both are set, &%user%& overrides.
30582
30583 Care should be taken to ensure that none of the commands in the filter file
30584 specify a significant delivery if the message is to go on to be delivered to
30585 its intended recipient. The router will not then claim to have dealt with the
30586 address, so it will be passed on to subsequent routers to be delivered in the
30587 normal way.
30588 .ecindex IIDsysfil1
30589 .ecindex IIDsysfil2
30590 .ecindex IIDsysfil3
30591
30592
30593
30594
30595
30596
30597 . ////////////////////////////////////////////////////////////////////////////
30598 . ////////////////////////////////////////////////////////////////////////////
30599
30600 .chapter "Message processing" "CHAPmsgproc"
30601 .scindex IIDmesproc "message" "general processing"
30602 Exim performs various transformations on the sender and recipient addresses of
30603 all messages that it handles, and also on the messages' header lines. Some of
30604 these are optional and configurable, while others always take place. All of
30605 this processing, except rewriting as a result of routing, and the addition or
30606 removal of header lines while delivering, happens when a message is received,
30607 before it is placed on Exim's queue.
30608
30609 Some of the automatic processing takes place by default only for
30610 &"locally-originated"& messages. This adjective is used to describe messages
30611 that are not received over TCP/IP, but instead are passed to an Exim process on
30612 its standard input. This includes the interactive &"local SMTP"& case that is
30613 set up by the &%-bs%& command line option.
30614
30615 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
30616 or ::1) are not considered to be locally-originated. Exim does not treat the
30617 loopback interface specially in any way.
30618
30619 If you want the loopback interface to be treated specially, you must ensure
30620 that there are appropriate entries in your ACLs.
30621
30622
30623
30624
30625 .section "Submission mode for non-local messages" "SECTsubmodnon"
30626 .cindex "message" "submission"
30627 .cindex "submission mode"
30628 Processing that happens automatically for locally-originated messages (unless
30629 &%suppress_local_fixups%& is set) can also be requested for messages that are
30630 received over TCP/IP. The term &"submission mode"& is used to describe this
30631 state. Submission mode is set by the modifier
30632 .code
30633 control = submission
30634 .endd
30635 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
30636 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
30637 a local submission, and is normally used when the source of the message is
30638 known to be an MUA running on a client host (as opposed to an MTA). For
30639 example, to set submission mode for messages originating on the IPv4 loopback
30640 interface, you could include the following in the MAIL ACL:
30641 .code
30642 warn  hosts = 127.0.0.1
30643       control = submission
30644 .endd
30645 .cindex "&%sender_retain%& submission option"
30646 There are some options that can be used when setting submission mode. A slash
30647 is used to separate options. For example:
30648 .code
30649 control = submission/sender_retain
30650 .endd
30651 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
30652 true and &%local_from_check%& false for the current incoming message. The first
30653 of these allows an existing &'Sender:'& header in the message to remain, and
30654 the second suppresses the check to ensure that &'From:'& matches the
30655 authenticated sender. With this setting, Exim still fixes up messages by adding
30656 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
30657 attempt to check sender authenticity in header lines.
30658
30659 When &%sender_retain%& is not set, a submission mode setting may specify a
30660 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
30661 example:
30662 .code
30663 control = submission/domain=some.domain
30664 .endd
30665 The domain may be empty. How this value is used is described in sections
30666 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
30667 that allows you to specify the user's full name for inclusion in a created
30668 &'Sender:'& or &'From:'& header line. For example:
30669 .code
30670 accept authenticated = *
30671        control = submission/domain=wonderland.example/\
30672                             name=${lookup {$authenticated_id} \
30673                                    lsearch {/etc/exim/namelist}}
30674 .endd
30675 Because the name may contain any characters, including slashes, the &%name%&
30676 option must be given last. The remainder of the string is used as the name. For
30677 the example above, if &_/etc/exim/namelist_& contains:
30678 .code
30679 bigegg:  Humpty Dumpty
30680 .endd
30681 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
30682 line would be:
30683 .code
30684 Sender: Humpty Dumpty <bigegg@wonderland.example>
30685 .endd
30686 .cindex "return path" "in submission mode"
30687 By default, submission mode forces the return path to the same address as is
30688 used to create the &'Sender:'& header. However, if &%sender_retain%& is
30689 specified, the return path is also left unchanged.
30690
30691 &*Note*&: The changes caused by submission mode take effect after the predata
30692 ACL. This means that any sender checks performed before the fix-ups use the
30693 untrusted sender address specified by the user, not the trusted sender address
30694 specified by submission mode. Although this might be slightly unexpected, it
30695 does mean that you can configure ACL checks to spot that a user is trying to
30696 spoof another's address.
30697
30698 .section "Line endings" "SECTlineendings"
30699 .cindex "line endings"
30700 .cindex "carriage return"
30701 .cindex "linefeed"
30702 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
30703 linefeed) is the line ending for messages transmitted over the Internet using
30704 SMTP over TCP/IP. However, within individual operating systems, different
30705 conventions are used. For example, Unix-like systems use just LF, but others
30706 use CRLF or just CR.
30707
30708 Exim was designed for Unix-like systems, and internally, it stores messages
30709 using the system's convention of a single LF as a line terminator. When
30710 receiving a message, all line endings are translated to this standard format.
30711 Originally, it was thought that programs that passed messages directly to an
30712 MTA within an operating system would use that system's convention. Experience
30713 has shown that this is not the case; for example, there are Unix applications
30714 that use CRLF in this circumstance. For this reason, and for compatibility with
30715 other MTAs, the way Exim handles line endings for all messages is now as
30716 follows:
30717
30718 .ilist
30719 LF not preceded by CR is treated as a line ending.
30720 .next
30721 CR is treated as a line ending; if it is immediately followed by LF, the LF
30722 is ignored.
30723 .next
30724 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
30725 nor a local message in the state where a line containing only a dot is a
30726 terminator.
30727 .next
30728 If a bare CR is encountered within a header line, an extra space is added after
30729 the line terminator so as not to end the header line. The reasoning behind this
30730 is that bare CRs in header lines are most likely either to be mistakes, or
30731 people trying to play silly games.
30732 .next
30733 If the first header line received in a message ends with CRLF, a subsequent
30734 bare LF in a header line is treated in the same way as a bare CR in a header
30735 line.
30736 .endlist
30737
30738
30739
30740
30741
30742 .section "Unqualified addresses" "SECID218"
30743 .cindex "unqualified addresses"
30744 .cindex "address" "qualification"
30745 By default, Exim expects every envelope address it receives from an external
30746 host to be fully qualified. Unqualified addresses cause negative responses to
30747 SMTP commands. However, because SMTP is used as a means of transporting
30748 messages from MUAs running on personal workstations, there is sometimes a
30749 requirement to accept unqualified addresses from specific hosts or IP networks.
30750
30751 Exim has two options that separately control which hosts may send unqualified
30752 sender or recipient addresses in SMTP commands, namely
30753 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
30754 cases, if an unqualified address is accepted, it is qualified by adding the
30755 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
30756
30757 .oindex "&%qualify_domain%&"
30758 .oindex "&%qualify_recipient%&"
30759 Unqualified addresses in header lines are automatically qualified for messages
30760 that are locally originated, unless the &%-bnq%& option is given on the command
30761 line. For messages received over SMTP, unqualified addresses in header lines
30762 are qualified only if unqualified addresses are permitted in SMTP commands. In
30763 other words, such qualification is also controlled by
30764 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
30765
30766
30767
30768
30769 .section "The UUCP From line" "SECID219"
30770 .cindex "&""From""& line"
30771 .cindex "UUCP" "&""From""& line"
30772 .cindex "sender" "address"
30773 .oindex "&%uucp_from_pattern%&"
30774 .oindex "&%uucp_from_sender%&"
30775 .cindex "envelope sender"
30776 .cindex "Sendmail compatibility" "&""From""& line"
30777 Messages that have come from UUCP (and some other applications) often begin
30778 with a line containing the envelope sender and a timestamp, following the word
30779 &"From"&. Examples of two common formats are:
30780 .code
30781 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
30782 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
30783 .endd
30784 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
30785 Exim recognizes such lines at the start of messages that are submitted to it
30786 via the command line (that is, on the standard input). It does not recognize
30787 such lines in incoming SMTP messages, unless the sending host matches
30788 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
30789 and &%ignore_fromline_local%& is set. The recognition is controlled by a
30790 regular expression that is defined by the &%uucp_from_pattern%& option, whose
30791 default value matches the two common cases shown above and puts the address
30792 that follows &"From"& into &$1$&.
30793
30794 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
30795 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
30796 a trusted user, the message's sender address is constructed by expanding the
30797 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
30798 then parsed as an RFC 2822 address. If there is no domain, the local part is
30799 qualified with &%qualify_domain%& unless it is the empty string. However, if
30800 the command line &%-f%& option is used, it overrides the &"From"& line.
30801
30802 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
30803 sender address is not changed. This is also the case for incoming SMTP messages
30804 that are permitted to contain &"From"& lines.
30805
30806 Only one &"From"& line is recognized. If there is more than one, the second is
30807 treated as a data line that starts the body of the message, as it is not valid
30808 as a header line. This also happens if a &"From"& line is present in an
30809 incoming SMTP message from a source that is not permitted to send them.
30810
30811
30812
30813 .section "Resent- header lines" "SECID220"
30814 .cindex "&%Resent-%& header lines"
30815 RFC 2822 makes provision for sets of header lines starting with the string
30816 &`Resent-`& to be added to a message when it is resent by the original
30817 recipient to somebody else. These headers are &'Resent-Date:'&,
30818 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
30819 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
30820
30821 .blockquote
30822 &'Resent fields are strictly informational. They MUST NOT be used in the normal
30823 processing of replies or other such automatic actions on messages.'&
30824 .endblockquote
30825
30826 This leaves things a bit vague as far as other processing actions such as
30827 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30828 follows:
30829
30830 .ilist
30831 A &'Resent-From:'& line that just contains the login id of the submitting user
30832 is automatically rewritten in the same way as &'From:'& (see below).
30833 .next
30834 If there's a rewriting rule for a particular header line, it is also applied to
30835 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30836 &'From:'& also rewrites &'Resent-From:'&.
30837 .next
30838 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30839 also removed.
30840 .next
30841 For a locally-submitted message,
30842 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30843 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30844 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30845 included in log lines in this case.
30846 .next
30847 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30848 &%Resent-%& header lines are present.
30849 .endlist
30850
30851
30852
30853
30854 .section "The Auto-Submitted: header line" "SECID221"
30855 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30856 includes the header line:
30857 .code
30858 Auto-Submitted: auto-replied
30859 .endd
30860
30861 .section "The Bcc: header line" "SECID222"
30862 .cindex "&'Bcc:'& header line"
30863 If Exim is called with the &%-t%& option, to take recipient addresses from a
30864 message's header, it removes any &'Bcc:'& header line that may exist (after
30865 extracting its addresses). If &%-t%& is not present on the command line, any
30866 existing &'Bcc:'& is not removed.
30867
30868
30869 .section "The Date: header line" "SECID223"
30870 .cindex "&'Date:'& header line"
30871 If a locally-generated or submission-mode message has no &'Date:'& header line,
30872 Exim adds one, using the current date and time, unless the
30873 &%suppress_local_fixups%& control has been specified.
30874
30875 .section "The Delivery-date: header line" "SECID224"
30876 .cindex "&'Delivery-date:'& header line"
30877 .oindex "&%delivery_date_remove%&"
30878 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30879 set. Exim can be configured to add them to the final delivery of messages. (See
30880 the generic &%delivery_date_add%& transport option.) They should not be present
30881 in messages in transit. If the &%delivery_date_remove%& configuration option is
30882 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30883 messages.
30884
30885
30886 .section "The Envelope-to: header line" "SECID225"
30887 .cindex "&'Envelope-to:'& header line"
30888 .oindex "&%envelope_to_remove%&"
30889 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30890 Exim can be configured to add them to the final delivery of messages. (See the
30891 generic &%envelope_to_add%& transport option.) They should not be present in
30892 messages in transit. If the &%envelope_to_remove%& configuration option is set
30893 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30894 messages.
30895
30896
30897 .section "The From: header line" "SECTthefrohea"
30898 .cindex "&'From:'& header line"
30899 .cindex "Sendmail compatibility" "&""From""& line"
30900 .cindex "message" "submission"
30901 .cindex "submission mode"
30902 If a submission-mode message does not contain a &'From:'& header line, Exim
30903 adds one if either of the following conditions is true:
30904
30905 .ilist
30906 The envelope sender address is not empty (that is, this is not a bounce
30907 message). The added header line copies the envelope sender address.
30908 .next
30909 .vindex "&$authenticated_id$&"
30910 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30911 .olist
30912 .vindex "&$qualify_domain$&"
30913 If no domain is specified by the submission control, the local part is
30914 &$authenticated_id$& and the domain is &$qualify_domain$&.
30915 .next
30916 If a non-empty domain is specified by the submission control, the local
30917 part is &$authenticated_id$&, and the domain is the specified domain.
30918 .next
30919 If an empty domain is specified by the submission control,
30920 &$authenticated_id$& is assumed to be the complete address.
30921 .endlist
30922 .endlist
30923
30924 A non-empty envelope sender takes precedence.
30925
30926 If a locally-generated incoming message does not contain a &'From:'& header
30927 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30928 containing the sender's address. The calling user's login name and full name
30929 are used to construct the address, as described in section &<<SECTconstr>>&.
30930 They are obtained from the password data by calling &[getpwuid()]& (but see the
30931 &%unknown_login%& configuration option). The address is qualified with
30932 &%qualify_domain%&.
30933
30934 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30935 &'From:'& header line containing just the unqualified login name of the calling
30936 user, this is replaced by an address containing the user's login name and full
30937 name as described in section &<<SECTconstr>>&.
30938
30939
30940 .section "The Message-ID: header line" "SECID226"
30941 .cindex "&'Message-ID:'& header line"
30942 .cindex "message" "submission"
30943 .oindex "&%message_id_header_text%&"
30944 If a locally-generated or submission-mode incoming message does not contain a
30945 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30946 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30947 to the message. If there are any &'Resent-:'& headers in the message, it
30948 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30949 message id, preceded by the letter E to ensure it starts with a letter, and
30950 followed by @ and the primary host name. Additional information can be included
30951 in this header line by setting the &%message_id_header_text%& and/or
30952 &%message_id_header_domain%& options.
30953
30954
30955 .section "The Received: header line" "SECID227"
30956 .cindex "&'Received:'& header line"
30957 A &'Received:'& header line is added at the start of every message. The
30958 contents are defined by the &%received_header_text%& configuration option, and
30959 Exim automatically adds a semicolon and a timestamp to the configured string.
30960
30961 The &'Received:'& header is generated as soon as the message's header lines
30962 have been received. At this stage, the timestamp in the &'Received:'& header
30963 line is the time that the message started to be received. This is the value
30964 that is seen by the DATA ACL and by the &[local_scan()]& function.
30965
30966 Once a message is accepted, the timestamp in the &'Received:'& header line is
30967 changed to the time of acceptance, which is (apart from a small delay while the
30968 -H spool file is written) the earliest time at which delivery could start.
30969
30970
30971 .section "The References: header line" "SECID228"
30972 .cindex "&'References:'& header line"
30973 Messages created by the &(autoreply)& transport include a &'References:'&
30974 header line. This is constructed according to the rules that are described in
30975 section 3.64 of RFC 2822 (which states that replies should contain such a
30976 header line), and section 3.14 of RFC 3834 (which states that automatic
30977 responses are not different in this respect). However, because some mail
30978 processing software does not cope well with very long header lines, no more
30979 than 12 message IDs are copied from the &'References:'& header line in the
30980 incoming message. If there are more than 12, the first one and then the final
30981 11 are copied, before adding the message ID of the incoming message.
30982
30983
30984
30985 .section "The Return-path: header line" "SECID229"
30986 .cindex "&'Return-path:'& header line"
30987 .oindex "&%return_path_remove%&"
30988 &'Return-path:'& header lines are defined as something an MTA may insert when
30989 it does the final delivery of messages. (See the generic &%return_path_add%&
30990 transport option.) Therefore, they should not be present in messages in
30991 transit. If the &%return_path_remove%& configuration option is set (the
30992 default), Exim removes &'Return-path:'& header lines from incoming messages.
30993
30994
30995
30996 .section "The Sender: header line" "SECTthesenhea"
30997 .cindex "&'Sender:'& header line"
30998 .cindex "message" "submission"
30999 For a locally-originated message from an untrusted user, Exim may remove an
31000 existing &'Sender:'& header line, and it may add a new one. You can modify
31001 these actions by setting the &%local_sender_retain%& option true, the
31002 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31003 control setting.
31004
31005 When a local message is received from an untrusted user and
31006 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31007 control has not been set, a check is made to see if the address given in the
31008 &'From:'& header line is the correct (local) sender of the message. The address
31009 that is expected has the login name as the local part and the value of
31010 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31011 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31012 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31013 line is added to the message.
31014
31015 If you set &%local_from_check%& false, this checking does not occur. However,
31016 the removal of an existing &'Sender:'& line still happens, unless you also set
31017 &%local_sender_retain%& to be true. It is not possible to set both of these
31018 options true at the same time.
31019
31020 .cindex "submission mode"
31021 By default, no processing of &'Sender:'& header lines is done for messages
31022 received over TCP/IP or for messages submitted by trusted users. However, when
31023 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31024 not specified on the submission control, the following processing takes place:
31025
31026 .vindex "&$authenticated_id$&"
31027 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31028 authenticated, and &$authenticated_id$& is not empty, a sender address is
31029 created as follows:
31030
31031 .ilist
31032 .vindex "&$qualify_domain$&"
31033 If no domain is specified by the submission control, the local part is
31034 &$authenticated_id$& and the domain is &$qualify_domain$&.
31035 .next
31036 If a non-empty domain is specified by the submission control, the local part
31037 is &$authenticated_id$&, and the domain is the specified domain.
31038 .next
31039 If an empty domain is specified by the submission control,
31040 &$authenticated_id$& is assumed to be the complete address.
31041 .endlist
31042
31043 This address is compared with the address in the &'From:'& header line. If they
31044 are different, a &'Sender:'& header line containing the created address is
31045 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31046 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31047
31048 .cindex "return path" "created from &'Sender:'&"
31049 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31050 the message (the envelope sender address) is changed to be the same address,
31051 except in the case of submission mode when &%sender_retain%& is specified.
31052
31053
31054
31055 .section "Adding and removing header lines in routers and transports" &&&
31056          "SECTheadersaddrem"
31057 .cindex "header lines" "adding; in router or transport"
31058 .cindex "header lines" "removing; in router or transport"
31059 When a message is delivered, the addition and removal of header lines can be
31060 specified in a system filter, or on any of the routers and transports that
31061 process the message. Section &<<SECTaddremheasys>>& contains details about
31062 modifying headers in a system filter. Header lines can also be added in an ACL
31063 as a message is received (see section &<<SECTaddheadacl>>&).
31064
31065 In contrast to what happens in a system filter, header modifications that are
31066 specified on routers and transports apply only to the particular recipient
31067 addresses that are being processed by those routers and transports. These
31068 changes do not actually take place until a copy of the message is being
31069 transported. Therefore, they do not affect the basic set of header lines, and
31070 they do not affect the values of the variables that refer to header lines.
31071
31072 &*Note*&: In particular, this means that any expansions in the configuration of
31073 the transport cannot refer to the modified header lines, because such
31074 expansions all occur before the message is actually transported.
31075
31076 For both routers and transports, the result of expanding a &%headers_add%&
31077 option must be in the form of one or more RFC 2822 header lines, separated by
31078 newlines (coded as &"\n"&). For example:
31079 .code
31080 headers_add = X-added-header: added by $primary_hostname\n\
31081               X-added-second: another added header line
31082 .endd
31083 Exim does not check the syntax of these added header lines.
31084
31085 The result of expanding &%headers_remove%& must consist of a colon-separated
31086 list of header names. This is confusing, because header names themselves are
31087 often terminated by colons. In this case, the colons are the list separators,
31088 not part of the names. For example:
31089 .code
31090 headers_remove = return-receipt-to:acknowledge-to
31091 .endd
31092 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31093 is expanded at routing time, and then associated with all addresses that are
31094 accepted by that router, and also with any new addresses that it generates. If
31095 an address passes through several routers as a result of aliasing or
31096 forwarding, the changes are cumulative.
31097
31098 .oindex "&%unseen%&"
31099 However, this does not apply to multiple routers that result from the use of
31100 the &%unseen%& option. Any header modifications that were specified by the
31101 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31102
31103 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31104 settings cannot be delivered together in a batch, so a transport is always
31105 dealing with a set of addresses that have the same header-processing
31106 requirements.
31107
31108 The transport starts by writing the original set of header lines that arrived
31109 with the message, possibly modified by the system filter. As it writes out
31110 these lines, it consults the list of header names that were attached to the
31111 recipient address(es) by &%headers_remove%& options in routers, and it also
31112 consults the transport's own &%headers_remove%& option. Header lines whose
31113 names are on either of these lists are not written out. If there are multiple
31114 instances of any listed header, they are all skipped.
31115
31116 After the remaining original header lines have been written, new header
31117 lines that were specified by routers' &%headers_add%& options are written, in
31118 the order in which they were attached to the address. These are followed by any
31119 header lines specified by the transport's &%headers_add%& option.
31120
31121 This way of handling header line modifications in routers and transports has
31122 the following consequences:
31123
31124 .ilist
31125 The original set of header lines, possibly modified by the system filter,
31126 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31127 to it, at all times.
31128 .next
31129 Header lines that are added by a router's
31130 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31131 expansion syntax in subsequent routers or the transport.
31132 .next
31133 Conversely, header lines that are specified for removal by &%headers_remove%&
31134 in a router remain visible to subsequent routers and the transport.
31135 .next
31136 Headers added to an address by &%headers_add%& in a router cannot be removed by
31137 a later router or by a transport.
31138 .next
31139 An added header can refer to the contents of an original header that is to be
31140 removed, even it has the same name as the added header. For example:
31141 .code
31142 headers_remove = subject
31143 headers_add = Subject: new subject (was: $h_subject:)
31144 .endd
31145 .endlist
31146
31147 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31148 for a &(redirect)& router that has the &%one_time%& option set.
31149
31150
31151
31152
31153
31154 .section "Constructed addresses" "SECTconstr"
31155 .cindex "address" "constructed"
31156 .cindex "constructed address"
31157 When Exim constructs a sender address for a locally-generated message, it uses
31158 the form
31159 .display
31160 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31161 .endd
31162 For example:
31163 .code
31164 Zaphod Beeblebrox <zaphod@end.univ.example>
31165 .endd
31166 The user name is obtained from the &%-F%& command line option if set, or
31167 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31168 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31169 ampersand character, this is replaced by the login name with the first letter
31170 upper cased, as is conventional in a number of operating systems. See the
31171 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31172 The &%unknown_username%& option can be used to specify user names in cases when
31173 there is no password file entry.
31174
31175 .cindex "RFC 2047"
31176 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31177 parts of it if necessary. In addition, if it contains any non-printing
31178 characters, it is encoded as described in RFC 2047, which defines a way of
31179 including non-ASCII characters in header lines. The value of the
31180 &%headers_charset%& option specifies the name of the encoding that is used (the
31181 characters are assumed to be in this encoding). The setting of
31182 &%print_topbitchars%& controls whether characters with the top bit set (that
31183 is, with codes greater than 127) count as printing characters or not.
31184
31185
31186
31187 .section "Case of local parts" "SECID230"
31188 .cindex "case of local parts"
31189 .cindex "local part" "case of"
31190 RFC 2822 states that the case of letters in the local parts of addresses cannot
31191 be assumed to be non-significant. Exim preserves the case of local parts of
31192 addresses, but by default it uses a lower-cased form when it is routing,
31193 because on most Unix systems, usernames are in lower case and case-insensitive
31194 routing is required. However, any particular router can be made to use the
31195 original case for local parts by setting the &%caseful_local_part%& generic
31196 router option.
31197
31198 .cindex "mixed-case login names"
31199 If you must have mixed-case user names on your system, the best way to proceed,
31200 assuming you want case-independent handling of incoming email, is to set up
31201 your first router to convert incoming local parts in your domains to the
31202 correct case by means of a file lookup. For example:
31203 .code
31204 correct_case:
31205   driver = redirect
31206   domains = +local_domains
31207   data = ${lookup{$local_part}cdb\
31208               {/etc/usercased.cdb}{$value}fail}\
31209               @$domain
31210 .endd
31211 For this router, the local part is forced to lower case by the default action
31212 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31213 up a new local part in the correct case. If you then set &%caseful_local_part%&
31214 on any subsequent routers which process your domains, they will operate on
31215 local parts with the correct case in a case-sensitive manner.
31216
31217
31218
31219 .section "Dots in local parts" "SECID231"
31220 .cindex "dot" "in local part"
31221 .cindex "local part" "dots in"
31222 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31223 part may not begin or end with a dot, nor have two consecutive dots in the
31224 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31225 empty components for compatibility.
31226
31227
31228
31229 .section "Rewriting addresses" "SECID232"
31230 .cindex "rewriting" "addresses"
31231 Rewriting of sender and recipient addresses, and addresses in headers, can
31232 happen automatically, or as the result of configuration options, as described
31233 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31234 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31235
31236 Automatic rewriting includes qualification, as mentioned above. The other case
31237 in which it can happen is when an incomplete non-local domain is given. The
31238 routing process may cause this to be expanded into the full domain name. For
31239 example, a header such as
31240 .code
31241 To: hare@teaparty
31242 .endd
31243 might get rewritten as
31244 .code
31245 To: hare@teaparty.wonderland.fict.example
31246 .endd
31247 Rewriting as a result of routing is the one kind of message processing that
31248 does not happen at input time, as it cannot be done until the address has
31249 been routed.
31250
31251 Strictly, one should not do &'any'& deliveries of a message until all its
31252 addresses have been routed, in case any of the headers get changed as a
31253 result of routing. However, doing this in practice would hold up many
31254 deliveries for unreasonable amounts of time, just because one address could not
31255 immediately be routed. Exim therefore does not delay other deliveries when
31256 routing of one or more addresses is deferred.
31257 .ecindex IIDmesproc
31258
31259
31260
31261 . ////////////////////////////////////////////////////////////////////////////
31262 . ////////////////////////////////////////////////////////////////////////////
31263
31264 .chapter "SMTP processing" "CHAPSMTP"
31265 .scindex IIDsmtpproc1 "SMTP" "processing details"
31266 .scindex IIDsmtpproc2 "LMTP" "processing details"
31267 Exim supports a number of different ways of using the SMTP protocol, and its
31268 LMTP variant, which is an interactive protocol for transferring messages into a
31269 closed mail store application. This chapter contains details of how SMTP is
31270 processed. For incoming mail, the following are available:
31271
31272 .ilist
31273 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31274 .next
31275 SMTP over the standard input and output (the &%-bs%& option);
31276 .next
31277 Batched SMTP on the standard input (the &%-bS%& option).
31278 .endlist
31279
31280 For mail delivery, the following are available:
31281
31282 .ilist
31283 SMTP over TCP/IP (the &(smtp)& transport);
31284 .next
31285 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31286 &"lmtp"&);
31287 .next
31288 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31289 transport);
31290 .next
31291 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31292 the &%use_bsmtp%& option set).
31293 .endlist
31294
31295 &'Batched SMTP'& is the name for a process in which batches of messages are
31296 stored in or read from files (or pipes), in a format in which SMTP commands are
31297 used to contain the envelope information.
31298
31299
31300
31301 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
31302 .cindex "SMTP" "outgoing over TCP/IP"
31303 .cindex "outgoing SMTP over TCP/IP"
31304 .cindex "LMTP" "over TCP/IP"
31305 .cindex "outgoing LMTP over TCP/IP"
31306 .cindex "EHLO"
31307 .cindex "HELO"
31308 .cindex "SIZE option on MAIL command"
31309 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
31310 The &%protocol%& option selects which protocol is to be used, but the actual
31311 processing is the same in both cases.
31312
31313 If, in response to its EHLO command, Exim is told that the SIZE
31314 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
31315 command. The value of <&'n'&> is the message size plus the value of the
31316 &%size_addition%& option (default 1024) to allow for additions to the message
31317 such as per-transport header lines, or changes made in a
31318 .cindex "transport" "filter"
31319 .cindex "filter" "transport filter"
31320 transport filter. If &%size_addition%& is set negative, the use of SIZE is
31321 suppressed.
31322
31323 If the remote server advertises support for PIPELINING, Exim uses the
31324 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
31325 required for the transaction.
31326
31327 If the remote server advertises support for the STARTTLS command, and Exim
31328 was built to support TLS encryption, it tries to start a TLS session unless the
31329 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
31330
31331 If the remote server advertises support for the AUTH command, Exim scans
31332 the authenticators configuration for any suitable client settings, as described
31333 in chapter &<<CHAPSMTPAUTH>>&.
31334
31335 .cindex "carriage return"
31336 .cindex "linefeed"
31337 Responses from the remote host are supposed to be terminated by CR followed by
31338 LF. However, there are known to be hosts that do not send CR characters, so in
31339 order to be able to interwork with such hosts, Exim treats LF on its own as a
31340 line terminator.
31341
31342 If a message contains a number of different addresses, all those with the same
31343 characteristics (for example, the same envelope sender) that resolve to the
31344 same set of hosts, in the same order, are sent in a single SMTP transaction,
31345 even if they are for different domains, unless there are more than the setting
31346 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
31347 they are split into groups containing no more than &%max_rcpt%&s addresses
31348 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
31349 in parallel sessions. The order of hosts with identical MX values is not
31350 significant when checking whether addresses can be batched in this way.
31351
31352 When the &(smtp)& transport suffers a temporary failure that is not
31353 message-related, Exim updates its transport-specific database, which contains
31354 records indexed by host name that remember which messages are waiting for each
31355 particular host. It also updates the retry database with new retry times.
31356
31357 .cindex "hints database" "retry keys"
31358 Exim's retry hints are based on host name plus IP address, so if one address of
31359 a multi-homed host is broken, it will soon be skipped most of the time.
31360 See the next section for more detail about error handling.
31361
31362 .cindex "SMTP" "passed connection"
31363 .cindex "SMTP" "batching over TCP/IP"
31364 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
31365 looks in the hints database for the transport to see if there are any queued
31366 messages waiting for the host to which it is connected. If it finds one, it
31367 creates a new Exim process using the &%-MC%& option (which can only be used by
31368 a process running as root or the Exim user) and passes the TCP/IP socket to it
31369 so that it can deliver another message using the same socket. The new process
31370 does only those deliveries that are routed to the connected host, and may in
31371 turn pass the socket on to a third process, and so on.
31372
31373 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
31374 limit the number of messages sent down a single TCP/IP connection.
31375
31376 .cindex "asterisk" "after IP address"
31377 The second and subsequent messages delivered down an existing connection are
31378 identified in the main log by the addition of an asterisk after the closing
31379 square bracket of the IP address.
31380
31381
31382
31383
31384 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
31385 .cindex "error" "in outgoing SMTP"
31386 .cindex "SMTP" "errors in outgoing"
31387 .cindex "host" "error"
31388 Three different kinds of error are recognized for outgoing SMTP: host errors,
31389 message errors, and recipient errors.
31390
31391 .vlist
31392 .vitem "&*Host errors*&"
31393 A host error is not associated with a particular message or with a
31394 particular recipient of a message. The host errors are:
31395
31396 .ilist
31397 Connection refused or timed out,
31398 .next
31399 Any error response code on connection,
31400 .next
31401 Any error response code to EHLO or HELO,
31402 .next
31403 Loss of connection at any time, except after &"."&,
31404 .next
31405 I/O errors at any time,
31406 .next
31407 Timeouts during the session, other than in response to MAIL, RCPT or
31408 the &"."& at the end of the data.
31409 .endlist ilist
31410
31411 For a host error, a permanent error response on connection, or in response to
31412 EHLO, causes all addresses routed to the host to be failed. Any other host
31413 error causes all addresses to be deferred, and retry data to be created for the
31414 host. It is not tried again, for any message, until its retry time arrives. If
31415 the current set of addresses are not all delivered in this run (to some
31416 alternative host), the message is added to the list of those waiting for this
31417 host, so if it is still undelivered when a subsequent successful delivery is
31418 made to the host, it will be sent down the same SMTP connection.
31419
31420 .vitem "&*Message errors*&"
31421 .cindex "message" "error"
31422 A message error is associated with a particular message when sent to a
31423 particular host, but not with a particular recipient of the message. The
31424 message errors are:
31425
31426 .ilist
31427 Any error response code to MAIL, DATA, or the &"."& that terminates
31428 the data,
31429 .next
31430 Timeout after MAIL,
31431 .next
31432 Timeout or loss of connection after the &"."& that terminates the data. A
31433 timeout after the DATA command itself is treated as a host error, as is loss of
31434 connection at any other time.
31435 .endlist ilist
31436
31437 For a message error, a permanent error response (5&'xx'&) causes all addresses
31438 to be failed, and a delivery error report to be returned to the sender. A
31439 temporary error response (4&'xx'&), or one of the timeouts, causes all
31440 addresses to be deferred. Retry data is not created for the host, but instead,
31441 a retry record for the combination of host plus message id is created. The
31442 message is not added to the list of those waiting for this host. This ensures
31443 that the failing message will not be sent to this host again until the retry
31444 time arrives. However, other messages that are routed to the host are not
31445 affected, so if it is some property of the message that is causing the error,
31446 it will not stop the delivery of other mail.
31447
31448 If the remote host specified support for the SIZE parameter in its response
31449 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
31450 over-large message will cause a message error because the error arrives as a
31451 response to MAIL.
31452
31453 .vitem "&*Recipient errors*&"
31454 .cindex "recipient" "error"
31455 A recipient error is associated with a particular recipient of a message. The
31456 recipient errors are:
31457
31458 .ilist
31459 Any error response to RCPT,
31460 .next
31461 Timeout after RCPT.
31462 .endlist
31463
31464 For a recipient error, a permanent error response (5&'xx'&) causes the
31465 recipient address to be failed, and a bounce message to be returned to the
31466 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
31467 address to be deferred, and routing retry data to be created for it. This is
31468 used to delay processing of the address in subsequent queue runs, until its
31469 routing retry time arrives. This applies to all messages, but because it
31470 operates only in queue runs, one attempt will be made to deliver a new message
31471 to the failing address before the delay starts to operate. This ensures that,
31472 if the failure is really related to the message rather than the recipient
31473 (&"message too big for this recipient"& is a possible example), other messages
31474 have a chance of getting delivered. If a delivery to the address does succeed,
31475 the retry information gets cleared, so all stuck messages get tried again, and
31476 the retry clock is reset.
31477
31478 The message is not added to the list of those waiting for this host. Use of the
31479 host for other messages is unaffected, and except in the case of a timeout,
31480 other recipients are processed independently, and may be successfully delivered
31481 in the current SMTP session. After a timeout it is of course impossible to
31482 proceed with the session, so all addresses get deferred. However, those other
31483 than the one that failed do not suffer any subsequent retry delays. Therefore,
31484 if one recipient is causing trouble, the others have a chance of getting
31485 through when a subsequent delivery attempt occurs before the failing
31486 recipient's retry time.
31487 .endlist
31488
31489 In all cases, if there are other hosts (or IP addresses) available for the
31490 current set of addresses (for example, from multiple MX records), they are
31491 tried in this run for any undelivered addresses, subject of course to their
31492 own retry data. In other words, recipient error retry data does not take effect
31493 until the next delivery attempt.
31494
31495 Some hosts have been observed to give temporary error responses to every
31496 MAIL command at certain times (&"insufficient space"& has been seen). It
31497 would be nice if such circumstances could be recognized, and defer data for the
31498 host itself created, but this is not possible within the current Exim design.
31499 What actually happens is that retry data for every (host, message) combination
31500 is created.
31501
31502 The reason that timeouts after MAIL and RCPT are treated specially is that
31503 these can sometimes arise as a result of the remote host's verification
31504 procedures. Exim makes this assumption, and treats them as if a temporary error
31505 response had been received. A timeout after &"."& is treated specially because
31506 it is known that some broken implementations fail to recognize the end of the
31507 message if the last character of the last line is a binary zero. Thus, it is
31508 helpful to treat this case as a message error.
31509
31510 Timeouts at other times are treated as host errors, assuming a problem with the
31511 host, or the connection to it. If a timeout after MAIL, RCPT,
31512 or &"."& is really a connection problem, the assumption is that at the next try
31513 the timeout is likely to occur at some other point in the dialogue, causing it
31514 then to be treated as a host error.
31515
31516 There is experimental evidence that some MTAs drop the connection after the
31517 terminating &"."& if they do not like the contents of the message for some
31518 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
31519 should be given. That is why Exim treats this case as a message rather than a
31520 host error, in order not to delay other messages to the same host.
31521
31522
31523
31524
31525 .section "Incoming SMTP messages over TCP/IP" "SECID233"
31526 .cindex "SMTP" "incoming over TCP/IP"
31527 .cindex "incoming SMTP over TCP/IP"
31528 .cindex "inetd"
31529 .cindex "daemon"
31530 Incoming SMTP messages can be accepted in one of two ways: by running a
31531 listening daemon, or by using &'inetd'&. In the latter case, the entry in
31532 &_/etc/inetd.conf_& should be like this:
31533 .code
31534 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
31535 .endd
31536 Exim distinguishes between this case and the case of a locally running user
31537 agent using the &%-bs%& option by checking whether or not the standard input is
31538 a socket. When it is, either the port must be privileged (less than 1024), or
31539 the caller must be root or the Exim user. If any other user passes a socket
31540 with an unprivileged port number, Exim prints a message on the standard error
31541 stream and exits with an error code.
31542
31543 By default, Exim does not make a log entry when a remote host connects or
31544 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
31545 unexpected. It can be made to write such log entries by setting the
31546 &%smtp_connection%& log selector.
31547
31548 .cindex "carriage return"
31549 .cindex "linefeed"
31550 Commands from the remote host are supposed to be terminated by CR followed by
31551 LF. However, there are known to be hosts that do not send CR characters. In
31552 order to be able to interwork with such hosts, Exim treats LF on its own as a
31553 line terminator.
31554 Furthermore, because common code is used for receiving messages from all
31555 sources, a CR on its own is also interpreted as a line terminator. However, the
31556 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
31557
31558 .cindex "EHLO" "invalid data"
31559 .cindex "HELO" "invalid data"
31560 One area that sometimes gives rise to problems concerns the EHLO or
31561 HELO commands. Some clients send syntactically invalid versions of these
31562 commands, which Exim rejects by default. (This is nothing to do with verifying
31563 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
31564 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
31565 match the broken hosts that send invalid commands.
31566
31567 .cindex "SIZE option on MAIL command"
31568 .cindex "MAIL" "SIZE option"
31569 The amount of disk space available is checked whenever SIZE is received on
31570 a MAIL command, independently of whether &%message_size_limit%& or
31571 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
31572 false. A temporary error is given if there is not enough space. If
31573 &%check_spool_space%& is set, the check is for that amount of space plus the
31574 value given with SIZE, that is, it checks that the addition of the incoming
31575 message will not reduce the space below the threshold.
31576
31577 When a message is successfully received, Exim includes the local message id in
31578 its response to the final &"."& that terminates the data. If the remote host
31579 logs this text it can help with tracing what has happened to a message.
31580
31581 The Exim daemon can limit the number of simultaneous incoming connections it is
31582 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
31583 number of simultaneous incoming connections from a single remote host (see the
31584 &%smtp_accept_max_per_host%& option). Additional connection attempts are
31585 rejected using the SMTP temporary error code 421.
31586
31587 The Exim daemon does not rely on the SIGCHLD signal to detect when a
31588 subprocess has finished, as this can get lost at busy times. Instead, it looks
31589 for completed subprocesses every time it wakes up. Provided there are other
31590 things happening (new incoming calls, starts of queue runs), completed
31591 processes will be noticed and tidied away. On very quiet systems you may
31592 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
31593 it will be noticed when the daemon next wakes up.
31594
31595 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
31596 and can also be set up to reject SMTP calls from non-reserved hosts at times of
31597 high system load &-- for details see the &%smtp_accept_reserve%&,
31598 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
31599 applies in both the daemon and &'inetd'& cases.
31600
31601 Exim normally starts a delivery process for each message received, though this
31602 can be varied by means of the &%-odq%& command line option and the
31603 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
31604 number of simultaneously running delivery processes started in this way from
31605 SMTP input can be limited by the &%smtp_accept_queue%& and
31606 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
31607 subsequently received messages are just put on the input queue without starting
31608 a delivery process.
31609
31610 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
31611 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
31612 started up from the &'inetd'& daemon, because in that case each connection is
31613 handled by an entirely independent Exim process. Control by load average is,
31614 however, available with &'inetd'&.
31615
31616 Exim can be configured to verify addresses in incoming SMTP commands as they
31617 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
31618 to rewrite addresses at this time &-- before any syntax checking is done. See
31619 section &<<SECTrewriteS>>&.
31620
31621 Exim can also be configured to limit the rate at which a client host submits
31622 MAIL and RCPT commands in a single SMTP session. See the
31623 &%smtp_ratelimit_hosts%& option.
31624
31625
31626
31627 .section "Unrecognized SMTP commands" "SECID234"
31628 .cindex "SMTP" "unrecognized commands"
31629 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
31630 commands during a single SMTP connection, it drops the connection after sending
31631 the error response to the last command. The default value for
31632 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
31633 abuse that subvert web servers into making connections to SMTP ports; in these
31634 circumstances, a number of non-SMTP lines are sent first.
31635
31636
31637 .section "Syntax and protocol errors in SMTP commands" "SECID235"
31638 .cindex "SMTP" "syntax errors"
31639 .cindex "SMTP" "protocol errors"
31640 A syntax error is detected if an SMTP command is recognized, but there is
31641 something syntactically wrong with its data, for example, a malformed email
31642 address in a RCPT command. Protocol errors include invalid command
31643 sequencing such as RCPT before MAIL. If Exim receives more than
31644 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
31645 drops the connection after sending the error response to the last command. The
31646 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
31647 broken clients that loop sending bad commands (yes, it has been seen).
31648
31649
31650
31651 .section "Use of non-mail SMTP commands" "SECID236"
31652 .cindex "SMTP" "non-mail commands"
31653 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
31654 DATA. Exim counts such commands, and drops the connection if there are too
31655 many of them in a single SMTP session. This action catches some
31656 denial-of-service attempts and things like repeated failing AUTHs, or a mad
31657 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
31658 defines what &"too many"& means. Its default value is 10.
31659
31660 When a new message is expected, one occurrence of RSET is not counted. This
31661 allows a client to send one RSET between messages (this is not necessary,
31662 but some clients do it). Exim also allows one uncounted occurrence of HELO
31663 or EHLO, and one occurrence of STARTTLS between messages. After
31664 starting up a TLS session, another EHLO is expected, and so it too is not
31665 counted.
31666
31667 The first occurrence of AUTH in a connection, or immediately following
31668 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
31669 RCPT, DATA, and QUIT are counted.
31670
31671 You can control which hosts are subject to the limit set by
31672 &%smtp_accept_max_nonmail%& by setting
31673 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
31674 the limit apply to all hosts. This option means that you can exclude any
31675 specific badly-behaved hosts that you have to live with.
31676
31677
31678
31679
31680 .section "The VRFY and EXPN commands" "SECID237"
31681 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
31682 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
31683 appropriate) in order to decide whether the command should be accepted or not.
31684 If no ACL is defined, the command is rejected.
31685
31686 .cindex "VRFY" "processing"
31687 When VRFY is accepted, it runs exactly the same code as when Exim is
31688 called with the &%-bv%& option.
31689
31690 .cindex "EXPN" "processing"
31691 When EXPN is accepted, a single-level expansion of the address is done.
31692 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
31693 than a verification (the &%-bv%& option). If an unqualified local part is given
31694 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
31695 of VRFY and EXPN commands are logged on the main and reject logs, and
31696 VRFY verification failures are logged on the main log for consistency with
31697 RCPT failures.
31698
31699
31700
31701 .section "The ETRN command" "SECTETRN"
31702 .cindex "ETRN" "processing"
31703 RFC 1985 describes an SMTP command called ETRN that is designed to
31704 overcome the security problems of the TURN command (which has fallen into
31705 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
31706 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
31707 should be accepted or not. If no ACL is defined, the command is rejected.
31708
31709 The ETRN command is concerned with &"releasing"& messages that are awaiting
31710 delivery to certain hosts. As Exim does not organize its message queue by host,
31711 the only form of ETRN that is supported by default is the one where the
31712 text starts with the &"#"& prefix, in which case the remainder of the text is
31713 specific to the SMTP server. A valid ETRN command causes a run of Exim with
31714 the &%-R%& option to happen, with the remainder of the ETRN text as its
31715 argument. For example,
31716 .code
31717 ETRN #brigadoon
31718 .endd
31719 runs the command
31720 .code
31721 exim -R brigadoon
31722 .endd
31723 which causes a delivery attempt on all messages with undelivered addresses
31724 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
31725 default), Exim prevents the simultaneous execution of more than one queue run
31726 for the same argument string as a result of an ETRN command. This stops
31727 a misbehaving client from starting more than one queue runner at once.
31728
31729 .cindex "hints database" "ETRN serialization"
31730 Exim implements the serialization by means of a hints database in which a
31731 record is written whenever a process is started by ETRN, and deleted when
31732 the process completes. However, Exim does not keep the SMTP session waiting for
31733 the ETRN process to complete. Once ETRN is accepted, the client is sent
31734 a &"success"& return code. Obviously there is scope for hints records to get
31735 left lying around if there is a system or program crash. To guard against this,
31736 Exim ignores any records that are more than six hours old.
31737
31738 .oindex "&%smtp_etrn_command%&"
31739 For more control over what ETRN does, the &%smtp_etrn_command%& option can
31740 used. This specifies a command that is run whenever ETRN is received,
31741 whatever the form of its argument. For
31742 example:
31743 .code
31744 smtp_etrn_command = /etc/etrn_command $domain \
31745                     $sender_host_address
31746 .endd
31747 .vindex "&$domain$&"
31748 The string is split up into arguments which are independently expanded. The
31749 expansion variable &$domain$& is set to the argument of the ETRN command,
31750 and no syntax checking is done on the contents of this argument. Exim does not
31751 wait for the command to complete, so its status code is not checked. Exim runs
31752 under its own uid and gid when receiving incoming SMTP, so it is not possible
31753 for it to change them before running the command.
31754
31755
31756
31757 .section "Incoming local SMTP" "SECID238"
31758 .cindex "SMTP" "local incoming"
31759 Some user agents use SMTP to pass messages to their local MTA using the
31760 standard input and output, as opposed to passing the envelope on the command
31761 line and writing the message to the standard input. This is supported by the
31762 &%-bs%& option. This form of SMTP is handled in the same way as incoming
31763 messages over TCP/IP (including the use of ACLs), except that the envelope
31764 sender given in a MAIL command is ignored unless the caller is trusted. In
31765 an ACL you can detect this form of SMTP input by testing for an empty host
31766 identification. It is common to have this as the first line in the ACL that
31767 runs for RCPT commands:
31768 .code
31769 accept hosts = :
31770 .endd
31771 This accepts SMTP messages from local processes without doing any other tests.
31772
31773
31774
31775 .section "Outgoing batched SMTP" "SECTbatchSMTP"
31776 .cindex "SMTP" "batched outgoing"
31777 .cindex "batched SMTP output"
31778 Both the &(appendfile)& and &(pipe)& transports can be used for handling
31779 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
31780 be output in BSMTP format. No SMTP responses are possible for this form of
31781 delivery. All it is doing is using SMTP commands as a way of transmitting the
31782 envelope along with the message.
31783
31784 The message is written to the file or pipe preceded by the SMTP commands
31785 MAIL and RCPT, and followed by a line containing a single dot. Lines in
31786 the message that start with a dot have an extra dot added. The SMTP command
31787 HELO is not normally used. If it is required, the &%message_prefix%& option
31788 can be used to specify it.
31789
31790 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
31791 one recipient address at a time by default. However, you can arrange for them
31792 to handle several addresses at once by setting the &%batch_max%& option. When
31793 this is done for BSMTP, messages may contain multiple RCPT commands. See
31794 chapter &<<CHAPbatching>>& for more details.
31795
31796 .vindex "&$host$&"
31797 When one or more addresses are routed to a BSMTP transport by a router that
31798 sets up a host list, the name of the first host on the list is available to the
31799 transport in the variable &$host$&. Here is an example of such a transport and
31800 router:
31801 .code
31802 begin routers
31803 route_append:
31804   driver = manualroute
31805   transport = smtp_appendfile
31806   route_list = domain.example  batch.host.example
31807
31808 begin transports
31809 smtp_appendfile:
31810   driver = appendfile
31811   directory = /var/bsmtp/$host
31812   batch_max = 1000
31813   use_bsmtp
31814   user = exim
31815 .endd
31816 This causes messages addressed to &'domain.example'& to be written in BSMTP
31817 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
31818 message (unless there are more than 1000 recipients).
31819
31820
31821
31822 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
31823 .cindex "SMTP" "batched incoming"
31824 .cindex "batched SMTP input"
31825 The &%-bS%& command line option causes Exim to accept one or more messages by
31826 reading SMTP on the standard input, but to generate no responses. If the caller
31827 is trusted, the senders in the MAIL commands are believed; otherwise the
31828 sender is always the caller of Exim. Unqualified senders and receivers are not
31829 rejected (there seems little point) but instead just get qualified. HELO
31830 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31831 as NOOP; QUIT quits.
31832
31833 Minimal policy checking is done for BSMTP input. Only the non-SMTP
31834 ACL is run in the same way as for non-SMTP local input.
31835
31836 If an error is detected while reading a message, including a missing &"."& at
31837 the end, Exim gives up immediately. It writes details of the error to the
31838 standard output in a stylized way that the calling program should be able to
31839 make some use of automatically, for example:
31840 .code
31841 554 Unexpected end of file
31842 Transaction started in line 10
31843 Error detected in line 14
31844 .endd
31845 It writes a more verbose version, for human consumption, to the standard error
31846 file, for example:
31847 .code
31848 An error was detected while processing a file of BSMTP input.
31849 The error message was:
31850
31851 501 '>' missing at end of address
31852
31853 The SMTP transaction started in line 10.
31854 The error was detected in line 12.
31855 The SMTP command at fault was:
31856
31857 rcpt to:<malformed@in.com.plete
31858
31859 1 previous message was successfully processed.
31860 The rest of the batch was abandoned.
31861 .endd
31862 The return code from Exim is zero only if there were no errors. It is 1 if some
31863 messages were accepted before an error was detected, and 2 if no messages were
31864 accepted.
31865 .ecindex IIDsmtpproc1
31866 .ecindex IIDsmtpproc2
31867
31868
31869
31870 . ////////////////////////////////////////////////////////////////////////////
31871 . ////////////////////////////////////////////////////////////////////////////
31872
31873 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31874          "Customizing messages"
31875 When a message fails to be delivered, or remains on the queue for more than a
31876 configured amount of time, Exim sends a message to the original sender, or
31877 to an alternative configured address. The text of these messages is built into
31878 the code of Exim, but it is possible to change it, either by adding a single
31879 string, or by replacing each of the paragraphs by text supplied in a file.
31880
31881 The &'From:'& and &'To:'& header lines are automatically generated; you can
31882 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31883 option. Exim also adds the line
31884 .code
31885 Auto-Submitted: auto-generated
31886 .endd
31887 to all warning and bounce messages,
31888
31889
31890 .section "Customizing bounce messages" "SECID239"
31891 .cindex "customizing" "bounce message"
31892 .cindex "bounce message" "customizing"
31893 If &%bounce_message_text%& is set, its contents are included in the default
31894 message immediately after &"This message was created automatically by mail
31895 delivery software."& The string is not expanded. It is not used if
31896 &%bounce_message_file%& is set.
31897
31898 When &%bounce_message_file%& is set, it must point to a template file for
31899 constructing error messages. The file consists of a series of text items,
31900 separated by lines consisting of exactly four asterisks. If the file cannot be
31901 opened, default text is used and a message is written to the main and panic
31902 logs. If any text item in the file is empty, default text is used for that
31903 item.
31904
31905 .vindex "&$bounce_recipient$&"
31906 .vindex "&$bounce_return_size_limit$&"
31907 Each item of text that is read from the file is expanded, and there are two
31908 expansion variables which can be of use here: &$bounce_recipient$& is set to
31909 the recipient of an error message while it is being created, and
31910 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31911 option, rounded to a whole number.
31912
31913 The items must appear in the file in the following order:
31914
31915 .ilist
31916 The first item is included in the headers, and should include at least a
31917 &'Subject:'& header. Exim does not check the syntax of these headers.
31918 .next
31919 The second item forms the start of the error message. After it, Exim lists the
31920 failing addresses with their error messages.
31921 .next
31922 The third item is used to introduce any text from pipe transports that is to be
31923 returned to the sender. It is omitted if there is no such text.
31924 .next
31925 The fourth item is used to introduce the copy of the message that is returned
31926 as part of the error report.
31927 .next
31928 The fifth item is added after the fourth one if the returned message is
31929 truncated because it is bigger than &%return_size_limit%&.
31930 .next
31931 The sixth item is added after the copy of the original message.
31932 .endlist
31933
31934 The default state (&%bounce_message_file%& unset) is equivalent to the
31935 following file, in which the sixth item is empty. The &'Subject:'& and some
31936 other lines have been split in order to fit them on the page:
31937 .code
31938 Subject: Mail delivery failed
31939   ${if eq{$sender_address}{$bounce_recipient}
31940   {: returning message to sender}}
31941 ****
31942 This message was created automatically by mail delivery software.
31943
31944 A message ${if eq{$sender_address}{$bounce_recipient}
31945   {that you sent }{sent by
31946
31947 <$sender_address>
31948
31949 }}could not be delivered to all of its recipients.
31950 This is a permanent error. The following address(es) failed:
31951 ****
31952 The following text was generated during the delivery attempt(s):
31953 ****
31954 ------ This is a copy of the message, including all the headers.
31955   ------
31956 ****
31957 ------ The body of the message is $message_size characters long;
31958   only the first
31959 ------ $bounce_return_size_limit or so are included here.
31960 ****
31961 .endd
31962 .section "Customizing warning messages" "SECTcustwarn"
31963 .cindex "customizing" "warning message"
31964 .cindex "warning of delay" "customizing the message"
31965 The option &%warn_message_file%& can be pointed at a template file for use when
31966 warnings about message delays are created. In this case there are only three
31967 text sections:
31968
31969 .ilist
31970 The first item is included in the headers, and should include at least a
31971 &'Subject:'& header. Exim does not check the syntax of these headers.
31972 .next
31973 The second item forms the start of the warning message. After it, Exim lists
31974 the delayed addresses.
31975 .next
31976 The third item then ends the message.
31977 .endlist
31978
31979 The default state is equivalent to the following file, except that some lines
31980 have been split here, in order to fit them on the page:
31981 .code
31982 Subject: Warning: message $message_exim_id delayed
31983   $warn_message_delay
31984 ****
31985 This message was created automatically by mail delivery software.
31986
31987 A message ${if eq{$sender_address}{$warn_message_recipients}
31988 {that you sent }{sent by
31989
31990 <$sender_address>
31991
31992 }}has not been delivered to all of its recipients after
31993 more than $warn_message_delay on the queue on $primary_hostname.
31994
31995 The message identifier is:     $message_exim_id
31996 The subject of the message is: $h_subject
31997 The date of the message is:    $h_date
31998
31999 The following address(es) have not yet been delivered:
32000 ****
32001 No action is required on your part. Delivery attempts will
32002 continue for some time, and this warning may be repeated at
32003 intervals if the message remains undelivered. Eventually the
32004 mail delivery software will give up, and when that happens,
32005 the message will be returned to you.
32006 .endd
32007 .vindex "&$warn_message_delay$&"
32008 .vindex "&$warn_message_recipients$&"
32009 However, in the default state the subject and date lines are omitted if no
32010 appropriate headers exist. During the expansion of this file,
32011 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32012 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32013 of recipients for the warning message. There may be more than one if there are
32014 multiple addresses with different &%errors_to%& settings on the routers that
32015 handled them.
32016
32017
32018
32019
32020 . ////////////////////////////////////////////////////////////////////////////
32021 . ////////////////////////////////////////////////////////////////////////////
32022
32023 .chapter "Some common configuration settings" "CHAPcomconreq"
32024 This chapter discusses some configuration settings that seem to be fairly
32025 common. More examples and discussion can be found in the Exim book.
32026
32027
32028
32029 .section "Sending mail to a smart host" "SECID240"
32030 .cindex "smart host" "example router"
32031 If you want to send all mail for non-local domains to a &"smart host"&, you
32032 should replace the default &(dnslookup)& router with a router which does the
32033 routing explicitly:
32034 .code
32035 send_to_smart_host:
32036   driver = manualroute
32037   route_list = !+local_domains smart.host.name
32038   transport = remote_smtp
32039 .endd
32040 You can use the smart host's IP address instead of the name if you wish.
32041 If you are using Exim only to submit messages to a smart host, and not for
32042 receiving incoming messages, you can arrange for it to do the submission
32043 synchronously by setting the &%mua_wrapper%& option (see chapter
32044 &<<CHAPnonqueueing>>&).
32045
32046
32047
32048
32049 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32050 .cindex "mailing lists"
32051 Exim can be used to run simple mailing lists, but for large and/or complicated
32052 requirements, the use of additional specialized mailing list software such as
32053 Majordomo or Mailman is recommended.
32054
32055 The &(redirect)& router can be used to handle mailing lists where each list
32056 is maintained in a separate file, which can therefore be managed by an
32057 independent manager. The &%domains%& router option can be used to run these
32058 lists in a separate domain from normal mail. For example:
32059 .code
32060 lists:
32061   driver = redirect
32062   domains = lists.example
32063   file = /usr/lists/$local_part
32064   forbid_pipe
32065   forbid_file
32066   errors_to = $local_part-request@lists.example
32067   no_more
32068 .endd
32069 This router is skipped for domains other than &'lists.example'&. For addresses
32070 in that domain, it looks for a file that matches the local part. If there is no
32071 such file, the router declines, but because &%no_more%& is set, no subsequent
32072 routers are tried, and so the whole delivery fails.
32073
32074 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32075 expanded into a file name or a pipe delivery, which is usually inappropriate in
32076 a mailing list.
32077
32078 .oindex "&%errors_to%&"
32079 The &%errors_to%& option specifies that any delivery errors caused by addresses
32080 taken from a mailing list are to be sent to the given address rather than the
32081 original sender of the message. However, before acting on this, Exim verifies
32082 the error address, and ignores it if verification fails.
32083
32084 For example, using the configuration above, mail sent to
32085 &'dicts@lists.example'& is passed on to those addresses contained in
32086 &_/usr/lists/dicts_&, with error reports directed to
32087 &'dicts-request@lists.example'&, provided that this address can be verified.
32088 There could be a file called &_/usr/lists/dicts-request_& containing
32089 the address(es) of this particular list's manager(s), but other approaches,
32090 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32091 or &%local_part_suffix%& options) to handle addresses of the form
32092 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32093
32094
32095
32096 .section "Syntax errors in mailing lists" "SECID241"
32097 .cindex "mailing lists" "syntax errors in"
32098 If an entry in redirection data contains a syntax error, Exim normally defers
32099 delivery of the original address. That means that a syntax error in a mailing
32100 list holds up all deliveries to the list. This may not be appropriate when a
32101 list is being maintained automatically from data supplied by users, and the
32102 addresses are not rigorously checked.
32103
32104 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32105 entries that fail to parse, noting the incident in the log. If in addition
32106 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32107 whenever a broken address is skipped. It is usually appropriate to set
32108 &%syntax_errors_to%& to the same address as &%errors_to%&.
32109
32110
32111
32112 .section "Re-expansion of mailing lists" "SECID242"
32113 .cindex "mailing lists" "re-expansion of"
32114 Exim remembers every individual address to which a message has been delivered,
32115 in order to avoid duplication, but it normally stores only the original
32116 recipient addresses with a message. If all the deliveries to a mailing list
32117 cannot be done at the first attempt, the mailing list is re-expanded when the
32118 delivery is next tried. This means that alterations to the list are taken into
32119 account at each delivery attempt, so addresses that have been added to
32120 the list since the message arrived will therefore receive a copy of the
32121 message, even though it pre-dates their subscription.
32122
32123 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32124 on the &(redirect)& router. If this is done, any addresses generated by the
32125 router that fail to deliver at the first attempt are added to the message as
32126 &"top level"& addresses, and the parent address that generated them is marked
32127 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32128 subsequent delivery attempts. The disadvantage of this is that if any of the
32129 failing addresses are incorrect, correcting them in the file has no effect on
32130 pre-existing messages.
32131
32132 The original top-level address is remembered with each of the generated
32133 addresses, and is output in any log messages. However, any intermediate parent
32134 addresses are not recorded. This makes a difference to the log only if the
32135 &%all_parents%& selector is set, but for mailing lists there is normally only
32136 one level of expansion anyway.
32137
32138
32139
32140 .section "Closed mailing lists" "SECID243"
32141 .cindex "mailing lists" "closed"
32142 The examples so far have assumed open mailing lists, to which anybody may
32143 send mail. It is also possible to set up closed lists, where mail is accepted
32144 from specified senders only. This is done by making use of the generic
32145 &%senders%& option to restrict the router that handles the list.
32146
32147 The following example uses the same file as a list of recipients and as a list
32148 of permitted senders. It requires three routers:
32149 .code
32150 lists_request:
32151   driver = redirect
32152   domains = lists.example
32153   local_part_suffix = -request
32154   file = /usr/lists/$local_part$local_part_suffix
32155   no_more
32156
32157 lists_post:
32158   driver = redirect
32159   domains = lists.example
32160   senders = ${if exists {/usr/lists/$local_part}\
32161              {lsearch;/usr/lists/$local_part}{*}}
32162   file = /usr/lists/$local_part
32163   forbid_pipe
32164   forbid_file
32165   errors_to = $local_part-request@lists.example
32166   no_more
32167
32168 lists_closed:
32169   driver = redirect
32170   domains = lists.example
32171   allow_fail
32172   data = :fail: $local_part@lists.example is a closed mailing list
32173 .endd
32174 All three routers have the same &%domains%& setting, so for any other domains,
32175 they are all skipped. The first router runs only if the local part ends in
32176 &%-request%&. It handles messages to the list manager(s) by means of an open
32177 mailing list.
32178
32179 The second router runs only if the &%senders%& precondition is satisfied. It
32180 checks for the existence of a list that corresponds to the local part, and then
32181 checks that the sender is on the list by means of a linear search. It is
32182 necessary to check for the existence of the file before trying to search it,
32183 because otherwise Exim thinks there is a configuration error. If the file does
32184 not exist, the expansion of &%senders%& is *, which matches all senders. This
32185 means that the router runs, but because there is no list, declines, and
32186 &%no_more%& ensures that no further routers are run. The address fails with an
32187 &"unrouteable address"& error.
32188
32189 The third router runs only if the second router is skipped, which happens when
32190 a mailing list exists, but the sender is not on it. This router forcibly fails
32191 the address, giving a suitable error message.
32192
32193
32194
32195
32196 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32197 .cindex "VERP"
32198 .cindex "Variable Envelope Return Paths"
32199 .cindex "envelope sender"
32200 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32201 are a way of helping mailing list administrators discover which subscription
32202 address is the cause of a particular delivery failure. The idea is to encode
32203 the original recipient address in the outgoing envelope sender address, so that
32204 if the message is forwarded by another host and then subsequently bounces, the
32205 original recipient can be extracted from the recipient address of the bounce.
32206
32207 .oindex &%errors_to%&
32208 .oindex &%return_path%&
32209 Envelope sender addresses can be modified by Exim using two different
32210 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32211 list examples), or the &%return_path%& option on a transport. The second of
32212 these is effective only if the message is successfully delivered to another
32213 host; it is not used for errors detected on the local host (see the description
32214 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32215 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32216 .code
32217 verp_smtp:
32218   driver = smtp
32219   max_rcpt = 1
32220   return_path = \
32221     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32222       {$1-request+$local_part=$domain@your.dom.example}fail}
32223 .endd
32224 This has the effect of rewriting the return path (envelope sender) on outgoing
32225 SMTP messages, if the local part of the original return path ends in
32226 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32227 local part and domain of the recipient into the return path. Suppose, for
32228 example, that a message whose return path has been set to
32229 &'somelist-request@your.dom.example'& is sent to
32230 &'subscriber@other.dom.example'&. In the transport, the return path is
32231 rewritten as
32232 .code
32233 somelist-request+subscriber=other.dom.example@your.dom.example
32234 .endd
32235 .vindex "&$local_part$&"
32236 For this to work, you must tell Exim to send multiple copies of messages that
32237 have more than one recipient, so that each copy has just one recipient. This is
32238 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32239 might be sent to several different recipients in the same domain, in which case
32240 &$local_part$& is not available in the transport, because it is not unique.
32241
32242 Unless your host is doing nothing but mailing list deliveries, you should
32243 probably use a separate transport for the VERP deliveries, so as not to use
32244 extra resources in making one-per-recipient copies for other deliveries. This
32245 can easily be done by expanding the &%transport%& option in the router:
32246 .code
32247 dnslookup:
32248   driver = dnslookup
32249   domains = ! +local_domains
32250   transport = \
32251     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32252       {verp_smtp}{remote_smtp}}
32253   no_more
32254 .endd
32255 If you want to change the return path using &%errors_to%& in a router instead
32256 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32257 routers that handle mailing list addresses. This will ensure that all delivery
32258 errors, including those detected on the local host, are sent to the VERP
32259 address.
32260
32261 On a host that does no local deliveries and has no manual routing, only the
32262 &(dnslookup)& router needs to be changed. A special transport is not needed for
32263 SMTP deliveries. Every mailing list recipient has its own return path value,
32264 and so Exim must hand them to the transport one at a time. Here is an example
32265 of a &(dnslookup)& router that implements VERP:
32266 .code
32267 verp_dnslookup:
32268   driver = dnslookup
32269   domains = ! +local_domains
32270   transport = remote_smtp
32271   errors_to = \
32272     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32273      {$1-request+$local_part=$domain@your.dom.example}fail}
32274   no_more
32275 .endd
32276 Before you start sending out messages with VERPed return paths, you must also
32277 configure Exim to accept the bounce messages that come back to those paths.
32278 Typically this is done by setting a &%local_part_suffix%& option for a
32279 router, and using this to route the messages to wherever you want to handle
32280 them.
32281
32282 The overhead incurred in using VERP depends very much on the size of the
32283 message, the number of recipient addresses that resolve to the same remote
32284 host, and the speed of the connection over which the message is being sent. If
32285 a lot of addresses resolve to the same host and the connection is slow, sending
32286 a separate copy of the message for each address may take substantially longer
32287 than sending a single copy with many recipients (for which VERP cannot be
32288 used).
32289
32290
32291
32292
32293
32294
32295 .section "Virtual domains" "SECTvirtualdomains"
32296 .cindex "virtual domains"
32297 .cindex "domain" "virtual"
32298 The phrase &'virtual domain'& is unfortunately used with two rather different
32299 meanings:
32300
32301 .ilist
32302 A domain for which there are no real mailboxes; all valid local parts are
32303 aliases for other email addresses. Common examples are organizational
32304 top-level domains and &"vanity"& domains.
32305 .next
32306 One of a number of independent domains that are all handled by the same host,
32307 with mailboxes on that host, but where the mailbox owners do not necessarily
32308 have login accounts on that host.
32309 .endlist
32310
32311 The first usage is probably more common, and does seem more &"virtual"& than
32312 the second. This kind of domain can be handled in Exim with a straightforward
32313 aliasing router. One approach is to create a separate alias file for each
32314 virtual domain. Exim can test for the existence of the alias file to determine
32315 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
32316 to a router of this form:
32317 .code
32318 virtual:
32319   driver = redirect
32320   domains = dsearch;/etc/mail/virtual
32321   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
32322   no_more
32323 .endd
32324 The &%domains%& option specifies that the router is to be skipped, unless there
32325 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
32326 domain that is being processed. When the router runs, it looks up the local
32327 part in the file to find a new address (or list of addresses). The &%no_more%&
32328 setting ensures that if the lookup fails (leading to &%data%& being an empty
32329 string), Exim gives up on the address without trying any subsequent routers.
32330
32331 This one router can handle all the virtual domains because the alias file names
32332 follow a fixed pattern. Permissions can be arranged so that appropriate people
32333 can edit the different alias files. A successful aliasing operation results in
32334 a new envelope recipient address, which is then routed from scratch.
32335
32336 The other kind of &"virtual"& domain can also be handled in a straightforward
32337 way. One approach is to create a file for each domain containing a list of
32338 valid local parts, and use it in a router like this:
32339 .code
32340 my_domains:
32341   driver = accept
32342   domains = dsearch;/etc/mail/domains
32343   local_parts = lsearch;/etc/mail/domains/$domain
32344   transport = my_mailboxes
32345 .endd
32346 The address is accepted if there is a file for the domain, and the local part
32347 can be found in the file. The &%domains%& option is used to check for the
32348 file's existence because &%domains%& is tested before the &%local_parts%&
32349 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
32350 because that option is tested after &%local_parts%&. The transport is as
32351 follows:
32352 .code
32353 my_mailboxes:
32354   driver = appendfile
32355   file = /var/mail/$domain/$local_part
32356   user = mail
32357 .endd
32358 This uses a directory of mailboxes for each domain. The &%user%& setting is
32359 required, to specify which uid is to be used for writing to the mailboxes.
32360
32361 The configuration shown here is just one example of how you might support this
32362 requirement. There are many other ways this kind of configuration can be set
32363 up, for example, by using a database instead of separate files to hold all the
32364 information about the domains.
32365
32366
32367
32368 .section "Multiple user mailboxes" "SECTmulbox"
32369 .cindex "multiple mailboxes"
32370 .cindex "mailbox" "multiple"
32371 .cindex "local part" "prefix"
32372 .cindex "local part" "suffix"
32373 Heavy email users often want to operate with multiple mailboxes, into which
32374 incoming mail is automatically sorted. A popular way of handling this is to
32375 allow users to use multiple sender addresses, so that replies can easily be
32376 identified. Users are permitted to add prefixes or suffixes to their local
32377 parts for this purpose. The wildcard facility of the generic router options
32378 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
32379 example, consider this router:
32380 .code
32381 userforward:
32382   driver = redirect
32383   check_local_user
32384   file = $home/.forward
32385   local_part_suffix = -*
32386   local_part_suffix_optional
32387   allow_filter
32388 .endd
32389 .vindex "&$local_part_suffix$&"
32390 It runs a user's &_.forward_& file for all local parts of the form
32391 &'username-*'&. Within the filter file the user can distinguish different
32392 cases by testing the variable &$local_part_suffix$&. For example:
32393 .code
32394 if $local_part_suffix contains -special then
32395 save /home/$local_part/Mail/special
32396 endif
32397 .endd
32398 If the filter file does not exist, or does not deal with such addresses, they
32399 fall through to subsequent routers, and, assuming no subsequent use of the
32400 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
32401 control over which suffixes are valid.
32402
32403 Alternatively, a suffix can be used to trigger the use of a different
32404 &_.forward_& file &-- which is the way a similar facility is implemented in
32405 another MTA:
32406 .code
32407 userforward:
32408   driver = redirect
32409   check_local_user
32410   file = $home/.forward$local_part_suffix
32411   local_part_suffix = -*
32412   local_part_suffix_optional
32413   allow_filter
32414 .endd
32415 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
32416 example, &_.forward-special_& is used. Once again, if the appropriate file
32417 does not exist, or does not deal with the address, it is passed on to
32418 subsequent routers, which could, if required, look for an unqualified
32419 &_.forward_& file to use as a default.
32420
32421
32422
32423 .section "Simplified vacation processing" "SECID244"
32424 .cindex "vacation processing"
32425 The traditional way of running the &'vacation'& program is for a user to set up
32426 a pipe command in a &_.forward_& file
32427 (see section &<<SECTspecitredli>>& for syntax details).
32428 This is prone to error by inexperienced users. There are two features of Exim
32429 that can be used to make this process simpler for users:
32430
32431 .ilist
32432 A local part prefix such as &"vacation-"& can be specified on a router which
32433 can cause the message to be delivered directly to the &'vacation'& program, or
32434 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
32435 &_.forward_& file are then much simpler. For example:
32436 .code
32437 spqr, vacation-spqr
32438 .endd
32439 .next
32440 The &%require_files%& generic router option can be used to trigger a
32441 vacation delivery by checking for the existence of a certain file in the
32442 user's home directory. The &%unseen%& generic option should also be used, to
32443 ensure that the original delivery also proceeds. In this case, all the user has
32444 to do is to create a file called, say, &_.vacation_&, containing a vacation
32445 message.
32446 .endlist
32447
32448 Another advantage of both these methods is that they both work even when the
32449 use of arbitrary pipes by users is locked out.
32450
32451
32452
32453 .section "Taking copies of mail" "SECID245"
32454 .cindex "message" "copying every"
32455 Some installations have policies that require archive copies of all messages to
32456 be made. A single copy of each message can easily be taken by an appropriate
32457 command in a system filter, which could, for example, use a different file for
32458 each day's messages.
32459
32460 There is also a shadow transport mechanism that can be used to take copies of
32461 messages that are successfully delivered by local transports, one copy per
32462 delivery. This could be used, &'inter alia'&, to implement automatic
32463 notification of delivery by sites that insist on doing such things.
32464
32465
32466
32467 .section "Intermittently connected hosts" "SECID246"
32468 .cindex "intermittently connected hosts"
32469 It has become quite common (because it is cheaper) for hosts to connect to the
32470 Internet periodically rather than remain connected all the time. The normal
32471 arrangement is that mail for such hosts accumulates on a system that is
32472 permanently connected.
32473
32474 Exim was designed for use on permanently connected hosts, and so it is not
32475 particularly well-suited to use in an intermittently connected environment.
32476 Nevertheless there are some features that can be used.
32477
32478
32479 .section "Exim on the upstream server host" "SECID247"
32480 It is tempting to arrange for incoming mail for the intermittently connected
32481 host to remain on Exim's queue until the client connects. However, this
32482 approach does not scale very well. Two different kinds of waiting message are
32483 being mixed up in the same queue &-- those that cannot be delivered because of
32484 some temporary problem, and those that are waiting for their destination host
32485 to connect. This makes it hard to manage the queue, as well as wasting
32486 resources, because each queue runner scans the entire queue.
32487
32488 A better approach is to separate off those messages that are waiting for an
32489 intermittently connected host. This can be done by delivering these messages
32490 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
32491 format, from where they are transmitted by other software when their
32492 destination connects. This makes it easy to collect all the mail for one host
32493 in a single directory, and to apply local timeout rules on a per-message basis
32494 if required.
32495
32496 On a very small scale, leaving the mail on Exim's queue can be made to work. If
32497 you are doing this, you should configure Exim with a long retry period for the
32498 intermittent host. For example:
32499 .code
32500 cheshire.wonderland.fict.example    *   F,5d,24h
32501 .endd
32502 This stops a lot of failed delivery attempts from occurring, but Exim remembers
32503 which messages it has queued up for that host. Once the intermittent host comes
32504 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
32505 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
32506 causes all the queued up messages to be delivered, often down a single SMTP
32507 connection. While the host remains connected, any new messages get delivered
32508 immediately.
32509
32510 If the connecting hosts do not have fixed IP addresses, that is, if a host is
32511 issued with a different IP address each time it connects, Exim's retry
32512 mechanisms on the holding host get confused, because the IP address is normally
32513 used as part of the key string for holding retry information. This can be
32514 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
32515 Since this has disadvantages for permanently connected hosts, it is best to
32516 arrange a separate transport for the intermittently connected ones.
32517
32518
32519
32520 .section "Exim on the intermittently connected client host" "SECID248"
32521 The value of &%smtp_accept_queue_per_connection%& should probably be
32522 increased, or even set to zero (that is, disabled) on the intermittently
32523 connected host, so that all incoming messages down a single connection get
32524 delivered immediately.
32525
32526 .cindex "SMTP" "passed connection"
32527 .cindex "SMTP" "multiple deliveries"
32528 .cindex "multiple SMTP deliveries"
32529 Mail waiting to be sent from an intermittently connected host will probably
32530 not have been routed, because without a connection DNS lookups are not
32531 possible. This means that if a normal queue run is done at connection time,
32532 each message is likely to be sent in a separate SMTP session. This can be
32533 avoided by starting the queue run with a command line option beginning with
32534 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
32535 first pass, routing is done but no deliveries take place. The second pass is a
32536 normal queue run; since all the messages have been previously routed, those
32537 destined for the same host are likely to get sent as multiple deliveries in a
32538 single SMTP connection.
32539
32540
32541
32542 . ////////////////////////////////////////////////////////////////////////////
32543 . ////////////////////////////////////////////////////////////////////////////
32544
32545 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
32546          "Exim as a non-queueing client"
32547 .cindex "client, non-queueing"
32548 .cindex "smart host" "suppressing queueing"
32549 On a personal computer, it is a common requirement for all
32550 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
32551 configured to operate that way, for all the popular operating systems.
32552 However, there are some MUAs for Unix-like systems that cannot be so
32553 configured: they submit messages using the command line interface of
32554 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
32555 messages this way.
32556
32557 If the personal computer runs continuously, there is no problem, because it can
32558 run a conventional MTA that handles delivery to the smart host, and deal with
32559 any delays via its queueing mechanism. However, if the computer does not run
32560 continuously or runs different operating systems at different times, queueing
32561 email is not desirable.
32562
32563 There is therefore a requirement for something that can provide the
32564 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
32565 any queueing or retrying facilities. Furthermore, the delivery to the smart
32566 host should be synchronous, so that if it fails, the sending MUA is immediately
32567 informed. In other words, we want something that extends an MUA that submits
32568 to a local MTA via the command line so that it behaves like one that submits
32569 to a remote smart host using TCP/SMTP.
32570
32571 There are a number of applications (for example, there is one called &'ssmtp'&)
32572 that do this job. However, people have found them to be lacking in various
32573 ways. For instance, you might want to allow aliasing and forwarding to be done
32574 before sending a message to the smart host.
32575
32576 Exim already had the necessary infrastructure for doing this job. Just a few
32577 tweaks were needed to make it behave as required, though it is somewhat of an
32578 overkill to use a fully-featured MTA for this purpose.
32579
32580 .oindex "&%mua_wrapper%&"
32581 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
32582 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
32583 assumes that it is being used to &"wrap"& a command-line MUA in the manner
32584 just described. As well as setting &%mua_wrapper%&, you also need to provide a
32585 compatible router and transport configuration. Typically there will be just one
32586 router and one transport, sending everything to a smart host.
32587
32588 When run in MUA wrapping mode, the behaviour of Exim changes in the
32589 following ways:
32590
32591 .ilist
32592 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
32593 In other words, the only way to submit messages is via the command line.
32594 .next
32595 Each message is synchronously delivered as soon as it is received (&%-odi%& is
32596 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
32597 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
32598 does not finish until the delivery attempt is complete. If the delivery is
32599 successful, a zero return code is given.
32600 .next
32601 Address redirection is permitted, but the final routing for all addresses must
32602 be to the same remote transport, and to the same list of hosts. Furthermore,
32603 the return address (envelope sender) must be the same for all recipients, as
32604 must any added or deleted header lines. In other words, it must be possible to
32605 deliver the message in a single SMTP transaction, however many recipients there
32606 are.
32607 .next
32608 If these conditions are not met, or if routing any address results in a
32609 failure or defer status, or if Exim is unable to deliver all the recipients
32610 successfully to one of the smart hosts, delivery of the entire message fails.
32611 .next
32612 Because no queueing is allowed, all failures are treated as permanent; there
32613 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
32614 smart host. Furthermore, because only a single yes/no response can be given to
32615 the caller, it is not possible to deliver to some recipients and not others. If
32616 there is an error (temporary or permanent) for any recipient, all are failed.
32617 .next
32618 If more than one smart host is listed, Exim will try another host after a
32619 connection failure or a timeout, in the normal way. However, if this kind of
32620 failure happens for all the hosts, the delivery fails.
32621 .next
32622 When delivery fails, an error message is written to the standard error stream
32623 (as well as to Exim's log), and Exim exits to the caller with a return code
32624 value 1. The message is expunged from Exim's spool files. No bounce messages
32625 are ever generated.
32626 .next
32627 No retry data is maintained, and any retry rules are ignored.
32628 .next
32629 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
32630 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
32631 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
32632 .endlist
32633
32634 The overall effect is that Exim makes a single synchronous attempt to deliver
32635 the message, failing if there is any kind of problem. Because no local
32636 deliveries are done and no daemon can be run, Exim does not need root
32637 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
32638 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
32639 the advantages and disadvantages of running without root privilege.
32640
32641
32642
32643
32644 . ////////////////////////////////////////////////////////////////////////////
32645 . ////////////////////////////////////////////////////////////////////////////
32646
32647 .chapter "Log files" "CHAPlog"
32648 .scindex IIDloggen "log" "general description"
32649 .cindex "log" "types of"
32650 Exim writes three different logs, referred to as the main log, the reject log,
32651 and the panic log:
32652
32653 .ilist
32654 .cindex "main log"
32655 The main log records the arrival of each message and each delivery in a single
32656 line in each case. The format is as compact as possible, in an attempt to keep
32657 down the size of log files. Two-character flag sequences make it easy to pick
32658 out these lines. A number of other events are recorded in the main log. Some of
32659 them are optional, in which case the &%log_selector%& option controls whether
32660 they are included or not. A Perl script called &'eximstats'&, which does simple
32661 analysis of main log files, is provided in the Exim distribution (see section
32662 &<<SECTmailstat>>&).
32663 .next
32664 .cindex "reject log"
32665 The reject log records information from messages that are rejected as a result
32666 of a configuration option (that is, for policy reasons).
32667 The first line of each rejection is a copy of the line that is also written to
32668 the main log. Then, if the message's header has been read at the time the log
32669 is written, its contents are written to this log. Only the original header
32670 lines are available; header lines added by ACLs are not logged. You can use the
32671 reject log to check that your policy controls are working correctly; on a busy
32672 host this may be easier than scanning the main log for rejection messages. You
32673 can suppress the writing of the reject log by setting &%write_rejectlog%&
32674 false.
32675 .next
32676 .cindex "panic log"
32677 .cindex "system log"
32678 When certain serious errors occur, Exim writes entries to its panic log. If the
32679 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
32680 are usually written to the main log as well, but can get lost amid the mass of
32681 other entries. The panic log should be empty under normal circumstances. It is
32682 therefore a good idea to check it (or to have a &'cron'& script check it)
32683 regularly, in order to become aware of any problems. When Exim cannot open its
32684 panic log, it tries as a last resort to write to the system log (syslog). This
32685 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
32686 message itself is written at priority LOG_CRIT.
32687 .endlist
32688
32689 Every log line starts with a timestamp, in the format shown in the following
32690 example. Note that many of the examples shown in this chapter are line-wrapped.
32691 In the log file, this would be all on one line:
32692 .code
32693 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
32694   by QUIT
32695 .endd
32696 By default, the timestamps are in the local timezone. There are two
32697 ways of changing this:
32698
32699 .ilist
32700 You can set the &%timezone%& option to a different time zone; in particular, if
32701 you set
32702 .code
32703 timezone = UTC
32704 .endd
32705 the timestamps will be in UTC (aka GMT).
32706 .next
32707 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
32708 example:
32709 .code
32710 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
32711 .endd
32712 .endlist
32713
32714 .cindex "log" "process ids in"
32715 .cindex "pid (process id)" "in log lines"
32716 Exim does not include its process id in log lines by default, but you can
32717 request that it does so by specifying the &`pid`& log selector (see section
32718 &<<SECTlogselector>>&). When this is set, the process id is output, in square
32719 brackets, immediately after the time and date.
32720
32721
32722
32723
32724 .section "Where the logs are written" "SECTwhelogwri"
32725 .cindex "log" "destination"
32726 .cindex "log" "to file"
32727 .cindex "log" "to syslog"
32728 .cindex "syslog"
32729 The logs may be written to local files, or to syslog, or both. However, it
32730 should be noted that many syslog implementations use UDP as a transport, and
32731 are therefore unreliable in the sense that messages are not guaranteed to
32732 arrive at the loghost, nor is the ordering of messages necessarily maintained.
32733 It has also been reported that on large log files (tens of megabytes) you may
32734 need to tweak syslog to prevent it syncing the file with each write &-- on
32735 Linux this has been seen to make syslog take 90% plus of CPU time.
32736
32737 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
32738 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
32739 configuration. This latter string is expanded, so it can contain, for example,
32740 references to the host name:
32741 .code
32742 log_file_path = /var/log/$primary_hostname/exim_%slog
32743 .endd
32744 It is generally advisable, however, to set the string in &_Local/Makefile_&
32745 rather than at run time, because then the setting is available right from the
32746 start of Exim's execution. Otherwise, if there's something it wants to log
32747 before it has read the configuration file (for example, an error in the
32748 configuration file) it will not use the path you want, and may not be able to
32749 log at all.
32750
32751 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
32752 list, currently limited to at most two items. This is one option where the
32753 facility for changing a list separator may not be used. The list must always be
32754 colon-separated. If an item in the list is &"syslog"& then syslog is used;
32755 otherwise the item must either be an absolute path, containing &`%s`& at the
32756 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
32757 implying the use of a default path.
32758
32759 When Exim encounters an empty item in the list, it searches the list defined by
32760 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
32761 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
32762 mean &"use the path specified at build time"&. It no such item exists, log
32763 files are written in the &_log_& subdirectory of the spool directory. This is
32764 equivalent to the setting:
32765 .code
32766 log_file_path = $spool_directory/log/%slog
32767 .endd
32768 If you do not specify anything at build time or run time, that is where the
32769 logs are written.
32770
32771 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
32772 are in use &-- see section &<<SECTdatlogfil>>& below.
32773
32774 Here are some examples of possible settings:
32775 .display
32776 &`LOG_FILE_PATH=syslog                    `& syslog only
32777 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
32778 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
32779 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
32780 .endd
32781 If there are more than two paths in the list, the first is used and a panic
32782 error is logged.
32783
32784
32785
32786 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
32787 .cindex "log" "cycling local files"
32788 .cindex "cycling logs"
32789 .cindex "&'exicyclog'&"
32790 .cindex "log" "local files; writing to"
32791 Some operating systems provide centralized and standardized methods for cycling
32792 log files. For those that do not, a utility script called &'exicyclog'& is
32793 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
32794 main and reject logs each time it is called. The maximum number of old logs to
32795 keep can be set. It is suggested this script is run as a daily &'cron'& job.
32796
32797 An Exim delivery process opens the main log when it first needs to write to it,
32798 and it keeps the file open in case subsequent entries are required &-- for
32799 example, if a number of different deliveries are being done for the same
32800 message. However, remote SMTP deliveries can take a long time, and this means
32801 that the file may be kept open long after it is renamed if &'exicyclog'& or
32802 something similar is being used to rename log files on a regular basis. To
32803 ensure that a switch of log files is noticed as soon as possible, Exim calls
32804 &[stat()]& on the main log's name before reusing an open file, and if the file
32805 does not exist, or its inode has changed, the old file is closed and Exim
32806 tries to open the main log from scratch. Thus, an old log file may remain open
32807 for quite some time, but no Exim processes should write to it once it has been
32808 renamed.
32809
32810
32811
32812 .section "Datestamped log files" "SECTdatlogfil"
32813 .cindex "log" "datestamped files"
32814 Instead of cycling the main and reject log files by renaming them
32815 periodically, some sites like to use files whose names contain a datestamp,
32816 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
32817 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
32818 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
32819 point where the datestamp is required. For example:
32820 .code
32821 log_file_path = /var/spool/exim/log/%slog-%D
32822 log_file_path = /var/log/exim-%s-%D.log
32823 log_file_path = /var/spool/exim/log/%D-%slog
32824 log_file_path = /var/log/exim/%s.%M
32825 .endd
32826 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32827 examples of names generated by the above examples:
32828 .code
32829 /var/spool/exim/log/mainlog-20021225
32830 /var/log/exim-reject-20021225.log
32831 /var/spool/exim/log/20021225-mainlog
32832 /var/log/exim/main.200212
32833 .endd
32834 When this form of log file is specified, Exim automatically switches to new
32835 files at midnight. It does not make any attempt to compress old logs; you
32836 will need to write your own script if you require this. You should not
32837 run &'exicyclog'& with this form of logging.
32838
32839 The location of the panic log is also determined by &%log_file_path%&, but it
32840 is not datestamped, because rotation of the panic log does not make sense.
32841 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
32842 the string. In addition, if it immediately follows a slash, a following
32843 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
32844 character is removed. Thus, the four examples above would give these panic
32845 log names:
32846 .code
32847 /var/spool/exim/log/paniclog
32848 /var/log/exim-panic.log
32849 /var/spool/exim/log/paniclog
32850 /var/log/exim/panic
32851 .endd
32852
32853
32854 .section "Logging to syslog" "SECID249"
32855 .cindex "log" "syslog; writing to"
32856 The use of syslog does not change what Exim logs or the format of its messages,
32857 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32858 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32859 that, the same strings are written to syslog as to log files. The syslog
32860 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32861 by default, but you can change these by setting the &%syslog_facility%& and
32862 &%syslog_processname%& options, respectively. If Exim was compiled with
32863 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32864 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32865 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32866 the time and host name to each line.
32867 The three log streams are mapped onto syslog priorities as follows:
32868
32869 .ilist
32870 &'mainlog'& is mapped to LOG_INFO
32871 .next
32872 &'rejectlog'& is mapped to LOG_NOTICE
32873 .next
32874 &'paniclog'& is mapped to LOG_ALERT
32875 .endlist
32876
32877 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32878 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32879 these are routed by syslog to the same place. You can suppress this duplication
32880 by setting &%syslog_duplication%& false.
32881
32882 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32883 entries contain multiple lines when headers are included. To cope with both
32884 these cases, entries written to syslog are split into separate &[syslog()]&
32885 calls at each internal newline, and also after a maximum of
32886 870 data characters. (This allows for a total syslog line length of 1024, when
32887 additions such as timestamps are added.) If you are running a syslog
32888 replacement that can handle lines longer than the 1024 characters allowed by
32889 RFC 3164, you should set
32890 .code
32891 SYSLOG_LONG_LINES=yes
32892 .endd
32893 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32894 lines, but it still splits at internal newlines in &'reject'& log entries.
32895
32896 To make it easy to re-assemble split lines later, each component of a split
32897 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32898 where <&'n'&> is the component number and <&'m'&> is the total number of
32899 components in the entry. The / delimiter is used when the line was split
32900 because it was too long; if it was split because of an internal newline, the \
32901 delimiter is used. For example, supposing the length limit to be 50 instead of
32902 870, the following would be the result of a typical rejection message to
32903 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32904 name, and pid as added by syslog:
32905 .code
32906 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32907 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32908 [3/5]  when scanning for sender: missing or malformed lo
32909 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32910 [5/5] mple>)
32911 .endd
32912 The same error might cause the following lines to be written to &"rejectlog"&
32913 (LOG_NOTICE):
32914 .code
32915 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32916 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32917 [3/18] er when scanning for sender: missing or malformed
32918 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32919 [5\18] .example>)
32920 [6\18] Recipients: ph10@some.domain.cam.example
32921 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32922 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32923 [9\18]        id 16RdAL-0006pc-00
32924 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32925 [11\18] 09:43 +0100
32926 [12\18] F From: <>
32927 [13\18]   Subject: this is a test header
32928 [18\18]   X-something: this is another header
32929 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32930 [16\18] le>
32931 [17\18] B Bcc:
32932 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32933 .endd
32934 Log lines that are neither too long nor contain newlines are written to syslog
32935 without modification.
32936
32937 If only syslog is being used, the Exim monitor is unable to provide a log tail
32938 display, unless syslog is routing &'mainlog'& to a file on the local host and
32939 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32940 where it is.
32941
32942
32943
32944 .section "Log line flags" "SECID250"
32945 One line is written to the main log for each message received, and for each
32946 successful, unsuccessful, and delayed delivery. These lines can readily be
32947 picked out by the distinctive two-character flags that immediately follow the
32948 timestamp. The flags are:
32949 .display
32950 &`<=`&     message arrival
32951 &`=>`&     normal message delivery
32952 &`->`&     additional address in same delivery
32953 &`*>`&     delivery suppressed by &%-N%&
32954 &`**`&     delivery failed; address bounced
32955 &`==`&     delivery deferred; temporary problem
32956 .endd
32957
32958
32959 .section "Logging message reception" "SECID251"
32960 .cindex "log" "reception line"
32961 The format of the single-line entry in the main log that is written for every
32962 message received is shown in the basic example below, which is split over
32963 several lines in order to fit it on the page:
32964 .code
32965 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32966   H=mailer.fict.example [192.168.123.123] U=exim
32967   P=smtp S=5678 id=<incoming message id>
32968 .endd
32969 The address immediately following &"<="& is the envelope sender address. A
32970 bounce message is shown with the sender address &"<>"&, and if it is locally
32971 generated, this is followed by an item of the form
32972 .code
32973 R=<message id>
32974 .endd
32975 which is a reference to the message that caused the bounce to be sent.
32976
32977 .cindex "HELO"
32978 .cindex "EHLO"
32979 For messages from other hosts, the H and U fields identify the remote host and
32980 record the RFC 1413 identity of the user that sent the message, if one was
32981 received. The number given in square brackets is the IP address of the sending
32982 host. If there is a single, unparenthesized  host name in the H field, as
32983 above, it has been verified to correspond to the IP address (see the
32984 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
32985 by the remote host in the SMTP HELO or EHLO command, and has not been
32986 verified. If verification yields a different name to that given for HELO or
32987 EHLO, the verified name appears first, followed by the HELO or EHLO
32988 name in parentheses.
32989
32990 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
32991 without brackets, in the HELO or EHLO command, leading to entries in
32992 the log containing text like these examples:
32993 .code
32994 H=(10.21.32.43) [192.168.8.34]
32995 H=([10.21.32.43]) [192.168.8.34]
32996 .endd
32997 This can be confusing. Only the final address in square brackets can be relied
32998 on.
32999
33000 For locally generated messages (that is, messages not received over TCP/IP),
33001 the H field is omitted, and the U field contains the login name of the caller
33002 of Exim.
33003
33004 .cindex "authentication" "logging"
33005 .cindex "AUTH" "logging"
33006 For all messages, the P field specifies the protocol used to receive the
33007 message. This is the value that is stored in &$received_protocol$&. In the case
33008 of incoming SMTP messages, the value indicates whether or not any SMTP
33009 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33010 session was encrypted, there is an additional X field that records the cipher
33011 suite that was used.
33012
33013 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33014 hosts that have authenticated themselves using the SMTP AUTH command. The first
33015 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33016 there is an additional item A= followed by the name of the authenticator that
33017 was used. If an authenticated identification was set up by the authenticator's
33018 &%server_set_id%& option, this is logged too, separated by a colon from the
33019 authenticator name.
33020
33021 .cindex "size" "of message"
33022 The id field records the existing message id, if present. The size of the
33023 received message is given by the S field. When the message is delivered,
33024 headers may be removed or added, so that the size of delivered copies of the
33025 message may not correspond with this value (and indeed may be different to each
33026 other).
33027
33028 The &%log_selector%& option can be used to request the logging of additional
33029 data when a message is received. See section &<<SECTlogselector>>& below.
33030
33031
33032
33033 .section "Logging deliveries" "SECID252"
33034 .cindex "log" "delivery line"
33035 The format of the single-line entry in the main log that is written for every
33036 delivery is shown in one of the examples below, for local and remote
33037 deliveries, respectively. Each example has been split into two lines in order
33038 to fit it on the page:
33039 .code
33040 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33041   <marv@hitch.fict.example> R=localuser T=local_delivery
33042 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33043   monk@holistic.fict.example R=dnslookup T=remote_smtp
33044   H=holistic.fict.example [192.168.234.234]
33045 .endd
33046 For ordinary local deliveries, the original address is given in angle brackets
33047 after the final delivery address, which might be a pipe or a file. If
33048 intermediate address(es) exist between the original and the final address, the
33049 last of these is given in parentheses after the final address. The R and T
33050 fields record the router and transport that were used to process the address.
33051
33052 If a shadow transport was run after a successful local delivery, the log line
33053 for the successful delivery has an item added on the end, of the form
33054 .display
33055 &`ST=<`&&'shadow transport name'&&`>`&
33056 .endd
33057 If the shadow transport did not succeed, the error message is put in
33058 parentheses afterwards.
33059
33060 .cindex "asterisk" "after IP address"
33061 When more than one address is included in a single delivery (for example, two
33062 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33063 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33064 down a single SMTP connection, an asterisk follows the IP address in the log
33065 lines for the second and subsequent messages.
33066
33067 The generation of a reply message by a filter file gets logged as a
33068 &"delivery"& to the addressee, preceded by &">"&.
33069
33070 The &%log_selector%& option can be used to request the logging of additional
33071 data when a message is delivered. See section &<<SECTlogselector>>& below.
33072
33073
33074 .section "Discarded deliveries" "SECID253"
33075 .cindex "discarded messages"
33076 .cindex "message" "discarded"
33077 .cindex "delivery" "discarded; logging"
33078 When a message is discarded as a result of the command &"seen finish"& being
33079 obeyed in a filter file which generates no deliveries, a log entry of the form
33080 .code
33081 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33082   <low.club@bridge.example> R=userforward
33083 .endd
33084 is written, to record why no deliveries are logged. When a message is discarded
33085 because it is aliased to &":blackhole:"& the log line is like this:
33086 .code
33087 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33088   <hole@nowhere.example> R=blackhole_router
33089 .endd
33090
33091
33092 .section "Deferred deliveries" "SECID254"
33093 When a delivery is deferred, a line of the following form is logged:
33094 .code
33095 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33096   R=dnslookup T=smtp defer (146): Connection refused
33097 .endd
33098 In the case of remote deliveries, the error is the one that was given for the
33099 last IP address that was tried. Details of individual SMTP failures are also
33100 written to the log, so the above line would be preceded by something like
33101 .code
33102 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33103   mail1.endrest.example [192.168.239.239]: Connection refused
33104 .endd
33105 When a deferred address is skipped because its retry time has not been reached,
33106 a message is written to the log, but this can be suppressed by setting an
33107 appropriate value in &%log_selector%&.
33108
33109
33110
33111 .section "Delivery failures" "SECID255"
33112 .cindex "delivery" "failure; logging"
33113 If a delivery fails because an address cannot be routed, a line of the
33114 following form is logged:
33115 .code
33116 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33117   <jim@trek99.example>: unknown mail domain
33118 .endd
33119 If a delivery fails at transport time, the router and transport are shown, and
33120 the response from the remote host is included, as in this example:
33121 .code
33122 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33123   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33124   after pipelined RCPT TO:<ace400@pb.example>: host
33125   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33126   <ace400@pb.example>...Addressee unknown
33127 .endd
33128 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33129 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33130 disabling PIPELINING. The log lines for all forms of delivery failure are
33131 flagged with &`**`&.
33132
33133
33134
33135 .section "Fake deliveries" "SECID256"
33136 .cindex "delivery" "fake; logging"
33137 If a delivery does not actually take place because the &%-N%& option has been
33138 used to suppress it, a normal delivery line is written to the log, except that
33139 &"=>"& is replaced by &"*>"&.
33140
33141
33142
33143 .section "Completion" "SECID257"
33144 A line of the form
33145 .code
33146 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33147 .endd
33148 is written to the main log when a message is about to be removed from the spool
33149 at the end of its processing.
33150
33151
33152
33153
33154 .section "Summary of Fields in Log Lines" "SECID258"
33155 .cindex "log" "summary of fields"
33156 A summary of the field identifiers that are used in log lines is shown in
33157 the following table:
33158 .display
33159 &`A   `&        authenticator name (and optional id)
33160 &`C   `&        SMTP confirmation on delivery
33161 &`    `&        command list for &"no mail in SMTP session"&
33162 &`CV  `&        certificate verification status
33163 &`D   `&        duration of &"no mail in SMTP session"&
33164 &`DN  `&        distinguished name from peer certificate
33165 &`DT  `&        on &`=>`& lines: time taken for a delivery
33166 &`F   `&        sender address (on delivery lines)
33167 &`H   `&        host name and IP address
33168 &`I   `&        local interface used
33169 &`id  `&        message id for incoming message
33170 &`P   `&        on &`<=`& lines: protocol used
33171 &`    `&        on &`=>`& and &`**`& lines: return path
33172 &`QT  `&        on &`=>`& lines: time spent on queue so far
33173 &`    `&        on &"Completed"& lines: time spent on queue
33174 &`R   `&        on &`<=`& lines: reference for local bounce
33175 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33176 &`S   `&        size of message
33177 &`ST  `&        shadow transport name
33178 &`T   `&        on &`<=`& lines: message subject (topic)
33179 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33180 &`U   `&        local user or RFC 1413 identity
33181 &`X   `&        TLS cipher suite
33182 .endd
33183
33184
33185 .section "Other log entries" "SECID259"
33186 Various other types of log entry are written from time to time. Most should be
33187 self-explanatory. Among the more common are:
33188
33189 .ilist
33190 .cindex "retry" "time not reached"
33191 &'retry time not reached'&&~&~An address previously suffered a temporary error
33192 during routing or local delivery, and the time to retry has not yet arrived.
33193 This message is not written to an individual message log file unless it happens
33194 during the first delivery attempt.
33195 .next
33196 &'retry time not reached for any host'&&~&~An address previously suffered
33197 temporary errors during remote delivery, and the retry time has not yet arrived
33198 for any of the hosts to which it is routed.
33199 .next
33200 .cindex "spool directory" "file locked"
33201 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33202 some other Exim process is already working on the message. This can be quite
33203 common if queue running processes are started at frequent intervals. The
33204 &'exiwhat'& utility script can be used to find out what Exim processes are
33205 doing.
33206 .next
33207 .cindex "error" "ignored"
33208 &'error ignored'&&~&~There are several circumstances that give rise to this
33209 message:
33210 .olist
33211 Exim failed to deliver a bounce message whose age was greater than
33212 &%ignore_bounce_errors_after%&. The bounce was discarded.
33213 .next
33214 A filter file set up a delivery using the &"noerror"& option, and the delivery
33215 failed. The delivery was discarded.
33216 .next
33217 A delivery set up by a router configured with
33218 . ==== As this is a nested list, any displays it contains must be indented
33219 . ==== as otherwise they are too far to the left.
33220 .code
33221     errors_to = <>
33222 .endd
33223 failed. The delivery was discarded.
33224 .endlist olist
33225 .endlist ilist
33226
33227
33228
33229
33230
33231 .section "Reducing or increasing what is logged" "SECTlogselector"
33232 .cindex "log" "selectors"
33233 By setting the &%log_selector%& global option, you can disable some of Exim's
33234 default logging, or you can request additional logging. The value of
33235 &%log_selector%& is made up of names preceded by plus or minus characters. For
33236 example:
33237 .code
33238 log_selector = +arguments -retry_defer
33239 .endd
33240 The list of optional log items is in the following table, with the default
33241 selection marked by asterisks:
33242 .display
33243 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33244 &` address_rewrite            `&  address rewriting
33245 &` all_parents                `&  all parents in => lines
33246 &` arguments                  `&  command line arguments
33247 &`*connection_reject          `&  connection rejections
33248 &`*delay_delivery             `&  immediate delivery delayed
33249 &` deliver_time               `&  time taken to perform delivery
33250 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33251 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33252 &`*etrn                       `&  ETRN commands
33253 &`*host_lookup_failed         `&  as it says
33254 &` ident_timeout              `&  timeout for ident connection
33255 &` incoming_interface         `&  incoming interface on <= lines
33256 &` incoming_port              `&  incoming port on <= lines
33257 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33258 &` outgoing_port              `&  add remote port to => lines
33259 &`*queue_run                  `&  start and end queue runs
33260 &` queue_time                 `&  time on queue for one recipient
33261 &` queue_time_overall         `&  time on queue for whole message
33262 &` pid                        `&  Exim process id
33263 &` received_recipients        `&  recipients on <= lines
33264 &` received_sender            `&  sender on <= lines
33265 &`*rejected_header            `&  header contents on reject log
33266 &`*retry_defer                `&  &"retry time not reached"&
33267 &` return_path_on_delivery    `&  put return path on => and ** lines
33268 &` sender_on_delivery         `&  add sender to => lines
33269 &`*sender_verify_fail         `&  sender verification failures
33270 &`*size_reject                `&  rejection because too big
33271 &`*skip_delivery              `&  delivery skipped in a queue run
33272 &` smtp_confirmation          `&  SMTP confirmation on => lines
33273 &` smtp_connection            `&  SMTP connections
33274 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33275 &` smtp_no_mail               `&  session with no MAIL commands
33276 &` smtp_protocol_error        `&  SMTP protocol errors
33277 &` smtp_syntax_error          `&  SMTP syntax errors
33278 &` subject                    `&  contents of &'Subject:'& on <= lines
33279 &` tls_certificate_verified   `&  certificate verification status
33280 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
33281 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
33282 &` tls_sni                    `&  TLS SNI on <= lines
33283 &` unknown_in_list            `&  DNS lookup failed in list match
33284
33285 &` all                        `&  all of the above
33286 .endd
33287 More details on each of these items follows:
33288
33289 .ilist
33290 .cindex "&%warn%& ACL verb" "log when skipping"
33291 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
33292 its conditions cannot be evaluated, a log line to this effect is written if
33293 this log selector is set.
33294 .next
33295 .cindex "log" "rewriting"
33296 .cindex "rewriting" "logging"
33297 &%address_rewrite%&: This applies both to global rewrites and per-transport
33298 rewrites, but not to rewrites in filters run as an unprivileged user (because
33299 such users cannot access the log).
33300 .next
33301 .cindex "log" "full parentage"
33302 &%all_parents%&: Normally only the original and final addresses are logged on
33303 delivery lines; with this selector, intermediate parents are given in
33304 parentheses between them.
33305 .next
33306 .cindex "log" "Exim arguments"
33307 .cindex "Exim arguments, logging"
33308 &%arguments%&: This causes Exim to write the arguments with which it was called
33309 to the main log, preceded by the current working directory. This is a debugging
33310 feature, added to make it easier to find out how certain MUAs call
33311 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
33312 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
33313 that are empty or that contain white space are quoted. Non-printing characters
33314 are shown as escape sequences. This facility cannot log unrecognized arguments,
33315 because the arguments are checked before the configuration file is read. The
33316 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
33317 between the caller and Exim.
33318 .next
33319 .cindex "log" "connection rejections"
33320 &%connection_reject%&: A log entry is written whenever an incoming SMTP
33321 connection is rejected, for whatever reason.
33322 .next
33323 .cindex "log" "delayed delivery"
33324 .cindex "delayed delivery, logging"
33325 &%delay_delivery%&: A log entry is written whenever a delivery process is not
33326 started for an incoming message because the load is too high or too many
33327 messages were received on one connection. Logging does not occur if no delivery
33328 process is started because &%queue_only%& is set or &%-odq%& was used.
33329 .next
33330 .cindex "log" "delivery duration"
33331 &%deliver_time%&: For each delivery, the amount of real time it has taken to
33332 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
33333 .next
33334 .cindex "log" "message size on delivery"
33335 .cindex "size" "of message"
33336 &%delivery_size%&: For each delivery, the size of message delivered is added to
33337 the &"=>"& line, tagged with S=.
33338 .next
33339 .cindex "log" "dnslist defer"
33340 .cindex "DNS list" "logging defer"
33341 .cindex "black list (DNS)"
33342 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
33343 DNS black list suffers a temporary error.
33344 .next
33345 .cindex "log" "ETRN commands"
33346 .cindex "ETRN" "logging"
33347 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
33348 is run to determine whether or not it is actually accepted. An invalid ETRN
33349 command, or one received within a message transaction is not logged by this
33350 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
33351 .next
33352 .cindex "log" "host lookup failure"
33353 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
33354 any addresses, or when a lookup of an IP address fails to find a host name, a
33355 log line is written. This logging does not apply to direct DNS lookups when
33356 routing email addresses, but it does apply to &"byname"& lookups.
33357 .next
33358 .cindex "log" "ident timeout"
33359 .cindex "RFC 1413" "logging timeout"
33360 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
33361 client's ident port times out.
33362 .next
33363 .cindex "log" "incoming interface"
33364 .cindex "interface" "logging"
33365 &%incoming_interface%&: The interface on which a message was received is added
33366 to the &"<="& line as an IP address in square brackets, tagged by I= and
33367 followed by a colon and the port number. The local interface and port are also
33368 added to other SMTP log lines, for example &"SMTP connection from"&, and to
33369 rejection lines.
33370 .next
33371 .cindex "log" "incoming remote port"
33372 .cindex "port" "logging remote"
33373 .cindex "TCP/IP" "logging incoming remote port"
33374 .vindex "&$sender_fullhost$&"
33375 .vindex "&$sender_rcvhost$&"
33376 &%incoming_port%&: The remote port number from which a message was received is
33377 added to log entries and &'Received:'& header lines, following the IP address
33378 in square brackets, and separated from it by a colon. This is implemented by
33379 changing the value that is put in the &$sender_fullhost$& and
33380 &$sender_rcvhost$& variables. Recording the remote port number has become more
33381 important with the widening use of NAT (see RFC 2505).
33382 .next
33383 .cindex "log" "dropped connection"
33384 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
33385 connection is unexpectedly dropped.
33386 .next
33387 .cindex "log" "outgoing remote port"
33388 .cindex "port" "logging outgoint remote"
33389 .cindex "TCP/IP" "logging ougtoing remote port"
33390 &%outgoing_port%&: The remote port number is added to delivery log lines (those
33391 containing => tags) following the IP address. This option is not included in
33392 the default setting, because for most ordinary configurations, the remote port
33393 number is always 25 (the SMTP port).
33394 .next
33395 .cindex "log" "process ids in"
33396 .cindex "pid (process id)" "in log lines"
33397 &%pid%&: The current process id is added to every log line, in square brackets,
33398 immediately after the time and date.
33399 .next
33400 .cindex "log" "queue run"
33401 .cindex "queue runner" "logging"
33402 &%queue_run%&: The start and end of every queue run are logged.
33403 .next
33404 .cindex "log" "queue time"
33405 &%queue_time%&: The amount of time the message has been in the queue on the
33406 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
33407 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
33408 includes reception time as well as the delivery time for the current address.
33409 This means that it may be longer than the difference between the arrival and
33410 delivery log line times, because the arrival log line is not written until the
33411 message has been successfully received.
33412 .next
33413 &%queue_time_overall%&: The amount of time the message has been in the queue on
33414 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
33415 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
33416 message, so it includes reception time as well as the total delivery time.
33417 .next
33418 .cindex "log" "recipients"
33419 &%received_recipients%&: The recipients of a message are listed in the main log
33420 as soon as the message is received. The list appears at the end of the log line
33421 that is written when a message is received, preceded by the word &"for"&. The
33422 addresses are listed after they have been qualified, but before any rewriting
33423 has taken place.
33424 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
33425 in the list.
33426 .next
33427 .cindex "log" "sender reception"
33428 &%received_sender%&: The unrewritten original sender of a message is added to
33429 the end of the log line that records the message's arrival, after the word
33430 &"from"& (before the recipients if &%received_recipients%& is also set).
33431 .next
33432 .cindex "log" "header lines for rejection"
33433 &%rejected_header%&: If a message's header has been received at the time a
33434 rejection is written to the reject log, the complete header is added to the
33435 log. Header logging can be turned off individually for messages that are
33436 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
33437 .next
33438 .cindex "log" "retry defer"
33439 &%retry_defer%&: A log line is written if a delivery is deferred because a
33440 retry time has not yet been reached. However, this &"retry time not reached"&
33441 message is always omitted from individual message logs after the first delivery
33442 attempt.
33443 .next
33444 .cindex "log" "return path"
33445 &%return_path_on_delivery%&: The return path that is being transmitted with
33446 the message is included in delivery and bounce lines, using the tag P=.
33447 This is omitted if no delivery actually happens, for example, if routing fails,
33448 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
33449 .next
33450 .cindex "log" "sender on delivery"
33451 &%sender_on_delivery%&: The message's sender address is added to every delivery
33452 and bounce line, tagged by F= (for &"from"&).
33453 This is the original sender that was received with the message; it is not
33454 necessarily the same as the outgoing return path.
33455 .next
33456 .cindex "log" "sender verify failure"
33457 &%sender_verify_fail%&: If this selector is unset, the separate log line that
33458 gives details of a sender verification failure is not written. Log lines for
33459 the rejection of SMTP commands contain just &"sender verify failed"&, so some
33460 detail is lost.
33461 .next
33462 .cindex "log" "size rejection"
33463 &%size_reject%&: A log line is written whenever a message is rejected because
33464 it is too big.
33465 .next
33466 .cindex "log" "frozen messages; skipped"
33467 .cindex "frozen messages" "logging skipping"
33468 &%skip_delivery%&: A log line is written whenever a message is skipped during a
33469 queue run because it is frozen or because another process is already delivering
33470 it.
33471 .cindex "&""spool file is locked""&"
33472 The message that is written is &"spool file is locked"&.
33473 .next
33474 .cindex "log" "smtp confirmation"
33475 .cindex "SMTP" "logging confirmation"
33476 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
33477 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
33478 A number of MTAs (including Exim) return an identifying string in this
33479 response.
33480 .next
33481 .cindex "log" "SMTP connections"
33482 .cindex "SMTP" "logging connections"
33483 &%smtp_connection%&: A log line is written whenever an SMTP connection is
33484 established or closed, unless the connection is from a host that matches
33485 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
33486 only when the closure is unexpected.) This applies to connections from local
33487 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
33488 dropped in the middle of a message, a log line is always written, whether or
33489 not this selector is set, but otherwise nothing is written at the start and end
33490 of connections unless this selector is enabled.
33491
33492 For TCP/IP connections to an Exim daemon, the current number of connections is
33493 included in the log message for each new connection, but note that the count is
33494 reset if the daemon is restarted.
33495 Also, because connections are closed (and the closure is logged) in
33496 subprocesses, the count may not include connections that have been closed but
33497 whose termination the daemon has not yet noticed. Thus, while it is possible to
33498 match up the opening and closing of connections in the log, the value of the
33499 logged counts may not be entirely accurate.
33500 .next
33501 .cindex "log" "SMTP transaction; incomplete"
33502 .cindex "SMTP" "logging incomplete transactions"
33503 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
33504 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
33505 and the message sender plus any accepted recipients are included in the log
33506 line. This can provide evidence of dictionary attacks.
33507 .next
33508 .cindex "log" "non-MAIL SMTP sessions"
33509 .cindex "MAIL" "logging session without"
33510 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
33511 connection terminates without having issued a MAIL command. This includes both
33512 the case when the connection is dropped, and the case when QUIT is used. It
33513 does not include cases where the connection is rejected right at the start (by
33514 an ACL, or because there are too many connections, or whatever). These cases
33515 already have their own log lines.
33516
33517 The log line that is written contains the identity of the client in the usual
33518 way, followed by D= and a time, which records the duration of the connection.
33519 If the connection was authenticated, this fact is logged exactly as it is for
33520 an incoming message, with an A= item. If the connection was encrypted, CV=,
33521 DN=, and X= items may appear as they do for an incoming message, controlled by
33522 the same logging options.
33523
33524 Finally, if any SMTP commands were issued during the connection, a C= item
33525 is added to the line, listing the commands that were used. For example,
33526 .code
33527 C=EHLO,QUIT
33528 .endd
33529 shows that the client issued QUIT straight after EHLO. If there were fewer
33530 than 20 commands, they are all listed. If there were more than 20 commands,
33531 the last 20 are listed, preceded by &"..."&. However, with the default
33532 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
33533 have been aborted before 20 non-mail commands are processed.
33534 .next
33535 .cindex "log" "SMTP protocol error"
33536 .cindex "SMTP" "logging protocol error"
33537 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
33538 encountered. Exim does not have perfect detection of all protocol errors
33539 because of transmission delays and the use of pipelining. If PIPELINING has
33540 been advertised to a client, an Exim server assumes that the client will use
33541 it, and therefore it does not count &"expected"& errors (for example, RCPT
33542 received after rejecting MAIL) as protocol errors.
33543 .next
33544 .cindex "SMTP" "logging syntax errors"
33545 .cindex "SMTP" "syntax errors; logging"
33546 .cindex "SMTP" "unknown command; logging"
33547 .cindex "log" "unknown SMTP command"
33548 .cindex "log" "SMTP syntax error"
33549 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
33550 encountered. An unrecognized command is treated as a syntax error. For an
33551 external connection, the host identity is given; for an internal connection
33552 using &%-bs%& the sender identification (normally the calling user) is given.
33553 .next
33554 .cindex "log" "subject"
33555 .cindex "subject, logging"
33556 &%subject%&: The subject of the message is added to the arrival log line,
33557 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
33558 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
33559 specifies whether characters with values greater than 127 should be logged
33560 unchanged, or whether they should be rendered as escape sequences.
33561 .next
33562 .cindex "log" "certificate verification"
33563 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
33564 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
33565 verified, and &`CV=no`& if not.
33566 .next
33567 .cindex "log" "TLS cipher"
33568 .cindex "TLS" "logging cipher"
33569 &%tls_cipher%&: When a message is sent or received over an encrypted
33570 connection, the cipher suite used is added to the log line, preceded by X=.
33571 .next
33572 .cindex "log" "TLS peer DN"
33573 .cindex "TLS" "logging peer DN"
33574 &%tls_peerdn%&: When a message is sent or received over an encrypted
33575 connection, and a certificate is supplied by the remote host, the peer DN is
33576 added to the log line, preceded by DN=.
33577 .next
33578 .cindex "log" "TLS SNI"
33579 .cindex "TLS" "logging SNI"
33580 &%tls_sni%&: When a message is received over an encrypted connection, and
33581 the remote host provided the Server Name Indication extension, the SNI is
33582 added to the log line, preceded by SNI=.
33583 .next
33584 .cindex "log" "DNS failure in list"
33585 &%unknown_in_list%&: This setting causes a log entry to be written when the
33586 result of a list match is failure because a DNS lookup failed.
33587 .endlist
33588
33589
33590 .section "Message log" "SECID260"
33591 .cindex "message" "log file for"
33592 .cindex "log" "message log; description of"
33593 .cindex "&_msglog_& directory"
33594 .oindex "&%preserve_message_logs%&"
33595 In addition to the general log files, Exim writes a log file for each message
33596 that it handles. The names of these per-message logs are the message ids, and
33597 they are kept in the &_msglog_& sub-directory of the spool directory. Each
33598 message log contains copies of the log lines that apply to the message. This
33599 makes it easier to inspect the status of an individual message without having
33600 to search the main log. A message log is deleted when processing of the message
33601 is complete, unless &%preserve_message_logs%& is set, but this should be used
33602 only with great care because they can fill up your disk very quickly.
33603
33604 On a heavily loaded system, it may be desirable to disable the use of
33605 per-message logs, in order to reduce disk I/O. This can be done by setting the
33606 &%message_logs%& option false.
33607 .ecindex IIDloggen
33608
33609
33610
33611
33612 . ////////////////////////////////////////////////////////////////////////////
33613 . ////////////////////////////////////////////////////////////////////////////
33614
33615 .chapter "Exim utilities" "CHAPutils"
33616 .scindex IIDutils "utilities"
33617 A number of utility scripts and programs are supplied with Exim and are
33618 described in this chapter. There is also the Exim Monitor, which is covered in
33619 the next chapter. The utilities described here are:
33620
33621 .itable none 0 0 3  7* left  15* left  40* left
33622 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
33623   "list what Exim processes are doing"
33624 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
33625 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
33626 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
33627 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
33628                                                 various criteria"
33629 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
33630 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
33631   "extract statistics from the log"
33632 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
33633   "check address acceptance from given IP"
33634 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
33635 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
33636 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
33637 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
33638 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
33639 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
33640 .endtable
33641
33642 Another utility that might be of use to sites with many MTAs is Tom Kistner's
33643 &'exilog'&. It provides log visualizations across multiple Exim servers. See
33644 &url(http://duncanthrax.net/exilog/) for details.
33645
33646
33647
33648
33649 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
33650 .cindex "&'exiwhat'&"
33651 .cindex "process, querying"
33652 .cindex "SIGUSR1"
33653 On operating systems that can restart a system call after receiving a signal
33654 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
33655 a line describing what it is doing to the file &_exim-process.info_& in the
33656 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
33657 processes it can find, having first emptied the file. It then waits for one
33658 second to allow the Exim processes to react before displaying the results. In
33659 order to run &'exiwhat'& successfully you have to have sufficient privilege to
33660 send the signal to the Exim processes, so it is normally run as root.
33661
33662 &*Warning*&: This is not an efficient process. It is intended for occasional
33663 use by system administrators. It is not sensible, for example, to set up a
33664 script that sends SIGUSR1 signals to Exim processes at short intervals.
33665
33666
33667 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
33668 varies in different operating systems. Not only are different options used,
33669 but the format of the output is different. For this reason, there are some
33670 system configuration options that configure exactly how &'exiwhat'& works. If
33671 it doesn't seem to be working for you, check the following compile-time
33672 options:
33673 .display
33674 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
33675 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
33676 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
33677 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
33678 .endd
33679 An example of typical output from &'exiwhat'& is
33680 .code
33681 164 daemon: -q1h, listening on port 25
33682 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
33683 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
33684   [10.19.42.42] (editor@ref.example)
33685 10592 handling incoming call from [192.168.243.242]
33686 10628 accepting a local non-SMTP message
33687 .endd
33688 The first number in the output line is the process number. The third line has
33689 been split here, in order to fit it on the page.
33690
33691
33692
33693 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
33694 .cindex "&'exiqgrep'&"
33695 .cindex "queue" "grepping"
33696 This utility is a Perl script contributed by Matt Hubbard. It runs
33697 .code
33698 exim -bpu
33699 .endd
33700 to obtain a queue listing with undelivered recipients only, and then greps the
33701 output to select messages that match given criteria. The following selection
33702 options are available:
33703
33704 .vlist
33705 .vitem &*-f*&&~<&'regex'&>
33706 Match the sender address. The field that is tested is enclosed in angle
33707 brackets, so you can test for bounce messages with
33708 .code
33709 exiqgrep -f '^<>$'
33710 .endd
33711 .vitem &*-r*&&~<&'regex'&>
33712 Match a recipient address. The field that is tested is not enclosed in angle
33713 brackets.
33714
33715 .vitem &*-s*&&~<&'regex'&>
33716 Match against the size field.
33717
33718 .vitem &*-y*&&~<&'seconds'&>
33719 Match messages that are younger than the given time.
33720
33721 .vitem &*-o*&&~<&'seconds'&>
33722 Match messages that are older than the given time.
33723
33724 .vitem &*-z*&
33725 Match only frozen messages.
33726
33727 .vitem &*-x*&
33728 Match only non-frozen messages.
33729 .endlist
33730
33731 The following options control the format of the output:
33732
33733 .vlist
33734 .vitem &*-c*&
33735 Display only the count of matching messages.
33736
33737 .vitem &*-l*&
33738 Long format &-- display the full message information as output by Exim. This is
33739 the default.
33740
33741 .vitem &*-i*&
33742 Display message ids only.
33743
33744 .vitem &*-b*&
33745 Brief format &-- one line per message.
33746
33747 .vitem &*-R*&
33748 Display messages in reverse order.
33749 .endlist
33750
33751 There is one more option, &%-h%&, which outputs a list of options.
33752
33753
33754
33755 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
33756 .cindex "&'exiqsumm'&"
33757 .cindex "queue" "summary"
33758 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
33759 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
33760 running a command such as
33761 .code
33762 exim -bp | exiqsumm
33763 .endd
33764 The output consists of one line for each domain that has messages waiting for
33765 it, as in the following example:
33766 .code
33767 3   2322   74m   66m  msn.com.example
33768 .endd
33769 Each line lists the number of pending deliveries for a domain, their total
33770 volume, and the length of time that the oldest and the newest messages have
33771 been waiting. Note that the number of pending deliveries is greater than the
33772 number of messages when messages have more than one recipient.
33773
33774 A summary line is output at the end. By default the output is sorted on the
33775 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
33776 the output to be sorted by oldest message and by count of messages,
33777 respectively. There are also three options that split the messages for each
33778 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
33779 separates frozen messages, and &%-s%& separates messages according to their
33780 sender.
33781
33782 The output of &'exim -bp'& contains the original addresses in the message, so
33783 this also applies to the output from &'exiqsumm'&. No domains from addresses
33784 generated by aliasing or forwarding are included (unless the &%one_time%&
33785 option of the &(redirect)& router has been used to convert them into &"top
33786 level"& addresses).
33787
33788
33789
33790
33791 .section "Extracting specific information from the log (exigrep)" &&&
33792          "SECTextspeinf"
33793 .cindex "&'exigrep'&"
33794 .cindex "log" "extracts; grepping for"
33795 The &'exigrep'& utility is a Perl script that searches one or more main log
33796 files for entries that match a given pattern. When it finds a match, it
33797 extracts all the log entries for the relevant message, not just those that
33798 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
33799 given message, or all mail for a given user, or for a given host, for example.
33800 The input files can be in Exim log format or syslog format.
33801 If a matching log line is not associated with a specific message, it is
33802 included in &'exigrep'&'s output without any additional lines. The usage is:
33803 .display
33804 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
33805 .endd
33806 If no log file names are given on the command line, the standard input is read.
33807
33808 The &%-t%& argument specifies a number of seconds. It adds an additional
33809 condition for message selection. Messages that are complete are shown only if
33810 they spent more than <&'n'&> seconds on the queue.
33811
33812 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
33813 makes it case-sensitive. This may give a performance improvement when searching
33814 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
33815 option; with &%-I%& they do not. In both cases it is possible to change the
33816 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
33817
33818 The &%-l%& option means &"literal"&, that is, treat all characters in the
33819 pattern as standing for themselves. Otherwise the pattern must be a Perl
33820 regular expression.
33821
33822 The &%-v%& option inverts the matching condition. That is, a line is selected
33823 if it does &'not'& match the pattern.
33824
33825 If the location of a &'zcat'& command is known from the definition of
33826 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
33827 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
33828
33829
33830 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
33831 .cindex "&'exipick'&"
33832 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
33833 lists messages from the queue according to a variety of criteria. For details
33834 of &'exipick'&'s facilities, visit the web page at
33835 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33836 the &%--help%& option.
33837
33838
33839 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33840 .cindex "log" "cycling local files"
33841 .cindex "cycling logs"
33842 .cindex "&'exicyclog'&"
33843 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33844 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33845 you are using log files with datestamps in their names (see section
33846 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33847 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33848 There are two command line options for &'exicyclog'&:
33849 .ilist
33850 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33851 default that is set when Exim is built. The default default is 10.
33852 .next
33853 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33854 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33855 overriding the script's default, which is to find the setting from Exim's
33856 configuration.
33857 .endlist
33858
33859 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33860 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33861 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33862 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33863 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33864 logs are handled similarly.
33865
33866 If the limit is greater than 99, the script uses 3-digit numbers such as
33867 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33868 to one that is greater, or &'vice versa'&, you will have to fix the names of
33869 any existing log files.
33870
33871 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33872 the end are deleted. All files with numbers greater than 01 are compressed,
33873 using a compression command which is configured by the COMPRESS_COMMAND
33874 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33875 root &%crontab%& entry of the form
33876 .code
33877 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33878 .endd
33879 assuming you have used the name &"exim"& for the Exim user. You can run
33880 &'exicyclog'& as root if you wish, but there is no need.
33881
33882
33883
33884 .section "Mail statistics (eximstats)" "SECTmailstat"
33885 .cindex "statistics"
33886 .cindex "&'eximstats'&"
33887 A Perl script called &'eximstats'& is provided for extracting statistical
33888 information from log files. The output is either plain text, or HTML.
33889 Exim log files are also supported by the &'Lire'& system produced by the
33890 LogReport Foundation &url(http://www.logreport.org).
33891
33892 The &'eximstats'& script has been hacked about quite a bit over time. The
33893 latest version is the result of some extensive revision by Steve Campbell. A
33894 lot of information is given by default, but there are options for suppressing
33895 various parts of it. Following any options, the arguments to the script are a
33896 list of files, which should be main log files. For example:
33897 .code
33898 eximstats -nr /var/spool/exim/log/mainlog.01
33899 .endd
33900 By default, &'eximstats'& extracts information about the number and volume of
33901 messages received from or delivered to various hosts. The information is sorted
33902 both by message count and by volume, and the top fifty hosts in each category
33903 are listed on the standard output. Similar information, based on email
33904 addresses or domains instead of hosts can be requested by means of various
33905 options. For messages delivered and received locally, similar statistics are
33906 also produced per user.
33907
33908 The output also includes total counts and statistics about delivery errors, and
33909 histograms showing the number of messages received and deliveries made in each
33910 hour of the day. A delivery with more than one address in its envelope (for
33911 example, an SMTP transaction with more than one RCPT command) is counted
33912 as a single delivery by &'eximstats'&.
33913
33914 Though normally more deliveries than receipts are reported (as messages may
33915 have multiple recipients), it is possible for &'eximstats'& to report more
33916 messages received than delivered, even though the queue is empty at the start
33917 and end of the period in question. If an incoming message contains no valid
33918 recipients, no deliveries are recorded for it. A bounce message is handled as
33919 an entirely separate message.
33920
33921 &'eximstats'& always outputs a grand total summary giving the volume and number
33922 of messages received and deliveries made, and the number of hosts involved in
33923 each case. It also outputs the number of messages that were delayed (that is,
33924 not completely delivered at the first attempt), and the number that had at
33925 least one address that failed.
33926
33927 The remainder of the output is in sections that can be independently disabled
33928 or modified by various options. It consists of a summary of deliveries by
33929 transport, histograms of messages received and delivered per time interval
33930 (default per hour), information about the time messages spent on the queue,
33931 a list of relayed messages, lists of the top fifty sending hosts, local
33932 senders, destination hosts, and destination local users by count and by volume,
33933 and a list of delivery errors that occurred.
33934
33935 The relay information lists messages that were actually relayed, that is, they
33936 came from a remote host and were directly delivered to some other remote host,
33937 without being processed (for example, for aliasing or forwarding) locally.
33938
33939 There are quite a few options for &'eximstats'& to control exactly what it
33940 outputs. These are documented in the Perl script itself, and can be extracted
33941 by running the command &(perldoc)& on the script. For example:
33942 .code
33943 perldoc /usr/exim/bin/eximstats
33944 .endd
33945
33946 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33947 .cindex "&'exim_checkaccess'&"
33948 .cindex "policy control" "checking access"
33949 .cindex "checking access"
33950 The &%-bh%& command line argument allows you to run a fake SMTP session with
33951 debugging output, in order to check what Exim is doing when it is applying
33952 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33953 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33954 sometimes you just want to answer the question &"Does this address have
33955 access?"& without bothering with any further details.
33956
33957 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33958 two arguments, an IP address and an email address:
33959 .code
33960 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33961 .endd
33962 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33963 given email address would be accepted in a RCPT command in a TCP/IP
33964 connection from the host with the given IP address. The output of the utility
33965 is either the word &"accepted"&, or the SMTP error response, for example:
33966 .code
33967 Rejected:
33968 550 Relay not permitted
33969 .endd
33970 When running this test, the utility uses &`<>`& as the envelope sender address
33971 for the MAIL command, but you can change this by providing additional
33972 options. These are passed directly to the Exim command. For example, to specify
33973 that the test is to be run with the sender address &'himself@there.example'&
33974 you can use:
33975 .code
33976 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
33977                  -f himself@there.example
33978 .endd
33979 Note that these additional Exim command line items must be given after the two
33980 mandatory arguments.
33981
33982 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
33983 while running its checks. You can run checks that include callouts by using
33984 &%-bhc%&, but this is not yet available in a &"packaged"& form.
33985
33986
33987
33988 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
33989 .cindex "DBM" "building dbm files"
33990 .cindex "building DBM files"
33991 .cindex "&'exim_dbmbuild'&"
33992 .cindex "lower casing"
33993 .cindex "binary zero" "in lookup key"
33994 The &'exim_dbmbuild'& program reads an input file containing keys and data in
33995 the format used by the &(lsearch)& lookup (see section
33996 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
33997 names as keys and the remainder of the information as data. The lower-casing
33998 can be prevented by calling the program with the &%-nolc%& option.
33999
34000 A terminating zero is included as part of the key string. This is expected by
34001 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34002 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34003 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34004 files.
34005
34006 The program requires two arguments: the name of the input file (which can be a
34007 single hyphen to indicate the standard input), and the name of the output file.
34008 It creates the output under a temporary name, and then renames it if all went
34009 well.
34010
34011 .cindex "USE_DB"
34012 If the native DB interface is in use (USE_DB is set in a compile-time
34013 configuration file &-- this is common in free versions of Unix) the two file
34014 names must be different, because in this mode the Berkeley DB functions create
34015 a single output file using exactly the name given. For example,
34016 .code
34017 exim_dbmbuild /etc/aliases /etc/aliases.db
34018 .endd
34019 reads the system alias file and creates a DBM version of it in
34020 &_/etc/aliases.db_&.
34021
34022 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34023 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34024 environment, the suffixes are added to the second argument of
34025 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34026 when the Berkeley functions are used in compatibility mode (though this is not
34027 recommended), because in that case it adds a &_.db_& suffix to the file name.
34028
34029 If a duplicate key is encountered, the program outputs a warning, and when it
34030 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34031 option is used. By default, only the first of a set of duplicates is used &--
34032 this makes it compatible with &(lsearch)& lookups. There is an option
34033 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34034 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34035 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34036 return code is 2.
34037
34038
34039
34040
34041 .section "Finding individual retry times (exinext)" "SECTfinindret"
34042 .cindex "retry" "times"
34043 .cindex "&'exinext'&"
34044 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34045 fish specific information out of the retry database. Given a mail domain (or a
34046 complete address), it looks up the hosts for that domain, and outputs any retry
34047 information for the hosts or for the domain. At present, the retry information
34048 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34049 output. For example:
34050 .code
34051 $ exinext piglet@milne.fict.example
34052 kanga.milne.example:192.168.8.1 error 146: Connection refused
34053   first failed: 21-Feb-1996 14:57:34
34054   last tried:   21-Feb-1996 14:57:34
34055   next try at:  21-Feb-1996 15:02:34
34056 roo.milne.example:192.168.8.3 error 146: Connection refused
34057   first failed: 20-Jan-1996 13:12:08
34058   last tried:   21-Feb-1996 11:42:03
34059   next try at:  21-Feb-1996 19:42:03
34060   past final cutoff time
34061 .endd
34062 You can also give &'exinext'& a local part, without a domain, and it
34063 will give any retry information for that local part in your default domain.
34064 A message id can be used to obtain retry information pertaining to a specific
34065 message. This exists only when an attempt to deliver a message to a remote host
34066 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34067 &'exinext'& is not particularly efficient, but then it is not expected to be
34068 run very often.
34069
34070 The &'exinext'& utility calls Exim to find out information such as the location
34071 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34072 passed on to the &'exim'& commands. The first specifies an alternate Exim
34073 configuration file, and the second sets macros for use within the configuration
34074 file. These features are mainly to help in testing, but might also be useful in
34075 environments where more than one configuration file is in use.
34076
34077
34078
34079 .section "Hints database maintenance" "SECThindatmai"
34080 .cindex "hints database" "maintenance"
34081 .cindex "maintaining Exim's hints database"
34082 Three utility programs are provided for maintaining the DBM files that Exim
34083 uses to contain its delivery hint information. Each program requires two
34084 arguments. The first specifies the name of Exim's spool directory, and the
34085 second is the name of the database it is to operate on. These are as follows:
34086
34087 .ilist
34088 &'retry'&: the database of retry information
34089 .next
34090 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34091 for remote hosts
34092 .next
34093 &'callout'&: the callout cache
34094 .next
34095 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34096 .next
34097 &'misc'&: other hints data
34098 .endlist
34099
34100 The &'misc'& database is used for
34101
34102 .ilist
34103 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34104 .next
34105 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34106 &(smtp)& transport)
34107 .endlist
34108
34109
34110
34111 .section "exim_dumpdb" "SECID261"
34112 .cindex "&'exim_dumpdb'&"
34113 The entire contents of a database are written to the standard output by the
34114 &'exim_dumpdb'& program, which has no options or arguments other than the
34115 spool and database names. For example, to dump the retry database:
34116 .code
34117 exim_dumpdb /var/spool/exim retry
34118 .endd
34119 Two lines of output are produced for each entry:
34120 .code
34121 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34122 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34123 .endd
34124 The first item on the first line is the key of the record. It starts with one
34125 of the letters R, or T, depending on whether it refers to a routing or
34126 transport retry. For a local delivery, the next part is the local address; for
34127 a remote delivery it is the name of the remote host, followed by its failing IP
34128 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34129 transport). If the remote port is not the standard one (port 25), it is added
34130 to the IP address. Then there follows an error code, an additional error code,
34131 and a textual description of the error.
34132
34133 The three times on the second line are the time of first failure, the time of
34134 the last delivery attempt, and the computed time for the next attempt. The line
34135 ends with an asterisk if the cutoff time for the last retry rule has been
34136 exceeded.
34137
34138 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34139 consists of a host name followed by a list of ids for messages that are or were
34140 waiting to be delivered to that host. If there are a very large number for any
34141 one host, continuation records, with a sequence number added to the host name,
34142 may be seen. The data in these records is often out of date, because a message
34143 may be routed to several alternative hosts, and Exim makes no effort to keep
34144 cross-references.
34145
34146
34147
34148 .section "exim_tidydb" "SECID262"
34149 .cindex "&'exim_tidydb'&"
34150 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34151 database. If run with no options, it removes all records that are more than 30
34152 days old. The age is calculated from the date and time that the record was last
34153 updated. Note that, in the case of the retry database, it is &'not'& the time
34154 since the first delivery failure. Information about a host that has been down
34155 for more than 30 days will remain in the database, provided that the record is
34156 updated sufficiently often.
34157
34158 The cutoff date can be altered by means of the &%-t%& option, which must be
34159 followed by a time. For example, to remove all records older than a week from
34160 the retry database:
34161 .code
34162 exim_tidydb -t 7d /var/spool/exim retry
34163 .endd
34164 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34165 message ids. In the former these appear as data in records keyed by host &--
34166 they were messages that were waiting for that host &-- and in the latter they
34167 are the keys for retry information for messages that have suffered certain
34168 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34169 message ids in database records are those of messages that are still on the
34170 queue. Message ids for messages that no longer exist are removed from
34171 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34172 For the &'retry'& database, records whose keys are non-existent message ids are
34173 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34174 whenever it removes information from the database.
34175
34176 Certain records are automatically removed by Exim when they are no longer
34177 needed, but others are not. For example, if all the MX hosts for a domain are
34178 down, a retry record is created for each one. If the primary MX host comes back
34179 first, its record is removed when Exim successfully delivers to it, but the
34180 records for the others remain because Exim has not tried to use those hosts.
34181
34182 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34183 hints databases. You should do this at a quiet time of day, because it requires
34184 a database to be locked (and therefore inaccessible to Exim) while it does its
34185 work. Removing records from a DBM file does not normally make the file smaller,
34186 but all the common DBM libraries are able to re-use the space that is released.
34187 After an initial phase of increasing in size, the databases normally reach a
34188 point at which they no longer get any bigger, as long as they are regularly
34189 tidied.
34190
34191 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34192 databases is likely to keep on increasing.
34193
34194
34195
34196
34197 .section "exim_fixdb" "SECID263"
34198 .cindex "&'exim_fixdb'&"
34199 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34200 Its main use is for testing Exim, but it might also be occasionally useful for
34201 getting round problems in a live system. It has no options, and its interface
34202 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34203 key of a database record can then be entered, and the data for that record is
34204 displayed.
34205
34206 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34207 except the &'retry'& database, that is the only operation that can be carried
34208 out. For the &'retry'& database, each field is output preceded by a number, and
34209 data for individual fields can be changed by typing the field number followed
34210 by new data, for example:
34211 .code
34212 > 4 951102:1000
34213 .endd
34214 resets the time of the next delivery attempt. Time values are given as a
34215 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34216 used as optional separators.
34217
34218
34219
34220
34221 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34222 .cindex "mailbox" "maintenance"
34223 .cindex "&'exim_lock'&"
34224 .cindex "locking mailboxes"
34225 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34226 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34227 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34228 a user agent while investigating a problem. The utility requires the name of
34229 the file as its first argument. If the locking is successful, the second
34230 argument is run as a command (using C's &[system()]& function); if there is no
34231 second argument, the value of the SHELL environment variable is used; if this
34232 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34233 is unlocked and the utility ends. The following options are available:
34234
34235 .vlist
34236 .vitem &%-fcntl%&
34237 Use &[fcntl()]& locking on the open mailbox.
34238
34239 .vitem &%-flock%&
34240 Use &[flock()]& locking on the open mailbox, provided the operating system
34241 supports it.
34242
34243 .vitem &%-interval%&
34244 This must be followed by a number, which is a number of seconds; it sets the
34245 interval to sleep between retries (default 3).
34246
34247 .vitem &%-lockfile%&
34248 Create a lock file before opening the mailbox.
34249
34250 .vitem &%-mbx%&
34251 Lock the mailbox using MBX rules.
34252
34253 .vitem &%-q%&
34254 Suppress verification output.
34255
34256 .vitem &%-retries%&
34257 This must be followed by a number; it sets the number of times to try to get
34258 the lock (default 10).
34259
34260 .vitem &%-restore_time%&
34261 This option causes &%exim_lock%& to restore the modified and read times to the
34262 locked file before exiting. This allows you to access a locked mailbox (for
34263 example, to take a backup copy) without disturbing the times that the user
34264 subsequently sees.
34265
34266 .vitem &%-timeout%&
34267 This must be followed by a number, which is a number of seconds; it sets a
34268 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
34269 default), a non-blocking call is used.
34270
34271 .vitem &%-v%&
34272 Generate verbose output.
34273 .endlist
34274
34275 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
34276 default is to create a lock file and also to use &[fcntl()]& locking on the
34277 mailbox, which is the same as Exim's default. The use of &%-flock%& or
34278 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
34279 requires that the directory containing the file be writeable. Locking by lock
34280 file does not last for ever; Exim assumes that a lock file is expired if it is
34281 more than 30 minutes old.
34282
34283 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
34284 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
34285 to be taken out on the open mailbox, and an exclusive lock on the file
34286 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
34287 number of the mailbox file. When the locking is released, if an exclusive lock
34288 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
34289
34290 The default output contains verification of the locking that takes place. The
34291 &%-v%& option causes some additional information to be given. The &%-q%& option
34292 suppresses all output except error messages.
34293
34294 A command such as
34295 .code
34296 exim_lock /var/spool/mail/spqr
34297 .endd
34298 runs an interactive shell while the file is locked, whereas
34299 .display
34300 &`exim_lock -q /var/spool/mail/spqr <<End`&
34301 <&'some commands'&>
34302 &`End`&
34303 .endd
34304 runs a specific non-interactive sequence of commands while the file is locked,
34305 suppressing all verification output. A single command can be run by a command
34306 such as
34307 .code
34308 exim_lock -q /var/spool/mail/spqr \
34309   "cp /var/spool/mail/spqr /some/where"
34310 .endd
34311 Note that if a command is supplied, it must be entirely contained within the
34312 second argument &-- hence the quotes.
34313 .ecindex IIDutils
34314
34315
34316 . ////////////////////////////////////////////////////////////////////////////
34317 . ////////////////////////////////////////////////////////////////////////////
34318
34319 .chapter "The Exim monitor" "CHAPeximon"
34320 .scindex IIDeximon "Exim monitor" "description"
34321 .cindex "X-windows"
34322 .cindex "&'eximon'&"
34323 .cindex "Local/eximon.conf"
34324 .cindex "&_exim_monitor/EDITME_&"
34325 The Exim monitor is an application which displays in an X window information
34326 about the state of Exim's queue and what Exim is doing. An admin user can
34327 perform certain operations on messages from this GUI interface; however all
34328 such facilities are also available from the command line, and indeed, the
34329 monitor itself makes use of the command line to perform any actions requested.
34330
34331
34332
34333 .section "Running the monitor" "SECID264"
34334 The monitor is started by running the script called &'eximon'&. This is a shell
34335 script that sets up a number of environment variables, and then runs the
34336 binary called &_eximon.bin_&. The default appearance of the monitor window can
34337 be changed by editing the &_Local/eximon.conf_& file created by editing
34338 &_exim_monitor/EDITME_&. Comments in that file describe what the various
34339 parameters are for.
34340
34341 The parameters that get built into the &'eximon'& script can be overridden for
34342 a particular invocation by setting up environment variables of the same names,
34343 preceded by &`EXIMON_`&. For example, a shell command such as
34344 .code
34345 EXIMON_LOG_DEPTH=400 eximon
34346 .endd
34347 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
34348 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
34349 overrides the Exim log file configuration. This makes it possible to have
34350 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
34351 syslog messages are routed to a file on the local host.
34352
34353 X resources can be used to change the appearance of the window in the normal
34354 way. For example, a resource setting of the form
34355 .code
34356 Eximon*background: gray94
34357 .endd
34358 changes the colour of the background to light grey rather than white. The
34359 stripcharts are drawn with both the data lines and the reference lines in
34360 black. This means that the reference lines are not visible when on top of the
34361 data. However, their colour can be changed by setting a resource called
34362 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
34363 For example, if your X server is running Unix, you could set up lighter
34364 reference lines in the stripcharts by obeying
34365 .code
34366 xrdb -merge <<End
34367 Eximon*highlight: gray
34368 End
34369 .endd
34370 .cindex "admin user"
34371 In order to see the contents of messages on the queue, and to operate on them,
34372 &'eximon'& must either be run as root or by an admin user.
34373
34374 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
34375 contain X11 resource parameters interpreted by the X11 library.  In addition,
34376 if the first parameter starts with the string "gdb" then it is removed and the
34377 binary is invoked under gdb (the parameter is used as the gdb command-name, so
34378 versioned variants of gdb can be invoked).
34379
34380 The monitor's window is divided into three parts. The first contains one or
34381 more stripcharts and two action buttons, the second contains a &"tail"& of the
34382 main log file, and the third is a display of the queue of messages awaiting
34383 delivery, with two more action buttons. The following sections describe these
34384 different parts of the display.
34385
34386
34387
34388
34389 .section "The stripcharts" "SECID265"
34390 .cindex "stripchart"
34391 The first stripchart is always a count of messages on the queue. Its name can
34392 be configured by setting QUEUE_STRIPCHART_NAME in the
34393 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
34394 configuration script by regular expression matches on log file entries, making
34395 it possible to display, for example, counts of messages delivered to certain
34396 hosts or using certain transports. The supplied defaults display counts of
34397 received and delivered messages, and of local and SMTP deliveries. The default
34398 period between stripchart updates is one minute; this can be adjusted by a
34399 parameter in the &_Local/eximon.conf_& file.
34400
34401 The stripchart displays rescale themselves automatically as the value they are
34402 displaying changes. There are always 10 horizontal lines in each chart; the
34403 title string indicates the value of each division when it is greater than one.
34404 For example, &"x2"& means that each division represents a value of 2.
34405
34406 It is also possible to have a stripchart which shows the percentage fullness of
34407 a particular disk partition, which is useful when local deliveries are confined
34408 to a single partition.
34409
34410 .cindex "&%statvfs%& function"
34411 This relies on the availability of the &[statvfs()]& function or equivalent in
34412 the operating system. Most, but not all versions of Unix that support Exim have
34413 this. For this particular stripchart, the top of the chart always represents
34414 100%, and the scale is given as &"x10%"&. This chart is configured by setting
34415 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
34416 &_Local/eximon.conf_& file.
34417
34418
34419
34420
34421 .section "Main action buttons" "SECID266"
34422 .cindex "size" "of monitor window"
34423 .cindex "Exim monitor" "window size"
34424 .cindex "window size"
34425 Below the stripcharts there is an action button for quitting the monitor. Next
34426 to this is another button marked &"Size"&. They are placed here so that
34427 shrinking the window to its default minimum size leaves just the queue count
34428 stripchart and these two buttons visible. Pressing the &"Size"& button causes
34429 the window to expand to its maximum size, unless it is already at the maximum,
34430 in which case it is reduced to its minimum.
34431
34432 When expanding to the maximum, if the window cannot be fully seen where it
34433 currently is, it is moved back to where it was the last time it was at full
34434 size. When it is expanding from its minimum size, the old position is
34435 remembered, and next time it is reduced to the minimum it is moved back there.
34436
34437 The idea is that you can keep a reduced window just showing one or two
34438 stripcharts at a convenient place on your screen, easily expand it to show
34439 the full window when required, and just as easily put it back to what it was.
34440 The idea is copied from what the &'twm'& window manager does for its
34441 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
34442 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
34443
34444 Normally, the monitor starts up with the window at its full size, but it can be
34445 built so that it starts up with the window at its smallest size, by setting
34446 START_SMALL=yes in &_Local/eximon.conf_&.
34447
34448
34449
34450 .section "The log display" "SECID267"
34451 .cindex "log" "tail of; in monitor"
34452 The second section of the window is an area in which a display of the tail of
34453 the main log is maintained.
34454 To save space on the screen, the timestamp on each log line is shortened by
34455 removing the date and, if &%log_timezone%& is set, the timezone.
34456 The log tail is not available when the only destination for logging data is
34457 syslog, unless the syslog lines are routed to a local file whose name is passed
34458 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
34459
34460 The log sub-window has a scroll bar at its lefthand side which can be used to
34461 move back to look at earlier text, and the up and down arrow keys also have a
34462 scrolling effect. The amount of log that is kept depends on the setting of
34463 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
34464 to use. When this is full, the earlier 50% of data is discarded &-- this is
34465 much more efficient than throwing it away line by line. The sub-window also has
34466 a horizontal scroll bar for accessing the ends of long log lines. This is the
34467 only means of horizontal scrolling; the right and left arrow keys are not
34468 available. Text can be cut from this part of the window using the mouse in the
34469 normal way. The size of this subwindow is controlled by parameters in the
34470 configuration file &_Local/eximon.conf_&.
34471
34472 Searches of the text in the log window can be carried out by means of the ^R
34473 and ^S keystrokes, which default to a reverse and a forward search,
34474 respectively. The search covers only the text that is displayed in the window.
34475 It cannot go further back up the log.
34476
34477 The point from which the search starts is indicated by a caret marker. This is
34478 normally at the end of the text in the window, but can be positioned explicitly
34479 by pointing and clicking with the left mouse button, and is moved automatically
34480 by a successful search. If new text arrives in the window when it is scrolled
34481 back, the caret remains where it is, but if the window is not scrolled back,
34482 the caret is moved to the end of the new text.
34483
34484 Pressing ^R or ^S pops up a window into which the search text can be typed.
34485 There are buttons for selecting forward or reverse searching, for carrying out
34486 the search, and for cancelling. If the &"Search"& button is pressed, the search
34487 happens and the window remains so that further searches can be done. If the
34488 &"Return"& key is pressed, a single search is done and the window is closed. If
34489 ^C is typed the search is cancelled.
34490
34491 The searching facility is implemented using the facilities of the Athena text
34492 widget. By default this pops up a window containing both &"search"& and
34493 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
34494 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
34495 However, the linkers in BSDI and HP-UX seem unable to handle an externally
34496 provided version of &%TextPop%& when the remaining parts of the text widget
34497 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
34498 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
34499 on these systems, at the expense of having unwanted items in the search popup
34500 window.
34501
34502
34503
34504 .section "The queue display" "SECID268"
34505 .cindex "queue" "display in monitor"
34506 The bottom section of the monitor window contains a list of all messages that
34507 are on the queue, which includes those currently being received or delivered,
34508 as well as those awaiting delivery. The size of this subwindow is controlled by
34509 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
34510 at which it is updated is controlled by another parameter in the same file &--
34511 the default is 5 minutes, since queue scans can be quite expensive. However,
34512 there is an &"Update"& action button just above the display which can be used
34513 to force an update of the queue display at any time.
34514
34515 When a host is down for some time, a lot of pending mail can build up for it,
34516 and this can make it hard to deal with other messages on the queue. To help
34517 with this situation there is a button next to &"Update"& called &"Hide"&. If
34518 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
34519 type anything in here and press &"Return"&, the text is added to a chain of
34520 such texts, and if every undelivered address in a message matches at least one
34521 of the texts, the message is not displayed.
34522
34523 If there is an address that does not match any of the texts, all the addresses
34524 are displayed as normal. The matching happens on the ends of addresses so, for
34525 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
34526 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
34527 has been set up, a button called &"Unhide"& is displayed. If pressed, it
34528 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
34529 a hide request is automatically cancelled after one hour.
34530
34531 While the dialogue box is displayed, you can't press any buttons or do anything
34532 else to the monitor window. For this reason, if you want to cut text from the
34533 queue display to use in the dialogue box, you have to do the cutting before
34534 pressing the &"Hide"& button.
34535
34536 The queue display contains, for each unhidden queued message, the length of
34537 time it has been on the queue, the size of the message, the message id, the
34538 message sender, and the first undelivered recipient, all on one line. If it is
34539 a bounce message, the sender is shown as &"<>"&. If there is more than one
34540 recipient to which the message has not yet been delivered, subsequent ones are
34541 listed on additional lines, up to a maximum configured number, following which
34542 an ellipsis is displayed. Recipients that have already received the message are
34543 not shown.
34544
34545 .cindex "frozen messages" "display"
34546 If a message is frozen, an asterisk is displayed at the left-hand side.
34547
34548 The queue display has a vertical scroll bar, and can also be scrolled by means
34549 of the arrow keys. Text can be cut from it using the mouse in the normal way.
34550 The text searching facilities, as described above for the log window, are also
34551 available, but the caret is always moved to the end of the text when the queue
34552 display is updated.
34553
34554
34555
34556 .section "The queue menu" "SECID269"
34557 .cindex "queue" "menu in monitor"
34558 If the &%shift%& key is held down and the left button is clicked when the mouse
34559 pointer is over the text for any message, an action menu pops up, and the first
34560 line of the queue display for the message is highlighted. This does not affect
34561 any selected text.
34562
34563 If you want to use some other event for popping up the menu, you can set the
34564 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
34565 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
34566 value set in this parameter is a standard X event description. For example, to
34567 run eximon using &%ctrl%& rather than &%shift%& you could use
34568 .code
34569 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
34570 .endd
34571 The title of the menu is the message id, and it contains entries which act as
34572 follows:
34573
34574 .ilist
34575 &'message log'&: The contents of the message log for the message are displayed
34576 in a new text window.
34577 .next
34578 &'headers'&: Information from the spool file that contains the envelope
34579 information and headers is displayed in a new text window. See chapter
34580 &<<CHAPspool>>& for a description of the format of spool files.
34581 .next
34582 &'body'&: The contents of the spool file containing the body of the message are
34583 displayed in a new text window. There is a default limit of 20,000 bytes to the
34584 amount of data displayed. This can be changed by setting the BODY_MAX
34585 option at compile time, or the EXIMON_BODY_MAX option at run time.
34586 .next
34587 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
34588 delivery of the message. This causes an automatic thaw if the message is
34589 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
34590 a new text window. The delivery is run in a separate process, to avoid holding
34591 up the monitor while the delivery proceeds.
34592 .next
34593 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
34594 that the message be frozen.
34595 .next
34596 .cindex "thawing messages"
34597 .cindex "unfreezing messages"
34598 .cindex "frozen messages" "thawing"
34599 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
34600 that the message be thawed.
34601 .next
34602 .cindex "delivery" "forcing failure"
34603 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
34604 that Exim gives up trying to deliver the message. A bounce message is generated
34605 for any remaining undelivered addresses.
34606 .next
34607 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
34608 that the message be deleted from the system without generating a bounce
34609 message.
34610 .next
34611 &'add recipient'&: A dialog box is displayed into which a recipient address can
34612 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34613 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34614 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34615 causes a call to Exim to be made using the &%-Mar%& option to request that an
34616 additional recipient be added to the message, unless the entry box is empty, in
34617 which case no action is taken.
34618 .next
34619 &'mark delivered'&: A dialog box is displayed into which a recipient address
34620 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34621 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34622 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34623 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
34624 recipient address as already delivered, unless the entry box is empty, in which
34625 case no action is taken.
34626 .next
34627 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
34628 mark all recipient addresses as already delivered.
34629 .next
34630 &'edit sender'&: A dialog box is displayed initialized with the current
34631 sender's address. Pressing RETURN causes a call to Exim to be made using the
34632 &%-Mes%& option to replace the sender address, unless the entry box is empty,
34633 in which case no action is taken. If you want to set an empty sender (as in
34634 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
34635 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
34636 the address is qualified with that domain.
34637 .endlist
34638
34639 When a delivery is forced, a window showing the &%-v%& output is displayed. In
34640 other cases when a call to Exim is made, if there is any output from Exim (in
34641 particular, if the command fails) a window containing the command and the
34642 output is displayed. Otherwise, the results of the action are normally apparent
34643 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
34644 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
34645 if no output is generated.
34646
34647 The queue display is automatically updated for actions such as freezing and
34648 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
34649 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
34650 force an update of the display after one of these actions.
34651
34652 In any text window that is displayed as result of a menu action, the normal
34653 cut-and-paste facility is available, and searching can be carried out using ^R
34654 and ^S, as described above for the log tail window.
34655 .ecindex IIDeximon
34656
34657
34658
34659
34660
34661 . ////////////////////////////////////////////////////////////////////////////
34662 . ////////////////////////////////////////////////////////////////////////////
34663
34664 .chapter "Security considerations" "CHAPsecurity"
34665 .scindex IIDsecurcon "security" "discussion of"
34666 This chapter discusses a number of issues concerned with security, some of
34667 which are also covered in other parts of this manual.
34668
34669 For reasons that this author does not understand, some people have promoted
34670 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
34671 existence of this chapter in the documentation. However, the intent of the
34672 chapter is simply to describe the way Exim works in relation to certain
34673 security concerns, not to make any specific claims about the effectiveness of
34674 its security as compared with other MTAs.
34675
34676 What follows is a description of the way Exim is supposed to be. Best efforts
34677 have been made to try to ensure that the code agrees with the theory, but an
34678 absence of bugs can never be guaranteed. Any that are reported will get fixed
34679 as soon as possible.
34680
34681
34682 .section "Building a more &""hardened""& Exim" "SECID286"
34683 .cindex "security" "build-time features"
34684 There are a number of build-time options that can be set in &_Local/Makefile_&
34685 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
34686 Exim administrator who does not have the root password, or by someone who has
34687 penetrated the Exim (but not the root) account. These options are as follows:
34688
34689 .ilist
34690 ALT_CONFIG_PREFIX can be set to a string that is required to match the
34691 start of any file names used with the &%-C%& option. When it is set, these file
34692 names are also not allowed to contain the sequence &"/../"&. (However, if the
34693 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
34694 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
34695 default setting for &%ALT_CONFIG_PREFIX%&.
34696
34697 If the permitted configuration files are confined to a directory to
34698 which only root has access, this guards against someone who has broken
34699 into the Exim account from running a privileged Exim with an arbitrary
34700 configuration file, and using it to break into other accounts.
34701 .next
34702
34703 If a non-trusted configuration file (i.e. not the default configuration file
34704 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
34705 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
34706 the next item), then root privilege is retained only if the caller of Exim is
34707 root. This locks out the possibility of testing a configuration using &%-C%&
34708 right through message reception and delivery, even if the caller is root. The
34709 reception works, but by that time, Exim is running as the Exim user, so when
34710 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
34711 privilege to be lost. However, root can test reception and delivery using two
34712 separate commands.
34713
34714 .next
34715 The WHITELIST_D_MACROS build option declares some macros to be safe to override
34716 with &%-D%& if the real uid is one of root, the Exim run-time user or the
34717 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
34718 requiring the run-time value supplied to &%-D%& to match a regex that errs on
34719 the restrictive side.  Requiring build-time selection of safe macros is onerous
34720 but this option is intended solely as a transition mechanism to permit
34721 previously-working configurations to continue to work after release 4.73.
34722 .next
34723 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
34724 is disabled.
34725 .next
34726 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
34727 never to be used for any deliveries. This is like the &%never_users%& runtime
34728 option, but it cannot be overridden; the runtime option adds additional users
34729 to the list. The default setting is &"root"&; this prevents a non-root user who
34730 is permitted to modify the runtime file from using Exim as a way to get root.
34731 .endlist
34732
34733
34734
34735 .section "Root privilege" "SECID270"
34736 .cindex "setuid"
34737 .cindex "root privilege"
34738 The Exim binary is normally setuid to root, which means that it gains root
34739 privilege (runs as root) when it starts execution. In some special cases (for
34740 example, when the daemon is not in use and there are no local deliveries), it
34741 may be possible to run Exim setuid to some user other than root. This is
34742 discussed in the next section. However, in most installations, root privilege
34743 is required for two things:
34744
34745 .ilist
34746 To set up a socket connected to the standard SMTP port (25) when initialising
34747 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
34748 not required.
34749 .next
34750 To be able to change uid and gid in order to read users' &_.forward_& files and
34751 perform local deliveries as the receiving user or as specified in the
34752 configuration.
34753 .endlist
34754
34755 It is not necessary to be root to do any of the other things Exim does, such as
34756 receiving messages and delivering them externally over SMTP, and it is
34757 obviously more secure if Exim does not run as root except when necessary.
34758 For this reason, a user and group for Exim to use must be defined in
34759 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
34760 group"&. Their values can be changed by the run time configuration, though this
34761 is not recommended. Often a user called &'exim'& is used, but some sites use
34762 &'mail'& or another user name altogether.
34763
34764 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
34765 abdication; the process cannot regain root afterwards. Prior to release 4.00,
34766 &[seteuid()]& was used in some circumstances, but this is no longer the case.
34767
34768 After a new Exim process has interpreted its command line options, it changes
34769 uid and gid in the following cases:
34770
34771 .ilist
34772 .oindex "&%-C%&"
34773 .oindex "&%-D%&"
34774 If the &%-C%& option is used to specify an alternate configuration file, or if
34775 the &%-D%& option is used to define macro values for the configuration, and the
34776 calling process is not running as root, the uid and gid are changed to those of
34777 the calling process.
34778 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
34779 option may not be used at all.
34780 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
34781 can be supplied if the calling process is running as root, the Exim run-time
34782 user or CONFIGURE_OWNER, if defined.
34783 .next
34784 .oindex "&%-be%&"
34785 .oindex "&%-bf%&"
34786 .oindex "&%-bF%&"
34787 If the expansion test option (&%-be%&) or one of the filter testing options
34788 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
34789 calling process.
34790 .next
34791 If the process is not a daemon process or a queue runner process or a delivery
34792 process or a process for testing address routing (started with &%-bt%&), the
34793 uid and gid are changed to the Exim user and group. This means that Exim always
34794 runs under its own uid and gid when receiving messages. This also applies when
34795 testing address verification
34796 .oindex "&%-bv%&"
34797 .oindex "&%-bh%&"
34798 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
34799 option).
34800 .next
34801 For a daemon, queue runner, delivery, or address testing process, the uid
34802 remains as root at this stage, but the gid is changed to the Exim group.
34803 .endlist
34804
34805 The processes that initially retain root privilege behave as follows:
34806
34807 .ilist
34808 A daemon process changes the gid to the Exim group and the uid to the Exim
34809 user after setting up one or more listening sockets. The &[initgroups()]&
34810 function is called, so that if the Exim user is in any additional groups, they
34811 will be used during message reception.
34812 .next
34813 A queue runner process retains root privilege throughout its execution. Its
34814 job is to fork a controlled sequence of delivery processes.
34815 .next
34816 A delivery process retains root privilege throughout most of its execution,
34817 but any actual deliveries (that is, the transports themselves) are run in
34818 subprocesses which always change to a non-root uid and gid. For local
34819 deliveries this is typically the uid and gid of the owner of the mailbox; for
34820 remote deliveries, the Exim uid and gid are used. Once all the delivery
34821 subprocesses have been run, a delivery process changes to the Exim uid and gid
34822 while doing post-delivery tidying up such as updating the retry database and
34823 generating bounce and warning messages.
34824
34825 While the recipient addresses in a message are being routed, the delivery
34826 process runs as root. However, if a user's filter file has to be processed,
34827 this is done in a subprocess that runs under the individual user's uid and
34828 gid. A system filter is run as root unless &%system_filter_user%& is set.
34829 .next
34830 A process that is testing addresses (the &%-bt%& option) runs as root so that
34831 the routing is done in the same environment as a message delivery.
34832 .endlist
34833
34834
34835
34836
34837 .section "Running Exim without privilege" "SECTrunexiwitpri"
34838 .cindex "privilege, running without"
34839 .cindex "unprivileged running"
34840 .cindex "root privilege" "running without"
34841 Some installations like to run Exim in an unprivileged state for more of its
34842 operation, for added security. Support for this mode of operation is provided
34843 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34844 gid are changed to the Exim user and group at the start of a delivery process
34845 (and also queue runner and address testing processes). This means that address
34846 routing is no longer run as root, and the deliveries themselves cannot change
34847 to any other uid.
34848
34849 .cindex SIGHUP
34850 .cindex "daemon" "restarting"
34851 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34852 that the daemon can still be started in the usual way, and it can respond
34853 correctly to SIGHUP because the re-invocation regains root privilege.
34854
34855 An alternative approach is to make Exim setuid to the Exim user and also setgid
34856 to the Exim group. If you do this, the daemon must be started from a root
34857 process. (Calling Exim from a root process makes it behave in the way it does
34858 when it is setuid root.) However, the daemon cannot restart itself after a
34859 SIGHUP signal because it cannot regain privilege.
34860
34861 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34862 stops Exim from trying to re-invoke itself to do a delivery after a message has
34863 been received. Such a re-invocation is a waste of resources because it has no
34864 effect.
34865
34866 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34867 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34868 to the Exim user seems a clean approach, but there is one complication:
34869
34870 In this style of operation, Exim is running with the real uid and gid set to
34871 those of the calling process, and the effective uid/gid set to Exim's values.
34872 Ideally, any association with the calling process' uid/gid should be dropped,
34873 that is, the real uid/gid should be reset to the effective values so as to
34874 discard any privileges that the caller may have. While some operating systems
34875 have a function that permits this action for a non-root effective uid, quite a
34876 number of them do not. Because of this lack of standardization, Exim does not
34877 address this problem at this time.
34878
34879 For this reason, the recommended approach for &"mostly unprivileged"& running
34880 is to keep the Exim binary setuid to root, and to set
34881 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34882 be used in the most straightforward way.
34883
34884 If you configure Exim not to run delivery processes as root, there are a
34885 number of restrictions on what you can do:
34886
34887 .ilist
34888 You can deliver only as the Exim user/group. You should  explicitly use the
34889 &%user%& and &%group%& options to override routers or local transports that
34890 normally deliver as the recipient. This makes sure that configurations that
34891 work in this mode function the same way in normal mode. Any implicit or
34892 explicit specification of another user causes an error.
34893 .next
34894 Use of &_.forward_& files is severely restricted, such that it is usually
34895 not worthwhile to include them in the configuration.
34896 .next
34897 Users who wish to use &_.forward_& would have to make their home directory and
34898 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34899 and their equivalents in Exim filters, cannot be used. While they could be
34900 enabled in the Exim user's name, that would be insecure and not very useful.
34901 .next
34902 Unless the local user mailboxes are all owned by the Exim user (possible in
34903 some POP3 or IMAP-only environments):
34904
34905 .olist
34906 They must be owned by the Exim group and be writeable by that group. This
34907 implies you must set &%mode%& in the appendfile configuration, as well as the
34908 mode of the mailbox files themselves.
34909 .next
34910 You must set &%no_check_owner%&, since most or all of the files will not be
34911 owned by the Exim user.
34912 .next
34913 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34914 on a newly created mailbox when unprivileged. This also implies that new
34915 mailboxes need to be created manually.
34916 .endlist olist
34917 .endlist ilist
34918
34919
34920 These restrictions severely restrict what can be done in local deliveries.
34921 However, there are no restrictions on remote deliveries. If you are running a
34922 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34923 gives more security at essentially no cost.
34924
34925 If you are using the &%mua_wrapper%& facility (see chapter
34926 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34927
34928
34929
34930
34931 .section "Delivering to local files" "SECID271"
34932 Full details of the checks applied by &(appendfile)& before it writes to a file
34933 are given in chapter &<<CHAPappendfile>>&.
34934
34935
34936
34937 .section "IPv4 source routing" "SECID272"
34938 .cindex "source routing" "in IP packets"
34939 .cindex "IP source routing"
34940 Many operating systems suppress IP source-routed packets in the kernel, but
34941 some cannot be made to do this, so Exim does its own check. It logs incoming
34942 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34943 IPv6. No special checking is currently done.
34944
34945
34946
34947 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34948 Support for these SMTP commands is disabled by default. If required, they can
34949 be enabled by defining suitable ACLs.
34950
34951
34952
34953
34954 .section "Privileged users" "SECID274"
34955 .cindex "trusted users"
34956 .cindex "admin user"
34957 .cindex "privileged user"
34958 .cindex "user" "trusted"
34959 .cindex "user" "admin"
34960 Exim recognizes two sets of users with special privileges. Trusted users are
34961 able to submit new messages to Exim locally, but supply their own sender
34962 addresses and information about a sending host. For other users submitting
34963 local messages, Exim sets up the sender address from the uid, and doesn't
34964 permit a remote host to be specified.
34965
34966 .oindex "&%-f%&"
34967 However, an untrusted user is permitted to use the &%-f%& command line option
34968 in the special form &%-f <>%& to indicate that a delivery failure for the
34969 message should not cause an error report. This affects the message's envelope,
34970 but it does not affect the &'Sender:'& header. Untrusted users may also be
34971 permitted to use specific forms of address with the &%-f%& option by setting
34972 the &%untrusted_set_sender%& option.
34973
34974 Trusted users are used to run processes that receive mail messages from some
34975 other mail domain and pass them on to Exim for delivery either locally, or over
34976 the Internet. Exim trusts a caller that is running as root, as the Exim user,
34977 as any user listed in the &%trusted_users%& configuration option, or under any
34978 group listed in the &%trusted_groups%& option.
34979
34980 Admin users are permitted to do things to the messages on Exim's queue. They
34981 can freeze or thaw messages, cause them to be returned to their senders, remove
34982 them entirely, or modify them in various ways. In addition, admin users can run
34983 the Exim monitor and see all the information it is capable of providing, which
34984 includes the contents of files on the spool.
34985
34986 .oindex "&%-M%&"
34987 .oindex "&%-q%&"
34988 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
34989 delivery of messages on its queue is restricted to admin users. This
34990 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
34991 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
34992 queue is also restricted to admin users. This restriction can be relaxed by
34993 setting &%no_queue_list_requires_admin%&.
34994
34995 Exim recognizes an admin user if the calling process is running as root or as
34996 the Exim user or if any of the groups associated with the calling process is
34997 the Exim group. It is not necessary actually to be running under the Exim
34998 group. However, if admin users who are not root or the Exim user are to access
34999 the contents of files on the spool via the Exim monitor (which runs
35000 unprivileged), Exim must be built to allow group read access to its spool
35001 files.
35002
35003
35004
35005 .section "Spool files" "SECID275"
35006 .cindex "spool directory" "files"
35007 Exim's spool directory and everything it contains is owned by the Exim user and
35008 set to the Exim group. The mode for spool files is defined in the
35009 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35010 any user who is a member of the Exim group can access these files.
35011
35012
35013
35014 .section "Use of argv[0]" "SECID276"
35015 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35016 of specific strings, Exim assumes certain options. For example, calling Exim
35017 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35018 to calling it with the option &%-bS%&. There are no security implications in
35019 this.
35020
35021
35022
35023 .section "Use of %f formatting" "SECID277"
35024 The only use made of &"%f"& by Exim is in formatting load average values. These
35025 are actually stored in integer variables as 1000 times the load average.
35026 Consequently, their range is limited and so therefore is the length of the
35027 converted output.
35028
35029
35030
35031 .section "Embedded Exim path" "SECID278"
35032 Exim uses its own path name, which is embedded in the code, only when it needs
35033 to re-exec in order to regain root privilege. Therefore, it is not root when it
35034 does so. If some bug allowed the path to get overwritten, it would lead to an
35035 arbitrary program's being run as exim, not as root.
35036
35037
35038
35039 .section "Dynamic module directory" "SECTdynmoddir"
35040 Any dynamically loadable modules must be installed into the directory
35041 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35042 loading it.
35043
35044
35045 .section "Use of sprintf()" "SECID279"
35046 .cindex "&[sprintf()]&"
35047 A large number of occurrences of &"sprintf"& in the code are actually calls to
35048 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35049 The intermediate formatting is done into a large fixed buffer by a function
35050 that runs through the format string itself, and checks the length of each
35051 conversion before performing it, thus preventing buffer overruns.
35052
35053 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35054 the output buffer is known to be sufficiently long to contain the converted
35055 string.
35056
35057
35058
35059 .section "Use of debug_printf() and log_write()" "SECID280"
35060 Arbitrary strings are passed to both these functions, but they do their
35061 formatting by calling the function &'string_vformat()'&, which runs through
35062 the format string itself, and checks the length of each conversion.
35063
35064
35065
35066 .section "Use of strcat() and strcpy()" "SECID281"
35067 These are used only in cases where the output buffer is known to be large
35068 enough to hold the result.
35069 .ecindex IIDsecurcon
35070
35071
35072
35073
35074 . ////////////////////////////////////////////////////////////////////////////
35075 . ////////////////////////////////////////////////////////////////////////////
35076
35077 .chapter "Format of spool files" "CHAPspool"
35078 .scindex IIDforspo1 "format" "spool files"
35079 .scindex IIDforspo2 "spool directory" "format of files"
35080 .scindex IIDforspo3 "spool files" "format of"
35081 .cindex "spool files" "editing"
35082 A message on Exim's queue consists of two files, whose names are the message id
35083 followed by -D and -H, respectively. The data portion of the message is kept in
35084 the -D file on its own. The message's envelope, status, and headers are all
35085 kept in the -H file, whose format is described in this chapter. Each of these
35086 two files contains the final component of its own name as its first line. This
35087 is insurance against disk crashes where the directory is lost but the files
35088 themselves are recoverable.
35089
35090 Some people are tempted into editing -D files in order to modify messages. You
35091 need to be extremely careful if you do this; it is not recommended and you are
35092 on your own if you do it. Here are some of the pitfalls:
35093
35094 .ilist
35095 You must ensure that Exim does not try to deliver the message while you are
35096 fiddling with it. The safest way is to take out a write lock on the -D file,
35097 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35098 place, the lock will be retained. If you write a new file and rename it, the
35099 lock will be lost at the instant of rename.
35100 .next
35101 .vindex "&$body_linecount$&"
35102 If you change the number of lines in the file, the value of
35103 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35104 present, this value is not used by Exim, but there is no guarantee that this
35105 will always be the case.
35106 .next
35107 If the message is in MIME format, you must take care not to break it.
35108 .next
35109 If the message is cryptographically signed, any change will invalidate the
35110 signature.
35111 .endlist
35112 All in all, modifying -D files is fraught with danger.
35113
35114 Files whose names end with -J may also be seen in the &_input_& directory (or
35115 its subdirectories when &%split_spool_directory%& is set). These are journal
35116 files, used to record addresses to which the message has been delivered during
35117 the course of a delivery attempt. If there are still undelivered recipients at
35118 the end, the -H file is updated, and the -J file is deleted. If, however, there
35119 is some kind of crash (for example, a power outage) before this happens, the -J
35120 file remains in existence. When Exim next processes the message, it notices the
35121 -J file and uses it to update the -H file before starting the next delivery
35122 attempt.
35123
35124 .section "Format of the -H file" "SECID282"
35125 .cindex "uid (user id)" "in spool file"
35126 .cindex "gid (group id)" "in spool file"
35127 The second line of the -H file contains the login name for the uid of the
35128 process that called Exim to read the message, followed by the numerical uid and
35129 gid. For a locally generated message, this is normally the user who sent the
35130 message. For a message received over TCP/IP via the daemon, it is
35131 normally the Exim user.
35132
35133 The third line of the file contains the address of the message's sender as
35134 transmitted in the envelope, contained in angle brackets. The sender address is
35135 empty for bounce messages. For incoming SMTP mail, the sender address is given
35136 in the MAIL command. For locally generated mail, the sender address is
35137 created by Exim from the login name of the current user and the configured
35138 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35139 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35140 &"<>"& or an address that matches &%untrusted_set_senders%&.
35141
35142 The fourth line contains two numbers. The first is the time that the message
35143 was received, in the conventional Unix form &-- the number of seconds since the
35144 start of the epoch. The second number is a count of the number of messages
35145 warning of delayed delivery that have been sent to the sender.
35146
35147 There follow a number of lines starting with a hyphen. These can appear in any
35148 order, and are omitted when not relevant:
35149
35150 .vlist
35151 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35152 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35153 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35154 recognized, to provide backward compatibility. In the old format, a line of
35155 this form is present for every ACL variable that is not empty. The number
35156 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35157 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35158 the data string for the variable. The string itself starts at the beginning of
35159 the next line, and is followed by a newline character. It may contain internal
35160 newlines.
35161
35162 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35163 A line of this form is present for every ACL connection variable that is
35164 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35165 The length is the length of the data string for the variable. The string itself
35166 starts at the beginning of the next line, and is followed by a newline
35167 character. It may contain internal newlines.
35168
35169 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35170 A line of this form is present for every ACL message variable that is defined.
35171 Note that there is a space between &%-aclm%& and the rest of the name. The
35172 length is the length of the data string for the variable. The string itself
35173 starts at the beginning of the next line, and is followed by a newline
35174 character. It may contain internal newlines.
35175
35176 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35177 This is present if, when the message was received over SMTP, the value of
35178 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35179
35180 .vitem &%-allow_unqualified_recipient%&
35181 This is present if unqualified recipient addresses are permitted in header
35182 lines (to stop such addresses from being qualified if rewriting occurs at
35183 transport time). Local messages that were input using &%-bnq%& and remote
35184 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35185
35186 .vitem &%-allow_unqualified_sender%&
35187 This is present if unqualified sender addresses are permitted in header lines
35188 (to stop such addresses from being qualified if rewriting occurs at transport
35189 time). Local messages that were input using &%-bnq%& and remote messages from
35190 hosts that match &%sender_unqualified_hosts%& set this flag.
35191
35192 .vitem "&%-auth_id%&&~<&'text'&>"
35193 The id information for a message received on an authenticated SMTP connection
35194 &-- the value of the &$authenticated_id$& variable.
35195
35196 .vitem "&%-auth_sender%&&~<&'address'&>"
35197 The address of an authenticated sender &-- the value of the
35198 &$authenticated_sender$& variable.
35199
35200 .vitem "&%-body_linecount%&&~<&'number'&>"
35201 This records the number of lines in the body of the message, and is always
35202 present.
35203
35204 .vitem "&%-body_zerocount%&&~<&'number'&>"
35205 This records the number of binary zero bytes in the body of the message, and is
35206 present if the number is greater than zero.
35207
35208 .vitem &%-deliver_firsttime%&
35209 This is written when a new message is first added to the spool. When the spool
35210 file is updated after a deferral, it is omitted.
35211
35212 .vitem "&%-frozen%&&~<&'time'&>"
35213 .cindex "frozen messages" "spool data"
35214 The message is frozen, and the freezing happened at <&'time'&>.
35215
35216 .vitem "&%-helo_name%&&~<&'text'&>"
35217 This records the host name as specified by a remote host in a HELO or EHLO
35218 command.
35219
35220 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35221 This records the IP address of the host from which the message was received and
35222 the remote port number that was used. It is omitted for locally generated
35223 messages.
35224
35225 .vitem "&%-host_auth%&&~<&'text'&>"
35226 If the message was received on an authenticated SMTP connection, this records
35227 the name of the authenticator &-- the value of the
35228 &$sender_host_authenticated$& variable.
35229
35230 .vitem &%-host_lookup_failed%&
35231 This is present if an attempt to look up the sending host's name from its IP
35232 address failed. It corresponds to the &$host_lookup_failed$& variable.
35233
35234 .vitem "&%-host_name%&&~<&'text'&>"
35235 .cindex "reverse DNS lookup"
35236 .cindex "DNS" "reverse lookup"
35237 This records the name of the remote host from which the message was received,
35238 if the host name was looked up from the IP address when the message was being
35239 received. It is not present if no reverse lookup was done.
35240
35241 .vitem "&%-ident%&&~<&'text'&>"
35242 For locally submitted messages, this records the login of the originating user,
35243 unless it was a trusted user and the &%-oMt%& option was used to specify an
35244 ident value. For messages received over TCP/IP, this records the ident string
35245 supplied by the remote host, if any.
35246
35247 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
35248 This records the IP address of the local interface and the port number through
35249 which a message was received from a remote host. It is omitted for locally
35250 generated messages.
35251
35252 .vitem &%-local%&
35253 The message is from a local sender.
35254
35255 .vitem &%-localerror%&
35256 The message is a locally-generated bounce message.
35257
35258 .vitem "&%-local_scan%&&~<&'string'&>"
35259 This records the data string that was returned by the &[local_scan()]& function
35260 when the message was received &-- the value of the &$local_scan_data$&
35261 variable. It is omitted if no data was returned.
35262
35263 .vitem &%-manual_thaw%&
35264 The message was frozen but has been thawed manually, that is, by an explicit
35265 Exim command rather than via the auto-thaw process.
35266
35267 .vitem &%-N%&
35268 A testing delivery process was started using the &%-N%& option to suppress any
35269 actual deliveries, but delivery was deferred. At any further delivery attempts,
35270 &%-N%& is assumed.
35271
35272 .vitem &%-received_protocol%&
35273 This records the value of the &$received_protocol$& variable, which contains
35274 the name of the protocol by which the message was received.
35275
35276 .vitem &%-sender_set_untrusted%&
35277 The envelope sender of this message was set by an untrusted local caller (used
35278 to ensure that the caller is displayed in queue listings).
35279
35280 .vitem "&%-spam_score_int%&&~<&'number'&>"
35281 If a message was scanned by SpamAssassin, this is present. It records the value
35282 of &$spam_score_int$&.
35283
35284 .vitem &%-tls_certificate_verified%&
35285 A TLS certificate was received from the client that sent this message, and the
35286 certificate was verified by the server.
35287
35288 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
35289 When the message was received over an encrypted connection, this records the
35290 name of the cipher suite that was used.
35291
35292 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
35293 When the message was received over an encrypted connection, and a certificate
35294 was received from the client, this records the Distinguished Name from that
35295 certificate.
35296 .endlist
35297
35298 Following the options there is a list of those addresses to which the message
35299 is not to be delivered. This set of addresses is initialized from the command
35300 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
35301 is set; otherwise it starts out empty. Whenever a successful delivery is made,
35302 the address is added to this set. The addresses are kept internally as a
35303 balanced binary tree, and it is a representation of that tree which is written
35304 to the spool file. If an address is expanded via an alias or forward file, the
35305 original address is added to the tree when deliveries to all its child
35306 addresses are complete.
35307
35308 If the tree is empty, there is a single line in the spool file containing just
35309 the text &"XX"&. Otherwise, each line consists of two letters, which are either
35310 Y or N, followed by an address. The address is the value for the node of the
35311 tree, and the letters indicate whether the node has a left branch and/or a
35312 right branch attached to it, respectively. If branches exist, they immediately
35313 follow. Here is an example of a three-node tree:
35314 .code
35315 YY darcy@austen.fict.example
35316 NN alice@wonderland.fict.example
35317 NN editor@thesaurus.ref.example
35318 .endd
35319 After the non-recipients tree, there is a list of the message's recipients.
35320 This is a simple list, preceded by a count. It includes all the original
35321 recipients of the message, including those to whom the message has already been
35322 delivered. In the simplest case, the list contains one address per line. For
35323 example:
35324 .code
35325 4
35326 editor@thesaurus.ref.example
35327 darcy@austen.fict.example
35328 rdo@foundation
35329 alice@wonderland.fict.example
35330 .endd
35331 However, when a child address has been added to the top-level addresses as a
35332 result of the use of the &%one_time%& option on a &(redirect)& router, each
35333 line is of the following form:
35334 .display
35335 <&'top-level address'&> <&'errors_to address'&> &&&
35336   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
35337 .endd
35338 The 01 flag bit indicates the presence of the three other fields that follow
35339 the top-level address. Other bits may be used in future to support additional
35340 fields. The <&'parent number'&> is the offset in the recipients list of the
35341 original parent of the &"one time"& address. The first two fields are the
35342 envelope sender that is associated with this address and its length. If the
35343 length is zero, there is no special envelope sender (there are then two space
35344 characters in the line). A non-empty field can arise from a &(redirect)& router
35345 that has an &%errors_to%& setting.
35346
35347
35348 A blank line separates the envelope and status information from the headers
35349 which follow. A header may occupy several lines of the file, and to save effort
35350 when reading it in, each header is preceded by a number and an identifying
35351 character. The number is the number of characters in the header, including any
35352 embedded newlines and the terminating newline. The character is one of the
35353 following:
35354
35355 .table2 50pt
35356 .row <&'blank'&>         "header in which Exim has no special interest"
35357 .row &`B`&               "&'Bcc:'& header"
35358 .row &`C`&               "&'Cc:'& header"
35359 .row &`F`&               "&'From:'& header"
35360 .row &`I`&               "&'Message-id:'& header"
35361 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
35362 .row &`R`&               "&'Reply-To:'& header"
35363 .row &`S`&               "&'Sender:'& header"
35364 .row &`T`&               "&'To:'& header"
35365 .row &`*`&               "replaced or deleted header"
35366 .endtable
35367
35368 Deleted or replaced (rewritten) headers remain in the spool file for debugging
35369 purposes. They are not transmitted when the message is delivered. Here is a
35370 typical set of headers:
35371 .code
35372 111P Received: by hobbit.fict.example with local (Exim 4.00)
35373 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
35374 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
35375 038* X-rewrote-sender: bb@hobbit.fict.example
35376 042* From: Bilbo Baggins <bb@hobbit.fict.example>
35377 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
35378 099* To: alice@wonderland.fict.example, rdo@foundation,
35379 darcy@austen.fict.example, editor@thesaurus.ref.example
35380 104T To: alice@wonderland.fict.example, rdo@foundation.example,
35381 darcy@austen.fict.example, editor@thesaurus.ref.example
35382 038  Date: Fri, 11 May 2001 10:28:59 +0100
35383 .endd
35384 The asterisked headers indicate that the envelope sender, &'From:'& header, and
35385 &'To:'& header have been rewritten, the last one because routing expanded the
35386 unqualified domain &'foundation'&.
35387 .ecindex IIDforspo1
35388 .ecindex IIDforspo2
35389 .ecindex IIDforspo3
35390
35391 . ////////////////////////////////////////////////////////////////////////////
35392 . ////////////////////////////////////////////////////////////////////////////
35393
35394 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHID12" &&&
35395          "DKIM Support"
35396 .cindex "DKIM"
35397
35398 DKIM is a mechanism by which messages sent by some entity can be provably
35399 linked to a domain which that entity controls.  It permits reputation to
35400 be tracked on a per-domain basis, rather than merely upon source IP address.
35401 DKIM is documented in RFC 4871.
35402
35403 Since version 4.70, DKIM support is compiled into Exim by default. It can be
35404 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
35405
35406 Exim's DKIM implementation allows to
35407 .olist
35408 Sign outgoing messages: This function is implemented in the SMTP transport.
35409 It can co-exist with all other Exim features, including transport filters.
35410 .next
35411 Verify signatures in incoming messages: This is implemented by an additional
35412 ACL (acl_smtp_dkim), which can be called several times per message, with
35413 different signature contexts.
35414 .endlist
35415
35416 In typical Exim style, the verification implementation does not include any
35417 default "policy". Instead it enables you to build your own policy using
35418 Exim's standard controls.
35419
35420 Please note that verification of DKIM signatures in incoming mail is turned
35421 on by default for logging purposes. For each signature in incoming email,
35422 exim will log a line displaying the most important signature details, and the
35423 signature status. Here is an example (with line-breaks added for clarity):
35424 .code
35425 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
35426     d=facebookmail.com s=q1-2009b
35427     c=relaxed/relaxed a=rsa-sha1
35428     i=@facebookmail.com t=1252484542 [verification succeeded]
35429 .endd
35430 You might want to turn off DKIM verification processing entirely for internal
35431 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
35432 control modifier. This should typically be done in the RCPT ACL, at points
35433 where you accept mail from relay sources (internal hosts or authenticated
35434 senders).
35435
35436
35437 .section "Signing outgoing messages" "SECID513"
35438 .cindex "DKIM" "signing"
35439
35440 Signing is implemented by setting private options on the SMTP transport.
35441 These options take (expandable) strings as arguments.
35442
35443 .option dkim_domain smtp string&!! unset
35444 MANDATORY:
35445 The domain you want to sign with. The result of this expanded
35446 option is put into the &%$dkim_domain%& expansion variable.
35447
35448 .option dkim_selector smtp string&!! unset
35449 MANDATORY:
35450 This sets the key selector string. You can use the &%$dkim_domain%& expansion
35451 variable to look up a matching selector. The result is put in the expansion
35452 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
35453 option along with &%$dkim_domain%&.
35454
35455 .option dkim_private_key smtp string&!! unset
35456 MANDATORY:
35457 This sets the private key to use. You can use the &%$dkim_domain%& and
35458 &%$dkim_selector%& expansion variables to determine the private key to use.
35459 The result can either
35460 .ilist
35461 be a valid RSA private key in ASCII armor, including line breaks.
35462 .next
35463 start with a slash, in which case it is treated as a file that contains
35464 the private key.
35465 .next
35466 be "0", "false" or the empty string, in which case the message will not
35467 be signed. This case will not result in an error, even if &%dkim_strict%&
35468 is set.
35469 .endlist
35470
35471 .option dkim_canon smtp string&!! unset
35472 OPTIONAL:
35473 This option sets the canonicalization method used when signing a message.
35474 The DKIM RFC currently supports two methods: "simple" and "relaxed".
35475 The option defaults to "relaxed" when unset. Note: the current implementation
35476 only supports using the same canonicalization method for both headers and body.
35477
35478 .option dkim_strict smtp string&!! unset
35479 OPTIONAL:
35480 This  option  defines  how  Exim  behaves  when  signing a message that
35481 should be signed fails for some reason.  When the expansion evaluates to
35482 either "1" or "true", Exim will defer. Otherwise Exim will send the message
35483 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
35484 variables here.
35485
35486 .option dkim_sign_headers smtp string&!! unset
35487 OPTIONAL:
35488 When set, this option must expand to (or be specified as) a colon-separated
35489 list of header names. Headers with these names will be included in the message
35490 signature. When unspecified, the header names recommended in RFC4871 will be
35491 used.
35492
35493
35494 .section "Verifying DKIM signatures in incoming mail" "SECID514"
35495 .cindex "DKIM" "verification"
35496
35497 Verification of DKIM signatures in incoming email is implemented via the
35498 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
35499 syntactically(!) correct signature in the incoming message.
35500
35501 To evaluate the signature in the ACL a large number of expansion variables
35502 containing the signature status and its details are set up during the
35503 runtime of the ACL.
35504
35505 Calling the ACL only for existing signatures is not sufficient to build
35506 more advanced policies. For that reason, the global option
35507 &%dkim_verify_signers%&, and a global expansion variable
35508 &%$dkim_signers%& exist.
35509
35510 The global option &%dkim_verify_signers%& can be set to a colon-separated
35511 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
35512 called. It is expanded when the message has been received. At this point,
35513 the expansion variable &%$dkim_signers%& already contains a colon-separated
35514 list of signer domains and identities for the message. When
35515 &%dkim_verify_signers%& is not specified in the main configuration,
35516 it defaults as:
35517 .code
35518 dkim_verify_signers = $dkim_signers
35519 .endd
35520 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
35521 DKIM signature in the message. Current DKIM verifiers may want to explicitly
35522 call the ACL for known domains or identities. This would be achieved as follows:
35523 .code
35524 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
35525 .endd
35526 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
35527 and "ebay.com", plus all domains and identities that have signatures in the message.
35528 You can also be more creative in constructing your policy. For example:
35529 .code
35530 dkim_verify_signers = $sender_address_domain:$dkim_signers
35531 .endd
35532
35533 If a domain or identity is listed several times in the (expanded) value of
35534 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
35535
35536
35537 Inside the &%acl_smtp_dkim%&, the following expansion variables are
35538 available (from most to least important):
35539
35540
35541 .vlist
35542 .vitem &%$dkim_cur_signer%&
35543 The signer that is being evaluated in this ACL run. This can be a domain or
35544 an identity. This is one of the list items from the expanded main option
35545 &%dkim_verify_signers%& (see above).
35546 .vitem &%$dkim_verify_status%&
35547 A string describing the general status of the signature. One of
35548 .ilist
35549 &%none%&: There is no signature in the message for the current domain or
35550 identity (as reflected by &%$dkim_cur_signer%&).
35551 .next
35552 &%invalid%&: The signature could not be verified due to a processing error.
35553 More detail is available in &%$dkim_verify_reason%&.
35554 .next
35555 &%fail%&: Verification of the signature failed.  More detail is
35556 available in &%$dkim_verify_reason%&.
35557 .next
35558 &%pass%&: The signature passed verification. It is valid.
35559 .endlist
35560 .vitem &%$dkim_verify_reason%&
35561 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
35562 "fail" or "invalid". One of
35563 .ilist
35564 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
35565 key for the domain could not be retrieved. This may be a temporary problem.
35566 .next
35567 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
35568 record for the domain is syntactically invalid.
35569 .next
35570 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
35571 body hash does not match the one specified in the signature header. This
35572 means that the message body was modified in transit.
35573 .next
35574 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
35575 could not be verified. This may mean that headers were modified,
35576 re-written or otherwise changed in a way which is incompatible with
35577 DKIM verification. It may of course also mean that the signature is forged.
35578 .endlist
35579 .vitem &%$dkim_domain%&
35580 The signing domain. IMPORTANT: This variable is only populated if there is
35581 an actual signature in the message for the current domain or identity (as
35582 reflected by &%$dkim_cur_signer%&).
35583 .vitem &%$dkim_identity%&
35584 The signing identity, if present. IMPORTANT: This variable is only populated
35585 if there is an actual signature in the message for the current domain or
35586 identity (as reflected by &%$dkim_cur_signer%&).
35587 .vitem &%$dkim_selector%&
35588 The key record selector string.
35589 .vitem &%$dkim_algo%&
35590 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
35591 .vitem &%$dkim_canon_body%&
35592 The body canonicalization method. One of 'relaxed' or 'simple'.
35593 .vitem &%dkim_canon_headers%&
35594 The header canonicalization method. One of 'relaxed' or 'simple'.
35595 .vitem &%$dkim_copiedheaders%&
35596 A transcript of headers and their values which are included in the signature
35597 (copied from the 'z=' tag of the signature).
35598 .vitem &%$dkim_bodylength%&
35599 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
35600 limit was set by the signer, "9999999999999" is returned. This makes sure
35601 that this variable always expands to an integer value.
35602 .vitem &%$dkim_created%&
35603 UNIX timestamp reflecting the date and time when the signature was created.
35604 When this was not specified by the signer, "0" is returned.
35605 .vitem &%$dkim_expires%&
35606 UNIX timestamp reflecting the date and time when the signer wants the
35607 signature to be treated as "expired". When this was not specified by the
35608 signer, "9999999999999" is returned. This makes it possible to do useful
35609 integer size comparisons against this value.
35610 .vitem &%$dkim_headernames%&
35611 A colon-separated list of names of headers included in the signature.
35612 .vitem &%$dkim_key_testing%&
35613 "1" if the key record has the "testing" flag set, "0" if not.
35614 .vitem &%$nosubdomains%&
35615 "1" if the key record forbids subdomaining, "0" otherwise.
35616 .vitem &%$dkim_key_srvtype%&
35617 Service type (tag s=) from the key record. Defaults to "*" if not specified
35618 in the key record.
35619 .vitem &%$dkim_key_granularity%&
35620 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
35621 in the key record.
35622 .vitem &%$dkim_key_notes%&
35623 Notes from the key record (tag n=).
35624 .endlist
35625
35626 In addition, two ACL conditions are provided:
35627
35628 .vlist
35629 .vitem &%dkim_signers%&
35630 ACL condition that checks a colon-separated list of domains or identities
35631 for a match against the domain or identity that the ACL is currently verifying
35632 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
35633 verb to a group of domains or identities. For example:
35634
35635 .code
35636 # Warn when Mail purportedly from GMail has no signature at all
35637 warn log_message = GMail sender without DKIM signature
35638      sender_domains = gmail.com
35639      dkim_signers = gmail.com
35640      dkim_status = none
35641 .endd
35642
35643 .vitem &%dkim_status%&
35644 ACL condition that checks a colon-separated list of possible DKIM verification
35645 results agains the actual result of verification. This is typically used
35646 to restrict an ACL verb to a list of verification outcomes, for example:
35647
35648 .code
35649 deny message = Mail from Paypal with invalid/missing signature
35650      sender_domains = paypal.com:paypal.de
35651      dkim_signers = paypal.com:paypal.de
35652      dkim_status = none:invalid:fail
35653 .endd
35654
35655 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
35656 see the documentation of the &%$dkim_verify_status%& expansion variable above
35657 for more information of what they mean.
35658 .endlist
35659
35660 . ////////////////////////////////////////////////////////////////////////////
35661 . ////////////////////////////////////////////////////////////////////////////
35662
35663 .chapter "Adding new drivers or lookup types" "CHID13" &&&
35664          "Adding drivers or lookups"
35665 .cindex "adding drivers"
35666 .cindex "new drivers, adding"
35667 .cindex "drivers" "adding new"
35668 The following actions have to be taken in order to add a new router, transport,
35669 authenticator, or lookup type to Exim:
35670
35671 .olist
35672 Choose a name for the driver or lookup type that does not conflict with any
35673 existing name; I will use &"newdriver"& in what follows.
35674 .next
35675 Add to &_src/EDITME_& the line:
35676 .display
35677 <&'type'&>&`_NEWDRIVER=yes`&
35678 .endd
35679 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
35680 code is not to be included in the binary by default, comment this line out. You
35681 should also add any relevant comments about the driver or lookup type.
35682 .next
35683 Add to &_src/config.h.defaults_& the line:
35684 .code
35685 #define <type>_NEWDRIVER
35686 .endd
35687 .next
35688 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
35689 and create a table entry as is done for all the other drivers and lookup types.
35690 .next
35691 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
35692 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
35693 driver or lookup type and add it to the definition of OBJ.
35694 .next
35695 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
35696 &_src_&.
35697 .next
35698 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
35699 as for other drivers and lookups.
35700 .endlist
35701
35702 Then all you need to do is write the code! A good way to start is to make a
35703 proforma by copying an existing module of the same type, globally changing all
35704 occurrences of the name, and cutting out most of the code. Note that any
35705 options you create must be listed in alphabetical order, because the tables are
35706 searched using a binary chop procedure.
35707
35708 There is a &_README_& file in each of the sub-directories of &_src_& describing
35709 the interface that is expected.
35710
35711
35712
35713
35714 . ////////////////////////////////////////////////////////////////////////////
35715 . ////////////////////////////////////////////////////////////////////////////
35716
35717 . /////////////////////////////////////////////////////////////////////////////
35718 . These lines are processing instructions for the Simple DocBook Processor that
35719 . Philip Hazel has developed as a less cumbersome way of making PostScript and
35720 . PDFs than using xmlto and fop. They will be ignored by all other XML
35721 . processors.
35722 . /////////////////////////////////////////////////////////////////////////////
35723
35724 .literal xml
35725 <?sdop
35726   format="newpage"
35727   foot_right_recto="&chaptertitle;"
35728   foot_right_verso="&chaptertitle;"
35729 ?>
35730 .literal off
35731
35732 .makeindex "Options index"   "option"
35733 .makeindex "Variables index" "variable"
35734 .makeindex "Concept index"   "concept"
35735
35736
35737 . /////////////////////////////////////////////////////////////////////////////
35738 . /////////////////////////////////////////////////////////////////////////////