Doc: drop .new/.wen, update previousversion.
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing. Remember that
45 . the <bookinfo> element must also be updated for each new edition.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.80"
49 .set version "4.80"
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54
55 . /////////////////////////////////////////////////////////////////////////////
56 . Additional xfpt markup used by this document, over and above the default
57 . provided in the xfpt library.
58 . /////////////////////////////////////////////////////////////////////////////
59
60 . --- Override the &$ flag to automatically insert a $ with the variable name
61
62 .flag &$  $&   "<varname>$"  "</varname>"
63
64 . --- Short flags for daggers in option headings. They will always be inside
65 . --- an italic string, but we want the daggers to be roman.
66
67 .flag &!!      "</emphasis>&dagger;<emphasis>"
68 .flag &!?      "</emphasis>&Dagger;<emphasis>"
69
70 . --- A macro for an Exim option definition heading, generating a one-line
71 . --- table with four columns. For cases when the option name is given with
72 . --- a space, so that it can be split, a fifth argument is used for the
73 . --- index entry.
74
75 .macro option
76 .arg 5
77 .oindex "&%$5%&"
78 .endarg
79 .arg -5
80 .oindex "&%$1%&"
81 .endarg
82 .itable all 0 0 4 8* left 6* center 6* center 6* right
83 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
84 .endtable
85 .endmacro
86
87 . --- A macro for the common 2-column tables. The width of the first column
88 . --- is suitable for the many tables at the start of the main options chapter;
89 . --- the small number of other 2-column tables override it.
90
91 .macro table2 196pt 254pt
92 .itable none 0 0 2 $1 left $2 left
93 .endmacro
94
95 . --- A macro that generates .row, but puts &I; at the start of the first
96 . --- argument, thus indenting it. Assume a minimum of two arguments, and
97 . --- allow up to four arguments, which is as many as we'll ever need.
98
99 .macro irow
100 .arg 4
101 .row "&I;$1" "$2" "$3" "$4"
102 .endarg
103 .arg -4
104 .arg 3
105 .row "&I;$1" "$2" "$3"
106 .endarg
107 .arg -3
108 .row "&I;$1" "$2"
109 .endarg
110 .endarg
111 .endmacro
112
113 . --- Macros for option, variable, and concept index entries. For a "range"
114 . --- style of entry, use .scindex for the start and .ecindex for the end. The
115 . --- first argument of .scindex and the only argument of .ecindex must be the
116 . --- ID that ties them together.
117
118 .macro cindex
119 &<indexterm role="concept">&
120 &<primary>&$1&</primary>&
121 .arg 2
122 &<secondary>&$2&</secondary>&
123 .endarg
124 &</indexterm>&
125 .endmacro
126
127 .macro scindex
128 &<indexterm role="concept" id="$1" class="startofrange">&
129 &<primary>&$2&</primary>&
130 .arg 3
131 &<secondary>&$3&</secondary>&
132 .endarg
133 &</indexterm>&
134 .endmacro
135
136 .macro ecindex
137 &<indexterm role="concept" startref="$1" class="endofrange"/>&
138 .endmacro
139
140 .macro oindex
141 &<indexterm role="option">&
142 &<primary>&$1&</primary>&
143 .arg 2
144 &<secondary>&$2&</secondary>&
145 .endarg
146 &</indexterm>&
147 .endmacro
148
149 .macro vindex
150 &<indexterm role="variable">&
151 &<primary>&$1&</primary>&
152 .arg 2
153 &<secondary>&$2&</secondary>&
154 .endarg
155 &</indexterm>&
156 .endmacro
157
158 .macro index
159 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
160 .endmacro
161 . ////////////////////////////////////////////////////////////////////////////
162
163
164 . ////////////////////////////////////////////////////////////////////////////
165 . The <bookinfo> element is removed from the XML before processing for Ascii
166 . output formats.
167 . ////////////////////////////////////////////////////////////////////////////
168
169 .literal xml
170 <bookinfo>
171 <title>Specification of the Exim Mail Transfer Agent</title>
172 <titleabbrev>The Exim MTA</titleabbrev>
173 <date>17 May 2012</date>
174 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
175 <authorinitials>EM</authorinitials>
176 <revhistory><revision>
177   <revnumber>4.80</revnumber>
178   <date>17 May 2012</date>
179   <authorinitials>EM</authorinitials>
180 </revision></revhistory>
181 <copyright><year>2012</year><holder>University of Cambridge</holder></copyright>
182 </bookinfo>
183 .literal off
184
185
186 . /////////////////////////////////////////////////////////////////////////////
187 . This chunk of literal XML implements index entries of the form "x, see y" and
188 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
189 . at the top level, so we have to put the .chapter directive first.
190 . /////////////////////////////////////////////////////////////////////////////
191
192 .chapter "Introduction" "CHID1"
193 .literal xml
194
195 <indexterm role="variable">
196   <primary>$1, $2, etc.</primary>
197   <see><emphasis>numerical variables</emphasis></see>
198 </indexterm>
199 <indexterm role="concept">
200   <primary>address</primary>
201   <secondary>rewriting</secondary>
202   <see><emphasis>rewriting</emphasis></see>
203 </indexterm>
204 <indexterm role="concept">
205   <primary>Bounce Address Tag Validation</primary>
206   <see><emphasis>BATV</emphasis></see>
207 </indexterm>
208 <indexterm role="concept">
209   <primary>Client SMTP Authorization</primary>
210   <see><emphasis>CSA</emphasis></see>
211 </indexterm>
212 <indexterm role="concept">
213   <primary>CR character</primary>
214   <see><emphasis>carriage return</emphasis></see>
215 </indexterm>
216 <indexterm role="concept">
217   <primary>CRL</primary>
218   <see><emphasis>certificate revocation list</emphasis></see>
219 </indexterm>
220 <indexterm role="concept">
221   <primary>delivery</primary>
222   <secondary>failure report</secondary>
223   <see><emphasis>bounce message</emphasis></see>
224 </indexterm>
225 <indexterm role="concept">
226   <primary>dialup</primary>
227   <see><emphasis>intermittently connected hosts</emphasis></see>
228 </indexterm>
229 <indexterm role="concept">
230   <primary>exiscan</primary>
231   <see><emphasis>content scanning</emphasis></see>
232 </indexterm>
233 <indexterm role="concept">
234   <primary>failover</primary>
235   <see><emphasis>fallback</emphasis></see>
236 </indexterm>
237 <indexterm role="concept">
238   <primary>fallover</primary>
239   <see><emphasis>fallback</emphasis></see>
240 </indexterm>
241 <indexterm role="concept">
242   <primary>filter</primary>
243   <secondary>Sieve</secondary>
244   <see><emphasis>Sieve filter</emphasis></see>
245 </indexterm>
246 <indexterm role="concept">
247   <primary>ident</primary>
248   <see><emphasis>RFC 1413</emphasis></see>
249 </indexterm>
250 <indexterm role="concept">
251   <primary>LF character</primary>
252   <see><emphasis>linefeed</emphasis></see>
253 </indexterm>
254 <indexterm role="concept">
255   <primary>maximum</primary>
256   <seealso><emphasis>limit</emphasis></seealso>
257 </indexterm>
258 <indexterm role="concept">
259   <primary>monitor</primary>
260   <see><emphasis>Exim monitor</emphasis></see>
261 </indexterm>
262 <indexterm role="concept">
263   <primary>no_<emphasis>xxx</emphasis></primary>
264   <see>entry for xxx</see>
265 </indexterm>
266 <indexterm role="concept">
267   <primary>NUL</primary>
268   <see><emphasis>binary zero</emphasis></see>
269 </indexterm>
270 <indexterm role="concept">
271   <primary>passwd file</primary>
272   <see><emphasis>/etc/passwd</emphasis></see>
273 </indexterm>
274 <indexterm role="concept">
275   <primary>process id</primary>
276   <see><emphasis>pid</emphasis></see>
277 </indexterm>
278 <indexterm role="concept">
279   <primary>RBL</primary>
280   <see><emphasis>DNS list</emphasis></see>
281 </indexterm>
282 <indexterm role="concept">
283   <primary>redirection</primary>
284   <see><emphasis>address redirection</emphasis></see>
285 </indexterm>
286 <indexterm role="concept">
287   <primary>return path</primary>
288   <seealso><emphasis>envelope sender</emphasis></seealso>
289 </indexterm>
290 <indexterm role="concept">
291   <primary>scanning</primary>
292   <see><emphasis>content scanning</emphasis></see>
293 </indexterm>
294 <indexterm role="concept">
295   <primary>SSL</primary>
296   <see><emphasis>TLS</emphasis></see>
297 </indexterm>
298 <indexterm role="concept">
299   <primary>string</primary>
300   <secondary>expansion</secondary>
301   <see><emphasis>expansion</emphasis></see>
302 </indexterm>
303 <indexterm role="concept">
304   <primary>top bit</primary>
305   <see><emphasis>8-bit characters</emphasis></see>
306 </indexterm>
307 <indexterm role="concept">
308   <primary>variables</primary>
309   <see><emphasis>expansion, variables</emphasis></see>
310 </indexterm>
311 <indexterm role="concept">
312   <primary>zero, binary</primary>
313   <see><emphasis>binary zero</emphasis></see>
314 </indexterm>
315
316 .literal off
317
318
319 . /////////////////////////////////////////////////////////////////////////////
320 . This is the real start of the first chapter. See the comment above as to why
321 . we can't have the .chapter line here.
322 . chapter "Introduction"
323 . /////////////////////////////////////////////////////////////////////////////
324
325 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
326 Unix-like operating systems. It was designed on the assumption that it would be
327 run on hosts that are permanently connected to the Internet. However, it can be
328 used on intermittently connected hosts with suitable configuration adjustments.
329
330 Configuration files currently exist for the following operating systems: AIX,
331 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
332 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
333 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
334 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
335 Some of these operating systems are no longer current and cannot easily be
336 tested, so the configuration files may no longer work in practice.
337
338 There are also configuration files for compiling Exim in the Cygwin environment
339 that can be installed on systems running Windows. However, this document does
340 not contain any information about running Exim in the Cygwin environment.
341
342 The terms and conditions for the use and distribution of Exim are contained in
343 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
344 Public Licence, a copy of which may be found in the file &_LICENCE_&.
345
346 The use, supply or promotion of Exim for the purpose of sending bulk,
347 unsolicited electronic mail is incompatible with the basic aims of the program,
348 which revolve around the free provision of a service that enhances the quality
349 of personal communications. The author of Exim regards indiscriminate
350 mass-mailing as an antisocial, irresponsible abuse of the Internet.
351
352 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
353 experience of running and working on the Smail 3 code, I could never have
354 contemplated starting to write a new MTA. Many of the ideas and user interfaces
355 were originally taken from Smail 3, though the actual code of Exim is entirely
356 new, and has developed far beyond the initial concept.
357
358 Many people, both in Cambridge and around the world, have contributed to the
359 development and the testing of Exim, and to porting it to various operating
360 systems. I am grateful to them all. The distribution now contains a file called
361 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
362 contributors.
363
364
365 .section "Exim documentation" "SECID1"
366 . Keep this example change bar when updating the documentation!
367
368 .new
369 .cindex "documentation"
370 This edition of the Exim specification applies to version &version; of Exim.
371 Substantive changes from the &previousversion; edition are marked in some
372 renditions of the document; this paragraph is so marked if the rendition is
373 capable of showing a change indicator.
374 .wen
375
376 This document is very much a reference manual; it is not a tutorial. The reader
377 is expected to have some familiarity with the SMTP mail transfer protocol and
378 with general Unix system administration. Although there are some discussions
379 and examples in places, the information is mostly organized in a way that makes
380 it easy to look up, rather than in a natural order for sequential reading.
381 Furthermore, the manual aims to cover every aspect of Exim in detail, including
382 a number of rarely-used, special-purpose features that are unlikely to be of
383 very wide interest.
384
385 .cindex "books about Exim"
386 An &"easier"& discussion of Exim which provides more in-depth explanatory,
387 introductory, and tutorial material can be found in a book entitled &'The Exim
388 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
389 (&url(http://www.uit.co.uk/exim-book/)).
390
391 This book also contains a chapter that gives a general introduction to SMTP and
392 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
393 with the latest release of Exim. (Note that the earlier book about Exim,
394 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
395
396 .cindex "Debian" "information sources"
397 If you are using a Debian distribution of Exim, you will find information about
398 Debian-specific features in the file
399 &_/usr/share/doc/exim4-base/README.Debian_&.
400 The command &(man update-exim.conf)& is another source of Debian-specific
401 information.
402
403 .cindex "&_doc/NewStuff_&"
404 .cindex "&_doc/ChangeLog_&"
405 .cindex "change log"
406 As the program develops, there may be features in newer versions that have not
407 yet made it into this document, which is updated only when the most significant
408 digit of the fractional part of the version number changes. Specifications of
409 new features that are not yet in this manual are placed in the file
410 &_doc/NewStuff_& in the Exim distribution.
411
412 Some features may be classified as &"experimental"&. These may change
413 incompatibly while they are developing, or even be withdrawn. For this reason,
414 they are not documented in this manual. Information about experimental features
415 can be found in the file &_doc/experimental.txt_&.
416
417 All changes to the program (whether new features, bug fixes, or other kinds of
418 change) are noted briefly in the file called &_doc/ChangeLog_&.
419
420 .cindex "&_doc/spec.txt_&"
421 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
422 that it can easily be searched with a text editor. Other files in the &_doc_&
423 directory are:
424
425 .table2 100pt
426 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
427 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
428 .row &_exim.8_&              "a man page of Exim's command line options"
429 .row &_experimental.txt_&    "documentation of experimental features"
430 .row &_filter.txt_&          "specification of the filter language"
431 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
432 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
433 .endtable
434
435 The main specification and the specification of the filtering language are also
436 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
437 &<<SECTavail>>& below tells you how to get hold of these.
438
439
440
441 .section "FTP and web sites" "SECID2"
442 .cindex "web site"
443 .cindex "FTP site"
444 The primary site for Exim source distributions is currently the University of
445 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
446 distribution'& below. In addition, there is a web site and an FTP site at
447 &%exim.org%&. These are now also hosted at the University of Cambridge. The
448 &%exim.org%& site was previously hosted for a number of years by Energis
449 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
450
451 .cindex "wiki"
452 .cindex "FAQ"
453 As well as Exim distribution tar files, the Exim web site contains a number of
454 differently formatted versions of the documentation. A recent addition to the
455 online information is the Exim wiki (&url(http://wiki.exim.org)),
456 which contains what used to be a separate FAQ, as well as various other
457 examples, tips, and know-how that have been contributed by Exim users.
458
459 .cindex Bugzilla
460 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
461 this to report bugs, and also to add items to the wish list. Please search
462 first to check that you are not duplicating a previous entry.
463
464
465
466 .section "Mailing lists" "SECID3"
467 .cindex "mailing lists" "for Exim users"
468 The following Exim mailing lists exist:
469
470 .table2 140pt
471 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
472 .row &'exim-users@exim.org'&      "General discussion list"
473 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
474 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
475 .endtable
476
477 You can subscribe to these lists, change your existing subscriptions, and view
478 or search the archives via the mailing lists link on the Exim home page.
479 .cindex "Debian" "mailing list for"
480 If you are using a Debian distribution of Exim, you may wish to subscribe to
481 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
482 via this web page:
483 .display
484 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
485 .endd
486 Please ask Debian-specific questions on this list and not on the general Exim
487 lists.
488
489 .section "Exim training" "SECID4"
490 .cindex "training courses"
491 Training courses in Cambridge (UK) used to be run annually by the author of
492 Exim, before he retired. At the time of writing, there are no plans to run
493 further Exim courses in Cambridge. However, if that changes, relevant
494 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
495
496 .section "Bug reports" "SECID5"
497 .cindex "bug reports"
498 .cindex "reporting bugs"
499 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
500 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
501 whether some behaviour is a bug or not, the best thing to do is to post a
502 message to the &'exim-dev'& mailing list and have it discussed.
503
504
505
506 .section "Where to find the Exim distribution" "SECTavail"
507 .cindex "FTP site"
508 .cindex "distribution" "ftp site"
509 The master ftp site for the Exim distribution is
510 .display
511 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
512 .endd
513 This is mirrored by
514 .display
515 &*ftp://ftp.exim.org/pub/exim*&
516 .endd
517 The file references that follow are relative to the &_exim_& directories at
518 these sites. There are now quite a number of independent mirror sites around
519 the world. Those that I know about are listed in the file called &_Mirrors_&.
520
521 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
522 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
523 distributions), and &_Testing_& for testing versions. In the &_exim4_&
524 subdirectory, the current release can always be found in files called
525 .display
526 &_exim-n.nn.tar.gz_&
527 &_exim-n.nn.tar.bz2_&
528 .endd
529 where &'n.nn'& is the highest such version number in the directory. The two
530 files contain identical data; the only difference is the type of compression.
531 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
532
533 .cindex "distribution" "signing details"
534 .cindex "distribution" "public key"
535 .cindex "public key for signed distribution"
536 The distributions are currently signed with Nigel Metheringham's GPG key. The
537 corresponding public key is available from a number of keyservers, and there is
538 also a copy in the file &_nigel-pubkey.asc_&. The signatures for the tar bundles are
539 in:
540 .display
541 &_exim-n.nn.tar.gz.asc_&
542 &_exim-n.nn.tar.bz2.asc_&
543 .endd
544 For each released version, the log of changes is made separately available in a
545 separate file in the directory &_ChangeLogs_& so that it is possible to
546 find out what has changed without having to download the entire distribution.
547
548 .cindex "documentation" "available formats"
549 The main distribution contains ASCII versions of this specification and other
550 documentation; other formats of the documents are available in separate files
551 inside the &_exim4_& directory of the FTP site:
552 .display
553 &_exim-html-n.nn.tar.gz_&
554 &_exim-pdf-n.nn.tar.gz_&
555 &_exim-postscript-n.nn.tar.gz_&
556 &_exim-texinfo-n.nn.tar.gz_&
557 .endd
558 These tar files contain only the &_doc_& directory, not the complete
559 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
560
561
562 .section "Limitations" "SECID6"
563 .ilist
564 .cindex "limitations of Exim"
565 .cindex "bang paths" "not handled by Exim"
566 Exim is designed for use as an Internet MTA, and therefore handles addresses in
567 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
568 simple two-component bang paths can be converted by a straightforward rewriting
569 configuration. This restriction does not prevent Exim from being interfaced to
570 UUCP as a transport mechanism, provided that domain addresses are used.
571 .next
572 .cindex "domainless addresses"
573 .cindex "address" "without domain"
574 Exim insists that every address it handles has a domain attached. For incoming
575 local messages, domainless addresses are automatically qualified with a
576 configured domain value. Configuration options specify from which remote
577 systems unqualified addresses are acceptable. These are then qualified on
578 arrival.
579 .next
580 .cindex "transport" "external"
581 .cindex "external transports"
582 The only external transport mechanisms that are currently implemented are SMTP
583 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
584 transport is available, and there are facilities for writing messages to files
585 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
586 to send messages to other transport mechanisms such as UUCP, provided they can
587 handle domain-style addresses. Batched SMTP input is also catered for.
588 .next
589 Exim is not designed for storing mail for dial-in hosts. When the volumes of
590 such mail are large, it is better to get the messages &"delivered"& into files
591 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
592 other means.
593 .next
594 Although Exim does have basic facilities for scanning incoming messages, these
595 are not comprehensive enough to do full virus or spam scanning. Such operations
596 are best carried out using additional specialized software packages. If you
597 compile Exim with the content-scanning extension, straightforward interfaces to
598 a number of common scanners are provided.
599 .endlist
600
601
602 .section "Run time configuration" "SECID7"
603 Exim's run time configuration is held in a single text file that is divided
604 into a number of sections. The entries in this file consist of keywords and
605 values, in the style of Smail 3 configuration files. A default configuration
606 file which is suitable for simple online installations is provided in the
607 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
608
609
610 .section "Calling interface" "SECID8"
611 .cindex "Sendmail compatibility" "command line interface"
612 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
613 can be a straight replacement for &_/usr/lib/sendmail_& or
614 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
615 about Sendmail in order to run Exim. For actions other than sending messages,
616 Sendmail-compatible options also exist, but those that produce output (for
617 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
618 format. There are also some additional options that are compatible with Smail
619 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
620 documents all Exim's command line options. This information is automatically
621 made into the man page that forms part of the Exim distribution.
622
623 Control of messages on the queue can be done via certain privileged command
624 line options. There is also an optional monitor program called &'eximon'&,
625 which displays current information in an X window, and which contains a menu
626 interface to Exim's command line administration options.
627
628
629
630 .section "Terminology" "SECID9"
631 .cindex "terminology definitions"
632 .cindex "body of message" "definition of"
633 The &'body'& of a message is the actual data that the sender wants to transmit.
634 It is the last part of a message, and is separated from the &'header'& (see
635 below) by a blank line.
636
637 .cindex "bounce message" "definition of"
638 When a message cannot be delivered, it is normally returned to the sender in a
639 delivery failure message or a &"non-delivery report"& (NDR). The term
640 &'bounce'& is commonly used for this action, and the error reports are often
641 called &'bounce messages'&. This is a convenient shorthand for &"delivery
642 failure error report"&. Such messages have an empty sender address in the
643 message's &'envelope'& (see below) to ensure that they cannot themselves give
644 rise to further bounce messages.
645
646 The term &'default'& appears frequently in this manual. It is used to qualify a
647 value which is used in the absence of any setting in the configuration. It may
648 also qualify an action which is taken unless a configuration setting specifies
649 otherwise.
650
651 The term &'defer'& is used when the delivery of a message to a specific
652 destination cannot immediately take place for some reason (a remote host may be
653 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
654 until a later time.
655
656 The word &'domain'& is sometimes used to mean all but the first component of a
657 host's name. It is &'not'& used in that sense here, where it normally refers to
658 the part of an email address following the @ sign.
659
660 .cindex "envelope, definition of"
661 .cindex "sender" "definition of"
662 A message in transit has an associated &'envelope'&, as well as a header and a
663 body. The envelope contains a sender address (to which bounce messages should
664 be delivered), and any number of recipient addresses. References to the
665 sender or the recipients of a message usually mean the addresses in the
666 envelope. An MTA uses these addresses for delivery, and for returning bounce
667 messages, not the addresses that appear in the header lines.
668
669 .cindex "message" "header, definition of"
670 .cindex "header section" "definition of"
671 The &'header'& of a message is the first part of a message's text, consisting
672 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
673 &'Subject:'&, etc. Long header lines can be split over several text lines by
674 indenting the continuations. The header is separated from the body by a blank
675 line.
676
677 .cindex "local part" "definition of"
678 .cindex "domain" "definition of"
679 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
680 part of an email address that precedes the @ sign. The part that follows the
681 @ sign is called the &'domain'& or &'mail domain'&.
682
683 .cindex "local delivery" "definition of"
684 .cindex "remote delivery, definition of"
685 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
686 delivery to a file or a pipe on the local host from delivery by SMTP over
687 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
688 host it is running on are &'remote'&.
689
690 .cindex "return path" "definition of"
691 &'Return path'& is another name that is used for the sender address in a
692 message's envelope.
693
694 .cindex "queue" "definition of"
695 The term &'queue'& is used to refer to the set of messages awaiting delivery,
696 because this term is in widespread use in the context of MTAs. However, in
697 Exim's case the reality is more like a pool than a queue, because there is
698 normally no ordering of waiting messages.
699
700 .cindex "queue runner" "definition of"
701 The term &'queue runner'& is used to describe a process that scans the queue
702 and attempts to deliver those messages whose retry times have come. This term
703 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
704 the waiting messages are normally processed in an unpredictable order.
705
706 .cindex "spool directory" "definition of"
707 The term &'spool directory'& is used for a directory in which Exim keeps the
708 messages on its queue &-- that is, those that it is in the process of
709 delivering. This should not be confused with the directory in which local
710 mailboxes are stored, which is called a &"spool directory"& by some people. In
711 the Exim documentation, &"spool"& is always used in the first sense.
712
713
714
715
716
717
718 . ////////////////////////////////////////////////////////////////////////////
719 . ////////////////////////////////////////////////////////////////////////////
720
721 .chapter "Incorporated code" "CHID2"
722 .cindex "incorporated code"
723 .cindex "regular expressions" "library"
724 .cindex "PCRE"
725 A number of pieces of external code are included in the Exim distribution.
726
727 .ilist
728 Regular expressions are supported in the main Exim program and in the
729 Exim monitor using the freely-distributable PCRE library, copyright
730 &copy; University of Cambridge. The source to PCRE is no longer shipped with
731 Exim, so you will need to use the version of PCRE shipped with your system,
732 or obtain and install the full version of the library from
733 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
734 .next
735 .cindex "cdb" "acknowledgment"
736 Support for the cdb (Constant DataBase) lookup method is provided by code
737 contributed by Nigel Metheringham of (at the time he contributed it) Planet
738 Online Ltd. The implementation is completely contained within the code of Exim.
739 It does not link against an external cdb library. The code contains the
740 following statements:
741
742 .blockquote
743 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
744
745 This program is free software; you can redistribute it and/or modify it under
746 the terms of the GNU General Public License as published by the Free Software
747 Foundation; either version 2 of the License, or (at your option) any later
748 version.
749 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
750 the spec and sample code for cdb can be obtained from
751 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
752 some code from Dan Bernstein's implementation (which has no license
753 restrictions applied to it).
754 .endblockquote
755 .next
756 .cindex "SPA authentication"
757 .cindex "Samba project"
758 .cindex "Microsoft Secure Password Authentication"
759 Client support for Microsoft's &'Secure Password Authentication'& is provided
760 by code contributed by Marc Prud'hommeaux. Server support was contributed by
761 Tom Kistner. This includes code taken from the Samba project, which is released
762 under the Gnu GPL.
763 .next
764 .cindex "Cyrus"
765 .cindex "&'pwcheck'& daemon"
766 .cindex "&'pwauthd'& daemon"
767 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
768 by code taken from the Cyrus-SASL library and adapted by Alexander S.
769 Sabourenkov. The permission notice appears below, in accordance with the
770 conditions expressed therein.
771
772 .blockquote
773 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
774
775 Redistribution and use in source and binary forms, with or without
776 modification, are permitted provided that the following conditions
777 are met:
778
779 .olist
780 Redistributions of source code must retain the above copyright
781 notice, this list of conditions and the following disclaimer.
782 .next
783 Redistributions in binary form must reproduce the above copyright
784 notice, this list of conditions and the following disclaimer in
785 the documentation and/or other materials provided with the
786 distribution.
787 .next
788 The name &"Carnegie Mellon University"& must not be used to
789 endorse or promote products derived from this software without
790 prior written permission. For permission or any other legal
791 details, please contact
792 .display
793               Office of Technology Transfer
794               Carnegie Mellon University
795               5000 Forbes Avenue
796               Pittsburgh, PA  15213-3890
797               (412) 268-4387, fax: (412) 268-7395
798               tech-transfer@andrew.cmu.edu
799 .endd
800 .next
801 Redistributions of any form whatsoever must retain the following
802 acknowledgment:
803
804 &"This product includes software developed by Computing Services
805 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
806
807 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
808 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
809 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
810 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
811 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
812 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
813 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
814 .endlist
815 .endblockquote
816
817 .next
818 .cindex "Exim monitor" "acknowledgment"
819 .cindex "X-windows"
820 .cindex "Athena"
821 The Exim Monitor program, which is an X-Window application, includes
822 modified versions of the Athena StripChart and TextPop widgets.
823 This code is copyright by DEC and MIT, and their permission notice appears
824 below, in accordance with the conditions expressed therein.
825
826 .blockquote
827 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
828 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
829
830 All Rights Reserved
831
832 Permission to use, copy, modify, and distribute this software and its
833 documentation for any purpose and without fee is hereby granted,
834 provided that the above copyright notice appear in all copies and that
835 both that copyright notice and this permission notice appear in
836 supporting documentation, and that the names of Digital or MIT not be
837 used in advertising or publicity pertaining to distribution of the
838 software without specific, written prior permission.
839
840 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
841 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
842 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
843 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
844 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
845 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
846 SOFTWARE.
847 .endblockquote
848
849 .next
850 Many people have contributed code fragments, some large, some small, that were
851 not covered by any specific licence requirements. It is assumed that the
852 contributors are happy to see their code incorporated into Exim under the GPL.
853 .endlist
854
855
856
857
858
859 . ////////////////////////////////////////////////////////////////////////////
860 . ////////////////////////////////////////////////////////////////////////////
861
862 .chapter "How Exim receives and delivers mail" "CHID11" &&&
863          "Receiving and delivering mail"
864
865
866 .section "Overall philosophy" "SECID10"
867 .cindex "design philosophy"
868 Exim is designed to work efficiently on systems that are permanently connected
869 to the Internet and are handling a general mix of mail. In such circumstances,
870 most messages can be delivered immediately. Consequently, Exim does not
871 maintain independent queues of messages for specific domains or hosts, though
872 it does try to send several messages in a single SMTP connection after a host
873 has been down, and it also maintains per-host retry information.
874
875
876 .section "Policy control" "SECID11"
877 .cindex "policy control" "overview"
878 Policy controls are now an important feature of MTAs that are connected to the
879 Internet. Perhaps their most important job is to stop MTAs being abused as
880 &"open relays"& by misguided individuals who send out vast amounts of
881 unsolicited junk, and want to disguise its source. Exim provides flexible
882 facilities for specifying policy controls on incoming mail:
883
884 .ilist
885 .cindex "&ACL;" "introduction"
886 Exim 4 (unlike previous versions of Exim) implements policy controls on
887 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
888 series of statements that may either grant or deny access. ACLs can be used at
889 several places in the SMTP dialogue while receiving a message from a remote
890 host. However, the most common places are after each RCPT command, and at the
891 very end of the message. The sysadmin can specify conditions for accepting or
892 rejecting individual recipients or the entire message, respectively, at these
893 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
894 error code.
895 .next
896 An ACL is also available for locally generated, non-SMTP messages. In this
897 case, the only available actions are to accept or deny the entire message.
898 .next
899 When Exim is compiled with the content-scanning extension, facilities are
900 provided in the ACL mechanism for passing the message to external virus and/or
901 spam scanning software. The result of such a scan is passed back to the ACL,
902 which can then use it to decide what to do with the message.
903 .next
904 When a message has been received, either from a remote host or from the local
905 host, but before the final acknowledgment has been sent, a locally supplied C
906 function called &[local_scan()]& can be run to inspect the message and decide
907 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
908 is accepted, the list of recipients can be modified by the function.
909 .next
910 Using the &[local_scan()]& mechanism is another way of calling external scanner
911 software. The &%SA-Exim%& add-on package works this way. It does not require
912 Exim to be compiled with the content-scanning extension.
913 .next
914 After a message has been accepted, a further checking mechanism is available in
915 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
916 runs at the start of every delivery process.
917 .endlist
918
919
920
921 .section "User filters" "SECID12"
922 .cindex "filter" "introduction"
923 .cindex "Sieve filter"
924 In a conventional Exim configuration, users are able to run private filters by
925 setting up appropriate &_.forward_& files in their home directories. See
926 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
927 configuration needed to support this, and the separate document entitled
928 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
929 of filtering are available:
930
931 .ilist
932 Sieve filters are written in the standard filtering language that is defined
933 by RFC 3028.
934 .next
935 Exim filters are written in a syntax that is unique to Exim, but which is more
936 powerful than Sieve, which it pre-dates.
937 .endlist
938
939 User filters are run as part of the routing process, described below.
940
941
942
943 .section "Message identification" "SECTmessiden"
944 .cindex "message ids" "details of format"
945 .cindex "format" "of message id"
946 .cindex "id of message"
947 .cindex "base62"
948 .cindex "base36"
949 .cindex "Darwin"
950 .cindex "Cygwin"
951 Every message handled by Exim is given a &'message id'& which is sixteen
952 characters long. It is divided into three parts, separated by hyphens, for
953 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
954 normally encoding numbers in base 62. However, in the Darwin operating
955 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
956 (avoiding the use of lower case letters) is used instead, because the message
957 id is used to construct file names, and the names of files in those systems are
958 not always case-sensitive.
959
960 .cindex "pid (process id)" "re-use of"
961 The detail of the contents of the message id have changed as Exim has evolved.
962 Earlier versions relied on the operating system not re-using a process id (pid)
963 within one second. On modern operating systems, this assumption can no longer
964 be made, so the algorithm had to be changed. To retain backward compatibility,
965 the format of the message id was retained, which is why the following rules are
966 somewhat eccentric:
967
968 .ilist
969 The first six characters of the message id are the time at which the message
970 started to be received, to a granularity of one second. That is, this field
971 contains the number of seconds since the start of the epoch (the normal Unix
972 way of representing the date and time of day).
973 .next
974 After the first hyphen, the next six characters are the id of the process that
975 received the message.
976 .next
977 There are two different possibilities for the final two characters:
978 .olist
979 .oindex "&%localhost_number%&"
980 If &%localhost_number%& is not set, this value is the fractional part of the
981 time of reception, normally in units of 1/2000 of a second, but for systems
982 that must use base 36 instead of base 62 (because of case-insensitive file
983 systems), the units are 1/1000 of a second.
984 .next
985 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
986 the fractional part of the time, which in this case is in units of 1/200
987 (1/100) of a second.
988 .endlist
989 .endlist
990
991 After a message has been received, Exim waits for the clock to tick at the
992 appropriate resolution before proceeding, so that if another message is
993 received by the same process, or by another process with the same (re-used)
994 pid, it is guaranteed that the time will be different. In most cases, the clock
995 will already have ticked while the message was being received.
996
997
998 .section "Receiving mail" "SECID13"
999 .cindex "receiving mail"
1000 .cindex "message" "reception"
1001 The only way Exim can receive mail from another host is using SMTP over
1002 TCP/IP, in which case the sender and recipient addresses are transferred using
1003 SMTP commands. However, from a locally running process (such as a user's MUA),
1004 there are several possibilities:
1005
1006 .ilist
1007 If the process runs Exim with the &%-bm%& option, the message is read
1008 non-interactively (usually via a pipe), with the recipients taken from the
1009 command line, or from the body of the message if &%-t%& is also used.
1010 .next
1011 If the process runs Exim with the &%-bS%& option, the message is also read
1012 non-interactively, but in this case the recipients are listed at the start of
1013 the message in a series of SMTP RCPT commands, terminated by a DATA
1014 command. This is so-called &"batch SMTP"& format,
1015 but it isn't really SMTP. The SMTP commands are just another way of passing
1016 envelope addresses in a non-interactive submission.
1017 .next
1018 If the process runs Exim with the &%-bs%& option, the message is read
1019 interactively, using the SMTP protocol. A two-way pipe is normally used for
1020 passing data between the local process and the Exim process.
1021 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1022 example, the ACLs for SMTP commands are used for this form of submission.
1023 .next
1024 A local process may also make a TCP/IP call to the host's loopback address
1025 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1026 does not treat the loopback address specially. It treats all such connections
1027 in the same way as connections from other hosts.
1028 .endlist
1029
1030
1031 .cindex "message sender, constructed by Exim"
1032 .cindex "sender" "constructed by Exim"
1033 In the three cases that do not involve TCP/IP, the sender address is
1034 constructed from the login name of the user that called Exim and a default
1035 qualification domain (which can be set by the &%qualify_domain%& configuration
1036 option). For local or batch SMTP, a sender address that is passed using the
1037 SMTP MAIL command is ignored. However, the system administrator may allow
1038 certain users (&"trusted users"&) to specify a different sender address
1039 unconditionally, or all users to specify certain forms of different sender
1040 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1041 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1042 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1043 users to change sender addresses.
1044
1045 Messages received by either of the non-interactive mechanisms are subject to
1046 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1047 (either over TCP/IP, or interacting with a local process) can be checked by a
1048 number of ACLs that operate at different times during the SMTP session. Either
1049 individual recipients, or the entire message, can be rejected if local policy
1050 requirements are not met. The &[local_scan()]& function (see chapter
1051 &<<CHAPlocalscan>>&) is run for all incoming messages.
1052
1053 Exim can be configured not to start a delivery process when a message is
1054 received; this can be unconditional, or depend on the number of incoming SMTP
1055 connections or the system load. In these situations, new messages wait on the
1056 queue until a queue runner process picks them up. However, in standard
1057 configurations under normal conditions, delivery is started as soon as a
1058 message is received.
1059
1060
1061
1062
1063
1064 .section "Handling an incoming message" "SECID14"
1065 .cindex "spool directory" "files that hold a message"
1066 .cindex "file" "how a message is held"
1067 When Exim accepts a message, it writes two files in its spool directory. The
1068 first contains the envelope information, the current status of the message, and
1069 the header lines, and the second contains the body of the message. The names of
1070 the two spool files consist of the message id, followed by &`-H`& for the
1071 file containing the envelope and header, and &`-D`& for the data file.
1072
1073 .cindex "spool directory" "&_input_& sub-directory"
1074 By default all these message files are held in a single directory called
1075 &_input_& inside the general Exim spool directory. Some operating systems do
1076 not perform very well if the number of files in a directory gets large; to
1077 improve performance in such cases, the &%split_spool_directory%& option can be
1078 used. This causes Exim to split up the input files into 62 sub-directories
1079 whose names are single letters or digits. When this is done, the queue is
1080 processed one sub-directory at a time instead of all at once, which can improve
1081 overall performance even when there are not enough files in each directory to
1082 affect file system performance.
1083
1084 The envelope information consists of the address of the message's sender and
1085 the addresses of the recipients. This information is entirely separate from
1086 any addresses contained in the header lines. The status of the message includes
1087 a list of recipients who have already received the message. The format of the
1088 first spool file is described in chapter &<<CHAPspool>>&.
1089
1090 .cindex "rewriting" "addresses"
1091 Address rewriting that is specified in the rewrite section of the configuration
1092 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1093 both in the header lines and the envelope, at the time the message is accepted.
1094 If during the course of delivery additional addresses are generated (for
1095 example, via aliasing), these new addresses are rewritten as soon as they are
1096 generated. At the time a message is actually delivered (transported) further
1097 rewriting can take place; because this is a transport option, it can be
1098 different for different forms of delivery. It is also possible to specify the
1099 addition or removal of certain header lines at the time the message is
1100 delivered (see chapters &<<CHAProutergeneric>>& and
1101 &<<CHAPtransportgeneric>>&).
1102
1103
1104
1105 .section "Life of a message" "SECID15"
1106 .cindex "message" "life of"
1107 .cindex "message" "frozen"
1108 A message remains in the spool directory until it is completely delivered to
1109 its recipients or to an error address, or until it is deleted by an
1110 administrator or by the user who originally created it. In cases when delivery
1111 cannot proceed &-- for example, when a message can neither be delivered to its
1112 recipients nor returned to its sender, the message is marked &"frozen"& on the
1113 spool, and no more deliveries are attempted.
1114
1115 .cindex "frozen messages" "thawing"
1116 .cindex "message" "thawing frozen"
1117 An administrator can &"thaw"& such messages when the problem has been
1118 corrected, and can also freeze individual messages by hand if necessary. In
1119 addition, an administrator can force a delivery error, causing a bounce message
1120 to be sent.
1121
1122 .oindex "&%timeout_frozen_after%&"
1123 .oindex "&%ignore_bounce_errors_after%&"
1124 There are options called &%ignore_bounce_errors_after%& and
1125 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1126 The first applies only to frozen bounces, the second to any frozen messages.
1127
1128 .cindex "message" "log file for"
1129 .cindex "log" "file for each message"
1130 While Exim is working on a message, it writes information about each delivery
1131 attempt to its main log file. This includes successful, unsuccessful, and
1132 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1133 lines are also written to a separate &'message log'& file for each message.
1134 These logs are solely for the benefit of the administrator, and are normally
1135 deleted along with the spool files when processing of a message is complete.
1136 The use of individual message logs can be disabled by setting
1137 &%no_message_logs%&; this might give an improvement in performance on very busy
1138 systems.
1139
1140 .cindex "journal file"
1141 .cindex "file" "journal"
1142 All the information Exim itself needs to set up a delivery is kept in the first
1143 spool file, along with the header lines. When a successful delivery occurs, the
1144 address is immediately written at the end of a journal file, whose name is the
1145 message id followed by &`-J`&. At the end of a delivery run, if there are some
1146 addresses left to be tried again later, the first spool file (the &`-H`& file)
1147 is updated to indicate which these are, and the journal file is then deleted.
1148 Updating the spool file is done by writing a new file and renaming it, to
1149 minimize the possibility of data loss.
1150
1151 Should the system or the program crash after a successful delivery but before
1152 the spool file has been updated, the journal is left lying around. The next
1153 time Exim attempts to deliver the message, it reads the journal file and
1154 updates the spool file before proceeding. This minimizes the chances of double
1155 deliveries caused by crashes.
1156
1157
1158
1159 .section "Processing an address for delivery" "SECTprocaddress"
1160 .cindex "drivers" "definition of"
1161 .cindex "router" "definition of"
1162 .cindex "transport" "definition of"
1163 The main delivery processing elements of Exim are called &'routers'& and
1164 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1165 number of them is provided in the source distribution, and compile-time options
1166 specify which ones are included in the binary. Run time options specify which
1167 ones are actually used for delivering messages.
1168
1169 .cindex "drivers" "instance definition"
1170 Each driver that is specified in the run time configuration is an &'instance'&
1171 of that particular driver type. Multiple instances are allowed; for example,
1172 you can set up several different &(smtp)& transports, each with different
1173 option values that might specify different ports or different timeouts. Each
1174 instance has its own identifying name. In what follows we will normally use the
1175 instance name when discussing one particular instance (that is, one specific
1176 configuration of the driver), and the generic driver name when discussing
1177 the driver's features in general.
1178
1179 A &'router'& is a driver that operates on an address, either determining how
1180 its delivery should happen, by assigning it to a specific transport, or
1181 converting the address into one or more new addresses (for example, via an
1182 alias file). A router may also explicitly choose to fail an address, causing it
1183 to be bounced.
1184
1185 A &'transport'& is a driver that transmits a copy of the message from Exim's
1186 spool to some destination. There are two kinds of transport: for a &'local'&
1187 transport, the destination is a file or a pipe on the local host, whereas for a
1188 &'remote'& transport the destination is some other host. A message is passed
1189 to a specific transport as a result of successful routing. If a message has
1190 several recipients, it may be passed to a number of different transports.
1191
1192 .cindex "preconditions" "definition of"
1193 An address is processed by passing it to each configured router instance in
1194 turn, subject to certain preconditions, until a router accepts the address or
1195 specifies that it should be bounced. We will describe this process in more
1196 detail shortly. First, as a simple example, we consider how each recipient
1197 address in a message is processed in a small configuration of three routers.
1198
1199 To make this a more concrete example, it is described in terms of some actual
1200 routers, but remember, this is only an example. You can configure Exim's
1201 routers in many different ways, and there may be any number of routers in a
1202 configuration.
1203
1204 The first router that is specified in a configuration is often one that handles
1205 addresses in domains that are not recognized specially by the local host. These
1206 are typically addresses for arbitrary domains on the Internet. A precondition
1207 is set up which looks for the special domains known to the host (for example,
1208 its own domain name), and the router is run for addresses that do &'not'&
1209 match. Typically, this is a router that looks up domains in the DNS in order to
1210 find the hosts to which this address routes. If it succeeds, the address is
1211 assigned to a suitable SMTP transport; if it does not succeed, the router is
1212 configured to fail the address.
1213
1214 The second router is reached only when the domain is recognized as one that
1215 &"belongs"& to the local host. This router does redirection &-- also known as
1216 aliasing and forwarding. When it generates one or more new addresses from the
1217 original, each of them is routed independently from the start. Otherwise, the
1218 router may cause an address to fail, or it may simply decline to handle the
1219 address, in which case the address is passed to the next router.
1220
1221 The final router in many configurations is one that checks to see if the
1222 address belongs to a local mailbox. The precondition may involve a check to
1223 see if the local part is the name of a login account, or it may look up the
1224 local part in a file or a database. If its preconditions are not met, or if
1225 the router declines, we have reached the end of the routers. When this happens,
1226 the address is bounced.
1227
1228
1229
1230 .section "Processing an address for verification" "SECID16"
1231 .cindex "router" "for verification"
1232 .cindex "verifying address" "overview"
1233 As well as being used to decide how to deliver to an address, Exim's routers
1234 are also used for &'address verification'&. Verification can be requested as
1235 one of the checks to be performed in an ACL for incoming messages, on both
1236 sender and recipient addresses, and it can be tested using the &%-bv%& and
1237 &%-bvs%& command line options.
1238
1239 When an address is being verified, the routers are run in &"verify mode"&. This
1240 does not affect the way the routers work, but it is a state that can be
1241 detected. By this means, a router can be skipped or made to behave differently
1242 when verifying. A common example is a configuration in which the first router
1243 sends all messages to a message-scanning program, unless they have been
1244 previously scanned. Thus, the first router accepts all addresses without any
1245 checking, making it useless for verifying. Normally, the &%no_verify%& option
1246 would be set for such a router, causing it to be skipped in verify mode.
1247
1248
1249
1250
1251 .section "Running an individual router" "SECTrunindrou"
1252 .cindex "router" "running details"
1253 .cindex "preconditions" "checking"
1254 .cindex "router" "result of running"
1255 As explained in the example above, a number of preconditions are checked before
1256 running a router. If any are not met, the router is skipped, and the address is
1257 passed to the next router. When all the preconditions on a router &'are'& met,
1258 the router is run. What happens next depends on the outcome, which is one of
1259 the following:
1260
1261 .ilist
1262 &'accept'&: The router accepts the address, and either assigns it to a
1263 transport, or generates one or more &"child"& addresses. Processing the
1264 original address ceases,
1265 .oindex "&%unseen%&"
1266 unless the &%unseen%& option is set on the router. This option
1267 can be used to set up multiple deliveries with different routing (for example,
1268 for keeping archive copies of messages). When &%unseen%& is set, the address is
1269 passed to the next router. Normally, however, an &'accept'& return marks the
1270 end of routing.
1271
1272 Any child addresses generated by the router are processed independently,
1273 starting with the first router by default. It is possible to change this by
1274 setting the &%redirect_router%& option to specify which router to start at for
1275 child addresses. Unlike &%pass_router%& (see below) the router specified by
1276 &%redirect_router%& may be anywhere in the router configuration.
1277 .next
1278 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1279 requests that the address be passed to another router. By default the address
1280 is passed to the next router, but this can be changed by setting the
1281 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1282 must be below the current router (to avoid loops).
1283 .next
1284 &'decline'&: The router declines to accept the address because it does not
1285 recognize it at all. By default, the address is passed to the next router, but
1286 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1287 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1288 &'decline'& into &'fail'&.
1289 .next
1290 &'fail'&: The router determines that the address should fail, and queues it for
1291 the generation of a bounce message. There is no further processing of the
1292 original address unless &%unseen%& is set on the router.
1293 .next
1294 &'defer'&: The router cannot handle the address at the present time. (A
1295 database may be offline, or a DNS lookup may have timed out.) No further
1296 processing of the address happens in this delivery attempt. It is tried again
1297 next time the message is considered for delivery.
1298 .next
1299 &'error'&: There is some error in the router (for example, a syntax error in
1300 its configuration). The action is as for defer.
1301 .endlist
1302
1303 If an address reaches the end of the routers without having been accepted by
1304 any of them, it is bounced as unrouteable. The default error message in this
1305 situation is &"unrouteable address"&, but you can set your own message by
1306 making use of the &%cannot_route_message%& option. This can be set for any
1307 router; the value from the last router that &"saw"& the address is used.
1308
1309 Sometimes while routing you want to fail a delivery when some conditions are
1310 met but others are not, instead of passing the address on for further routing.
1311 You can do this by having a second router that explicitly fails the delivery
1312 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1313 facility for this purpose.
1314
1315
1316 .section "Duplicate addresses" "SECID17"
1317 .cindex "case of local parts"
1318 .cindex "address duplicate, discarding"
1319 .cindex "duplicate addresses"
1320 Once routing is complete, Exim scans the addresses that are assigned to local
1321 and remote transports, and discards any duplicates that it finds. During this
1322 check, local parts are treated as case-sensitive. This happens only when
1323 actually delivering a message; when testing routers with &%-bt%&, all the
1324 routed addresses are shown.
1325
1326
1327
1328 .section "Router preconditions" "SECTrouprecon"
1329 .cindex "router" "preconditions, order of processing"
1330 .cindex "preconditions" "order of processing"
1331 The preconditions that are tested for each router are listed below, in the
1332 order in which they are tested. The individual configuration options are
1333 described in more detail in chapter &<<CHAProutergeneric>>&.
1334
1335 .ilist
1336 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1337 the local parts handled by the router may or must have certain prefixes and/or
1338 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1339 skipped. These conditions are tested first. When an affix is present, it is
1340 removed from the local part before further processing, including the evaluation
1341 of any other conditions.
1342 .next
1343 Routers can be designated for use only when not verifying an address, that is,
1344 only when routing it for delivery (or testing its delivery routing). If the
1345 &%verify%& option is set false, the router is skipped when Exim is verifying an
1346 address.
1347 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1348 &%verify_recipient%&, which independently control the use of the router for
1349 sender and recipient verification. You can set these options directly if
1350 you want a router to be used for only one type of verification.
1351 .next
1352 If the &%address_test%& option is set false, the router is skipped when Exim is
1353 run with the &%-bt%& option to test an address routing. This can be helpful
1354 when the first router sends all new messages to a scanner of some sort; it
1355 makes it possible to use &%-bt%& to test subsequent delivery routing without
1356 having to simulate the effect of the scanner.
1357 .next
1358 Routers can be designated for use only when verifying an address, as
1359 opposed to routing it for delivery. The &%verify_only%& option controls this.
1360 .next
1361 Individual routers can be explicitly skipped when running the routers to
1362 check an address given in the SMTP EXPN command (see the &%expn%& option).
1363 .next
1364 If the &%domains%& option is set, the domain of the address must be in the set
1365 of domains that it defines.
1366 .next
1367 .vindex "&$local_part_prefix$&"
1368 .vindex "&$local_part$&"
1369 .vindex "&$local_part_suffix$&"
1370 If the &%local_parts%& option is set, the local part of the address must be in
1371 the set of local parts that it defines. If &%local_part_prefix%& or
1372 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1373 part before this check. If you want to do precondition tests on local parts
1374 that include affixes, you can do so by using a &%condition%& option (see below)
1375 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1376 &$local_part_suffix$& as necessary.
1377 .next
1378 .vindex "&$local_user_uid$&"
1379 .vindex "&$local_user_gid$&"
1380 .vindex "&$home$&"
1381 If the &%check_local_user%& option is set, the local part must be the name of
1382 an account on the local host. If this check succeeds, the uid and gid of the
1383 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1384 user's home directory is placed in &$home$&; these values can be used in the
1385 remaining preconditions.
1386 .next
1387 If the &%router_home_directory%& option is set, it is expanded at this point,
1388 because it overrides the value of &$home$&. If this expansion were left till
1389 later, the value of &$home$& as set by &%check_local_user%& would be used in
1390 subsequent tests. Having two different values of &$home$& in the same router
1391 could lead to confusion.
1392 .next
1393 If the &%senders%& option is set, the envelope sender address must be in the
1394 set of addresses that it defines.
1395 .next
1396 If the &%require_files%& option is set, the existence or non-existence of
1397 specified files is tested.
1398 .next
1399 .cindex "customizing" "precondition"
1400 If the &%condition%& option is set, it is evaluated and tested. This option
1401 uses an expanded string to allow you to set up your own custom preconditions.
1402 Expanded strings are described in chapter &<<CHAPexpand>>&.
1403 .endlist
1404
1405
1406 Note that &%require_files%& comes near the end of the list, so you cannot use
1407 it to check for the existence of a file in which to lookup up a domain, local
1408 part, or sender. However, as these options are all expanded, you can use the
1409 &%exists%& expansion condition to make such tests within each condition. The
1410 &%require_files%& option is intended for checking files that the router may be
1411 going to use internally, or which are needed by a specific transport (for
1412 example, &_.procmailrc_&).
1413
1414
1415
1416 .section "Delivery in detail" "SECID18"
1417 .cindex "delivery" "in detail"
1418 When a message is to be delivered, the sequence of events is as follows:
1419
1420 .ilist
1421 If a system-wide filter file is specified, the message is passed to it. The
1422 filter may add recipients to the message, replace the recipients, discard the
1423 message, cause a new message to be generated, or cause the message delivery to
1424 fail. The format of the system filter file is the same as for Exim user filter
1425 files, described in the separate document entitled &'Exim's interfaces to mail
1426 filtering'&.
1427 .cindex "Sieve filter" "not available for system filter"
1428 (&*Note*&: Sieve cannot be used for system filter files.)
1429
1430 Some additional features are available in system filters &-- see chapter
1431 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1432 filter only once per delivery attempt, however many recipients it has. However,
1433 if there are several delivery attempts because one or more addresses could not
1434 be immediately delivered, the system filter is run each time. The filter
1435 condition &%first_delivery%& can be used to detect the first run of the system
1436 filter.
1437 .next
1438 Each recipient address is offered to each configured router in turn, subject to
1439 its preconditions, until one is able to handle it. If no router can handle the
1440 address, that is, if they all decline, the address is failed. Because routers
1441 can be targeted at particular domains, several locally handled domains can be
1442 processed entirely independently of each other.
1443 .next
1444 .cindex "routing" "loops in"
1445 .cindex "loop" "while routing"
1446 A router that accepts an address may assign it to a local or a remote
1447 transport. However, the transport is not run at this time. Instead, the address
1448 is placed on a list for the particular transport, which will be run later.
1449 Alternatively, the router may generate one or more new addresses (typically
1450 from alias, forward, or filter files). New addresses are fed back into this
1451 process from the top, but in order to avoid loops, a router ignores any address
1452 which has an identically-named ancestor that was processed by itself.
1453 .next
1454 When all the routing has been done, addresses that have been successfully
1455 handled are passed to their assigned transports. When local transports are
1456 doing real local deliveries, they handle only one address at a time, but if a
1457 local transport is being used as a pseudo-remote transport (for example, to
1458 collect batched SMTP messages for transmission by some other means) multiple
1459 addresses can be handled. Remote transports can always handle more than one
1460 address at a time, but can be configured not to do so, or to restrict multiple
1461 addresses to the same domain.
1462 .next
1463 Each local delivery to a file or a pipe runs in a separate process under a
1464 non-privileged uid, and these deliveries are run one at a time. Remote
1465 deliveries also run in separate processes, normally under a uid that is private
1466 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1467 run in parallel. The maximum number of simultaneous remote deliveries for any
1468 one message is set by the &%remote_max_parallel%& option.
1469 The order in which deliveries are done is not defined, except that all local
1470 deliveries happen before any remote deliveries.
1471 .next
1472 .cindex "queue runner"
1473 When it encounters a local delivery during a queue run, Exim checks its retry
1474 database to see if there has been a previous temporary delivery failure for the
1475 address before running the local transport. If there was a previous failure,
1476 Exim does not attempt a new delivery until the retry time for the address is
1477 reached. However, this happens only for delivery attempts that are part of a
1478 queue run. Local deliveries are always attempted when delivery immediately
1479 follows message reception, even if retry times are set for them. This makes for
1480 better behaviour if one particular message is causing problems (for example,
1481 causing quota overflow, or provoking an error in a filter file).
1482 .next
1483 .cindex "delivery" "retry in remote transports"
1484 Remote transports do their own retry handling, since an address may be
1485 deliverable to one of a number of hosts, each of which may have a different
1486 retry time. If there have been previous temporary failures and no host has
1487 reached its retry time, no delivery is attempted, whether in a queue run or
1488 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1489 .next
1490 If there were any permanent errors, a bounce message is returned to an
1491 appropriate address (the sender in the common case), with details of the error
1492 for each failing address. Exim can be configured to send copies of bounce
1493 messages to other addresses.
1494 .next
1495 .cindex "delivery" "deferral"
1496 If one or more addresses suffered a temporary failure, the message is left on
1497 the queue, to be tried again later. Delivery of these addresses is said to be
1498 &'deferred'&.
1499 .next
1500 When all the recipient addresses have either been delivered or bounced,
1501 handling of the message is complete. The spool files and message log are
1502 deleted, though the message log can optionally be preserved if required.
1503 .endlist
1504
1505
1506
1507
1508 .section "Retry mechanism" "SECID19"
1509 .cindex "delivery" "retry mechanism"
1510 .cindex "retry" "description of mechanism"
1511 .cindex "queue runner"
1512 Exim's mechanism for retrying messages that fail to get delivered at the first
1513 attempt is the queue runner process. You must either run an Exim daemon that
1514 uses the &%-q%& option with a time interval to start queue runners at regular
1515 intervals, or use some other means (such as &'cron'&) to start them. If you do
1516 not arrange for queue runners to be run, messages that fail temporarily at the
1517 first attempt will remain on your queue for ever. A queue runner process works
1518 its way through the queue, one message at a time, trying each delivery that has
1519 passed its retry time.
1520 You can run several queue runners at once.
1521
1522 Exim uses a set of configured rules to determine when next to retry the failing
1523 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1524 should give up trying to deliver to the address, at which point it generates a
1525 bounce message. If no retry rules are set for a particular host, address, and
1526 error combination, no retries are attempted, and temporary errors are treated
1527 as permanent.
1528
1529
1530
1531 .section "Temporary delivery failure" "SECID20"
1532 .cindex "delivery" "temporary failure"
1533 There are many reasons why a message may not be immediately deliverable to a
1534 particular address. Failure to connect to a remote machine (because it, or the
1535 connection to it, is down) is one of the most common. Temporary failures may be
1536 detected during routing as well as during the transport stage of delivery.
1537 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1538 is on a file system where the user is over quota. Exim can be configured to
1539 impose its own quotas on local mailboxes; where system quotas are set they will
1540 also apply.
1541
1542 If a host is unreachable for a period of time, a number of messages may be
1543 waiting for it by the time it recovers, and sending them in a single SMTP
1544 connection is clearly beneficial. Whenever a delivery to a remote host is
1545 deferred,
1546 .cindex "hints database"
1547 Exim makes a note in its hints database, and whenever a successful
1548 SMTP delivery has happened, it looks to see if any other messages are waiting
1549 for the same host. If any are found, they are sent over the same SMTP
1550 connection, subject to a configuration limit as to the maximum number in any
1551 one connection.
1552
1553
1554
1555 .section "Permanent delivery failure" "SECID21"
1556 .cindex "delivery" "permanent failure"
1557 .cindex "bounce message" "when generated"
1558 When a message cannot be delivered to some or all of its intended recipients, a
1559 bounce message is generated. Temporary delivery failures turn into permanent
1560 errors when their timeout expires. All the addresses that fail in a given
1561 delivery attempt are listed in a single message. If the original message has
1562 many recipients, it is possible for some addresses to fail in one delivery
1563 attempt and others to fail subsequently, giving rise to more than one bounce
1564 message. The wording of bounce messages can be customized by the administrator.
1565 See chapter &<<CHAPemsgcust>>& for details.
1566
1567 .cindex "&'X-Failed-Recipients:'& header line"
1568 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1569 failed addresses, for the benefit of programs that try to analyse such messages
1570 automatically.
1571
1572 .cindex "bounce message" "recipient of"
1573 A bounce message is normally sent to the sender of the original message, as
1574 obtained from the message's envelope. For incoming SMTP messages, this is the
1575 address given in the MAIL command. However, when an address is expanded via a
1576 forward or alias file, an alternative address can be specified for delivery
1577 failures of the generated addresses. For a mailing list expansion (see section
1578 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1579 of the list.
1580
1581
1582
1583 .section "Failures to deliver bounce messages" "SECID22"
1584 .cindex "bounce message" "failure to deliver"
1585 If a bounce message (either locally generated or received from a remote host)
1586 itself suffers a permanent delivery failure, the message is left on the queue,
1587 but it is frozen, awaiting the attention of an administrator. There are options
1588 that can be used to make Exim discard such failed messages, or to keep them
1589 for only a short time (see &%timeout_frozen_after%& and
1590 &%ignore_bounce_errors_after%&).
1591
1592
1593
1594
1595
1596 . ////////////////////////////////////////////////////////////////////////////
1597 . ////////////////////////////////////////////////////////////////////////////
1598
1599 .chapter "Building and installing Exim" "CHID3"
1600 .scindex IIDbuex "building Exim"
1601
1602 .section "Unpacking" "SECID23"
1603 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1604 creates a directory with the name of the current release (for example,
1605 &_exim-&version;_&) into which the following files are placed:
1606
1607 .table2 140pt
1608 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1609 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1610   documented"
1611 .irow &_LICENCE_&         "the GNU General Public Licence"
1612 .irow &_Makefile_&        "top-level make file"
1613 .irow &_NOTICE_&          "conditions for the use of Exim"
1614 .irow &_README_&          "list of files, directories and simple build &&&
1615   instructions"
1616 .endtable
1617
1618 Other files whose names begin with &_README_& may also be present. The
1619 following subdirectories are created:
1620
1621 .table2 140pt
1622 .irow &_Local_&           "an empty directory for local configuration files"
1623 .irow &_OS_&              "OS-specific files"
1624 .irow &_doc_&             "documentation files"
1625 .irow &_exim_monitor_&    "source files for the Exim monitor"
1626 .irow &_scripts_&         "scripts used in the build process"
1627 .irow &_src_&             "remaining source files"
1628 .irow &_util_&            "independent utilities"
1629 .endtable
1630
1631 The main utility programs are contained in the &_src_& directory, and are built
1632 with the Exim binary. The &_util_& directory contains a few optional scripts
1633 that may be useful to some sites.
1634
1635
1636 .section "Multiple machine architectures and operating systems" "SECID24"
1637 .cindex "building Exim" "multiple OS/architectures"
1638 The building process for Exim is arranged to make it easy to build binaries for
1639 a number of different architectures and operating systems from the same set of
1640 source files. Compilation does not take place in the &_src_& directory.
1641 Instead, a &'build directory'& is created for each architecture and operating
1642 system.
1643 .cindex "symbolic link" "to build directory"
1644 Symbolic links to the sources are installed in this directory, which is where
1645 the actual building takes place. In most cases, Exim can discover the machine
1646 architecture and operating system for itself, but the defaults can be
1647 overridden if necessary.
1648
1649
1650 .section "PCRE library" "SECTpcre"
1651 .cindex "PCRE library"
1652 Exim no longer has an embedded PCRE library as the vast majority of
1653 modern systems include PCRE as a system library, although you may need
1654 to install the PCRE or PCRE development package for your operating
1655 system. If your system has a normal PCRE installation the Exim build
1656 process will need no further configuration. If the library or the
1657 headers are in an unusual location you will need to either set the PCRE_LIBS
1658 and INCLUDE directives appropriately,
1659 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1660 If your operating system has no
1661 PCRE support then you will need to obtain and build the current PCRE
1662 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1663 More information on PCRE is available at &url(http://www.pcre.org/).
1664
1665 .section "DBM libraries" "SECTdb"
1666 .cindex "DBM libraries" "discussion of"
1667 .cindex "hints database" "DBM files used for"
1668 Even if you do not use any DBM files in your configuration, Exim still needs a
1669 DBM library in order to operate, because it uses indexed files for its hints
1670 databases. Unfortunately, there are a number of DBM libraries in existence, and
1671 different operating systems often have different ones installed.
1672
1673 .cindex "Solaris" "DBM library for"
1674 .cindex "IRIX, DBM library for"
1675 .cindex "BSD, DBM library for"
1676 .cindex "Linux, DBM library for"
1677 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1678 Linux distribution, the DBM configuration should happen automatically, and you
1679 may be able to ignore this section. Otherwise, you may have to learn more than
1680 you would like about DBM libraries from what follows.
1681
1682 .cindex "&'ndbm'& DBM library"
1683 Licensed versions of Unix normally contain a library of DBM functions operating
1684 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1685 versions of Unix seem to vary in what they contain as standard. In particular,
1686 some early versions of Linux have no default DBM library, and different
1687 distributors have chosen to bundle different libraries with their packaged
1688 versions. However, the more recent releases seem to have standardized on the
1689 Berkeley DB library.
1690
1691 Different DBM libraries have different conventions for naming the files they
1692 use. When a program opens a file called &_dbmfile_&, there are several
1693 possibilities:
1694
1695 .olist
1696 A traditional &'ndbm'& implementation, such as that supplied as part of
1697 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1698 .next
1699 .cindex "&'gdbm'& DBM library"
1700 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1701 compatibility interface it makes two different hard links to it with names
1702 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1703 file name is used unmodified.
1704 .next
1705 .cindex "Berkeley DB library"
1706 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1707 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1708 programmer exactly the same as the traditional &'ndbm'& implementation.
1709 .next
1710 If the Berkeley package is used in its native mode, it operates on a single
1711 file called &_dbmfile_&; the programmer's interface is somewhat different to
1712 the traditional &'ndbm'& interface.
1713 .next
1714 To complicate things further, there are several very different versions of the
1715 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1716 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1717 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1718 versions of Berkeley DB can be obtained from
1719 &url(http://www.sleepycat.com/).
1720 .next
1721 .cindex "&'tdb'& DBM library"
1722 Yet another DBM library, called &'tdb'&, is available from
1723 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1724 operates on a single file.
1725 .endlist
1726
1727 .cindex "USE_DB"
1728 .cindex "DBM libraries" "configuration for building"
1729 Exim and its utilities can be compiled to use any of these interfaces. In order
1730 to use any version of the Berkeley DB package in native mode, you must set
1731 USE_DB in an appropriate configuration file (typically
1732 &_Local/Makefile_&). For example:
1733 .code
1734 USE_DB=yes
1735 .endd
1736 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1737 error is diagnosed if you set more than one of these.
1738
1739 At the lowest level, the build-time configuration sets none of these options,
1740 thereby assuming an interface of type (1). However, some operating system
1741 configuration files (for example, those for the BSD operating systems and
1742 Linux) assume type (4) by setting USE_DB as their default, and the
1743 configuration files for Cygwin set USE_GDBM. Anything you set in
1744 &_Local/Makefile_&, however, overrides these system defaults.
1745
1746 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1747 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1748 in one of these lines:
1749 .code
1750 DBMLIB = -ldb
1751 DBMLIB = -ltdb
1752 .endd
1753 Settings like that will work if the DBM library is installed in the standard
1754 place. Sometimes it is not, and the library's header file may also not be in
1755 the default path. You may need to set INCLUDE to specify where the header
1756 file is, and to specify the path to the library more fully in DBMLIB, as in
1757 this example:
1758 .code
1759 INCLUDE=-I/usr/local/include/db-4.1
1760 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1761 .endd
1762 There is further detailed discussion about the various DBM libraries in the
1763 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1764
1765
1766
1767 .section "Pre-building configuration" "SECID25"
1768 .cindex "building Exim" "pre-building configuration"
1769 .cindex "configuration for building Exim"
1770 .cindex "&_Local/Makefile_&"
1771 .cindex "&_src/EDITME_&"
1772 Before building Exim, a local configuration file that specifies options
1773 independent of any operating system has to be created with the name
1774 &_Local/Makefile_&. A template for this file is supplied as the file
1775 &_src/EDITME_&, and it contains full descriptions of all the option settings
1776 therein. These descriptions are therefore not repeated here. If you are
1777 building Exim for the first time, the simplest thing to do is to copy
1778 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1779
1780 There are three settings that you must supply, because Exim will not build
1781 without them. They are the location of the run time configuration file
1782 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1783 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1784 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1785 a colon-separated list of file names; Exim uses the first of them that exists.
1786
1787 There are a few other parameters that can be specified either at build time or
1788 at run time, to enable the same binary to be used on a number of different
1789 machines. However, if the locations of Exim's spool directory and log file
1790 directory (if not within the spool directory) are fixed, it is recommended that
1791 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1792 detected early in Exim's execution (such as a malformed configuration file) can
1793 be logged.
1794
1795 .cindex "content scanning" "specifying at build time"
1796 Exim's interfaces for calling virus and spam scanning software directly from
1797 access control lists are not compiled by default. If you want to include these
1798 facilities, you need to set
1799 .code
1800 WITH_CONTENT_SCAN=yes
1801 .endd
1802 in your &_Local/Makefile_&. For details of the facilities themselves, see
1803 chapter &<<CHAPexiscan>>&.
1804
1805
1806 .cindex "&_Local/eximon.conf_&"
1807 .cindex "&_exim_monitor/EDITME_&"
1808 If you are going to build the Exim monitor, a similar configuration process is
1809 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1810 your installation and saved under the name &_Local/eximon.conf_&. If you are
1811 happy with the default settings described in &_exim_monitor/EDITME_&,
1812 &_Local/eximon.conf_& can be empty, but it must exist.
1813
1814 This is all the configuration that is needed in straightforward cases for known
1815 operating systems. However, the building process is set up so that it is easy
1816 to override options that are set by default or by operating-system-specific
1817 configuration files, for example to change the name of the C compiler, which
1818 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1819 do this.
1820
1821
1822
1823 .section "Support for iconv()" "SECID26"
1824 .cindex "&[iconv()]& support"
1825 .cindex "RFC 2047"
1826 The contents of header lines in messages may be encoded according to the rules
1827 described RFC 2047. This makes it possible to transmit characters that are not
1828 in the ASCII character set, and to label them as being in a particular
1829 character set. When Exim is inspecting header lines by means of the &%$h_%&
1830 mechanism, it decodes them, and translates them into a specified character set
1831 (default ISO-8859-1). The translation is possible only if the operating system
1832 supports the &[iconv()]& function.
1833
1834 However, some of the operating systems that supply &[iconv()]& do not support
1835 very many conversions. The GNU &%libiconv%& library (available from
1836 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1837 systems to remedy this deficiency, as well as on systems that do not supply
1838 &[iconv()]& at all. After installing &%libiconv%&, you should add
1839 .code
1840 HAVE_ICONV=yes
1841 .endd
1842 to your &_Local/Makefile_& and rebuild Exim.
1843
1844
1845
1846 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1847 .cindex "TLS" "including support for TLS"
1848 .cindex "encryption" "including support for"
1849 .cindex "SUPPORT_TLS"
1850 .cindex "OpenSSL" "building Exim with"
1851 .cindex "GnuTLS" "building Exim with"
1852 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1853 command as per RFC 2487. It can also support legacy clients that expect to
1854 start a TLS session immediately on connection to a non-standard port (see the
1855 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1856 line option).
1857
1858 If you want to build Exim with TLS support, you must first install either the
1859 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1860 implementing SSL.
1861
1862 If OpenSSL is installed, you should set
1863 .code
1864 SUPPORT_TLS=yes
1865 TLS_LIBS=-lssl -lcrypto
1866 .endd
1867 in &_Local/Makefile_&. You may also need to specify the locations of the
1868 OpenSSL library and include files. For example:
1869 .code
1870 SUPPORT_TLS=yes
1871 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1872 TLS_INCLUDE=-I/usr/local/openssl/include/
1873 .endd
1874 .cindex "pkg-config" "OpenSSL"
1875 If you have &'pkg-config'& available, then instead you can just use:
1876 .code
1877 SUPPORT_TLS=yes
1878 USE_OPENSSL_PC=openssl
1879 .endd
1880 .cindex "USE_GNUTLS"
1881 If GnuTLS is installed, you should set
1882 .code
1883 SUPPORT_TLS=yes
1884 USE_GNUTLS=yes
1885 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1886 .endd
1887 in &_Local/Makefile_&, and again you may need to specify the locations of the
1888 library and include files. For example:
1889 .code
1890 SUPPORT_TLS=yes
1891 USE_GNUTLS=yes
1892 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1893 TLS_INCLUDE=-I/usr/gnu/include
1894 .endd
1895 .cindex "pkg-config" "GnuTLS"
1896 If you have &'pkg-config'& available, then instead you can just use:
1897 .code
1898 SUPPORT_TLS=yes
1899 USE_GNUTLS=yes
1900 USE_GNUTLS_PC=gnutls
1901 .endd
1902
1903 You do not need to set TLS_INCLUDE if the relevant directory is already
1904 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1905 given in chapter &<<CHAPTLS>>&.
1906
1907
1908
1909
1910 .section "Use of tcpwrappers" "SECID27"
1911
1912 .cindex "tcpwrappers, building Exim to support"
1913 .cindex "USE_TCP_WRAPPERS"
1914 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1915 .cindex "tcp_wrappers_daemon_name"
1916 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1917 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1918 alternative to Exim's own checking facilities for installations that are
1919 already making use of &'tcpwrappers'& for other purposes. To do this, you
1920 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1921 &_tcpd.h_& to be available at compile time, and also ensure that the library
1922 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1923 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1924 you might have
1925 .code
1926 USE_TCP_WRAPPERS=yes
1927 CFLAGS=-O -I/usr/local/include
1928 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1929 .endd
1930 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1931 files is &"exim"&. For example, the line
1932 .code
1933 exim : LOCAL  192.168.1.  .friendly.domain.example
1934 .endd
1935 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1936 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1937 All other connections are denied. The daemon name used by &'tcpwrappers'&
1938 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1939 in &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1940 configure file. Consult the &'tcpwrappers'& documentation for
1941 further details.
1942
1943
1944 .section "Including support for IPv6" "SECID28"
1945 .cindex "IPv6" "including support for"
1946 Exim contains code for use on systems that have IPv6 support. Setting
1947 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1948 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1949 where the IPv6 support is not fully integrated into the normal include and
1950 library files.
1951
1952 Two different types of DNS record for handling IPv6 addresses have been
1953 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1954 currently seen as the mainstream. Another record type called A6 was proposed
1955 as better than AAAA because it had more flexibility. However, it was felt to be
1956 over-complex, and its status was reduced to &"experimental"&. It is not known
1957 if anyone is actually using A6 records. Exim has support for A6 records, but
1958 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1959 support has not been tested for some time.
1960
1961
1962
1963 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1964 .cindex "lookup modules"
1965 .cindex "dynamic modules"
1966 .cindex ".so building"
1967 On some platforms, Exim supports not compiling all lookup types directly into
1968 the main binary, instead putting some into external modules which can be loaded
1969 on demand.
1970 This permits packagers to build Exim with support for lookups with extensive
1971 library dependencies without requiring all users to install all of those
1972 dependencies.
1973 Most, but not all, lookup types can be built this way.
1974
1975 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1976 installed; Exim will only load modules from that directory, as a security
1977 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1978 for your OS; see &_OS/Makefile-Linux_& for an example.
1979 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1980 see &_src/EDITME_& for details.
1981
1982 Then, for each module to be loaded dynamically, define the relevant
1983 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1984 For example, this will build in lsearch but load sqlite and mysql support
1985 on demand:
1986 .code
1987 LOOKUP_LSEARCH=yes
1988 LOOKUP_SQLITE=2
1989 LOOKUP_MYSQL=2
1990 .endd
1991
1992
1993 .section "The building process" "SECID29"
1994 .cindex "build directory"
1995 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1996 created, run &'make'& at the top level. It determines the architecture and
1997 operating system types, and creates a build directory if one does not exist.
1998 For example, on a Sun system running Solaris 8, the directory
1999 &_build-SunOS5-5.8-sparc_& is created.
2000 .cindex "symbolic link" "to source files"
2001 Symbolic links to relevant source files are installed in the build directory.
2002
2003 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2004 building process fails if it is set.
2005
2006 If this is the first time &'make'& has been run, it calls a script that builds
2007 a make file inside the build directory, using the configuration files from the
2008 &_Local_& directory. The new make file is then passed to another instance of
2009 &'make'&. This does the real work, building a number of utility scripts, and
2010 then compiling and linking the binaries for the Exim monitor (if configured), a
2011 number of utility programs, and finally Exim itself. The command &`make
2012 makefile`& can be used to force a rebuild of the make file in the build
2013 directory, should this ever be necessary.
2014
2015 If you have problems building Exim, check for any comments there may be in the
2016 &_README_& file concerning your operating system, and also take a look at the
2017 FAQ, where some common problems are covered.
2018
2019
2020
2021 .section 'Output from &"make"&' "SECID283"
2022 The output produced by the &'make'& process for compile lines is often very
2023 unreadable, because these lines can be very long. For this reason, the normal
2024 output is suppressed by default, and instead output similar to that which
2025 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2026 each module that is being compiled or linked. However, it is still possible to
2027 get the full output, by calling &'make'& like this:
2028 .code
2029 FULLECHO='' make -e
2030 .endd
2031 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2032 command reflection in &'make'&. When you ask for the full output, it is
2033 given in addition to the short output.
2034
2035
2036
2037 .section "Overriding build-time options for Exim" "SECToverride"
2038 .cindex "build-time options, overriding"
2039 The main make file that is created at the beginning of the building process
2040 consists of the concatenation of a number of files which set configuration
2041 values, followed by a fixed set of &'make'& instructions. If a value is set
2042 more than once, the last setting overrides any previous ones. This provides a
2043 convenient way of overriding defaults. The files that are concatenated are, in
2044 order:
2045 .display
2046 &_OS/Makefile-Default_&
2047 &_OS/Makefile-_&<&'ostype'&>
2048 &_Local/Makefile_&
2049 &_Local/Makefile-_&<&'ostype'&>
2050 &_Local/Makefile-_&<&'archtype'&>
2051 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2052 &_OS/Makefile-Base_&
2053 .endd
2054 .cindex "&_Local/Makefile_&"
2055 .cindex "building Exim" "operating system type"
2056 .cindex "building Exim" "architecture type"
2057 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2058 architecture type. &_Local/Makefile_& is required to exist, and the building
2059 process fails if it is absent. The other three &_Local_& files are optional,
2060 and are often not needed.
2061
2062 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2063 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2064 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2065 values are used, thereby providing a means of forcing particular settings.
2066 Otherwise, the scripts try to get values from the &%uname%& command. If this
2067 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2068 of &'ad hoc'& transformations are then applied, to produce the standard names
2069 that Exim expects. You can run these scripts directly from the shell in order
2070 to find out what values are being used on your system.
2071
2072
2073 &_OS/Makefile-Default_& contains comments about the variables that are set
2074 therein. Some (but not all) are mentioned below. If there is something that
2075 needs changing, review the contents of this file and the contents of the make
2076 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2077 default values are.
2078
2079
2080 .cindex "building Exim" "overriding default settings"
2081 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2082 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2083 need to change the original files. Instead, you should make the changes by
2084 putting the new values in an appropriate &_Local_& file. For example,
2085 .cindex "Tru64-Unix build-time settings"
2086 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2087 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2088 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2089 called with the option &%-std1%&, to make it recognize some of the features of
2090 Standard C that Exim uses. (Most other compilers recognize Standard C by
2091 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2092 containing the lines
2093 .code
2094 CC=cc
2095 CFLAGS=-std1
2096 .endd
2097 If you are compiling for just one operating system, it may be easier to put
2098 these lines directly into &_Local/Makefile_&.
2099
2100 Keeping all your local configuration settings separate from the distributed
2101 files makes it easy to transfer them to new versions of Exim simply by copying
2102 the contents of the &_Local_& directory.
2103
2104
2105 .cindex "NIS lookup type" "including support for"
2106 .cindex "NIS+ lookup type" "including support for"
2107 .cindex "LDAP" "including support for"
2108 .cindex "lookup" "inclusion in binary"
2109 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2110 lookup, but not all systems have these components installed, so the default is
2111 not to include the relevant code in the binary. All the different kinds of file
2112 and database lookup that Exim supports are implemented as separate code modules
2113 which are included only if the relevant compile-time options are set. In the
2114 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2115 .code
2116 LOOKUP_LDAP=yes
2117 LOOKUP_NIS=yes
2118 LOOKUP_NISPLUS=yes
2119 .endd
2120 and similar settings apply to the other lookup types. They are all listed in
2121 &_src/EDITME_&. In many cases the relevant include files and interface
2122 libraries need to be installed before compiling Exim.
2123 .cindex "cdb" "including support for"
2124 However, there are some optional lookup types (such as cdb) for which
2125 the code is entirely contained within Exim, and no external include
2126 files or libraries are required. When a lookup type is not included in the
2127 binary, attempts to configure Exim to use it cause run time configuration
2128 errors.
2129
2130 .cindex "pkg-config" "lookups"
2131 .cindex "pkg-config" "authenticators"
2132 Many systems now use a tool called &'pkg-config'& to encapsulate information
2133 about how to compile against a library; Exim has some initial support for
2134 being able to use pkg-config for lookups and authenticators.  For any given
2135 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2136 variable with the &`_PC`& suffix in the name and assign as the value the
2137 name of the package to be queried.  The results of querying via the
2138 &'pkg-config'& command will be added to the appropriate Makefile variables
2139 with &`+=`& directives, so your version of &'make'& will need to support that
2140 syntax.  For instance:
2141 .code
2142 LOOKUP_SQLITE=yes
2143 LOOKUP_SQLITE_PC=sqlite3
2144 AUTH_GSASL=yes
2145 AUTH_GSASL_PC=libgsasl
2146 AUTH_HEIMDAL_GSSAPI=yes
2147 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2148 .endd
2149
2150 .cindex "Perl" "including support for"
2151 Exim can be linked with an embedded Perl interpreter, allowing Perl
2152 subroutines to be called during string expansion. To enable this facility,
2153 .code
2154 EXIM_PERL=perl.o
2155 .endd
2156 must be defined in &_Local/Makefile_&. Details of this facility are given in
2157 chapter &<<CHAPperl>>&.
2158
2159 .cindex "X11 libraries, location of"
2160 The location of the X11 libraries is something that varies a lot between
2161 operating systems, and there may be different versions of X11 to cope
2162 with. Exim itself makes no use of X11, but if you are compiling the Exim
2163 monitor, the X11 libraries must be available.
2164 The following three variables are set in &_OS/Makefile-Default_&:
2165 .code
2166 X11=/usr/X11R6
2167 XINCLUDE=-I$(X11)/include
2168 XLFLAGS=-L$(X11)/lib
2169 .endd
2170 These are overridden in some of the operating-system configuration files. For
2171 example, in &_OS/Makefile-SunOS5_& there is
2172 .code
2173 X11=/usr/openwin
2174 XINCLUDE=-I$(X11)/include
2175 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2176 .endd
2177 If you need to override the default setting for your operating system, place a
2178 definition of all three of these variables into your
2179 &_Local/Makefile-<ostype>_& file.
2180
2181 .cindex "EXTRALIBS"
2182 If you need to add any extra libraries to the link steps, these can be put in a
2183 variable called EXTRALIBS, which appears in all the link commands, but by
2184 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2185 command for linking the main Exim binary, and not for any associated utilities.
2186
2187 .cindex "DBM libraries" "configuration for building"
2188 There is also DBMLIB, which appears in the link commands for binaries that
2189 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2190 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2191 binary, and which can be used, for example, to include additional X11
2192 libraries.
2193
2194 .cindex "configuration file" "editing"
2195 The make file copes with rebuilding Exim correctly if any of the configuration
2196 files are edited. However, if an optional configuration file is deleted, it is
2197 necessary to touch the associated non-optional file (that is,
2198 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2199
2200
2201 .section "OS-specific header files" "SECID30"
2202 .cindex "&_os.h_&"
2203 .cindex "building Exim" "OS-specific C header files"
2204 The &_OS_& directory contains a number of files with names of the form
2205 &_os.h-<ostype>_&. These are system-specific C header files that should not
2206 normally need to be changed. There is a list of macro settings that are
2207 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2208 are porting Exim to a new operating system.
2209
2210
2211
2212 .section "Overriding build-time options for the monitor" "SECID31"
2213 .cindex "building Eximon"
2214 A similar process is used for overriding things when building the Exim monitor,
2215 where the files that are involved are
2216 .display
2217 &_OS/eximon.conf-Default_&
2218 &_OS/eximon.conf-_&<&'ostype'&>
2219 &_Local/eximon.conf_&
2220 &_Local/eximon.conf-_&<&'ostype'&>
2221 &_Local/eximon.conf-_&<&'archtype'&>
2222 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2223 .endd
2224 .cindex "&_Local/eximon.conf_&"
2225 As with Exim itself, the final three files need not exist, and in this case the
2226 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2227 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2228 variables of the same name, preceded by EXIMON_. For example, setting
2229 EXIMON_LOG_DEPTH in the environment overrides the value of
2230 LOG_DEPTH at run time.
2231 .ecindex IIDbuex
2232
2233
2234 .section "Installing Exim binaries and scripts" "SECID32"
2235 .cindex "installing Exim"
2236 .cindex "BIN_DIRECTORY"
2237 The command &`make install`& runs the &(exim_install)& script with no
2238 arguments. The script copies binaries and utility scripts into the directory
2239 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2240 .cindex "setuid" "installing Exim with"
2241 The install script copies files only if they are newer than the files they are
2242 going to replace. The Exim binary is required to be owned by root and have the
2243 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2244 install`& as root so that it can set up the Exim binary in this way. However, in
2245 some special situations (for example, if a host is doing no local deliveries)
2246 it may be possible to run Exim without making the binary setuid root (see
2247 chapter &<<CHAPsecurity>>& for details).
2248
2249 .cindex "CONFIGURE_FILE"
2250 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2251 in &_Local/Makefile_&. If this names a single file, and the file does not
2252 exist, the default configuration file &_src/configure.default_& is copied there
2253 by the installation script. If a run time configuration file already exists, it
2254 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2255 alternative files, no default is installed.
2256
2257 .cindex "system aliases file"
2258 .cindex "&_/etc/aliases_&"
2259 One change is made to the default configuration file when it is installed: the
2260 default configuration contains a router that references a system aliases file.
2261 The path to this file is set to the value specified by
2262 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2263 If the system aliases file does not exist, the installation script creates it,
2264 and outputs a comment to the user.
2265
2266 The created file contains no aliases, but it does contain comments about the
2267 aliases a site should normally have. Mail aliases have traditionally been
2268 kept in &_/etc/aliases_&. However, some operating systems are now using
2269 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2270 Exim's configuration if necessary.
2271
2272 The default configuration uses the local host's name as the only local domain,
2273 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2274 running as the local user. System aliases and &_.forward_& files in users' home
2275 directories are supported, but no NIS or NIS+ support is configured. Domains
2276 other than the name of the local host are routed using the DNS, with delivery
2277 over SMTP.
2278
2279 It is possible to install Exim for special purposes (such as building a binary
2280 distribution) in a private part of the file system. You can do this by a
2281 command such as
2282 .code
2283 make DESTDIR=/some/directory/ install
2284 .endd
2285 This has the effect of pre-pending the specified directory to all the file
2286 paths, except the name of the system aliases file that appears in the default
2287 configuration. (If a default alias file is created, its name &'is'& modified.)
2288 For backwards compatibility, ROOT is used if DESTDIR is not set,
2289 but this usage is deprecated.
2290
2291 .cindex "installing Exim" "what is not installed"
2292 Running &'make install'& does not copy the Exim 4 conversion script
2293 &'convert4r4'&. You will probably run this only once if you are
2294 upgrading from Exim 3. None of the documentation files in the &_doc_&
2295 directory are copied, except for the info files when you have set
2296 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2297
2298 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2299 to their names. The Exim binary itself, however, is handled differently. It is
2300 installed under a name that includes the version number and the compile number,
2301 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2302 called &_exim_& to point to the binary. If you are updating a previous version
2303 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2304 from the directory (as seen by other processes).
2305
2306 .cindex "installing Exim" "testing the script"
2307 If you want to see what the &'make install'& will do before running it for
2308 real, you can pass the &%-n%& option to the installation script by this
2309 command:
2310 .code
2311 make INSTALL_ARG=-n install
2312 .endd
2313 The contents of the variable INSTALL_ARG are passed to the installation
2314 script. You do not need to be root to run this test. Alternatively, you can run
2315 the installation script directly, but this must be from within the build
2316 directory. For example, from the top-level Exim directory you could use this
2317 command:
2318 .code
2319 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2320 .endd
2321 .cindex "installing Exim" "install script options"
2322 There are two other options that can be supplied to the installation script.
2323
2324 .ilist
2325 &%-no_chown%& bypasses the call to change the owner of the installed binary
2326 to root, and the call to make it a setuid binary.
2327 .next
2328 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2329 installed binary.
2330 .endlist
2331
2332 INSTALL_ARG can be used to pass these options to the script. For example:
2333 .code
2334 make INSTALL_ARG=-no_symlink install
2335 .endd
2336 The installation script can also be given arguments specifying which files are
2337 to be copied. For example, to install just the Exim binary, and nothing else,
2338 without creating the symbolic link, you could use:
2339 .code
2340 make INSTALL_ARG='-no_symlink exim' install
2341 .endd
2342
2343
2344
2345 .section "Installing info documentation" "SECTinsinfdoc"
2346 .cindex "installing Exim" "&'info'& documentation"
2347 Not all systems use the GNU &'info'& system for documentation, and for this
2348 reason, the Texinfo source of Exim's documentation is not included in the main
2349 distribution. Instead it is available separately from the ftp site (see section
2350 &<<SECTavail>>&).
2351
2352 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2353 source of the documentation is found in the source tree, running &`make
2354 install`& automatically builds the info files and installs them.
2355
2356
2357
2358 .section "Setting up the spool directory" "SECID33"
2359 .cindex "spool directory" "creating"
2360 When it starts up, Exim tries to create its spool directory if it does not
2361 exist. The Exim uid and gid are used for the owner and group of the spool
2362 directory. Sub-directories are automatically created in the spool directory as
2363 necessary.
2364
2365
2366
2367
2368 .section "Testing" "SECID34"
2369 .cindex "testing" "installation"
2370 Having installed Exim, you can check that the run time configuration file is
2371 syntactically valid by running the following command, which assumes that the
2372 Exim binary directory is within your PATH environment variable:
2373 .code
2374 exim -bV
2375 .endd
2376 If there are any errors in the configuration file, Exim outputs error messages.
2377 Otherwise it outputs the version number and build date,
2378 the DBM library that is being used, and information about which drivers and
2379 other optional code modules are included in the binary.
2380 Some simple routing tests can be done by using the address testing option. For
2381 example,
2382 .display
2383 &`exim -bt`& <&'local username'&>
2384 .endd
2385 should verify that it recognizes a local mailbox, and
2386 .display
2387 &`exim -bt`& <&'remote address'&>
2388 .endd
2389 a remote one. Then try getting it to deliver mail, both locally and remotely.
2390 This can be done by passing messages directly to Exim, without going through a
2391 user agent. For example:
2392 .code
2393 exim -v postmaster@your.domain.example
2394 From: user@your.domain.example
2395 To: postmaster@your.domain.example
2396 Subject: Testing Exim
2397
2398 This is a test message.
2399 ^D
2400 .endd
2401 The &%-v%& option causes Exim to output some verification of what it is doing.
2402 In this case you should see copies of three log lines, one for the message's
2403 arrival, one for its delivery, and one containing &"Completed"&.
2404
2405 .cindex "delivery" "problems with"
2406 If you encounter problems, look at Exim's log files (&'mainlog'& and
2407 &'paniclog'&) to see if there is any relevant information there. Another source
2408 of information is running Exim with debugging turned on, by specifying the
2409 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2410 with debugging turned on by a command of the form
2411 .display
2412 &`exim -d -M`& <&'exim-message-id'&>
2413 .endd
2414 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2415 produces rather a lot of output, but you can cut this down to specific areas.
2416 For example, if you use &%-d-all+route%& only the debugging information
2417 relevant to routing is included. (See the &%-d%& option in chapter
2418 &<<CHAPcommandline>>& for more details.)
2419
2420 .cindex '&"sticky"& bit'
2421 .cindex "lock files"
2422 One specific problem that has shown up on some sites is the inability to do
2423 local deliveries into a shared mailbox directory, because it does not have the
2424 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2425 writing to a mailbox file, and if it cannot create the lock file, the delivery
2426 is deferred. You can get round this either by setting the &"sticky bit"& on the
2427 directory, or by setting a specific group for local deliveries and allowing
2428 that group to create files in the directory (see the comments above the
2429 &(local_delivery)& transport in the default configuration file). Another
2430 approach is to configure Exim not to use lock files, but just to rely on
2431 &[fcntl()]& locking instead. However, you should do this only if all user
2432 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2433 see chapter &<<CHAPappendfile>>&.
2434
2435 One thing that cannot be tested on a system that is already running an MTA is
2436 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2437 &%-oX%& option can be used to run an Exim daemon that listens on some other
2438 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2439 &'exim_checkaccess'& utility can be used to check out policy controls on
2440 incoming SMTP mail.
2441
2442 Testing a new version on a system that is already running Exim can most easily
2443 be done by building a binary with a different CONFIGURE_FILE setting. From
2444 within the run time configuration, all other file and directory names
2445 that Exim uses can be altered, in order to keep it entirely clear of the
2446 production version.
2447
2448
2449 .section "Replacing another MTA with Exim" "SECID35"
2450 .cindex "replacing another MTA"
2451 Building and installing Exim for the first time does not of itself put it in
2452 general use. The name by which the system's MTA is called by mail user agents
2453 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2454 operating system), and it is necessary to make this name point to the &'exim'&
2455 binary in order to get the user agents to pass messages to Exim. This is
2456 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2457 or &_/usr/lib/sendmail_&
2458 .cindex "symbolic link" "to &'exim'& binary"
2459 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2460 privilege and executable status from the old MTA. It is then necessary to stop
2461 and restart the mailer daemon, if one is running.
2462
2463 .cindex "FreeBSD, MTA indirection"
2464 .cindex "&_/etc/mail/mailer.conf_&"
2465 Some operating systems have introduced alternative ways of switching MTAs. For
2466 example, if you are running FreeBSD, you need to edit the file
2467 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2468 described. A typical example of the contents of this file for running Exim is
2469 as follows:
2470 .code
2471 sendmail            /usr/exim/bin/exim
2472 send-mail           /usr/exim/bin/exim
2473 mailq               /usr/exim/bin/exim -bp
2474 newaliases          /usr/bin/true
2475 .endd
2476 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2477 your Exim installation is &"live"&. Check it by sending a message from your
2478 favourite user agent.
2479
2480 You should consider what to tell your users about the change of MTA. Exim may
2481 have different capabilities to what was previously running, and there are
2482 various operational differences such as the text of messages produced by
2483 command line options and in bounce messages. If you allow your users to make
2484 use of Exim's filtering capabilities, you should make the document entitled
2485 &'Exim's interface to mail filtering'& available to them.
2486
2487
2488
2489 .section "Upgrading Exim" "SECID36"
2490 .cindex "upgrading Exim"
2491 If you are already running Exim on your host, building and installing a new
2492 version automatically makes it available to MUAs, or any other programs that
2493 call the MTA directly. However, if you are running an Exim daemon, you do need
2494 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2495 new binary. You do not need to stop processing mail in order to install a new
2496 version of Exim. The install script does not modify an existing runtime
2497 configuration file.
2498
2499
2500
2501
2502 .section "Stopping the Exim daemon on Solaris" "SECID37"
2503 .cindex "Solaris" "stopping Exim on"
2504 The standard command for stopping the mailer daemon on Solaris is
2505 .code
2506 /etc/init.d/sendmail stop
2507 .endd
2508 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2509 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2510 for the text &"sendmail"&; this is not present because the actual program name
2511 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2512 solution is to replace the line that finds the process id with something like
2513 .code
2514 pid=`cat /var/spool/exim/exim-daemon.pid`
2515 .endd
2516 to obtain the daemon's pid directly from the file that Exim saves it in.
2517
2518 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2519 still be received from local processes, and if automatic delivery is configured
2520 (the normal case), deliveries will still occur.
2521
2522
2523
2524
2525 . ////////////////////////////////////////////////////////////////////////////
2526 . ////////////////////////////////////////////////////////////////////////////
2527
2528 .chapter "The Exim command line" "CHAPcommandline"
2529 .scindex IIDclo1 "command line" "options"
2530 .scindex IIDclo2 "options" "command line"
2531 Exim's command line takes the standard Unix form of a sequence of options,
2532 each starting with a hyphen character, followed by a number of arguments. The
2533 options are compatible with the main options of Sendmail, and there are also
2534 some additional options, some of which are compatible with Smail 3. Certain
2535 combinations of options do not make sense, and provoke an error if used.
2536 The form of the arguments depends on which options are set.
2537
2538
2539 .section "Setting options by program name" "SECID38"
2540 .cindex "&'mailq'&"
2541 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2542 were present before any other options.
2543 The &%-bp%& option requests a listing of the contents of the mail queue on the
2544 standard output.
2545 This feature is for compatibility with some systems that contain a command of
2546 that name in one of the standard libraries, symbolically linked to
2547 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2548
2549 .cindex "&'rsmtp'&"
2550 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2551 were present before any other options, for compatibility with Smail. The
2552 &%-bS%& option is used for reading in a number of messages in batched SMTP
2553 format.
2554
2555 .cindex "&'rmail'&"
2556 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2557 &%-oee%& options were present before any other options, for compatibility with
2558 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2559
2560 .cindex "&'runq'&"
2561 .cindex "queue runner"
2562 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2563 were present before any other options, for compatibility with Smail. The &%-q%&
2564 option causes a single queue runner process to be started.
2565
2566 .cindex "&'newaliases'&"
2567 .cindex "alias file" "building"
2568 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2569 If Exim is called under the name &'newaliases'& it behaves as if the option
2570 &%-bi%& were present before any other options, for compatibility with Sendmail.
2571 This option is used for rebuilding Sendmail's alias file. Exim does not have
2572 the concept of a single alias file, but can be configured to run a given
2573 command if called with the &%-bi%& option.
2574
2575
2576 .section "Trusted and admin users" "SECTtrustedadmin"
2577 Some Exim options are available only to &'trusted users'& and others are
2578 available only to &'admin users'&. In the description below, the phrases &"Exim
2579 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2580 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2581 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2582
2583 .ilist
2584 .cindex "trusted users" "definition of"
2585 .cindex "user" "trusted definition of"
2586 The trusted users are root, the Exim user, any user listed in the
2587 &%trusted_users%& configuration option, and any user whose current group or any
2588 supplementary group is one of those listed in the &%trusted_groups%&
2589 configuration option. Note that the Exim group is not automatically trusted.
2590
2591 .cindex '&"From"& line'
2592 .cindex "envelope sender"
2593 Trusted users are always permitted to use the &%-f%& option or a leading
2594 &"From&~"& line to specify the envelope sender of a message that is passed to
2595 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2596 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2597 users to set envelope senders.
2598
2599 .cindex "&'From:'& header line"
2600 .cindex "&'Sender:'& header line"
2601 For a trusted user, there is never any check on the contents of the &'From:'&
2602 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2603 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2604
2605 Trusted users may also specify a host name, host address, interface address,
2606 protocol name, ident value, and authentication data when submitting a message
2607 locally. Thus, they are able to insert messages into Exim's queue locally that
2608 have the characteristics of messages received from a remote host. Untrusted
2609 users may in some circumstances use &%-f%&, but can never set the other values
2610 that are available to trusted users.
2611 .next
2612 .cindex "user" "admin definition of"
2613 .cindex "admin user" "definition of"
2614 The admin users are root, the Exim user, and any user that is a member of the
2615 Exim group or of any group listed in the &%admin_groups%& configuration option.
2616 The current group does not have to be one of these groups.
2617
2618 Admin users are permitted to list the queue, and to carry out certain
2619 operations on messages, for example, to force delivery failures. It is also
2620 necessary to be an admin user in order to see the full information provided by
2621 the Exim monitor, and full debugging output.
2622
2623 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2624 Exim to attempt delivery of messages on its queue is restricted to admin users.
2625 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2626 option false (that is, specifying &%no_prod_requires_admin%&).
2627
2628 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2629 is restricted to admin users unless &%queue_list_requires_admin%& is set
2630 false.
2631 .endlist
2632
2633
2634 &*Warning*&: If you configure your system so that admin users are able to
2635 edit Exim's configuration file, you are giving those users an easy way of
2636 getting root. There is further discussion of this issue at the start of chapter
2637 &<<CHAPconf>>&.
2638
2639
2640
2641
2642 .section "Command line options" "SECID39"
2643 Exim's command line options are described in alphabetical order below. If none
2644 of the options that specifies a specific action (such as starting the daemon or
2645 a queue runner, or testing an address, or receiving a message in a specific
2646 format, or listing the queue) are present, and there is at least one argument
2647 on the command line, &%-bm%& (accept a local message on the standard input,
2648 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2649 outputs a brief message about itself and exits.
2650
2651 . ////////////////////////////////////////////////////////////////////////////
2652 . Insert a stylized XML comment here, to identify the start of the command line
2653 . options. This is for the benefit of the Perl script that automatically
2654 . creates a man page for the options.
2655 . ////////////////////////////////////////////////////////////////////////////
2656
2657 .literal xml
2658 <!-- === Start of command line options === -->
2659 .literal off
2660
2661
2662 .vlist
2663 .vitem &%--%&
2664 .oindex "--"
2665 .cindex "options" "command line; terminating"
2666 This is a pseudo-option whose only purpose is to terminate the options and
2667 therefore to cause subsequent command line items to be treated as arguments
2668 rather than options, even if they begin with hyphens.
2669
2670 .vitem &%--help%&
2671 .oindex "&%--help%&"
2672 This option causes Exim to output a few sentences stating what it is.
2673 The same output is generated if the Exim binary is called with no options and
2674 no arguments.
2675
2676 .vitem &%--version%&
2677 .oindex "&%--version%&"
2678 This option is an alias for &%-bV%& and causes version information to be
2679 displayed.
2680
2681 .vitem &%-B%&<&'type'&>
2682 .oindex "&%-B%&"
2683 .cindex "8-bit characters"
2684 .cindex "Sendmail compatibility" "8-bit characters"
2685 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2686 clean; it ignores this option.
2687
2688 .vitem &%-bd%&
2689 .oindex "&%-bd%&"
2690 .cindex "daemon"
2691 .cindex "SMTP" "listener"
2692 .cindex "queue runner"
2693 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2694 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2695 that the daemon should also initiate periodic queue runs.
2696
2697 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2698 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2699 disconnect from the controlling terminal. When running this way, it can be
2700 stopped by pressing ctrl-C.
2701
2702 By default, Exim listens for incoming connections to the standard SMTP port on
2703 all the host's running interfaces. However, it is possible to listen on other
2704 ports, on multiple ports, and only on specific interfaces. Chapter
2705 &<<CHAPinterfaces>>& contains a description of the options that control this.
2706
2707 When a listening daemon
2708 .cindex "daemon" "process id (pid)"
2709 .cindex "pid (process id)" "of daemon"
2710 is started without the use of &%-oX%& (that is, without overriding the normal
2711 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2712 in Exim's spool directory. This location can be overridden by setting
2713 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2714 running as root.
2715
2716 When &%-oX%& is used on the command line to start a listening daemon, the
2717 process id is not written to the normal pid file path. However, &%-oP%& can be
2718 used to specify a path on the command line if a pid file is required.
2719
2720 The SIGHUP signal
2721 .cindex "SIGHUP"
2722 .cindex "daemon" "restarting"
2723 can be used to cause the daemon to re-execute itself. This should be done
2724 whenever Exim's configuration file, or any file that is incorporated into it by
2725 means of the &%.include%& facility, is changed, and also whenever a new version
2726 of Exim is installed. It is not necessary to do this when other files that are
2727 referenced from the configuration (for example, alias files) are changed,
2728 because these are reread each time they are used.
2729
2730 .vitem &%-bdf%&
2731 .oindex "&%-bdf%&"
2732 This option has the same effect as &%-bd%& except that it never disconnects
2733 from the controlling terminal, even when no debugging is specified.
2734
2735 .vitem &%-be%&
2736 .oindex "&%-be%&"
2737 .cindex "testing" "string expansion"
2738 .cindex "expansion" "testing"
2739 Run Exim in expansion testing mode. Exim discards its root privilege, to
2740 prevent ordinary users from using this mode to read otherwise inaccessible
2741 files. If no arguments are given, Exim runs interactively, prompting for lines
2742 of data. Otherwise, it processes each argument in turn.
2743
2744 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2745 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2746 used without command line arguments. If successful, it uses the &[readline()]&
2747 function, which provides extensive line-editing facilities, for reading the
2748 test data. A line history is supported.
2749
2750 Long expansion expressions can be split over several lines by using backslash
2751 continuations. As in Exim's run time configuration, white space at the start of
2752 continuation lines is ignored. Each argument or data line is passed through the
2753 string expansion mechanism, and the result is output. Variable values from the
2754 configuration file (for example, &$qualify_domain$&) are available, but no
2755 message-specific values (such as &$sender_domain$&) are set, because no message
2756 is being processed (but see &%-bem%& and &%-Mset%&).
2757
2758 &*Note*&: If you use this mechanism to test lookups, and you change the data
2759 files or databases you are using, you must exit and restart Exim before trying
2760 the same lookup again. Otherwise, because each Exim process caches the results
2761 of lookups, you will just get the same result as before.
2762
2763 .vitem &%-bem%&&~<&'filename'&>
2764 .oindex "&%-bem%&"
2765 .cindex "testing" "string expansion"
2766 .cindex "expansion" "testing"
2767 This option operates like &%-be%& except that it must be followed by the name
2768 of a file. For example:
2769 .code
2770 exim -bem /tmp/testmessage
2771 .endd
2772 The file is read as a message (as if receiving a locally-submitted non-SMTP
2773 message) before any of the test expansions are done. Thus, message-specific
2774 variables such as &$message_size$& and &$header_from:$& are available. However,
2775 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2776 recipients are read from the headers in the normal way, and are shown in the
2777 &$recipients$& variable. Note that recipients cannot be given on the command
2778 line, because further arguments are taken as strings to expand (just like
2779 &%-be%&).
2780
2781 .vitem &%-bF%&&~<&'filename'&>
2782 .oindex "&%-bF%&"
2783 .cindex "system filter" "testing"
2784 .cindex "testing" "system filter"
2785 This option is the same as &%-bf%& except that it assumes that the filter being
2786 tested is a system filter. The additional commands that are available only in
2787 system filters are recognized.
2788
2789 .vitem &%-bf%&&~<&'filename'&>
2790 .oindex "&%-bf%&"
2791 .cindex "filter" "testing"
2792 .cindex "testing" "filter file"
2793 .cindex "forward file" "testing"
2794 .cindex "testing" "forward file"
2795 .cindex "Sieve filter" "testing"
2796 This option runs Exim in user filter testing mode; the file is the filter file
2797 to be tested, and a test message must be supplied on the standard input. If
2798 there are no message-dependent tests in the filter, an empty file can be
2799 supplied.
2800
2801 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2802 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2803 filter and a user filter in the same run. For example:
2804 .code
2805 exim -bF /system/filter -bf /user/filter </test/message
2806 .endd
2807 This is helpful when the system filter adds header lines or sets filter
2808 variables that are used by the user filter.
2809
2810 If the test filter file does not begin with one of the special lines
2811 .code
2812 # Exim filter
2813 # Sieve filter
2814 .endd
2815 it is taken to be a normal &_.forward_& file, and is tested for validity under
2816 that interpretation. See sections &<<SECTitenonfilred>>& to
2817 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2818 redirection lists.
2819
2820 The result of an Exim command that uses &%-bf%&, provided no errors are
2821 detected, is a list of the actions that Exim would try to take if presented
2822 with the message for real. More details of filter testing are given in the
2823 separate document entitled &'Exim's interfaces to mail filtering'&.
2824
2825 When testing a filter file,
2826 .cindex "&""From""& line"
2827 .cindex "envelope sender"
2828 .oindex "&%-f%&" "for filter testing"
2829 the envelope sender can be set by the &%-f%& option,
2830 or by a &"From&~"& line at the start of the test message. Various parameters
2831 that would normally be taken from the envelope recipient address of the message
2832 can be set by means of additional command line options (see the next four
2833 options).
2834
2835 .vitem &%-bfd%&&~<&'domain'&>
2836 .oindex "&%-bfd%&"
2837 .vindex "&$qualify_domain$&"
2838 This sets the domain of the recipient address when a filter file is being
2839 tested by means of the &%-bf%& option. The default is the value of
2840 &$qualify_domain$&.
2841
2842 .vitem &%-bfl%&&~<&'local&~part'&>
2843 .oindex "&%-bfl%&"
2844 This sets the local part of the recipient address when a filter file is being
2845 tested by means of the &%-bf%& option. The default is the username of the
2846 process that calls Exim. A local part should be specified with any prefix or
2847 suffix stripped, because that is how it appears to the filter when a message is
2848 actually being delivered.
2849
2850 .vitem &%-bfp%&&~<&'prefix'&>
2851 .oindex "&%-bfp%&"
2852 This sets the prefix of the local part of the recipient address when a filter
2853 file is being tested by means of the &%-bf%& option. The default is an empty
2854 prefix.
2855
2856 .vitem &%-bfs%&&~<&'suffix'&>
2857 .oindex "&%-bfs%&"
2858 This sets the suffix of the local part of the recipient address when a filter
2859 file is being tested by means of the &%-bf%& option. The default is an empty
2860 suffix.
2861
2862 .vitem &%-bh%&&~<&'IP&~address'&>
2863 .oindex "&%-bh%&"
2864 .cindex "testing" "incoming SMTP"
2865 .cindex "SMTP" "testing incoming"
2866 .cindex "testing" "relay control"
2867 .cindex "relaying" "testing configuration"
2868 .cindex "policy control" "testing"
2869 .cindex "debugging" "&%-bh%& option"
2870 This option runs a fake SMTP session as if from the given IP address, using the
2871 standard input and output. The IP address may include a port number at the end,
2872 after a full stop. For example:
2873 .code
2874 exim -bh 10.9.8.7.1234
2875 exim -bh fe80::a00:20ff:fe86:a061.5678
2876 .endd
2877 When an IPv6 address is given, it is converted into canonical form. In the case
2878 of the second example above, the value of &$sender_host_address$& after
2879 conversion to the canonical form is
2880 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2881
2882 Comments as to what is going on are written to the standard error file. These
2883 include lines beginning with &"LOG"& for anything that would have been logged.
2884 This facility is provided for testing configuration options for incoming
2885 messages, to make sure they implement the required policy. For example, you can
2886 test your relay controls using &%-bh%&.
2887
2888 &*Warning 1*&:
2889 .cindex "RFC 1413"
2890 You can test features of the configuration that rely on ident (RFC 1413)
2891 information by using the &%-oMt%& option. However, Exim cannot actually perform
2892 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2893 connection.
2894
2895 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2896 are also skipped when testing using &%-bh%&. If you want these callouts to
2897 occur, use &%-bhc%& instead.
2898
2899 Messages supplied during the testing session are discarded, and nothing is
2900 written to any of the real log files. There may be pauses when DNS (and other)
2901 lookups are taking place, and of course these may time out. The &%-oMi%& option
2902 can be used to specify a specific IP interface and port if this is important,
2903 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2904 session were authenticated.
2905
2906 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2907 output just states whether a given recipient address from a given host is
2908 acceptable or not. See section &<<SECTcheckaccess>>&.
2909
2910 Features such as authentication and encryption, where the client input is not
2911 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2912 specialized SMTP test program such as
2913 &url(http://jetmore.org/john/code/#swaks,swaks).
2914
2915 .vitem &%-bhc%&&~<&'IP&~address'&>
2916 .oindex "&%-bhc%&"
2917 This option operates in the same way as &%-bh%&, except that address
2918 verification callouts are performed if required. This includes consulting and
2919 updating the callout cache database.
2920
2921 .vitem &%-bi%&
2922 .oindex "&%-bi%&"
2923 .cindex "alias file" "building"
2924 .cindex "building alias file"
2925 .cindex "Sendmail compatibility" "&%-bi%& option"
2926 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2927 Exim does not have the concept of a single alias file, and so it cannot mimic
2928 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2929 tend to appear in various scripts such as NIS make files, so the option must be
2930 recognized.
2931
2932 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2933 configuration option is run, under the uid and gid of the caller of Exim. If
2934 the &%-oA%& option is used, its value is passed to the command as an argument.
2935 The command set by &%bi_command%& may not contain arguments. The command can
2936 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2937 if this is required. If the &%bi_command%& option is not set, calling Exim with
2938 &%-bi%& is a no-op.
2939
2940 .vitem &%-bm%&
2941 .oindex "&%-bm%&"
2942 .cindex "local message reception"
2943 This option runs an Exim receiving process that accepts an incoming,
2944 locally-generated message on the current input. The recipients are given as the
2945 command arguments (except when &%-t%& is also present &-- see below). Each
2946 argument can be a comma-separated list of RFC 2822 addresses. This is the
2947 default option for selecting the overall action of an Exim call; it is assumed
2948 if no other conflicting option is present.
2949
2950 If any addresses in the message are unqualified (have no domain), they are
2951 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2952 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2953 suppressing this for special cases.
2954
2955 Policy checks on the contents of local messages can be enforced by means of
2956 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2957
2958 .cindex "return code" "for &%-bm%&"
2959 The return code is zero if the message is successfully accepted. Otherwise, the
2960 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2961
2962 The format
2963 .cindex "message" "format"
2964 .cindex "format" "message"
2965 .cindex "&""From""& line"
2966 .cindex "UUCP" "&""From""& line"
2967 .cindex "Sendmail compatibility" "&""From""& line"
2968 of the message must be as defined in RFC 2822, except that, for
2969 compatibility with Sendmail and Smail, a line in one of the forms
2970 .code
2971 From sender Fri Jan  5 12:55 GMT 1997
2972 From sender Fri, 5 Jan 97 12:55:01
2973 .endd
2974 (with the weekday optional, and possibly with additional text after the date)
2975 is permitted to appear at the start of the message. There appears to be no
2976 authoritative specification of the format of this line. Exim recognizes it by
2977 matching against the regular expression defined by the &%uucp_from_pattern%&
2978 option, which can be changed if necessary.
2979
2980 .oindex "&%-f%&" "overriding &""From""& line"
2981 The specified sender is treated as if it were given as the argument to the
2982 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2983 preference to the address taken from the message. The caller of Exim must be a
2984 trusted user for the sender of a message to be set in this way.
2985
2986 .vitem &%-bmalware%&&~<&'filename'&>
2987 .oindex "&%-bmalware%&"
2988 .cindex "testing", "malware"
2989 .cindex "malware scan test"
2990 This debugging option causes Exim to scan the given file,
2991 using the malware scanning framework.  The option of &%av_scanner%& influences
2992 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
2993 the expansion should have defaults which apply to this invocation.  ACLs are
2994 not invoked, so if &%av_scanner%& references an ACL variable then that variable
2995 will never be populated and &%-bmalware%& will fail.
2996
2997 Exim will have changed working directory before resolving the filename, so
2998 using fully qualified pathnames is advisable.  Exim will be running as the Exim
2999 user when it tries to open the file, rather than as the invoking user.
3000 This option requires admin privileges.
3001
3002 The &%-bmalware%& option will not be extended to be more generally useful,
3003 there are better tools for file-scanning.  This option exists to help
3004 administrators verify their Exim and AV scanner configuration.
3005
3006 .vitem &%-bnq%&
3007 .oindex "&%-bnq%&"
3008 .cindex "address qualification, suppressing"
3009 By default, Exim automatically qualifies unqualified addresses (those
3010 without domains) that appear in messages that are submitted locally (that
3011 is, not over TCP/IP). This qualification applies both to addresses in
3012 envelopes, and addresses in header lines. Sender addresses are qualified using
3013 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3014 defaults to the value of &%qualify_domain%&).
3015
3016 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3017 being used to re-submit messages that originally came from remote hosts after
3018 content scanning, you probably do not want to qualify unqualified addresses in
3019 header lines. (Such lines will be present only if you have not enabled a header
3020 syntax check in the appropriate ACL.)
3021
3022 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3023 messages that originate on the local host. When this is used, unqualified
3024 addresses in the envelope provoke errors (causing message rejection) and
3025 unqualified addresses in header lines are left alone.
3026
3027
3028 .vitem &%-bP%&
3029 .oindex "&%-bP%&"
3030 .cindex "configuration options" "extracting"
3031 .cindex "options" "configuration &-- extracting"
3032 If this option is given with no arguments, it causes the values of all Exim's
3033 main configuration options to be written to the standard output. The values
3034 of one or more specific options can be requested by giving their names as
3035 arguments, for example:
3036 .code
3037 exim -bP qualify_domain hold_domains
3038 .endd
3039 .cindex "hiding configuration option values"
3040 .cindex "configuration options" "hiding value of"
3041 .cindex "options" "hiding value of"
3042 However, any option setting that is preceded by the word &"hide"& in the
3043 configuration file is not shown in full, except to an admin user. For other
3044 users, the output is as in this example:
3045 .code
3046 mysql_servers = <value not displayable>
3047 .endd
3048 If &%configure_file%& is given as an argument, the name of the run time
3049 configuration file is output.
3050 If a list of configuration files was supplied, the value that is output here
3051 is the name of the file that was actually used.
3052
3053 .cindex "daemon" "process id (pid)"
3054 .cindex "pid (process id)" "of daemon"
3055 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3056 directories where log files and daemon pid files are written are output,
3057 respectively. If these values are unset, log files are written in a
3058 sub-directory of the spool directory called &%log%&, and the pid file is
3059 written directly into the spool directory.
3060
3061 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3062 .code
3063 exim -bP +local_domains
3064 .endd
3065 it searches for a matching named list of any type (domain, host, address, or
3066 local part) and outputs what it finds.
3067
3068 .cindex "options" "router &-- extracting"
3069 .cindex "options" "transport &-- extracting"
3070 .cindex "options" "authenticator &-- extracting"
3071 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3072 followed by the name of an appropriate driver instance, the option settings for
3073 that driver are output. For example:
3074 .code
3075 exim -bP transport local_delivery
3076 .endd
3077 The generic driver options are output first, followed by the driver's private
3078 options. A list of the names of drivers of a particular type can be obtained by
3079 using one of the words &%router_list%&, &%transport_list%&, or
3080 &%authenticator_list%&, and a complete list of all drivers with their option
3081 settings can be obtained by using &%routers%&, &%transports%&, or
3082 &%authenticators%&.
3083
3084 .cindex "options" "macro &-- extracting"
3085 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3086 are available, similarly to the drivers.  Because macros are sometimes used
3087 for storing passwords, this option is restricted.
3088 The output format is one item per line.
3089
3090 .vitem &%-bp%&
3091 .oindex "&%-bp%&"
3092 .cindex "queue" "listing messages on"
3093 .cindex "listing" "messages on the queue"
3094 This option requests a listing of the contents of the mail queue on the
3095 standard output. If the &%-bp%& option is followed by a list of message ids,
3096 just those messages are listed. By default, this option can be used only by an
3097 admin user. However, the &%queue_list_requires_admin%& option can be set false
3098 to allow any user to see the queue.
3099
3100 Each message on the queue is displayed as in the following example:
3101 .code
3102 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3103           red.king@looking-glass.fict.example
3104           <other addresses>
3105 .endd
3106 .cindex "message" "size in queue listing"
3107 .cindex "size" "of message"
3108 The first line contains the length of time the message has been on the queue
3109 (in this case 25 minutes), the size of the message (2.9K), the unique local
3110 identifier for the message, and the message sender, as contained in the
3111 envelope. For bounce messages, the sender address is empty, and appears as
3112 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3113 the default sender address, the user's login name is shown in parentheses
3114 before the sender address.
3115
3116 .cindex "frozen messages" "in queue listing"
3117 If the message is frozen (attempts to deliver it are suspended) then the text
3118 &"*** frozen ***"& is displayed at the end of this line.
3119
3120 The recipients of the message (taken from the envelope, not the headers) are
3121 displayed on subsequent lines. Those addresses to which the message has already
3122 been delivered are marked with the letter D. If an original address gets
3123 expanded into several addresses via an alias or forward file, the original is
3124 displayed with a D only when deliveries for all of its child addresses are
3125 complete.
3126
3127
3128 .vitem &%-bpa%&
3129 .oindex "&%-bpa%&"
3130 This option operates like &%-bp%&, but in addition it shows delivered addresses
3131 that were generated from the original top level address(es) in each message by
3132 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3133 of just &"D"&.
3134
3135
3136 .vitem &%-bpc%&
3137 .oindex "&%-bpc%&"
3138 .cindex "queue" "count of messages on"
3139 This option counts the number of messages on the queue, and writes the total
3140 to the standard output. It is restricted to admin users, unless
3141 &%queue_list_requires_admin%& is set false.
3142
3143
3144 .vitem &%-bpr%&
3145 .oindex "&%-bpr%&"
3146 This option operates like &%-bp%&, but the output is not sorted into
3147 chronological order of message arrival. This can speed it up when there are
3148 lots of messages on the queue, and is particularly useful if the output is
3149 going to be post-processed in a way that doesn't need the sorting.
3150
3151 .vitem &%-bpra%&
3152 .oindex "&%-bpra%&"
3153 This option is a combination of &%-bpr%& and &%-bpa%&.
3154
3155 .vitem &%-bpru%&
3156 .oindex "&%-bpru%&"
3157 This option is a combination of &%-bpr%& and &%-bpu%&.
3158
3159
3160 .vitem &%-bpu%&
3161 .oindex "&%-bpu%&"
3162 This option operates like &%-bp%& but shows only undelivered top-level
3163 addresses for each message displayed. Addresses generated by aliasing or
3164 forwarding are not shown, unless the message was deferred after processing by a
3165 router with the &%one_time%& option set.
3166
3167
3168 .vitem &%-brt%&
3169 .oindex "&%-brt%&"
3170 .cindex "testing" "retry configuration"
3171 .cindex "retry" "configuration testing"
3172 This option is for testing retry rules, and it must be followed by up to three
3173 arguments. It causes Exim to look for a retry rule that matches the values
3174 and to write it to the standard output. For example:
3175 .code
3176 exim -brt bach.comp.mus.example
3177 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3178 .endd
3179 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3180 argument, which is required, can be a complete address in the form
3181 &'local_part@domain'&, or it can be just a domain name. If the second argument
3182 contains a dot, it is interpreted as an optional second domain name; if no
3183 retry rule is found for the first argument, the second is tried. This ties in
3184 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3185 rule is found that matches the host, one that matches the mail domain is
3186 sought. Finally, an argument that is the name of a specific delivery error, as
3187 used in setting up retry rules, can be given. For example:
3188 .code
3189 exim -brt haydn.comp.mus.example quota_3d
3190 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3191 .endd
3192
3193 .vitem &%-brw%&
3194 .oindex "&%-brw%&"
3195 .cindex "testing" "rewriting"
3196 .cindex "rewriting" "testing"
3197 This option is for testing address rewriting rules, and it must be followed by
3198 a single argument, consisting of either a local part without a domain, or a
3199 complete address with a fully qualified domain. Exim outputs how this address
3200 would be rewritten for each possible place it might appear. See chapter
3201 &<<CHAPrewrite>>& for further details.
3202
3203 .vitem &%-bS%&
3204 .oindex "&%-bS%&"
3205 .cindex "SMTP" "batched incoming"
3206 .cindex "batched SMTP input"
3207 This option is used for batched SMTP input, which is an alternative interface
3208 for non-interactive local message submission. A number of messages can be
3209 submitted in a single run. However, despite its name, this is not really SMTP
3210 input. Exim reads each message's envelope from SMTP commands on the standard
3211 input, but generates no responses. If the caller is trusted, or
3212 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3213 believed; otherwise the sender is always the caller of Exim.
3214
3215 The message itself is read from the standard input, in SMTP format (leading
3216 dots doubled), terminated by a line containing just a single dot. An error is
3217 provoked if the terminating dot is missing. A further message may then follow.
3218
3219 As for other local message submissions, the contents of incoming batch SMTP
3220 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3221 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3222 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3223
3224 Some other SMTP commands are recognized in the input. HELO and EHLO act
3225 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3226 QUIT quits, ignoring the rest of the standard input.
3227
3228 .cindex "return code" "for &%-bS%&"
3229 If any error is encountered, reports are written to the standard output and
3230 error streams, and Exim gives up immediately. The return code is 0 if no error
3231 was detected; it is 1 if one or more messages were accepted before the error
3232 was detected; otherwise it is 2.
3233
3234 More details of input using batched SMTP are given in section
3235 &<<SECTincomingbatchedSMTP>>&.
3236
3237 .vitem &%-bs%&
3238 .oindex "&%-bs%&"
3239 .cindex "SMTP" "local input"
3240 .cindex "local SMTP input"
3241 This option causes Exim to accept one or more messages by reading SMTP commands
3242 on the standard input, and producing SMTP replies on the standard output. SMTP
3243 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3244 Some user agents use this interface as a way of passing locally-generated
3245 messages to the MTA.
3246
3247 In
3248 .cindex "sender" "source of"
3249 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3250 set, the senders of messages are taken from the SMTP MAIL commands.
3251 Otherwise the content of these commands is ignored and the sender is set up as
3252 the calling user. Unqualified addresses are automatically qualified using
3253 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3254 &%-bnq%& option is used.
3255
3256 .cindex "inetd"
3257 The
3258 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3259 using a listening daemon. Exim can distinguish the two cases by checking
3260 whether the standard input is a TCP/IP socket. When Exim is called from
3261 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3262 above concerning senders and qualification do not apply. In this situation,
3263 Exim behaves in exactly the same way as it does when receiving a message via
3264 the listening daemon.
3265
3266 .vitem &%-bt%&
3267 .oindex "&%-bt%&"
3268 .cindex "testing" "addresses"
3269 .cindex "address" "testing"
3270 This option runs Exim in address testing mode, in which each argument is taken
3271 as a recipient address to be tested for deliverability. The results are
3272 written to the standard output. If a test fails, and the caller is not an admin
3273 user, no details of the failure are output, because these might contain
3274 sensitive information such as usernames and passwords for database lookups.
3275
3276 If no arguments are given, Exim runs in an interactive manner, prompting with a
3277 right angle bracket for addresses to be tested.
3278
3279 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3280 &[readline()]& function, because it is running as &'root'& and there are
3281 security issues.
3282
3283 Each address is handled as if it were the recipient address of a message
3284 (compare the &%-bv%& option). It is passed to the routers and the result is
3285 written to the standard output. However, any router that has
3286 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3287 genuine routing tests if your first router passes everything to a scanner
3288 program.
3289
3290 .cindex "return code" "for &%-bt%&"
3291 The return code is 2 if any address failed outright; it is 1 if no address
3292 failed outright but at least one could not be resolved for some reason. Return
3293 code 0 is given only when all addresses succeed.
3294
3295 .cindex "duplicate addresses"
3296 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3297 addresses after routing is complete, so that only one delivery takes place.
3298 This does not happen when testing with &%-bt%&; the full results of routing are
3299 always shown.
3300
3301 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3302 routers in the configuration makes any tests on the sender address of a
3303 message,
3304 .oindex "&%-f%&" "for address testing"
3305 you can use the &%-f%& option to set an appropriate sender when running
3306 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3307 default qualifying domain. However, if you have set up (for example) routers
3308 whose behaviour depends on the contents of an incoming message, you cannot test
3309 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3310 doing such tests.
3311
3312 .vitem &%-bV%&
3313 .oindex "&%-bV%&"
3314 .cindex "version number of Exim"
3315 This option causes Exim to write the current version number, compilation
3316 number, and compilation date of the &'exim'& binary to the standard output.
3317 It also lists the DBM library that is being used, the optional modules (such as
3318 specific lookup types), the drivers that are included in the binary, and the
3319 name of the run time configuration file that is in use.
3320
3321 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3322 configuration file. However, this is a static check only. It cannot check
3323 values that are to be expanded. For example, although a misspelt ACL verb is
3324 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3325 alone to discover (for example) all the typos in the configuration; some
3326 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3327 dynamic testing facilities.
3328
3329 .vitem &%-bv%&
3330 .oindex "&%-bv%&"
3331 .cindex "verifying address" "using &%-bv%&"
3332 .cindex "address" "verification"
3333 This option runs Exim in address verification mode, in which each argument is
3334 taken as a recipient address to be verified by the routers. (This does
3335 not involve any verification callouts). During normal operation, verification
3336 happens mostly as a consequence processing a &%verify%& condition in an ACL
3337 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3338 including callouts, see the &%-bh%& and &%-bhc%& options.
3339
3340 If verification fails, and the caller is not an admin user, no details of the
3341 failure are output, because these might contain sensitive information such as
3342 usernames and passwords for database lookups.
3343
3344 If no arguments are given, Exim runs in an interactive manner, prompting with a
3345 right angle bracket for addresses to be verified.
3346
3347 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3348 &[readline()]& function, because it is running as &'exim'& and there are
3349 security issues.
3350
3351 Verification differs from address testing (the &%-bt%& option) in that routers
3352 that have &%no_verify%& set are skipped, and if the address is accepted by a
3353 router that has &%fail_verify%& set, verification fails. The address is
3354 verified as a recipient if &%-bv%& is used; to test verification for a sender
3355 address, &%-bvs%& should be used.
3356
3357 If the &%-v%& option is not set, the output consists of a single line for each
3358 address, stating whether it was verified or not, and giving a reason in the
3359 latter case. Without &%-v%&, generating more than one address by redirection
3360 causes verification to end successfully, without considering the generated
3361 addresses. However, if just one address is generated, processing continues,
3362 and the generated address must verify successfully for the overall verification
3363 to succeed.
3364
3365 When &%-v%& is set, more details are given of how the address has been handled,
3366 and in the case of address redirection, all the generated addresses are also
3367 considered. Verification may succeed for some and fail for others.
3368
3369 The
3370 .cindex "return code" "for &%-bv%&"
3371 return code is 2 if any address failed outright; it is 1 if no address
3372 failed outright but at least one could not be resolved for some reason. Return
3373 code 0 is given only when all addresses succeed.
3374
3375 If any of the routers in the configuration makes any tests on the sender
3376 address of a message, you should use the &%-f%& option to set an appropriate
3377 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3378 calling user at the default qualifying domain.
3379
3380 .vitem &%-bvs%&
3381 .oindex "&%-bvs%&"
3382 This option acts like &%-bv%&, but verifies the address as a sender rather
3383 than a recipient address. This affects any rewriting and qualification that
3384 might happen.
3385
3386 .vitem &%-bw%&
3387 .oindex "&%-bw%&"
3388 .cindex "daemon"
3389 .cindex "inetd"
3390 .cindex "inetd" "wait mode"
3391 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3392 similarly to the &%-bd%& option.  All port specifications on the command-line
3393 and in the configuration file are ignored.  Queue-running may not be specified.
3394
3395 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3396 listening for connections.  This permits the system to start up and have
3397 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3398 each port only when the first connection is received.
3399
3400 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3401 which the daemon will exit, which should cause inetd to listen once more.
3402
3403 .vitem &%-C%&&~<&'filelist'&>
3404 .oindex "&%-C%&"
3405 .cindex "configuration file" "alternate"
3406 .cindex "CONFIGURE_FILE"
3407 .cindex "alternate configuration file"
3408 This option causes Exim to find the run time configuration file from the given
3409 list instead of from the list specified by the CONFIGURE_FILE
3410 compile-time setting. Usually, the list will consist of just a single file
3411 name, but it can be a colon-separated list of names. In this case, the first
3412 file that exists is used. Failure to open an existing file stops Exim from
3413 proceeding any further along the list, and an error is generated.
3414
3415 When this option is used by a caller other than root, and the list is different
3416 from the compiled-in list, Exim gives up its root privilege immediately, and
3417 runs with the real and effective uid and gid set to those of the caller.
3418 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3419 file contains a list of full pathnames, one per line, for configuration files
3420 which are trusted. Root privilege is retained for any configuration file so
3421 listed, as long as the caller is the Exim user (or the user specified in the
3422 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3423 not writeable by inappropriate users or groups.
3424
3425 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3426 configuration using &%-C%& right through message reception and delivery,
3427 even if the caller is root. The reception works, but by that time, Exim is
3428 running as the Exim user, so when it re-executes to regain privilege for the
3429 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3430 test reception and delivery using two separate commands (one to put a message
3431 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3432
3433 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3434 prefix string with which any file named in a &%-C%& command line option
3435 must start. In addition, the file name must not contain the sequence &`/../`&.
3436 However, if the value of the &%-C%& option is identical to the value of
3437 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3438 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3439 unset, any file name can be used with &%-C%&.
3440
3441 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3442 to a directory to which only root has access. This prevents someone who has
3443 broken into the Exim account from running a privileged Exim with an arbitrary
3444 configuration file.
3445
3446 The &%-C%& facility is useful for ensuring that configuration files are
3447 syntactically correct, but cannot be used for test deliveries, unless the
3448 caller is privileged, or unless it is an exotic configuration that does not
3449 require privilege. No check is made on the owner or group of the files
3450 specified by this option.
3451
3452
3453 .vitem &%-D%&<&'macro'&>=<&'value'&>
3454 .oindex "&%-D%&"
3455 .cindex "macro" "setting on command line"
3456 This option can be used to override macro definitions in the configuration file
3457 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3458 unprivileged caller, it causes Exim to give up its root privilege.
3459 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3460 completely disabled, and its use causes an immediate error exit.
3461
3462 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3463 colon-separated list of macros which are considered safe and, if &%-D%& only
3464 supplies macros from this list, and the values are acceptable, then Exim will
3465 not give up root privilege if the caller is root, the Exim run-time user, or
3466 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3467 to be removed in the future.  Acceptable values for the macros satisfy the
3468 regexp: &`^[A-Za-z0-9_/.-]*$`&
3469
3470 The entire option (including equals sign if present) must all be within one
3471 command line item. &%-D%& can be used to set the value of a macro to the empty
3472 string, in which case the equals sign is optional. These two commands are
3473 synonymous:
3474 .code
3475 exim -DABC  ...
3476 exim -DABC= ...
3477 .endd
3478 To include spaces in a macro definition item, quotes must be used. If you use
3479 quotes, spaces are permitted around the macro name and the equals sign. For
3480 example:
3481 .code
3482 exim '-D ABC = something' ...
3483 .endd
3484 &%-D%& may be repeated up to 10 times on a command line.
3485
3486
3487 .vitem &%-d%&<&'debug&~options'&>
3488 .oindex "&%-d%&"
3489 .cindex "debugging" "list of selectors"
3490 .cindex "debugging" "&%-d%& option"
3491 This option causes debugging information to be written to the standard
3492 error stream. It is restricted to admin users because debugging output may show
3493 database queries that contain password information. Also, the details of users'
3494 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3495 writes an error message to the standard error stream and exits with a non-zero
3496 return code.
3497
3498 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3499 standard debugging data is output. This can be reduced, or increased to include
3500 some more rarely needed information, by directly following &%-d%& with a string
3501 made up of names preceded by plus or minus characters. These add or remove sets
3502 of debugging data, respectively. For example, &%-d+filter%& adds filter
3503 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3504 no spaces are allowed in the debug setting. The available debugging categories
3505 are:
3506 .display
3507 &`acl            `& ACL interpretation
3508 &`auth           `& authenticators
3509 &`deliver        `& general delivery logic
3510 &`dns            `& DNS lookups (see also resolver)
3511 &`dnsbl          `& DNS black list (aka RBL) code
3512 &`exec           `& arguments for &[execv()]& calls
3513 &`expand         `& detailed debugging for string expansions
3514 &`filter         `& filter handling
3515 &`hints_lookup   `& hints data lookups
3516 &`host_lookup    `& all types of name-to-IP address handling
3517 &`ident          `& ident lookup
3518 &`interface      `& lists of local interfaces
3519 &`lists          `& matching things in lists
3520 &`load           `& system load checks
3521 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3522                     &<<CHAPlocalscan>>&)
3523 &`lookup         `& general lookup code and all lookups
3524 &`memory         `& memory handling
3525 &`pid            `& add pid to debug output lines
3526 &`process_info   `& setting info for the process log
3527 &`queue_run      `& queue runs
3528 &`receive        `& general message reception logic
3529 &`resolver       `& turn on the DNS resolver's debugging output
3530 &`retry          `& retry handling
3531 &`rewrite        `& address rewriting
3532 &`route          `& address routing
3533 &`timestamp      `& add timestamp to debug output lines
3534 &`tls            `& TLS logic
3535 &`transport      `& transports
3536 &`uid            `& changes of uid/gid and looking up uid/gid
3537 &`verify         `& address verification logic
3538 &`all            `& almost all of the above (see below), and also &%-v%&
3539 .endd
3540 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3541 for &`-all`&. The reason for this is that &`+all`& is something that people
3542 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3543 is included, an awful lot of output that is very rarely of interest is
3544 generated, so it now has to be explicitly requested. However, &`-all`& does
3545 turn everything off.
3546
3547 .cindex "resolver, debugging output"
3548 .cindex "DNS resolver, debugging output"
3549 The &`resolver`& option produces output only if the DNS resolver was compiled
3550 with DEBUG enabled. This is not the case in some operating systems. Also,
3551 unfortunately, debugging output from the DNS resolver is written to stdout
3552 rather than stderr.
3553
3554 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3555 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3556 However, the &`pid`& selector is forced when debugging is turned on for a
3557 daemon, which then passes it on to any re-executed Exims. Exim also
3558 automatically adds the pid to debug lines when several remote deliveries are
3559 run in parallel.
3560
3561 The &`timestamp`& selector causes the current time to be inserted at the start
3562 of all debug output lines. This can be useful when trying to track down delays
3563 in processing.
3564
3565 If the &%debug_print%& option is set in any driver, it produces output whenever
3566 any debugging is selected, or if &%-v%& is used.
3567
3568 .vitem &%-dd%&<&'debug&~options'&>
3569 .oindex "&%-dd%&"
3570 This option behaves exactly like &%-d%& except when used on a command that
3571 starts a daemon process. In that case, debugging is turned off for the
3572 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3573 behaviour of the daemon without creating as much output as full debugging does.
3574
3575 .vitem &%-dropcr%&
3576 .oindex "&%-dropcr%&"
3577 This is an obsolete option that is now a no-op. It used to affect the way Exim
3578 handled CR and LF characters in incoming messages. What happens now is
3579 described in section &<<SECTlineendings>>&.
3580
3581 .vitem &%-E%&
3582 .oindex "&%-E%&"
3583 .cindex "bounce message" "generating"
3584 This option specifies that an incoming message is a locally-generated delivery
3585 failure report. It is used internally by Exim when handling delivery failures
3586 and is not intended for external use. Its only effect is to stop Exim
3587 generating certain messages to the postmaster, as otherwise message cascades
3588 could occur in some situations. As part of the same option, a message id may
3589 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3590 new message contains the id, following &"R="&, as a cross-reference.
3591
3592 .vitem &%-e%&&'x'&
3593 .oindex "&%-e%&&'x'&"
3594 There are a number of Sendmail options starting with &%-oe%& which seem to be
3595 called by various programs without the leading &%o%& in the option. For
3596 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3597 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3598
3599 .vitem &%-F%&&~<&'string'&>
3600 .oindex "&%-F%&"
3601 .cindex "sender" "name"
3602 .cindex "name" "of sender"
3603 This option sets the sender's full name for use when a locally-generated
3604 message is being accepted. In the absence of this option, the user's &'gecos'&
3605 entry from the password data is used. As users are generally permitted to alter
3606 their &'gecos'& entries, no security considerations are involved. White space
3607 between &%-F%& and the <&'string'&> is optional.
3608
3609 .vitem &%-f%&&~<&'address'&>
3610 .oindex "&%-f%&"
3611 .cindex "sender" "address"
3612 .cindex "address" "sender"
3613 .cindex "trusted users"
3614 .cindex "envelope sender"
3615 .cindex "user" "trusted"
3616 This option sets the address of the envelope sender of a locally-generated
3617 message (also known as the return path). The option can normally be used only
3618 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3619 users to use it.
3620
3621 Processes running as root or the Exim user are always trusted. Other
3622 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3623 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3624 of a local message is set to the caller's login name at the default qualify
3625 domain.
3626
3627 There is one exception to the restriction on the use of &%-f%&: an empty sender
3628 can be specified by any user, trusted or not, to create a message that can
3629 never provoke a bounce. An empty sender can be specified either as an empty
3630 string, or as a pair of angle brackets with nothing between them, as in these
3631 examples of shell commands:
3632 .code
3633 exim -f '<>' user@domain
3634 exim -f "" user@domain
3635 .endd
3636 In addition, the use of &%-f%& is not restricted when testing a filter file
3637 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3638 &%-bv%& options.
3639
3640 Allowing untrusted users to change the sender address does not of itself make
3641 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3642 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3643 though this can be overridden by setting &%no_local_from_check%&.
3644
3645 White
3646 .cindex "&""From""& line"
3647 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3648 given as two arguments or one combined argument). The sender of a
3649 locally-generated message can also be set (when permitted) by an initial
3650 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3651 if &%-f%& is also present, it overrides &"From&~"&.
3652
3653 .vitem &%-G%&
3654 .oindex "&%-G%&"
3655 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3656 This is a Sendmail option which is ignored by Exim.
3657
3658 .vitem &%-h%&&~<&'number'&>
3659 .oindex "&%-h%&"
3660 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3661 This option is accepted for compatibility with Sendmail, but has no effect. (In
3662 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3663 headers.)
3664
3665 .vitem &%-i%&
3666 .oindex "&%-i%&"
3667 .cindex "Solaris" "&'mail'& command"
3668 .cindex "dot" "in incoming non-SMTP message"
3669 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3670 line by itself should not terminate an incoming, non-SMTP message. I can find
3671 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3672 command in Solaris 2.4 uses it. See also &%-ti%&.
3673
3674 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3675 .oindex "&%-M%&"
3676 .cindex "forcing delivery"
3677 .cindex "delivery" "forcing attempt"
3678 .cindex "frozen messages" "forcing delivery"
3679 This option requests Exim to run a delivery attempt on each message in turn. If
3680 any of the messages are frozen, they are automatically thawed before the
3681 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3682 and &%hold_domains%& are ignored.
3683
3684 Retry
3685 .cindex "hints database" "overriding retry hints"
3686 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3687 the normal retry time has not yet been reached. This option requires the caller
3688 to be an admin user. However, there is an option called &%prod_requires_admin%&
3689 which can be set false to relax this restriction (and also the same requirement
3690 for the &%-q%&, &%-R%&, and &%-S%& options).
3691
3692 The deliveries happen synchronously, that is, the original Exim process does
3693 not terminate until all the delivery attempts have finished. No output is
3694 produced unless there is a serious error. If you want to see what is happening,
3695 use the &%-v%& option as well, or inspect Exim's main log.
3696
3697 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3698 .oindex "&%-Mar%&"
3699 .cindex "message" "adding recipients"
3700 .cindex "recipient" "adding"
3701 This option requests Exim to add the addresses to the list of recipients of the
3702 message (&"ar"& for &"add recipients"&). The first argument must be a message
3703 id, and the remaining ones must be email addresses. However, if the message is
3704 active (in the middle of a delivery attempt), it is not altered. This option
3705 can be used only by an admin user.
3706
3707 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3708         &~<&'message&~id'&>"
3709 .oindex "&%-MC%&"
3710 .cindex "SMTP" "passed connection"
3711 .cindex "SMTP" "multiple deliveries"
3712 .cindex "multiple SMTP deliveries"
3713 This option is not intended for use by external callers. It is used internally
3714 by Exim to invoke another instance of itself to deliver a waiting message using
3715 an existing SMTP connection, which is passed as the standard input. Details are
3716 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3717 must be root or the Exim user in order to use it.
3718
3719 .vitem &%-MCA%&
3720 .oindex "&%-MCA%&"
3721 This option is not intended for use by external callers. It is used internally
3722 by Exim in conjunction with the &%-MC%& option. It signifies that the
3723 connection to the remote host has been authenticated.
3724
3725 .vitem &%-MCP%&
3726 .oindex "&%-MCP%&"
3727 This option is not intended for use by external callers. It is used internally
3728 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3729 which Exim is connected supports pipelining.
3730
3731 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3732 .oindex "&%-MCQ%&"
3733 This option is not intended for use by external callers. It is used internally
3734 by Exim in conjunction with the &%-MC%& option when the original delivery was
3735 started by a queue runner. It passes on the process id of the queue runner,
3736 together with the file descriptor number of an open pipe. Closure of the pipe
3737 signals the final completion of the sequence of processes that are passing
3738 messages through the same SMTP connection.
3739
3740 .vitem &%-MCS%&
3741 .oindex "&%-MCS%&"
3742 This option is not intended for use by external callers. It is used internally
3743 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3744 SMTP SIZE option should be used on messages delivered down the existing
3745 connection.
3746
3747 .vitem &%-MCT%&
3748 .oindex "&%-MCT%&"
3749 This option is not intended for use by external callers. It is used internally
3750 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3751 host to which Exim is connected supports TLS encryption.
3752
3753 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3754 .oindex "&%-Mc%&"
3755 .cindex "hints database" "not overridden by &%-Mc%&"
3756 .cindex "delivery" "manually started &-- not forced"
3757 This option requests Exim to run a delivery attempt on each message in turn,
3758 but unlike the &%-M%& option, it does check for retry hints, and respects any
3759 that are found. This option is not very useful to external callers. It is
3760 provided mainly for internal use by Exim when it needs to re-invoke itself in
3761 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3762 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3763 respects retry times and other options such as &%hold_domains%& that are
3764 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3765 If you want to run a specific delivery as if in a queue run, you should use
3766 &%-q%& with a message id argument. A distinction between queue run deliveries
3767 and other deliveries is made in one or two places.
3768
3769 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3770 .oindex "&%-Mes%&"
3771 .cindex "message" "changing sender"
3772 .cindex "sender" "changing"
3773 This option requests Exim to change the sender address in the message to the
3774 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3775 &"edit sender"&). There must be exactly two arguments. The first argument must
3776 be a message id, and the second one an email address. However, if the message
3777 is active (in the middle of a delivery attempt), its status is not altered.
3778 This option can be used only by an admin user.
3779
3780 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3781 .oindex "&%-Mf%&"
3782 .cindex "freezing messages"
3783 .cindex "message" "manually freezing"
3784 This option requests Exim to mark each listed message as &"frozen"&. This
3785 prevents any delivery attempts taking place until the message is &"thawed"&,
3786 either manually or as a result of the &%auto_thaw%& configuration option.
3787 However, if any of the messages are active (in the middle of a delivery
3788 attempt), their status is not altered. This option can be used only by an admin
3789 user.
3790
3791 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3792 .oindex "&%-Mg%&"
3793 .cindex "giving up on messages"
3794 .cindex "message" "abandoning delivery attempts"
3795 .cindex "delivery" "abandoning further attempts"
3796 This option requests Exim to give up trying to deliver the listed messages,
3797 including any that are frozen. However, if any of the messages are active,
3798 their status is not altered. For non-bounce messages, a delivery error message
3799 is sent to the sender, containing the text &"cancelled by administrator"&.
3800 Bounce messages are just discarded. This option can be used only by an admin
3801 user.
3802
3803 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3804 .oindex "&%-Mmad%&"
3805 .cindex "delivery" "cancelling all"
3806 This option requests Exim to mark all the recipient addresses in the messages
3807 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3808 message is active (in the middle of a delivery attempt), its status is not
3809 altered. This option can be used only by an admin user.
3810
3811 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3812 .oindex "&%-Mmd%&"
3813 .cindex "delivery" "cancelling by address"
3814 .cindex "recipient" "removing"
3815 .cindex "removing recipients"
3816 This option requests Exim to mark the given addresses as already delivered
3817 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3818 the remaining ones must be email addresses. These are matched to recipient
3819 addresses in the message in a case-sensitive manner. If the message is active
3820 (in the middle of a delivery attempt), its status is not altered. This option
3821 can be used only by an admin user.
3822
3823 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3824 .oindex "&%-Mrm%&"
3825 .cindex "removing messages"
3826 .cindex "abandoning mail"
3827 .cindex "message" "manually discarding"
3828 This option requests Exim to remove the given messages from the queue. No
3829 bounce messages are sent; each message is simply forgotten. However, if any of
3830 the messages are active, their status is not altered. This option can be used
3831 only by an admin user or by the user who originally caused the message to be
3832 placed on the queue.
3833
3834 .vitem &%-Mset%&&~<&'message&~id'&>
3835 .oindex "&%-Mset%&
3836 .cindex "testing" "string expansion"
3837 .cindex "expansion" "testing"
3838 This option is useful only in conjunction with &%-be%& (that is, when testing
3839 string expansions). Exim loads the given message from its spool before doing
3840 the test expansions, thus setting message-specific variables such as
3841 &$message_size$& and the header variables. The &$recipients$& variable is made
3842 available. This feature is provided to make it easier to test expansions that
3843 make use of these variables. However, this option can be used only by an admin
3844 user. See also &%-bem%&.
3845
3846 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3847 .oindex "&%-Mt%&"
3848 .cindex "thawing messages"
3849 .cindex "unfreezing messages"
3850 .cindex "frozen messages" "thawing"
3851 .cindex "message" "thawing frozen"
3852 This option requests Exim to &"thaw"& any of the listed messages that are
3853 &"frozen"&, so that delivery attempts can resume. However, if any of the
3854 messages are active, their status is not altered. This option can be used only
3855 by an admin user.
3856
3857 .vitem &%-Mvb%&&~<&'message&~id'&>
3858 .oindex "&%-Mvb%&"
3859 .cindex "listing" "message body"
3860 .cindex "message" "listing body of"
3861 This option causes the contents of the message body (-D) spool file to be
3862 written to the standard output. This option can be used only by an admin user.
3863
3864 .vitem &%-Mvc%&&~<&'message&~id'&>
3865 .oindex "&%-Mvc%&"
3866 .cindex "message" "listing in RFC 2822 format"
3867 .cindex "listing" "message in RFC 2822 format"
3868 This option causes a copy of the complete message (header lines plus body) to
3869 be written to the standard output in RFC 2822 format. This option can be used
3870 only by an admin user.
3871
3872 .vitem &%-Mvh%&&~<&'message&~id'&>
3873 .oindex "&%-Mvh%&"
3874 .cindex "listing" "message headers"
3875 .cindex "header lines" "listing"
3876 .cindex "message" "listing header lines"
3877 This option causes the contents of the message headers (-H) spool file to be
3878 written to the standard output. This option can be used only by an admin user.
3879
3880 .vitem &%-Mvl%&&~<&'message&~id'&>
3881 .oindex "&%-Mvl%&"
3882 .cindex "listing" "message log"
3883 .cindex "message" "listing message log"
3884 This option causes the contents of the message log spool file to be written to
3885 the standard output. This option can be used only by an admin user.
3886
3887 .vitem &%-m%&
3888 .oindex "&%-m%&"
3889 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3890 treats it that way too.
3891
3892 .vitem &%-N%&
3893 .oindex "&%-N%&"
3894 .cindex "debugging" "&%-N%& option"
3895 .cindex "debugging" "suppressing delivery"
3896 This is a debugging option that inhibits delivery of a message at the transport
3897 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3898 it just doesn't actually transport the message, but instead behaves as if it
3899 had successfully done so. However, it does not make any updates to the retry
3900 database, and the log entries for deliveries are flagged with &"*>"& rather
3901 than &"=>"&.
3902
3903 Because &%-N%& discards any message to which it applies, only root or the Exim
3904 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3905 words, an ordinary user can use it only when supplying an incoming message to
3906 which it will apply. Although transportation never fails when &%-N%& is set, an
3907 address may be deferred because of a configuration problem on a transport, or a
3908 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3909 the message, and applies to any subsequent delivery attempts that may happen
3910 for that message.
3911
3912 .vitem &%-n%&
3913 .oindex "&%-n%&"
3914 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3915 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3916 by Exim.
3917
3918 .vitem &%-O%&&~<&'data'&>
3919 .oindex "&%-O%&"
3920 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3921 Exim.
3922
3923 .vitem &%-oA%&&~<&'file&~name'&>
3924 .oindex "&%-oA%&"
3925 .cindex "Sendmail compatibility" "&%-oA%& option"
3926 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3927 alternative alias file name. Exim handles &%-bi%& differently; see the
3928 description above.
3929
3930 .vitem &%-oB%&&~<&'n'&>
3931 .oindex "&%-oB%&"
3932 .cindex "SMTP" "passed connection"
3933 .cindex "SMTP" "multiple deliveries"
3934 .cindex "multiple SMTP deliveries"
3935 This is a debugging option which limits the maximum number of messages that can
3936 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3937 transport. If <&'n'&> is omitted, the limit is set to 1.
3938
3939 .vitem &%-odb%&
3940 .oindex "&%-odb%&"
3941 .cindex "background delivery"
3942 .cindex "delivery" "in the background"
3943 This option applies to all modes in which Exim accepts incoming messages,
3944 including the listening daemon. It requests &"background"& delivery of such
3945 messages, which means that the accepting process automatically starts a
3946 delivery process for each message received, but does not wait for the delivery
3947 processes to finish.
3948
3949 When all the messages have been received, the reception process exits,
3950 leaving the delivery processes to finish in their own time. The standard output
3951 and error streams are closed at the start of each delivery process.
3952 This is the default action if none of the &%-od%& options are present.
3953
3954 If one of the queueing options in the configuration file
3955 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3956 overrides it if &%queue_only_override%& is set true, which is the default
3957 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3958
3959 .vitem &%-odf%&
3960 .oindex "&%-odf%&"
3961 .cindex "foreground delivery"
3962 .cindex "delivery" "in the foreground"
3963 This option requests &"foreground"& (synchronous) delivery when Exim has
3964 accepted a locally-generated message. (For the daemon it is exactly the same as
3965 &%-odb%&.) A delivery process is automatically started to deliver the message,
3966 and Exim waits for it to complete before proceeding.
3967
3968 The original Exim reception process does not finish until the delivery
3969 process for the final message has ended. The standard error stream is left open
3970 during deliveries.
3971
3972 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3973 false and one of the queueing options in the configuration file is in effect.
3974
3975 If there is a temporary delivery error during foreground delivery, the
3976 message is left on the queue for later delivery, and the original reception
3977 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3978 restricted configuration that never queues messages.
3979
3980
3981 .vitem &%-odi%&
3982 .oindex "&%-odi%&"
3983 This option is synonymous with &%-odf%&. It is provided for compatibility with
3984 Sendmail.
3985
3986 .vitem &%-odq%&
3987 .oindex "&%-odq%&"
3988 .cindex "non-immediate delivery"
3989 .cindex "delivery" "suppressing immediate"
3990 .cindex "queueing incoming messages"
3991 This option applies to all modes in which Exim accepts incoming messages,
3992 including the listening daemon. It specifies that the accepting process should
3993 not automatically start a delivery process for each message received. Messages
3994 are placed on the queue, and remain there until a subsequent queue runner
3995 process encounters them. There are several configuration options (such as
3996 &%queue_only%&) that can be used to queue incoming messages under certain
3997 conditions. This option overrides all of them and also &%-odqs%&. It always
3998 forces queueing.
3999
4000 .vitem &%-odqs%&
4001 .oindex "&%-odqs%&"
4002 .cindex "SMTP" "delaying delivery"
4003 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4004 However, like &%-odb%& and &%-odi%&, this option has no effect if
4005 &%queue_only_override%& is false and one of the queueing options in the
4006 configuration file is in effect.
4007
4008 When &%-odqs%& does operate, a delivery process is started for each incoming
4009 message, in the background by default, but in the foreground if &%-odi%& is
4010 also present. The recipient addresses are routed, and local deliveries are done
4011 in the normal way. However, if any SMTP deliveries are required, they are not
4012 done at this time, so the message remains on the queue until a subsequent queue
4013 runner process encounters it. Because routing was done, Exim knows which
4014 messages are waiting for which hosts, and so a number of messages for the same
4015 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4016 configuration option has the same effect for specific domains. See also the
4017 &%-qq%& option.
4018
4019 .vitem &%-oee%&
4020 .oindex "&%-oee%&"
4021 .cindex "error" "reporting"
4022 If an error is detected while a non-SMTP message is being received (for
4023 example, a malformed address), the error is reported to the sender in a mail
4024 message.
4025
4026 .cindex "return code" "for &%-oee%&"
4027 Provided
4028 this error message is successfully sent, the Exim receiving process
4029 exits with a return code of zero. If not, the return code is 2 if the problem
4030 is that the original message has no recipients, or 1 any other error. This is
4031 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4032
4033 .vitem &%-oem%&
4034 .oindex "&%-oem%&"
4035 .cindex "error" "reporting"
4036 .cindex "return code" "for &%-oem%&"
4037 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4038 return code, whether or not the error message was successfully sent.
4039 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4040
4041 .vitem &%-oep%&
4042 .oindex "&%-oep%&"
4043 .cindex "error" "reporting"
4044 If an error is detected while a non-SMTP message is being received, the
4045 error is reported by writing a message to the standard error file (stderr).
4046 .cindex "return code" "for &%-oep%&"
4047 The return code is 1 for all errors.
4048
4049 .vitem &%-oeq%&
4050 .oindex "&%-oeq%&"
4051 .cindex "error" "reporting"
4052 This option is supported for compatibility with Sendmail, but has the same
4053 effect as &%-oep%&.
4054
4055 .vitem &%-oew%&
4056 .oindex "&%-oew%&"
4057 .cindex "error" "reporting"
4058 This option is supported for compatibility with Sendmail, but has the same
4059 effect as &%-oem%&.
4060
4061 .vitem &%-oi%&
4062 .oindex "&%-oi%&"
4063 .cindex "dot" "in incoming non-SMTP message"
4064 This option, which has the same effect as &%-i%&, specifies that a dot on a
4065 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4066 single dot does terminate, though Exim does no special processing for other
4067 lines that start with a dot. This option is set by default if Exim is called as
4068 &'rmail'&. See also &%-ti%&.
4069
4070 .vitem &%-oitrue%&
4071 .oindex "&%-oitrue%&"
4072 This option is treated as synonymous with &%-oi%&.
4073
4074 .vitem &%-oMa%&&~<&'host&~address'&>
4075 .oindex "&%-oMa%&"
4076 .cindex "sender" "host address, specifying for local message"
4077 A number of options starting with &%-oM%& can be used to set values associated
4078 with remote hosts on locally-submitted messages (that is, messages not received
4079 over TCP/IP). These options can be used by any caller in conjunction with the
4080 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4081 other circumstances, they are ignored unless the caller is trusted.
4082
4083 The &%-oMa%& option sets the sender host address. This may include a port
4084 number at the end, after a full stop (period). For example:
4085 .code
4086 exim -bs -oMa 10.9.8.7.1234
4087 .endd
4088 An alternative syntax is to enclose the IP address in square brackets,
4089 followed by a colon and the port number:
4090 .code
4091 exim -bs -oMa [10.9.8.7]:1234
4092 .endd
4093 The IP address is placed in the &$sender_host_address$& variable, and the
4094 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4095 are present on the command line, the sender host IP address is taken from
4096 whichever one is last.
4097
4098 .vitem &%-oMaa%&&~<&'name'&>
4099 .oindex "&%-oMaa%&"
4100 .cindex "authentication" "name, specifying for local message"
4101 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4102 option sets the value of &$sender_host_authenticated$& (the authenticator
4103 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4104 This option can be used with &%-bh%& and &%-bs%& to set up an
4105 authenticated SMTP session without actually using the SMTP AUTH command.
4106
4107 .vitem &%-oMai%&&~<&'string'&>
4108 .oindex "&%-oMai%&"
4109 .cindex "authentication" "id, specifying for local message"
4110 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4111 option sets the value of &$authenticated_id$& (the id that was authenticated).
4112 This overrides the default value (the caller's login id, except with &%-bh%&,
4113 where there is no default) for messages from local sources. See chapter
4114 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4115
4116 .vitem &%-oMas%&&~<&'address'&>
4117 .oindex "&%-oMas%&"
4118 .cindex "authentication" "sender, specifying for local message"
4119 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4120 option sets the authenticated sender value in &$authenticated_sender$&. It
4121 overrides the sender address that is created from the caller's login id for
4122 messages from local sources, except when &%-bh%& is used, when there is no
4123 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4124 specified on a MAIL command overrides this value. See chapter
4125 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4126
4127 .vitem &%-oMi%&&~<&'interface&~address'&>
4128 .oindex "&%-oMi%&"
4129 .cindex "interface" "address, specifying for local message"
4130 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4131 option sets the IP interface address value. A port number may be included,
4132 using the same syntax as for &%-oMa%&. The interface address is placed in
4133 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4134
4135 .vitem &%-oMr%&&~<&'protocol&~name'&>
4136 .oindex "&%-oMr%&"
4137 .cindex "protocol, specifying for local message"
4138 .vindex "&$received_protocol$&"
4139 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4140 option sets the received protocol value that is stored in
4141 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4142 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4143 SMTP protocol names (see the description of &$received_protocol$& in section
4144 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4145 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4146 be set by &%-oMr%&.
4147
4148 .vitem &%-oMs%&&~<&'host&~name'&>
4149 .oindex "&%-oMs%&"
4150 .cindex "sender" "host name, specifying for local message"
4151 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4152 option sets the sender host name in &$sender_host_name$&. When this option is
4153 present, Exim does not attempt to look up a host name from an IP address; it
4154 uses the name it is given.
4155
4156 .vitem &%-oMt%&&~<&'ident&~string'&>
4157 .oindex "&%-oMt%&"
4158 .cindex "sender" "ident string, specifying for local message"
4159 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4160 option sets the sender ident value in &$sender_ident$&. The default setting for
4161 local callers is the login id of the calling process, except when &%-bh%& is
4162 used, when there is no default.
4163
4164 .vitem &%-om%&
4165 .oindex "&%-om%&"
4166 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4167 In Sendmail, this option means &"me too"&, indicating that the sender of a
4168 message should receive a copy of the message if the sender appears in an alias
4169 expansion. Exim always does this, so the option does nothing.
4170
4171 .vitem &%-oo%&
4172 .oindex "&%-oo%&"
4173 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4174 This option is ignored. In Sendmail it specifies &"old style headers"&,
4175 whatever that means.
4176
4177 .vitem &%-oP%&&~<&'path'&>
4178 .oindex "&%-oP%&"
4179 .cindex "pid (process id)" "of daemon"
4180 .cindex "daemon" "process id (pid)"
4181 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4182 value. The option specifies the file to which the process id of the daemon is
4183 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4184 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4185 because in those cases, the normal pid file is not used.
4186
4187 .vitem &%-or%&&~<&'time'&>
4188 .oindex "&%-or%&"
4189 .cindex "timeout" "for non-SMTP input"
4190 This option sets a timeout value for incoming non-SMTP messages. If it is not
4191 set, Exim will wait forever for the standard input. The value can also be set
4192 by the &%receive_timeout%& option. The format used for specifying times is
4193 described in section &<<SECTtimeformat>>&.
4194
4195 .vitem &%-os%&&~<&'time'&>
4196 .oindex "&%-os%&"
4197 .cindex "timeout" "for SMTP input"
4198 .cindex "SMTP" "input timeout"
4199 This option sets a timeout value for incoming SMTP messages. The timeout
4200 applies to each SMTP command and block of data. The value can also be set by
4201 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4202 for specifying times is described in section &<<SECTtimeformat>>&.
4203
4204 .vitem &%-ov%&
4205 .oindex "&%-ov%&"
4206 This option has exactly the same effect as &%-v%&.
4207
4208 .vitem &%-oX%&&~<&'number&~or&~string'&>
4209 .oindex "&%-oX%&"
4210 .cindex "TCP/IP" "setting listening ports"
4211 .cindex "TCP/IP" "setting listening interfaces"
4212 .cindex "port" "receiving TCP/IP"
4213 This option is relevant only when the &%-bd%& (start listening daemon) option
4214 is also given. It controls which ports and interfaces the daemon uses. Details
4215 of the syntax, and how it interacts with configuration file options, are given
4216 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4217 file is written unless &%-oP%& is also present to specify a pid file name.
4218
4219 .vitem &%-pd%&
4220 .oindex "&%-pd%&"
4221 .cindex "Perl" "starting the interpreter"
4222 This option applies when an embedded Perl interpreter is linked with Exim (see
4223 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4224 option, forcing the starting of the interpreter to be delayed until it is
4225 needed.
4226
4227 .vitem &%-ps%&
4228 .oindex "&%-ps%&"
4229 .cindex "Perl" "starting the interpreter"
4230 This option applies when an embedded Perl interpreter is linked with Exim (see
4231 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4232 option, forcing the starting of the interpreter to occur as soon as Exim is
4233 started.
4234
4235 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4236 .oindex "&%-p%&"
4237 For compatibility with Sendmail, this option is equivalent to
4238 .display
4239 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4240 .endd
4241 It sets the incoming protocol and host name (for trusted callers). The
4242 host name and its colon can be omitted when only the protocol is to be set.
4243 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4244 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4245 or &`s`& using this option (but that does not seem a real limitation).
4246
4247 .vitem &%-q%&
4248 .oindex "&%-q%&"
4249 .cindex "queue runner" "starting manually"
4250 This option is normally restricted to admin users. However, there is a
4251 configuration option called &%prod_requires_admin%& which can be set false to
4252 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4253 and &%-S%& options).
4254
4255 .cindex "queue runner" "description of operation"
4256 The &%-q%& option starts one queue runner process. This scans the queue of
4257 waiting messages, and runs a delivery process for each one in turn. It waits
4258 for each delivery process to finish before starting the next one. A delivery
4259 process may not actually do any deliveries if the retry times for the addresses
4260 have not been reached. Use &%-qf%& (see below) if you want to override this.
4261
4262 If
4263 .cindex "SMTP" "passed connection"
4264 .cindex "SMTP" "multiple deliveries"
4265 .cindex "multiple SMTP deliveries"
4266 the delivery process spawns other processes to deliver other messages down
4267 passed SMTP connections, the queue runner waits for these to finish before
4268 proceeding.
4269
4270 When all the queued messages have been considered, the original queue runner
4271 process terminates. In other words, a single pass is made over the waiting
4272 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4273 this to be repeated periodically.
4274
4275 Exim processes the waiting messages in an unpredictable order. It isn't very
4276 random, but it is likely to be different each time, which is all that matters.
4277 If one particular message screws up a remote MTA, other messages to the same
4278 MTA have a chance of getting through if they get tried first.
4279
4280 It is possible to cause the messages to be processed in lexical message id
4281 order, which is essentially the order in which they arrived, by setting the
4282 &%queue_run_in_order%& option, but this is not recommended for normal use.
4283
4284 .vitem &%-q%&<&'qflags'&>
4285 The &%-q%& option may be followed by one or more flag letters that change its
4286 behaviour. They are all optional, but if more than one is present, they must
4287 appear in the correct order. Each flag is described in a separate item below.
4288
4289 .vitem &%-qq...%&
4290 .oindex "&%-qq%&"
4291 .cindex "queue" "double scanning"
4292 .cindex "queue" "routing"
4293 .cindex "routing" "whole queue before delivery"
4294 An option starting with &%-qq%& requests a two-stage queue run. In the first
4295 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4296 every domain. Addresses are routed, local deliveries happen, but no remote
4297 transports are run.
4298
4299 .cindex "hints database" "remembering routing"
4300 The hints database that remembers which messages are waiting for specific hosts
4301 is updated, as if delivery to those hosts had been deferred. After this is
4302 complete, a second, normal queue scan happens, with routing and delivery taking
4303 place as normal. Messages that are routed to the same host should mostly be
4304 delivered down a single SMTP
4305 .cindex "SMTP" "passed connection"
4306 .cindex "SMTP" "multiple deliveries"
4307 .cindex "multiple SMTP deliveries"
4308 connection because of the hints that were set up during the first queue scan.
4309 This option may be useful for hosts that are connected to the Internet
4310 intermittently.
4311
4312 .vitem &%-q[q]i...%&
4313 .oindex "&%-qi%&"
4314 .cindex "queue" "initial delivery"
4315 If the &'i'& flag is present, the queue runner runs delivery processes only for
4316 those messages that haven't previously been tried. (&'i'& stands for &"initial
4317 delivery"&.) This can be helpful if you are putting messages on the queue using
4318 &%-odq%& and want a queue runner just to process the new messages.
4319
4320 .vitem &%-q[q][i]f...%&
4321 .oindex "&%-qf%&"
4322 .cindex "queue" "forcing delivery"
4323 .cindex "delivery" "forcing in queue run"
4324 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4325 message, whereas without &'f'& only those non-frozen addresses that have passed
4326 their retry times are tried.
4327
4328 .vitem &%-q[q][i]ff...%&
4329 .oindex "&%-qff%&"
4330 .cindex "frozen messages" "forcing delivery"
4331 If &'ff'& is present, a delivery attempt is forced for every message, whether
4332 frozen or not.
4333
4334 .vitem &%-q[q][i][f[f]]l%&
4335 .oindex "&%-ql%&"
4336 .cindex "queue" "local deliveries only"
4337 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4338 be done. If a message requires any remote deliveries, it remains on the queue
4339 for later delivery.
4340
4341 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4342 .cindex "queue" "delivering specific messages"
4343 When scanning the queue, Exim can be made to skip over messages whose ids are
4344 lexically less than a given value by following the &%-q%& option with a
4345 starting message id. For example:
4346 .code
4347 exim -q 0t5C6f-0000c8-00
4348 .endd
4349 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4350 second message id is given, messages whose ids are lexically greater than it
4351 are also skipped. If the same id is given twice, for example,
4352 .code
4353 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4354 .endd
4355 just one delivery process is started, for that message. This differs from
4356 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4357 that it counts as a delivery from a queue run. Note that the selection
4358 mechanism does not affect the order in which the messages are scanned. There
4359 are also other ways of selecting specific sets of messages for delivery in a
4360 queue run &-- see &%-R%& and &%-S%&.
4361
4362 .vitem &%-q%&<&'qflags'&><&'time'&>
4363 .cindex "queue runner" "starting periodically"
4364 .cindex "periodic queue running"
4365 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4366 starting a queue runner process at intervals specified by the given time value
4367 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4368 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4369 single daemon process handles both functions. A common way of starting up a
4370 combined daemon at system boot time is to use a command such as
4371 .code
4372 /usr/exim/bin/exim -bd -q30m
4373 .endd
4374 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4375 process every 30 minutes.
4376
4377 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4378 pid file is written unless one is explicitly requested by the &%-oP%& option.
4379
4380 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4381 .oindex "&%-qR%&"
4382 This option is synonymous with &%-R%&. It is provided for Sendmail
4383 compatibility.
4384
4385 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4386 .oindex "&%-qS%&"
4387 This option is synonymous with &%-S%&.
4388
4389 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4390 .oindex "&%-R%&"
4391 .cindex "queue runner" "for specific recipients"
4392 .cindex "delivery" "to given domain"
4393 .cindex "domain" "delivery to"
4394 The <&'rsflags'&> may be empty, in which case the white space before the string
4395 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4396 which are the possible values for <&'rsflags'&>. White space is required if
4397 <&'rsflags'&> is not empty.
4398
4399 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4400 perform a single queue run, except that, when scanning the messages on the
4401 queue, Exim processes only those that have at least one undelivered recipient
4402 address containing the given string, which is checked in a case-independent
4403 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4404 regular expression; otherwise it is a literal string.
4405
4406 If you want to do periodic queue runs for messages with specific recipients,
4407 you can combine &%-R%& with &%-q%& and a time value. For example:
4408 .code
4409 exim -q25m -R @special.domain.example
4410 .endd
4411 This example does a queue run for messages with recipients in the given domain
4412 every 25 minutes. Any additional flags that are specified with &%-q%& are
4413 applied to each queue run.
4414
4415 Once a message is selected for delivery by this mechanism, all its addresses
4416 are processed. For the first selected message, Exim overrides any retry
4417 information and forces a delivery attempt for each undelivered address. This
4418 means that if delivery of any address in the first message is successful, any
4419 existing retry information is deleted, and so delivery attempts for that
4420 address in subsequently selected messages (which are processed without forcing)
4421 will run. However, if delivery of any address does not succeed, the retry
4422 information is updated, and in subsequently selected messages, the failing
4423 address will be skipped.
4424
4425 .cindex "frozen messages" "forcing delivery"
4426 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4427 all selected messages, not just the first; frozen messages are included when
4428 &'ff'& is present.
4429
4430 The &%-R%& option makes it straightforward to initiate delivery of all messages
4431 to a given domain after a host has been down for some time. When the SMTP
4432 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4433 effect is to run Exim with the &%-R%& option, but it can be configured to run
4434 an arbitrary command instead.
4435
4436 .vitem &%-r%&
4437 .oindex "&%-r%&"
4438 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4439
4440 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4441 .oindex "&%-S%&"
4442 .cindex "delivery" "from given sender"
4443 .cindex "queue runner" "for specific senders"
4444 This option acts like &%-R%& except that it checks the string against each
4445 message's sender instead of against the recipients. If &%-R%& is also set, both
4446 conditions must be met for a message to be selected. If either of the options
4447 has &'f'& or &'ff'& in its flags, the associated action is taken.
4448
4449 .vitem &%-Tqt%&&~<&'times'&>
4450 .oindex "&%-Tqt%&"
4451 This an option that is exclusively for use by the Exim testing suite. It is not
4452 recognized when Exim is run normally. It allows for the setting up of explicit
4453 &"queue times"& so that various warning/retry features can be tested.
4454
4455 .vitem &%-t%&
4456 .oindex "&%-t%&"
4457 .cindex "recipient" "extracting from header lines"
4458 .cindex "&'Bcc:'& header line"
4459 .cindex "&'Cc:'& header line"
4460 .cindex "&'To:'& header line"
4461 When Exim is receiving a locally-generated, non-SMTP message on its standard
4462 input, the &%-t%& option causes the recipients of the message to be obtained
4463 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4464 from the command arguments. The addresses are extracted before any rewriting
4465 takes place and the &'Bcc:'& header line, if present, is then removed.
4466
4467 .cindex "Sendmail compatibility" "&%-t%& option"
4468 If the command has any arguments, they specify addresses to which the message
4469 is &'not'& to be delivered. That is, the argument addresses are removed from
4470 the recipients list obtained from the headers. This is compatible with Smail 3
4471 and in accordance with the documented behaviour of several versions of
4472 Sendmail, as described in man pages on a number of operating systems (e.g.
4473 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4474 argument addresses to those obtained from the headers, and the O'Reilly
4475 Sendmail book documents it that way. Exim can be made to add argument addresses
4476 instead of subtracting them by setting the option
4477 &%extract_addresses_remove_arguments%& false.
4478
4479 .cindex "&%Resent-%& header lines" "with &%-t%&"
4480 If there are any &%Resent-%& header lines in the message, Exim extracts
4481 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4482 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4483 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4484 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4485
4486 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4487 message is resent several times). The RFC also specifies that they should be
4488 added at the front of the message, and separated by &'Received:'& lines. It is
4489 not at all clear how &%-t%& should operate in the present of multiple sets,
4490 nor indeed exactly what constitutes a &"set"&.
4491 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4492 are often added at the end of the header, and if a message is resent more than
4493 once, it is common for the original set of &%Resent-%& headers to be renamed as
4494 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4495
4496 .vitem &%-ti%&
4497 .oindex "&%-ti%&"
4498 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4499 compatibility with Sendmail.
4500
4501 .vitem &%-tls-on-connect%&
4502 .oindex "&%-tls-on-connect%&"
4503 .cindex "TLS" "use without STARTTLS"
4504 .cindex "TLS" "automatic start"
4505 This option is available when Exim is compiled with TLS support. It forces all
4506 incoming SMTP connections to behave as if the incoming port is listed in the
4507 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4508 &<<CHAPTLS>>& for further details.
4509
4510
4511 .vitem &%-U%&
4512 .oindex "&%-U%&"
4513 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4514 Sendmail uses this option for &"initial message submission"&, and its
4515 documentation states that in future releases, it may complain about
4516 syntactically invalid messages rather than fixing them when this flag is not
4517 set. Exim ignores this option.
4518
4519 .vitem &%-v%&
4520 .oindex "&%-v%&"
4521 This option causes Exim to write information to the standard error stream,
4522 describing what it is doing. In particular, it shows the log lines for
4523 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4524 dialogue is shown. Some of the log lines shown may not actually be written to
4525 the log if the setting of &%log_selector%& discards them. Any relevant
4526 selectors are shown with each log line. If none are shown, the logging is
4527 unconditional.
4528
4529 .vitem &%-x%&
4530 .oindex "&%-x%&"
4531 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4532 National Language Support extended characters in the body of the mail item"&).
4533 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4534 this option.
4535 .endlist
4536
4537 .ecindex IIDclo1
4538 .ecindex IIDclo2
4539
4540
4541 . ////////////////////////////////////////////////////////////////////////////
4542 . Insert a stylized DocBook comment here, to identify the end of the command
4543 . line options. This is for the benefit of the Perl script that automatically
4544 . creates a man page for the options.
4545 . ////////////////////////////////////////////////////////////////////////////
4546
4547 .literal xml
4548 <!-- === End of command line options === -->
4549 .literal off
4550
4551
4552
4553
4554
4555 . ////////////////////////////////////////////////////////////////////////////
4556 . ////////////////////////////////////////////////////////////////////////////
4557
4558
4559 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4560          "The runtime configuration file"
4561
4562 .cindex "run time configuration"
4563 .cindex "configuration file" "general description"
4564 .cindex "CONFIGURE_FILE"
4565 .cindex "configuration file" "errors in"
4566 .cindex "error" "in configuration file"
4567 .cindex "return code" "for bad configuration"
4568 Exim uses a single run time configuration file that is read whenever an Exim
4569 binary is executed. Note that in normal operation, this happens frequently,
4570 because Exim is designed to operate in a distributed manner, without central
4571 control.
4572
4573 If a syntax error is detected while reading the configuration file, Exim
4574 writes a message on the standard error, and exits with a non-zero return code.
4575 The message is also written to the panic log. &*Note*&: Only simple syntax
4576 errors can be detected at this time. The values of any expanded options are
4577 not checked until the expansion happens, even when the expansion does not
4578 actually alter the string.
4579
4580 The name of the configuration file is compiled into the binary for security
4581 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4582 most configurations, this specifies a single file. However, it is permitted to
4583 give a colon-separated list of file names, in which case Exim uses the first
4584 existing file in the list.
4585
4586 .cindex "EXIM_USER"
4587 .cindex "EXIM_GROUP"
4588 .cindex "CONFIGURE_OWNER"
4589 .cindex "CONFIGURE_GROUP"
4590 .cindex "configuration file" "ownership"
4591 .cindex "ownership" "configuration file"
4592 The run time configuration file must be owned by root or by the user that is
4593 specified at compile time by the CONFIGURE_OWNER option (if set). The
4594 configuration file must not be world-writeable, or group-writeable unless its
4595 group is the root group or the one specified at compile time by the
4596 CONFIGURE_GROUP option.
4597
4598 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4599 to root, anybody who is able to edit the run time configuration file has an
4600 easy way to run commands as root. If you specify a user or group in the
4601 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4602 who are members of that group will trivially be able to obtain root privileges.
4603
4604 Up to Exim version 4.72, the run time configuration file was also permitted to
4605 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4606 since it offered a simple privilege escalation for any attacker who managed to
4607 compromise the Exim user account.
4608
4609 A default configuration file, which will work correctly in simple situations,
4610 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4611 defines just one file name, the installation process copies the default
4612 configuration to a new file of that name if it did not previously exist. If
4613 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4614 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4615 configuration.
4616
4617
4618
4619 .section "Using a different configuration file" "SECID40"
4620 .cindex "configuration file" "alternate"
4621 A one-off alternate configuration can be specified by the &%-C%& command line
4622 option, which may specify a single file or a list of files. However, when
4623 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4624 unless the argument for &%-C%& is identical to the built-in value from
4625 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4626 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4627 is useful mainly for checking the syntax of configuration files before
4628 installing them. No owner or group checks are done on a configuration file
4629 specified by &%-C%&, if root privilege has been dropped.
4630
4631 Even the Exim user is not trusted to specify an arbitrary configuration file
4632 with the &%-C%& option to be used with root privileges, unless that file is
4633 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4634 testing a configuration using &%-C%& right through message reception and
4635 delivery, even if the caller is root. The reception works, but by that time,
4636 Exim is running as the Exim user, so when it re-execs to regain privilege for
4637 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4638 can test reception and delivery using two separate commands (one to put a
4639 message on the queue, using &%-odq%&, and another to do the delivery, using
4640 &%-M%&).
4641
4642 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4643 prefix string with which any file named in a &%-C%& command line option must
4644 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4645 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4646 name can be used with &%-C%&.
4647
4648 One-off changes to a configuration can be specified by the &%-D%& command line
4649 option, which defines and overrides values for macros used inside the
4650 configuration file. However, like &%-C%&, the use of this option by a
4651 non-privileged user causes Exim to discard its root privilege.
4652 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4653 completely disabled, and its use causes an immediate error exit.
4654
4655 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4656 to declare certain macro names trusted, such that root privilege will not
4657 necessarily be discarded.
4658 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4659 considered safe and, if &%-D%& only supplies macros from this list, and the
4660 values are acceptable, then Exim will not give up root privilege if the caller
4661 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4662 transition mechanism and is expected to be removed in the future.  Acceptable
4663 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4664
4665 Some sites may wish to use the same Exim binary on different machines that
4666 share a file system, but to use different configuration files on each machine.
4667 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4668 looks for a file whose name is the configuration file name followed by a dot
4669 and the machine's node name, as obtained from the &[uname()]& function. If this
4670 file does not exist, the standard name is tried. This processing occurs for
4671 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4672
4673 In some esoteric situations different versions of Exim may be run under
4674 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4675 help with this. See the comments in &_src/EDITME_& for details.
4676
4677
4678
4679 .section "Configuration file format" "SECTconffilfor"
4680 .cindex "configuration file" "format of"
4681 .cindex "format" "configuration file"
4682 Exim's configuration file is divided into a number of different parts. General
4683 option settings must always appear at the start of the file. The other parts
4684 are all optional, and may appear in any order. Each part other than the first
4685 is introduced by the word &"begin"& followed by the name of the part. The
4686 optional parts are:
4687
4688 .ilist
4689 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4690 &<<CHAPACL>>&).
4691 .next
4692 .cindex "AUTH" "configuration"
4693 &'authenticators'&: Configuration settings for the authenticator drivers. These
4694 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4695 .next
4696 &'routers'&: Configuration settings for the router drivers. Routers process
4697 addresses and determine how the message is to be delivered (see chapters
4698 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4699 .next
4700 &'transports'&: Configuration settings for the transport drivers. Transports
4701 define mechanisms for copying messages to destinations (see chapters
4702 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4703 .next
4704 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4705 If there is no retry section, or if it is empty (that is, no retry rules are
4706 defined), Exim will not retry deliveries. In this situation, temporary errors
4707 are treated the same as permanent errors. Retry rules are discussed in chapter
4708 &<<CHAPretry>>&.
4709 .next
4710 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4711 when new addresses are generated during delivery. Rewriting is discussed in
4712 chapter &<<CHAPrewrite>>&.
4713 .next
4714 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4715 want to use this feature, you must set
4716 .code
4717 LOCAL_SCAN_HAS_OPTIONS=yes
4718 .endd
4719 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4720 facility are given in chapter &<<CHAPlocalscan>>&.
4721 .endlist
4722
4723 .cindex "configuration file" "leading white space in"
4724 .cindex "configuration file" "trailing white space in"
4725 .cindex "white space" "in configuration file"
4726 Leading and trailing white space in configuration lines is always ignored.
4727
4728 Blank lines in the file, and lines starting with a # character (ignoring
4729 leading white space) are treated as comments and are ignored. &*Note*&: A
4730 # character other than at the beginning of a line is not treated specially,
4731 and does not introduce a comment.
4732
4733 Any non-comment line can be continued by ending it with a backslash. Note that
4734 the general rule for white space means that trailing white space after the
4735 backslash and leading white space at the start of continuation
4736 lines is ignored. Comment lines beginning with # (but not empty lines) may
4737 appear in the middle of a sequence of continuation lines.
4738
4739 A convenient way to create a configuration file is to start from the
4740 default, which is supplied in &_src/configure.default_&, and add, delete, or
4741 change settings as required.
4742
4743 The ACLs, retry rules, and rewriting rules have their own syntax which is
4744 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4745 respectively. The other parts of the configuration file have some syntactic
4746 items in common, and these are described below, from section &<<SECTcos>>&
4747 onwards. Before that, the inclusion, macro, and conditional facilities are
4748 described.
4749
4750
4751
4752 .section "File inclusions in the configuration file" "SECID41"
4753 .cindex "inclusions in configuration file"
4754 .cindex "configuration file" "including other files"
4755 .cindex "&`.include`& in configuration file"
4756 .cindex "&`.include_if_exists`& in configuration file"
4757 You can include other files inside Exim's run time configuration file by
4758 using this syntax:
4759 .display
4760 &`.include`& <&'file name'&>
4761 &`.include_if_exists`& <&'file name'&>
4762 .endd
4763 on a line by itself. Double quotes round the file name are optional. If you use
4764 the first form, a configuration error occurs if the file does not exist; the
4765 second form does nothing for non-existent files. In all cases, an absolute file
4766 name is required.
4767
4768 Includes may be nested to any depth, but remember that Exim reads its
4769 configuration file often, so it is a good idea to keep them to a minimum.
4770 If you change the contents of an included file, you must HUP the daemon,
4771 because an included file is read only when the configuration itself is read.
4772
4773 The processing of inclusions happens early, at a physical line level, so, like
4774 comment lines, an inclusion can be used in the middle of an option setting,
4775 for example:
4776 .code
4777 hosts_lookup = a.b.c \
4778                .include /some/file
4779 .endd
4780 Include processing happens after macro processing (see below). Its effect is to
4781 process the lines of the included file as if they occurred inline where the
4782 inclusion appears.
4783
4784
4785
4786 .section "Macros in the configuration file" "SECTmacrodefs"
4787 .cindex "macro" "description of"
4788 .cindex "configuration file" "macros"
4789 If a line in the main part of the configuration (that is, before the first
4790 &"begin"& line) begins with an upper case letter, it is taken as a macro
4791 definition, and must be of the form
4792 .display
4793 <&'name'&> = <&'rest of line'&>
4794 .endd
4795 The name must consist of letters, digits, and underscores, and need not all be
4796 in upper case, though that is recommended. The rest of the line, including any
4797 continuations, is the replacement text, and has leading and trailing white
4798 space removed. Quotes are not removed. The replacement text can never end with
4799 a backslash character, but this doesn't seem to be a serious limitation.
4800
4801 Macros may also be defined between router, transport, authenticator, or ACL
4802 definitions. They may not, however, be defined within an individual driver or
4803 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4804
4805 .section "Macro substitution" "SECID42"
4806 Once a macro is defined, all subsequent lines in the file (and any included
4807 files) are scanned for the macro name; if there are several macros, the line is
4808 scanned for each in turn, in the order in which the macros are defined. The
4809 replacement text is not re-scanned for the current macro, though it is scanned
4810 for subsequently defined macros. For this reason, a macro name may not contain
4811 the name of a previously defined macro as a substring. You could, for example,
4812 define
4813 .display
4814 &`ABCD_XYZ = `&<&'something'&>
4815 &`ABCD = `&<&'something else'&>
4816 .endd
4817 but putting the definitions in the opposite order would provoke a configuration
4818 error. Macro expansion is applied to individual physical lines from the file,
4819 before checking for line continuation or file inclusion (see above). If a line
4820 consists solely of a macro name, and the expansion of the macro is empty, the
4821 line is ignored. A macro at the start of a line may turn the line into a
4822 comment line or a &`.include`& line.
4823
4824
4825 .section "Redefining macros" "SECID43"
4826 Once defined, the value of a macro can be redefined later in the configuration
4827 (or in an included file). Redefinition is specified by using &'=='& instead of
4828 &'='&. For example:
4829 .code
4830 MAC =  initial value
4831 ...
4832 MAC == updated value
4833 .endd
4834 Redefinition does not alter the order in which the macros are applied to the
4835 subsequent lines of the configuration file. It is still the same order in which
4836 the macros were originally defined. All that changes is the macro's value.
4837 Redefinition makes it possible to accumulate values. For example:
4838 .code
4839 MAC =  initial value
4840 ...
4841 MAC == MAC and something added
4842 .endd
4843 This can be helpful in situations where the configuration file is built
4844 from a number of other files.
4845
4846 .section "Overriding macro values" "SECID44"
4847 The values set for macros in the configuration file can be overridden by the
4848 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4849 used, unless called by root or the Exim user. A definition on the command line
4850 using the &%-D%& option causes all definitions and redefinitions within the
4851 file to be ignored.
4852
4853
4854
4855 .section "Example of macro usage" "SECID45"
4856 As an example of macro usage, consider a configuration where aliases are looked
4857 up in a MySQL database. It helps to keep the file less cluttered if long
4858 strings such as SQL statements are defined separately as macros, for example:
4859 .code
4860 ALIAS_QUERY = select mailbox from user where \
4861               login='${quote_mysql:$local_part}';
4862 .endd
4863 This can then be used in a &(redirect)& router setting like this:
4864 .code
4865 data = ${lookup mysql{ALIAS_QUERY}}
4866 .endd
4867 In earlier versions of Exim macros were sometimes used for domain, host, or
4868 address lists. In Exim 4 these are handled better by named lists &-- see
4869 section &<<SECTnamedlists>>&.
4870
4871
4872 .section "Conditional skips in the configuration file" "SECID46"
4873 .cindex "configuration file" "conditional skips"
4874 .cindex "&`.ifdef`&"
4875 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4876 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4877 portions of the configuration file. The processing happens whenever the file is
4878 read (that is, when an Exim binary starts to run).
4879
4880 The implementation is very simple. Instances of the first four directives must
4881 be followed by text that includes the names of one or macros. The condition
4882 that is tested is whether or not any macro substitution has taken place in the
4883 line. Thus:
4884 .code
4885 .ifdef AAA
4886 message_size_limit = 50M
4887 .else
4888 message_size_limit = 100M
4889 .endif
4890 .endd
4891 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4892 otherwise. If there is more than one macro named on the line, the condition
4893 is true if any of them are defined. That is, it is an &"or"& condition. To
4894 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4895
4896 Although you can use a macro expansion to generate one of these directives,
4897 it is not very useful, because the condition &"there was a macro substitution
4898 in this line"& will always be true.
4899
4900 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4901 to clarify complicated nestings.
4902
4903
4904
4905 .section "Common option syntax" "SECTcos"
4906 .cindex "common option syntax"
4907 .cindex "syntax of common options"
4908 .cindex "configuration file" "common option syntax"
4909 For the main set of options, driver options, and &[local_scan()]& options,
4910 each setting is on a line by itself, and starts with a name consisting of
4911 lower-case letters and underscores. Many options require a data value, and in
4912 these cases the name must be followed by an equals sign (with optional white
4913 space) and then the value. For example:
4914 .code
4915 qualify_domain = mydomain.example.com
4916 .endd
4917 .cindex "hiding configuration option values"
4918 .cindex "configuration options" "hiding value of"
4919 .cindex "options" "hiding value of"
4920 Some option settings may contain sensitive data, for example, passwords for
4921 accessing databases. To stop non-admin users from using the &%-bP%& command
4922 line option to read these values, you can precede the option settings with the
4923 word &"hide"&. For example:
4924 .code
4925 hide mysql_servers = localhost/users/admin/secret-password
4926 .endd
4927 For non-admin users, such options are displayed like this:
4928 .code
4929 mysql_servers = <value not displayable>
4930 .endd
4931 If &"hide"& is used on a driver option, it hides the value of that option on
4932 all instances of the same driver.
4933
4934 The following sections describe the syntax used for the different data types
4935 that are found in option settings.
4936
4937
4938 .section "Boolean options" "SECID47"
4939 .cindex "format" "boolean"
4940 .cindex "boolean configuration values"
4941 .oindex "&%no_%&&'xxx'&"
4942 .oindex "&%not_%&&'xxx'&"
4943 Options whose type is given as boolean are on/off switches. There are two
4944 different ways of specifying such options: with and without a data value. If
4945 the option name is specified on its own without data, the switch is turned on;
4946 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4947 boolean options may be followed by an equals sign and one of the words
4948 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4949 the following two settings have exactly the same effect:
4950 .code
4951 queue_only
4952 queue_only = true
4953 .endd
4954 The following two lines also have the same (opposite) effect:
4955 .code
4956 no_queue_only
4957 queue_only = false
4958 .endd
4959 You can use whichever syntax you prefer.
4960
4961
4962
4963
4964 .section "Integer values" "SECID48"
4965 .cindex "integer configuration values"
4966 .cindex "format" "integer"
4967 If an option's type is given as &"integer"&, the value can be given in decimal,
4968 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4969 number is assumed. Otherwise, it is treated as an octal number unless it starts
4970 with the characters &"0x"&, in which case the remainder is interpreted as a
4971 hexadecimal number.
4972
4973 If an integer value is followed by the letter K, it is multiplied by 1024; if
4974 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4975 of integer option settings are output, values which are an exact multiple of
4976 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4977 and M. The printing style is independent of the actual input format that was
4978 used.
4979
4980
4981 .section "Octal integer values" "SECID49"
4982 .cindex "integer format"
4983 .cindex "format" "octal integer"
4984 If an option's type is given as &"octal integer"&, its value is always
4985 interpreted as an octal number, whether or not it starts with the digit zero.
4986 Such options are always output in octal.
4987
4988
4989 .section "Fixed point numbers" "SECID50"
4990 .cindex "fixed point configuration values"
4991 .cindex "format" "fixed point"
4992 If an option's type is given as &"fixed-point"&, its value must be a decimal
4993 integer, optionally followed by a decimal point and up to three further digits.
4994
4995
4996
4997 .section "Time intervals" "SECTtimeformat"
4998 .cindex "time interval" "specifying in configuration"
4999 .cindex "format" "time interval"
5000 A time interval is specified as a sequence of numbers, each followed by one of
5001 the following letters, with no intervening white space:
5002
5003 .table2 30pt
5004 .irow &%s%& seconds
5005 .irow &%m%& minutes
5006 .irow &%h%& hours
5007 .irow &%d%& days
5008 .irow &%w%& weeks
5009 .endtable
5010
5011 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5012 intervals are output in the same format. Exim does not restrict the values; it
5013 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5014
5015
5016
5017 .section "String values" "SECTstrings"
5018 .cindex "string" "format of configuration values"
5019 .cindex "format" "string"
5020 If an option's type is specified as &"string"&, the value can be specified with
5021 or without double-quotes. If it does not start with a double-quote, the value
5022 consists of the remainder of the line plus any continuation lines, starting at
5023 the first character after any leading white space, with trailing white space
5024 removed, and with no interpretation of the characters in the string. Because
5025 Exim removes comment lines (those beginning with #) at an early stage, they can
5026 appear in the middle of a multi-line string. The following two settings are
5027 therefore equivalent:
5028 .code
5029 trusted_users = uucp:mail
5030 trusted_users = uucp:\
5031                 # This comment line is ignored
5032                 mail
5033 .endd
5034 .cindex "string" "quoted"
5035 .cindex "escape characters in quoted strings"
5036 If a string does start with a double-quote, it must end with a closing
5037 double-quote, and any backslash characters other than those used for line
5038 continuation are interpreted as escape characters, as follows:
5039
5040 .table2 100pt
5041 .irow &`\\`&                     "single backslash"
5042 .irow &`\n`&                     "newline"
5043 .irow &`\r`&                     "carriage return"
5044 .irow &`\t`&                     "tab"
5045 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5046 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5047                                    character"
5048 .endtable
5049
5050 If a backslash is followed by some other character, including a double-quote
5051 character, that character replaces the pair.
5052
5053 Quoting is necessary only if you want to make use of the backslash escapes to
5054 insert special characters, or if you need to specify a value with leading or
5055 trailing spaces. These cases are rare, so quoting is almost never needed in
5056 current versions of Exim. In versions of Exim before 3.14, quoting was required
5057 in order to continue lines, so you may come across older configuration files
5058 and examples that apparently quote unnecessarily.
5059
5060
5061 .section "Expanded strings" "SECID51"
5062 .cindex "expansion" "definition of"
5063 Some strings in the configuration file are subjected to &'string expansion'&,
5064 by which means various parts of the string may be changed according to the
5065 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5066 is as just described; in particular, the handling of backslashes in quoted
5067 strings is done as part of the input process, before expansion takes place.
5068 However, backslash is also an escape character for the expander, so any
5069 backslashes that are required for that reason must be doubled if they are
5070 within a quoted configuration string.
5071
5072
5073 .section "User and group names" "SECID52"
5074 .cindex "user name" "format of"
5075 .cindex "format" "user name"
5076 .cindex "groups" "name format"
5077 .cindex "format" "group name"
5078 User and group names are specified as strings, using the syntax described
5079 above, but the strings are interpreted specially. A user or group name must
5080 either consist entirely of digits, or be a name that can be looked up using the
5081 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5082
5083
5084 .section "List construction" "SECTlistconstruct"
5085 .cindex "list" "syntax of in configuration"
5086 .cindex "format" "list item in configuration"
5087 .cindex "string" "list, definition of"
5088 The data for some configuration options is a list of items, with colon as the
5089 default separator. Many of these options are shown with type &"string list"& in
5090 the descriptions later in this document. Others are listed as &"domain list"&,
5091 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5092 are all the same; however, those other than &"string list"& are subject to
5093 particular kinds of interpretation, as described in chapter
5094 &<<CHAPdomhosaddlists>>&.
5095
5096 In all these cases, the entire list is treated as a single string as far as the
5097 input syntax is concerned. The &%trusted_users%& setting in section
5098 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5099 in a list, it must be entered as two colons. Leading and trailing white space
5100 on each item in a list is ignored. This makes it possible to include items that
5101 start with a colon, and in particular, certain forms of IPv6 address. For
5102 example, the list
5103 .code
5104 local_interfaces = 127.0.0.1 : ::::1
5105 .endd
5106 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5107
5108 &*Note*&: Although leading and trailing white space is ignored in individual
5109 list items, it is not ignored when parsing the list. The space after the first
5110 colon in the example above is necessary. If it were not there, the list would
5111 be interpreted as the two items 127.0.0.1:: and 1.
5112
5113 .section "Changing list separators" "SECID53"
5114 .cindex "list separator" "changing"
5115 .cindex "IPv6" "addresses in lists"
5116 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5117 introduced to allow the separator character to be changed. If a list begins
5118 with a left angle bracket, followed by any punctuation character, that
5119 character is used instead of colon as the list separator. For example, the list
5120 above can be rewritten to use a semicolon separator like this:
5121 .code
5122 local_interfaces = <; 127.0.0.1 ; ::1
5123 .endd
5124 This facility applies to all lists, with the exception of the list in
5125 &%log_file_path%&. It is recommended that the use of non-colon separators be
5126 confined to circumstances where they really are needed.
5127
5128 .cindex "list separator" "newline as"
5129 .cindex "newline" "as list separator"
5130 It is also possible to use newline and other control characters (those with
5131 code values less than 32, plus DEL) as separators in lists. Such separators
5132 must be provided literally at the time the list is processed. For options that
5133 are string-expanded, you can write the separator using a normal escape
5134 sequence. This will be processed by the expander before the string is
5135 interpreted as a list. For example, if a newline-separated list of domains is
5136 generated by a lookup, you can process it directly by a line such as this:
5137 .code
5138 domains = <\n ${lookup mysql{.....}}
5139 .endd
5140 This avoids having to change the list separator in such data. You are unlikely
5141 to want to use a control character as a separator in an option that is not
5142 expanded, because the value is literal text. However, it can be done by giving
5143 the value in quotes. For example:
5144 .code
5145 local_interfaces = "<\n 127.0.0.1 \n ::1"
5146 .endd
5147 Unlike printing character separators, which can be included in list items by
5148 doubling, it is not possible to include a control character as data when it is
5149 set as the separator. Two such characters in succession are interpreted as
5150 enclosing an empty list item.
5151
5152
5153
5154 .section "Empty items in lists" "SECTempitelis"
5155 .cindex "list" "empty item in"
5156 An empty item at the end of a list is always ignored. In other words, trailing
5157 separator characters are ignored. Thus, the list in
5158 .code
5159 senders = user@domain :
5160 .endd
5161 contains only a single item. If you want to include an empty string as one item
5162 in a list, it must not be the last item. For example, this list contains three
5163 items, the second of which is empty:
5164 .code
5165 senders = user1@domain : : user2@domain
5166 .endd
5167 &*Note*&: There must be white space between the two colons, as otherwise they
5168 are interpreted as representing a single colon data character (and the list
5169 would then contain just one item). If you want to specify a list that contains
5170 just one, empty item, you can do it as in this example:
5171 .code
5172 senders = :
5173 .endd
5174 In this case, the first item is empty, and the second is discarded because it
5175 is at the end of the list.
5176
5177
5178
5179
5180 .section "Format of driver configurations" "SECTfordricon"
5181 .cindex "drivers" "configuration format"
5182 There are separate parts in the configuration for defining routers, transports,
5183 and authenticators. In each part, you are defining a number of driver
5184 instances, each with its own set of options. Each driver instance is defined by
5185 a sequence of lines like this:
5186 .display
5187 <&'instance name'&>:
5188   <&'option'&>
5189   ...
5190   <&'option'&>
5191 .endd
5192 In the following example, the instance name is &(localuser)&, and it is
5193 followed by three options settings:
5194 .code
5195 localuser:
5196   driver = accept
5197   check_local_user
5198   transport = local_delivery
5199 .endd
5200 For each driver instance, you specify which Exim code module it uses &-- by the
5201 setting of the &%driver%& option &-- and (optionally) some configuration
5202 settings. For example, in the case of transports, if you want a transport to
5203 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5204 a local file you would use the &(appendfile)& driver. Each of the drivers is
5205 described in detail in its own separate chapter later in this manual.
5206
5207 You can have several routers, transports, or authenticators that are based on
5208 the same underlying driver (each must have a different instance name).
5209
5210 The order in which routers are defined is important, because addresses are
5211 passed to individual routers one by one, in order. The order in which
5212 transports are defined does not matter at all. The order in which
5213 authenticators are defined is used only when Exim, as a client, is searching
5214 them to find one that matches an authentication mechanism offered by the
5215 server.
5216
5217 .cindex "generic options"
5218 .cindex "options" "generic &-- definition of"
5219 Within a driver instance definition, there are two kinds of option: &'generic'&
5220 and &'private'&. The generic options are those that apply to all drivers of the
5221 same type (that is, all routers, all transports or all authenticators). The
5222 &%driver%& option is a generic option that must appear in every definition.
5223 .cindex "private options"
5224 The private options are special for each driver, and none need appear, because
5225 they all have default values.
5226
5227 The options may appear in any order, except that the &%driver%& option must
5228 precede any private options, since these depend on the particular driver. For
5229 this reason, it is recommended that &%driver%& always be the first option.
5230
5231 Driver instance names, which are used for reference in log entries and
5232 elsewhere, can be any sequence of letters, digits, and underscores (starting
5233 with a letter) and must be unique among drivers of the same type. A router and
5234 a transport (for example) can each have the same name, but no two router
5235 instances can have the same name. The name of a driver instance should not be
5236 confused with the name of the underlying driver module. For example, the
5237 configuration lines:
5238 .code
5239 remote_smtp:
5240   driver = smtp
5241 .endd
5242 create an instance of the &(smtp)& transport driver whose name is
5243 &(remote_smtp)&. The same driver code can be used more than once, with
5244 different instance names and different option settings each time. A second
5245 instance of the &(smtp)& transport, with different options, might be defined
5246 thus:
5247 .code
5248 special_smtp:
5249   driver = smtp
5250   port = 1234
5251   command_timeout = 10s
5252 .endd
5253 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5254 these transport instances from routers, and these names would appear in log
5255 lines.
5256
5257 Comment lines may be present in the middle of driver specifications. The full
5258 list of option settings for any particular driver instance, including all the
5259 defaulted values, can be extracted by making use of the &%-bP%& command line
5260 option.
5261
5262
5263
5264
5265
5266
5267 . ////////////////////////////////////////////////////////////////////////////
5268 . ////////////////////////////////////////////////////////////////////////////
5269
5270 .chapter "The default configuration file" "CHAPdefconfil"
5271 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5272 .cindex "default" "configuration file &""walk through""&"
5273 The default configuration file supplied with Exim as &_src/configure.default_&
5274 is sufficient for a host with simple mail requirements. As an introduction to
5275 the way Exim is configured, this chapter &"walks through"& the default
5276 configuration, giving brief explanations of the settings. Detailed descriptions
5277 of the options are given in subsequent chapters. The default configuration file
5278 itself contains extensive comments about ways you might want to modify the
5279 initial settings. However, note that there are many options that are not
5280 mentioned at all in the default configuration.
5281
5282
5283
5284 .section "Main configuration settings" "SECTdefconfmain"
5285 The main (global) configuration option settings must always come first in the
5286 file. The first thing you'll see in the file, after some initial comments, is
5287 the line
5288 .code
5289 # primary_hostname =
5290 .endd
5291 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5292 to know the official, fully qualified name of your host, and this is where you
5293 can specify it. However, in most cases you do not need to set this option. When
5294 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5295
5296 The first three non-comment configuration lines are as follows:
5297 .code
5298 domainlist local_domains = @
5299 domainlist relay_to_domains =
5300 hostlist   relay_from_hosts = 127.0.0.1
5301 .endd
5302 These are not, in fact, option settings. They are definitions of two named
5303 domain lists and one named host list. Exim allows you to give names to lists of
5304 domains, hosts, and email addresses, in order to make it easier to manage the
5305 configuration file (see section &<<SECTnamedlists>>&).
5306
5307 The first line defines a domain list called &'local_domains'&; this is used
5308 later in the configuration to identify domains that are to be delivered
5309 on the local host.
5310
5311 .cindex "@ in a domain list"
5312 There is just one item in this list, the string &"@"&. This is a special form
5313 of entry which means &"the name of the local host"&. Thus, if the local host is
5314 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5315 be delivered locally. Because the local host's name is referenced indirectly,
5316 the same configuration file can be used on different hosts.
5317
5318 The second line defines a domain list called &'relay_to_domains'&, but the
5319 list itself is empty. Later in the configuration we will come to the part that
5320 controls mail relaying through the local host; it allows relaying to any
5321 domains in this list. By default, therefore, no relaying on the basis of a mail
5322 domain is permitted.
5323
5324 The third line defines a host list called &'relay_from_hosts'&. This list is
5325 used later in the configuration to permit relaying from any host or IP address
5326 that matches the list. The default contains just the IP address of the IPv4
5327 loopback interface, which means that processes on the local host are able to
5328 submit mail for relaying by sending it over TCP/IP to that interface. No other
5329 hosts are permitted to submit messages for relaying.
5330
5331 Just to be sure there's no misunderstanding: at this point in the configuration
5332 we aren't actually setting up any controls. We are just defining some domains
5333 and hosts that will be used in the controls that are specified later.
5334
5335 The next two configuration lines are genuine option settings:
5336 .code
5337 acl_smtp_rcpt = acl_check_rcpt
5338 acl_smtp_data = acl_check_data
5339 .endd
5340 These options specify &'Access Control Lists'& (ACLs) that are to be used
5341 during an incoming SMTP session for every recipient of a message (every RCPT
5342 command), and after the contents of the message have been received,
5343 respectively. The names of the lists are &'acl_check_rcpt'& and
5344 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5345 section of the configuration. The RCPT ACL controls which recipients are
5346 accepted for an incoming message &-- if a configuration does not provide an ACL
5347 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5348 contents of a message to be checked.
5349
5350 Two commented-out option settings are next:
5351 .code
5352 # av_scanner = clamd:/tmp/clamd
5353 # spamd_address = 127.0.0.1 783
5354 .endd
5355 These are example settings that can be used when Exim is compiled with the
5356 content-scanning extension. The first specifies the interface to the virus
5357 scanner, and the second specifies the interface to SpamAssassin. Further
5358 details are given in chapter &<<CHAPexiscan>>&.
5359
5360 Three more commented-out option settings follow:
5361 .code
5362 # tls_advertise_hosts = *
5363 # tls_certificate = /etc/ssl/exim.crt
5364 # tls_privatekey = /etc/ssl/exim.pem
5365 .endd
5366 These are example settings that can be used when Exim is compiled with
5367 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5368 first one specifies the list of clients that are allowed to use TLS when
5369 connecting to this server; in this case the wildcard means all clients. The
5370 other options specify where Exim should find its TLS certificate and private
5371 key, which together prove the server's identity to any clients that connect.
5372 More details are given in chapter &<<CHAPTLS>>&.
5373
5374 Another two commented-out option settings follow:
5375 .code
5376 # daemon_smtp_ports = 25 : 465 : 587
5377 # tls_on_connect_ports = 465
5378 .endd
5379 .cindex "port" "465 and 587"
5380 .cindex "port" "for message submission"
5381 .cindex "message" "submission, ports for"
5382 .cindex "ssmtp protocol"
5383 .cindex "smtps protocol"
5384 .cindex "SMTP" "ssmtp protocol"
5385 .cindex "SMTP" "smtps protocol"
5386 These options provide better support for roaming users who wish to use this
5387 server for message submission. They are not much use unless you have turned on
5388 TLS (as described in the previous paragraph) and authentication (about which
5389 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5390 on end-user networks, so RFC 4409 specifies that message submission should use
5391 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5392 configured to use port 587 correctly, so these settings also enable the
5393 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5394 &<<SECTsupobssmt>>&).
5395
5396 Two more commented-out options settings follow:
5397 .code
5398 # qualify_domain =
5399 # qualify_recipient =
5400 .endd
5401 The first of these specifies a domain that Exim uses when it constructs a
5402 complete email address from a local login name. This is often needed when Exim
5403 receives a message from a local process. If you do not set &%qualify_domain%&,
5404 the value of &%primary_hostname%& is used. If you set both of these options,
5405 you can have different qualification domains for sender and recipient
5406 addresses. If you set only the first one, its value is used in both cases.
5407
5408 .cindex "domain literal" "recognizing format"
5409 The following line must be uncommented if you want Exim to recognize
5410 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5411 (an IP address within square brackets) instead of a named domain.
5412 .code
5413 # allow_domain_literals
5414 .endd
5415 The RFCs still require this form, but many people think that in the modern
5416 Internet it makes little sense to permit mail to be sent to specific hosts by
5417 quoting their IP addresses. This ancient format has been used by people who
5418 try to abuse hosts by using them for unwanted relaying. However, some
5419 people believe there are circumstances (for example, messages addressed to
5420 &'postmaster'&) where domain literals are still useful.
5421
5422 The next configuration line is a kind of trigger guard:
5423 .code
5424 never_users = root
5425 .endd
5426 It specifies that no delivery must ever be run as the root user. The normal
5427 convention is to set up &'root'& as an alias for the system administrator. This
5428 setting is a guard against slips in the configuration.
5429 The list of users specified by &%never_users%& is not, however, the complete
5430 list; the build-time configuration in &_Local/Makefile_& has an option called
5431 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5432 contents of &%never_users%& are added to this list. By default
5433 FIXED_NEVER_USERS also specifies root.
5434
5435 When a remote host connects to Exim in order to send mail, the only information
5436 Exim has about the host's identity is its IP address. The next configuration
5437 line,
5438 .code
5439 host_lookup = *
5440 .endd
5441 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5442 in order to get a host name. This improves the quality of the logging
5443 information, but if you feel it is too expensive, you can remove it entirely,
5444 or restrict the lookup to hosts on &"nearby"& networks.
5445 Note that it is not always possible to find a host name from an IP address,
5446 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5447 unreachable.
5448
5449 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5450 1413 (hence their names):
5451 .code
5452 rfc1413_hosts = *
5453 rfc1413_query_timeout = 5s
5454 .endd
5455 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5456 You can limit the hosts to which these calls are made, or change the timeout
5457 that is used. If you set the timeout to zero, all ident calls are disabled.
5458 Although they are cheap and can provide useful information for tracing problem
5459 messages, some hosts and firewalls have problems with ident calls. This can
5460 result in a timeout instead of an immediate refused connection, leading to
5461 delays on starting up an incoming SMTP session.
5462
5463 When Exim receives messages over SMTP connections, it expects all addresses to
5464 be fully qualified with a domain, as required by the SMTP definition. However,
5465 if you are running a server to which simple clients submit messages, you may
5466 find that they send unqualified addresses. The two commented-out options:
5467 .code
5468 # sender_unqualified_hosts =
5469 # recipient_unqualified_hosts =
5470 .endd
5471 show how you can specify hosts that are permitted to send unqualified sender
5472 and recipient addresses, respectively.
5473
5474 The &%percent_hack_domains%& option is also commented out:
5475 .code
5476 # percent_hack_domains =
5477 .endd
5478 It provides a list of domains for which the &"percent hack"& is to operate.
5479 This is an almost obsolete form of explicit email routing. If you do not know
5480 anything about it, you can safely ignore this topic.
5481
5482 The last two settings in the main part of the default configuration are
5483 concerned with messages that have been &"frozen"& on Exim's queue. When a
5484 message is frozen, Exim no longer continues to try to deliver it. Freezing
5485 occurs when a bounce message encounters a permanent failure because the sender
5486 address of the original message that caused the bounce is invalid, so the
5487 bounce cannot be delivered. This is probably the most common case, but there
5488 are also other conditions that cause freezing, and frozen messages are not
5489 always bounce messages.
5490 .code
5491 ignore_bounce_errors_after = 2d
5492 timeout_frozen_after = 7d
5493 .endd
5494 The first of these options specifies that failing bounce messages are to be
5495 discarded after 2 days on the queue. The second specifies that any frozen
5496 message (whether a bounce message or not) is to be timed out (and discarded)
5497 after a week. In this configuration, the first setting ensures that no failing
5498 bounce message ever lasts a week.
5499
5500
5501
5502 .section "ACL configuration" "SECID54"
5503 .cindex "default" "ACLs"
5504 .cindex "&ACL;" "default configuration"
5505 In the default configuration, the ACL section follows the main configuration.
5506 It starts with the line
5507 .code
5508 begin acl
5509 .endd
5510 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5511 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5512 and &%acl_smtp_data%& above.
5513
5514 .cindex "RCPT" "ACL for"
5515 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5516 RCPT command specifies one of the message's recipients. The ACL statements
5517 are considered in order, until the recipient address is either accepted or
5518 rejected. The RCPT command is then accepted or rejected, according to the
5519 result of the ACL processing.
5520 .code
5521 acl_check_rcpt:
5522 .endd
5523 This line, consisting of a name terminated by a colon, marks the start of the
5524 ACL, and names it.
5525 .code
5526 accept  hosts = :
5527 .endd
5528 This ACL statement accepts the recipient if the sending host matches the list.
5529 But what does that strange list mean? It doesn't actually contain any host
5530 names or IP addresses. The presence of the colon puts an empty item in the
5531 list; Exim matches this only if the incoming message did not come from a remote
5532 host, because in that case, the remote hostname is empty. The colon is
5533 important. Without it, the list itself is empty, and can never match anything.
5534
5535 What this statement is doing is to accept unconditionally all recipients in
5536 messages that are submitted by SMTP from local processes using the standard
5537 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5538 manner.
5539 .code
5540 deny    message       = Restricted characters in address
5541         domains       = +local_domains
5542         local_parts   = ^[.] : ^.*[@%!/|]
5543
5544 deny    message       = Restricted characters in address
5545         domains       = !+local_domains
5546         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5547 .endd
5548 These statements are concerned with local parts that contain any of the
5549 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5550 Although these characters are entirely legal in local parts (in the case of
5551 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5552 in Internet mail addresses.
5553
5554 The first three have in the past been associated with explicitly routed
5555 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5556 option). Addresses containing these characters are regularly tried by spammers
5557 in an attempt to bypass relaying restrictions, and also by open relay testing
5558 programs. Unless you really need them it is safest to reject these characters
5559 at this early stage. This configuration is heavy-handed in rejecting these
5560 characters for all messages it accepts from remote hosts. This is a deliberate
5561 policy of being as safe as possible.
5562
5563 The first rule above is stricter, and is applied to messages that are addressed
5564 to one of the local domains handled by this host. This is implemented by the
5565 first condition, which restricts it to domains that are listed in the
5566 &'local_domains'& domain list. The &"+"& character is used to indicate a
5567 reference to a named list. In this configuration, there is just one domain in
5568 &'local_domains'&, but in general there may be many.
5569
5570 The second condition on the first statement uses two regular expressions to
5571 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5572 or &"|"&. If you have local accounts that include these characters, you will
5573 have to modify this rule.
5574
5575 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5576 allows them because they have been encountered in practice. (Consider the
5577 common convention of local parts constructed as
5578 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5579 the author of Exim, who has no second initial.) However, a local part starting
5580 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5581 file name (for example, for a mailing list). This is also true for local parts
5582 that contain slashes. A pipe symbol can also be troublesome if the local part
5583 is incorporated unthinkingly into a shell command line.
5584
5585 The second rule above applies to all other domains, and is less strict. This
5586 allows your own users to send outgoing messages to sites that use slashes
5587 and vertical bars in their local parts. It blocks local parts that begin
5588 with a dot, slash, or vertical bar, but allows these characters within the
5589 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5590 and &"!"& is blocked, as before. The motivation here is to prevent your users
5591 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5592 .code
5593 accept  local_parts   = postmaster
5594         domains       = +local_domains
5595 .endd
5596 This statement, which has two conditions, accepts an incoming address if the
5597 local part is &'postmaster'& and the domain is one of those listed in the
5598 &'local_domains'& domain list. The &"+"& character is used to indicate a
5599 reference to a named list. In this configuration, there is just one domain in
5600 &'local_domains'&, but in general there may be many.
5601
5602 The presence of this statement means that mail to postmaster is never blocked
5603 by any of the subsequent tests. This can be helpful while sorting out problems
5604 in cases where the subsequent tests are incorrectly denying access.
5605 .code
5606 require verify        = sender
5607 .endd
5608 This statement requires the sender address to be verified before any subsequent
5609 ACL statement can be used. If verification fails, the incoming recipient
5610 address is refused. Verification consists of trying to route the address, to
5611 see if a bounce message could be delivered to it. In the case of remote
5612 addresses, basic verification checks only the domain, but &'callouts'& can be
5613 used for more verification if required. Section &<<SECTaddressverification>>&
5614 discusses the details of address verification.
5615 .code
5616 accept  hosts         = +relay_from_hosts
5617         control       = submission
5618 .endd
5619 This statement accepts the address if the message is coming from one of the
5620 hosts that are defined as being allowed to relay through this host. Recipient
5621 verification is omitted here, because in many cases the clients are dumb MUAs
5622 that do not cope well with SMTP error responses. For the same reason, the
5623 second line specifies &"submission mode"& for messages that are accepted. This
5624 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5625 messages that are deficient in some way, for example, because they lack a
5626 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5627 probably add recipient verification here, and disable submission mode.
5628 .code
5629 accept  authenticated = *
5630         control       = submission
5631 .endd
5632 This statement accepts the address if the client host has authenticated itself.
5633 Submission mode is again specified, on the grounds that such messages are most
5634 likely to come from MUAs. The default configuration does not define any
5635 authenticators, though it does include some nearly complete commented-out
5636 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5637 fact authenticate until you complete the authenticator definitions.
5638 .code
5639 require message = relay not permitted
5640         domains = +local_domains : +relay_domains
5641 .endd
5642 This statement rejects the address if its domain is neither a local domain nor
5643 one of the domains for which this host is a relay.
5644 .code
5645 require verify = recipient
5646 .endd
5647 This statement requires the recipient address to be verified; if verification
5648 fails, the address is rejected.
5649 .code
5650 # deny    message     = rejected because $sender_host_address \
5651 #                       is in a black list at $dnslist_domain\n\
5652 #                       $dnslist_text
5653 #         dnslists    = black.list.example
5654 #
5655 # warn    dnslists    = black.list.example
5656 #         add_header  = X-Warning: $sender_host_address is in \
5657 #                       a black list at $dnslist_domain
5658 #         log_message = found in $dnslist_domain
5659 .endd
5660 These commented-out lines are examples of how you could configure Exim to check
5661 sending hosts against a DNS black list. The first statement rejects messages
5662 from blacklisted hosts, whereas the second just inserts a warning header
5663 line.
5664 .code
5665 # require verify = csa
5666 .endd
5667 This commented-out line is an example of how you could turn on client SMTP
5668 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5669 records.
5670 .code
5671 accept
5672 .endd
5673 The final statement in the first ACL unconditionally accepts any recipient
5674 address that has successfully passed all the previous tests.
5675 .code
5676 acl_check_data:
5677 .endd
5678 This line marks the start of the second ACL, and names it. Most of the contents
5679 of this ACL are commented out:
5680 .code
5681 # deny    malware   = *
5682 #         message   = This message contains a virus \
5683 #                     ($malware_name).
5684 .endd
5685 These lines are examples of how to arrange for messages to be scanned for
5686 viruses when Exim has been compiled with the content-scanning extension, and a
5687 suitable virus scanner is installed. If the message is found to contain a
5688 virus, it is rejected with the given custom error message.
5689 .code
5690 # warn    spam      = nobody
5691 #         message   = X-Spam_score: $spam_score\n\
5692 #                     X-Spam_score_int: $spam_score_int\n\
5693 #                     X-Spam_bar: $spam_bar\n\
5694 #                     X-Spam_report: $spam_report
5695 .endd
5696 These lines are an example of how to arrange for messages to be scanned by
5697 SpamAssassin when Exim has been compiled with the content-scanning extension,
5698 and SpamAssassin has been installed. The SpamAssassin check is run with
5699 &`nobody`& as its user parameter, and the results are added to the message as a
5700 series of extra header line. In this case, the message is not rejected,
5701 whatever the spam score.
5702 .code
5703 accept
5704 .endd
5705 This final line in the DATA ACL accepts the message unconditionally.
5706
5707
5708 .section "Router configuration" "SECID55"
5709 .cindex "default" "routers"
5710 .cindex "routers" "default"
5711 The router configuration comes next in the default configuration, introduced
5712 by the line
5713 .code
5714 begin routers
5715 .endd
5716 Routers are the modules in Exim that make decisions about where to send
5717 messages. An address is passed to each router in turn, until it is either
5718 accepted, or failed. This means that the order in which you define the routers
5719 matters. Each router is fully described in its own chapter later in this
5720 manual. Here we give only brief overviews.
5721 .code
5722 # domain_literal:
5723 #   driver = ipliteral
5724 #   domains = !+local_domains
5725 #   transport = remote_smtp
5726 .endd
5727 .cindex "domain literal" "default router"
5728 This router is commented out because the majority of sites do not want to
5729 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5730 you uncomment this router, you also need to uncomment the setting of
5731 &%allow_domain_literals%& in the main part of the configuration.
5732 .code
5733 dnslookup:
5734   driver = dnslookup
5735   domains = ! +local_domains
5736   transport = remote_smtp
5737   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5738   no_more
5739 .endd
5740 The first uncommented router handles addresses that do not involve any local
5741 domains. This is specified by the line
5742 .code
5743 domains = ! +local_domains
5744 .endd
5745 The &%domains%& option lists the domains to which this router applies, but the
5746 exclamation mark is a negation sign, so the router is used only for domains
5747 that are not in the domain list called &'local_domains'& (which was defined at
5748 the start of the configuration). The plus sign before &'local_domains'&
5749 indicates that it is referring to a named list. Addresses in other domains are
5750 passed on to the following routers.
5751
5752 The name of the router driver is &(dnslookup)&,
5753 and is specified by the &%driver%& option. Do not be confused by the fact that
5754 the name of this router instance is the same as the name of the driver. The
5755 instance name is arbitrary, but the name set in the &%driver%& option must be
5756 one of the driver modules that is in the Exim binary.
5757
5758 The &(dnslookup)& router routes addresses by looking up their domains in the
5759 DNS in order to obtain a list of hosts to which the address is routed. If the
5760 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5761 specified by the &%transport%& option. If the router does not find the domain
5762 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5763 the address fails and is bounced.
5764
5765 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5766 be entirely ignored. This option is present because a number of cases have been
5767 encountered where MX records in the DNS point to host names
5768 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5769 Completely ignoring these IP addresses causes Exim to fail to route the
5770 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5771 continue to try to deliver the message periodically until the address timed
5772 out.
5773 .code
5774 system_aliases:
5775   driver = redirect
5776   allow_fail
5777   allow_defer
5778   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5779 # user = exim
5780   file_transport = address_file
5781   pipe_transport = address_pipe
5782 .endd
5783 Control reaches this and subsequent routers only for addresses in the local
5784 domains. This router checks to see whether the local part is defined as an
5785 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5786 data that it looks up from that file. If no data is found for the local part,
5787 the value of the &%data%& option is empty, causing the address to be passed to
5788 the next router.
5789
5790 &_/etc/aliases_& is a conventional name for the system aliases file that is
5791 often used. That is why it is referenced by from the default configuration
5792 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5793 &_Local/Makefile_& before building Exim.
5794 .code
5795 userforward:
5796   driver = redirect
5797   check_local_user
5798 # local_part_suffix = +* : -*
5799 # local_part_suffix_optional
5800   file = $home/.forward
5801 # allow_filter
5802   no_verify
5803   no_expn
5804   check_ancestor
5805   file_transport = address_file
5806   pipe_transport = address_pipe
5807   reply_transport = address_reply
5808 .endd
5809 This is the most complicated router in the default configuration. It is another
5810 redirection router, but this time it is looking for forwarding data set up by
5811 individual users. The &%check_local_user%& setting specifies a check that the
5812 local part of the address is the login name of a local user. If it is not, the
5813 router is skipped. The two commented options that follow &%check_local_user%&,
5814 namely:
5815 .code
5816 # local_part_suffix = +* : -*
5817 # local_part_suffix_optional
5818 .endd
5819 .vindex "&$local_part_suffix$&"
5820 show how you can specify the recognition of local part suffixes. If the first
5821 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5822 by any sequence of characters, is removed from the local part and placed in the
5823 variable &$local_part_suffix$&. The second suffix option specifies that the
5824 presence of a suffix in the local part is optional. When a suffix is present,
5825 the check for a local login uses the local part with the suffix removed.
5826
5827 When a local user account is found, the file called &_.forward_& in the user's
5828 home directory is consulted. If it does not exist, or is empty, the router
5829 declines. Otherwise, the contents of &_.forward_& are interpreted as
5830 redirection data (see chapter &<<CHAPredirect>>& for more details).
5831
5832 .cindex "Sieve filter" "enabling in default router"
5833 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5834 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5835 is commented out by default), the contents of the file are interpreted as a set
5836 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5837 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5838 separate document entitled &'Exim's interfaces to mail filtering'&.
5839
5840 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5841 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5842 There are two reasons for doing this:
5843
5844 .olist
5845 Whether or not a local user has a &_.forward_& file is not really relevant when
5846 checking an address for validity; it makes sense not to waste resources doing
5847 unnecessary work.
5848 .next
5849 More importantly, when Exim is verifying addresses or handling an EXPN
5850 command during an SMTP session, it is running as the Exim user, not as root.
5851 The group is the Exim group, and no additional groups are set up.
5852 It may therefore not be possible for Exim to read users' &_.forward_& files at
5853 this time.
5854 .endlist
5855
5856 The setting of &%check_ancestor%& prevents the router from generating a new
5857 address that is the same as any previous address that was redirected. (This
5858 works round a problem concerning a bad interaction between aliasing and
5859 forwarding &-- see section &<<SECTredlocmai>>&).
5860
5861 The final three option settings specify the transports that are to be used when
5862 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5863 auto-reply, respectively. For example, if a &_.forward_& file contains
5864 .code
5865 a.nother@elsewhere.example, /home/spqr/archive
5866 .endd
5867 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5868 transport.
5869 .code
5870 localuser:
5871   driver = accept
5872   check_local_user
5873 # local_part_suffix = +* : -*
5874 # local_part_suffix_optional
5875   transport = local_delivery
5876 .endd
5877 The final router sets up delivery into local mailboxes, provided that the local
5878 part is the name of a local login, by accepting the address and assigning it to
5879 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5880 routers, so the address is bounced. The commented suffix settings fulfil the
5881 same purpose as they do for the &(userforward)& router.
5882
5883
5884 .section "Transport configuration" "SECID56"
5885 .cindex "default" "transports"
5886 .cindex "transports" "default"
5887 Transports define mechanisms for actually delivering messages. They operate
5888 only when referenced from routers, so the order in which they are defined does
5889 not matter. The transports section of the configuration starts with
5890 .code
5891 begin transports
5892 .endd
5893 One remote transport and four local transports are defined.
5894 .code
5895 remote_smtp:
5896   driver = smtp
5897 .endd
5898 This transport is used for delivering messages over SMTP connections. All its
5899 options are defaulted. The list of remote hosts comes from the router.
5900 .code
5901 local_delivery:
5902   driver = appendfile
5903   file = /var/mail/$local_part
5904   delivery_date_add
5905   envelope_to_add
5906   return_path_add
5907 # group = mail
5908 # mode = 0660
5909 .endd
5910 This &(appendfile)& transport is used for local delivery to user mailboxes in
5911 traditional BSD mailbox format. By default it runs under the uid and gid of the
5912 local user, which requires the sticky bit to be set on the &_/var/mail_&
5913 directory. Some systems use the alternative approach of running mail deliveries
5914 under a particular group instead of using the sticky bit. The commented options
5915 show how this can be done.
5916
5917 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5918 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5919 similarly-named options above.
5920 .code
5921 address_pipe:
5922   driver = pipe
5923   return_output
5924 .endd
5925 This transport is used for handling deliveries to pipes that are generated by
5926 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5927 option specifies that any output generated by the pipe is to be returned to the
5928 sender.
5929 .code
5930 address_file:
5931   driver = appendfile
5932   delivery_date_add
5933   envelope_to_add
5934   return_path_add
5935 .endd
5936 This transport is used for handling deliveries to files that are generated by
5937 redirection. The name of the file is not specified in this instance of
5938 &(appendfile)&, because it comes from the &(redirect)& router.
5939 .code
5940 address_reply:
5941   driver = autoreply
5942 .endd
5943 This transport is used for handling automatic replies generated by users'
5944 filter files.
5945
5946
5947
5948 .section "Default retry rule" "SECID57"
5949 .cindex "retry" "default rule"
5950 .cindex "default" "retry rule"
5951 The retry section of the configuration file contains rules which affect the way
5952 Exim retries deliveries that cannot be completed at the first attempt. It is
5953 introduced by the line
5954 .code
5955 begin retry
5956 .endd
5957 In the default configuration, there is just one rule, which applies to all
5958 errors:
5959 .code
5960 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5961 .endd
5962 This causes any temporarily failing address to be retried every 15 minutes for
5963 2 hours, then at intervals starting at one hour and increasing by a factor of
5964 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5965 is not delivered after 4 days of temporary failure, it is bounced.
5966
5967 If the retry section is removed from the configuration, or is empty (that is,
5968 if no retry rules are defined), Exim will not retry deliveries. This turns
5969 temporary errors into permanent errors.
5970
5971
5972 .section "Rewriting configuration" "SECID58"
5973 The rewriting section of the configuration, introduced by
5974 .code
5975 begin rewrite
5976 .endd
5977 contains rules for rewriting addresses in messages as they arrive. There are no
5978 rewriting rules in the default configuration file.
5979
5980
5981
5982 .section "Authenticators configuration" "SECTdefconfauth"
5983 .cindex "AUTH" "configuration"
5984 The authenticators section of the configuration, introduced by
5985 .code
5986 begin authenticators
5987 .endd
5988 defines mechanisms for the use of the SMTP AUTH command. The default
5989 configuration file contains two commented-out example authenticators
5990 which support plaintext username/password authentication using the
5991 standard PLAIN mechanism and the traditional but non-standard LOGIN
5992 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
5993 to support most MUA software.
5994
5995 The example PLAIN authenticator looks like this:
5996 .code
5997 #PLAIN:
5998 #  driver                  = plaintext
5999 #  server_set_id           = $auth2
6000 #  server_prompts          = :
6001 #  server_condition        = Authentication is not yet configured
6002 #  server_advertise_condition = ${if def:tls_cipher }
6003 .endd
6004 And the example LOGIN authenticator looks like this:
6005 .code
6006 #LOGIN:
6007 #  driver                  = plaintext
6008 #  server_set_id           = $auth1
6009 #  server_prompts          = <| Username: | Password:
6010 #  server_condition        = Authentication is not yet configured
6011 #  server_advertise_condition = ${if def:tls_cipher }
6012 .endd
6013
6014 The &%server_set_id%& option makes Exim remember the authenticated username
6015 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6016 &%server_prompts%& option configures the &(plaintext)& authenticator so
6017 that it implements the details of the specific authentication mechanism,
6018 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6019 when Exim offers authentication to clients; in the examples, this is only
6020 when TLS or SSL has been started, so to enable the authenticators you also
6021 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6022
6023 The &%server_condition%& setting defines how to verify that the username and
6024 password are correct. In the examples it just produces an error message.
6025 To make the authenticators work, you can use a string expansion
6026 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6027
6028 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6029 usercode and password are in different positions.
6030 Chapter &<<CHAPplaintext>>& covers both.
6031
6032 .ecindex IIDconfiwal
6033
6034
6035
6036 . ////////////////////////////////////////////////////////////////////////////
6037 . ////////////////////////////////////////////////////////////////////////////
6038
6039 .chapter "Regular expressions" "CHAPregexp"
6040
6041 .cindex "regular expressions" "library"
6042 .cindex "PCRE"
6043 Exim supports the use of regular expressions in many of its options. It
6044 uses the PCRE regular expression library; this provides regular expression
6045 matching that is compatible with Perl 5. The syntax and semantics of
6046 regular expressions is discussed in many Perl reference books, and also in
6047 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6048 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6049
6050 The documentation for the syntax and semantics of the regular expressions that
6051 are supported by PCRE is included in the PCRE distribution, and no further
6052 description is included here. The PCRE functions are called from Exim using
6053 the default option settings (that is, with no PCRE options set), except that
6054 the PCRE_CASELESS option is set when the matching is required to be
6055 case-insensitive.
6056
6057 In most cases, when a regular expression is required in an Exim configuration,
6058 it has to start with a circumflex, in order to distinguish it from plain text
6059 or an &"ends with"& wildcard. In this example of a configuration setting, the
6060 second item in the colon-separated list is a regular expression.
6061 .code
6062 domains = a.b.c : ^\\d{3} : *.y.z : ...
6063 .endd
6064 The doubling of the backslash is required because of string expansion that
6065 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6066 of this issue, and a way of avoiding the need for doubling backslashes. The
6067 regular expression that is eventually used in this example contains just one
6068 backslash. The circumflex is included in the regular expression, and has the
6069 normal effect of &"anchoring"& it to the start of the string that is being
6070 matched.
6071
6072 There are, however, two cases where a circumflex is not required for the
6073 recognition of a regular expression: these are the &%match%& condition in a
6074 string expansion, and the &%matches%& condition in an Exim filter file. In
6075 these cases, the relevant string is always treated as a regular expression; if
6076 it does not start with a circumflex, the expression is not anchored, and can
6077 match anywhere in the subject string.
6078
6079 In all cases, if you want a regular expression to match at the end of a string,
6080 you must code the $ metacharacter to indicate this. For example:
6081 .code
6082 domains = ^\\d{3}\\.example
6083 .endd
6084 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6085 You need to use:
6086 .code
6087 domains = ^\\d{3}\\.example\$
6088 .endd
6089 if you want &'example'& to be the top-level domain. The backslash before the
6090 $ is needed because string expansion also interprets dollar characters.
6091
6092
6093
6094 . ////////////////////////////////////////////////////////////////////////////
6095 . ////////////////////////////////////////////////////////////////////////////
6096
6097 .chapter "File and database lookups" "CHAPfdlookup"
6098 .scindex IIDfidalo1 "file" "lookups"
6099 .scindex IIDfidalo2 "database" "lookups"
6100 .cindex "lookup" "description of"
6101 Exim can be configured to look up data in files or databases as it processes
6102 messages. Two different kinds of syntax are used:
6103
6104 .olist
6105 A string that is to be expanded may contain explicit lookup requests. These
6106 cause parts of the string to be replaced by data that is obtained from the
6107 lookup. Lookups of this type are conditional expansion items. Different results
6108 can be defined for the cases of lookup success and failure. See chapter
6109 &<<CHAPexpand>>&, where string expansions are described in detail.
6110 .next
6111 Lists of domains, hosts, and email addresses can contain lookup requests as a
6112 way of avoiding excessively long linear lists. In this case, the data that is
6113 returned by the lookup is often (but not always) discarded; whether the lookup
6114 succeeds or fails is what really counts. These kinds of list are described in
6115 chapter &<<CHAPdomhosaddlists>>&.
6116 .endlist
6117
6118 String expansions, lists, and lookups interact with each other in such a way
6119 that there is no order in which to describe any one of them that does not
6120 involve references to the others. Each of these three chapters makes more sense
6121 if you have read the other two first. If you are reading this for the first
6122 time, be aware that some of it will make a lot more sense after you have read
6123 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6124
6125 .section "Examples of different lookup syntax" "SECID60"
6126 It is easy to confuse the two different kinds of lookup, especially as the
6127 lists that may contain the second kind are always expanded before being
6128 processed as lists. Therefore, they may also contain lookups of the first kind.
6129 Be careful to distinguish between the following two examples:
6130 .code
6131 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6132 domains = lsearch;/some/file
6133 .endd
6134 The first uses a string expansion, the result of which must be a domain list.
6135 No strings have been specified for a successful or a failing lookup; the
6136 defaults in this case are the looked-up data and an empty string, respectively.
6137 The expansion takes place before the string is processed as a list, and the
6138 file that is searched could contain lines like this:
6139 .code
6140 192.168.3.4: domain1:domain2:...
6141 192.168.1.9: domain3:domain4:...
6142 .endd
6143 When the lookup succeeds, the result of the expansion is a list of domains (and
6144 possibly other types of item that are allowed in domain lists).
6145
6146 In the second example, the lookup is a single item in a domain list. It causes
6147 Exim to use a lookup to see if the domain that is being processed can be found
6148 in the file. The file could contains lines like this:
6149 .code
6150 domain1:
6151 domain2:
6152 .endd
6153 Any data that follows the keys is not relevant when checking that the domain
6154 matches the list item.
6155
6156 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6157 Consider a file containing lines like this:
6158 .code
6159 192.168.5.6: lsearch;/another/file
6160 .endd
6161 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6162 first &%domains%& setting above generates the second setting, which therefore
6163 causes a second lookup to occur.
6164
6165 The rest of this chapter describes the different lookup types that are
6166 available. Any of them can be used in any part of the configuration where a
6167 lookup is permitted.
6168
6169
6170 .section "Lookup types" "SECID61"
6171 .cindex "lookup" "types of"
6172 .cindex "single-key lookup" "definition of"
6173 Two different types of data lookup are implemented:
6174
6175 .ilist
6176 The &'single-key'& type requires the specification of a file in which to look,
6177 and a single key to search for. The key must be a non-empty string for the
6178 lookup to succeed. The lookup type determines how the file is searched.
6179 .next
6180 .cindex "query-style lookup" "definition of"
6181 The &'query-style'& type accepts a generalized database query. No particular
6182 key value is assumed by Exim for query-style lookups. You can use whichever
6183 Exim variables you need to construct the database query.
6184 .endlist
6185
6186 The code for each lookup type is in a separate source file that is included in
6187 the binary of Exim only if the corresponding compile-time option is set. The
6188 default settings in &_src/EDITME_& are:
6189 .code
6190 LOOKUP_DBM=yes
6191 LOOKUP_LSEARCH=yes
6192 .endd
6193 which means that only linear searching and DBM lookups are included by default.
6194 For some types of lookup (e.g. SQL databases), you need to install appropriate
6195 libraries and header files before building Exim.
6196
6197
6198
6199
6200 .section "Single-key lookup types" "SECTsinglekeylookups"
6201 .cindex "lookup" "single-key types"
6202 .cindex "single-key lookup" "list of types"
6203 The following single-key lookup types are implemented:
6204
6205 .ilist
6206 .cindex "cdb" "description of"
6207 .cindex "lookup" "cdb"
6208 .cindex "binary zero" "in lookup key"
6209 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6210 string without a terminating binary zero. The cdb format is designed for
6211 indexed files that are read frequently and never updated, except by total
6212 re-creation. As such, it is particularly suitable for large files containing
6213 aliases or other indexed data referenced by an MTA. Information about cdb can
6214 be found in several places:
6215 .display
6216 &url(http://www.pobox.com/~djb/cdb.html)
6217 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6218 &url(http://packages.debian.org/stable/utils/freecdb.html)
6219 .endd
6220 A cdb distribution is not needed in order to build Exim with cdb support,
6221 because the code for reading cdb files is included directly in Exim itself.
6222 However, no means of building or testing cdb files is provided with Exim, so
6223 you need to obtain a cdb distribution in order to do this.
6224 .next
6225 .cindex "DBM" "lookup type"
6226 .cindex "lookup" "dbm"
6227 .cindex "binary zero" "in lookup key"
6228 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6229 DBM file by looking up the record with the given key. A terminating binary
6230 zero is included in the key that is passed to the DBM library. See section
6231 &<<SECTdb>>& for a discussion of DBM libraries.
6232
6233 .cindex "Berkeley DB library" "file format"
6234 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6235 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6236 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6237 the DB_UNKNOWN option. This enables it to handle any of the types of database
6238 that the library supports, and can be useful for accessing DBM files created by
6239 other applications. (For earlier DB versions, DB_HASH is always used.)
6240 .next
6241 .cindex "lookup" "dbmjz"
6242 .cindex "lookup" "dbm &-- embedded NULs"
6243 .cindex "sasldb2"
6244 .cindex "dbmjz lookup type"
6245 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6246 interpreted as an Exim list; the elements of the list are joined together with
6247 ASCII NUL characters to form the lookup key.  An example usage would be to
6248 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6249 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6250 &(cram_md5)& authenticator.
6251 .next
6252 .cindex "lookup" "dbmnz"
6253 .cindex "lookup" "dbm &-- terminating zero"
6254 .cindex "binary zero" "in lookup key"
6255 .cindex "Courier"
6256 .cindex "&_/etc/userdbshadow.dat_&"
6257 .cindex "dbmnz lookup type"
6258 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6259 is not included in the key that is passed to the DBM library. You may need this
6260 if you want to look up data in files that are created by or shared with some
6261 other application that does not use terminating zeros. For example, you need to
6262 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6263 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6264 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6265 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6266 .next
6267 .cindex "lookup" "dsearch"
6268 .cindex "dsearch lookup type"
6269 &(dsearch)&: The given file must be a directory; this is searched for an entry
6270 whose name is the key by calling the &[lstat()]& function. The key may not
6271 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6272 the lookup is the name of the entry, which may be a file, directory,
6273 symbolic link, or any other kind of directory entry. An example of how this
6274 lookup can be used to support virtual domains is given in section
6275 &<<SECTvirtualdomains>>&.
6276 .next
6277 .cindex "lookup" "iplsearch"
6278 .cindex "iplsearch lookup type"
6279 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6280 terminated by a colon or white space or the end of the line. The keys in the
6281 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6282 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6283 being interpreted as a key terminator. For example:
6284 .code
6285 1.2.3.4:           data for 1.2.3.4
6286 192.168.0.0/16:    data for 192.168.0.0/16
6287 "abcd::cdab":      data for abcd::cdab
6288 "abcd:abcd::/32"   data for abcd:abcd::/32
6289 .endd
6290 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6291 file is searched linearly, using the CIDR masks where present, until a matching
6292 key is found. The first key that matches is used; there is no attempt to find a
6293 &"best"& match. Apart from the way the keys are matched, the processing for
6294 &(iplsearch)& is the same as for &(lsearch)&.
6295
6296 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6297 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6298 lookup types support only literal keys.
6299
6300 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6301 the implicit key is the host's IP address rather than its name (see section
6302 &<<SECThoslispatsikey>>&).
6303 .next
6304 .cindex "linear search"
6305 .cindex "lookup" "lsearch"
6306 .cindex "lsearch lookup type"
6307 .cindex "case sensitivity" "in lsearch lookup"
6308 &(lsearch)&: The given file is a text file that is searched linearly for a
6309 line beginning with the search key, terminated by a colon or white space or the
6310 end of the line. The search is case-insensitive; that is, upper and lower case
6311 letters are treated as the same. The first occurrence of the key that is found
6312 in the file is used.
6313
6314 White space between the key and the colon is permitted. The remainder of the
6315 line, with leading and trailing white space removed, is the data. This can be
6316 continued onto subsequent lines by starting them with any amount of white
6317 space, but only a single space character is included in the data at such a
6318 junction. If the data begins with a colon, the key must be terminated by a
6319 colon, for example:
6320 .code
6321 baduser:  :fail:
6322 .endd
6323 Empty lines and lines beginning with # are ignored, even if they occur in the
6324 middle of an item. This is the traditional textual format of alias files. Note
6325 that the keys in an &(lsearch)& file are literal strings. There is no
6326 wildcarding of any kind.
6327
6328 .cindex "lookup" "lsearch &-- colons in keys"
6329 .cindex "white space" "in lsearch key"
6330 In most &(lsearch)& files, keys are not required to contain colons or #
6331 characters, or white space. However, if you need this feature, it is available.
6332 If a key begins with a doublequote character, it is terminated only by a
6333 matching quote (or end of line), and the normal escaping rules apply to its
6334 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6335 quoted keys (exactly as for unquoted keys). There is no special handling of
6336 quotes for the data part of an &(lsearch)& line.
6337
6338 .next
6339 .cindex "NIS lookup type"
6340 .cindex "lookup" "NIS"
6341 .cindex "binary zero" "in lookup key"
6342 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6343 the given key, without a terminating binary zero. There is a variant called
6344 &(nis0)& which does include the terminating binary zero in the key. This is
6345 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6346 aliases; the full map names must be used.
6347
6348 .next
6349 .cindex "wildlsearch lookup type"
6350 .cindex "lookup" "wildlsearch"
6351 .cindex "nwildlsearch lookup type"
6352 .cindex "lookup" "nwildlsearch"
6353 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6354 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6355 the file may be wildcarded. The difference between these two lookup types is
6356 that for &(wildlsearch)&, each key in the file is string-expanded before being
6357 used, whereas for &(nwildlsearch)&, no expansion takes place.
6358
6359 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6360 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6361 file that are regular expressions can be made case-sensitive by the use of
6362 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6363
6364 . ==== As this is a nested list, any displays it contains must be indented
6365 . ==== as otherwise they are too far to the left.
6366
6367 .olist
6368 The string may begin with an asterisk to mean &"ends with"&. For example:
6369 .code
6370     *.a.b.c       data for anything.a.b.c
6371     *fish         data for anythingfish
6372 .endd
6373 .next
6374 The string may begin with a circumflex to indicate a regular expression. For
6375 example, for &(wildlsearch)&:
6376 .code
6377     ^\N\d+\.a\.b\N    data for <digits>.a.b
6378 .endd
6379 Note the use of &`\N`& to disable expansion of the contents of the regular
6380 expression. If you are using &(nwildlsearch)&, where the keys are not
6381 string-expanded, the equivalent entry is:
6382 .code
6383     ^\d+\.a\.b        data for <digits>.a.b
6384 .endd
6385 The case-insensitive flag is set at the start of compiling the regular
6386 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6387 For example, to make the entire pattern case-sensitive:
6388 .code
6389     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6390 .endd
6391
6392 If the regular expression contains white space or colon characters, you must
6393 either quote it (see &(lsearch)& above), or represent these characters in other
6394 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6395 colon. This may be easier than quoting, because if you quote, you have to
6396 escape all the backslashes inside the quotes.
6397
6398 &*Note*&: It is not possible to capture substrings in a regular expression
6399 match for later use, because the results of all lookups are cached. If a lookup
6400 is repeated, the result is taken from the cache, and no actual pattern matching
6401 takes place. The values of all the numeric variables are unset after a
6402 &((n)wildlsearch)& match.
6403
6404 .next
6405 Although I cannot see it being of much use, the general matching function that
6406 is used to implement &((n)wildlsearch)& means that the string may begin with a
6407 lookup name terminated by a semicolon, and followed by lookup data. For
6408 example:
6409 .code
6410     cdb;/some/file  data for keys that match the file
6411 .endd
6412 The data that is obtained from the nested lookup is discarded.
6413 .endlist olist
6414
6415 Keys that do not match any of these patterns are interpreted literally. The
6416 continuation rules for the data are the same as for &(lsearch)&, and keys may
6417 be followed by optional colons.
6418
6419 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6420 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6421 lookup types support only literal keys.
6422 .endlist ilist
6423
6424
6425 .section "Query-style lookup types" "SECID62"
6426 .cindex "lookup" "query-style types"
6427 .cindex "query-style lookup" "list of types"
6428 The supported query-style lookup types are listed below. Further details about
6429 many of them are given in later sections.
6430
6431 .ilist
6432 .cindex "DNS" "as a lookup type"
6433 .cindex "lookup" "DNS"
6434 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6435 are given in the supplied query. The resulting data is the contents of the
6436 records. See section &<<SECTdnsdb>>&.
6437 .next
6438 .cindex "InterBase lookup type"
6439 .cindex "lookup" "InterBase"
6440 &(ibase)&: This does a lookup in an InterBase database.
6441 .next
6442 .cindex "LDAP" "lookup type"
6443 .cindex "lookup" "LDAP"
6444 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6445 returns attributes from a single entry. There is a variant called &(ldapm)&
6446 that permits values from multiple entries to be returned. A third variant
6447 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6448 any attribute values. See section &<<SECTldap>>&.
6449 .next
6450 .cindex "MySQL" "lookup type"
6451 .cindex "lookup" "MySQL"
6452 &(mysql)&: The format of the query is an SQL statement that is passed to a
6453 MySQL database. See section &<<SECTsql>>&.
6454 .next
6455 .cindex "NIS+ lookup type"
6456 .cindex "lookup" "NIS+"
6457 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6458 the field to be returned. See section &<<SECTnisplus>>&.
6459 .next
6460 .cindex "Oracle" "lookup type"
6461 .cindex "lookup" "Oracle"
6462 &(oracle)&: The format of the query is an SQL statement that is passed to an
6463 Oracle database. See section &<<SECTsql>>&.
6464 .next
6465 .cindex "lookup" "passwd"
6466 .cindex "passwd lookup type"
6467 .cindex "&_/etc/passwd_&"
6468 &(passwd)& is a query-style lookup with queries that are just user names. The
6469 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6470 success, the result string is the same as you would get from an &(lsearch)&
6471 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6472 password value. For example:
6473 .code
6474 *:42:42:King Rat:/home/kr:/bin/bash
6475 .endd
6476 .next
6477 .cindex "PostgreSQL lookup type"
6478 .cindex "lookup" "PostgreSQL"
6479 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6480 PostgreSQL database. See section &<<SECTsql>>&.
6481
6482 .next
6483 .cindex "sqlite lookup type"
6484 .cindex "lookup" "sqlite"
6485 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6486 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6487
6488 .next
6489 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6490 not likely to be useful in normal operation.
6491 .next
6492 .cindex "whoson lookup type"
6493 .cindex "lookup" "whoson"
6494 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6495 allows a server to check whether a particular (dynamically allocated) IP
6496 address is currently allocated to a known (trusted) user and, optionally, to
6497 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6498 at one time for &"POP before SMTP"& authentication, but that approach has been
6499 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6500 &"POP before SMTP"& checking using ACL statements such as
6501 .code
6502 require condition = \
6503   ${lookup whoson {$sender_host_address}{yes}{no}}
6504 .endd
6505 The query consists of a single IP address. The value returned is the name of
6506 the authenticated user, which is stored in the variable &$value$&. However, in
6507 this example, the data in &$value$& is not used; the result of the lookup is
6508 one of the fixed strings &"yes"& or &"no"&.
6509 .endlist
6510
6511
6512
6513 .section "Temporary errors in lookups" "SECID63"
6514 .cindex "lookup" "temporary error in"
6515 Lookup functions can return temporary error codes if the lookup cannot be
6516 completed. For example, an SQL or LDAP database might be unavailable. For this
6517 reason, it is not advisable to use a lookup that might do this for critical
6518 options such as a list of local domains.
6519
6520 When a lookup cannot be completed in a router or transport, delivery
6521 of the message (to the relevant address) is deferred, as for any other
6522 temporary error. In other circumstances Exim may assume the lookup has failed,
6523 or may give up altogether.
6524
6525
6526
6527 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6528 .cindex "wildcard lookups"
6529 .cindex "lookup" "default values"
6530 .cindex "lookup" "wildcard"
6531 .cindex "lookup" "* added to type"
6532 .cindex "default" "in single-key lookups"
6533 In this context, a &"default value"& is a value specified by the administrator
6534 that is to be used if a lookup fails.
6535
6536 &*Note:*& This section applies only to single-key lookups. For query-style
6537 lookups, the facilities of the query language must be used. An attempt to
6538 specify a default for a query-style lookup provokes an error.
6539
6540 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6541 and the initial lookup fails, the key &"*"& is looked up in the file to
6542 provide a default value. See also the section on partial matching below.
6543
6544 .cindex "*@ with single-key lookup"
6545 .cindex "lookup" "*@ added to type"
6546 .cindex "alias file" "per-domain default"
6547 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6548 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6549 character, a second lookup is done with everything before the last @ replaced
6550 by *. This makes it possible to provide per-domain defaults in alias files
6551 that include the domains in the keys. If the second lookup fails (or doesn't
6552 take place because there is no @ in the key), &"*"& is looked up.
6553 For example, a &(redirect)& router might contain:
6554 .code
6555 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6556 .endd
6557 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6558 looks up these keys, in this order:
6559 .code
6560 jane@eyre.example
6561 *@eyre.example
6562 *
6563 .endd
6564 The data is taken from whichever key it finds first. &*Note*&: In an
6565 &(lsearch)& file, this does not mean the first of these keys in the file. A
6566 complete scan is done for each key, and only if it is not found at all does
6567 Exim move on to try the next key.
6568
6569
6570
6571 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6572 .cindex "partial matching"
6573 .cindex "wildcard lookups"
6574 .cindex "lookup" "partial matching"
6575 .cindex "lookup" "wildcard"
6576 .cindex "asterisk" "in search type"
6577 The normal operation of a single-key lookup is to search the file for an exact
6578 match with the given key. However, in a number of situations where domains are
6579 being looked up, it is useful to be able to do partial matching. In this case,
6580 information in the file that has a key starting with &"*."& is matched by any
6581 domain that ends with the components that follow the full stop. For example, if
6582 a key in a DBM file is
6583 .code
6584 *.dates.fict.example
6585 .endd
6586 then when partial matching is enabled this is matched by (amongst others)
6587 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6588 by &'dates.fict.example'&, if that does not appear as a separate key in the
6589 file.
6590
6591 &*Note*&: Partial matching is not available for query-style lookups. It is
6592 also not available for any lookup items in address lists (see section
6593 &<<SECTaddresslist>>&).
6594
6595 Partial matching is implemented by doing a series of separate lookups using
6596 keys constructed by modifying the original subject key. This means that it can
6597 be used with any of the single-key lookup types, provided that
6598 partial matching keys
6599 beginning with a special prefix (default &"*."&) are included in the data file.
6600 Keys in the file that do not begin with the prefix are matched only by
6601 unmodified subject keys when partial matching is in use.
6602
6603 Partial matching is requested by adding the string &"partial-"& to the front of
6604 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6605 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6606 is added at the start of the subject key, and it is looked up again. If that
6607 fails, further lookups are tried with dot-separated components removed from the
6608 start of the subject key, one-by-one, and &"*."& added on the front of what
6609 remains.
6610
6611 A minimum number of two non-* components are required. This can be adjusted
6612 by including a number before the hyphen in the search type. For example,
6613 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6614 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6615 subject key is &'2250.dates.fict.example'& then the following keys are looked
6616 up when the minimum number of non-* components is two:
6617 .code
6618 2250.dates.fict.example
6619 *.2250.dates.fict.example
6620 *.dates.fict.example
6621 *.fict.example
6622 .endd
6623 As soon as one key in the sequence is successfully looked up, the lookup
6624 finishes.
6625
6626 .cindex "lookup" "partial matching &-- changing prefix"
6627 .cindex "prefix" "for partial matching"
6628 The use of &"*."& as the partial matching prefix is a default that can be
6629 changed. The motivation for this feature is to allow Exim to operate with file
6630 formats that are used by other MTAs. A different prefix can be supplied in
6631 parentheses instead of the hyphen after &"partial"&. For example:
6632 .code
6633 domains = partial(.)lsearch;/some/file
6634 .endd
6635 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6636 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6637 components is unchanged). The prefix may consist of any punctuation characters
6638 other than a closing parenthesis. It may be empty, for example:
6639 .code
6640 domains = partial1()cdb;/some/file
6641 .endd
6642 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6643 &`a.b.c`&, &`b.c`&, and &`c`&.
6644
6645 If &"partial0"& is specified, what happens at the end (when the lookup with
6646 just one non-wild component has failed, and the original key is shortened right
6647 down to the null string) depends on the prefix:
6648
6649 .ilist
6650 If the prefix has zero length, the whole lookup fails.
6651 .next
6652 If the prefix has length 1, a lookup for just the prefix is done. For
6653 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6654 .next
6655 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6656 remainder is looked up. With the default prefix, therefore, the final lookup is
6657 for &"*"& on its own.
6658 .next
6659 Otherwise, the whole prefix is looked up.
6660 .endlist
6661
6662
6663 If the search type ends in &"*"& or &"*@"& (see section
6664 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6665 this implies happens after all partial lookups have failed. If &"partial0"& is
6666 specified, adding &"*"& to the search type has no effect with the default
6667 prefix, because the &"*"& key is already included in the sequence of partial
6668 lookups. However, there might be a use for lookup types such as
6669 &"partial0(.)lsearch*"&.
6670
6671 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6672 in domain lists and the like. Partial matching works only in terms of
6673 dot-separated components; a key such as &`*fict.example`&
6674 in a database file is useless, because the asterisk in a partial matching
6675 subject key is always followed by a dot.
6676
6677
6678
6679
6680 .section "Lookup caching" "SECID64"
6681 .cindex "lookup" "caching"
6682 .cindex "caching" "lookup data"
6683 Exim caches all lookup results in order to avoid needless repetition of
6684 lookups. However, because (apart from the daemon) Exim operates as a collection
6685 of independent, short-lived processes, this caching applies only within a
6686 single Exim process. There is no inter-process lookup caching facility.
6687
6688 For single-key lookups, Exim keeps the relevant files open in case there is
6689 another lookup that needs them. In some types of configuration this can lead to
6690 many files being kept open for messages with many recipients. To avoid hitting
6691 the operating system limit on the number of simultaneously open files, Exim
6692 closes the least recently used file when it needs to open more files than its
6693 own internal limit, which can be changed via the &%lookup_open_max%& option.
6694
6695 The single-key lookup files are closed and the lookup caches are flushed at
6696 strategic points during delivery &-- for example, after all routing is
6697 complete.
6698
6699
6700
6701
6702 .section "Quoting lookup data" "SECID65"
6703 .cindex "lookup" "quoting"
6704 .cindex "quoting" "in lookups"
6705 When data from an incoming message is included in a query-style lookup, there
6706 is the possibility of special characters in the data messing up the syntax of
6707 the query. For example, a NIS+ query that contains
6708 .code
6709 [name=$local_part]
6710 .endd
6711 will be broken if the local part happens to contain a closing square bracket.
6712 For NIS+, data can be enclosed in double quotes like this:
6713 .code
6714 [name="$local_part"]
6715 .endd
6716 but this still leaves the problem of a double quote in the data. The rule for
6717 NIS+ is that double quotes must be doubled. Other lookup types have different
6718 rules, and to cope with the differing requirements, an expansion operator
6719 of the following form is provided:
6720 .code
6721 ${quote_<lookup-type>:<string>}
6722 .endd
6723 For example, the safest way to write the NIS+ query is
6724 .code
6725 [name="${quote_nisplus:$local_part}"]
6726 .endd
6727 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6728 operator can be used for all lookup types, but has no effect for single-key
6729 lookups, since no quoting is ever needed in their key strings.
6730
6731
6732
6733
6734 .section "More about dnsdb" "SECTdnsdb"
6735 .cindex "dnsdb lookup"
6736 .cindex "lookup" "dnsdb"
6737 .cindex "DNS" "as a lookup type"
6738 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6739 of a record type and a domain name, separated by an equals sign. For example,
6740 an expansion string could contain:
6741 .code
6742 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6743 .endd
6744 If the lookup succeeds, the result is placed in &$value$&, which in this case
6745 is used on its own as the result. If the lookup does not succeed, the
6746 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6747 &<<SECTforexpfai>>& for an explanation of what this means.
6748
6749 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6750 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6751 configured). If no type is given, TXT is assumed. When the type is PTR,
6752 the data can be an IP address, written as normal; inversion and the addition of
6753 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6754 .code
6755 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6756 .endd
6757 If the data for a PTR record is not a syntactically valid IP address, it is not
6758 altered and nothing is added.
6759
6760 .cindex "MX record" "in &(dnsdb)& lookup"
6761 .cindex "SRV record" "in &(dnsdb)& lookup"
6762 For an MX lookup, both the preference value and the host name are returned for
6763 each record, separated by a space. For an SRV lookup, the priority, weight,
6764 port, and host name are returned for each record, separated by spaces.
6765
6766 For any record type, if multiple records are found (or, for A6 lookups, if a
6767 single record leads to multiple addresses), the data is returned as a
6768 concatenation, with newline as the default separator. The order, of course,
6769 depends on the DNS resolver. You can specify a different separator character
6770 between multiple records by putting a right angle-bracket followed immediately
6771 by the new separator at the start of the query. For example:
6772 .code
6773 ${lookup dnsdb{>: a=host1.example}}
6774 .endd
6775 It is permitted to specify a space as the separator character. Further
6776 white space is ignored.
6777
6778 .cindex "TXT record" "in &(dnsdb)& lookup"
6779 .cindex "SPF record" "in &(dnsdb)& lookup"
6780 For TXT records with multiple items of data, only the first item is returned,
6781 unless a separator for them is specified using a comma after the separator
6782 character followed immediately by the TXT record item separator. To concatenate
6783 items without a separator, use a semicolon instead. For SPF records the
6784 default behaviour is to concatenate multiple items without using a separator.
6785 .code
6786 ${lookup dnsdb{>\n,: txt=a.b.example}}
6787 ${lookup dnsdb{>\n; txt=a.b.example}}
6788 ${lookup dnsdb{spf=example.org}}
6789 .endd
6790 It is permitted to specify a space as the separator character. Further
6791 white space is ignored.
6792
6793 .section "Pseudo dnsdb record types" "SECID66"
6794 .cindex "MX record" "in &(dnsdb)& lookup"
6795 By default, both the preference value and the host name are returned for
6796 each MX record, separated by a space. If you want only host names, you can use
6797 the pseudo-type MXH:
6798 .code
6799 ${lookup dnsdb{mxh=a.b.example}}
6800 .endd
6801 In this case, the preference values are omitted, and just the host names are
6802 returned.
6803
6804 .cindex "name server for enclosing domain"
6805 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6806 records on the given domain, but if none are found, it removes the first
6807 component of the domain name, and tries again. This process continues until NS
6808 records are found or there are no more components left (or there is a DNS
6809 error). In other words, it may return the name servers for a top-level domain,
6810 but it never returns the root name servers. If there are no NS records for the
6811 top-level domain, the lookup fails. Consider these examples:
6812 .code
6813 ${lookup dnsdb{zns=xxx.quercite.com}}
6814 ${lookup dnsdb{zns=xxx.edu}}
6815 .endd
6816 Assuming that in each case there are no NS records for the full domain name,
6817 the first returns the name servers for &%quercite.com%&, and the second returns
6818 the name servers for &%edu%&.
6819
6820 You should be careful about how you use this lookup because, unless the
6821 top-level domain does not exist, the lookup always returns some host names. The
6822 sort of use to which this might be put is for seeing if the name servers for a
6823 given domain are on a blacklist. You can probably assume that the name servers
6824 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6825 such a list.
6826
6827 .cindex "CSA" "in &(dnsdb)& lookup"
6828 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6829 records according to the CSA rules, which are described in section
6830 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6831 not sufficient because of the extra parent domain search behaviour of CSA. The
6832 result of a successful lookup such as:
6833 .code
6834 ${lookup dnsdb {csa=$sender_helo_name}}
6835 .endd
6836 has two space-separated fields: an authorization code and a target host name.
6837 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6838 authorization required but absent, or &"?"& for unknown.
6839
6840
6841 .section "Multiple dnsdb lookups" "SECID67"
6842 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6843 However, you can specify a list of domains or IP addresses in a single
6844 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6845 the default separator, but with the ability to change this. For example:
6846 .code
6847 ${lookup dnsdb{one.domain.com:two.domain.com}}
6848 ${lookup dnsdb{a=one.host.com:two.host.com}}
6849 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6850 .endd
6851 In order to retain backwards compatibility, there is one special case: if
6852 the lookup type is PTR and no change of separator is specified, Exim looks
6853 to see if the rest of the string is precisely one IPv6 address. In this
6854 case, it does not treat it as a list.
6855
6856 The data from each lookup is concatenated, with newline separators by default,
6857 in the same way that multiple DNS records for a single item are handled. A
6858 different separator can be specified, as described above.
6859
6860 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6861 temporary DNS error for any of them, the behaviour is controlled by
6862 an optional keyword followed by a comma that may appear before the record
6863 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6864 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6865 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6866 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6867 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6868 error causes the whole lookup to defer only if none of the other lookups
6869 succeed. The default is &"lax"&, so the following lookups are equivalent:
6870 .code
6871 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6872 ${lookup dnsdb{a=one.host.com:two.host.com}}
6873 .endd
6874 Thus, in the default case, as long as at least one of the DNS lookups
6875 yields some data, the lookup succeeds.
6876
6877
6878
6879
6880 .section "More about LDAP" "SECTldap"
6881 .cindex "LDAP" "lookup, more about"
6882 .cindex "lookup" "LDAP"
6883 .cindex "Solaris" "LDAP"
6884 The original LDAP implementation came from the University of Michigan; this has
6885 become &"Open LDAP"&, and there are now two different releases. Another
6886 implementation comes from Netscape, and Solaris 7 and subsequent releases
6887 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6888 the lookup function level, their error handling is different. For this reason
6889 it is necessary to set a compile-time variable when building Exim with LDAP, to
6890 indicate which LDAP library is in use. One of the following should appear in
6891 your &_Local/Makefile_&:
6892 .code
6893 LDAP_LIB_TYPE=UMICHIGAN
6894 LDAP_LIB_TYPE=OPENLDAP1
6895 LDAP_LIB_TYPE=OPENLDAP2
6896 LDAP_LIB_TYPE=NETSCAPE
6897 LDAP_LIB_TYPE=SOLARIS
6898 .endd
6899 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6900 same interface as the University of Michigan version.
6901
6902 There are three LDAP lookup types in Exim. These behave slightly differently in
6903 the way they handle the results of a query:
6904
6905 .ilist
6906 &(ldap)& requires the result to contain just one entry; if there are more, it
6907 gives an error.
6908 .next
6909 &(ldapdn)& also requires the result to contain just one entry, but it is the
6910 Distinguished Name that is returned rather than any attribute values.
6911 .next
6912 &(ldapm)& permits the result to contain more than one entry; the attributes
6913 from all of them are returned.
6914 .endlist
6915
6916
6917 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6918 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6919 the data returned by a successful lookup is described in the next section.
6920 First we explain how LDAP queries are coded.
6921
6922
6923 .section "Format of LDAP queries" "SECTforldaque"
6924 .cindex "LDAP" "query format"
6925 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6926 the configuration of a &(redirect)& router one might have this setting:
6927 .code
6928 data = ${lookup ldap \
6929   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6930   c=UK?mailbox?base?}}
6931 .endd
6932 .cindex "LDAP" "with TLS"
6933 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6934 secure (encrypted) LDAP connections. The second of these ensures that an
6935 encrypted TLS connection is used.
6936
6937 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
6938 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
6939 See the &%ldap_start_tls%& option.
6940
6941
6942 .section "LDAP quoting" "SECID68"
6943 .cindex "LDAP" "quoting"
6944 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6945 and the second because the LDAP query is represented as a URL. Furthermore,
6946 within an LDAP query, two different kinds of quoting are required. For this
6947 reason, there are two different LDAP-specific quoting operators.
6948
6949 The &%quote_ldap%& operator is designed for use on strings that are part of
6950 filter specifications. Conceptually, it first does the following conversions on
6951 the string:
6952 .code
6953 *   =>   \2A
6954 (   =>   \28
6955 )   =>   \29
6956 \   =>   \5C
6957 .endd
6958 in accordance with RFC 2254. The resulting string is then quoted according
6959 to the rules for URLs, that is, all non-alphanumeric characters except
6960 .code
6961 ! $ ' - . _ ( ) * +
6962 .endd
6963 are converted to their hex values, preceded by a percent sign. For example:
6964 .code
6965 ${quote_ldap: a(bc)*, a<yz>; }
6966 .endd
6967 yields
6968 .code
6969 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6970 .endd
6971 Removing the URL quoting, this is (with a leading and a trailing space):
6972 .code
6973 a\28bc\29\2A, a<yz>;
6974 .endd
6975 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6976 base DN specifications in queries. Conceptually, it first converts the string
6977 by inserting a backslash in front of any of the following characters:
6978 .code
6979 , + " \ < > ;
6980 .endd
6981 It also inserts a backslash before any leading spaces or # characters, and
6982 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6983 is then quoted according to the rules for URLs. For example:
6984 .code
6985 ${quote_ldap_dn: a(bc)*, a<yz>; }
6986 .endd
6987 yields
6988 .code
6989 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
6990 .endd
6991 Removing the URL quoting, this is (with a trailing space):
6992 .code
6993 \ a(bc)*\, a\<yz\>\;\
6994 .endd
6995 There are some further comments about quoting in the section on LDAP
6996 authentication below.
6997
6998
6999 .section "LDAP connections" "SECID69"
7000 .cindex "LDAP" "connections"
7001 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7002 is in use, via a Unix domain socket. The example given above does not specify
7003 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7004 by starting it with
7005 .code
7006 ldap://<hostname>:<port>/...
7007 .endd
7008 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7009 used. When no server is specified in a query, a list of default servers is
7010 taken from the &%ldap_default_servers%& configuration option. This supplies a
7011 colon-separated list of servers which are tried in turn until one successfully
7012 handles a query, or there is a serious error. Successful handling either
7013 returns the requested data, or indicates that it does not exist. Serious errors
7014 are syntactical, or multiple values when only a single value is expected.
7015 Errors which cause the next server to be tried are connection failures, bind
7016 failures, and timeouts.
7017
7018 For each server name in the list, a port number can be given. The standard way
7019 of specifying a host and port is to use a colon separator (RFC 1738). Because
7020 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7021 doubled. For example
7022 .code
7023 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7024 .endd
7025 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7026 to the LDAP library with no server name, and the library's default (normally
7027 the local host) is used.
7028
7029 If you are using the OpenLDAP library, you can connect to an LDAP server using
7030 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7031 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7032 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7033 not available.
7034
7035 For this type of connection, instead of a host name for the server, a pathname
7036 for the socket is required, and the port number is not relevant. The pathname
7037 can be specified either as an item in &%ldap_default_servers%&, or inline in
7038 the query. In the former case, you can have settings such as
7039 .code
7040 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7041 .endd
7042 When the pathname is given in the query, you have to escape the slashes as
7043 &`%2F`& to fit in with the LDAP URL syntax. For example:
7044 .code
7045 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7046 .endd
7047 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7048 a pathname, it uses the Unix domain socket code, even if the query actually
7049 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7050 socket connection. This behaviour means that you can use a setting of
7051 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7052 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7053 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7054 backup host.
7055
7056 If an explicit &`ldapi`& type is given in a query when a host name is
7057 specified, an error is diagnosed. However, if there are more items in
7058 &%ldap_default_servers%&, they are tried. In other words:
7059
7060 .ilist
7061 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7062 interface.
7063 .next
7064 Using &`ldapi`& with a host name causes an error.
7065 .endlist
7066
7067
7068 Using &`ldapi`& with no host or path in the query, and no setting of
7069 &%ldap_default_servers%&, does whatever the library does by default.
7070
7071
7072
7073 .section "LDAP authentication and control information" "SECID70"
7074 .cindex "LDAP" "authentication"
7075 The LDAP URL syntax provides no way of passing authentication and other control
7076 information to the server. To make this possible, the URL in an LDAP query may
7077 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7078 spaces. If a value contains spaces it must be enclosed in double quotes, and
7079 when double quotes are used, backslash is interpreted in the usual way inside
7080 them. The following names are recognized:
7081 .display
7082 &`DEREFERENCE`&  set the dereferencing parameter
7083 &`NETTIME    `&  set a timeout for a network operation
7084 &`USER       `&  set the DN, for authenticating the LDAP bind
7085 &`PASS       `&  set the password, likewise
7086 &`REFERRALS  `&  set the referrals parameter
7087 &`SIZE       `&  set the limit for the number of entries returned
7088 &`TIME       `&  set the maximum waiting time for a query
7089 .endd
7090 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7091 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7092 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7093 library from trying to follow referrals issued by the LDAP server.
7094
7095 The name CONNECT is an obsolete name for NETTIME, retained for
7096 backwards compatibility. This timeout (specified as a number of seconds) is
7097 enforced from the client end for operations that can be carried out over a
7098 network. Specifically, it applies to network connections and calls to the
7099 &'ldap_result()'& function. If the value is greater than zero, it is used if
7100 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7101 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7102 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7103 Netscape SDK; for OpenLDAP no action is taken.
7104
7105 The TIME parameter (also a number of seconds) is passed to the server to
7106 set a server-side limit on the time taken to complete a search.
7107
7108
7109 Here is an example of an LDAP query in an Exim lookup that uses some of these
7110 values. This is a single line, folded to fit on the page:
7111 .code
7112 ${lookup ldap
7113   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7114   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7115   {$value}fail}
7116 .endd
7117 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7118 any of the auxiliary data. Exim configuration settings that include lookups
7119 which contain password information should be preceded by &"hide"& to prevent
7120 non-admin users from using the &%-bP%& option to see their values.
7121
7122 The auxiliary data items may be given in any order. The default is no
7123 connection timeout (the system timeout is used), no user or password, no limit
7124 on the number of entries returned, and no time limit on queries.
7125
7126 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7127 removes any URL quoting that it may contain before passing it LDAP. Apparently
7128 some libraries do this for themselves, but some do not. Removing the URL
7129 quoting has two advantages:
7130
7131 .ilist
7132 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7133 DNs as with DNs inside actual queries.
7134 .next
7135 It permits spaces inside USER= DNs.
7136 .endlist
7137
7138 For example, a setting such as
7139 .code
7140 USER=cn=${quote_ldap_dn:$1}
7141 .endd
7142 should work even if &$1$& contains spaces.
7143
7144 Expanded data for the PASS= value should be quoted using the &%quote%&
7145 expansion operator, rather than the LDAP quote operators. The only reason this
7146 field needs quoting is to ensure that it conforms to the Exim syntax, which
7147 does not allow unquoted spaces. For example:
7148 .code
7149 PASS=${quote:$3}
7150 .endd
7151 The LDAP authentication mechanism can be used to check passwords as part of
7152 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7153 &<<CHAPexpand>>&.
7154
7155
7156
7157 .section "Format of data returned by LDAP" "SECID71"
7158 .cindex "LDAP" "returned data formats"
7159 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7160 as a sequence of values, for example
7161 .code
7162 cn=manager, o=University of Cambridge, c=UK
7163 .endd
7164 The &(ldap)& lookup type generates an error if more than one entry matches the
7165 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7166 the result between the data from different entries. It is possible for multiple
7167 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7168 you know that whatever values are returned all came from a single entry in the
7169 directory.
7170
7171 In the common case where you specify a single attribute in your LDAP query, the
7172 result is not quoted, and does not contain the attribute name. If the attribute
7173 has multiple values, they are separated by commas.
7174
7175 If you specify multiple attributes, the result contains space-separated, quoted
7176 strings, each preceded by the attribute name and an equals sign. Within the
7177 quotes, the quote character, backslash, and newline are escaped with
7178 backslashes, and commas are used to separate multiple values for the attribute.
7179 Apart from the escaping, the string within quotes takes the same form as the
7180 output when a single attribute is requested. Specifying no attributes is the
7181 same as specifying all of an entry's attributes.
7182
7183 Here are some examples of the output format. The first line of each pair is an
7184 LDAP query, and the second is the data that is returned. The attribute called
7185 &%attr1%& has two values, whereas &%attr2%& has only one value:
7186 .code
7187 ldap:///o=base?attr1?sub?(uid=fred)
7188 value1.1, value1.2
7189
7190 ldap:///o=base?attr2?sub?(uid=fred)
7191 value two
7192
7193 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7194 attr1="value1.1, value1.2" attr2="value two"
7195
7196 ldap:///o=base??sub?(uid=fred)
7197 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7198 .endd
7199 The &%extract%& operator in string expansions can be used to pick out
7200 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7201 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7202 results of LDAP lookups.
7203
7204
7205
7206
7207 .section "More about NIS+" "SECTnisplus"
7208 .cindex "NIS+ lookup type"
7209 .cindex "lookup" "NIS+"
7210 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7211 and field name. If this is given, the result of a successful query is the
7212 contents of the named field; otherwise the result consists of a concatenation
7213 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7214 values containing spaces are quoted. For example, the query
7215 .code
7216 [name=mg1456],passwd.org_dir
7217 .endd
7218 might return the string
7219 .code
7220 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7221 home=/home/mg1456 shell=/bin/bash shadow=""
7222 .endd
7223 (split over two lines here to fit on the page), whereas
7224 .code
7225 [name=mg1456],passwd.org_dir:gcos
7226 .endd
7227 would just return
7228 .code
7229 Martin Guerre
7230 .endd
7231 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7232 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7233 operator is to double any quote characters within the text.
7234
7235
7236
7237 .section "SQL lookups" "SECTsql"
7238 .cindex "SQL lookup types"
7239 .cindex "MySQL" "lookup type"
7240 .cindex "PostgreSQL lookup type"
7241 .cindex "lookup" "MySQL"
7242 .cindex "lookup" "PostgreSQL"
7243 .cindex "Oracle" "lookup type"
7244 .cindex "lookup" "Oracle"
7245 .cindex "InterBase lookup type"
7246 .cindex "lookup" "InterBase"
7247 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7248 databases. Queries for these databases contain SQL statements, so an example
7249 might be
7250 .code
7251 ${lookup mysql{select mailbox from users where id='userx'}\
7252   {$value}fail}
7253 .endd
7254 If the result of the query contains more than one field, the data for each
7255 field in the row is returned, preceded by its name, so the result of
7256 .code
7257 ${lookup pgsql{select home,name from users where id='userx'}\
7258   {$value}}
7259 .endd
7260 might be
7261 .code
7262 home=/home/userx name="Mister X"
7263 .endd
7264 Empty values and values containing spaces are double quoted, with embedded
7265 quotes escaped by a backslash. If the result of the query contains just one
7266 field, the value is passed back verbatim, without a field name, for example:
7267 .code
7268 Mister X
7269 .endd
7270 If the result of the query yields more than one row, it is all concatenated,
7271 with a newline between the data for each row.
7272
7273
7274 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7275 .cindex "MySQL" "lookup type"
7276 .cindex "PostgreSQL lookup type"
7277 .cindex "lookup" "MySQL"
7278 .cindex "lookup" "PostgreSQL"
7279 .cindex "Oracle" "lookup type"
7280 .cindex "lookup" "Oracle"
7281 .cindex "InterBase lookup type"
7282 .cindex "lookup" "InterBase"
7283 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7284 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7285 option (as appropriate) must be set to a colon-separated list of server
7286 information.
7287 (For MySQL and PostgreSQL only, the global option need not be set if all
7288 queries contain their own server information &-- see section
7289 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7290 items: host name, database name, user name, and password. In the case of
7291 Oracle, the host name field is used for the &"service name"&, and the database
7292 name field is not used and should be empty. For example:
7293 .code
7294 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7295 .endd
7296 Because password data is sensitive, you should always precede the setting with
7297 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7298 option. Here is an example where two MySQL servers are listed:
7299 .code
7300 hide mysql_servers = localhost/users/root/secret:\
7301                      otherhost/users/root/othersecret
7302 .endd
7303 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7304 because this is a colon-separated list, the colon has to be doubled. For each
7305 query, these parameter groups are tried in order until a connection is made and
7306 a query is successfully processed. The result of a query may be that no data is
7307 found, but that is still a successful query. In other words, the list of
7308 servers provides a backup facility, not a list of different places to look.
7309
7310 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7311 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7312 respectively, and the characters single-quote, double-quote, and backslash
7313 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7314 addition, escapes the percent and underscore characters. This cannot be done
7315 for MySQL because these escapes are not recognized in contexts where these
7316 characters are not special.
7317
7318 .section "Specifying the server in the query" "SECTspeserque"
7319 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7320 it is possible to specify a list of servers with an individual query. This is
7321 done by starting the query with
7322 .display
7323 &`servers=`&&'server1:server2:server3:...'&&`;`&
7324 .endd
7325 Each item in the list may take one of two forms:
7326 .olist
7327 If it contains no slashes it is assumed to be just a host name. The appropriate
7328 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7329 of the same name, and the remaining parameters (database, user, password) are
7330 taken from there.
7331 .next
7332 If it contains any slashes, it is taken as a complete parameter set.
7333 .endlist
7334 The list of servers is used in exactly the same way as the global list.
7335 Once a connection to a server has happened and a query has been
7336 successfully executed, processing of the lookup ceases.
7337
7338 This feature is intended for use in master/slave situations where updates
7339 are occurring and you want to update the master rather than a slave. If the
7340 master is in the list as a backup for reading, you might have a global setting
7341 like this:
7342 .code
7343 mysql_servers = slave1/db/name/pw:\
7344                 slave2/db/name/pw:\
7345                 master/db/name/pw
7346 .endd
7347 In an updating lookup, you could then write:
7348 .code
7349 ${lookup mysql{servers=master; UPDATE ...} }
7350 .endd
7351 That query would then be sent only to the master server. If, on the other hand,
7352 the master is not to be used for reading, and so is not present in the global
7353 option, you can still update it by a query of this form:
7354 .code
7355 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7356 .endd
7357
7358
7359 .section "Special MySQL features" "SECID73"
7360 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7361 causes a connection to the server on the local host by means of a Unix domain
7362 socket. An alternate socket can be specified in parentheses. The full syntax of
7363 each item in &%mysql_servers%& is:
7364 .display
7365 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7366   <&'user'&>/<&'password'&>
7367 .endd
7368 Any of the three sub-parts of the first field can be omitted. For normal use on
7369 the local host it can be left blank or set to just &"localhost"&.
7370
7371 No database need be supplied &-- but if it is absent here, it must be given in
7372 the queries.
7373
7374 If a MySQL query is issued that does not request any data (an insert, update,
7375 or delete command), the result of the lookup is the number of rows affected.
7376
7377 &*Warning*&: This can be misleading. If an update does not actually change
7378 anything (for example, setting a field to the value it already has), the result
7379 is zero because no rows are affected.
7380
7381
7382 .section "Special PostgreSQL features" "SECID74"
7383 PostgreSQL lookups can also use Unix domain socket connections to the database.
7384 This is usually faster and costs less CPU time than a TCP/IP connection.
7385 However it can be used only if the mail server runs on the same machine as the
7386 database server. A configuration line for PostgreSQL via Unix domain sockets
7387 looks like this:
7388 .code
7389 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7390 .endd
7391 In other words, instead of supplying a host name, a path to the socket is
7392 given. The path name is enclosed in parentheses so that its slashes aren't
7393 visually confused with the delimiters for the other server parameters.
7394
7395 If a PostgreSQL query is issued that does not request any data (an insert,
7396 update, or delete command), the result of the lookup is the number of rows
7397 affected.
7398
7399 .section "More about SQLite" "SECTsqlite"
7400 .cindex "lookup" "SQLite"
7401 .cindex "sqlite lookup type"
7402 SQLite is different to the other SQL lookups because a file name is required in
7403 addition to the SQL query. An SQLite database is a single file, and there is no
7404 daemon as in the other SQL databases. The interface to Exim requires the name
7405 of the file, as an absolute path, to be given at the start of the query. It is
7406 separated from the query by white space. This means that the path name cannot
7407 contain white space. Here is a lookup expansion example:
7408 .code
7409 ${lookup sqlite {/some/thing/sqlitedb \
7410   select name from aliases where id='userx';}}
7411 .endd
7412 In a list, the syntax is similar. For example:
7413 .code
7414 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7415    select * from relays where ip='$sender_host_address';
7416 .endd
7417 The only character affected by the &%quote_sqlite%& operator is a single
7418 quote, which it doubles.
7419
7420 The SQLite library handles multiple simultaneous accesses to the database
7421 internally. Multiple readers are permitted, but only one process can
7422 update at once. Attempts to access the database while it is being updated
7423 are rejected after a timeout period, during which the SQLite library
7424 waits for the lock to be released. In Exim, the default timeout is set
7425 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7426 option.
7427 .ecindex IIDfidalo1
7428 .ecindex IIDfidalo2
7429
7430
7431 . ////////////////////////////////////////////////////////////////////////////
7432 . ////////////////////////////////////////////////////////////////////////////
7433
7434 .chapter "Domain, host, address, and local part lists" &&&
7435          "CHAPdomhosaddlists" &&&
7436          "Domain, host, and address lists"
7437 .scindex IIDdohoadli "lists of domains; hosts; etc."
7438 A number of Exim configuration options contain lists of domains, hosts,
7439 email addresses, or local parts. For example, the &%hold_domains%& option
7440 contains a list of domains whose delivery is currently suspended. These lists
7441 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7442 arguments to expansion conditions such as &%match_domain%&.
7443
7444 Each item in one of these lists is a pattern to be matched against a domain,
7445 host, email address, or local part, respectively. In the sections below, the
7446 different types of pattern for each case are described, but first we cover some
7447 general facilities that apply to all four kinds of list.
7448
7449
7450
7451 .section "Expansion of lists" "SECID75"
7452 .cindex "expansion" "of lists"
7453 Each list is expanded as a single string before it is used. The result of
7454 expansion must be a list, possibly containing empty items, which is split up
7455 into separate items for matching. By default, colon is the separator character,
7456 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7457 &<<SECTempitelis>>& for details of the list syntax; the second of these
7458 discusses the way to specify empty list items.
7459
7460
7461 If the string expansion is forced to fail, Exim behaves as if the item it is
7462 testing (domain, host, address, or local part) is not in the list. Other
7463 expansion failures cause temporary errors.
7464
7465 If an item in a list is a regular expression, backslashes, dollars and possibly
7466 other special characters in the expression must be protected against
7467 misinterpretation by the string expander. The easiest way to do this is to use
7468 the &`\N`& expansion feature to indicate that the contents of the regular
7469 expression should not be expanded. For example, in an ACL you might have:
7470 .code
7471 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7472                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7473 .endd
7474 The first item is a regular expression that is protected from expansion by
7475 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7476 senders based on the receiving domain.
7477
7478
7479
7480
7481 .section "Negated items in lists" "SECID76"
7482 .cindex "list" "negation"
7483 .cindex "negation" "in lists"
7484 Items in a list may be positive or negative. Negative items are indicated by a
7485 leading exclamation mark, which may be followed by optional white space. A list
7486 defines a set of items (domains, etc). When Exim processes one of these lists,
7487 it is trying to find out whether a domain, host, address, or local part
7488 (respectively) is in the set that is defined by the list. It works like this:
7489
7490 The list is scanned from left to right. If a positive item is matched, the
7491 subject that is being checked is in the set; if a negative item is matched, the
7492 subject is not in the set. If the end of the list is reached without the
7493 subject having matched any of the patterns, it is in the set if the last item
7494 was a negative one, but not if it was a positive one. For example, the list in
7495 .code
7496 domainlist relay_domains = !a.b.c : *.b.c
7497 .endd
7498 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7499 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7500 list is positive. However, if the setting were
7501 .code
7502 domainlist relay_domains = !a.b.c
7503 .endd
7504 then all domains other than &'a.b.c'& would match because the last item in the
7505 list is negative. In other words, a list that ends with a negative item behaves
7506 as if it had an extra item &`:*`& on the end.
7507
7508 Another way of thinking about positive and negative items in lists is to read
7509 the connector as &"or"& after a positive item and as &"and"& after a negative
7510 item.
7511
7512
7513
7514 .section "File names in lists" "SECTfilnamlis"
7515 .cindex "list" "file name in"
7516 If an item in a domain, host, address, or local part list is an absolute file
7517 name (beginning with a slash character), each line of the file is read and
7518 processed as if it were an independent item in the list, except that further
7519 file names are not allowed,
7520 and no expansion of the data from the file takes place.
7521 Empty lines in the file are ignored, and the file may also contain comment
7522 lines:
7523
7524 .ilist
7525 For domain and host lists, if a # character appears anywhere in a line of the
7526 file, it and all following characters are ignored.
7527 .next
7528 Because local parts may legitimately contain # characters, a comment in an
7529 address list or local part list file is recognized only if # is preceded by
7530 white space or the start of the line. For example:
7531 .code
7532 not#comment@x.y.z   # but this is a comment
7533 .endd
7534 .endlist
7535
7536 Putting a file name in a list has the same effect as inserting each line of the
7537 file as an item in the list (blank lines and comments excepted). However, there
7538 is one important difference: the file is read each time the list is processed,
7539 so if its contents vary over time, Exim's behaviour changes.
7540
7541 If a file name is preceded by an exclamation mark, the sense of any match
7542 within the file is inverted. For example, if
7543 .code
7544 hold_domains = !/etc/nohold-domains
7545 .endd
7546 and the file contains the lines
7547 .code
7548 !a.b.c
7549 *.b.c
7550 .endd
7551 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7552 any domain matching &`*.b.c`& is not.
7553
7554
7555
7556 .section "An lsearch file is not an out-of-line list" "SECID77"
7557 As will be described in the sections that follow, lookups can be used in lists
7558 to provide indexed methods of checking list membership. There has been some
7559 confusion about the way &(lsearch)& lookups work in lists. Because
7560 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7561 sometimes thought that it is allowed to contain wild cards and other kinds of
7562 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7563 always fixed strings, just as for any other single-key lookup type.
7564
7565 If you want to use a file to contain wild-card patterns that form part of a
7566 list, just give the file name on its own, without a search type, as described
7567 in the previous section. You could also use the &(wildlsearch)& or
7568 &(nwildlsearch)&, but there is no advantage in doing this.
7569
7570
7571
7572
7573 .section "Named lists" "SECTnamedlists"
7574 .cindex "named lists"
7575 .cindex "list" "named"
7576 A list of domains, hosts, email addresses, or local parts can be given a name
7577 which is then used to refer to the list elsewhere in the configuration. This is
7578 particularly convenient if the same list is required in several different
7579 places. It also allows lists to be given meaningful names, which can improve
7580 the readability of the configuration. For example, it is conventional to define
7581 a domain list called &'local_domains'& for all the domains that are handled
7582 locally on a host, using a configuration line such as
7583 .code
7584 domainlist local_domains = localhost:my.dom.example
7585 .endd
7586 Named lists are referenced by giving their name preceded by a plus sign, so,
7587 for example, a router that is intended to handle local domains would be
7588 configured with the line
7589 .code
7590 domains = +local_domains
7591 .endd
7592 The first router in a configuration is often one that handles all domains
7593 except the local ones, using a configuration with a negated item like this:
7594 .code
7595 dnslookup:
7596   driver = dnslookup
7597   domains = ! +local_domains
7598   transport = remote_smtp
7599   no_more
7600 .endd
7601 The four kinds of named list are created by configuration lines starting with
7602 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7603 respectively. Then there follows the name that you are defining, followed by an
7604 equals sign and the list itself. For example:
7605 .code
7606 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7607 addresslist bad_senders = cdb;/etc/badsenders
7608 .endd
7609 A named list may refer to other named lists:
7610 .code
7611 domainlist  dom1 = first.example : second.example
7612 domainlist  dom2 = +dom1 : third.example
7613 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7614 .endd
7615 &*Warning*&: If the last item in a referenced list is a negative one, the
7616 effect may not be what you intended, because the negation does not propagate
7617 out to the higher level. For example, consider:
7618 .code
7619 domainlist  dom1 = !a.b
7620 domainlist  dom2 = +dom1 : *.b
7621 .endd
7622 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7623 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7624 means it matches the second list as well. The effect is not the same as
7625 .code
7626 domainlist  dom2 = !a.b : *.b
7627 .endd
7628 where &'x.y'& does not match. It's best to avoid negation altogether in
7629 referenced lists if you can.
7630
7631 Named lists may have a performance advantage. When Exim is routing an
7632 address or checking an incoming message, it caches the result of tests on named
7633 lists. So, if you have a setting such as
7634 .code
7635 domains = +local_domains
7636 .endd
7637 on several of your routers
7638 or in several ACL statements,
7639 the actual test is done only for the first one. However, the caching works only
7640 if there are no expansions within the list itself or any sublists that it
7641 references. In other words, caching happens only for lists that are known to be
7642 the same each time they are referenced.
7643
7644 By default, there may be up to 16 named lists of each type. This limit can be
7645 extended by changing a compile-time variable. The use of domain and host lists
7646 is recommended for concepts such as local domains, relay domains, and relay
7647 hosts. The default configuration is set up like this.
7648
7649
7650
7651 .section "Named lists compared with macros" "SECID78"
7652 .cindex "list" "named compared with macro"
7653 .cindex "macro" "compared with named list"
7654 At first sight, named lists might seem to be no different from macros in the
7655 configuration file. However, macros are just textual substitutions. If you
7656 write
7657 .code
7658 ALIST = host1 : host2
7659 auth_advertise_hosts = !ALIST
7660 .endd
7661 it probably won't do what you want, because that is exactly the same as
7662 .code
7663 auth_advertise_hosts = !host1 : host2
7664 .endd
7665 Notice that the second host name is not negated. However, if you use a host
7666 list, and write
7667 .code
7668 hostlist alist = host1 : host2
7669 auth_advertise_hosts = ! +alist
7670 .endd
7671 the negation applies to the whole list, and so that is equivalent to
7672 .code
7673 auth_advertise_hosts = !host1 : !host2
7674 .endd
7675
7676
7677 .section "Named list caching" "SECID79"
7678 .cindex "list" "caching of named"
7679 .cindex "caching" "named lists"
7680 While processing a message, Exim caches the result of checking a named list if
7681 it is sure that the list is the same each time. In practice, this means that
7682 the cache operates only if the list contains no $ characters, which guarantees
7683 that it will not change when it is expanded. Sometimes, however, you may have
7684 an expanded list that you know will be the same each time within a given
7685 message. For example:
7686 .code
7687 domainlist special_domains = \
7688            ${lookup{$sender_host_address}cdb{/some/file}}
7689 .endd
7690 This provides a list of domains that depends only on the sending host's IP
7691 address. If this domain list is referenced a number of times (for example,
7692 in several ACL lines, or in several routers) the result of the check is not
7693 cached by default, because Exim does not know that it is going to be the
7694 same list each time.
7695
7696 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7697 cache the result anyway. For example:
7698 .code
7699 domainlist_cache special_domains = ${lookup{...
7700 .endd
7701 If you do this, you should be absolutely sure that caching is going to do
7702 the right thing in all cases. When in doubt, leave it out.
7703
7704
7705
7706 .section "Domain lists" "SECTdomainlist"
7707 .cindex "domain list" "patterns for"
7708 .cindex "list" "domain list"
7709 Domain lists contain patterns that are to be matched against a mail domain.
7710 The following types of item may appear in domain lists:
7711
7712 .ilist
7713 .cindex "primary host name"
7714 .cindex "host name" "matched in domain list"
7715 .oindex "&%primary_hostname%&"
7716 .cindex "domain list" "matching primary host name"
7717 .cindex "@ in a domain list"
7718 If a pattern consists of a single @ character, it matches the local host name,
7719 as set by the &%primary_hostname%& option (or defaulted). This makes it
7720 possible to use the same configuration file on several different hosts that
7721 differ only in their names.
7722 .next
7723 .cindex "@[] in a domain list"
7724 .cindex "domain list" "matching local IP interfaces"
7725 .cindex "domain literal"
7726 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7727 in square brackets (as in an email address that contains a domain literal), but
7728 only if that IP address is recognized as local for email routing purposes. The
7729 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7730 control which of a host's several IP addresses are treated as local.
7731 In today's Internet, the use of domain literals is controversial.
7732 .next
7733 .cindex "@mx_any"
7734 .cindex "@mx_primary"
7735 .cindex "@mx_secondary"
7736 .cindex "domain list" "matching MX pointers to local host"
7737 If a pattern consists of the string &`@mx_any`& it matches any domain that
7738 has an MX record pointing to the local host or to any host that is listed in
7739 .oindex "&%hosts_treat_as_local%&"
7740 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7741 are similar, except that the first matches only when a primary MX target is the
7742 local host, and the second only when no primary MX target is the local host,
7743 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7744 preference value &-- there may of course be more than one of them.
7745
7746 The MX lookup that takes place when matching a pattern of this type is
7747 performed with the resolver options for widening names turned off. Thus, for
7748 example, a single-component domain will &'not'& be expanded by adding the
7749 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7750 options of the &(dnslookup)& router for a discussion of domain widening.
7751
7752 Sometimes you may want to ignore certain IP addresses when using one of these
7753 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7754 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7755 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7756 on a router). For example:
7757 .code
7758 domains = @mx_any/ignore=127.0.0.1
7759 .endd
7760 This example matches any domain that has an MX record pointing to one of
7761 the local host's IP addresses other than 127.0.0.1.
7762
7763 The list of IP addresses is in fact processed by the same code that processes
7764 host lists, so it may contain CIDR-coded network specifications and it may also
7765 contain negative items.
7766
7767 Because the list of IP addresses is a sublist within a domain list, you have to
7768 be careful about delimiters if there is more than one address. Like any other
7769 list, the default delimiter can be changed. Thus, you might have:
7770 .code
7771 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7772           an.other.domain : ...
7773 .endd
7774 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7775 involved, it is easiest to change the delimiter for the main list as well:
7776 .code
7777 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7778           an.other.domain ? ...
7779 .endd
7780 .next
7781 .cindex "asterisk" "in domain list"
7782 .cindex "domain list" "asterisk in"
7783 .cindex "domain list" "matching &""ends with""&"
7784 If a pattern starts with an asterisk, the remaining characters of the pattern
7785 are compared with the terminating characters of the domain. The use of &"*"& in
7786 domain lists differs from its use in partial matching lookups. In a domain
7787 list, the character following the asterisk need not be a dot, whereas partial
7788 matching works only in terms of dot-separated components. For example, a domain
7789 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7790 &'cipher.key.ex'&.
7791
7792 .next
7793 .cindex "regular expressions" "in domain list"
7794 .cindex "domain list" "matching regular expression"
7795 If a pattern starts with a circumflex character, it is treated as a regular
7796 expression, and matched against the domain using a regular expression matching
7797 function. The circumflex is treated as part of the regular expression.
7798 Email domains are case-independent, so this regular expression match is by
7799 default case-independent, but you can make it case-dependent by starting it
7800 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7801 are given in chapter &<<CHAPregexp>>&.
7802
7803 &*Warning*&: Because domain lists are expanded before being processed, you
7804 must escape any backslash and dollar characters in the regular expression, or
7805 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7806 it is not to be expanded (unless you really do want to build a regular
7807 expression by expansion, of course).
7808 .next
7809 .cindex "lookup" "in domain list"
7810 .cindex "domain list" "matching by lookup"
7811 If a pattern starts with the name of a single-key lookup type followed by a
7812 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7813 must be a file name in a suitable format for the lookup type. For example, for
7814 &"cdb;"& it must be an absolute path:
7815 .code
7816 domains = cdb;/etc/mail/local_domains.cdb
7817 .endd
7818 The appropriate type of lookup is done on the file using the domain name as the
7819 key. In most cases, the data that is looked up is not used; Exim is interested
7820 only in whether or not the key is present in the file. However, when a lookup
7821 is used for the &%domains%& option on a router
7822 or a &%domains%& condition in an ACL statement, the data is preserved in the
7823 &$domain_data$& variable and can be referred to in other router options or
7824 other statements in the same ACL.
7825
7826 .next
7827 Any of the single-key lookup type names may be preceded by
7828 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7829 .code
7830 domains = partial-dbm;/partial/domains
7831 .endd
7832 This causes partial matching logic to be invoked; a description of how this
7833 works is given in section &<<SECTpartiallookup>>&.
7834
7835 .next
7836 .cindex "asterisk" "in lookup type"
7837 Any of the single-key lookup types may be followed by an asterisk. This causes
7838 a default lookup for a key consisting of a single asterisk to be done if the
7839 original lookup fails. This is not a useful feature when using a domain list to
7840 select particular domains (because any domain would match), but it might have
7841 value if the result of the lookup is being used via the &$domain_data$&
7842 expansion variable.
7843 .next
7844 If the pattern starts with the name of a query-style lookup type followed by a
7845 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7846 pattern must be an appropriate query for the lookup type, as described in
7847 chapter &<<CHAPfdlookup>>&. For example:
7848 .code
7849 hold_domains = mysql;select domain from holdlist \
7850   where domain = '${quote_mysql:$domain}';
7851 .endd
7852 In most cases, the data that is looked up is not used (so for an SQL query, for
7853 example, it doesn't matter what field you select). Exim is interested only in
7854 whether or not the query succeeds. However, when a lookup is used for the
7855 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7856 variable and can be referred to in other options.
7857 .next
7858 .cindex "domain list" "matching literal domain name"
7859 If none of the above cases apply, a caseless textual comparison is made
7860 between the pattern and the domain.
7861 .endlist
7862
7863 Here is an example that uses several different kinds of pattern:
7864 .code
7865 domainlist funny_domains = \
7866   @ : \
7867   lib.unseen.edu : \
7868   *.foundation.fict.example : \
7869   \N^[1-2]\d{3}\.fict\.example$\N : \
7870   partial-dbm;/opt/data/penguin/book : \
7871   nis;domains.byname : \
7872   nisplus;[name=$domain,status=local],domains.org_dir
7873 .endd
7874 There are obvious processing trade-offs among the various matching modes. Using
7875 an asterisk is faster than a regular expression, and listing a few names
7876 explicitly probably is too. The use of a file or database lookup is expensive,
7877 but may be the only option if hundreds of names are required. Because the
7878 patterns are tested in order, it makes sense to put the most commonly matched
7879 patterns earlier.
7880
7881
7882
7883 .section "Host lists" "SECThostlist"
7884 .cindex "host list" "patterns in"
7885 .cindex "list" "host list"
7886 Host lists are used to control what remote hosts are allowed to do. For
7887 example, some hosts may be allowed to use the local host as a relay, and some
7888 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7889 two different ways, by name or by IP address. In a host list, some types of
7890 pattern are matched to a host name, and some are matched to an IP address.
7891 You need to be particularly careful with this when single-key lookups are
7892 involved, to ensure that the right value is being used as the key.
7893
7894
7895 .section "Special host list patterns" "SECID80"
7896 .cindex "empty item in hosts list"
7897 .cindex "host list" "empty string in"
7898 If a host list item is the empty string, it matches only when no remote host is
7899 involved. This is the case when a message is being received from a local
7900 process using SMTP on the standard input, that is, when a TCP/IP connection is
7901 not used.
7902
7903 .cindex "asterisk" "in host list"
7904 The special pattern &"*"& in a host list matches any host or no host. Neither
7905 the IP address nor the name is actually inspected.
7906
7907
7908
7909 .section "Host list patterns that match by IP address" "SECThoslispatip"
7910 .cindex "host list" "matching IP addresses"
7911 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7912 the incoming address actually appears in the IPv6 host as
7913 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7914 list, it is converted into a traditional IPv4 address first. (Not all operating
7915 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7916 concerns.)
7917
7918 The following types of pattern in a host list check the remote host by
7919 inspecting its IP address:
7920
7921 .ilist
7922 If the pattern is a plain domain name (not a regular expression, not starting
7923 with *, not a lookup of any kind), Exim calls the operating system function
7924 to find the associated IP address(es). Exim uses the newer
7925 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7926 This typically causes a forward DNS lookup of the name. The result is compared
7927 with the IP address of the subject host.
7928
7929 If there is a temporary problem (such as a DNS timeout) with the host name
7930 lookup, a temporary error occurs. For example, if the list is being used in an
7931 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7932 temporary SMTP error code. If no IP address can be found for the host name,
7933 what happens is described in section &<<SECTbehipnot>>& below.
7934
7935 .next
7936 .cindex "@ in a host list"
7937 If the pattern is &"@"&, the primary host name is substituted and used as a
7938 domain name, as just described.
7939
7940 .next
7941 If the pattern is an IP address, it is matched against the IP address of the
7942 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7943 IPv6 addresses can be given in colon-separated format, but the colons have to
7944 be doubled so as not to be taken as item separators when the default list
7945 separator is used. IPv6 addresses are recognized even when Exim is compiled
7946 without IPv6 support. This means that if they appear in a host list on an
7947 IPv4-only host, Exim will not treat them as host names. They are just addresses
7948 that can never match a client host.
7949
7950 .next
7951 .cindex "@[] in a host list"
7952 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7953 the local host. For example, if the local host is an IPv4 host with one
7954 interface address 10.45.23.56, these two ACL statements have the same effect:
7955 .code
7956 accept hosts = 127.0.0.1 : 10.45.23.56
7957 accept hosts = @[]
7958 .endd
7959 .next
7960 .cindex "CIDR notation"
7961 If the pattern is an IP address followed by a slash and a mask length (for
7962 example 10.11.42.0/24), it is matched against the IP address of the subject
7963 host under the given mask. This allows, an entire network of hosts to be
7964 included (or excluded) by a single item. The mask uses CIDR notation; it
7965 specifies the number of address bits that must match, starting from the most
7966 significant end of the address.
7967
7968 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7969 of a range of addresses. It is the number of bits in the network portion of the
7970 address. The above example specifies a 24-bit netmask, so it matches all 256
7971 addresses in the 10.11.42.0 network. An item such as
7972 .code
7973 192.168.23.236/31
7974 .endd
7975 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7976 32 for an IPv4 address is the same as no mask at all; just a single address
7977 matches.
7978
7979 Here is another example which shows an IPv4 and an IPv6 network:
7980 .code
7981 recipient_unqualified_hosts = 192.168.0.0/16: \
7982                               3ffe::ffff::836f::::/48
7983 .endd
7984 The doubling of list separator characters applies only when these items
7985 appear inline in a host list. It is not required when indirecting via a file.
7986 For example:
7987 .code
7988 recipient_unqualified_hosts = /opt/exim/unqualnets
7989 .endd
7990 could make use of a file containing
7991 .code
7992 172.16.0.0/12
7993 3ffe:ffff:836f::/48
7994 .endd
7995 to have exactly the same effect as the previous example. When listing IPv6
7996 addresses inline, it is usually more convenient to use the facility for
7997 changing separator characters. This list contains the same two networks:
7998 .code
7999 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8000                                  3ffe:ffff:836f::/48
8001 .endd
8002 The separator is changed to semicolon by the leading &"<;"& at the start of the
8003 list.
8004 .endlist
8005
8006
8007
8008 .section "Host list patterns for single-key lookups by host address" &&&
8009          "SECThoslispatsikey"
8010 .cindex "host list" "lookup of IP address"
8011 When a host is to be identified by a single-key lookup of its complete IP
8012 address, the pattern takes this form:
8013 .display
8014 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8015 .endd
8016 For example:
8017 .code
8018 hosts_lookup = net-cdb;/hosts-by-ip.db
8019 .endd
8020 The text form of the IP address of the subject host is used as the lookup key.
8021 IPv6 addresses are converted to an unabbreviated form, using lower case
8022 letters, with dots as separators because colon is the key terminator in
8023 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8024 quoting the keys, but this is a facility that was added later.] The data
8025 returned by the lookup is not used.
8026
8027 .cindex "IP address" "masking"
8028 .cindex "host list" "masked IP address"
8029 Single-key lookups can also be performed using masked IP addresses, using
8030 patterns of this form:
8031 .display
8032 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8033 .endd
8034 For example:
8035 .code
8036 net24-dbm;/networks.db
8037 .endd
8038 The IP address of the subject host is masked using <&'number'&> as the mask
8039 length. A textual string is constructed from the masked value, followed by the
8040 mask, and this is used as the lookup key. For example, if the host's IP address
8041 is 192.168.34.6, the key that is looked up for the above example is
8042 &"192.168.34.0/24"&.
8043
8044 When an IPv6 address is converted to a string, dots are normally used instead
8045 of colons, so that keys in &(lsearch)& files need not contain colons (which
8046 terminate &(lsearch)& keys). This was implemented some time before the ability
8047 to quote keys was made available in &(lsearch)& files. However, the more
8048 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8049 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8050 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8051 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8052 addresses are always used.
8053
8054 Ideally, it would be nice to tidy up this anomalous situation by changing to
8055 colons in all cases, given that quoting is now available for &(lsearch)&.
8056 However, this would be an incompatible change that might break some existing
8057 configurations.
8058
8059 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8060 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8061 the former case the key strings include the mask value, whereas in the latter
8062 case the IP address is used on its own.
8063
8064
8065
8066 .section "Host list patterns that match by host name" "SECThoslispatnam"
8067 .cindex "host" "lookup failures"
8068 .cindex "unknown host name"
8069 .cindex "host list" "matching host name"
8070 There are several types of pattern that require Exim to know the name of the
8071 remote host. These are either wildcard patterns or lookups by name. (If a
8072 complete hostname is given without any wildcarding, it is used to find an IP
8073 address to match against, as described in the section &<<SECThoslispatip>>&
8074 above.)
8075
8076 If the remote host name is not already known when Exim encounters one of these
8077 patterns, it has to be found from the IP address.
8078 Although many sites on the Internet are conscientious about maintaining reverse
8079 DNS data for their hosts, there are also many that do not do this.
8080 Consequently, a name cannot always be found, and this may lead to unwanted
8081 effects. Take care when configuring host lists with wildcarded name patterns.
8082 Consider what will happen if a name cannot be found.
8083
8084 Because of the problems of determining host names from IP addresses, matching
8085 against host names is not as common as matching against IP addresses.
8086
8087 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8088 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8089 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8090 are done can be changed by setting the &%host_lookup_order%& option. For
8091 security, once Exim has found one or more names, it looks up the IP addresses
8092 for these names and compares them with the IP address that it started with.
8093 Only those names whose IP addresses match are accepted. Any other names are
8094 discarded. If no names are left, Exim behaves as if the host name cannot be
8095 found. In the most common case there is only one name and one IP address.
8096
8097 There are some options that control what happens if a host name cannot be
8098 found. These are described in section &<<SECTbehipnot>>& below.
8099
8100 .cindex "host" "alias for"
8101 .cindex "alias for host"
8102 As a result of aliasing, hosts may have more than one name. When processing any
8103 of the following types of pattern, all the host's names are checked:
8104
8105 .ilist
8106 .cindex "asterisk" "in host list"
8107 If a pattern starts with &"*"& the remainder of the item must match the end of
8108 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8109 &'.b.c'&. This special simple form is provided because this is a very common
8110 requirement. Other kinds of wildcarding require the use of a regular
8111 expression.
8112 .next
8113 .cindex "regular expressions" "in host list"
8114 .cindex "host list" "regular expression in"
8115 If the item starts with &"^"& it is taken to be a regular expression which is
8116 matched against the host name. Host names are case-independent, so this regular
8117 expression match is by default case-independent, but you can make it
8118 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8119 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8120 example,
8121 .code
8122 ^(a|b)\.c\.d$
8123 .endd
8124 is a regular expression that matches either of the two hosts &'a.c.d'& or
8125 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8126 that backslash and dollar characters are not misinterpreted as part of the
8127 string expansion. The simplest way to do this is to use &`\N`& to mark that
8128 part of the string as non-expandable. For example:
8129 .code
8130 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8131 .endd
8132 &*Warning*&: If you want to match a complete host name, you must include the
8133 &`$`& terminating metacharacter in the regular expression, as in the above
8134 example. Without it, a match at the start of the host name is all that is
8135 required.
8136 .endlist
8137
8138
8139
8140
8141 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8142 .cindex "host" "lookup failures, permanent"
8143 While processing a host list, Exim may need to look up an IP address from a
8144 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8145 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8146 behaviour when it fails to find the information it is seeking is the same.
8147
8148 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8149 apply to temporary DNS errors, whose handling is described in the next section.
8150
8151 .cindex "&`+include_unknown`&"
8152 .cindex "&`+ignore_unknown`&"
8153 By default, Exim behaves as if the host does not match the list. This may not
8154 always be what you want to happen. To change Exim's behaviour, the special
8155 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8156 top level &-- they are not recognized in an indirected file).
8157
8158 .ilist
8159 If any item that follows &`+include_unknown`& requires information that
8160 cannot found, Exim behaves as if the host does match the list. For example,
8161 .code
8162 host_reject_connection = +include_unknown:*.enemy.ex
8163 .endd
8164 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8165 any hosts whose name it cannot find.
8166
8167 .next
8168 If any item that follows &`+ignore_unknown`& requires information that cannot
8169 be found, Exim ignores that item and proceeds to the rest of the list. For
8170 example:
8171 .code
8172 accept hosts = +ignore_unknown : friend.example : \
8173                192.168.4.5
8174 .endd
8175 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8176 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8177 name can be found for 192.168.4.5, it is rejected.
8178 .endlist
8179
8180 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8181 list. The effect of each one lasts until the next, or until the end of the
8182 list.
8183
8184
8185 .section "Temporary DNS errors when looking up host information" &&&
8186          "SECTtemdnserr"
8187 .cindex "host" "lookup failures, temporary"
8188 .cindex "&`+include_defer`&"
8189 .cindex "&`+ignore_defer`&"
8190 A temporary DNS lookup failure normally causes a defer action (except when
8191 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8192 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8193 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8194 section. These options should be used with care, probably only in non-critical
8195 host lists such as whitelists.
8196
8197
8198
8199 .section "Host list patterns for single-key lookups by host name" &&&
8200          "SECThoslispatnamsk"
8201 .cindex "unknown host name"
8202 .cindex "host list" "matching host name"
8203 If a pattern is of the form
8204 .display
8205 <&'single-key-search-type'&>;<&'search-data'&>
8206 .endd
8207 for example
8208 .code
8209 dbm;/host/accept/list
8210 .endd
8211 a single-key lookup is performed, using the host name as its key. If the
8212 lookup succeeds, the host matches the item. The actual data that is looked up
8213 is not used.
8214
8215 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8216 keys in the file, not IP addresses. If you want to do lookups based on IP
8217 addresses, you must precede the search type with &"net-"& (see section
8218 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8219 two items in the same list, one doing an address lookup and one doing a name
8220 lookup, both using the same file.
8221
8222
8223
8224 .section "Host list patterns for query-style lookups" "SECID81"
8225 If a pattern is of the form
8226 .display
8227 <&'query-style-search-type'&>;<&'query'&>
8228 .endd
8229 the query is obeyed, and if it succeeds, the host matches the item. The actual
8230 data that is looked up is not used. The variables &$sender_host_address$& and
8231 &$sender_host_name$& can be used in the query. For example:
8232 .code
8233 hosts_lookup = pgsql;\
8234   select ip from hostlist where ip='$sender_host_address'
8235 .endd
8236 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8237 can use the &%sg%& expansion item to change this if you need to. If you want to
8238 use masked IP addresses in database queries, you can use the &%mask%& expansion
8239 operator.
8240
8241 If the query contains a reference to &$sender_host_name$&, Exim automatically
8242 looks up the host name if has not already done so. (See section
8243 &<<SECThoslispatnam>>& for comments on finding host names.)
8244
8245 Historical note: prior to release 4.30, Exim would always attempt to find a
8246 host name before running the query, unless the search type was preceded by
8247 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8248 still recognized for query-style lookups, but its presence or absence has no
8249 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8250 See section &<<SECThoslispatsikey>>&.)
8251
8252
8253
8254 .section "Mixing wildcarded host names and addresses in host lists" &&&
8255          "SECTmixwilhos"
8256 .cindex "host list" "mixing names and addresses in"
8257 If you have name lookups or wildcarded host names and IP addresses in the same
8258 host list, you should normally put the IP addresses first. For example, in an
8259 ACL you could have:
8260 .code
8261 accept hosts = 10.9.8.7 : *.friend.example
8262 .endd
8263 The reason for this lies in the left-to-right way that Exim processes lists.
8264 It can test IP addresses without doing any DNS lookups, but when it reaches an
8265 item that requires a host name, it fails if it cannot find a host name to
8266 compare with the pattern. If the above list is given in the opposite order, the
8267 &%accept%& statement fails for a host whose name cannot be found, even if its
8268 IP address is 10.9.8.7.
8269
8270 If you really do want to do the name check first, and still recognize the IP
8271 address, you can rewrite the ACL like this:
8272 .code
8273 accept hosts = *.friend.example
8274 accept hosts = 10.9.8.7
8275 .endd
8276 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8277 &<<CHAPACL>>& for details of ACLs.
8278
8279
8280
8281
8282
8283 .section "Address lists" "SECTaddresslist"
8284 .cindex "list" "address list"
8285 .cindex "address list" "empty item"
8286 .cindex "address list" "patterns"
8287 Address lists contain patterns that are matched against mail addresses. There
8288 is one special case to be considered: the sender address of a bounce message is
8289 always empty. You can test for this by providing an empty item in an address
8290 list. For example, you can set up a router to process bounce messages by
8291 using this option setting:
8292 .code
8293 senders = :
8294 .endd
8295 The presence of the colon creates an empty item. If you do not provide any
8296 data, the list is empty and matches nothing. The empty sender can also be
8297 detected by a regular expression that matches an empty string,
8298 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8299
8300 Non-empty items in an address list can be straightforward email addresses. For
8301 example:
8302 .code
8303 senders = jbc@askone.example : hs@anacreon.example
8304 .endd
8305 A certain amount of wildcarding is permitted. If a pattern contains an @
8306 character, but is not a regular expression and does not begin with a
8307 semicolon-terminated lookup type (described below), the local part of the
8308 subject address is compared with the local part of the pattern, which may start
8309 with an asterisk. If the local parts match, the domain is checked in exactly
8310 the same way as for a pattern in a domain list. For example, the domain can be
8311 wildcarded, refer to a named list, or be a lookup:
8312 .code
8313 deny senders = *@*.spamming.site:\
8314                *@+hostile_domains:\
8315                bozo@partial-lsearch;/list/of/dodgy/sites:\
8316                *@dbm;/bad/domains.db
8317 .endd
8318 .cindex "local part" "starting with !"
8319 .cindex "address list" "local part starting with !"
8320 If a local part that begins with an exclamation mark is required, it has to be
8321 specified using a regular expression, because otherwise the exclamation mark is
8322 treated as a sign of negation, as is standard in lists.
8323
8324 If a non-empty pattern that is not a regular expression or a lookup does not
8325 contain an @ character, it is matched against the domain part of the subject
8326 address. The only two formats that are recognized this way are a literal
8327 domain, or a domain pattern that starts with *. In both these cases, the effect
8328 is the same as if &`*@`& preceded the pattern. For example:
8329 .code
8330 deny senders = enemy.domain : *.enemy.domain
8331 .endd
8332
8333 The following kinds of more complicated address list pattern can match any
8334 address, including the empty address that is characteristic of bounce message
8335 senders:
8336
8337 .ilist
8338 .cindex "regular expressions" "in address list"
8339 .cindex "address list" "regular expression in"
8340 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8341 done against the complete address, with the pattern as the regular expression.
8342 You must take care that backslash and dollar characters are not misinterpreted
8343 as part of the string expansion. The simplest way to do this is to use &`\N`&
8344 to mark that part of the string as non-expandable. For example:
8345 .code
8346 deny senders = \N^.*this.*@example\.com$\N : \
8347                \N^\d{8}.+@spamhaus.example$\N : ...
8348 .endd
8349 The &`\N`& sequences are removed by the expansion, so these items do indeed
8350 start with &"^"& by the time they are being interpreted as address patterns.
8351
8352 .next
8353 .cindex "address list" "lookup for complete address"
8354 Complete addresses can be looked up by using a pattern that starts with a
8355 lookup type terminated by a semicolon, followed by the data for the lookup. For
8356 example:
8357 .code
8358 deny senders = cdb;/etc/blocked.senders : \
8359   mysql;select address from blocked where \
8360   address='${quote_mysql:$sender_address}'
8361 .endd
8362 Both query-style and single-key lookup types can be used. For a single-key
8363 lookup type, Exim uses the complete address as the key. However, empty keys are
8364 not supported for single-key lookups, so a match against the empty address
8365 always fails. This restriction does not apply to query-style lookups.
8366
8367 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8368 cannot be used, and is ignored if specified, with an entry being written to the
8369 panic log.
8370 .cindex "*@ with single-key lookup"
8371 However, you can configure lookup defaults, as described in section
8372 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8373 default. For example, with this lookup:
8374 .code
8375 accept senders = lsearch*@;/some/file
8376 .endd
8377 the file could contains lines like this:
8378 .code
8379 user1@domain1.example
8380 *@domain2.example
8381 .endd
8382 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8383 that are tried is:
8384 .code
8385 nimrod@jaeger.example
8386 *@jaeger.example
8387 *
8388 .endd
8389 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8390 would mean that every address matches, thus rendering the test useless.
8391
8392 &*Warning 2*&: Do not confuse these two kinds of item:
8393 .code
8394 deny recipients = dbm*@;/some/file
8395 deny recipients = *@dbm;/some/file
8396 .endd
8397 The first does a whole address lookup, with defaulting, as just described,
8398 because it starts with a lookup type. The second matches the local part and
8399 domain independently, as described in a bullet point below.
8400 .endlist
8401
8402
8403 The following kinds of address list pattern can match only non-empty addresses.
8404 If the subject address is empty, a match against any of these pattern types
8405 always fails.
8406
8407
8408 .ilist
8409 .cindex "@@ with single-key lookup"
8410 .cindex "address list" "@@ lookup type"
8411 .cindex "address list" "split local part and domain"
8412 If a pattern starts with &"@@"& followed by a single-key lookup item
8413 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8414 split into a local part and a domain. The domain is looked up in the file. If
8415 it is not found, there is no match. If it is found, the data that is looked up
8416 from the file is treated as a colon-separated list of local part patterns, each
8417 of which is matched against the subject local part in turn.
8418
8419 .cindex "asterisk" "in address list"
8420 The lookup may be a partial one, and/or one involving a search for a default
8421 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8422 patterns that are looked up can be regular expressions or begin with &"*"&, or
8423 even be further lookups. They may also be independently negated. For example,
8424 with
8425 .code
8426 deny senders = @@dbm;/etc/reject-by-domain
8427 .endd
8428 the data from which the DBM file is built could contain lines like
8429 .code
8430 baddomain.com:  !postmaster : *
8431 .endd
8432 to reject all senders except &%postmaster%& from that domain.
8433
8434 .cindex "local part" "starting with !"
8435 If a local part that actually begins with an exclamation mark is required, it
8436 has to be specified using a regular expression. In &(lsearch)& files, an entry
8437 may be split over several lines by indenting the second and subsequent lines,
8438 but the separating colon must still be included at line breaks. White space
8439 surrounding the colons is ignored. For example:
8440 .code
8441 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8442 spammer3 : spammer4
8443 .endd
8444 As in all colon-separated lists in Exim, a colon can be included in an item by
8445 doubling.
8446
8447 If the last item in the list starts with a right angle-bracket, the remainder
8448 of the item is taken as a new key to look up in order to obtain a continuation
8449 list of local parts. The new key can be any sequence of characters. Thus one
8450 might have entries like
8451 .code
8452 aol.com: spammer1 : spammer 2 : >*
8453 xyz.com: spammer3 : >*
8454 *:       ^\d{8}$
8455 .endd
8456 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8457 local parts for all domains, in addition to the specific local parts listed for
8458 each domain. Of course, using this feature costs another lookup each time a
8459 chain is followed, but the effort needed to maintain the data is reduced.
8460
8461 .cindex "loop" "in lookups"
8462 It is possible to construct loops using this facility, and in order to catch
8463 them, the chains may be no more than fifty items long.
8464
8465 .next
8466 The @@<&'lookup'&> style of item can also be used with a query-style
8467 lookup, but in this case, the chaining facility is not available. The lookup
8468 can only return a single list of local parts.
8469 .endlist
8470
8471 &*Warning*&: There is an important difference between the address list items
8472 in these two examples:
8473 .code
8474 senders = +my_list
8475 senders = *@+my_list
8476 .endd
8477 In the first one, &`my_list`& is a named address list, whereas in the second
8478 example it is a named domain list.
8479
8480
8481
8482
8483 .section "Case of letters in address lists" "SECTcasletadd"
8484 .cindex "case of local parts"
8485 .cindex "address list" "case forcing"
8486 .cindex "case forcing in address lists"
8487 Domains in email addresses are always handled caselessly, but for local parts
8488 case may be significant on some systems (see &%caseful_local_part%& for how
8489 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8490 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8491 blocking lists should be done in a case-independent manner. Since most address
8492 lists in Exim are used for this kind of control, Exim attempts to do this by
8493 default.
8494
8495 The domain portion of an address is always lowercased before matching it to an
8496 address list. The local part is lowercased by default, and any string
8497 comparisons that take place are done caselessly. This means that the data in
8498 the address list itself, in files included as plain file names, and in any file
8499 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8500 keys in files that are looked up by a search type other than &(lsearch)& (which
8501 works caselessly) must be in lower case, because these lookups are not
8502 case-independent.
8503
8504 .cindex "&`+caseful`&"
8505 To allow for the possibility of caseful address list matching, if an item in
8506 an address list is the string &"+caseful"&, the original case of the local
8507 part is restored for any comparisons that follow, and string comparisons are no
8508 longer case-independent. This does not affect the domain, which remains in
8509 lower case. However, although independent matches on the domain alone are still
8510 performed caselessly, regular expressions that match against an entire address
8511 become case-sensitive after &"+caseful"& has been seen.
8512
8513
8514
8515 .section "Local part lists" "SECTlocparlis"
8516 .cindex "list" "local part list"
8517 .cindex "local part" "list"
8518 Case-sensitivity in local part lists is handled in the same way as for address
8519 lists, as just described. The &"+caseful"& item can be used if required. In a
8520 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8521 set false, the subject is lowercased and the matching is initially
8522 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8523 matching in the local part list, but not elsewhere in the router. If
8524 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8525 option is case-sensitive from the start.
8526
8527 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8528 comments are handled in the same way as address lists &-- they are recognized
8529 only if the # is preceded by white space or the start of the line.
8530 Otherwise, local part lists are matched in the same way as domain lists, except
8531 that the special items that refer to the local host (&`@`&, &`@[]`&,
8532 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8533 Refer to section &<<SECTdomainlist>>& for details of the other available item
8534 types.
8535 .ecindex IIDdohoadli
8536
8537
8538
8539
8540 . ////////////////////////////////////////////////////////////////////////////
8541 . ////////////////////////////////////////////////////////////////////////////
8542
8543 .chapter "String expansions" "CHAPexpand"
8544 .scindex IIDstrexp "expansion" "of strings"
8545 Many strings in Exim's run time configuration are expanded before use. Some of
8546 them are expanded every time they are used; others are expanded only once.
8547
8548 When a string is being expanded it is copied verbatim from left to right except
8549 when a dollar or backslash character is encountered. A dollar specifies the
8550 start of a portion of the string that is interpreted and replaced as described
8551 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8552 escape character, as described in the following section.
8553
8554 Whether a string is expanded depends upon the context.  Usually this is solely
8555 dependent upon the option for which a value is sought; in this documentation,
8556 options for which string expansion is performed are marked with &dagger; after
8557 the data type.  ACL rules always expand strings.  A couple of expansion
8558 conditions do not expand some of the brace-delimited branches, for security
8559 reasons.
8560
8561
8562
8563 .section "Literal text in expanded strings" "SECTlittext"
8564 .cindex "expansion" "including literal text"
8565 An uninterpreted dollar can be included in an expanded string by putting a
8566 backslash in front of it. A backslash can be used to prevent any special
8567 character being treated specially in an expansion, including backslash itself.
8568 If the string appears in quotes in the configuration file, two backslashes are
8569 required because the quotes themselves cause interpretation of backslashes when
8570 the string is read in (see section &<<SECTstrings>>&).
8571
8572 .cindex "expansion" "non-expandable substrings"
8573 A portion of the string can specified as non-expandable by placing it between
8574 two occurrences of &`\N`&. This is particularly useful for protecting regular
8575 expressions, which often contain backslashes and dollar signs. For example:
8576 .code
8577 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8578 .endd
8579 On encountering the first &`\N`&, the expander copies subsequent characters
8580 without interpretation until it reaches the next &`\N`& or the end of the
8581 string.
8582
8583
8584
8585 .section "Character escape sequences in expanded strings" "SECID82"
8586 .cindex "expansion" "escape sequences"
8587 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8588 expanded string is recognized as an escape sequence for the character newline,
8589 carriage return, or tab, respectively. A backslash followed by up to three
8590 octal digits is recognized as an octal encoding for a single character, and a
8591 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8592 encoding.
8593
8594 These escape sequences are also recognized in quoted strings when they are read
8595 in. Their interpretation in expansions as well is useful for unquoted strings,
8596 and for other cases such as looked-up strings that are then expanded.
8597
8598
8599 .section "Testing string expansions" "SECID83"
8600 .cindex "expansion" "testing"
8601 .cindex "testing" "string expansion"
8602 .oindex "&%-be%&"
8603 Many expansions can be tested by calling Exim with the &%-be%& option. This
8604 takes the command arguments, or lines from the standard input if there are no
8605 arguments, runs them through the string expansion code, and writes the results
8606 to the standard output. Variables based on configuration values are set up, but
8607 since no message is being processed, variables such as &$local_part$& have no
8608 value. Nevertheless the &%-be%& option can be useful for checking out file and
8609 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8610 and &%nhash%&.
8611
8612 Exim gives up its root privilege when it is called with the &%-be%& option, and
8613 instead runs under the uid and gid it was called with, to prevent users from
8614 using &%-be%& for reading files to which they do not have access.
8615
8616 .oindex "&%-bem%&"
8617 If you want to test expansions that include variables whose values are taken
8618 from a message, there are two other options that can be used. The &%-bem%&
8619 option is like &%-be%& except that it is followed by a file name. The file is
8620 read as a message before doing the test expansions. For example:
8621 .code
8622 exim -bem /tmp/test.message '$h_subject:'
8623 .endd
8624 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8625 Exim message identifier. For example:
8626 .code
8627 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8628 .endd
8629 This loads the message from Exim's spool before doing the test expansions, and
8630 is therefore restricted to admin users.
8631
8632
8633 .section "Forced expansion failure" "SECTforexpfai"
8634 .cindex "expansion" "forced failure"
8635 A number of expansions that are described in the following section have
8636 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8637 (which are sometimes called &"curly brackets"&). Which of the two strings is
8638 used depends on some condition that is evaluated as part of the expansion. If,
8639 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8640 the entire string expansion fails in a way that can be detected by the code
8641 that requested the expansion. This is called &"forced expansion failure"&, and
8642 its consequences depend on the circumstances. In some cases it is no different
8643 from any other expansion failure, but in others a different action may be
8644 taken. Such variations are mentioned in the documentation of the option that is
8645 being expanded.
8646
8647
8648
8649
8650 .section "Expansion items" "SECTexpansionitems"
8651 The following items are recognized in expanded strings. White space may be used
8652 between sub-items that are keywords or substrings enclosed in braces inside an
8653 outer set of braces, to improve readability. &*Warning*&: Within braces,
8654 white space is significant.
8655
8656 .vlist
8657 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8658 .cindex "expansion" "variables"
8659 Substitute the contents of the named variable, for example:
8660 .code
8661 $local_part
8662 ${domain}
8663 .endd
8664 The second form can be used to separate the name from subsequent alphanumeric
8665 characters. This form (using braces) is available only for variables; it does
8666 &'not'& apply to message headers. The names of the variables are given in
8667 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8668 given, the expansion fails.
8669
8670 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8671 .cindex "expansion" "operators"
8672 The string is first itself expanded, and then the operation specified by
8673 <&'op'&> is applied to it. For example:
8674 .code
8675 ${lc:$local_part}
8676 .endd
8677 The string starts with the first character after the colon, which may be
8678 leading white space. A list of operators is given in section &<<SECTexpop>>&
8679 below. The operator notation is used for simple expansion items that have just
8680 one argument, because it reduces the number of braces and therefore makes the
8681 string easier to understand.
8682
8683 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8684 This item inserts &"basic"& header lines. It is described with the &%header%&
8685 expansion item below.
8686
8687 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8688        {*&<&'arg'&>&*}...}*&"
8689 .cindex &%dlfunc%&
8690 This expansion dynamically loads and then calls a locally-written C function.
8691 This functionality is available only if Exim is compiled with
8692 .code
8693 EXPAND_DLFUNC=yes
8694 .endd
8695 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8696 object so that it doesn't reload the same object file in the same Exim process
8697 (but of course Exim does start new processes frequently).
8698
8699 There may be from zero to eight arguments to the function. When compiling
8700 a local function that is to be called in this way, &_local_scan.h_& should be
8701 included. The Exim variables and functions that are defined by that API
8702 are also available for dynamically loaded functions. The function itself
8703 must have the following type:
8704 .code
8705 int dlfunction(uschar **yield, int argc, uschar *argv[])
8706 .endd
8707 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8708 function should return one of the following values:
8709
8710 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8711 into the expanded string that is being built.
8712
8713 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8714 from &'yield'&, if it is set.
8715
8716 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8717 taken from &'yield'& if it is set.
8718
8719 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8720
8721 When compiling a function that is to be used in this way with gcc,
8722 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8723 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8724
8725 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8726        {*&<&'string3'&>&*}}*&"
8727 .cindex "expansion" "extracting substrings by key"
8728 .cindex "&%extract%&" "substrings by key"
8729 The key and <&'string1'&> are first expanded separately. Leading and trailing
8730 white space is removed from the key (but not from any of the strings). The key
8731 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8732 form:
8733 .display
8734 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8735 .endd
8736 .vindex "&$value$&"
8737 where the equals signs and spaces (but not both) are optional. If any of the
8738 values contain white space, they must be enclosed in double quotes, and any
8739 values that are enclosed in double quotes are subject to escape processing as
8740 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8741 for the value that corresponds to the key. The search is case-insensitive. If
8742 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8743 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8744 variable &$value$& contains the value that has been extracted. Afterwards, it
8745 is restored to any previous value it might have had.
8746
8747 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8748 key is not found. If {<&'string2'&>} is also omitted, the value that was
8749 extracted is used. Thus, for example, these two expansions are identical, and
8750 yield &"2001"&:
8751 .code
8752 ${extract{gid}{uid=1984 gid=2001}}
8753 ${extract{gid}{uid=1984 gid=2001}{$value}}
8754 .endd
8755 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8756 appear, for example:
8757 .code
8758 ${extract{Z}{A=... B=...}{$value} fail }
8759 .endd
8760 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8761 {<&'string2'&>} must be present for &"fail"& to be recognized.
8762
8763
8764 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8765         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8766 .cindex "expansion" "extracting substrings by number"
8767 .cindex "&%extract%&" "substrings by number"
8768 The <&'number'&> argument must consist entirely of decimal digits,
8769 apart from leading and trailing white space, which is ignored.
8770 This is what distinguishes this form of &%extract%& from the previous kind. It
8771 behaves in the same way, except that, instead of extracting a named field, it
8772 extracts from <&'string1'&> the field whose number is given as the first
8773 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8774 <&'string3'&> as before.
8775
8776 The fields in the string are separated by any one of the characters in the
8777 separator string. These may include space or tab characters.
8778 The first field is numbered one. If the number is negative, the fields are
8779 counted from the end of the string, with the rightmost one numbered -1. If the
8780 number given is zero, the entire string is returned. If the modulus of the
8781 number is greater than the number of fields in the string, the result is the
8782 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8783 provided. For example:
8784 .code
8785 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8786 .endd
8787 yields &"42"&, and
8788 .code
8789 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8790 .endd
8791 yields &"99"&. Two successive separators mean that the field between them is
8792 empty (for example, the fifth field above).
8793
8794
8795 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8796 .cindex "list" "selecting by condition"
8797 .cindex "expansion" "selecting from list by condition"
8798 .vindex "&$item$&"
8799 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8800 default, but the separator can be changed in the usual way. For each item
8801 in this list, its value is place in &$item$&, and then the condition is
8802 evaluated. If the condition is true, &$item$& is added to the output as an
8803 item in a new list; if the condition is false, the item is discarded. The
8804 separator used for the output list is the same as the one used for the
8805 input, but a separator setting is not included in the output. For example:
8806 .code
8807 ${filter{a:b:c}{!eq{$item}{b}}
8808 .endd
8809 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8810 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8811
8812
8813 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8814 .cindex "hash function" "textual"
8815 .cindex "expansion" "textual hash"
8816 This is a textual hashing function, and was the first to be implemented in
8817 early versions of Exim. In current releases, there are other hashing functions
8818 (numeric, MD5, and SHA-1), which are described below.
8819
8820 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8821 <&'n'&>. If you are using fixed values for these numbers, that is, if
8822 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8823 use the simpler operator notation that avoids some of the braces:
8824 .code
8825 ${hash_<n>_<m>:<string>}
8826 .endd
8827 The second number is optional (in both notations). If <&'n'&> is greater than
8828 or equal to the length of the string, the expansion item returns the string.
8829 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8830 function to the string. The new string consists of characters taken from the
8831 first <&'m'&> characters of the string
8832 .code
8833 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8834 .endd
8835 If <&'m'&> is not present the value 26 is used, so that only lower case
8836 letters appear. For example:
8837 .display
8838 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8839 &`$hash{5}{monty}}           `&   yields  &`monty`&
8840 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8841 .endd
8842
8843 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8844         &*$h_*&<&'header&~name'&>&*:*&" &&&
8845        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8846         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8847        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8848         &*$rh_*&<&'header&~name'&>&*:*&"
8849 .cindex "expansion" "header insertion"
8850 .vindex "&$header_$&"
8851 .vindex "&$bheader_$&"
8852 .vindex "&$rheader_$&"
8853 .cindex "header lines" "in expansion strings"
8854 .cindex "header lines" "character sets"
8855 .cindex "header lines" "decoding"
8856 Substitute the contents of the named message header line, for example
8857 .code
8858 $header_reply-to:
8859 .endd
8860 The newline that terminates a header line is not included in the expansion, but
8861 internal newlines (caused by splitting the header line over several physical
8862 lines) may be present.
8863
8864 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8865 the data in the header line is interpreted.
8866
8867 .ilist
8868 .cindex "white space" "in header lines"
8869 &%rheader%& gives the original &"raw"& content of the header line, with no
8870 processing at all, and without the removal of leading and trailing white space.
8871
8872 .next
8873 .cindex "base64 encoding" "in header lines"
8874 &%bheader%& removes leading and trailing white space, and then decodes base64
8875 or quoted-printable MIME &"words"& within the header text, but does no
8876 character set translation. If decoding of what looks superficially like a MIME
8877 &"word"& fails, the raw string is returned. If decoding
8878 .cindex "binary zero" "in header line"
8879 produces a binary zero character, it is replaced by a question mark &-- this is
8880 what Exim does for binary zeros that are actually received in header lines.
8881
8882 .next
8883 &%header%& tries to translate the string as decoded by &%bheader%& to a
8884 standard character set. This is an attempt to produce the same string as would
8885 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8886 returned. Translation is attempted only on operating systems that support the
8887 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8888 a system Makefile or in &_Local/Makefile_&.
8889 .endlist ilist
8890
8891 In a filter file, the target character set for &%header%& can be specified by a
8892 command of the following form:
8893 .code
8894 headers charset "UTF-8"
8895 .endd
8896 This command affects all references to &$h_$& (or &$header_$&) expansions in
8897 subsequently obeyed filter commands. In the absence of this command, the target
8898 character set in a filter is taken from the setting of the &%headers_charset%&
8899 option in the runtime configuration. The value of this option defaults to the
8900 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8901 ISO-8859-1.
8902
8903 Header names follow the syntax of RFC 2822, which states that they may contain
8904 any printing characters except space and colon. Consequently, curly brackets
8905 &'do not'& terminate header names, and should not be used to enclose them as
8906 if they were variables. Attempting to do so causes a syntax error.
8907
8908 Only header lines that are common to all copies of a message are visible to
8909 this mechanism. These are the original header lines that are received with the
8910 message, and any that are added by an ACL statement or by a system
8911 filter. Header lines that are added to a particular copy of a message by a
8912 router or transport are not accessible.
8913
8914 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8915 before the DATA ACL, because the header structure is not set up until the
8916 message is received. Header lines that are added in a RCPT ACL (for example)
8917 are saved until the message's incoming header lines are available, at which
8918 point they are added. When a DATA ACL is running, however, header lines added
8919 by earlier ACLs are visible.
8920
8921 Upper case and lower case letters are synonymous in header names. If the
8922 following character is white space, the terminating colon may be omitted, but
8923 this is not recommended, because you may then forget it when it is needed. When
8924 white space terminates the header name, it is included in the expanded string.
8925 If the message does not contain the given header, the expansion item is
8926 replaced by an empty string. (See the &%def%& condition in section
8927 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8928
8929 If there is more than one header with the same name, they are all concatenated
8930 to form the substitution string, up to a maximum length of 64K. Unless
8931 &%rheader%& is being used, leading and trailing white space is removed from
8932 each header before concatenation, and a completely empty header is ignored. A
8933 newline character is then inserted between non-empty headers, but there is no
8934 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8935 those headers that contain lists of addresses, a comma is also inserted at the
8936 junctions between headers. This does not happen for the &%rheader%& expansion.
8937
8938
8939 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8940 .cindex "expansion" "hmac hashing"
8941 .cindex &%hmac%&
8942 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8943 shared secret and some text into a message authentication code, as specified in
8944 RFC 2104. This differs from &`${md5:secret_text...}`& or
8945 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8946 cryptographic hash, allowing for authentication that is not possible with MD5
8947 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8948 present. For example:
8949 .code
8950 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8951 .endd
8952 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8953 produces:
8954 .code
8955 dd97e3ba5d1a61b5006108f8c8252953
8956 .endd
8957 As an example of how this might be used, you might put in the main part of
8958 an Exim configuration:
8959 .code
8960 SPAMSCAN_SECRET=cohgheeLei2thahw
8961 .endd
8962 In a router or a transport you could then have:
8963 .code
8964 headers_add = \
8965   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8966   ${hmac{md5}{SPAMSCAN_SECRET}\
8967   {${primary_hostname},${message_exim_id},$h_message-id:}}
8968 .endd
8969 Then given a message, you can check where it was scanned by looking at the
8970 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8971 this header line is authentic by recomputing the authentication code from the
8972 host name, message ID and the &'Message-id:'& header line. This can be done
8973 using Exim's &%-be%& option, or by other means, for example by using the
8974 &'hmac_md5_hex()'& function in Perl.
8975
8976
8977 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8978 .cindex "expansion" "conditional"
8979 .cindex "&%if%&, expansion item"
8980 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8981 item; otherwise <&'string2'&> is used. The available conditions are described
8982 in section &<<SECTexpcond>>& below. For example:
8983 .code
8984 ${if eq {$local_part}{postmaster} {yes}{no} }
8985 .endd
8986 The second string need not be present; if it is not and the condition is not
8987 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
8988 be present instead of the second string (without any curly brackets). In this
8989 case, the expansion is forced to fail if the condition is not true (see section
8990 &<<SECTforexpfai>>&).
8991
8992 If both strings are omitted, the result is the string &`true`& if the condition
8993 is true, and the empty string if the condition is false. This makes it less
8994 cumbersome to write custom ACL and router conditions. For example, instead of
8995 .code
8996 condition = ${if >{$acl_m4}{3}{true}{false}}
8997 .endd
8998 you can use
8999 .code
9000 condition = ${if >{$acl_m4}{3}}
9001 .endd
9002
9003 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9004 .cindex "expansion" "string truncation"
9005 .cindex "&%length%& expansion item"
9006 The &%length%& item is used to extract the initial portion of a string. Both
9007 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9008 you are using a fixed value for the number, that is, if <&'string1'&> does not
9009 change when expanded, you can use the simpler operator notation that avoids
9010 some of the braces:
9011 .code
9012 ${length_<n>:<string>}
9013 .endd
9014 The result of this item is either the first <&'n'&> characters or the whole
9015 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9016 &%strlen%&, which gives the length of a string.
9017
9018
9019 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9020         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9021 This is the first of one of two different types of lookup item, which are both
9022 described in the next item.
9023
9024 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9025         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9026 .cindex "expansion" "lookup in"
9027 .cindex "file" "lookups"
9028 .cindex "lookup" "in expanded string"
9029 The two forms of lookup item specify data lookups in files and databases, as
9030 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9031 lookups, and the second is used for query-style lookups. The <&'key'&>,
9032 <&'file'&>, and <&'query'&> strings are expanded before use.
9033
9034 If there is any white space in a lookup item which is part of a filter command,
9035 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9036 other place where white space is significant, the lookup item must be enclosed
9037 in double quotes. The use of data lookups in users' filter files may be locked
9038 out by the system administrator.
9039
9040 .vindex "&$value$&"
9041 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9042 During its expansion, the variable &$value$& contains the data returned by the
9043 lookup. Afterwards it reverts to the value it had previously (at the outer
9044 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9045 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9046 string on failure. If <&'string2'&> is provided, it can itself be a nested
9047 lookup, thus providing a mechanism for looking up a default value when the
9048 original lookup fails.
9049
9050 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9051 data for the outer lookup while the parameters of the second lookup are
9052 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9053 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9054 appear, and in this case, if the lookup fails, the entire expansion is forced
9055 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9056 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9057 successful lookup, and nothing in the case of failure.
9058
9059 For single-key lookups, the string &"partial"& is permitted to precede the
9060 search type in order to do partial matching, and * or *@ may follow a search
9061 type to request default lookups if the key does not match (see sections
9062 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9063
9064 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9065 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9066 and non-wild parts of the key during the expansion of the replacement text.
9067 They return to their previous values at the end of the lookup item.
9068
9069 This example looks up the postmaster alias in the conventional alias file:
9070 .code
9071 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9072 .endd
9073 This example uses NIS+ to look up the full name of the user corresponding to
9074 the local part of an address, forcing the expansion to fail if it is not found:
9075 .code
9076 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9077   {$value}fail}
9078 .endd
9079
9080
9081 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9082 .cindex "expansion" "list creation"
9083 .vindex "&$item$&"
9084 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9085 default, but the separator can be changed in the usual way. For each item
9086 in this list, its value is place in &$item$&, and then <&'string2'&> is
9087 expanded and added to the output as an item in a new list. The separator used
9088 for the output list is the same as the one used for the input, but a separator
9089 setting is not included in the output. For example:
9090 .code
9091 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9092 .endd
9093 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9094 value of &$item$& is restored to what it was before. See also the &*filter*&
9095 and &*reduce*& expansion items.
9096
9097 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9098 .cindex "expansion" "numeric hash"
9099 .cindex "hash function" "numeric"
9100 The three strings are expanded; the first two must yield numbers. Call them
9101 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9102 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9103 can use the simpler operator notation that avoids some of the braces:
9104 .code
9105 ${nhash_<n>_<m>:<string>}
9106 .endd
9107 The second number is optional (in both notations). If there is only one number,
9108 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9109 processed by a div/mod hash function that returns two numbers, separated by a
9110 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9111 example,
9112 .code
9113 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9114 .endd
9115 returns the string &"6/33"&.
9116
9117
9118
9119 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9120 .cindex "Perl" "use in expanded string"
9121 .cindex "expansion" "calling Perl from"
9122 This item is available only if Exim has been built to include an embedded Perl
9123 interpreter. The subroutine name and the arguments are first separately
9124 expanded, and then the Perl subroutine is called with those arguments. No
9125 additional arguments need be given; the maximum number permitted, including the
9126 name of the subroutine, is nine.
9127
9128 The return value of the subroutine is inserted into the expanded string, unless
9129 the return value is &%undef%&. In that case, the expansion fails in the same
9130 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9131 Whatever you return is evaluated in a scalar context. For example, if you
9132 return the name of a Perl vector, the return value is the size of the vector,
9133 not its contents.
9134
9135 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9136 with the error message that was passed to &%die%&. More details of the embedded
9137 Perl facility are given in chapter &<<CHAPperl>>&.
9138
9139 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9140 out the use of this expansion item in filter files.
9141
9142
9143 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9144 .cindex "&%prvs%& expansion item"
9145 The first argument is a complete email address and the second is secret
9146 keystring. The third argument, specifying a key number, is optional. If absent,
9147 it defaults to 0. The result of the expansion is a prvs-signed email address,
9148 to be typically used with the &%return_path%& option on an &(smtp)& transport
9149 as part of a bounce address tag validation (BATV) scheme. For more discussion
9150 and an example, see section &<<SECTverifyPRVS>>&.
9151
9152 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9153         {*&<&'string'&>&*}}*&"
9154 .cindex "&%prvscheck%& expansion item"
9155 This expansion item is the complement of the &%prvs%& item. It is used for
9156 checking prvs-signed addresses. If the expansion of the first argument does not
9157 yield a syntactically valid prvs-signed address, the whole item expands to the
9158 empty string. When the first argument does expand to a syntactically valid
9159 prvs-signed address, the second argument is expanded, with the prvs-decoded
9160 version of the address and the key number extracted from the address in the
9161 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9162
9163 These two variables can be used in the expansion of the second argument to
9164 retrieve the secret. The validity of the prvs-signed address is then checked
9165 against the secret. The result is stored in the variable &$prvscheck_result$&,
9166 which is empty for failure or &"1"& for success.
9167
9168 The third argument is optional; if it is missing, it defaults to an empty
9169 string. This argument is now expanded. If the result is an empty string, the
9170 result of the expansion is the decoded version of the address. This is the case
9171 whether or not the signature was valid. Otherwise, the result of the expansion
9172 is the expansion of the third argument.
9173
9174 All three variables can be used in the expansion of the third argument.
9175 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9176 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9177
9178 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9179 .cindex "expansion" "inserting an entire file"
9180 .cindex "file" "inserting into expansion"
9181 .cindex "&%readfile%& expansion item"
9182 The file name and end-of-line string are first expanded separately. The file is
9183 then read, and its contents replace the entire item. All newline characters in
9184 the file are replaced by the end-of-line string if it is present. Otherwise,
9185 newlines are left in the string.
9186 String expansion is not applied to the contents of the file. If you want this,
9187 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9188 the string expansion fails.
9189
9190 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9191 locks out the use of this expansion item in filter files.
9192
9193
9194
9195 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9196         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9197 .cindex "expansion" "inserting from a socket"
9198 .cindex "socket, use of in expansion"
9199 .cindex "&%readsocket%& expansion item"
9200 This item inserts data from a Unix domain or Internet socket into the expanded
9201 string. The minimal way of using it uses just two arguments, as in these
9202 examples:
9203 .code
9204 ${readsocket{/socket/name}{request string}}
9205 ${readsocket{inet:some.host:1234}{request string}}
9206 .endd
9207 For a Unix domain socket, the first substring must be the path to the socket.
9208 For an Internet socket, the first substring must contain &`inet:`& followed by
9209 a host name or IP address, followed by a colon and a port, which can be a
9210 number or the name of a TCP port in &_/etc/services_&. An IP address may
9211 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9212 example:
9213 .code
9214 ${readsocket{inet:[::1]:1234}{request string}}
9215 .endd
9216 Only a single host name may be given, but if looking it up yields more than
9217 one IP address, they are each tried in turn until a connection is made. For
9218 both kinds of socket, Exim makes a connection, writes the request string
9219 (unless it is an empty string) and reads from the socket until an end-of-file
9220 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9221 extend what can be done. Firstly, you can vary the timeout. For example:
9222 .code
9223 ${readsocket{/socket/name}{request string}{3s}}
9224 .endd
9225 A fourth argument allows you to change any newlines that are in the data
9226 that is read, in the same way as for &%readfile%& (see above). This example
9227 turns them into spaces:
9228 .code
9229 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9230 .endd
9231 As with all expansions, the substrings are expanded before the processing
9232 happens. Errors in these sub-expansions cause the expansion to fail. In
9233 addition, the following errors can occur:
9234
9235 .ilist
9236 Failure to create a socket file descriptor;
9237 .next
9238 Failure to connect the socket;
9239 .next
9240 Failure to write the request string;
9241 .next
9242 Timeout on reading from the socket.
9243 .endlist
9244
9245 By default, any of these errors causes the expansion to fail. However, if
9246 you supply a fifth substring, it is expanded and used when any of the above
9247 errors occurs. For example:
9248 .code
9249 ${readsocket{/socket/name}{request string}{3s}{\n}\
9250   {socket failure}}
9251 .endd
9252 You can test for the existence of a Unix domain socket by wrapping this
9253 expansion in &`${if exists`&, but there is a race condition between that test
9254 and the actual opening of the socket, so it is safer to use the fifth argument
9255 if you want to be absolutely sure of avoiding an expansion error for a
9256 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9257
9258 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9259 locks out the use of this expansion item in filter files.
9260
9261
9262 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9263 .cindex "expansion" "reducing a list to a scalar"
9264 .cindex "list" "reducing to a scalar"
9265 .vindex "&$value$&"
9266 .vindex "&$item$&"
9267 This operation reduces a list to a single, scalar string. After expansion,
9268 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9269 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9270 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9271 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9272 them. The result of that expansion is assigned to &$value$& before the next
9273 iteration. When the end of the list is reached, the final value of &$value$& is
9274 added to the expansion output. The &*reduce*& expansion item can be used in a
9275 number of ways. For example, to add up a list of numbers:
9276 .code
9277 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9278 .endd
9279 The result of that expansion would be &`6`&. The maximum of a list of numbers
9280 can be found:
9281 .code
9282 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9283 .endd
9284 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9285 restored to what they were before. See also the &*filter*& and &*map*&
9286 expansion items.
9287
9288 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9289 This item inserts &"raw"& header lines. It is described with the &%header%&
9290 expansion item above.
9291
9292 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9293         {*&<&'string2'&>&*}}*&"
9294 .cindex "expansion" "running a command"
9295 .cindex "&%run%& expansion item"
9296 The command and its arguments are first expanded separately, and then the
9297 command is run in a separate process, but under the same uid and gid. As in
9298 other command executions from Exim, a shell is not used by default. If you want
9299 a shell, you must explicitly code it.
9300
9301 The standard input for the command exists, but is empty. The standard output
9302 and standard error are set to the same file descriptor.
9303 .cindex "return code" "from &%run%& expansion"
9304 .vindex "&$value$&"
9305 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9306 and replaces the entire item; during this expansion, the standard output/error
9307 from the command is in the variable &$value$&. If the command fails,
9308 <&'string2'&>, if present, is expanded and used. Once again, during the
9309 expansion, the standard output/error from the command is in the variable
9310 &$value$&.
9311
9312 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9313 can be the word &"fail"& (not in braces) to force expansion failure if the
9314 command does not succeed. If both strings are omitted, the result is contents
9315 of the standard output/error on success, and nothing on failure.
9316
9317 .vindex "&$runrc$&"
9318 The return code from the command is put in the variable &$runrc$&, and this
9319 remains set afterwards, so in a filter file you can do things like this:
9320 .code
9321 if "${run{x y z}{}}$runrc" is 1 then ...
9322   elif $runrc is 2 then ...
9323   ...
9324 endif
9325 .endd
9326 If execution of the command fails (for example, the command does not exist),
9327 the return code is 127 &-- the same code that shells use for non-existent
9328 commands.
9329
9330 &*Warning*&: In a router or transport, you cannot assume the order in which
9331 option values are expanded, except for those preconditions whose order of
9332 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9333 by the expansion of one option, and use it in another.
9334
9335 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9336 out the use of this expansion item in filter files.
9337
9338
9339 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9340 .cindex "expansion" "string substitution"
9341 .cindex "&%sg%& expansion item"
9342 This item works like Perl's substitution operator (s) with the global (/g)
9343 option; hence its name. However, unlike the Perl equivalent, Exim does not
9344 modify the subject string; instead it returns the modified string for insertion
9345 into the overall expansion. The item takes three arguments: the subject string,
9346 a regular expression, and a substitution string. For example:
9347 .code
9348 ${sg{abcdefabcdef}{abc}{xyz}}
9349 .endd
9350 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9351 if any $ or \ characters are required in the regular expression or in the
9352 substitution string, they have to be escaped. For example:
9353 .code
9354 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9355 .endd
9356 yields &"defabc"&, and
9357 .code
9358 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9359 .endd
9360 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9361 the regular expression from string expansion.
9362
9363
9364
9365 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9366 .cindex "&%substr%& expansion item"
9367 .cindex "substring extraction"
9368 .cindex "expansion" "substring extraction"
9369 The three strings are expanded; the first two must yield numbers. Call them
9370 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9371 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9372 can use the simpler operator notation that avoids some of the braces:
9373 .code
9374 ${substr_<n>_<m>:<string>}
9375 .endd
9376 The second number is optional (in both notations).
9377 If it is absent in the simpler format, the preceding underscore must also be
9378 omitted.
9379
9380 The &%substr%& item can be used to extract more general substrings than
9381 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9382 length required. For example
9383 .code
9384 ${substr{3}{2}{$local_part}}
9385 .endd
9386 If the starting offset is greater than the string length the result is the
9387 null string; if the length plus starting offset is greater than the string
9388 length, the result is the right-hand part of the string, starting from the
9389 given offset. The first character in the string has offset zero.
9390
9391 The &%substr%& expansion item can take negative offset values to count
9392 from the right-hand end of its operand. The last character is offset -1, the
9393 second-last is offset -2, and so on. Thus, for example,
9394 .code
9395 ${substr{-5}{2}{1234567}}
9396 .endd
9397 yields &"34"&. If the absolute value of a negative offset is greater than the
9398 length of the string, the substring starts at the beginning of the string, and
9399 the length is reduced by the amount of overshoot. Thus, for example,
9400 .code
9401 ${substr{-5}{2}{12}}
9402 .endd
9403 yields an empty string, but
9404 .code
9405 ${substr{-3}{2}{12}}
9406 .endd
9407 yields &"1"&.
9408
9409 When the second number is omitted from &%substr%&, the remainder of the string
9410 is taken if the offset is positive. If it is negative, all characters in the
9411 string preceding the offset point are taken. For example, an offset of -1 and
9412 no length, as in these semantically identical examples:
9413 .code
9414 ${substr_-1:abcde}
9415 ${substr{-1}{abcde}}
9416 .endd
9417 yields all but the last character of the string, that is, &"abcd"&.
9418
9419
9420
9421 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9422         {*&<&'replacements'&>&*}}*&"
9423 .cindex "expansion" "character translation"
9424 .cindex "&%tr%& expansion item"
9425 This item does single-character translation on its subject string. The second
9426 argument is a list of characters to be translated in the subject string. Each
9427 matching character is replaced by the corresponding character from the
9428 replacement list. For example
9429 .code
9430 ${tr{abcdea}{ac}{13}}
9431 .endd
9432 yields &`1b3de1`&. If there are duplicates in the second character string, the
9433 last occurrence is used. If the third string is shorter than the second, its
9434 last character is replicated. However, if it is empty, no translation takes
9435 place.
9436 .endlist
9437
9438
9439
9440 .section "Expansion operators" "SECTexpop"
9441 .cindex "expansion" "operators"
9442 For expansion items that perform transformations on a single argument string,
9443 the &"operator"& notation is used because it is simpler and uses fewer braces.
9444 The substring is first expanded before the operation is applied to it. The
9445 following operations can be performed:
9446
9447 .vlist
9448 .vitem &*${address:*&<&'string'&>&*}*&
9449 .cindex "expansion" "RFC 2822 address handling"
9450 .cindex "&%address%& expansion item"
9451 The string is interpreted as an RFC 2822 address, as it might appear in a
9452 header line, and the effective address is extracted from it. If the string does
9453 not parse successfully, the result is empty.
9454
9455
9456 .vitem &*${addresses:*&<&'string'&>&*}*&
9457 .cindex "expansion" "RFC 2822 address handling"
9458 .cindex "&%addresses%& expansion item"
9459 The string (after expansion) is interpreted as a list of addresses in RFC
9460 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9461 operative address (&'local-part@domain'&) is extracted from each item, and the
9462 result of the expansion is a colon-separated list, with appropriate
9463 doubling of colons should any happen to be present in the email addresses.
9464 Syntactically invalid RFC2822 address items are omitted from the output.
9465
9466 It is possible to specify a character other than colon for the output
9467 separator by starting the string with > followed by the new separator
9468 character. For example:
9469 .code
9470 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9471 .endd
9472 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9473 expansion item, which extracts the working address from a single RFC2822
9474 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9475 processing lists.
9476
9477
9478 .vitem &*${base62:*&<&'digits'&>&*}*&
9479 .cindex "&%base62%& expansion item"
9480 .cindex "expansion" "conversion to base 62"
9481 The string must consist entirely of decimal digits. The number is converted to
9482 base 62 and output as a string of six characters, including leading zeros. In
9483 the few operating environments where Exim uses base 36 instead of base 62 for
9484 its message identifiers (because those systems do not have case-sensitive file
9485 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9486 be absolutely clear: this is &'not'& base64 encoding.
9487
9488 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9489 .cindex "&%base62d%& expansion item"
9490 .cindex "expansion" "conversion to base 62"
9491 The string must consist entirely of base-62 digits, or, in operating
9492 environments where Exim uses base 36 instead of base 62 for its message
9493 identifiers, base-36 digits. The number is converted to decimal and output as a
9494 string.
9495
9496 .vitem &*${domain:*&<&'string'&>&*}*&
9497 .cindex "domain" "extraction"
9498 .cindex "expansion" "domain extraction"
9499 The string is interpreted as an RFC 2822 address and the domain is extracted
9500 from it. If the string does not parse successfully, the result is empty.
9501
9502
9503 .vitem &*${escape:*&<&'string'&>&*}*&
9504 .cindex "expansion" "escaping non-printing characters"
9505 .cindex "&%escape%& expansion item"
9506 If the string contains any non-printing characters, they are converted to
9507 escape sequences starting with a backslash. Whether characters with the most
9508 significant bit set (so-called &"8-bit characters"&) count as printing or not
9509 is controlled by the &%print_topbitchars%& option.
9510
9511
9512 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9513 .cindex "expansion" "expression evaluation"
9514 .cindex "expansion" "arithmetic expression"
9515 .cindex "&%eval%& expansion item"
9516 These items supports simple arithmetic and bitwise logical operations in
9517 expansion strings. The string (after expansion) must be a conventional
9518 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9519 logical operators, and parentheses. All operations are carried out using
9520 integer arithmetic. The operator priorities are as follows (the same as in the
9521 C programming language):
9522 .table2 70pt 300pt
9523 .irow &'highest:'& "not (~), negate (-)"
9524 .irow ""   "multiply (*), divide (/), remainder (%)"
9525 .irow ""   "plus (+), minus (-)"
9526 .irow ""   "shift-left (<<), shift-right (>>)"
9527 .irow ""   "and (&&)"
9528 .irow ""   "xor (^)"
9529 .irow &'lowest:'&  "or (|)"
9530 .endtable
9531 Binary operators with the same priority are evaluated from left to right. White
9532 space is permitted before or after operators.
9533
9534 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9535 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9536 decimal, even if they start with a leading zero; hexadecimal numbers are not
9537 permitted. This can be useful when processing numbers extracted from dates or
9538 times, which often do have leading zeros.
9539
9540 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9541 or 1024*1024*1024,
9542 respectively. Negative numbers are supported. The result of the computation is
9543 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9544
9545 .display
9546 &`${eval:1+1}            `&  yields 2
9547 &`${eval:1+2*3}          `&  yields 7
9548 &`${eval:(1+2)*3}        `&  yields 9
9549 &`${eval:2+42%5}         `&  yields 4
9550 &`${eval:0xc&amp;5}          `&  yields 4
9551 &`${eval:0xc|5}          `&  yields 13
9552 &`${eval:0xc^5}          `&  yields 9
9553 &`${eval:0xc>>1}         `&  yields 6
9554 &`${eval:0xc<<1}         `&  yields 24
9555 &`${eval:~255&amp;0x1234}    `&  yields 4608
9556 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9557 .endd
9558
9559 As a more realistic example, in an ACL you might have
9560 .code
9561 deny   message = Too many bad recipients
9562        condition =                    \
9563          ${if and {                   \
9564            {>{$rcpt_count}{10}}       \
9565            {                          \
9566            <                          \
9567              {$recipients_count}      \
9568              {${eval:$rcpt_count/2}}  \
9569            }                          \
9570          }{yes}{no}}
9571 .endd
9572 The condition is true if there have been more than 10 RCPT commands and
9573 fewer than half of them have resulted in a valid recipient.
9574
9575
9576 .vitem &*${expand:*&<&'string'&>&*}*&
9577 .cindex "expansion" "re-expansion of substring"
9578 The &%expand%& operator causes a string to be expanded for a second time. For
9579 example,
9580 .code
9581 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9582 .endd
9583 first looks up a string in a file while expanding the operand for &%expand%&,
9584 and then re-expands what it has found.
9585
9586
9587 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9588 .cindex "Unicode"
9589 .cindex "UTF-8" "conversion from"
9590 .cindex "expansion" "UTF-8 conversion"
9591 .cindex "&%from_utf8%& expansion item"
9592 The world is slowly moving towards Unicode, although there are no standards for
9593 email yet. However, other applications (including some databases) are starting
9594 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9595 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9596 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9597 the result is an undefined sequence of bytes.
9598
9599 Unicode code points with values less than 256 are compatible with ASCII and
9600 ISO-8859-1 (also known as Latin-1).
9601 For example, character 169 is the copyright symbol in both cases, though the
9602 way it is encoded is different. In UTF-8, more than one byte is needed for
9603 characters with code values greater than 127, whereas ISO-8859-1 is a
9604 single-byte encoding (but thereby limited to 256 characters). This makes
9605 translation from UTF-8 to ISO-8859-1 straightforward.
9606
9607
9608 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9609 .cindex "hash function" "textual"
9610 .cindex "expansion" "textual hash"
9611 The &%hash%& operator is a simpler interface to the hashing function that can
9612 be used when the two parameters are fixed numbers (as opposed to strings that
9613 change when expanded). The effect is the same as
9614 .code
9615 ${hash{<n>}{<m>}{<string>}}
9616 .endd
9617 See the description of the general &%hash%& item above for details. The
9618 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9619
9620
9621
9622 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9623 .cindex "base64 encoding" "conversion from hex"
9624 .cindex "expansion" "hex to base64"
9625 .cindex "&%hex2b64%& expansion item"
9626 This operator converts a hex string into one that is base64 encoded. This can
9627 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9628
9629
9630 .vitem &*${lc:*&<&'string'&>&*}*&
9631 .cindex "case forcing in strings"
9632 .cindex "string" "case forcing"
9633 .cindex "lower casing"
9634 .cindex "expansion" "case forcing"
9635 .cindex "&%lc%& expansion item"
9636 This forces the letters in the string into lower-case, for example:
9637 .code
9638 ${lc:$local_part}
9639 .endd
9640
9641 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9642 .cindex "expansion" "string truncation"
9643 .cindex "&%length%& expansion item"
9644 The &%length%& operator is a simpler interface to the &%length%& function that
9645 can be used when the parameter is a fixed number (as opposed to a string that
9646 changes when expanded). The effect is the same as
9647 .code
9648 ${length{<number>}{<string>}}
9649 .endd
9650 See the description of the general &%length%& item above for details. Note that
9651 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9652 when &%length%& is used as an operator.
9653
9654
9655 .vitem &*${local_part:*&<&'string'&>&*}*&
9656 .cindex "expansion" "local part extraction"
9657 .cindex "&%local_part%& expansion item"
9658 The string is interpreted as an RFC 2822 address and the local part is
9659 extracted from it. If the string does not parse successfully, the result is
9660 empty.
9661
9662
9663 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9664 .cindex "masked IP address"
9665 .cindex "IP address" "masking"
9666 .cindex "CIDR notation"
9667 .cindex "expansion" "IP address masking"
9668 .cindex "&%mask%& expansion item"
9669 If the form of the string to be operated on is not an IP address followed by a
9670 slash and an integer (that is, a network address in CIDR notation), the
9671 expansion fails. Otherwise, this operator converts the IP address to binary,
9672 masks off the least significant bits according to the bit count, and converts
9673 the result back to text, with mask appended. For example,
9674 .code
9675 ${mask:10.111.131.206/28}
9676 .endd
9677 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9678 be mostly used for looking up masked addresses in files, the result for an IPv6
9679 address uses dots to separate components instead of colons, because colon
9680 terminates a key string in lsearch files. So, for example,
9681 .code
9682 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9683 .endd
9684 returns the string
9685 .code
9686 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9687 .endd
9688 Letters in IPv6 addresses are always output in lower case.
9689
9690
9691 .vitem &*${md5:*&<&'string'&>&*}*&
9692 .cindex "MD5 hash"
9693 .cindex "expansion" "MD5 hash"
9694 .cindex "&%md5%& expansion item"
9695 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9696 as a 32-digit hexadecimal number, in which any letters are in lower case.
9697
9698
9699 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9700 .cindex "expansion" "numeric hash"
9701 .cindex "hash function" "numeric"
9702 The &%nhash%& operator is a simpler interface to the numeric hashing function
9703 that can be used when the two parameters are fixed numbers (as opposed to
9704 strings that change when expanded). The effect is the same as
9705 .code
9706 ${nhash{<n>}{<m>}{<string>}}
9707 .endd
9708 See the description of the general &%nhash%& item above for details.
9709
9710
9711 .vitem &*${quote:*&<&'string'&>&*}*&
9712 .cindex "quoting" "in string expansions"
9713 .cindex "expansion" "quoting"
9714 .cindex "&%quote%& expansion item"
9715 The &%quote%& operator puts its argument into double quotes if it
9716 is an empty string or
9717 contains anything other than letters, digits, underscores, dots, and hyphens.
9718 Any occurrences of double quotes and backslashes are escaped with a backslash.
9719 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9720 respectively For example,
9721 .code
9722 ${quote:ab"*"cd}
9723 .endd
9724 becomes
9725 .code
9726 "ab\"*\"cd"
9727 .endd
9728 The place where this is useful is when the argument is a substitution from a
9729 variable or a message header.
9730
9731 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9732 .cindex "&%quote_local_part%& expansion item"
9733 This operator is like &%quote%&, except that it quotes the string only if
9734 required to do so by the rules of RFC 2822 for quoting local parts. For
9735 example, a plus sign would not cause quoting (but it would for &%quote%&).
9736 If you are creating a new email address from the contents of &$local_part$&
9737 (or any other unknown data), you should always use this operator.
9738
9739
9740 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9741 .cindex "quoting" "lookup-specific"
9742 This operator applies lookup-specific quoting rules to the string. Each
9743 query-style lookup type has its own quoting rules which are described with
9744 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9745 .code
9746 ${quote_ldap:two * two}
9747 .endd
9748 returns
9749 .code
9750 two%20%5C2A%20two
9751 .endd
9752 For single-key lookup types, no quoting is ever necessary and this operator
9753 yields an unchanged string.
9754
9755
9756 .vitem &*${randint:*&<&'n'&>&*}*&
9757 .cindex "random number"
9758 This operator returns a somewhat random number which is less than the
9759 supplied number and is at least 0.  The quality of this randomness depends
9760 on how Exim was built; the values are not suitable for keying material.
9761 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9762 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
9763 for versions of GnuTLS with that function.
9764 Otherwise, the implementation may be arc4random(), random() seeded by
9765 srandomdev() or srandom(), or a custom implementation even weaker than
9766 random().
9767
9768
9769 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9770 .cindex "expansion" "IP address"
9771 This operator reverses an IP address; for IPv4 addresses, the result is in
9772 dotted-quad decimal form, while for IPv6 addreses the result is in
9773 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9774 for DNS.  For example,
9775 .code
9776 ${reverse_ip:192.0.2.4}
9777 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9778 .endd
9779 returns
9780 .code
9781 4.2.0.192
9782 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
9783 .endd
9784
9785
9786 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9787 .cindex "expansion" "RFC 2047"
9788 .cindex "RFC 2047" "expansion operator"
9789 .cindex "&%rfc2047%& expansion item"
9790 This operator encodes text according to the rules of RFC 2047. This is an
9791 encoding that is used in header lines to encode non-ASCII characters. It is
9792 assumed that the input string is in the encoding specified by the
9793 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9794 contains only characters in the range 33&--126, and no instances of the
9795 characters
9796 .code
9797 ? = ( ) < > @ , ; : \ " . [ ] _
9798 .endd
9799 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9800 string, using as many &"encoded words"& as necessary to encode all the
9801 characters.
9802
9803
9804 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9805 .cindex "expansion" "RFC 2047"
9806 .cindex "RFC 2047" "decoding"
9807 .cindex "&%rfc2047d%& expansion item"
9808 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9809 bytes are replaced by question marks. Characters are converted into the
9810 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9811 not recognized unless &%check_rfc2047_length%& is set false.
9812
9813 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9814 access a header line, RFC 2047 decoding is done automatically. You do not need
9815 to use this operator as well.
9816
9817
9818
9819 .vitem &*${rxquote:*&<&'string'&>&*}*&
9820 .cindex "quoting" "in regular expressions"
9821 .cindex "regular expressions" "quoting"
9822 .cindex "&%rxquote%& expansion item"
9823 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9824 characters in its argument. This is useful when substituting the values of
9825 variables or headers inside regular expressions.
9826
9827
9828 .vitem &*${sha1:*&<&'string'&>&*}*&
9829 .cindex "SHA-1 hash"
9830 .cindex "expansion" "SHA-1 hashing"
9831 .cindex "&%sha2%& expansion item"
9832 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9833 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9834
9835
9836 .vitem &*${stat:*&<&'string'&>&*}*&
9837 .cindex "expansion" "statting a file"
9838 .cindex "file" "extracting characteristics"
9839 .cindex "&%stat%& expansion item"
9840 The string, after expansion, must be a file path. A call to the &[stat()]&
9841 function is made for this path. If &[stat()]& fails, an error occurs and the
9842 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9843 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9844 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9845 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9846 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9847 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9848 can extract individual fields using the &%extract%& expansion item.
9849
9850 The use of the &%stat%& expansion in users' filter files can be locked out by
9851 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9852 systems for files larger than 2GB.
9853
9854 .vitem &*${str2b64:*&<&'string'&>&*}*&
9855 .cindex "expansion" "base64 encoding"
9856 .cindex "base64 encoding" "in string expansion"
9857 .cindex "&%str2b64%& expansion item"
9858 This operator converts a string into one that is base64 encoded.
9859
9860
9861
9862 .vitem &*${strlen:*&<&'string'&>&*}*&
9863 .cindex "expansion" "string length"
9864 .cindex "string" "length in expansion"
9865 .cindex "&%strlen%& expansion item"
9866 The item is replace by the length of the expanded string, expressed as a
9867 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9868
9869
9870 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9871 .cindex "&%substr%& expansion item"
9872 .cindex "substring extraction"
9873 .cindex "expansion" "substring expansion"
9874 The &%substr%& operator is a simpler interface to the &%substr%& function that
9875 can be used when the two parameters are fixed numbers (as opposed to strings
9876 that change when expanded). The effect is the same as
9877 .code
9878 ${substr{<start>}{<length>}{<string>}}
9879 .endd
9880 See the description of the general &%substr%& item above for details. The
9881 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9882
9883 .vitem &*${time_eval:*&<&'string'&>&*}*&
9884 .cindex "&%time_eval%& expansion item"
9885 .cindex "time interval" "decoding"
9886 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9887 seconds.
9888
9889 .vitem &*${time_interval:*&<&'string'&>&*}*&
9890 .cindex "&%time_interval%& expansion item"
9891 .cindex "time interval" "formatting"
9892 The argument (after sub-expansion) must be a sequence of decimal digits that
9893 represents an interval of time as a number of seconds. It is converted into a
9894 number of larger units and output in Exim's normal time format, for example,
9895 &`1w3d4h2m6s`&.
9896
9897 .vitem &*${uc:*&<&'string'&>&*}*&
9898 .cindex "case forcing in strings"
9899 .cindex "string" "case forcing"
9900 .cindex "upper casing"
9901 .cindex "expansion" "case forcing"
9902 .cindex "&%uc%& expansion item"
9903 This forces the letters in the string into upper-case.
9904 .endlist
9905
9906
9907
9908
9909
9910
9911 .section "Expansion conditions" "SECTexpcond"
9912 .scindex IIDexpcond "expansion" "conditions"
9913 The following conditions are available for testing by the &%${if%& construct
9914 while expanding strings:
9915
9916 .vlist
9917 .vitem &*!*&<&'condition'&>
9918 .cindex "expansion" "negating a condition"
9919 .cindex "negation" "in expansion condition"
9920 Preceding any condition with an exclamation mark negates the result of the
9921 condition.
9922
9923 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9924 .cindex "numeric comparison"
9925 .cindex "expansion" "numeric comparison"
9926 There are a number of symbolic operators for doing numeric comparisons. They
9927 are:
9928 .display
9929 &`=   `&   equal
9930 &`==  `&   equal
9931 &`>   `&   greater
9932 &`>=  `&   greater or equal
9933 &`<   `&   less
9934 &`<=  `&   less or equal
9935 .endd
9936 For example:
9937 .code
9938 ${if >{$message_size}{10M} ...
9939 .endd
9940 Note that the general negation operator provides for inequality testing. The
9941 two strings must take the form of optionally signed decimal integers,
9942 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9943 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9944 As a special case, the numerical value of an empty string is taken as
9945 zero.
9946
9947 In all cases, a relative comparator OP is testing if <&'string1'&> OP
9948 <&'string2'&>; the above example is checking if &$message_size$& is larger than
9949 10M, not if 10M is larger than &$message_size$&.
9950
9951
9952 .vitem &*bool&~{*&<&'string'&>&*}*&
9953 .cindex "expansion" "boolean parsing"
9954 .cindex "&%bool%& expansion condition"
9955 This condition turns a string holding a true or false representation into
9956 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9957 (case-insensitively); also positive integer numbers map to true if non-zero,
9958 false if zero.
9959 An empty string is treated as false.
9960 Leading and trailing whitespace is ignored;
9961 thus a string consisting only of whitespace is false.
9962 All other string values will result in expansion failure.
9963
9964 When combined with ACL variables, this expansion condition will let you
9965 make decisions in one place and act on those decisions in another place.
9966 For example:
9967 .code
9968 ${if bool{$acl_m_privileged_sender} ...
9969 .endd
9970
9971
9972 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9973 .cindex "expansion" "boolean parsing"
9974 .cindex "&%bool_lax%& expansion condition"
9975 Like &%bool%&, this condition turns a string into a boolean state.  But
9976 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9977 loose definition that the Router &%condition%& option uses.  The empty string
9978 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9979 true.  Leading and trailing whitespace is ignored.
9980
9981 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9982
9983 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9984 .cindex "expansion" "encrypted comparison"
9985 .cindex "encrypted strings, comparing"
9986 .cindex "&%crypteq%& expansion condition"
9987 This condition is included in the Exim binary if it is built to support any
9988 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9989 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9990 included in the binary.
9991
9992 The &%crypteq%& condition has two arguments. The first is encrypted and
9993 compared against the second, which is already encrypted. The second string may
9994 be in the LDAP form for storing encrypted strings, which starts with the
9995 encryption type in curly brackets, followed by the data. If the second string
9996 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
9997 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
9998 Typically this will be a field from a password file. An example of an encrypted
9999 string in LDAP form is:
10000 .code
10001 {md5}CY9rzUYh03PK3k6DJie09g==
10002 .endd
10003 If such a string appears directly in an expansion, the curly brackets have to
10004 be quoted, because they are part of the expansion syntax. For example:
10005 .code
10006 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10007 .endd
10008 The following encryption types (whose names are matched case-independently) are
10009 supported:
10010
10011 .ilist
10012 .cindex "MD5 hash"
10013 .cindex "base64 encoding" "in encrypted password"
10014 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10015 printable characters to compare with the remainder of the second string. If the
10016 length of the comparison string is 24, Exim assumes that it is base64 encoded
10017 (as in the above example). If the length is 32, Exim assumes that it is a
10018 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10019 comparison fails.
10020
10021 .next
10022 .cindex "SHA-1 hash"
10023 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10024 printable characters to compare with the remainder of the second string. If the
10025 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10026 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10027 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10028
10029 .next
10030 .cindex "&[crypt()]&"
10031 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10032 only the first eight characters of the password. However, in modern operating
10033 systems this is no longer true, and in many cases the entire password is used,
10034 whatever its length.
10035
10036 .next
10037 .cindex "&[crypt16()]&"
10038 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10039 use up to 16 characters of the password in some operating systems. Again, in
10040 modern operating systems, more characters may be used.
10041 .endlist
10042 Exim has its own version of &[crypt16()]&, which is just a double call to
10043 &[crypt()]&. For operating systems that have their own version, setting
10044 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10045 operating system version instead of its own. This option is set by default in
10046 the OS-dependent &_Makefile_& for those operating systems that are known to
10047 support &[crypt16()]&.
10048
10049 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10050 it was not using the same algorithm as some operating systems' versions. It
10051 turns out that as well as &[crypt16()]& there is a function called
10052 &[bigcrypt()]& in some operating systems. This may or may not use the same
10053 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10054
10055 However, since there is now a move away from the traditional &[crypt()]&
10056 functions towards using SHA1 and other algorithms, tidying up this area of
10057 Exim is seen as very low priority.
10058
10059 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10060 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10061 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10062 default is &`{crypt}`&. Whatever the default, you can always use either
10063 function by specifying it explicitly in curly brackets.
10064
10065 .vitem &*def:*&<&'variable&~name'&>
10066 .cindex "expansion" "checking for empty variable"
10067 .cindex "&%def%& expansion condition"
10068 The &%def%& condition must be followed by the name of one of the expansion
10069 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10070 variable does not contain the empty string. For example:
10071 .code
10072 ${if def:sender_ident {from $sender_ident}}
10073 .endd
10074 Note that the variable name is given without a leading &%$%& character. If the
10075 variable does not exist, the expansion fails.
10076
10077 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10078         &~&*def:h_*&<&'header&~name'&>&*:*&"
10079 .cindex "expansion" "checking header line existence"
10080 This condition is true if a message is being processed and the named header
10081 exists in the message. For example,
10082 .code
10083 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10084 .endd
10085 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10086 the header name must be terminated by a colon if white space does not follow.
10087
10088 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10089        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10090 .cindex "string" "comparison"
10091 .cindex "expansion" "string comparison"
10092 .cindex "&%eq%& expansion condition"
10093 .cindex "&%eqi%& expansion condition"
10094 The two substrings are first expanded. The condition is true if the two
10095 resulting strings are identical. For &%eq%& the comparison includes the case of
10096 letters, whereas for &%eqi%& the comparison is case-independent.
10097
10098 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10099 .cindex "expansion" "file existence test"
10100 .cindex "file" "existence test"
10101 .cindex "&%exists%&, expansion condition"
10102 The substring is first expanded and then interpreted as an absolute path. The
10103 condition is true if the named file (or directory) exists. The existence test
10104 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10105 users' filter files may be locked out by the system administrator.
10106
10107 .vitem &*first_delivery*&
10108 .cindex "delivery" "first"
10109 .cindex "first delivery"
10110 .cindex "expansion" "first delivery test"
10111 .cindex "&%first_delivery%& expansion condition"
10112 This condition, which has no data, is true during a message's first delivery
10113 attempt. It is false during any subsequent delivery attempts.
10114
10115
10116 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10117        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10118 .cindex "list" "iterative conditions"
10119 .cindex "expansion" "&*forall*& condition"
10120 .cindex "expansion" "&*forany*& condition"
10121 .vindex "&$item$&"
10122 These conditions iterate over a list. The first argument is expanded to form
10123 the list. By default, the list separator is a colon, but it can be changed by
10124 the normal method. The second argument is interpreted as a condition that is to
10125 be applied to each item in the list in turn. During the interpretation of the
10126 condition, the current list item is placed in a variable called &$item$&.
10127 .ilist
10128 For &*forany*&, interpretation stops if the condition is true for any item, and
10129 the result of the whole condition is true. If the condition is false for all
10130 items in the list, the overall condition is false.
10131 .next
10132 For &*forall*&, interpretation stops if the condition is false for any item,
10133 and the result of the whole condition is false. If the condition is true for
10134 all items in the list, the overall condition is true.
10135 .endlist
10136 Note that negation of &*forany*& means that the condition must be false for all
10137 items for the overall condition to succeed, and negation of &*forall*& means
10138 that the condition must be false for at least one item. In this example, the
10139 list separator is changed to a comma:
10140 .code
10141 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10142 .endd
10143 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10144 being processed, to enable these expansion items to be nested.
10145
10146
10147 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10148        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10149 .cindex "string" "comparison"
10150 .cindex "expansion" "string comparison"
10151 .cindex "&%ge%& expansion condition"
10152 .cindex "&%gei%& expansion condition"
10153 The two substrings are first expanded. The condition is true if the first
10154 string is lexically greater than or equal to the second string. For &%ge%& the
10155 comparison includes the case of letters, whereas for &%gei%& the comparison is
10156 case-independent.
10157
10158 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10159        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10160 .cindex "string" "comparison"
10161 .cindex "expansion" "string comparison"
10162 .cindex "&%gt%& expansion condition"
10163 .cindex "&%gti%& expansion condition"
10164 The two substrings are first expanded. The condition is true if the first
10165 string is lexically greater than the second string. For &%gt%& the comparison
10166 includes the case of letters, whereas for &%gti%& the comparison is
10167 case-independent.
10168
10169 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10170        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10171 .cindex "string" "comparison"
10172 .cindex "list" "iterative conditions"
10173 Both strings are expanded; the second string is treated as a list of simple
10174 strings; if the first string is a member of the second, then the condition
10175 is true.
10176
10177 These are simpler to use versions of the more powerful &*forany*& condition.
10178 Examples, and the &*forany*& equivalents:
10179 .code
10180 ${if inlist{needle}{foo:needle:bar}}
10181   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10182 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10183   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10184 .endd
10185
10186 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10187        &*isip4&~{*&<&'string'&>&*}*& &&&
10188        &*isip6&~{*&<&'string'&>&*}*&
10189 .cindex "IP address" "testing string format"
10190 .cindex "string" "testing for IP address"
10191 .cindex "&%isip%& expansion condition"
10192 .cindex "&%isip4%& expansion condition"
10193 .cindex "&%isip6%& expansion condition"
10194 The substring is first expanded, and then tested to see if it has the form of
10195 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10196 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10197
10198 For an IPv4 address, the test is for four dot-separated components, each of
10199 which consists of from one to three digits. For an IPv6 address, up to eight
10200 colon-separated components are permitted, each containing from one to four
10201 hexadecimal digits. There may be fewer than eight components if an empty
10202 component (adjacent colons) is present. Only one empty component is permitted.
10203
10204 &*Note*&: The checks are just on the form of the address; actual numerical
10205 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10206 check. The main use of these tests is to distinguish between IP addresses and
10207 host names, or between IPv4 and IPv6 addresses. For example, you could use
10208 .code
10209 ${if isip4{$sender_host_address}...
10210 .endd
10211 to test which IP version an incoming SMTP connection is using.
10212
10213 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10214 .cindex "LDAP" "use for authentication"
10215 .cindex "expansion" "LDAP authentication test"
10216 .cindex "&%ldapauth%& expansion condition"
10217 This condition supports user authentication using LDAP. See section
10218 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10219 queries. For this use, the query must contain a user name and password. The
10220 query itself is not used, and can be empty. The condition is true if the
10221 password is not empty, and the user name and password are accepted by the LDAP
10222 server. An empty password is rejected without calling LDAP because LDAP binds
10223 with an empty password are considered anonymous regardless of the username, and
10224 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10225 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10226 this can be used.
10227
10228
10229 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10230        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10231 .cindex "string" "comparison"
10232 .cindex "expansion" "string comparison"
10233 .cindex "&%le%& expansion condition"
10234 .cindex "&%lei%& expansion condition"
10235 The two substrings are first expanded. The condition is true if the first
10236 string is lexically less than or equal to the second string. For &%le%& the
10237 comparison includes the case of letters, whereas for &%lei%& the comparison is
10238 case-independent.
10239
10240 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10241        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10242 .cindex "string" "comparison"
10243 .cindex "expansion" "string comparison"
10244 .cindex "&%lt%& expansion condition"
10245 .cindex "&%lti%& expansion condition"
10246 The two substrings are first expanded. The condition is true if the first
10247 string is lexically less than the second string. For &%lt%& the comparison
10248 includes the case of letters, whereas for &%lti%& the comparison is
10249 case-independent.
10250
10251
10252 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10253 .cindex "expansion" "regular expression comparison"
10254 .cindex "regular expressions" "match in expanded string"
10255 .cindex "&%match%& expansion condition"
10256 The two substrings are first expanded. The second is then treated as a regular
10257 expression and applied to the first. Because of the pre-expansion, if the
10258 regular expression contains dollar, or backslash characters, they must be
10259 escaped. Care must also be taken if the regular expression contains braces
10260 (curly brackets). A closing brace must be escaped so that it is not taken as a
10261 premature termination of <&'string2'&>. The easiest approach is to use the
10262 &`\N`& feature to disable expansion of the regular expression.
10263 For example,
10264 .code
10265 ${if match {$local_part}{\N^\d{3}\N} ...
10266 .endd
10267 If the whole expansion string is in double quotes, further escaping of
10268 backslashes is also required.
10269
10270 The condition is true if the regular expression match succeeds.
10271 The regular expression is not required to begin with a circumflex
10272 metacharacter, but if there is no circumflex, the expression is not anchored,
10273 and it may match anywhere in the subject, not just at the start. If you want
10274 the pattern to match at the end of the subject, you must include the &`$`&
10275 metacharacter at an appropriate point.
10276
10277 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10278 At the start of an &%if%& expansion the values of the numeric variable
10279 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10280 succeeds causes them to be reset to the substrings of that condition and they
10281 will have these values during the expansion of the success string. At the end
10282 of the &%if%& expansion, the previous values are restored. After testing a
10283 combination of conditions using &%or%&, the subsequent values of the numeric
10284 variables are those of the condition that succeeded.
10285
10286 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10287 .cindex "&%match_address%& expansion condition"
10288 See &*match_local_part*&.
10289
10290 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10291 .cindex "&%match_domain%& expansion condition"
10292 See &*match_local_part*&.
10293
10294 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10295 .cindex "&%match_ip%& expansion condition"
10296 This condition matches an IP address to a list of IP address patterns. It must
10297 be followed by two argument strings. The first (after expansion) must be an IP
10298 address or an empty string. The second (not expanded) is a restricted host
10299 list that can match only an IP address, not a host name. For example:
10300 .code
10301 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10302 .endd
10303 The specific types of host list item that are permitted in the list are:
10304
10305 .ilist
10306 An IP address, optionally with a CIDR mask.
10307 .next
10308 A single asterisk, which matches any IP address.
10309 .next
10310 An empty item, which matches only if the IP address is empty. This could be
10311 useful for testing for a locally submitted message or one from specific hosts
10312 in a single test such as
10313 . ==== As this is a nested list, any displays it contains must be indented
10314 . ==== as otherwise they are too far to the left. This comment applies to
10315 . ==== the use of xmlto plus fop. There's no problem when formatting with
10316 . ==== sdop, with or without the extra indent.
10317 .code
10318   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10319 .endd
10320 where the first item in the list is the empty string.
10321 .next
10322 The item @[] matches any of the local host's interface addresses.
10323 .next
10324 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10325 even if &`net-`& is not specified. There is never any attempt to turn the IP
10326 address into a host name. The most common type of linear search for
10327 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10328 masks. For example:
10329 .code
10330   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10331 .endd
10332 It is of course possible to use other kinds of lookup, and in such a case, you
10333 do need to specify the &`net-`& prefix if you want to specify a specific
10334 address mask, for example:
10335 .code
10336   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10337 .endd
10338 However, unless you are combining a &%match_ip%& condition with others, it is
10339 just as easy to use the fact that a lookup is itself a condition, and write:
10340 .code
10341   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10342 .endd
10343 .endlist ilist
10344
10345 Note that <&'string2'&> is not itself subject to string expansion, unless
10346 Exim was built with the EXPAND_LISTMATCH_RHS option.
10347
10348 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10349
10350 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10351 .cindex "domain list" "in expansion condition"
10352 .cindex "address list" "in expansion condition"
10353 .cindex "local part" "list, in expansion condition"
10354 .cindex "&%match_local_part%& expansion condition"
10355 This condition, together with &%match_address%& and &%match_domain%&, make it
10356 possible to test domain, address, and local part lists within expansions. Each
10357 condition requires two arguments: an item and a list to match. A trivial
10358 example is:
10359 .code
10360 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10361 .endd
10362 In each case, the second argument may contain any of the allowable items for a
10363 list of the appropriate type. Also, because the second argument (after
10364 expansion) is a standard form of list, it is possible to refer to a named list.
10365 Thus, you can use conditions like this:
10366 .code
10367 ${if match_domain{$domain}{+local_domains}{...
10368 .endd
10369 .cindex "&`+caseful`&"
10370 For address lists, the matching starts off caselessly, but the &`+caseful`&
10371 item can be used, as in all address lists, to cause subsequent items to
10372 have their local parts matched casefully. Domains are always matched
10373 caselessly.
10374
10375 Note that <&'string2'&> is not itself subject to string expansion, unless
10376 Exim was built with the EXPAND_LISTMATCH_RHS option.
10377
10378 &*Note*&: Host lists are &'not'& supported in this way. This is because
10379 hosts have two identities: a name and an IP address, and it is not clear
10380 how to specify cleanly how such a test would work. However, IP addresses can be
10381 matched using &%match_ip%&.
10382
10383 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10384 .cindex "PAM authentication"
10385 .cindex "AUTH" "with PAM"
10386 .cindex "Solaris" "PAM support"
10387 .cindex "expansion" "PAM authentication test"
10388 .cindex "&%pam%& expansion condition"
10389 &'Pluggable Authentication Modules'&
10390 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10391 available in the latest releases of Solaris and in some GNU/Linux
10392 distributions. The Exim support, which is intended for use in conjunction with
10393 the SMTP AUTH command, is available only if Exim is compiled with
10394 .code
10395 SUPPORT_PAM=yes
10396 .endd
10397 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10398 in some releases of GNU/Linux &%-ldl%& is also needed.
10399
10400 The argument string is first expanded, and the result must be a
10401 colon-separated list of strings. Leading and trailing white space is ignored.
10402 The PAM module is initialized with the service name &"exim"& and the user name
10403 taken from the first item in the colon-separated data string (<&'string1'&>).
10404 The remaining items in the data string are passed over in response to requests
10405 from the authentication function. In the simple case there will only be one
10406 request, for a password, so the data consists of just two strings.
10407
10408 There can be problems if any of the strings are permitted to contain colon
10409 characters. In the usual way, these have to be doubled to avoid being taken as
10410 separators. If the data is being inserted from a variable, the &%sg%& expansion
10411 item can be used to double any existing colons. For example, the configuration
10412 of a LOGIN authenticator might contain this setting:
10413 .code
10414 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10415 .endd
10416 For a PLAIN authenticator you could use:
10417 .code
10418 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10419 .endd
10420 In some operating systems, PAM authentication can be done only from a process
10421 running as root. Since Exim is running as the Exim user when receiving
10422 messages, this means that PAM cannot be used directly in those systems.
10423 A patched version of the &'pam_unix'& module that comes with the
10424 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10425 The patched module allows one special uid/gid combination, in addition to root,
10426 to authenticate. If you build the patched module to allow the Exim user and
10427 group, PAM can then be used from an Exim authenticator.
10428
10429
10430 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10431 .cindex "&'pwcheck'& daemon"
10432 .cindex "Cyrus"
10433 .cindex "expansion" "&'pwcheck'& authentication test"
10434 .cindex "&%pwcheck%& expansion condition"
10435 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10436 This is one way of making it possible for passwords to be checked by a process
10437 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10438 deprecated. Its replacement is &'saslauthd'& (see below).
10439
10440 The pwcheck support is not included in Exim by default. You need to specify
10441 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10442 building Exim. For example:
10443 .code
10444 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10445 .endd
10446 You do not need to install the full Cyrus software suite in order to use
10447 the pwcheck daemon. You can compile and install just the daemon alone
10448 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10449 access to the &_/var/pwcheck_& directory.
10450
10451 The &%pwcheck%& condition takes one argument, which must be the user name and
10452 password, separated by a colon. For example, in a LOGIN authenticator
10453 configuration, you might have this:
10454 .code
10455 server_condition = ${if pwcheck{$auth1:$auth2}}
10456 .endd
10457 Again, for a PLAIN authenticator configuration, this would be:
10458 .code
10459 server_condition = ${if pwcheck{$auth2:$auth3}}
10460 .endd
10461 .vitem &*queue_running*&
10462 .cindex "queue runner" "detecting when delivering from"
10463 .cindex "expansion" "queue runner test"
10464 .cindex "&%queue_running%& expansion condition"
10465 This condition, which has no data, is true during delivery attempts that are
10466 initiated by queue runner processes, and false otherwise.
10467
10468
10469 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10470 .cindex "Radius"
10471 .cindex "expansion" "Radius authentication"
10472 .cindex "&%radius%& expansion condition"
10473 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10474 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10475 the Radius client configuration file in order to build Exim with Radius
10476 support.
10477
10478 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10479 library, using the original API. If you are using release 0.4.0 or later of
10480 this library, you need to set
10481 .code
10482 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10483 .endd
10484 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10485 &%libradius%& library that comes with FreeBSD. To do this, set
10486 .code
10487 RADIUS_LIB_TYPE=RADLIB
10488 .endd
10489 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10490 You may also have to supply a suitable setting in EXTRALIBS so that the
10491 Radius library can be found when Exim is linked.
10492
10493 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10494 Radius client library, which calls the Radius server. The condition is true if
10495 the authentication is successful. For example:
10496 .code
10497 server_condition = ${if radius{<arguments>}}
10498 .endd
10499
10500
10501 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10502         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10503 .cindex "&'saslauthd'& daemon"
10504 .cindex "Cyrus"
10505 .cindex "expansion" "&'saslauthd'& authentication test"
10506 .cindex "&%saslauthd%& expansion condition"
10507 This condition supports user authentication using the Cyrus &'saslauthd'&
10508 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10509 Using this daemon is one way of making it possible for passwords to be checked
10510 by a process that is not running as root.
10511
10512 The saslauthd support is not included in Exim by default. You need to specify
10513 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10514 building Exim. For example:
10515 .code
10516 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10517 .endd
10518 You do not need to install the full Cyrus software suite in order to use
10519 the saslauthd daemon. You can compile and install just the daemon alone
10520 from the Cyrus SASL library.
10521
10522 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10523 two are mandatory. For example:
10524 .code
10525 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10526 .endd
10527 The service and the realm are optional (which is why the arguments are enclosed
10528 in their own set of braces). For details of the meaning of the service and
10529 realm, and how to run the daemon, consult the Cyrus documentation.
10530 .endlist vlist
10531
10532
10533
10534 .section "Combining expansion conditions" "SECID84"
10535 .cindex "expansion" "combining conditions"
10536 Several conditions can be tested at once by combining them using the &%and%&
10537 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10538 conditions on their own, and precede their lists of sub-conditions. Each
10539 sub-condition must be enclosed in braces within the overall braces that contain
10540 the list. No repetition of &%if%& is used.
10541
10542
10543 .vlist
10544 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10545 .cindex "&""or""& expansion condition"
10546 .cindex "expansion" "&""or""& of conditions"
10547 The sub-conditions are evaluated from left to right. The condition is true if
10548 any one of the sub-conditions is true.
10549 For example,
10550 .code
10551 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10552 .endd
10553 When a true sub-condition is found, the following ones are parsed but not
10554 evaluated. If there are several &"match"& sub-conditions the values of the
10555 numeric variables afterwards are taken from the first one that succeeds.
10556
10557 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10558 .cindex "&""and""& expansion condition"
10559 .cindex "expansion" "&""and""& of conditions"
10560 The sub-conditions are evaluated from left to right. The condition is true if
10561 all of the sub-conditions are true. If there are several &"match"&
10562 sub-conditions, the values of the numeric variables afterwards are taken from
10563 the last one. When a false sub-condition is found, the following ones are
10564 parsed but not evaluated.
10565 .endlist
10566 .ecindex IIDexpcond
10567
10568
10569
10570
10571 .section "Expansion variables" "SECTexpvar"
10572 .cindex "expansion" "variables, list of"
10573 This section contains an alphabetical list of all the expansion variables. Some
10574 of them are available only when Exim is compiled with specific options such as
10575 support for TLS or the content scanning extension.
10576
10577 .vlist
10578 .vitem "&$0$&, &$1$&, etc"
10579 .cindex "numerical variables (&$1$& &$2$& etc)"
10580 When a &%match%& expansion condition succeeds, these variables contain the
10581 captured substrings identified by the regular expression during subsequent
10582 processing of the success string of the containing &%if%& expansion item.
10583 However, they do not retain their values afterwards; in fact, their previous
10584 values are restored at the end of processing an &%if%& item. The numerical
10585 variables may also be set externally by some other matching process which
10586 precedes the expansion of the string. For example, the commands available in
10587 Exim filter files include an &%if%& command with its own regular expression
10588 matching condition.
10589
10590 .vitem "&$acl_c...$&"
10591 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10592 can be given any name that starts with &$acl_c$& and is at least six characters
10593 long, but the sixth character must be either a digit or an underscore. For
10594 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10595 variables persist throughout the lifetime of an SMTP connection. They can be
10596 used to pass information between ACLs and between different invocations of the
10597 same ACL. When a message is received, the values of these variables are saved
10598 with the message, and can be accessed by filters, routers, and transports
10599 during subsequent delivery.
10600
10601 .vitem "&$acl_m...$&"
10602 These variables are like the &$acl_c...$& variables, except that their values
10603 are reset after a message has been received. Thus, if several messages are
10604 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10605 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10606 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10607 message is received, the values of these variables are saved with the message,
10608 and can be accessed by filters, routers, and transports during subsequent
10609 delivery.
10610
10611 .vitem &$acl_verify_message$&
10612 .vindex "&$acl_verify_message$&"
10613 After an address verification has failed, this variable contains the failure
10614 message. It retains its value for use in subsequent modifiers. The message can
10615 be preserved by coding like this:
10616 .code
10617 warn !verify = sender
10618      set acl_m0 = $acl_verify_message
10619 .endd
10620 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10621 &%log_message%& modifiers, to include information about the verification
10622 failure.
10623
10624 .vitem &$address_data$&
10625 .vindex "&$address_data$&"
10626 This variable is set by means of the &%address_data%& option in routers. The
10627 value then remains with the address while it is processed by subsequent routers
10628 and eventually a transport. If the transport is handling multiple addresses,
10629 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10630 for more details. &*Note*&: The contents of &$address_data$& are visible in
10631 user filter files.
10632
10633 If &$address_data$& is set when the routers are called from an ACL to verify
10634 a recipient address, the final value is still in the variable for subsequent
10635 conditions and modifiers of the ACL statement. If routing the address caused it
10636 to be redirected to just one address, the child address is also routed as part
10637 of the verification, and in this case the final value of &$address_data$& is
10638 from the child's routing.
10639
10640 If &$address_data$& is set when the routers are called from an ACL to verify a
10641 sender address, the final value is also preserved, but this time in
10642 &$sender_address_data$&, to distinguish it from data from a recipient
10643 address.
10644
10645 In both cases (recipient and sender verification), the value does not persist
10646 after the end of the current ACL statement. If you want to preserve
10647 these values for longer, you can save them in ACL variables.
10648
10649 .vitem &$address_file$&
10650 .vindex "&$address_file$&"
10651 When, as a result of aliasing, forwarding, or filtering, a message is directed
10652 to a specific file, this variable holds the name of the file when the transport
10653 is running. At other times, the variable is empty. For example, using the
10654 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10655 .code
10656 /home/r2d2/savemail
10657 .endd
10658 then when the &(address_file)& transport is running, &$address_file$&
10659 contains the text string &`/home/r2d2/savemail`&.
10660 .cindex "Sieve filter" "value of &$address_file$&"
10661 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10662 then up to the transport configuration to generate an appropriate absolute path
10663 to the relevant file.
10664
10665 .vitem &$address_pipe$&
10666 .vindex "&$address_pipe$&"
10667 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10668 this variable holds the pipe command when the transport is running.
10669
10670 .vitem "&$auth1$& &-- &$auth3$&"
10671 .vindex "&$auth1$&, &$auth2$&, etc"
10672 These variables are used in SMTP authenticators (see chapters
10673 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10674
10675 .vitem &$authenticated_id$&
10676 .cindex "authentication" "id"
10677 .vindex "&$authenticated_id$&"
10678 When a server successfully authenticates a client it may be configured to
10679 preserve some of the authentication information in the variable
10680 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10681 user/password authenticator configuration might preserve the user name for use
10682 in the routers. Note that this is not the same information that is saved in
10683 &$sender_host_authenticated$&.
10684 When a message is submitted locally (that is, not over a TCP connection)
10685 the value of &$authenticated_id$& is normally the login name of the calling
10686 process. However, a trusted user can override this by means of the &%-oMai%&
10687 command line option.
10688
10689
10690
10691
10692 .vitem &$authenticated_sender$&
10693 .cindex "sender" "authenticated"
10694 .cindex "authentication" "sender"
10695 .cindex "AUTH" "on MAIL command"
10696 .vindex "&$authenticated_sender$&"
10697 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10698 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10699 described in section &<<SECTauthparamail>>&. Unless the data is the string
10700 &"<>"&, it is set as the authenticated sender of the message, and the value is
10701 available during delivery in the &$authenticated_sender$& variable. If the
10702 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10703
10704 .vindex "&$qualify_domain$&"
10705 When a message is submitted locally (that is, not over a TCP connection), the
10706 value of &$authenticated_sender$& is an address constructed from the login
10707 name of the calling process and &$qualify_domain$&, except that a trusted user
10708 can override this by means of the &%-oMas%& command line option.
10709
10710
10711 .vitem &$authentication_failed$&
10712 .cindex "authentication" "failure"
10713 .vindex "&$authentication_failed$&"
10714 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10715 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10716 possible to distinguish between &"did not try to authenticate"&
10717 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10718 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10719 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10720 negative response to an AUTH command, including (for example) an attempt to use
10721 an undefined mechanism.
10722
10723 .vitem &$av_failed$&
10724 .cindex "content scanning" "AV scanner failure"
10725 This variable is available when Exim is compiled with the content-scanning
10726 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10727 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10728 the ACL malware condition.
10729
10730 .vitem &$body_linecount$&
10731 .cindex "message body" "line count"
10732 .cindex "body of message" "line count"
10733 .vindex "&$body_linecount$&"
10734 When a message is being received or delivered, this variable contains the
10735 number of lines in the message's body. See also &$message_linecount$&.
10736
10737 .vitem &$body_zerocount$&
10738 .cindex "message body" "binary zero count"
10739 .cindex "body of message" "binary zero count"
10740 .cindex "binary zero" "in message body"
10741 .vindex "&$body_zerocount$&"
10742 When a message is being received or delivered, this variable contains the
10743 number of binary zero bytes (ASCII NULs) in the message's body.
10744
10745 .vitem &$bounce_recipient$&
10746 .vindex "&$bounce_recipient$&"
10747 This is set to the recipient address of a bounce message while Exim is creating
10748 it. It is useful if a customized bounce message text file is in use (see
10749 chapter &<<CHAPemsgcust>>&).
10750
10751 .vitem &$bounce_return_size_limit$&
10752 .vindex "&$bounce_return_size_limit$&"
10753 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10754 up to a multiple of 1000. It is useful when a customized error message text
10755 file is in use (see chapter &<<CHAPemsgcust>>&).
10756
10757 .vitem &$caller_gid$&
10758 .cindex "gid (group id)" "caller"
10759 .vindex "&$caller_gid$&"
10760 The real group id under which the process that called Exim was running. This is
10761 not the same as the group id of the originator of a message (see
10762 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10763 incarnation normally contains the Exim gid.
10764
10765 .vitem &$caller_uid$&
10766 .cindex "uid (user id)" "caller"
10767 .vindex "&$caller_uid$&"
10768 The real user id under which the process that called Exim was running. This is
10769 not the same as the user id of the originator of a message (see
10770 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10771 incarnation normally contains the Exim uid.
10772
10773 .vitem &$compile_date$&
10774 .vindex "&$compile_date$&"
10775 The date on which the Exim binary was compiled.
10776
10777 .vitem &$compile_number$&
10778 .vindex "&$compile_number$&"
10779 The building process for Exim keeps a count of the number
10780 of times it has been compiled. This serves to distinguish different
10781 compilations of the same version of the program.
10782
10783 .vitem &$demime_errorlevel$&
10784 .vindex "&$demime_errorlevel$&"
10785 This variable is available when Exim is compiled with
10786 the content-scanning extension and the obsolete &%demime%& condition. For
10787 details, see section &<<SECTdemimecond>>&.
10788
10789 .vitem &$demime_reason$&
10790 .vindex "&$demime_reason$&"
10791 This variable is available when Exim is compiled with the
10792 content-scanning extension and the obsolete &%demime%& condition. For details,
10793 see section &<<SECTdemimecond>>&.
10794
10795 .vitem &$dnslist_domain$& &&&
10796        &$dnslist_matched$& &&&
10797        &$dnslist_text$& &&&
10798        &$dnslist_value$&
10799 .vindex "&$dnslist_domain$&"
10800 .vindex "&$dnslist_matched$&"
10801 .vindex "&$dnslist_text$&"
10802 .vindex "&$dnslist_value$&"
10803 .cindex "black list (DNS)"
10804 When a DNS (black) list lookup succeeds, these variables are set to contain
10805 the following data from the lookup: the list's domain name, the key that was
10806 looked up, the contents of any associated TXT record, and the value from the
10807 main A record. See section &<<SECID204>>& for more details.
10808
10809 .vitem &$domain$&
10810 .vindex "&$domain$&"
10811 When an address is being routed, or delivered on its own, this variable
10812 contains the domain. Uppercase letters in the domain are converted into lower
10813 case for &$domain$&.
10814
10815 Global address rewriting happens when a message is received, so the value of
10816 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10817 is set during user filtering, but not during system filtering, because a
10818 message may have many recipients and the system filter is called just once.
10819
10820 When more than one address is being delivered at once (for example, several
10821 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10822 have the same domain. Transports can be restricted to handling only one domain
10823 at a time if the value of &$domain$& is required at transport time &-- this is
10824 the default for local transports. For further details of the environment in
10825 which local transports are run, see chapter &<<CHAPenvironment>>&.
10826
10827 .oindex "&%delay_warning_condition%&"
10828 At the end of a delivery, if all deferred addresses have the same domain, it is
10829 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10830
10831 The &$domain$& variable is also used in some other circumstances:
10832
10833 .ilist
10834 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10835 the recipient address. The domain of the &'sender'& address is in
10836 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10837 normally set during the running of the MAIL ACL. However, if the sender address
10838 is verified with a callout during the MAIL ACL, the sender domain is placed in
10839 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10840 the &(smtp)& transport.
10841
10842 .next
10843 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10844 &$domain$& contains the domain portion of the address that is being rewritten;
10845 it can be used in the expansion of the replacement address, for example, to
10846 rewrite domains by file lookup.
10847
10848 .next
10849 With one important exception, whenever a domain list is being scanned,
10850 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10851 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10852 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10853 that, in a RCPT ACL, the sender domain list can be dependent on the
10854 recipient domain (which is what is in &$domain$& at this time).
10855
10856 .next
10857 .cindex "ETRN" "value of &$domain$&"
10858 .oindex "&%smtp_etrn_command%&"
10859 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10860 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10861 .endlist
10862
10863
10864 .vitem &$domain_data$&
10865 .vindex "&$domain_data$&"
10866 When the &%domains%& option on a router matches a domain by
10867 means of a lookup, the data read by the lookup is available during the running
10868 of the router as &$domain_data$&. In addition, if the driver routes the
10869 address to a transport, the value is available in that transport. If the
10870 transport is handling multiple addresses, the value from the first address is
10871 used.
10872
10873 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10874 domain by means of a lookup. The data read by the lookup is available during
10875 the rest of the ACL statement. In all other situations, this variable expands
10876 to nothing.
10877
10878 .vitem &$exim_gid$&
10879 .vindex "&$exim_gid$&"
10880 This variable contains the numerical value of the Exim group id.
10881
10882 .vitem &$exim_path$&
10883 .vindex "&$exim_path$&"
10884 This variable contains the path to the Exim binary.
10885
10886 .vitem &$exim_uid$&
10887 .vindex "&$exim_uid$&"
10888 This variable contains the numerical value of the Exim user id.
10889
10890 .vitem &$found_extension$&
10891 .vindex "&$found_extension$&"
10892 This variable is available when Exim is compiled with the
10893 content-scanning extension and the obsolete &%demime%& condition. For details,
10894 see section &<<SECTdemimecond>>&.
10895
10896 .vitem &$header_$&<&'name'&>
10897 This is not strictly an expansion variable. It is expansion syntax for
10898 inserting the message header line with the given name. Note that the name must
10899 be terminated by colon or white space, because it may contain a wide variety of
10900 characters. Note also that braces must &'not'& be used.
10901
10902 .vitem &$home$&
10903 .vindex "&$home$&"
10904 When the &%check_local_user%& option is set for a router, the user's home
10905 directory is placed in &$home$& when the check succeeds. In particular, this
10906 means it is set during the running of users' filter files. A router may also
10907 explicitly set a home directory for use by a transport; this can be overridden
10908 by a setting on the transport itself.
10909
10910 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10911 of the environment variable HOME.
10912
10913 .vitem &$host$&
10914 .vindex "&$host$&"
10915 If a router assigns an address to a transport (any transport), and passes a
10916 list of hosts with the address, the value of &$host$& when the transport starts
10917 to run is the name of the first host on the list. Note that this applies both
10918 to local and remote transports.
10919
10920 .cindex "transport" "filter"
10921 .cindex "filter" "transport filter"
10922 For the &(smtp)& transport, if there is more than one host, the value of
10923 &$host$& changes as the transport works its way through the list. In
10924 particular, when the &(smtp)& transport is expanding its options for encryption
10925 using TLS, or for specifying a transport filter (see chapter
10926 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10927 is connected.
10928
10929 When used in the client part of an authenticator configuration (see chapter
10930 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10931 client is connected.
10932
10933
10934 .vitem &$host_address$&
10935 .vindex "&$host_address$&"
10936 This variable is set to the remote host's IP address whenever &$host$& is set
10937 for a remote connection. It is also set to the IP address that is being checked
10938 when the &%ignore_target_hosts%& option is being processed.
10939
10940 .vitem &$host_data$&
10941 .vindex "&$host_data$&"
10942 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10943 result of the lookup is made available in the &$host_data$& variable. This
10944 allows you, for example, to do things like this:
10945 .code
10946 deny  hosts = net-lsearch;/some/file
10947 message = $host_data
10948 .endd
10949 .vitem &$host_lookup_deferred$&
10950 .cindex "host name" "lookup, failure of"
10951 .vindex "&$host_lookup_deferred$&"
10952 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10953 message comes from a remote host and there is an attempt to look up the host's
10954 name from its IP address, and the attempt is not successful, one of these
10955 variables is set to &"1"&.
10956
10957 .ilist
10958 If the lookup receives a definite negative response (for example, a DNS lookup
10959 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10960
10961 .next
10962 If there is any kind of problem during the lookup, such that Exim cannot
10963 tell whether or not the host name is defined (for example, a timeout for a DNS
10964 lookup), &$host_lookup_deferred$& is set to &"1"&.
10965 .endlist ilist
10966
10967 Looking up a host's name from its IP address consists of more than just a
10968 single reverse lookup. Exim checks that a forward lookup of at least one of the
10969 names it receives from a reverse lookup yields the original IP address. If this
10970 is not the case, Exim does not accept the looked up name(s), and
10971 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10972 IP address (for example, the existence of a PTR record in the DNS) is not
10973 sufficient on its own for the success of a host name lookup. If the reverse
10974 lookup succeeds, but there is a lookup problem such as a timeout when checking
10975 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10976 &"1"&. See also &$sender_host_name$&.
10977
10978 .vitem &$host_lookup_failed$&
10979 .vindex "&$host_lookup_failed$&"
10980 See &$host_lookup_deferred$&.
10981
10982
10983 .vitem &$inode$&
10984 .vindex "&$inode$&"
10985 The only time this variable is set is while expanding the &%directory_file%&
10986 option in the &(appendfile)& transport. The variable contains the inode number
10987 of the temporary file which is about to be renamed. It can be used to construct
10988 a unique name for the file.
10989
10990 .vitem &$interface_address$&
10991 .vindex "&$interface_address$&"
10992 This is an obsolete name for &$received_ip_address$&.
10993
10994 .vitem &$interface_port$&
10995 .vindex "&$interface_port$&"
10996 This is an obsolete name for &$received_port$&.
10997
10998 .vitem &$item$&
10999 .vindex "&$item$&"
11000 This variable is used during the expansion of &*forall*& and &*forany*&
11001 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11002 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11003 empty.
11004
11005 .vitem &$ldap_dn$&
11006 .vindex "&$ldap_dn$&"
11007 This variable, which is available only when Exim is compiled with LDAP support,
11008 contains the DN from the last entry in the most recently successful LDAP
11009 lookup.
11010
11011 .vitem &$load_average$&
11012 .vindex "&$load_average$&"
11013 This variable contains the system load average, multiplied by 1000 so that it
11014 is an integer. For example, if the load average is 0.21, the value of the
11015 variable is 210. The value is recomputed every time the variable is referenced.
11016
11017 .vitem &$local_part$&
11018 .vindex "&$local_part$&"
11019 When an address is being routed, or delivered on its own, this
11020 variable contains the local part. When a number of addresses are being
11021 delivered together (for example, multiple RCPT commands in an SMTP
11022 session), &$local_part$& is not set.
11023
11024 Global address rewriting happens when a message is received, so the value of
11025 &$local_part$& during routing and delivery is the value after rewriting.
11026 &$local_part$& is set during user filtering, but not during system filtering,
11027 because a message may have many recipients and the system filter is called just
11028 once.
11029
11030 .vindex "&$local_part_prefix$&"
11031 .vindex "&$local_part_suffix$&"
11032 If a local part prefix or suffix has been recognized, it is not included in the
11033 value of &$local_part$& during routing and subsequent delivery. The values of
11034 any prefix or suffix are in &$local_part_prefix$& and
11035 &$local_part_suffix$&, respectively.
11036
11037 When a message is being delivered to a file, pipe, or autoreply transport as a
11038 result of aliasing or forwarding, &$local_part$& is set to the local part of
11039 the parent address, not to the file name or command (see &$address_file$& and
11040 &$address_pipe$&).
11041
11042 When an ACL is running for a RCPT command, &$local_part$& contains the
11043 local part of the recipient address.
11044
11045 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11046 &$local_part$& contains the local part of the address that is being rewritten;
11047 it can be used in the expansion of the replacement address, for example.
11048
11049 In all cases, all quoting is removed from the local part. For example, for both
11050 the addresses
11051 .code
11052 "abc:xyz"@test.example
11053 abc\:xyz@test.example
11054 .endd
11055 the value of &$local_part$& is
11056 .code
11057 abc:xyz
11058 .endd
11059 If you use &$local_part$& to create another address, you should always wrap it
11060 inside a quoting operator. For example, in a &(redirect)& router you could
11061 have:
11062 .code
11063 data = ${quote_local_part:$local_part}@new.domain.example
11064 .endd
11065 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11066 to process local parts in a case-dependent manner in a router, you can set the
11067 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11068
11069 .vitem &$local_part_data$&
11070 .vindex "&$local_part_data$&"
11071 When the &%local_parts%& option on a router matches a local part by means of a
11072 lookup, the data read by the lookup is available during the running of the
11073 router as &$local_part_data$&. In addition, if the driver routes the address
11074 to a transport, the value is available in that transport. If the transport is
11075 handling multiple addresses, the value from the first address is used.
11076
11077 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11078 matches a local part by means of a lookup. The data read by the lookup is
11079 available during the rest of the ACL statement. In all other situations, this
11080 variable expands to nothing.
11081
11082 .vitem &$local_part_prefix$&
11083 .vindex "&$local_part_prefix$&"
11084 When an address is being routed or delivered, and a
11085 specific prefix for the local part was recognized, it is available in this
11086 variable, having been removed from &$local_part$&.
11087
11088 .vitem &$local_part_suffix$&
11089 .vindex "&$local_part_suffix$&"
11090 When an address is being routed or delivered, and a
11091 specific suffix for the local part was recognized, it is available in this
11092 variable, having been removed from &$local_part$&.
11093
11094 .vitem &$local_scan_data$&
11095 .vindex "&$local_scan_data$&"
11096 This variable contains the text returned by the &[local_scan()]& function when
11097 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11098
11099 .vitem &$local_user_gid$&
11100 .vindex "&$local_user_gid$&"
11101 See &$local_user_uid$&.
11102
11103 .vitem &$local_user_uid$&
11104 .vindex "&$local_user_uid$&"
11105 This variable and &$local_user_gid$& are set to the uid and gid after the
11106 &%check_local_user%& router precondition succeeds. This means that their values
11107 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11108 and &%condition%&), for the &%address_data%& expansion, and for any
11109 router-specific expansions. At all other times, the values in these variables
11110 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11111
11112 .vitem &$localhost_number$&
11113 .vindex "&$localhost_number$&"
11114 This contains the expanded value of the
11115 &%localhost_number%& option. The expansion happens after the main options have
11116 been read.
11117
11118 .vitem &$log_inodes$&
11119 .vindex "&$log_inodes$&"
11120 The number of free inodes in the disk partition where Exim's
11121 log files are being written. The value is recalculated whenever the variable is
11122 referenced. If the relevant file system does not have the concept of inodes,
11123 the value of is -1. See also the &%check_log_inodes%& option.
11124
11125 .vitem &$log_space$&
11126 .vindex "&$log_space$&"
11127 The amount of free space (as a number of kilobytes) in the disk
11128 partition where Exim's log files are being written. The value is recalculated
11129 whenever the variable is referenced. If the operating system does not have the
11130 ability to find the amount of free space (only true for experimental systems),
11131 the space value is -1. See also the &%check_log_space%& option.
11132
11133
11134 .vitem &$mailstore_basename$&
11135 .vindex "&$mailstore_basename$&"
11136 This variable is set only when doing deliveries in &"mailstore"& format in the
11137 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11138 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11139 contains the basename of the files that are being written, that is, the name
11140 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11141 variable is empty.
11142
11143 .vitem &$malware_name$&
11144 .vindex "&$malware_name$&"
11145 This variable is available when Exim is compiled with the
11146 content-scanning extension. It is set to the name of the virus that was found
11147 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11148
11149 .vitem &$max_received_linelength$&
11150 .vindex "&$max_received_linelength$&"
11151 .cindex "maximum" "line length"
11152 .cindex "line length" "maximum"
11153 This variable contains the number of bytes in the longest line that was
11154 received as part of the message, not counting the line termination
11155 character(s).
11156
11157 .vitem &$message_age$&
11158 .cindex "message" "age of"
11159 .vindex "&$message_age$&"
11160 This variable is set at the start of a delivery attempt to contain the number
11161 of seconds since the message was received. It does not change during a single
11162 delivery attempt.
11163
11164 .vitem &$message_body$&
11165 .cindex "body of message" "expansion variable"
11166 .cindex "message body" "in expansion"
11167 .cindex "binary zero" "in message body"
11168 .vindex "&$message_body$&"
11169 .oindex "&%message_body_visible%&"
11170 This variable contains the initial portion of a message's body while it is
11171 being delivered, and is intended mainly for use in filter files. The maximum
11172 number of characters of the body that are put into the variable is set by the
11173 &%message_body_visible%& configuration option; the default is 500.
11174
11175 .oindex "&%message_body_newlines%&"
11176 By default, newlines are converted into spaces in &$message_body$&, to make it
11177 easier to search for phrases that might be split over a line break. However,
11178 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11179 zeros are always converted into spaces.
11180
11181 .vitem &$message_body_end$&
11182 .cindex "body of message" "expansion variable"
11183 .cindex "message body" "in expansion"
11184 .vindex "&$message_body_end$&"
11185 This variable contains the final portion of a message's
11186 body while it is being delivered. The format and maximum size are as for
11187 &$message_body$&.
11188
11189 .vitem &$message_body_size$&
11190 .cindex "body of message" "size"
11191 .cindex "message body" "size"
11192 .vindex "&$message_body_size$&"
11193 When a message is being delivered, this variable contains the size of the body
11194 in bytes. The count starts from the character after the blank line that
11195 separates the body from the header. Newlines are included in the count. See
11196 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11197
11198 .vitem &$message_exim_id$&
11199 .vindex "&$message_exim_id$&"
11200 When a message is being received or delivered, this variable contains the
11201 unique message id that is generated and used by Exim to identify the message.
11202 An id is not created for a message until after its header has been successfully
11203 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11204 line; it is the local id that Exim assigns to the message, for example:
11205 &`1BXTIK-0001yO-VA`&.
11206
11207 .vitem &$message_headers$&
11208 .vindex &$message_headers$&
11209 This variable contains a concatenation of all the header lines when a message
11210 is being processed, except for lines added by routers or transports. The header
11211 lines are separated by newline characters. Their contents are decoded in the
11212 same way as a header line that is inserted by &%bheader%&.
11213
11214 .vitem &$message_headers_raw$&
11215 .vindex &$message_headers_raw$&
11216 This variable is like &$message_headers$& except that no processing of the
11217 contents of header lines is done.
11218
11219 .vitem &$message_id$&
11220 This is an old name for &$message_exim_id$&, which is now deprecated.
11221
11222 .vitem &$message_linecount$&
11223 .vindex "&$message_linecount$&"
11224 This variable contains the total number of lines in the header and body of the
11225 message. Compare &$body_linecount$&, which is the count for the body only.
11226 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11227 number of lines received. Before delivery happens (that is, before filters,
11228 routers, and transports run) the count is increased to include the
11229 &'Received:'& header line that Exim standardly adds, and also any other header
11230 lines that are added by ACLs. The blank line that separates the message header
11231 from the body is not counted.
11232
11233 As with the special case of &$message_size$&, during the expansion of the
11234 appendfile transport's maildir_tag option in maildir format, the value of
11235 &$message_linecount$& is the precise size of the number of newlines in the
11236 file that has been written (minus one for the blank line between the
11237 header and the body).
11238
11239 Here is an example of the use of this variable in a DATA ACL:
11240 .code
11241 deny message   = Too many lines in message header
11242      condition = \
11243       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11244 .endd
11245 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11246 message has not yet been received.
11247
11248 .vitem &$message_size$&
11249 .cindex "size" "of message"
11250 .cindex "message" "size"
11251 .vindex "&$message_size$&"
11252 When a message is being processed, this variable contains its size in bytes. In
11253 most cases, the size includes those headers that were received with the
11254 message, but not those (such as &'Envelope-to:'&) that are added to individual
11255 deliveries as they are written. However, there is one special case: during the
11256 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11257 doing a delivery in maildir format, the value of &$message_size$& is the
11258 precise size of the file that has been written. See also
11259 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11260
11261 .cindex "RCPT" "value of &$message_size$&"
11262 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11263 contains the size supplied on the MAIL command, or -1 if no size was given. The
11264 value may not, of course, be truthful.
11265
11266 .vitem &$mime_$&&'xxx'&
11267 A number of variables whose names start with &$mime$& are
11268 available when Exim is compiled with the content-scanning extension. For
11269 details, see section &<<SECTscanmimepart>>&.
11270
11271 .vitem "&$n0$& &-- &$n9$&"
11272 These variables are counters that can be incremented by means
11273 of the &%add%& command in filter files.
11274
11275 .vitem &$original_domain$&
11276 .vindex "&$domain$&"
11277 .vindex "&$original_domain$&"
11278 When a top-level address is being processed for delivery, this contains the
11279 same value as &$domain$&. However, if a &"child"& address (for example,
11280 generated by an alias, forward, or filter file) is being processed, this
11281 variable contains the domain of the original address (lower cased). This
11282 differs from &$parent_domain$& only when there is more than one level of
11283 aliasing or forwarding. When more than one address is being delivered in a
11284 single transport run, &$original_domain$& is not set.
11285
11286 If a new address is created by means of a &%deliver%& command in a system
11287 filter, it is set up with an artificial &"parent"& address. This has the local
11288 part &'system-filter'& and the default qualify domain.
11289
11290 .vitem &$original_local_part$&
11291 .vindex "&$local_part$&"
11292 .vindex "&$original_local_part$&"
11293 When a top-level address is being processed for delivery, this contains the
11294 same value as &$local_part$&, unless a prefix or suffix was removed from the
11295 local part, because &$original_local_part$& always contains the full local
11296 part. When a &"child"& address (for example, generated by an alias, forward, or
11297 filter file) is being processed, this variable contains the full local part of
11298 the original address.
11299
11300 If the router that did the redirection processed the local part
11301 case-insensitively, the value in &$original_local_part$& is in lower case.
11302 This variable differs from &$parent_local_part$& only when there is more than
11303 one level of aliasing or forwarding. When more than one address is being
11304 delivered in a single transport run, &$original_local_part$& is not set.
11305
11306 If a new address is created by means of a &%deliver%& command in a system
11307 filter, it is set up with an artificial &"parent"& address. This has the local
11308 part &'system-filter'& and the default qualify domain.
11309
11310 .vitem &$originator_gid$&
11311 .cindex "gid (group id)" "of originating user"
11312 .cindex "sender" "gid"
11313 .vindex "&$caller_gid$&"
11314 .vindex "&$originator_gid$&"
11315 This variable contains the value of &$caller_gid$& that was set when the
11316 message was received. For messages received via the command line, this is the
11317 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11318 normally the gid of the Exim user.
11319
11320 .vitem &$originator_uid$&
11321 .cindex "uid (user id)" "of originating user"
11322 .cindex "sender" "uid"
11323 .vindex "&$caller_uid$&"
11324 .vindex "&$originaltor_uid$&"
11325 The value of &$caller_uid$& that was set when the message was received. For
11326 messages received via the command line, this is the uid of the sending user.
11327 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11328 user.
11329
11330 .vitem &$parent_domain$&
11331 .vindex "&$parent_domain$&"
11332 This variable is similar to &$original_domain$& (see
11333 above), except that it refers to the immediately preceding parent address.
11334
11335 .vitem &$parent_local_part$&
11336 .vindex "&$parent_local_part$&"
11337 This variable is similar to &$original_local_part$&
11338 (see above), except that it refers to the immediately preceding parent address.
11339
11340 .vitem &$pid$&
11341 .cindex "pid (process id)" "of current process"
11342 .vindex "&$pid$&"
11343 This variable contains the current process id.
11344
11345 .vitem &$pipe_addresses$&
11346 .cindex "filter" "transport filter"
11347 .cindex "transport" "filter"
11348 .vindex "&$pipe_addresses$&"
11349 This is not an expansion variable, but is mentioned here because the string
11350 &`$pipe_addresses`& is handled specially in the command specification for the
11351 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11352 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11353 It cannot be used in general expansion strings, and provokes an &"unknown
11354 variable"& error if encountered.
11355
11356 .vitem &$primary_hostname$&
11357 .vindex "&$primary_hostname$&"
11358 This variable contains the value set by &%primary_hostname%& in the
11359 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11360 a single-component name, Exim calls &[gethostbyname()]& (or
11361 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11362 qualified host name. See also &$smtp_active_hostname$&.
11363
11364
11365 .vitem &$prvscheck_address$&
11366 This variable is used in conjunction with the &%prvscheck%& expansion item,
11367 which is described in sections &<<SECTexpansionitems>>& and
11368 &<<SECTverifyPRVS>>&.
11369
11370 .vitem &$prvscheck_keynum$&
11371 This variable is used in conjunction with the &%prvscheck%& expansion item,
11372 which is described in sections &<<SECTexpansionitems>>& and
11373 &<<SECTverifyPRVS>>&.
11374
11375 .vitem &$prvscheck_result$&
11376 This variable is used in conjunction with the &%prvscheck%& expansion item,
11377 which is described in sections &<<SECTexpansionitems>>& and
11378 &<<SECTverifyPRVS>>&.
11379
11380 .vitem &$qualify_domain$&
11381 .vindex "&$qualify_domain$&"
11382 The value set for the &%qualify_domain%& option in the configuration file.
11383
11384 .vitem &$qualify_recipient$&
11385 .vindex "&$qualify_recipient$&"
11386 The value set for the &%qualify_recipient%& option in the configuration file,
11387 or if not set, the value of &$qualify_domain$&.
11388
11389 .vitem &$rcpt_count$&
11390 .vindex "&$rcpt_count$&"
11391 When a message is being received by SMTP, this variable contains the number of
11392 RCPT commands received for the current message. If this variable is used in a
11393 RCPT ACL, its value includes the current command.
11394
11395 .vitem &$rcpt_defer_count$&
11396 .vindex "&$rcpt_defer_count$&"
11397 .cindex "4&'xx'& responses" "count of"
11398 When a message is being received by SMTP, this variable contains the number of
11399 RCPT commands in the current message that have previously been rejected with a
11400 temporary (4&'xx'&) response.
11401
11402 .vitem &$rcpt_fail_count$&
11403 .vindex "&$rcpt_fail_count$&"
11404 When a message is being received by SMTP, this variable contains the number of
11405 RCPT commands in the current message that have previously been rejected with a
11406 permanent (5&'xx'&) response.
11407
11408 .vitem &$received_count$&
11409 .vindex "&$received_count$&"
11410 This variable contains the number of &'Received:'& header lines in the message,
11411 including the one added by Exim (so its value is always greater than zero). It
11412 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11413 delivering.
11414
11415 .vitem &$received_for$&
11416 .vindex "&$received_for$&"
11417 If there is only a single recipient address in an incoming message, this
11418 variable contains that address when the &'Received:'& header line is being
11419 built. The value is copied after recipient rewriting has happened, but before
11420 the &[local_scan()]& function is run.
11421
11422 .vitem &$received_ip_address$&
11423 .vindex "&$received_ip_address$&"
11424 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11425 variable is set to the address of the local IP interface, and &$received_port$&
11426 is set to the local port number. (The remote IP address and port are in
11427 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11428 the port value is -1 unless it has been set using the &%-oMi%& command line
11429 option.
11430
11431 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11432 could be used, for example, to make the file name for a TLS certificate depend
11433 on which interface and/or port is being used for the incoming connection. The
11434 values of &$received_ip_address$& and &$received_port$& are saved with any
11435 messages that are received, thus making these variables available at delivery
11436 time.
11437
11438 &*Note:*& There are no equivalent variables for outgoing connections, because
11439 the values are unknown (unless they are explicitly set by options of the
11440 &(smtp)& transport).
11441
11442 .vitem &$received_port$&
11443 .vindex "&$received_port$&"
11444 See &$received_ip_address$&.
11445
11446 .vitem &$received_protocol$&
11447 .vindex "&$received_protocol$&"
11448 When a message is being processed, this variable contains the name of the
11449 protocol by which it was received. Most of the names used by Exim are defined
11450 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11451 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11452 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11453 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11454 connection and the client was successfully authenticated.
11455
11456 Exim uses the protocol name &"smtps"& for the case when encryption is
11457 automatically set up on connection without the use of STARTTLS (see
11458 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11459 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11460 where the client initially uses EHLO, sets up an encrypted connection using
11461 STARTTLS, and then uses HELO afterwards.
11462
11463 The &%-oMr%& option provides a way of specifying a custom protocol name for
11464 messages that are injected locally by trusted callers. This is commonly used to
11465 identify messages that are being re-injected after some kind of scanning.
11466
11467 .vitem &$received_time$&
11468 .vindex "&$received_time$&"
11469 This variable contains the date and time when the current message was received,
11470 as a number of seconds since the start of the Unix epoch.
11471
11472 .vitem &$recipient_data$&
11473 .vindex "&$recipient_data$&"
11474 This variable is set after an indexing lookup success in an ACL &%recipients%&
11475 condition. It contains the data from the lookup, and the value remains set
11476 until the next &%recipients%& test. Thus, you can do things like this:
11477 .display
11478 &`require recipients  = cdb*@;/some/file`&
11479 &`deny    `&&'some further test involving'& &`$recipient_data`&
11480 .endd
11481 &*Warning*&: This variable is set only when a lookup is used as an indexing
11482 method in the address list, using the semicolon syntax as in the example above.
11483 The variable is not set for a lookup that is used as part of the string
11484 expansion that all such lists undergo before being interpreted.
11485
11486 .vitem &$recipient_verify_failure$&
11487 .vindex "&$recipient_verify_failure$&"
11488 In an ACL, when a recipient verification fails, this variable contains
11489 information about the failure. It is set to one of the following words:
11490
11491 .ilist
11492 &"qualify"&: The address was unqualified (no domain), and the message
11493 was neither local nor came from an exempted host.
11494
11495 .next
11496 &"route"&: Routing failed.
11497
11498 .next
11499 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11500 or before the MAIL command (that is, on initial connection, HELO, or
11501 MAIL).
11502
11503 .next
11504 &"recipient"&: The RCPT command in a callout was rejected.
11505 .next
11506
11507 &"postmaster"&: The postmaster check in a callout was rejected.
11508 .endlist
11509
11510 The main use of this variable is expected to be to distinguish between
11511 rejections of MAIL and rejections of RCPT.
11512
11513 .vitem &$recipients$&
11514 .vindex "&$recipients$&"
11515 This variable contains a list of envelope recipients for a message. A comma and
11516 a space separate the addresses in the replacement text. However, the variable
11517 is not generally available, to prevent exposure of Bcc recipients in
11518 unprivileged users' filter files. You can use &$recipients$& only in these
11519 cases:
11520
11521 .olist
11522 In a system filter file.
11523 .next
11524 In the ACLs associated with the DATA command and with non-SMTP messages, that
11525 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11526 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11527 &%acl_not_smtp_mime%&.
11528 .next
11529 From within a &[local_scan()]& function.
11530 .endlist
11531
11532
11533 .vitem &$recipients_count$&
11534 .vindex "&$recipients_count$&"
11535 When a message is being processed, this variable contains the number of
11536 envelope recipients that came with the message. Duplicates are not excluded
11537 from the count. While a message is being received over SMTP, the number
11538 increases for each accepted recipient. It can be referenced in an ACL.
11539
11540
11541 .vitem &$regex_match_string$&
11542 .vindex "&$regex_match_string$&"
11543 This variable is set to contain the matching regular expression after a
11544 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11545
11546
11547 .vitem &$reply_address$&
11548 .vindex "&$reply_address$&"
11549 When a message is being processed, this variable contains the contents of the
11550 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11551 contents of the &'From:'& header line. Apart from the removal of leading
11552 white space, the value is not processed in any way. In particular, no RFC 2047
11553 decoding or character code translation takes place.
11554
11555 .vitem &$return_path$&
11556 .vindex "&$return_path$&"
11557 When a message is being delivered, this variable contains the return path &--
11558 the sender field that will be sent as part of the envelope. It is not enclosed
11559 in <> characters. At the start of routing an address, &$return_path$& has the
11560 same value as &$sender_address$&, but if, for example, an incoming message to a
11561 mailing list has been expanded by a router which specifies a different address
11562 for bounce messages, &$return_path$& subsequently contains the new bounce
11563 address, whereas &$sender_address$& always contains the original sender address
11564 that was received with the message. In other words, &$sender_address$& contains
11565 the incoming envelope sender, and &$return_path$& contains the outgoing
11566 envelope sender.
11567
11568 .vitem &$return_size_limit$&
11569 .vindex "&$return_size_limit$&"
11570 This is an obsolete name for &$bounce_return_size_limit$&.
11571
11572 .vitem &$runrc$&
11573 .cindex "return code" "from &%run%& expansion"
11574 .vindex "&$runrc$&"
11575 This variable contains the return code from a command that is run by the
11576 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11577 assume the order in which option values are expanded, except for those
11578 preconditions whose order of testing is documented. Therefore, you cannot
11579 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11580 another.
11581
11582 .vitem &$self_hostname$&
11583 .oindex "&%self%&" "value of host name"
11584 .vindex "&$self_hostname$&"
11585 When an address is routed to a supposedly remote host that turns out to be the
11586 local host, what happens is controlled by the &%self%& generic router option.
11587 One of its values causes the address to be passed to another router. When this
11588 happens, &$self_hostname$& is set to the name of the local host that the
11589 original router encountered. In other circumstances its contents are null.
11590
11591 .vitem &$sender_address$&
11592 .vindex "&$sender_address$&"
11593 When a message is being processed, this variable contains the sender's address
11594 that was received in the message's envelope. The case of letters in the address
11595 is retained, in both the local part and the domain. For bounce messages, the
11596 value of this variable is the empty string. See also &$return_path$&.
11597
11598 .vitem &$sender_address_data$&
11599 .vindex "&$address_data$&"
11600 .vindex "&$sender_address_data$&"
11601 If &$address_data$& is set when the routers are called from an ACL to verify a
11602 sender address, the final value is preserved in &$sender_address_data$&, to
11603 distinguish it from data from a recipient address. The value does not persist
11604 after the end of the current ACL statement. If you want to preserve it for
11605 longer, you can save it in an ACL variable.
11606
11607 .vitem &$sender_address_domain$&
11608 .vindex "&$sender_address_domain$&"
11609 The domain portion of &$sender_address$&.
11610
11611 .vitem &$sender_address_local_part$&
11612 .vindex "&$sender_address_local_part$&"
11613 The local part portion of &$sender_address$&.
11614
11615 .vitem &$sender_data$&
11616 .vindex "&$sender_data$&"
11617 This variable is set after a lookup success in an ACL &%senders%& condition or
11618 in a router &%senders%& option. It contains the data from the lookup, and the
11619 value remains set until the next &%senders%& test. Thus, you can do things like
11620 this:
11621 .display
11622 &`require senders      = cdb*@;/some/file`&
11623 &`deny    `&&'some further test involving'& &`$sender_data`&
11624 .endd
11625 &*Warning*&: This variable is set only when a lookup is used as an indexing
11626 method in the address list, using the semicolon syntax as in the example above.
11627 The variable is not set for a lookup that is used as part of the string
11628 expansion that all such lists undergo before being interpreted.
11629
11630 .vitem &$sender_fullhost$&
11631 .vindex "&$sender_fullhost$&"
11632 When a message is received from a remote host, this variable contains the host
11633 name and IP address in a single string. It ends with the IP address in square
11634 brackets, followed by a colon and a port number if the logging of ports is
11635 enabled. The format of the rest of the string depends on whether the host
11636 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11637 looking up its IP address. (Looking up the IP address can be forced by the
11638 &%host_lookup%& option, independent of verification.) A plain host name at the
11639 start of the string is a verified host name; if this is not present,
11640 verification either failed or was not requested. A host name in parentheses is
11641 the argument of a HELO or EHLO command. This is omitted if it is identical to
11642 the verified host name or to the host's IP address in square brackets.
11643
11644 .vitem &$sender_helo_name$&
11645 .vindex "&$sender_helo_name$&"
11646 When a message is received from a remote host that has issued a HELO or EHLO
11647 command, the argument of that command is placed in this variable. It is also
11648 set if HELO or EHLO is used when a message is received using SMTP locally via
11649 the &%-bs%& or &%-bS%& options.
11650
11651 .vitem &$sender_host_address$&
11652 .vindex "&$sender_host_address$&"
11653 When a message is received from a remote host, this variable contains that
11654 host's IP address. For locally submitted messages, it is empty.
11655
11656 .vitem &$sender_host_authenticated$&
11657 .vindex "&$sender_host_authenticated$&"
11658 This variable contains the name (not the public name) of the authenticator
11659 driver that successfully authenticated the client from which the message was
11660 received. It is empty if there was no successful authentication. See also
11661 &$authenticated_id$&.
11662
11663 .vitem &$sender_host_name$&
11664 .vindex "&$sender_host_name$&"
11665 When a message is received from a remote host, this variable contains the
11666 host's name as obtained by looking up its IP address. For messages received by
11667 other means, this variable is empty.
11668
11669 .vindex "&$host_lookup_failed$&"
11670 If the host name has not previously been looked up, a reference to
11671 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11672 A looked up name is accepted only if it leads back to the original IP address
11673 via a forward lookup. If either the reverse or the forward lookup fails to find
11674 any data, or if the forward lookup does not yield the original IP address,
11675 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11676
11677 .vindex "&$host_lookup_deferred$&"
11678 However, if either of the lookups cannot be completed (for example, there is a
11679 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11680 &$host_lookup_failed$& remains set to &"0"&.
11681
11682 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11683 host name again if there is a subsequent reference to &$sender_host_name$&
11684 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11685 is set to &"1"&.
11686
11687 Exim does not automatically look up every calling host's name. If you want
11688 maximum efficiency, you should arrange your configuration so that it avoids
11689 these lookups altogether. The lookup happens only if one or more of the
11690 following are true:
11691
11692 .ilist
11693 A string containing &$sender_host_name$& is expanded.
11694 .next
11695 The calling host matches the list in &%host_lookup%&. In the default
11696 configuration, this option is set to *, so it must be changed if lookups are
11697 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11698 .next
11699 Exim needs the host name in order to test an item in a host list. The items
11700 that require this are described in sections &<<SECThoslispatnam>>& and
11701 &<<SECThoslispatnamsk>>&.
11702 .next
11703 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11704 In this case, the host name is required to compare with the name quoted in any
11705 EHLO or HELO commands that the client issues.
11706 .next
11707 The remote host issues a EHLO or HELO command that quotes one of the
11708 domains in &%helo_lookup_domains%&. The default value of this option is
11709 . ==== As this is a nested list, any displays it contains must be indented
11710 . ==== as otherwise they are too far to the left.
11711 .code
11712   helo_lookup_domains = @ : @[]
11713 .endd
11714 which causes a lookup if a remote host (incorrectly) gives the server's name or
11715 IP address in an EHLO or HELO command.
11716 .endlist
11717
11718
11719 .vitem &$sender_host_port$&
11720 .vindex "&$sender_host_port$&"
11721 When a message is received from a remote host, this variable contains the port
11722 number that was used on the remote host.
11723
11724 .vitem &$sender_ident$&
11725 .vindex "&$sender_ident$&"
11726 When a message is received from a remote host, this variable contains the
11727 identification received in response to an RFC 1413 request. When a message has
11728 been received locally, this variable contains the login name of the user that
11729 called Exim.
11730
11731 .vitem &$sender_rate_$&&'xxx'&
11732 A number of variables whose names begin &$sender_rate_$& are set as part of the
11733 &%ratelimit%& ACL condition. Details are given in section
11734 &<<SECTratelimiting>>&.
11735
11736 .vitem &$sender_rcvhost$&
11737 .cindex "DNS" "reverse lookup"
11738 .cindex "reverse DNS lookup"
11739 .vindex "&$sender_rcvhost$&"
11740 This is provided specifically for use in &'Received:'& headers. It starts with
11741 either the verified host name (as obtained from a reverse DNS lookup) or, if
11742 there is no verified host name, the IP address in square brackets. After that
11743 there may be text in parentheses. When the first item is a verified host name,
11744 the first thing in the parentheses is the IP address in square brackets,
11745 followed by a colon and a port number if port logging is enabled. When the
11746 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11747 the parentheses.
11748
11749 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11750 was used and its argument was not identical to the real host name or IP
11751 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11752 all three items are present in the parentheses, a newline and tab are inserted
11753 into the string, to improve the formatting of the &'Received:'& header.
11754
11755 .vitem &$sender_verify_failure$&
11756 .vindex "&$sender_verify_failure$&"
11757 In an ACL, when a sender verification fails, this variable contains information
11758 about the failure. The details are the same as for
11759 &$recipient_verify_failure$&.
11760
11761 .vitem &$sending_ip_address$&
11762 .vindex "&$sending_ip_address$&"
11763 This variable is set whenever an outgoing SMTP connection to another host has
11764 been set up. It contains the IP address of the local interface that is being
11765 used. This is useful if a host that has more than one IP address wants to take
11766 on different personalities depending on which one is being used. For incoming
11767 connections, see &$received_ip_address$&.
11768
11769 .vitem &$sending_port$&
11770 .vindex "&$sending_port$&"
11771 This variable is set whenever an outgoing SMTP connection to another host has
11772 been set up. It contains the local port that is being used. For incoming
11773 connections, see &$received_port$&.
11774
11775 .vitem &$smtp_active_hostname$&
11776 .vindex "&$smtp_active_hostname$&"
11777 During an incoming SMTP session, this variable contains the value of the active
11778 host name, as specified by the &%smtp_active_hostname%& option. The value of
11779 &$smtp_active_hostname$& is saved with any message that is received, so its
11780 value can be consulted during routing and delivery.
11781
11782 .vitem &$smtp_command$&
11783 .vindex "&$smtp_command$&"
11784 During the processing of an incoming SMTP command, this variable contains the
11785 entire command. This makes it possible to distinguish between HELO and EHLO in
11786 the HELO ACL, and also to distinguish between commands such as these:
11787 .code
11788 MAIL FROM:<>
11789 MAIL FROM: <>
11790 .endd
11791 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11792 command, the address in &$smtp_command$& is the original address before any
11793 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11794 the address after SMTP-time rewriting.
11795
11796 .vitem &$smtp_command_argument$&
11797 .cindex "SMTP" "command, argument for"
11798 .vindex "&$smtp_command_argument$&"
11799 While an ACL is running to check an SMTP command, this variable contains the
11800 argument, that is, the text that follows the command name, with leading white
11801 space removed. Following the introduction of &$smtp_command$&, this variable is
11802 somewhat redundant, but is retained for backwards compatibility.
11803
11804 .vitem &$smtp_count_at_connection_start$&
11805 .vindex "&$smtp_count_at_connection_start$&"
11806 This variable is set greater than zero only in processes spawned by the Exim
11807 daemon for handling incoming SMTP connections. The name is deliberately long,
11808 in order to emphasize what the contents are. When the daemon accepts a new
11809 connection, it increments this variable. A copy of the variable is passed to
11810 the child process that handles the connection, but its value is fixed, and
11811 never changes. It is only an approximation of how many incoming connections
11812 there actually are, because many other connections may come and go while a
11813 single connection is being processed. When a child process terminates, the
11814 daemon decrements its copy of the variable.
11815
11816 .vitem "&$sn0$& &-- &$sn9$&"
11817 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11818 that were current at the end of the system filter file. This allows a system
11819 filter file to set values that can be tested in users' filter files. For
11820 example, a system filter could set a value indicating how likely it is that a
11821 message is junk mail.
11822
11823 .vitem &$spam_$&&'xxx'&
11824 A number of variables whose names start with &$spam$& are available when Exim
11825 is compiled with the content-scanning extension. For details, see section
11826 &<<SECTscanspamass>>&.
11827
11828
11829 .vitem &$spool_directory$&
11830 .vindex "&$spool_directory$&"
11831 The name of Exim's spool directory.
11832
11833 .vitem &$spool_inodes$&
11834 .vindex "&$spool_inodes$&"
11835 The number of free inodes in the disk partition where Exim's spool files are
11836 being written. The value is recalculated whenever the variable is referenced.
11837 If the relevant file system does not have the concept of inodes, the value of
11838 is -1. See also the &%check_spool_inodes%& option.
11839
11840 .vitem &$spool_space$&
11841 .vindex "&$spool_space$&"
11842 The amount of free space (as a number of kilobytes) in the disk partition where
11843 Exim's spool files are being written. The value is recalculated whenever the
11844 variable is referenced. If the operating system does not have the ability to
11845 find the amount of free space (only true for experimental systems), the space
11846 value is -1. For example, to check in an ACL that there is at least 50
11847 megabytes free on the spool, you could write:
11848 .code
11849 condition = ${if > {$spool_space}{50000}}
11850 .endd
11851 See also the &%check_spool_space%& option.
11852
11853
11854 .vitem &$thisaddress$&
11855 .vindex "&$thisaddress$&"
11856 This variable is set only during the processing of the &%foranyaddress%&
11857 command in a filter file. Its use is explained in the description of that
11858 command, which can be found in the separate document entitled &'Exim's
11859 interfaces to mail filtering'&.
11860
11861 .vitem &$tls_bits$&
11862 .vindex "&$tls_bits$&"
11863 Contains an approximation of the TLS cipher's bit-strength; the meaning of
11864 this depends upon the TLS implementation used.
11865 If TLS has not been negotiated, the value will be 0.
11866 The value of this is automatically fed into the Cyrus SASL authenticator
11867 when acting as a server, to specify the "external SSF" (a SASL term).
11868
11869 .vitem &$tls_certificate_verified$&
11870 .vindex "&$tls_certificate_verified$&"
11871 This variable is set to &"1"& if a TLS certificate was verified when the
11872 message was received, and &"0"& otherwise.
11873
11874 .vitem &$tls_cipher$&
11875 .vindex "&$tls_cipher$&"
11876 When a message is received from a remote host over an encrypted SMTP
11877 connection, this variable is set to the cipher suite that was negotiated, for
11878 example DES-CBC3-SHA. In other circumstances, in particular, for message
11879 received over unencrypted connections, the variable is empty. Testing
11880 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11881 non-encrypted connections during ACL processing.
11882
11883 The &$tls_cipher$& variable retains its value during message delivery, except
11884 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11885 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11886 and then set to the outgoing cipher suite if one is negotiated. See chapter
11887 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11888 details of the &(smtp)& transport.
11889
11890 .vitem &$tls_peerdn$&
11891 .vindex "&$tls_peerdn$&"
11892 When a message is received from a remote host over an encrypted SMTP
11893 connection, and Exim is configured to request a certificate from the client,
11894 the value of the Distinguished Name of the certificate is made available in the
11895 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11896 value is retained during message delivery, except during outbound SMTP
11897 deliveries.
11898
11899 .vitem &$tls_sni$&
11900 .vindex "&$tls_sni$&"
11901 .cindex "TLS" "Server Name Indication"
11902 When a TLS session is being established, if the client sends the Server
11903 Name Indication extension, the value will be placed in this variable.
11904 If the variable appears in &%tls_certificate%& then this option and
11905 some others, described in &<<SECTtlssni>>&,
11906 will be re-expanded early in the TLS session, to permit
11907 a different certificate to be presented (and optionally a different key to be
11908 used) to the client, based upon the value of the SNI extension.
11909
11910 The value will be retained for the lifetime of the message.  During outbound
11911 SMTP deliveries, it reflects the value of the &%tls_sni%& option on
11912 the transport.
11913
11914 .vitem &$tod_bsdinbox$&
11915 .vindex "&$tod_bsdinbox$&"
11916 The time of day and the date, in the format required for BSD-style mailbox
11917 files, for example: Thu Oct 17 17:14:09 1995.
11918
11919 .vitem &$tod_epoch$&
11920 .vindex "&$tod_epoch$&"
11921 The time and date as a number of seconds since the start of the Unix epoch.
11922
11923 .vitem &$tod_epoch_l$&
11924 .vindex "&$tod_epoch_l$&"
11925 The time and date as a number of microseconds since the start of the Unix epoch.
11926
11927 .vitem &$tod_full$&
11928 .vindex "&$tod_full$&"
11929 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11930 +0100. The timezone is always given as a numerical offset from UTC, with
11931 positive values used for timezones that are ahead (east) of UTC, and negative
11932 values for those that are behind (west).
11933
11934 .vitem &$tod_log$&
11935 .vindex "&$tod_log$&"
11936 The time and date in the format used for writing Exim's log files, for example:
11937 1995-10-12 15:32:29, but without a timezone.
11938
11939 .vitem &$tod_logfile$&
11940 .vindex "&$tod_logfile$&"
11941 This variable contains the date in the format yyyymmdd. This is the format that
11942 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11943 flag.
11944
11945 .vitem &$tod_zone$&
11946 .vindex "&$tod_zone$&"
11947 This variable contains the numerical value of the local timezone, for example:
11948 -0500.
11949
11950 .vitem &$tod_zulu$&
11951 .vindex "&$tod_zulu$&"
11952 This variable contains the UTC date and time in &"Zulu"& format, as specified
11953 by ISO 8601, for example: 20030221154023Z.
11954
11955 .vitem &$value$&
11956 .vindex "&$value$&"
11957 This variable contains the result of an expansion lookup, extraction operation,
11958 or external command, as described above. It is also used during a
11959 &*reduce*& expansion.
11960
11961 .vitem &$version_number$&
11962 .vindex "&$version_number$&"
11963 The version number of Exim.
11964
11965 .vitem &$warn_message_delay$&
11966 .vindex "&$warn_message_delay$&"
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
11970 .vitem &$warn_message_recipients$&
11971 .vindex "&$warn_message_recipients$&"
11972 This variable is set only during the creation of a message warning about a
11973 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11974 .endlist
11975 .ecindex IIDstrexp
11976
11977
11978
11979 . ////////////////////////////////////////////////////////////////////////////
11980 . ////////////////////////////////////////////////////////////////////////////
11981
11982 .chapter "Embedded Perl" "CHAPperl"
11983 .scindex IIDperl "Perl" "calling from Exim"
11984 Exim can be built to include an embedded Perl interpreter. When this is done,
11985 Perl subroutines can be called as part of the string expansion process. To make
11986 use of the Perl support, you need version 5.004 or later of Perl installed on
11987 your system. To include the embedded interpreter in the Exim binary, include
11988 the line
11989 .code
11990 EXIM_PERL = perl.o
11991 .endd
11992 in your &_Local/Makefile_& and then build Exim in the normal way.
11993
11994
11995 .section "Setting up so Perl can be used" "SECID85"
11996 .oindex "&%perl_startup%&"
11997 Access to Perl subroutines is via a global configuration option called
11998 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
11999 no &%perl_startup%& option in the Exim configuration file then no Perl
12000 interpreter is started and there is almost no overhead for Exim (since none of
12001 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12002 option then the associated value is taken to be Perl code which is executed in
12003 a newly created Perl interpreter.
12004
12005 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12006 need backslashes before any characters to escape special meanings. The option
12007 should usually be something like
12008 .code
12009 perl_startup = do '/etc/exim.pl'
12010 .endd
12011 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12012 use from Exim. Exim can be configured either to start up a Perl interpreter as
12013 soon as it is entered, or to wait until the first time it is needed. Starting
12014 the interpreter at the beginning ensures that it is done while Exim still has
12015 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12016 fact used in a particular run. Also, note that this does not mean that Exim is
12017 necessarily running as root when Perl is called at a later time. By default,
12018 the interpreter is started only when it is needed, but this can be changed in
12019 two ways:
12020
12021 .ilist
12022 .oindex "&%perl_at_start%&"
12023 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12024 a startup when Exim is entered.
12025 .next
12026 The command line option &%-ps%& also requests a startup when Exim is entered,
12027 overriding the setting of &%perl_at_start%&.
12028 .endlist
12029
12030 There is also a command line option &%-pd%& (for delay) which suppresses the
12031 initial startup, even if &%perl_at_start%& is set.
12032
12033
12034 .section "Calling Perl subroutines" "SECID86"
12035 When the configuration file includes a &%perl_startup%& option you can make use
12036 of the string expansion item to call the Perl subroutines that are defined
12037 by the &%perl_startup%& code. The operator is used in any of the following
12038 forms:
12039 .code
12040 ${perl{foo}}
12041 ${perl{foo}{argument}}
12042 ${perl{foo}{argument1}{argument2} ... }
12043 .endd
12044 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12045 arguments may be passed. Passing more than this results in an expansion failure
12046 with an error message of the form
12047 .code
12048 Too many arguments passed to Perl subroutine "foo" (max is 8)
12049 .endd
12050 The return value of the Perl subroutine is evaluated in a scalar context before
12051 it is passed back to Exim to be inserted into the expanded string. If the
12052 return value is &'undef'&, the expansion is forced to fail in the same way as
12053 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12054 by obeying Perl's &%die%& function, the expansion fails with the error message
12055 that was passed to &%die%&.
12056
12057
12058 .section "Calling Exim functions from Perl" "SECID87"
12059 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12060 is available to call back into Exim's string expansion function. For example,
12061 the Perl code
12062 .code
12063 my $lp = Exim::expand_string('$local_part');
12064 .endd
12065 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12066 Note those are single quotes and not double quotes to protect against
12067 &$local_part$& being interpolated as a Perl variable.
12068
12069 If the string expansion is forced to fail by a &"fail"& item, the result of
12070 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12071 expansion string, the Perl call from the original expansion string fails with
12072 an appropriate error message, in the same way as if &%die%& were used.
12073
12074 .cindex "debugging" "from embedded Perl"
12075 .cindex "log" "writing from embedded Perl"
12076 Two other Exim functions are available for use from within Perl code.
12077 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12078 debugging is enabled. If you want a newline at the end, you must supply it.
12079 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12080 timestamp. In this case, you should not supply a terminating newline.
12081
12082
12083 .section "Use of standard output and error by Perl" "SECID88"
12084 .cindex "Perl" "standard output and error"
12085 You should not write to the standard error or output streams from within your
12086 Perl code, as it is not defined how these are set up. In versions of Exim
12087 before 4.50, it is possible for the standard output or error to refer to the
12088 SMTP connection during message reception via the daemon. Writing to this stream
12089 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12090 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12091 avoided, but the output is lost.
12092
12093 .cindex "Perl" "use of &%warn%&"
12094 The Perl &%warn%& statement writes to the standard error stream by default.
12095 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12096 you have no control. When Exim starts up the Perl interpreter, it arranges for
12097 output from the &%warn%& statement to be written to the Exim main log. You can
12098 change this by including appropriate Perl magic somewhere in your Perl code.
12099 For example, to discard &%warn%& output completely, you need this:
12100 .code
12101 $SIG{__WARN__} = sub { };
12102 .endd
12103 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12104 example, the code for the subroutine is empty, so it does nothing, but you can
12105 include any Perl code that you like. The text of the &%warn%& message is passed
12106 as the first subroutine argument.
12107 .ecindex IIDperl
12108
12109
12110 . ////////////////////////////////////////////////////////////////////////////
12111 . ////////////////////////////////////////////////////////////////////////////
12112
12113 .chapter "Starting the daemon and the use of network interfaces" &&&
12114          "CHAPinterfaces" &&&
12115          "Starting the daemon"
12116 .cindex "daemon" "starting"
12117 .cindex "interface" "listening"
12118 .cindex "network interface"
12119 .cindex "interface" "network"
12120 .cindex "IP address" "for listening"
12121 .cindex "daemon" "listening IP addresses"
12122 .cindex "TCP/IP" "setting listening interfaces"
12123 .cindex "TCP/IP" "setting listening ports"
12124 A host that is connected to a TCP/IP network may have one or more physical
12125 hardware network interfaces. Each of these interfaces may be configured as one
12126 or more &"logical"& interfaces, which are the entities that a program actually
12127 works with. Each of these logical interfaces is associated with an IP address.
12128 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12129 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12130 knowledge about the host's interfaces for use in three different circumstances:
12131
12132 .olist
12133 When a listening daemon is started, Exim needs to know which interfaces
12134 and ports to listen on.
12135 .next
12136 When Exim is routing an address, it needs to know which IP addresses
12137 are associated with local interfaces. This is required for the correct
12138 processing of MX lists by removing the local host and others with the
12139 same or higher priority values. Also, Exim needs to detect cases
12140 when an address is routed to an IP address that in fact belongs to the
12141 local host. Unless the &%self%& router option or the &%allow_localhost%&
12142 option of the smtp transport is set (as appropriate), this is treated
12143 as an error situation.
12144 .next
12145 When Exim connects to a remote host, it may need to know which interface to use
12146 for the outgoing connection.
12147 .endlist
12148
12149
12150 Exim's default behaviour is likely to be appropriate in the vast majority
12151 of cases. If your host has only one interface, and you want all its IP
12152 addresses to be treated in the same way, and you are using only the
12153 standard SMTP port, you should not need to take any special action. The
12154 rest of this chapter does not apply to you.
12155
12156 In a more complicated situation you may want to listen only on certain
12157 interfaces, or on different ports, and for this reason there are a number of
12158 options that can be used to influence Exim's behaviour. The rest of this
12159 chapter describes how they operate.
12160
12161 When a message is received over TCP/IP, the interface and port that were
12162 actually used are set in &$received_ip_address$& and &$received_port$&.
12163
12164
12165
12166 .section "Starting a listening daemon" "SECID89"
12167 When a listening daemon is started (by means of the &%-bd%& command line
12168 option), the interfaces and ports on which it listens are controlled by the
12169 following options:
12170
12171 .ilist
12172 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12173 compatibility, this option can also be specified in the singular.)
12174 .next
12175 &%local_interfaces%& contains list of interface IP addresses on which to
12176 listen. Each item may optionally also specify a port.
12177 .endlist
12178
12179 The default list separator in both cases is a colon, but this can be changed as
12180 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12181 it is usually best to change the separator to avoid having to double all the
12182 colons. For example:
12183 .code
12184 local_interfaces = <; 127.0.0.1 ; \
12185                       192.168.23.65 ; \
12186                       ::1 ; \
12187                       3ffe:ffff:836f::fe86:a061
12188 .endd
12189 There are two different formats for specifying a port along with an IP address
12190 in &%local_interfaces%&:
12191
12192 .olist
12193 The port is added onto the address with a dot separator. For example, to listen
12194 on port 1234 on two different IP addresses:
12195 .code
12196 local_interfaces = <; 192.168.23.65.1234 ; \
12197                       3ffe:ffff:836f::fe86:a061.1234
12198 .endd
12199 .next
12200 The IP address is enclosed in square brackets, and the port is added
12201 with a colon separator, for example:
12202 .code
12203 local_interfaces = <; [192.168.23.65]:1234 ; \
12204                       [3ffe:ffff:836f::fe86:a061]:1234
12205 .endd
12206 .endlist
12207
12208 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12209 default setting contains just one port:
12210 .code
12211 daemon_smtp_ports = smtp
12212 .endd
12213 If more than one port is listed, each interface that does not have its own port
12214 specified listens on all of them. Ports that are listed in
12215 &%daemon_smtp_ports%& can be identified either by name (defined in
12216 &_/etc/services_&) or by number. However, when ports are given with individual
12217 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12218
12219
12220
12221 .section "Special IP listening addresses" "SECID90"
12222 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12223 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12224 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12225 instead of setting up separate listening sockets for each interface. The
12226 default value of &%local_interfaces%& is
12227 .code
12228 local_interfaces = 0.0.0.0
12229 .endd
12230 when Exim is built without IPv6 support; otherwise it is:
12231 .code
12232 local_interfaces = <; ::0 ; 0.0.0.0
12233 .endd
12234 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12235
12236
12237
12238 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12239 The &%-oX%& command line option can be used to override the values of
12240 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12241 instance. Another way of doing this would be to use macros and the &%-D%&
12242 option. However, &%-oX%& can be used by any admin user, whereas modification of
12243 the runtime configuration by &%-D%& is allowed only when the caller is root or
12244 exim.
12245
12246 The value of &%-oX%& is a list of items. The default colon separator can be
12247 changed in the usual way if required. If there are any items that do not
12248 contain dots or colons (that is, are not IP addresses), the value of
12249 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12250 items that do contain dots or colons, the value of &%local_interfaces%& is
12251 replaced by those items. Thus, for example,
12252 .code
12253 -oX 1225
12254 .endd
12255 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12256 whereas
12257 .code
12258 -oX 192.168.34.5.1125
12259 .endd
12260 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12261 (However, since &%local_interfaces%& now contains no items without ports, the
12262 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12263
12264
12265
12266 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12267 .cindex "ssmtp protocol"
12268 .cindex "smtps protocol"
12269 .cindex "SMTP" "ssmtp protocol"
12270 .cindex "SMTP" "smtps protocol"
12271 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12272 before the STARTTLS command was standardized for SMTP. Some legacy clients
12273 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12274 list of port numbers, connections to those ports must use SSMTP. The most
12275 common use of this option is expected to be
12276 .code
12277 tls_on_connect_ports = 465
12278 .endd
12279 because 465 is the usual port number used by the legacy clients. There is also
12280 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12281 this way when a daemon is started.
12282
12283 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12284 daemon to listen on those ports. You must still specify them in
12285 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12286 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12287 connections via the daemon.)
12288
12289
12290
12291
12292 .section "IPv6 address scopes" "SECID92"
12293 .cindex "IPv6" "address scopes"
12294 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12295 can, in principle, have the same link-local IPv6 address on different
12296 interfaces. Thus, additional information is needed, over and above the IP
12297 address, to distinguish individual interfaces. A convention of using a
12298 percent sign followed by something (often the interface name) has been
12299 adopted in some cases, leading to addresses like this:
12300 .code
12301 fe80::202:b3ff:fe03:45c1%eth0
12302 .endd
12303 To accommodate this usage, a percent sign followed by an arbitrary string is
12304 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12305 to convert a textual IPv6 address for actual use. This function recognizes the
12306 percent convention in operating systems that support it, and it processes the
12307 address appropriately. Unfortunately, some older libraries have problems with
12308 &[getaddrinfo()]&. If
12309 .code
12310 IPV6_USE_INET_PTON=yes
12311 .endd
12312 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12313 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12314 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12315 function.) Of course, this means that the additional functionality of
12316 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12317
12318 .section "Disabling IPv6" "SECID93"
12319 .cindex "IPv6" "disabling"
12320 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12321 run on a host whose kernel does not support IPv6. The binary will fall back to
12322 using IPv4, but it may waste resources looking up AAAA records, and trying to
12323 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12324 .oindex "&%disable_ipv6%&"
12325 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12326 activities take place. AAAA records are never looked up, and any IPv6 addresses
12327 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12328 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12329 to handle IPv6 literal addresses.
12330
12331 On the other hand, when IPv6 is in use, there may be times when you want to
12332 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12333 option to globally suppress the lookup of AAAA records for specified domains,
12334 and you can use the &%ignore_target_hosts%& generic router option to ignore
12335 IPv6 addresses in an individual router.
12336
12337
12338
12339 .section "Examples of starting a listening daemon" "SECID94"
12340 The default case in an IPv6 environment is
12341 .code
12342 daemon_smtp_ports = smtp
12343 local_interfaces = <; ::0 ; 0.0.0.0
12344 .endd
12345 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12346 Either one or two sockets may be used, depending on the characteristics of
12347 the TCP/IP stack. (This is complicated and messy; for more information,
12348 read the comments in the &_daemon.c_& source file.)
12349
12350 To specify listening on ports 25 and 26 on all interfaces:
12351 .code
12352 daemon_smtp_ports = 25 : 26
12353 .endd
12354 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12355 .code
12356 local_interfaces = <; ::0.25     ; ::0.26 \
12357                       0.0.0.0.25 ; 0.0.0.0.26
12358 .endd
12359 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12360 IPv4 loopback address only:
12361 .code
12362 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12363 .endd
12364 To specify listening on the default port on specific interfaces only:
12365 .code
12366 local_interfaces = 192.168.34.67 : 192.168.34.67
12367 .endd
12368 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12369
12370
12371
12372 .section "Recognizing the local host" "SECTreclocipadd"
12373 The &%local_interfaces%& option is also used when Exim needs to determine
12374 whether or not an IP address refers to the local host. That is, the IP
12375 addresses of all the interfaces on which a daemon is listening are always
12376 treated as local.
12377
12378 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12379 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12380 available interfaces from the operating system, and extracts the relevant
12381 (that is, IPv4 or IPv6) addresses to use for checking.
12382
12383 Some systems set up large numbers of virtual interfaces in order to provide
12384 many virtual web servers. In this situation, you may want to listen for
12385 email on only a few of the available interfaces, but nevertheless treat all
12386 interfaces as local when routing. You can do this by setting
12387 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12388 &"all"& wildcard values. These addresses are recognized as local, but are not
12389 used for listening. Consider this example:
12390 .code
12391 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12392                       192.168.53.235 ; \
12393                       3ffe:2101:12:1:a00:20ff:fe86:a061
12394
12395 extra_local_interfaces = <; ::0 ; 0.0.0.0
12396 .endd
12397 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12398 address, but all available interface addresses are treated as local when
12399 Exim is routing.
12400
12401 In some environments the local host name may be in an MX list, but with an IP
12402 address that is not assigned to any local interface. In other cases it may be
12403 desirable to treat other host names as if they referred to the local host. Both
12404 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12405 This contains host names rather than IP addresses. When a host is referenced
12406 during routing, either via an MX record or directly, it is treated as the local
12407 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12408 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12409
12410
12411
12412 .section "Delivering to a remote host" "SECID95"
12413 Delivery to a remote host is handled by the smtp transport. By default, it
12414 allows the system's TCP/IP functions to choose which interface to use (if
12415 there is more than one) when connecting to a remote host. However, the
12416 &%interface%& option can be set to specify which interface is used. See the
12417 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12418 details.
12419
12420
12421
12422
12423 . ////////////////////////////////////////////////////////////////////////////
12424 . ////////////////////////////////////////////////////////////////////////////
12425
12426 .chapter "Main configuration" "CHAPmainconfig"
12427 .scindex IIDconfima "configuration file" "main section"
12428 .scindex IIDmaiconf "main configuration"
12429 The first part of the run time configuration file contains three types of item:
12430
12431 .ilist
12432 Macro definitions: These lines start with an upper case letter. See section
12433 &<<SECTmacrodefs>>& for details of macro processing.
12434 .next
12435 Named list definitions: These lines start with one of the words &"domainlist"&,
12436 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12437 section &<<SECTnamedlists>>&.
12438 .next
12439 Main configuration settings: Each setting occupies one line of the file
12440 (with possible continuations). If any setting is preceded by the word
12441 &"hide"&, the &%-bP%& command line option displays its value to admin users
12442 only. See section &<<SECTcos>>& for a description of the syntax of these option
12443 settings.
12444 .endlist
12445
12446 This chapter specifies all the main configuration options, along with their
12447 types and default values. For ease of finding a particular option, they appear
12448 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12449 are now so many options, they are first listed briefly in functional groups, as
12450 an aid to finding the name of the option you are looking for. Some options are
12451 listed in more than one group.
12452
12453 .section "Miscellaneous" "SECID96"
12454 .table2
12455 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12456 .row &%disable_ipv6%&                "do no IPv6 processing"
12457 .row &%keep_malformed%&              "for broken files &-- should not happen"
12458 .row &%localhost_number%&            "for unique message ids in clusters"
12459 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12460 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12461 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12462 .row &%print_topbitchars%&           "top-bit characters are printing"
12463 .row &%timezone%&                    "force time zone"
12464 .endtable
12465
12466
12467 .section "Exim parameters" "SECID97"
12468 .table2
12469 .row &%exim_group%&                  "override compiled-in value"
12470 .row &%exim_path%&                   "override compiled-in value"
12471 .row &%exim_user%&                   "override compiled-in value"
12472 .row &%primary_hostname%&            "default from &[uname()]&"
12473 .row &%split_spool_directory%&       "use multiple directories"
12474 .row &%spool_directory%&             "override compiled-in value"
12475 .endtable
12476
12477
12478
12479 .section "Privilege controls" "SECID98"
12480 .table2
12481 .row &%admin_groups%&                "groups that are Exim admin users"
12482 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12483 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12484 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12485 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12486 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12487 .row &%never_users%&                 "do not run deliveries as these"
12488 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12489 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12490 .row &%trusted_groups%&              "groups that are trusted"
12491 .row &%trusted_users%&               "users that are trusted"
12492 .endtable
12493
12494
12495
12496 .section "Logging" "SECID99"
12497 .table2
12498 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12499 .row &%log_file_path%&               "override compiled-in value"
12500 .row &%log_selector%&                "set/unset optional logging"
12501 .row &%log_timezone%&                "add timezone to log lines"
12502 .row &%message_logs%&                "create per-message logs"
12503 .row &%preserve_message_logs%&       "after message completion"
12504 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12505 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12506 .row &%syslog_facility%&             "set syslog &""facility""& field"
12507 .row &%syslog_processname%&          "set syslog &""ident""& field"
12508 .row &%syslog_timestamp%&            "timestamp syslog lines"
12509 .row &%write_rejectlog%&             "control use of message log"
12510 .endtable
12511
12512
12513
12514 .section "Frozen messages" "SECID100"
12515 .table2
12516 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12517 .row &%freeze_tell%&                 "send message when freezing"
12518 .row &%move_frozen_messages%&        "to another directory"
12519 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12520 .endtable
12521
12522
12523
12524 .section "Data lookups" "SECID101"
12525 .table2
12526 .row &%ibase_servers%&               "InterBase servers"
12527 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12528 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12529 .row &%ldap_cert_file%&              "client cert file for LDAP"
12530 .row &%ldap_cert_key%&               "client key file for LDAP"
12531 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12532 .row &%ldap_default_servers%&        "used if no server in query"
12533 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12534 .row &%ldap_start_tls%&              "require TLS within LDAP"
12535 .row &%ldap_version%&                "set protocol version"
12536 .row &%lookup_open_max%&             "lookup files held open"
12537 .row &%mysql_servers%&               "default MySQL servers"
12538 .row &%oracle_servers%&              "Oracle servers"
12539 .row &%pgsql_servers%&               "default PostgreSQL servers"
12540 .row &%sqlite_lock_timeout%&         "as it says"
12541 .endtable
12542
12543
12544
12545 .section "Message ids" "SECID102"
12546 .table2
12547 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12548 .row &%message_id_header_text%&      "ditto"
12549 .endtable
12550
12551
12552
12553 .section "Embedded Perl Startup" "SECID103"
12554 .table2
12555 .row &%perl_at_start%&               "always start the interpreter"
12556 .row &%perl_startup%&                "code to obey when starting Perl"
12557 .endtable
12558
12559
12560
12561 .section "Daemon" "SECID104"
12562 .table2
12563 .row &%daemon_smtp_ports%&           "default ports"
12564 .row &%daemon_startup_retries%&      "number of times to retry"
12565 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12566 .row &%extra_local_interfaces%&      "not necessarily listened on"
12567 .row &%local_interfaces%&            "on which to listen, with optional ports"
12568 .row &%pid_file_path%&               "override compiled-in value"
12569 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12570 .endtable
12571
12572
12573
12574 .section "Resource control" "SECID105"
12575 .table2
12576 .row &%check_log_inodes%&            "before accepting a message"
12577 .row &%check_log_space%&             "before accepting a message"
12578 .row &%check_spool_inodes%&          "before accepting a message"
12579 .row &%check_spool_space%&           "before accepting a message"
12580 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12581 .row &%queue_only_load%&             "queue incoming if load high"
12582 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12583 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12584 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12585 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12586 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12587 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12588 .row &%smtp_accept_max_per_connection%& "messages per connection"
12589 .row &%smtp_accept_max_per_host%&    "connections from one host"
12590 .row &%smtp_accept_queue%&           "queue mail if more connections"
12591 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12592                                            connection"
12593 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12594 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12595 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12596 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12597 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12598 .endtable
12599
12600
12601
12602 .section "Policy controls" "SECID106"
12603 .table2
12604 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12605 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12606 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12607 .row &%acl_smtp_auth%&               "ACL for AUTH"
12608 .row &%acl_smtp_connect%&            "ACL for connection"
12609 .row &%acl_smtp_data%&               "ACL for DATA"
12610 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12611 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12612 .row &%acl_smtp_expn%&               "ACL for EXPN"
12613 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12614 .row &%acl_smtp_mail%&               "ACL for MAIL"
12615 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12616 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12617 .row &%acl_smtp_predata%&            "ACL for start of data"
12618 .row &%acl_smtp_quit%&               "ACL for QUIT"
12619 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12620 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12621 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12622 .row &%av_scanner%&                  "specify virus scanner"
12623 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12624                                       words""&"
12625 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12626 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12627 .row &%header_maxsize%&              "total size of message header"
12628 .row &%header_line_maxsize%&         "individual header line limit"
12629 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12630 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12631 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12632 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12633 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12634 .row &%host_lookup%&                 "host name looked up for these hosts"
12635 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12636 .row &%host_reject_connection%&      "reject connection from these hosts"
12637 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12638 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12639 .row &%message_size_limit%&          "for all messages"
12640 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12641 .row &%spamd_address%&               "set interface to SpamAssassin"
12642 .row &%strict_acl_vars%&             "object to unset ACL variables"
12643 .endtable
12644
12645
12646
12647 .section "Callout cache" "SECID107"
12648 .table2
12649 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12650                                          item"
12651 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12652                                          item"
12653 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12654 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12655 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12656 .endtable
12657
12658
12659
12660 .section "TLS" "SECID108"
12661 .table2
12662 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12663 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12664 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12665 .row &%tls_certificate%&             "location of server certificate"
12666 .row &%tls_crl%&                     "certificate revocation list"
12667 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
12668 .row &%tls_dhparam%&                 "DH parameters for server"
12669 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12670 .row &%tls_privatekey%&              "location of server private key"
12671 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12672 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12673 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12674 .row &%tls_verify_certificates%&     "expected client certificates"
12675 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12676 .endtable
12677
12678
12679
12680 .section "Local user handling" "SECID109"
12681 .table2
12682 .row &%finduser_retries%&            "useful in NIS environments"
12683 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12684 .row &%gecos_pattern%&               "ditto"
12685 .row &%max_username_length%&         "for systems that truncate"
12686 .row &%unknown_login%&               "used when no login name found"
12687 .row &%unknown_username%&            "ditto"
12688 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12689 .row &%uucp_from_sender%&            "ditto"
12690 .endtable
12691
12692
12693
12694 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12695 .table2
12696 .row &%header_maxsize%&              "total size of message header"
12697 .row &%header_line_maxsize%&         "individual header line limit"
12698 .row &%message_size_limit%&          "applies to all messages"
12699 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12700 .row &%received_header_text%&        "expanded to make &'Received:'&"
12701 .row &%received_headers_max%&        "for mail loop detection"
12702 .row &%recipients_max%&              "limit per message"
12703 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12704 .endtable
12705
12706
12707
12708
12709 .section "Non-SMTP incoming messages" "SECID111"
12710 .table2
12711 .row &%receive_timeout%&             "for non-SMTP messages"
12712 .endtable
12713
12714
12715
12716
12717
12718 .section "Incoming SMTP messages" "SECID112"
12719 See also the &'Policy controls'& section above.
12720
12721 .table2
12722 .row &%host_lookup%&                 "host name looked up for these hosts"
12723 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12724 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12725 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12726 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12727 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12728 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12729 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12730 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12731 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12732 .row &%smtp_accept_max_per_connection%& "messages per connection"
12733 .row &%smtp_accept_max_per_host%&    "connections from one host"
12734 .row &%smtp_accept_queue%&           "queue mail if more connections"
12735 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12736                                            connection"
12737 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12738 .row &%smtp_active_hostname%&        "host name to use in messages"
12739 .row &%smtp_banner%&                 "text for welcome banner"
12740 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12741 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12742 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12743 .row &%smtp_etrn_command%&           "what to run for ETRN"
12744 .row &%smtp_etrn_serialize%&         "only one at once"
12745 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12746 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12747 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12748 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12749 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12750 .row &%smtp_receive_timeout%&        "per command or data line"
12751 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12752 .row &%smtp_return_error_details%&   "give detail on rejections"
12753 .endtable
12754
12755
12756
12757 .section "SMTP extensions" "SECID113"
12758 .table2
12759 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12760 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12761 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12762 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12763 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12764 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12765 .endtable
12766
12767
12768
12769 .section "Processing messages" "SECID114"
12770 .table2
12771 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12772 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12773 .row &%allow_utf8_domains%&          "in addresses"
12774 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12775                                       words""&"
12776 .row &%delivery_date_remove%&        "from incoming messages"
12777 .row &%envelope_to_remove%&          "from incoming messages"
12778 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12779 .row &%headers_charset%&             "default for translations"
12780 .row &%qualify_domain%&              "default for senders"
12781 .row &%qualify_recipient%&           "default for recipients"
12782 .row &%return_path_remove%&          "from incoming messages"
12783 .row &%strip_excess_angle_brackets%& "in addresses"
12784 .row &%strip_trailing_dot%&          "at end of addresses"
12785 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12786 .endtable
12787
12788
12789
12790 .section "System filter" "SECID115"
12791 .table2
12792 .row &%system_filter%&               "locate system filter"
12793 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12794                                             directory"
12795 .row &%system_filter_file_transport%& "transport for delivery to a file"
12796 .row &%system_filter_group%&         "group for filter running"
12797 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12798 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12799 .row &%system_filter_user%&          "user for filter running"
12800 .endtable
12801
12802
12803
12804 .section "Routing and delivery" "SECID116"
12805 .table2
12806 .row &%disable_ipv6%&                "do no IPv6 processing"
12807 .row &%dns_again_means_nonexist%&    "for broken domains"
12808 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12809 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12810 .row &%dns_retrans%&                 "parameter for resolver"
12811 .row &%dns_retry%&                   "parameter for resolver"
12812 .row &%dns_use_edns0%&               "parameter for resolver"
12813 .row &%hold_domains%&                "hold delivery for these domains"
12814 .row &%local_interfaces%&            "for routing checks"
12815 .row &%queue_domains%&               "no immediate delivery for these"
12816 .row &%queue_only%&                  "no immediate delivery at all"
12817 .row &%queue_only_file%&             "no immediate delivery if file exists"
12818 .row &%queue_only_load%&             "no immediate delivery if load is high"
12819 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12820 .row &%queue_only_override%&         "allow command line to override"
12821 .row &%queue_run_in_order%&          "order of arrival"
12822 .row &%queue_run_max%&               "of simultaneous queue runners"
12823 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12824 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12825 .row &%remote_sort_domains%&         "order of remote deliveries"
12826 .row &%retry_data_expire%&           "timeout for retry data"
12827 .row &%retry_interval_max%&          "safety net for retry rules"
12828 .endtable
12829
12830
12831
12832 .section "Bounce and warning messages" "SECID117"
12833 .table2
12834 .row &%bounce_message_file%&         "content of bounce"
12835 .row &%bounce_message_text%&         "content of bounce"
12836 .row &%bounce_return_body%&          "include body if returning message"
12837 .row &%bounce_return_message%&       "include original message in bounce"
12838 .row &%bounce_return_size_limit%&    "limit on returned message"
12839 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12840 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12841 .row &%errors_copy%&                 "copy bounce messages"
12842 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12843 .row &%delay_warning%&               "time schedule"
12844 .row &%delay_warning_condition%&     "condition for warning messages"
12845 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12846 .row &%smtp_return_error_details%&   "give detail on rejections"
12847 .row &%warn_message_file%&           "content of warning message"
12848 .endtable
12849
12850
12851
12852 .section "Alphabetical list of main options" "SECTalomo"
12853 Those options that undergo string expansion before use are marked with
12854 &dagger;.
12855
12856 .option accept_8bitmime main boolean true
12857 .cindex "8BITMIME"
12858 .cindex "8-bit characters"
12859 This option causes Exim to send 8BITMIME in its response to an SMTP
12860 EHLO command, and to accept the BODY= parameter on MAIL commands.
12861 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12862 takes no steps to do anything special with messages received by this route.
12863
12864 Historically Exim kept this option off by default, but the maintainers
12865 feel that in today's Internet, this causes more problems than it solves.
12866 It now defaults to true.
12867 A more detailed analysis of the issues is provided by Dan Bernstein:
12868 .display
12869 &url(http://cr.yp.to/smtp/8bitmime.html)
12870 .endd
12871
12872 .option acl_not_smtp main string&!! unset
12873 .cindex "&ACL;" "for non-SMTP messages"
12874 .cindex "non-SMTP messages" "ACLs for"
12875 This option defines the ACL that is run when a non-SMTP message has been
12876 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12877 further details.
12878
12879 .option acl_not_smtp_mime main string&!! unset
12880 This option defines the ACL that is run for individual MIME parts of non-SMTP
12881 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12882 SMTP messages.
12883
12884 .option acl_not_smtp_start main string&!! unset
12885 .cindex "&ACL;" "at start of non-SMTP message"
12886 .cindex "non-SMTP messages" "ACLs for"
12887 This option defines the ACL that is run before Exim starts reading a
12888 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12889
12890 .option acl_smtp_auth main string&!! unset
12891 .cindex "&ACL;" "setting up for SMTP commands"
12892 .cindex "AUTH" "ACL for"
12893 This option defines the ACL that is run when an SMTP AUTH command is
12894 received. See chapter &<<CHAPACL>>& for further details.
12895
12896 .option acl_smtp_connect main string&!! unset
12897 .cindex "&ACL;" "on SMTP connection"
12898 This option defines the ACL that is run when an SMTP connection is received.
12899 See chapter &<<CHAPACL>>& for further details.
12900
12901 .option acl_smtp_data main string&!! unset
12902 .cindex "DATA" "ACL for"
12903 This option defines the ACL that is run after an SMTP DATA command has been
12904 processed and the message itself has been received, but before the final
12905 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12906
12907 .option acl_smtp_etrn main string&!! unset
12908 .cindex "ETRN" "ACL for"
12909 This option defines the ACL that is run when an SMTP ETRN command is
12910 received. See chapter &<<CHAPACL>>& for further details.
12911
12912 .option acl_smtp_expn main string&!! unset
12913 .cindex "EXPN" "ACL for"
12914 This option defines the ACL that is run when an SMTP EXPN command is
12915 received. See chapter &<<CHAPACL>>& for further details.
12916
12917 .option acl_smtp_helo main string&!! unset
12918 .cindex "EHLO" "ACL for"
12919 .cindex "HELO" "ACL for"
12920 This option defines the ACL that is run when an SMTP EHLO or HELO
12921 command is received. See chapter &<<CHAPACL>>& for further details.
12922
12923
12924 .option acl_smtp_mail main string&!! unset
12925 .cindex "MAIL" "ACL for"
12926 This option defines the ACL that is run when an SMTP MAIL command is
12927 received. See chapter &<<CHAPACL>>& for further details.
12928
12929 .option acl_smtp_mailauth main string&!! unset
12930 .cindex "AUTH" "on MAIL command"
12931 This option defines the ACL that is run when there is an AUTH parameter on
12932 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12933 &<<CHAPSMTPAUTH>>& for details of authentication.
12934
12935 .option acl_smtp_mime main string&!! unset
12936 .cindex "MIME content scanning" "ACL for"
12937 This option is available when Exim is built with the content-scanning
12938 extension. It defines the ACL that is run for each MIME part in a message. See
12939 section &<<SECTscanmimepart>>& for details.
12940
12941 .option acl_smtp_predata main string&!! unset
12942 This option defines the ACL that is run when an SMTP DATA command is
12943 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12944 further details.
12945
12946 .option acl_smtp_quit main string&!! unset
12947 .cindex "QUIT, ACL for"
12948 This option defines the ACL that is run when an SMTP QUIT command is
12949 received. See chapter &<<CHAPACL>>& for further details.
12950
12951 .option acl_smtp_rcpt main string&!! unset
12952 .cindex "RCPT" "ACL for"
12953 This option defines the ACL that is run when an SMTP RCPT command is
12954 received. See chapter &<<CHAPACL>>& for further details.
12955
12956 .option acl_smtp_starttls main string&!! unset
12957 .cindex "STARTTLS, ACL for"
12958 This option defines the ACL that is run when an SMTP STARTTLS command is
12959 received. See chapter &<<CHAPACL>>& for further details.
12960
12961 .option acl_smtp_vrfy main string&!! unset
12962 .cindex "VRFY" "ACL for"
12963 This option defines the ACL that is run when an SMTP VRFY command is
12964 received. See chapter &<<CHAPACL>>& for further details.
12965
12966 .option admin_groups main "string list&!!" unset
12967 .cindex "admin user"
12968 This option is expanded just once, at the start of Exim's processing. If the
12969 current group or any of the supplementary groups of an Exim caller is in this
12970 colon-separated list, the caller has admin privileges. If all your system
12971 programmers are in a specific group, for example, you can give them all Exim
12972 admin privileges by putting that group in &%admin_groups%&. However, this does
12973 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12974 To permit this, you have to add individuals to the Exim group.
12975
12976 .option allow_domain_literals main boolean false
12977 .cindex "domain literal"
12978 If this option is set, the RFC 2822 domain literal format is permitted in
12979 email addresses. The option is not set by default, because the domain literal
12980 format is not normally required these days, and few people know about it. It
12981 has, however, been exploited by mail abusers.
12982
12983 Unfortunately, it seems that some DNS black list maintainers are using this
12984 format to report black listing to postmasters. If you want to accept messages
12985 addressed to your hosts by IP address, you need to set
12986 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
12987 domains (defined in the named domain list &%local_domains%& in the default
12988 configuration). This &"magic string"& matches the domain literal form of all
12989 the local host's IP addresses.
12990
12991
12992 .option allow_mx_to_ip main boolean false
12993 .cindex "MX record" "pointing to IP address"
12994 It appears that more and more DNS zone administrators are breaking the rules
12995 and putting domain names that look like IP addresses on the right hand side of
12996 MX records. Exim follows the rules and rejects this, giving an error message
12997 that explains the mis-configuration. However, some other MTAs support this
12998 practice, so to avoid &"Why can't Exim do this?"& complaints,
12999 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13000 recommended, except when you have no other choice.
13001
13002 .option allow_utf8_domains main boolean false
13003 .cindex "domain" "UTF-8 characters in"
13004 .cindex "UTF-8" "in domain name"
13005 Lots of discussion is going on about internationalized domain names. One
13006 camp is strongly in favour of just using UTF-8 characters, and it seems
13007 that at least two other MTAs permit this. This option allows Exim users to
13008 experiment if they wish.
13009
13010 If it is set true, Exim's domain parsing function allows valid
13011 UTF-8 multicharacters to appear in domain name components, in addition to
13012 letters, digits, and hyphens. However, just setting this option is not
13013 enough; if you want to look up these domain names in the DNS, you must also
13014 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13015 suitable setting is:
13016 .code
13017 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13018   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13019 .endd
13020 Alternatively, you can just disable this feature by setting
13021 .code
13022 dns_check_names_pattern =
13023 .endd
13024 That is, set the option to an empty string so that no check is done.
13025
13026
13027 .option auth_advertise_hosts main "host list&!!" *
13028 .cindex "authentication" "advertising"
13029 .cindex "AUTH" "advertising"
13030 If any server authentication mechanisms are configured, Exim advertises them in
13031 response to an EHLO command only if the calling host matches this list.
13032 Otherwise, Exim does not advertise AUTH.
13033 Exim does not accept AUTH commands from clients to which it has not
13034 advertised the availability of AUTH. The advertising of individual
13035 authentication mechanisms can be controlled by the use of the
13036 &%server_advertise_condition%& generic authenticator option on the individual
13037 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13038
13039 Certain mail clients (for example, Netscape) require the user to provide a name
13040 and password for authentication if AUTH is advertised, even though it may
13041 not be needed (the host may accept messages from hosts on its local LAN without
13042 authentication, for example). The &%auth_advertise_hosts%& option can be used
13043 to make these clients more friendly by excluding them from the set of hosts to
13044 which Exim advertises AUTH.
13045
13046 .cindex "AUTH" "advertising when encrypted"
13047 If you want to advertise the availability of AUTH only when the connection
13048 is encrypted using TLS, you can make use of the fact that the value of this
13049 option is expanded, with a setting like this:
13050 .code
13051 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
13052 .endd
13053 .vindex "&$tls_cipher$&"
13054 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
13055 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13056 expansion is *, which matches all hosts.
13057
13058
13059 .option auto_thaw main time 0s
13060 .cindex "thawing messages"
13061 .cindex "unfreezing messages"
13062 If this option is set to a time greater than zero, a queue runner will try a
13063 new delivery attempt on any frozen message, other than a bounce message, if
13064 this much time has passed since it was frozen. This may result in the message
13065 being re-frozen if nothing has changed since the last attempt. It is a way of
13066 saying &"keep on trying, even though there are big problems"&.
13067
13068 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13069 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13070 thought to be very useful any more, and its use should probably be avoided.
13071
13072
13073 .option av_scanner main string "see below"
13074 This option is available if Exim is built with the content-scanning extension.
13075 It specifies which anti-virus scanner to use. The default value is:
13076 .code
13077 sophie:/var/run/sophie
13078 .endd
13079 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13080 before use. See section &<<SECTscanvirus>>& for further details.
13081
13082
13083 .option bi_command main string unset
13084 .oindex "&%-bi%&"
13085 This option supplies the name of a command that is run when Exim is called with
13086 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13087 just the command name, it is not a complete command line. If an argument is
13088 required, it must come from the &%-oA%& command line option.
13089
13090
13091 .option bounce_message_file main string unset
13092 .cindex "bounce message" "customizing"
13093 .cindex "customizing" "bounce message"
13094 This option defines a template file containing paragraphs of text to be used
13095 for constructing bounce messages.  Details of the file's contents are given in
13096 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13097
13098
13099 .option bounce_message_text main string unset
13100 When this option is set, its contents are included in the default bounce
13101 message immediately after &"This message was created automatically by mail
13102 delivery software."& It is not used if &%bounce_message_file%& is set.
13103
13104 .option bounce_return_body main boolean true
13105 .cindex "bounce message" "including body"
13106 This option controls whether the body of an incoming message is included in a
13107 bounce message when &%bounce_return_message%& is true. The default setting
13108 causes the entire message, both header and body, to be returned (subject to the
13109 value of &%bounce_return_size_limit%&). If this option is false, only the
13110 message header is included. In the case of a non-SMTP message containing an
13111 error that is detected during reception, only those header lines preceding the
13112 point at which the error was detected are returned.
13113 .cindex "bounce message" "including original"
13114
13115 .option bounce_return_message main boolean true
13116 If this option is set false, none of the original message is included in
13117 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13118 &%bounce_return_body%&.
13119
13120
13121 .option bounce_return_size_limit main integer 100K
13122 .cindex "size" "of bounce, limit"
13123 .cindex "bounce message" "size limit"
13124 .cindex "limit" "bounce message size"
13125 This option sets a limit in bytes on the size of messages that are returned to
13126 senders as part of bounce messages when &%bounce_return_message%& is true. The
13127 limit should be less than the value of the global &%message_size_limit%& and of
13128 any &%message_size_limit%& settings on transports, to allow for the bounce text
13129 that Exim generates. If this option is set to zero there is no limit.
13130
13131 When the body of any message that is to be included in a bounce message is
13132 greater than the limit, it is truncated, and a comment pointing this out is
13133 added at the top. The actual cutoff may be greater than the value given, owing
13134 to the use of buffering for transferring the message in chunks (typically 8K in
13135 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13136 messages.
13137
13138 .option bounce_sender_authentication main string unset
13139 .cindex "bounce message" "sender authentication"
13140 .cindex "authentication" "bounce message"
13141 .cindex "AUTH" "on bounce message"
13142 This option provides an authenticated sender address that is sent with any
13143 bounce messages generated by Exim that are sent over an authenticated SMTP
13144 connection. A typical setting might be:
13145 .code
13146 bounce_sender_authentication = mailer-daemon@my.domain.example
13147 .endd
13148 which would cause bounce messages to be sent using the SMTP command:
13149 .code
13150 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13151 .endd
13152 The value of &%bounce_sender_authentication%& must always be a complete email
13153 address.
13154
13155 .option callout_domain_negative_expire main time 3h
13156 .cindex "caching" "callout timeouts"
13157 .cindex "callout" "caching timeouts"
13158 This option specifies the expiry time for negative callout cache data for a
13159 domain. See section &<<SECTcallver>>& for details of callout verification, and
13160 section &<<SECTcallvercache>>& for details of the caching.
13161
13162
13163 .option callout_domain_positive_expire main time 7d
13164 This option specifies the expiry time for positive callout cache data for a
13165 domain. See section &<<SECTcallver>>& for details of callout verification, and
13166 section &<<SECTcallvercache>>& for details of the caching.
13167
13168
13169 .option callout_negative_expire main time 2h
13170 This option specifies the expiry time for negative callout cache data for an
13171 address. See section &<<SECTcallver>>& for details of callout verification, and
13172 section &<<SECTcallvercache>>& for details of the caching.
13173
13174
13175 .option callout_positive_expire main time 24h
13176 This option specifies the expiry time for positive callout cache data for an
13177 address. See section &<<SECTcallver>>& for details of callout verification, and
13178 section &<<SECTcallvercache>>& for details of the caching.
13179
13180
13181 .option callout_random_local_part main string&!! "see below"
13182 This option defines the &"random"& local part that can be used as part of
13183 callout verification. The default value is
13184 .code
13185 $primary_hostname-$tod_epoch-testing
13186 .endd
13187 See section &<<CALLaddparcall>>& for details of how this value is used.
13188
13189
13190 .option check_log_inodes main integer 0
13191 See &%check_spool_space%& below.
13192
13193
13194 .option check_log_space main integer 0
13195 See &%check_spool_space%& below.
13196
13197 .oindex "&%check_rfc2047_length%&"
13198 .cindex "RFC 2047" "disabling length check"
13199 .option check_rfc2047_length main boolean true
13200 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13201 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13202 word; strings to be encoded that exceed this length are supposed to use
13203 multiple encoded words. By default, Exim does not recognize encoded words that
13204 exceed the maximum length. However, it seems that some software, in violation
13205 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13206 set false, Exim recognizes encoded words of any length.
13207
13208
13209 .option check_spool_inodes main integer 0
13210 See &%check_spool_space%& below.
13211
13212
13213 .option check_spool_space main integer 0
13214 .cindex "checking disk space"
13215 .cindex "disk space, checking"
13216 .cindex "spool directory" "checking space"
13217 The four &%check_...%& options allow for checking of disk resources before a
13218 message is accepted.
13219
13220 .vindex "&$log_inodes$&"
13221 .vindex "&$log_space$&"
13222 .vindex "&$spool_inodes$&"
13223 .vindex "&$spool_space$&"
13224 When any of these options are set, they apply to all incoming messages. If you
13225 want to apply different checks to different kinds of message, you can do so by
13226 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13227 &$spool_space$& in an ACL with appropriate additional conditions.
13228
13229
13230 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13231 either value is greater than zero, for example:
13232 .code
13233 check_spool_space = 10M
13234 check_spool_inodes = 100
13235 .endd
13236 The spool partition is the one that contains the directory defined by
13237 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13238 transit.
13239
13240 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13241 files are written if either is greater than zero. These should be set only if
13242 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13243
13244 If there is less space or fewer inodes than requested, Exim refuses to accept
13245 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13246 error response to the MAIL command. If ESMTP is in use and there was a
13247 SIZE parameter on the MAIL command, its value is added to the
13248 &%check_spool_space%& value, and the check is performed even if
13249 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13250
13251 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13252 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13253
13254 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13255 failure a message is written to stderr and Exim exits with a non-zero code, as
13256 it obviously cannot send an error message of any kind.
13257
13258 .option daemon_smtp_ports main string &`smtp`&
13259 .cindex "port" "for daemon"
13260 .cindex "TCP/IP" "setting listening ports"
13261 This option specifies one or more default SMTP ports on which the Exim daemon
13262 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13263 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13264
13265 .option daemon_startup_retries main integer 9
13266 .cindex "daemon startup, retrying"
13267 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13268 the daemon at startup when it cannot immediately bind a listening socket
13269 (typically because the socket is already in use): &%daemon_startup_retries%&
13270 defines the number of retries after the first failure, and
13271 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13272
13273 .option daemon_startup_sleep main time 30s
13274 See &%daemon_startup_retries%&.
13275
13276 .option delay_warning main "time list" 24h
13277 .cindex "warning of delay"
13278 .cindex "delay warning, specifying"
13279 When a message is delayed, Exim sends a warning message to the sender at
13280 intervals specified by this option. The data is a colon-separated list of times
13281 after which to send warning messages. If the value of the option is an empty
13282 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13283 message has been on the queue for longer than the last time, the last interval
13284 between the times is used to compute subsequent warning times. For example,
13285 with
13286 .code
13287 delay_warning = 4h:8h:24h
13288 .endd
13289 the first message is sent after 4 hours, the second after 8 hours, and
13290 the third one after 24 hours. After that, messages are sent every 16 hours,
13291 because that is the interval between the last two times on the list. If you set
13292 just one time, it specifies the repeat interval. For example, with:
13293 .code
13294 delay_warning = 6h
13295 .endd
13296 messages are repeated every six hours. To stop warnings after a given time, set
13297 a very large time at the end of the list. For example:
13298 .code
13299 delay_warning = 2h:12h:99d
13300 .endd
13301
13302 .option delay_warning_condition main string&!! "see below"
13303 .vindex "&$domain$&"
13304 The string is expanded at the time a warning message might be sent. If all the
13305 deferred addresses have the same domain, it is set in &$domain$& during the
13306 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13307 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13308 &"false"& (the comparison being done caselessly) then the warning message is
13309 not sent. The default is:
13310 .code
13311 delay_warning_condition = ${if or {\
13312   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13313   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13314   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13315   } {no}{yes}}
13316 .endd
13317 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13318 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13319 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13320 &"auto-replied"& in an &'Auto-Submitted:'& header.
13321
13322 .option deliver_drop_privilege main boolean false
13323 .cindex "unprivileged delivery"
13324 .cindex "delivery" "unprivileged"
13325 If this option is set true, Exim drops its root privilege at the start of a
13326 delivery process, and runs as the Exim user throughout. This severely restricts
13327 the kinds of local delivery that are possible, but is viable in certain types
13328 of configuration. There is a discussion about the use of root privilege in
13329 chapter &<<CHAPsecurity>>&.
13330
13331 .option deliver_queue_load_max main fixed-point unset
13332 .cindex "load average"
13333 .cindex "queue runner" "abandoning"
13334 When this option is set, a queue run is abandoned if the system load average
13335 becomes greater than the value of the option. The option has no effect on
13336 ancient operating systems on which Exim cannot determine the load average.
13337 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13338
13339
13340 .option delivery_date_remove main boolean true
13341 .cindex "&'Delivery-date:'& header line"
13342 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13343 message when it is delivered, in exactly the same way as &'Return-path:'& is
13344 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13345 should not be present in incoming messages, and this option causes them to be
13346 removed at the time the message is received, to avoid any problems that might
13347 occur when a delivered message is subsequently sent on to some other recipient.
13348
13349 .option disable_fsync main boolean false
13350 .cindex "&[fsync()]&, disabling"
13351 This option is available only if Exim was built with the compile-time option
13352 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13353 a runtime configuration generates an &"unknown option"& error. You should not
13354 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13355 really, really, really understand what you are doing. &'No pre-compiled
13356 distributions of Exim should ever make this option available.'&
13357
13358 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13359 updated files' data to be written to disc before continuing. Unexpected events
13360 such as crashes and power outages may cause data to be lost or scrambled.
13361 Here be Dragons. &*Beware.*&
13362
13363
13364 .option disable_ipv6 main boolean false
13365 .cindex "IPv6" "disabling"
13366 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13367 activities take place. AAAA records are never looked up, and any IPv6 addresses
13368 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13369 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13370 to handle IPv6 literal addresses.
13371
13372
13373 .option dns_again_means_nonexist main "domain list&!!" unset
13374 .cindex "DNS" "&""try again""& response; overriding"
13375 DNS lookups give a &"try again"& response for the DNS errors
13376 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13377 keep trying to deliver a message, or to give repeated temporary errors to
13378 incoming mail. Sometimes the effect is caused by a badly set up name server and
13379 may persist for a long time. If a domain which exhibits this problem matches
13380 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13381 This option should be used with care. You can make it apply to reverse lookups
13382 by a setting such as this:
13383 .code
13384 dns_again_means_nonexist = *.in-addr.arpa
13385 .endd
13386 This option applies to all DNS lookups that Exim does. It also applies when the
13387 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13388 since these are most likely to be caused by DNS lookup problems. The
13389 &(dnslookup)& router has some options of its own for controlling what happens
13390 when lookups for MX or SRV records give temporary errors. These more specific
13391 options are applied after this global option.
13392
13393 .option dns_check_names_pattern main string "see below"
13394 .cindex "DNS" "pre-check of name syntax"
13395 When this option is set to a non-empty string, it causes Exim to check domain
13396 names for characters that are not allowed in host names before handing them to
13397 the DNS resolver, because some resolvers give temporary errors for names that
13398 contain unusual characters. If a domain name contains any unwanted characters,
13399 a &"not found"& result is forced, and the resolver is not called. The check is
13400 done by matching the domain name against a regular expression, which is the
13401 value of this option. The default pattern is
13402 .code
13403 dns_check_names_pattern = \
13404   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13405 .endd
13406 which permits only letters, digits, slashes, and hyphens in components, but
13407 they must start and end with a letter or digit. Slashes are not, in fact,
13408 permitted in host names, but they are found in certain NS records (which can be
13409 accessed in Exim by using a &%dnsdb%& lookup). If you set
13410 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13411 empty string.
13412
13413 .option dns_csa_search_limit main integer 5
13414 This option controls the depth of parental searching for CSA SRV records in the
13415 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13416
13417 .option dns_csa_use_reverse main boolean true
13418 This option controls whether or not an IP address, given as a CSA domain, is
13419 reversed and looked up in the reverse DNS, as described in more detail in
13420 section &<<SECTverifyCSA>>&.
13421
13422 .option dns_ipv4_lookup main "domain list&!!" unset
13423 .cindex "IPv6" "DNS lookup for AAAA records"
13424 .cindex "DNS" "IPv6 lookup for AAAA records"
13425 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13426 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13427 (A records) when trying to find IP addresses for hosts, unless the host's
13428 domain matches this list.
13429
13430 This is a fudge to help with name servers that give big delays or otherwise do
13431 not work for the AAAA record type. In due course, when the world's name
13432 servers have all been upgraded, there should be no need for this option.
13433
13434
13435 .option dns_retrans main time 0s
13436 .cindex "DNS" "resolver options"
13437 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13438 retransmission and retry parameters for DNS lookups. Values of zero (the
13439 defaults) leave the system default settings unchanged. The first value is the
13440 time between retries, and the second is the number of retries. It isn't
13441 totally clear exactly how these settings affect the total time a DNS lookup may
13442 take. I haven't found any documentation about timeouts on DNS lookups; these
13443 parameter values are available in the external resolver interface structure,
13444 but nowhere does it seem to describe how they are used or what you might want
13445 to set in them.
13446
13447
13448 .option dns_retry main integer 0
13449 See &%dns_retrans%& above.
13450
13451
13452 .option dns_use_edns0 main integer -1
13453 .cindex "DNS" "resolver options"
13454 .cindex "DNS" "EDNS0"
13455 If this option is set to a non-negative number then Exim will initialise the
13456 DNS resolver library to either use or not use EDNS0 extensions, overriding
13457 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13458 on.
13459
13460 If the resolver library does not support EDNS0 then this option has no effect.
13461
13462
13463 .option drop_cr main boolean false
13464 This is an obsolete option that is now a no-op. It used to affect the way Exim
13465 handled CR and LF characters in incoming messages. What happens now is
13466 described in section &<<SECTlineendings>>&.
13467
13468 .option dsn_from main "string&!!" "see below"
13469 .cindex "&'From:'& header line" "in bounces"
13470 .cindex "bounce messages" "&'From:'& line, specifying"
13471 This option can be used to vary the contents of &'From:'& header lines in
13472 bounces and other automatically generated messages (&"Delivery Status
13473 Notifications"& &-- hence the name of the option). The default setting is:
13474 .code
13475 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13476 .endd
13477 The value is expanded every time it is needed. If the expansion fails, a
13478 panic is logged, and the default value is used.
13479
13480 .option envelope_to_remove main boolean true
13481 .cindex "&'Envelope-to:'& header line"
13482 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13483 message when it is delivered, in exactly the same way as &'Return-path:'& is
13484 handled. &'Envelope-to:'& records the original recipient address from the
13485 messages's envelope that caused the delivery to happen. Such headers should not
13486 be present in incoming messages, and this option causes them to be removed at
13487 the time the message is received, to avoid any problems that might occur when a
13488 delivered message is subsequently sent on to some other recipient.
13489
13490
13491 .option errors_copy main "string list&!!" unset
13492 .cindex "bounce message" "copy to other address"
13493 .cindex "copy of bounce message"
13494 Setting this option causes Exim to send bcc copies of bounce messages that it
13495 generates to other addresses. &*Note*&: This does not apply to bounce messages
13496 coming from elsewhere. The value of the option is a colon-separated list of
13497 items. Each item consists of a pattern, terminated by white space, followed by
13498 a comma-separated list of email addresses. If a pattern contains spaces, it
13499 must be enclosed in double quotes.
13500
13501 Each pattern is processed in the same way as a single item in an address list
13502 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13503 the bounce message, the message is copied to the addresses on the list. The
13504 items are scanned in order, and once a matching one is found, no further items
13505 are examined. For example:
13506 .code
13507 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13508               rqps@mydomain   hostmaster@mydomain.example,\
13509                               postmaster@mydomain.example
13510 .endd
13511 .vindex "&$domain$&"
13512 .vindex "&$local_part$&"
13513 The address list is expanded before use. The expansion variables &$local_part$&
13514 and &$domain$& are set from the original recipient of the error message, and if
13515 there was any wildcard matching in the pattern, the expansion
13516 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13517 variables &$0$&, &$1$&, etc. are set in the normal way.
13518
13519
13520 .option errors_reply_to main string unset
13521 .cindex "bounce message" "&'Reply-to:'& in"
13522 By default, Exim's bounce and delivery warning messages contain the header line
13523 .display
13524 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13525 .endd
13526 .oindex &%quota_warn_message%&
13527 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13528 A warning message that is generated by the &%quota_warn_message%& option in an
13529 &(appendfile)& transport may contain its own &'From:'& header line that
13530 overrides the default.
13531
13532 Experience shows that people reply to bounce messages. If the
13533 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13534 and warning messages. For example:
13535 .code
13536 errors_reply_to = postmaster@my.domain.example
13537 .endd
13538 The value of the option is not expanded. It must specify a valid RFC 2822
13539 address. However, if a warning message that is generated by the
13540 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13541 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13542 not used.
13543
13544
13545 .option exim_group main string "compile-time configured"
13546 .cindex "gid (group id)" "Exim's own"
13547 .cindex "Exim group"
13548 This option changes the gid under which Exim runs when it gives up root
13549 privilege. The default value is compiled into the binary. The value of this
13550 option is used only when &%exim_user%& is also set. Unless it consists entirely
13551 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13552 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13553 security issues.
13554
13555
13556 .option exim_path main string "see below"
13557 .cindex "Exim binary, path name"
13558 This option specifies the path name of the Exim binary, which is used when Exim
13559 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13560 the directory configured at compile time by the BIN_DIRECTORY setting. It
13561 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13562 other place.
13563 &*Warning*&: Do not use a macro to define the value of this option, because
13564 you will break those Exim utilities that scan the configuration file to find
13565 where the binary is. (They then use the &%-bP%& option to extract option
13566 settings such as the value of &%spool_directory%&.)
13567
13568
13569 .option exim_user main string "compile-time configured"
13570 .cindex "uid (user id)" "Exim's own"
13571 .cindex "Exim user"
13572 This option changes the uid under which Exim runs when it gives up root
13573 privilege. The default value is compiled into the binary. Ownership of the run
13574 time configuration file and the use of the &%-C%& and &%-D%& command line
13575 options is checked against the values in the binary, not what is set here.
13576
13577 Unless it consists entirely of digits, the string is looked up using
13578 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13579 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13580 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13581
13582
13583 .option extra_local_interfaces main "string list" unset
13584 This option defines network interfaces that are to be considered local when
13585 routing, but which are not used for listening by the daemon. See section
13586 &<<SECTreclocipadd>>& for details.
13587
13588
13589 . Allow this long option name to split; give it unsplit as a fifth argument
13590 . for the automatic .oindex that is generated by .option.
13591
13592 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13593          extract_addresses_remove_arguments
13594 .oindex "&%-t%&"
13595 .cindex "command line" "addresses with &%-t%&"
13596 .cindex "Sendmail compatibility" "&%-t%& option"
13597 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13598 are present on the command line when the &%-t%& option is used to build an
13599 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13600 line addresses are removed from the recipients list. This is also how Smail
13601 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13602 command line addresses are added to those obtained from the header lines. When
13603 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13604 argument headers. If it is set false, Exim adds rather than removes argument
13605 addresses.
13606
13607
13608 .option finduser_retries main integer 0
13609 .cindex "NIS, retrying user lookups"
13610 On systems running NIS or other schemes in which user and group information is
13611 distributed from a remote system, there can be times when &[getpwnam()]& and
13612 related functions fail, even when given valid data, because things time out.
13613 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13614 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13615 many extra times to find a user or a group, waiting for one second between
13616 retries.
13617
13618 .cindex "&_/etc/passwd_&" "multiple reading of"
13619 You should not set this option greater than zero if your user information is in
13620 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13621 search the file multiple times for non-existent users, and also cause delay.
13622
13623
13624
13625 .option freeze_tell main "string list, comma separated" unset
13626 .cindex "freezing messages" "sending a message when freezing"
13627 On encountering certain errors, or when configured to do so in a system filter,
13628 ACL, or special router, Exim freezes a message. This means that no further
13629 delivery attempts take place until an administrator thaws the message, or the
13630 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13631 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13632 warning message whenever it freezes something, unless the message it is
13633 freezing is a locally-generated bounce message. (Without this exception there
13634 is the possibility of looping.) The warning message is sent to the addresses
13635 supplied as the comma-separated value of this option. If several of the
13636 message's addresses cause freezing, only a single message is sent. If the
13637 freezing was automatic, the reason(s) for freezing can be found in the message
13638 log. If you configure freezing in a filter or ACL, you must arrange for any
13639 logging that you require.
13640
13641
13642 .option gecos_name main string&!! unset
13643 .cindex "HP-UX"
13644 .cindex "&""gecos""& field, parsing"
13645 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13646 password file to hold other information in addition to users' real names. Exim
13647 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13648 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13649 of the field are used unchanged, except that, if an ampersand is encountered,
13650 it is replaced by the user's login name with the first character forced to
13651 upper case, since this is a convention that is observed on many systems.
13652
13653 When these options are set, &%gecos_pattern%& is treated as a regular
13654 expression that is to be applied to the field (again with && replaced by the
13655 login name), and if it matches, &%gecos_name%& is expanded and used as the
13656 user's name.
13657
13658 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13659 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13660 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13661 name terminates at the first comma, the following can be used:
13662 .code
13663 gecos_pattern = ([^,]*)
13664 gecos_name = $1
13665 .endd
13666
13667 .option gecos_pattern main string unset
13668 See &%gecos_name%& above.
13669
13670
13671 .option gnutls_compat_mode main boolean unset
13672 This option controls whether GnuTLS is used in compatibility mode in an Exim
13673 server. This reduces security slightly, but improves interworking with older
13674 implementations of TLS.
13675
13676 .option headers_charset main string "see below"
13677 This option sets a default character set for translating from encoded MIME
13678 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13679 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13680 ultimate default is ISO-8859-1. For more details see the description of header
13681 insertions in section &<<SECTexpansionitems>>&.
13682
13683
13684
13685 .option header_maxsize main integer "see below"
13686 .cindex "header section" "maximum size of"
13687 .cindex "limit" "size of message header section"
13688 This option controls the overall maximum size of a message's header
13689 section. The default is the value of HEADER_MAXSIZE in
13690 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13691 sections are rejected.
13692
13693
13694 .option header_line_maxsize main integer 0
13695 .cindex "header lines" "maximum size of"
13696 .cindex "limit" "size of one header line"
13697 This option limits the length of any individual header line in a message, after
13698 all the continuations have been joined together. Messages with individual
13699 header lines that are longer than the limit are rejected. The default value of
13700 zero means &"no limit"&.
13701
13702
13703
13704
13705 .option helo_accept_junk_hosts main "host list&!!" unset
13706 .cindex "HELO" "accepting junk data"
13707 .cindex "EHLO" "accepting junk data"
13708 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13709 mail, and gives an error response for invalid data. Unfortunately, there are
13710 some SMTP clients that send syntactic junk. They can be accommodated by setting
13711 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13712 if you want to do semantic checking.
13713 See also &%helo_allow_chars%& for a way of extending the permitted character
13714 set.
13715
13716
13717 .option helo_allow_chars main string unset
13718 .cindex "HELO" "underscores in"
13719 .cindex "EHLO" "underscores in"
13720 .cindex "underscore in EHLO/HELO"
13721 This option can be set to a string of rogue characters that are permitted in
13722 all EHLO and HELO names in addition to the standard letters, digits,
13723 hyphens, and dots. If you really must allow underscores, you can set
13724 .code
13725 helo_allow_chars = _
13726 .endd
13727 Note that the value is one string, not a list.
13728
13729
13730 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13731 .cindex "HELO" "forcing reverse lookup"
13732 .cindex "EHLO" "forcing reverse lookup"
13733 If the domain given by a client in a HELO or EHLO command matches this
13734 list, a reverse lookup is done in order to establish the host's true name. The
13735 default forces a lookup if the client host gives the server's name or any of
13736 its IP addresses (in brackets), something that broken clients have been seen to
13737 do.
13738
13739
13740 .option helo_try_verify_hosts main "host list&!!" unset
13741 .cindex "HELO verifying" "optional"
13742 .cindex "EHLO" "verifying, optional"
13743 By default, Exim just checks the syntax of HELO and EHLO commands (see
13744 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13745 to do more extensive checking of the data supplied by these commands. The ACL
13746 condition &`verify = helo`& is provided to make this possible.
13747 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13748 to force the check to occur. From release 4.53 onwards, this is no longer
13749 necessary. If the check has not been done before &`verify = helo`& is
13750 encountered, it is done at that time. Consequently, this option is obsolete.
13751 Its specification is retained here for backwards compatibility.
13752
13753 When an EHLO or HELO command is received, if the calling host matches
13754 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13755 EHLO command either:
13756
13757 .ilist
13758 is an IP literal matching the calling address of the host, or
13759 .next
13760 .cindex "DNS" "reverse lookup"
13761 .cindex "reverse DNS lookup"
13762 matches the host name that Exim obtains by doing a reverse lookup of the
13763 calling host address, or
13764 .next
13765 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13766 available) yields the calling host address.
13767 .endlist
13768
13769 However, the EHLO or HELO command is not rejected if any of the checks
13770 fail. Processing continues, but the result of the check is remembered, and can
13771 be detected later in an ACL by the &`verify = helo`& condition.
13772
13773 .option helo_verify_hosts main "host list&!!" unset
13774 .cindex "HELO verifying" "mandatory"
13775 .cindex "EHLO" "verifying, mandatory"
13776 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13777 backwards compatibility. For hosts that match this option, Exim checks the host
13778 name given in the HELO or EHLO in the same way as for
13779 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13780 rejected with a 550 error, and entries are written to the main and reject logs.
13781 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13782 error.
13783
13784 .option hold_domains main "domain list&!!" unset
13785 .cindex "domain" "delaying delivery"
13786 .cindex "delivery" "delaying certain domains"
13787 This option allows mail for particular domains to be held on the queue
13788 manually. The option is overridden if a message delivery is forced with the
13789 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13790 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13791 item in &%hold_domains%&, no routing or delivery for that address is done, and
13792 it is deferred every time the message is looked at.
13793
13794 This option is intended as a temporary operational measure for delaying the
13795 delivery of mail while some problem is being sorted out, or some new
13796 configuration tested. If you just want to delay the processing of some
13797 domains until a queue run occurs, you should use &%queue_domains%& or
13798 &%queue_smtp_domains%&, not &%hold_domains%&.
13799
13800 A setting of &%hold_domains%& does not override Exim's code for removing
13801 messages from the queue if they have been there longer than the longest retry
13802 time in any retry rule. If you want to hold messages for longer than the normal
13803 retry times, insert a dummy retry rule with a long retry time.
13804
13805
13806 .option host_lookup main "host list&!!" unset
13807 .cindex "host name" "lookup, forcing"
13808 Exim does not look up the name of a calling host from its IP address unless it
13809 is required to compare against some host list, or the host matches
13810 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13811 option (which normally contains IP addresses rather than host names). The
13812 default configuration file contains
13813 .code
13814 host_lookup = *
13815 .endd
13816 which causes a lookup to happen for all hosts. If the expense of these lookups
13817 is felt to be too great, the setting can be changed or removed.
13818
13819 After a successful reverse lookup, Exim does a forward lookup on the name it
13820 has obtained, to verify that it yields the IP address that it started with. If
13821 this check fails, Exim behaves as if the name lookup failed.
13822
13823 .vindex "&$host_lookup_failed$&"
13824 .vindex "&$sender_host_name$&"
13825 After any kind of failure, the host name (in &$sender_host_name$&) remains
13826 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13827 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13828 &`verify = reverse_host_lookup`& in ACLs.
13829
13830
13831 .option host_lookup_order main "string list" &`bydns:byaddr`&
13832 This option specifies the order of different lookup methods when Exim is trying
13833 to find a host name from an IP address. The default is to do a DNS lookup
13834 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13835 if that fails. You can change the order of these lookups, or omit one entirely,
13836 if you want.
13837
13838 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13839 multiple PTR records in the DNS and the IP address is not listed in
13840 &_/etc/hosts_&. Different operating systems give different results in this
13841 case. That is why the default tries a DNS lookup first.
13842
13843
13844
13845 .option host_reject_connection main "host list&!!" unset
13846 .cindex "host" "rejecting connections from"
13847 If this option is set, incoming SMTP calls from the hosts listed are rejected
13848 as soon as the connection is made.
13849 This option is obsolete, and retained only for backward compatibility, because
13850 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13851 connections immediately.
13852
13853 The ability to give an immediate rejection (either by this option or using an
13854 ACL) is provided for use in unusual cases. Many hosts will just try again,
13855 sometimes without much delay. Normally, it is better to use an ACL to reject
13856 incoming messages at a later stage, such as after RCPT commands. See
13857 chapter &<<CHAPACL>>&.
13858
13859
13860 .option hosts_connection_nolog main "host list&!!" unset
13861 .cindex "host" "not logging connections from"
13862 This option defines a list of hosts for which connection logging does not
13863 happen, even though the &%smtp_connection%& log selector is set. For example,
13864 you might want not to log SMTP connections from local processes, or from
13865 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13866 the daemon; you should therefore strive to restrict its value to a short inline
13867 list of IP addresses and networks. To disable logging SMTP connections from
13868 local processes, you must create a host list with an empty item. For example:
13869 .code
13870 hosts_connection_nolog = :
13871 .endd
13872 If the &%smtp_connection%& log selector is not set, this option has no effect.
13873
13874
13875
13876 .option hosts_treat_as_local main "domain list&!!" unset
13877 .cindex "local host" "domains treated as"
13878 .cindex "host" "treated as local"
13879 If this option is set, any host names that match the domain list are treated as
13880 if they were the local host when Exim is scanning host lists obtained from MX
13881 records
13882 or other sources. Note that the value of this option is a domain list, not a
13883 host list, because it is always used to check host names, not IP addresses.
13884
13885 This option also applies when Exim is matching the special items
13886 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13887 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13888 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13889 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13890 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13891 interfaces and recognizing the local host.
13892
13893
13894 .option ibase_servers main "string list" unset
13895 .cindex "InterBase" "server list"
13896 This option provides a list of InterBase servers and associated connection data,
13897 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13898 The option is available only if Exim has been built with InterBase support.
13899
13900
13901
13902 .option ignore_bounce_errors_after main time 10w
13903 .cindex "bounce message" "discarding"
13904 .cindex "discarding bounce message"
13905 This option affects the processing of bounce messages that cannot be delivered,
13906 that is, those that suffer a permanent delivery failure. (Bounce messages that
13907 suffer temporary delivery failures are of course retried in the usual way.)
13908
13909 After a permanent delivery failure, bounce messages are frozen,
13910 because there is no sender to whom they can be returned. When a frozen bounce
13911 message has been on the queue for more than the given time, it is unfrozen at
13912 the next queue run, and a further delivery is attempted. If delivery fails
13913 again, the bounce message is discarded. This makes it possible to keep failed
13914 bounce messages around for a shorter time than the normal maximum retry time
13915 for frozen messages. For example,
13916 .code
13917 ignore_bounce_errors_after = 12h
13918 .endd
13919 retries failed bounce message deliveries after 12 hours, discarding any further
13920 failures. If the value of this option is set to a zero time period, bounce
13921 failures are discarded immediately. Setting a very long time (as in the default
13922 value) has the effect of disabling this option. For ways of automatically
13923 dealing with other kinds of frozen message, see &%auto_thaw%& and
13924 &%timeout_frozen_after%&.
13925
13926
13927 .option ignore_fromline_hosts main "host list&!!" unset
13928 .cindex "&""From""& line"
13929 .cindex "UUCP" "&""From""& line"
13930 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13931 the headers of a message. By default this is treated as the start of the
13932 message's body, which means that any following headers are not recognized as
13933 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13934 match those hosts that insist on sending it. If the sender is actually a local
13935 process rather than a remote host, and is using &%-bs%& to inject the messages,
13936 &%ignore_fromline_local%& must be set to achieve this effect.
13937
13938
13939 .option ignore_fromline_local main boolean false
13940 See &%ignore_fromline_hosts%& above.
13941
13942
13943 .option keep_malformed main time 4d
13944 This option specifies the length of time to keep messages whose spool files
13945 have been corrupted in some way. This should, of course, never happen. At the
13946 next attempt to deliver such a message, it gets removed. The incident is
13947 logged.
13948
13949
13950 .option ldap_ca_cert_dir main string unset
13951 .cindex "LDAP", "TLS CA certificate directory"
13952 This option indicates which directory contains CA certificates for verifying
13953 a TLS certificate presented by an LDAP server.
13954 While Exim does not provide a default value, your SSL library may.
13955 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13956 and constrained to be a directory.
13957
13958
13959 .option ldap_ca_cert_file main string unset
13960 .cindex "LDAP", "TLS CA certificate file"
13961 This option indicates which file contains CA certificates for verifying
13962 a TLS certificate presented by an LDAP server.
13963 While Exim does not provide a default value, your SSL library may.
13964 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13965 and constrained to be a file.
13966
13967
13968 .option ldap_cert_file main string unset
13969 .cindex "LDAP" "TLS client certificate file"
13970 This option indicates which file contains an TLS client certificate which
13971 Exim should present to the LDAP server during TLS negotiation.
13972 Should be used together with &%ldap_cert_key%&.
13973
13974
13975 .option ldap_cert_key main string unset
13976 .cindex "LDAP" "TLS client key file"
13977 This option indicates which file contains the secret/private key to use
13978 to prove identity to the LDAP server during TLS negotiation.
13979 Should be used together with &%ldap_cert_file%&, which contains the
13980 identity to be proven.
13981
13982
13983 .option ldap_cipher_suite main string unset
13984 .cindex "LDAP" "TLS cipher suite"
13985 This controls the TLS cipher-suite negotiation during TLS negotiation with
13986 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
13987 cipher-suite options with OpenSSL (as used by LDAP client libraries).
13988
13989
13990 .option ldap_default_servers main "string list" unset
13991 .cindex "LDAP" "default servers"
13992 This option provides a list of LDAP servers which are tried in turn when an
13993 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
13994 details of LDAP queries. This option is available only when Exim has been built
13995 with LDAP support.
13996
13997
13998 .option ldap_require_cert main string unset.
13999 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14000 This should be one of the values "hard", "demand", "allow", "try" or "never".
14001 A value other than one of these is interpreted as "never".
14002 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14003 Although Exim does not set a default, the LDAP library probably defaults
14004 to hard/demand.
14005
14006
14007 .option ldap_start_tls main boolean false
14008 .cindex "LDAP" "whether or not to negotiate TLS"
14009 If set, Exim will attempt to negotiate TLS with the LDAP server when
14010 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14011 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14012 of SSL-on-connect.
14013 In the event of failure to negotiate TLS, the action taken is controlled
14014 by &%ldap_require_cert%&.
14015
14016
14017 .option ldap_version main integer unset
14018 .cindex "LDAP" "protocol version, forcing"
14019 This option can be used to force Exim to set a specific protocol version for
14020 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14021 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14022 the LDAP headers; otherwise it is 2. This option is available only when Exim
14023 has been built with LDAP support.
14024
14025
14026
14027 .option local_from_check main boolean true
14028 .cindex "&'Sender:'& header line" "disabling addition of"
14029 .cindex "&'From:'& header line" "disabling checking of"
14030 When a message is submitted locally (that is, not over a TCP/IP connection) by
14031 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14032 checks that the &'From:'& header line matches the login of the calling user and
14033 the domain specified by &%qualify_domain%&.
14034
14035 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14036 locally submitted message is automatically qualified by Exim, unless the
14037 &%-bnq%& command line option is used.
14038
14039 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14040 on the local part. If the &'From:'& header line does not match, Exim adds a
14041 &'Sender:'& header with an address constructed from the calling user's login
14042 and the default qualify domain.
14043
14044 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14045 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14046 &'Sender:'& header lines supplied by untrusted users, you must also set
14047 &%local_sender_retain%& to be true.
14048
14049 .cindex "envelope sender"
14050 These options affect only the header lines in the message. The envelope sender
14051 is still forced to be the login id at the qualify domain unless
14052 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14053
14054 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14055 request similar header line checking. See section &<<SECTthesenhea>>&, which
14056 has more details about &'Sender:'& processing.
14057
14058
14059
14060
14061 .option local_from_prefix main string unset
14062 When Exim checks the &'From:'& header line of locally submitted messages for
14063 matching the login id (see &%local_from_check%& above), it can be configured to
14064 ignore certain prefixes and suffixes in the local part of the address. This is
14065 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14066 appropriate lists, in the same form as the &%local_part_prefix%& and
14067 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14068 example, if
14069 .code
14070 local_from_prefix = *-
14071 .endd
14072 is set, a &'From:'& line containing
14073 .code
14074 From: anything-user@your.domain.example
14075 .endd
14076 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14077 matches the actual sender address that is constructed from the login name and
14078 qualify domain.
14079
14080
14081 .option local_from_suffix main string unset
14082 See &%local_from_prefix%& above.
14083
14084
14085 .option local_interfaces main "string list" "see below"
14086 This option controls which network interfaces are used by the daemon for
14087 listening; they are also used to identify the local host when routing. Chapter
14088 &<<CHAPinterfaces>>& contains a full description of this option and the related
14089 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14090 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14091 &%local_interfaces%& is
14092 .code
14093 local_interfaces = 0.0.0.0
14094 .endd
14095 when Exim is built without IPv6 support; otherwise it is
14096 .code
14097 local_interfaces = <; ::0 ; 0.0.0.0
14098 .endd
14099
14100 .option local_scan_timeout main time 5m
14101 .cindex "timeout" "for &[local_scan()]& function"
14102 .cindex "&[local_scan()]& function" "timeout"
14103 This timeout applies to the &[local_scan()]& function (see chapter
14104 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14105 the incoming message is rejected with a temporary error if it is an SMTP
14106 message. For a non-SMTP message, the message is dropped and Exim ends with a
14107 non-zero code. The incident is logged on the main and reject logs.
14108
14109
14110
14111 .option local_sender_retain main boolean false
14112 .cindex "&'Sender:'& header line" "retaining from local submission"
14113 When a message is submitted locally (that is, not over a TCP/IP connection) by
14114 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14115 do not want this to happen, you must set &%local_sender_retain%&, and you must
14116 also set &%local_from_check%& to be false (Exim will complain if you do not).
14117 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14118 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14119
14120
14121
14122
14123 .option localhost_number main string&!! unset
14124 .cindex "host" "locally unique number for"
14125 .cindex "message ids" "with multiple hosts"
14126 .vindex "&$localhost_number$&"
14127 Exim's message ids are normally unique only within the local host. If
14128 uniqueness among a set of hosts is required, each host must set a different
14129 value for the &%localhost_number%& option. The string is expanded immediately
14130 after reading the configuration file (so that a number can be computed from the
14131 host name, for example) and the result of the expansion must be a number in the
14132 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14133 systems). This is available in subsequent string expansions via the variable
14134 &$localhost_number$&. When &%localhost_number is set%&, the final two
14135 characters of the message id, instead of just being a fractional part of the
14136 time, are computed from the time and the local host number as described in
14137 section &<<SECTmessiden>>&.
14138
14139
14140
14141 .option log_file_path main "string list&!!" "set at compile time"
14142 .cindex "log" "file path for"
14143 This option sets the path which is used to determine the names of Exim's log
14144 files, or indicates that logging is to be to syslog, or both. It is expanded
14145 when Exim is entered, so it can, for example, contain a reference to the host
14146 name. If no specific path is set for the log files at compile or run time, they
14147 are written in a sub-directory called &_log_& in Exim's spool directory.
14148 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14149 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14150 used. If this string is fixed at your installation (contains no expansion
14151 variables) it is recommended that you do not set this option in the
14152 configuration file, but instead supply the path using LOG_FILE_PATH in
14153 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14154 early on &-- in particular, failure to read the configuration file.
14155
14156
14157 .option log_selector main string unset
14158 .cindex "log" "selectors"
14159 This option can be used to reduce or increase the number of things that Exim
14160 writes to its log files. Its argument is made up of names preceded by plus or
14161 minus characters. For example:
14162 .code
14163 log_selector = +arguments -retry_defer
14164 .endd
14165 A list of possible names and what they control is given in the chapter on
14166 logging, in section &<<SECTlogselector>>&.
14167
14168
14169 .option log_timezone main boolean false
14170 .cindex "log" "timezone for entries"
14171 .vindex "&$tod_log$&"
14172 .vindex "&$tod_zone$&"
14173 By default, the timestamps on log lines are in local time without the
14174 timezone. This means that if your timezone changes twice a year, the timestamps
14175 in log lines are ambiguous for an hour when the clocks go back. One way of
14176 avoiding this problem is to set the timezone to UTC. An alternative is to set
14177 &%log_timezone%& true. This turns on the addition of the timezone offset to
14178 timestamps in log lines. Turning on this option can add quite a lot to the size
14179 of log files because each line is extended by 6 characters. Note that the
14180 &$tod_log$& variable contains the log timestamp without the zone, but there is
14181 another variable called &$tod_zone$& that contains just the timezone offset.
14182
14183
14184 .option lookup_open_max main integer 25
14185 .cindex "too many open files"
14186 .cindex "open files, too many"
14187 .cindex "file" "too many open"
14188 .cindex "lookup" "maximum open files"
14189 .cindex "limit" "open files for lookups"
14190 This option limits the number of simultaneously open files for single-key
14191 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14192 Exim normally keeps these files open during routing, because often the same
14193 file is required several times. If the limit is reached, Exim closes the least
14194 recently used file. Note that if you are using the &'ndbm'& library, it
14195 actually opens two files for each logical DBM database, though it still counts
14196 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14197 open files"& errors with NDBM, you need to reduce the value of
14198 &%lookup_open_max%&.
14199
14200
14201 .option max_username_length main integer 0
14202 .cindex "length of login name"
14203 .cindex "user name" "maximum length"
14204 .cindex "limit" "user name length"
14205 Some operating systems are broken in that they truncate long arguments to
14206 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14207 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14208 an argument that is longer behaves as if &[getpwnam()]& failed.
14209
14210
14211 .option message_body_newlines main bool false
14212 .cindex "message body" "newlines in variables"
14213 .cindex "newline" "in message body variables"
14214 .vindex "&$message_body$&"
14215 .vindex "&$message_body_end$&"
14216 By default, newlines in the message body are replaced by spaces when setting
14217 the &$message_body$& and &$message_body_end$& expansion variables. If this
14218 option is set true, this no longer happens.
14219
14220
14221 .option message_body_visible main integer 500
14222 .cindex "body of message" "visible size"
14223 .cindex "message body" "visible size"
14224 .vindex "&$message_body$&"
14225 .vindex "&$message_body_end$&"
14226 This option specifies how much of a message's body is to be included in the
14227 &$message_body$& and &$message_body_end$& expansion variables.
14228
14229
14230 .option message_id_header_domain main string&!! unset
14231 .cindex "&'Message-ID:'& header line"
14232 If this option is set, the string is expanded and used as the right hand side
14233 (domain) of the &'Message-ID:'& header that Exim creates if a
14234 locally-originated incoming message does not have one. &"Locally-originated"&
14235 means &"not received over TCP/IP."&
14236 Otherwise, the primary host name is used.
14237 Only letters, digits, dot and hyphen are accepted; any other characters are
14238 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14239 empty string, the option is ignored.
14240
14241
14242 .option message_id_header_text main string&!! unset
14243 If this variable is set, the string is expanded and used to augment the text of
14244 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14245 message does not have one. The text of this header is required by RFC 2822 to
14246 take the form of an address. By default, Exim uses its internal message id as
14247 the local part, and the primary host name as the domain. If this option is set,
14248 it is expanded, and provided the expansion is not forced to fail, and does not
14249 yield an empty string, the result is inserted into the header immediately
14250 before the @, separated from the internal message id by a dot. Any characters
14251 that are illegal in an address are automatically converted into hyphens. This
14252 means that variables such as &$tod_log$& can be used, because the spaces and
14253 colons will become hyphens.
14254
14255
14256 .option message_logs main boolean true
14257 .cindex "message logs" "disabling"
14258 .cindex "log" "message log; disabling"
14259 If this option is turned off, per-message log files are not created in the
14260 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14261 Exim, by reducing the number of files involved in handling a message from a
14262 minimum of four (header spool file, body spool file, delivery journal, and
14263 per-message log) to three. The other major I/O activity is Exim's main log,
14264 which is not affected by this option.
14265
14266
14267 .option message_size_limit main string&!! 50M
14268 .cindex "message" "size limit"
14269 .cindex "limit" "message size"
14270 .cindex "size" "of message, limit"
14271 This option limits the maximum size of message that Exim will process. The
14272 value is expanded for each incoming connection so, for example, it can be made
14273 to depend on the IP address of the remote host for messages arriving via
14274 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14275 optionally followed by K or M.
14276
14277 &*Note*&: This limit cannot be made to depend on a message's sender or any
14278 other properties of an individual message, because it has to be advertised in
14279 the server's response to EHLO. String expansion failure causes a temporary
14280 error. A value of zero means no limit, but its use is not recommended. See also
14281 &%bounce_return_size_limit%&.
14282
14283 Incoming SMTP messages are failed with a 552 error if the limit is
14284 exceeded; locally-generated messages either get a stderr message or a delivery
14285 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14286 an oversized message is logged in both the main and the reject logs. See also
14287 the generic transport option &%message_size_limit%&, which limits the size of
14288 message that an individual transport can process.
14289
14290 If you use a virus-scanner and set this option to to a value larger than the
14291 maximum size that your virus-scanner is configured to support, you may get
14292 failures triggered by large mails.  The right size to configure for the
14293 virus-scanner depends upon what data is passed and the options in use but it's
14294 probably safest to just set it to a little larger than this value.  Eg, with a
14295 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14296 some problems may result.
14297
14298 A value of 0 will disable size limit checking; Exim will still advertise the
14299 SIZE extension in an EHLO response, but without a limit, so as to permit
14300 SMTP clients to still indicate the message size along with the MAIL verb.
14301
14302
14303 .option move_frozen_messages main boolean false
14304 .cindex "frozen messages" "moving"
14305 This option, which is available only if Exim has been built with the setting
14306 .code
14307 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14308 .endd
14309 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14310 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14311 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14312 standard utilities for handling such moved messages, and they do not show up in
14313 lists generated by &%-bp%& or by the Exim monitor.
14314
14315
14316 .option mua_wrapper main boolean false
14317 Setting this option true causes Exim to run in a very restrictive mode in which
14318 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14319 contains a full description of this facility.
14320
14321
14322
14323 .option mysql_servers main "string list" unset
14324 .cindex "MySQL" "server list"
14325 This option provides a list of MySQL servers and associated connection data, to
14326 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14327 option is available only if Exim has been built with MySQL support.
14328
14329
14330 .option never_users main "string list&!!" unset
14331 This option is expanded just once, at the start of Exim's processing. Local
14332 message deliveries are normally run in processes that are setuid to the
14333 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14334 It is usually desirable to prevent any deliveries from running as root, as a
14335 safety precaution.
14336
14337 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14338 list of users that must not be used for local deliveries. This list is fixed in
14339 the binary and cannot be overridden by the configuration file. By default, it
14340 contains just the single user name &"root"&. The &%never_users%& runtime option
14341 can be used to add more users to the fixed list.
14342
14343 If a message is to be delivered as one of the users on the fixed list or the
14344 &%never_users%& list, an error occurs, and delivery is deferred. A common
14345 example is
14346 .code
14347 never_users = root:daemon:bin
14348 .endd
14349 Including root is redundant if it is also on the fixed list, but it does no
14350 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14351 transport driver.
14352
14353
14354 .option openssl_options main "string list" "+no_sslv2"
14355 .cindex "OpenSSL "compatibility options"
14356 This option allows an administrator to adjust the SSL options applied
14357 by OpenSSL to connections.  It is given as a space-separated list of items,
14358 each one to be +added or -subtracted from the current value.
14359
14360 This option is only available if Exim is built against OpenSSL.  The values
14361 available for this option vary according to the age of your OpenSSL install.
14362 The &"all"& value controls a subset of flags which are available, typically
14363 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14364 list the values known on your system and Exim should support all the
14365 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14366 names lose the leading &"SSL_OP_"& and are lower-cased.
14367
14368 Note that adjusting the options can have severe impact upon the security of
14369 SSL as used by Exim.  It is possible to disable safety checks and shoot
14370 yourself in the foot in various unpleasant ways.  This option should not be
14371 adjusted lightly.  An unrecognised item will be detected at startup, by
14372 invoking Exim with the &%-bV%& flag.
14373
14374 Historical note: prior to release 4.80, Exim defaulted this value to
14375 "+dont_insert_empty_fragments", which may still be needed for compatibility
14376 with some clients, but which lowers security by increasing exposure to
14377 some now infamous attacks.
14378
14379 An example:
14380 .code
14381 # Make both old MS and old Eudora happy:
14382 openssl_options = -all +microsoft_big_sslv3_buffer \
14383                        +dont_insert_empty_fragments
14384 .endd
14385
14386 Possible options may include:
14387 .ilist
14388 &`all`&
14389 .next
14390 &`allow_unsafe_legacy_renegotiation`&
14391 .next
14392 &`cipher_server_preference`&
14393 .next
14394 &`dont_insert_empty_fragments`&
14395 .next
14396 &`ephemeral_rsa`&
14397 .next
14398 &`legacy_server_connect`&
14399 .next
14400 &`microsoft_big_sslv3_buffer`&
14401 .next
14402 &`microsoft_sess_id_bug`&
14403 .next
14404 &`msie_sslv2_rsa_padding`&
14405 .next
14406 &`netscape_challenge_bug`&
14407 .next
14408 &`netscape_reuse_cipher_change_bug`&
14409 .next
14410 &`no_compression`&
14411 .next
14412 &`no_session_resumption_on_renegotiation`&
14413 .next
14414 &`no_sslv2`&
14415 .next
14416 &`no_sslv3`&
14417 .next
14418 &`no_ticket`&
14419 .next
14420 &`no_tlsv1`&
14421 .next
14422 &`no_tlsv1_1`&
14423 .next
14424 &`no_tlsv1_2`&
14425 .next
14426 &`single_dh_use`&
14427 .next
14428 &`single_ecdh_use`&
14429 .next
14430 &`ssleay_080_client_dh_bug`&
14431 .next
14432 &`sslref2_reuse_cert_type_bug`&
14433 .next
14434 &`tls_block_padding_bug`&
14435 .next
14436 &`tls_d5_bug`&
14437 .next
14438 &`tls_rollback_bug`&
14439 .endlist
14440
14441
14442 .option oracle_servers main "string list" unset
14443 .cindex "Oracle" "server list"
14444 This option provides a list of Oracle servers and associated connection data,
14445 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14446 The option is available only if Exim has been built with Oracle support.
14447
14448
14449 .option percent_hack_domains main "domain list&!!" unset
14450 .cindex "&""percent hack""&"
14451 .cindex "source routing" "in email address"
14452 .cindex "address" "source-routed"
14453 The &"percent hack"& is the convention whereby a local part containing a
14454 percent sign is re-interpreted as a new email address, with the percent
14455 replaced by @. This is sometimes called &"source routing"&, though that term is
14456 also applied to RFC 2822 addresses that begin with an @ character. If this
14457 option is set, Exim implements the percent facility for those domains listed,
14458 but no others. This happens before an incoming SMTP address is tested against
14459 an ACL.
14460
14461 &*Warning*&: The &"percent hack"& has often been abused by people who are
14462 trying to get round relaying restrictions. For this reason, it is best avoided
14463 if at all possible. Unfortunately, a number of less security-conscious MTAs
14464 implement it unconditionally. If you are running Exim on a gateway host, and
14465 routing mail through to internal MTAs without processing the local parts, it is
14466 a good idea to reject recipient addresses with percent characters in their
14467 local parts. Exim's default configuration does this.
14468
14469
14470 .option perl_at_start main boolean false
14471 This option is available only when Exim is built with an embedded Perl
14472 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14473
14474
14475 .option perl_startup main string unset
14476 This option is available only when Exim is built with an embedded Perl
14477 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14478
14479
14480 .option pgsql_servers main "string list" unset
14481 .cindex "PostgreSQL lookup type" "server list"
14482 This option provides a list of PostgreSQL servers and associated connection
14483 data, to be used in conjunction with &(pgsql)& lookups (see section
14484 &<<SECID72>>&). The option is available only if Exim has been built with
14485 PostgreSQL support.
14486
14487
14488 .option pid_file_path main string&!! "set at compile time"
14489 .cindex "daemon" "pid file path"
14490 .cindex "pid file, path for"
14491 This option sets the name of the file to which the Exim daemon writes its
14492 process id. The string is expanded, so it can contain, for example, references
14493 to the host name:
14494 .code
14495 pid_file_path = /var/log/$primary_hostname/exim.pid
14496 .endd
14497 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14498 spool directory.
14499 The value set by the option can be overridden by the &%-oP%& command line
14500 option. A pid file is not written if a &"non-standard"& daemon is run by means
14501 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14502
14503
14504 .option pipelining_advertise_hosts main "host list&!!" *
14505 .cindex "PIPELINING" "suppressing advertising"
14506 This option can be used to suppress the advertisement of the SMTP
14507 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14508 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14509 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14510 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14511 that clients will use it; &"out of order"& commands that are &"expected"& do
14512 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14513
14514
14515 .option preserve_message_logs main boolean false
14516 .cindex "message logs" "preserving"
14517 If this option is set, message log files are not deleted when messages are
14518 completed. Instead, they are moved to a sub-directory of the spool directory
14519 called &_msglog.OLD_&, where they remain available for statistical or debugging
14520 purposes. This is a dangerous option to set on systems with any appreciable
14521 volume of mail. Use with care!
14522
14523
14524 .option primary_hostname main string "see below"
14525 .cindex "name" "of local host"
14526 .cindex "host" "name of local"
14527 .cindex "local host" "name of"
14528 .vindex "&$primary_hostname$&"
14529 This specifies the name of the current host. It is used in the default EHLO or
14530 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14531 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14532 The value is also used by default in some SMTP response messages from an Exim
14533 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14534
14535 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14536 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14537 contains only one component, Exim passes it to &[gethostbyname()]& (or
14538 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14539 version. The variable &$primary_hostname$& contains the host name, whether set
14540 explicitly by this option, or defaulted.
14541
14542
14543 .option print_topbitchars main boolean false
14544 .cindex "printing characters"
14545 .cindex "8-bit characters"
14546 By default, Exim considers only those characters whose codes lie in the range
14547 32&--126 to be printing characters. In a number of circumstances (for example,
14548 when writing log entries) non-printing characters are converted into escape
14549 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14550 is set, code values of 128 and above are also considered to be printing
14551 characters.
14552
14553 This option also affects the header syntax checks performed by the
14554 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14555 the user's full name when constructing From: and Sender: addresses (as
14556 described in section &<<SECTconstr>>&). Setting this option can cause
14557 Exim to generate eight bit message headers that do not conform to the
14558 standards.
14559
14560
14561 .option process_log_path main string unset
14562 .cindex "process log path"
14563 .cindex "log" "process log"
14564 .cindex "&'exiwhat'&"
14565 This option sets the name of the file to which an Exim process writes its
14566 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14567 utility script. If this option is unset, the file called &_exim-process.info_&
14568 in Exim's spool directory is used. The ability to specify the name explicitly
14569 can be useful in environments where two different Exims are running, using
14570 different spool directories.
14571
14572
14573 .option prod_requires_admin main boolean true
14574 .oindex "&%-M%&"
14575 .oindex "&%-R%&"
14576 .oindex "&%-q%&"
14577 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14578 admin user unless &%prod_requires_admin%& is set false. See also
14579 &%queue_list_requires_admin%&.
14580
14581
14582 .option qualify_domain main string "see below"
14583 .cindex "domain" "for qualifying addresses"
14584 .cindex "address" "qualification"
14585 This option specifies the domain name that is added to any envelope sender
14586 addresses that do not have a domain qualification. It also applies to
14587 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14588 are accepted by default only for locally-generated messages. Qualification is
14589 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14590 locally-generated messages, unless the &%-bnq%& command line option is used.
14591
14592 Messages from external sources must always contain fully qualified addresses,
14593 unless the sending host matches &%sender_unqualified_hosts%& or
14594 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14595 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14596 necessary. Internally, Exim always works with fully qualified envelope
14597 addresses. If &%qualify_domain%& is not set, it defaults to the
14598 &%primary_hostname%& value.
14599
14600
14601 .option qualify_recipient main string "see below"
14602 This option allows you to specify a different domain for qualifying recipient
14603 addresses to the one that is used for senders. See &%qualify_domain%& above.
14604
14605
14606
14607 .option queue_domains main "domain list&!!" unset
14608 .cindex "domain" "specifying non-immediate delivery"
14609 .cindex "queueing incoming messages"
14610 .cindex "message" "queueing certain domains"
14611 This option lists domains for which immediate delivery is not required.
14612 A delivery process is started whenever a message is received, but only those
14613 domains that do not match are processed. All other deliveries wait until the
14614 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14615
14616
14617 .option queue_list_requires_admin main boolean true
14618 .oindex "&%-bp%&"
14619 The &%-bp%& command-line option, which lists the messages that are on the
14620 queue, requires the caller to be an admin user unless
14621 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14622
14623
14624 .option queue_only main boolean false
14625 .cindex "queueing incoming messages"
14626 .cindex "message" "queueing unconditionally"
14627 If &%queue_only%& is set, a delivery process is not automatically started
14628 whenever a message is received. Instead, the message waits on the queue for the
14629 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14630 delivered immediately when certain conditions (such as heavy load) occur.
14631
14632 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14633 and &%-odi%& command line options override &%queue_only%& unless
14634 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14635 &%queue_only_load%&, and &%smtp_accept_queue%&.
14636
14637
14638 .option queue_only_file main string unset
14639 .cindex "queueing incoming messages"
14640 .cindex "message" "queueing by file existence"
14641 This option can be set to a colon-separated list of absolute path names, each
14642 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14643 it tests for the existence of each listed path using a call to &[stat()]&. For
14644 each path that exists, the corresponding queueing option is set.
14645 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14646 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14647 .code
14648 queue_only_file = smtp/some/file
14649 .endd
14650 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14651 &_/some/file_& exists.
14652
14653
14654 .option queue_only_load main fixed-point unset
14655 .cindex "load average"
14656 .cindex "queueing incoming messages"
14657 .cindex "message" "queueing by load"
14658 If the system load average is higher than this value, incoming messages from
14659 all sources are queued, and no automatic deliveries are started. If this
14660 happens during local or remote SMTP input, all subsequent messages received on
14661 the same SMTP connection are queued by default, whatever happens to the load in
14662 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14663 false.
14664
14665 Deliveries will subsequently be performed by queue runner processes. This
14666 option has no effect on ancient operating systems on which Exim cannot
14667 determine the load average. See also &%deliver_queue_load_max%& and
14668 &%smtp_load_reserve%&.
14669
14670
14671 .option queue_only_load_latch main boolean true
14672 .cindex "load average" "re-evaluating per message"
14673 When this option is true (the default), once one message has been queued
14674 because the load average is higher than the value set by &%queue_only_load%&,
14675 all subsequent messages received on the same SMTP connection are also queued.
14676 This is a deliberate choice; even though the load average may fall below the
14677 threshold, it doesn't seem right to deliver later messages on the same
14678 connection when not delivering earlier ones. However, there are special
14679 circumstances such as very long-lived connections from scanning appliances
14680 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14681 should be set false. This causes the value of the load average to be
14682 re-evaluated for each message.
14683
14684
14685 .option queue_only_override main boolean true
14686 .cindex "queueing incoming messages"
14687 When this option is true, the &%-od%&&'x'& command line options override the
14688 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14689 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14690 to override; they are accepted, but ignored.
14691
14692
14693 .option queue_run_in_order main boolean false
14694 .cindex "queue runner" "processing messages in order"
14695 If this option is set, queue runs happen in order of message arrival instead of
14696 in an arbitrary order. For this to happen, a complete list of the entire queue
14697 must be set up before the deliveries start. When the queue is all held in a
14698 single directory (the default), a single list is created for both the ordered
14699 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14700 single list is not created when &%queue_run_in_order%& is false. In this case,
14701 the sub-directories are processed one at a time (in a random order), and this
14702 avoids setting up one huge list for the whole queue. Thus, setting
14703 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14704 when the queue is large, because of the extra work in setting up the single,
14705 large list. In most situations, &%queue_run_in_order%& should not be set.
14706
14707
14708
14709 .option queue_run_max main integer 5
14710 .cindex "queue runner" "maximum number of"
14711 This controls the maximum number of queue runner processes that an Exim daemon
14712 can run simultaneously. This does not mean that it starts them all at once,
14713 but rather that if the maximum number are still running when the time comes to
14714 start another one, it refrains from starting another one. This can happen with
14715 very large queues and/or very sluggish deliveries. This option does not,
14716 however, interlock with other processes, so additional queue runners can be
14717 started by other means, or by killing and restarting the daemon.
14718
14719 Setting this option to zero does not suppress queue runs; rather, it disables
14720 the limit, allowing any number of simultaneous queue runner processes to be
14721 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14722 the daemon's command line.
14723
14724 .option queue_smtp_domains main "domain list&!!" unset
14725 .cindex "queueing incoming messages"
14726 .cindex "message" "queueing remote deliveries"
14727 When this option is set, a delivery process is started whenever a message is
14728 received, routing is performed, and local deliveries take place.
14729 However, if any SMTP deliveries are required for domains that match
14730 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14731 message waits on the queue for the next queue run. Since routing of the message
14732 has taken place, Exim knows to which remote hosts it must be delivered, and so
14733 when the queue run happens, multiple messages for the same host are delivered
14734 over a single SMTP connection. The &%-odqs%& command line option causes all
14735 SMTP deliveries to be queued in this way, and is equivalent to setting
14736 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14737 &%queue_domains%&.
14738
14739
14740 .option receive_timeout main time 0s
14741 .cindex "timeout" "for non-SMTP input"
14742 This option sets the timeout for accepting a non-SMTP message, that is, the
14743 maximum time that Exim waits when reading a message on the standard input. If
14744 the value is zero, it will wait for ever. This setting is overridden by the
14745 &%-or%& command line option. The timeout for incoming SMTP messages is
14746 controlled by &%smtp_receive_timeout%&.
14747
14748 .option received_header_text main string&!! "see below"
14749 .cindex "customizing" "&'Received:'& header"
14750 .cindex "&'Received:'& header line" "customizing"
14751 This string defines the contents of the &'Received:'& message header that is
14752 added to each message, except for the timestamp, which is automatically added
14753 on at the end (preceded by a semicolon). The string is expanded each time it is
14754 used. If the expansion yields an empty string, no &'Received:'& header line is
14755 added to the message. Otherwise, the string should start with the text
14756 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14757 header lines. The default setting is:
14758
14759 .code
14760 received_header_text = Received: \
14761   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14762   {${if def:sender_ident \
14763   {from ${quote_local_part:$sender_ident} }}\
14764   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14765   by $primary_hostname \
14766   ${if def:received_protocol {with $received_protocol}} \
14767   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14768   (Exim $version_number)\n\t\
14769   ${if def:sender_address \
14770   {(envelope-from <$sender_address>)\n\t}}\
14771   id $message_exim_id\
14772   ${if def:received_for {\n\tfor $received_for}}
14773 .endd
14774
14775 The reference to the TLS cipher is omitted when Exim is built without TLS
14776 support. The use of conditional expansions ensures that this works for both
14777 locally generated messages and messages received from remote hosts, giving
14778 header lines such as the following:
14779 .code
14780 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14781 by marley.carol.example with esmtp (Exim 4.00)
14782 (envelope-from <bob@carol.example>)
14783 id 16IOWa-00019l-00
14784 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14785 Received: by scrooge.carol.example with local (Exim 4.00)
14786 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14787 .endd
14788 Until the body of the message has been received, the timestamp is the time when
14789 the message started to be received. Once the body has arrived, and all policy
14790 checks have taken place, the timestamp is updated to the time at which the
14791 message was accepted.
14792
14793
14794 .option received_headers_max main integer 30
14795 .cindex "loop" "prevention"
14796 .cindex "mail loop prevention"
14797 .cindex "&'Received:'& header line" "counting"
14798 When a message is to be delivered, the number of &'Received:'& headers is
14799 counted, and if it is greater than this parameter, a mail loop is assumed to
14800 have occurred, the delivery is abandoned, and an error message is generated.
14801 This applies to both local and remote deliveries.
14802
14803
14804 .option recipient_unqualified_hosts main "host list&!!" unset
14805 .cindex "unqualified addresses"
14806 .cindex "host" "unqualified addresses from"
14807 This option lists those hosts from which Exim is prepared to accept unqualified
14808 recipient addresses in message envelopes. The addresses are made fully
14809 qualified by the addition of the &%qualify_recipient%& value. This option also
14810 affects message header lines. Exim does not reject unqualified recipient
14811 addresses in headers, but it qualifies them only if the message came from a
14812 host that matches &%recipient_unqualified_hosts%&,
14813 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14814 option was not set.
14815
14816
14817 .option recipients_max main integer 0
14818 .cindex "limit" "number of recipients"
14819 .cindex "recipient" "maximum number"
14820 If this option is set greater than zero, it specifies the maximum number of
14821 original recipients for any message. Additional recipients that are generated
14822 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14823 all recipients over the limit; earlier recipients are delivered as normal.
14824 Non-SMTP messages with too many recipients are failed, and no deliveries are
14825 done.
14826
14827 .cindex "RCPT" "maximum number of incoming"
14828 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14829 RCPT commands in a single message.
14830
14831
14832 .option recipients_max_reject main boolean false
14833 If this option is set true, Exim rejects SMTP messages containing too many
14834 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14835 error to the eventual DATA command. Otherwise (the default) it gives a 452
14836 error to the surplus RCPT commands and accepts the message on behalf of the
14837 initial set of recipients. The remote server should then re-send the message
14838 for the remaining recipients at a later time.
14839
14840
14841 .option remote_max_parallel main integer 2
14842 .cindex "delivery" "parallelism for remote"
14843 This option controls parallel delivery of one message to a number of remote
14844 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14845 does all the remote deliveries for a message one by one. Otherwise, if a single
14846 message has to be delivered to more than one remote host, or if several copies
14847 have to be sent to the same remote host, up to &%remote_max_parallel%&
14848 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14849 deliveries are required, the maximum number of processes are started, and as
14850 each one finishes, another is begun. The order of starting processes is the
14851 same as if sequential delivery were being done, and can be controlled by the
14852 &%remote_sort_domains%& option. If parallel delivery takes place while running
14853 with debugging turned on, the debugging output from each delivery process is
14854 tagged with its process id.
14855
14856 This option controls only the maximum number of parallel deliveries for one
14857 message in one Exim delivery process. Because Exim has no central queue
14858 manager, there is no way of controlling the total number of simultaneous
14859 deliveries if the configuration allows a delivery attempt as soon as a message
14860 is received.
14861
14862 .cindex "number of deliveries"
14863 .cindex "delivery" "maximum number of"
14864 If you want to control the total number of deliveries on the system, you
14865 need to set the &%queue_only%& option. This ensures that all incoming messages
14866 are added to the queue without starting a delivery process. Then set up an Exim
14867 daemon to start queue runner processes at appropriate intervals (probably
14868 fairly often, for example, every minute), and limit the total number of queue
14869 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14870 delivers only one message at a time, the maximum number of deliveries that can
14871 then take place at once is &%queue_run_max%& multiplied by
14872 &%remote_max_parallel%&.
14873
14874 If it is purely remote deliveries you want to control, use
14875 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14876 doing the SMTP routing before queueing, so that several messages for the same
14877 host will eventually get delivered down the same connection.
14878
14879
14880 .option remote_sort_domains main "domain list&!!" unset
14881 .cindex "sorting remote deliveries"
14882 .cindex "delivery" "sorting remote"
14883 When there are a number of remote deliveries for a message, they are sorted by
14884 domain into the order given by this list. For example,
14885 .code
14886 remote_sort_domains = *.cam.ac.uk:*.uk
14887 .endd
14888 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14889 then to those in the &%uk%& domain, then to any others.
14890
14891
14892 .option retry_data_expire main time 7d
14893 .cindex "hints database" "data expiry"
14894 This option sets a &"use before"& time on retry information in Exim's hints
14895 database. Any older retry data is ignored. This means that, for example, once a
14896 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14897 past failures.
14898
14899
14900 .option retry_interval_max main time 24h
14901 .cindex "retry" "limit on interval"
14902 .cindex "limit" "on retry interval"
14903 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14904 intervals between delivery attempts for messages that cannot be delivered
14905 straight away. This option sets an overall limit to the length of time between
14906 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14907 the default value.
14908
14909
14910 .option return_path_remove main boolean true
14911 .cindex "&'Return-path:'& header line" "removing"
14912 RFC 2821, section 4.4, states that an SMTP server must insert a
14913 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14914 The &'Return-path:'& header preserves the sender address as received in the
14915 MAIL command. This description implies that this header should not be present
14916 in an incoming message. If &%return_path_remove%& is true, any existing
14917 &'Return-path:'& headers are removed from messages at the time they are
14918 received. Exim's transports have options for adding &'Return-path:'& headers at
14919 the time of delivery. They are normally used only for final local deliveries.
14920
14921
14922 .option return_size_limit main integer 100K
14923 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14924
14925
14926 .option rfc1413_hosts main "host list&!!" *
14927 .cindex "RFC 1413"
14928 .cindex "host" "for RFC 1413 calls"
14929 RFC 1413 identification calls are made to any client host which matches an item
14930 in the list.
14931
14932 .option rfc1413_query_timeout main time 5s
14933 .cindex "RFC 1413" "query timeout"
14934 .cindex "timeout" "for RFC 1413 call"
14935 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14936 no RFC 1413 calls are ever made.
14937
14938
14939 .option sender_unqualified_hosts main "host list&!!" unset
14940 .cindex "unqualified addresses"
14941 .cindex "host" "unqualified addresses from"
14942 This option lists those hosts from which Exim is prepared to accept unqualified
14943 sender addresses. The addresses are made fully qualified by the addition of
14944 &%qualify_domain%&. This option also affects message header lines. Exim does
14945 not reject unqualified addresses in headers that contain sender addresses, but
14946 it qualifies them only if the message came from a host that matches
14947 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14948 using TCP/IP), and the &%-bnq%& option was not set.
14949
14950
14951 .option smtp_accept_keepalive main boolean true
14952 .cindex "keepalive" "on incoming connection"
14953 This option controls the setting of the SO_KEEPALIVE option on incoming
14954 TCP/IP socket connections. When set, it causes the kernel to probe idle
14955 connections periodically, by sending packets with &"old"& sequence numbers. The
14956 other end of the connection should send an acknowledgment if the connection is
14957 still okay or a reset if the connection has been aborted. The reason for doing
14958 this is that it has the beneficial effect of freeing up certain types of
14959 connection that can get stuck when the remote host is disconnected without
14960 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14961 hours to detect unreachable hosts.
14962
14963
14964
14965 .option smtp_accept_max main integer 20
14966 .cindex "limit" "incoming SMTP connections"
14967 .cindex "SMTP" "incoming connection count"
14968 .cindex "inetd"
14969 This option specifies the maximum number of simultaneous incoming SMTP calls
14970 that Exim will accept. It applies only to the listening daemon; there is no
14971 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14972 value is set to zero, no limit is applied. However, it is required to be
14973 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14974 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14975
14976 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14977 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14978 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14979 and &%smtp_load_reserve%& are then checked before accepting the connection.
14980
14981
14982 .option smtp_accept_max_nonmail main integer 10
14983 .cindex "limit" "non-mail SMTP commands"
14984 .cindex "SMTP" "limiting non-mail commands"
14985 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
14986 the connection if there are too many. This option defines &"too many"&. The
14987 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
14988 client looping sending EHLO, for example. The check is applied only if the
14989 client host matches &%smtp_accept_max_nonmail_hosts%&.
14990
14991 When a new message is expected, one occurrence of RSET is not counted. This
14992 allows a client to send one RSET between messages (this is not necessary,
14993 but some clients do it). Exim also allows one uncounted occurrence of HELO
14994 or EHLO, and one occurrence of STARTTLS between messages. After
14995 starting up a TLS session, another EHLO is expected, and so it too is not
14996 counted. The first occurrence of AUTH in a connection, or immediately
14997 following STARTTLS is not counted. Otherwise, all commands other than
14998 MAIL, RCPT, DATA, and QUIT are counted.
14999
15000
15001 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15002 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15003 check by setting this option. The default value makes it apply to all hosts. By
15004 changing the value, you can exclude any badly-behaved hosts that you have to
15005 live with.
15006
15007
15008 . Allow this long option name to split; give it unsplit as a fifth argument
15009 . for the automatic .oindex that is generated by .option.
15010
15011 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
15012          smtp_accept_max_per_connection
15013 .cindex "SMTP" "limiting incoming message count"
15014 .cindex "limit" "messages per SMTP connection"
15015 The value of this option limits the number of MAIL commands that Exim is
15016 prepared to accept over a single SMTP connection, whether or not each command
15017 results in the transfer of a message. After the limit is reached, a 421
15018 response is given to subsequent MAIL commands. This limit is a safety
15019 precaution against a client that goes mad (incidents of this type have been
15020 seen).
15021
15022
15023 .option smtp_accept_max_per_host main string&!! unset
15024 .cindex "limit" "SMTP connections from one host"
15025 .cindex "host" "limiting SMTP connections from"
15026 This option restricts the number of simultaneous IP connections from a single
15027 host (strictly, from a single IP address) to the Exim daemon. The option is
15028 expanded, to enable different limits to be applied to different hosts by
15029 reference to &$sender_host_address$&. Once the limit is reached, additional
15030 connection attempts from the same host are rejected with error code 421. This
15031 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15032 of zero imposes no limit. If this option is set greater than zero, it is
15033 required that &%smtp_accept_max%& be non-zero.
15034
15035 &*Warning*&: When setting this option you should not use any expansion
15036 constructions that take an appreciable amount of time. The expansion and test
15037 happen in the main daemon loop, in order to reject additional connections
15038 without forking additional processes (otherwise a denial-of-service attack
15039 could cause a vast number or processes to be created). While the daemon is
15040 doing this processing, it cannot accept any other incoming connections.
15041
15042
15043
15044 .option smtp_accept_queue main integer 0
15045 .cindex "SMTP" "incoming connection count"
15046 .cindex "queueing incoming messages"
15047 .cindex "message" "queueing by SMTP connection count"
15048 If the number of simultaneous incoming SMTP connections being handled via the
15049 listening daemon exceeds this value, messages received by SMTP are just placed
15050 on the queue; no delivery processes are started automatically. The count is
15051 fixed at the start of an SMTP connection. It cannot be updated in the
15052 subprocess that receives messages, and so the queueing or not queueing applies
15053 to all messages received in the same connection.
15054
15055 A value of zero implies no limit, and clearly any non-zero value is useful only
15056 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15057 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15058 various &%-od%&&'x'& command line options.
15059
15060
15061 . Allow this long option name to split; give it unsplit as a fifth argument
15062 . for the automatic .oindex that is generated by .option.
15063
15064 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15065          smtp_accept_queue_per_connection
15066 .cindex "queueing incoming messages"
15067 .cindex "message" "queueing by message count"
15068 This option limits the number of delivery processes that Exim starts
15069 automatically when receiving messages via SMTP, whether via the daemon or by
15070 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15071 and the number of messages received in a single SMTP session exceeds this
15072 number, subsequent messages are placed on the queue, but no delivery processes
15073 are started. This helps to limit the number of Exim processes when a server
15074 restarts after downtime and there is a lot of mail waiting for it on other
15075 systems. On large systems, the default should probably be increased, and on
15076 dial-in client systems it should probably be set to zero (that is, disabled).
15077
15078
15079 .option smtp_accept_reserve main integer 0
15080 .cindex "SMTP" "incoming call count"
15081 .cindex "host" "reserved"
15082 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15083 number of SMTP connections that are reserved for connections from the hosts
15084 that are specified in &%smtp_reserve_hosts%&. The value set in
15085 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15086 restricted to this number of connections; the option specifies a minimum number
15087 of connection slots for them, not a maximum. It is a guarantee that this group
15088 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15089 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15090 individual host.
15091
15092 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15093 set to 5, once there are 45 active connections (from any hosts), new
15094 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15095 provided the other criteria for acceptance are met.
15096
15097
15098 .option smtp_active_hostname main string&!! unset
15099 .cindex "host" "name in SMTP responses"
15100 .cindex "SMTP" "host name in responses"
15101 .vindex "&$primary_hostname$&"
15102 This option is provided for multi-homed servers that want to masquerade as
15103 several different hosts. At the start of an incoming SMTP connection, its value
15104 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15105 responses. For example, it is used as domain name in the response to an
15106 incoming HELO or EHLO command.
15107
15108 .vindex "&$smtp_active_hostname$&"
15109 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15110 is saved with any messages that are received. It is therefore available for use
15111 in routers and transports when the message is later delivered.
15112
15113 If this option is unset, or if its expansion is forced to fail, or if the
15114 expansion results in an empty string, the value of &$primary_hostname$& is
15115 used. Other expansion failures cause a message to be written to the main and
15116 panic logs, and the SMTP command receives a temporary error. Typically, the
15117 value of &%smtp_active_hostname%& depends on the incoming interface address.
15118 For example:
15119 .code
15120 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15121   {cox.mydomain}{box.mydomain}}
15122 .endd
15123
15124 Although &$smtp_active_hostname$& is primarily concerned with incoming
15125 messages, it is also used as the default for HELO commands in callout
15126 verification if there is no remote transport from which to obtain a
15127 &%helo_data%& value.
15128
15129 .option smtp_banner main string&!! "see below"
15130 .cindex "SMTP" "welcome banner"
15131 .cindex "banner for SMTP"
15132 .cindex "welcome banner for SMTP"
15133 .cindex "customizing" "SMTP banner"
15134 This string, which is expanded every time it is used, is output as the initial
15135 positive response to an SMTP connection. The default setting is:
15136 .code
15137 smtp_banner = $smtp_active_hostname ESMTP Exim \
15138   $version_number $tod_full
15139 .endd
15140 Failure to expand the string causes a panic error. If you want to create a
15141 multiline response to the initial SMTP connection, use &"\n"& in the string at
15142 appropriate points, but not at the end. Note that the 220 code is not included
15143 in this string. Exim adds it automatically (several times in the case of a
15144 multiline response).
15145
15146
15147 .option smtp_check_spool_space main boolean true
15148 .cindex "checking disk space"
15149 .cindex "disk space, checking"
15150 .cindex "spool directory" "checking space"
15151 When this option is set, if an incoming SMTP session encounters the SIZE
15152 option on a MAIL command, it checks that there is enough space in the
15153 spool directory's partition to accept a message of that size, while still
15154 leaving free the amount specified by &%check_spool_space%& (even if that value
15155 is zero). If there isn't enough space, a temporary error code is returned.
15156
15157
15158 .option smtp_connect_backlog main integer 20
15159 .cindex "connection backlog"
15160 .cindex "SMTP" "connection backlog"
15161 .cindex "backlog of connections"
15162 This option specifies a maximum number of waiting SMTP connections. Exim passes
15163 this value to the TCP/IP system when it sets up its listener. Once this number
15164 of connections are waiting for the daemon's attention, subsequent connection
15165 attempts are refused at the TCP/IP level. At least, that is what the manuals
15166 say; in some circumstances such connection attempts have been observed to time
15167 out instead. For large systems it is probably a good idea to increase the
15168 value (to 50, say). It also gives some protection against denial-of-service
15169 attacks by SYN flooding.
15170
15171
15172 .option smtp_enforce_sync main boolean true
15173 .cindex "SMTP" "synchronization checking"
15174 .cindex "synchronization checking in SMTP"
15175 The SMTP protocol specification requires the client to wait for a response from
15176 the server at certain points in the dialogue. Without PIPELINING these
15177 synchronization points are after every command; with PIPELINING they are
15178 fewer, but they still exist.
15179
15180 Some spamming sites send out a complete set of SMTP commands without waiting
15181 for any response. Exim protects against this by rejecting a message if the
15182 client has sent further input when it should not have. The error response &"554
15183 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15184 for this error cannot be perfect because of transmission delays (unexpected
15185 input may be on its way but not yet received when Exim checks). However, it
15186 does detect many instances.
15187
15188 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15189 If you want to disable the check selectively (for example, only for certain
15190 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15191 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15192
15193
15194
15195 .option smtp_etrn_command main string&!! unset
15196 .cindex "ETRN" "command to be run"
15197 .vindex "&$domain$&"
15198 If this option is set, the given command is run whenever an SMTP ETRN
15199 command is received from a host that is permitted to issue such commands (see
15200 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15201 are independently expanded. The expansion variable &$domain$& is set to the
15202 argument of the ETRN command, and no syntax checking is done on it. For
15203 example:
15204 .code
15205 smtp_etrn_command = /etc/etrn_command $domain \
15206                     $sender_host_address
15207 .endd
15208 A new process is created to run the command, but Exim does not wait for it to
15209 complete. Consequently, its status cannot be checked. If the command cannot be
15210 run, a line is written to the panic log, but the ETRN caller still receives
15211 a 250 success response. Exim is normally running under its own uid when
15212 receiving SMTP, so it is not possible for it to change the uid before running
15213 the command.
15214
15215
15216 .option smtp_etrn_serialize main boolean true
15217 .cindex "ETRN" "serializing"
15218 When this option is set, it prevents the simultaneous execution of more than
15219 one identical command as a result of ETRN in an SMTP connection. See
15220 section &<<SECTETRN>>& for details.
15221
15222
15223 .option smtp_load_reserve main fixed-point unset
15224 .cindex "load average"
15225 If the system load average ever gets higher than this, incoming SMTP calls are
15226 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15227 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15228 the load is over the limit. The option has no effect on ancient operating
15229 systems on which Exim cannot determine the load average. See also
15230 &%deliver_queue_load_max%& and &%queue_only_load%&.
15231
15232
15233
15234 .option smtp_max_synprot_errors main integer 3
15235 .cindex "SMTP" "limiting syntax and protocol errors"
15236 .cindex "limit" "SMTP syntax and protocol errors"
15237 Exim rejects SMTP commands that contain syntax or protocol errors. In
15238 particular, a syntactically invalid email address, as in this command:
15239 .code
15240 RCPT TO:<abc xyz@a.b.c>
15241 .endd
15242 causes immediate rejection of the command, before any other tests are done.
15243 (The ACL cannot be run if there is no valid address to set up for it.) An
15244 example of a protocol error is receiving RCPT before MAIL. If there are
15245 too many syntax or protocol errors in one SMTP session, the connection is
15246 dropped. The limit is set by this option.
15247
15248 .cindex "PIPELINING" "expected errors"
15249 When the PIPELINING extension to SMTP is in use, some protocol errors are
15250 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15251 Exim assumes that PIPELINING will be used if it advertises it (see
15252 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15253 not count towards the limit.
15254
15255
15256
15257 .option smtp_max_unknown_commands main integer 3
15258 .cindex "SMTP" "limiting unknown commands"
15259 .cindex "limit" "unknown SMTP commands"
15260 If there are too many unrecognized commands in an incoming SMTP session, an
15261 Exim server drops the connection. This is a defence against some kinds of abuse
15262 that subvert web
15263 clients
15264 into making connections to SMTP ports; in these circumstances, a number of
15265 non-SMTP command lines are sent first.
15266
15267
15268
15269 .option smtp_ratelimit_hosts main "host list&!!" unset
15270 .cindex "SMTP" "rate limiting"
15271 .cindex "limit" "rate of message arrival"
15272 .cindex "RCPT" "rate limiting"
15273 Some sites find it helpful to be able to limit the rate at which certain hosts
15274 can send them messages, and the rate at which an individual message can specify
15275 recipients.
15276
15277 Exim has two rate-limiting facilities. This section describes the older
15278 facility, which can limit rates within a single connection. The newer
15279 &%ratelimit%& ACL condition can limit rates across all connections. See section
15280 &<<SECTratelimiting>>& for details of the newer facility.
15281
15282 When a host matches &%smtp_ratelimit_hosts%&, the values of
15283 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15284 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15285 respectively. Each option, if set, must contain a set of four comma-separated
15286 values:
15287
15288 .ilist
15289 A threshold, before which there is no rate limiting.
15290 .next
15291 An initial time delay. Unlike other times in Exim, numbers with decimal
15292 fractional parts are allowed here.
15293 .next
15294 A factor by which to increase the delay each time.
15295 .next
15296 A maximum value for the delay. This should normally be less than 5 minutes,
15297 because after that time, the client is liable to timeout the SMTP command.
15298 .endlist
15299
15300 For example, these settings have been used successfully at the site which
15301 first suggested this feature, for controlling mail from their customers:
15302 .code
15303 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15304 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15305 .endd
15306 The first setting specifies delays that are applied to MAIL commands after
15307 two have been received over a single connection. The initial delay is 0.5
15308 seconds, increasing by a factor of 1.05 each time. The second setting applies
15309 delays to RCPT commands when more than four occur in a single message.
15310
15311
15312 .option smtp_ratelimit_mail main string unset
15313 See &%smtp_ratelimit_hosts%& above.
15314
15315
15316 .option smtp_ratelimit_rcpt main string unset
15317 See &%smtp_ratelimit_hosts%& above.
15318
15319
15320 .option smtp_receive_timeout main time 5m
15321 .cindex "timeout" "for SMTP input"
15322 .cindex "SMTP" "input timeout"
15323 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15324 input, including batch SMTP. If a line of input (either an SMTP command or a
15325 data line) is not received within this time, the SMTP connection is dropped and
15326 the message is abandoned.
15327 A line is written to the log containing one of the following messages:
15328 .code
15329 SMTP command timeout on connection from...
15330 SMTP data timeout on connection from...
15331 .endd
15332 The former means that Exim was expecting to read an SMTP command; the latter
15333 means that it was in the DATA phase, reading the contents of a message.
15334
15335
15336 .oindex "&%-os%&"
15337 The value set by this option can be overridden by the
15338 &%-os%& command-line option. A setting of zero time disables the timeout, but
15339 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15340 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15341 timeout is controlled by &%receive_timeout%& and &%-or%&.
15342
15343
15344 .option smtp_reserve_hosts main "host list&!!" unset
15345 This option defines hosts for which SMTP connections are reserved; see
15346 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15347
15348
15349 .option smtp_return_error_details main boolean false
15350 .cindex "SMTP" "details policy failures"
15351 .cindex "policy control" "rejection, returning details"
15352 In the default state, Exim uses bland messages such as
15353 &"Administrative prohibition"& when it rejects SMTP commands for policy
15354 reasons. Many sysadmins like this because it gives away little information
15355 to spammers. However, some other sysadmins who are applying strict checking
15356 policies want to give out much fuller information about failures. Setting
15357 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15358 example, instead of &"Administrative prohibition"&, it might give:
15359 .code
15360 550-Rejected after DATA: '>' missing at end of address:
15361 550 failing address in "From" header is: <user@dom.ain
15362 .endd
15363
15364 .option spamd_address main string "see below"
15365 This option is available when Exim is compiled with the content-scanning
15366 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15367 The default value is
15368 .code
15369 127.0.0.1 783
15370 .endd
15371 See section &<<SECTscanspamass>>& for more details.
15372
15373
15374
15375 .option split_spool_directory main boolean false
15376 .cindex "multiple spool directories"
15377 .cindex "spool directory" "split"
15378 .cindex "directories, multiple"
15379 If this option is set, it causes Exim to split its input directory into 62
15380 subdirectories, each with a single alphanumeric character as its name. The
15381 sixth character of the message id is used to allocate messages to
15382 subdirectories; this is the least significant base-62 digit of the time of
15383 arrival of the message.
15384
15385 Splitting up the spool in this way may provide better performance on systems
15386 where there are long mail queues, by reducing the number of files in any one
15387 directory. The msglog directory is also split up in a similar way to the input
15388 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15389 are still placed in the single directory &_msglog.OLD_&.
15390
15391 It is not necessary to take any special action for existing messages when
15392 changing &%split_spool_directory%&. Exim notices messages that are in the
15393 &"wrong"& place, and continues to process them. If the option is turned off
15394 after a period of being on, the subdirectories will eventually empty and be
15395 automatically deleted.
15396
15397 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15398 changes. Instead of creating a list of all messages in the queue, and then
15399 trying to deliver each one in turn, it constructs a list of those in one
15400 sub-directory and tries to deliver them, before moving on to the next
15401 sub-directory. The sub-directories are processed in a random order. This
15402 spreads out the scanning of the input directories, and uses less memory. It is
15403 particularly beneficial when there are lots of messages on the queue. However,
15404 if &%queue_run_in_order%& is set, none of this new processing happens. The
15405 entire queue has to be scanned and sorted before any deliveries can start.
15406
15407
15408 .option spool_directory main string&!! "set at compile time"
15409 .cindex "spool directory" "path to"
15410 This defines the directory in which Exim keeps its spool, that is, the messages
15411 it is waiting to deliver. The default value is taken from the compile-time
15412 configuration setting, if there is one. If not, this option must be set. The
15413 string is expanded, so it can contain, for example, a reference to
15414 &$primary_hostname$&.
15415
15416 If the spool directory name is fixed on your installation, it is recommended
15417 that you set it at build time rather than from this option, particularly if the
15418 log files are being written to the spool directory (see &%log_file_path%&).
15419 Otherwise log files cannot be used for errors that are detected early on, such
15420 as failures in the configuration file.
15421
15422 By using this option to override the compiled-in path, it is possible to run
15423 tests of Exim without using the standard spool.
15424
15425 .option sqlite_lock_timeout main time 5s
15426 .cindex "sqlite lookup type" "lock timeout"
15427 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15428 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15429
15430 .option strict_acl_vars main boolean false
15431 .cindex "&ACL;" "variables, handling unset"
15432 This option controls what happens if a syntactically valid but undefined ACL
15433 variable is referenced. If it is false (the default), an empty string
15434 is substituted; if it is true, an error is generated. See section
15435 &<<SECTaclvariables>>& for details of ACL variables.
15436
15437 .option strip_excess_angle_brackets main boolean false
15438 .cindex "angle brackets, excess"
15439 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15440 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15441 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15442 passed on to another MTA, the excess angle brackets are not passed on. If this
15443 option is not set, multiple pairs of angle brackets cause a syntax error.
15444
15445
15446 .option strip_trailing_dot main boolean false
15447 .cindex "trailing dot on domain"
15448 .cindex "dot" "trailing on domain"
15449 If this option is set, a trailing dot at the end of a domain in an address is
15450 ignored. If this is in the envelope and the message is passed on to another
15451 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15452 domain causes a syntax error.
15453 However, addresses in header lines are checked only when an ACL requests header
15454 syntax checking.
15455
15456
15457 .option syslog_duplication main boolean true
15458 .cindex "syslog" "duplicate log lines; suppressing"
15459 When Exim is logging to syslog, it writes the log lines for its three
15460 separate logs at different syslog priorities so that they can in principle
15461 be separated on the logging hosts. Some installations do not require this
15462 separation, and in those cases, the duplication of certain log lines is a
15463 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15464 particular log line is written to syslog. For lines that normally go to
15465 both the main log and the reject log, the reject log version (possibly
15466 containing message header lines) is written, at LOG_NOTICE priority.
15467 Lines that normally go to both the main and the panic log are written at
15468 the LOG_ALERT priority.
15469
15470
15471 .option syslog_facility main string unset
15472 .cindex "syslog" "facility; setting"
15473 This option sets the syslog &"facility"& name, used when Exim is logging to
15474 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15475 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15476 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15477 details of Exim's logging.
15478
15479
15480
15481 .option syslog_processname main string &`exim`&
15482 .cindex "syslog" "process name; setting"
15483 This option sets the syslog &"ident"& name, used when Exim is logging to
15484 syslog. The value must be no longer than 32 characters. See chapter
15485 &<<CHAPlog>>& for details of Exim's logging.
15486
15487
15488
15489 .option syslog_timestamp main boolean true
15490 .cindex "syslog" "timestamps"
15491 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15492 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15493 details of Exim's logging.
15494
15495
15496 .option system_filter main string&!! unset
15497 .cindex "filter" "system filter"
15498 .cindex "system filter" "specifying"
15499 .cindex "Sieve filter" "not available for system filter"
15500 This option specifies an Exim filter file that is applied to all messages at
15501 the start of each delivery attempt, before any routing is done. System filters
15502 must be Exim filters; they cannot be Sieve filters. If the system filter
15503 generates any deliveries to files or pipes, or any new mail messages, the
15504 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15505 which transports are to be used. Details of this facility are given in chapter
15506 &<<CHAPsystemfilter>>&.
15507
15508
15509 .option system_filter_directory_transport main string&!! unset
15510 .vindex "&$address_file$&"
15511 This sets the name of the transport driver that is to be used when the
15512 &%save%& command in a system message filter specifies a path ending in &"/"&,
15513 implying delivery of each message into a separate file in some directory.
15514 During the delivery, the variable &$address_file$& contains the path name.
15515
15516
15517 .option system_filter_file_transport main string&!! unset
15518 .cindex "file" "transport for system filter"
15519 This sets the name of the transport driver that is to be used when the &%save%&
15520 command in a system message filter specifies a path not ending in &"/"&. During
15521 the delivery, the variable &$address_file$& contains the path name.
15522
15523 .option system_filter_group main string unset
15524 .cindex "gid (group id)" "system filter"
15525 This option is used only when &%system_filter_user%& is also set. It sets the
15526 gid under which the system filter is run, overriding any gid that is associated
15527 with the user. The value may be numerical or symbolic.
15528
15529 .option system_filter_pipe_transport main string&!! unset
15530 .cindex "&(pipe)& transport" "for system filter"
15531 .vindex "&$address_pipe$&"
15532 This specifies the transport driver that is to be used when a &%pipe%& command
15533 is used in a system filter. During the delivery, the variable &$address_pipe$&
15534 contains the pipe command.
15535
15536
15537 .option system_filter_reply_transport main string&!! unset
15538 .cindex "&(autoreply)& transport" "for system filter"
15539 This specifies the transport driver that is to be used when a &%mail%& command
15540 is used in a system filter.
15541
15542
15543 .option system_filter_user main string unset
15544 .cindex "uid (user id)" "system filter"
15545 If this option is set to root, the system filter is run in the main Exim
15546 delivery process, as root.  Otherwise, the system filter runs in a separate
15547 process, as the given user, defaulting to the Exim run-time user.
15548 Unless the string consists entirely of digits, it
15549 is looked up in the password data. Failure to find the named user causes a
15550 configuration error. The gid is either taken from the password data, or
15551 specified by &%system_filter_group%&. When the uid is specified numerically,
15552 &%system_filter_group%& is required to be set.
15553
15554 If the system filter generates any pipe, file, or reply deliveries, the uid
15555 under which the filter is run is used when transporting them, unless a
15556 transport option overrides.
15557
15558
15559 .option tcp_nodelay main boolean true
15560 .cindex "daemon" "TCP_NODELAY on sockets"
15561 .cindex "Nagle algorithm"
15562 .cindex "TCP_NODELAY on listening sockets"
15563 If this option is set false, it stops the Exim daemon setting the
15564 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15565 turns off the &"Nagle algorithm"&, which is a way of improving network
15566 performance in interactive (character-by-character) situations. Turning it off
15567 should improve Exim's performance a bit, so that is what happens by default.
15568 However, it appears that some broken clients cannot cope, and time out. Hence
15569 this option. It affects only those sockets that are set up for listening by the
15570 daemon. Sockets created by the smtp transport for delivering mail always set
15571 TCP_NODELAY.
15572
15573
15574 .option timeout_frozen_after main time 0s
15575 .cindex "frozen messages" "timing out"
15576 .cindex "timeout" "frozen messages"
15577 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15578 message of any kind that has been on the queue for longer than the given time
15579 is automatically cancelled at the next queue run. If the frozen message is a
15580 bounce message, it is just discarded; otherwise, a bounce is sent to the
15581 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15582 If you want to timeout frozen bounce messages earlier than other kinds of
15583 frozen message, see &%ignore_bounce_errors_after%&.
15584
15585 &*Note:*& the default value of zero means no timeouts; with this setting,
15586 frozen messages remain on the queue forever (except for any frozen bounce
15587 messages that are released by &%ignore_bounce_errors_after%&).
15588
15589
15590 .option timezone main string unset
15591 .cindex "timezone, setting"
15592 The value of &%timezone%& is used to set the environment variable TZ while
15593 running Exim (if it is different on entry). This ensures that all timestamps
15594 created by Exim are in the required timezone. If you want all your timestamps
15595 to be in UTC (aka GMT) you should set
15596 .code
15597 timezone = UTC
15598 .endd
15599 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15600 or, if that is not set, from the value of the TZ environment variable when Exim
15601 is built. If &%timezone%& is set to the empty string, either at build or run
15602 time, any existing TZ variable is removed from the environment when Exim
15603 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15604 unfortunately not all, operating systems.
15605
15606
15607 .option tls_advertise_hosts main "host list&!!" unset
15608 .cindex "TLS" "advertising"
15609 .cindex "encryption" "on SMTP connection"
15610 .cindex "SMTP" "encrypted connection"
15611 When Exim is built with support for TLS encrypted connections, the availability
15612 of the STARTTLS command to set up an encrypted session is advertised in
15613 response to EHLO only to those client hosts that match this option. See
15614 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15615
15616
15617 .option tls_certificate main string&!! unset
15618 .cindex "TLS" "server certificate; location of"
15619 .cindex "certificate" "server, location of"
15620 The value of this option is expanded, and must then be the absolute path to a
15621 file which contains the server's certificates. The server's private key is also
15622 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15623 &<<CHAPTLS>>& for further details.
15624
15625 &*Note*&: The certificates defined by this option are used only when Exim is
15626 receiving incoming messages as a server. If you want to supply certificates for
15627 use when sending messages as a client, you must set the &%tls_certificate%&
15628 option in the relevant &(smtp)& transport.
15629
15630 If the option contains &$tls_sni$& and Exim is built against OpenSSL, then
15631 if the OpenSSL build supports TLS extensions and the TLS client sends the
15632 Server Name Indication extension, then this option and others documented in
15633 &<<SECTtlssni>>& will be re-expanded.
15634
15635 .option tls_crl main string&!! unset
15636 .cindex "TLS" "server certificate revocation list"
15637 .cindex "certificate" "revocation list for server"
15638 This option specifies a certificate revocation list. The expanded value must
15639 be the name of a file that contains a CRL in PEM format.
15640
15641 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15642
15643
15644 .option tls_dh_max_bits main integer 2236
15645 .cindex "TLS" "D-H bit count"
15646 The number of bits used for Diffie-Hellman key-exchange may be suggested by
15647 the chosen TLS library.  That value might prove to be too high for
15648 interoperability.  This option provides a maximum clamp on the value
15649 suggested, trading off security for interoperability.
15650
15651 The value must be at least 1024.
15652
15653 The value 2236 was chosen because, at time of adding the option, it was the
15654 hard-coded maximum value supported by the NSS cryptographic library, as used
15655 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
15656
15657 If you prefer more security and are willing to break some clients, raise this
15658 number.
15659
15660 Note that the value passed to GnuTLS for *generating* a new prime may be a
15661 little less than this figure, because GnuTLS is inexact and may produce a
15662 larger prime than requested.
15663
15664
15665 .option tls_dhparam main string&!! unset
15666 .cindex "TLS" "D-H parameters for server"
15667 The value of this option is expanded and indicates the source of DH parameters
15668 to be used by Exim.
15669
15670 If it is a filename starting with a &`/`&, then it names a file from which DH
15671 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
15672 PKCS#3 representation of the DH prime.  If the file does not exist, for
15673 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
15674 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
15675 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
15676 and treated as though the &%tls_dhparam%& were set to "none".
15677
15678 If this option expands to the string "none", then no DH parameters will be
15679 loaded by Exim.
15680
15681 If this option expands to the string "historic" and Exim is using GnuTLS, then
15682 Exim will attempt to load a file from inside the spool directory.  If the file
15683 does not exist, Exim will attempt to create it.
15684 See section &<<SECTgnutlsparam>>& for further details.
15685
15686 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
15687 a default DH prime; the default is the 2048 bit prime described in section
15688 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
15689 in IKE is assigned number 23.
15690
15691 Otherwise, the option must expand to the name used by Exim for any of a number
15692 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
15693 "ike" followed by the number used by IKE, of "default" which corresponds to
15694 "ike23".
15695
15696 The available primes are:
15697 &`ike1`&, &`ike2`&, &`ike5`&,
15698 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
15699 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
15700
15701 Some of these will be too small to be accepted by clients.
15702 Some may be too large to be accepted by clients.
15703
15704
15705 .option tls_on_connect_ports main "string list" unset
15706 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15707 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15708 set up without waiting for the client to issue a STARTTLS command. For
15709 further details, see section &<<SECTsupobssmt>>&.
15710
15711
15712
15713 .option tls_privatekey main string&!! unset
15714 .cindex "TLS" "server private key; location of"
15715 The value of this option is expanded, and must then be the absolute path to a
15716 file which contains the server's private key. If this option is unset, or if
15717 the expansion is forced to fail, or the result is an empty string, the private
15718 key is assumed to be in the same file as the server's certificates. See chapter
15719 &<<CHAPTLS>>& for further details.
15720
15721 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15722
15723
15724 .option tls_remember_esmtp main boolean false
15725 .cindex "TLS" "esmtp state; remembering"
15726 .cindex "TLS" "broken clients"
15727 If this option is set true, Exim violates the RFCs by remembering that it is in
15728 &"esmtp"& state after successfully negotiating a TLS session. This provides
15729 support for broken clients that fail to send a new EHLO after starting a
15730 TLS session.
15731
15732
15733 .option tls_require_ciphers main string&!! unset
15734 .cindex "TLS" "requiring specific ciphers"
15735 .cindex "cipher" "requiring specific"
15736 This option controls which ciphers can be used for incoming TLS connections.
15737 The &(smtp)& transport has an option of the same name for controlling outgoing
15738 connections. This option is expanded for each connection, so can be varied for
15739 different clients if required. The value of this option must be a list of
15740 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15741 in somewhat different ways. If GnuTLS is being used, the client controls the
15742 preference order of the available ciphers. Details are given in sections
15743 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15744
15745
15746 .option tls_try_verify_hosts main "host list&!!" unset
15747 .cindex "TLS" "client certificate verification"
15748 .cindex "certificate" "verification of client"
15749 See &%tls_verify_hosts%& below.
15750
15751
15752 .option tls_verify_certificates main string&!! unset
15753 .cindex "TLS" "client certificate verification"
15754 .cindex "certificate" "verification of client"
15755 The value of this option is expanded, and must then be the absolute path to
15756 a file containing permitted certificates for clients that
15757 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15758 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15759 directory containing certificate files. This does not work with GnuTLS; the
15760 option must be set to the name of a single file if you are using GnuTLS.
15761
15762 These certificates should be for the certificate authorities trusted, rather
15763 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
15764 the value is a file then the certificates are sent by Exim as a server to
15765 connecting clients, defining the list of accepted certificate authorities.
15766 Thus the values defined should be considered public data.  To avoid this,
15767 use OpenSSL with a directory.
15768
15769 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15770
15771
15772 .option tls_verify_hosts main "host list&!!" unset
15773 .cindex "TLS" "client certificate verification"
15774 .cindex "certificate" "verification of client"
15775 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15776 certificates from clients. The expected certificates are defined by
15777 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15778 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15779 &%tls_verify_certificates%& is not set.
15780
15781 Any client that matches &%tls_verify_hosts%& is constrained by
15782 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15783 present one of the listed certificates. If it does not, the connection is
15784 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15785 the host to use TLS. It can still send SMTP commands through unencrypted
15786 connections. Forcing a client to use TLS has to be done separately using an
15787 ACL to reject inappropriate commands when the connection is not encrypted.
15788
15789 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15790 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15791 certificate and checks it against &%tls_verify_certificates%&, but does not
15792 abort the connection if there is no certificate or if it does not match. This
15793 state can be detected in an ACL, which makes it possible to implement policies
15794 such as &"accept for relay only if a verified certificate has been received,
15795 but accept for local delivery if encrypted, even without a verified
15796 certificate"&.
15797
15798 Client hosts that match neither of these lists are not asked to present
15799 certificates.
15800
15801
15802 .option trusted_groups main "string list&!!" unset
15803 .cindex "trusted groups"
15804 .cindex "groups" "trusted"
15805 This option is expanded just once, at the start of Exim's processing. If this
15806 option is set, any process that is running in one of the listed groups, or
15807 which has one of them as a supplementary group, is trusted. The groups can be
15808 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15809 details of what trusted callers are permitted to do. If neither
15810 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15811 are trusted.
15812
15813 .option trusted_users main "string list&!!" unset
15814 .cindex "trusted users"
15815 .cindex "user" "trusted"
15816 This option is expanded just once, at the start of Exim's processing. If this
15817 option is set, any process that is running as one of the listed users is
15818 trusted. The users can be specified numerically or by name. See section
15819 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15820 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15821 Exim user are trusted.
15822
15823 .option unknown_login main string&!! unset
15824 .cindex "uid (user id)" "unknown caller"
15825 .vindex "&$caller_uid$&"
15826 This is a specialized feature for use in unusual configurations. By default, if
15827 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15828 gives up. The &%unknown_login%& option can be used to set a login name to be
15829 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15830 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15831 is used for the user's real name (gecos field), unless this has been set by the
15832 &%-F%& option.
15833
15834 .option unknown_username main string unset
15835 See &%unknown_login%&.
15836
15837 .option untrusted_set_sender main "address list&!!" unset
15838 .cindex "trusted users"
15839 .cindex "sender" "setting by untrusted user"
15840 .cindex "untrusted user setting sender"
15841 .cindex "user" "untrusted setting sender"
15842 .cindex "envelope sender"
15843 When an untrusted user submits a message to Exim using the standard input, Exim
15844 normally creates an envelope sender address from the user's login and the
15845 default qualification domain. Data from the &%-f%& option (for setting envelope
15846 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15847 is used) is ignored.
15848
15849 However, untrusted users are permitted to set an empty envelope sender address,
15850 to declare that a message should never generate any bounces. For example:
15851 .code
15852 exim -f '<>' user@domain.example
15853 .endd
15854 .vindex "&$sender_ident$&"
15855 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15856 other envelope sender addresses in a controlled way. When it is set, untrusted
15857 users are allowed to set envelope sender addresses that match any of the
15858 patterns in the list. Like all address lists, the string is expanded. The
15859 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15860 users to setting senders that start with their login ids
15861 followed by a hyphen
15862 by a setting like this:
15863 .code
15864 untrusted_set_sender = ^$sender_ident-
15865 .endd
15866 If you want to allow untrusted users to set envelope sender addresses without
15867 restriction, you can use
15868 .code
15869 untrusted_set_sender = *
15870 .endd
15871 The &%untrusted_set_sender%& option applies to all forms of local input, but
15872 only to the setting of the envelope sender. It does not permit untrusted users
15873 to use the other options which trusted user can use to override message
15874 parameters. Furthermore, it does not stop Exim from removing an existing
15875 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15876 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15877 overriding these actions. The handling of the &'Sender:'& header is also
15878 described in section &<<SECTthesenhea>>&.
15879
15880 The log line for a message's arrival shows the envelope sender following
15881 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15882 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15883 envelope sender address, the user's login is shown in parentheses after the
15884 sender address.
15885
15886
15887 .option uucp_from_pattern main string "see below"
15888 .cindex "&""From""& line"
15889 .cindex "UUCP" "&""From""& line"
15890 Some applications that pass messages to an MTA via a command line interface use
15891 an initial line starting with &"From&~"& to pass the envelope sender. In
15892 particular, this is used by UUCP software. Exim recognizes such a line by means
15893 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15894 matches, the sender address is constructed by expanding the contents of
15895 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15896 default pattern recognizes lines in the following two forms:
15897 .code
15898 From ph10 Fri Jan  5 12:35 GMT 1996
15899 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15900 .endd
15901 The pattern can be seen by running
15902 .code
15903 exim -bP uucp_from_pattern
15904 .endd
15905 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15906 year in the second case. The first word after &"From&~"& is matched in the
15907 regular expression by a parenthesized subpattern. The default value for
15908 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15909 (&"ph10"& in the example above) as the message's sender. See also
15910 &%ignore_fromline_hosts%&.
15911
15912
15913 .option uucp_from_sender main string&!! &`$1`&
15914 See &%uucp_from_pattern%& above.
15915
15916
15917 .option warn_message_file main string unset
15918 .cindex "warning of delay" "customizing the message"
15919 .cindex "customizing" "warning message"
15920 This option defines a template file containing paragraphs of text to be used
15921 for constructing the warning message which is sent by Exim when a message has
15922 been on the queue for a specified amount of time, as specified by
15923 &%delay_warning%&. Details of the file's contents are given in chapter
15924 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15925
15926
15927 .option write_rejectlog main boolean true
15928 .cindex "reject log" "disabling"
15929 If this option is set false, Exim no longer writes anything to the reject log.
15930 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15931 .ecindex IIDconfima
15932 .ecindex IIDmaiconf
15933
15934
15935
15936
15937 . ////////////////////////////////////////////////////////////////////////////
15938 . ////////////////////////////////////////////////////////////////////////////
15939
15940 .chapter "Generic options for routers" "CHAProutergeneric"
15941 .scindex IIDgenoprou1 "options" "generic; for routers"
15942 .scindex IIDgenoprou2 "generic options" "router"
15943 This chapter describes the generic options that apply to all routers.
15944 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15945
15946 For a general description of how a router operates, see sections
15947 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15948 which the preconditions are tested. The order of expansion of the options that
15949 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15950 &%headers_remove%&, &%transport%&.
15951
15952
15953
15954 .option address_data routers string&!! unset
15955 .cindex "router" "data attached to address"
15956 The string is expanded just before the router is run, that is, after all the
15957 precondition tests have succeeded. If the expansion is forced to fail, the
15958 router declines, the value of &%address_data%& remains unchanged, and the
15959 &%more%& option controls what happens next. Other expansion failures cause
15960 delivery of the address to be deferred.
15961
15962 .vindex "&$address_data$&"
15963 When the expansion succeeds, the value is retained with the address, and can be
15964 accessed using the variable &$address_data$& in the current router, subsequent
15965 routers, and the eventual transport.
15966
15967 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15968 that runs a user's filter file, the contents of &$address_data$& are accessible
15969 in the filter. This is not normally a problem, because such data is usually
15970 either not confidential or it &"belongs"& to the current user, but if you do
15971 put confidential data into &$address_data$& you need to remember this point.
15972
15973 Even if the router declines or passes, the value of &$address_data$& remains
15974 with the address, though it can be changed by another &%address_data%& setting
15975 on a subsequent router. If a router generates child addresses, the value of
15976 &$address_data$& propagates to them. This also applies to the special kind of
15977 &"child"& that is generated by a router with the &%unseen%& option.
15978
15979 The idea of &%address_data%& is that you can use it to look up a lot of data
15980 for the address once, and then pick out parts of the data later. For example,
15981 you could use a single LDAP lookup to return a string of the form
15982 .code
15983 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15984 .endd
15985 In the transport you could pick out the mailbox by a setting such as
15986 .code
15987 file = ${extract{mailbox}{$address_data}}
15988 .endd
15989 This makes the configuration file less messy, and also reduces the number of
15990 lookups (though Exim does cache lookups).
15991
15992 .vindex "&$sender_address_data$&"
15993 .vindex "&$address_data$&"
15994 The &%address_data%& facility is also useful as a means of passing information
15995 from one router to another, and from a router to a transport. In addition, if
15996 &$address_data$& is set by a router when verifying a recipient address from an
15997 ACL, it remains available for use in the rest of the ACL statement. After
15998 verifying a sender, the value is transferred to &$sender_address_data$&.
15999
16000
16001
16002 .option address_test routers&!? boolean true
16003 .oindex "&%-bt%&"
16004 .cindex "router" "skipping when address testing"
16005 If this option is set false, the router is skipped when routing is being tested
16006 by means of the &%-bt%& command line option. This can be a convenience when
16007 your first router sends messages to an external scanner, because it saves you
16008 having to set the &"already scanned"& indicator when testing real address
16009 routing.
16010
16011
16012
16013 .option cannot_route_message routers string&!! unset
16014 .cindex "router" "customizing &""cannot route""& message"
16015 .cindex "customizing" "&""cannot route""& message"
16016 This option specifies a text message that is used when an address cannot be
16017 routed because Exim has run out of routers. The default message is
16018 &"Unrouteable address"&. This option is useful only on routers that have
16019 &%more%& set false, or on the very last router in a configuration, because the
16020 value that is used is taken from the last router that is considered. This
16021 includes a router that is skipped because its preconditions are not met, as
16022 well as a router that declines. For example, using the default configuration,
16023 you could put:
16024 .code
16025 cannot_route_message = Remote domain not found in DNS
16026 .endd
16027 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16028 and
16029 .code
16030 cannot_route_message = Unknown local user
16031 .endd
16032 on the final router that checks for local users. If string expansion fails for
16033 this option, the default message is used. Unless the expansion failure was
16034 explicitly forced, a message about the failure is written to the main and panic
16035 logs, in addition to the normal message about the routing failure.
16036
16037
16038 .option caseful_local_part routers boolean false
16039 .cindex "case of local parts"
16040 .cindex "router" "case of local parts"
16041 By default, routers handle the local parts of addresses in a case-insensitive
16042 manner, though the actual case is preserved for transmission with the message.
16043 If you want the case of letters to be significant in a router, you must set
16044 this option true. For individual router options that contain address or local
16045 part lists (for example, &%local_parts%&), case-sensitive matching can be
16046 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16047 more details.
16048
16049 .vindex "&$local_part$&"
16050 .vindex "&$original_local_part$&"
16051 .vindex "&$parent_local_part$&"
16052 The value of the &$local_part$& variable is forced to lower case while a
16053 router is running unless &%caseful_local_part%& is set. When a router assigns
16054 an address to a transport, the value of &$local_part$& when the transport runs
16055 is the same as it was in the router. Similarly, when a router generates child
16056 addresses by aliasing or forwarding, the values of &$original_local_part$&
16057 and &$parent_local_part$& are those that were used by the redirecting router.
16058
16059 This option applies to the processing of an address by a router. When a
16060 recipient address is being processed in an ACL, there is a separate &%control%&
16061 modifier that can be used to specify case-sensitive processing within the ACL
16062 (see section &<<SECTcontrols>>&).
16063
16064
16065
16066 .option check_local_user routers&!? boolean false
16067 .cindex "local user, checking in router"
16068 .cindex "router" "checking for local user"
16069 .cindex "&_/etc/passwd_&"
16070 .vindex "&$home$&"
16071 When this option is true, Exim checks that the local part of the recipient
16072 address (with affixes removed if relevant) is the name of an account on the
16073 local system. The check is done by calling the &[getpwnam()]& function rather
16074 than trying to read &_/etc/passwd_& directly. This means that other methods of
16075 holding password data (such as NIS) are supported. If the local part is a local
16076 user, &$home$& is set from the password data, and can be tested in other
16077 preconditions that are evaluated after this one (the order of evaluation is
16078 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16079 overridden by &%router_home_directory%&. If the local part is not a local user,
16080 the router is skipped.
16081
16082 If you want to check that the local part is either the name of a local user
16083 or matches something else, you cannot combine &%check_local_user%& with a
16084 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16085 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16086 setting to achieve this. For example:
16087 .code
16088 local_parts = passwd;$local_part : lsearch;/etc/other/users
16089 .endd
16090 Note, however, that the side effects of &%check_local_user%& (such as setting
16091 up a home directory) do not occur when a &(passwd)& lookup is used in a
16092 &%local_parts%& (or any other) precondition.
16093
16094
16095
16096 .option condition routers&!? string&!! unset
16097 .cindex "router" "customized precondition"
16098 This option specifies a general precondition test that has to succeed for the
16099 router to be called. The &%condition%& option is the last precondition to be
16100 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16101 result is a forced failure, or an empty string, or one of the strings &"0"& or
16102 &"no"& or &"false"& (checked without regard to the case of the letters), the
16103 router is skipped, and the address is offered to the next one.
16104
16105 If the result is any other value, the router is run (as this is the last
16106 precondition to be evaluated, all the other preconditions must be true).
16107
16108 This option is unique in that multiple &%condition%& options may be present.
16109 All &%condition%& options must succeed.
16110
16111 The &%condition%& option provides a means of applying custom conditions to the
16112 running of routers. Note that in the case of a simple conditional expansion,
16113 the default expansion values are exactly what is wanted. For example:
16114 .code
16115 condition = ${if >{$message_age}{600}}
16116 .endd
16117 Because of the default behaviour of the string expansion, this is equivalent to
16118 .code
16119 condition = ${if >{$message_age}{600}{true}{}}
16120 .endd
16121
16122 A multiple condition example, which succeeds:
16123 .code
16124 condition = ${if >{$message_age}{600}}
16125 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16126 condition = foobar
16127 .endd
16128
16129 If the expansion fails (other than forced failure) delivery is deferred. Some
16130 of the other precondition options are common special cases that could in fact
16131 be specified using &%condition%&.
16132
16133
16134 .option debug_print routers string&!! unset
16135 .cindex "testing" "variables in drivers"
16136 If this option is set and debugging is enabled (see the &%-d%& command line
16137 option), the string is expanded and included in the debugging output.
16138 If expansion of the string fails, the error message is written to the debugging
16139 output, and Exim carries on processing.
16140 This option is provided to help with checking out the values of variables and
16141 so on when debugging router configurations. For example, if a &%condition%&
16142 option appears not to be working, &%debug_print%& can be used to output the
16143 variables it references. The output happens after checks for &%domains%&,
16144 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16145 are tested. A newline is added to the text if it does not end with one.
16146
16147
16148
16149 .option disable_logging routers boolean false
16150 If this option is set true, nothing is logged for any routing errors
16151 or for any deliveries caused by this router. You should not set this option
16152 unless you really, really know what you are doing. See also the generic
16153 transport option of the same name.
16154
16155
16156 .option domains routers&!? "domain list&!!" unset
16157 .cindex "router" "restricting to specific domains"
16158 .vindex "&$domain_data$&"
16159 If this option is set, the router is skipped unless the current domain matches
16160 the list. If the match is achieved by means of a file lookup, the data that the
16161 lookup returned for the domain is placed in &$domain_data$& for use in string
16162 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16163 a list of the order in which preconditions are evaluated.
16164
16165
16166
16167 .option driver routers string unset
16168 This option must always be set. It specifies which of the available routers is
16169 to be used.
16170
16171
16172
16173 .option errors_to routers string&!! unset
16174 .cindex "envelope sender"
16175 .cindex "router" "changing address for errors"
16176 If a router successfully handles an address, it may assign the address to a
16177 transport for delivery or it may generate child addresses. In both cases, if
16178 there is a delivery problem during later processing, the resulting bounce
16179 message is sent to the address that results from expanding this string,
16180 provided that the address verifies successfully. The &%errors_to%& option is
16181 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16182
16183 The &%errors_to%& setting associated with an address can be overridden if it
16184 subsequently passes through other routers that have their own &%errors_to%&
16185 settings, or if the message is delivered by a transport with a &%return_path%&
16186 setting.
16187
16188 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16189 the expansion fails to verify, the errors address associated with the incoming
16190 address is used. At top level, this is the envelope sender. A non-forced
16191 expansion failure causes delivery to be deferred.
16192
16193 If an address for which &%errors_to%& has been set ends up being delivered over
16194 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16195 any bounces that are generated by other MTAs on the delivery route are also
16196 sent there. You can set &%errors_to%& to the empty string by either of these
16197 settings:
16198 .code
16199 errors_to =
16200 errors_to = ""
16201 .endd
16202 An expansion item that yields an empty string has the same effect. If you do
16203 this, a locally detected delivery error for addresses processed by this router
16204 no longer gives rise to a bounce message; the error is discarded. If the
16205 address is delivered to a remote host, the return path is set to &`<>`&, unless
16206 overridden by the &%return_path%& option on the transport.
16207
16208 .vindex "&$address_data$&"
16209 If for some reason you want to discard local errors, but use a non-empty
16210 MAIL command for remote delivery, you can preserve the original return
16211 path in &$address_data$& in the router, and reinstate it in the transport by
16212 setting &%return_path%&.
16213
16214 The most common use of &%errors_to%& is to direct mailing list bounces to the
16215 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16216 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16217
16218
16219
16220 .option expn routers&!? boolean true
16221 .cindex "address" "testing"
16222 .cindex "testing" "addresses"
16223 .cindex "EXPN" "router skipping"
16224 .cindex "router" "skipping for EXPN"
16225 If this option is turned off, the router is skipped when testing an address
16226 as a result of processing an SMTP EXPN command. You might, for example,
16227 want to turn it off on a router for users' &_.forward_& files, while leaving it
16228 on for the system alias file.
16229 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16230 are evaluated.
16231
16232 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16233 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16234 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16235
16236
16237
16238 .option fail_verify routers boolean false
16239 .cindex "router" "forcing verification failure"
16240 Setting this option has the effect of setting both &%fail_verify_sender%& and
16241 &%fail_verify_recipient%& to the same value.
16242
16243
16244
16245 .option fail_verify_recipient routers boolean false
16246 If this option is true and an address is accepted by this router when
16247 verifying a recipient, verification fails.
16248
16249
16250
16251 .option fail_verify_sender routers boolean false
16252 If this option is true and an address is accepted by this router when
16253 verifying a sender, verification fails.
16254
16255
16256
16257 .option fallback_hosts routers "string list" unset
16258 .cindex "router" "fallback hosts"
16259 .cindex "fallback" "hosts specified on router"
16260 String expansion is not applied to this option. The argument must be a
16261 colon-separated list of host names or IP addresses. The list separator can be
16262 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16263 each name or address. In fact, the format of each item is exactly the same as
16264 defined for the list of hosts in a &(manualroute)& router (see section
16265 &<<SECTformatonehostitem>>&).
16266
16267 If a router queues an address for a remote transport, this host list is
16268 associated with the address, and used instead of the transport's fallback host
16269 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16270 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16271 transport for further details.
16272
16273
16274 .option group routers string&!! "see below"
16275 .cindex "gid (group id)" "local delivery"
16276 .cindex "local transports" "uid and gid"
16277 .cindex "transport" "local"
16278 .cindex "router" "setting group"
16279 When a router queues an address for a transport, and the transport does not
16280 specify a group, the group given here is used when running the delivery
16281 process.
16282 The group may be specified numerically or by name. If expansion fails, the
16283 error is logged and delivery is deferred.
16284 The default is unset, unless &%check_local_user%& is set, when the default
16285 is taken from the password information. See also &%initgroups%& and &%user%&
16286 and the discussion in chapter &<<CHAPenvironment>>&.
16287
16288
16289
16290 .option headers_add routers string&!! unset
16291 .cindex "header lines" "adding"
16292 .cindex "router" "adding header lines"
16293 This option specifies a string of text that is expanded at routing time, and
16294 associated with any addresses that are accepted by the router. However, this
16295 option has no effect when an address is just being verified. The way in which
16296 the text is used to add header lines at transport time is described in section
16297 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16298 message is in the process of being transported. This means that references to
16299 header lines in string expansions in the transport's configuration do not
16300 &"see"& the added header lines.
16301
16302 The &%headers_add%& option is expanded after &%errors_to%&, but before
16303 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16304 the expansion is forced to fail, the option has no effect. Other expansion
16305 failures are treated as configuration errors.
16306
16307 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16308 router that has the &%one_time%& option set.
16309
16310 .cindex "duplicate addresses"
16311 .oindex "&%unseen%&"
16312 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16313 additions are deleted when the address is passed on to subsequent routers.
16314 For a &%redirect%& router, if a generated address is the same as the incoming
16315 address, this can lead to duplicate addresses with different header
16316 modifications. Exim does not do duplicate deliveries (except, in certain
16317 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16318 which of the duplicates is discarded, so this ambiguous situation should be
16319 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16320
16321
16322
16323 .option headers_remove routers string&!! unset
16324 .cindex "header lines" "removing"
16325 .cindex "router" "removing header lines"
16326 This option specifies a string of text that is expanded at routing time, and
16327 associated with any addresses that are accepted by the router. However, this
16328 option has no effect when an address is just being verified. The way in which
16329 the text is used to remove header lines at transport time is described in
16330 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16331 the message is in the process of being transported. This means that references
16332 to header lines in string expansions in the transport's configuration still
16333 &"see"& the original header lines.
16334
16335 The &%headers_remove%& option is expanded after &%errors_to%& and
16336 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16337 the option has no effect. Other expansion failures are treated as configuration
16338 errors.
16339
16340 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16341 router that has the &%one_time%& option set.
16342
16343 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16344 removal requests are deleted when the address is passed on to subsequent
16345 routers, and this can lead to problems with duplicates -- see the similar
16346 warning for &%headers_add%& above.
16347
16348
16349 .option ignore_target_hosts routers "host list&!!" unset
16350 .cindex "IP address" "discarding"
16351 .cindex "router" "discarding IP addresses"
16352 Although this option is a host list, it should normally contain IP address
16353 entries rather than names. If any host that is looked up by the router has an
16354 IP address that matches an item in this list, Exim behaves as if that IP
16355 address did not exist. This option allows you to cope with rogue DNS entries
16356 like
16357 .code
16358 remote.domain.example.  A  127.0.0.1
16359 .endd
16360 by setting
16361 .code
16362 ignore_target_hosts = 127.0.0.1
16363 .endd
16364 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16365 discarded in this way, the router declines. In a conventional configuration, an
16366 attempt to mail to such a domain would normally provoke the &"unrouteable
16367 domain"& error, and an attempt to verify an address in the domain would fail.
16368 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16369 router declines if presented with one of the listed addresses.
16370
16371 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16372 means of the first or the second of the following settings, respectively:
16373 .code
16374 ignore_target_hosts = 0.0.0.0/0
16375 ignore_target_hosts = <; 0::0/0
16376 .endd
16377 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16378 in the second line matches all IPv6 addresses.
16379
16380 This option may also be useful for ignoring link-local and site-local IPv6
16381 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16382 is expanded before use as a list, it is possible to make it dependent on the
16383 domain that is being routed.
16384
16385 .vindex "&$host_address$&"
16386 During its expansion, &$host_address$& is set to the IP address that is being
16387 checked.
16388
16389 .option initgroups routers boolean false
16390 .cindex "additional groups"
16391 .cindex "groups" "additional"
16392 .cindex "local transports" "uid and gid"
16393 .cindex "transport" "local"
16394 If the router queues an address for a transport, and this option is true, and
16395 the uid supplied by the router is not overridden by the transport, the
16396 &[initgroups()]& function is called when running the transport to ensure that
16397 any additional groups associated with the uid are set up. See also &%group%&
16398 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16399
16400
16401
16402 .option local_part_prefix routers&!? "string list" unset
16403 .cindex "router" "prefix for local part"
16404 .cindex "prefix" "for local part, used in router"
16405 If this option is set, the router is skipped unless the local part starts with
16406 one of the given strings, or &%local_part_prefix_optional%& is true. See
16407 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16408 evaluated.
16409
16410 The list is scanned from left to right, and the first prefix that matches is
16411 used. A limited form of wildcard is available; if the prefix begins with an
16412 asterisk, it matches the longest possible sequence of arbitrary characters at
16413 the start of the local part. An asterisk should therefore always be followed by
16414 some character that does not occur in normal local parts.
16415 .cindex "multiple mailboxes"
16416 .cindex "mailbox" "multiple"
16417 Wildcarding can be used to set up multiple user mailboxes, as described in
16418 section &<<SECTmulbox>>&.
16419
16420 .vindex "&$local_part$&"
16421 .vindex "&$local_part_prefix$&"
16422 During the testing of the &%local_parts%& option, and while the router is
16423 running, the prefix is removed from the local part, and is available in the
16424 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16425 the router accepts the address, this remains true during subsequent delivery by
16426 a transport. In particular, the local part that is transmitted in the RCPT
16427 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16428 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16429 the relevant transport.
16430
16431 When an address is being verified, &%local_part_prefix%& affects only the
16432 behaviour of the router. If the callout feature of verification is in use, this
16433 means that the full address, including the prefix, will be used during the
16434 callout.
16435
16436 The prefix facility is commonly used to handle local parts of the form
16437 &%owner-something%&. Another common use is to support local parts of the form
16438 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16439 to tell a user their forwarding is broken &-- by placing a router like this one
16440 immediately before the router that handles &_.forward_& files:
16441 .code
16442 real_localuser:
16443   driver = accept
16444   local_part_prefix = real-
16445   check_local_user
16446   transport = local_delivery
16447 .endd
16448 For security, it would probably be a good idea to restrict the use of this
16449 router to locally-generated messages, using a condition such as this:
16450 .code
16451   condition = ${if match {$sender_host_address}\
16452                          {\N^(|127\.0\.0\.1)$\N}}
16453 .endd
16454
16455 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16456 both conditions must be met if not optional. Care must be taken if wildcards
16457 are used in both a prefix and a suffix on the same router. Different
16458 separator characters must be used to avoid ambiguity.
16459
16460
16461 .option local_part_prefix_optional routers boolean false
16462 See &%local_part_prefix%& above.
16463
16464
16465
16466 .option local_part_suffix routers&!? "string list" unset
16467 .cindex "router" "suffix for local part"
16468 .cindex "suffix for local part" "used in router"
16469 This option operates in the same way as &%local_part_prefix%&, except that the
16470 local part must end (rather than start) with the given string, the
16471 &%local_part_suffix_optional%& option determines whether the suffix is
16472 mandatory, and the wildcard * character, if present, must be the last
16473 character of the suffix. This option facility is commonly used to handle local
16474 parts of the form &%something-request%& and multiple user mailboxes of the form
16475 &%username-foo%&.
16476
16477
16478 .option local_part_suffix_optional routers boolean false
16479 See &%local_part_suffix%& above.
16480
16481
16482
16483 .option local_parts routers&!? "local part list&!!" unset
16484 .cindex "router" "restricting to specific local parts"
16485 .cindex "local part" "checking in router"
16486 The router is run only if the local part of the address matches the list.
16487 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16488 are evaluated, and
16489 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16490 string is expanded, it is possible to make it depend on the domain, for
16491 example:
16492 .code
16493 local_parts = dbm;/usr/local/specials/$domain
16494 .endd
16495 .vindex "&$local_part_data$&"
16496 If the match is achieved by a lookup, the data that the lookup returned
16497 for the local part is placed in the variable &$local_part_data$& for use in
16498 expansions of the router's private options. You might use this option, for
16499 example, if you have a large number of local virtual domains, and you want to
16500 send all postmaster mail to the same place without having to set up an alias in
16501 each virtual domain:
16502 .code
16503 postmaster:
16504   driver = redirect
16505   local_parts = postmaster
16506   data = postmaster@real.domain.example
16507 .endd
16508
16509
16510 .option log_as_local routers boolean "see below"
16511 .cindex "log" "delivery line"
16512 .cindex "delivery" "log line format"
16513 Exim has two logging styles for delivery, the idea being to make local
16514 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16515 recipient address is given just as the local part, without a domain. The use of
16516 this style is controlled by this option. It defaults to true for the &(accept)&
16517 router, and false for all the others. This option applies only when a
16518 router assigns an address to a transport. It has no effect on routers that
16519 redirect addresses.
16520
16521
16522
16523 .option more routers boolean&!! true
16524 The result of string expansion for this option must be a valid boolean value,
16525 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16526 result causes an error, and delivery is deferred. If the expansion is forced to
16527 fail, the default value for the option (true) is used. Other failures cause
16528 delivery to be deferred.
16529
16530 If this option is set false, and the router declines to handle the address, no
16531 further routers are tried, routing fails, and the address is bounced.
16532 .oindex "&%self%&"
16533 However, if the router explicitly passes an address to the following router by
16534 means of the setting
16535 .code
16536 self = pass
16537 .endd
16538 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16539 does not affect the behaviour if one of the precondition tests fails. In that
16540 case, the address is always passed to the next router.
16541
16542 Note that &%address_data%& is not considered to be a precondition. If its
16543 expansion is forced to fail, the router declines, and the value of &%more%&
16544 controls what happens next.
16545
16546
16547 .option pass_on_timeout routers boolean false
16548 .cindex "timeout" "of router"
16549 .cindex "router" "timeout"
16550 If a router times out during a host lookup, it normally causes deferral of the
16551 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16552 router, overriding &%no_more%&. This may be helpful for systems that are
16553 intermittently connected to the Internet, or those that want to pass to a smart
16554 host any messages that cannot immediately be delivered.
16555
16556 There are occasional other temporary errors that can occur while doing DNS
16557 lookups. They are treated in the same way as a timeout, and this option
16558 applies to all of them.
16559
16560
16561
16562 .option pass_router routers string unset
16563 .cindex "router" "go to after &""pass""&"
16564 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16565 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16566 routing to continue, and overriding a false setting of &%more%&. When one of
16567 these routers returns &"pass"&, the address is normally handed on to the next
16568 router in sequence. This can be changed by setting &%pass_router%& to the name
16569 of another router. However (unlike &%redirect_router%&) the named router must
16570 be below the current router, to avoid loops. Note that this option applies only
16571 to the special case of &"pass"&. It does not apply when a router returns
16572 &"decline"& because it cannot handle an address.
16573
16574
16575
16576 .option redirect_router routers string unset
16577 .cindex "router" "start at after redirection"
16578 Sometimes an administrator knows that it is pointless to reprocess addresses
16579 generated from alias or forward files with the same router again. For
16580 example, if an alias file translates real names into login ids there is no
16581 point searching the alias file a second time, especially if it is a large file.
16582
16583 The &%redirect_router%& option can be set to the name of any router instance.
16584 It causes the routing of any generated addresses to start at the named router
16585 instead of at the first router. This option has no effect if the router in
16586 which it is set does not generate new addresses.
16587
16588
16589
16590 .option require_files routers&!? "string list&!!" unset
16591 .cindex "file" "requiring for router"
16592 .cindex "router" "requiring file existence"
16593 This option provides a general mechanism for predicating the running of a
16594 router on the existence or non-existence of certain files or directories.
16595 Before running a router, as one of its precondition tests, Exim works its way
16596 through the &%require_files%& list, expanding each item separately.
16597
16598 Because the list is split before expansion, any colons in expansion items must
16599 be doubled, or the facility for using a different list separator must be used.
16600 If any expansion is forced to fail, the item is ignored. Other expansion
16601 failures cause routing of the address to be deferred.
16602
16603 If any expanded string is empty, it is ignored. Otherwise, except as described
16604 below, each string must be a fully qualified file path, optionally preceded by
16605 &"!"&. The paths are passed to the &[stat()]& function to test for the
16606 existence of the files or directories. The router is skipped if any paths not
16607 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16608
16609 .cindex "NFS"
16610 If &[stat()]& cannot determine whether a file exists or not, delivery of
16611 the message is deferred. This can happen when NFS-mounted filesystems are
16612 unavailable.
16613
16614 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16615 options, so you cannot use it to check for the existence of a file in which to
16616 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16617 full list of the order in which preconditions are evaluated.) However, as
16618 these options are all expanded, you can use the &%exists%& expansion condition
16619 to make such tests. The &%require_files%& option is intended for checking files
16620 that the router may be going to use internally, or which are needed by a
16621 transport (for example &_.procmailrc_&).
16622
16623 During delivery, the &[stat()]& function is run as root, but there is a
16624 facility for some checking of the accessibility of a file by another user.
16625 This is not a proper permissions check, but just a &"rough"& check that
16626 operates as follows:
16627
16628 If an item in a &%require_files%& list does not contain any forward slash
16629 characters, it is taken to be the user (and optional group, separated by a
16630 comma) to be checked for subsequent files in the list. If no group is specified
16631 but the user is specified symbolically, the gid associated with the uid is
16632 used. For example:
16633 .code
16634 require_files = mail:/some/file
16635 require_files = $local_part:$home/.procmailrc
16636 .endd
16637 If a user or group name in a &%require_files%& list does not exist, the
16638 &%require_files%& condition fails.
16639
16640 Exim performs the check by scanning along the components of the file path, and
16641 checking the access for the given uid and gid. It checks for &"x"& access on
16642 directories, and &"r"& access on the final file. Note that this means that file
16643 access control lists, if the operating system has them, are ignored.
16644
16645 &*Warning 1*&: When the router is being run to verify addresses for an
16646 incoming SMTP message, Exim is not running as root, but under its own uid. This
16647 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16648 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16649 user is not permitted to read one of the directories on the file's path.
16650
16651 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16652 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16653 without root access. In this case, if a check for access by a particular user
16654 is requested, Exim creates a subprocess that runs as that user, and tries the
16655 check again in that process.
16656
16657 The default action for handling an unresolved EACCES is to consider it to
16658 be caused by a configuration error, and routing is deferred because the
16659 existence or non-existence of the file cannot be determined. However, in some
16660 circumstances it may be desirable to treat this condition as if the file did
16661 not exist. If the file name (or the exclamation mark that precedes the file
16662 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16663 as if the file did not exist. For example:
16664 .code
16665 require_files = +/some/file
16666 .endd
16667 If the router is not an essential part of verification (for example, it
16668 handles users' &_.forward_& files), another solution is to set the &%verify%&
16669 option false so that the router is skipped when verifying.
16670
16671
16672
16673 .option retry_use_local_part routers boolean "see below"
16674 .cindex "hints database" "retry keys"
16675 .cindex "local part" "in retry keys"
16676 When a delivery suffers a temporary routing failure, a retry record is created
16677 in Exim's hints database. For addresses whose routing depends only on the
16678 domain, the key for the retry record should not involve the local part, but for
16679 other addresses, both the domain and the local part should be included.
16680 Usually, remote routing is of the former kind, and local routing is of the
16681 latter kind.
16682
16683 This option controls whether the local part is used to form the key for retry
16684 hints for addresses that suffer temporary errors while being handled by this
16685 router. The default value is true for any router that has &%check_local_user%&
16686 set, and false otherwise. Note that this option does not apply to hints keys
16687 for transport delays; they are controlled by a generic transport option of the
16688 same name.
16689
16690 The setting of &%retry_use_local_part%& applies only to the router on which it
16691 appears. If the router generates child addresses, they are routed
16692 independently; this setting does not become attached to them.
16693
16694
16695
16696 .option router_home_directory routers string&!! unset
16697 .cindex "router" "home directory for"
16698 .cindex "home directory" "for router"
16699 .vindex "&$home$&"
16700 This option sets a home directory for use while the router is running. (Compare
16701 &%transport_home_directory%&, which sets a home directory for later
16702 transporting.) In particular, if used on a &(redirect)& router, this option
16703 sets a value for &$home$& while a filter is running. The value is expanded;
16704 forced expansion failure causes the option to be ignored &-- other failures
16705 cause the router to defer.
16706
16707 Expansion of &%router_home_directory%& happens immediately after the
16708 &%check_local_user%& test (if configured), before any further expansions take
16709 place.
16710 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16711 are evaluated.)
16712 While the router is running, &%router_home_directory%& overrides the value of
16713 &$home$& that came from &%check_local_user%&.
16714
16715 When a router accepts an address and assigns it to a local transport (including
16716 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16717 delivery), the home directory setting for the transport is taken from the first
16718 of these values that is set:
16719
16720 .ilist
16721 The &%home_directory%& option on the transport;
16722 .next
16723 The &%transport_home_directory%& option on the router;
16724 .next
16725 The password data if &%check_local_user%& is set on the router;
16726 .next
16727 The &%router_home_directory%& option on the router.
16728 .endlist
16729
16730 In other words, &%router_home_directory%& overrides the password data for the
16731 router, but not for the transport.
16732
16733
16734
16735 .option self routers string freeze
16736 .cindex "MX record" "pointing to local host"
16737 .cindex "local host" "MX pointing to"
16738 This option applies to those routers that use a recipient address to find a
16739 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16740 and &(manualroute)& routers.
16741 Certain configurations of the &(queryprogram)& router can also specify a list
16742 of remote hosts.
16743 Usually such routers are configured to send the message to a remote host via an
16744 &(smtp)& transport. The &%self%& option specifies what happens when the first
16745 host on the list turns out to be the local host.
16746 The way in which Exim checks for the local host is described in section
16747 &<<SECTreclocipadd>>&.
16748
16749 Normally this situation indicates either an error in Exim's configuration (for
16750 example, the router should be configured not to process this domain), or an
16751 error in the DNS (for example, the MX should not point to this host). For this
16752 reason, the default action is to log the incident, defer the address, and
16753 freeze the message. The following alternatives are provided for use in special
16754 cases:
16755
16756 .vlist
16757 .vitem &%defer%&
16758 Delivery of the message is tried again later, but the message is not frozen.
16759
16760 .vitem "&%reroute%&: <&'domain'&>"
16761 The domain is changed to the given domain, and the address is passed back to
16762 be reprocessed by the routers. No rewriting of headers takes place. This
16763 behaviour is essentially a redirection.
16764
16765 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16766 The domain is changed to the given domain, and the address is passed back to be
16767 reprocessed by the routers. Any headers that contain the original domain are
16768 rewritten.
16769
16770 .vitem &%pass%&
16771 .oindex "&%more%&"
16772 .vindex "&$self_hostname$&"
16773 The router passes the address to the next router, or to the router named in the
16774 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16775 subsequent routing and delivery, the variable &$self_hostname$& contains the
16776 name of the local host that the router encountered. This can be used to
16777 distinguish between different cases for hosts with multiple names. The
16778 combination
16779 .code
16780 self = pass
16781 no_more
16782 .endd
16783 ensures that only those addresses that routed to the local host are passed on.
16784 Without &%no_more%&, addresses that were declined for other reasons would also
16785 be passed to the next router.
16786
16787 .vitem &%fail%&
16788 Delivery fails and an error report is generated.
16789
16790 .vitem &%send%&
16791 .cindex "local host" "sending to"
16792 The anomaly is ignored and the address is queued for the transport. This
16793 setting should be used with extreme caution. For an &(smtp)& transport, it
16794 makes sense only in cases where the program that is listening on the SMTP port
16795 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16796 different configuration file that handles the domain in another way.
16797 .endlist
16798
16799
16800
16801 .option senders routers&!? "address list&!!" unset
16802 .cindex "router" "checking senders"
16803 If this option is set, the router is skipped unless the message's sender
16804 address matches something on the list.
16805 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16806 are evaluated.
16807
16808 There are issues concerning verification when the running of routers is
16809 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16810 setting, it sets the sender to the null string. When using the &%-bt%& option
16811 to check a configuration file, it is necessary also to use the &%-f%& option to
16812 set an appropriate sender. For incoming mail, the sender is unset when
16813 verifying the sender, but is available when verifying any recipients. If the
16814 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16815 matters.
16816
16817
16818 .option translate_ip_address routers string&!! unset
16819 .cindex "IP address" "translating"
16820 .cindex "packet radio"
16821 .cindex "router" "IP address translation"
16822 There exist some rare networking situations (for example, packet radio) where
16823 it is helpful to be able to translate IP addresses generated by normal routing
16824 mechanisms into other IP addresses, thus performing a kind of manual IP
16825 routing. This should be done only if the normal IP routing of the TCP/IP stack
16826 is inadequate or broken. Because this is an extremely uncommon requirement, the
16827 code to support this option is not included in the Exim binary unless
16828 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16829
16830 .vindex "&$host_address$&"
16831 The &%translate_ip_address%& string is expanded for every IP address generated
16832 by the router, with the generated address set in &$host_address$&. If the
16833 expansion is forced to fail, no action is taken.
16834 For any other expansion error, delivery of the message is deferred.
16835 If the result of the expansion is an IP address, that replaces the original
16836 address; otherwise the result is assumed to be a host name &-- this is looked
16837 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16838 produce one or more replacement IP addresses. For example, to subvert all IP
16839 addresses in some specific networks, this could be added to a router:
16840 .code
16841 translate_ip_address = \
16842   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16843     {$value}fail}}
16844 .endd
16845 The file would contain lines like
16846 .code
16847 10.2.3.128/26    some.host
16848 10.8.4.34/26     10.44.8.15
16849 .endd
16850 You should not make use of this facility unless you really understand what you
16851 are doing.
16852
16853
16854
16855 .option transport routers string&!! unset
16856 This option specifies the transport to be used when a router accepts an address
16857 and sets it up for delivery. A transport is never needed if a router is used
16858 only for verification. The value of the option is expanded at routing time,
16859 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16860 and result must be the name of one of the configured transports. If it is not,
16861 delivery is deferred.
16862
16863 The &%transport%& option is not used by the &(redirect)& router, but it does
16864 have some private options that set up transports for pipe and file deliveries
16865 (see chapter &<<CHAPredirect>>&).
16866
16867
16868
16869 .option transport_current_directory routers string&!! unset
16870 .cindex "current directory for local transport"
16871 This option associates a current directory with any address that is routed
16872 to a local transport. This can happen either because a transport is
16873 explicitly configured for the router, or because it generates a delivery to a
16874 file or a pipe. During the delivery process (that is, at transport time), this
16875 option string is expanded and is set as the current directory, unless
16876 overridden by a setting on the transport.
16877 If the expansion fails for any reason, including forced failure, an error is
16878 logged, and delivery is deferred.
16879 See chapter &<<CHAPenvironment>>& for details of the local delivery
16880 environment.
16881
16882
16883
16884
16885 .option transport_home_directory routers string&!! "see below"
16886 .cindex "home directory" "for local transport"
16887 This option associates a home directory with any address that is routed to a
16888 local transport. This can happen either because a transport is explicitly
16889 configured for the router, or because it generates a delivery to a file or a
16890 pipe. During the delivery process (that is, at transport time), the option
16891 string is expanded and is set as the home directory, unless overridden by a
16892 setting of &%home_directory%& on the transport.
16893 If the expansion fails for any reason, including forced failure, an error is
16894 logged, and delivery is deferred.
16895
16896 If the transport does not specify a home directory, and
16897 &%transport_home_directory%& is not set for the router, the home directory for
16898 the transport is taken from the password data if &%check_local_user%& is set for
16899 the router. Otherwise it is taken from &%router_home_directory%& if that option
16900 is set; if not, no home directory is set for the transport.
16901
16902 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16903 environment.
16904
16905
16906
16907
16908 .option unseen routers boolean&!! false
16909 .cindex "router" "carrying on after success"
16910 The result of string expansion for this option must be a valid boolean value,
16911 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16912 result causes an error, and delivery is deferred. If the expansion is forced to
16913 fail, the default value for the option (false) is used. Other failures cause
16914 delivery to be deferred.
16915
16916 When this option is set true, routing does not cease if the router accepts the
16917 address. Instead, a copy of the incoming address is passed to the next router,
16918 overriding a false setting of &%more%&. There is little point in setting
16919 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16920 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16921 sometimes true and sometimes false).
16922
16923 .cindex "copy of message (&%unseen%& option)"
16924 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16925 qualifier in filter files. It can be used to cause copies of messages to be
16926 delivered to some other destination, while also carrying out a normal delivery.
16927 In effect, the current address is made into a &"parent"& that has two children
16928 &-- one that is delivered as specified by this router, and a clone that goes on
16929 to be routed further. For this reason, &%unseen%& may not be combined with the
16930 &%one_time%& option in a &(redirect)& router.
16931
16932 &*Warning*&: Header lines added to the address (or specified for removal) by
16933 this router or by previous routers affect the &"unseen"& copy of the message
16934 only. The clone that continues to be processed by further routers starts with
16935 no added headers and none specified for removal. For a &%redirect%& router, if
16936 a generated address is the same as the incoming address, this can lead to
16937 duplicate addresses with different header modifications. Exim does not do
16938 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16939 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16940 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16941 &%redirect%& router may be of help.
16942
16943 Unlike the handling of header modifications, any data that was set by the
16944 &%address_data%& option in the current or previous routers &'is'& passed on to
16945 subsequent routers.
16946
16947
16948 .option user routers string&!! "see below"
16949 .cindex "uid (user id)" "local delivery"
16950 .cindex "local transports" "uid and gid"
16951 .cindex "transport" "local"
16952 .cindex "router" "user for filter processing"
16953 .cindex "filter" "user for processing"
16954 When a router queues an address for a transport, and the transport does not
16955 specify a user, the user given here is used when running the delivery process.
16956 The user may be specified numerically or by name. If expansion fails, the
16957 error is logged and delivery is deferred.
16958 This user is also used by the &(redirect)& router when running a filter file.
16959 The default is unset, except when &%check_local_user%& is set. In this case,
16960 the default is taken from the password information. If the user is specified as
16961 a name, and &%group%& is not set, the group associated with the user is used.
16962 See also &%initgroups%& and &%group%& and the discussion in chapter
16963 &<<CHAPenvironment>>&.
16964
16965
16966
16967 .option verify routers&!? boolean true
16968 Setting this option has the effect of setting &%verify_sender%& and
16969 &%verify_recipient%& to the same value.
16970
16971
16972 .option verify_only routers&!? boolean false
16973 .cindex "EXPN" "with &%verify_only%&"
16974 .oindex "&%-bv%&"
16975 .cindex "router" "used only when verifying"
16976 If this option is set, the router is used only when verifying an address or
16977 testing with the &%-bv%& option, not when actually doing a delivery, testing
16978 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16979 restricted to verifying only senders or recipients by means of
16980 &%verify_sender%& and &%verify_recipient%&.
16981
16982 &*Warning*&: When the router is being run to verify addresses for an incoming
16983 SMTP message, Exim is not running as root, but under its own uid. If the router
16984 accesses any files, you need to make sure that they are accessible to the Exim
16985 user or group.
16986
16987
16988 .option verify_recipient routers&!? boolean true
16989 If this option is false, the router is skipped when verifying recipient
16990 addresses
16991 or testing recipient verification using &%-bv%&.
16992 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16993 are evaluated.
16994
16995
16996 .option verify_sender routers&!? boolean true
16997 If this option is false, the router is skipped when verifying sender addresses
16998 or testing sender verification using &%-bvs%&.
16999 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17000 are evaluated.
17001 .ecindex IIDgenoprou1
17002 .ecindex IIDgenoprou2
17003
17004
17005
17006
17007
17008
17009 . ////////////////////////////////////////////////////////////////////////////
17010 . ////////////////////////////////////////////////////////////////////////////
17011
17012 .chapter "The accept router" "CHID4"
17013 .cindex "&(accept)& router"
17014 .cindex "routers" "&(accept)&"
17015 The &(accept)& router has no private options of its own. Unless it is being
17016 used purely for verification (see &%verify_only%&) a transport is required to
17017 be defined by the generic &%transport%& option. If the preconditions that are
17018 specified by generic options are met, the router accepts the address and queues
17019 it for the given transport. The most common use of this router is for setting
17020 up deliveries to local mailboxes. For example:
17021 .code
17022 localusers:
17023   driver = accept
17024   domains = mydomain.example
17025   check_local_user
17026   transport = local_delivery
17027 .endd
17028 The &%domains%& condition in this example checks the domain of the address, and
17029 &%check_local_user%& checks that the local part is the login of a local user.
17030 When both preconditions are met, the &(accept)& router runs, and queues the
17031 address for the &(local_delivery)& transport.
17032
17033
17034
17035
17036
17037
17038 . ////////////////////////////////////////////////////////////////////////////
17039 . ////////////////////////////////////////////////////////////////////////////
17040
17041 .chapter "The dnslookup router" "CHAPdnslookup"
17042 .scindex IIDdnsrou1 "&(dnslookup)& router"
17043 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17044 The &(dnslookup)& router looks up the hosts that handle mail for the
17045 recipient's domain in the DNS. A transport must always be set for this router,
17046 unless &%verify_only%& is set.
17047
17048 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17049 SRV records. If none are found, or if SRV support is not configured,
17050 MX records are looked up. If no MX records exist, address records are sought.
17051 However, &%mx_domains%& can be set to disable the direct use of address
17052 records.
17053
17054 MX records of equal priority are sorted by Exim into a random order. Exim then
17055 looks for address records for the host names obtained from MX or SRV records.
17056 When a host has more than one IP address, they are sorted into a random order,
17057 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17058 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17059 generic option, the router declines.
17060
17061 Unless they have the highest priority (lowest MX value), MX records that point
17062 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17063 are discarded, together with any other MX records of equal or lower priority.
17064
17065 .cindex "MX record" "pointing to local host"
17066 .cindex "local host" "MX pointing to"
17067 .oindex "&%self%&" "in &(dnslookup)& router"
17068 If the host pointed to by the highest priority MX record, or looked up as an
17069 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17070 happens is controlled by the generic &%self%& option.
17071
17072
17073 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17074 There have been problems with DNS servers when SRV records are looked up.
17075 Some mis-behaving servers return a DNS error or timeout when a non-existent
17076 SRV record is sought. Similar problems have in the past been reported for
17077 MX records. The global &%dns_again_means_nonexist%& option can help with this
17078 problem, but it is heavy-handed because it is a global option.
17079
17080 For this reason, there are two options, &%srv_fail_domains%& and
17081 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17082 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17083 an attempt to look up an SRV or MX record causes one of these results, and the
17084 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17085 such record"&. In the case of an SRV lookup, this means that the router
17086 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17087 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17088 case routing fails.
17089
17090
17091 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17092 .cindex "&(dnslookup)& router" "declines"
17093 There are a few cases where a &(dnslookup)& router will decline to accept
17094 an address; if such a router is expected to handle "all remaining non-local
17095 domains", then it is important to set &%no_more%&.
17096
17097 Reasons for a &(dnslookup)& router to decline currently include:
17098 .ilist
17099 The domain does not exist in DNS
17100 .next
17101 The domain exists but the MX record's host part is just "."; this is a common
17102 convention (borrowed from SRV) used to indicate that there is no such service
17103 for this domain and to not fall back to trying A/AAAA records.
17104 .next
17105 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17106 .next
17107 MX record points to a non-existent host.
17108 .next
17109 MX record points to an IP address and the main section option
17110 &%allow_mx_to_ip%& is not set.
17111 .next
17112 MX records exist and point to valid hosts, but all hosts resolve only to
17113 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17114 .next
17115 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17116 &%dns_check_names_pattern%& for handling one variant of this)
17117 .next
17118 &%check_secondary_mx%& is set on this router but the local host can
17119 not be found in the MX records (see below)
17120 .endlist
17121
17122
17123
17124
17125 .section "Private options for dnslookup" "SECID118"
17126 .cindex "options" "&(dnslookup)& router"
17127 The private options for the &(dnslookup)& router are as follows:
17128
17129 .option check_secondary_mx dnslookup boolean false
17130 .cindex "MX record" "checking for secondary"
17131 If this option is set, the router declines unless the local host is found in
17132 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17133 process domains for which the local host is a secondary mail exchanger
17134 differently to other domains. The way in which Exim decides whether a host is
17135 the local host is described in section &<<SECTreclocipadd>>&.
17136
17137
17138 .option check_srv dnslookup string&!! unset
17139 .cindex "SRV record" "enabling use of"
17140 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17141 addition to MX and address records. The support is disabled by default. To
17142 enable SRV support, set the &%check_srv%& option to the name of the service
17143 required. For example,
17144 .code
17145 check_srv = smtp
17146 .endd
17147 looks for SRV records that refer to the normal smtp service. The option is
17148 expanded, so the service name can vary from message to message or address
17149 to address. This might be helpful if SRV records are being used for a
17150 submission service. If the expansion is forced to fail, the &%check_srv%&
17151 option is ignored, and the router proceeds to look for MX records in the
17152 normal way.
17153
17154 When the expansion succeeds, the router searches first for SRV records for
17155 the given service (it assumes TCP protocol). A single SRV record with a
17156 host name that consists of just a single dot indicates &"no such service for
17157 this domain"&; if this is encountered, the router declines. If other kinds of
17158 SRV record are found, they are used to construct a host list for delivery
17159 according to the rules of RFC 2782. MX records are not sought in this case.
17160
17161 When no SRV records are found, MX records (and address records) are sought in
17162 the traditional way. In other words, SRV records take precedence over MX
17163 records, just as MX records take precedence over address records. Note that
17164 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17165 defined it. It is apparently believed that MX records are sufficient for email
17166 and that SRV records should not be used for this purpose. However, SRV records
17167 have an additional &"weight"& feature which some people might find useful when
17168 trying to split an SMTP load between hosts of different power.
17169
17170 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17171 when there is a DNS lookup error.
17172
17173
17174
17175 .option mx_domains dnslookup "domain list&!!" unset
17176 .cindex "MX record" "required to exist"
17177 .cindex "SRV record" "required to exist"
17178 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17179 record in order to be recognized. (The name of this option could be improved.)
17180 For example, if all the mail hosts in &'fict.example'& are known to have MX
17181 records, except for those in &'discworld.fict.example'&, you could use this
17182 setting:
17183 .code
17184 mx_domains = ! *.discworld.fict.example : *.fict.example
17185 .endd
17186 This specifies that messages addressed to a domain that matches the list but
17187 has no MX record should be bounced immediately instead of being routed using
17188 the address record.
17189
17190
17191 .option mx_fail_domains dnslookup "domain list&!!" unset
17192 If the DNS lookup for MX records for one of the domains in this list causes a
17193 DNS lookup error, Exim behaves as if no MX records were found. See section
17194 &<<SECTprowitdnsloo>>& for more discussion.
17195
17196
17197
17198
17199 .option qualify_single dnslookup boolean true
17200 .cindex "DNS" "resolver options"
17201 .cindex "DNS" "qualifying single-component names"
17202 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17203 lookups. Typically, but not standardly, this causes the resolver to qualify
17204 single-component names with the default domain. For example, on a machine
17205 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17206 &'thesaurus.ref.example'& inside the resolver. For details of what your
17207 resolver actually does, consult your man pages for &'resolver'& and
17208 &'resolv.conf'&.
17209
17210
17211
17212 .option rewrite_headers dnslookup boolean true
17213 .cindex "rewriting" "header lines"
17214 .cindex "header lines" "rewriting"
17215 If the domain name in the address that is being processed is not fully
17216 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17217 an address is specified as &'dormouse@teaparty'&, the domain might be
17218 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17219 occur as a result of setting the &%widen_domains%& option. If
17220 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17221 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17222 header lines of the message are rewritten with the full domain name.
17223
17224 This option should be turned off only when it is known that no message is
17225 ever going to be sent outside an environment where the abbreviation makes
17226 sense.
17227
17228 When an MX record is looked up in the DNS and matches a wildcard record, name
17229 servers normally return a record containing the name that has been looked up,
17230 making it impossible to detect whether a wildcard was present or not. However,
17231 some name servers have recently been seen to return the wildcard entry. If the
17232 name returned by a DNS lookup begins with an asterisk, it is not used for
17233 header rewriting.
17234
17235
17236 .option same_domain_copy_routing dnslookup boolean false
17237 .cindex "address" "copying routing"
17238 Addresses with the same domain are normally routed by the &(dnslookup)& router
17239 to the same list of hosts. However, this cannot be presumed, because the router
17240 options and preconditions may refer to the local part of the address. By
17241 default, therefore, Exim routes each address in a message independently. DNS
17242 servers run caches, so repeated DNS lookups are not normally expensive, and in
17243 any case, personal messages rarely have more than a few recipients.
17244
17245 If you are running mailing lists with large numbers of subscribers at the same
17246 domain, and you are using a &(dnslookup)& router which is independent of the
17247 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17248 lookups for identical domains in one message. In this case, when &(dnslookup)&
17249 routes an address to a remote transport, any other unrouted addresses in the
17250 message that have the same domain are automatically given the same routing
17251 without processing them independently,
17252 provided the following conditions are met:
17253
17254 .ilist
17255 No router that processed the address specified &%headers_add%& or
17256 &%headers_remove%&.
17257 .next
17258 The router did not change the address in any way, for example, by &"widening"&
17259 the domain.
17260 .endlist
17261
17262
17263
17264
17265 .option search_parents dnslookup boolean false
17266 .cindex "DNS" "resolver options"
17267 When this option is true, the resolver option RES_DNSRCH is set for DNS
17268 lookups. This is different from the &%qualify_single%& option in that it
17269 applies to domains containing dots. Typically, but not standardly, it causes
17270 the resolver to search for the name in the current domain and in parent
17271 domains. For example, on a machine in the &'fict.example'& domain, if looking
17272 up &'teaparty.wonderland'& failed, the resolver would try
17273 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17274 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17275
17276 Setting this option true can cause problems in domains that have a wildcard MX
17277 record, because any domain that does not have its own MX record matches the
17278 local wildcard.
17279
17280
17281
17282 .option srv_fail_domains dnslookup "domain list&!!" unset
17283 If the DNS lookup for SRV records for one of the domains in this list causes a
17284 DNS lookup error, Exim behaves as if no SRV records were found. See section
17285 &<<SECTprowitdnsloo>>& for more discussion.
17286
17287
17288
17289
17290 .option widen_domains dnslookup "string list" unset
17291 .cindex "domain" "partial; widening"
17292 If a DNS lookup fails and this option is set, each of its strings in turn is
17293 added onto the end of the domain, and the lookup is tried again. For example,
17294 if
17295 .code
17296 widen_domains = fict.example:ref.example
17297 .endd
17298 is set and a lookup of &'klingon.dictionary'& fails,
17299 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17300 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17301 and &%search_parents%& options can cause some widening to be undertaken inside
17302 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17303 when verifying, unless &%rewrite_headers%& is false (not the default).
17304
17305
17306 .section "Effect of qualify_single and search_parents" "SECID119"
17307 When a domain from an envelope recipient is changed by the resolver as a result
17308 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17309 corresponding address in the message's header lines unless &%rewrite_headers%&
17310 is set false. Exim then re-routes the address, using the full domain.
17311
17312 These two options affect only the DNS lookup that takes place inside the router
17313 for the domain of the address that is being routed. They do not affect lookups
17314 such as that implied by
17315 .code
17316 domains = @mx_any
17317 .endd
17318 that may happen while processing a router precondition before the router is
17319 entered. No widening ever takes place for these lookups.
17320 .ecindex IIDdnsrou1
17321 .ecindex IIDdnsrou2
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331 . ////////////////////////////////////////////////////////////////////////////
17332 . ////////////////////////////////////////////////////////////////////////////
17333
17334 .chapter "The ipliteral router" "CHID5"
17335 .cindex "&(ipliteral)& router"
17336 .cindex "domain literal" "routing"
17337 .cindex "routers" "&(ipliteral)&"
17338 This router has no private options. Unless it is being used purely for
17339 verification (see &%verify_only%&) a transport is required to be defined by the
17340 generic &%transport%& option. The router accepts the address if its domain part
17341 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17342 router handles the address
17343 .code
17344 root@[192.168.1.1]
17345 .endd
17346 by setting up delivery to the host with that IP address. IPv4 domain literals
17347 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17348 are similar, but the address is preceded by &`ipv6:`&. For example:
17349 .code
17350 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17351 .endd
17352 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17353 grounds that sooner or later somebody will try it.
17354
17355 .oindex "&%self%&" "in &(ipliteral)& router"
17356 If the IP address matches something in &%ignore_target_hosts%&, the router
17357 declines. If an IP literal turns out to refer to the local host, the generic
17358 &%self%& option determines what happens.
17359
17360 The RFCs require support for domain literals; however, their use is
17361 controversial in today's Internet. If you want to use this router, you must
17362 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17363 Exim will not recognize the domain literal syntax in addresses.
17364
17365
17366
17367 . ////////////////////////////////////////////////////////////////////////////
17368 . ////////////////////////////////////////////////////////////////////////////
17369
17370 .chapter "The iplookup router" "CHID6"
17371 .cindex "&(iplookup)& router"
17372 .cindex "routers" "&(iplookup)&"
17373 The &(iplookup)& router was written to fulfil a specific requirement in
17374 Cambridge University (which in fact no longer exists). For this reason, it is
17375 not included in the binary of Exim by default. If you want to include it, you
17376 must set
17377 .code
17378 ROUTER_IPLOOKUP=yes
17379 .endd
17380 in your &_Local/Makefile_& configuration file.
17381
17382 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17383 connection to one or more specific hosts. The host can then return the same or
17384 a different address &-- in effect rewriting the recipient address in the
17385 message's envelope. The new address is then passed on to subsequent routers. If
17386 this process fails, the address can be passed on to other routers, or delivery
17387 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17388 must not be specified for it.
17389
17390 .cindex "options" "&(iplookup)& router"
17391 .option hosts iplookup string unset
17392 This option must be supplied. Its value is a colon-separated list of host
17393 names. The hosts are looked up using &[gethostbyname()]&
17394 (or &[getipnodebyname()]& when available)
17395 and are tried in order until one responds to the query. If none respond, what
17396 happens is controlled by &%optional%&.
17397
17398
17399 .option optional iplookup boolean false
17400 If &%optional%& is true, if no response is obtained from any host, the address
17401 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17402 delivery to the address is deferred.
17403
17404
17405 .option port iplookup integer 0
17406 .cindex "port" "&(iplookup)& router"
17407 This option must be supplied. It specifies the port number for the TCP or UDP
17408 call.
17409
17410
17411 .option protocol iplookup string udp
17412 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17413 protocols is to be used.
17414
17415
17416 .option query iplookup string&!! "see below"
17417 This defines the content of the query that is sent to the remote hosts. The
17418 default value is:
17419 .code
17420 $local_part@$domain $local_part@$domain
17421 .endd
17422 The repetition serves as a way of checking that a response is to the correct
17423 query in the default case (see &%response_pattern%& below).
17424
17425
17426 .option reroute iplookup string&!! unset
17427 If this option is not set, the rerouted address is precisely the byte string
17428 returned by the remote host, up to the first white space, if any. If set, the
17429 string is expanded to form the rerouted address. It can include parts matched
17430 in the response by &%response_pattern%& by means of numeric variables such as
17431 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17432 whether or not a pattern is in use. In all cases, the rerouted address must end
17433 up in the form &'local_part@domain'&.
17434
17435
17436 .option response_pattern iplookup string unset
17437 This option can be set to a regular expression that is applied to the string
17438 returned from the remote host. If the pattern does not match the response, the
17439 router declines. If &%response_pattern%& is not set, no checking of the
17440 response is done, unless the query was defaulted, in which case there is a
17441 check that the text returned after the first white space is the original
17442 address. This checks that the answer that has been received is in response to
17443 the correct question. For example, if the response is just a new domain, the
17444 following could be used:
17445 .code
17446 response_pattern = ^([^@]+)$
17447 reroute = $local_part@$1
17448 .endd
17449
17450 .option timeout iplookup time 5s
17451 This specifies the amount of time to wait for a response from the remote
17452 machine. The same timeout is used for the &[connect()]& function for a TCP
17453 call. It does not apply to UDP.
17454
17455
17456
17457
17458 . ////////////////////////////////////////////////////////////////////////////
17459 . ////////////////////////////////////////////////////////////////////////////
17460
17461 .chapter "The manualroute router" "CHID7"
17462 .scindex IIDmanrou1 "&(manualroute)& router"
17463 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17464 .cindex "domain" "manually routing"
17465 The &(manualroute)& router is so-called because it provides a way of manually
17466 routing an address according to its domain. It is mainly used when you want to
17467 route addresses to remote hosts according to your own rules, bypassing the
17468 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17469 route to local transports, a facility that may be useful if you want to save
17470 messages for dial-in hosts in local files.
17471
17472 The &(manualroute)& router compares a list of domain patterns with the domain
17473 it is trying to route. If there is no match, the router declines. Each pattern
17474 has associated with it a list of hosts and some other optional data, which may
17475 include a transport. The combination of a pattern and its data is called a
17476 &"routing rule"&. For patterns that do not have an associated transport, the
17477 generic &%transport%& option must specify a transport, unless the router is
17478 being used purely for verification (see &%verify_only%&).
17479
17480 .vindex "&$host$&"
17481 In the case of verification, matching the domain pattern is sufficient for the
17482 router to accept the address. When actually routing an address for delivery,
17483 an address that matches a domain pattern is queued for the associated
17484 transport. If the transport is not a local one, a host list must be associated
17485 with the pattern; IP addresses are looked up for the hosts, and these are
17486 passed to the transport along with the mail address. For local transports, a
17487 host list is optional. If it is present, it is passed in &$host$& as a single
17488 text string.
17489
17490 The list of routing rules can be provided as an inline string in
17491 &%route_list%&, or the data can be obtained by looking up the domain in a file
17492 or database by setting &%route_data%&. Only one of these settings may appear in
17493 any one instance of &(manualroute)&. The format of routing rules is described
17494 below, following the list of private options.
17495
17496
17497 .section "Private options for manualroute" "SECTprioptman"
17498
17499 .cindex "options" "&(manualroute)& router"
17500 The private options for the &(manualroute)& router are as follows:
17501
17502 .option host_all_ignored manualroute string defer
17503 See &%host_find_failed%&.
17504
17505 .option host_find_failed manualroute string freeze
17506 This option controls what happens when &(manualroute)& tries to find an IP
17507 address for a host, and the host does not exist. The option can be set to one
17508 of the following values:
17509 .code
17510 decline
17511 defer
17512 fail
17513 freeze
17514 ignore
17515 pass
17516 .endd
17517 The default (&"freeze"&) assumes that this state is a serious configuration
17518 error. The difference between &"pass"& and &"decline"& is that the former
17519 forces the address to be passed to the next router (or the router defined by
17520 &%pass_router%&),
17521 .oindex "&%more%&"
17522 overriding &%no_more%&, whereas the latter passes the address to the next
17523 router only if &%more%& is true.
17524
17525 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17526 cannot be found. If all the hosts in the list are ignored, the behaviour is
17527 controlled by the &%host_all_ignored%& option. This takes the same values
17528 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17529
17530 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17531 state; if a host lookup gets a temporary error, delivery is deferred unless the
17532 generic &%pass_on_timeout%& option is set.
17533
17534
17535 .option hosts_randomize manualroute boolean false
17536 .cindex "randomized host list"
17537 .cindex "host" "list of; randomized"
17538 If this option is set, the order of the items in a host list in a routing rule
17539 is randomized each time the list is used, unless an option in the routing rule
17540 overrides (see below). Randomizing the order of a host list can be used to do
17541 crude load sharing. However, if more than one mail address is routed by the
17542 same router to the same host list, the host lists are considered to be the same
17543 (even though they may be randomized into different orders) for the purpose of
17544 deciding whether to batch the deliveries into a single SMTP transaction.
17545
17546 When &%hosts_randomize%& is true, a host list may be split
17547 into groups whose order is separately randomized. This makes it possible to
17548 set up MX-like behaviour. The boundaries between groups are indicated by an
17549 item that is just &`+`& in the host list. For example:
17550 .code
17551 route_list = * host1:host2:host3:+:host4:host5
17552 .endd
17553 The order of the first three hosts and the order of the last two hosts is
17554 randomized for each use, but the first three always end up before the last two.
17555 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17556 randomized host list is passed to an &(smtp)& transport that also has
17557 &%hosts_randomize set%&, the list is not re-randomized.
17558
17559
17560 .option route_data manualroute string&!! unset
17561 If this option is set, it must expand to yield the data part of a routing rule.
17562 Typically, the expansion string includes a lookup based on the domain. For
17563 example:
17564 .code
17565 route_data = ${lookup{$domain}dbm{/etc/routes}}
17566 .endd
17567 If the expansion is forced to fail, or the result is an empty string, the
17568 router declines. Other kinds of expansion failure cause delivery to be
17569 deferred.
17570
17571
17572 .option route_list manualroute "string list" unset
17573 This string is a list of routing rules, in the form defined below. Note that,
17574 unlike most string lists, the items are separated by semicolons. This is so
17575 that they may contain colon-separated host lists.
17576
17577
17578 .option same_domain_copy_routing manualroute boolean false
17579 .cindex "address" "copying routing"
17580 Addresses with the same domain are normally routed by the &(manualroute)&
17581 router to the same list of hosts. However, this cannot be presumed, because the
17582 router options and preconditions may refer to the local part of the address. By
17583 default, therefore, Exim routes each address in a message independently. DNS
17584 servers run caches, so repeated DNS lookups are not normally expensive, and in
17585 any case, personal messages rarely have more than a few recipients.
17586
17587 If you are running mailing lists with large numbers of subscribers at the same
17588 domain, and you are using a &(manualroute)& router which is independent of the
17589 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17590 lookups for identical domains in one message. In this case, when
17591 &(manualroute)& routes an address to a remote transport, any other unrouted
17592 addresses in the message that have the same domain are automatically given the
17593 same routing without processing them independently. However, this is only done
17594 if &%headers_add%& and &%headers_remove%& are unset.
17595
17596
17597
17598
17599 .section "Routing rules in route_list" "SECID120"
17600 The value of &%route_list%& is a string consisting of a sequence of routing
17601 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17602 entered as two semicolons. Alternatively, the list separator can be changed as
17603 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17604 Empty rules are ignored. The format of each rule is
17605 .display
17606 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17607 .endd
17608 The following example contains two rules, each with a simple domain pattern and
17609 no options:
17610 .code
17611 route_list = \
17612   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17613   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17614 .endd
17615 The three parts of a rule are separated by white space. The pattern and the
17616 list of hosts can be enclosed in quotes if necessary, and if they are, the
17617 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17618 single domain pattern, which is the only mandatory item in the rule. The
17619 pattern is in the same format as one item in a domain list (see section
17620 &<<SECTdomainlist>>&),
17621 except that it may not be the name of an interpolated file.
17622 That is, it may be wildcarded, or a regular expression, or a file or database
17623 lookup (with semicolons doubled, because of the use of semicolon as a separator
17624 in a &%route_list%&).
17625
17626 The rules in &%route_list%& are searched in order until one of the patterns
17627 matches the domain that is being routed. The list of hosts and then options are
17628 then used as described below. If there is no match, the router declines. When
17629 &%route_list%& is set, &%route_data%& must not be set.
17630
17631
17632
17633 .section "Routing rules in route_data" "SECID121"
17634 The use of &%route_list%& is convenient when there are only a small number of
17635 routing rules. For larger numbers, it is easier to use a file or database to
17636 hold the routing information, and use the &%route_data%& option instead.
17637 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17638 Most commonly, &%route_data%& is set as a string that contains an
17639 expansion lookup. For example, suppose we place two routing rules in a file
17640 like this:
17641 .code
17642 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17643 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17644 .endd
17645 This data can be accessed by setting
17646 .code
17647 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17648 .endd
17649 Failure of the lookup results in an empty string, causing the router to
17650 decline. However, you do not have to use a lookup in &%route_data%&. The only
17651 requirement is that the result of expanding the string is a list of hosts,
17652 possibly followed by options, separated by white space. The list of hosts must
17653 be enclosed in quotes if it contains white space.
17654
17655
17656
17657
17658 .section "Format of the list of hosts" "SECID122"
17659 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17660 always separately expanded before use. If the expansion fails, the router
17661 declines. The result of the expansion must be a colon-separated list of names
17662 and/or IP addresses, optionally also including ports. The format of each item
17663 in the list is described in the next section. The list separator can be changed
17664 as described in section &<<SECTlistconstruct>>&.
17665
17666 If the list of hosts was obtained from a &%route_list%& item, the following
17667 variables are set during its expansion:
17668
17669 .ilist
17670 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17671 If the domain was matched against a regular expression, the numeric variables
17672 &$1$&, &$2$&, etc. may be set. For example:
17673 .code
17674 route_list = ^domain(\d+)   host-$1.text.example
17675 .endd
17676 .next
17677 &$0$& is always set to the entire domain.
17678 .next
17679 &$1$& is also set when partial matching is done in a file lookup.
17680
17681 .next
17682 .vindex "&$value$&"
17683 If the pattern that matched the domain was a lookup item, the data that was
17684 looked up is available in the expansion variable &$value$&. For example:
17685 .code
17686 route_list = lsearch;;/some/file.routes  $value
17687 .endd
17688 .endlist
17689
17690 Note the doubling of the semicolon in the pattern that is necessary because
17691 semicolon is the default route list separator.
17692
17693
17694
17695 .section "Format of one host item" "SECTformatonehostitem"
17696 Each item in the list of hosts is either a host name or an IP address,
17697 optionally with an attached port number. When no port is given, an IP address
17698 is not enclosed in brackets. When a port is specified, it overrides the port
17699 specification on the transport. The port is separated from the name or address
17700 by a colon. This leads to some complications:
17701
17702 .ilist
17703 Because colon is the default separator for the list of hosts, either
17704 the colon that specifies a port must be doubled, or the list separator must
17705 be changed. The following two examples have the same effect:
17706 .code
17707 route_list = * "host1.tld::1225 : host2.tld::1226"
17708 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17709 .endd
17710 .next
17711 When IPv6 addresses are involved, it gets worse, because they contain
17712 colons of their own. To make this case easier, it is permitted to
17713 enclose an IP address (either v4 or v6) in square brackets if a port
17714 number follows. For example:
17715 .code
17716 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17717 .endd
17718 .endlist
17719
17720 .section "How the list of hosts is used" "SECThostshowused"
17721 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17722 the hosts is tried, in the order specified, when carrying out the SMTP
17723 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17724 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17725 transport.
17726
17727 Hosts may be listed by name or by IP address. An unadorned name in the list of
17728 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17729 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17730 records in the DNS. For example:
17731 .code
17732 route_list = *  x.y.z:p.q.r/MX:e.f.g
17733 .endd
17734 If this feature is used with a port specifier, the port must come last. For
17735 example:
17736 .code
17737 route_list = *  dom1.tld/mx::1225
17738 .endd
17739 If the &%hosts_randomize%& option is set, the order of the items in the list is
17740 randomized before any lookups are done. Exim then scans the list; for any name
17741 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17742 be an interface on the local host and the item is not the first in the list,
17743 Exim discards it and any subsequent items. If it is the first item, what
17744 happens is controlled by the
17745 .oindex "&%self%&" "in &(manualroute)& router"
17746 &%self%& option of the router.
17747
17748 A name on the list that is followed by &`/MX`& is replaced with the list of
17749 hosts obtained by looking up MX records for the name. This is always a DNS
17750 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17751 below) are not relevant here. The order of these hosts is determined by the
17752 preference values in the MX records, according to the usual rules. Because
17753 randomizing happens before the MX lookup, it does not affect the order that is
17754 defined by MX preferences.
17755
17756 If the local host is present in the sublist obtained from MX records, but is
17757 not the most preferred host in that list, it and any equally or less
17758 preferred hosts are removed before the sublist is inserted into the main list.
17759
17760 If the local host is the most preferred host in the MX list, what happens
17761 depends on where in the original list of hosts the &`/MX`& item appears. If it
17762 is not the first item (that is, there are previous hosts in the main list),
17763 Exim discards this name and any subsequent items in the main list.
17764
17765 If the MX item is first in the list of hosts, and the local host is the
17766 most preferred host, what happens is controlled by the &%self%& option of the
17767 router.
17768
17769 DNS failures when lookup up the MX records are treated in the same way as DNS
17770 failures when looking up IP addresses: &%pass_on_timeout%& and
17771 &%host_find_failed%& are used when relevant.
17772
17773 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17774 whether obtained from an MX lookup or not.
17775
17776
17777
17778 .section "How the options are used" "SECThowoptused"
17779 The options are a sequence of words; in practice no more than three are ever
17780 present. One of the words can be the name of a transport; this overrides the
17781 &%transport%& option on the router for this particular routing rule only. The
17782 other words (if present) control randomization of the list of hosts on a
17783 per-rule basis, and how the IP addresses of the hosts are to be found when
17784 routing to a remote transport. These options are as follows:
17785
17786 .ilist
17787 &%randomize%&: randomize the order of the hosts in this list, overriding the
17788 setting of &%hosts_randomize%& for this routing rule only.
17789 .next
17790 &%no_randomize%&: do not randomize the order of the hosts in this list,
17791 overriding the setting of &%hosts_randomize%& for this routing rule only.
17792 .next
17793 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17794 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17795 also look in &_/etc/hosts_& or other sources of information.
17796 .next
17797 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17798 no address records are found. If there is a temporary DNS error (such as a
17799 timeout), delivery is deferred.
17800 .endlist
17801
17802 For example:
17803 .code
17804 route_list = domain1  host1:host2:host3  randomize bydns;\
17805              domain2  host4:host5
17806 .endd
17807 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17808 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17809 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17810 or &[gethostbyname()]&, and the result of the lookup is the result of that
17811 call.
17812
17813 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17814 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17815 instead of TRY_AGAIN. That is why the default action is to try a DNS
17816 lookup first. Only if that gives a definite &"no such host"& is the local
17817 function called.
17818
17819
17820
17821 If no IP address for a host can be found, what happens is controlled by the
17822 &%host_find_failed%& option.
17823
17824 .vindex "&$host$&"
17825 When an address is routed to a local transport, IP addresses are not looked up.
17826 The host list is passed to the transport in the &$host$& variable.
17827
17828
17829
17830 .section "Manualroute examples" "SECID123"
17831 In some of the examples that follow, the presence of the &%remote_smtp%&
17832 transport, as defined in the default configuration file, is assumed:
17833
17834 .ilist
17835 .cindex "smart host" "example router"
17836 The &(manualroute)& router can be used to forward all external mail to a
17837 &'smart host'&. If you have set up, in the main part of the configuration, a
17838 named domain list that contains your local domains, for example:
17839 .code
17840 domainlist local_domains = my.domain.example
17841 .endd
17842 You can arrange for all other domains to be routed to a smart host by making
17843 your first router something like this:
17844 .code
17845 smart_route:
17846   driver = manualroute
17847   domains = !+local_domains
17848   transport = remote_smtp
17849   route_list = * smarthost.ref.example
17850 .endd
17851 This causes all non-local addresses to be sent to the single host
17852 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17853 they are tried in order
17854 (but you can use &%hosts_randomize%& to vary the order each time).
17855 Another way of configuring the same thing is this:
17856 .code
17857 smart_route:
17858   driver = manualroute
17859   transport = remote_smtp
17860   route_list = !+local_domains  smarthost.ref.example
17861 .endd
17862 There is no difference in behaviour between these two routers as they stand.
17863 However, they behave differently if &%no_more%& is added to them. In the first
17864 example, the router is skipped if the domain does not match the &%domains%&
17865 precondition; the following router is always tried. If the router runs, it
17866 always matches the domain and so can never decline. Therefore, &%no_more%&
17867 would have no effect. In the second case, the router is never skipped; it
17868 always runs. However, if it doesn't match the domain, it declines. In this case
17869 &%no_more%& would prevent subsequent routers from running.
17870
17871 .next
17872 .cindex "mail hub example"
17873 A &'mail hub'& is a host which receives mail for a number of domains via MX
17874 records in the DNS and delivers it via its own private routing mechanism. Often
17875 the final destinations are behind a firewall, with the mail hub being the one
17876 machine that can connect to machines both inside and outside the firewall. The
17877 &(manualroute)& router is usually used on a mail hub to route incoming messages
17878 to the correct hosts. For a small number of domains, the routing can be inline,
17879 using the &%route_list%& option, but for a larger number a file or database
17880 lookup is easier to manage.
17881
17882 If the domain names are in fact the names of the machines to which the mail is
17883 to be sent by the mail hub, the configuration can be quite simple. For
17884 example:
17885 .code
17886 hub_route:
17887   driver = manualroute
17888   transport = remote_smtp
17889   route_list = *.rhodes.tvs.example  $domain
17890 .endd
17891 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17892 whose names are the same as the mail domains. A similar approach can be taken
17893 if the host name can be obtained from the domain name by a string manipulation
17894 that the expansion facilities can handle. Otherwise, a lookup based on the
17895 domain can be used to find the host:
17896 .code
17897 through_firewall:
17898   driver = manualroute
17899   transport = remote_smtp
17900   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17901 .endd
17902 The result of the lookup must be the name or IP address of the host (or
17903 hosts) to which the address is to be routed. If the lookup fails, the route
17904 data is empty, causing the router to decline. The address then passes to the
17905 next router.
17906
17907 .next
17908 .cindex "batched SMTP output example"
17909 .cindex "SMTP" "batched outgoing; example"
17910 You can use &(manualroute)& to deliver messages to pipes or files in batched
17911 SMTP format for onward transportation by some other means. This is one way of
17912 storing mail for a dial-up host when it is not connected. The route list entry
17913 can be as simple as a single domain name in a configuration like this:
17914 .code
17915 save_in_file:
17916   driver = manualroute
17917   transport = batchsmtp_appendfile
17918   route_list = saved.domain.example
17919 .endd
17920 though often a pattern is used to pick up more than one domain. If there are
17921 several domains or groups of domains with different transport requirements,
17922 different transports can be listed in the routing information:
17923 .code
17924 save_in_file:
17925   driver = manualroute
17926   route_list = \
17927     *.saved.domain1.example  $domain  batch_appendfile; \
17928     *.saved.domain2.example  \
17929       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17930       batch_pipe
17931 .endd
17932 .vindex "&$domain$&"
17933 .vindex "&$host$&"
17934 The first of these just passes the domain in the &$host$& variable, which
17935 doesn't achieve much (since it is also in &$domain$&), but the second does a
17936 file lookup to find a value to pass, causing the router to decline to handle
17937 the address if the lookup fails.
17938
17939 .next
17940 .cindex "UUCP" "example of router for"
17941 Routing mail directly to UUCP software is a specific case of the use of
17942 &(manualroute)& in a gateway to another mail environment. This is an example of
17943 one way it can be done:
17944 .code
17945 # Transport
17946 uucp:
17947   driver = pipe
17948   user = nobody
17949   command = /usr/local/bin/uux -r - \
17950     ${substr_-5:$host}!rmail ${local_part}
17951   return_fail_output = true
17952
17953 # Router
17954 uucphost:
17955   transport = uucp
17956   driver = manualroute
17957   route_data = \
17958     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17959 .endd
17960 The file &_/usr/local/exim/uucphosts_& contains entries like
17961 .code
17962 darksite.ethereal.example:           darksite.UUCP
17963 .endd
17964 It can be set up more simply without adding and removing &".UUCP"& but this way
17965 makes clear the distinction between the domain name
17966 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17967 .endlist
17968 .ecindex IIDmanrou1
17969 .ecindex IIDmanrou2
17970
17971
17972
17973
17974
17975
17976
17977
17978 . ////////////////////////////////////////////////////////////////////////////
17979 . ////////////////////////////////////////////////////////////////////////////
17980
17981 .chapter "The queryprogram router" "CHAPdriverlast"
17982 .scindex IIDquerou1 "&(queryprogram)& router"
17983 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17984 .cindex "routing" "by external program"
17985 The &(queryprogram)& router routes an address by running an external command
17986 and acting on its output. This is an expensive way to route, and is intended
17987 mainly for use in lightly-loaded systems, or for performing experiments.
17988 However, if it is possible to use the precondition options (&%domains%&,
17989 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17990 be used in special cases, even on a busy host. There are the following private
17991 options:
17992 .cindex "options" "&(queryprogram)& router"
17993
17994 .option command queryprogram string&!! unset
17995 This option must be set. It specifies the command that is to be run. The
17996 command is split up into a command name and arguments, and then each is
17997 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17998 &<<CHAPpipetransport>>&).
17999
18000
18001 .option command_group queryprogram string unset
18002 .cindex "gid (group id)" "in &(queryprogram)& router"
18003 This option specifies a gid to be set when running the command while routing an
18004 address for deliver. It must be set if &%command_user%& specifies a numerical
18005 uid. If it begins with a digit, it is interpreted as the numerical value of the
18006 gid. Otherwise it is looked up using &[getgrnam()]&.
18007
18008
18009 .option command_user queryprogram string unset
18010 .cindex "uid (user id)" "for &(queryprogram)&"
18011 This option must be set. It specifies the uid which is set when running the
18012 command while routing an address for delivery. If the value begins with a digit,
18013 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18014 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18015 not set, a value for the gid also.
18016
18017 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18018 root, which it does during a normal delivery in a conventional configuration.
18019 However, when an address is being verified during message reception, Exim is
18020 usually running as the Exim user, not as root. If the &(queryprogram)& router
18021 is called from a non-root process, Exim cannot change uid or gid before running
18022 the command. In this circumstance the command runs under the current uid and
18023 gid.
18024
18025
18026 .option current_directory queryprogram string /
18027 This option specifies an absolute path which is made the current directory
18028 before running the command.
18029
18030
18031 .option timeout queryprogram time 1h
18032 If the command does not complete within the timeout period, its process group
18033 is killed and the message is frozen. A value of zero time specifies no
18034 timeout.
18035
18036
18037 The standard output of the command is connected to a pipe, which is read when
18038 the command terminates. It should consist of a single line of output,
18039 containing up to five fields, separated by white space. The maximum length of
18040 the line is 1023 characters. Longer lines are silently truncated. The first
18041 field is one of the following words (case-insensitive):
18042
18043 .ilist
18044 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18045 below).
18046 .next
18047 &'Decline'&: the router declines; pass the address to the next router, unless
18048 &%no_more%& is set.
18049 .next
18050 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18051 subsequent text on the line is an error message. If the router is run as part
18052 of address verification during an incoming SMTP message, the message is
18053 included in the SMTP response.
18054 .next
18055 &'Defer'&: routing could not be completed at this time; try again later. Any
18056 subsequent text on the line is an error message which is logged. It is not
18057 included in any SMTP response.
18058 .next
18059 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18060 .next
18061 &'Pass'&: pass the address to the next router (or the router specified by
18062 &%pass_router%&), overriding &%no_more%&.
18063 .next
18064 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18065 new addresses, which are routed independently, starting with the first router,
18066 or the router specified by &%redirect_router%&, if set.
18067 .endlist
18068
18069 When the first word is &'accept'&, the remainder of the line consists of a
18070 number of keyed data values, as follows (split into two lines here, to fit on
18071 the page):
18072 .code
18073 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18074 LOOKUP=byname|bydns DATA=<text>
18075 .endd
18076 The data items can be given in any order, and all are optional. If no transport
18077 is included, the transport specified by the generic &%transport%& option is
18078 used. The list of hosts and the lookup type are needed only if the transport is
18079 an &(smtp)& transport that does not itself supply a list of hosts.
18080
18081 The format of the list of hosts is the same as for the &(manualroute)& router.
18082 As well as host names and IP addresses with optional port numbers, as described
18083 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18084 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18085 (see section &<<SECThostshowused>>&).
18086
18087 If the lookup type is not specified, Exim behaves as follows when trying to
18088 find an IP address for each host: First, a DNS lookup is done. If this yields
18089 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18090 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18091 result of the lookup is the result of that call.
18092
18093 .vindex "&$address_data$&"
18094 If the DATA field is set, its value is placed in the &$address_data$&
18095 variable. For example, this return line
18096 .code
18097 accept hosts=x1.y.example:x2.y.example data="rule1"
18098 .endd
18099 routes the address to the default transport, passing a list of two hosts. When
18100 the transport runs, the string &"rule1"& is in &$address_data$&.
18101 .ecindex IIDquerou1
18102 .ecindex IIDquerou2
18103
18104
18105
18106
18107 . ////////////////////////////////////////////////////////////////////////////
18108 . ////////////////////////////////////////////////////////////////////////////
18109
18110 .chapter "The redirect router" "CHAPredirect"
18111 .scindex IIDredrou1 "&(redirect)& router"
18112 .scindex IIDredrou2 "routers" "&(redirect)&"
18113 .cindex "alias file" "in a &(redirect)& router"
18114 .cindex "address redirection" "&(redirect)& router"
18115 The &(redirect)& router handles several kinds of address redirection. Its most
18116 common uses are for resolving local part aliases from a central alias file
18117 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18118 files, but it has many other potential uses. The incoming address can be
18119 redirected in several different ways:
18120
18121 .ilist
18122 It can be replaced by one or more new addresses which are themselves routed
18123 independently.
18124 .next
18125 It can be routed to be delivered to a given file or directory.
18126 .next
18127 It can be routed to be delivered to a specified pipe command.
18128 .next
18129 It can cause an automatic reply to be generated.
18130 .next
18131 It can be forced to fail, optionally with a custom error message.
18132 .next
18133 It can be temporarily deferred, optionally with a custom message.
18134 .next
18135 It can be discarded.
18136 .endlist
18137
18138 The generic &%transport%& option must not be set for &(redirect)& routers.
18139 However, there are some private options which define transports for delivery to
18140 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18141 &%pipe_transport%& and &%reply_transport%& descriptions below.
18142
18143
18144
18145 .section "Redirection data" "SECID124"
18146 The router operates by interpreting a text string which it obtains either by
18147 expanding the contents of the &%data%& option, or by reading the entire
18148 contents of a file whose name is given in the &%file%& option. These two
18149 options are mutually exclusive. The first is commonly used for handling system
18150 aliases, in a configuration like this:
18151 .code
18152 system_aliases:
18153   driver = redirect
18154   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18155 .endd
18156 If the lookup fails, the expanded string in this example is empty. When the
18157 expansion of &%data%& results in an empty string, the router declines. A forced
18158 expansion failure also causes the router to decline; other expansion failures
18159 cause delivery to be deferred.
18160
18161 A configuration using &%file%& is commonly used for handling users'
18162 &_.forward_& files, like this:
18163 .code
18164 userforward:
18165   driver = redirect
18166   check_local_user
18167   file = $home/.forward
18168   no_verify
18169 .endd
18170 If the file does not exist, or causes no action to be taken (for example, it is
18171 empty or consists only of comments), the router declines. &*Warning*&: This
18172 is not the case when the file contains syntactically valid items that happen to
18173 yield empty addresses, for example, items containing only RFC 2822 address
18174 comments.
18175
18176
18177
18178 .section "Forward files and address verification" "SECID125"
18179 .cindex "address redirection" "while verifying"
18180 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18181 &_.forward_& files, as in the example above. There are two reasons for this:
18182
18183 .ilist
18184 When Exim is receiving an incoming SMTP message from a remote host, it is
18185 running under the Exim uid, not as root. Exim is unable to change uid to read
18186 the file as the user, and it may not be able to read it as the Exim user. So in
18187 practice the router may not be able to operate.
18188 .next
18189 However, even when the router can operate, the existence of a &_.forward_& file
18190 is unimportant when verifying an address. What should be checked is whether the
18191 local part is a valid user name or not. Cutting out the redirection processing
18192 saves some resources.
18193 .endlist
18194
18195
18196
18197
18198
18199
18200 .section "Interpreting redirection data" "SECID126"
18201 .cindex "Sieve filter" "specifying in redirection data"
18202 .cindex "filter" "specifying in redirection data"
18203 The contents of the data string, whether obtained from &%data%& or &%file%&,
18204 can be interpreted in two different ways:
18205
18206 .ilist
18207 If the &%allow_filter%& option is set true, and the data begins with the text
18208 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18209 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18210 respectively. Details of the syntax and semantics of filter files are described
18211 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18212 document is intended for use by end users.
18213 .next
18214 Otherwise, the data must be a comma-separated list of redirection items, as
18215 described in the next section.
18216 .endlist
18217
18218 When a message is redirected to a file (a &"mail folder"&), the file name given
18219 in a non-filter redirection list must always be an absolute path. A filter may
18220 generate a relative path &-- how this is handled depends on the transport's
18221 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18222 for the &(appendfile)& transport.
18223
18224
18225
18226 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18227 .cindex "address redirection" "non-filter list items"
18228 When the redirection data is not an Exim or Sieve filter, for example, if it
18229 comes from a conventional alias or forward file, it consists of a list of
18230 addresses, file names, pipe commands, or certain special items (see section
18231 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18232 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18233 depending on their default values. The items in the list are separated by
18234 commas or newlines.
18235 If a comma is required in an item, the entire item must be enclosed in double
18236 quotes.
18237
18238 Lines starting with a # character are comments, and are ignored, and # may
18239 also appear following a comma, in which case everything between the # and the
18240 next newline character is ignored.
18241
18242 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18243 double quotes are retained because some forms of mail address require their use
18244 (but never to enclose the entire address). In the following description,
18245 &"item"& refers to what remains after any surrounding double quotes have been
18246 removed.
18247
18248 .vindex "&$local_part$&"
18249 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18250 and the expansion contains a reference to &$local_part$&, you should make use
18251 of the &%quote_local_part%& expansion operator, in case the local part contains
18252 special characters. For example, to redirect all mail for the domain
18253 &'obsolete.example'&, retaining the existing local part, you could use this
18254 setting:
18255 .code
18256 data = ${quote_local_part:$local_part}@newdomain.example
18257 .endd
18258
18259
18260 .section "Redirecting to a local mailbox" "SECTredlocmai"
18261 .cindex "routing" "loops in"
18262 .cindex "loop" "while routing, avoidance of"
18263 .cindex "address redirection" "to local mailbox"
18264 A redirection item may safely be the same as the address currently under
18265 consideration. This does not cause a routing loop, because a router is
18266 automatically skipped if any ancestor of the address that is being processed
18267 is the same as the current address and was processed by the current router.
18268 Such an address is therefore passed to the following routers, so it is handled
18269 as if there were no redirection. When making this loop-avoidance test, the
18270 complete local part, including any prefix or suffix, is used.
18271
18272 .cindex "address redirection" "local part without domain"
18273 Specifying the same local part without a domain is a common usage in personal
18274 filter files when the user wants to have messages delivered to the local
18275 mailbox and also forwarded elsewhere. For example, the user whose login is
18276 &'cleo'& might have a &_.forward_& file containing this:
18277 .code
18278 cleo, cleopatra@egypt.example
18279 .endd
18280 .cindex "backslash in alias file"
18281 .cindex "alias file" "backslash in"
18282 For compatibility with other MTAs, such unqualified local parts may be
18283 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18284 it does make a difference if more than one domain is being handled
18285 synonymously.
18286
18287 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18288 2822 address that does not include a domain, the item is qualified using the
18289 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18290 addresses are qualified using the value in &%qualify_recipient%&, but you can
18291 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18292
18293 Care must be taken if there are alias names for local users.
18294 Consider an MTA handling a single local domain where the system alias file
18295 contains:
18296 .code
18297 Sam.Reman: spqr
18298 .endd
18299 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18300 messages in the local mailbox, and also forward copies elsewhere. He creates
18301 this forward file:
18302 .code
18303 Sam.Reman, spqr@reme.elsewhere.example
18304 .endd
18305 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18306 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18307 second time round, because it has previously routed it,
18308 and the following routers presumably cannot handle the alias. The forward file
18309 should really contain
18310 .code
18311 spqr, spqr@reme.elsewhere.example
18312 .endd
18313 but because this is such a common error, the &%check_ancestor%& option (see
18314 below) exists to provide a way to get round it. This is normally set on a
18315 &(redirect)& router that is handling users' &_.forward_& files.
18316
18317
18318
18319 .section "Special items in redirection lists" "SECTspecitredli"
18320 In addition to addresses, the following types of item may appear in redirection
18321 lists (that is, in non-filter redirection data):
18322
18323 .ilist
18324 .cindex "pipe" "in redirection list"
18325 .cindex "address redirection" "to pipe"
18326 An item is treated as a pipe command if it begins with &"|"& and does not parse
18327 as a valid RFC 2822 address that includes a domain. A transport for running the
18328 command must be specified by the &%pipe_transport%& option.
18329 Normally, either the router or the transport specifies a user and a group under
18330 which to run the delivery. The default is to use the Exim user and group.
18331
18332 Single or double quotes can be used for enclosing the individual arguments of
18333 the pipe command; no interpretation of escapes is done for single quotes. If
18334 the command contains a comma character, it is necessary to put the whole item
18335 in double quotes, for example:
18336 .code
18337 "|/some/command ready,steady,go"
18338 .endd
18339 since items in redirection lists are terminated by commas. Do not, however,
18340 quote just the command. An item such as
18341 .code
18342 |"/some/command ready,steady,go"
18343 .endd
18344 is interpreted as a pipe with a rather strange command name, and no arguments.
18345
18346 .next
18347 .cindex "file" "in redirection list"
18348 .cindex "address redirection" "to file"
18349 An item is interpreted as a path name if it begins with &"/"& and does not
18350 parse as a valid RFC 2822 address that includes a domain. For example,
18351 .code
18352 /home/world/minbari
18353 .endd
18354 is treated as a file name, but
18355 .code
18356 /s=molari/o=babylon/@x400gate.way
18357 .endd
18358 is treated as an address. For a file name, a transport must be specified using
18359 the &%file_transport%& option. However, if the generated path name ends with a
18360 forward slash character, it is interpreted as a directory name rather than a
18361 file name, and &%directory_transport%& is used instead.
18362
18363 Normally, either the router or the transport specifies a user and a group under
18364 which to run the delivery. The default is to use the Exim user and group.
18365
18366 .cindex "&_/dev/null_&"
18367 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18368 bypassed at a high level, and the log entry shows &"**bypassed**"&
18369 instead of a transport name. In this case the user and group are not used.
18370
18371 .next
18372 .cindex "included address list"
18373 .cindex "address redirection" "included external list"
18374 If an item is of the form
18375 .code
18376 :include:<path name>
18377 .endd
18378 a list of further items is taken from the given file and included at that
18379 point. &*Note*&: Such a file can not be a filter file; it is just an
18380 out-of-line addition to the list. The items in the included list are separated
18381 by commas or newlines and are not subject to expansion. If this is the first
18382 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18383 the alias name. This example is incorrect:
18384 .code
18385 list1    :include:/opt/lists/list1
18386 .endd
18387 It must be given as
18388 .code
18389 list1:   :include:/opt/lists/list1
18390 .endd
18391 .next
18392 .cindex "address redirection" "to black hole"
18393 Sometimes you want to throw away mail to a particular local part. Making the
18394 &%data%& option expand to an empty string does not work, because that causes
18395 the router to decline. Instead, the alias item
18396 .cindex "black hole"
18397 .cindex "abandoning mail"
18398 &':blackhole:'& can be used. It does what its name implies. No delivery is
18399 done, and no error message is generated. This has the same effect as specifing
18400 &_/dev/null_& as a destination, but it can be independently disabled.
18401
18402 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18403 delivery is done for the original local part, even if other redirection items
18404 are present. If you are generating a multi-item list (for example, by reading a
18405 database) and need the ability to provide a no-op item, you must use
18406 &_/dev/null_&.
18407
18408 .next
18409 .cindex "delivery" "forcing failure"
18410 .cindex "delivery" "forcing deferral"
18411 .cindex "failing delivery" "forcing"
18412 .cindex "deferred delivery, forcing"
18413 .cindex "customizing" "failure message"
18414 An attempt to deliver a particular address can be deferred or forced to fail by
18415 redirection items of the form
18416 .code
18417 :defer:
18418 :fail:
18419 .endd
18420 respectively. When a redirection list contains such an item, it applies
18421 to the entire redirection; any other items in the list are ignored. Any
18422 text following &':fail:'& or &':defer:'& is placed in the error text
18423 associated with the failure. For example, an alias file might contain:
18424 .code
18425 X.Employee:  :fail: Gone away, no forwarding address
18426 .endd
18427 In the case of an address that is being verified from an ACL or as the subject
18428 of a
18429 .cindex "VRFY" "error text, display of"
18430 VRFY command, the text is included in the SMTP error response by
18431 default.
18432 .cindex "EXPN" "error text, display of"
18433 The text is not included in the response to an EXPN command. In non-SMTP cases
18434 the text is included in the error message that Exim generates.
18435
18436 .cindex "SMTP" "error codes"
18437 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18438 &':fail:'&. However, if the message starts with three digits followed by a
18439 space, optionally followed by an extended code of the form &'n.n.n'&, also
18440 followed by a space, and the very first digit is the same as the default error
18441 code, the code from the message is used instead. If the very first digit is
18442 incorrect, a panic error is logged, and the default code is used. You can
18443 suppress the use of the supplied code in a redirect router by setting the
18444 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18445 ignored.
18446
18447 .vindex "&$acl_verify_message$&"
18448 In an ACL, an explicitly provided message overrides the default, but the
18449 default message is available in the variable &$acl_verify_message$& and can
18450 therefore be included in a custom message if this is desired.
18451
18452 Normally the error text is the rest of the redirection list &-- a comma does
18453 not terminate it &-- but a newline does act as a terminator. Newlines are not
18454 normally present in alias expansions. In &(lsearch)& lookups they are removed
18455 as part of the continuation process, but they may exist in other kinds of
18456 lookup and in &':include:'& files.
18457
18458 During routing for message delivery (as opposed to verification), a redirection
18459 containing &':fail:'& causes an immediate failure of the incoming address,
18460 whereas &':defer:'& causes the message to remain on the queue so that a
18461 subsequent delivery attempt can happen at a later time. If an address is
18462 deferred for too long, it will ultimately fail, because the normal retry
18463 rules still apply.
18464
18465 .next
18466 .cindex "alias file" "exception to default"
18467 Sometimes it is useful to use a single-key search type with a default (see
18468 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18469 for exceptions to the default. These can be handled by aliasing them to
18470 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18471 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18472 results in an empty redirection list has the same effect.
18473 .endlist
18474
18475
18476 .section "Duplicate addresses" "SECTdupaddr"
18477 .cindex "duplicate addresses"
18478 .cindex "address duplicate, discarding"
18479 .cindex "pipe" "duplicated"
18480 Exim removes duplicate addresses from the list to which it is delivering, so as
18481 to deliver just one copy to each address. This does not apply to deliveries
18482 routed to pipes by different immediate parent addresses, but an indirect
18483 aliasing scheme of the type
18484 .code
18485 pipe:       |/some/command $local_part
18486 localpart1: pipe
18487 localpart2: pipe
18488 .endd
18489 does not work with a message that is addressed to both local parts, because
18490 when the second is aliased to the intermediate local part &"pipe"& it gets
18491 discarded as being the same as a previously handled address. However, a scheme
18492 such as
18493 .code
18494 localpart1: |/some/command $local_part
18495 localpart2: |/some/command $local_part
18496 .endd
18497 does result in two different pipe deliveries, because the immediate parents of
18498 the pipes are distinct.
18499
18500
18501
18502 .section "Repeated redirection expansion" "SECID128"
18503 .cindex "repeated redirection expansion"
18504 .cindex "address redirection" "repeated for each delivery attempt"
18505 When a message cannot be delivered to all of its recipients immediately,
18506 leading to two or more delivery attempts, redirection expansion is carried out
18507 afresh each time for those addresses whose children were not all previously
18508 delivered. If redirection is being used as a mailing list, this can lead to new
18509 members of the list receiving copies of old messages. The &%one_time%& option
18510 can be used to avoid this.
18511
18512
18513 .section "Errors in redirection lists" "SECID129"
18514 .cindex "address redirection" "errors"
18515 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18516 error is skipped, and an entry is written to the main log. This may be useful
18517 for mailing lists that are automatically managed. Otherwise, if an error is
18518 detected while generating the list of new addresses, the original address is
18519 deferred. See also &%syntax_errors_to%&.
18520
18521
18522
18523 .section "Private options for the redirect router" "SECID130"
18524
18525 .cindex "options" "&(redirect)& router"
18526 The private options for the &(redirect)& router are as follows:
18527
18528
18529 .option allow_defer redirect boolean false
18530 Setting this option allows the use of &':defer:'& in non-filter redirection
18531 data, or the &%defer%& command in an Exim filter file.
18532
18533
18534 .option allow_fail redirect boolean false
18535 .cindex "failing delivery" "from filter"
18536 If this option is true, the &':fail:'& item can be used in a redirection list,
18537 and the &%fail%& command may be used in an Exim filter file.
18538
18539
18540 .option allow_filter redirect boolean false
18541 .cindex "filter" "enabling use of"
18542 .cindex "Sieve filter" "enabling use of"
18543 Setting this option allows Exim to interpret redirection data that starts with
18544 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18545 are some features of Exim filter files that some administrators may wish to
18546 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18547
18548 It is also possible to lock out Exim filters or Sieve filters while allowing
18549 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18550
18551
18552 The filter is run using the uid and gid set by the generic &%user%& and
18553 &%group%& options. These take their defaults from the password data if
18554 &%check_local_user%& is set, so in the normal case of users' personal filter
18555 files, the filter is run as the relevant user. When &%allow_filter%& is set
18556 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18557
18558
18559
18560 .option allow_freeze redirect boolean false
18561 .cindex "freezing messages" "allowing in filter"
18562 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18563 This command is more normally encountered in system filters, and is disabled by
18564 default for redirection filters because it isn't something you usually want to
18565 let ordinary users do.
18566
18567
18568
18569 .option check_ancestor redirect boolean false
18570 This option is concerned with handling generated addresses that are the same
18571 as some address in the list of redirection ancestors of the current address.
18572 Although it is turned off by default in the code, it is set in the default
18573 configuration file for handling users' &_.forward_& files. It is recommended
18574 for this use of the &(redirect)& router.
18575
18576 When &%check_ancestor%& is set, if a generated address (including the domain)
18577 is the same as any ancestor of the current address, it is replaced by a copy of
18578 the current address. This helps in the case where local part A is aliased to B,
18579 and B has a &_.forward_& file pointing back to A. For example, within a single
18580 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18581 &_&~jb/.forward_& contains:
18582 .code
18583 \Joe.Bloggs, <other item(s)>
18584 .endd
18585 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18586 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18587 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18588 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18589 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18590 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18591 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18592 original address. See also the &%repeat_use%& option below.
18593
18594
18595 .option check_group redirect boolean "see below"
18596 When the &%file%& option is used, the group owner of the file is checked only
18597 when this option is set. The permitted groups are those listed in the
18598 &%owngroups%& option, together with the user's default group if
18599 &%check_local_user%& is set. If the file has the wrong group, routing is
18600 deferred. The default setting for this option is true if &%check_local_user%&
18601 is set and the &%modemask%& option permits the group write bit, or if the
18602 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18603
18604
18605
18606 .option check_owner redirect boolean "see below"
18607 When the &%file%& option is used, the owner of the file is checked only when
18608 this option is set. If &%check_local_user%& is set, the local user is
18609 permitted; otherwise the owner must be one of those listed in the &%owners%&
18610 option. The default value for this option is true if &%check_local_user%& or
18611 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18612
18613
18614 .option data redirect string&!! unset
18615 This option is mutually exclusive with &%file%&. One or other of them must be
18616 set, but not both. The contents of &%data%& are expanded, and then used as the
18617 list of forwarding items, or as a set of filtering instructions. If the
18618 expansion is forced to fail, or the result is an empty string or a string that
18619 has no effect (consists entirely of comments), the router declines.
18620
18621 When filtering instructions are used, the string must begin with &"#Exim
18622 filter"&, and all comments in the string, including this initial one, must be
18623 terminated with newline characters. For example:
18624 .code
18625 data = #Exim filter\n\
18626        if $h_to: contains Exim then save $home/mail/exim endif
18627 .endd
18628 If you are reading the data from a database where newlines cannot be included,
18629 you can use the &${sg}$& expansion item to turn the escape string of your
18630 choice into a newline.
18631
18632
18633 .option directory_transport redirect string&!! unset
18634 A &(redirect)& router sets up a direct delivery to a directory when a path name
18635 ending with a slash is specified as a new &"address"&. The transport used is
18636 specified by this option, which, after expansion, must be the name of a
18637 configured transport. This should normally be an &(appendfile)& transport.
18638
18639
18640 .option file redirect string&!! unset
18641 This option specifies the name of a file that contains the redirection data. It
18642 is mutually exclusive with the &%data%& option. The string is expanded before
18643 use; if the expansion is forced to fail, the router declines. Other expansion
18644 failures cause delivery to be deferred. The result of a successful expansion
18645 must be an absolute path. The entire file is read and used as the redirection
18646 data. If the data is an empty string or a string that has no effect (consists
18647 entirely of comments), the router declines.
18648
18649 .cindex "NFS" "checking for file existence"
18650 If the attempt to open the file fails with a &"does not exist"& error, Exim
18651 runs a check on the containing directory,
18652 unless &%ignore_enotdir%& is true (see below).
18653 If the directory does not appear to exist, delivery is deferred. This can
18654 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18655 is a mount problem. If the containing directory does exist, but the file does
18656 not, the router declines.
18657
18658
18659 .option file_transport redirect string&!! unset
18660 .vindex "&$address_file$&"
18661 A &(redirect)& router sets up a direct delivery to a file when a path name not
18662 ending in a slash is specified as a new &"address"&. The transport used is
18663 specified by this option, which, after expansion, must be the name of a
18664 configured transport. This should normally be an &(appendfile)& transport. When
18665 it is running, the file name is in &$address_file$&.
18666
18667
18668 .option filter_prepend_home redirect boolean true
18669 When this option is true, if a &(save)& command in an Exim filter specifies a
18670 relative path, and &$home$& is defined, it is automatically prepended to the
18671 relative path. If this option is set false, this action does not happen. The
18672 relative path is then passed to the transport unmodified.
18673
18674
18675 .option forbid_blackhole redirect boolean false
18676 If this option is true, the &':blackhole:'& item may not appear in a
18677 redirection list.
18678
18679
18680 .option forbid_exim_filter redirect boolean false
18681 If this option is set true, only Sieve filters are permitted when
18682 &%allow_filter%& is true.
18683
18684
18685
18686
18687 .option forbid_file redirect boolean false
18688 .cindex "delivery" "to file; forbidding"
18689 .cindex "Sieve filter" "forbidding delivery to a file"
18690 .cindex "Sieve filter" "&""keep""& facility; disabling"
18691 If this option is true, this router may not generate a new address that
18692 specifies delivery to a local file or directory, either from a filter or from a
18693 conventional forward file. This option is forced to be true if &%one_time%& is
18694 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18695 locks out the Sieve's &"keep"& facility.
18696
18697
18698 .option forbid_filter_dlfunc redirect boolean false
18699 .cindex "filter" "locking out certain features"
18700 If this option is true, string expansions in Exim filters are not allowed to
18701 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18702 functions.
18703
18704 .option forbid_filter_existstest redirect boolean false
18705 .cindex "expansion" "statting a file"
18706 If this option is true, string expansions in Exim filters are not allowed to
18707 make use of the &%exists%& condition or the &%stat%& expansion item.
18708
18709 .option forbid_filter_logwrite redirect boolean false
18710 If this option is true, use of the logging facility in Exim filters is not
18711 permitted. Logging is in any case available only if the filter is being run
18712 under some unprivileged uid (which is normally the case for ordinary users'
18713 &_.forward_& files).
18714
18715
18716 .option forbid_filter_lookup redirect boolean false
18717 If this option is true, string expansions in Exim filter files are not allowed
18718 to make use of &%lookup%& items.
18719
18720
18721 .option forbid_filter_perl redirect boolean false
18722 This option has an effect only if Exim is built with embedded Perl support. If
18723 it is true, string expansions in Exim filter files are not allowed to make use
18724 of the embedded Perl support.
18725
18726
18727 .option forbid_filter_readfile redirect boolean false
18728 If this option is true, string expansions in Exim filter files are not allowed
18729 to make use of &%readfile%& items.
18730
18731
18732 .option forbid_filter_readsocket redirect boolean false
18733 If this option is true, string expansions in Exim filter files are not allowed
18734 to make use of &%readsocket%& items.
18735
18736
18737 .option forbid_filter_reply redirect boolean false
18738 If this option is true, this router may not generate an automatic reply
18739 message. Automatic replies can be generated only from Exim or Sieve filter
18740 files, not from traditional forward files. This option is forced to be true if
18741 &%one_time%& is set.
18742
18743
18744 .option forbid_filter_run redirect boolean false
18745 If this option is true, string expansions in Exim filter files are not allowed
18746 to make use of &%run%& items.
18747
18748
18749 .option forbid_include redirect boolean false
18750 If this option is true, items of the form
18751 .code
18752 :include:<path name>
18753 .endd
18754 are not permitted in non-filter redirection lists.
18755
18756
18757 .option forbid_pipe redirect boolean false
18758 .cindex "delivery" "to pipe; forbidding"
18759 If this option is true, this router may not generate a new address which
18760 specifies delivery to a pipe, either from an Exim filter or from a conventional
18761 forward file. This option is forced to be true if &%one_time%& is set.
18762
18763
18764 .option forbid_sieve_filter redirect boolean false
18765 If this option is set true, only Exim filters are permitted when
18766 &%allow_filter%& is true.
18767
18768
18769 .cindex "SMTP" "error codes"
18770 .option forbid_smtp_code redirect boolean false
18771 If this option is set true, any SMTP error codes that are present at the start
18772 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18773 the default codes (451 and 550, respectively) are always used.
18774
18775
18776
18777
18778 .option hide_child_in_errmsg redirect boolean false
18779 .cindex "bounce message" "redirection details; suppressing"
18780 If this option is true, it prevents Exim from quoting a child address if it
18781 generates a bounce or delay message for it. Instead it says &"an address
18782 generated from <&'the top level address'&>"&. Of course, this applies only to
18783 bounces generated locally. If a message is forwarded to another host, &'its'&
18784 bounce may well quote the generated address.
18785
18786
18787 .option ignore_eacces redirect boolean false
18788 .cindex "EACCES"
18789 If this option is set and an attempt to open a redirection file yields the
18790 EACCES error (permission denied), the &(redirect)& router behaves as if the
18791 file did not exist.
18792
18793
18794 .option ignore_enotdir redirect boolean false
18795 .cindex "ENOTDIR"
18796 If this option is set and an attempt to open a redirection file yields the
18797 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18798 router behaves as if the file did not exist.
18799
18800 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18801 router that has the &%file%& option set discovers that the file does not exist
18802 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18803 against unmounted NFS directories. If the parent can not be statted, delivery
18804 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18805 is set, because that option tells Exim to ignore &"something on the path is not
18806 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18807 that some operating systems give ENOENT where others give ENOTDIR.
18808
18809
18810
18811 .option include_directory redirect string unset
18812 If this option is set, the path names of any &':include:'& items in a
18813 redirection list must start with this directory.
18814
18815
18816 .option modemask redirect "octal integer" 022
18817 This specifies mode bits which must not be set for a file specified by the
18818 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18819
18820
18821 .option one_time redirect boolean false
18822 .cindex "one-time aliasing/forwarding expansion"
18823 .cindex "alias file" "one-time expansion"
18824 .cindex "forward file" "one-time expansion"
18825 .cindex "mailing lists" "one-time expansion"
18826 .cindex "address redirection" "one-time expansion"
18827 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18828 files each time it tries to deliver a message causes a problem when one or more
18829 of the generated addresses fails be delivered at the first attempt. The problem
18830 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18831 but of what happens when the redirection list changes during the time that the
18832 message is on Exim's queue. This is particularly true in the case of mailing
18833 lists, where new subscribers might receive copies of messages that were posted
18834 before they subscribed.
18835
18836 If &%one_time%& is set and any addresses generated by the router fail to
18837 deliver at the first attempt, the failing addresses are added to the message as
18838 &"top level"& addresses, and the parent address that generated them is marked
18839 &"delivered"&. Thus, redirection does not happen again at the next delivery
18840 attempt.
18841
18842 &*Warning 1*&: Any header line addition or removal that is specified by this
18843 router would be lost if delivery did not succeed at the first attempt. For this
18844 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18845 permitted when &%one_time%& is set.
18846
18847 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18848 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18849 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18850
18851 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18852 &%one_time%&.
18853
18854 The original top-level address is remembered with each of the generated
18855 addresses, and is output in any log messages. However, any intermediate parent
18856 addresses are not recorded. This makes a difference to the log only if
18857 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18858 typically be used for mailing lists, where there is normally just one level of
18859 expansion.
18860
18861
18862 .option owners redirect "string list" unset
18863 .cindex "ownership" "alias file"
18864 .cindex "ownership" "forward file"
18865 .cindex "alias file" "ownership"
18866 .cindex "forward file" "ownership"
18867 This specifies a list of permitted owners for the file specified by &%file%&.
18868 This list is in addition to the local user when &%check_local_user%& is set.
18869 See &%check_owner%& above.
18870
18871
18872 .option owngroups redirect "string list" unset
18873 This specifies a list of permitted groups for the file specified by &%file%&.
18874 The list is in addition to the local user's primary group when
18875 &%check_local_user%& is set. See &%check_group%& above.
18876
18877
18878 .option pipe_transport redirect string&!! unset
18879 .vindex "&$address_pipe$&"
18880 A &(redirect)& router sets up a direct delivery to a pipe when a string
18881 starting with a vertical bar character is specified as a new &"address"&. The
18882 transport used is specified by this option, which, after expansion, must be the
18883 name of a configured transport. This should normally be a &(pipe)& transport.
18884 When the transport is run, the pipe command is in &$address_pipe$&.
18885
18886
18887 .option qualify_domain redirect string&!! unset
18888 .vindex "&$qualify_recipient$&"
18889 If this option is set, and an unqualified address (one without a domain) is
18890 generated, and that address would normally be qualified by the global setting
18891 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18892 expanding this string. If the expansion fails, the router declines. If you want
18893 to revert to the default, you can have the expansion generate
18894 &$qualify_recipient$&.
18895
18896 This option applies to all unqualified addresses generated by Exim filters,
18897 but for traditional &_.forward_& files, it applies only to addresses that are
18898 not preceded by a backslash. Sieve filters cannot generate unqualified
18899 addresses.
18900
18901 .option qualify_preserve_domain redirect boolean false
18902 .cindex "domain" "in redirection; preserving"
18903 .cindex "preserving domain in redirection"
18904 .cindex "address redirection" "domain; preserving"
18905 If this option is set, the router's local &%qualify_domain%& option must not be
18906 set (a configuration error occurs if it is). If an unqualified address (one
18907 without a domain) is generated, it is qualified with the domain of the parent
18908 address (the immediately preceding ancestor) instead of the global
18909 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18910 this applies whether or not the address is preceded by a backslash.
18911
18912
18913 .option repeat_use redirect boolean true
18914 If this option is set false, the router is skipped for a child address that has
18915 any ancestor that was routed by this router. This test happens before any of
18916 the other preconditions are tested. Exim's default anti-looping rules skip
18917 only when the ancestor is the same as the current address. See also
18918 &%check_ancestor%& above and the generic &%redirect_router%& option.
18919
18920
18921 .option reply_transport redirect string&!! unset
18922 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18923 &%vacation%& command is used in a filter file. The transport used is specified
18924 by this option, which, after expansion, must be the name of a configured
18925 transport. This should normally be an &(autoreply)& transport. Other transports
18926 are unlikely to do anything sensible or useful.
18927
18928
18929 .option rewrite redirect boolean true
18930 .cindex "address redirection" "disabling rewriting"
18931 If this option is set false, addresses generated by the router are not
18932 subject to address rewriting. Otherwise, they are treated like new addresses
18933 and are rewritten according to the global rewriting rules.
18934
18935
18936 .option sieve_subaddress redirect string&!! unset
18937 The value of this option is passed to a Sieve filter to specify the
18938 :subaddress part of an address.
18939
18940 .option sieve_useraddress redirect string&!! unset
18941 The value of this option is passed to a Sieve filter to specify the :user part
18942 of an address. However, if it is unset, the entire original local part
18943 (including any prefix or suffix) is used for :user.
18944
18945
18946 .option sieve_vacation_directory redirect string&!! unset
18947 .cindex "Sieve filter" "vacation directory"
18948 To enable the &"vacation"& extension for Sieve filters, you must set
18949 &%sieve_vacation_directory%& to the directory where vacation databases are held
18950 (do not put anything else in that directory), and ensure that the
18951 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18952 needs their own directory; Exim will create it if necessary.
18953
18954
18955
18956 .option skip_syntax_errors redirect boolean false
18957 .cindex "forward file" "broken"
18958 .cindex "address redirection" "broken files"
18959 .cindex "alias file" "broken"
18960 .cindex "broken alias or forward files"
18961 .cindex "ignoring faulty addresses"
18962 .cindex "skipping faulty addresses"
18963 .cindex "error" "skipping bad syntax"
18964 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18965 non-filter redirection data are skipped, and each failing address is logged. If
18966 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18967 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18968 are expanded and placed at the head of the error message generated by
18969 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18970 be the same address as the generic &%errors_to%& option. The
18971 &%skip_syntax_errors%& option is often used when handling mailing lists.
18972
18973 If all the addresses in a redirection list are skipped because of syntax
18974 errors, the router declines to handle the original address, and it is passed to
18975 the following routers.
18976
18977 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18978 error in the filter causes filtering to be abandoned without any action being
18979 taken. The incident is logged, and the router declines to handle the address,
18980 so it is passed to the following routers.
18981
18982 .cindex "Sieve filter" "syntax errors in"
18983 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18984 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18985 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18986
18987 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18988 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18989 option, used with an address that does not get redirected, can be used to
18990 notify users of these errors, by means of a router like this:
18991 .code
18992 userforward:
18993   driver = redirect
18994   allow_filter
18995   check_local_user
18996   file = $home/.forward
18997   file_transport = address_file
18998   pipe_transport = address_pipe
18999   reply_transport = address_reply
19000   no_verify
19001   skip_syntax_errors
19002   syntax_errors_to = real-$local_part@$domain
19003   syntax_errors_text = \
19004    This is an automatically generated message. An error has\n\
19005    been found in your .forward file. Details of the error are\n\
19006    reported below. While this error persists, you will receive\n\
19007    a copy of this message for every message that is addressed\n\
19008    to you. If your .forward file is a filter file, or if it is\n\
19009    a non-filter file containing no valid forwarding addresses,\n\
19010    a copy of each incoming message will be put in your normal\n\
19011    mailbox. If a non-filter file contains at least one valid\n\
19012    forwarding address, forwarding to the valid addresses will\n\
19013    happen, and those will be the only deliveries that occur.
19014 .endd
19015 You also need a router to ensure that local addresses that are prefixed by
19016 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19017 put this immediately before the &(userforward)& router:
19018 .code
19019 real_localuser:
19020   driver = accept
19021   check_local_user
19022   local_part_prefix = real-
19023   transport = local_delivery
19024 .endd
19025 For security, it would probably be a good idea to restrict the use of this
19026 router to locally-generated messages, using a condition such as this:
19027 .code
19028   condition = ${if match {$sender_host_address}\
19029                          {\N^(|127\.0\.0\.1)$\N}}
19030 .endd
19031
19032
19033 .option syntax_errors_text redirect string&!! unset
19034 See &%skip_syntax_errors%& above.
19035
19036
19037 .option syntax_errors_to redirect string unset
19038 See &%skip_syntax_errors%& above.
19039 .ecindex IIDredrou1
19040 .ecindex IIDredrou2
19041
19042
19043
19044
19045
19046
19047 . ////////////////////////////////////////////////////////////////////////////
19048 . ////////////////////////////////////////////////////////////////////////////
19049
19050 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19051          "Environment for local transports"
19052 .scindex IIDenvlotra1 "local transports" "environment for"
19053 .scindex IIDenvlotra2 "environment for local transports"
19054 .scindex IIDenvlotra3 "transport" "local; environment for"
19055 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19056 transport can be thought of as similar to a pipe.) Exim always runs transports
19057 in subprocesses, under specified uids and gids. Typical deliveries to local
19058 mailboxes run under the uid and gid of the local user.
19059
19060 Exim also sets a specific current directory while running the transport; for
19061 some transports a home directory setting is also relevant. The &(pipe)&
19062 transport is the only one that sets up environment variables; see section
19063 &<<SECTpipeenv>>& for details.
19064
19065 The values used for the uid, gid, and the directories may come from several
19066 different places. In many cases, the router that handles the address associates
19067 settings with that address as a result of its &%check_local_user%&, &%group%&,
19068 or &%user%& options. However, values may also be given in the transport's own
19069 configuration, and these override anything that comes from the router.
19070
19071
19072
19073 .section "Concurrent deliveries" "SECID131"
19074 .cindex "concurrent deliveries"
19075 .cindex "simultaneous deliveries"
19076 If two different messages for the same local recipient arrive more or less
19077 simultaneously, the two delivery processes are likely to run concurrently. When
19078 the &(appendfile)& transport is used to write to a file, Exim applies locking
19079 rules to stop concurrent processes from writing to the same file at the same
19080 time.
19081
19082 However, when you use a &(pipe)& transport, it is up to you to arrange any
19083 locking that is needed. Here is a silly example:
19084 .code
19085 my_transport:
19086   driver = pipe
19087   command = /bin/sh -c 'cat >>/some/file'
19088 .endd
19089 This is supposed to write the message at the end of the file. However, if two
19090 messages arrive at the same time, the file will be scrambled. You can use the
19091 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19092 file using the same algorithm that Exim itself uses.
19093
19094
19095
19096
19097 .section "Uids and gids" "SECTenvuidgid"
19098 .cindex "local transports" "uid and gid"
19099 .cindex "transport" "local; uid and gid"
19100 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19101 overrides any group that the router set in the address, even if &%user%& is not
19102 set for the transport. This makes it possible, for example, to run local mail
19103 delivery under the uid of the recipient (set by the router), but in a special
19104 group (set by the transport). For example:
19105 .code
19106 # Routers ...
19107 # User/group are set by check_local_user in this router
19108 local_users:
19109   driver = accept
19110   check_local_user
19111   transport = group_delivery
19112
19113 # Transports ...
19114 # This transport overrides the group
19115 group_delivery:
19116   driver = appendfile
19117   file = /var/spool/mail/$local_part
19118   group = mail
19119 .endd
19120 If &%user%& is set for a transport, its value overrides what is set in the
19121 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19122 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19123 set.
19124
19125 .oindex "&%initgroups%&"
19126 When the uid is taken from the transport's configuration, the &[initgroups()]&
19127 function is called for the groups associated with that uid if the
19128 &%initgroups%& option is set for the transport. When the uid is not specified
19129 by the transport, but is associated with the address by a router, the option
19130 for calling &[initgroups()]& is taken from the router configuration.
19131
19132 .cindex "&(pipe)& transport" "uid for"
19133 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19134 is set and &%user%& is not set, the uid of the process that called Exim to
19135 receive the message is used, and if &%group%& is not set, the corresponding
19136 original gid is also used.
19137
19138 This is the detailed preference order for obtaining a gid; the first of the
19139 following that is set is used:
19140
19141 .ilist
19142 A &%group%& setting of the transport;
19143 .next
19144 A &%group%& setting of the router;
19145 .next
19146 A gid associated with a user setting of the router, either as a result of
19147 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19148 .next
19149 The group associated with a non-numeric &%user%& setting of the transport;
19150 .next
19151 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19152 the uid is the creator's uid;
19153 .next
19154 The Exim gid if the Exim uid is being used as a default.
19155 .endlist
19156
19157 If, for example, the user is specified numerically on the router and there are
19158 no group settings, no gid is available. In this situation, an error occurs.
19159 This is different for the uid, for which there always is an ultimate default.
19160 The first of the following that is set is used:
19161
19162 .ilist
19163 A &%user%& setting of the transport;
19164 .next
19165 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19166 .next
19167 A &%user%& setting of the router;
19168 .next
19169 A &%check_local_user%& setting of the router;
19170 .next
19171 The Exim uid.
19172 .endlist
19173
19174 Of course, an error will still occur if the uid that is chosen is on the
19175 &%never_users%& list.
19176
19177
19178
19179
19180
19181 .section "Current and home directories" "SECID132"
19182 .cindex "current directory for local transport"
19183 .cindex "home directory" "for local transport"
19184 .cindex "transport" "local; home directory for"
19185 .cindex "transport" "local; current directory for"
19186 Routers may set current and home directories for local transports by means of
19187 the &%transport_current_directory%& and &%transport_home_directory%& options.
19188 However, if the transport's &%current_directory%& or &%home_directory%& options
19189 are set, they override the router's values. In detail, the home directory
19190 for a local transport is taken from the first of these values that is set:
19191
19192 .ilist
19193 The &%home_directory%& option on the transport;
19194 .next
19195 The &%transport_home_directory%& option on the router;
19196 .next
19197 The password data if &%check_local_user%& is set on the router;
19198 .next
19199 The &%router_home_directory%& option on the router.
19200 .endlist
19201
19202 The current directory is taken from the first of these values that is set:
19203
19204 .ilist
19205 The &%current_directory%& option on the transport;
19206 .next
19207 The &%transport_current_directory%& option on the router.
19208 .endlist
19209
19210
19211 If neither the router nor the transport sets a current directory, Exim uses the
19212 value of the home directory, if it is set. Otherwise it sets the current
19213 directory to &_/_& before running a local transport.
19214
19215
19216
19217 .section "Expansion variables derived from the address" "SECID133"
19218 .vindex "&$domain$&"
19219 .vindex "&$local_part$&"
19220 .vindex "&$original_domain$&"
19221 Normally a local delivery is handling a single address, and in that case the
19222 variables such as &$domain$& and &$local_part$& are set during local
19223 deliveries. However, in some circumstances more than one address may be handled
19224 at once (for example, while writing batch SMTP for onward transmission by some
19225 other means). In this case, the variables associated with the local part are
19226 never set, &$domain$& is set only if all the addresses have the same domain,
19227 and &$original_domain$& is never set.
19228 .ecindex IIDenvlotra1
19229 .ecindex IIDenvlotra2
19230 .ecindex IIDenvlotra3
19231
19232
19233
19234
19235
19236
19237
19238 . ////////////////////////////////////////////////////////////////////////////
19239 . ////////////////////////////////////////////////////////////////////////////
19240
19241 .chapter "Generic options for transports" "CHAPtransportgeneric"
19242 .scindex IIDgenoptra1 "generic options" "transport"
19243 .scindex IIDgenoptra2 "options" "generic; for transports"
19244 .scindex IIDgenoptra3 "transport" "generic options for"
19245 The following generic options apply to all transports:
19246
19247
19248 .option body_only transports boolean false
19249 .cindex "transport" "body only"
19250 .cindex "message" "transporting body only"
19251 .cindex "body of message" "transporting"
19252 If this option is set, the message's headers are not transported. It is
19253 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19254 or &(pipe)& transports, the settings of &%message_prefix%& and
19255 &%message_suffix%& should be checked, because this option does not
19256 automatically suppress them.
19257
19258
19259 .option current_directory transports string&!! unset
19260 .cindex "transport" "current directory for"
19261 This specifies the current directory that is to be set while running the
19262 transport, overriding any value that may have been set by the router.
19263 If the expansion fails for any reason, including forced failure, an error is
19264 logged, and delivery is deferred.
19265
19266
19267 .option disable_logging transports boolean false
19268 If this option is set true, nothing is logged for any
19269 deliveries by the transport or for any
19270 transport errors. You should not set this option unless you really, really know
19271 what you are doing.
19272
19273
19274 .option debug_print transports string&!! unset
19275 .cindex "testing" "variables in drivers"
19276 If this option is set and debugging is enabled (see the &%-d%& command line
19277 option), the string is expanded and included in the debugging output when the
19278 transport is run.
19279 If expansion of the string fails, the error message is written to the debugging
19280 output, and Exim carries on processing.
19281 This facility is provided to help with checking out the values of variables and
19282 so on when debugging driver configurations. For example, if a &%headers_add%&
19283 option is not working properly, &%debug_print%& could be used to output the
19284 variables it references. A newline is added to the text if it does not end with
19285 one.
19286
19287
19288 .option delivery_date_add transports boolean false
19289 .cindex "&'Delivery-date:'& header line"
19290 If this option is true, a &'Delivery-date:'& header is added to the message.
19291 This gives the actual time the delivery was made. As this is not a standard
19292 header, Exim has a configuration option (&%delivery_date_remove%&) which
19293 requests its removal from incoming messages, so that delivered messages can
19294 safely be resent to other recipients.
19295
19296
19297 .option driver transports string unset
19298 This specifies which of the available transport drivers is to be used.
19299 There is no default, and this option must be set for every transport.
19300
19301
19302 .option envelope_to_add transports boolean false
19303 .cindex "&'Envelope-to:'& header line"
19304 If this option is true, an &'Envelope-to:'& header is added to the message.
19305 This gives the original address(es) in the incoming envelope that caused this
19306 delivery to happen. More than one address may be present if the transport is
19307 configured to handle several addresses at once, or if more than one original
19308 address was redirected to the same final address. As this is not a standard
19309 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19310 its removal from incoming messages, so that delivered messages can safely be
19311 resent to other recipients.
19312
19313
19314 .option group transports string&!! "Exim group"
19315 .cindex "transport" "group; specifying"
19316 This option specifies a gid for running the transport process, overriding any
19317 value that the router supplies, and also overriding any value associated with
19318 &%user%& (see below).
19319
19320
19321 .option headers_add transports string&!! unset
19322 .cindex "header lines" "adding in transport"
19323 .cindex "transport" "header lines; adding"
19324 This option specifies a string of text that is expanded and added to the header
19325 portion of a message as it is transported, as described in section
19326 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19327 routers. If the result of the expansion is an empty string, or if the expansion
19328 is forced to fail, no action is taken. Other expansion failures are treated as
19329 errors and cause the delivery to be deferred.
19330
19331
19332
19333 .option headers_only transports boolean false
19334 .cindex "transport" "header lines only"
19335 .cindex "message" "transporting headers only"
19336 .cindex "header lines" "transporting"
19337 If this option is set, the message's body is not transported. It is mutually
19338 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19339 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19340 checked, since this option does not automatically suppress them.
19341
19342
19343 .option headers_remove transports string&!! unset
19344 .cindex "header lines" "removing"
19345 .cindex "transport" "header lines; removing"
19346 This option specifies a string that is expanded into a list of header names;
19347 these headers are omitted from the message as it is transported, as described
19348 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19349 routers. If the result of the expansion is an empty string, or if the expansion
19350 is forced to fail, no action is taken. Other expansion failures are treated as
19351 errors and cause the delivery to be deferred.
19352
19353
19354
19355 .option headers_rewrite transports string unset
19356 .cindex "transport" "header lines; rewriting"
19357 .cindex "rewriting" "at transport time"
19358 This option allows addresses in header lines to be rewritten at transport time,
19359 that is, as the message is being copied to its destination. The contents of the
19360 option are a colon-separated list of rewriting rules. Each rule is in exactly
19361 the same form as one of the general rewriting rules that are applied when a
19362 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19363 example,
19364 .code
19365 headers_rewrite = a@b c@d f : \
19366                   x@y w@z
19367 .endd
19368 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19369 &'w@z'& in all address-bearing header lines. The rules are applied to the
19370 header lines just before they are written out at transport time, so they affect
19371 only those copies of the message that pass through the transport. However, only
19372 the message's original header lines, and any that were added by a system
19373 filter, are rewritten. If a router or transport adds header lines, they are not
19374 affected by this option. These rewriting rules are &'not'& applied to the
19375 envelope. You can change the return path using &%return_path%&, but you cannot
19376 change envelope recipients at this time.
19377
19378
19379 .option home_directory transports string&!! unset
19380 .cindex "transport" "home directory for"
19381 .vindex "&$home$&"
19382 This option specifies a home directory setting for a local transport,
19383 overriding any value that may be set by the router. The home directory is
19384 placed in &$home$& while expanding the transport's private options. It is also
19385 used as the current directory if no current directory is set by the
19386 &%current_directory%& option on the transport or the
19387 &%transport_current_directory%& option on the router. If the expansion fails
19388 for any reason, including forced failure, an error is logged, and delivery is
19389 deferred.
19390
19391
19392 .option initgroups transports boolean false
19393 .cindex "additional groups"
19394 .cindex "groups" "additional"
19395 .cindex "transport" "group; additional"
19396 If this option is true and the uid for the delivery process is provided by the
19397 transport, the &[initgroups()]& function is called when running the transport
19398 to ensure that any additional groups associated with the uid are set up.
19399
19400
19401 .option message_size_limit transports string&!! 0
19402 .cindex "limit" "message size per transport"
19403 .cindex "size" "of message, limit"
19404 .cindex "transport" "message size; limiting"
19405 This option controls the size of messages passed through the transport. It is
19406 expanded before use; the result of the expansion must be a sequence of decimal
19407 digits, optionally followed by K or M. If the expansion fails for any reason,
19408 including forced failure, or if the result is not of the required form,
19409 delivery is deferred. If the value is greater than zero and the size of a
19410 message exceeds this limit, the address is failed. If there is any chance that
19411 the resulting bounce message could be routed to the same transport, you should
19412 ensure that &%return_size_limit%& is less than the transport's
19413 &%message_size_limit%&, as otherwise the bounce message will fail to get
19414 delivered.
19415
19416
19417
19418 .option rcpt_include_affixes transports boolean false
19419 .cindex "prefix" "for local part, including in envelope"
19420 .cindex "suffix for local part" "including in envelope"
19421 .cindex "local part" "prefix"
19422 .cindex "local part" "suffix"
19423 When this option is false (the default), and an address that has had any
19424 affixes (prefixes or suffixes) removed from the local part is delivered by any
19425 form of SMTP or LMTP, the affixes are not included. For example, if a router
19426 that contains
19427 .code
19428 local_part_prefix = *-
19429 .endd
19430 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19431 is delivered with
19432 .code
19433 RCPT TO:<xyz@some.domain>
19434 .endd
19435 This is also the case when an ACL-time callout is being used to verify a
19436 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19437 whole local part is included in the RCPT command. This option applies to BSMTP
19438 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19439 &(lmtp)& and &(smtp)& transports.
19440
19441
19442 .option retry_use_local_part transports boolean "see below"
19443 .cindex "hints database" "retry keys"
19444 When a delivery suffers a temporary failure, a retry record is created
19445 in Exim's hints database. For remote deliveries, the key for the retry record
19446 is based on the name and/or IP address of the failing remote host. For local
19447 deliveries, the key is normally the entire address, including both the local
19448 part and the domain. This is suitable for most common cases of local delivery
19449 temporary failure &-- for example, exceeding a mailbox quota should delay only
19450 deliveries to that mailbox, not to the whole domain.
19451
19452 However, in some special cases you may want to treat a temporary local delivery
19453 as a failure associated with the domain, and not with a particular local part.
19454 (For example, if you are storing all mail for some domain in files.) You can do
19455 this by setting &%retry_use_local_part%& false.
19456
19457 For all the local transports, its default value is true. For remote transports,
19458 the default value is false for tidiness, but changing the value has no effect
19459 on a remote transport in the current implementation.
19460
19461
19462 .option return_path transports string&!! unset
19463 .cindex "envelope sender"
19464 .cindex "transport" "return path; changing"
19465 .cindex "return path" "changing in transport"
19466 If this option is set, the string is expanded at transport time and replaces
19467 the existing return path (envelope sender) value in the copy of the message
19468 that is being delivered. An empty return path is permitted. This feature is
19469 designed for remote deliveries, where the value of this option is used in the
19470 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19471 only effect is to change the address that is placed in the &'Return-path:'&
19472 header line, if one is added to the message (see the next option).
19473
19474 &*Note:*& A changed return path is not logged unless you add
19475 &%return_path_on_delivery%& to the log selector.
19476
19477 .vindex "&$return_path$&"
19478 The expansion can refer to the existing value via &$return_path$&. This is
19479 either the message's envelope sender, or an address set by the
19480 &%errors_to%& option on a router. If the expansion is forced to fail, no
19481 replacement occurs; if it fails for another reason, delivery is deferred. This
19482 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19483 section &<<SECTverp>>&.
19484
19485 &*Note*&: If a delivery error is detected locally, including the case when a
19486 remote server rejects a message at SMTP time, the bounce message is not sent to
19487 the value of this option. It is sent to the previously set errors address.
19488 This defaults to the incoming sender address, but can be changed by setting
19489 &%errors_to%& in a router.
19490
19491
19492
19493 .option return_path_add transports boolean false
19494 .cindex "&'Return-path:'& header line"
19495 If this option is true, a &'Return-path:'& header is added to the message.
19496 Although the return path is normally available in the prefix line of BSD
19497 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19498 have easy access to it.
19499
19500 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19501 the delivery SMTP server makes the final delivery"&. This implies that this
19502 header should not be present in incoming messages. Exim has a configuration
19503 option, &%return_path_remove%&, which requests removal of this header from
19504 incoming messages, so that delivered messages can safely be resent to other
19505 recipients.
19506
19507
19508 .option shadow_condition transports string&!! unset
19509 See &%shadow_transport%& below.
19510
19511
19512 .option shadow_transport transports string unset
19513 .cindex "shadow transport"
19514 .cindex "transport" "shadow"
19515 A local transport may set the &%shadow_transport%& option to the name of
19516 another local transport. Shadow remote transports are not supported.
19517
19518 Whenever a delivery to the main transport succeeds, and either
19519 &%shadow_condition%& is unset, or its expansion does not result in the empty
19520 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19521 passed to the shadow transport, with the same delivery address or addresses. If
19522 expansion fails, no action is taken except that non-forced expansion failures
19523 cause a log line to be written.
19524
19525 The result of the shadow transport is discarded and does not affect the
19526 subsequent processing of the message. Only a single level of shadowing is
19527 provided; the &%shadow_transport%& option is ignored on any transport when it
19528 is running as a shadow. Options concerned with output from pipes are also
19529 ignored. The log line for the successful delivery has an item added on the end,
19530 of the form
19531 .code
19532 ST=<shadow transport name>
19533 .endd
19534 If the shadow transport did not succeed, the error message is put in
19535 parentheses afterwards. Shadow transports can be used for a number of different
19536 purposes, including keeping more detailed log information than Exim normally
19537 provides, and implementing automatic acknowledgment policies based on message
19538 headers that some sites insist on.
19539
19540
19541 .option transport_filter transports string&!! unset
19542 .cindex "transport" "filter"
19543 .cindex "filter" "transport filter"
19544 This option sets up a filtering (in the Unix shell sense) process for messages
19545 at transport time. It should not be confused with mail filtering as set up by
19546 individual users or via a system filter.
19547
19548 When the message is about to be written out, the command specified by
19549 &%transport_filter%& is started up in a separate, parallel process, and
19550 the entire message, including the header lines, is passed to it on its standard
19551 input (this in fact is done from a third process, to avoid deadlock). The
19552 command must be specified as an absolute path.
19553
19554 The lines of the message that are written to the transport filter are
19555 terminated by newline (&"\n"&). The message is passed to the filter before any
19556 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19557 lines beginning with a dot, and also before any processing implied by the
19558 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19559 &(pipe)& transports.
19560
19561 The standard error for the filter process is set to the same destination as its
19562 standard output; this is read and written to the message's ultimate
19563 destination. The process that writes the message to the filter, the
19564 filter itself, and the original process that reads the result and delivers it
19565 are all run in parallel, like a shell pipeline.
19566
19567 The filter can perform any transformations it likes, but of course should take
19568 care not to break RFC 2822 syntax. Exim does not check the result, except to
19569 test for a final newline when SMTP is in use. All messages transmitted over
19570 SMTP must end with a newline, so Exim supplies one if it is missing.
19571
19572 .cindex "content scanning" "per user"
19573 A transport filter can be used to provide content-scanning on a per-user basis
19574 at delivery time if the only required effect of the scan is to modify the
19575 message. For example, a content scan could insert a new header line containing
19576 a spam score. This could be interpreted by a filter in the user's MUA. It is
19577 not possible to discard a message at this stage.
19578
19579 .cindex "SMTP" "SIZE"
19580 A problem might arise if the filter increases the size of a message that is
19581 being sent down an SMTP connection. If the receiving SMTP server has indicated
19582 support for the SIZE parameter, Exim will have sent the size of the message
19583 at the start of the SMTP session. If what is actually sent is substantially
19584 more, the server might reject the message. This can be worked round by setting
19585 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19586 additions to the message, or to disable the use of SIZE altogether.
19587
19588 .vindex "&$pipe_addresses$&"
19589 The value of the &%transport_filter%& option is the command string for starting
19590 the filter, which is run directly from Exim, not under a shell. The string is
19591 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19592 Exim breaks it up into arguments and then expands each argument separately (see
19593 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19594 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19595 of arguments, one for each address that applies to this delivery. (This isn't
19596 an ideal name for this feature here, but as it was already implemented for the
19597 &(pipe)& transport, it seemed sensible not to change it.)
19598
19599 .vindex "&$host$&"
19600 .vindex "&$host_address$&"
19601 The expansion variables &$host$& and &$host_address$& are available when the
19602 transport is a remote one. They contain the name and IP address of the host to
19603 which the message is being sent. For example:
19604 .code
19605 transport_filter = /some/directory/transport-filter.pl \
19606   $host $host_address $sender_address $pipe_addresses
19607 .endd
19608
19609 Two problems arise if you want to use more complicated expansion items to
19610 generate transport filter commands, both of which due to the fact that the
19611 command is split up &'before'& expansion.
19612 .ilist
19613 If an expansion item contains white space, you must quote it, so that it is all
19614 part of the same command item. If the entire option setting is one such
19615 expansion item, you have to take care what kind of quoting you use. For
19616 example:
19617 .code
19618 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19619 .endd
19620 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19621 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19622 stripped by Exim when it read the option's value. When the value is used, if
19623 the single quotes were missing, the line would be split into two items,
19624 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19625 Exim tried to expand the first one.
19626 .next
19627 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19628 expansion cannot generate multiple arguments, or a command name followed by
19629 arguments. Consider this example:
19630 .code
19631 transport_filter = ${lookup{$host}lsearch{/a/file}\
19632                     {$value}{/bin/cat}}
19633 .endd
19634 The result of the lookup is interpreted as the name of the command, even
19635 if it contains white space. The simplest way round this is to use a shell:
19636 .code
19637 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19638                                {$value}{/bin/cat}}
19639 .endd
19640 .endlist
19641
19642 The filter process is run under the same uid and gid as the normal delivery.
19643 For remote deliveries this is the Exim uid/gid by default. The command should
19644 normally yield a zero return code. Transport filters are not supposed to fail.
19645 A non-zero code is taken to mean that the transport filter encountered some
19646 serious problem. Delivery of the message is deferred; the message remains on
19647 the queue and is tried again later. It is not possible to cause a message to be
19648 bounced from a transport filter.
19649
19650 If a transport filter is set on an autoreply transport, the original message is
19651 passed through the filter as it is being copied into the newly generated
19652 message, which happens if the &%return_message%& option is set.
19653
19654
19655 .option transport_filter_timeout transports time 5m
19656 .cindex "transport" "filter, timeout"
19657 When Exim is reading the output of a transport filter, it a applies a timeout
19658 that can be set by this option. Exceeding the timeout is normally treated as a
19659 temporary delivery failure. However, if a transport filter is used with a
19660 &(pipe)& transport, a timeout in the transport filter is treated in the same
19661 way as a timeout in the pipe command itself. By default, a timeout is a hard
19662 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19663 becomes a temporary error.
19664
19665
19666 .option user transports string&!! "Exim user"
19667 .cindex "uid (user id)" "local delivery"
19668 .cindex "transport" "user, specifying"
19669 This option specifies the user under whose uid the delivery process is to be
19670 run, overriding any uid that may have been set by the router. If the user is
19671 given as a name, the uid is looked up from the password data, and the
19672 associated group is taken as the value of the gid to be used if the &%group%&
19673 option is not set.
19674
19675 For deliveries that use local transports, a user and group are normally
19676 specified explicitly or implicitly (for example, as a result of
19677 &%check_local_user%&) by the router or transport.
19678
19679 .cindex "hints database" "access by remote transport"
19680 For remote transports, you should leave this option unset unless you really are
19681 sure you know what you are doing. When a remote transport is running, it needs
19682 to be able to access Exim's hints databases, because each host may have its own
19683 retry data.
19684 .ecindex IIDgenoptra1
19685 .ecindex IIDgenoptra2
19686 .ecindex IIDgenoptra3
19687
19688
19689
19690
19691
19692
19693 . ////////////////////////////////////////////////////////////////////////////
19694 . ////////////////////////////////////////////////////////////////////////////
19695
19696 .chapter "Address batching in local transports" "CHAPbatching" &&&
19697          "Address batching"
19698 .cindex "transport" "local; address batching in"
19699 The only remote transport (&(smtp)&) is normally configured to handle more than
19700 one address at a time, so that when several addresses are routed to the same
19701 remote host, just one copy of the message is sent. Local transports, however,
19702 normally handle one address at a time. That is, a separate instance of the
19703 transport is run for each address that is routed to the transport. A separate
19704 copy of the message is delivered each time.
19705
19706 .cindex "batched local delivery"
19707 .oindex "&%batch_max%&"
19708 .oindex "&%batch_id%&"
19709 In special cases, it may be desirable to handle several addresses at once in a
19710 local transport, for example:
19711
19712 .ilist
19713 In an &(appendfile)& transport, when storing messages in files for later
19714 delivery by some other means, a single copy of the message with multiple
19715 recipients saves space.
19716 .next
19717 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19718 a single copy saves time, and is the normal way LMTP is expected to work.
19719 .next
19720 In a &(pipe)& transport, when passing the message
19721 to a scanner program or
19722 to some other delivery mechanism such as UUCP, multiple recipients may be
19723 acceptable.
19724 .endlist
19725
19726 These three local transports all have the same options for controlling multiple
19727 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19728 repeating the information for each transport, these options are described here.
19729
19730 The &%batch_max%& option specifies the maximum number of addresses that can be
19731 delivered together in a single run of the transport. Its default value is one
19732 (no batching). When more than one address is routed to a transport that has a
19733 &%batch_max%& value greater than one, the addresses are delivered in a batch
19734 (that is, in a single run of the transport with multiple recipients), subject
19735 to certain conditions:
19736
19737 .ilist
19738 .vindex "&$local_part$&"
19739 If any of the transport's options contain a reference to &$local_part$&, no
19740 batching is possible.
19741 .next
19742 .vindex "&$domain$&"
19743 If any of the transport's options contain a reference to &$domain$&, only
19744 addresses with the same domain are batched.
19745 .next
19746 .cindex "customizing" "batching condition"
19747 If &%batch_id%& is set, it is expanded for each address, and only those
19748 addresses with the same expanded value are batched. This allows you to specify
19749 customized batching conditions. Failure of the expansion for any reason,
19750 including forced failure, disables batching, but it does not stop the delivery
19751 from taking place.
19752 .next
19753 Batched addresses must also have the same errors address (where to send
19754 delivery errors), the same header additions and removals, the same user and
19755 group for the transport, and if a host list is present, the first host must
19756 be the same.
19757 .endlist
19758
19759 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19760 both when the file or pipe command is specified in the transport, and when it
19761 is specified by a &(redirect)& router, but all the batched addresses must of
19762 course be routed to the same file or pipe command. These two transports have an
19763 option called &%use_bsmtp%&, which causes them to deliver the message in
19764 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19765 &%check_string%& and &%escape_string%& options are forced to the values
19766 .code
19767 check_string = "."
19768 escape_string = ".."
19769 .endd
19770 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19771 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19772 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19773
19774 .cindex "&'Envelope-to:'& header line"
19775 If the generic &%envelope_to_add%& option is set for a batching transport, the
19776 &'Envelope-to:'& header that is added to the message contains all the addresses
19777 that are being processed together. If you are using a batching &(appendfile)&
19778 transport without &%use_bsmtp%&, the only way to preserve the recipient
19779 addresses is to set the &%envelope_to_add%& option.
19780
19781 .cindex "&(pipe)& transport" "with multiple addresses"
19782 .vindex "&$pipe_addresses$&"
19783 If you are using a &(pipe)& transport without BSMTP, and setting the
19784 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19785 the command. This is not a true variable; it is a bit of magic that causes each
19786 of the recipient addresses to be inserted into the command as a separate
19787 argument. This provides a way of accessing all the addresses that are being
19788 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19789 are specified by a &(redirect)& router.
19790
19791
19792
19793
19794 . ////////////////////////////////////////////////////////////////////////////
19795 . ////////////////////////////////////////////////////////////////////////////
19796
19797 .chapter "The appendfile transport" "CHAPappendfile"
19798 .scindex IIDapptra1 "&(appendfile)& transport"
19799 .scindex IIDapptra2 "transports" "&(appendfile)&"
19800 .cindex "directory creation"
19801 .cindex "creating directories"
19802 The &(appendfile)& transport delivers a message by appending it to an existing
19803 file, or by creating an entirely new file in a specified directory. Single
19804 files to which messages are appended can be in the traditional Unix mailbox
19805 format, or optionally in the MBX format supported by the Pine MUA and
19806 University of Washington IMAP daemon, &'inter alia'&. When each message is
19807 being delivered as a separate file, &"maildir"& format can optionally be used
19808 to give added protection against failures that happen part-way through the
19809 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19810 supported. For all file formats, Exim attempts to create as many levels of
19811 directory as necessary, provided that &%create_directory%& is set.
19812
19813 The code for the optional formats is not included in the Exim binary by
19814 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19815 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19816 included.
19817
19818 .cindex "quota" "system"
19819 Exim recognizes system quota errors, and generates an appropriate message. Exim
19820 also supports its own quota control within the transport, for use when the
19821 system facility is unavailable or cannot be used for some reason.
19822
19823 If there is an error while appending to a file (for example, quota exceeded or
19824 partition filled), Exim attempts to reset the file's length and last
19825 modification time back to what they were before. If there is an error while
19826 creating an entirely new file, the new file is removed.
19827
19828 Before appending to a file, a number of security checks are made, and the
19829 file is locked. A detailed description is given below, after the list of
19830 private options.
19831
19832 The &(appendfile)& transport is most commonly used for local deliveries to
19833 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19834 putting messages into files for remote delivery by some means other than Exim.
19835 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19836 option).
19837
19838
19839
19840 .section "The file and directory options" "SECTfildiropt"
19841 The &%file%& option specifies a single file, to which the message is appended;
19842 the &%directory%& option specifies a directory, in which a new file containing
19843 the message is created. Only one of these two options can be set, and for
19844 normal deliveries to mailboxes, one of them &'must'& be set.
19845
19846 .vindex "&$address_file$&"
19847 .vindex "&$local_part$&"
19848 However, &(appendfile)& is also used for delivering messages to files or
19849 directories whose names (or parts of names) are obtained from alias,
19850 forwarding, or filtering operations (for example, a &%save%& command in a
19851 user's Exim filter). When such a transport is running, &$local_part$& contains
19852 the local part that was aliased or forwarded, and &$address_file$& contains the
19853 name (or partial name) of the file or directory generated by the redirection
19854 operation. There are two cases:
19855
19856 .ilist
19857 If neither &%file%& nor &%directory%& is set, the redirection operation
19858 must specify an absolute path (one that begins with &`/`&). This is the most
19859 common case when users with local accounts use filtering to sort mail into
19860 different folders. See for example, the &(address_file)& transport in the
19861 default configuration. If the path ends with a slash, it is assumed to be the
19862 name of a directory. A delivery to a directory can also be forced by setting
19863 &%maildir_format%& or &%mailstore_format%&.
19864 .next
19865 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19866 used to determine the file or directory name for the delivery. Normally, the
19867 contents of &$address_file$& are used in some way in the string expansion.
19868 .endlist
19869
19870
19871 .cindex "Sieve filter" "configuring &(appendfile)&"
19872 .cindex "Sieve filter" "relative mailbox path handling"
19873 As an example of the second case, consider an environment where users do not
19874 have home directories. They may be permitted to use Exim filter commands of the
19875 form:
19876 .code
19877 save folder23
19878 .endd
19879 or Sieve filter commands of the form:
19880 .code
19881 require "fileinto";
19882 fileinto "folder23";
19883 .endd
19884 In this situation, the expansion of &%file%& or &%directory%& in the transport
19885 must transform the relative path into an appropriate absolute file name. In the
19886 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19887 is used as a result of a &"keep"& action in the filter. This example shows one
19888 way of handling this requirement:
19889 .code
19890 file = ${if eq{$address_file}{inbox} \
19891             {/var/mail/$local_part} \
19892             {${if eq{${substr_0_1:$address_file}}{/} \
19893                   {$address_file} \
19894                   {$home/mail/$address_file} \
19895             }} \
19896        }
19897 .endd
19898 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19899 location, absolute paths are used without change, and other folders are in the
19900 &_mail_& directory within the home directory.
19901
19902 &*Note 1*&: While processing an Exim filter, a relative path such as
19903 &_folder23_& is turned into an absolute path if a home directory is known to
19904 the router. In particular, this is the case if &%check_local_user%& is set. If
19905 you want to prevent this happening at routing time, you can set
19906 &%router_home_directory%& empty. This forces the router to pass the relative
19907 path to the transport.
19908
19909 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19910 the &%file%& or &%directory%& option is still used if it is set.
19911
19912
19913
19914
19915 .section "Private options for appendfile" "SECID134"
19916 .cindex "options" "&(appendfile)& transport"
19917
19918
19919
19920 .option allow_fifo appendfile boolean false
19921 .cindex "fifo (named pipe)"
19922 .cindex "named pipe (fifo)"
19923 .cindex "pipe" "named (fifo)"
19924 Setting this option permits delivery to named pipes (FIFOs) as well as to
19925 regular files. If no process is reading the named pipe at delivery time, the
19926 delivery is deferred.
19927
19928
19929 .option allow_symlink appendfile boolean false
19930 .cindex "symbolic link" "to mailbox"
19931 .cindex "mailbox" "symbolic link"
19932 By default, &(appendfile)& will not deliver if the path name for the file is
19933 that of a symbolic link. Setting this option relaxes that constraint, but there
19934 are security issues involved in the use of symbolic links. Be sure you know
19935 what you are doing if you set this. Details of exactly what this option affects
19936 are included in the discussion which follows this list of options.
19937
19938
19939 .option batch_id appendfile string&!! unset
19940 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19941 However, batching is automatically disabled for &(appendfile)& deliveries that
19942 happen as a result of forwarding or aliasing or other redirection directly to a
19943 file.
19944
19945
19946 .option batch_max appendfile integer 1
19947 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19948
19949
19950 .option check_group appendfile boolean false
19951 When this option is set, the group owner of the file defined by the &%file%&
19952 option is checked to see that it is the same as the group under which the
19953 delivery process is running. The default setting is false because the default
19954 file mode is 0600, which means that the group is irrelevant.
19955
19956
19957 .option check_owner appendfile boolean true
19958 When this option is set, the owner of the file defined by the &%file%& option
19959 is checked to ensure that it is the same as the user under which the delivery
19960 process is running.
19961
19962
19963 .option check_string appendfile string "see below"
19964 .cindex "&""From""& line"
19965 As &(appendfile)& writes the message, the start of each line is tested for
19966 matching &%check_string%&, and if it does, the initial matching characters are
19967 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19968 a literal string, not a regular expression, and the case of any letters it
19969 contains is significant.
19970
19971 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19972 are forced to &"."& and &".."& respectively, and any settings in the
19973 configuration are ignored. Otherwise, they default to &"From&~"& and
19974 &">From&~"& when the &%file%& option is set, and unset when any of the
19975 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19976
19977 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19978 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19979 &"From&~"& indicates the start of a new message. All four options need changing
19980 if another format is used. For example, to deliver to mailboxes in MMDF format:
19981 .cindex "MMDF format mailbox"
19982 .cindex "mailbox" "MMDF format"
19983 .code
19984 check_string = "\1\1\1\1\n"
19985 escape_string = "\1\1\1\1 \n"
19986 message_prefix = "\1\1\1\1\n"
19987 message_suffix = "\1\1\1\1\n"
19988 .endd
19989 .option create_directory appendfile boolean true
19990 .cindex "directory creation"
19991 When this option is true, Exim attempts to create any missing superior
19992 directories for the file that it is about to write. A created directory's mode
19993 is given by the &%directory_mode%& option.
19994
19995 The group ownership of a newly created directory is highly dependent on the
19996 operating system (and possibly the file system) that is being used. For
19997 example, in Solaris, if the parent directory has the setgid bit set, its group
19998 is propagated to the child; if not, the currently set group is used. However,
19999 in FreeBSD, the parent's group is always used.
20000
20001
20002
20003 .option create_file appendfile string anywhere
20004 This option constrains the location of files and directories that are created
20005 by this transport. It applies to files defined by the &%file%& option and
20006 directories defined by the &%directory%& option. In the case of maildir
20007 delivery, it applies to the top level directory, not the maildir directories
20008 beneath.
20009
20010 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20011 &"belowhome"&. In the second and third cases, a home directory must have been
20012 set for the transport. This option is not useful when an explicit file name is
20013 given for normal mailbox deliveries. It is intended for the case when file
20014 names are generated from users' &_.forward_& files. These are usually handled
20015 by an &(appendfile)& transport called &%address_file%&. See also
20016 &%file_must_exist%&.
20017
20018
20019 .option directory appendfile string&!! unset
20020 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20021 or &%directory%& must be set, unless the delivery is the direct result of a
20022 redirection (see section &<<SECTfildiropt>>&).
20023
20024 When &%directory%& is set, the string is expanded, and the message is delivered
20025 into a new file or files in or below the given directory, instead of being
20026 appended to a single mailbox file. A number of different formats are provided
20027 (see &%maildir_format%& and &%mailstore_format%&), and see section
20028 &<<SECTopdir>>& for further details of this form of delivery.
20029
20030
20031 .option directory_file appendfile string&!! "see below"
20032 .cindex "base62"
20033 .vindex "&$inode$&"
20034 When &%directory%& is set, but neither &%maildir_format%& nor
20035 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20036 whose name is obtained by expanding this string. The default value is:
20037 .code
20038 q${base62:$tod_epoch}-$inode
20039 .endd
20040 This generates a unique name from the current time, in base 62 form, and the
20041 inode of the file. The variable &$inode$& is available only when expanding this
20042 option.
20043
20044
20045 .option directory_mode appendfile "octal integer" 0700
20046 If &(appendfile)& creates any directories as a result of the
20047 &%create_directory%& option, their mode is specified by this option.
20048
20049
20050 .option escape_string appendfile string "see description"
20051 See &%check_string%& above.
20052
20053
20054 .option file appendfile string&!! unset
20055 This option is mutually exclusive with the &%directory%& option, but one of
20056 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20057 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20058 specifies a single file, to which the message is appended. One or more of
20059 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20060 &%file%&.
20061
20062 .cindex "NFS" "lock file"
20063 .cindex "locking files"
20064 .cindex "lock files"
20065 If you are using more than one host to deliver over NFS into the same
20066 mailboxes, you should always use lock files.
20067
20068 The string value is expanded for each delivery, and must yield an absolute
20069 path. The most common settings of this option are variations on one of these
20070 examples:
20071 .code
20072 file = /var/spool/mail/$local_part
20073 file = /home/$local_part/inbox
20074 file = $home/inbox
20075 .endd
20076 .cindex "&""sticky""& bit"
20077 In the first example, all deliveries are done into the same directory. If Exim
20078 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20079 create a file in the directory, so the &"sticky"& bit must be turned on for
20080 deliveries to be possible, or alternatively the &%group%& option can be used to
20081 run the delivery under a group id which has write access to the directory.
20082
20083
20084
20085 .option file_format appendfile string unset
20086 .cindex "file" "mailbox; checking existing format"
20087 This option requests the transport to check the format of an existing file
20088 before adding to it. The check consists of matching a specific string at the
20089 start of the file. The value of the option consists of an even number of
20090 colon-separated strings. The first of each pair is the test string, and the
20091 second is the name of a transport. If the transport associated with a matched
20092 string is not the current transport, control is passed over to the other
20093 transport. For example, suppose the standard &(local_delivery)& transport has
20094 this added to it:
20095 .code
20096 file_format = "From       : local_delivery :\
20097                \1\1\1\1\n : local_mmdf_delivery"
20098 .endd
20099 Mailboxes that begin with &"From"& are still handled by this transport, but if
20100 a mailbox begins with four binary ones followed by a newline, control is passed
20101 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20102 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20103 is assumed to match the current transport. If the start of a mailbox doesn't
20104 match any string, or if the transport named for a given string is not defined,
20105 delivery is deferred.
20106
20107
20108 .option file_must_exist appendfile boolean false
20109 If this option is true, the file specified by the &%file%& option must exist.
20110 A temporary error occurs if it does not, causing delivery to be deferred.
20111 If this option is false, the file is created if it does not exist.
20112
20113
20114 .option lock_fcntl_timeout appendfile time 0s
20115 .cindex "timeout" "mailbox locking"
20116 .cindex "mailbox" "locking, blocking and non-blocking"
20117 .cindex "locking files"
20118 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20119 when locking an open mailbox file. If the call fails, the delivery process
20120 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20121 Non-blocking calls are used so that the file is not kept open during the wait
20122 for the lock; the reason for this is to make it as safe as possible for
20123 deliveries over NFS in the case when processes might be accessing an NFS
20124 mailbox without using a lock file. This should not be done, but
20125 misunderstandings and hence misconfigurations are not unknown.
20126
20127 On a busy system, however, the performance of a non-blocking lock approach is
20128 not as good as using a blocking lock with a timeout. In this case, the waiting
20129 is done inside the system call, and Exim's delivery process acquires the lock
20130 and can proceed as soon as the previous lock holder releases it.
20131
20132 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20133 timeout, are used. There may still be some retrying: the maximum number of
20134 retries is
20135 .code
20136 (lock_retries * lock_interval) / lock_fcntl_timeout
20137 .endd
20138 rounded up to the next whole number. In other words, the total time during
20139 which &(appendfile)& is trying to get a lock is roughly the same, unless
20140 &%lock_fcntl_timeout%& is set very large.
20141
20142 You should consider setting this option if you are getting a lot of delayed
20143 local deliveries because of errors of the form
20144 .code
20145 failed to lock mailbox /some/file (fcntl)
20146 .endd
20147
20148 .option lock_flock_timeout appendfile time 0s
20149 This timeout applies to file locking when using &[flock()]& (see
20150 &%use_flock%&); the timeout operates in a similar manner to
20151 &%lock_fcntl_timeout%&.
20152
20153
20154 .option lock_interval appendfile time 3s
20155 This specifies the time to wait between attempts to lock the file. See below
20156 for details of locking.
20157
20158
20159 .option lock_retries appendfile integer 10
20160 This specifies the maximum number of attempts to lock the file. A value of zero
20161 is treated as 1. See below for details of locking.
20162
20163
20164 .option lockfile_mode appendfile "octal integer" 0600
20165 This specifies the mode of the created lock file, when a lock file is being
20166 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20167
20168
20169 .option lockfile_timeout appendfile time 30m
20170 .cindex "timeout" "mailbox locking"
20171 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20172 exists and is older than this value, it is assumed to have been left behind by
20173 accident, and Exim attempts to remove it.
20174
20175
20176 .option mailbox_filecount appendfile string&!! unset
20177 .cindex "mailbox" "specifying size of"
20178 .cindex "size" "of mailbox"
20179 If this option is set, it is expanded, and the result is taken as the current
20180 number of files in the mailbox. It must be a decimal number, optionally
20181 followed by K or M. This provides a way of obtaining this information from an
20182 external source that maintains the data.
20183
20184
20185 .option mailbox_size appendfile string&!! unset
20186 .cindex "mailbox" "specifying size of"
20187 .cindex "size" "of mailbox"
20188 If this option is set, it is expanded, and the result is taken as the current
20189 size the mailbox. It must be a decimal number, optionally followed by K or M.
20190 This provides a way of obtaining this information from an external source that
20191 maintains the data. This is likely to be helpful for maildir deliveries where
20192 it is computationally expensive to compute the size of a mailbox.
20193
20194
20195
20196 .option maildir_format appendfile boolean false
20197 .cindex "maildir format" "specifying"
20198 If this option is set with the &%directory%& option, the delivery is into a new
20199 file, in the &"maildir"& format that is used by other mail software. When the
20200 transport is activated directly from a &(redirect)& router (for example, the
20201 &(address_file)& transport in the default configuration), setting
20202 &%maildir_format%& causes the path received from the router to be treated as a
20203 directory, whether or not it ends with &`/`&. This option is available only if
20204 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20205 &<<SECTmaildirdelivery>>& below for further details.
20206
20207
20208 .option maildir_quota_directory_regex appendfile string "See below"
20209 .cindex "maildir format" "quota; directories included in"
20210 .cindex "quota" "maildir; directories included in"
20211 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20212 a regular expression for specifying directories, relative to the quota
20213 directory (see &%quota_directory%&), that should be included in the quota
20214 calculation. The default value is:
20215 .code
20216 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20217 .endd
20218 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20219 (directories whose names begin with a dot). If you want to exclude the
20220 &_Trash_&
20221 folder from the count (as some sites do), you need to change this setting to
20222 .code
20223 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20224 .endd
20225 This uses a negative lookahead in the regular expression to exclude the
20226 directory whose name is &_.Trash_&. When a directory is excluded from quota
20227 calculations, quota processing is bypassed for any messages that are delivered
20228 directly into that directory.
20229
20230
20231 .option maildir_retries appendfile integer 10
20232 This option specifies the number of times to retry when writing a file in
20233 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20234
20235
20236 .option maildir_tag appendfile string&!! unset
20237 This option applies only to deliveries in maildir format, and is described in
20238 section &<<SECTmaildirdelivery>>& below.
20239
20240
20241 .option maildir_use_size_file appendfile&!! boolean false
20242 .cindex "maildir format" "&_maildirsize_& file"
20243 The result of string expansion for this option must be a valid boolean value.
20244 If it is true, it enables support for &_maildirsize_& files. Exim
20245 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20246 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20247 value is zero. See &%maildir_quota_directory_regex%& above and section
20248 &<<SECTmaildirdelivery>>& below for further details.
20249
20250 .option maildirfolder_create_regex appendfile string unset
20251 .cindex "maildir format" "&_maildirfolder_& file"
20252 .cindex "&_maildirfolder_&, creating"
20253 The value of this option is a regular expression. If it is unset, it has no
20254 effect. Otherwise, before a maildir delivery takes place, the pattern is
20255 matched against the name of the maildir directory, that is, the directory
20256 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20257 delivery. If there is a match, Exim checks for the existence of a file called
20258 &_maildirfolder_& in the directory, and creates it if it does not exist.
20259 See section &<<SECTmaildirdelivery>>& for more details.
20260
20261
20262 .option mailstore_format appendfile boolean false
20263 .cindex "mailstore format" "specifying"
20264 If this option is set with the &%directory%& option, the delivery is into two
20265 new files in  &"mailstore"& format. The option is available only if
20266 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20267 below for further details.
20268
20269
20270 .option mailstore_prefix appendfile string&!! unset
20271 This option applies only to deliveries in mailstore format, and is described in
20272 section &<<SECTopdir>>& below.
20273
20274
20275 .option mailstore_suffix appendfile string&!! unset
20276 This option applies only to deliveries in mailstore format, and is described in
20277 section &<<SECTopdir>>& below.
20278
20279
20280 .option mbx_format appendfile boolean false
20281 .cindex "locking files"
20282 .cindex "file" "locking"
20283 .cindex "file" "MBX format"
20284 .cindex "MBX format, specifying"
20285 This option is available only if Exim has been compiled with SUPPORT_MBX
20286 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20287 the message is appended to the mailbox file in MBX format instead of
20288 traditional Unix format. This format is supported by Pine4 and its associated
20289 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20290
20291 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20292 automatically changed by the use of &%mbx_format%&. They should normally be set
20293 empty when using MBX format, so this option almost always appears in this
20294 combination:
20295 .code
20296 mbx_format = true
20297 message_prefix =
20298 message_suffix =
20299 .endd
20300 If none of the locking options are mentioned in the configuration,
20301 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20302 is possible to specify the other kinds of locking with &%mbx_format%&, but
20303 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20304 interworks with &'c-client'&, providing for shared access to the mailbox. It
20305 should not be used if any program that does not use this form of locking is
20306 going to access the mailbox, nor should it be used if the mailbox file is NFS
20307 mounted, because it works only when the mailbox is accessed from a single host.
20308
20309 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20310 the standard version of &'c-client'&, because as long as it has a mailbox open
20311 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20312 append messages to it.
20313
20314
20315 .option message_prefix appendfile string&!! "see below"
20316 .cindex "&""From""& line"
20317 The string specified here is expanded and output at the start of every message.
20318 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20319 in which case it is:
20320 .code
20321 message_prefix = "From ${if def:return_path{$return_path}\
20322   {MAILER-DAEMON}} $tod_bsdinbox\n"
20323 .endd
20324 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20325 &`\n`& to &`\r\n`& in &%message_prefix%&.
20326
20327 .option message_suffix appendfile string&!! "see below"
20328 The string specified here is expanded and output at the end of every message.
20329 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20330 in which case it is a single newline character. The suffix can be suppressed by
20331 setting
20332 .code
20333 message_suffix =
20334 .endd
20335 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20336 &`\n`& to &`\r\n`& in &%message_suffix%&.
20337
20338 .option mode appendfile "octal integer" 0600
20339 If the output file is created, it is given this mode. If it already exists and
20340 has wider permissions, they are reduced to this mode. If it has narrower
20341 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20342 if the delivery is the result of a &%save%& command in a filter file specifying
20343 a particular mode, the mode of the output file is always forced to take that
20344 value, and this option is ignored.
20345
20346
20347 .option mode_fail_narrower appendfile boolean true
20348 This option applies in the case when an existing mailbox file has a narrower
20349 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20350 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20351 continues with the delivery attempt, using the existing mode of the file.
20352
20353
20354 .option notify_comsat appendfile boolean false
20355 If this option is true, the &'comsat'& daemon is notified after every
20356 successful delivery to a user mailbox. This is the daemon that notifies logged
20357 on users about incoming mail.
20358
20359
20360 .option quota appendfile string&!! unset
20361 .cindex "quota" "imposed by Exim"
20362 This option imposes a limit on the size of the file to which Exim is appending,
20363 or to the total space used in the directory tree when the &%directory%& option
20364 is set. In the latter case, computation of the space used is expensive, because
20365 all the files in the directory (and any sub-directories) have to be
20366 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20367 &%maildir_use_size_file%& for ways to avoid this in environments where users
20368 have no shell access to their mailboxes).
20369
20370 As there is no interlock against two simultaneous deliveries into a
20371 multi-file mailbox, it is possible for the quota to be overrun in this case.
20372 For single-file mailboxes, of course, an interlock is a necessity.
20373
20374 A file's size is taken as its &'used'& value. Because of blocking effects, this
20375 may be a lot less than the actual amount of disk space allocated to the file.
20376 If the sizes of a number of files are being added up, the rounding effect can
20377 become quite noticeable, especially on systems that have large block sizes.
20378 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20379 the obvious value which users understand most easily.
20380
20381 The value of the option is expanded, and must then be a numerical value
20382 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20383 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20384 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20385 be handled.
20386
20387 &*Note*&: A value of zero is interpreted as &"no quota"&.
20388
20389 The expansion happens while Exim is running as root, before it changes uid for
20390 the delivery. This means that files that are inaccessible to the end user can
20391 be used to hold quota values that are looked up in the expansion. When delivery
20392 fails because this quota is exceeded, the handling of the error is as for
20393 system quota failures.
20394
20395 By default, Exim's quota checking mimics system quotas, and restricts the
20396 mailbox to the specified maximum size, though the value is not accurate to the
20397 last byte, owing to separator lines and additional headers that may get added
20398 during message delivery. When a mailbox is nearly full, large messages may get
20399 refused even though small ones are accepted, because the size of the current
20400 message is added to the quota when the check is made. This behaviour can be
20401 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20402 for exceeding the quota does not include the current message. Thus, deliveries
20403 continue until the quota has been exceeded; thereafter, no further messages are
20404 delivered. See also &%quota_warn_threshold%&.
20405
20406
20407 .option quota_directory appendfile string&!! unset
20408 This option defines the directory to check for quota purposes when delivering
20409 into individual files. The default is the delivery directory, or, if a file
20410 called &_maildirfolder_& exists in a maildir directory, the parent of the
20411 delivery directory.
20412
20413
20414 .option quota_filecount appendfile string&!! 0
20415 This option applies when the &%directory%& option is set. It limits the total
20416 number of files in the directory (compare the inode limit in system quotas). It
20417 can only be used if &%quota%& is also set. The value is expanded; an expansion
20418 failure causes delivery to be deferred. A value of zero is interpreted as
20419 &"no quota"&.
20420
20421
20422 .option quota_is_inclusive appendfile boolean true
20423 See &%quota%& above.
20424
20425
20426 .option quota_size_regex appendfile string unset
20427 This option applies when one of the delivery modes that writes a separate file
20428 for each message is being used. When Exim wants to find the size of one of
20429 these files in order to test the quota, it first checks &%quota_size_regex%&.
20430 If this is set to a regular expression that matches the file name, and it
20431 captures one string, that string is interpreted as a representation of the
20432 file's size. The value of &%quota_size_regex%& is not expanded.
20433
20434 This feature is useful only when users have no shell access to their mailboxes
20435 &-- otherwise they could defeat the quota simply by renaming the files. This
20436 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20437 the file length to the file name. For example:
20438 .code
20439 maildir_tag = ,S=$message_size
20440 quota_size_regex = ,S=(\d+)
20441 .endd
20442 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20443 number of lines in the message.
20444
20445 The regular expression should not assume that the length is at the end of the
20446 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20447 sometimes add other information onto the ends of message file names.
20448
20449 Section &<<SECID136>>& contains further information.
20450
20451
20452 .option quota_warn_message appendfile string&!! "see below"
20453 See below for the use of this option. If it is not set when
20454 &%quota_warn_threshold%& is set, it defaults to
20455 .code
20456 quota_warn_message = "\
20457   To: $local_part@$domain\n\
20458   Subject: Your mailbox\n\n\
20459   This message is automatically created \
20460   by mail delivery software.\n\n\
20461   The size of your mailbox has exceeded \
20462   a warning threshold that is\n\
20463   set by the system administrator.\n"
20464 .endd
20465
20466
20467 .option quota_warn_threshold appendfile string&!! 0
20468 .cindex "quota" "warning threshold"
20469 .cindex "mailbox" "size warning"
20470 .cindex "size" "of mailbox"
20471 This option is expanded in the same way as &%quota%& (see above). If the
20472 resulting value is greater than zero, and delivery of the message causes the
20473 size of the file or total space in the directory tree to cross the given
20474 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20475 may be specified as a percentage of it by following the value with a percent
20476 sign. For example:
20477 .code
20478 quota = 10M
20479 quota_warn_threshold = 75%
20480 .endd
20481 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20482 percent sign is ignored.
20483
20484 The warning message itself is specified by the &%quota_warn_message%& option,
20485 and it must start with a &'To:'& header line containing the recipient(s) of the
20486 warning message. These do not necessarily have to include the recipient(s) of
20487 the original message. A &'Subject:'& line should also normally be supplied. You
20488 can include any other header lines that you want. If you do not include a
20489 &'From:'& line, the default is:
20490 .code
20491 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20492 .endd
20493 .oindex &%errors_reply_to%&
20494 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20495 option.
20496
20497 The &%quota%& option does not have to be set in order to use this option; they
20498 are independent of one another except when the threshold is specified as a
20499 percentage.
20500
20501
20502 .option use_bsmtp appendfile boolean false
20503 .cindex "envelope sender"
20504 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20505 format, with the envelope sender and recipient(s) included as SMTP commands. If
20506 you want to include a leading HELO command with such messages, you can do
20507 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20508 for details of batch SMTP.
20509
20510
20511 .option use_crlf appendfile boolean false
20512 .cindex "carriage return"
20513 .cindex "linefeed"
20514 This option causes lines to be terminated with the two-character CRLF sequence
20515 (carriage return, linefeed) instead of just a linefeed character. In the case
20516 of batched SMTP, the byte sequence written to the file is then an exact image
20517 of what would be sent down a real SMTP connection.
20518
20519 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20520 (which are used to supply the traditional &"From&~"& and blank line separators
20521 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20522 carriage return characters if these are needed. In cases where these options
20523 have non-empty defaults, the values end with a single linefeed, so they must be
20524 changed to end with &`\r\n`& if &%use_crlf%& is set.
20525
20526
20527 .option use_fcntl_lock appendfile boolean "see below"
20528 This option controls the use of the &[fcntl()]& function to lock a file for
20529 exclusive use when a message is being appended. It is set by default unless
20530 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20531 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20532 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20533
20534
20535 .option use_flock_lock appendfile boolean false
20536 This option is provided to support the use of &[flock()]& for file locking, for
20537 the few situations where it is needed. Most modern operating systems support
20538 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20539 each other. Exim uses &[fcntl()]& locking by default.
20540
20541 This option is required only if you are using an operating system where
20542 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20543 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20544 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20545
20546 .cindex "Solaris" "&[flock()]& support"
20547 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20548 have it (and some, I think, provide a not quite right version built on top of
20549 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20550 the ability to use it, and any attempt to do so will cause a configuration
20551 error.
20552
20553 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20554 is just being mapped onto &[fcntl()]& by the OS).
20555
20556
20557 .option use_lockfile appendfile boolean "see below"
20558 If this option is turned off, Exim does not attempt to create a lock file when
20559 appending to a mailbox file. In this situation, the only locking is by
20560 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20561 sure that every MUA that is ever going to look at your users' mailboxes uses
20562 &[fcntl()]& rather than a lock file, and even then only when you are not
20563 delivering over NFS from more than one host.
20564
20565 .cindex "NFS" "lock file"
20566 In order to append to an NFS file safely from more than one host, it is
20567 necessary to take out a lock &'before'& opening the file, and the lock file
20568 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20569 file corruption.
20570
20571 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20572 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20573 except when &%mbx_format%& is set.
20574
20575
20576 .option use_mbx_lock appendfile boolean "see below"
20577 This option is available only if Exim has been compiled with SUPPORT_MBX
20578 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20579 locking rules be used. It is set by default if &%mbx_format%& is set and none
20580 of the locking options are mentioned in the configuration. The locking rules
20581 are the same as are used by the &'c-client'& library that underlies Pine and
20582 the IMAP4 and POP daemons that come with it (see the discussion below). The
20583 rules allow for shared access to the mailbox. However, this kind of locking
20584 does not work when the mailbox is NFS mounted.
20585
20586 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20587 &%use_flock_lock%& to control what kind of locking is used in implementing the
20588 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20589 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20590
20591
20592
20593
20594 .section "Operational details for appending" "SECTopappend"
20595 .cindex "appending to a file"
20596 .cindex "file" "appending"
20597 Before appending to a file, the following preparations are made:
20598
20599 .ilist
20600 If the name of the file is &_/dev/null_&, no action is taken, and a success
20601 return is given.
20602
20603 .next
20604 .cindex "directory creation"
20605 If any directories on the file's path are missing, Exim creates them if the
20606 &%create_directory%& option is set. A created directory's mode is given by the
20607 &%directory_mode%& option.
20608
20609 .next
20610 If &%file_format%& is set, the format of an existing file is checked. If this
20611 indicates that a different transport should be used, control is passed to that
20612 transport.
20613
20614 .next
20615 .cindex "file" "locking"
20616 .cindex "locking files"
20617 .cindex "NFS" "lock file"
20618 If &%use_lockfile%& is set, a lock file is built in a way that will work
20619 reliably over NFS, as follows:
20620
20621 .olist
20622 Create a &"hitching post"& file whose name is that of the lock file with the
20623 current time, primary host name, and process id added, by opening for writing
20624 as a new file. If this fails with an access error, delivery is deferred.
20625 .next
20626 Close the hitching post file, and hard link it to the lock file name.
20627 .next
20628 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20629 Unlink the hitching post name.
20630 .next
20631 Otherwise, use &[stat()]& to get information about the hitching post file, and
20632 then unlink hitching post name. If the number of links is exactly two, creation
20633 of the lock file succeeded but something (for example, an NFS server crash and
20634 restart) caused this fact not to be communicated to the &[link()]& call.
20635 .next
20636 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20637 up to &%lock_retries%& times. However, since any program that writes to a
20638 mailbox should complete its task very quickly, it is reasonable to time out old
20639 lock files that are normally the result of user agent and system crashes. If an
20640 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20641 it before trying again.
20642 .endlist olist
20643
20644 .next
20645 A call is made to &[lstat()]& to discover whether the main file exists, and if
20646 so, what its characteristics are. If &[lstat()]& fails for any reason other
20647 than non-existence, delivery is deferred.
20648
20649 .next
20650 .cindex "symbolic link" "to mailbox"
20651 .cindex "mailbox" "symbolic link"
20652 If the file does exist and is a symbolic link, delivery is deferred, unless the
20653 &%allow_symlink%& option is set, in which case the ownership of the link is
20654 checked, and then &[stat()]& is called to find out about the real file, which
20655 is then subjected to the checks below. The check on the top-level link
20656 ownership prevents one user creating a link for another's mailbox in a sticky
20657 directory, though allowing symbolic links in this case is definitely not a good
20658 idea. If there is a chain of symbolic links, the intermediate ones are not
20659 checked.
20660
20661 .next
20662 If the file already exists but is not a regular file, or if the file's owner
20663 and group (if the group is being checked &-- see &%check_group%& above) are
20664 different from the user and group under which the delivery is running,
20665 delivery is deferred.
20666
20667 .next
20668 If the file's permissions are more generous than specified, they are reduced.
20669 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20670 is set false, in which case the delivery is tried using the existing
20671 permissions.
20672
20673 .next
20674 The file's inode number is saved, and the file is then opened for appending.
20675 If this fails because the file has vanished, &(appendfile)& behaves as if it
20676 hadn't existed (see below). For any other failures, delivery is deferred.
20677
20678 .next
20679 If the file is opened successfully, check that the inode number hasn't
20680 changed, that it is still a regular file, and that the owner and permissions
20681 have not changed. If anything is wrong, defer delivery and freeze the message.
20682
20683 .next
20684 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20685 option is set. Otherwise, check that the file is being created in a permitted
20686 directory if the &%create_file%& option is set (deferring on failure), and then
20687 open for writing as a new file, with the O_EXCL and O_CREAT options,
20688 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20689 set). In this case, which can happen if the link points to a non-existent file,
20690 the file is opened for writing using O_CREAT but not O_EXCL, because
20691 that prevents link following.
20692
20693 .next
20694 .cindex "loop" "while file testing"
20695 If opening fails because the file exists, obey the tests given above for
20696 existing files. However, to avoid looping in a situation where the file is
20697 being continuously created and destroyed, the exists/not-exists loop is broken
20698 after 10 repetitions, and the message is then frozen.
20699
20700 .next
20701 If opening fails with any other error, defer delivery.
20702
20703 .next
20704 .cindex "file" "locking"
20705 .cindex "locking files"
20706 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20707 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20708 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20709 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20710 file, and an exclusive lock on the file whose name is
20711 .code
20712 /tmp/.<device-number>.<inode-number>
20713 .endd
20714 using the device and inode numbers of the open mailbox file, in accordance with
20715 the MBX locking rules. This file is created with a mode that is specified by
20716 the &%lockfile_mode%& option.
20717
20718 If Exim fails to lock the file, there are two possible courses of action,
20719 depending on the value of the locking timeout. This is obtained from
20720 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20721
20722 If the timeout value is zero, the file is closed, Exim waits for
20723 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20724 to lock it again. This happens up to &%lock_retries%& times, after which the
20725 delivery is deferred.
20726
20727 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20728 &[flock()]& are used (with the given timeout), so there has already been some
20729 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20730 immediately. It retries up to
20731 .code
20732 (lock_retries * lock_interval) / <timeout>
20733 .endd
20734 times (rounded up).
20735 .endlist
20736
20737 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20738 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20739
20740
20741 .section "Operational details for delivery to a new file" "SECTopdir"
20742 .cindex "delivery" "to single file"
20743 .cindex "&""From""& line"
20744 When the &%directory%& option is set instead of &%file%&, each message is
20745 delivered into a newly-created file or set of files. When &(appendfile)& is
20746 activated directly from a &(redirect)& router, neither &%file%& nor
20747 &%directory%& is normally set, because the path for delivery is supplied by the
20748 router. (See for example, the &(address_file)& transport in the default
20749 configuration.) In this case, delivery is to a new file if either the path name
20750 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20751
20752 No locking is required while writing the message to a new file, so the various
20753 locking options of the transport are ignored. The &"From"& line that by default
20754 separates messages in a single file is not normally needed, nor is the escaping
20755 of message lines that start with &"From"&, and there is no need to ensure a
20756 newline at the end of each message. Consequently, the default values for
20757 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20758 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20759
20760 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20761 the files in the delivery directory by default. However, you can specify a
20762 different directory by setting &%quota_directory%&. Also, for maildir
20763 deliveries (see below) the &_maildirfolder_& convention is honoured.
20764
20765
20766 .cindex "maildir format"
20767 .cindex "mailstore format"
20768 There are three different ways in which delivery to individual files can be
20769 done, controlled by the settings of the &%maildir_format%& and
20770 &%mailstore_format%& options. Note that code to support maildir or mailstore
20771 formats is not included in the binary unless SUPPORT_MAILDIR or
20772 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20773
20774 .cindex "directory creation"
20775 In all three cases an attempt is made to create the directory and any necessary
20776 sub-directories if they do not exist, provided that the &%create_directory%&
20777 option is set (the default). The location of a created directory can be
20778 constrained by setting &%create_file%&. A created directory's mode is given by
20779 the &%directory_mode%& option. If creation fails, or if the
20780 &%create_directory%& option is not set when creation is required, delivery is
20781 deferred.
20782
20783
20784
20785 .section "Maildir delivery" "SECTmaildirdelivery"
20786 .cindex "maildir format" "description of"
20787 If the &%maildir_format%& option is true, Exim delivers each message by writing
20788 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20789 directory that is defined by the &%directory%& option (the &"delivery
20790 directory"&). If the delivery is successful, the file is renamed into the
20791 &_new_& subdirectory.
20792
20793 In the file name, <&'stime'&> is the current time of day in seconds, and
20794 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20795 Exim checks that the time-of-day clock has moved on by at least one microsecond
20796 before terminating the delivery process. This guarantees uniqueness for the
20797 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20798 opening it. If any response other than ENOENT (does not exist) is given,
20799 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20800
20801 Before Exim carries out a maildir delivery, it ensures that subdirectories
20802 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20803 do not exist, Exim tries to create them and any superior directories in their
20804 path, subject to the &%create_directory%& and &%create_file%& options. If the
20805 &%maildirfolder_create_regex%& option is set, and the regular expression it
20806 contains matches the delivery directory, Exim also ensures that a file called
20807 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20808 &_maildirfolder_& file cannot be created, delivery is deferred.
20809
20810 These features make it possible to use Exim to create all the necessary files
20811 and directories in a maildir mailbox, including subdirectories for maildir++
20812 folders. Consider this example:
20813 .code
20814 maildir_format = true
20815 directory = /var/mail/$local_part\
20816            ${if eq{$local_part_suffix}{}{}\
20817            {/.${substr_1:$local_part_suffix}}}
20818 maildirfolder_create_regex = /\.[^/]+$
20819 .endd
20820 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20821 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20822 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20823 not match this name, so Exim will not look for or create the file
20824 &_/var/mail/pimbo/maildirfolder_&, though it will create
20825 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20826
20827 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20828 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20829 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20830 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20831 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20832
20833 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20834 not inadvertently match the toplevel maildir directory, because a
20835 &_maildirfolder_& file at top level would completely break quota calculations.
20836
20837 .cindex "quota" "in maildir delivery"
20838 .cindex "maildir++"
20839 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20840 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20841 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20842 Exim assumes the directory is a maildir++ folder directory, which is one level
20843 down from the user's top level mailbox directory. This causes it to start at
20844 the parent directory instead of the current directory when calculating the
20845 amount of space used.
20846
20847 One problem with delivering into a multi-file mailbox is that it is
20848 computationally expensive to compute the size of the mailbox for quota
20849 checking. Various approaches have been taken to reduce the amount of work
20850 needed. The next two sections describe two of them. A third alternative is to
20851 use some external process for maintaining the size data, and use the expansion
20852 of the &%mailbox_size%& option as a way of importing it into Exim.
20853
20854
20855
20856
20857 .section "Using tags to record message sizes" "SECID135"
20858 If &%maildir_tag%& is set, the string is expanded for each delivery.
20859 When the maildir file is renamed into the &_new_& sub-directory, the
20860 tag is added to its name. However, if adding the tag takes the length of the
20861 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20862 the tag is dropped and the maildir file is created with no tag.
20863
20864
20865 .vindex "&$message_size$&"
20866 Tags can be used to encode the size of files in their names; see
20867 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20868 happens after the message has been written. The value of the &$message_size$&
20869 variable is set to the number of bytes actually written. If the expansion is
20870 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20871 be deferred. The expanded tag may contain any printing characters except &"/"&.
20872 Non-printing characters in the string are ignored; if the resulting string is
20873 empty, it is ignored. If it starts with an alphanumeric character, a leading
20874 colon is inserted; this default has not proven to be the path that popular
20875 maildir implementations have chosen (but changing it in Exim would break
20876 backwards compatibility).
20877
20878 For one common implementation, you might set:
20879 .code
20880 maildir_tag = ,S=${message_size}
20881 .endd
20882 but you should check the documentation of the other software to be sure.
20883
20884 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
20885 as this allows Exim to extract the size from your tag, instead of having to
20886 &[stat()]& each message file.
20887
20888
20889 .section "Using a maildirsize file" "SECID136"
20890 .cindex "quota" "in maildir delivery"
20891 .cindex "maildir format" "&_maildirsize_& file"
20892 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20893 storing quota and message size information in a file called &_maildirsize_&
20894 within the toplevel maildir directory. If this file does not exist, Exim
20895 creates it, setting the quota from the &%quota%& option of the transport. If
20896 the maildir directory itself does not exist, it is created before any attempt
20897 to write a &_maildirsize_& file.
20898
20899 The &_maildirsize_& file is used to hold information about the sizes of
20900 messages in the maildir, thus speeding up quota calculations. The quota value
20901 in the file is just a cache; if the quota is changed in the transport, the new
20902 value overrides the cached value when the next message is delivered. The cache
20903 is maintained for the benefit of other programs that access the maildir and
20904 need to know the quota.
20905
20906 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20907 file is maintained (with a zero quota setting), but no quota is imposed.
20908
20909 A regular expression is available for controlling which directories in the
20910 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20911 See the description of the &%maildir_quota_directory_regex%& option above for
20912 details.
20913
20914
20915 .section "Mailstore delivery" "SECID137"
20916 .cindex "mailstore format" "description of"
20917 If the &%mailstore_format%& option is true, each message is written as two
20918 files in the given directory. A unique base name is constructed from the
20919 message id and the current delivery process, and the files that are written use
20920 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20921 contains the message's envelope, and the &_.msg_& file contains the message
20922 itself. The base name is placed in the variable &$mailstore_basename$&.
20923
20924 During delivery, the envelope is first written to a file with the suffix
20925 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20926 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20927 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20928 file before accessing either of them. An alternative approach is to wait for
20929 the absence of a &_.tmp_& file.
20930
20931 The envelope file starts with any text defined by the &%mailstore_prefix%&
20932 option, expanded and terminated by a newline if there isn't one. Then follows
20933 the sender address on one line, then all the recipient addresses, one per line.
20934 There can be more than one recipient only if the &%batch_max%& option is set
20935 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20936 appended to the file, followed by a newline if it does not end with one.
20937
20938 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20939 failure, it is ignored. Other expansion errors are treated as serious
20940 configuration errors, and delivery is deferred. The variable
20941 &$mailstore_basename$& is available for use during these expansions.
20942
20943
20944 .section "Non-special new file delivery" "SECID138"
20945 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20946 file is created directly in the named directory. For example, when delivering
20947 messages into files in batched SMTP format for later delivery to some host (see
20948 section &<<SECTbatchSMTP>>&), a setting such as
20949 .code
20950 directory = /var/bsmtp/$host
20951 .endd
20952 might be used. A message is written to a file with a temporary name, which is
20953 then renamed when the delivery is complete. The final name is obtained by
20954 expanding the contents of the &%directory_file%& option.
20955 .ecindex IIDapptra1
20956 .ecindex IIDapptra2
20957
20958
20959
20960
20961
20962
20963 . ////////////////////////////////////////////////////////////////////////////
20964 . ////////////////////////////////////////////////////////////////////////////
20965
20966 .chapter "The autoreply transport" "CHID8"
20967 .scindex IIDauttra1 "transports" "&(autoreply)&"
20968 .scindex IIDauttra2 "&(autoreply)& transport"
20969 The &(autoreply)& transport is not a true transport in that it does not cause
20970 the message to be transmitted. Instead, it generates a new mail message as an
20971 automatic reply to the incoming message. &'References:'& and
20972 &'Auto-Submitted:'& header lines are included. These are constructed according
20973 to the rules in RFCs 2822 and 3834, respectively.
20974
20975 If the router that passes the message to this transport does not have the
20976 &%unseen%& option set, the original message (for the current recipient) is not
20977 delivered anywhere. However, when the &%unseen%& option is set on the router
20978 that passes the message to this transport, routing of the address continues, so
20979 another router can set up a normal message delivery.
20980
20981
20982 The &(autoreply)& transport is usually run as the result of mail filtering, a
20983 &"vacation"& message being the standard example. However, it can also be run
20984 directly from a router like any other transport. To reduce the possibility of
20985 message cascades, messages created by the &(autoreply)& transport always have
20986 empty envelope sender addresses, like bounce messages.
20987
20988 The parameters of the message to be sent can be specified in the configuration
20989 by options described below. However, these are used only when the address
20990 passed to the transport does not contain its own reply information. When the
20991 transport is run as a consequence of a
20992 &%mail%&
20993 or &%vacation%& command in a filter file, the parameters of the message are
20994 supplied by the filter, and passed with the address. The transport's options
20995 that define the message are then ignored (so they are not usually set in this
20996 case). The message is specified entirely by the filter or by the transport; it
20997 is never built from a mixture of options. However, the &%file_optional%&,
20998 &%mode%&, and &%return_message%& options apply in all cases.
20999
21000 &(Autoreply)& is implemented as a local transport. When used as a result of a
21001 command in a user's filter file, &(autoreply)& normally runs under the uid and
21002 gid of the user, and with appropriate current and home directories (see chapter
21003 &<<CHAPenvironment>>&).
21004
21005 There is a subtle difference between routing a message to a &(pipe)& transport
21006 that generates some text to be returned to the sender, and routing it to an
21007 &(autoreply)& transport. This difference is noticeable only if more than one
21008 address from the same message is so handled. In the case of a pipe, the
21009 separate outputs from the different addresses are gathered up and returned to
21010 the sender in a single message, whereas if &(autoreply)& is used, a separate
21011 message is generated for each address that is passed to it.
21012
21013 Non-printing characters are not permitted in the header lines generated for the
21014 message that &(autoreply)& creates, with the exception of newlines that are
21015 immediately followed by white space. If any non-printing characters are found,
21016 the transport defers.
21017 Whether characters with the top bit set count as printing characters or not is
21018 controlled by the &%print_topbitchars%& global option.
21019
21020 If any of the generic options for manipulating headers (for example,
21021 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21022 of the original message that is included in the generated message when
21023 &%return_message%& is set. They do not apply to the generated message itself.
21024
21025 .vindex "&$sender_address$&"
21026 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21027 the message, indicating that there were no recipients, it does not treat this
21028 as an error. This means that autoreplies sent to &$sender_address$& when this
21029 is empty (because the incoming message is a bounce message) do not cause
21030 problems. They are just discarded.
21031
21032
21033
21034 .section "Private options for autoreply" "SECID139"
21035 .cindex "options" "&(autoreply)& transport"
21036
21037 .option bcc autoreply string&!! unset
21038 This specifies the addresses that are to receive &"blind carbon copies"& of the
21039 message when the message is specified by the transport.
21040
21041
21042 .option cc autoreply string&!! unset
21043 This specifies recipients of the message and the contents of the &'Cc:'& header
21044 when the message is specified by the transport.
21045
21046
21047 .option file autoreply string&!! unset
21048 The contents of the file are sent as the body of the message when the message
21049 is specified by the transport. If both &%file%& and &%text%& are set, the text
21050 string comes first.
21051
21052
21053 .option file_expand autoreply boolean false
21054 If this is set, the contents of the file named by the &%file%& option are
21055 subjected to string expansion as they are added to the message.
21056
21057
21058 .option file_optional autoreply boolean false
21059 If this option is true, no error is generated if the file named by the &%file%&
21060 option or passed with the address does not exist or cannot be read.
21061
21062
21063 .option from autoreply string&!! unset
21064 This specifies the contents of the &'From:'& header when the message is
21065 specified by the transport.
21066
21067
21068 .option headers autoreply string&!! unset
21069 This specifies additional RFC 2822 headers that are to be added to the message
21070 when the message is specified by the transport. Several can be given by using
21071 &"\n"& to separate them. There is no check on the format.
21072
21073
21074 .option log autoreply string&!! unset
21075 This option names a file in which a record of every message sent is logged when
21076 the message is specified by the transport.
21077
21078
21079 .option mode autoreply "octal integer" 0600
21080 If either the log file or the &"once"& file has to be created, this mode is
21081 used.
21082
21083
21084 .option never_mail autoreply "address list&!!" unset
21085 If any run of the transport creates a message with a recipient that matches any
21086 item in the list, that recipient is quietly discarded. If all recipients are
21087 discarded, no message is created. This applies both when the recipients are
21088 generated by a filter and when they are specified in the transport.
21089
21090
21091
21092 .option once autoreply string&!! unset
21093 This option names a file or DBM database in which a record of each &'To:'&
21094 recipient is kept when the message is specified by the transport. &*Note*&:
21095 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21096
21097 If &%once%& is unset, or is set to an empty string, the message is always sent.
21098 By default, if &%once%& is set to a non-empty file name, the message
21099 is not sent if a potential recipient is already listed in the database.
21100 However, if the &%once_repeat%& option specifies a time greater than zero, the
21101 message is sent if that much time has elapsed since a message was last sent to
21102 this recipient. A setting of zero time for &%once_repeat%& (the default)
21103 prevents a message from being sent a second time &-- in this case, zero means
21104 infinity.
21105
21106 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21107 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21108 greater than zero, it changes the way Exim implements the &%once%& option.
21109 Instead of using a DBM file to record every recipient it sends to, it uses a
21110 regular file, whose size will never get larger than the given value.
21111
21112 In the file, Exim keeps a linear list of recipient addresses and the times at
21113 which they were sent messages. If the file is full when a new address needs to
21114 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21115 means that a given recipient may receive multiple messages, but at
21116 unpredictable intervals that depend on the rate of turnover of addresses in the
21117 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21118
21119
21120 .option once_file_size autoreply integer 0
21121 See &%once%& above.
21122
21123
21124 .option once_repeat autoreply time&!! 0s
21125 See &%once%& above.
21126 After expansion, the value of this option must be a valid time value.
21127
21128
21129 .option reply_to autoreply string&!! unset
21130 This specifies the contents of the &'Reply-To:'& header when the message is
21131 specified by the transport.
21132
21133
21134 .option return_message autoreply boolean false
21135 If this is set, a copy of the original message is returned with the new
21136 message, subject to the maximum size set in the &%return_size_limit%& global
21137 configuration option.
21138
21139
21140 .option subject autoreply string&!! unset
21141 This specifies the contents of the &'Subject:'& header when the message is
21142 specified by the transport. It is tempting to quote the original subject in
21143 automatic responses. For example:
21144 .code
21145 subject = Re: $h_subject:
21146 .endd
21147 There is a danger in doing this, however. It may allow a third party to
21148 subscribe your users to an opt-in mailing list, provided that the list accepts
21149 bounce messages as subscription confirmations. Well-managed lists require a
21150 non-bounce message to confirm a subscription, so the danger is relatively
21151 small.
21152
21153
21154
21155 .option text autoreply string&!! unset
21156 This specifies a single string to be used as the body of the message when the
21157 message is specified by the transport. If both &%text%& and &%file%& are set,
21158 the text comes first.
21159
21160
21161 .option to autoreply string&!! unset
21162 This specifies recipients of the message and the contents of the &'To:'& header
21163 when the message is specified by the transport.
21164 .ecindex IIDauttra1
21165 .ecindex IIDauttra2
21166
21167
21168
21169
21170 . ////////////////////////////////////////////////////////////////////////////
21171 . ////////////////////////////////////////////////////////////////////////////
21172
21173 .chapter "The lmtp transport" "CHAPLMTP"
21174 .cindex "transports" "&(lmtp)&"
21175 .cindex "&(lmtp)& transport"
21176 .cindex "LMTP" "over a pipe"
21177 .cindex "LMTP" "over a socket"
21178 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21179 specified command
21180 or by interacting with a Unix domain socket.
21181 This transport is something of a cross between the &(pipe)& and &(smtp)&
21182 transports. Exim also has support for using LMTP over TCP/IP; this is
21183 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21184 to be of minority interest, the default build-time configure in &_src/EDITME_&
21185 has it commented out. You need to ensure that
21186 .code
21187 TRANSPORT_LMTP=yes
21188 .endd
21189 .cindex "options" "&(lmtp)& transport"
21190 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21191 included in the Exim binary. The private options of the &(lmtp)& transport are
21192 as follows:
21193
21194 .option batch_id lmtp string&!! unset
21195 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21196
21197
21198 .option batch_max lmtp integer 1
21199 This limits the number of addresses that can be handled in a single delivery.
21200 Most LMTP servers can handle several addresses at once, so it is normally a
21201 good idea to increase this value. See the description of local delivery
21202 batching in chapter &<<CHAPbatching>>&.
21203
21204
21205 .option command lmtp string&!! unset
21206 This option must be set if &%socket%& is not set. The string is a command which
21207 is run in a separate process. It is split up into a command name and list of
21208 arguments, each of which is separately expanded (so expansion cannot change the
21209 number of arguments). The command is run directly, not via a shell. The message
21210 is passed to the new process using the standard input and output to operate the
21211 LMTP protocol.
21212
21213 .option ignore_quota lmtp boolean false
21214 .cindex "LMTP" "ignoring quota errors"
21215 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21216 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21217 in its response to the LHLO command.
21218
21219 .option socket lmtp string&!! unset
21220 This option must be set if &%command%& is not set. The result of expansion must
21221 be the name of a Unix domain socket. The transport connects to the socket and
21222 delivers the message to it using the LMTP protocol.
21223
21224
21225 .option timeout lmtp time 5m
21226 The transport is aborted if the created process or Unix domain socket does not
21227 respond to LMTP commands or message input within this timeout. Delivery
21228 is deferred, and will be tried again later. Here is an example of a typical
21229 LMTP transport:
21230 .code
21231 lmtp:
21232   driver = lmtp
21233   command = /some/local/lmtp/delivery/program
21234   batch_max = 20
21235   user = exim
21236 .endd
21237 This delivers up to 20 addresses at a time, in a mixture of domains if
21238 necessary, running as the user &'exim'&.
21239
21240
21241
21242 . ////////////////////////////////////////////////////////////////////////////
21243 . ////////////////////////////////////////////////////////////////////////////
21244
21245 .chapter "The pipe transport" "CHAPpipetransport"
21246 .scindex IIDpiptra1 "transports" "&(pipe)&"
21247 .scindex IIDpiptra2 "&(pipe)& transport"
21248 The &(pipe)& transport is used to deliver messages via a pipe to a command
21249 running in another process. One example is the use of &(pipe)& as a
21250 pseudo-remote transport for passing messages to some other delivery mechanism
21251 (such as UUCP). Another is the use by individual users to automatically process
21252 their incoming messages. The &(pipe)& transport can be used in one of the
21253 following ways:
21254
21255 .ilist
21256 .vindex "&$local_part$&"
21257 A router routes one address to a transport in the normal way, and the
21258 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21259 contains the local part of the address (as usual), and the command that is run
21260 is specified by the &%command%& option on the transport.
21261 .next
21262 .vindex "&$pipe_addresses$&"
21263 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21264 transport can handle more than one address in a single run. In this case, when
21265 more than one address is routed to the transport, &$local_part$& is not set
21266 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21267 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21268 that are routed to the transport.
21269 .next
21270 .vindex "&$address_pipe$&"
21271 A router redirects an address directly to a pipe command (for example, from an
21272 alias or forward file). In this case, &$address_pipe$& contains the text of the
21273 pipe command, and the &%command%& option on the transport is ignored. If only
21274 one address is being transported (&%batch_max%& is not greater than one, or
21275 only one address was redirected to this pipe command), &$local_part$& contains
21276 the local part that was redirected.
21277 .endlist
21278
21279
21280 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21281 deliver messages over pipes using the LMTP interactive protocol. This is
21282 implemented by the &(lmtp)& transport.
21283
21284 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21285 &_.forward_& file, the command runs under the uid and gid of that user. In
21286 other cases, the uid and gid have to be specified explicitly, either on the
21287 transport or on the router that handles the address. Current and &"home"&
21288 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21289 details of the local delivery environment and chapter &<<CHAPbatching>>&
21290 for a discussion of local delivery batching.
21291
21292
21293 .section "Concurrent delivery" "SECID140"
21294 If two messages arrive at almost the same time, and both are routed to a pipe
21295 delivery, the two pipe transports may be run concurrently. You must ensure that
21296 any pipe commands you set up are robust against this happening. If the commands
21297 write to a file, the &%exim_lock%& utility might be of use.
21298
21299
21300
21301
21302 .section "Returned status and data" "SECID141"
21303 .cindex "&(pipe)& transport" "returned data"
21304 If the command exits with a non-zero return code, the delivery is deemed to
21305 have failed, unless either the &%ignore_status%& option is set (in which case
21306 the return code is treated as zero), or the return code is one of those listed
21307 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21308 later"&. In this case, delivery is deferred. Details of a permanent failure are
21309 logged, but are not included in the bounce message, which merely contains
21310 &"local delivery failed"&.
21311
21312 If the command exits on a signal and the &%freeze_signal%& option is set then
21313 the message will be frozen in the queue. If that option is not set, a bounce
21314 will be sent as normal.
21315
21316 If the return code is greater than 128 and the command being run is a shell
21317 script, it normally means that the script was terminated by a signal whose
21318 value is the return code minus 128. The &%freeze_signal%& option does not
21319 apply in this case.
21320
21321 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21322 return code is set to 127. This is the value that a shell returns if it is
21323 asked to run a non-existent command. The wording for the log line suggests that
21324 a non-existent command may be the problem.
21325
21326 The &%return_output%& option can affect the result of a pipe delivery. If it is
21327 set and the command produces any output on its standard output or standard
21328 error streams, the command is considered to have failed, even if it gave a zero
21329 return code or if &%ignore_status%& is set. The output from the command is
21330 included as part of the bounce message. The &%return_fail_output%& option is
21331 similar, except that output is returned only when the command exits with a
21332 failure return code, that is, a value other than zero or a code that matches
21333 &%temp_errors%&.
21334
21335
21336
21337 .section "How the command is run" "SECThowcommandrun"
21338 .cindex "&(pipe)& transport" "path for command"
21339 The command line is (by default) broken down into a command name and arguments
21340 by the &(pipe)& transport itself. The &%allow_commands%& and
21341 &%restrict_to_path%& options can be used to restrict the commands that may be
21342 run.
21343
21344 .cindex "quoting" "in pipe command"
21345 Unquoted arguments are delimited by white space. If an argument appears in
21346 double quotes, backslash is interpreted as an escape character in the usual
21347 way. If an argument appears in single quotes, no escaping is done.
21348
21349 String expansion is applied to the command line except when it comes from a
21350 traditional &_.forward_& file (commands from a filter file are expanded). The
21351 expansion is applied to each argument in turn rather than to the whole line.
21352 For this reason, any string expansion item that contains white space must be
21353 quoted so as to be contained within a single argument. A setting such as
21354 .code
21355 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21356 .endd
21357 will not work, because the expansion item gets split between several
21358 arguments. You have to write
21359 .code
21360 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21361 .endd
21362 to ensure that it is all in one argument. The expansion is done in this way,
21363 argument by argument, so that the number of arguments cannot be changed as a
21364 result of expansion, and quotes or backslashes in inserted variables do not
21365 interact with external quoting. However, this leads to problems if you want to
21366 generate multiple arguments (or the command name plus arguments) from a single
21367 expansion. In this situation, the simplest solution is to use a shell. For
21368 example:
21369 .code
21370 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21371 .endd
21372
21373 .cindex "transport" "filter"
21374 .cindex "filter" "transport filter"
21375 .vindex "&$pipe_addresses$&"
21376 Special handling takes place when an argument consists of precisely the text
21377 &`$pipe_addresses`&. This is not a general expansion variable; the only
21378 place this string is recognized is when it appears as an argument for a pipe or
21379 transport filter command. It causes each address that is being handled to be
21380 inserted in the argument list at that point &'as a separate argument'&. This
21381 avoids any problems with spaces or shell metacharacters, and is of use when a
21382 &(pipe)& transport is handling groups of addresses in a batch.
21383
21384 After splitting up into arguments and expansion, the resulting command is run
21385 in a subprocess directly from the transport, &'not'& under a shell. The
21386 message that is being delivered is supplied on the standard input, and the
21387 standard output and standard error are both connected to a single pipe that is
21388 read by Exim. The &%max_output%& option controls how much output the command
21389 may produce, and the &%return_output%& and &%return_fail_output%& options
21390 control what is done with it.
21391
21392 Not running the command under a shell (by default) lessens the security risks
21393 in cases when a command from a user's filter file is built out of data that was
21394 taken from an incoming message. If a shell is required, it can of course be
21395 explicitly specified as the command to be run. However, there are circumstances
21396 where existing commands (for example, in &_.forward_& files) expect to be run
21397 under a shell and cannot easily be modified. To allow for these cases, there is
21398 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21399 works. Instead of breaking up the command line as just described, it expands it
21400 as a single string and passes the result to &_/bin/sh_&. The
21401 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21402 with &%use_shell%&, and the whole mechanism is inherently less secure.
21403
21404
21405
21406 .section "Environment variables" "SECTpipeenv"
21407 .cindex "&(pipe)& transport" "environment for command"
21408 .cindex "environment for pipe transport"
21409 The environment variables listed below are set up when the command is invoked.
21410 This list is a compromise for maximum compatibility with other MTAs. Note that
21411 the &%environment%& option can be used to add additional variables to this
21412 environment.
21413 .display
21414 &`DOMAIN            `&   the domain of the address
21415 &`HOME              `&   the home directory, if set
21416 &`HOST              `&   the host name when called from a router (see below)
21417 &`LOCAL_PART        `&   see below
21418 &`LOCAL_PART_PREFIX `&   see below
21419 &`LOCAL_PART_SUFFIX `&   see below
21420 &`LOGNAME           `&   see below
21421 &`MESSAGE_ID        `&   Exim's local ID for the message
21422 &`PATH              `&   as specified by the &%path%& option below
21423 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21424 &`RECIPIENT         `&   the complete recipient address
21425 &`SENDER            `&   the sender of the message (empty if a bounce)
21426 &`SHELL             `&   &`/bin/sh`&
21427 &`TZ                `&   the value of the &%timezone%& option, if set
21428 &`USER              `&   see below
21429 .endd
21430 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21431 router, LOCAL_PART is set to the local part of the address. When it is
21432 called as a result of a forward or alias expansion, LOCAL_PART is set to
21433 the local part of the address that was expanded. In both cases, any affixes are
21434 removed from the local part, and made available in LOCAL_PART_PREFIX and
21435 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21436 same value as LOCAL_PART for compatibility with other MTAs.
21437
21438 .cindex "HOST"
21439 HOST is set only when a &(pipe)& transport is called from a router that
21440 associates hosts with an address, typically when using &(pipe)& as a
21441 pseudo-remote transport. HOST is set to the first host name specified by
21442 the router.
21443
21444 .cindex "HOME"
21445 If the transport's generic &%home_directory%& option is set, its value is used
21446 for the HOME environment variable. Otherwise, a home directory may be set
21447 by the router's &%transport_home_directory%& option, which defaults to the
21448 user's home directory if &%check_local_user%& is set.
21449
21450
21451 .section "Private options for pipe" "SECID142"
21452 .cindex "options" "&(pipe)& transport"
21453
21454
21455
21456 .option allow_commands pipe "string list&!!" unset
21457 .cindex "&(pipe)& transport" "permitted commands"
21458 The string is expanded, and is then interpreted as a colon-separated list of
21459 permitted commands. If &%restrict_to_path%& is not set, the only commands
21460 permitted are those in the &%allow_commands%& list. They need not be absolute
21461 paths; the &%path%& option is still used for relative paths. If
21462 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21463 in the &%allow_commands%& list, or a name without any slashes that is found on
21464 the path. In other words, if neither &%allow_commands%& nor
21465 &%restrict_to_path%& is set, there is no restriction on the command, but
21466 otherwise only commands that are permitted by one or the other are allowed. For
21467 example, if
21468 .code
21469 allow_commands = /usr/bin/vacation
21470 .endd
21471 and &%restrict_to_path%& is not set, the only permitted command is
21472 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21473 &%use_shell%& is set.
21474
21475
21476 .option batch_id pipe string&!! unset
21477 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21478
21479
21480 .option batch_max pipe integer 1
21481 This limits the number of addresses that can be handled in a single delivery.
21482 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21483
21484
21485 .option check_string pipe string unset
21486 As &(pipe)& writes the message, the start of each line is tested for matching
21487 &%check_string%&, and if it does, the initial matching characters are replaced
21488 by the contents of &%escape_string%&, provided both are set. The value of
21489 &%check_string%& is a literal string, not a regular expression, and the case of
21490 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21491 of &%check_string%& and &%escape_string%& are forced to values that implement
21492 the SMTP escaping protocol. Any settings made in the configuration file are
21493 ignored.
21494
21495
21496 .option command pipe string&!! unset
21497 This option need not be set when &(pipe)& is being used to deliver to pipes
21498 obtained directly from address redirections. In other cases, the option must be
21499 set, to provide a command to be run. It need not yield an absolute path (see
21500 the &%path%& option below). The command is split up into separate arguments by
21501 Exim, and each argument is separately expanded, as described in section
21502 &<<SECThowcommandrun>>& above.
21503
21504
21505 .option environment pipe string&!! unset
21506 .cindex "&(pipe)& transport" "environment for command"
21507 .cindex "environment for &(pipe)& transport"
21508 This option is used to add additional variables to the environment in which the
21509 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21510 a string which is expanded, and then interpreted as a colon-separated list of
21511 environment settings of the form <&'name'&>=<&'value'&>.
21512
21513
21514 .option escape_string pipe string unset
21515 See &%check_string%& above.
21516
21517
21518 .option freeze_exec_fail pipe boolean false
21519 .cindex "exec failure"
21520 .cindex "failure of exec"
21521 .cindex "&(pipe)& transport" "failure of exec"
21522 Failure to exec the command in a pipe transport is by default treated like
21523 any other failure while running the command. However, if &%freeze_exec_fail%&
21524 is set, failure to exec is treated specially, and causes the message to be
21525 frozen, whatever the setting of &%ignore_status%&.
21526
21527
21528 .option freeze_signal pipe boolean false
21529 .cindex "signal exit"
21530 .cindex "&(pipe)& transport", "signal exit"
21531 Normally if the process run by a command in a pipe transport exits on a signal,
21532 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21533 frozen in Exim's queue instead.
21534
21535
21536 .option ignore_status pipe boolean false
21537 If this option is true, the status returned by the subprocess that is set up to
21538 run the command is ignored, and Exim behaves as if zero had been returned.
21539 Otherwise, a non-zero status or termination by signal causes an error return
21540 from the transport unless the status value is one of those listed in
21541 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21542
21543 &*Note*&: This option does not apply to timeouts, which do not return a status.
21544 See the &%timeout_defer%& option for how timeouts are handled.
21545
21546 .option log_defer_output pipe boolean false
21547 .cindex "&(pipe)& transport" "logging output"
21548 If this option is set, and the status returned by the command is
21549 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21550 and any output was produced, the first line of it is written to the main log.
21551
21552
21553 .option log_fail_output pipe boolean false
21554 If this option is set, and the command returns any output, and also ends with a
21555 return code that is neither zero nor one of the return codes listed in
21556 &%temp_errors%& (that is, the delivery failed), the first line of output is
21557 written to the main log. This option and &%log_output%& are mutually exclusive.
21558 Only one of them may be set.
21559
21560
21561
21562 .option log_output pipe boolean false
21563 If this option is set and the command returns any output, the first line of
21564 output is written to the main log, whatever the return code. This option and
21565 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21566
21567
21568
21569 .option max_output pipe integer 20K
21570 This specifies the maximum amount of output that the command may produce on its
21571 standard output and standard error file combined. If the limit is exceeded, the
21572 process running the command is killed. This is intended as a safety measure to
21573 catch runaway processes. The limit is applied independently of the settings of
21574 the options that control what is done with such output (for example,
21575 &%return_output%&). Because of buffering effects, the amount of output may
21576 exceed the limit by a small amount before Exim notices.
21577
21578
21579 .option message_prefix pipe string&!! "see below"
21580 The string specified here is expanded and output at the start of every message.
21581 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21582 .code
21583 message_prefix = \
21584   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21585   ${tod_bsdinbox}\n
21586 .endd
21587 .cindex "Cyrus"
21588 .cindex "&%tmail%&"
21589 .cindex "&""From""& line"
21590 This is required by the commonly used &_/usr/bin/vacation_& program.
21591 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21592 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21593 setting
21594 .code
21595 message_prefix =
21596 .endd
21597 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21598 &`\n`& to &`\r\n`& in &%message_prefix%&.
21599
21600
21601 .option message_suffix pipe string&!! "see below"
21602 The string specified here is expanded and output at the end of every message.
21603 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21604 The suffix can be suppressed by setting
21605 .code
21606 message_suffix =
21607 .endd
21608 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21609 &`\n`& to &`\r\n`& in &%message_suffix%&.
21610
21611
21612 .option path pipe string "see below"
21613 This option specifies the string that is set up in the PATH environment
21614 variable of the subprocess. The default is:
21615 .code
21616 /bin:/usr/bin
21617 .endd
21618 If the &%command%& option does not yield an absolute path name, the command is
21619 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21620 apply to a command specified as a transport filter.
21621
21622
21623 .option permit_coredump pipe boolean false
21624 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21625 a core-dump of a pipe command, enable this command.  This enables core-dumps
21626 during delivery and affects both the Exim binary and the pipe command run.
21627 It is recommended that this option remain off unless and until you have a need
21628 for it and that this only be enabled when needed, as the risk of excessive
21629 resource consumption can be quite high.  Note also that Exim is typically
21630 installed as a setuid binary and most operating systems will inhibit coredumps
21631 of these by default, so further OS-specific action may be required.
21632
21633
21634 .option pipe_as_creator pipe boolean false
21635 .cindex "uid (user id)" "local delivery"
21636 If the generic &%user%& option is not set and this option is true, the delivery
21637 process is run under the uid that was in force when Exim was originally called
21638 to accept the message. If the group id is not otherwise set (via the generic
21639 &%group%& option), the gid that was in force when Exim was originally called to
21640 accept the message is used.
21641
21642
21643 .option restrict_to_path pipe boolean false
21644 When this option is set, any command name not listed in &%allow_commands%& must
21645 contain no slashes. The command is searched for only in the directories listed
21646 in the &%path%& option. This option is intended for use in the case when a pipe
21647 command has been generated from a user's &_.forward_& file. This is usually
21648 handled by a &(pipe)& transport called &%address_pipe%&.
21649
21650
21651 .option return_fail_output pipe boolean false
21652 If this option is true, and the command produced any output and ended with a
21653 return code other than zero or one of the codes listed in &%temp_errors%& (that
21654 is, the delivery failed), the output is returned in the bounce message.
21655 However, if the message has a null sender (that is, it is itself a bounce
21656 message), output from the command is discarded. This option and
21657 &%return_output%& are mutually exclusive. Only one of them may be set.
21658
21659
21660
21661 .option return_output pipe boolean false
21662 If this option is true, and the command produced any output, the delivery is
21663 deemed to have failed whatever the return code from the command, and the output
21664 is returned in the bounce message. Otherwise, the output is just discarded.
21665 However, if the message has a null sender (that is, it is a bounce message),
21666 output from the command is always discarded, whatever the setting of this
21667 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21668 of them may be set.
21669
21670
21671
21672 .option temp_errors pipe "string list" "see below"
21673 .cindex "&(pipe)& transport" "temporary failure"
21674 This option contains either a colon-separated list of numbers, or a single
21675 asterisk. If &%ignore_status%& is false
21676 and &%return_output%& is not set,
21677 and the command exits with a non-zero return code, the failure is treated as
21678 temporary and the delivery is deferred if the return code matches one of the
21679 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21680 codes are treated as permanent errors. The default setting contains the codes
21681 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21682 compiled on a system that does not define these macros, it assumes values of 75
21683 and 73, respectively.
21684
21685
21686 .option timeout pipe time 1h
21687 If the command fails to complete within this time, it is killed. This normally
21688 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21689 specifies no timeout. In order to ensure that any subprocesses created by the
21690 command are also killed, Exim makes the initial process a process group leader,
21691 and kills the whole process group on a timeout. However, this can be defeated
21692 if one of the processes starts a new process group.
21693
21694 .option timeout_defer pipe boolean false
21695 A timeout in a &(pipe)& transport, either in the command that the transport
21696 runs, or in a transport filter that is associated with it, is by default
21697 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21698 is set true, both kinds of timeout become temporary errors, causing the
21699 delivery to be deferred.
21700
21701 .option umask pipe "octal integer" 022
21702 This specifies the umask setting for the subprocess that runs the command.
21703
21704
21705 .option use_bsmtp pipe boolean false
21706 .cindex "envelope sender"
21707 If this option is set true, the &(pipe)& transport writes messages in &"batch
21708 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21709 commands. If you want to include a leading HELO command with such messages,
21710 you can do so by setting the &%message_prefix%& option. See section
21711 &<<SECTbatchSMTP>>& for details of batch SMTP.
21712
21713 .option use_classresources pipe boolean false
21714 .cindex "class resources (BSD)"
21715 This option is available only when Exim is running on FreeBSD, NetBSD, or
21716 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21717 resource limits when a &(pipe)& transport is run to perform a delivery. The
21718 limits for the uid under which the pipe is to run are obtained from the login
21719 class database.
21720
21721
21722 .option use_crlf pipe boolean false
21723 .cindex "carriage return"
21724 .cindex "linefeed"
21725 This option causes lines to be terminated with the two-character CRLF sequence
21726 (carriage return, linefeed) instead of just a linefeed character. In the case
21727 of batched SMTP, the byte sequence written to the pipe is then an exact image
21728 of what would be sent down a real SMTP connection.
21729
21730 The contents of the &%message_prefix%& and &%message_suffix%& options are
21731 written verbatim, so must contain their own carriage return characters if these
21732 are needed. When &%use_bsmtp%& is not set, the default values for both
21733 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21734 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21735
21736
21737 .option use_shell pipe boolean false
21738 .vindex "&$pipe_addresses$&"
21739 If this option is set, it causes the command to be passed to &_/bin/sh_&
21740 instead of being run directly from the transport, as described in section
21741 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21742 where the command is expected to be run under a shell and cannot easily be
21743 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21744 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21745 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21746 its &%-c%& option.
21747
21748
21749
21750 .section "Using an external local delivery agent" "SECID143"
21751 .cindex "local delivery" "using an external agent"
21752 .cindex "&'procmail'&"
21753 .cindex "external local delivery"
21754 .cindex "delivery" "&'procmail'&"
21755 .cindex "delivery" "by external agent"
21756 The &(pipe)& transport can be used to pass all messages that require local
21757 delivery to a separate local delivery agent such as &%procmail%&. When doing
21758 this, care must be taken to ensure that the pipe is run under an appropriate
21759 uid and gid. In some configurations one wants this to be a uid that is trusted
21760 by the delivery agent to supply the correct sender of the message. It may be
21761 necessary to recompile or reconfigure the delivery agent so that it trusts an
21762 appropriate user. The following is an example transport and router
21763 configuration for &%procmail%&:
21764 .code
21765 # transport
21766 procmail_pipe:
21767   driver = pipe
21768   command = /usr/local/bin/procmail -d $local_part
21769   return_path_add
21770   delivery_date_add
21771   envelope_to_add
21772   check_string = "From "
21773   escape_string = ">From "
21774   umask = 077
21775   user = $local_part
21776   group = mail
21777
21778 # router
21779 procmail:
21780   driver = accept
21781   check_local_user
21782   transport = procmail_pipe
21783 .endd
21784 In this example, the pipe is run as the local user, but with the group set to
21785 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21786 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21787 user to supply a correct sender address. If you do not specify either a
21788 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21789 home directory is the user's home directory by default.
21790
21791 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21792 .code
21793 IFS=" "
21794 .endd
21795 as shown in some &%procmail%& documentation, because Exim does not by default
21796 use a shell to run pipe commands.
21797
21798 .cindex "Cyrus"
21799 The next example shows a transport and a router for a system where local
21800 deliveries are handled by the Cyrus IMAP server.
21801 .code
21802 # transport
21803 local_delivery_cyrus:
21804   driver = pipe
21805   command = /usr/cyrus/bin/deliver \
21806             -m ${substr_1:$local_part_suffix} -- $local_part
21807   user = cyrus
21808   group = mail
21809   return_output
21810   log_output
21811   message_prefix =
21812   message_suffix =
21813
21814 # router
21815 local_user_cyrus:
21816   driver = accept
21817   check_local_user
21818   local_part_suffix = .*
21819   transport = local_delivery_cyrus
21820 .endd
21821 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21822 &%return_output%& to cause any text written by Cyrus to be returned to the
21823 sender.
21824 .ecindex IIDpiptra1
21825 .ecindex IIDpiptra2
21826
21827
21828 . ////////////////////////////////////////////////////////////////////////////
21829 . ////////////////////////////////////////////////////////////////////////////
21830
21831 .chapter "The smtp transport" "CHAPsmtptrans"
21832 .scindex IIDsmttra1 "transports" "&(smtp)&"
21833 .scindex IIDsmttra2 "&(smtp)& transport"
21834 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21835 or LMTP protocol. The list of hosts to try can either be taken from the address
21836 that is being processed (having been set up by the router), or specified
21837 explicitly for the transport. Timeout and retry processing (see chapter
21838 &<<CHAPretry>>&) is applied to each IP address independently.
21839
21840
21841 .section "Multiple messages on a single connection" "SECID144"
21842 The sending of multiple messages over a single TCP/IP connection can arise in
21843 two ways:
21844
21845 .ilist
21846 If a message contains more than &%max_rcpt%& (see below) addresses that are
21847 routed to the same host, more than one copy of the message has to be sent to
21848 that host. In this situation, multiple copies may be sent in a single run of
21849 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21850 does when it has too many addresses to send in one message also depends on the
21851 value of the global &%remote_max_parallel%& option. Details are given in
21852 section &<<SECToutSMTPTCP>>&.)
21853 .next
21854 .cindex "hints database" "remembering routing"
21855 When a message has been successfully delivered over a TCP/IP connection, Exim
21856 looks in its hints database to see if there are any other messages awaiting a
21857 connection to the same host. If there are, a new delivery process is started
21858 for one of them, and the current TCP/IP connection is passed on to it. The new
21859 process may in turn send multiple copies and possibly create yet another
21860 process.
21861 .endlist
21862
21863
21864 For each copy sent over the same TCP/IP connection, a sequence counter is
21865 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21866 no further messages are sent over that connection.
21867
21868
21869
21870 .section "Use of the $host and $host_address variables" "SECID145"
21871 .vindex "&$host$&"
21872 .vindex "&$host_address$&"
21873 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21874 &$host_address$& are the name and IP address of the first host on the host list
21875 passed by the router. However, when the transport is about to connect to a
21876 specific host, and while it is connected to that host, &$host$& and
21877 &$host_address$& are set to the values for that host. These are the values
21878 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21879 &%serialize_hosts%&, and the various TLS options are expanded.
21880
21881
21882 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21883 .vindex &$tls_bits$&
21884 .vindex &$tls_cipher$&
21885 .vindex &$tls_peerdn$&
21886 .vindex &$tls_sni$&
21887 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
21888 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
21889 are the values that were set when the message was received.
21890 These are the values that are used for options that are expanded before any
21891 SMTP connections are made. Just before each connection is made, these four
21892 variables are emptied. If TLS is subsequently started, they are set to the
21893 appropriate values for the outgoing connection, and these are the values that
21894 are in force when any authenticators are run and when the
21895 &%authenticated_sender%& option is expanded.
21896
21897
21898 .section "Private options for smtp" "SECID146"
21899 .cindex "options" "&(smtp)& transport"
21900 The private options of the &(smtp)& transport are as follows:
21901
21902
21903 .option address_retry_include_sender smtp boolean true
21904 .cindex "4&'xx'& responses" "retrying after"
21905 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21906 is the combination of sender and recipient that is delayed in subsequent queue
21907 runs until the retry time is reached. You can delay the recipient without
21908 reference to the sender (which is what earlier versions of Exim did), by
21909 setting &%address_retry_include_sender%& false. However, this can lead to
21910 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21911
21912 .option allow_localhost smtp boolean false
21913 .cindex "local host" "sending to"
21914 .cindex "fallback" "hosts specified on transport"
21915 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21916 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21917 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21918 the delivery anyway. This should be used only in special cases when the
21919 configuration ensures that no looping will result (for example, a differently
21920 configured Exim is listening on the port to which the message is sent).
21921
21922
21923 .option authenticated_sender smtp string&!! unset
21924 .cindex "Cyrus"
21925 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21926 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21927 overriding any existing authenticated sender value. If the string expansion is
21928 forced to fail, the option is ignored. Other expansion failures cause delivery
21929 to be deferred. If the result of expansion is an empty string, that is also
21930 ignored.
21931
21932 The expansion happens after the outgoing connection has been made and TLS
21933 started, if required. This means that the &$host$&, &$host_address$&,
21934 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21935 particular connection.
21936
21937 If the SMTP session is not authenticated, the expansion of
21938 &%authenticated_sender%& still happens (and can cause the delivery to be
21939 deferred if it fails), but no AUTH= item is added to MAIL commands
21940 unless &%authenticated_sender_force%& is true.
21941
21942 This option allows you to use the &(smtp)& transport in LMTP mode to
21943 deliver mail to Cyrus IMAP and provide the proper local part as the
21944 &"authenticated sender"&, via a setting such as:
21945 .code
21946 authenticated_sender = $local_part
21947 .endd
21948 This removes the need for IMAP subfolders to be assigned special ACLs to
21949 allow direct delivery to those subfolders.
21950
21951 Because of expected uses such as that just described for Cyrus (when no
21952 domain is involved), there is no checking on the syntax of the provided
21953 value.
21954
21955
21956 .option authenticated_sender_force smtp boolean false
21957 If this option is set true, the &%authenticated_sender%& option's value
21958 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21959 authenticated as a client.
21960
21961
21962 .option command_timeout smtp time 5m
21963 This sets a timeout for receiving a response to an SMTP command that has been
21964 sent out. It is also used when waiting for the initial banner line from the
21965 remote host. Its value must not be zero.
21966
21967
21968 .option connect_timeout smtp time 5m
21969 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21970 to a remote host. A setting of zero allows the system timeout (typically
21971 several minutes) to act. To have any effect, the value of this option must be
21972 less than the system timeout. However, it has been observed that on some
21973 systems there is no system timeout, which is why the default value for this
21974 option is 5 minutes, a value recommended by RFC 1123.
21975
21976
21977 .option connection_max_messages smtp integer 500
21978 .cindex "SMTP" "passed connection"
21979 .cindex "SMTP" "multiple deliveries"
21980 .cindex "multiple SMTP deliveries"
21981 This controls the maximum number of separate message deliveries that are sent
21982 over a single TCP/IP connection. If the value is zero, there is no limit.
21983 For testing purposes, this value can be overridden by the &%-oB%& command line
21984 option.
21985
21986
21987 .option data_timeout smtp time 5m
21988 This sets a timeout for the transmission of each block in the data portion of
21989 the message. As a result, the overall timeout for a message depends on the size
21990 of the message. Its value must not be zero. See also &%final_timeout%&.
21991
21992
21993 .option delay_after_cutoff smtp boolean true
21994 This option controls what happens when all remote IP addresses for a given
21995 domain have been inaccessible for so long that they have passed their retry
21996 cutoff times.
21997
21998 In the default state, if the next retry time has not been reached for any of
21999 them, the address is bounced without trying any deliveries. In other words,
22000 Exim delays retrying an IP address after the final cutoff time until a new
22001 retry time is reached, and can therefore bounce an address without ever trying
22002 a delivery, when machines have been down for a long time. Some people are
22003 unhappy at this prospect, so...
22004
22005 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22006 addresses are past their final cutoff time, Exim tries to deliver to those
22007 IP addresses that have not been tried since the message arrived. If there are
22008 none, of if they all fail, the address is bounced. In other words, it does not
22009 delay when a new message arrives, but immediately tries those expired IP
22010 addresses that haven't been tried since the message arrived. If there is a
22011 continuous stream of messages for the dead hosts, unsetting
22012 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22013 to them.
22014
22015
22016 .option dns_qualify_single smtp boolean true
22017 If the &%hosts%& or &%fallback_hosts%& option is being used,
22018 and the &%gethostbyname%& option is false,
22019 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22020 in chapter &<<CHAPdnslookup>>& for more details.
22021
22022
22023 .option dns_search_parents smtp boolean false
22024 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22025 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22026 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22027 details.
22028
22029
22030
22031 .option fallback_hosts smtp "string list" unset
22032 .cindex "fallback" "hosts specified on transport"
22033 String expansion is not applied to this option. The argument must be a
22034 colon-separated list of host names or IP addresses, optionally also including
22035 port numbers, though the separator can be changed, as described in section
22036 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22037 item in a &%route_list%& setting for the &(manualroute)& router, as described
22038 in section &<<SECTformatonehostitem>>&.
22039
22040 Fallback hosts can also be specified on routers, which associate them with the
22041 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22042 &%fallback_hosts%& specified on the transport is used only if the address does
22043 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22044 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22045 However, &%hosts_randomize%& does apply to fallback host lists.
22046
22047 If Exim is unable to deliver to any of the hosts for a particular address, and
22048 the errors are not permanent rejections, the address is put on a separate
22049 transport queue with its host list replaced by the fallback hosts, unless the
22050 address was routed via MX records and the current host was in the original MX
22051 list. In that situation, the fallback host list is not used.
22052
22053 Once normal deliveries are complete, the fallback queue is delivered by
22054 re-running the same transports with the new host lists. If several failing
22055 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22056 copy of the message is sent.
22057
22058 The resolution of the host names on the fallback list is controlled by the
22059 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22060 both to cases when the host list comes with the address and when it is taken
22061 from &%hosts%&. This option provides a &"use a smart host only if delivery
22062 fails"& facility.
22063
22064
22065 .option final_timeout smtp time 10m
22066 This is the timeout that applies while waiting for the response to the final
22067 line containing just &"."& that terminates a message. Its value must not be
22068 zero.
22069
22070 .option gethostbyname smtp boolean false
22071 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22072 being used, names are looked up using &[gethostbyname()]&
22073 (or &[getipnodebyname()]& when available)
22074 instead of using the DNS. Of course, that function may in fact use the DNS, but
22075 it may also consult other sources of information such as &_/etc/hosts_&.
22076
22077 .option gnutls_compat_mode smtp boolean unset
22078 This option controls whether GnuTLS is used in compatibility mode in an Exim
22079 server. This reduces security slightly, but improves interworking with older
22080 implementations of TLS.
22081
22082 .option helo_data smtp string&!! "see below"
22083 .cindex "HELO" "argument, setting"
22084 .cindex "EHLO" "argument, setting"
22085 .cindex "LHLO argument setting"
22086 The value of this option is expanded after a connection to a another host has
22087 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22088 command that starts the outgoing SMTP or LMTP session. The default value of the
22089 option is:
22090 .code
22091 $primary_hostname
22092 .endd
22093 During the expansion, the variables &$host$& and &$host_address$& are set to
22094 the identity of the remote host, and the variables &$sending_ip_address$& and
22095 &$sending_port$& are set to the local IP address and port number that are being
22096 used. These variables can be used to generate different values for different
22097 servers or different local IP addresses. For example, if you want the string
22098 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22099 interface address, you could use this:
22100 .code
22101 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22102   {$primary_hostname}}
22103 .endd
22104 The use of &%helo_data%& applies both to sending messages and when doing
22105 callouts.
22106
22107 .option hosts smtp "string list&!!" unset
22108 Hosts are associated with an address by a router such as &(dnslookup)&, which
22109 finds the hosts by looking up the address domain in the DNS, or by
22110 &(manualroute)&, which has lists of hosts in its configuration. However,
22111 email addresses can be passed to the &(smtp)& transport by any router, and not
22112 all of them can provide an associated list of hosts.
22113
22114 The &%hosts%& option specifies a list of hosts to be used if the address being
22115 processed does not have any hosts associated with it. The hosts specified by
22116 &%hosts%& are also used, whether or not the address has its own hosts, if
22117 &%hosts_override%& is set.
22118
22119 The string is first expanded, before being interpreted as a colon-separated
22120 list of host names or IP addresses, possibly including port numbers. The
22121 separator may be changed to something other than colon, as described in section
22122 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22123 item in a &%route_list%& setting for the &(manualroute)& router, as described
22124 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22125 of the &(manualroute)& router is not available here.
22126
22127 If the expansion fails, delivery is deferred. Unless the failure was caused by
22128 the inability to complete a lookup, the error is logged to the panic log as
22129 well as the main log. Host names are looked up either by searching directly for
22130 address records in the DNS or by calling &[gethostbyname()]& (or
22131 &[getipnodebyname()]& when available), depending on the setting of the
22132 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22133 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22134 address are used.
22135
22136 During delivery, the hosts are tried in order, subject to their retry status,
22137 unless &%hosts_randomize%& is set.
22138
22139
22140 .option hosts_avoid_esmtp smtp "host list&!!" unset
22141 .cindex "ESMTP, avoiding use of"
22142 .cindex "HELO" "forcing use of"
22143 .cindex "EHLO" "avoiding use of"
22144 .cindex "PIPELINING" "avoiding the use of"
22145 This option is for use with broken hosts that announce ESMTP facilities (for
22146 example, PIPELINING) and then fail to implement them properly. When a host
22147 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22148 start of the SMTP session. This means that it cannot use any of the ESMTP
22149 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22150
22151
22152 .option hosts_avoid_pipelining smtp "host list&!!" unset
22153 .cindex "PIPELINING" "avoiding the use of"
22154 Exim will not use the SMTP PIPELINING extension when delivering to any host
22155 that matches this list, even if the server host advertises PIPELINING support.
22156
22157
22158 .option hosts_avoid_tls smtp "host list&!!" unset
22159 .cindex "TLS" "avoiding for certain hosts"
22160 Exim will not try to start a TLS session when delivering to any host that
22161 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22162
22163
22164 .option hosts_max_try smtp integer 5
22165 .cindex "host" "maximum number to try"
22166 .cindex "limit" "number of hosts tried"
22167 .cindex "limit" "number of MX tried"
22168 .cindex "MX record" "maximum tried"
22169 This option limits the number of IP addresses that are tried for any one
22170 delivery in cases where there are temporary delivery errors. Section
22171 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22172
22173
22174 .option hosts_max_try_hardlimit smtp integer 50
22175 This is an additional check on the maximum number of IP addresses that Exim
22176 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22177 why it exists.
22178
22179
22180
22181 .option hosts_nopass_tls smtp "host list&!!" unset
22182 .cindex "TLS" "passing connection"
22183 .cindex "multiple SMTP deliveries"
22184 .cindex "TLS" "multiple message deliveries"
22185 For any host that matches this list, a connection on which a TLS session has
22186 been started will not be passed to a new delivery process for sending another
22187 message on the same connection. See section &<<SECTmulmessam>>& for an
22188 explanation of when this might be needed.
22189
22190
22191 .option hosts_override smtp boolean false
22192 If this option is set and the &%hosts%& option is also set, any hosts that are
22193 attached to the address are ignored, and instead the hosts specified by the
22194 &%hosts%& option are always used. This option does not apply to
22195 &%fallback_hosts%&.
22196
22197
22198 .option hosts_randomize smtp boolean false
22199 .cindex "randomized host list"
22200 .cindex "host" "list of; randomized"
22201 .cindex "fallback" "randomized hosts"
22202 If this option is set, and either the list of hosts is taken from the
22203 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22204 were not obtained from MX records (this includes fallback hosts from the
22205 router), and were not randomized by the router, the order of trying the hosts
22206 is randomized each time the transport runs. Randomizing the order of a host
22207 list can be used to do crude load sharing.
22208
22209 When &%hosts_randomize%& is true, a host list may be split into groups whose
22210 order is separately randomized. This makes it possible to set up MX-like
22211 behaviour. The boundaries between groups are indicated by an item that is just
22212 &`+`& in the host list. For example:
22213 .code
22214 hosts = host1:host2:host3:+:host4:host5
22215 .endd
22216 The order of the first three hosts and the order of the last two hosts is
22217 randomized for each use, but the first three always end up before the last two.
22218 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22219
22220 .option hosts_require_auth smtp "host list&!!" unset
22221 .cindex "authentication" "required by client"
22222 This option provides a list of servers for which authentication must succeed
22223 before Exim will try to transfer a message. If authentication fails for
22224 servers which are not in this list, Exim tries to send unauthenticated. If
22225 authentication fails for one of these servers, delivery is deferred. This
22226 temporary error is detectable in the retry rules, so it can be turned into a
22227 hard failure if required. See also &%hosts_try_auth%&, and chapter
22228 &<<CHAPSMTPAUTH>>& for details of authentication.
22229
22230
22231 .option hosts_require_tls smtp "host list&!!" unset
22232 .cindex "TLS" "requiring for certain servers"
22233 Exim will insist on using a TLS session when delivering to any host that
22234 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22235 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22236 incoming messages, use an appropriate ACL.
22237
22238 .option hosts_try_auth smtp "host list&!!" unset
22239 .cindex "authentication" "optional in client"
22240 This option provides a list of servers to which, provided they announce
22241 authentication support, Exim will attempt to authenticate as a client when it
22242 connects. If authentication fails, Exim will try to transfer the message
22243 unauthenticated. See also &%hosts_require_auth%&, and chapter
22244 &<<CHAPSMTPAUTH>>& for details of authentication.
22245
22246 .option interface smtp "string list&!!" unset
22247 .cindex "bind IP address"
22248 .cindex "IP address" "binding"
22249 .vindex "&$host$&"
22250 .vindex "&$host_address$&"
22251 This option specifies which interface to bind to when making an outgoing SMTP
22252 call. The value is an IP address, not an interface name such as
22253 &`eth0`&. Do not confuse this with the interface address that was used when a
22254 message was received, which is in &$received_ip_address$&, formerly known as
22255 &$interface_address$&. The name was changed to minimize confusion with the
22256 outgoing interface address. There is no variable that contains an outgoing
22257 interface address because, unless it is set by this option, its value is
22258 unknown.
22259
22260 During the expansion of the &%interface%& option the variables &$host$& and
22261 &$host_address$& refer to the host to which a connection is about to be made
22262 during the expansion of the string. Forced expansion failure, or an empty
22263 string result causes the option to be ignored. Otherwise, after expansion, the
22264 string must be a list of IP addresses, colon-separated by default, but the
22265 separator can be changed in the usual way. For example:
22266 .code
22267 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22268 .endd
22269 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22270 connection. If none of them are the correct type, the option is ignored. If
22271 &%interface%& is not set, or is ignored, the system's IP functions choose which
22272 interface to use if the host has more than one.
22273
22274
22275 .option keepalive smtp boolean true
22276 .cindex "keepalive" "on outgoing connection"
22277 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22278 connections. When set, it causes the kernel to probe idle connections
22279 periodically, by sending packets with &"old"& sequence numbers. The other end
22280 of the connection should send a acknowledgment if the connection is still okay
22281 or a reset if the connection has been aborted. The reason for doing this is
22282 that it has the beneficial effect of freeing up certain types of connection
22283 that can get stuck when the remote host is disconnected without tidying up the
22284 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22285 unreachable hosts.
22286
22287
22288 .option lmtp_ignore_quota smtp boolean false
22289 .cindex "LMTP" "ignoring quota errors"
22290 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22291 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22292 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22293
22294 .option max_rcpt smtp integer 100
22295 .cindex "RCPT" "maximum number of outgoing"
22296 This option limits the number of RCPT commands that are sent in a single
22297 SMTP message transaction. Each set of addresses is treated independently, and
22298 so can cause parallel connections to the same host if &%remote_max_parallel%&
22299 permits this.
22300
22301
22302 .option multi_domain smtp boolean true
22303 .vindex "&$domain$&"
22304 When this option is set, the &(smtp)& transport can handle a number of
22305 addresses containing a mixture of different domains provided they all resolve
22306 to the same list of hosts. Turning the option off restricts the transport to
22307 handling only one domain at a time. This is useful if you want to use
22308 &$domain$& in an expansion for the transport, because it is set only when there
22309 is a single domain involved in a remote delivery.
22310
22311
22312 .option port smtp string&!! "see below"
22313 .cindex "port" "sending TCP/IP"
22314 .cindex "TCP/IP" "setting outgoing port"
22315 This option specifies the TCP/IP port on the server to which Exim connects.
22316 &*Note:*& Do not confuse this with the port that was used when a message was
22317 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22318 The name was changed to minimize confusion with the outgoing port. There is no
22319 variable that contains an outgoing port.
22320
22321 If the value of this option begins with a digit it is taken as a port number;
22322 otherwise it is looked up using &[getservbyname()]&. The default value is
22323 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22324 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22325 is deferred.
22326
22327
22328
22329 .option protocol smtp string smtp
22330 .cindex "LMTP" "over TCP/IP"
22331 .cindex "ssmtp protocol" "outbound"
22332 .cindex "TLS" "SSL-on-connect outbound"
22333 .vindex "&$port$&"
22334 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22335 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22336 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22337 deliveries into closed message stores. Exim also has support for running LMTP
22338 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22339
22340 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22341 changes to &"smtps"&, and the transport initiates TLS immediately after
22342 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22343 The Internet standards bodies strongly discourage use of this mode.
22344
22345
22346 .option retry_include_ip_address smtp boolean true
22347 Exim normally includes both the host name and the IP address in the key it
22348 constructs for indexing retry data after a temporary delivery failure. This
22349 means that when one of several IP addresses for a host is failing, it gets
22350 tried periodically (controlled by the retry rules), but use of the other IP
22351 addresses is not affected.
22352
22353 However, in some dialup environments hosts are assigned a different IP address
22354 each time they connect. In this situation the use of the IP address as part of
22355 the retry key leads to undesirable behaviour. Setting this option false causes
22356 Exim to use only the host name. This should normally be done on a separate
22357 instance of the &(smtp)& transport, set up specially to handle the dialup
22358 hosts.
22359
22360
22361 .option serialize_hosts smtp "host list&!!" unset
22362 .cindex "serializing connections"
22363 .cindex "host" "serializing connections"
22364 Because Exim operates in a distributed manner, if several messages for the same
22365 host arrive at around the same time, more than one simultaneous connection to
22366 the remote host can occur. This is not usually a problem except when there is a
22367 slow link between the hosts. In that situation it may be helpful to restrict
22368 Exim to one connection at a time. This can be done by setting
22369 &%serialize_hosts%& to match the relevant hosts.
22370
22371 .cindex "hints database" "serializing deliveries to a host"
22372 Exim implements serialization by means of a hints database in which a record is
22373 written whenever a process connects to one of the restricted hosts. The record
22374 is deleted when the connection is completed. Obviously there is scope for
22375 records to get left lying around if there is a system or program crash. To
22376 guard against this, Exim ignores any records that are more than six hours old.
22377
22378 If you set up this kind of serialization, you should also arrange to delete the
22379 relevant hints database whenever your system reboots. The names of the files
22380 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22381 may be one or two files, depending on the type of DBM in use. The same files
22382 are used for ETRN serialization.
22383
22384
22385 .option size_addition smtp integer 1024
22386 .cindex "SMTP" "SIZE"
22387 .cindex "message" "size issue for transport filter"
22388 .cindex "size" "of message"
22389 .cindex "transport" "filter"
22390 .cindex "filter" "transport filter"
22391 If a remote SMTP server indicates that it supports the SIZE option of the
22392 MAIL command, Exim uses this to pass over the message size at the start of
22393 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22394 sends, to allow for headers and other text that may be added during delivery by
22395 configuration options or in a transport filter. It may be necessary to increase
22396 this if a lot of text is added to messages.
22397
22398 Alternatively, if the value of &%size_addition%& is set negative, it disables
22399 the use of the SIZE option altogether.
22400
22401
22402 .option tls_certificate smtp string&!! unset
22403 .cindex "TLS" "client certificate, location of"
22404 .cindex "certificate" "client, location of"
22405 .vindex "&$host$&"
22406 .vindex "&$host_address$&"
22407 The value of this option must be the absolute path to a file which contains the
22408 client's certificate, for possible use when sending a message over an encrypted
22409 connection. The values of &$host$& and &$host_address$& are set to the name and
22410 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22411 details of TLS.
22412
22413 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22414 certificate when sending messages as a client. The global option of the same
22415 name specifies the certificate for Exim as a server; it is not automatically
22416 assumed that the same certificate should be used when Exim is operating as a
22417 client.
22418
22419
22420 .option tls_crl smtp string&!! unset
22421 .cindex "TLS" "client certificate revocation list"
22422 .cindex "certificate" "revocation list for client"
22423 This option specifies a certificate revocation list. The expanded value must
22424 be the name of a file that contains a CRL in PEM format.
22425
22426
22427 .option tls_privatekey smtp string&!! unset
22428 .cindex "TLS" "client private key, location of"
22429 .vindex "&$host$&"
22430 .vindex "&$host_address$&"
22431 The value of this option must be the absolute path to a file which contains the
22432 client's private key. This is used when sending a message over an encrypted
22433 connection using a client certificate. The values of &$host$& and
22434 &$host_address$& are set to the name and address of the server during the
22435 expansion. If this option is unset, or the expansion is forced to fail, or the
22436 result is an empty string, the private key is assumed to be in the same file as
22437 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22438
22439
22440 .option tls_require_ciphers smtp string&!! unset
22441 .cindex "TLS" "requiring specific ciphers"
22442 .cindex "cipher" "requiring specific"
22443 .vindex "&$host$&"
22444 .vindex "&$host_address$&"
22445 The value of this option must be a list of permitted cipher suites, for use
22446 when setting up an outgoing encrypted connection. (There is a global option of
22447 the same name for controlling incoming connections.) The values of &$host$& and
22448 &$host_address$& are set to the name and address of the server during the
22449 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22450 is used in different ways by OpenSSL and GnuTLS (see sections
22451 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22452 ciphers is a preference order.
22453
22454
22455
22456 .option tls_sni smtp string&!! unset
22457 .cindex "TLS" "Server Name Indication"
22458 .vindex "&$tls_sni$&"
22459 If this option is set then it sets the $tls_sni variable and causes any
22460 TLS session to pass this value as the Server Name Indication extension to
22461 the remote side, which can be used by the remote side to select an appropriate
22462 certificate and private key for the session.
22463
22464 See &<<SECTtlssni>>& for more information.
22465
22466 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
22467 TLS extensions.
22468
22469
22470
22471
22472 .option tls_tempfail_tryclear smtp boolean true
22473 .cindex "4&'xx'& responses" "to STARTTLS"
22474 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22475 setting up a TLS session, this option determines whether or not Exim should try
22476 to deliver the message unencrypted. If it is set false, delivery to the
22477 current host is deferred; if there are other hosts, they are tried. If this
22478 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22479 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22480 TLS negotiation fails, Exim closes the current connection (because it is in an
22481 unknown state), opens a new one to the same host, and then tries the delivery
22482 in clear.
22483
22484
22485 .option tls_verify_certificates smtp string&!! unset
22486 .cindex "TLS" "server certificate verification"
22487 .cindex "certificate" "verification of server"
22488 .vindex "&$host$&"
22489 .vindex "&$host_address$&"
22490 The value of this option must be the absolute path to a file containing
22491 permitted server certificates, for use when setting up an encrypted connection.
22492 Alternatively, if you are using OpenSSL, you can set
22493 &%tls_verify_certificates%& to the name of a directory containing certificate
22494 files. This does not work with GnuTLS; the option must be set to the name of a
22495 single file if you are using GnuTLS. The values of &$host$& and
22496 &$host_address$& are set to the name and address of the server during the
22497 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22498
22499
22500
22501
22502 .section "How the limits for the number of hosts to try are used" &&&
22503          "SECTvalhosmax"
22504 .cindex "host" "maximum number to try"
22505 .cindex "limit" "hosts; maximum number tried"
22506 There are two options that are concerned with the number of hosts that are
22507 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22508 &%hosts_max_try_hardlimit%&.
22509
22510
22511 The &%hosts_max_try%& option limits the number of hosts that are tried
22512 for a single delivery. However, despite the term &"host"& in its name, the
22513 option actually applies to each IP address independently. In other words, a
22514 multihomed host is treated as several independent hosts, just as it is for
22515 retrying.
22516
22517 Many of the larger ISPs have multiple MX records which often point to
22518 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22519 created as a result of routing one of these domains.
22520
22521 Trying every single IP address on such a long list does not seem sensible; if
22522 several at the top of the list fail, it is reasonable to assume there is some
22523 problem that is likely to affect all of them. Roughly speaking, the value of
22524 &%hosts_max_try%& is the maximum number that are tried before deferring the
22525 delivery. However, the logic cannot be quite that simple.
22526
22527 Firstly, IP addresses that are skipped because their retry times have not
22528 arrived do not count, and in addition, addresses that are past their retry
22529 limits are also not counted, even when they are tried. This means that when
22530 some IP addresses are past their retry limits, more than the value of
22531 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22532 that all IP addresses are considered before timing out an email address (but
22533 see below for an exception).
22534
22535 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22536 list to see if there is a subsequent host with a different (higher valued) MX.
22537 If there is, that host is considered next, and the current IP address is used
22538 but not counted. This behaviour helps in the case of a domain with a retry rule
22539 that hardly ever delays any hosts, as is now explained:
22540
22541 Consider the case of a long list of hosts with one MX value, and a few with a
22542 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22543 hosts at the top of the list are tried at first. With the default retry rule,
22544 which specifies increasing retry times, the higher MX hosts are eventually
22545 tried when those at the top of the list are skipped because they have not
22546 reached their retry times.
22547
22548 However, it is common practice to put a fixed short retry time on domains for
22549 large ISPs, on the grounds that their servers are rarely down for very long.
22550 Unfortunately, these are exactly the domains that tend to resolve to long lists
22551 of hosts. The short retry time means that the lowest MX hosts are tried every
22552 time. The attempts may be in a different order because of random sorting, but
22553 without the special MX check, the higher MX hosts would never be tried until
22554 all the lower MX hosts had timed out (which might be several days), because
22555 there are always some lower MX hosts that have reached their retry times. With
22556 the special check, Exim considers at least one IP address from each MX value at
22557 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22558 reached.
22559
22560 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22561 particular, Exim normally eventually tries all the IP addresses before timing
22562 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22563 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22564 been set up with hundreds of IP addresses for some domains. It can
22565 take a very long time indeed for an address to time out in these cases.
22566
22567 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22568 Exim never tries more than this number of IP addresses; if it hits this limit
22569 and they are all timed out, the email address is bounced, even though not all
22570 possible IP addresses have been tried.
22571 .ecindex IIDsmttra1
22572 .ecindex IIDsmttra2
22573
22574
22575
22576
22577
22578 . ////////////////////////////////////////////////////////////////////////////
22579 . ////////////////////////////////////////////////////////////////////////////
22580
22581 .chapter "Address rewriting" "CHAPrewrite"
22582 .scindex IIDaddrew "rewriting" "addresses"
22583 There are some circumstances in which Exim automatically rewrites domains in
22584 addresses. The two most common are when an address is given without a domain
22585 (referred to as an &"unqualified address"&) or when an address contains an
22586 abbreviated domain that is expanded by DNS lookup.
22587
22588 Unqualified envelope addresses are accepted only for locally submitted
22589 messages, or for messages that are received from hosts matching
22590 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22591 appropriate. Unqualified addresses in header lines are qualified if they are in
22592 locally submitted messages, or messages from hosts that are permitted to send
22593 unqualified envelope addresses. Otherwise, unqualified addresses in header
22594 lines are neither qualified nor rewritten.
22595
22596 One situation in which Exim does &'not'& automatically rewrite a domain is
22597 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22598 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22599 do this. The new RFCs do not contain this suggestion.
22600
22601
22602 .section "Explicitly configured address rewriting" "SECID147"
22603 This chapter describes the rewriting rules that can be used in the
22604 main rewrite section of the configuration file, and also in the generic
22605 &%headers_rewrite%& option that can be set on any transport.
22606
22607 Some people believe that configured address rewriting is a Mortal Sin.
22608 Others believe that life is not possible without it. Exim provides the
22609 facility; you do not have to use it.
22610
22611 The main rewriting rules that appear in the &"rewrite"& section of the
22612 configuration file are applied to addresses in incoming messages, both envelope
22613 addresses and addresses in header lines. Each rule specifies the types of
22614 address to which it applies.
22615
22616 Whether or not addresses in header lines are rewritten depends on the origin of
22617 the headers and the type of rewriting. Global rewriting, that is, rewriting
22618 rules from the rewrite section of the configuration file, is applied only to
22619 those headers that were received with the message. Header lines that are added
22620 by ACLs or by a system filter or by individual routers or transports (which
22621 are specific to individual recipient addresses) are not rewritten by the global
22622 rules.
22623
22624 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22625 applies all headers except those added by routers and transports. That is, as
22626 well as the headers that were received with the message, it also applies to
22627 headers that were added by an ACL or a system filter.
22628
22629
22630 In general, rewriting addresses from your own system or domain has some
22631 legitimacy. Rewriting other addresses should be done only with great care and
22632 in special circumstances. The author of Exim believes that rewriting should be
22633 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22634 Although it can sometimes be used as a routing tool, this is very strongly
22635 discouraged.
22636
22637 There are two commonly encountered circumstances where rewriting is used, as
22638 illustrated by these examples:
22639
22640 .ilist
22641 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22642 exchange mail with each other behind a firewall, but there is only a single
22643 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22644 &'hitch.fict.example'& when sending mail off-site.
22645 .next
22646 A host rewrites the local parts of its own users so that, for example,
22647 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22648 .endlist
22649
22650
22651
22652 .section "When does rewriting happen?" "SECID148"
22653 .cindex "rewriting" "timing of"
22654 .cindex "&ACL;" "rewriting addresses in"
22655 Configured address rewriting can take place at several different stages of a
22656 message's processing.
22657
22658 .vindex "&$sender_address$&"
22659 At the start of an ACL for MAIL, the sender address may have been rewritten
22660 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22661 ordinary rewrite rules have yet been applied. If, however, the sender address
22662 is verified in the ACL, it is rewritten before verification, and remains
22663 rewritten thereafter. The subsequent value of &$sender_address$& is the
22664 rewritten address. This also applies if sender verification happens in a
22665 RCPT ACL. Otherwise, when the sender address is not verified, it is
22666 rewritten as soon as a message's header lines have been received.
22667
22668 .vindex "&$domain$&"
22669 .vindex "&$local_part$&"
22670 Similarly, at the start of an ACL for RCPT, the current recipient's address
22671 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22672 rewrite rules have yet been applied to it. However, the behaviour is different
22673 from the sender address when a recipient is verified. The address is rewritten
22674 for the verification, but the rewriting is not remembered at this stage. The
22675 value of &$local_part$& and &$domain$& after verification are always the same
22676 as they were before (that is, they contain the unrewritten &-- except for
22677 SMTP-time rewriting &-- address).
22678
22679 As soon as a message's header lines have been received, all the envelope
22680 recipient addresses are permanently rewritten, and rewriting is also applied to
22681 the addresses in the header lines (if configured). This happens before adding
22682 any header lines that were specified in MAIL or RCPT ACLs, and
22683 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22684 before the DATA ACL and &[local_scan()]& functions are run.
22685
22686 When an address is being routed, either for delivery or for verification,
22687 rewriting is applied immediately to child addresses that are generated by
22688 redirection, unless &%no_rewrite%& is set on the router.
22689
22690 .cindex "envelope sender" "rewriting at transport time"
22691 .cindex "rewriting" "at transport time"
22692 .cindex "header lines" "rewriting at transport time"
22693 At transport time, additional rewriting of addresses in header lines can be
22694 specified by setting the generic &%headers_rewrite%& option on a transport.
22695 This option contains rules that are identical in form to those in the rewrite
22696 section of the configuration file. They are applied to the original message
22697 header lines and any that were added by ACLs or a system filter. They are not
22698 applied to header lines that are added by routers or the transport.
22699
22700 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22701 transport option. However, it is not possible to rewrite envelope recipients at
22702 transport time.
22703
22704
22705
22706
22707 .section "Testing the rewriting rules that apply on input" "SECID149"
22708 .cindex "rewriting" "testing"
22709 .cindex "testing" "rewriting"
22710 Exim's input rewriting configuration appears in a part of the run time
22711 configuration file headed by &"begin rewrite"&. It can be tested by the
22712 &%-brw%& command line option. This takes an address (which can be a full RFC
22713 2822 address) as its argument. The output is a list of how the address would be
22714 transformed by the rewriting rules for each of the different places it might
22715 appear in an incoming message, that is, for each different header and for the
22716 envelope sender and recipient fields. For example,
22717 .code
22718 exim -brw ph10@exim.workshop.example
22719 .endd
22720 might produce the output
22721 .code
22722 sender: Philip.Hazel@exim.workshop.example
22723 from: Philip.Hazel@exim.workshop.example
22724 to: ph10@exim.workshop.example
22725 cc: ph10@exim.workshop.example
22726 bcc: ph10@exim.workshop.example
22727 reply-to: Philip.Hazel@exim.workshop.example
22728 env-from: Philip.Hazel@exim.workshop.example
22729 env-to: ph10@exim.workshop.example
22730 .endd
22731 which shows that rewriting has been set up for that address when used in any of
22732 the source fields, but not when it appears as a recipient address. At the
22733 present time, there is no equivalent way of testing rewriting rules that are
22734 set for a particular transport.
22735
22736
22737 .section "Rewriting rules" "SECID150"
22738 .cindex "rewriting" "rules"
22739 The rewrite section of the configuration file consists of lines of rewriting
22740 rules in the form
22741 .display
22742 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22743 .endd
22744 Rewriting rules that are specified for the &%headers_rewrite%& generic
22745 transport option are given as a colon-separated list. Each item in the list
22746 takes the same form as a line in the main rewriting configuration (except that
22747 any colons must be doubled, of course).
22748
22749 The formats of source patterns and replacement strings are described below.
22750 Each is terminated by white space, unless enclosed in double quotes, in which
22751 case normal quoting conventions apply inside the quotes. The flags are single
22752 characters which may appear in any order. Spaces and tabs between them are
22753 ignored.
22754
22755 For each address that could potentially be rewritten, the rules are scanned in
22756 order, and replacements for the address from earlier rules can themselves be
22757 replaced by later rules (but see the &"q"& and &"R"& flags).
22758
22759 The order in which addresses are rewritten is undefined, may change between
22760 releases, and must not be relied on, with one exception: when a message is
22761 received, the envelope sender is always rewritten first, before any header
22762 lines are rewritten. For example, the replacement string for a rewrite of an
22763 address in &'To:'& must not assume that the message's address in &'From:'& has
22764 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22765 that the envelope sender has already been rewritten.
22766
22767 .vindex "&$domain$&"
22768 .vindex "&$local_part$&"
22769 The variables &$local_part$& and &$domain$& can be used in the replacement
22770 string to refer to the address that is being rewritten. Note that lookup-driven
22771 rewriting can be done by a rule of the form
22772 .code
22773 *@*   ${lookup ...
22774 .endd
22775 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22776 refer to the address that is being rewritten.
22777
22778
22779 .section "Rewriting patterns" "SECID151"
22780 .cindex "rewriting" "patterns"
22781 .cindex "address list" "in a rewriting pattern"
22782 The source pattern in a rewriting rule is any item which may appear in an
22783 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22784 single-item address list, which means that it is expanded before being tested
22785 against the address. As always, if you use a regular expression as a pattern,
22786 you must take care to escape dollar and backslash characters, or use the &`\N`&
22787 facility to suppress string expansion within the regular expression.
22788
22789 Domains in patterns should be given in lower case. Local parts in patterns are
22790 case-sensitive. If you want to do case-insensitive matching of local parts, you
22791 can use a regular expression that starts with &`^(?i)`&.
22792
22793 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22794 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22795 depending on the type of match which occurred. These can be used in the
22796 replacement string to insert portions of the incoming address. &$0$& always
22797 refers to the complete incoming address. When a regular expression is used, the
22798 numerical variables are set from its capturing subexpressions. For other types
22799 of pattern they are set as follows:
22800
22801 .ilist
22802 If a local part or domain starts with an asterisk, the numerical variables
22803 refer to the character strings matched by asterisks, with &$1$& associated with
22804 the first asterisk, and &$2$& with the second, if present. For example, if the
22805 pattern
22806 .code
22807 *queen@*.fict.example
22808 .endd
22809 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22810 .code
22811 $0 = hearts-queen@wonderland.fict.example
22812 $1 = hearts-
22813 $2 = wonderland
22814 .endd
22815 Note that if the local part does not start with an asterisk, but the domain
22816 does, it is &$1$& that contains the wild part of the domain.
22817
22818 .next
22819 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22820 of the domain are placed in the next available numerical variables. Suppose,
22821 for example, that the address &'foo@bar.baz.example'& is processed by a
22822 rewriting rule of the form
22823 .display
22824 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22825 .endd
22826 and the key in the file that matches the domain is &`*.baz.example`&. Then
22827 .code
22828 $1 = foo
22829 $2 = bar
22830 $3 = baz.example
22831 .endd
22832 If the address &'foo@baz.example'& is looked up, this matches the same
22833 wildcard file entry, and in this case &$2$& is set to the empty string, but
22834 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22835 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22836 whole domain. For non-partial domain lookups, no numerical variables are set.
22837 .endlist
22838
22839
22840 .section "Rewriting replacements" "SECID152"
22841 .cindex "rewriting" "replacements"
22842 If the replacement string for a rule is a single asterisk, addresses that
22843 match the pattern and the flags are &'not'& rewritten, and no subsequent
22844 rewriting rules are scanned. For example,
22845 .code
22846 hatta@lookingglass.fict.example  *  f
22847 .endd
22848 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22849 &'From:'& headers.
22850
22851 .vindex "&$domain$&"
22852 .vindex "&$local_part$&"
22853 If the replacement string is not a single asterisk, it is expanded, and must
22854 yield a fully qualified address. Within the expansion, the variables
22855 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22856 Any letters they contain retain their original case &-- they are not lower
22857 cased. The numerical variables are set up according to the type of pattern that
22858 matched the address, as described above. If the expansion is forced to fail by
22859 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22860 current rule is abandoned, but subsequent rules may take effect. Any other
22861 expansion failure causes the entire rewriting operation to be abandoned, and an
22862 entry written to the panic log.
22863
22864
22865
22866 .section "Rewriting flags" "SECID153"
22867 There are three different kinds of flag that may appear on rewriting rules:
22868
22869 .ilist
22870 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22871 c, f, h, r, s, t.
22872 .next
22873 A flag that specifies rewriting at SMTP time: S.
22874 .next
22875 Flags that control the rewriting process: Q, q, R, w.
22876 .endlist
22877
22878 For rules that are part of the &%headers_rewrite%& generic transport option,
22879 E, F, T, and S are not permitted.
22880
22881
22882
22883 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22884          "SECID154"
22885 .cindex "rewriting" "flags"
22886 If none of the following flag letters, nor the &"S"& flag (see section
22887 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22888 and to both the sender and recipient fields of the envelope, whereas a
22889 transport-time rewriting rule just applies to all headers. Otherwise, the
22890 rewriting rule is skipped unless the relevant addresses are being processed.
22891 .display
22892 &`E`&       rewrite all envelope fields
22893 &`F`&       rewrite the envelope From field
22894 &`T`&       rewrite the envelope To field
22895 &`b`&       rewrite the &'Bcc:'& header
22896 &`c`&       rewrite the &'Cc:'& header
22897 &`f`&       rewrite the &'From:'& header
22898 &`h`&       rewrite all headers
22899 &`r`&       rewrite the &'Reply-To:'& header
22900 &`s`&       rewrite the &'Sender:'& header
22901 &`t`&       rewrite the &'To:'& header
22902 .endd
22903 "All headers" means all of the headers listed above that can be selected
22904 individually, plus their &'Resent-'& versions. It does not include
22905 other headers such as &'Subject:'& etc.
22906
22907 You should be particularly careful about rewriting &'Sender:'& headers, and
22908 restrict this to special known cases in your own domains.
22909
22910
22911 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22912 .cindex "SMTP" "rewriting malformed addresses"
22913 .cindex "RCPT" "rewriting argument of"
22914 .cindex "MAIL" "rewriting argument of"
22915 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22916 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22917 before any other processing; even before syntax checking. The pattern is
22918 required to be a regular expression, and it is matched against the whole of the
22919 data for the command, including any surrounding angle brackets.
22920
22921 .vindex "&$domain$&"
22922 .vindex "&$local_part$&"
22923 This form of rewrite rule allows for the handling of addresses that are not
22924 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22925 input). Because the input is not required to be a syntactically valid address,
22926 the variables &$local_part$& and &$domain$& are not available during the
22927 expansion of the replacement string. The result of rewriting replaces the
22928 original address in the MAIL or RCPT command.
22929
22930
22931 .section "Flags controlling the rewriting process" "SECID155"
22932 There are four flags which control the way the rewriting process works. These
22933 take effect only when a rule is invoked, that is, when the address is of the
22934 correct type (matches the flags) and matches the pattern:
22935
22936 .ilist
22937 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22938 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22939 absence of &"Q"& the rewritten address must always include a domain.
22940 .next
22941 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22942 even if no rewriting actually takes place because of a &"fail"& in the
22943 expansion. The &"q"& flag is not effective if the address is of the wrong type
22944 (does not match the flags) or does not match the pattern.
22945 .next
22946 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22947 address, up to ten times. It can be combined with the &"q"& flag, to stop
22948 rewriting once it fails to match (after at least one successful rewrite).
22949 .next
22950 .cindex "rewriting" "whole addresses"
22951 When an address in a header is rewritten, the rewriting normally applies only
22952 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22953 left unchanged. For example, rewriting might change
22954 .code
22955 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22956 .endd
22957 into
22958 .code
22959 From: Ford Prefect <prefectf@hitch.fict.example>
22960 .endd
22961 .cindex "RFC 2047"
22962 Sometimes there is a need to replace the whole address item, and this can be
22963 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22964 causes an address in a header line to be rewritten, the entire address is
22965 replaced, not just the working part. The replacement must be a complete RFC
22966 2822 address, including the angle brackets if necessary. If text outside angle
22967 brackets contains a character whose value is greater than 126 or less than 32
22968 (except for tab), the text is encoded according to RFC 2047. The character set
22969 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22970
22971 When the &"w"& flag is set on a rule that causes an envelope address to be
22972 rewritten, all but the working part of the replacement address is discarded.
22973 .endlist
22974
22975
22976 .section "Rewriting examples" "SECID156"
22977 Here is an example of the two common rewriting paradigms:
22978 .code
22979 *@*.hitch.fict.example  $1@hitch.fict.example
22980 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22981                      {$value}fail}@hitch.fict.example bctfrF
22982 .endd
22983 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22984 the string expansion to fail if the lookup does not succeed. In this context it
22985 has the effect of leaving the original address unchanged, but Exim goes on to
22986 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22987 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22988 explicitly, which would cause the rewritten address to be the same as before,
22989 at the cost of a small bit of processing. Not supplying either of these is an
22990 error, since the rewritten address would then contain no local part.
22991
22992 The first example above replaces the domain with a superior, more general
22993 domain. This may not be desirable for certain local parts. If the rule
22994 .code
22995 root@*.hitch.fict.example  *
22996 .endd
22997 were inserted before the first rule, rewriting would be suppressed for the
22998 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22999
23000 Rewriting can be made conditional on a number of tests, by making use of
23001 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23002 messages that originate outside the local host:
23003 .code
23004 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23005                          {$1@hitch.fict.example}fail}"
23006 .endd
23007 The replacement string is quoted in this example because it contains white
23008 space.
23009
23010 .cindex "rewriting" "bang paths"
23011 .cindex "bang paths" "rewriting"
23012 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23013 an address it treats it as an unqualified local part which it qualifies with
23014 the local qualification domain (if the source of the message is local or if the
23015 remote host is permitted to send unqualified addresses). Rewriting can
23016 sometimes be used to handle simple bang paths with a fixed number of
23017 components. For example, the rule
23018 .code
23019 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23020 .endd
23021 rewrites a two-component bang path &'host.name!user'& as the domain address
23022 &'user@host.name'&. However, there is a security implication in using this as
23023 a global rewriting rule for envelope addresses. It can provide a backdoor
23024 method for using your system as a relay, because the incoming addresses appear
23025 to be local. If the bang path addresses are received via SMTP, it is safer to
23026 use the &"S"& flag to rewrite them as they are received, so that relay checking
23027 can be done on the rewritten addresses.
23028 .ecindex IIDaddrew
23029
23030
23031
23032
23033
23034 . ////////////////////////////////////////////////////////////////////////////
23035 . ////////////////////////////////////////////////////////////////////////////
23036
23037 .chapter "Retry configuration" "CHAPretry"
23038 .scindex IIDretconf1 "retry" "configuration, description of"
23039 .scindex IIDregconf2 "configuration file" "retry section"
23040 The &"retry"& section of the runtime configuration file contains a list of
23041 retry rules that control how often Exim tries to deliver messages that cannot
23042 be delivered at the first attempt. If there are no retry rules (the section is
23043 empty or not present), there are no retries. In this situation, temporary
23044 errors are treated as permanent. The default configuration contains a single,
23045 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23046 line option can be used to test which retry rule will be used for a given
23047 address, domain and error.
23048
23049 The most common cause of retries is temporary failure to deliver to a remote
23050 host because the host is down, or inaccessible because of a network problem.
23051 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23052 address) basis, not on a per-message basis. Thus, if one message has recently
23053 been delayed, delivery of a new message to the same host is not immediately
23054 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23055 log selector is set, the message
23056 .cindex "retry" "time not reached"
23057 &"retry time not reached"& is written to the main log whenever a delivery is
23058 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23059 the handling of errors during remote deliveries.
23060
23061 Retry processing applies to routing as well as to delivering, except as covered
23062 in the next paragraph. The retry rules do not distinguish between these
23063 actions. It is not possible, for example, to specify different behaviour for
23064 failures to route the domain &'snark.fict.example'& and failures to deliver to
23065 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23066 added complication, so did not implement it. However, although they share the
23067 same retry rule, the actual retry times for routing and transporting a given
23068 domain are maintained independently.
23069
23070 When a delivery is not part of a queue run (typically an immediate delivery on
23071 receipt of a message), the routers are always run, and local deliveries are
23072 always attempted, even if retry times are set for them. This makes for better
23073 behaviour if one particular message is causing problems (for example, causing
23074 quota overflow, or provoking an error in a filter file). If such a delivery
23075 suffers a temporary failure, the retry data is updated as normal, and
23076 subsequent delivery attempts from queue runs occur only when the retry time for
23077 the local address is reached.
23078
23079 .section "Changing retry rules" "SECID157"
23080 If you change the retry rules in your configuration, you should consider
23081 whether or not to delete the retry data that is stored in Exim's spool area in
23082 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23083 always safe; that is why they are called &"hints"&.
23084
23085 The hints retry data contains suggested retry times based on the previous
23086 rules. In the case of a long-running problem with a remote host, it might
23087 record the fact that the host has timed out. If your new rules increase the
23088 timeout time for such a host, you should definitely remove the old retry data
23089 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23090 messages that it should now be retaining.
23091
23092
23093
23094 .section "Format of retry rules" "SECID158"
23095 .cindex "retry" "rules"
23096 Each retry rule occupies one line and consists of three or four parts,
23097 separated by white space: a pattern, an error name, an optional list of sender
23098 addresses, and a list of retry parameters. The pattern and sender lists must be
23099 enclosed in double quotes if they contain white space. The rules are searched
23100 in order until one is found where the pattern, error name, and sender list (if
23101 present) match the failing host or address, the error that occurred, and the
23102 message's sender, respectively.
23103
23104
23105 The pattern is any single item that may appear in an address list (see section
23106 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23107 which means that it is expanded before being tested against the address that
23108 has been delayed. A negated address list item is permitted. Address
23109 list processing treats a plain domain name as if it were preceded by &"*@"&,
23110 which makes it possible for many retry rules to start with just a domain. For
23111 example,
23112 .code
23113 lookingglass.fict.example        *  F,24h,30m;
23114 .endd
23115 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23116 whereas
23117 .code
23118 alice@lookingglass.fict.example  *  F,24h,30m;
23119 .endd
23120 applies only to temporary failures involving the local part &%alice%&.
23121 In practice, almost all rules start with a domain name pattern without a local
23122 part.
23123
23124 .cindex "regular expressions" "in retry rules"
23125 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23126 must match a complete address, not just a domain, because that is how regular
23127 expressions work in address lists.
23128 .display
23129 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23130 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23131 .endd
23132
23133
23134 .section "Choosing which retry rule to use for address errors" "SECID159"
23135 When Exim is looking for a retry rule after a routing attempt has failed (for
23136 example, after a DNS timeout), each line in the retry configuration is tested
23137 against the complete address only if &%retry_use_local_part%& is set for the
23138 router. Otherwise, only the domain is used, except when matching against a
23139 regular expression, when the local part of the address is replaced with &"*"&.
23140 A domain on its own can match a domain pattern, or a pattern that starts with
23141 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23142 &%check_local_user%& is true, and false for other routers.
23143
23144 Similarly, when Exim is looking for a retry rule after a local delivery has
23145 failed (for example, after a mailbox full error), each line in the retry
23146 configuration is tested against the complete address only if
23147 &%retry_use_local_part%& is set for the transport (it defaults true for all
23148 local transports).
23149
23150 .cindex "4&'xx'& responses" "retry rules for"
23151 However, when Exim is looking for a retry rule after a remote delivery attempt
23152 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23153 whole address is always used as the key when searching the retry rules. The
23154 rule that is found is used to create a retry time for the combination of the
23155 failing address and the message's sender. It is the combination of sender and
23156 recipient that is delayed in subsequent queue runs until its retry time is
23157 reached. You can delay the recipient without regard to the sender by setting
23158 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23159 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23160 commands.
23161
23162
23163
23164 .section "Choosing which retry rule to use for host and message errors" &&&
23165          "SECID160"
23166 For a temporary error that is not related to an individual address (for
23167 example, a connection timeout), each line in the retry configuration is checked
23168 twice. First, the name of the remote host is used as a domain name (preceded by
23169 &"*@"& when matching a regular expression). If this does not match the line,
23170 the domain from the email address is tried in a similar fashion. For example,
23171 suppose the MX records for &'a.b.c.example'& are
23172 .code
23173 a.b.c.example  MX  5  x.y.z.example
23174                MX  6  p.q.r.example
23175                MX  7  m.n.o.example
23176 .endd
23177 and the retry rules are
23178 .code
23179 p.q.r.example    *      F,24h,30m;
23180 a.b.c.example    *      F,4d,45m;
23181 .endd
23182 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23183 first rule matches neither the host nor the domain, so Exim looks at the second
23184 rule. This does not match the host, but it does match the domain, so it is used
23185 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23186 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23187 first retry rule is used, because it matches the host.
23188
23189 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23190 first rule to determine retry times, but for all the other hosts for the domain
23191 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23192 routing to &'a.b.c.example'& suffers a temporary failure.
23193
23194 &*Note*&: The host name is used when matching the patterns, not its IP address.
23195 However, if a message is routed directly to an IP address without the use of a
23196 host name, for example, if a &(manualroute)& router contains a setting such as:
23197 .code
23198 route_list = *.a.example  192.168.34.23
23199 .endd
23200 then the &"host name"& that is used when searching for a retry rule is the
23201 textual form of the IP address.
23202
23203 .section "Retry rules for specific errors" "SECID161"
23204 .cindex "retry" "specific errors; specifying"
23205 The second field in a retry rule is the name of a particular error, or an
23206 asterisk, which matches any error. The errors that can be tested for are:
23207
23208 .vlist
23209 .vitem &%auth_failed%&
23210 Authentication failed when trying to send to a host in the
23211 &%hosts_require_auth%& list in an &(smtp)& transport.
23212
23213 .vitem &%data_4xx%&
23214 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23215 after the command, or after sending the message's data.
23216
23217 .vitem &%mail_4xx%&
23218 A 4&'xx'& error was received for an outgoing MAIL command.
23219
23220 .vitem &%rcpt_4xx%&
23221 A 4&'xx'& error was received for an outgoing RCPT command.
23222 .endlist
23223
23224 For the three 4&'xx'& errors, either the first or both of the x's can be given
23225 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23226 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23227 and have retries every ten minutes with a one-hour timeout, you could set up a
23228 retry rule of this form:
23229 .code
23230 the.domain.name  rcpt_452   F,1h,10m
23231 .endd
23232 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23233 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23234
23235 .vlist
23236 .vitem &%lost_connection%&
23237 A server unexpectedly closed the SMTP connection. There may, of course,
23238 legitimate reasons for this (host died, network died), but if it repeats a lot
23239 for the same host, it indicates something odd.
23240
23241 .vitem &%refused_MX%&
23242 A connection to a host obtained from an MX record was refused.
23243
23244 .vitem &%refused_A%&
23245 A connection to a host not obtained from an MX record was refused.
23246
23247 .vitem &%refused%&
23248 A connection was refused.
23249
23250 .vitem &%timeout_connect_MX%&
23251 A connection attempt to a host obtained from an MX record timed out.
23252
23253 .vitem &%timeout_connect_A%&
23254 A connection attempt to a host not obtained from an MX record timed out.
23255
23256 .vitem &%timeout_connect%&
23257 A connection attempt timed out.
23258
23259 .vitem &%timeout_MX%&
23260 There was a timeout while connecting or during an SMTP session with a host
23261 obtained from an MX record.
23262
23263 .vitem &%timeout_A%&
23264 There was a timeout while connecting or during an SMTP session with a host not
23265 obtained from an MX record.
23266
23267 .vitem &%timeout%&
23268 There was a timeout while connecting or during an SMTP session.
23269
23270 .vitem &%tls_required%&
23271 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23272 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23273 to STARTTLS, or there was a problem setting up the TLS connection.
23274
23275 .vitem &%quota%&
23276 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23277 transport.
23278
23279 .vitem &%quota_%&<&'time'&>
23280 .cindex "quota" "error testing in retry rule"
23281 .cindex "retry" "quota error testing"
23282 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23283 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23284 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23285 for four days.
23286 .endlist
23287
23288 .cindex "mailbox" "time of last read"
23289 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23290 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23291 it should be based on the last time that the user accessed the mailbox.
23292 However, it is not always possible to determine this. Exim uses the following
23293 heuristic rules:
23294
23295 .ilist
23296 If the mailbox is a single file, the time of last access (the &"atime"&) is
23297 used. As no new messages are being delivered (because the mailbox is over
23298 quota), Exim does not access the file, so this is the time of last user access.
23299 .next
23300 .cindex "maildir format" "time of last read"
23301 For a maildir delivery, the time of last modification of the &_new_&
23302 subdirectory is used. As the mailbox is over quota, no new files are created in
23303 the &_new_& subdirectory, because no new messages are being delivered. Any
23304 change to the &_new_& subdirectory is therefore assumed to be the result of an
23305 MUA moving a new message to the &_cur_& directory when it is first read. The
23306 time that is used is therefore the last time that the user read a new message.
23307 .next
23308 For other kinds of multi-file mailbox, the time of last access cannot be
23309 obtained, so a retry rule that uses this type of error field is never matched.
23310 .endlist
23311
23312 The quota errors apply both to system-enforced quotas and to Exim's own quota
23313 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23314 when a local delivery is deferred because a partition is full (the ENOSPC
23315 error).
23316
23317
23318
23319 .section "Retry rules for specified senders" "SECID162"
23320 .cindex "retry" "rules; sender-specific"
23321 You can specify retry rules that apply only when the failing message has a
23322 specific sender. In particular, this can be used to define retry rules that
23323 apply only to bounce messages. The third item in a retry rule can be of this
23324 form:
23325 .display
23326 &`senders=`&<&'address list'&>
23327 .endd
23328 The retry timings themselves are then the fourth item. For example:
23329 .code
23330 *   rcpt_4xx   senders=:   F,1h,30m
23331 .endd
23332 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23333 host. If the address list contains white space, it must be enclosed in quotes.
23334 For example:
23335 .code
23336 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23337 .endd
23338 &*Warning*&: This facility can be unhelpful if it is used for host errors
23339 (which do not depend on the recipient). The reason is that the sender is used
23340 only to match the retry rule. Once the rule has been found for a host error,
23341 its contents are used to set a retry time for the host, and this will apply to
23342 all messages, not just those with specific senders.
23343
23344 When testing retry rules using &%-brt%&, you can supply a sender using the
23345 &%-f%& command line option, like this:
23346 .code
23347 exim -f "" -brt user@dom.ain
23348 .endd
23349 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23350 list is never matched.
23351
23352
23353
23354
23355
23356 .section "Retry parameters" "SECID163"
23357 .cindex "retry" "parameters in rules"
23358 The third (or fourth, if a senders list is present) field in a retry rule is a
23359 sequence of retry parameter sets, separated by semicolons. Each set consists of
23360 .display
23361 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23362 .endd
23363 The letter identifies the algorithm for computing a new retry time; the cutoff
23364 time is the time beyond which this algorithm no longer applies, and the
23365 arguments vary the algorithm's action. The cutoff time is measured from the
23366 time that the first failure for the domain (combined with the local part if
23367 relevant) was detected, not from the time the message was received.
23368
23369 .cindex "retry" "algorithms"
23370 .cindex "retry" "fixed intervals"
23371 .cindex "retry" "increasing intervals"
23372 .cindex "retry" "random intervals"
23373 The available algorithms are:
23374
23375 .ilist
23376 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23377 the interval.
23378 .next
23379 &'G'&: retry at geometrically increasing intervals. The first argument
23380 specifies a starting value for the interval, and the second a multiplier, which
23381 is used to increase the size of the interval at each retry.
23382 .next
23383 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23384 retry, the previous interval is multiplied by the factor in order to get a
23385 maximum for the next interval. The minimum interval is the first argument of
23386 the parameter, and an actual interval is chosen randomly between them. Such a
23387 rule has been found to be helpful in cluster configurations when all the
23388 members of the cluster restart at once, and may therefore synchronize their
23389 queue processing times.
23390 .endlist
23391
23392 When computing the next retry time, the algorithm definitions are scanned in
23393 order until one whose cutoff time has not yet passed is reached. This is then
23394 used to compute a new retry time that is later than the current time. In the
23395 case of fixed interval retries, this simply means adding the interval to the
23396 current time. For geometrically increasing intervals, retry intervals are
23397 computed from the rule's parameters until one that is greater than the previous
23398 interval is found. The main configuration variable
23399 .cindex "limit" "retry interval"
23400 .cindex "retry" "interval, maximum"
23401 .oindex "&%retry_interval_max%&"
23402 &%retry_interval_max%& limits the maximum interval between retries. It
23403 cannot be set greater than &`24h`&, which is its default value.
23404
23405 A single remote domain may have a number of hosts associated with it, and each
23406 host may have more than one IP address. Retry algorithms are selected on the
23407 basis of the domain name, but are applied to each IP address independently. If,
23408 for example, a host has two IP addresses and one is unusable, Exim will
23409 generate retry times for it and will not try to use it until its next retry
23410 time comes. Thus the good IP address is likely to be tried first most of the
23411 time.
23412
23413 .cindex "hints database" "use for retrying"
23414 Retry times are hints rather than promises. Exim does not make any attempt to
23415 run deliveries exactly at the computed times. Instead, a queue runner process
23416 starts delivery processes for delayed messages periodically, and these attempt
23417 new deliveries only for those addresses that have passed their next retry time.
23418 If a new message arrives for a deferred address, an immediate delivery attempt
23419 occurs only if the address has passed its retry time. In the absence of new
23420 messages, the minimum time between retries is the interval between queue runner
23421 processes. There is not much point in setting retry times of five minutes if
23422 your queue runners happen only once an hour, unless there are a significant
23423 number of incoming messages (which might be the case on a system that is
23424 sending everything to a smart host, for example).
23425
23426 The data in the retry hints database can be inspected by using the
23427 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23428 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23429 &'exinext'& utility script can be used to find out what the next retry times
23430 are for the hosts associated with a particular mail domain, and also for local
23431 deliveries that have been deferred.
23432
23433
23434 .section "Retry rule examples" "SECID164"
23435 Here are some example retry rules:
23436 .code
23437 alice@wonderland.fict.example quota_5d  F,7d,3h
23438 wonderland.fict.example       quota_5d
23439 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23440 lookingglass.fict.example     *         F,24h,30m;
23441 *                 refused_A   F,2h,20m;
23442 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23443 .endd
23444 The first rule sets up special handling for mail to
23445 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23446 mailbox has not been read for at least 5 days. Retries continue every three
23447 hours for 7 days. The second rule handles over-quota errors for all other local
23448 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23449 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23450 fail are bounced immediately if the mailbox has not been read for at least 5
23451 days.
23452
23453 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23454 happen every 15 minutes for an hour, then with geometrically increasing
23455 intervals until two days have passed since a delivery first failed. After the
23456 first hour there is a delay of one hour, then two hours, then four hours, and
23457 so on (this is a rather extreme example).
23458
23459 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23460 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23461 all other domains, with special action for connection refusal from hosts that
23462 were not obtained from an MX record.
23463
23464 The final rule in a retry configuration should always have asterisks in the
23465 first two fields so as to provide a general catch-all for any addresses that do
23466 not have their own special handling. This example tries every 15 minutes for 2
23467 hours, then with intervals starting at one hour and increasing by a factor of
23468 1.5 up to 16 hours, then every 8 hours up to 5 days.
23469
23470
23471
23472 .section "Timeout of retry data" "SECID165"
23473 .cindex "timeout" "of retry data"
23474 .oindex "&%retry_data_expire%&"
23475 .cindex "hints database" "data expiry"
23476 .cindex "retry" "timeout of data"
23477 Exim timestamps the data that it writes to its retry hints database. When it
23478 consults the data during a delivery it ignores any that is older than the value
23479 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23480 been tried for 7 days, Exim will try to deliver to it immediately a message
23481 arrives, and if that fails, it will calculate a retry time as if it were
23482 failing for the first time.
23483
23484 This improves the behaviour for messages routed to rarely-used hosts such as MX
23485 backups. If such a host was down at one time, and happens to be down again when
23486 Exim tries a month later, using the old retry data would imply that it had been
23487 down all the time, which is not a justified assumption.
23488
23489 If a host really is permanently dead, this behaviour causes a burst of retries
23490 every now and again, but only if messages routed to it are rare. If there is a
23491 message at least once every 7 days the retry data never expires.
23492
23493
23494
23495
23496 .section "Long-term failures" "SECID166"
23497 .cindex "delivery failure, long-term"
23498 .cindex "retry" "after long-term failure"
23499 Special processing happens when an email address has been failing for so long
23500 that the cutoff time for the last algorithm is reached. For example, using the
23501 default retry rule:
23502 .code
23503 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23504 .endd
23505 the cutoff time is four days. Reaching the retry cutoff is independent of how
23506 long any specific message has been failing; it is the length of continuous
23507 failure for the recipient address that counts.
23508
23509 When the cutoff time is reached for a local delivery, or for all the IP
23510 addresses associated with a remote delivery, a subsequent delivery failure
23511 causes Exim to give up on the address, and a bounce message is generated.
23512 In order to cater for new messages that use the failing address, a next retry
23513 time is still computed from the final algorithm, and is used as follows:
23514
23515 For local deliveries, one delivery attempt is always made for any subsequent
23516 messages. If this delivery fails, the address fails immediately. The
23517 post-cutoff retry time is not used.
23518
23519 If the delivery is remote, there are two possibilities, controlled by the
23520 .oindex "&%delay_after_cutoff%&"
23521 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23522 default. Until the post-cutoff retry time for one of the IP addresses is
23523 reached, the failing email address is bounced immediately, without a delivery
23524 attempt taking place. After that time, one new delivery attempt is made to
23525 those IP addresses that are past their retry times, and if that still fails,
23526 the address is bounced and new retry times are computed.
23527
23528 In other words, when all the hosts for a given email address have been failing
23529 for a long time, Exim bounces rather then defers until one of the hosts' retry
23530 times is reached. Then it tries once, and bounces if that attempt fails. This
23531 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23532 to a broken destination, but if the host does recover, Exim will eventually
23533 notice.
23534
23535 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23536 addresses are past their final cutoff time, Exim tries to deliver to those IP
23537 addresses that have not been tried since the message arrived. If there are
23538 no suitable IP addresses, or if they all fail, the address is bounced. In other
23539 words, it does not delay when a new message arrives, but tries the expired
23540 addresses immediately, unless they have been tried since the message arrived.
23541 If there is a continuous stream of messages for the failing domains, setting
23542 &%delay_after_cutoff%& false means that there will be many more attempts to
23543 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23544 true.
23545
23546 .section "Deliveries that work intermittently" "SECID167"
23547 .cindex "retry" "intermittently working deliveries"
23548 Some additional logic is needed to cope with cases where a host is
23549 intermittently available, or when a message has some attribute that prevents
23550 its delivery when others to the same address get through. In this situation,
23551 because some messages are successfully delivered, the &"retry clock"& for the
23552 host or address keeps getting reset by the successful deliveries, and so
23553 failing messages remain on the queue for ever because the cutoff time is never
23554 reached.
23555
23556 Two exceptional actions are applied to prevent this happening. The first
23557 applies to errors that are related to a message rather than a remote host.
23558 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23559 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23560 commands, and quota failures. For this type of error, if a message's arrival
23561 time is earlier than the &"first failed"& time for the error, the earlier time
23562 is used when scanning the retry rules to decide when to try next and when to
23563 time out the address.
23564
23565 The exceptional second action applies in all cases. If a message has been on
23566 the queue for longer than the cutoff time of any applicable retry rule for a
23567 given address, a delivery is attempted for that address, even if it is not yet
23568 time, and if this delivery fails, the address is timed out. A new retry time is
23569 not computed in this case, so that other messages for the same address are
23570 considered immediately.
23571 .ecindex IIDretconf1
23572 .ecindex IIDregconf2
23573
23574
23575
23576
23577
23578
23579 . ////////////////////////////////////////////////////////////////////////////
23580 . ////////////////////////////////////////////////////////////////////////////
23581
23582 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23583 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23584 .scindex IIDauthconf2 "authentication"
23585 The &"authenticators"& section of Exim's run time configuration is concerned
23586 with SMTP authentication. This facility is an extension to the SMTP protocol,
23587 described in RFC 2554, which allows a client SMTP host to authenticate itself
23588 to a server. This is a common way for a server to recognize clients that are
23589 permitted to use it as a relay. SMTP authentication is not of relevance to the
23590 transfer of mail between servers that have no managerial connection with each
23591 other.
23592
23593 .cindex "AUTH" "description of"
23594 Very briefly, the way SMTP authentication works is as follows:
23595
23596 .ilist
23597 The server advertises a number of authentication &'mechanisms'& in response to
23598 the client's EHLO command.
23599 .next
23600 The client issues an AUTH command, naming a specific mechanism. The command
23601 may, optionally, contain some authentication data.
23602 .next
23603 The server may issue one or more &'challenges'&, to which the client must send
23604 appropriate responses. In simple authentication mechanisms, the challenges are
23605 just prompts for user names and passwords. The server does not have to issue
23606 any challenges &-- in some mechanisms the relevant data may all be transmitted
23607 with the AUTH command.
23608 .next
23609 The server either accepts or denies authentication.
23610 .next
23611 If authentication succeeds, the client may optionally make use of the AUTH
23612 option on the MAIL command to pass an authenticated sender in subsequent
23613 mail transactions. Authentication lasts for the remainder of the SMTP
23614 connection.
23615 .next
23616 If authentication fails, the client may give up, or it may try a different
23617 authentication mechanism, or it may try transferring mail over the
23618 unauthenticated connection.
23619 .endlist
23620
23621 If you are setting up a client, and want to know which authentication
23622 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23623 SMTP port) on the server, and issue an EHLO command. The response to this
23624 includes the list of supported mechanisms. For example:
23625 .display
23626 &`$ `&&*&`telnet server.example 25`&*&
23627 &`Trying 192.168.34.25...`&
23628 &`Connected to server.example.`&
23629 &`Escape character is &#x0027;^]&#x0027;.`&
23630 &`220 server.example ESMTP Exim 4.20 ...`&
23631 &*&`ehlo client.example`&*&
23632 &`250-server.example Hello client.example [10.8.4.5]`&
23633 &`250-SIZE 52428800`&
23634 &`250-PIPELINING`&
23635 &`250-AUTH PLAIN`&
23636 &`250 HELP`&
23637 .endd
23638 The second-last line of this example output shows that the server supports
23639 authentication using the PLAIN mechanism. In Exim, the different authentication
23640 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23641 routers and transports, which authenticators are included in the binary is
23642 controlled by build-time definitions. The following are currently available,
23643 included by setting
23644 .code
23645 AUTH_CRAM_MD5=yes
23646 AUTH_CYRUS_SASL=yes
23647 AUTH_DOVECOT=yes
23648 AUTH_GSASL=yes
23649 AUTH_HEIMDAL_GSSAPI=yes
23650 AUTH_PLAINTEXT=yes
23651 AUTH_SPA=yes
23652 .endd
23653 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23654 authentication mechanism (RFC 2195), and the second provides an interface to
23655 the Cyrus SASL authentication library.
23656 The third is an interface to Dovecot's authentication system, delegating the
23657 work via a socket interface.
23658 The fourth provides an interface to the GNU SASL authentication library, which
23659 provides mechanisms but typically not data sources.
23660 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
23661 supporting setting a server keytab.
23662 The sixth can be configured to support
23663 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23664 not formally documented, but used by several MUAs. The seventh authenticator
23665 supports Microsoft's &'Secure Password Authentication'& mechanism.
23666
23667 The authenticators are configured using the same syntax as other drivers (see
23668 section &<<SECTfordricon>>&). If no authenticators are required, no
23669 authentication section need be present in the configuration file. Each
23670 authenticator can in principle have both server and client functions. When Exim
23671 is receiving SMTP mail, it is acting as a server; when it is sending out
23672 messages over SMTP, it is acting as a client. Authenticator configuration
23673 options are provided for use in both these circumstances.
23674
23675 To make it clear which options apply to which situation, the prefixes
23676 &%server_%& and &%client_%& are used on option names that are specific to
23677 either the server or the client function, respectively. Server and client
23678 functions are disabled if none of their options are set. If an authenticator is
23679 to be used for both server and client functions, a single definition, using
23680 both sets of options, is required. For example:
23681 .code
23682 cram:
23683   driver = cram_md5
23684   public_name = CRAM-MD5
23685   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23686   client_name = ph10
23687   client_secret = secret2
23688 .endd
23689 The &%server_%& option is used when Exim is acting as a server, and the
23690 &%client_%& options when it is acting as a client.
23691
23692 Descriptions of the individual authenticators are given in subsequent chapters.
23693 The remainder of this chapter covers the generic options for the
23694 authenticators, followed by general discussion of the way authentication works
23695 in Exim.
23696
23697 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
23698 per-mechanism basis.  Please read carefully to determine which variables hold
23699 account labels such as usercodes and which hold passwords or other
23700 authenticating data.
23701
23702 Note that some mechanisms support two different identifiers for accounts: the
23703 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
23704 and &'authz'& are commonly encountered.  The American spelling is standard here.
23705 Conceptually, authentication data such as passwords are tied to the identifier
23706 used to authenticate; servers may have rules to permit one user to act as a
23707 second user, so that after login the session is treated as though that second
23708 user had logged in.  That second user is the &'authorization id'&.  A robust
23709 configuration might confirm that the &'authz'& field is empty or matches the
23710 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
23711 as verified data, the &'authz'& as an unverified request which the server might
23712 choose to honour.
23713
23714 A &'realm'& is a text string, typically a domain name, presented by a server
23715 to a client to help it select an account and credentials to use.  In some
23716 mechanisms, the client and server provably agree on the realm, but clients
23717 typically can not treat the realm as secure data to be blindly trusted.
23718
23719
23720
23721 .section "Generic options for authenticators" "SECID168"
23722 .cindex "authentication" "generic options"
23723 .cindex "options" "generic; for authenticators"
23724
23725 .option client_condition authenticators string&!! unset
23726 When Exim is authenticating as a client, it skips any authenticator whose
23727 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23728 used, for example, to skip plain text authenticators when the connection is not
23729 encrypted by a setting such as:
23730 .code
23731 client_condition = ${if !eq{$tls_cipher}{}}
23732 .endd
23733 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23734 used for incoming messages. In fact, during SMTP delivery, it contains the
23735 cipher used for the delivery.)
23736
23737
23738 .option driver authenticators string unset
23739 This option must always be set. It specifies which of the available
23740 authenticators is to be used.
23741
23742
23743 .option public_name authenticators string unset
23744 This option specifies the name of the authentication mechanism that the driver
23745 implements, and by which it is known to the outside world. These names should
23746 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23747 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23748 defaults to the driver's instance name.
23749
23750
23751 .option server_advertise_condition authenticators string&!! unset
23752 When a server is about to advertise an authentication mechanism, the condition
23753 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23754 mechanism is not advertised.
23755 If the expansion fails, the mechanism is not advertised. If the failure was not
23756 forced, and was not caused by a lookup defer, the incident is logged.
23757 See section &<<SECTauthexiser>>& below for further discussion.
23758
23759
23760 .option server_condition authenticators string&!! unset
23761 This option must be set for a &%plaintext%& server authenticator, where it
23762 is used directly to control authentication. See section &<<SECTplainserver>>&
23763 for details.
23764
23765 For the &(gsasl)& authenticator, this option is required for various
23766 mechanisms; see chapter &<<CHAPgsasl>>& for details.
23767
23768 For the other authenticators, &%server_condition%& can be used as an additional
23769 authentication or authorization mechanism that is applied after the other
23770 authenticator conditions succeed. If it is set, it is expanded when the
23771 authenticator would otherwise return a success code. If the expansion is forced
23772 to fail, authentication fails. Any other expansion failure causes a temporary
23773 error code to be returned. If the result of a successful expansion is an empty
23774 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23775 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23776 other result, a temporary error code is returned, with the expanded string as
23777 the error text.
23778
23779
23780 .option server_debug_print authenticators string&!! unset
23781 If this option is set and authentication debugging is enabled (see the &%-d%&
23782 command line option), the string is expanded and included in the debugging
23783 output when the authenticator is run as a server. This can help with checking
23784 out the values of variables.
23785 If expansion of the string fails, the error message is written to the debugging
23786 output, and Exim carries on processing.
23787
23788
23789 .option server_set_id authenticators string&!! unset
23790 .vindex "&$authenticated_id$&"
23791 When an Exim server successfully authenticates a client, this string is
23792 expanded using data from the authentication, and preserved for any incoming
23793 messages in the variable &$authenticated_id$&. It is also included in the log
23794 lines for incoming messages. For example, a user/password authenticator
23795 configuration might preserve the user name that was used to authenticate, and
23796 refer to it subsequently during delivery of the message.
23797 If expansion fails, the option is ignored.
23798
23799
23800 .option server_mail_auth_condition authenticators string&!! unset
23801 This option allows a server to discard authenticated sender addresses supplied
23802 as part of MAIL commands in SMTP connections that are authenticated by the
23803 driver on which &%server_mail_auth_condition%& is set. The option is not used
23804 as part of the authentication process; instead its (unexpanded) value is
23805 remembered for later use.
23806 How it is used is described in the following section.
23807
23808
23809
23810
23811
23812 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23813 .cindex "authentication" "sender; authenticated"
23814 .cindex "AUTH" "on MAIL command"
23815 When a client supplied an AUTH= item on a MAIL command, Exim applies
23816 the following checks before accepting it as the authenticated sender of the
23817 message:
23818
23819 .ilist
23820 If the connection is not using extended SMTP (that is, HELO was used rather
23821 than EHLO), the use of AUTH= is a syntax error.
23822 .next
23823 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23824 .next
23825 .vindex "&$authenticated_sender$&"
23826 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23827 running, the value of &$authenticated_sender$& is set to the value obtained
23828 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23829 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23830 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23831 given for the MAIL command.
23832 .next
23833 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23834 is accepted and placed in &$authenticated_sender$& only if the client has
23835 authenticated.
23836 .next
23837 If the AUTH= value was accepted by either of the two previous rules, and
23838 the client has authenticated, and the authenticator has a setting for the
23839 &%server_mail_auth_condition%&, the condition is checked at this point. The
23840 valued that was saved from the authenticator is expanded. If the expansion
23841 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23842 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23843 the value of &$authenticated_sender$& is retained and passed on with the
23844 message.
23845 .endlist
23846
23847
23848 When &$authenticated_sender$& is set for a message, it is passed on to other
23849 hosts to which Exim authenticates as a client. Do not confuse this value with
23850 &$authenticated_id$&, which is a string obtained from the authentication
23851 process, and which is not usually a complete email address.
23852
23853 .vindex "&$sender_address$&"
23854 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23855 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23856 therefore make use of &$authenticated_sender$&. The converse is not true: the
23857 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23858 ACL is run.
23859
23860
23861
23862 .section "Authentication on an Exim server" "SECTauthexiser"
23863 .cindex "authentication" "on an Exim server"
23864 When Exim receives an EHLO command, it advertises the public names of those
23865 authenticators that are configured as servers, subject to the following
23866 conditions:
23867
23868 .ilist
23869 The client host must match &%auth_advertise_hosts%& (default *).
23870 .next
23871 It the &%server_advertise_condition%& option is set, its expansion must not
23872 yield the empty string, &"0"&, &"no"&, or &"false"&.
23873 .endlist
23874
23875 The order in which the authenticators are defined controls the order in which
23876 the mechanisms are advertised.
23877
23878 Some mail clients (for example, some versions of Netscape) require the user to
23879 provide a name and password for authentication whenever AUTH is advertised,
23880 even though authentication may not in fact be needed (for example, Exim may be
23881 set up to allow unconditional relaying from the client by an IP address check).
23882 You can make such clients more friendly by not advertising AUTH to them.
23883 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23884 that runs for RCPT) to relay without authentication, you should set
23885 .code
23886 auth_advertise_hosts = ! 10.9.8.0/24
23887 .endd
23888 so that no authentication mechanisms are advertised to them.
23889
23890 The &%server_advertise_condition%& controls the advertisement of individual
23891 authentication mechanisms. For example, it can be used to restrict the
23892 advertisement of a particular mechanism to encrypted connections, by a setting
23893 such as:
23894 .code
23895 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23896 .endd
23897 .vindex "&$tls_cipher$&"
23898 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23899 yields &"yes"&, which allows the advertisement to happen.
23900
23901 When an Exim server receives an AUTH command from a client, it rejects it
23902 immediately if AUTH was not advertised in response to an earlier EHLO
23903 command. This is the case if
23904
23905 .ilist
23906 The client host does not match &%auth_advertise_hosts%&; or
23907 .next
23908 No authenticators are configured with server options; or
23909 .next
23910 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23911 server authenticators.
23912 .endlist
23913
23914
23915 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23916 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23917 AUTH is accepted from any client host.
23918
23919 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23920 server authentication mechanism that was advertised in response to EHLO and
23921 that matches the one named in the AUTH command. If it finds one, it runs
23922 the appropriate authentication protocol, and authentication either succeeds or
23923 fails. If there is no matching advertised mechanism, the AUTH command is
23924 rejected with a 504 error.
23925
23926 .vindex "&$received_protocol$&"
23927 .vindex "&$sender_host_authenticated$&"
23928 When a message is received from an authenticated host, the value of
23929 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23930 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23931 public name) of the authenticator driver that successfully authenticated the
23932 client from which the message was received. This variable is empty if there was
23933 no successful authentication.
23934
23935
23936
23937
23938 .section "Testing server authentication" "SECID169"
23939 .cindex "authentication" "testing a server"
23940 .cindex "AUTH" "testing a server"
23941 .cindex "base64 encoding" "creating authentication test data"
23942 Exim's &%-bh%& option can be useful for testing server authentication
23943 configurations. The data for the AUTH command has to be sent using base64
23944 encoding. A quick way to produce such data for testing is the following Perl
23945 script:
23946 .code
23947 use MIME::Base64;
23948 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23949 .endd
23950 .cindex "binary zero" "in authentication data"
23951 This interprets its argument as a Perl string, and then encodes it. The
23952 interpretation as a Perl string allows binary zeros, which are required for
23953 some kinds of authentication, to be included in the data. For example, a
23954 command line to run this script on such data might be
23955 .code
23956 encode '\0user\0password'
23957 .endd
23958 Note the use of single quotes to prevent the shell interpreting the
23959 backslashes, so that they can be interpreted by Perl to specify characters
23960 whose code value is zero.
23961
23962 &*Warning 1*&: If either of the user or password strings starts with an octal
23963 digit, you must use three zeros instead of one after the leading backslash. If
23964 you do not, the octal digit that starts your string will be incorrectly
23965 interpreted as part of the code for the first character.
23966
23967 &*Warning 2*&: If there are characters in the strings that Perl interprets
23968 specially, you must use a Perl escape to prevent them being misinterpreted. For
23969 example, a command such as
23970 .code
23971 encode '\0user@domain.com\0pas$$word'
23972 .endd
23973 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23974
23975 If you have the &%mimencode%& command installed, another way to do produce
23976 base64-encoded strings is to run the command
23977 .code
23978 echo -e -n `\0user\0password' | mimencode
23979 .endd
23980 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23981 in the argument, and the &%-n%& option specifies no newline at the end of its
23982 output. However, not all versions of &%echo%& recognize these options, so you
23983 should check your version before relying on this suggestion.
23984
23985
23986
23987 .section "Authentication by an Exim client" "SECID170"
23988 .cindex "authentication" "on an Exim client"
23989 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23990 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23991 announces support for authentication, and the host matches an entry in either
23992 of these options, Exim (as a client) tries to authenticate as follows:
23993
23994 .ilist
23995 For each authenticator that is configured as a client, in the order in which
23996 they are defined in the configuration, it searches the authentication
23997 mechanisms announced by the server for one whose name matches the public name
23998 of the authenticator.
23999 .next
24000 .vindex "&$host$&"
24001 .vindex "&$host_address$&"
24002 When it finds one that matches, it runs the authenticator's client code. The
24003 variables &$host$& and &$host_address$& are available for any string expansions
24004 that the client might do. They are set to the server's name and IP address. If
24005 any expansion is forced to fail, the authentication attempt is abandoned, and
24006 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24007 delivery to be deferred.
24008 .next
24009 If the result of the authentication attempt is a temporary error or a timeout,
24010 Exim abandons trying to send the message to the host for the moment. It will
24011 try again later. If there are any backup hosts available, they are tried in the
24012 usual way.
24013 .next
24014 If the response to authentication is a permanent error (5&'xx'& code), Exim
24015 carries on searching the list of authenticators and tries another one if
24016 possible. If all authentication attempts give permanent errors, or if there are
24017 no attempts because no mechanisms match (or option expansions force failure),
24018 what happens depends on whether the host matches &%hosts_require_auth%& or
24019 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24020 delivery is deferred. The error can be detected in the retry rules, and thereby
24021 turned into a permanent error if you wish. In the second case, Exim tries to
24022 deliver the message unauthenticated.
24023 .endlist
24024
24025 .cindex "AUTH" "on MAIL command"
24026 When Exim has authenticated itself to a remote server, it adds the AUTH
24027 parameter to the MAIL commands it sends, if it has an authenticated sender for
24028 the message. If the message came from a remote host, the authenticated sender
24029 is the one that was receiving on an incoming MAIL command, provided that the
24030 incoming connection was authenticated and the &%server_mail_auth%& condition
24031 allowed the authenticated sender to be retained. If a local process calls Exim
24032 to send a message, the sender address that is built from the login name and
24033 &%qualify_domain%& is treated as authenticated. However, if the
24034 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24035 the authenticated sender that was received with the message.
24036 .ecindex IIDauthconf1
24037 .ecindex IIDauthconf2
24038
24039
24040
24041
24042
24043
24044 . ////////////////////////////////////////////////////////////////////////////
24045 . ////////////////////////////////////////////////////////////////////////////
24046
24047 .chapter "The plaintext authenticator" "CHAPplaintext"
24048 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24049 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24050 The &(plaintext)& authenticator can be configured to support the PLAIN and
24051 LOGIN authentication mechanisms, both of which transfer authentication data as
24052 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24053 security risk; you are strongly advised to insist on the use of SMTP encryption
24054 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24055 use unencrypted plain text, you should not use the same passwords for SMTP
24056 connections as you do for login accounts.
24057
24058 .section "Plaintext options" "SECID171"
24059 .cindex "options" "&(plaintext)& authenticator (server)"
24060 When configured as a server, &(plaintext)& uses the following options:
24061
24062 .option server_condition authenticators string&!! unset
24063 This is actually a global authentication option, but it must be set in order to
24064 configure the &(plaintext)& driver as a server. Its use is described below.
24065
24066 .option server_prompts plaintext string&!! unset
24067 The contents of this option, after expansion, must be a colon-separated list of
24068 prompt strings. If expansion fails, a temporary authentication rejection is
24069 given.
24070
24071 .section "Using plaintext in a server" "SECTplainserver"
24072 .cindex "AUTH" "in &(plaintext)& authenticator"
24073 .cindex "binary zero" "in &(plaintext)& authenticator"
24074 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24075         "in &(plaintext)& authenticator"
24076 .vindex "&$auth1$&, &$auth2$&, etc"
24077 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24078
24079 When running as a server, &(plaintext)& performs the authentication test by
24080 expanding a string. The data sent by the client with the AUTH command, or in
24081 response to subsequent prompts, is base64 encoded, and so may contain any byte
24082 values when decoded. If any data is supplied with the command, it is treated as
24083 a list of strings, separated by NULs (binary zeros), the first three of which
24084 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24085 (neither LOGIN nor PLAIN uses more than three strings).
24086
24087 For compatibility with previous releases of Exim, the values are also placed in
24088 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24089 variables for this purpose is now deprecated, as it can lead to confusion in
24090 string expansions that also use them for other things.
24091
24092 If there are more strings in &%server_prompts%& than the number of strings
24093 supplied with the AUTH command, the remaining prompts are used to obtain more
24094 data. Each response from the client may be a list of NUL-separated strings.
24095
24096 .vindex "&$authenticated_id$&"
24097 Once a sufficient number of data strings have been received,
24098 &%server_condition%& is expanded. If the expansion is forced to fail,
24099 authentication fails. Any other expansion failure causes a temporary error code
24100 to be returned. If the result of a successful expansion is an empty string,
24101 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24102 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24103 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24104 For any other result, a temporary error code is returned, with the expanded
24105 string as the error text.
24106
24107 &*Warning*&: If you use a lookup in the expansion to find the user's
24108 password, be sure to make the authentication fail if the user is unknown.
24109 There are good and bad examples at the end of the next section.
24110
24111
24112
24113 .section "The PLAIN authentication mechanism" "SECID172"
24114 .cindex "PLAIN authentication mechanism"
24115 .cindex "authentication" "PLAIN mechanism"
24116 .cindex "binary zero" "in &(plaintext)& authenticator"
24117 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24118 sent as one item of data (that is, one combined string containing two NUL
24119 separators). The data is sent either as part of the AUTH command, or
24120 subsequently in response to an empty prompt from the server.
24121
24122 The second and third strings are a user name and a corresponding password.
24123 Using a single fixed user name and password as an example, this could be
24124 configured as follows:
24125 .code
24126 fixed_plain:
24127   driver = plaintext
24128   public_name = PLAIN
24129   server_prompts = :
24130   server_condition = \
24131     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24132   server_set_id = $auth2
24133 .endd
24134 Note that the default result strings from &%if%& (&"true"& or an empty string)
24135 are exactly what we want here, so they need not be specified. Obviously, if the
24136 password contains expansion-significant characters such as dollar, backslash,
24137 or closing brace, they have to be escaped.
24138
24139 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24140 the end of a string list are ignored). If all the data comes as part of the
24141 AUTH command, as is commonly the case, the prompt is not used. This
24142 authenticator is advertised in the response to EHLO as
24143 .code
24144 250-AUTH PLAIN
24145 .endd
24146 and a client host can authenticate itself by sending the command
24147 .code
24148 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24149 .endd
24150 As this contains three strings (more than the number of prompts), no further
24151 data is required from the client. Alternatively, the client may just send
24152 .code
24153 AUTH PLAIN
24154 .endd
24155 to initiate authentication, in which case the server replies with an empty
24156 prompt. The client must respond with the combined data string.
24157
24158 The data string is base64 encoded, as required by the RFC. This example,
24159 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24160 represents a zero byte. This is split up into three strings, the first of which
24161 is empty. The &%server_condition%& option in the authenticator checks that the
24162 second two are &`username`& and &`mysecret`& respectively.
24163
24164 Having just one fixed user name and password, as in this example, is not very
24165 realistic, though for a small organization with only a handful of
24166 authenticating clients it could make sense.
24167
24168 A more sophisticated instance of this authenticator could use the user name in
24169 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24170 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24171 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24172 This is an incorrect example:
24173 .code
24174 server_condition = \
24175   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24176 .endd
24177 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24178 which it then compares to the supplied password (&$auth3$&). Why is this example
24179 incorrect? It works fine for existing users, but consider what happens if a
24180 non-existent user name is given. The lookup fails, but as no success/failure
24181 strings are given for the lookup, it yields an empty string. Thus, to defeat
24182 the authentication, all a client has to do is to supply a non-existent user
24183 name and an empty password. The correct way of writing this test is:
24184 .code
24185 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24186   {${if eq{$value}{$auth3}}} {false}}
24187 .endd
24188 In this case, if the lookup succeeds, the result is checked; if the lookup
24189 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24190 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24191 always fails if its second argument is empty. However, the second way of
24192 writing the test makes the logic clearer.
24193
24194
24195 .section "The LOGIN authentication mechanism" "SECID173"
24196 .cindex "LOGIN authentication mechanism"
24197 .cindex "authentication" "LOGIN mechanism"
24198 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24199 in a number of programs. No data is sent with the AUTH command. Instead, a
24200 user name and password are supplied separately, in response to prompts. The
24201 plaintext authenticator can be configured to support this as in this example:
24202 .code
24203 fixed_login:
24204   driver = plaintext
24205   public_name = LOGIN
24206   server_prompts = User Name : Password
24207   server_condition = \
24208     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24209   server_set_id = $auth1
24210 .endd
24211 Because of the way plaintext operates, this authenticator accepts data supplied
24212 with the AUTH command (in contravention of the specification of LOGIN), but
24213 if the client does not supply it (as is the case for LOGIN clients), the prompt
24214 strings are used to obtain two data items.
24215
24216 Some clients are very particular about the precise text of the prompts. For
24217 example, Outlook Express is reported to recognize only &"Username:"& and
24218 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24219 strings. It uses the &%ldapauth%& expansion condition to check the user
24220 name and password by binding to an LDAP server:
24221 .code
24222 login:
24223   driver = plaintext
24224   public_name = LOGIN
24225   server_prompts = Username:: : Password::
24226   server_condition = ${if and{{ \
24227     !eq{}{$auth1} }{ \
24228     ldapauth{\
24229       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24230       pass=${quote:$auth2} \
24231       ldap://ldap.example.org/} }} }
24232   server_set_id = uid=$auth1,ou=people,o=example.org
24233 .endd
24234 We have to check that the username is not empty before using it, because LDAP
24235 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24236 operator to correctly quote the DN for authentication. However, the basic
24237 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24238 correct one to use for the password, because quoting is needed only to make
24239 the password conform to the Exim syntax. At the LDAP level, the password is an
24240 uninterpreted string.
24241
24242
24243 .section "Support for different kinds of authentication" "SECID174"
24244 A number of string expansion features are provided for the purpose of
24245 interfacing to different ways of user authentication. These include checking
24246 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24247 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24248 &<<SECTexpcond>>&.
24249
24250
24251
24252
24253 .section "Using plaintext in a client" "SECID175"
24254 .cindex "options" "&(plaintext)& authenticator (client)"
24255 The &(plaintext)& authenticator has two client options:
24256
24257 .option client_ignore_invalid_base64 plaintext boolean false
24258 If the client receives a server prompt that is not a valid base64 string,
24259 authentication is abandoned by default. However, if this option is set true,
24260 the error in the challenge is ignored and the client sends the response as
24261 usual.
24262
24263 .option client_send plaintext string&!! unset
24264 The string is a colon-separated list of authentication data strings. Each
24265 string is independently expanded before being sent to the server. The first
24266 string is sent with the AUTH command; any more strings are sent in response
24267 to prompts from the server. Before each string is expanded, the value of the
24268 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24269 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24270 way. Thus, the prompt that is received in response to sending the first string
24271 (with the AUTH command) can be used in the expansion of the second string, and
24272 so on. If an invalid base64 string is received when
24273 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24274 &$auth$&<&'n'&> variable.
24275
24276 &*Note*&: You cannot use expansion to create multiple strings, because
24277 splitting takes priority and happens first.
24278
24279 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24280 the data, further processing is applied to each string before it is sent. If
24281 there are any single circumflex characters in the string, they are converted to
24282 NULs. Should an actual circumflex be required as data, it must be doubled in
24283 the string.
24284
24285 This is an example of a client configuration that implements the PLAIN
24286 authentication mechanism with a fixed user name and password:
24287 .code
24288 fixed_plain:
24289   driver = plaintext
24290   public_name = PLAIN
24291   client_send = ^username^mysecret
24292 .endd
24293 The lack of colons means that the entire text is sent with the AUTH
24294 command, with the circumflex characters converted to NULs. A similar example
24295 that uses the LOGIN mechanism is:
24296 .code
24297 fixed_login:
24298   driver = plaintext
24299   public_name = LOGIN
24300   client_send = : username : mysecret
24301 .endd
24302 The initial colon means that the first string is empty, so no data is sent with
24303 the AUTH command itself. The remaining strings are sent in response to
24304 prompts.
24305 .ecindex IIDplaiauth1
24306 .ecindex IIDplaiauth2
24307
24308
24309
24310
24311 . ////////////////////////////////////////////////////////////////////////////
24312 . ////////////////////////////////////////////////////////////////////////////
24313
24314 .chapter "The cram_md5 authenticator" "CHID9"
24315 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24316 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24317 .cindex "CRAM-MD5 authentication mechanism"
24318 .cindex "authentication" "CRAM-MD5 mechanism"
24319 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24320 sends a challenge string to the client, and the response consists of a user
24321 name and the CRAM-MD5 digest of the challenge string combined with a secret
24322 string (password) which is known to both server and client. Thus, the secret
24323 is not sent over the network as plain text, which makes this authenticator more
24324 secure than &(plaintext)&. However, the downside is that the secret has to be
24325 available in plain text at either end.
24326
24327
24328 .section "Using cram_md5 as a server" "SECID176"
24329 .cindex "options" "&(cram_md5)& authenticator (server)"
24330 This authenticator has one server option, which must be set to configure the
24331 authenticator as a server:
24332
24333 .option server_secret cram_md5 string&!! unset
24334 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24335 When the server receives the client's response, the user name is placed in
24336 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24337 obtain the password for that user. The server then computes the CRAM-MD5 digest
24338 that the client should have sent, and checks that it received the correct
24339 string. If the expansion of &%server_secret%& is forced to fail, authentication
24340 fails. If the expansion fails for some other reason, a temporary error code is
24341 returned to the client.
24342
24343 For compatibility with previous releases of Exim, the user name is also placed
24344 in &$1$&. However, the use of this variables for this purpose is now
24345 deprecated, as it can lead to confusion in string expansions that also use
24346 numeric variables for other things.
24347
24348 For example, the following authenticator checks that the user name given by the
24349 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24350 user name, authentication fails.
24351 .code
24352 fixed_cram:
24353   driver = cram_md5
24354   public_name = CRAM-MD5
24355   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24356   server_set_id = $auth1
24357 .endd
24358 .vindex "&$authenticated_id$&"
24359 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24360 name in &$authenticated_id$&. A more typical configuration might look up the
24361 secret string in a file, using the user name as the key. For example:
24362 .code
24363 lookup_cram:
24364   driver = cram_md5
24365   public_name = CRAM-MD5
24366   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24367                   {$value}fail}
24368   server_set_id = $auth1
24369 .endd
24370 Note that this expansion explicitly forces failure if the lookup fails
24371 because &$auth1$& contains an unknown user name.
24372
24373 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24374 using the relevant libraries, you need to know the realm to specify in the
24375 lookup and then ask for the &"userPassword"& attribute for that user in that
24376 realm, with:
24377 .code
24378 cyrusless_crammd5:
24379   driver = cram_md5
24380   public_name = CRAM-MD5
24381   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24382                   dbmjz{/etc/sasldb2}}
24383   server_set_id = $auth1
24384 .endd
24385
24386 .section "Using cram_md5 as a client" "SECID177"
24387 .cindex "options" "&(cram_md5)& authenticator (client)"
24388 When used as a client, the &(cram_md5)& authenticator has two options:
24389
24390
24391
24392 .option client_name cram_md5 string&!! "the primary host name"
24393 This string is expanded, and the result used as the user name data when
24394 computing the response to the server's challenge.
24395
24396
24397 .option client_secret cram_md5 string&!! unset
24398 This option must be set for the authenticator to work as a client. Its value is
24399 expanded and the result used as the secret string when computing the response.
24400
24401
24402 .vindex "&$host$&"
24403 .vindex "&$host_address$&"
24404 Different user names and secrets can be used for different servers by referring
24405 to &$host$& or &$host_address$& in the options. Forced failure of either
24406 expansion string is treated as an indication that this authenticator is not
24407 prepared to handle this case. Exim moves on to the next configured client
24408 authenticator. Any other expansion failure causes Exim to give up trying to
24409 send the message to the current server.
24410
24411 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24412 strings, is:
24413 .code
24414 fixed_cram:
24415   driver = cram_md5
24416   public_name = CRAM-MD5
24417   client_name = ph10
24418   client_secret = secret
24419 .endd
24420 .ecindex IIDcramauth1
24421 .ecindex IIDcramauth2
24422
24423
24424
24425 . ////////////////////////////////////////////////////////////////////////////
24426 . ////////////////////////////////////////////////////////////////////////////
24427
24428 .chapter "The cyrus_sasl authenticator" "CHID10"
24429 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24430 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24431 .cindex "Cyrus" "SASL library"
24432 .cindex "Kerberos"
24433 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24434 Digital Ltd (&url(http://www.aldigital.co.uk)).
24435
24436 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24437 library implementation of the RFC 2222 (&"Simple Authentication and Security
24438 Layer"&). This library supports a number of authentication mechanisms,
24439 including PLAIN and LOGIN, but also several others that Exim does not support
24440 directly. In particular, there is support for Kerberos authentication.
24441
24442 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24443 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24444 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24445 name of the driver to determine which mechanism to support.
24446
24447 Where access to some kind of secret file is required, for example in GSSAPI
24448 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24449 user, and that the Cyrus SASL library has no way of escalating privileges
24450 by default. You may also find you need to set environment variables,
24451 depending on the driver you are using.
24452
24453 The application name provided by Exim is &"exim"&, so various SASL options may
24454 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24455 Kerberos, note that because of limitations in the GSSAPI interface,
24456 changing the server keytab might need to be communicated down to the Kerberos
24457 layer independently. The mechanism for doing so is dependent upon the Kerberos
24458 implementation.
24459
24460 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24461 may be set to point to an alternative keytab file. Exim will pass this
24462 variable through from its own inherited environment when started as root or the
24463 Exim user. The keytab file needs to be readable by the Exim user.
24464 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24465 environment variable.  In practice, for those releases, the Cyrus authenticator
24466 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24467 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24468
24469
24470 .section "Using cyrus_sasl as a server" "SECID178"
24471 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24472 (on a successful authentication) into &$auth1$&. For compatibility with
24473 previous releases of Exim, the username is also placed in &$1$&. However, the
24474 use of this variable for this purpose is now deprecated, as it can lead to
24475 confusion in string expansions that also use numeric variables for other
24476 things.
24477
24478
24479 .option server_hostname cyrus_sasl string&!! "see below"
24480 This option selects the hostname that is used when communicating with the
24481 library. The default value is &`$primary_hostname`&. It is up to the underlying
24482 SASL plug-in what it does with this data.
24483
24484
24485 .option server_mech cyrus_sasl string "see below"
24486 This option selects the authentication mechanism this driver should use. The
24487 default is the value of the generic &%public_name%& option. This option allows
24488 you to use a different underlying mechanism from the advertised name. For
24489 example:
24490 .code
24491 sasl:
24492   driver = cyrus_sasl
24493   public_name = X-ANYTHING
24494   server_mech = CRAM-MD5
24495   server_set_id = $auth1
24496 .endd
24497
24498 .option server_realm cyrus_sasl string&!! unset
24499 This specifies the SASL realm that the server claims to be in.
24500
24501
24502 .option server_service cyrus_sasl string &`smtp`&
24503 This is the SASL service that the server claims to implement.
24504
24505
24506 For straightforward cases, you do not need to set any of the authenticator's
24507 private options. All you need to do is to specify an appropriate mechanism as
24508 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24509 PLAIN, you could have two authenticators as follows:
24510 .code
24511 sasl_cram_md5:
24512   driver = cyrus_sasl
24513   public_name = CRAM-MD5
24514   server_set_id = $auth1
24515
24516 sasl_plain:
24517   driver = cyrus_sasl
24518   public_name = PLAIN
24519   server_set_id = $auth2
24520 .endd
24521 Cyrus SASL does implement the LOGIN authentication method, even though it is
24522 not a standard method. It is disabled by default in the source distribution,
24523 but it is present in many binary distributions.
24524 .ecindex IIDcyrauth1
24525 .ecindex IIDcyrauth2
24526
24527
24528
24529
24530 . ////////////////////////////////////////////////////////////////////////////
24531 . ////////////////////////////////////////////////////////////////////////////
24532 .chapter "The dovecot authenticator" "CHAPdovecot"
24533 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24534 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24535 This authenticator is an interface to the authentication facility of the
24536 Dovecot POP/IMAP server, which can support a number of authentication methods.
24537 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24538 to use the same mechanisms for SMTP authentication. This is a server
24539 authenticator only. There is only one option:
24540
24541 .option server_socket dovecot string unset
24542
24543 This option must specify the socket that is the interface to Dovecot
24544 authentication. The &%public_name%& option must specify an authentication
24545 mechanism that Dovecot is configured to support. You can have several
24546 authenticators for different mechanisms. For example:
24547 .code
24548 dovecot_plain:
24549   driver = dovecot
24550   public_name = PLAIN
24551   server_socket = /var/run/dovecot/auth-client
24552   server_set_id = $auth2
24553
24554 dovecot_ntlm:
24555   driver = dovecot
24556   public_name = NTLM
24557   server_socket = /var/run/dovecot/auth-client
24558   server_set_id = $auth1
24559 .endd
24560 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24561 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24562 option is passed in the Dovecot authentication command. If, for a TLS
24563 connection, a client certificate has been verified, the &"valid-client-cert"&
24564 option is passed. When authentication succeeds, the identity of the user
24565 who authenticated is placed in &$auth1$&.
24566 .ecindex IIDdcotauth1
24567 .ecindex IIDdcotauth2
24568
24569
24570 . ////////////////////////////////////////////////////////////////////////////
24571 . ////////////////////////////////////////////////////////////////////////////
24572 .chapter "The gsasl authenticator" "CHAPgsasl"
24573 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
24574 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
24575 .cindex "authentication" "GNU SASL"
24576 .cindex "authentication" "SASL"
24577 .cindex "authentication" "EXTERNAL"
24578 .cindex "authentication" "ANONYMOUS"
24579 .cindex "authentication" "PLAIN"
24580 .cindex "authentication" "LOGIN"
24581 .cindex "authentication" "DIGEST-MD5"
24582 .cindex "authentication" "CRAM-MD5"
24583 .cindex "authentication" "SCRAM-SHA-1"
24584 The &(gsasl)& authenticator provides server integration for the GNU SASL
24585 library and the mechanisms it provides.  This is new as of the 4.80 release
24586 and there are a few areas where the library does not let Exim smoothly
24587 scale to handle future authentication mechanisms, so no guarantee can be
24588 made that any particular new authentication mechanism will be supported
24589 without code changes in Exim.
24590
24591
24592 .option server_channelbinding gsasl boolean false
24593 Some authentication mechanisms are able to use external context at both ends
24594 of the session to bind the authentication to that context, and fail the
24595 authentication process if that context differs.  Specifically, some TLS
24596 ciphersuites can provide identifying information about the cryptographic
24597 context.
24598
24599 This means that certificate identity and verification becomes a non-issue,
24600 as a man-in-the-middle attack will cause the correct client and server to
24601 see different identifiers and authentication will fail.
24602
24603 This is currently only supported when using the GnuTLS library.  This is
24604 only usable by mechanisms which support "channel binding"; at time of
24605 writing, that's the SCRAM family.
24606
24607 This defaults off to ensure smooth upgrade across Exim releases, in case
24608 this option causes some clients to start failing.  Some future release
24609 of Exim may switch the default to be true.
24610
24611
24612 .option server_hostname gsasl string&!! "see below"
24613 This option selects the hostname that is used when communicating with the
24614 library. The default value is &`$primary_hostname`&.
24615 Some mechanisms will use this data.
24616
24617
24618 .option server_mech gsasl string "see below"
24619 This option selects the authentication mechanism this driver should use. The
24620 default is the value of the generic &%public_name%& option. This option allows
24621 you to use a different underlying mechanism from the advertised name. For
24622 example:
24623 .code
24624 sasl:
24625   driver = gsasl
24626   public_name = X-ANYTHING
24627   server_mech = CRAM-MD5
24628   server_set_id = $auth1
24629 .endd
24630
24631
24632 .option server_password gsasl string&!! unset
24633 Various mechanisms need access to the cleartext password on the server, so
24634 that proof-of-possession can be demonstrated on the wire, without sending
24635 the password itself.
24636
24637 The data available for lookup varies per mechanism.
24638 In all cases, &$auth1$& is set to the &'authentication id'&.
24639 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
24640 if available, else the empty string.
24641 The &$auth3$& variable will always be the &'realm'& if available,
24642 else the empty string.
24643
24644 A forced failure will cause authentication to defer.
24645
24646 If using this option, it may make sense to set the &%server_condition%&
24647 option to be simply "true".
24648
24649
24650 .option server_realm gsasl string&!! unset
24651 This specifies the SASL realm that the server claims to be in.
24652 Some mechanisms will use this data.
24653
24654
24655 .option server_scram_iter gsasl string&!! unset
24656 This option provides data for the SCRAM family of mechanisms.
24657 &$auth1$& is not available at evaluation time.
24658 (This may change, as we receive feedback on use)
24659
24660
24661 .option server_scram_salt gsasl string&!! unset
24662 This option provides data for the SCRAM family of mechanisms.
24663 &$auth1$& is not available at evaluation time.
24664 (This may change, as we receive feedback on use)
24665
24666
24667 .option server_service gsasl string &`smtp`&
24668 This is the SASL service that the server claims to implement.
24669 Some mechanisms will use this data.
24670
24671
24672 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
24673 .vindex "&$auth1$&, &$auth2$&, etc"
24674 These may be set when evaluating specific options, as detailed above.
24675 They will also be set when evaluating &%server_condition%&.
24676
24677 Unless otherwise stated below, the &(gsasl)& integration will use the following
24678 meanings for these variables:
24679
24680 .ilist
24681 .vindex "&$auth1$&"
24682 &$auth1$&: the &'authentication id'&
24683 .next
24684 .vindex "&$auth2$&"
24685 &$auth2$&: the &'authorization id'&
24686 .next
24687 .vindex "&$auth3$&"
24688 &$auth3$&: the &'realm'&
24689 .endlist
24690
24691 On a per-mechanism basis:
24692
24693 .ilist
24694 .cindex "authentication" "EXTERNAL"
24695 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
24696 the &%server_condition%& option must be present.
24697 .next
24698 .cindex "authentication" "ANONYMOUS"
24699 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
24700 the &%server_condition%& option must be present.
24701 .next
24702 .cindex "authentication" "GSSAPI"
24703 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
24704 &$auth2$& will be set to the &'authorization id'&,
24705 the &%server_condition%& option must be present.
24706 .endlist
24707
24708 An &'anonymous token'& is something passed along as an unauthenticated
24709 identifier; this is analogous to FTP anonymous authentication passing an
24710 email address, or software-identifier@, as the "password".
24711
24712
24713 An example showing the password having the realm specified in the callback
24714 and demonstrating a Cyrus SASL to GSASL migration approach is:
24715 .code
24716 gsasl_cyrusless_crammd5:
24717   driver = gsasl
24718   public_name = CRAM-MD5
24719   server_realm = imap.example.org
24720   server_password = ${lookup{$auth1:$auth3:userPassword}\
24721                     dbmjz{/etc/sasldb2}{$value}fail}
24722   server_set_id = ${quote:$auth1}
24723   server_condition = yes
24724 .endd
24725
24726
24727 . ////////////////////////////////////////////////////////////////////////////
24728 . ////////////////////////////////////////////////////////////////////////////
24729
24730 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
24731 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
24732 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
24733 .cindex "authentication" "GSSAPI"
24734 .cindex "authentication" "Kerberos"
24735 The &(heimdal_gssapi)& authenticator provides server integration for the
24736 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
24737 reliably.
24738
24739 .option server_hostname heimdal_gssapi string&!! "see below"
24740 This option selects the hostname that is used, with &%server_service%&,
24741 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
24742 identifier.  The default value is &`$primary_hostname`&.
24743
24744 .option server_keytab heimdal_gssapi string&!! unset
24745 If set, then Heimdal will not use the system default keytab (typically
24746 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
24747 The value should be a pathname, with no &"file:"& prefix.
24748
24749 .option server_service heimdal_gssapi string&!! "smtp"
24750 This option specifies the service identifier used, in conjunction with
24751 &%server_hostname%&, for building the identifer for finding credentials
24752 from the keytab.
24753
24754
24755 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
24756 Beware that these variables will typically include a realm, thus will appear
24757 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
24758 not verified, so a malicious client can set it to anything.
24759
24760 The &$auth1$& field should be safely trustable as a value from the Key
24761 Distribution Center.  Note that these are not quite email addresses.
24762 Each identifier is for a role, and so the left-hand-side may include a
24763 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
24764
24765 .vindex "&$auth1$&, &$auth2$&, etc"
24766 .ilist
24767 .vindex "&$auth1$&"
24768 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
24769 .next
24770 .vindex "&$auth2$&"
24771 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
24772 authentication.  If that was empty, this will also be set to the
24773 GSS Display Name.
24774 .endlist
24775
24776
24777 . ////////////////////////////////////////////////////////////////////////////
24778 . ////////////////////////////////////////////////////////////////////////////
24779
24780 .chapter "The spa authenticator" "CHAPspa"
24781 .scindex IIDspaauth1 "&(spa)& authenticator"
24782 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24783 .cindex "authentication" "Microsoft Secure Password"
24784 .cindex "authentication" "NTLM"
24785 .cindex "Microsoft Secure Password Authentication"
24786 .cindex "NTLM authentication"
24787 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24788 Password Authentication'& mechanism,
24789 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24790 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24791 taken from the Samba project (&url(http://www.samba.org)). The code for the
24792 server side was subsequently contributed by Tom Kistner. The mechanism works as
24793 follows:
24794
24795 .ilist
24796 After the AUTH command has been accepted, the client sends an SPA
24797 authentication request based on the user name and optional domain.
24798 .next
24799 The server sends back a challenge.
24800 .next
24801 The client builds a challenge response which makes use of the user's password
24802 and sends it to the server, which then accepts or rejects it.
24803 .endlist
24804
24805 Encryption is used to protect the password in transit.
24806
24807
24808
24809 .section "Using spa as a server" "SECID179"
24810 .cindex "options" "&(spa)& authenticator (server)"
24811 The &(spa)& authenticator has just one server option:
24812
24813 .option server_password spa string&!! unset
24814 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24815 This option is expanded, and the result must be the cleartext password for the
24816 authenticating user, whose name is at this point in &$auth1$&. For
24817 compatibility with previous releases of Exim, the user name is also placed in
24818 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24819 it can lead to confusion in string expansions that also use numeric variables
24820 for other things. For example:
24821 .code
24822 spa:
24823   driver = spa
24824   public_name = NTLM
24825   server_password = \
24826     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24827 .endd
24828 If the expansion is forced to fail, authentication fails. Any other expansion
24829 failure causes a temporary error code to be returned.
24830
24831
24832
24833
24834
24835 .section "Using spa as a client" "SECID180"
24836 .cindex "options" "&(spa)& authenticator (client)"
24837 The &(spa)& authenticator has the following client options:
24838
24839
24840
24841 .option client_domain spa string&!! unset
24842 This option specifies an optional domain for the authentication.
24843
24844
24845 .option client_password spa string&!! unset
24846 This option specifies the user's password, and must be set.
24847
24848
24849 .option client_username spa string&!! unset
24850 This option specifies the user name, and must be set. Here is an example of a
24851 configuration of this authenticator for use with the mail servers at
24852 &'msn.com'&:
24853 .code
24854 msn:
24855   driver = spa
24856   public_name = MSN
24857   client_username = msn/msn_username
24858   client_password = msn_plaintext_password
24859   client_domain = DOMAIN_OR_UNSET
24860 .endd
24861 .ecindex IIDspaauth1
24862 .ecindex IIDspaauth2
24863
24864
24865
24866
24867
24868 . ////////////////////////////////////////////////////////////////////////////
24869 . ////////////////////////////////////////////////////////////////////////////
24870
24871 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24872          "Encrypted SMTP connections"
24873 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24874 .scindex IIDencsmtp2 "SMTP" "encryption"
24875 .cindex "TLS" "on SMTP connection"
24876 .cindex "OpenSSL"
24877 .cindex "GnuTLS"
24878 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24879 Sockets Layer), is implemented by making use of the OpenSSL library or the
24880 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24881 cryptographic code in the Exim distribution itself for implementing TLS. In
24882 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24883 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24884 You also need to understand the basic concepts of encryption at a managerial
24885 level, and in particular, the way that public keys, private keys, and
24886 certificates are used.
24887
24888 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24889 connection is established, the client issues a STARTTLS command. If the
24890 server accepts this, the client and the server negotiate an encryption
24891 mechanism. If the negotiation succeeds, the data that subsequently passes
24892 between them is encrypted.
24893
24894 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24895 and if so, what cipher suite is in use, whether the client supplied a
24896 certificate, and whether or not that certificate was verified. This makes it
24897 possible for an Exim server to deny or accept certain commands based on the
24898 encryption state.
24899
24900 &*Warning*&: Certain types of firewall and certain anti-virus products can
24901 disrupt TLS connections. You need to turn off SMTP scanning for these products
24902 in order to get TLS to work.
24903
24904
24905
24906 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24907          "SECID284"
24908 .cindex "ssmtp protocol"
24909 .cindex "smtps protocol"
24910 .cindex "SMTP" "ssmtp protocol"
24911 .cindex "SMTP" "smtps protocol"
24912 Early implementations of encrypted SMTP used a different TCP port from normal
24913 SMTP, and expected an encryption negotiation to start immediately, instead of
24914 waiting for a STARTTLS command from the client using the standard SMTP
24915 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24916 allocated for this purpose.
24917
24918 This approach was abandoned when encrypted SMTP was standardized, but there are
24919 still some legacy clients that use it. Exim supports these clients by means of
24920 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24921 numbers; the most common use is expected to be:
24922 .code
24923 tls_on_connect_ports = 465
24924 .endd
24925 The port numbers specified by this option apply to all SMTP connections, both
24926 via the daemon and via &'inetd'&. You still need to specify all the ports that
24927 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24928 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24929 an extra port &-- rather, it specifies different behaviour on a port that is
24930 defined elsewhere.
24931
24932 There is also a &%-tls-on-connect%& command line option. This overrides
24933 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24934
24935
24936
24937
24938
24939
24940 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24941 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24942 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24943 followed later, when the first versions of GnuTLS were released. To build Exim
24944 to use GnuTLS, you need to set
24945 .code
24946 USE_GNUTLS=yes
24947 .endd
24948 in Local/Makefile, in addition to
24949 .code
24950 SUPPORT_TLS=yes
24951 .endd
24952 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24953 include files and libraries for GnuTLS can be found.
24954
24955 There are some differences in usage when using GnuTLS instead of OpenSSL:
24956
24957 .ilist
24958 The &%tls_verify_certificates%& option must contain the name of a file, not the
24959 name of a directory (for OpenSSL it can be either).
24960 .next
24961 The default value for &%tls_dhparam%& differs for historical reasons.
24962 .next
24963 .vindex "&$tls_peerdn$&"
24964 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24965 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24966 affects the value of the &$tls_peerdn$& variable.
24967 .next
24968 OpenSSL identifies cipher suites using hyphens as separators, for example:
24969 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
24970 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
24971 in a cipher list. To make life simpler, Exim changes underscores to hyphens
24972 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
24973 to handle its own older variants) when processing lists of cipher suites in the
24974 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24975 option).
24976 .next
24977 The &%tls_require_ciphers%& options operate differently, as described in the
24978 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24979 .next
24980 Some other recently added features may only be available in one or the other.
24981 This should be documented with the feature.  If the documentation does not
24982 explicitly state that the feature is infeasible in the other TLS
24983 implementation, then patches are welcome.
24984 .endlist
24985
24986
24987 .section "GnuTLS parameter computation" "SECTgnutlsparam"
24988 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
24989 an explicit path; if the latter, then the text about generation still applies,
24990 but not the chosen filename.
24991 By default, as of Exim 4.80 a hard-coded D-H prime is used.
24992 See the documentation of &%tls_dhparam%& for more information.
24993
24994 GnuTLS uses D-H parameters that may take a substantial amount of time
24995 to compute. It is unreasonable to re-compute them for every TLS session.
24996 Therefore, Exim keeps this data in a file in its spool directory, called
24997 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
24998 of bits requested.
24999 The file is owned by the Exim user and is readable only by
25000 its owner. Every Exim process that start up GnuTLS reads the D-H
25001 parameters from this file. If the file does not exist, the first Exim process
25002 that needs it computes the data and writes it to a temporary file which is
25003 renamed once it is complete. It does not matter if several Exim processes do
25004 this simultaneously (apart from wasting a few resources). Once a file is in
25005 place, new Exim processes immediately start using it.
25006
25007 For maximum security, the parameters that are stored in this file should be
25008 recalculated periodically, the frequency depending on your paranoia level.
25009 If you are avoiding using the fixed D-H primes published in RFCs, then you
25010 are concerned about some advanced attacks and will wish to do this; if you do
25011 not regenerate then you might as well stick to the standard primes.
25012
25013 Arranging this is easy in principle; just delete the file when you want new
25014 values to be computed. However, there may be a problem. The calculation of new
25015 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25016 If the system is not very active, &_/dev/random_& may delay returning data
25017 until enough randomness (entropy) is available. This may cause Exim to hang for
25018 a substantial amount of time, causing timeouts on incoming connections.
25019
25020 The solution is to generate the parameters externally to Exim. They are stored
25021 in &_gnutls-params-N_& in PEM format, which means that they can be
25022 generated externally using the &(certtool)& command that is part of GnuTLS.
25023
25024 To replace the parameters with new ones, instead of deleting the file
25025 and letting Exim re-create it, you can generate new parameters using
25026 &(certtool)& and, when this has been done, replace Exim's cache file by
25027 renaming. The relevant commands are something like this:
25028 .code
25029 # ls
25030 [ look for file; assume gnutls-params-2236 is the most recent ]
25031 # rm -f new-params
25032 # touch new-params
25033 # chown exim:exim new-params
25034 # chmod 0600 new-params
25035 # certtool --generate-dh-params --bits 2236 >>new-params
25036 # openssl dhparam -noout -text -in new-params | head
25037 [ check the first line, make sure it's not more than 2236;
25038   if it is, then go back to the start ("rm") and repeat
25039   until the size generated is at most the size requested ]
25040 # chmod 0400 new-params
25041 # mv new-params gnutls-params-2236
25042 .endd
25043 If Exim never has to generate the parameters itself, the possibility of
25044 stalling is removed.
25045
25046 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25047 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25048 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25049 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25050 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25051 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25052 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25053 which applies to all D-H usage, client or server.  If the value returned by
25054 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25055 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25056 limit, which is still much higher than Exim historically used.
25057
25058 The filename and bits used will change as the GnuTLS maintainers change the
25059 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25060 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25061 2432 bits, while NSS is limited to 2236 bits.
25062
25063 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25064 increase the chance of the generated prime actually being within acceptable
25065 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25066 procedure above.  There is no sane procedure available to Exim to double-check
25067 the size of the generated prime, so it might still be too large.
25068
25069
25070 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25071 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25072 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25073 There is a function in the OpenSSL library that can be passed a list of cipher
25074 suites before the cipher negotiation takes place. This specifies which ciphers
25075 are acceptable. The list is colon separated and may contain names like
25076 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25077 directly to this function call.
25078 Many systems will install the OpenSSL manual-pages, so you may have
25079 &'ciphers(1)'& available to you.
25080 The following quotation from the OpenSSL
25081 documentation specifies what forms of item are allowed in the cipher string:
25082
25083 .ilist
25084 It can consist of a single cipher suite such as RC4-SHA.
25085 .next
25086 It can represent a list of cipher suites containing a certain algorithm,
25087 or cipher suites of a certain type. For example SHA1 represents all
25088 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25089 SSL v3 algorithms.
25090 .next
25091 Lists of cipher suites can be combined in a single cipher string using
25092 the + character. This is used as a logical and operation. For example
25093 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25094 algorithms.
25095 .endlist
25096
25097 Each cipher string can be optionally preceded by one of the characters &`!`&,
25098 &`-`& or &`+`&.
25099 .ilist
25100 If &`!`& is used, the ciphers are permanently deleted from the list. The
25101 ciphers deleted can never reappear in the list even if they are explicitly
25102 stated.
25103 .next
25104 If &`-`& is used, the ciphers are deleted from the list, but some or all
25105 of the ciphers can be added again by later options.
25106 .next
25107 If &`+`& is used, the ciphers are moved to the end of the list. This
25108 option does not add any new ciphers; it just moves matching existing ones.
25109 .endlist
25110
25111 If none of these characters is present, the string is interpreted as
25112 a list of ciphers to be appended to the current preference list. If the list
25113 includes any ciphers already present they will be ignored: that is, they will
25114 not be moved to the end of the list.
25115 .endlist
25116
25117 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25118 string:
25119 .code
25120 # note single-quotes to get ! past any shell history expansion
25121 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25122 .endd
25123
25124 This example will let the library defaults be permitted on the MX port, where
25125 there's probably no identity verification anyway, but ups the ante on the
25126 submission ports where the administrator might have some influence on the
25127 choice of clients used:
25128 .code
25129 # OpenSSL variant; see man ciphers(1)
25130 tls_require_ciphers = ${if =={$received_port}{25}\
25131                            {DEFAULT}\
25132                            {HIGH:!MD5:!SHA1}}
25133 .endd
25134
25135
25136
25137 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25138          "SECTreqciphgnu"
25139 .cindex "GnuTLS" "specifying parameters for"
25140 .cindex "TLS" "specifying ciphers (GnuTLS)"
25141 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25142 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25143 .cindex "TLS" "specifying protocols (GnuTLS)"
25144 .cindex "TLS" "specifying priority string (GnuTLS)"
25145 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25146 The GnuTLS library allows the caller to provide a "priority string", documented
25147 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25148 ciphersuite specification in OpenSSL.
25149
25150 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25151
25152 The &%tls_require_ciphers%& option is available both as an global option,
25153 controlling how Exim behaves as a server, and also as an option of the
25154 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25155 the value is string expanded.  The resulting string is not an Exim list and
25156 the string is given to the GnuTLS library, so that Exim does not need to be
25157 aware of future feature enhancements of GnuTLS.
25158
25159 Documentation of the strings accepted may be found in the GnuTLS manual, under
25160 "Priority strings".  This is online as
25161 &url(http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html),
25162 but beware that this relates to GnuTLS 3, which may be newer than the version
25163 installed on your system.  If you are using GnuTLS 3,
25164 &url(http://www.gnu.org/software/gnutls/manual/html_node/Listing-the-ciphersuites-in-a-priority-string.html, then the example code)
25165 on that site can be used to test a given string.
25166
25167 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25168 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25169 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25170
25171 This example will let the library defaults be permitted on the MX port, where
25172 there's probably no identity verification anyway, and lowers security further
25173 by increasing compatibility; but this ups the ante on the submission ports
25174 where the administrator might have some influence on the choice of clients
25175 used:
25176 .code
25177 # GnuTLS variant
25178 tls_require_ciphers = ${if =={$received_port}{25}\
25179                            {NORMAL:%COMPAT}\
25180                            {SECURE128}}
25181 .endd
25182
25183
25184 .section "Configuring an Exim server to use TLS" "SECID182"
25185 .cindex "TLS" "configuring an Exim server"
25186 When Exim has been built with TLS support, it advertises the availability of
25187 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25188 but not to any others. The default value of this option is unset, which means
25189 that STARTTLS is not advertised at all. This default is chosen because you
25190 need to set some other options in order to make TLS available, and also it is
25191 sensible for systems that want to use TLS only as a client.
25192
25193 If a client issues a STARTTLS command and there is some configuration
25194 problem in the server, the command is rejected with a 454 error. If the client
25195 persists in trying to issue SMTP commands, all except QUIT are rejected
25196 with the error
25197 .code
25198 554 Security failure
25199 .endd
25200 If a STARTTLS command is issued within an existing TLS session, it is
25201 rejected with a 554 error code.
25202
25203 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25204 match some hosts. You can, of course, set it to * to match all hosts.
25205 However, this is not all you need to do. TLS sessions to a server won't work
25206 without some further configuration at the server end.
25207
25208 It is rumoured that all existing clients that support TLS/SSL use RSA
25209 encryption. To make this work you need to set, in the server,
25210 .code
25211 tls_certificate = /some/file/name
25212 tls_privatekey = /some/file/name
25213 .endd
25214 These options are, in fact, expanded strings, so you can make them depend on
25215 the identity of the client that is connected if you wish. The first file
25216 contains the server's X509 certificate, and the second contains the private key
25217 that goes with it. These files need to be readable by the Exim user, and must
25218 always be given as full path names. They can be the same file if both the
25219 certificate and the key are contained within it. If &%tls_privatekey%& is not
25220 set, or if its expansion is forced to fail or results in an empty string, this
25221 is assumed to be the case. The certificate file may also contain intermediate
25222 certificates that need to be sent to the client to enable it to authenticate
25223 the server's certificate.
25224
25225 If you do not understand about certificates and keys, please try to find a
25226 source of this background information, which is not Exim-specific. (There are a
25227 few comments below in section &<<SECTcerandall>>&.)
25228
25229 &*Note*&: These options do not apply when Exim is operating as a client &--
25230 they apply only in the case of a server. If you need to use a certificate in an
25231 Exim client, you must set the options of the same names in an &(smtp)&
25232 transport.
25233
25234 With just these options, an Exim server will be able to use TLS. It does not
25235 require the client to have a certificate (but see below for how to insist on
25236 this). There is one other option that may be needed in other situations. If
25237 .code
25238 tls_dhparam = /some/file/name
25239 .endd
25240 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25241 with the parameters contained in the file.
25242 Set this to &`none`& to disable use of DH entirely, by making no prime
25243 available:
25244 .code
25245 tls_dhparam = none
25246 .endd
25247 This may also be set to a string identifying a standard prime to be used for
25248 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25249 used is &`ike23`&.  There are a few standard primes available, see the
25250 documetnation for &%tls_dhparam%& for the complete list.
25251
25252 See the command
25253 .code
25254 openssl dhparam
25255 .endd
25256 for a way of generating file data.
25257
25258 The strings supplied for these three options are expanded every time a client
25259 host connects. It is therefore possible to use different certificates and keys
25260 for different hosts, if you so wish, by making use of the client's IP address
25261 in &$sender_host_address$& to control the expansion. If a string expansion is
25262 forced to fail, Exim behaves as if the option is not set.
25263
25264 .cindex "cipher" "logging"
25265 .cindex "log" "TLS cipher"
25266 .vindex "&$tls_cipher$&"
25267 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
25268 an incoming TLS connection. It is included in the &'Received:'& header of an
25269 incoming message (by default &-- you can, of course, change this), and it is
25270 also included in the log line that records a message's arrival, keyed by
25271 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25272 condition can be used to test for specific cipher suites in ACLs.
25273 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
25274 &<<SECID185>>&.)
25275
25276 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25277 can check the name of the cipher suite and vary their actions accordingly. The
25278 cipher suite names vary, depending on which TLS library is being used. For
25279 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25280 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25281 documentation for more details.
25282
25283
25284 .section "Requesting and verifying client certificates" "SECID183"
25285 .cindex "certificate" "verification of client"
25286 .cindex "TLS" "client certificate verification"
25287 If you want an Exim server to request a certificate when negotiating a TLS
25288 session with a client, you must set either &%tls_verify_hosts%& or
25289 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25290 apply to all TLS connections. For any host that matches one of these options,
25291 Exim requests a certificate as part of the setup of the TLS session. The
25292 contents of the certificate are verified by comparing it with a list of
25293 expected certificates. These must be available in a file or,
25294 for OpenSSL only (not GnuTLS), a directory, identified by
25295 &%tls_verify_certificates%&.
25296
25297 A file can contain multiple certificates, concatenated end to end. If a
25298 directory is used
25299 (OpenSSL only),
25300 each certificate must be in a separate file, with a name (or a symbolic link)
25301 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25302 certificate. You can compute the relevant hash by running the command
25303 .code
25304 openssl x509 -hash -noout -in /cert/file
25305 .endd
25306 where &_/cert/file_& contains a single certificate.
25307
25308 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25309 what happens if the client does not supply a certificate, or if the certificate
25310 does not match any of the certificates in the collection named by
25311 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25312 attempt to set up a TLS session is aborted, and the incoming connection is
25313 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25314 session continues. ACLs that run for subsequent SMTP commands can detect the
25315 fact that no certificate was verified, and vary their actions accordingly. For
25316 example, you can insist on a certificate before accepting a message for
25317 relaying, but not when the message is destined for local delivery.
25318
25319 .vindex "&$tls_peerdn$&"
25320 When a client supplies a certificate (whether it verifies or not), the value of
25321 the Distinguished Name of the certificate is made available in the variable
25322 &$tls_peerdn$& during subsequent processing of the message.
25323
25324 .cindex "log" "distinguished name"
25325 Because it is often a long text string, it is not included in the log line or
25326 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25327 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25328 &%received_header_text%& to change the &'Received:'& header. When no
25329 certificate is supplied, &$tls_peerdn$& is empty.
25330
25331
25332 .section "Revoked certificates" "SECID184"
25333 .cindex "TLS" "revoked certificates"
25334 .cindex "revocation list"
25335 .cindex "certificate" "revocation list"
25336 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25337 certificates are revoked. If you have such a list, you can pass it to an Exim
25338 server using the global option called &%tls_crl%& and to an Exim client using
25339 an identically named option for the &(smtp)& transport. In each case, the value
25340 of the option is expanded and must then be the name of a file that contains a
25341 CRL in PEM format.
25342
25343
25344 .section "Configuring an Exim client to use TLS" "SECID185"
25345 .cindex "cipher" "logging"
25346 .cindex "log" "TLS cipher"
25347 .cindex "log" "distinguished name"
25348 .cindex "TLS" "configuring an Exim client"
25349 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25350 deliveries as well as to incoming, the latter one causing logging of the
25351 server certificate's DN. The remaining client configuration for TLS is all
25352 within the &(smtp)& transport.
25353
25354 It is not necessary to set any options to have TLS work in the &(smtp)&
25355 transport. If Exim is built with TLS support, and TLS is advertised by a
25356 server, the &(smtp)& transport always tries to start a TLS session. However,
25357 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25358 transport) to a list of server hosts for which TLS should not be used.
25359
25360 If you do not want Exim to attempt to send messages unencrypted when an attempt
25361 to set up an encrypted connection fails in any way, you can set
25362 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25363 those hosts, delivery is always deferred if an encrypted connection cannot be
25364 set up. If there are any other hosts for the address, they are tried in the
25365 usual way.
25366
25367 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25368 the message unencrypted. It always does this if the response to STARTTLS is
25369 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25370 session after a success response code, what happens is controlled by the
25371 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25372 delivery to this host is deferred, and other hosts (if available) are tried. If
25373 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25374 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25375 negotiation fails, Exim closes the current connection (because it is in an
25376 unknown state), opens a new one to the same host, and then tries the delivery
25377 unencrypted.
25378
25379 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25380 transport provide the client with a certificate, which is passed to the server
25381 if it requests it. If the server is Exim, it will request a certificate only if
25382 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25383
25384 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25385 must name a file or,
25386 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25387 expected server certificates. The client verifies the server's certificate
25388 against this collection, taking into account any revoked certificates that are
25389 in the list defined by &%tls_crl%&.
25390
25391 If
25392 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25393 list of permitted cipher suites. If either of these checks fails, delivery to
25394 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25395 alternative hosts, if any.
25396
25397  &*Note*&:
25398 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25399 is operating as a client. Exim does not assume that a server certificate (set
25400 by the global options of the same name) should also be used when operating as a
25401 client.
25402
25403 .vindex "&$host$&"
25404 .vindex "&$host_address$&"
25405 All the TLS options in the &(smtp)& transport are expanded before use, with
25406 &$host$& and &$host_address$& containing the name and address of the server to
25407 which the client is connected. Forced failure of an expansion causes Exim to
25408 behave as if the relevant option were unset.
25409
25410 .vindex &$tls_bits$&
25411 .vindex &$tls_cipher$&
25412 .vindex &$tls_peerdn$&
25413 .vindex &$tls_sni$&
25414 Before an SMTP connection is established, the
25415 &$tls_bits$&, &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25416 variables are emptied. (Until the first connection, they contain the values
25417 that were set when the message was received.) If STARTTLS is subsequently
25418 successfully obeyed, these variables are set to the relevant values for the
25419 outgoing connection.
25420
25421
25422
25423 .section "Use of TLS Server Name Indication" "SECTtlssni"
25424 .cindex "TLS" "Server Name Indication"
25425 .vindex "&$tls_sni$&"
25426 .oindex "&%tls_sni%&"
25427 With TLS1.0 or above, there is an extension mechanism by which extra
25428 information can be included at various points in the protocol.  One of these
25429 extensions, documented in RFC 6066 (and before that RFC 4366) is
25430 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25431 client in the initial handshake, so that the server can examine the servername
25432 within and possibly choose to use different certificates and keys (and more)
25433 for this session.
25434
25435 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25436 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25437 address.
25438
25439 With SMTP to MX, there are the same problems here as in choosing the identity
25440 against which to validate a certificate: you can't rely on insecure DNS to
25441 provide the identity which you then cryptographically verify.  So this will
25442 be of limited use in that environment.
25443
25444 With SMTP to Submission, there is a well-defined hostname which clients are
25445 connecting to and can validate certificates against.  Thus clients &*can*&
25446 choose to include this information in the TLS negotiation.  If this becomes
25447 wide-spread, then hosters can choose to present different certificates to
25448 different clients.  Or even negotiate different cipher suites.
25449
25450 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25451 if not empty, will be sent on a TLS session as part of the handshake.  There's
25452 nothing more to it.  Choosing a sensible value not derived insecurely is the
25453 only point of caution.  The &$tls_sni$& variable will be set to this string
25454 for the lifetime of the client connection (including during authentication).
25455
25456 Except during SMTP client sessions, if &$tls_sni$& is set then it is a string
25457 received from a client.
25458 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25459
25460 If the string &`tls_sni`& appears in the main section's &%tls_certificate%&
25461 option (prior to expansion) then the following options will be re-expanded
25462 during TLS session handshake, to permit alternative values to be chosen:
25463
25464 .ilist
25465 .vindex "&%tls_certificate%&"
25466 &%tls_certificate%&
25467 .next
25468 .vindex "&%tls_crl%&"
25469 &%tls_crl%&
25470 .next
25471 .vindex "&%tls_privatekey%&"
25472 &%tls_privatekey%&
25473 .next
25474 .vindex "&%tls_verify_certificates%&"
25475 &%tls_verify_certificates%&
25476 .endlist
25477
25478 Great care should be taken to deal with matters of case, various injection
25479 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25480 can always be referenced; it is important to remember that &$tls_sni$& is
25481 arbitrary unverified data provided prior to authentication.
25482
25483 The Exim developers are proceeding cautiously and so far no other TLS options
25484 are re-expanded.
25485
25486 When Exim is built againt OpenSSL, OpenSSL must have been built with support
25487 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
25488 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
25489 see &`-servername`& in the output, then OpenSSL has support.
25490
25491 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
25492 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
25493 built, then you have SNI support).
25494
25495
25496
25497 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25498          "SECTmulmessam"
25499 .cindex "multiple SMTP deliveries with TLS"
25500 .cindex "TLS" "multiple message deliveries"
25501 Exim sends multiple messages down the same TCP/IP connection by starting up
25502 an entirely new delivery process for each message, passing the socket from
25503 one process to the next. This implementation does not fit well with the use
25504 of TLS, because there is quite a lot of state information associated with a TLS
25505 connection, not just a socket identification. Passing all the state information
25506 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25507 session before passing the socket to a new process. The new process may then
25508 try to start a new TLS session, and if successful, may try to re-authenticate
25509 if AUTH is in use, before sending the next message.
25510
25511 The RFC is not clear as to whether or not an SMTP session continues in clear
25512 after TLS has been shut down, or whether TLS may be restarted again later, as
25513 just described. However, if the server is Exim, this shutdown and
25514 reinitialization works. It is not known which (if any) other servers operate
25515 successfully if the client closes a TLS session and continues with unencrypted
25516 SMTP, but there are certainly some that do not work. For such servers, Exim
25517 should not pass the socket to another process, because the failure of the
25518 subsequent attempt to use it would cause Exim to record a temporary host error,
25519 and delay other deliveries to that host.
25520
25521 To test for this case, Exim sends an EHLO command to the server after
25522 closing down the TLS session. If this fails in any way, the connection is
25523 closed instead of being passed to a new delivery process, but no retry
25524 information is recorded.
25525
25526 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25527 &(smtp)& transport to match those hosts for which Exim should not pass
25528 connections to new processes if TLS has been used.
25529
25530
25531
25532
25533 .section "Certificates and all that" "SECTcerandall"
25534 .cindex "certificate" "references to discussion"
25535 In order to understand fully how TLS works, you need to know about
25536 certificates, certificate signing, and certificate authorities. This is not the
25537 place to give a tutorial, especially as I do not know very much about it
25538 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25539 to Apache, currently at
25540 .display
25541 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25542 .endd
25543 Other parts of the &'modssl'& documentation are also helpful, and have
25544 links to further files.
25545 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25546 0-201-61598-3), contains both introductory and more in-depth descriptions.
25547 Some sample programs taken from the book are available from
25548 .display
25549 &url(http://www.rtfm.com/openssl-examples/)
25550 .endd
25551
25552
25553 .section "Certificate chains" "SECID186"
25554 The file named by &%tls_certificate%& may contain more than one
25555 certificate. This is useful in the case where the certificate that is being
25556 sent is validated by an intermediate certificate which the other end does
25557 not have. Multiple certificates must be in the correct order in the file.
25558 First the host's certificate itself, then the first intermediate
25559 certificate to validate the issuer of the host certificate, then the next
25560 intermediate certificate to validate the issuer of the first intermediate
25561 certificate, and so on, until finally (optionally) the root certificate.
25562 The root certificate must already be trusted by the recipient for
25563 validation to succeed, of course, but if it's not preinstalled, sending the
25564 root certificate along with the rest makes it available for the user to
25565 install if the receiving end is a client MUA that can interact with a user.
25566
25567
25568 .section "Self-signed certificates" "SECID187"
25569 .cindex "certificate" "self-signed"
25570 You can create a self-signed certificate using the &'req'& command provided
25571 with OpenSSL, like this:
25572 .code
25573 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
25574             -days 9999 -nodes
25575 .endd
25576 &_file1_& and &_file2_& can be the same file; the key and the certificate are
25577 delimited and so can be identified independently. The &%-days%& option
25578 specifies a period for which the certificate is valid. The &%-nodes%& option is
25579 important: if you do not set it, the key is encrypted with a passphrase
25580 that you are prompted for, and any use that is made of the key causes more
25581 prompting for the passphrase. This is not helpful if you are going to use
25582 this certificate and key in an MTA, where prompting is not possible.
25583
25584 A self-signed certificate made in this way is sufficient for testing, and
25585 may be adequate for all your requirements if you are mainly interested in
25586 encrypting transfers, and not in secure identification.
25587
25588 However, many clients require that the certificate presented by the server be a
25589 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
25590 certificate. In this situation, the self-signed certificate described above
25591 must be installed on the client host as a trusted root &'certification
25592 authority'& (CA), and the certificate used by Exim must be a user certificate
25593 signed with that self-signed certificate.
25594
25595 For information on creating self-signed CA certificates and using them to sign
25596 user certificates, see the &'General implementation overview'& chapter of the
25597 Open-source PKI book, available online at
25598 &url(http://ospkibook.sourceforge.net/).
25599 .ecindex IIDencsmtp1
25600 .ecindex IIDencsmtp2
25601
25602
25603
25604 . ////////////////////////////////////////////////////////////////////////////
25605 . ////////////////////////////////////////////////////////////////////////////
25606
25607 .chapter "Access control lists" "CHAPACL"
25608 .scindex IIDacl "&ACL;" "description"
25609 .cindex "control of incoming mail"
25610 .cindex "message" "controlling incoming"
25611 .cindex "policy control" "access control lists"
25612 Access Control Lists (ACLs) are defined in a separate section of the run time
25613 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
25614 name, terminated by a colon. Here is a complete ACL section that contains just
25615 one very small ACL:
25616 .code
25617 begin acl
25618 small_acl:
25619   accept   hosts = one.host.only
25620 .endd
25621 You can have as many lists as you like in the ACL section, and the order in
25622 which they appear does not matter. The lists are self-terminating.
25623
25624 The majority of ACLs are used to control Exim's behaviour when it receives
25625 certain SMTP commands. This applies both to incoming TCP/IP connections, and
25626 when a local process submits a message using SMTP by specifying the &%-bs%&
25627 option. The most common use is for controlling which recipients are accepted
25628 in incoming messages. In addition, you can define an ACL that is used to check
25629 local non-SMTP messages. The default configuration file contains an example of
25630 a realistic ACL for checking RCPT commands. This is discussed in chapter
25631 &<<CHAPdefconfil>>&.
25632
25633
25634 .section "Testing ACLs" "SECID188"
25635 The &%-bh%& command line option provides a way of testing your ACL
25636 configuration locally by running a fake SMTP session with which you interact.
25637 The host &'relay-test.mail-abuse.org'& provides a service for checking your
25638 relaying configuration (see section &<<SECTcheralcon>>& for more details).
25639
25640
25641
25642 .section "Specifying when ACLs are used" "SECID189"
25643 .cindex "&ACL;" "options for specifying"
25644 In order to cause an ACL to be used, you have to name it in one of the relevant
25645 options in the main part of the configuration. These options are:
25646 .cindex "AUTH" "ACL for"
25647 .cindex "DATA" "ACLs for"
25648 .cindex "ETRN" "ACL for"
25649 .cindex "EXPN" "ACL for"
25650 .cindex "HELO" "ACL for"
25651 .cindex "EHLO" "ACL for"
25652 .cindex "MAIL" "ACL for"
25653 .cindex "QUIT, ACL for"
25654 .cindex "RCPT" "ACL for"
25655 .cindex "STARTTLS, ACL for"
25656 .cindex "VRFY" "ACL for"
25657 .cindex "SMTP" "connection, ACL for"
25658 .cindex "non-SMTP messages" "ACLs for"
25659 .cindex "MIME content scanning" "ACL for"
25660
25661 .table2 140pt
25662 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
25663 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25664 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25665 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25666 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
25667 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
25668 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
25669 .irow &%acl_smtp_expn%&        "ACL for EXPN"
25670 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
25671 .irow &%acl_smtp_mail%&        "ACL for MAIL"
25672 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
25673 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
25674 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
25675 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
25676 .irow &%acl_smtp_quit%&        "ACL for QUIT"
25677 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
25678 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
25679 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
25680 .endtable
25681
25682 For example, if you set
25683 .code
25684 acl_smtp_rcpt = small_acl
25685 .endd
25686 the little ACL defined above is used whenever Exim receives a RCPT command
25687 in an SMTP dialogue. The majority of policy tests on incoming messages can be
25688 done when RCPT commands arrive. A rejection of RCPT should cause the
25689 sending MTA to give up on the recipient address contained in the RCPT
25690 command, whereas rejection at other times may cause the client MTA to keep on
25691 trying to deliver the message. It is therefore recommended that you do as much
25692 testing as possible at RCPT time.
25693
25694
25695 .section "The non-SMTP ACLs" "SECID190"
25696 .cindex "non-SMTP messages" "ACLs for"
25697 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
25698 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
25699 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
25700 the state of the SMTP connection such as encryption and authentication) are not
25701 relevant and are forbidden in these ACLs. However, the sender and recipients
25702 are known, so the &%senders%& and &%sender_domains%& conditions and the
25703 &$sender_address$& and &$recipients$& variables can be used. Variables such as
25704 &$authenticated_sender$& are also available. You can specify added header lines
25705 in any of these ACLs.
25706
25707 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
25708 non-SMTP message, before any of the message has been read. (This is the
25709 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
25710 batched SMTP input, it runs after the DATA command has been reached. The
25711 result of this ACL is ignored; it cannot be used to reject a message. If you
25712 really need to, you could set a value in an ACL variable here and reject based
25713 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
25714 controls, and in particular, it can be used to set
25715 .code
25716 control = suppress_local_fixups
25717 .endd
25718 This cannot be used in the other non-SMTP ACLs because by the time they are
25719 run, it is too late.
25720
25721 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
25722 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25723
25724 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
25725 kind of rejection is treated as permanent, because there is no way of sending a
25726 temporary error for these kinds of message.
25727
25728
25729 .section "The SMTP connect ACL" "SECID191"
25730 .cindex "SMTP" "connection, ACL for"
25731 .oindex &%smtp_banner%&
25732 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
25733 session, after the test specified by &%host_reject_connection%& (which is now
25734 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
25735 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
25736 the message override the banner message that is otherwise specified by the
25737 &%smtp_banner%& option.
25738
25739
25740 .section "The EHLO/HELO ACL" "SECID192"
25741 .cindex "EHLO" "ACL for"
25742 .cindex "HELO" "ACL for"
25743 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
25744 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
25745 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
25746 Note that a client may issue more than one EHLO or HELO command in an SMTP
25747 session, and indeed is required to issue a new EHLO or HELO after successfully
25748 setting up encryption following a STARTTLS command.
25749
25750 If the command is accepted by an &%accept%& verb that has a &%message%&
25751 modifier, the message may not contain more than one line (it will be truncated
25752 at the first newline and a panic logged if it does). Such a message cannot
25753 affect the EHLO options that are listed on the second and subsequent lines of
25754 an EHLO response.
25755
25756
25757 .section "The DATA ACLs" "SECID193"
25758 .cindex "DATA" "ACLs for"
25759 Two ACLs are associated with the DATA command, because it is two-stage
25760 command, with two responses being sent to the client.
25761 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
25762 is obeyed. This gives you control after all the RCPT commands, but before
25763 the message itself is received. It offers the opportunity to give a negative
25764 response to the DATA command before the data is transmitted. Header lines
25765 added by MAIL or RCPT ACLs are not visible at this time, but any that
25766 are defined here are visible when the &%acl_smtp_data%& ACL is run.
25767
25768 You cannot test the contents of the message, for example, to verify addresses
25769 in the headers, at RCPT time or when the DATA command is received. Such
25770 tests have to appear in the ACL that is run after the message itself has been
25771 received, before the final response to the DATA command is sent. This is
25772 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
25773 associated with the DATA command.
25774
25775 For both of these ACLs, it is not possible to reject individual recipients. An
25776 error response rejects the entire message. Unfortunately, it is known that some
25777 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
25778 before or after the data) correctly &-- they keep the message on their queues
25779 and try again later, but that is their problem, though it does waste some of
25780 your resources.
25781
25782
25783 .section "The SMTP DKIM ACL" "SECTDKIMACL"
25784 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
25785 enabled (which is the default).
25786
25787 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
25788 received, and is executed for each DKIM signature found in a message.  If not
25789 otherwise specified, the default action is to accept.
25790
25791 For details on the operation of DKIM, see chapter &<<CHID12>>&.
25792
25793
25794 .section "The SMTP MIME ACL" "SECID194"
25795 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
25796 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25797
25798
25799 .section "The QUIT ACL" "SECTQUITACL"
25800 .cindex "QUIT, ACL for"
25801 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
25802 does not affect the response code to QUIT, which is always 221. Thus, the ACL
25803 does not in fact control any access. For this reason, the only verbs that are
25804 permitted are &%accept%& and &%warn%&.
25805
25806 This ACL can be used for tasks such as custom logging at the end of an SMTP
25807 session. For example, you can use ACL variables in other ACLs to count
25808 messages, recipients, etc., and log the totals at QUIT time using one or
25809 more &%logwrite%& modifiers on a &%warn%& verb.
25810
25811 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
25812 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
25813
25814 You do not need to have a final &%accept%&, but if you do, you can use a
25815 &%message%& modifier to specify custom text that is sent as part of the 221
25816 response to QUIT.
25817
25818 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
25819 failure (for example, failure to open a log file, or when Exim is bombing out
25820 because it has detected an unrecoverable error), all SMTP commands from the
25821 client are given temporary error responses until QUIT is received or the
25822 connection is closed. In these special cases, the QUIT ACL does not run.
25823
25824
25825 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25826 .vindex &$acl_smtp_notquit$&
25827 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25828 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25829 trouble, such as being unable to write to its log files, this ACL is not run,
25830 because it might try to do things (such as write to log files) that make the
25831 situation even worse.
25832
25833 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25834 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25835 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25836 and &%warn%&.
25837
25838 .vindex &$smtp_notquit_reason$&
25839 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25840 to a string that indicates the reason for the termination of the SMTP
25841 connection. The possible values are:
25842 .table2
25843 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25844 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25845 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25846 .irow &`connection-lost`&          "The SMTP connection has been lost"
25847 .irow &`data-timeout`&             "Timeout while reading message data"
25848 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25849 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25850 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25851 .irow &`synchronization-error`&    "SMTP synchronization error"
25852 .irow &`tls-failed`&               "TLS failed to start"
25853 .endtable
25854 In most cases when an SMTP connection is closed without having received QUIT,
25855 Exim sends an SMTP response message before actually closing the connection.
25856 With the exception of the &`acl-drop`& case, the default message can be
25857 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25858 &%drop%& verb in another ACL, it is the message from the other ACL that is
25859 used.
25860
25861
25862 .section "Finding an ACL to use" "SECID195"
25863 .cindex "&ACL;" "finding which to use"
25864 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25865 you can use different ACLs in different circumstances. For example,
25866 .code
25867 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25868                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25869 .endd
25870 In the default configuration file there are some example settings for
25871 providing an RFC 4409 message submission service on port 587 and a
25872 non-standard &"smtps"& service on port 465. You can use a string
25873 expansion like this to choose an ACL for MUAs on these ports which is
25874 more appropriate for this purpose than the default ACL on port 25.
25875
25876 The expanded string does not have to be the name of an ACL in the
25877 configuration file; there are other possibilities. Having expanded the
25878 string, Exim searches for an ACL as follows:
25879
25880 .ilist
25881 If the string begins with a slash, Exim uses it as a file name, and reads its
25882 contents as an ACL. The lines are processed in the same way as lines in the
25883 Exim configuration file. In particular, continuation lines are supported, blank
25884 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25885 If the file does not exist or cannot be read, an error occurs (typically
25886 causing a temporary failure of whatever caused the ACL to be run). For example:
25887 .code
25888 acl_smtp_data = /etc/acls/\
25889   ${lookup{$sender_host_address}lsearch\
25890   {/etc/acllist}{$value}{default}}
25891 .endd
25892 This looks up an ACL file to use on the basis of the host's IP address, falling
25893 back to a default if the lookup fails. If an ACL is successfully read from a
25894 file, it is retained in memory for the duration of the Exim process, so that it
25895 can be re-used without having to re-read the file.
25896 .next
25897 If the string does not start with a slash, and does not contain any spaces,
25898 Exim searches the ACL section of the configuration for an ACL whose name
25899 matches the string.
25900 .next
25901 If no named ACL is found, or if the string contains spaces, Exim parses
25902 the string as an inline ACL. This can save typing in cases where you just
25903 want to have something like
25904 .code
25905 acl_smtp_vrfy = accept
25906 .endd
25907 in order to allow free use of the VRFY command. Such a string may contain
25908 newlines; it is processed in the same way as an ACL that is read from a file.
25909 .endlist
25910
25911
25912
25913
25914 .section "ACL return codes" "SECID196"
25915 .cindex "&ACL;" "return codes"
25916 Except for the QUIT ACL, which does not affect the SMTP return code (see
25917 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25918 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25919 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25920 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25921 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25922 This also causes a 4&'xx'& return code.
25923
25924 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25925 &"deny"&, because there is no mechanism for passing temporary errors to the
25926 submitters of non-SMTP messages.
25927
25928
25929 ACLs that are relevant to message reception may also return &"discard"&. This
25930 has the effect of &"accept"&, but causes either the entire message or an
25931 individual recipient address to be discarded. In other words, it is a
25932 blackholing facility. Use it with care.
25933
25934 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25935 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25936 RCPT ACL is to discard just the one recipient address. If there are no
25937 recipients left when the message's data is received, the DATA ACL is not
25938 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25939 remaining recipients. The &"discard"& return is not permitted for the
25940 &%acl_smtp_predata%& ACL.
25941
25942
25943 .cindex "&[local_scan()]& function" "when all recipients discarded"
25944 The &[local_scan()]& function is always run, even if there are no remaining
25945 recipients; it may create new recipients.
25946
25947
25948
25949 .section "Unset ACL options" "SECID197"
25950 .cindex "&ACL;" "unset options"
25951 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25952 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25953 not defined at all. For any defined ACL, the default action when control
25954 reaches the end of the ACL statements is &"deny"&.
25955
25956 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25957 these two are ACLs that are used only for their side effects. They cannot be
25958 used to accept or reject anything.
25959
25960 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25961 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25962 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25963 when the ACL is not defined is &"accept"&.
25964
25965 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25966 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25967 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25968 messages over an SMTP connection. For an example, see the ACL in the default
25969 configuration file.
25970
25971
25972
25973
25974 .section "Data for message ACLs" "SECID198"
25975 .cindex "&ACL;" "data for message ACL"
25976 .vindex &$domain$&
25977 .vindex &$local_part$&
25978 .vindex &$sender_address$&
25979 .vindex &$sender_host_address$&
25980 .vindex &$smtp_command$&
25981 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25982 that contain information about the host and the message's sender (for example,
25983 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25984 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25985 &$local_part$& are set from the argument address. The entire SMTP command
25986 is available in &$smtp_command$&.
25987
25988 When an ACL for the AUTH parameter of MAIL is running, the variables that
25989 contain information about the host are set, but &$sender_address$& is not yet
25990 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25991 how it is used.
25992
25993 .vindex "&$message_size$&"
25994 The &$message_size$& variable is set to the value of the SIZE parameter on
25995 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25996 that parameter is not given. The value is updated to the true message size by
25997 the time the final DATA ACL is run (after the message data has been
25998 received).
25999
26000 .vindex "&$rcpt_count$&"
26001 .vindex "&$recipients_count$&"
26002 The &$rcpt_count$& variable increases by one for each RCPT command received.
26003 The &$recipients_count$& variable increases by one each time a RCPT command is
26004 accepted, so while an ACL for RCPT is being processed, it contains the number
26005 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26006 &$rcpt_count$& contains the total number of RCPT commands, and
26007 &$recipients_count$& contains the total number of accepted recipients.
26008
26009
26010
26011
26012
26013 .section "Data for non-message ACLs" "SECTdatfornon"
26014 .cindex "&ACL;" "data for non-message ACL"
26015 .vindex &$smtp_command_argument$&
26016 .vindex &$smtp_command$&
26017 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26018 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26019 and the entire SMTP command is available in &$smtp_command$&.
26020 These variables can be tested using a &%condition%& condition. For example,
26021 here is an ACL for use with AUTH, which insists that either the session is
26022 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26023 does not permit authentication methods that use cleartext passwords on
26024 unencrypted connections.
26025 .code
26026 acl_check_auth:
26027   accept encrypted = *
26028   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26029                      {CRAM-MD5}}
26030   deny   message   = TLS encryption or CRAM-MD5 required
26031 .endd
26032 (Another way of applying this restriction is to arrange for the authenticators
26033 that use cleartext passwords not to be advertised when the connection is not
26034 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26035 option to do this.)
26036
26037
26038
26039 .section "Format of an ACL" "SECID199"
26040 .cindex "&ACL;" "format of"
26041 .cindex "&ACL;" "verbs, definition of"
26042 An individual ACL consists of a number of statements. Each statement starts
26043 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26044 Modifiers can change the way the verb operates, define error and log messages,
26045 set variables, insert delays, and vary the processing of accepted messages.
26046
26047 If all the conditions are met, the verb is obeyed. The same condition may be
26048 used (with different arguments) more than once in the same statement. This
26049 provides a means of specifying an &"and"& conjunction between conditions. For
26050 example:
26051 .code
26052 deny  dnslists = list1.example
26053 dnslists = list2.example
26054 .endd
26055 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26056 the conditions and modifiers when it reaches a condition that fails. What
26057 happens then depends on the verb (and in one case, on a special modifier). Not
26058 all the conditions make sense at every testing point. For example, you cannot
26059 test a sender address in the ACL that is run for a VRFY command.
26060
26061
26062 .section "ACL verbs" "SECID200"
26063 The ACL verbs are as follows:
26064
26065 .ilist
26066 .cindex "&%accept%& ACL verb"
26067 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26068 of the conditions are not met, what happens depends on whether &%endpass%&
26069 appears among the conditions (for syntax see below). If the failing condition
26070 is before &%endpass%&, control is passed to the next ACL statement; if it is
26071 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26072 check a RCPT command:
26073 .code
26074 accept domains = +local_domains
26075 endpass
26076 verify = recipient
26077 .endd
26078 If the recipient domain does not match the &%domains%& condition, control
26079 passes to the next statement. If it does match, the recipient is verified, and
26080 the command is accepted if verification succeeds. However, if verification
26081 fails, the ACL yields &"deny"&, because the failing condition is after
26082 &%endpass%&.
26083
26084 The &%endpass%& feature has turned out to be confusing to many people, so its
26085 use is not recommended nowadays. It is always possible to rewrite an ACL so
26086 that &%endpass%& is not needed, and it is no longer used in the default
26087 configuration.
26088
26089 .cindex "&%message%& ACL modifier" "with &%accept%&"
26090 If a &%message%& modifier appears on an &%accept%& statement, its action
26091 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26092 (when an &%accept%& verb either accepts or passes control to the next
26093 statement), &%message%& can be used to vary the message that is sent when an
26094 SMTP command is accepted. For example, in a RCPT ACL you could have:
26095 .display
26096 &`accept  `&<&'some conditions'&>
26097 &`        message = OK, I will allow you through today`&
26098 .endd
26099 You can specify an SMTP response code, optionally followed by an &"extended
26100 response code"& at the start of the message, but the first digit must be the
26101 same as would be sent by default, which is 2 for an &%accept%& verb.
26102
26103 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26104 an error message that is used when access is denied. This behaviour is retained
26105 for backward compatibility, but current &"best practice"& is to avoid the use
26106 of &%endpass%&.
26107
26108
26109 .next
26110 .cindex "&%defer%& ACL verb"
26111 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26112 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26113 &%defer%& is the same as &%deny%&, because there is no way of sending a
26114 temporary error. For a RCPT command, &%defer%& is much the same as using a
26115 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26116 be used in any ACL, and even for a recipient it might be a simpler approach.
26117
26118
26119 .next
26120 .cindex "&%deny%& ACL verb"
26121 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26122 the conditions are not met, control is passed to the next ACL statement. For
26123 example,
26124 .code
26125 deny dnslists = blackholes.mail-abuse.org
26126 .endd
26127 rejects commands from hosts that are on a DNS black list.
26128
26129
26130 .next
26131 .cindex "&%discard%& ACL verb"
26132 &%discard%&: This verb behaves like &%accept%&, except that it returns
26133 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26134 that are concerned with receiving messages. When all the conditions are true,
26135 the sending entity receives a &"success"& response. However, &%discard%& causes
26136 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26137 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26138 message's recipients are discarded. Recipients that are discarded before DATA
26139 do not appear in the log line when the &%received_recipients%& log selector is set.
26140
26141 If the &%log_message%& modifier is set when &%discard%& operates,
26142 its contents are added to the line that is automatically written to the log.
26143 The &%message%& modifier operates exactly as it does for &%accept%&.
26144
26145
26146 .next
26147 .cindex "&%drop%& ACL verb"
26148 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26149 forcibly closed after the 5&'xx'& error message has been sent. For example:
26150 .code
26151 drop   message   = I don't take more than 20 RCPTs
26152        condition = ${if > {$rcpt_count}{20}}
26153 .endd
26154 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26155 The connection is always dropped after sending a 550 response.
26156
26157 .next
26158 .cindex "&%require%& ACL verb"
26159 &%require%&: If all the conditions are met, control is passed to the next ACL
26160 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26161 example, when checking a RCPT command,
26162 .code
26163 require message = Sender did not verify
26164         verify  = sender
26165 .endd
26166 passes control to subsequent statements only if the message's sender can be
26167 verified. Otherwise, it rejects the command. Note the positioning of the
26168 &%message%& modifier, before the &%verify%& condition. The reason for this is
26169 discussed in section &<<SECTcondmodproc>>&.
26170
26171 .next
26172 .cindex "&%warn%& ACL verb"
26173 &%warn%&: If all the conditions are true, a line specified by the
26174 &%log_message%& modifier is written to Exim's main log. Control always passes
26175 to the next ACL statement. If any condition is false, the log line is not
26176 written. If an identical log line is requested several times in the same
26177 message, only one copy is actually written to the log. If you want to force
26178 duplicates to be written, use the &%logwrite%& modifier instead.
26179
26180 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26181 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26182 &%logwrite%&, and &%add_header%&) that appear before the first failing
26183 condition. There is more about adding header lines in section
26184 &<<SECTaddheadacl>>&.
26185
26186 If any condition on a &%warn%& statement cannot be completed (that is, there is
26187 some sort of defer), the log line specified by &%log_message%& is not written.
26188 This does not include the case of a forced failure from a lookup, which
26189 is considered to be a successful completion. After a defer, no further
26190 conditions or modifiers in the &%warn%& statement are processed. The incident
26191 is logged, and the ACL continues to be processed, from the next statement
26192 onwards.
26193
26194
26195 .vindex "&$acl_verify_message$&"
26196 When one of the &%warn%& conditions is an address verification that fails, the
26197 text of the verification failure message is in &$acl_verify_message$&. If you
26198 want this logged, you must set it up explicitly. For example:
26199 .code
26200 warn   !verify = sender
26201        log_message = sender verify failed: $acl_verify_message
26202 .endd
26203 .endlist
26204
26205 At the end of each ACL there is an implicit unconditional &%deny%&.
26206
26207 As you can see from the examples above, the conditions and modifiers are
26208 written one to a line, with the first one on the same line as the verb, and
26209 subsequent ones on following lines. If you have a very long condition, you can
26210 continue it onto several physical lines by the usual backslash continuation
26211 mechanism. It is conventional to align the conditions vertically.
26212
26213
26214
26215 .section "ACL variables" "SECTaclvariables"
26216 .cindex "&ACL;" "variables"
26217 There are some special variables that can be set during ACL processing. They
26218 can be used to pass information between different ACLs, different invocations
26219 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26220 transports, and filters that are used to deliver a message. The names of these
26221 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26222 an underscore, but the remainder of the name can be any sequence of
26223 alphanumeric characters and underscores that you choose. There is no limit on
26224 the number of ACL variables. The two sets act as follows:
26225 .ilist
26226 The values of those variables whose names begin with &$acl_c$& persist
26227 throughout an SMTP connection. They are never reset. Thus, a value that is set
26228 while receiving one message is still available when receiving the next message
26229 on the same SMTP connection.
26230 .next
26231 The values of those variables whose names begin with &$acl_m$& persist only
26232 while a message is being received. They are reset afterwards. They are also
26233 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26234 .endlist
26235
26236 When a message is accepted, the current values of all the ACL variables are
26237 preserved with the message and are subsequently made available at delivery
26238 time. The ACL variables are set by a modifier called &%set%&. For example:
26239 .code
26240 accept hosts = whatever
26241        set acl_m4 = some value
26242 accept authenticated = *
26243        set acl_c_auth = yes
26244 .endd
26245 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26246 be set. If you want to set a variable without taking any action, you can use a
26247 &%warn%& verb without any other modifiers or conditions.
26248
26249 .oindex &%strict_acl_vars%&
26250 What happens if a syntactically valid but undefined ACL variable is
26251 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26252 false (the default), an empty string is substituted; if it is true, an
26253 error is generated.
26254
26255 Versions of Exim before 4.64 have a limited set of numbered variables, but
26256 their names are compatible, so there is no problem with upgrading.
26257
26258
26259 .section "Condition and modifier processing" "SECTcondmodproc"
26260 .cindex "&ACL;" "conditions; processing"
26261 .cindex "&ACL;" "modifiers; processing"
26262 An exclamation mark preceding a condition negates its result. For example:
26263 .code
26264 deny   domains = *.dom.example
26265       !verify  = recipient
26266 .endd
26267 causes the ACL to return &"deny"& if the recipient domain ends in
26268 &'dom.example'& and the recipient address cannot be verified. Sometimes
26269 negation can be used on the right-hand side of a condition. For example, these
26270 two statements are equivalent:
26271 .code
26272 deny  hosts = !192.168.3.4
26273 deny !hosts =  192.168.3.4
26274 .endd
26275 However, for many conditions (&%verify%& being a good example), only left-hand
26276 side negation of the whole condition is possible.
26277
26278 The arguments of conditions and modifiers are expanded. A forced failure
26279 of an expansion causes a condition to be ignored, that is, it behaves as if the
26280 condition is true. Consider these two statements:
26281 .code
26282 accept  senders = ${lookup{$host_name}lsearch\
26283                   {/some/file}{$value}fail}
26284 accept  senders = ${lookup{$host_name}lsearch\
26285                   {/some/file}{$value}{}}
26286 .endd
26287 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26288 the returned list is searched, but if the lookup fails the behaviour is
26289 different in the two cases. The &%fail%& in the first statement causes the
26290 condition to be ignored, leaving no further conditions. The &%accept%& verb
26291 therefore succeeds. The second statement, however, generates an empty list when
26292 the lookup fails. No sender can match an empty list, so the condition fails,
26293 and therefore the &%accept%& also fails.
26294
26295 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26296 specify actions that are taken as the conditions for a statement are checked;
26297 others specify text for messages that are used when access is denied or a
26298 warning is generated. The &%control%& modifier affects the way an incoming
26299 message is handled.
26300
26301 The positioning of the modifiers in an ACL statement important, because the
26302 processing of a verb ceases as soon as its outcome is known. Only those
26303 modifiers that have already been encountered will take effect. For example,
26304 consider this use of the &%message%& modifier:
26305 .code
26306 require message = Can't verify sender
26307         verify  = sender
26308         message = Can't verify recipient
26309         verify  = recipient
26310         message = This message cannot be used
26311 .endd
26312 If sender verification fails, Exim knows that the result of the statement is
26313 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26314 so its text is used as the error message. If sender verification succeeds, but
26315 recipient verification fails, the second message is used. If recipient
26316 verification succeeds, the third message becomes &"current"&, but is never used
26317 because there are no more conditions to cause failure.
26318
26319 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26320 modifier that is used, because all the conditions must be true for rejection to
26321 happen. Specifying more than one &%message%& modifier does not make sense, and
26322 the message can even be specified after all the conditions. For example:
26323 .code
26324 deny   hosts = ...
26325       !senders = *@my.domain.example
26326        message = Invalid sender from client host
26327 .endd
26328 The &"deny"& result does not happen until the end of the statement is reached,
26329 by which time Exim has set up the message.
26330
26331
26332
26333 .section "ACL modifiers" "SECTACLmodi"
26334 .cindex "&ACL;" "modifiers; list of"
26335 The ACL modifiers are as follows:
26336
26337 .vlist
26338 .vitem &*add_header*&&~=&~<&'text'&>
26339 This modifier specifies one or more header lines that are to be added to an
26340 incoming message, assuming, of course, that the message is ultimately
26341 accepted. For details, see section &<<SECTaddheadacl>>&.
26342
26343 .vitem &*continue*&&~=&~<&'text'&>
26344 .cindex "&%continue%& ACL modifier"
26345 .cindex "database" "updating in ACL"
26346 This modifier does nothing of itself, and processing of the ACL always
26347 continues with the next condition or modifier. The value of &%continue%& is in
26348 the side effects of expanding its argument. Typically this could be used to
26349 update a database. It is really just a syntactic tidiness, to avoid having to
26350 write rather ugly lines like this:
26351 .display
26352 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26353 .endd
26354 Instead, all you need is
26355 .display
26356 &`continue = `&<&'some expansion'&>
26357 .endd
26358
26359 .vitem &*control*&&~=&~<&'text'&>
26360 .cindex "&%control%& ACL modifier"
26361 This modifier affects the subsequent processing of the SMTP connection or of an
26362 incoming message that is accepted. The effect of the first type of control
26363 lasts for the duration of the connection, whereas the effect of the second type
26364 lasts only until the current message has been received. The message-specific
26365 controls always apply to the whole message, not to individual recipients,
26366 even if the &%control%& modifier appears in a RCPT ACL.
26367
26368 As there are now quite a few controls that can be applied, they are described
26369 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26370 in several different ways. For example:
26371
26372 . ==== As this is a nested list, any displays it contains must be indented
26373 . ==== as otherwise they are too far to the left. That comment applies only
26374 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26375 . ==== way.
26376
26377 .ilist
26378 It can be at the end of an &%accept%& statement:
26379 .code
26380     accept  ...some conditions
26381             control = queue_only
26382 .endd
26383 In this case, the control is applied when this statement yields &"accept"&, in
26384 other words, when the conditions are all true.
26385
26386 .next
26387 It can be in the middle of an &%accept%& statement:
26388 .code
26389     accept  ...some conditions...
26390             control = queue_only
26391             ...some more conditions...
26392 .endd
26393 If the first set of conditions are true, the control is applied, even if the
26394 statement does not accept because one of the second set of conditions is false.
26395 In this case, some subsequent statement must yield &"accept"& for the control
26396 to be relevant.
26397
26398 .next
26399 It can be used with &%warn%& to apply the control, leaving the
26400 decision about accepting or denying to a subsequent verb. For
26401 example:
26402 .code
26403     warn    ...some conditions...
26404             control = freeze
26405     accept  ...
26406 .endd
26407 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26408 &%logwrite%&, so it does not add anything to the message and does not write a
26409 log entry.
26410
26411 .next
26412 If you want to apply a control unconditionally, you can use it with a
26413 &%require%& verb. For example:
26414 .code
26415     require  control = no_multiline_responses
26416 .endd
26417 .endlist
26418
26419 .vitem &*delay*&&~=&~<&'time'&>
26420 .cindex "&%delay%& ACL modifier"
26421 .oindex "&%-bh%&"
26422 This modifier may appear in any ACL. It causes Exim to wait for the time
26423 interval before proceeding. However, when testing Exim using the &%-bh%&
26424 option, the delay is not actually imposed (an appropriate message is output
26425 instead). The time is given in the usual Exim notation, and the delay happens
26426 as soon as the modifier is processed. In an SMTP session, pending output is
26427 flushed before the delay is imposed.
26428
26429 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26430 example:
26431 .code
26432 deny    ...some conditions...
26433         delay = 30s
26434 .endd
26435 The delay happens if all the conditions are true, before the statement returns
26436 &"deny"&. Compare this with:
26437 .code
26438 deny    delay = 30s
26439         ...some conditions...
26440 .endd
26441 which waits for 30s before processing the conditions. The &%delay%& modifier
26442 can also be used with &%warn%& and together with &%control%&:
26443 .code
26444 warn    ...some conditions...
26445         delay = 2m
26446         control = freeze
26447 accept  ...
26448 .endd
26449
26450 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26451 responses to several commands are no longer buffered and sent in one packet (as
26452 they would normally be) because all output is flushed before imposing the
26453 delay. This optimization is disabled so that a number of small delays do not
26454 appear to the client as one large aggregated delay that might provoke an
26455 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26456 using a &%control%& modifier to set &%no_delay_flush%&.
26457
26458
26459 .vitem &*endpass*&
26460 .cindex "&%endpass%& ACL modifier"
26461 This modifier, which has no argument, is recognized only in &%accept%& and
26462 &%discard%& statements. It marks the boundary between the conditions whose
26463 failure causes control to pass to the next statement, and the conditions whose
26464 failure causes the ACL to return &"deny"&. This concept has proved to be
26465 confusing to some people, so the use of &%endpass%& is no longer recommended as
26466 &"best practice"&. See the description of &%accept%& above for more details.
26467
26468
26469 .vitem &*log_message*&&~=&~<&'text'&>
26470 .cindex "&%log_message%& ACL modifier"
26471 This modifier sets up a message that is used as part of the log message if the
26472 ACL denies access or a &%warn%& statement's conditions are true. For example:
26473 .code
26474 require log_message = wrong cipher suite $tls_cipher
26475         encrypted   = DES-CBC3-SHA
26476 .endd
26477 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26478 example:
26479 .display
26480 &`discard `&<&'some conditions'&>
26481 &`        log_message = Discarded $local_part@$domain because...`&
26482 .endd
26483 When access is denied, &%log_message%& adds to any underlying error message
26484 that may exist because of a condition failure. For example, while verifying a
26485 recipient address, a &':fail:'& redirection might have already set up a
26486 message.
26487
26488 The message may be defined before the conditions to which it applies, because
26489 the string expansion does not happen until Exim decides that access is to be
26490 denied. This means that any variables that are set by the condition are
26491 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26492 variables are set after a DNS black list lookup succeeds. If the expansion of
26493 &%log_message%& fails, or if the result is an empty string, the modifier is
26494 ignored.
26495
26496 .vindex "&$acl_verify_message$&"
26497 If you want to use a &%warn%& statement to log the result of an address
26498 verification, you can use &$acl_verify_message$& to include the verification
26499 error message.
26500
26501 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26502 the start of the logged message. If the same warning log message is requested
26503 more than once while receiving  a single email message, only one copy is
26504 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26505 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26506 is logged for a successful &%warn%& statement.
26507
26508 If &%log_message%& is not present and there is no underlying error message (for
26509 example, from the failure of address verification), but &%message%& is present,
26510 the &%message%& text is used for logging rejections. However, if any text for
26511 logging contains newlines, only the first line is logged. In the absence of
26512 both &%log_message%& and &%message%&, a default built-in message is used for
26513 logging rejections.
26514
26515
26516 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26517 .cindex "&%log_reject_target%& ACL modifier"
26518 .cindex "logging in ACL" "specifying which log"
26519 This modifier makes it possible to specify which logs are used for messages
26520 about ACL rejections. Its argument is a colon-separated list of words that can
26521 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26522 may be empty, in which case a rejection is not logged at all. For example, this
26523 ACL fragment writes no logging information when access is denied:
26524 .display
26525 &`deny `&<&'some conditions'&>
26526 &`     log_reject_target =`&
26527 .endd
26528 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26529 permanent and temporary rejections. Its effect lasts for the rest of the
26530 current ACL.
26531
26532
26533 .vitem &*logwrite*&&~=&~<&'text'&>
26534 .cindex "&%logwrite%& ACL modifier"
26535 .cindex "logging in ACL" "immediate"
26536 This modifier writes a message to a log file as soon as it is encountered when
26537 processing an ACL. (Compare &%log_message%&, which, except in the case of
26538 &%warn%& and &%discard%&, is used only if the ACL statement denies
26539 access.) The &%logwrite%& modifier can be used to log special incidents in
26540 ACLs. For example:
26541 .display
26542 &`accept `&<&'some special conditions'&>
26543 &`       control  = freeze`&
26544 &`       logwrite = froze message because ...`&
26545 .endd
26546 By default, the message is written to the main log. However, it may begin
26547 with a colon, followed by a comma-separated list of log names, and then
26548 another colon, to specify exactly which logs are to be written. For
26549 example:
26550 .code
26551 logwrite = :main,reject: text for main and reject logs
26552 logwrite = :panic: text for panic log only
26553 .endd
26554
26555
26556 .vitem &*message*&&~=&~<&'text'&>
26557 .cindex "&%message%& ACL modifier"
26558 This modifier sets up a text string that is expanded and used as a response
26559 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
26560 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
26561 there is some complication if &%endpass%& is involved; see the description of
26562 &%accept%& for details.)
26563
26564 The expansion of the message happens at the time Exim decides that the ACL is
26565 to end, not at the time it processes &%message%&. If the expansion fails, or
26566 generates an empty string, the modifier is ignored. Here is an example where
26567 &%message%& must be specified first, because the ACL ends with a rejection if
26568 the &%hosts%& condition fails:
26569 .code
26570 require  message = Host not recognized
26571          hosts = 10.0.0.0/8
26572 .endd
26573 (Once a condition has failed, no further conditions or modifiers are
26574 processed.)
26575
26576 .cindex "SMTP" "error codes"
26577 .oindex "&%smtp_banner%&
26578 For ACLs that are triggered by SMTP commands, the message is returned as part
26579 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
26580 is meaningful only for SMTP, as no message is returned when a non-SMTP message
26581 is accepted. In the case of the connect ACL, accepting with a message modifier
26582 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
26583 accept message may not contain more than one line (otherwise it will be
26584 truncated at the first newline and a panic logged), and it cannot affect the
26585 EHLO options.
26586
26587 When SMTP is involved, the message may begin with an overriding response code,
26588 consisting of three digits optionally followed by an &"extended response code"&
26589 of the form &'n.n.n'&, each code being followed by a space. For example:
26590 .code
26591 deny  message = 599 1.2.3 Host not welcome
26592       hosts = 192.168.34.0/24
26593 .endd
26594 The first digit of the supplied response code must be the same as would be sent
26595 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
26596 access, but for the predata ACL, note that the default success code is 354, not
26597 2&'xx'&.
26598
26599 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
26600 the message modifier cannot override the 221 response code.
26601
26602 The text in a &%message%& modifier is literal; any quotes are taken as
26603 literals, but because the string is expanded, backslash escapes are processed
26604 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
26605 response.
26606
26607 .vindex "&$acl_verify_message$&"
26608 If &%message%& is used on a statement that verifies an address, the message
26609 specified overrides any message that is generated by the verification process.
26610 However, the original message is available in the variable
26611 &$acl_verify_message$&, so you can incorporate it into your message if you
26612 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
26613 routers to be passed back as part of the SMTP response, you should either not
26614 use a &%message%& modifier, or make use of &$acl_verify_message$&.
26615
26616 For compatibility with previous releases of Exim, a &%message%& modifier that
26617 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
26618 modifier, but this usage is now deprecated. However, &%message%& acts only when
26619 all the conditions are true, wherever it appears in an ACL command, whereas
26620 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
26621 &%warn%& in an ACL that is not concerned with receiving a message, it has no
26622 effect.
26623
26624
26625 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
26626 .cindex "&%set%& ACL modifier"
26627 This modifier puts a value into one of the ACL variables (see section
26628 &<<SECTaclvariables>>&).
26629 .endlist
26630
26631
26632
26633
26634
26635 .section "Use of the control modifier" "SECTcontrols"
26636 .cindex "&%control%& ACL modifier"
26637 The &%control%& modifier supports the following settings:
26638
26639 .vlist
26640 .vitem &*control&~=&~allow_auth_unadvertised*&
26641 This modifier allows a client host to use the SMTP AUTH command even when it
26642 has not been advertised in response to EHLO. Furthermore, because there are
26643 apparently some really broken clients that do this, Exim will accept AUTH after
26644 HELO (rather than EHLO) when this control is set. It should be used only if you
26645 really need it, and you should limit its use to those broken clients that do
26646 not work without it. For example:
26647 .code
26648 warn hosts   = 192.168.34.25
26649      control = allow_auth_unadvertised
26650 .endd
26651 Normally, when an Exim server receives an AUTH command, it checks the name of
26652 the authentication mechanism that is given in the command to ensure that it
26653 matches an advertised mechanism. When this control is set, the check that a
26654 mechanism has been advertised is bypassed. Any configured mechanism can be used
26655 by the client. This control is permitted only in the connection and HELO ACLs.
26656
26657
26658 .vitem &*control&~=&~caseful_local_part*& &&&
26659        &*control&~=&~caselower_local_part*&
26660 .cindex "&ACL;" "case of local part in"
26661 .cindex "case of local parts"
26662 .vindex "&$local_part$&"
26663 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
26664 (that is, during RCPT processing). By default, the contents of &$local_part$&
26665 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
26666 any uppercase letters in the original local part are restored in &$local_part$&
26667 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
26668 is encountered.
26669
26670 These controls affect only the current recipient. Moreover, they apply only to
26671 local part handling that takes place directly in the ACL (for example, as a key
26672 in lookups). If a test to verify the recipient is obeyed, the case-related
26673 handling of the local part during the verification is controlled by the router
26674 configuration (see the &%caseful_local_part%& generic router option).
26675
26676 This facility could be used, for example, to add a spam score to local parts
26677 containing upper case letters. For example, using &$acl_m4$& to accumulate the
26678 spam score:
26679 .code
26680 warn  control = caseful_local_part
26681       set acl_m4 = ${eval:\
26682                      $acl_m4 + \
26683                      ${if match{$local_part}{[A-Z]}{1}{0}}\
26684                     }
26685       control = caselower_local_part
26686 .endd
26687 Notice that we put back the lower cased version afterwards, assuming that
26688 is what is wanted for subsequent tests.
26689
26690
26691 .vitem &*control&~=&~debug/*&<&'options'&>
26692 .cindex "&ACL;" "enabling debug logging"
26693 .cindex "debugging" "enabling from an ACL"
26694 This control turns on debug logging, almost as though Exim had been invoked
26695 with &`-d`&, with the output going to a new logfile, by default called
26696 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
26697 may access any variables already defined.  The logging may be adjusted with
26698 the &'opts'& option, which takes the same values as the &`-d`& command-line
26699 option.  Some examples (which depend on variables that don't exist in all
26700 contexts):
26701 .code
26702       control = debug
26703       control = debug/tag=.$sender_host_address
26704       control = debug/opts=+expand+acl
26705       control = debug/tag=.$message_exim_id/opts=+expand
26706 .endd
26707
26708
26709 .vitem &*control&~=&~enforce_sync*& &&&
26710        &*control&~=&~no_enforce_sync*&
26711 .cindex "SMTP" "synchronization checking"
26712 .cindex "synchronization checking in SMTP"
26713 These controls make it possible to be selective about when SMTP synchronization
26714 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
26715 state of the switch (it is true by default). See the description of this option
26716 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
26717
26718 The effect of these two controls lasts for the remainder of the SMTP
26719 connection. They can appear in any ACL except the one for the non-SMTP
26720 messages. The most straightforward place to put them is in the ACL defined by
26721 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
26722 before the first synchronization check. The expected use is to turn off the
26723 synchronization checks for badly-behaved hosts that you nevertheless need to
26724 work with.
26725
26726
26727 .vitem &*control&~=&~fakedefer/*&<&'message'&>
26728 .cindex "fake defer"
26729 .cindex "defer, fake"
26730 This control works in exactly the same way as &%fakereject%& (described below)
26731 except that it causes an SMTP 450 response after the message data instead of a
26732 550 response. You must take care when using &%fakedefer%& because it causes the
26733 messages to be duplicated when the sender retries. Therefore, you should not
26734 use &%fakedefer%& if the message is to be delivered normally.
26735
26736 .vitem &*control&~=&~fakereject/*&<&'message'&>
26737 .cindex "fake rejection"
26738 .cindex "rejection, fake"
26739 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
26740 words, only when an SMTP message is being received. If Exim accepts the
26741 message, instead the final 250 response, a 550 rejection message is sent.
26742 However, Exim proceeds to deliver the message as normal. The control applies
26743 only to the current message, not to any subsequent ones that may be received in
26744 the same SMTP connection.
26745
26746 The text for the 550 response is taken from the &%control%& modifier. If no
26747 message is supplied, the following is used:
26748 .code
26749 550-Your message has been rejected but is being
26750 550-kept for evaluation.
26751 550-If it was a legitimate message, it may still be
26752 550 delivered to the target recipient(s).
26753 .endd
26754 This facility should be used with extreme caution.
26755
26756 .vitem &*control&~=&~freeze*&
26757 .cindex "frozen messages" "forcing in ACL"
26758 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26759 other words, only when a message is being received. If the message is accepted,
26760 it is placed on Exim's queue and frozen. The control applies only to the
26761 current message, not to any subsequent ones that may be received in the same
26762 SMTP connection.
26763
26764 This modifier can optionally be followed by &`/no_tell`&. If the global option
26765 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
26766 is told about the freezing), provided all the &*control=freeze*& modifiers that
26767 are obeyed for the current message have the &`/no_tell`& option.
26768
26769 .vitem &*control&~=&~no_delay_flush*&
26770 .cindex "SMTP" "output flushing, disabling for delay"
26771 Exim normally flushes SMTP output before implementing a delay in an ACL, to
26772 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26773 use. This control, as long as it is encountered before the &%delay%& modifier,
26774 disables such output flushing.
26775
26776 .vitem &*control&~=&~no_callout_flush*&
26777 .cindex "SMTP" "output flushing, disabling for callout"
26778 Exim normally flushes SMTP output before performing a callout in an ACL, to
26779 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26780 use. This control, as long as it is encountered before the &%verify%& condition
26781 that causes the callout, disables such output flushing.
26782
26783 .vitem &*control&~=&~no_mbox_unspool*&
26784 This control is available when Exim is compiled with the content scanning
26785 extension. Content scanning may require a copy of the current message, or parts
26786 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
26787 or spam scanner. Normally, such copies are deleted when they are no longer
26788 needed. If this control is set, the copies are not deleted. The control applies
26789 only to the current message, not to any subsequent ones that may be received in
26790 the same SMTP connection. It is provided for debugging purposes and is unlikely
26791 to be useful in production.
26792
26793 .vitem &*control&~=&~no_multiline_responses*&
26794 .cindex "multiline responses, suppressing"
26795 This control is permitted for any ACL except the one for non-SMTP messages.
26796 It seems that there are broken clients in use that cannot handle multiline
26797 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
26798
26799 If this control is set, multiline SMTP responses from ACL rejections are
26800 suppressed. One way of doing this would have been to put out these responses as
26801 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
26802 (&"use multiline responses for more"& it says &-- ha!), and some of the
26803 responses might get close to that. So this facility, which is after all only a
26804 sop to broken clients, is implemented by doing two very easy things:
26805
26806 .ilist
26807 Extra information that is normally output as part of a rejection caused by
26808 sender verification failure is omitted. Only the final line (typically &"sender
26809 verification failed"&) is sent.
26810 .next
26811 If a &%message%& modifier supplies a multiline response, only the first
26812 line is output.
26813 .endlist
26814
26815 The setting of the switch can, of course, be made conditional on the
26816 calling host. Its effect lasts until the end of the SMTP connection.
26817
26818 .vitem &*control&~=&~no_pipelining*&
26819 .cindex "PIPELINING" "suppressing advertising"
26820 This control turns off the advertising of the PIPELINING extension to SMTP in
26821 the current session. To be useful, it must be obeyed before Exim sends its
26822 response to an EHLO command. Therefore, it should normally appear in an ACL
26823 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26824 &%pipelining_advertise_hosts%&.
26825
26826 .vitem &*control&~=&~queue_only*&
26827 .oindex "&%queue_only%&"
26828 .cindex "queueing incoming messages"
26829 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26830 other words, only when a message is being received. If the message is accepted,
26831 it is placed on Exim's queue and left there for delivery by a subsequent queue
26832 runner. No immediate delivery process is started. In other words, it has the
26833 effect as the &%queue_only%& global option. However, the control applies only
26834 to the current message, not to any subsequent ones that may be received in the
26835 same SMTP connection.
26836
26837 .vitem &*control&~=&~submission/*&<&'options'&>
26838 .cindex "message" "submission"
26839 .cindex "submission mode"
26840 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26841 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26842 the current message is a submission from a local MUA. In this case, Exim
26843 operates in &"submission mode"&, and applies certain fixups to the message if
26844 necessary. For example, it adds a &'Date:'& header line if one is not present.
26845 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26846 late (the message has already been created).
26847
26848 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26849 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26850 submission mode; the available options for this control are described there.
26851 The control applies only to the current message, not to any subsequent ones
26852 that may be received in the same SMTP connection.
26853
26854 .vitem &*control&~=&~suppress_local_fixups*&
26855 .cindex "submission fixups, suppressing"
26856 This control applies to locally submitted (non TCP/IP) messages, and is the
26857 complement of &`control = submission`&. It disables the fixups that are
26858 normally applied to locally-submitted messages. Specifically:
26859
26860 .ilist
26861 Any &'Sender:'& header line is left alone (in this respect, it is a
26862 dynamic version of &%local_sender_retain%&).
26863 .next
26864 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26865 .next
26866 There is no check that &'From:'& corresponds to the actual sender.
26867 .endlist ilist
26868
26869 This control may be useful when a remotely-originated message is accepted,
26870 passed to some scanning program, and then re-submitted for delivery. It can be
26871 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26872 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26873 data is read.
26874
26875 &*Note:*& This control applies only to the current message, not to any others
26876 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26877 .endlist vlist
26878
26879
26880 .section "Summary of message fixup control" "SECTsummesfix"
26881 All four possibilities for message fixups can be specified:
26882
26883 .ilist
26884 Locally submitted, fixups applied: the default.
26885 .next
26886 Locally submitted, no fixups applied: use
26887 &`control = suppress_local_fixups`&.
26888 .next
26889 Remotely submitted, no fixups applied: the default.
26890 .next
26891 Remotely submitted, fixups applied: use &`control = submission`&.
26892 .endlist
26893
26894
26895
26896 .section "Adding header lines in ACLs" "SECTaddheadacl"
26897 .cindex "header lines" "adding in an ACL"
26898 .cindex "header lines" "position of added lines"
26899 .cindex "&%message%& ACL modifier"
26900 The &%add_header%& modifier can be used to add one or more extra header lines
26901 to an incoming message, as in this example:
26902 .code
26903 warn dnslists = sbl.spamhaus.org : \
26904                 dialup.mail-abuse.org
26905      add_header = X-blacklisted-at: $dnslist_domain
26906 .endd
26907 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26908 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26909 receiving a message). The message must ultimately be accepted for
26910 &%add_header%& to have any significant effect. You can use &%add_header%& with
26911 any ACL verb, including &%deny%& (though this is potentially useful only in a
26912 RCPT ACL).
26913
26914 If the data for the &%add_header%& modifier contains one or more newlines that
26915 are not followed by a space or a tab, it is assumed to contain multiple header
26916 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26917 front of any line that is not a valid header line.
26918
26919 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26920 They are added to the message before processing the DATA and MIME ACLs.
26921 However, if an identical header line is requested more than once, only one copy
26922 is actually added to the message. Further header lines may be accumulated
26923 during the DATA and MIME ACLs, after which they are added to the message, again
26924 with duplicates suppressed. Thus, it is possible to add two identical header
26925 lines to an SMTP message, but only if one is added before DATA and one after.
26926 In the case of non-SMTP messages, new headers are accumulated during the
26927 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26928 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26929 are included in the entry that is written to the reject log.
26930
26931 .cindex "header lines" "added; visibility of"
26932 Header lines are not visible in string expansions until they are added to the
26933 message. It follows that header lines defined in the MAIL, RCPT, and predata
26934 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26935 header lines that are added by the DATA or MIME ACLs are not visible in those
26936 ACLs. Because of this restriction, you cannot use header lines as a way of
26937 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26938 this, you can use ACL variables, as described in section
26939 &<<SECTaclvariables>>&.
26940
26941 The &%add_header%& modifier acts immediately it is encountered during the
26942 processing of an ACL. Notice the difference between these two cases:
26943 .display
26944 &`accept add_header = ADDED: some text`&
26945 &`       `&<&'some condition'&>
26946
26947 &`accept `&<&'some condition'&>
26948 &`       add_header = ADDED: some text`&
26949 .endd
26950 In the first case, the header line is always added, whether or not the
26951 condition is true. In the second case, the header line is added only if the
26952 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26953 ACL statement. All those that are encountered before a condition fails are
26954 honoured.
26955
26956 .cindex "&%warn%& ACL verb"
26957 For compatibility with previous versions of Exim, a &%message%& modifier for a
26958 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26959 effect only if all the conditions are true, even if it appears before some of
26960 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26961 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26962 are present on a &%warn%& verb, both are processed according to their
26963 specifications.
26964
26965 By default, new header lines are added to a message at the end of the existing
26966 header lines. However, you can specify that any particular header line should
26967 be added right at the start (before all the &'Received:'& lines), immediately
26968 after the first block of &'Received:'& lines, or immediately before any line
26969 that is not a &'Received:'& or &'Resent-something:'& header.
26970
26971 This is done by specifying &":at_start:"&, &":after_received:"&, or
26972 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26973 header line, respectively. (Header text cannot start with a colon, as there has
26974 to be a header name first.) For example:
26975 .code
26976 warn add_header = \
26977        :after_received:X-My-Header: something or other...
26978 .endd
26979 If more than one header line is supplied in a single &%add_header%& modifier,
26980 each one is treated independently and can therefore be placed differently. If
26981 you add more than one line at the start, or after the Received: block, they end
26982 up in reverse order.
26983
26984 &*Warning*&: This facility currently applies only to header lines that are
26985 added in an ACL. It does NOT work for header lines that are added in a
26986 system filter or in a router or transport.
26987
26988
26989
26990
26991 .section "ACL conditions" "SECTaclconditions"
26992 .cindex "&ACL;" "conditions; list of"
26993 Some of conditions listed in this section are available only when Exim is
26994 compiled with the content-scanning extension. They are included here briefly
26995 for completeness. More detailed descriptions can be found in the discussion on
26996 content scanning in chapter &<<CHAPexiscan>>&.
26997
26998 Not all conditions are relevant in all circumstances. For example, testing
26999 senders and recipients does not make sense in an ACL that is being run as the
27000 result of the arrival of an ETRN command, and checks on message headers can be
27001 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27002 can use the same condition (with different parameters) more than once in the
27003 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27004 The conditions are as follows:
27005
27006
27007 .vlist
27008 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27009 .cindex "&ACL;" "nested"
27010 .cindex "&ACL;" "indirect"
27011 .cindex "&%acl%& ACL condition"
27012 The possible values of the argument are the same as for the
27013 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27014 &"accept"& the condition is true; if it returns &"deny"& the condition is
27015 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27016 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27017 condition false. This means that further processing of the &%warn%& verb
27018 ceases, but processing of the ACL continues.
27019
27020 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27021 the connection is dropped. If it returns &"discard"&, the verb must be
27022 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27023 conditions are tested.
27024
27025 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27026 loops. This condition allows you to use different ACLs in different
27027 circumstances. For example, different ACLs can be used to handle RCPT commands
27028 for different local users or different local domains.
27029
27030 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27031 .cindex "&%authenticated%& ACL condition"
27032 .cindex "authentication" "ACL checking"
27033 .cindex "&ACL;" "testing for authentication"
27034 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27035 the name of the authenticator is tested against the list. To test for
27036 authentication by any authenticator, you can set
27037 .code
27038 authenticated = *
27039 .endd
27040
27041 .vitem &*condition&~=&~*&<&'string'&>
27042 .cindex "&%condition%& ACL condition"
27043 .cindex "customizing" "ACL condition"
27044 .cindex "&ACL;" "customized test"
27045 .cindex "&ACL;" "testing, customized"
27046 This feature allows you to make up custom conditions. If the result of
27047 expanding the string is an empty string, the number zero, or one of the strings
27048 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27049 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27050 any other value, some error is assumed to have occurred, and the ACL returns
27051 &"defer"&. However, if the expansion is forced to fail, the condition is
27052 ignored. The effect is to treat it as true, whether it is positive or
27053 negative.
27054
27055 .vitem &*decode&~=&~*&<&'location'&>
27056 .cindex "&%decode%& ACL condition"
27057 This condition is available only when Exim is compiled with the
27058 content-scanning extension, and it is allowed only in the ACL defined by
27059 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27060 If all goes well, the condition is true. It is false only if there are
27061 problems such as a syntax error or a memory shortage. For more details, see
27062 chapter &<<CHAPexiscan>>&.
27063
27064 .vitem &*demime&~=&~*&<&'extension&~list'&>
27065 .cindex "&%demime%& ACL condition"
27066 This condition is available only when Exim is compiled with the
27067 content-scanning extension. Its use is described in section
27068 &<<SECTdemimecond>>&.
27069
27070 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27071 .cindex "&%dnslists%& ACL condition"
27072 .cindex "DNS list" "in ACL"
27073 .cindex "black list (DNS)"
27074 .cindex "&ACL;" "testing a DNS list"
27075 This condition checks for entries in DNS black lists. These are also known as
27076 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27077 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27078 different variants of this condition to describe briefly here. See sections
27079 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27080
27081 .vitem &*domains&~=&~*&<&'domain&~list'&>
27082 .cindex "&%domains%& ACL condition"
27083 .cindex "domain" "ACL checking"
27084 .cindex "&ACL;" "testing a recipient domain"
27085 .vindex "&$domain_data$&"
27086 This condition is relevant only after a RCPT command. It checks that the domain
27087 of the recipient address is in the domain list. If percent-hack processing is
27088 enabled, it is done before this test is done. If the check succeeds with a
27089 lookup, the result of the lookup is placed in &$domain_data$& until the next
27090 &%domains%& test.
27091
27092 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27093 use &%domains%& in a DATA ACL.
27094
27095
27096 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27097 .cindex "&%encrypted%& ACL condition"
27098 .cindex "encryption" "checking in an ACL"
27099 .cindex "&ACL;" "testing for encryption"
27100 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27101 name of the cipher suite in use is tested against the list. To test for
27102 encryption without testing for any specific cipher suite(s), set
27103 .code
27104 encrypted = *
27105 .endd
27106
27107
27108 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
27109 .cindex "&%hosts%& ACL condition"
27110 .cindex "host" "ACL checking"
27111 .cindex "&ACL;" "testing the client host"
27112 This condition tests that the calling host matches the host list. If you have
27113 name lookups or wildcarded host names and IP addresses in the same host list,
27114 you should normally put the IP addresses first. For example, you could have:
27115 .code
27116 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27117 .endd
27118 The lookup in this example uses the host name for its key. This is implied by
27119 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27120 and it wouldn't matter which way round you had these two items.)
27121
27122 The reason for the problem with host names lies in the left-to-right way that
27123 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27124 but when it reaches an item that requires a host name, it fails if it cannot
27125 find a host name to compare with the pattern. If the above list is given in the
27126 opposite order, the &%accept%& statement fails for a host whose name cannot be
27127 found, even if its IP address is 10.9.8.7.
27128
27129 If you really do want to do the name check first, and still recognize the IP
27130 address even if the name lookup fails, you can rewrite the ACL like this:
27131 .code
27132 accept hosts = dbm;/etc/friendly/hosts
27133 accept hosts = 10.9.8.7
27134 .endd
27135 The default action on failing to find the host name is to assume that the host
27136 is not in the list, so the first &%accept%& statement fails. The second
27137 statement can then check the IP address.
27138
27139 .vindex "&$host_data$&"
27140 If a &%hosts%& condition is satisfied by means of a lookup, the result
27141 of the lookup is made available in the &$host_data$& variable. This
27142 allows you, for example, to set up a statement like this:
27143 .code
27144 deny  hosts = net-lsearch;/some/file
27145 message = $host_data
27146 .endd
27147 which gives a custom error message for each denied host.
27148
27149 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27150 .cindex "&%local_parts%& ACL condition"
27151 .cindex "local part" "ACL checking"
27152 .cindex "&ACL;" "testing a local part"
27153 .vindex "&$local_part_data$&"
27154 This condition is relevant only after a RCPT command. It checks that the local
27155 part of the recipient address is in the list. If percent-hack processing is
27156 enabled, it is done before this test. If the check succeeds with a lookup, the
27157 result of the lookup is placed in &$local_part_data$&, which remains set until
27158 the next &%local_parts%& test.
27159
27160 .vitem &*malware&~=&~*&<&'option'&>
27161 .cindex "&%malware%& ACL condition"
27162 .cindex "&ACL;" "virus scanning"
27163 .cindex "&ACL;" "scanning for viruses"
27164 This condition is available only when Exim is compiled with the
27165 content-scanning extension. It causes the incoming message to be scanned for
27166 viruses. For details, see chapter &<<CHAPexiscan>>&.
27167
27168 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27169 .cindex "&%mime_regex%& ACL condition"
27170 .cindex "&ACL;" "testing by regex matching"
27171 This condition is available only when Exim is compiled with the
27172 content-scanning extension, and it is allowed only in the ACL defined by
27173 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27174 with any of the regular expressions. For details, see chapter
27175 &<<CHAPexiscan>>&.
27176
27177 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27178 .cindex "rate limiting"
27179 This condition can be used to limit the rate at which a user or host submits
27180 messages. Details are given in section &<<SECTratelimiting>>&.
27181
27182 .vitem &*recipients&~=&~*&<&'address&~list'&>
27183 .cindex "&%recipients%& ACL condition"
27184 .cindex "recipient" "ACL checking"
27185 .cindex "&ACL;" "testing a recipient"
27186 This condition is relevant only after a RCPT command. It checks the entire
27187 recipient address against a list of recipients.
27188
27189 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27190 .cindex "&%regex%& ACL condition"
27191 .cindex "&ACL;" "testing by regex matching"
27192 This condition is available only when Exim is compiled with the
27193 content-scanning extension, and is available only in the DATA, MIME, and
27194 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27195 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27196
27197 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27198 .cindex "&%sender_domains%& ACL condition"
27199 .cindex "sender" "ACL checking"
27200 .cindex "&ACL;" "testing a sender domain"
27201 .vindex "&$domain$&"
27202 .vindex "&$sender_address_domain$&"
27203 This condition tests the domain of the sender of the message against the given
27204 domain list. &*Note*&: The domain of the sender address is in
27205 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27206 of this condition. This is an exception to the general rule for testing domain
27207 lists. It is done this way so that, if this condition is used in an ACL for a
27208 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27209 influence the sender checking.
27210
27211 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27212 relaying, because sender addresses are easily, and commonly, forged.
27213
27214 .vitem &*senders&~=&~*&<&'address&~list'&>
27215 .cindex "&%senders%& ACL condition"
27216 .cindex "sender" "ACL checking"
27217 .cindex "&ACL;" "testing a sender"
27218 This condition tests the sender of the message against the given list. To test
27219 for a bounce message, which has an empty sender, set
27220 .code
27221 senders = :
27222 .endd
27223 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27224 relaying, because sender addresses are easily, and commonly, forged.
27225
27226 .vitem &*spam&~=&~*&<&'username'&>
27227 .cindex "&%spam%& ACL condition"
27228 .cindex "&ACL;" "scanning for spam"
27229 This condition is available only when Exim is compiled with the
27230 content-scanning extension. It causes the incoming message to be scanned by
27231 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27232
27233 .vitem &*verify&~=&~certificate*&
27234 .cindex "&%verify%& ACL condition"
27235 .cindex "TLS" "client certificate verification"
27236 .cindex "certificate" "verification of client"
27237 .cindex "&ACL;" "certificate verification"
27238 .cindex "&ACL;" "testing a TLS certificate"
27239 This condition is true in an SMTP session if the session is encrypted, and a
27240 certificate was received from the client, and the certificate was verified. The
27241 server requests a certificate only if the client matches &%tls_verify_hosts%&
27242 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27243
27244 .vitem &*verify&~=&~csa*&
27245 .cindex "CSA verification"
27246 This condition checks whether the sending host (the client) is authorized to
27247 send email. Details of how this works are given in section
27248 &<<SECTverifyCSA>>&.
27249
27250 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27251 .cindex "&%verify%& ACL condition"
27252 .cindex "&ACL;" "verifying sender in the header"
27253 .cindex "header lines" "verifying the sender in"
27254 .cindex "sender" "verifying in header"
27255 .cindex "verifying" "sender in header"
27256 This condition is relevant only in an ACL that is run after a message has been
27257 received, that is, in an ACL specified by &%acl_smtp_data%& or
27258 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27259 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27260 is loosely thought of as a &"sender"& address (hence the name of the test).
27261 However, an address that appears in one of these headers need not be an address
27262 that accepts bounce messages; only sender addresses in envelopes are required
27263 to accept bounces. Therefore, if you use the callout option on this check, you
27264 might want to arrange for a non-empty address in the MAIL command.
27265
27266 Details of address verification and the options are given later, starting at
27267 section &<<SECTaddressverification>>& (callouts are described in section
27268 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27269 condition to restrict it to bounce messages only:
27270 .code
27271 deny    senders = :
27272         message = A valid sender header is required for bounces
27273        !verify  = header_sender
27274 .endd
27275
27276 .vitem &*verify&~=&~header_syntax*&
27277 .cindex "&%verify%& ACL condition"
27278 .cindex "&ACL;" "verifying header syntax"
27279 .cindex "header lines" "verifying syntax"
27280 .cindex "verifying" "header syntax"
27281 This condition is relevant only in an ACL that is run after a message has been
27282 received, that is, in an ACL specified by &%acl_smtp_data%& or
27283 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27284 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27285 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27286 permitted only in locally generated messages and from hosts that match
27287 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27288 appropriate.
27289
27290 Note that this condition is a syntax check only. However, a common spamming
27291 ploy used to be to send syntactically invalid headers such as
27292 .code
27293 To: @
27294 .endd
27295 and this condition can be used to reject such messages, though they are not as
27296 common as they used to be.
27297
27298 .vitem &*verify&~=&~helo*&
27299 .cindex "&%verify%& ACL condition"
27300 .cindex "&ACL;" "verifying HELO/EHLO"
27301 .cindex "HELO" "verifying"
27302 .cindex "EHLO" "verifying"
27303 .cindex "verifying" "EHLO"
27304 .cindex "verifying" "HELO"
27305 This condition is true if a HELO or EHLO command has been received from the
27306 client host, and its contents have been verified. If there has been no previous
27307 attempt to verify the HELO/EHLO contents, it is carried out when this
27308 condition is encountered. See the description of the &%helo_verify_hosts%& and
27309 &%helo_try_verify_hosts%& options for details of how to request verification
27310 independently of this condition.
27311
27312 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27313 option), this condition is always true.
27314
27315
27316 .vitem &*verify&~=&~not_blind*&
27317 .cindex "verifying" "not blind"
27318 .cindex "bcc recipients, verifying none"
27319 This condition checks that there are no blind (bcc) recipients in the message.
27320 Every envelope recipient must appear either in a &'To:'& header line or in a
27321 &'Cc:'& header line for this condition to be true. Local parts are checked
27322 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27323 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27324 used only in a DATA or non-SMTP ACL.
27325
27326 There are, of course, many legitimate messages that make use of blind (bcc)
27327 recipients. This check should not be used on its own for blocking messages.
27328
27329
27330 .vitem &*verify&~=&~recipient/*&<&'options'&>
27331 .cindex "&%verify%& ACL condition"
27332 .cindex "&ACL;" "verifying recipient"
27333 .cindex "recipient" "verifying"
27334 .cindex "verifying" "recipient"
27335 .vindex "&$address_data$&"
27336 This condition is relevant only after a RCPT command. It verifies the current
27337 recipient. Details of address verification are given later, starting at section
27338 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27339 of &$address_data$& is the last value that was set while routing the address.
27340 This applies even if the verification fails. When an address that is being
27341 verified is redirected to a single address, verification continues with the new
27342 address, and in that case, the subsequent value of &$address_data$& is the
27343 value for the child address.
27344
27345 .vitem &*verify&~=&~reverse_host_lookup*&
27346 .cindex "&%verify%& ACL condition"
27347 .cindex "&ACL;" "verifying host reverse lookup"
27348 .cindex "host" "verifying reverse lookup"
27349 This condition ensures that a verified host name has been looked up from the IP
27350 address of the client host. (This may have happened already if the host name
27351 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27352 Verification ensures that the host name obtained from a reverse DNS lookup, or
27353 one of its aliases, does, when it is itself looked up in the DNS, yield the
27354 original IP address.
27355
27356 If this condition is used for a locally generated message (that is, when there
27357 is no client host involved), it always succeeds.
27358
27359 .vitem &*verify&~=&~sender/*&<&'options'&>
27360 .cindex "&%verify%& ACL condition"
27361 .cindex "&ACL;" "verifying sender"
27362 .cindex "sender" "verifying"
27363 .cindex "verifying" "sender"
27364 This condition is relevant only after a MAIL or RCPT command, or after a
27365 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27366 the message's sender is empty (that is, this is a bounce message), the
27367 condition is true. Otherwise, the sender address is verified.
27368
27369 .vindex "&$address_data$&"
27370 .vindex "&$sender_address_data$&"
27371 If there is data in the &$address_data$& variable at the end of routing, its
27372 value is placed in &$sender_address_data$& at the end of verification. This
27373 value can be used in subsequent conditions and modifiers in the same ACL
27374 statement. It does not persist after the end of the current statement. If you
27375 want to preserve the value for longer, you can save it in an ACL variable.
27376
27377 Details of verification are given later, starting at section
27378 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
27379 to avoid doing it more than once per message.
27380
27381 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
27382 .cindex "&%verify%& ACL condition"
27383 This is a variation of the previous option, in which a modified address is
27384 verified as a sender.
27385 .endlist
27386
27387
27388
27389 .section "Using DNS lists" "SECTmorednslists"
27390 .cindex "DNS list" "in ACL"
27391 .cindex "black list (DNS)"
27392 .cindex "&ACL;" "testing a DNS list"
27393 In its simplest form, the &%dnslists%& condition tests whether the calling host
27394 is on at least one of a number of DNS lists by looking up the inverted IP
27395 address in one or more DNS domains. (Note that DNS list domains are not mail
27396 domains, so the &`+`& syntax for named lists doesn't work - it is used for
27397 special options instead.) For example, if the calling host's IP
27398 address is 192.168.62.43, and the ACL statement is
27399 .code
27400 deny dnslists = blackholes.mail-abuse.org : \
27401                 dialups.mail-abuse.org
27402 .endd
27403 the following records are looked up:
27404 .code
27405 43.62.168.192.blackholes.mail-abuse.org
27406 43.62.168.192.dialups.mail-abuse.org
27407 .endd
27408 As soon as Exim finds an existing DNS record, processing of the list stops.
27409 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
27410 to test that a host is on more than one list (an &"and"& conjunction), you can
27411 use two separate conditions:
27412 .code
27413 deny dnslists = blackholes.mail-abuse.org
27414      dnslists = dialups.mail-abuse.org
27415 .endd
27416 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
27417 behaves as if the host does not match the list item, that is, as if the DNS
27418 record does not exist. If there are further items in the DNS list, they are
27419 processed.
27420
27421 This is usually the required action when &%dnslists%& is used with &%deny%&
27422 (which is the most common usage), because it prevents a DNS failure from
27423 blocking mail. However, you can change this behaviour by putting one of the
27424 following special items in the list:
27425 .display
27426 &`+include_unknown `&   behave as if the item is on the list
27427 &`+exclude_unknown `&   behave as if the item is not on the list (default)
27428 &`+defer_unknown   `&   give a temporary error
27429 .endd
27430 .cindex "&`+include_unknown`&"
27431 .cindex "&`+exclude_unknown`&"
27432 .cindex "&`+defer_unknown`&"
27433 Each of these applies to any subsequent items on the list. For example:
27434 .code
27435 deny dnslists = +defer_unknown : foo.bar.example
27436 .endd
27437 Testing the list of domains stops as soon as a match is found. If you want to
27438 warn for one list and block for another, you can use two different statements:
27439 .code
27440 deny  dnslists = blackholes.mail-abuse.org
27441 warn  message  = X-Warn: sending host is on dialups list
27442       dnslists = dialups.mail-abuse.org
27443 .endd
27444 DNS list lookups are cached by Exim for the duration of the SMTP session,
27445 so a lookup based on the IP address is done at most once for any incoming
27446 connection. Exim does not share information between multiple incoming
27447 connections (but your local name server cache should be active).
27448
27449
27450
27451 .section "Specifying the IP address for a DNS list lookup" "SECID201"
27452 .cindex "DNS list" "keyed by explicit IP address"
27453 By default, the IP address that is used in a DNS list lookup is the IP address
27454 of the calling host. However, you can specify another IP address by listing it
27455 after the domain name, introduced by a slash. For example:
27456 .code
27457 deny dnslists = black.list.tld/192.168.1.2
27458 .endd
27459 This feature is not very helpful with explicit IP addresses; it is intended for
27460 use with IP addresses that are looked up, for example, the IP addresses of the
27461 MX hosts or nameservers of an email sender address. For an example, see section
27462 &<<SECTmulkeyfor>>& below.
27463
27464
27465
27466
27467 .section "DNS lists keyed on domain names" "SECID202"
27468 .cindex "DNS list" "keyed by domain name"
27469 There are some lists that are keyed on domain names rather than inverted IP
27470 addresses (see for example the &'domain based zones'& link at
27471 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
27472 with these lists. You can change the name that is looked up in a DNS list by
27473 listing it after the domain name, introduced by a slash. For example,
27474 .code
27475 deny  message  = Sender's domain is listed at $dnslist_domain
27476       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
27477 .endd
27478 This particular example is useful only in ACLs that are obeyed after the
27479 RCPT or DATA commands, when a sender address is available. If (for
27480 example) the message's sender is &'user@tld.example'& the name that is looked
27481 up by this example is
27482 .code
27483 tld.example.dsn.rfc-ignorant.org
27484 .endd
27485 A single &%dnslists%& condition can contain entries for both names and IP
27486 addresses. For example:
27487 .code
27488 deny dnslists = sbl.spamhaus.org : \
27489                 dsn.rfc-ignorant.org/$sender_address_domain
27490 .endd
27491 The first item checks the sending host's IP address; the second checks a domain
27492 name. The whole condition is true if either of the DNS lookups succeeds.
27493
27494
27495
27496
27497 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
27498 .cindex "DNS list" "multiple keys for"
27499 The syntax described above for looking up explicitly-defined values (either
27500 names or IP addresses) in a DNS blacklist is a simplification. After the domain
27501 name for the DNS list, what follows the slash can in fact be a list of items.
27502 As with all lists in Exim, the default separator is a colon. However, because
27503 this is a sublist within the list of DNS blacklist domains, it is necessary
27504 either to double the separators like this:
27505 .code
27506 dnslists = black.list.tld/name.1::name.2
27507 .endd
27508 or to change the separator character, like this:
27509 .code
27510 dnslists = black.list.tld/<;name.1;name.2
27511 .endd
27512 If an item in the list is an IP address, it is inverted before the DNS
27513 blacklist domain is appended. If it is not an IP address, no inversion
27514 occurs. Consider this condition:
27515 .code
27516 dnslists = black.list.tld/<;192.168.1.2;a.domain
27517 .endd
27518 The DNS lookups that occur are:
27519 .code
27520 2.1.168.192.black.list.tld
27521 a.domain.black.list.tld
27522 .endd
27523 Once a DNS record has been found (that matches a specific IP return
27524 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
27525 are done. If there is a temporary DNS error, the rest of the sublist of domains
27526 or IP addresses is tried. A temporary error for the whole dnslists item occurs
27527 only if no other DNS lookup in this sublist succeeds. In other words, a
27528 successful lookup for any of the items in the sublist overrides a temporary
27529 error for a previous item.
27530
27531 The ability to supply a list of items after the slash is in some sense just a
27532 syntactic convenience. These two examples have the same effect:
27533 .code
27534 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
27535 dnslists = black.list.tld/a.domain::b.domain
27536 .endd
27537 However, when the data for the list is obtained from a lookup, the second form
27538 is usually much more convenient. Consider this example:
27539 .code
27540 deny message  = The mail servers for the domain \
27541                 $sender_address_domain \
27542                 are listed at $dnslist_domain ($dnslist_value); \
27543                 see $dnslist_text.
27544      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
27545                                    ${lookup dnsdb {>|mxh=\
27546                                    $sender_address_domain} }} }
27547 .endd
27548 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
27549 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
27550 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
27551 of expanding the condition might be something like this:
27552 .code
27553 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
27554 .endd
27555 Thus, this example checks whether or not the IP addresses of the sender
27556 domain's mail servers are on the Spamhaus black list.
27557
27558 The key that was used for a successful DNS list lookup is put into the variable
27559 &$dnslist_matched$& (see section &<<SECID204>>&).
27560
27561
27562
27563
27564 .section "Data returned by DNS lists" "SECID203"
27565 .cindex "DNS list" "data returned from"
27566 DNS lists are constructed using address records in the DNS. The original RBL
27567 just used the address 127.0.0.1 on the right hand side of each record, but the
27568 RBL+ list and some other lists use a number of values with different meanings.
27569 The values used on the RBL+ list are:
27570 .display
27571 127.1.0.1  RBL
27572 127.1.0.2  DUL
27573 127.1.0.3  DUL and RBL
27574 127.1.0.4  RSS
27575 127.1.0.5  RSS and RBL
27576 127.1.0.6  RSS and DUL
27577 127.1.0.7  RSS and DUL and RBL
27578 .endd
27579 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
27580 different values. Some DNS lists may return more than one address record;
27581 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
27582
27583
27584 .section "Variables set from DNS lists" "SECID204"
27585 .cindex "expansion" "variables, set from DNS list"
27586 .cindex "DNS list" "variables set from"
27587 .vindex "&$dnslist_domain$&"
27588 .vindex "&$dnslist_matched$&"
27589 .vindex "&$dnslist_text$&"
27590 .vindex "&$dnslist_value$&"
27591 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
27592 the name of the overall domain that matched (for example,
27593 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
27594 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
27595 the DNS record. When the key is an IP address, it is not reversed in
27596 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
27597 cases, for example:
27598 .code
27599 deny dnslists = spamhaus.example
27600 .endd
27601 the key is also available in another variable (in this case,
27602 &$sender_host_address$&). In more complicated cases, however, this is not true.
27603 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
27604 might generate a dnslists lookup like this:
27605 .code
27606 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
27607 .endd
27608 If this condition succeeds, the value in &$dnslist_matched$& might be
27609 &`192.168.6.7`& (for example).
27610
27611 If more than one address record is returned by the DNS lookup, all the IP
27612 addresses are included in &$dnslist_value$&, separated by commas and spaces.
27613 The variable &$dnslist_text$& contains the contents of any associated TXT
27614 record. For lists such as RBL+ the TXT record for a merged entry is often not
27615 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
27616 information.
27617
27618 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
27619 &-- although these appear before the condition in the ACL, they are not
27620 expanded until after it has failed. For example:
27621 .code
27622 deny    hosts = !+local_networks
27623         message = $sender_host_address is listed \
27624                   at $dnslist_domain
27625         dnslists = rbl-plus.mail-abuse.example
27626 .endd
27627
27628
27629
27630 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
27631 .cindex "DNS list" "matching specific returned data"
27632 You can add an equals sign and an IP address after a &%dnslists%& domain name
27633 in order to restrict its action to DNS records with a matching right hand side.
27634 For example,
27635 .code
27636 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
27637 .endd
27638 rejects only those hosts that yield 127.0.0.2. Without this additional data,
27639 any address record is considered to be a match. For the moment, we assume
27640 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
27641 describes how multiple records are handled.
27642
27643 More than one IP address may be given for checking, using a comma as a
27644 separator. These are alternatives &-- if any one of them matches, the
27645 &%dnslists%& condition is true. For example:
27646 .code
27647 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27648 .endd
27649 If you want to specify a constraining address list and also specify names or IP
27650 addresses to be looked up, the constraining address list must be specified
27651 first. For example:
27652 .code
27653 deny dnslists = dsn.rfc-ignorant.org\
27654                 =127.0.0.2/$sender_address_domain
27655 .endd
27656
27657 If the character &`&&`& is used instead of &`=`&, the comparison for each
27658 listed IP address is done by a bitwise &"and"& instead of by an equality test.
27659 In other words, the listed addresses are used as bit masks. The comparison is
27660 true if all the bits in the mask are present in the address that is being
27661 tested. For example:
27662 .code
27663 dnslists = a.b.c&0.0.0.3
27664 .endd
27665 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
27666 want to test whether one bit or another bit is present (as opposed to both
27667 being present), you must use multiple values. For example:
27668 .code
27669 dnslists = a.b.c&0.0.0.1,0.0.0.2
27670 .endd
27671 matches if the final component of the address is an odd number or two times
27672 an odd number.
27673
27674
27675
27676 .section "Negated DNS matching conditions" "SECID205"
27677 You can supply a negative list of IP addresses as part of a &%dnslists%&
27678 condition. Whereas
27679 .code
27680 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27681 .endd
27682 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27683 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
27684 .code
27685 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
27686 .endd
27687 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27688 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
27689 words, the result of the test is inverted if an exclamation mark appears before
27690 the &`=`& (or the &`&&`&) sign.
27691
27692 &*Note*&: This kind of negation is not the same as negation in a domain,
27693 host, or address list (which is why the syntax is different).
27694
27695 If you are using just one list, the negation syntax does not gain you much. The
27696 previous example is precisely equivalent to
27697 .code
27698 deny  dnslists = a.b.c
27699      !dnslists = a.b.c=127.0.0.2,127.0.0.3
27700 .endd
27701 However, if you are using multiple lists, the negation syntax is clearer.
27702 Consider this example:
27703 .code
27704 deny  dnslists = sbl.spamhaus.org : \
27705                  list.dsbl.org : \
27706                  dnsbl.njabl.org!=127.0.0.3 : \
27707                  relays.ordb.org
27708 .endd
27709 Using only positive lists, this would have to be:
27710 .code
27711 deny  dnslists = sbl.spamhaus.org : \
27712                  list.dsbl.org
27713 deny  dnslists = dnsbl.njabl.org
27714      !dnslists = dnsbl.njabl.org=127.0.0.3
27715 deny  dnslists = relays.ordb.org
27716 .endd
27717 which is less clear, and harder to maintain.
27718
27719
27720
27721
27722 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
27723 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
27724 thereby providing more than one IP address. When an item in a &%dnslists%& list
27725 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
27726 the match to specific results from the DNS lookup, there are two ways in which
27727 the checking can be handled. For example, consider the condition:
27728 .code
27729 dnslists = a.b.c=127.0.0.1
27730 .endd
27731 What happens if the DNS lookup for the incoming IP address yields both
27732 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
27733 condition true because at least one given value was found, or is it false
27734 because at least one of the found values was not listed? And how does this
27735 affect negated conditions? Both possibilities are provided for with the help of
27736 additional separators &`==`& and &`=&&`&.
27737
27738 .ilist
27739 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
27740 IP addresses matches one of the listed addresses. For the example above, the
27741 condition is true because 127.0.0.1 matches.
27742 .next
27743 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
27744 looked up IP addresses matches one of the listed addresses. If the condition is
27745 changed to:
27746 .code
27747 dnslists = a.b.c==127.0.0.1
27748 .endd
27749 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27750 false because 127.0.0.2 is not listed. You would need to have:
27751 .code
27752 dnslists = a.b.c==127.0.0.1,127.0.0.2
27753 .endd
27754 for the condition to be true.
27755 .endlist
27756
27757 When &`!`& is used to negate IP address matching, it inverts the result, giving
27758 the precise opposite of the behaviour above. Thus:
27759 .ilist
27760 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
27761 addresses matches one of the listed addresses. Consider:
27762 .code
27763 dnslists = a.b.c!&0.0.0.1
27764 .endd
27765 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27766 false because 127.0.0.1 matches.
27767 .next
27768 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
27769 looked up IP address that does not match. Consider:
27770 .code
27771 dnslists = a.b.c!=&0.0.0.1
27772 .endd
27773 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27774 true, because 127.0.0.2 does not match. You would need to have:
27775 .code
27776 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
27777 .endd
27778 for the condition to be false.
27779 .endlist
27780 When the DNS lookup yields only a single IP address, there is no difference
27781 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
27782
27783
27784
27785
27786 .section "Detailed information from merged DNS lists" "SECTmordetinf"
27787 .cindex "DNS list" "information from merged"
27788 When the facility for restricting the matching IP values in a DNS list is used,
27789 the text from the TXT record that is set in &$dnslist_text$& may not reflect
27790 the true reason for rejection. This happens when lists are merged and the IP
27791 address in the A record is used to distinguish them; unfortunately there is
27792 only one TXT record. One way round this is not to use merged lists, but that
27793 can be inefficient because it requires multiple DNS lookups where one would do
27794 in the vast majority of cases when the host of interest is not on any of the
27795 lists.
27796
27797 A less inefficient way of solving this problem is available. If
27798 two domain names, comma-separated, are given, the second is used first to
27799 do an initial check, making use of any IP value restrictions that are set.
27800 If there is a match, the first domain is used, without any IP value
27801 restrictions, to get the TXT record. As a byproduct of this, there is also
27802 a check that the IP being tested is indeed on the first list. The first
27803 domain is the one that is put in &$dnslist_domain$&. For example:
27804 .code
27805 reject message  = \
27806          rejected because $sender_host_address is blacklisted \
27807          at $dnslist_domain\n$dnslist_text
27808        dnslists = \
27809          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
27810          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27811 .endd
27812 For the first blacklist item, this starts by doing a lookup in
27813 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
27814 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
27815 value, and as long as something is found, it looks for the corresponding TXT
27816 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
27817 The second blacklist item is processed similarly.
27818
27819 If you are interested in more than one merged list, the same list must be
27820 given several times, but because the results of the DNS lookups are cached,
27821 the DNS calls themselves are not repeated. For example:
27822 .code
27823 reject dnslists = \
27824          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27825          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27826          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27827          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27828 .endd
27829 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27830 values matches (or if no record is found), this is the only lookup that is
27831 done. Only if there is a match is one of the more specific lists consulted.
27832
27833
27834
27835 .section "DNS lists and IPv6" "SECTmorednslistslast"
27836 .cindex "IPv6" "DNS black lists"
27837 .cindex "DNS list" "IPv6 usage"
27838 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27839 nibble by nibble. For example, if the calling host's IP address is
27840 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27841 .code
27842 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27843   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27844 .endd
27845 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27846 lists contain wildcard records, intended for IPv4, that interact badly with
27847 IPv6. For example, the DNS entry
27848 .code
27849 *.3.some.list.example.    A    127.0.0.1
27850 .endd
27851 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27852 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27853
27854 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27855 &%condition%& condition, as in this example:
27856 .code
27857 deny   condition = ${if isip4{$sender_host_address}}
27858        dnslists  = some.list.example
27859 .endd
27860
27861 .section "Rate limiting incoming messages" "SECTratelimiting"
27862 .cindex "rate limiting" "client sending"
27863 .cindex "limiting client sending rates"
27864 .oindex "&%smtp_ratelimit_*%&"
27865 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27866 which clients can send email. This is more powerful than the
27867 &%smtp_ratelimit_*%& options, because those options control the rate of
27868 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27869 works across all connections (concurrent and sequential) from the same client
27870 host. The syntax of the &%ratelimit%& condition is:
27871 .display
27872 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27873 .endd
27874 If the average client sending rate is less than &'m'& messages per time
27875 period &'p'& then the condition is false; otherwise it is true.
27876
27877 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27878 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27879 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27880 of &'p'&.
27881
27882 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27883 time interval, for example, &`8h`& for eight hours. A larger time constant
27884 means that it takes Exim longer to forget a client's past behaviour. The
27885 parameter &'m'& is the maximum number of messages that a client is permitted to
27886 send in each time interval. It also specifies the number of messages permitted
27887 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27888 constant, you can allow a client to send more messages in a burst without
27889 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27890 both small, messages must be sent at an even rate.
27891
27892 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27893 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27894 when deploying the &%ratelimit%& ACL condition. The script prints usage
27895 instructions when it is run with no arguments.
27896
27897 The key is used to look up the data for calculating the client's average
27898 sending rate. This data is stored in Exim's spool directory, alongside the
27899 retry and other hints databases. The default key is &$sender_host_address$&,
27900 which means Exim computes the sending rate of each client host IP address.
27901 By changing the key you can change how Exim identifies clients for the purpose
27902 of ratelimiting. For example, to limit the sending rate of each authenticated
27903 user, independent of the computer they are sending from, set the key to
27904 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27905 example, &$authenticated_id$& is only meaningful if the client has
27906 authenticated (which you can check with the &%authenticated%& ACL condition).
27907
27908 The lookup key does not have to identify clients: If you want to limit the
27909 rate at which a recipient receives messages, you can use the key
27910 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27911 ACL.
27912
27913 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
27914 specifies what Exim measures the rate of, for example messages or recipients
27915 or bytes. You can adjust the measurement using the &%unique=%& and/or
27916 &%count=%& options. You can also control when Exim updates the recorded rate
27917 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
27918 separated by a slash, like the other parameters. They may appear in any order.
27919
27920 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
27921 any options that alter the meaning of the stored data. The limit &'m'& is not
27922 stored, so you can alter the configured maximum rate and Exim will still
27923 remember clients' past behaviour. If you change the &%per_*%& mode or add or
27924 remove the &%unique=%& option, the lookup key changes so Exim will forget past
27925 behaviour. The lookup key is not affected by changes to the update mode and
27926 the &%count=%& option.
27927
27928
27929 .section "Ratelimit options for what is being measured" "ratoptmea"
27930 .cindex "rate limiting" "per_* options"
27931 The &%per_conn%& option limits the client's connection rate. It is not
27932 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
27933 &%acl_not_smtp_start%& ACLs.
27934
27935 The &%per_mail%& option limits the client's rate of sending messages. This is
27936 the default if none of the &%per_*%& options is specified. It can be used in
27937 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
27938 &%acl_smtp_data%&, or &%acl_not_smtp%&.
27939
27940 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
27941 the same ACLs as the &%per_mail%& option, though it is best to use this option
27942 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
27943 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
27944 in its MAIL command, which may be inaccurate or completely missing. You can
27945 follow the limit &'m'& in the configuration with K, M, or G to specify limits
27946 in kilobytes, megabytes, or gigabytes, respectively.
27947
27948 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
27949 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27950 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
27951 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
27952 ACLs the rate is updated with the total recipient count in one go. Note that
27953 in either case the rate limiting engine will see a message with many
27954 recipients as a large high-speed burst.
27955
27956 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
27957 number of different recipients that the client has sent messages to in the
27958 last time period. That is, if the client repeatedly sends messages to the same
27959 recipient, its measured rate is not increased. This option can only be used in
27960 &%acl_smtp_rcpt%&.
27961
27962 The &%per_cmd%& option causes Exim to recompute the rate every time the
27963 condition is processed. This can be used to limit the rate of any SMTP
27964 command. If it is used in multiple ACLs it can limit the aggregate rate of
27965 multiple different commands.
27966
27967 The &%count=%& option can be used to alter how much Exim adds to the client's
27968 measured rate. For example, the &%per_byte%& option is equivalent to
27969 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
27970 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
27971 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
27972
27973 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
27974
27975
27976 .section "Ratelimit update modes" "ratoptupd"
27977 .cindex "rate limiting" "reading data without updating"
27978 You can specify one of three options with the &%ratelimit%& condition to
27979 control when its database is updated. This section describes the &%readonly%&
27980 mode, and the next section describes the &%strict%& and &%leaky%& modes.
27981
27982 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
27983 previously-computed rate to check against the limit.
27984
27985 For example, you can test the client's sending rate and deny it access (when
27986 it is too fast) in the connect ACL. If the client passes this check then it
27987 can go on to send a message, in which case its recorded rate will be updated
27988 in the MAIL ACL. Subsequent connections from the same client will check this
27989 new rate.
27990 .code
27991 acl_check_connect:
27992  deny ratelimit = 100 / 5m / readonly
27993     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
27994                   (max $sender_rate_limit)
27995 # ...
27996 acl_check_mail:
27997  warn ratelimit = 100 / 5m / strict
27998     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
27999                   (max $sender_rate_limit)
28000 .endd
28001
28002 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28003 processing a message then it may increase the client's measured rate more than
28004 it should. For example, this will happen if you check the &%per_rcpt%& option
28005 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28006 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28007 multiple update problems by using the &%readonly%& option on later ratelimit
28008 checks.
28009
28010 The &%per_*%& options described above do not make sense in some ACLs. If you
28011 use a &%per_*%& option in an ACL where it is not normally permitted then the
28012 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28013 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28014 next section) so you must specify the &%readonly%& option explicitly.
28015
28016
28017 .section "Ratelimit options for handling fast clients" "ratoptfast"
28018 .cindex "rate limiting" "strict and leaky modes"
28019 If a client's average rate is greater than the maximum, the rate limiting
28020 engine can react in two possible ways, depending on the presence of the
28021 &%strict%& or &%leaky%& update modes. This is independent of the other
28022 counter-measures (such as rejecting the message) that may be specified by the
28023 rest of the ACL.
28024
28025 The &%leaky%& (default) option means that the client's recorded rate is not
28026 updated if it is above the limit. The effect of this is that Exim measures the
28027 client's average rate of successfully sent email, which cannot be greater than
28028 the maximum allowed. If the client is over the limit it may suffer some
28029 counter-measures (as specified in the ACL), but it will still be able to send
28030 email at the configured maximum rate, whatever the rate of its attempts. This
28031 is generally the better choice if you have clients that retry automatically.
28032 For example, it does not prevent a sender with an over-aggressive retry rate
28033 from getting any email through.
28034
28035 The &%strict%& option means that the client's recorded rate is always
28036 updated. The effect of this is that Exim measures the client's average rate
28037 of attempts to send email, which can be much higher than the maximum it is
28038 actually allowed. If the client is over the limit it may be subjected to
28039 counter-measures by the ACL. It must slow down and allow sufficient time to
28040 pass that its computed rate falls below the maximum before it can send email
28041 again. The time (the number of smoothing periods) it must wait and not
28042 attempt to send mail can be calculated with this formula:
28043 .code
28044         ln(peakrate/maxrate)
28045 .endd
28046
28047
28048 .section "Limiting the rate of different events" "ratoptuniq"
28049 .cindex "rate limiting" "counting unique events"
28050 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28051 rate of different events. For example, the &%per_addr%& option uses this
28052 mechanism to count the number of different recipients that the client has
28053 sent messages to in the last time period; it is equivalent to
28054 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28055 measure the rate that a client uses different sender addresses with the
28056 options &`per_mail/unique=$sender_address`&.
28057
28058 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28059 has seen for that key. The whole set is thrown away when it is older than the
28060 rate smoothing period &'p'&, so each different event is counted at most once
28061 per period. In the &%leaky%& update mode, an event that causes the client to
28062 go over the limit is not added to the set, in the same way that the client's
28063 recorded rate is not updated in the same situation.
28064
28065 When you combine the &%unique=%& and &%readonly%& options, the specific
28066 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28067 rate.
28068
28069 The &%unique=%& mechanism needs more space in the ratelimit database than the
28070 other &%ratelimit%& options in order to store the event set. The number of
28071 unique values is potentially as large as the rate limit, so the extra space
28072 required increases with larger limits.
28073
28074 The uniqueification is not perfect: there is a small probability that Exim
28075 will think a new event has happened before. If the sender's rate is less than
28076 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28077 the measured rate can go above the limit, in which case Exim may under-count
28078 events by a significant margin. Fortunately, if the rate is high enough (2.7
28079 times the limit) that the false positive rate goes above 9%, then Exim will
28080 throw away the over-full event set before the measured rate falls below the
28081 limit. Therefore the only harm should be that exceptionally high sending rates
28082 are logged incorrectly; any countermeasures you configure will be as effective
28083 as intended.
28084
28085
28086 .section "Using rate limiting" "useratlim"
28087 Exim's other ACL facilities are used to define what counter-measures are taken
28088 when the rate limit is exceeded. This might be anything from logging a warning
28089 (for example, while measuring existing sending rates in order to define
28090 policy), through time delays to slow down fast senders, up to rejecting the
28091 message. For example:
28092 .code
28093 # Log all senders' rates
28094 warn ratelimit = 0 / 1h / strict
28095      log_message = Sender rate $sender_rate / $sender_rate_period
28096
28097 # Slow down fast senders; note the need to truncate $sender_rate
28098 # at the decimal point.
28099 warn ratelimit = 100 / 1h / per_rcpt / strict
28100      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28101                    $sender_rate_limit }s
28102
28103 # Keep authenticated users under control
28104 deny authenticated = *
28105      ratelimit = 100 / 1d / strict / $authenticated_id
28106
28107 # System-wide rate limit
28108 defer message = Sorry, too busy. Try again later.
28109      ratelimit = 10 / 1s / $primary_hostname
28110
28111 # Restrict incoming rate from each host, with a default
28112 # set using a macro and special cases looked up in a table.
28113 defer message = Sender rate exceeds $sender_rate_limit \
28114                messages per $sender_rate_period
28115      ratelimit = ${lookup {$sender_host_address} \
28116                    cdb {DB/ratelimits.cdb} \
28117                    {$value} {RATELIMIT} }
28118 .endd
28119 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28120 especially with the &%per_rcpt%& option, you may suffer from a performance
28121 bottleneck caused by locking on the ratelimit hints database. Apart from
28122 making your ACLs less complicated, you can reduce the problem by using a
28123 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28124 this means that Exim will lose its hints data after a reboot (including retry
28125 hints, the callout cache, and ratelimit data).
28126
28127
28128
28129 .section "Address verification" "SECTaddressverification"
28130 .cindex "verifying address" "options for"
28131 .cindex "policy control" "address verification"
28132 Several of the &%verify%& conditions described in section
28133 &<<SECTaclconditions>>& cause addresses to be verified. Section
28134 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28135 The verification conditions can be followed by options that modify the
28136 verification process. The options are separated from the keyword and from each
28137 other by slashes, and some of them contain parameters. For example:
28138 .code
28139 verify = sender/callout
28140 verify = recipient/defer_ok/callout=10s,defer_ok
28141 .endd
28142 The first stage of address verification, which always happens, is to run the
28143 address through the routers, in &"verify mode"&. Routers can detect the
28144 difference between verification and routing for delivery, and their actions can
28145 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28146 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28147 The available options are as follows:
28148
28149 .ilist
28150 If the &%callout%& option is specified, successful routing to one or more
28151 remote hosts is followed by a &"callout"& to those hosts as an additional
28152 check. Callouts and their sub-options are discussed in the next section.
28153 .next
28154 If there is a defer error while doing verification routing, the ACL
28155 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28156 options, the condition is forced to be true instead. Note that this is a main
28157 verification option as well as a suboption for callouts.
28158 .next
28159 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28160 discusses the reporting of sender address verification failures.
28161 .next
28162 The &%success_on_redirect%& option causes verification always to succeed
28163 immediately after a successful redirection. By default, if a redirection
28164 generates just one address, that address is also verified. See further
28165 discussion in section &<<SECTredirwhilveri>>&.
28166 .endlist
28167
28168 .cindex "verifying address" "differentiating failures"
28169 .vindex "&$recipient_verify_failure$&"
28170 .vindex "&$sender_verify_failure$&"
28171 .vindex "&$acl_verify_message$&"
28172 After an address verification failure, &$acl_verify_message$& contains the
28173 error message that is associated with the failure. It can be preserved by
28174 coding like this:
28175 .code
28176 warn  !verify = sender
28177        set acl_m0 = $acl_verify_message
28178 .endd
28179 If you are writing your own custom rejection message or log message when
28180 denying access, you can use this variable to include information about the
28181 verification failure.
28182
28183 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28184 appropriate) contains one of the following words:
28185
28186 .ilist
28187 &%qualify%&: The address was unqualified (no domain), and the message
28188 was neither local nor came from an exempted host.
28189 .next
28190 &%route%&: Routing failed.
28191 .next
28192 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28193 occurred at or before the MAIL command (that is, on initial
28194 connection, HELO, or MAIL).
28195 .next
28196 &%recipient%&: The RCPT command in a callout was rejected.
28197 .next
28198 &%postmaster%&: The postmaster check in a callout was rejected.
28199 .endlist
28200
28201 The main use of these variables is expected to be to distinguish between
28202 rejections of MAIL and rejections of RCPT in callouts.
28203
28204
28205
28206
28207 .section "Callout verification" "SECTcallver"
28208 .cindex "verifying address" "by callout"
28209 .cindex "callout" "verification"
28210 .cindex "SMTP" "callout verification"
28211 For non-local addresses, routing verifies the domain, but is unable to do any
28212 checking of the local part. There are situations where some means of verifying
28213 the local part is desirable. One way this can be done is to make an SMTP
28214 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28215 a subsequent host for a recipient address, to see if the host accepts the
28216 address. We use the term &'callout'& to cover both cases. Note that for a
28217 sender address, the callback is not to the client host that is trying to
28218 deliver the message, but to one of the hosts that accepts incoming mail for the
28219 sender's domain.
28220
28221 Exim does not do callouts by default. If you want them to happen, you must
28222 request them by setting appropriate options on the &%verify%& condition, as
28223 described below. This facility should be used with care, because it can add a
28224 lot of resource usage to the cost of verifying an address. However, Exim does
28225 cache the results of callouts, which helps to reduce the cost. Details of
28226 caching are in section &<<SECTcallvercache>>&.
28227
28228 Recipient callouts are usually used only between hosts that are controlled by
28229 the same administration. For example, a corporate gateway host could use
28230 callouts to check for valid recipients on an internal mailserver. A successful
28231 callout does not guarantee that a real delivery to the address would succeed;
28232 on the other hand, a failing callout does guarantee that a delivery would fail.
28233
28234 If the &%callout%& option is present on a condition that verifies an address, a
28235 second stage of verification occurs if the address is successfully routed to
28236 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28237 &(manualroute)& router, where the router specifies the hosts. However, if a
28238 router that does not set up hosts routes to an &(smtp)& transport with a
28239 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28240 &%hosts_override%& set, its hosts are always used, whether or not the router
28241 supplies a host list.
28242
28243 The port that is used is taken from the transport, if it is specified and is a
28244 remote transport. (For routers that do verification only, no transport need be
28245 specified.) Otherwise, the default SMTP port is used. If a remote transport
28246 specifies an outgoing interface, this is used; otherwise the interface is not
28247 specified. Likewise, the text that is used for the HELO command is taken from
28248 the transport's &%helo_data%& option; if there is no transport, the value of
28249 &$smtp_active_hostname$& is used.
28250
28251 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28252 test whether a bounce message could be delivered to the sender address. The
28253 following SMTP commands are sent:
28254 .display
28255 &`HELO `&<&'local host name'&>
28256 &`MAIL FROM:<>`&
28257 &`RCPT TO:`&<&'the address to be tested'&>
28258 &`QUIT`&
28259 .endd
28260 LHLO is used instead of HELO if the transport's &%protocol%& option is
28261 set to &"lmtp"&.
28262
28263 A recipient callout check is similar. By default, it also uses an empty address
28264 for the sender. This default is chosen because most hosts do not make use of
28265 the sender address when verifying a recipient. Using the same address means
28266 that a single cache entry can be used for each recipient. Some sites, however,
28267 do make use of the sender address when verifying. These are catered for by the
28268 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28269
28270 If the response to the RCPT command is a 2&'xx'& code, the verification
28271 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28272 Exim tries the next host, if any. If there is a problem with all the remote
28273 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28274 &%callout%& option is given, in which case the condition is forced to succeed.
28275
28276 .cindex "SMTP" "output flushing, disabling for callout"
28277 A callout may take a little time. For this reason, Exim normally flushes SMTP
28278 output before performing a callout in an ACL, to avoid unexpected timeouts in
28279 clients when the SMTP PIPELINING extension is in use. The flushing can be
28280 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28281
28282
28283
28284
28285 .section "Additional parameters for callouts" "CALLaddparcall"
28286 .cindex "callout" "additional parameters for"
28287 The &%callout%& option can be followed by an equals sign and a number of
28288 optional parameters, separated by commas. For example:
28289 .code
28290 verify = recipient/callout=10s,defer_ok
28291 .endd
28292 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28293 separate verify options, is retained for backwards compatibility, but is now
28294 deprecated. The additional parameters for &%callout%& are as follows:
28295
28296
28297 .vlist
28298 .vitem <&'a&~time&~interval'&>
28299 .cindex "callout" "timeout, specifying"
28300 This specifies the timeout that applies for the callout attempt to each host.
28301 For example:
28302 .code
28303 verify = sender/callout=5s
28304 .endd
28305 The default is 30 seconds. The timeout is used for each response from the
28306 remote host. It is also used for the initial connection, unless overridden by
28307 the &%connect%& parameter.
28308
28309
28310 .vitem &*connect&~=&~*&<&'time&~interval'&>
28311 .cindex "callout" "connection timeout, specifying"
28312 This parameter makes it possible to set a different (usually smaller) timeout
28313 for making the SMTP connection. For example:
28314 .code
28315 verify = sender/callout=5s,connect=1s
28316 .endd
28317 If not specified, this timeout defaults to the general timeout value.
28318
28319 .vitem &*defer_ok*&
28320 .cindex "callout" "defer, action on"
28321 When this parameter is present, failure to contact any host, or any other kind
28322 of temporary error, is treated as success by the ACL. However, the cache is not
28323 updated in this circumstance.
28324
28325 .vitem &*fullpostmaster*&
28326 .cindex "callout" "full postmaster check"
28327 This operates like the &%postmaster%& option (see below), but if the check for
28328 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28329 accordance with the specification in RFC 2821. The RFC states that the
28330 unqualified address &'postmaster'& should be accepted.
28331
28332
28333 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28334 .cindex "callout" "sender when verifying header"
28335 When verifying addresses in header lines using the &%header_sender%&
28336 verification option, Exim behaves by default as if the addresses are envelope
28337 sender addresses from a message. Callout verification therefore tests to see
28338 whether a bounce message could be delivered, by using an empty address in the
28339 MAIL command. However, it is arguable that these addresses might never be used
28340 as envelope senders, and could therefore justifiably reject bounce messages
28341 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28342 address to use in the MAIL command. For example:
28343 .code
28344 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28345 .endd
28346 This parameter is available only for the &%header_sender%& verification option.
28347
28348
28349 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28350 .cindex "callout" "overall timeout, specifying"
28351 This parameter sets an overall timeout for performing a callout verification.
28352 For example:
28353 .code
28354 verify = sender/callout=5s,maxwait=30s
28355 .endd
28356 This timeout defaults to four times the callout timeout for individual SMTP
28357 commands. The overall timeout applies when there is more than one host that can
28358 be tried. The timeout is checked before trying the next host. This prevents
28359 very long delays if there are a large number of hosts and all are timing out
28360 (for example, when network connections are timing out).
28361
28362
28363 .vitem &*no_cache*&
28364 .cindex "callout" "cache, suppressing"
28365 .cindex "caching callout, suppressing"
28366 When this parameter is given, the callout cache is neither read nor updated.
28367
28368 .vitem &*postmaster*&
28369 .cindex "callout" "postmaster; checking"
28370 When this parameter is set, a successful callout check is followed by a similar
28371 check for the local part &'postmaster'& at the same domain. If this address is
28372 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28373 the postmaster check is recorded in a cache record; if it is a failure, this is
28374 used to fail subsequent callouts for the domain without a connection being
28375 made, until the cache record expires.
28376
28377 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
28378 The postmaster check uses an empty sender in the MAIL command by default.
28379 You can use this parameter to do a postmaster check using a different address.
28380 For example:
28381 .code
28382 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
28383 .endd
28384 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
28385 one overrides. The &%postmaster%& parameter is equivalent to this example:
28386 .code
28387 require  verify = sender/callout=postmaster_mailfrom=
28388 .endd
28389 &*Warning*&: The caching arrangements for postmaster checking do not take
28390 account of the sender address. It is assumed that either the empty address or
28391 a fixed non-empty address will be used. All that Exim remembers is that the
28392 postmaster check for the domain succeeded or failed.
28393
28394
28395 .vitem &*random*&
28396 .cindex "callout" "&""random""& check"
28397 When this parameter is set, before doing the normal callout check, Exim does a
28398 check for a &"random"& local part at the same domain. The local part is not
28399 really random &-- it is defined by the expansion of the option
28400 &%callout_random_local_part%&, which defaults to
28401 .code
28402 $primary_hostname-$tod_epoch-testing
28403 .endd
28404 The idea here is to try to determine whether the remote host accepts all local
28405 parts without checking. If it does, there is no point in doing callouts for
28406 specific local parts. If the &"random"& check succeeds, the result is saved in
28407 a cache record, and used to force the current and subsequent callout checks to
28408 succeed without a connection being made, until the cache record expires.
28409
28410 .vitem &*use_postmaster*&
28411 .cindex "callout" "sender for recipient check"
28412 This parameter applies to recipient callouts only. For example:
28413 .code
28414 deny  !verify = recipient/callout=use_postmaster
28415 .endd
28416 .vindex "&$qualify_domain$&"
28417 It causes a non-empty postmaster address to be used in the MAIL command when
28418 performing the callout for the recipient, and also for a &"random"& check if
28419 that is configured. The local part of the address is &`postmaster`& and the
28420 domain is the contents of &$qualify_domain$&.
28421
28422 .vitem &*use_sender*&
28423 This option applies to recipient callouts only. For example:
28424 .code
28425 require  verify = recipient/callout=use_sender
28426 .endd
28427 It causes the message's actual sender address to be used in the MAIL
28428 command when performing the callout, instead of an empty address. There is no
28429 need to use this option unless you know that the called hosts make use of the
28430 sender when checking recipients. If used indiscriminately, it reduces the
28431 usefulness of callout caching.
28432 .endlist
28433
28434 If you use any of the parameters that set a non-empty sender for the MAIL
28435 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
28436 &%use_sender%&), you should think about possible loops. Recipient checking is
28437 usually done between two hosts that are under the same management, and the host
28438 that receives the callouts is not normally configured to do callouts itself.
28439 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
28440 these circumstances.
28441
28442 However, if you use a non-empty sender address for a callout to an arbitrary
28443 host, there is the likelihood that the remote host will itself initiate a
28444 callout check back to your host. As it is checking what appears to be a message
28445 sender, it is likely to use an empty address in MAIL, thus avoiding a
28446 callout loop. However, to be on the safe side it would be best to set up your
28447 own ACLs so that they do not do sender verification checks when the recipient
28448 is the address you use for header sender or postmaster callout checking.
28449
28450 Another issue to think about when using non-empty senders for callouts is
28451 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
28452 by the sender/recipient combination; thus, for any given recipient, many more
28453 actual callouts are performed than when an empty sender or postmaster is used.
28454
28455
28456
28457
28458 .section "Callout caching" "SECTcallvercache"
28459 .cindex "hints database" "callout cache"
28460 .cindex "callout" "cache, description of"
28461 .cindex "caching" "callout"
28462 Exim caches the results of callouts in order to reduce the amount of resources
28463 used, unless you specify the &%no_cache%& parameter with the &%callout%&
28464 option. A hints database called &"callout"& is used for the cache. Two
28465 different record types are used: one records the result of a callout check for
28466 a specific address, and the other records information that applies to the
28467 entire domain (for example, that it accepts the local part &'postmaster'&).
28468
28469 When an original callout fails, a detailed SMTP error message is given about
28470 the failure. However, for subsequent failures use the cache data, this message
28471 is not available.
28472
28473 The expiry times for negative and positive address cache records are
28474 independent, and can be set by the global options &%callout_negative_expire%&
28475 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
28476
28477 If a host gives a negative response to an SMTP connection, or rejects any
28478 commands up to and including
28479 .code
28480 MAIL FROM:<>
28481 .endd
28482 (but not including the MAIL command with a non-empty address),
28483 any callout attempt is bound to fail. Exim remembers such failures in a
28484 domain cache record, which it uses to fail callouts for the domain without
28485 making new connections, until the domain record times out. There are two
28486 separate expiry times for domain cache records:
28487 &%callout_domain_negative_expire%& (default 3h) and
28488 &%callout_domain_positive_expire%& (default 7d).
28489
28490 Domain records expire when the negative expiry time is reached if callouts
28491 cannot be made for the domain, or if the postmaster check failed.
28492 Otherwise, they expire when the positive expiry time is reached. This
28493 ensures that, for example, a host that stops accepting &"random"& local parts
28494 will eventually be noticed.
28495
28496 The callout caching mechanism is based on the domain of the address that is
28497 being tested. If the domain routes to several hosts, it is assumed that their
28498 behaviour will be the same.
28499
28500
28501
28502 .section "Sender address verification reporting" "SECTsenaddver"
28503 .cindex "verifying" "suppressing error details"
28504 See section &<<SECTaddressverification>>& for a general discussion of
28505 verification. When sender verification fails in an ACL, the details of the
28506 failure are given as additional output lines before the 550 response to the
28507 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
28508 you might see:
28509 .code
28510 MAIL FROM:<xyz@abc.example>
28511 250 OK
28512 RCPT TO:<pqr@def.example>
28513 550-Verification failed for <xyz@abc.example>
28514 550-Called:   192.168.34.43
28515 550-Sent:     RCPT TO:<xyz@abc.example>
28516 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
28517 550 Sender verification failed
28518 .endd
28519 If more than one RCPT command fails in the same way, the details are given
28520 only for the first of them. However, some administrators do not want to send
28521 out this much information. You can suppress the details by adding
28522 &`/no_details`& to the ACL statement that requests sender verification. For
28523 example:
28524 .code
28525 verify = sender/no_details
28526 .endd
28527
28528 .section "Redirection while verifying" "SECTredirwhilveri"
28529 .cindex "verifying" "redirection while"
28530 .cindex "address redirection" "while verifying"
28531 A dilemma arises when a local address is redirected by aliasing or forwarding
28532 during verification: should the generated addresses themselves be verified,
28533 or should the successful expansion of the original address be enough to verify
28534 it? By default, Exim takes the following pragmatic approach:
28535
28536 .ilist
28537 When an incoming address is redirected to just one child address, verification
28538 continues with the child address, and if that fails to verify, the original
28539 verification also fails.
28540 .next
28541 When an incoming address is redirected to more than one child address,
28542 verification does not continue. A success result is returned.
28543 .endlist
28544
28545 This seems the most reasonable behaviour for the common use of aliasing as a
28546 way of redirecting different local parts to the same mailbox. It means, for
28547 example, that a pair of alias entries of the form
28548 .code
28549 A.Wol:   aw123
28550 aw123:   :fail: Gone away, no forwarding address
28551 .endd
28552 work as expected, with both local parts causing verification failure. When a
28553 redirection generates more than one address, the behaviour is more like a
28554 mailing list, where the existence of the alias itself is sufficient for
28555 verification to succeed.
28556
28557 It is possible, however, to change the default behaviour so that all successful
28558 redirections count as successful verifications, however many new addresses are
28559 generated. This is specified by the &%success_on_redirect%& verification
28560 option. For example:
28561 .code
28562 require verify = recipient/success_on_redirect/callout=10s
28563 .endd
28564 In this example, verification succeeds if a router generates a new address, and
28565 the callout does not occur, because no address was routed to a remote host.
28566
28567 When verification is being tested via the &%-bv%& option, the treatment of
28568 redirections is as just described, unless the &%-v%& or any debugging option is
28569 also specified. In that case, full verification is done for every generated
28570 address and a report is output for each of them.
28571
28572
28573
28574 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
28575 .cindex "CSA" "verifying"
28576 Client SMTP Authorization is a system that allows a site to advertise
28577 which machines are and are not permitted to send email. This is done by placing
28578 special SRV records in the DNS; these are looked up using the client's HELO
28579 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
28580 Authorization checks in Exim are performed by the ACL condition:
28581 .code
28582 verify = csa
28583 .endd
28584 This fails if the client is not authorized. If there is a DNS problem, or if no
28585 valid CSA SRV record is found, or if the client is authorized, the condition
28586 succeeds. These three cases can be distinguished using the expansion variable
28587 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
28588 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
28589 be likely to cause problems for legitimate email.
28590
28591 The error messages produced by the CSA code include slightly more
28592 detail. If &$csa_status$& is &"defer"&, this may be because of problems
28593 looking up the CSA SRV record, or problems looking up the CSA target
28594 address record. There are four reasons for &$csa_status$& being &"fail"&:
28595
28596 .ilist
28597 The client's host name is explicitly not authorized.
28598 .next
28599 The client's IP address does not match any of the CSA target IP addresses.
28600 .next
28601 The client's host name is authorized but it has no valid target IP addresses
28602 (for example, the target's addresses are IPv6 and the client is using IPv4).
28603 .next
28604 The client's host name has no CSA SRV record but a parent domain has asserted
28605 that all subdomains must be explicitly authorized.
28606 .endlist
28607
28608 The &%csa%& verification condition can take an argument which is the domain to
28609 use for the DNS query. The default is:
28610 .code
28611 verify = csa/$sender_helo_name
28612 .endd
28613 This implementation includes an extension to CSA. If the query domain
28614 is an address literal such as [192.0.2.95], or if it is a bare IP
28615 address, Exim searches for CSA SRV records in the reverse DNS as if
28616 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
28617 meaningful to say:
28618 .code
28619 verify = csa/$sender_host_address
28620 .endd
28621 In fact, this is the check that Exim performs if the client does not say HELO.
28622 This extension can be turned off by setting the main configuration option
28623 &%dns_csa_use_reverse%& to be false.
28624
28625 If a CSA SRV record is not found for the domain itself, a search
28626 is performed through its parent domains for a record which might be
28627 making assertions about subdomains. The maximum depth of this search is limited
28628 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
28629 default. Exim does not look for CSA SRV records in a top level domain, so the
28630 default settings handle HELO domains as long as seven
28631 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
28632 of legitimate HELO domains.
28633
28634 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
28635 direct SRV lookups, this is not sufficient because of the extra parent domain
28636 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
28637 addresses into lookups in the reverse DNS space. The result of a successful
28638 lookup such as:
28639 .code
28640 ${lookup dnsdb {csa=$sender_helo_name}}
28641 .endd
28642 has two space-separated fields: an authorization code and a target host name.
28643 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
28644 authorization required but absent, or &"?"& for unknown.
28645
28646
28647
28648
28649 .section "Bounce address tag validation" "SECTverifyPRVS"
28650 .cindex "BATV, verifying"
28651 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
28652 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
28653 Genuine incoming bounce messages should therefore always be addressed to
28654 recipients that have a valid tag. This scheme is a way of detecting unwanted
28655 bounce messages caused by sender address forgeries (often called &"collateral
28656 spam"&), because the recipients of such messages do not include valid tags.
28657
28658 There are two expansion items to help with the implementation of the BATV
28659 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
28660 the original envelope sender address by using a simple key to add a hash of the
28661 address and some time-based randomizing information. The &%prvs%& expansion
28662 item creates a signed address, and the &%prvscheck%& expansion item checks one.
28663 The syntax of these expansion items is described in section
28664 &<<SECTexpansionitems>>&.
28665
28666 As an example, suppose the secret per-address keys are stored in an MySQL
28667 database. A query to look up the key for an address could be defined as a macro
28668 like this:
28669 .code
28670 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
28671                 WHERE sender='${quote_mysql:$prvscheck_address}'\
28672                 }{$value}}
28673 .endd
28674 Suppose also that the senders who make use of BATV are defined by an address
28675 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
28676 use this:
28677 .code
28678 # Bounces: drop unsigned addresses for BATV senders
28679 deny message = This address does not send an unsigned reverse path
28680      senders = :
28681      recipients = +batv_senders
28682
28683 # Bounces: In case of prvs-signed address, check signature.
28684 deny message = Invalid reverse path signature.
28685      senders = :
28686      condition  = ${prvscheck {$local_part@$domain}\
28687                   {PRVSCHECK_SQL}{1}}
28688      !condition = $prvscheck_result
28689 .endd
28690 The first statement rejects recipients for bounce messages that are addressed
28691 to plain BATV sender addresses, because it is known that BATV senders do not
28692 send out messages with plain sender addresses. The second statement rejects
28693 recipients that are prvs-signed, but with invalid signatures (either because
28694 the key is wrong, or the signature has timed out).
28695
28696 A non-prvs-signed address is not rejected by the second statement, because the
28697 &%prvscheck%& expansion yields an empty string if its first argument is not a
28698 prvs-signed address, thus causing the &%condition%& condition to be false. If
28699 the first argument is a syntactically valid prvs-signed address, the yield is
28700 the third string (in this case &"1"&), whether or not the cryptographic and
28701 timeout checks succeed. The &$prvscheck_result$& variable contains the result
28702 of the checks (empty for failure, &"1"& for success).
28703
28704 There is one more issue you must consider when implementing prvs-signing:
28705 you have to ensure that the routers accept prvs-signed addresses and
28706 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
28707 router to remove the signature with a configuration along these lines:
28708 .code
28709 batv_redirect:
28710   driver = redirect
28711   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
28712 .endd
28713 This works because, if the third argument of &%prvscheck%& is empty, the result
28714 of the expansion of a prvs-signed address is the decoded value of the original
28715 address. This router should probably be the first of your routers that handles
28716 local addresses.
28717
28718 To create BATV-signed addresses in the first place, a transport of this form
28719 can be used:
28720 .code
28721 external_smtp_batv:
28722   driver = smtp
28723   return_path = ${prvs {$return_path} \
28724                        {${lookup mysql{SELECT \
28725                        secret FROM batv_prvs WHERE \
28726                        sender='${quote_mysql:$sender_address}'} \
28727                        {$value}fail}}}
28728 .endd
28729 If no key can be found for the existing return path, no signing takes place.
28730
28731
28732
28733 .section "Using an ACL to control relaying" "SECTrelaycontrol"
28734 .cindex "&ACL;" "relay control"
28735 .cindex "relaying" "control by ACL"
28736 .cindex "policy control" "relay control"
28737 An MTA is said to &'relay'& a message if it receives it from some host and
28738 delivers it directly to another host as a result of a remote address contained
28739 within it. Redirecting a local address via an alias or forward file and then
28740 passing the message on to another host is not relaying,
28741 .cindex "&""percent hack""&"
28742 but a redirection as a result of the &"percent hack"& is.
28743
28744 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
28745 A host which is acting as a gateway or an MX backup is concerned with incoming
28746 relaying from arbitrary hosts to a specific set of domains. On the other hand,
28747 a host which is acting as a smart host for a number of clients is concerned
28748 with outgoing relaying from those clients to the Internet at large. Often the
28749 same host is fulfilling both functions,
28750 . ///
28751 . as illustrated in the diagram below,
28752 . ///
28753 but in principle these two kinds of relaying are entirely independent. What is
28754 not wanted is the transmission of mail from arbitrary remote hosts through your
28755 system to arbitrary domains.
28756
28757
28758 You can implement relay control by means of suitable statements in the ACL that
28759 runs for each RCPT command. For convenience, it is often easiest to use
28760 Exim's named list facility to define the domains and hosts involved. For
28761 example, suppose you want to do the following:
28762
28763 .ilist
28764 Deliver a number of domains to mailboxes on the local host (or process them
28765 locally in some other way). Let's say these are &'my.dom1.example'& and
28766 &'my.dom2.example'&.
28767 .next
28768 Relay mail for a number of other domains for which you are the secondary MX.
28769 These might be &'friend1.example'& and &'friend2.example'&.
28770 .next
28771 Relay mail from the hosts on your local LAN, to whatever domains are involved.
28772 Suppose your LAN is 192.168.45.0/24.
28773 .endlist
28774
28775
28776 In the main part of the configuration, you put the following definitions:
28777 .code
28778 domainlist local_domains = my.dom1.example : my.dom2.example
28779 domainlist relay_domains = friend1.example : friend2.example
28780 hostlist   relay_hosts   = 192.168.45.0/24
28781 .endd
28782 Now you can use these definitions in the ACL that is run for every RCPT
28783 command:
28784 .code
28785 acl_check_rcpt:
28786   accept domains = +local_domains : +relay_domains
28787   accept hosts   = +relay_hosts
28788 .endd
28789 The first statement accepts any RCPT command that contains an address in
28790 the local or relay domains. For any other domain, control passes to the second
28791 statement, which accepts the command only if it comes from one of the relay
28792 hosts. In practice, you will probably want to make your ACL more sophisticated
28793 than this, for example, by including sender and recipient verification. The
28794 default configuration includes a more comprehensive example, which is described
28795 in chapter &<<CHAPdefconfil>>&.
28796
28797
28798
28799 .section "Checking a relay configuration" "SECTcheralcon"
28800 .cindex "relaying" "checking control of"
28801 You can check the relay characteristics of your configuration in the same way
28802 that you can test any ACL behaviour for an incoming SMTP connection, by using
28803 the &%-bh%& option to run a fake SMTP session with which you interact.
28804
28805 For specifically testing for unwanted relaying, the host
28806 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
28807 host from the host on which Exim is running, using the normal telnet port, you
28808 will see a normal telnet connection message and then quite a long delay. Be
28809 patient. The remote host is making an SMTP connection back to your host, and
28810 trying a number of common probes to test for open relay vulnerability. The
28811 results of the tests will eventually appear on your terminal.
28812 .ecindex IIDacl
28813
28814
28815
28816 . ////////////////////////////////////////////////////////////////////////////
28817 . ////////////////////////////////////////////////////////////////////////////
28818
28819 .chapter "Content scanning at ACL time" "CHAPexiscan"
28820 .scindex IIDcosca "content scanning" "at ACL time"
28821 The extension of Exim to include content scanning at ACL time, formerly known
28822 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
28823 was integrated into the main source for Exim release 4.50, and Tom continues to
28824 maintain it. Most of the wording of this chapter is taken from Tom's
28825 specification.
28826
28827 It is also possible to scan the content of messages at other times. The
28828 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
28829 scanning after all the ACLs have run. A transport filter can be used to scan
28830 messages at delivery time (see the &%transport_filter%& option, described in
28831 chapter &<<CHAPtransportgeneric>>&).
28832
28833 If you want to include the ACL-time content-scanning features when you compile
28834 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
28835 &_Local/Makefile_&. When you do that, the Exim binary is built with:
28836
28837 .ilist
28838 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
28839 for all MIME parts for SMTP and non-SMTP messages, respectively.
28840 .next
28841 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
28842 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
28843 run at the end of message reception (the &%acl_smtp_data%& ACL).
28844 .next
28845 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
28846 of messages, or parts of messages, for debugging purposes.
28847 .next
28848 Additional expansion variables that are set in the new ACL and by the new
28849 conditions.
28850 .next
28851 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
28852 .endlist
28853
28854 There is another content-scanning configuration option for &_Local/Makefile_&,
28855 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
28856 condition is compiled, in addition to all the other content-scanning features.
28857
28858 Content-scanning is continually evolving, and new features are still being
28859 added. While such features are still unstable and liable to incompatible
28860 changes, they are made available in Exim by setting options whose names begin
28861 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
28862 this manual. You can find out about them by reading the file called
28863 &_doc/experimental.txt_&.
28864
28865 All the content-scanning facilities work on a MBOX copy of the message that is
28866 temporarily created in a file called:
28867 .display
28868 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
28869 .endd
28870 The &_.eml_& extension is a friendly hint to virus scanners that they can
28871 expect an MBOX-like structure inside that file. The file is created when the
28872 first content scanning facility is called. Subsequent calls to content
28873 scanning conditions open the same file again. The directory is recursively
28874 removed when the &%acl_smtp_data%& ACL has finished running, unless
28875 .code
28876 control = no_mbox_unspool
28877 .endd
28878 has been encountered. When the MIME ACL decodes files, they are put into the
28879 same directory by default.
28880
28881
28882
28883 .section "Scanning for viruses" "SECTscanvirus"
28884 .cindex "virus scanning"
28885 .cindex "content scanning" "for viruses"
28886 .cindex "content scanning" "the &%malware%& condition"
28887 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
28888 It supports a &"generic"& interface to scanners called via the shell, and
28889 specialized interfaces for &"daemon"& type virus scanners, which are resident
28890 in memory and thus are much faster.
28891
28892
28893 .oindex "&%av_scanner%&"
28894 You can set the &%av_scanner%& option in first part of the Exim configuration
28895 file to specify which scanner to use, together with any additional options that
28896 are needed. The basic syntax is as follows:
28897 .display
28898 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28899 .endd
28900 If you do not set &%av_scanner%&, it defaults to
28901 .code
28902 av_scanner = sophie:/var/run/sophie
28903 .endd
28904 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28905 before use. The following scanner types are supported in this release:
28906
28907 .vlist
28908 .vitem &%aveserver%&
28909 .cindex "virus scanners" "Kaspersky"
28910 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28911 at &url(http://www.kaspersky.com). This scanner type takes one option,
28912 which is the path to the daemon's UNIX socket. The default is shown in this
28913 example:
28914 .code
28915 av_scanner = aveserver:/var/run/aveserver
28916 .endd
28917
28918
28919 .vitem &%clamd%&
28920 .cindex "virus scanners" "clamd"
28921 This daemon-type scanner is GPL and free. You can get it at
28922 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28923 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28924 in the MIME ACL. This no longer believed to be necessary. One option is
28925 required: either the path and name of a UNIX socket file, or a hostname or IP
28926 number, and a port, separated by space, as in the second of these examples:
28927 .code
28928 av_scanner = clamd:/opt/clamd/socket
28929 av_scanner = clamd:192.0.2.3 1234
28930 av_scanner = clamd:192.0.2.3 1234:local
28931 .endd
28932 If the value of av_scanner points to a UNIX socket file or contains the local
28933 keyword, then the ClamAV interface will pass a filename containing the data
28934 to be scanned, which will should normally result in less I/O happening and be
28935 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28936 Exim does not assume that there is a common filesystem with the remote host.
28937 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28938 you be running a version of ClamAV prior to 0.95.
28939 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28940 contributing the code for this scanner.
28941
28942 .vitem &%cmdline%&
28943 .cindex "virus scanners" "command line interface"
28944 This is the keyword for the generic command line scanner interface. It can be
28945 used to attach virus scanners that are invoked from the shell. This scanner
28946 type takes 3 mandatory options:
28947
28948 .olist
28949 The full path and name of the scanner binary, with all command line options,
28950 and a placeholder (&`%s`&) for the directory to scan.
28951
28952 .next
28953 A regular expression to match against the STDOUT and STDERR output of the
28954 virus scanner. If the expression matches, a virus was found. You must make
28955 absolutely sure that this expression matches on &"virus found"&. This is called
28956 the &"trigger"& expression.
28957
28958 .next
28959 Another regular expression, containing exactly one pair of parentheses, to
28960 match the name of the virus found in the scanners output. This is called the
28961 &"name"& expression.
28962 .endlist olist
28963
28964 For example, Sophos Sweep reports a virus on a line like this:
28965 .code
28966 Virus 'W32/Magistr-B' found in file ./those.bat
28967 .endd
28968 For the trigger expression, we can match the phrase &"found in file"&. For the
28969 name expression, we want to extract the W32/Magistr-B string, so we can match
28970 for the single quotes left and right of it. Altogether, this makes the
28971 configuration setting:
28972 .code
28973 av_scanner = cmdline:\
28974              /path/to/sweep -ss -all -rec -archive %s:\
28975              found in file:'(.+)'
28976 .endd
28977 .vitem &%drweb%&
28978 .cindex "virus scanners" "DrWeb"
28979 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28980 argument, either a full path to a UNIX socket, or an IP address and port
28981 separated by white space, as in these examples:
28982 .code
28983 av_scanner = drweb:/var/run/drwebd.sock
28984 av_scanner = drweb:192.168.2.20 31337
28985 .endd
28986 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28987 is used. Thanks to Alex Miller for contributing the code for this scanner.
28988
28989 .vitem &%fsecure%&
28990 .cindex "virus scanners" "F-Secure"
28991 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28992 argument which is the path to a UNIX socket. For example:
28993 .code
28994 av_scanner = fsecure:/path/to/.fsav
28995 .endd
28996 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28997 Thelmen for contributing the code for this scanner.
28998
28999 .vitem &%kavdaemon%&
29000 .cindex "virus scanners" "Kaspersky"
29001 This is the scanner daemon of Kaspersky Version 4. This version of the
29002 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29003 scanner type takes one option, which is the path to the daemon's UNIX socket.
29004 For example:
29005 .code
29006 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29007 .endd
29008 The default path is &_/var/run/AvpCtl_&.
29009
29010 .vitem &%mksd%&
29011 .cindex "virus scanners" "mksd"
29012 This is a daemon type scanner that is aimed mainly at Polish users, though some
29013 parts of documentation are now available in English. You can get it at
29014 &url(http://linux.mks.com.pl/). The only option for this scanner type is
29015 the maximum number of processes used simultaneously to scan the attachments,
29016 provided that the demime facility is employed and also provided that mksd has
29017 been run with at least the same number of child processes. For example:
29018 .code
29019 av_scanner = mksd:2
29020 .endd
29021 You can safely omit this option (the default value is 1).
29022
29023 .vitem &%sophie%&
29024 .cindex "virus scanners" "Sophos and Sophie"
29025 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
29026 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
29027 for this scanner type is the path to the UNIX socket that Sophie uses for
29028 client communication. For example:
29029 .code
29030 av_scanner = sophie:/tmp/sophie
29031 .endd
29032 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
29033 the option.
29034 .endlist
29035
29036 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29037 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29038 ACL.
29039
29040 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29041 makes it possible to use different scanners. See further below for an example.
29042 The &%malware%& condition caches its results, so when you use it multiple times
29043 for the same message, the actual scanning process is only carried out once.
29044 However, using expandable items in &%av_scanner%& disables this caching, in
29045 which case each use of the &%malware%& condition causes a new scan of the
29046 message.
29047
29048 The &%malware%& condition takes a right-hand argument that is expanded before
29049 use. It can then be one of
29050
29051 .ilist
29052 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29053 The condition succeeds if a virus was found, and fail otherwise. This is the
29054 recommended usage.
29055 .next
29056 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29057 the condition fails immediately.
29058 .next
29059 A regular expression, in which case the message is scanned for viruses. The
29060 condition succeeds if a virus is found and its name matches the regular
29061 expression. This allows you to take special actions on certain types of virus.
29062 .endlist
29063
29064 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29065 even if there is a problem with the virus scanner. Otherwise, such a problem
29066 causes the ACL to defer.
29067
29068 .vindex "&$malware_name$&"
29069 When a virus is found, the condition sets up an expansion variable called
29070 &$malware_name$& that contains the name of the virus. You can use it in a
29071 &%message%& modifier that specifies the error returned to the sender, and/or in
29072 logging data.
29073
29074 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29075 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29076 &%malware%& condition.
29077
29078 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29079 imposed by your anti-virus scanner.
29080
29081 Here is a very simple scanning example:
29082 .code
29083 deny message = This message contains malware ($malware_name)
29084      demime = *
29085      malware = *
29086 .endd
29087 The next example accepts messages when there is a problem with the scanner:
29088 .code
29089 deny message = This message contains malware ($malware_name)
29090      demime = *
29091      malware = */defer_ok
29092 .endd
29093 The next example shows how to use an ACL variable to scan with both sophie and
29094 aveserver. It assumes you have set:
29095 .code
29096 av_scanner = $acl_m0
29097 .endd
29098 in the main Exim configuration.
29099 .code
29100 deny message = This message contains malware ($malware_name)
29101      set acl_m0 = sophie
29102      malware = *
29103
29104 deny message = This message contains malware ($malware_name)
29105      set acl_m0 = aveserver
29106      malware = *
29107 .endd
29108
29109
29110 .section "Scanning with SpamAssassin" "SECTscanspamass"
29111 .cindex "content scanning" "for spam"
29112 .cindex "spam scanning"
29113 .cindex "SpamAssassin"
29114 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29115 score and a report for the message. You can get SpamAssassin at
29116 &url(http://www.spamassassin.org), or, if you have a working Perl
29117 installation, you can use CPAN by running:
29118 .code
29119 perl -MCPAN -e 'install Mail::SpamAssassin'
29120 .endd
29121 SpamAssassin has its own set of configuration files. Please review its
29122 documentation to see how you can tweak it. The default installation should work
29123 nicely, however.
29124
29125 .oindex "&%spamd_address%&"
29126 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29127 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29128 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29129 part of the Exim configuration as follows (example):
29130 .code
29131 spamd_address = 192.168.99.45 387
29132 .endd
29133 You do not need to set this option if you use the default. As of version 2.60,
29134 &%spamd%& also supports communication over UNIX sockets. If you want to use
29135 these, supply &%spamd_address%& with an absolute file name instead of a
29136 address/port pair:
29137 .code
29138 spamd_address = /var/run/spamd_socket
29139 .endd
29140 You can have multiple &%spamd%& servers to improve scalability. These can
29141 reside on other hardware reachable over the network. To specify multiple
29142 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29143 option, separated with colons:
29144 .code
29145 spamd_address = 192.168.2.10 783 : \
29146                 192.168.2.11 783 : \
29147                 192.168.2.12 783
29148 .endd
29149 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29150 fashion. When a server fails to respond to the connection attempt, all other
29151 servers are tried until one succeeds. If no server responds, the &%spam%&
29152 condition defers.
29153
29154 &*Warning*&: It is not possible to use the UNIX socket connection method with
29155 multiple &%spamd%& servers.
29156
29157 The &%spamd_address%& variable is expanded before use if it starts with
29158 a dollar sign. In this case, the expansion may return a string that is
29159 used as the list so that multiple spamd servers can be the result of an
29160 expansion.
29161
29162 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29163 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29164 .code
29165 deny message = This message was classified as SPAM
29166      spam = joe
29167 .endd
29168 The right-hand side of the &%spam%& condition specifies a name. This is
29169 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29170 to scan using a specific profile, but rather use the SpamAssassin system-wide
29171 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29172 However, you must put something on the right-hand side.
29173
29174 The name allows you to use per-domain or per-user antispam profiles in
29175 principle, but this is not straightforward in practice, because a message may
29176 have multiple recipients, not necessarily all in the same domain. Because the
29177 &%spam%& condition has to be called from a DATA ACL in order to be able to
29178 read the contents of the message, the variables &$local_part$& and &$domain$&
29179 are not set.
29180
29181 The right-hand side of the &%spam%& condition is expanded before being used, so
29182 you can put lookups or conditions there. When the right-hand side evaluates to
29183 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29184
29185
29186 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29187 large ones may cause significant performance degradation. As most spam messages
29188 are quite small, it is recommended that you do not scan the big ones. For
29189 example:
29190 .code
29191 deny message = This message was classified as SPAM
29192      condition = ${if < {$message_size}{10K}}
29193      spam = nobody
29194 .endd
29195
29196 The &%spam%& condition returns true if the threshold specified in the user's
29197 SpamAssassin profile has been matched or exceeded. If you want to use the
29198 &%spam%& condition for its side effects (see the variables below), you can make
29199 it always return &"true"& by appending &`:true`& to the username.
29200
29201 .cindex "spam scanning" "returned variables"
29202 When the &%spam%& condition is run, it sets up a number of expansion
29203 variables. These variables are saved with the received message, thus they are
29204 available for use at delivery time.
29205
29206 .vlist
29207 .vitem &$spam_score$&
29208 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29209 for inclusion in log or reject messages.
29210
29211 .vitem &$spam_score_int$&
29212 The spam score of the message, multiplied by ten, as an integer value. For
29213 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29214 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29215 The integer value is useful for numeric comparisons in conditions.
29216
29217 .vitem &$spam_bar$&
29218 A string consisting of a number of &"+"& or &"-"& characters, representing the
29219 integer part of the spam score value. A spam score of 4.4 would have a
29220 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29221 headers, since MUAs can match on such strings.
29222
29223 .vitem &$spam_report$&
29224 A multiline text table, containing the full SpamAssassin report for the
29225 message. Useful for inclusion in headers or reject messages.
29226 .endlist
29227
29228 The &%spam%& condition caches its results unless expansion in
29229 spamd_address was used. If you call it again with the same user name, it
29230 does not scan again, but rather returns the same values as before.
29231
29232 The &%spam%& condition returns DEFER if there is any error while running
29233 the message through SpamAssassin or if the expansion of spamd_address
29234 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29235 statement block), append &`/defer_ok`& to the right-hand side of the
29236 spam condition, like this:
29237 .code
29238 deny message = This message was classified as SPAM
29239      spam    = joe/defer_ok
29240 .endd
29241 This causes messages to be accepted even if there is a problem with &%spamd%&.
29242
29243 Here is a longer, commented example of the use of the &%spam%&
29244 condition:
29245 .code
29246 # put headers in all messages (no matter if spam or not)
29247 warn  spam = nobody:true
29248       add_header = X-Spam-Score: $spam_score ($spam_bar)
29249       add_header = X-Spam-Report: $spam_report
29250
29251 # add second subject line with *SPAM* marker when message
29252 # is over threshold
29253 warn  spam = nobody
29254       add_header = Subject: *SPAM* $h_Subject:
29255
29256 # reject spam at high scores (> 12)
29257 deny  message = This message scored $spam_score spam points.
29258       spam = nobody:true
29259       condition = ${if >{$spam_score_int}{120}{1}{0}}
29260 .endd
29261
29262
29263
29264 .section "Scanning MIME parts" "SECTscanmimepart"
29265 .cindex "content scanning" "MIME parts"
29266 .cindex "MIME content scanning"
29267 .oindex "&%acl_smtp_mime%&"
29268 .oindex "&%acl_not_smtp_mime%&"
29269 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29270 each MIME part of an SMTP message, including multipart types, in the sequence
29271 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29272 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29273 options may both refer to the same ACL if you want the same processing in both
29274 cases.
29275
29276 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29277 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29278 the case of a non-SMTP message. However, a MIME ACL is called only if the
29279 message contains a &'Content-Type:'& header line. When a call to a MIME
29280 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29281 result code is sent to the client. In the case of an SMTP message, the
29282 &%acl_smtp_data%& ACL is not called when this happens.
29283
29284 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29285 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29286 condition to match against the raw MIME part. You can also use the
29287 &%mime_regex%& condition to match against the decoded MIME part (see section
29288 &<<SECTscanregex>>&).
29289
29290 At the start of a MIME ACL, a number of variables are set from the header
29291 information for the relevant MIME part. These are described below. The contents
29292 of the MIME part are not by default decoded into a disk file except for MIME
29293 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29294 part into a disk file, you can use the &%decode%& condition. The general
29295 syntax is:
29296 .display
29297 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29298 .endd
29299 The right hand side is expanded before use. After expansion,
29300 the value can be:
29301
29302 .olist
29303 &"0"& or &"false"&, in which case no decoding is done.
29304 .next
29305 The string &"default"&. In that case, the file is put in the temporary
29306 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29307 a sequential file name consisting of the message id and a sequence number. The
29308 full path and name is available in &$mime_decoded_filename$& after decoding.
29309 .next
29310 A full path name starting with a slash. If the full name is an existing
29311 directory, it is used as a replacement for the default directory. The filename
29312 is then sequentially assigned. If the path does not exist, it is used as
29313 the full path and file name.
29314 .next
29315 If the string does not start with a slash, it is used as the
29316 filename, and the default path is then used.
29317 .endlist
29318 The &%decode%& condition normally succeeds. It is only false for syntax
29319 errors or unusual circumstances such as memory shortages. You can easily decode
29320 a file with its original, proposed filename using
29321 .code
29322 decode = $mime_filename
29323 .endd
29324 However, you should keep in mind that &$mime_filename$& might contain
29325 anything. If you place files outside of the default path, they are not
29326 automatically unlinked.
29327
29328 For RFC822 attachments (these are messages attached to messages, with a
29329 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29330 as for the primary message, only that the &$mime_is_rfc822$& expansion
29331 variable is set (see below). Attached messages are always decoded to disk
29332 before being checked, and the files are unlinked once the check is done.
29333
29334 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29335 used to match regular expressions against raw and decoded MIME parts,
29336 respectively. They are described in section &<<SECTscanregex>>&.
29337
29338 .cindex "MIME content scanning" "returned variables"
29339 The following list describes all expansion variables that are
29340 available in the MIME ACL:
29341
29342 .vlist
29343 .vitem &$mime_boundary$&
29344 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29345 have a boundary string, which is stored in this variable. If the current part
29346 has no boundary parameter in the &'Content-Type:'& header, this variable
29347 contains the empty string.
29348
29349 .vitem &$mime_charset$&
29350 This variable contains the character set identifier, if one was found in the
29351 &'Content-Type:'& header. Examples for charset identifiers are:
29352 .code
29353 us-ascii
29354 gb2312 (Chinese)
29355 iso-8859-1
29356 .endd
29357 Please note that this value is not normalized, so you should do matches
29358 case-insensitively.
29359
29360 .vitem &$mime_content_description$&
29361 This variable contains the normalized content of the &'Content-Description:'&
29362 header. It can contain a human-readable description of the parts content. Some
29363 implementations repeat the filename for attachments here, but they are usually
29364 only used for display purposes.
29365
29366 .vitem &$mime_content_disposition$&
29367 This variable contains the normalized content of the &'Content-Disposition:'&
29368 header. You can expect strings like &"attachment"& or &"inline"& here.
29369
29370 .vitem &$mime_content_id$&
29371 This variable contains the normalized content of the &'Content-ID:'& header.
29372 This is a unique ID that can be used to reference a part from another part.
29373
29374 .vitem &$mime_content_size$&
29375 This variable is set only after the &%decode%& modifier (see above) has been
29376 successfully run. It contains the size of the decoded part in kilobytes. The
29377 size is always rounded up to full kilobytes, so only a completely empty part
29378 has a &$mime_content_size$& of zero.
29379
29380 .vitem &$mime_content_transfer_encoding$&
29381 This variable contains the normalized content of the
29382 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
29383 type. Typical values are &"base64"& and &"quoted-printable"&.
29384
29385 .vitem &$mime_content_type$&
29386 If the MIME part has a &'Content-Type:'& header, this variable contains its
29387 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
29388 are some examples of popular MIME types, as they may appear in this variable:
29389 .code
29390 text/plain
29391 text/html
29392 application/octet-stream
29393 image/jpeg
29394 audio/midi
29395 .endd
29396 If the MIME part has no &'Content-Type:'& header, this variable contains the
29397 empty string.
29398
29399 .vitem &$mime_decoded_filename$&
29400 This variable is set only after the &%decode%& modifier (see above) has been
29401 successfully run. It contains the full path and file name of the file
29402 containing the decoded data.
29403 .endlist
29404
29405 .cindex "RFC 2047"
29406 .vlist
29407 .vitem &$mime_filename$&
29408 This is perhaps the most important of the MIME variables. It contains a
29409 proposed filename for an attachment, if one was found in either the
29410 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
29411 RFC2047 decoded, but no additional sanity checks are done. If no filename was
29412 found, this variable contains the empty string.
29413
29414 .vitem &$mime_is_coverletter$&
29415 This variable attempts to differentiate the &"cover letter"& of an e-mail from
29416 attached data. It can be used to clamp down on flashy or unnecessarily encoded
29417 content in the cover letter, while not restricting attachments at all.
29418
29419 The variable contains 1 (true) for a MIME part believed to be part of the
29420 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
29421 follows:
29422
29423 .olist
29424 The outermost MIME part of a message is always a cover letter.
29425
29426 .next
29427 If a multipart/alternative or multipart/related MIME part is a cover letter,
29428 so are all MIME subparts within that multipart.
29429
29430 .next
29431 If any other multipart is a cover letter, the first subpart is a cover letter,
29432 and the rest are attachments.
29433
29434 .next
29435 All parts contained within an attachment multipart are attachments.
29436 .endlist olist
29437
29438 As an example, the following will ban &"HTML mail"& (including that sent with
29439 alternative plain text), while allowing HTML files to be attached. HTML
29440 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
29441 .code
29442 deny message = HTML mail is not accepted here
29443 !condition = $mime_is_rfc822
29444 condition = $mime_is_coverletter
29445 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
29446 .endd
29447 .vitem &$mime_is_multipart$&
29448 This variable has the value 1 (true) when the current part has the main type
29449 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
29450 Since multipart entities only serve as containers for other parts, you may not
29451 want to carry out specific actions on them.
29452
29453 .vitem &$mime_is_rfc822$&
29454 This variable has the value 1 (true) if the current part is not a part of the
29455 checked message itself, but part of an attached message. Attached message
29456 decoding is fully recursive.
29457
29458 .vitem &$mime_part_count$&
29459 This variable is a counter that is raised for each processed MIME part. It
29460 starts at zero for the very first part (which is usually a multipart). The
29461 counter is per-message, so it is reset when processing RFC822 attachments (see
29462 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
29463 complete, so you can use it in the DATA ACL to determine the number of MIME
29464 parts of a message. For non-MIME messages, this variable contains the value -1.
29465 .endlist
29466
29467
29468
29469 .section "Scanning with regular expressions" "SECTscanregex"
29470 .cindex "content scanning" "with regular expressions"
29471 .cindex "regular expressions" "content scanning with"
29472 You can specify your own custom regular expression matches on the full body of
29473 the message, or on individual MIME parts.
29474
29475 The &%regex%& condition takes one or more regular expressions as arguments and
29476 matches them against the full message (when called in the DATA ACL) or a raw
29477 MIME part (when called in the MIME ACL). The &%regex%& condition matches
29478 linewise, with a maximum line length of 32K characters. That means you cannot
29479 have multiline matches with the &%regex%& condition.
29480
29481 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
29482 to 32K of decoded content (the whole content at once, not linewise). If the
29483 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
29484 is decoded automatically when &%mime_regex%& is executed (using default path
29485 and filename values). If the decoded data is larger than  32K, only the first
29486 32K characters are checked.
29487
29488 The regular expressions are passed as a colon-separated list. To include a
29489 literal colon, you must double it. Since the whole right-hand side string is
29490 expanded before being used, you must also escape dollar signs and backslashes
29491 with more backslashes, or use the &`\N`& facility to disable expansion.
29492 Here is a simple example that contains two regular expressions:
29493 .code
29494 deny message = contains blacklisted regex ($regex_match_string)
29495      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
29496 .endd
29497 The conditions returns true if any one of the regular expressions matches. The
29498 &$regex_match_string$& expansion variable is then set up and contains the
29499 matching regular expression.
29500
29501 &*Warning*&: With large messages, these conditions can be fairly
29502 CPU-intensive.
29503
29504
29505
29506
29507 .section "The demime condition" "SECTdemimecond"
29508 .cindex "content scanning" "MIME checking"
29509 .cindex "MIME content scanning"
29510 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
29511 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
29512 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
29513 ACL functionality, but provides no additional facilities. Please note that this
29514 condition is deprecated and kept only for backward compatibility. You must set
29515 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
29516 use the &%demime%& condition.
29517
29518 The &%demime%& condition unpacks MIME containers in the message. It detects
29519 errors in MIME containers and can match file extensions found in the message
29520 against a list. Using this facility produces files containing the unpacked MIME
29521 parts of the message in the temporary scan directory. If you do antivirus
29522 scanning, it is recommended that you use the &%demime%& condition before the
29523 antivirus (&%malware%&) condition.
29524
29525 On the right-hand side of the &%demime%& condition you can pass a
29526 colon-separated list of file extensions that it should match against. For
29527 example:
29528 .code
29529 deny message = Found blacklisted file attachment
29530      demime  = vbs:com:bat:pif:prf:lnk
29531 .endd
29532 If one of the file extensions is found, the condition is true, otherwise it is
29533 false. If there is a temporary error while demimeing (for example, &"disk
29534 full"&), the condition defers, and the message is temporarily rejected (unless
29535 the condition is on a &%warn%& verb).
29536
29537 The right-hand side is expanded before being treated as a list, so you can have
29538 conditions and lookups there. If it expands to an empty string, &"false"&, or
29539 zero (&"0"&), no demimeing is done and the condition is false.
29540
29541 The &%demime%& condition set the following variables:
29542
29543 .vlist
29544 .vitem &$demime_errorlevel$&
29545 .vindex "&$demime_errorlevel$&"
29546 When an error is detected in a MIME container, this variable contains the
29547 severity of the error, as an integer number. The higher the value, the more
29548 severe the error (the current maximum value is 3). If this variable is unset or
29549 zero, no error occurred.
29550
29551 .vitem &$demime_reason$&
29552 .vindex "&$demime_reason$&"
29553 When &$demime_errorlevel$& is greater than zero, this variable contains a
29554 human-readable text string describing the MIME error that occurred.
29555 .endlist
29556
29557 .vlist
29558 .vitem &$found_extension$&
29559 .vindex "&$found_extension$&"
29560 When the &%demime%& condition is true, this variable contains the file
29561 extension it found.
29562 .endlist
29563
29564 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
29565 the &%demime%& condition, and are not changed on subsequent calls.
29566
29567 If you do not want to check for file extensions, but rather use the &%demime%&
29568 condition for unpacking or error checking purposes, pass &"*"& as the
29569 right-hand side value. Here is a more elaborate example of how to use this
29570 facility:
29571 .code
29572 # Reject messages with serious MIME container errors
29573 deny  message = Found MIME error ($demime_reason).
29574       demime = *
29575       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
29576
29577 # Reject known virus spreading file extensions.
29578 # Accepting these is pretty much braindead.
29579 deny  message = contains $found_extension file (blacklisted).
29580       demime  = com:vbs:bat:pif:scr
29581
29582 # Freeze .exe and .doc files. Postmaster can
29583 # examine them and eventually thaw them.
29584 deny  log_message = Another $found_extension file.
29585       demime = exe:doc
29586       control = freeze
29587 .endd
29588 .ecindex IIDcosca
29589
29590
29591
29592
29593 . ////////////////////////////////////////////////////////////////////////////
29594 . ////////////////////////////////////////////////////////////////////////////
29595
29596 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
29597          "Local scan function"
29598 .scindex IIDlosca "&[local_scan()]& function" "description of"
29599 .cindex "customizing" "input scan using C function"
29600 .cindex "policy control" "by local scan function"
29601 In these days of email worms, viruses, and ever-increasing spam, some sites
29602 want to apply a lot of checking to messages before accepting them.
29603
29604 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
29605 passing messages to external virus and spam scanning software. You can also do
29606 a certain amount in Exim itself through string expansions and the &%condition%&
29607 condition in the ACL that runs after the SMTP DATA command or the ACL for
29608 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
29609
29610 To allow for further customization to a site's own requirements, there is the
29611 possibility of linking Exim with a private message scanning function, written
29612 in C. If you want to run code that is written in something other than C, you
29613 can of course use a little C stub to call it.
29614
29615 The local scan function is run once for every incoming message, at the point
29616 when Exim is just about to accept the message.
29617 It can therefore be used to control non-SMTP messages from local processes as
29618 well as messages arriving via SMTP.
29619
29620 Exim applies a timeout to calls of the local scan function, and there is an
29621 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
29622 Zero means &"no timeout"&.
29623 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
29624 before calling the local scan function, so that the most common types of crash
29625 are caught. If the timeout is exceeded or one of those signals is caught, the
29626 incoming message is rejected with a temporary error if it is an SMTP message.
29627 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
29628 code. The incident is logged on the main and reject logs.
29629
29630
29631
29632 .section "Building Exim to use a local scan function" "SECID207"
29633 .cindex "&[local_scan()]& function" "building Exim to use"
29634 To make use of the local scan function feature, you must tell Exim where your
29635 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
29636 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
29637 directory, so you might set
29638 .code
29639 LOCAL_SCAN_SOURCE=Local/local_scan.c
29640 .endd
29641 for example. The function must be called &[local_scan()]&. It is called by
29642 Exim after it has received a message, when the success return code is about to
29643 be sent. This is after all the ACLs have been run. The return code from your
29644 function controls whether the message is actually accepted or not. There is a
29645 commented template function (that just accepts the message) in the file
29646 _src/local_scan.c_.
29647
29648 If you want to make use of Exim's run time configuration file to set options
29649 for your &[local_scan()]& function, you must also set
29650 .code
29651 LOCAL_SCAN_HAS_OPTIONS=yes
29652 .endd
29653 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
29654
29655
29656
29657
29658 .section "API for local_scan()" "SECTapiforloc"
29659 .cindex "&[local_scan()]& function" "API description"
29660 You must include this line near the start of your code:
29661 .code
29662 #include "local_scan.h"
29663 .endd
29664 This header file defines a number of variables and other values, and the
29665 prototype for the function itself. Exim is coded to use unsigned char values
29666 almost exclusively, and one of the things this header defines is a shorthand
29667 for &`unsigned char`& called &`uschar`&.
29668 It also contains the following macro definitions, to simplify casting character
29669 strings and pointers to character strings:
29670 .code
29671 #define CS   (char *)
29672 #define CCS  (const char *)
29673 #define CSS  (char **)
29674 #define US   (unsigned char *)
29675 #define CUS  (const unsigned char *)
29676 #define USS  (unsigned char **)
29677 .endd
29678 The function prototype for &[local_scan()]& is:
29679 .code
29680 extern int local_scan(int fd, uschar **return_text);
29681 .endd
29682 The arguments are as follows:
29683
29684 .ilist
29685 &%fd%& is a file descriptor for the file that contains the body of the message
29686 (the -D file). The file is open for reading and writing, but updating it is not
29687 recommended. &*Warning*&: You must &'not'& close this file descriptor.
29688
29689 The descriptor is positioned at character 19 of the file, which is the first
29690 character of the body itself, because the first 19 characters are the message
29691 id followed by &`-D`& and a newline. If you rewind the file, you should use the
29692 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
29693 case this changes in some future version.
29694 .next
29695 &%return_text%& is an address which you can use to return a pointer to a text
29696 string at the end of the function. The value it points to on entry is NULL.
29697 .endlist
29698
29699 The function must return an &%int%& value which is one of the following macros:
29700
29701 .vlist
29702 .vitem &`LOCAL_SCAN_ACCEPT`&
29703 .vindex "&$local_scan_data$&"
29704 The message is accepted. If you pass back a string of text, it is saved with
29705 the message, and made available in the variable &$local_scan_data$&. No
29706 newlines are permitted (if there are any, they are turned into spaces) and the
29707 maximum length of text is 1000 characters.
29708
29709 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
29710 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29711 queued without immediate delivery, and is frozen.
29712
29713 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
29714 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29715 queued without immediate delivery.
29716
29717 .vitem &`LOCAL_SCAN_REJECT`&
29718 The message is rejected; the returned text is used as an error message which is
29719 passed back to the sender and which is also logged. Newlines are permitted &--
29720 they cause a multiline response for SMTP rejections, but are converted to
29721 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
29722 used.
29723
29724 .vitem &`LOCAL_SCAN_TEMPREJECT`&
29725 The message is temporarily rejected; the returned text is used as an error
29726 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
29727 problem"& is used.
29728
29729 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
29730 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
29731 message is not written to the reject log. It has the effect of unsetting the
29732 &%rejected_header%& log selector for just this rejection. If
29733 &%rejected_header%& is already unset (see the discussion of the
29734 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
29735 same as LOCAL_SCAN_REJECT.
29736
29737 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
29738 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
29739 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
29740 .endlist
29741
29742 If the message is not being received by interactive SMTP, rejections are
29743 reported by writing to &%stderr%& or by sending an email, as configured by the
29744 &%-oe%& command line options.
29745
29746
29747
29748 .section "Configuration options for local_scan()" "SECTconoptloc"
29749 .cindex "&[local_scan()]& function" "configuration options"
29750 It is possible to have option settings in the main configuration file
29751 that set values in static variables in the &[local_scan()]& module. If you
29752 want to do this, you must have the line
29753 .code
29754 LOCAL_SCAN_HAS_OPTIONS=yes
29755 .endd
29756 in your &_Local/Makefile_& when you build Exim. (This line is in
29757 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
29758 file, you must define static variables to hold the option values, and a table
29759 to define them.
29760
29761 The table must be a vector called &%local_scan_options%&, of type
29762 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
29763 and a pointer to the variable that holds the value. The entries must appear in
29764 alphabetical order. Following &%local_scan_options%& you must also define a
29765 variable called &%local_scan_options_count%& that contains the number of
29766 entries in the table. Here is a short example, showing two kinds of option:
29767 .code
29768 static int my_integer_option = 42;
29769 static uschar *my_string_option = US"a default string";
29770
29771 optionlist local_scan_options[] = {
29772   { "my_integer", opt_int,       &my_integer_option },
29773   { "my_string",  opt_stringptr, &my_string_option }
29774 };
29775
29776 int local_scan_options_count =
29777   sizeof(local_scan_options)/sizeof(optionlist);
29778 .endd
29779 The values of the variables can now be changed from Exim's runtime
29780 configuration file by including a local scan section as in this example:
29781 .code
29782 begin local_scan
29783 my_integer = 99
29784 my_string = some string of text...
29785 .endd
29786 The available types of option data are as follows:
29787
29788 .vlist
29789 .vitem &*opt_bool*&
29790 This specifies a boolean (true/false) option. The address should point to a
29791 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
29792 that are defined as &"1"& and &"0"&, respectively. If you want to detect
29793 whether such a variable has been set at all, you can initialize it to
29794 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
29795 values.)
29796
29797 .vitem &*opt_fixed*&
29798 This specifies a fixed point number, such as is used for load averages.
29799 The address should point to a variable of type &`int`&. The value is stored
29800 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
29801
29802 .vitem &*opt_int*&
29803 This specifies an integer; the address should point to a variable of type
29804 &`int`&. The value may be specified in any of the integer formats accepted by
29805 Exim.
29806
29807 .vitem &*opt_mkint*&
29808 This is the same as &%opt_int%&, except that when such a value is output in a
29809 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
29810 printed with the suffix K or M.
29811
29812 .vitem &*opt_octint*&
29813 This also specifies an integer, but the value is always interpreted as an
29814 octal integer, whether or not it starts with the digit zero, and it is
29815 always output in octal.
29816
29817 .vitem &*opt_stringptr*&
29818 This specifies a string value; the address must be a pointer to a
29819 variable that points to a string (for example, of type &`uschar *`&).
29820
29821 .vitem &*opt_time*&
29822 This specifies a time interval value. The address must point to a variable of
29823 type &`int`&. The value that is placed there is a number of seconds.
29824 .endlist
29825
29826 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
29827 out the values of all the &[local_scan()]& options.
29828
29829
29830
29831 .section "Available Exim variables" "SECID208"
29832 .cindex "&[local_scan()]& function" "available Exim variables"
29833 The header &_local_scan.h_& gives you access to a number of C variables. These
29834 are the only ones that are guaranteed to be maintained from release to release.
29835 Note, however, that you can obtain the value of any Exim expansion variable,
29836 including &$recipients$&, by calling &'expand_string()'&. The exported
29837 C variables are as follows:
29838
29839 .vlist
29840 .vitem &*int&~body_linecount*&
29841 This variable contains the number of lines in the message's body.
29842
29843 .vitem &*int&~body_zerocount*&
29844 This variable contains the number of binary zero bytes in the message's body.
29845
29846 .vitem &*unsigned&~int&~debug_selector*&
29847 This variable is set to zero when no debugging is taking place. Otherwise, it
29848 is a bitmap of debugging selectors. Two bits are identified for use in
29849 &[local_scan()]&; they are defined as macros:
29850
29851 .ilist
29852 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
29853 testing option that is not privileged &-- any caller may set it. All the
29854 other selector bits can be set only by admin users.
29855
29856 .next
29857 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
29858 by the &`+local_scan`& debug selector. It is not included in the default set
29859 of debugging bits.
29860 .endlist ilist
29861
29862 Thus, to write to the debugging output only when &`+local_scan`& has been
29863 selected, you should use code like this:
29864 .code
29865 if ((debug_selector & D_local_scan) != 0)
29866   debug_printf("xxx", ...);
29867 .endd
29868 .vitem &*uschar&~*expand_string_message*&
29869 After a failing call to &'expand_string()'& (returned value NULL), the
29870 variable &%expand_string_message%& contains the error message, zero-terminated.
29871
29872 .vitem &*header_line&~*header_list*&
29873 A pointer to a chain of header lines. The &%header_line%& structure is
29874 discussed below.
29875
29876 .vitem &*header_line&~*header_last*&
29877 A pointer to the last of the header lines.
29878
29879 .vitem &*uschar&~*headers_charset*&
29880 The value of the &%headers_charset%& configuration option.
29881
29882 .vitem &*BOOL&~host_checking*&
29883 This variable is TRUE during a host checking session that is initiated by the
29884 &%-bh%& command line option.
29885
29886 .vitem &*uschar&~*interface_address*&
29887 The IP address of the interface that received the message, as a string. This
29888 is NULL for locally submitted messages.
29889
29890 .vitem &*int&~interface_port*&
29891 The port on which this message was received. When testing with the &%-bh%&
29892 command line option, the value of this variable is -1 unless a port has been
29893 specified via the &%-oMi%& option.
29894
29895 .vitem &*uschar&~*message_id*&
29896 This variable contains Exim's message id for the incoming message (the value of
29897 &$message_exim_id$&) as a zero-terminated string.
29898
29899 .vitem &*uschar&~*received_protocol*&
29900 The name of the protocol by which the message was received.
29901
29902 .vitem &*int&~recipients_count*&
29903 The number of accepted recipients.
29904
29905 .vitem &*recipient_item&~*recipients_list*&
29906 .cindex "recipient" "adding in local scan"
29907 .cindex "recipient" "removing in local scan"
29908 The list of accepted recipients, held in a vector of length
29909 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29910 can add additional recipients by calling &'receive_add_recipient()'& (see
29911 below). You can delete recipients by removing them from the vector and
29912 adjusting the value in &%recipients_count%&. In particular, by setting
29913 &%recipients_count%& to zero you remove all recipients. If you then return the
29914 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29915 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29916 and then call &'receive_add_recipient()'& as often as needed.
29917
29918 .vitem &*uschar&~*sender_address*&
29919 The envelope sender address. For bounce messages this is the empty string.
29920
29921 .vitem &*uschar&~*sender_host_address*&
29922 The IP address of the sending host, as a string. This is NULL for
29923 locally-submitted messages.
29924
29925 .vitem &*uschar&~*sender_host_authenticated*&
29926 The name of the authentication mechanism that was used, or NULL if the message
29927 was not received over an authenticated SMTP connection.
29928
29929 .vitem &*uschar&~*sender_host_name*&
29930 The name of the sending host, if known.
29931
29932 .vitem &*int&~sender_host_port*&
29933 The port on the sending host.
29934
29935 .vitem &*BOOL&~smtp_input*&
29936 This variable is TRUE for all SMTP input, including BSMTP.
29937
29938 .vitem &*BOOL&~smtp_batched_input*&
29939 This variable is TRUE for BSMTP input.
29940
29941 .vitem &*int&~store_pool*&
29942 The contents of this variable control which pool of memory is used for new
29943 requests. See section &<<SECTmemhanloc>>& for details.
29944 .endlist
29945
29946
29947 .section "Structure of header lines" "SECID209"
29948 The &%header_line%& structure contains the members listed below.
29949 You can add additional header lines by calling the &'header_add()'& function
29950 (see below). You can cause header lines to be ignored (deleted) by setting
29951 their type to *.
29952
29953
29954 .vlist
29955 .vitem &*struct&~header_line&~*next*&
29956 A pointer to the next header line, or NULL for the last line.
29957
29958 .vitem &*int&~type*&
29959 A code identifying certain headers that Exim recognizes. The codes are printing
29960 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29961 Notice in particular that any header line whose type is * is not transmitted
29962 with the message. This flagging is used for header lines that have been
29963 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29964 lines.) Effectively, * means &"deleted"&.
29965
29966 .vitem &*int&~slen*&
29967 The number of characters in the header line, including the terminating and any
29968 internal newlines.
29969
29970 .vitem &*uschar&~*text*&
29971 A pointer to the text of the header. It always ends with a newline, followed by
29972 a zero byte. Internal newlines are preserved.
29973 .endlist
29974
29975
29976
29977 .section "Structure of recipient items" "SECID210"
29978 The &%recipient_item%& structure contains these members:
29979
29980 .vlist
29981 .vitem &*uschar&~*address*&
29982 This is a pointer to the recipient address as it was received.
29983
29984 .vitem &*int&~pno*&
29985 This is used in later Exim processing when top level addresses are created by
29986 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29987 and must always contain -1 at this stage.
29988
29989 .vitem &*uschar&~*errors_to*&
29990 If this value is not NULL, bounce messages caused by failing to deliver to the
29991 recipient are sent to the address it contains. In other words, it overrides the
29992 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29993 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29994 an unqualified address, Exim qualifies it using the domain from
29995 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29996 is NULL for all recipients.
29997 .endlist
29998
29999
30000
30001 .section "Available Exim functions" "SECID211"
30002 .cindex "&[local_scan()]& function" "available Exim functions"
30003 The header &_local_scan.h_& gives you access to a number of Exim functions.
30004 These are the only ones that are guaranteed to be maintained from release to
30005 release:
30006
30007 .vlist
30008 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
30009        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
30010
30011 This function creates a child process that runs the command specified by
30012 &%argv%&. The environment for the process is specified by &%envp%&, which can
30013 be NULL if no environment variables are to be passed. A new umask is supplied
30014 for the process in &%newumask%&.
30015
30016 Pipes to the standard input and output of the new process are set up
30017 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
30018 standard error is cloned to the standard output. If there are any file
30019 descriptors &"in the way"& in the new process, they are closed. If the final
30020 argument is TRUE, the new process is made into a process group leader.
30021
30022 The function returns the pid of the new process, or -1 if things go wrong.
30023
30024 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
30025 This function waits for a child process to terminate, or for a timeout (in
30026 seconds) to expire. A timeout value of zero means wait as long as it takes. The
30027 return value is as follows:
30028
30029 .ilist
30030 >= 0
30031
30032 The process terminated by a normal exit and the value is the process
30033 ending status.
30034
30035 .next
30036 < 0 and > &--256
30037
30038 The process was terminated by a signal and the value is the negation of the
30039 signal number.
30040
30041 .next
30042 &--256
30043
30044 The process timed out.
30045 .next
30046 &--257
30047
30048 The was some other error in wait(); &%errno%& is still set.
30049 .endlist
30050
30051 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30052 This function provide you with a means of submitting a new message to
30053 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30054 want, but this packages it all up for you.) The function creates a pipe,
30055 forks a subprocess that is running
30056 .code
30057 exim -t -oem -oi -f <>
30058 .endd
30059 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30060 that is connected to the standard input. The yield of the function is the PID
30061 of the subprocess. You can then write a message to the file descriptor, with
30062 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30063
30064 When you have finished, call &'child_close()'& to wait for the process to
30065 finish and to collect its ending status. A timeout value of zero is usually
30066 fine in this circumstance. Unless you have made a mistake with the recipient
30067 addresses, you should get a return code of zero.
30068
30069
30070 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30071        *sender_authentication)*&
30072 This function is a more sophisticated version of &'child_open()'&. The command
30073 that it runs is:
30074 .display
30075 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30076 .endd
30077 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30078
30079
30080 .vitem &*void&~debug_printf(char&~*,&~...)*&
30081 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30082 output is written to the standard error stream. If no debugging is selected,
30083 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30084 conditional on the &`local_scan`& debug selector by coding like this:
30085 .code
30086 if ((debug_selector & D_local_scan) != 0)
30087   debug_printf("xxx", ...);
30088 .endd
30089
30090 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30091 This is an interface to Exim's string expansion code. The return value is the
30092 expanded string, or NULL if there was an expansion failure.
30093 The C variable &%expand_string_message%& contains an error message after an
30094 expansion failure. If expansion does not change the string, the return value is
30095 the pointer to the input string. Otherwise, the return value points to a new
30096 block of memory that was obtained by a call to &'store_get()'&. See section
30097 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30098
30099 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30100 This function allows you to an add additional header line at the end of the
30101 existing ones. The first argument is the type, and should normally be a space
30102 character. The second argument is a format string and any number of
30103 substitution arguments as for &[sprintf()]&. You may include internal newlines
30104 if you want, and you must ensure that the string ends with a newline.
30105
30106 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30107         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30108 This function adds a new header line at a specified point in the header
30109 chain. The header itself is specified as for &'header_add()'&.
30110
30111 If &%name%& is NULL, the new header is added at the end of the chain if
30112 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30113 NULL, the header lines are searched for the first non-deleted header that
30114 matches the name. If one is found, the new header is added before it if
30115 &%after%& is false. If &%after%& is true, the new header is added after the
30116 found header and any adjacent subsequent ones with the same name (even if
30117 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30118 option controls where the header is added. If it is true, addition is at the
30119 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30120 headers, or at the top if there are no &'Received:'& headers, you could use
30121 .code
30122 header_add_at_position(TRUE, US"Received", TRUE,
30123   ' ', "X-xxx: ...");
30124 .endd
30125 Normally, there is always at least one non-deleted &'Received:'& header, but
30126 there may not be if &%received_header_text%& expands to an empty string.
30127
30128
30129 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30130 This function removes header lines. If &%occurrence%& is zero or negative, all
30131 occurrences of the header are removed. If occurrence is greater than zero, that
30132 particular instance of the header is removed. If no header(s) can be found that
30133 match the specification, the function does nothing.
30134
30135
30136 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30137         int&~length,&~BOOL&~notdel)*&"
30138 This function tests whether the given header has the given name. It is not just
30139 a string comparison, because white space is permitted between the name and the
30140 colon. If the &%notdel%& argument is true, a false return is forced for all
30141 &"deleted"& headers; otherwise they are not treated specially. For example:
30142 .code
30143 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30144 .endd
30145 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30146 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30147 This function base64-encodes a string, which is passed by address and length.
30148 The text may contain bytes of any value, including zero. The result is passed
30149 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30150 zero-terminated.
30151
30152 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30153 This function decodes a base64-encoded string. Its arguments are a
30154 zero-terminated base64-encoded string and the address of a variable that is set
30155 to point to the result, which is in dynamic memory. The length of the decoded
30156 string is the yield of the function. If the input is invalid base64 data, the
30157 yield is -1. A zero byte is added to the end of the output string to make it
30158 easy to interpret as a C string (assuming it contains no zeros of its own). The
30159 added zero byte is not included in the returned count.
30160
30161 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30162 This function checks for a match in a domain list. Domains are always
30163 matched caselessly. The return value is one of the following:
30164 .display
30165 &`OK     `& match succeeded
30166 &`FAIL   `& match failed
30167 &`DEFER  `& match deferred
30168 .endd
30169 DEFER is usually caused by some kind of lookup defer, such as the
30170 inability to contact a database.
30171
30172 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30173         BOOL&~caseless)*&"
30174 This function checks for a match in a local part list. The third argument
30175 controls case-sensitivity. The return values are as for
30176 &'lss_match_domain()'&.
30177
30178 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30179         BOOL&~caseless)*&"
30180 This function checks for a match in an address list. The third argument
30181 controls the case-sensitivity of the local part match. The domain is always
30182 matched caselessly. The return values are as for &'lss_match_domain()'&.
30183
30184 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30185         uschar&~*list)*&"
30186 This function checks for a match in a host list. The most common usage is
30187 expected to be
30188 .code
30189 lss_match_host(sender_host_name, sender_host_address, ...)
30190 .endd
30191 .vindex "&$sender_host_address$&"
30192 An empty address field matches an empty item in the host list. If the host name
30193 is NULL, the name corresponding to &$sender_host_address$& is automatically
30194 looked up if a host name is required to match an item in the list. The return
30195 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30196 returns ERROR in the case when it had to look up a host name, but the lookup
30197 failed.
30198
30199 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30200         *format,&~...)*&"
30201 This function writes to Exim's log files. The first argument should be zero (it
30202 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30203 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30204 them. It specifies to which log or logs the message is written. The remaining
30205 arguments are a format and relevant insertion arguments. The string should not
30206 contain any newlines, not even at the end.
30207
30208
30209 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30210 This function adds an additional recipient to the message. The first argument
30211 is the recipient address. If it is unqualified (has no domain), it is qualified
30212 with the &%qualify_recipient%& domain. The second argument must always be -1.
30213
30214 This function does not allow you to specify a private &%errors_to%& address (as
30215 described with the structure of &%recipient_item%& above), because it pre-dates
30216 the addition of that field to the structure. However, it is easy to add such a
30217 value afterwards. For example:
30218 .code
30219  receive_add_recipient(US"monitor@mydom.example", -1);
30220  recipients_list[recipients_count-1].errors_to =
30221    US"postmaster@mydom.example";
30222 .endd
30223
30224 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30225 This is a convenience function to remove a named recipient from the list of
30226 recipients. It returns true if a recipient was removed, and false if no
30227 matching recipient could be found. The argument must be a complete email
30228 address.
30229 .endlist
30230
30231
30232 .cindex "RFC 2047"
30233 .vlist
30234 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30235   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30236 This function decodes strings that are encoded according to RFC 2047. Typically
30237 these are the contents of header lines. First, each &"encoded word"& is decoded
30238 from the Q or B encoding into a byte-string. Then, if provided with the name of
30239 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30240 made  to translate the result to the named character set. If this fails, the
30241 binary string is returned with an error message.
30242
30243 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30244 maximum MIME word length is enforced. The third argument is the target
30245 encoding, or NULL if no translation is wanted.
30246
30247 .cindex "binary zero" "in RFC 2047 decoding"
30248 .cindex "RFC 2047" "binary zero in"
30249 If a binary zero is encountered in the decoded string, it is replaced by the
30250 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30251 not be 0 because header lines are handled as zero-terminated strings.
30252
30253 The function returns the result of processing the string, zero-terminated; if
30254 &%lenptr%& is not NULL, the length of the result is set in the variable to
30255 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30256
30257 If an error is encountered, the function returns NULL and uses the &%error%&
30258 argument to return an error message. The variable pointed to by &%error%& is
30259 set to NULL if there is no error; it may be set non-NULL even when the function
30260 returns a non-NULL value if decoding was successful, but there was a problem
30261 with translation.
30262
30263
30264 .vitem &*int&~smtp_fflush(void)*&
30265 This function is used in conjunction with &'smtp_printf()'&, as described
30266 below.
30267
30268 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30269 The arguments of this function are like &[printf()]&; it writes to the SMTP
30270 output stream. You should use this function only when there is an SMTP output
30271 stream, that is, when the incoming message is being received via interactive
30272 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30273 is FALSE. If you want to test for an incoming message from another host (as
30274 opposed to a local process that used the &%-bs%& command line option), you can
30275 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30276 is involved.
30277
30278 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30279 output function, so it can be used for all forms of SMTP connection.
30280
30281 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30282 must start with an appropriate response code: 550 if you are going to return
30283 LOCAL_SCAN_REJECT, 451 if you are going to return
30284 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30285 initial lines of a multi-line response, the code must be followed by a hyphen
30286 to indicate that the line is not the final response line. You must also ensure
30287 that the lines you write terminate with CRLF. For example:
30288 .code
30289 smtp_printf("550-this is some extra info\r\n");
30290 return LOCAL_SCAN_REJECT;
30291 .endd
30292 Note that you can also create multi-line responses by including newlines in
30293 the data returned via the &%return_text%& argument. The added value of using
30294 &'smtp_printf()'& is that, for instance, you could introduce delays between
30295 multiple output lines.
30296
30297 The &'smtp_printf()'& function does not return any error indication, because it
30298 does not automatically flush pending output, and therefore does not test
30299 the state of the stream. (In the main code of Exim, flushing and error
30300 detection is done when Exim is ready for the next SMTP input command.) If
30301 you want to flush the output and check for an error (for example, the
30302 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30303 arguments. It flushes the output stream, and returns a non-zero value if there
30304 is an error.
30305
30306 .vitem &*void&~*store_get(int)*&
30307 This function accesses Exim's internal store (memory) manager. It gets a new
30308 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30309 runs out of memory. See the next section for a discussion of memory handling.
30310
30311 .vitem &*void&~*store_get_perm(int)*&
30312 This function is like &'store_get()'&, but it always gets memory from the
30313 permanent pool. See the next section for a discussion of memory handling.
30314
30315 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30316 See below.
30317
30318 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30319 See below.
30320
30321 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30322 These three functions create strings using Exim's dynamic memory facilities.
30323 The first makes a copy of an entire string. The second copies up to a maximum
30324 number of characters, indicated by the second argument. The third uses a format
30325 and insertion arguments to create a new string. In each case, the result is a
30326 pointer to a new string in the current memory pool. See the next section for
30327 more discussion.
30328 .endlist
30329
30330
30331
30332 .section "More about Exim's memory handling" "SECTmemhanloc"
30333 .cindex "&[local_scan()]& function" "memory handling"
30334 No function is provided for freeing memory, because that is never needed.
30335 The dynamic memory that Exim uses when receiving a message is automatically
30336 recycled if another message is received by the same process (this applies only
30337 to incoming SMTP connections &-- other input methods can supply only one
30338 message at a time). After receiving the last message, a reception process
30339 terminates.
30340
30341 Because it is recycled, the normal dynamic memory cannot be used for holding
30342 data that must be preserved over a number of incoming messages on the same SMTP
30343 connection. However, Exim in fact uses two pools of dynamic memory; the second
30344 one is not recycled, and can be used for this purpose.
30345
30346 If you want to allocate memory that remains available for subsequent messages
30347 in the same SMTP connection, you should set
30348 .code
30349 store_pool = POOL_PERM
30350 .endd
30351 before calling the function that does the allocation. There is no need to
30352 restore the value if you do not need to; however, if you do want to revert to
30353 the normal pool, you can either restore the previous value of &%store_pool%& or
30354 set it explicitly to POOL_MAIN.
30355
30356 The pool setting applies to all functions that get dynamic memory, including
30357 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30358 There is also a convenience function called &'store_get_perm()'& that gets a
30359 block of memory from the permanent pool while preserving the value of
30360 &%store_pool%&.
30361 .ecindex IIDlosca
30362
30363
30364
30365
30366 . ////////////////////////////////////////////////////////////////////////////
30367 . ////////////////////////////////////////////////////////////////////////////
30368
30369 .chapter "System-wide message filtering" "CHAPsystemfilter"
30370 .scindex IIDsysfil1 "filter" "system filter"
30371 .scindex IIDsysfil2 "filtering all mail"
30372 .scindex IIDsysfil3 "system filter"
30373 The previous chapters (on ACLs and the local scan function) describe checks
30374 that can be applied to messages before they are accepted by a host. There is
30375 also a mechanism for checking messages once they have been received, but before
30376 they are delivered. This is called the &'system filter'&.
30377
30378 The system filter operates in a similar manner to users' filter files, but it
30379 is run just once per message (however many recipients the message has).
30380 It should not normally be used as a substitute for routing, because &%deliver%&
30381 commands in a system router provide new envelope recipient addresses.
30382 The system filter must be an Exim filter. It cannot be a Sieve filter.
30383
30384 The system filter is run at the start of a delivery attempt, before any routing
30385 is done. If a message fails to be completely delivered at the first attempt,
30386 the system filter is run again at the start of every retry.
30387 If you want your filter to do something only once per message, you can make use
30388 of the &%first_delivery%& condition in an &%if%& command in the filter to
30389 prevent it happening on retries.
30390
30391 .vindex "&$domain$&"
30392 .vindex "&$local_part$&"
30393 &*Warning*&: Because the system filter runs just once, variables that are
30394 specific to individual recipient addresses, such as &$local_part$& and
30395 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
30396 you want to run a centrally-specified filter for each recipient address
30397 independently, you can do so by setting up a suitable &(redirect)& router, as
30398 described in section &<<SECTperaddfil>>& below.
30399
30400
30401 .section "Specifying a system filter" "SECID212"
30402 .cindex "uid (user id)" "system filter"
30403 .cindex "gid (group id)" "system filter"
30404 The name of the file that contains the system filter must be specified by
30405 setting &%system_filter%&. If you want the filter to run under a uid and gid
30406 other than root, you must also set &%system_filter_user%& and
30407 &%system_filter_group%& as appropriate. For example:
30408 .code
30409 system_filter = /etc/mail/exim.filter
30410 system_filter_user = exim
30411 .endd
30412 If a system filter generates any deliveries directly to files or pipes (via the
30413 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
30414 specified by setting &%system_filter_file_transport%& and
30415 &%system_filter_pipe_transport%&, respectively. Similarly,
30416 &%system_filter_reply_transport%& must be set to handle any messages generated
30417 by the &%reply%& command.
30418
30419
30420 .section "Testing a system filter" "SECID213"
30421 You can run simple tests of a system filter in the same way as for a user
30422 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
30423 are permitted only in system filters are recognized.
30424
30425 If you want to test the combined effect of a system filter and a user filter,
30426 you can use both &%-bF%& and &%-bf%& on the same command line.
30427
30428
30429
30430 .section "Contents of a system filter" "SECID214"
30431 The language used to specify system filters is the same as for users' filter
30432 files. It is described in the separate end-user document &'Exim's interface to
30433 mail filtering'&. However, there are some additional features that are
30434 available only in system filters; these are described in subsequent sections.
30435 If they are encountered in a user's filter file or when testing with &%-bf%&,
30436 they cause errors.
30437
30438 .cindex "frozen messages" "manual thaw; testing in filter"
30439 There are two special conditions which, though available in users' filter
30440 files, are designed for use in system filters. The condition &%first_delivery%&
30441 is true only for the first attempt at delivering a message, and
30442 &%manually_thawed%& is true only if the message has been frozen, and
30443 subsequently thawed by an admin user. An explicit forced delivery counts as a
30444 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
30445
30446 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
30447 specify an &"unseen"& (non-significant) delivery, and that delivery does not
30448 succeed, it will not be tried again.
30449 If you want Exim to retry an unseen delivery until it succeeds, you should
30450 arrange to set it up every time the filter runs.
30451
30452 When a system filter finishes running, the values of the variables &$n0$& &--
30453 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
30454 users' filter files. Thus a system filter can, for example, set up &"scores"&
30455 to which users' filter files can refer.
30456
30457
30458
30459 .section "Additional variable for system filters" "SECID215"
30460 .vindex "&$recipients$&"
30461 The expansion variable &$recipients$&, containing a list of all the recipients
30462 of the message (separated by commas and white space), is available in system
30463 filters. It is not available in users' filters for privacy reasons.
30464
30465
30466
30467 .section "Defer, freeze, and fail commands for system filters" "SECID216"
30468 .cindex "freezing messages"
30469 .cindex "message" "freezing"
30470 .cindex "message" "forced failure"
30471 .cindex "&%fail%&" "in system filter"
30472 .cindex "&%freeze%& in system filter"
30473 .cindex "&%defer%& in system filter"
30474 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
30475 always available in system filters, but are not normally enabled in users'
30476 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
30477 for the &(redirect)& router.) These commands can optionally be followed by the
30478 word &%text%& and a string containing an error message, for example:
30479 .code
30480 fail text "this message looks like spam to me"
30481 .endd
30482 The keyword &%text%& is optional if the next character is a double quote.
30483
30484 The &%defer%& command defers delivery of the original recipients of the
30485 message. The &%fail%& command causes all the original recipients to be failed,
30486 and a bounce message to be created. The &%freeze%& command suspends all
30487 delivery attempts for the original recipients. In all cases, any new deliveries
30488 that are specified by the filter are attempted as normal after the filter has
30489 run.
30490
30491 The &%freeze%& command is ignored if the message has been manually unfrozen and
30492 not manually frozen since. This means that automatic freezing by a system
30493 filter can be used as a way of checking out suspicious messages. If a message
30494 is found to be all right, manually unfreezing it allows it to be delivered.
30495
30496 .cindex "log" "&%fail%& command log line"
30497 .cindex "&%fail%&" "log line; reducing"
30498 The text given with a fail command is used as part of the bounce message as
30499 well as being written to the log. If the message is quite long, this can fill
30500 up a lot of log space when such failures are common. To reduce the size of the
30501 log message, Exim interprets the text in a special way if it starts with the
30502 two characters &`<<`& and contains &`>>`& later. The text between these two
30503 strings is written to the log, and the rest of the text is used in the bounce
30504 message. For example:
30505 .code
30506 fail "<<filter test 1>>Your message is rejected \
30507      because it contains attachments that we are \
30508      not prepared to receive."
30509 .endd
30510
30511 .cindex "loop" "caused by &%fail%&"
30512 Take great care with the &%fail%& command when basing the decision to fail on
30513 the contents of the message, because the bounce message will of course include
30514 the contents of the original message and will therefore trigger the &%fail%&
30515 command again (causing a mail loop) unless steps are taken to prevent this.
30516 Testing the &%error_message%& condition is one way to prevent this. You could
30517 use, for example
30518 .code
30519 if $message_body contains "this is spam" and not error_message
30520 then fail text "spam is not wanted here" endif
30521 .endd
30522 though of course that might let through unwanted bounce messages. The
30523 alternative is clever checking of the body and/or headers to detect bounces
30524 generated by the filter.
30525
30526 The interpretation of a system filter file ceases after a
30527 &%defer%&,
30528 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
30529 set up earlier in the filter file are honoured, so you can use a sequence such
30530 as
30531 .code
30532 mail ...
30533 freeze
30534 .endd
30535 to send a specified message when the system filter is freezing (or deferring or
30536 failing) a message. The normal deliveries for the message do not, of course,
30537 take place.
30538
30539
30540
30541 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
30542 .cindex "header lines" "adding; in system filter"
30543 .cindex "header lines" "removing; in system filter"
30544 .cindex "filter" "header lines; adding/removing"
30545 Two filter commands that are available only in system filters are:
30546 .code
30547 headers add <string>
30548 headers remove <string>
30549 .endd
30550 The argument for the &%headers add%& is a string that is expanded and then
30551 added to the end of the message's headers. It is the responsibility of the
30552 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
30553 space is ignored, and if the string is otherwise empty, or if the expansion is
30554 forced to fail, the command has no effect.
30555
30556 You can use &"\n"& within the string, followed by white space, to specify
30557 continued header lines. More than one header may be added in one command by
30558 including &"\n"& within the string without any following white space. For
30559 example:
30560 .code
30561 headers add "X-header-1: ....\n  \
30562              continuation of X-header-1 ...\n\
30563              X-header-2: ...."
30564 .endd
30565 Note that the header line continuation white space after the first newline must
30566 be placed before the backslash that continues the input string, because white
30567 space after input continuations is ignored.
30568
30569 The argument for &%headers remove%& is a colon-separated list of header names.
30570 This command applies only to those headers that are stored with the message;
30571 those that are added at delivery time (such as &'Envelope-To:'& and
30572 &'Return-Path:'&) cannot be removed by this means. If there is more than one
30573 header with the same name, they are all removed.
30574
30575 The &%headers%& command in a system filter makes an immediate change to the set
30576 of header lines that was received with the message (with possible additions
30577 from ACL processing). Subsequent commands in the system filter operate on the
30578 modified set, which also forms the basis for subsequent message delivery.
30579 Unless further modified during routing or transporting, this set of headers is
30580 used for all recipients of the message.
30581
30582 During routing and transporting, the variables that refer to the contents of
30583 header lines refer only to those lines that are in this set. Thus, header lines
30584 that are added by a system filter are visible to users' filter files and to all
30585 routers and transports. This contrasts with the manipulation of header lines by
30586 routers and transports, which is not immediate, but which instead is saved up
30587 until the message is actually being written (see section
30588 &<<SECTheadersaddrem>>&).
30589
30590 If the message is not delivered at the first attempt, header lines that were
30591 added by the system filter are stored with the message, and so are still
30592 present at the next delivery attempt. Header lines that were removed are still
30593 present, but marked &"deleted"& so that they are not transported with the
30594 message. For this reason, it is usual to make the &%headers%& command
30595 conditional on &%first_delivery%& so that the set of header lines is not
30596 modified more than once.
30597
30598 Because header modification in a system filter acts immediately, you have to
30599 use an indirect approach if you want to modify the contents of a header line.
30600 For example:
30601 .code
30602 headers add "Old-Subject: $h_subject:"
30603 headers remove "Subject"
30604 headers add "Subject: new subject (was: $h_old-subject:)"
30605 headers remove "Old-Subject"
30606 .endd
30607
30608
30609
30610 .section "Setting an errors address in a system filter" "SECID217"
30611 .cindex "envelope sender"
30612 In a system filter, if a &%deliver%& command is followed by
30613 .code
30614 errors_to <some address>
30615 .endd
30616 in order to change the envelope sender (and hence the error reporting) for that
30617 delivery, any address may be specified. (In a user filter, only the current
30618 user's address can be set.) For example, if some mail is being monitored, you
30619 might use
30620 .code
30621 unseen deliver monitor@spying.example errors_to root@local.example
30622 .endd
30623 to take a copy which would not be sent back to the normal error reporting
30624 address if its delivery failed.
30625
30626
30627
30628 .section "Per-address filtering" "SECTperaddfil"
30629 .vindex "&$domain$&"
30630 .vindex "&$local_part$&"
30631 In contrast to the system filter, which is run just once per message for each
30632 delivery attempt, it is also possible to set up a system-wide filtering
30633 operation that runs once for each recipient address. In this case, variables
30634 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
30635 filter file could be made dependent on them. This is an example of a router
30636 which implements such a filter:
30637 .code
30638 central_filter:
30639   check_local_user
30640   driver = redirect
30641   domains = +local_domains
30642   file = /central/filters/$local_part
30643   no_verify
30644   allow_filter
30645   allow_freeze
30646 .endd
30647 The filter is run in a separate process under its own uid. Therefore, either
30648 &%check_local_user%& must be set (as above), in which case the filter is run as
30649 the local user, or the &%user%& option must be used to specify which user to
30650 use. If both are set, &%user%& overrides.
30651
30652 Care should be taken to ensure that none of the commands in the filter file
30653 specify a significant delivery if the message is to go on to be delivered to
30654 its intended recipient. The router will not then claim to have dealt with the
30655 address, so it will be passed on to subsequent routers to be delivered in the
30656 normal way.
30657 .ecindex IIDsysfil1
30658 .ecindex IIDsysfil2
30659 .ecindex IIDsysfil3
30660
30661
30662
30663
30664
30665
30666 . ////////////////////////////////////////////////////////////////////////////
30667 . ////////////////////////////////////////////////////////////////////////////
30668
30669 .chapter "Message processing" "CHAPmsgproc"
30670 .scindex IIDmesproc "message" "general processing"
30671 Exim performs various transformations on the sender and recipient addresses of
30672 all messages that it handles, and also on the messages' header lines. Some of
30673 these are optional and configurable, while others always take place. All of
30674 this processing, except rewriting as a result of routing, and the addition or
30675 removal of header lines while delivering, happens when a message is received,
30676 before it is placed on Exim's queue.
30677
30678 Some of the automatic processing takes place by default only for
30679 &"locally-originated"& messages. This adjective is used to describe messages
30680 that are not received over TCP/IP, but instead are passed to an Exim process on
30681 its standard input. This includes the interactive &"local SMTP"& case that is
30682 set up by the &%-bs%& command line option.
30683
30684 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
30685 or ::1) are not considered to be locally-originated. Exim does not treat the
30686 loopback interface specially in any way.
30687
30688 If you want the loopback interface to be treated specially, you must ensure
30689 that there are appropriate entries in your ACLs.
30690
30691
30692
30693
30694 .section "Submission mode for non-local messages" "SECTsubmodnon"
30695 .cindex "message" "submission"
30696 .cindex "submission mode"
30697 Processing that happens automatically for locally-originated messages (unless
30698 &%suppress_local_fixups%& is set) can also be requested for messages that are
30699 received over TCP/IP. The term &"submission mode"& is used to describe this
30700 state. Submission mode is set by the modifier
30701 .code
30702 control = submission
30703 .endd
30704 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
30705 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
30706 a local submission, and is normally used when the source of the message is
30707 known to be an MUA running on a client host (as opposed to an MTA). For
30708 example, to set submission mode for messages originating on the IPv4 loopback
30709 interface, you could include the following in the MAIL ACL:
30710 .code
30711 warn  hosts = 127.0.0.1
30712       control = submission
30713 .endd
30714 .cindex "&%sender_retain%& submission option"
30715 There are some options that can be used when setting submission mode. A slash
30716 is used to separate options. For example:
30717 .code
30718 control = submission/sender_retain
30719 .endd
30720 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
30721 true and &%local_from_check%& false for the current incoming message. The first
30722 of these allows an existing &'Sender:'& header in the message to remain, and
30723 the second suppresses the check to ensure that &'From:'& matches the
30724 authenticated sender. With this setting, Exim still fixes up messages by adding
30725 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
30726 attempt to check sender authenticity in header lines.
30727
30728 When &%sender_retain%& is not set, a submission mode setting may specify a
30729 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
30730 example:
30731 .code
30732 control = submission/domain=some.domain
30733 .endd
30734 The domain may be empty. How this value is used is described in sections
30735 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
30736 that allows you to specify the user's full name for inclusion in a created
30737 &'Sender:'& or &'From:'& header line. For example:
30738 .code
30739 accept authenticated = *
30740        control = submission/domain=wonderland.example/\
30741                             name=${lookup {$authenticated_id} \
30742                                    lsearch {/etc/exim/namelist}}
30743 .endd
30744 Because the name may contain any characters, including slashes, the &%name%&
30745 option must be given last. The remainder of the string is used as the name. For
30746 the example above, if &_/etc/exim/namelist_& contains:
30747 .code
30748 bigegg:  Humpty Dumpty
30749 .endd
30750 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
30751 line would be:
30752 .code
30753 Sender: Humpty Dumpty <bigegg@wonderland.example>
30754 .endd
30755 .cindex "return path" "in submission mode"
30756 By default, submission mode forces the return path to the same address as is
30757 used to create the &'Sender:'& header. However, if &%sender_retain%& is
30758 specified, the return path is also left unchanged.
30759
30760 &*Note*&: The changes caused by submission mode take effect after the predata
30761 ACL. This means that any sender checks performed before the fix-ups use the
30762 untrusted sender address specified by the user, not the trusted sender address
30763 specified by submission mode. Although this might be slightly unexpected, it
30764 does mean that you can configure ACL checks to spot that a user is trying to
30765 spoof another's address.
30766
30767 .section "Line endings" "SECTlineendings"
30768 .cindex "line endings"
30769 .cindex "carriage return"
30770 .cindex "linefeed"
30771 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
30772 linefeed) is the line ending for messages transmitted over the Internet using
30773 SMTP over TCP/IP. However, within individual operating systems, different
30774 conventions are used. For example, Unix-like systems use just LF, but others
30775 use CRLF or just CR.
30776
30777 Exim was designed for Unix-like systems, and internally, it stores messages
30778 using the system's convention of a single LF as a line terminator. When
30779 receiving a message, all line endings are translated to this standard format.
30780 Originally, it was thought that programs that passed messages directly to an
30781 MTA within an operating system would use that system's convention. Experience
30782 has shown that this is not the case; for example, there are Unix applications
30783 that use CRLF in this circumstance. For this reason, and for compatibility with
30784 other MTAs, the way Exim handles line endings for all messages is now as
30785 follows:
30786
30787 .ilist
30788 LF not preceded by CR is treated as a line ending.
30789 .next
30790 CR is treated as a line ending; if it is immediately followed by LF, the LF
30791 is ignored.
30792 .next
30793 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
30794 nor a local message in the state where a line containing only a dot is a
30795 terminator.
30796 .next
30797 If a bare CR is encountered within a header line, an extra space is added after
30798 the line terminator so as not to end the header line. The reasoning behind this
30799 is that bare CRs in header lines are most likely either to be mistakes, or
30800 people trying to play silly games.
30801 .next
30802 If the first header line received in a message ends with CRLF, a subsequent
30803 bare LF in a header line is treated in the same way as a bare CR in a header
30804 line.
30805 .endlist
30806
30807
30808
30809
30810
30811 .section "Unqualified addresses" "SECID218"
30812 .cindex "unqualified addresses"
30813 .cindex "address" "qualification"
30814 By default, Exim expects every envelope address it receives from an external
30815 host to be fully qualified. Unqualified addresses cause negative responses to
30816 SMTP commands. However, because SMTP is used as a means of transporting
30817 messages from MUAs running on personal workstations, there is sometimes a
30818 requirement to accept unqualified addresses from specific hosts or IP networks.
30819
30820 Exim has two options that separately control which hosts may send unqualified
30821 sender or recipient addresses in SMTP commands, namely
30822 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
30823 cases, if an unqualified address is accepted, it is qualified by adding the
30824 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
30825
30826 .oindex "&%qualify_domain%&"
30827 .oindex "&%qualify_recipient%&"
30828 Unqualified addresses in header lines are automatically qualified for messages
30829 that are locally originated, unless the &%-bnq%& option is given on the command
30830 line. For messages received over SMTP, unqualified addresses in header lines
30831 are qualified only if unqualified addresses are permitted in SMTP commands. In
30832 other words, such qualification is also controlled by
30833 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
30834
30835
30836
30837
30838 .section "The UUCP From line" "SECID219"
30839 .cindex "&""From""& line"
30840 .cindex "UUCP" "&""From""& line"
30841 .cindex "sender" "address"
30842 .oindex "&%uucp_from_pattern%&"
30843 .oindex "&%uucp_from_sender%&"
30844 .cindex "envelope sender"
30845 .cindex "Sendmail compatibility" "&""From""& line"
30846 Messages that have come from UUCP (and some other applications) often begin
30847 with a line containing the envelope sender and a timestamp, following the word
30848 &"From"&. Examples of two common formats are:
30849 .code
30850 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
30851 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
30852 .endd
30853 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
30854 Exim recognizes such lines at the start of messages that are submitted to it
30855 via the command line (that is, on the standard input). It does not recognize
30856 such lines in incoming SMTP messages, unless the sending host matches
30857 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
30858 and &%ignore_fromline_local%& is set. The recognition is controlled by a
30859 regular expression that is defined by the &%uucp_from_pattern%& option, whose
30860 default value matches the two common cases shown above and puts the address
30861 that follows &"From"& into &$1$&.
30862
30863 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
30864 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
30865 a trusted user, the message's sender address is constructed by expanding the
30866 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
30867 then parsed as an RFC 2822 address. If there is no domain, the local part is
30868 qualified with &%qualify_domain%& unless it is the empty string. However, if
30869 the command line &%-f%& option is used, it overrides the &"From"& line.
30870
30871 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
30872 sender address is not changed. This is also the case for incoming SMTP messages
30873 that are permitted to contain &"From"& lines.
30874
30875 Only one &"From"& line is recognized. If there is more than one, the second is
30876 treated as a data line that starts the body of the message, as it is not valid
30877 as a header line. This also happens if a &"From"& line is present in an
30878 incoming SMTP message from a source that is not permitted to send them.
30879
30880
30881
30882 .section "Resent- header lines" "SECID220"
30883 .cindex "&%Resent-%& header lines"
30884 RFC 2822 makes provision for sets of header lines starting with the string
30885 &`Resent-`& to be added to a message when it is resent by the original
30886 recipient to somebody else. These headers are &'Resent-Date:'&,
30887 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
30888 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
30889
30890 .blockquote
30891 &'Resent fields are strictly informational. They MUST NOT be used in the normal
30892 processing of replies or other such automatic actions on messages.'&
30893 .endblockquote
30894
30895 This leaves things a bit vague as far as other processing actions such as
30896 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30897 follows:
30898
30899 .ilist
30900 A &'Resent-From:'& line that just contains the login id of the submitting user
30901 is automatically rewritten in the same way as &'From:'& (see below).
30902 .next
30903 If there's a rewriting rule for a particular header line, it is also applied to
30904 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30905 &'From:'& also rewrites &'Resent-From:'&.
30906 .next
30907 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30908 also removed.
30909 .next
30910 For a locally-submitted message,
30911 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30912 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30913 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30914 included in log lines in this case.
30915 .next
30916 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30917 &%Resent-%& header lines are present.
30918 .endlist
30919
30920
30921
30922
30923 .section "The Auto-Submitted: header line" "SECID221"
30924 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30925 includes the header line:
30926 .code
30927 Auto-Submitted: auto-replied
30928 .endd
30929
30930 .section "The Bcc: header line" "SECID222"
30931 .cindex "&'Bcc:'& header line"
30932 If Exim is called with the &%-t%& option, to take recipient addresses from a
30933 message's header, it removes any &'Bcc:'& header line that may exist (after
30934 extracting its addresses). If &%-t%& is not present on the command line, any
30935 existing &'Bcc:'& is not removed.
30936
30937
30938 .section "The Date: header line" "SECID223"
30939 .cindex "&'Date:'& header line"
30940 If a locally-generated or submission-mode message has no &'Date:'& header line,
30941 Exim adds one, using the current date and time, unless the
30942 &%suppress_local_fixups%& control has been specified.
30943
30944 .section "The Delivery-date: header line" "SECID224"
30945 .cindex "&'Delivery-date:'& header line"
30946 .oindex "&%delivery_date_remove%&"
30947 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30948 set. Exim can be configured to add them to the final delivery of messages. (See
30949 the generic &%delivery_date_add%& transport option.) They should not be present
30950 in messages in transit. If the &%delivery_date_remove%& configuration option is
30951 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30952 messages.
30953
30954
30955 .section "The Envelope-to: header line" "SECID225"
30956 .cindex "&'Envelope-to:'& header line"
30957 .oindex "&%envelope_to_remove%&"
30958 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30959 Exim can be configured to add them to the final delivery of messages. (See the
30960 generic &%envelope_to_add%& transport option.) They should not be present in
30961 messages in transit. If the &%envelope_to_remove%& configuration option is set
30962 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30963 messages.
30964
30965
30966 .section "The From: header line" "SECTthefrohea"
30967 .cindex "&'From:'& header line"
30968 .cindex "Sendmail compatibility" "&""From""& line"
30969 .cindex "message" "submission"
30970 .cindex "submission mode"
30971 If a submission-mode message does not contain a &'From:'& header line, Exim
30972 adds one if either of the following conditions is true:
30973
30974 .ilist
30975 The envelope sender address is not empty (that is, this is not a bounce
30976 message). The added header line copies the envelope sender address.
30977 .next
30978 .vindex "&$authenticated_id$&"
30979 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30980 .olist
30981 .vindex "&$qualify_domain$&"
30982 If no domain is specified by the submission control, the local part is
30983 &$authenticated_id$& and the domain is &$qualify_domain$&.
30984 .next
30985 If a non-empty domain is specified by the submission control, the local
30986 part is &$authenticated_id$&, and the domain is the specified domain.
30987 .next
30988 If an empty domain is specified by the submission control,
30989 &$authenticated_id$& is assumed to be the complete address.
30990 .endlist
30991 .endlist
30992
30993 A non-empty envelope sender takes precedence.
30994
30995 If a locally-generated incoming message does not contain a &'From:'& header
30996 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30997 containing the sender's address. The calling user's login name and full name
30998 are used to construct the address, as described in section &<<SECTconstr>>&.
30999 They are obtained from the password data by calling &[getpwuid()]& (but see the
31000 &%unknown_login%& configuration option). The address is qualified with
31001 &%qualify_domain%&.
31002
31003 For compatibility with Sendmail, if an incoming, non-SMTP message has a
31004 &'From:'& header line containing just the unqualified login name of the calling
31005 user, this is replaced by an address containing the user's login name and full
31006 name as described in section &<<SECTconstr>>&.
31007
31008
31009 .section "The Message-ID: header line" "SECID226"
31010 .cindex "&'Message-ID:'& header line"
31011 .cindex "message" "submission"
31012 .oindex "&%message_id_header_text%&"
31013 If a locally-generated or submission-mode incoming message does not contain a
31014 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
31015 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
31016 to the message. If there are any &'Resent-:'& headers in the message, it
31017 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
31018 message id, preceded by the letter E to ensure it starts with a letter, and
31019 followed by @ and the primary host name. Additional information can be included
31020 in this header line by setting the &%message_id_header_text%& and/or
31021 &%message_id_header_domain%& options.
31022
31023
31024 .section "The Received: header line" "SECID227"
31025 .cindex "&'Received:'& header line"
31026 A &'Received:'& header line is added at the start of every message. The
31027 contents are defined by the &%received_header_text%& configuration option, and
31028 Exim automatically adds a semicolon and a timestamp to the configured string.
31029
31030 The &'Received:'& header is generated as soon as the message's header lines
31031 have been received. At this stage, the timestamp in the &'Received:'& header
31032 line is the time that the message started to be received. This is the value
31033 that is seen by the DATA ACL and by the &[local_scan()]& function.
31034
31035 Once a message is accepted, the timestamp in the &'Received:'& header line is
31036 changed to the time of acceptance, which is (apart from a small delay while the
31037 -H spool file is written) the earliest time at which delivery could start.
31038
31039
31040 .section "The References: header line" "SECID228"
31041 .cindex "&'References:'& header line"
31042 Messages created by the &(autoreply)& transport include a &'References:'&
31043 header line. This is constructed according to the rules that are described in
31044 section 3.64 of RFC 2822 (which states that replies should contain such a
31045 header line), and section 3.14 of RFC 3834 (which states that automatic
31046 responses are not different in this respect). However, because some mail
31047 processing software does not cope well with very long header lines, no more
31048 than 12 message IDs are copied from the &'References:'& header line in the
31049 incoming message. If there are more than 12, the first one and then the final
31050 11 are copied, before adding the message ID of the incoming message.
31051
31052
31053
31054 .section "The Return-path: header line" "SECID229"
31055 .cindex "&'Return-path:'& header line"
31056 .oindex "&%return_path_remove%&"
31057 &'Return-path:'& header lines are defined as something an MTA may insert when
31058 it does the final delivery of messages. (See the generic &%return_path_add%&
31059 transport option.) Therefore, they should not be present in messages in
31060 transit. If the &%return_path_remove%& configuration option is set (the
31061 default), Exim removes &'Return-path:'& header lines from incoming messages.
31062
31063
31064
31065 .section "The Sender: header line" "SECTthesenhea"
31066 .cindex "&'Sender:'& header line"
31067 .cindex "message" "submission"
31068 For a locally-originated message from an untrusted user, Exim may remove an
31069 existing &'Sender:'& header line, and it may add a new one. You can modify
31070 these actions by setting the &%local_sender_retain%& option true, the
31071 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31072 control setting.
31073
31074 When a local message is received from an untrusted user and
31075 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31076 control has not been set, a check is made to see if the address given in the
31077 &'From:'& header line is the correct (local) sender of the message. The address
31078 that is expected has the login name as the local part and the value of
31079 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31080 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31081 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31082 line is added to the message.
31083
31084 If you set &%local_from_check%& false, this checking does not occur. However,
31085 the removal of an existing &'Sender:'& line still happens, unless you also set
31086 &%local_sender_retain%& to be true. It is not possible to set both of these
31087 options true at the same time.
31088
31089 .cindex "submission mode"
31090 By default, no processing of &'Sender:'& header lines is done for messages
31091 received over TCP/IP or for messages submitted by trusted users. However, when
31092 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31093 not specified on the submission control, the following processing takes place:
31094
31095 .vindex "&$authenticated_id$&"
31096 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31097 authenticated, and &$authenticated_id$& is not empty, a sender address is
31098 created as follows:
31099
31100 .ilist
31101 .vindex "&$qualify_domain$&"
31102 If no domain is specified by the submission control, the local part is
31103 &$authenticated_id$& and the domain is &$qualify_domain$&.
31104 .next
31105 If a non-empty domain is specified by the submission control, the local part
31106 is &$authenticated_id$&, and the domain is the specified domain.
31107 .next
31108 If an empty domain is specified by the submission control,
31109 &$authenticated_id$& is assumed to be the complete address.
31110 .endlist
31111
31112 This address is compared with the address in the &'From:'& header line. If they
31113 are different, a &'Sender:'& header line containing the created address is
31114 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31115 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31116
31117 .cindex "return path" "created from &'Sender:'&"
31118 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31119 the message (the envelope sender address) is changed to be the same address,
31120 except in the case of submission mode when &%sender_retain%& is specified.
31121
31122
31123
31124 .section "Adding and removing header lines in routers and transports" &&&
31125          "SECTheadersaddrem"
31126 .cindex "header lines" "adding; in router or transport"
31127 .cindex "header lines" "removing; in router or transport"
31128 When a message is delivered, the addition and removal of header lines can be
31129 specified in a system filter, or on any of the routers and transports that
31130 process the message. Section &<<SECTaddremheasys>>& contains details about
31131 modifying headers in a system filter. Header lines can also be added in an ACL
31132 as a message is received (see section &<<SECTaddheadacl>>&).
31133
31134 In contrast to what happens in a system filter, header modifications that are
31135 specified on routers and transports apply only to the particular recipient
31136 addresses that are being processed by those routers and transports. These
31137 changes do not actually take place until a copy of the message is being
31138 transported. Therefore, they do not affect the basic set of header lines, and
31139 they do not affect the values of the variables that refer to header lines.
31140
31141 &*Note*&: In particular, this means that any expansions in the configuration of
31142 the transport cannot refer to the modified header lines, because such
31143 expansions all occur before the message is actually transported.
31144
31145 For both routers and transports, the result of expanding a &%headers_add%&
31146 option must be in the form of one or more RFC 2822 header lines, separated by
31147 newlines (coded as &"\n"&). For example:
31148 .code
31149 headers_add = X-added-header: added by $primary_hostname\n\
31150               X-added-second: another added header line
31151 .endd
31152 Exim does not check the syntax of these added header lines.
31153
31154 The result of expanding &%headers_remove%& must consist of a colon-separated
31155 list of header names. This is confusing, because header names themselves are
31156 often terminated by colons. In this case, the colons are the list separators,
31157 not part of the names. For example:
31158 .code
31159 headers_remove = return-receipt-to:acknowledge-to
31160 .endd
31161 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31162 is expanded at routing time, and then associated with all addresses that are
31163 accepted by that router, and also with any new addresses that it generates. If
31164 an address passes through several routers as a result of aliasing or
31165 forwarding, the changes are cumulative.
31166
31167 .oindex "&%unseen%&"
31168 However, this does not apply to multiple routers that result from the use of
31169 the &%unseen%& option. Any header modifications that were specified by the
31170 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31171
31172 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31173 settings cannot be delivered together in a batch, so a transport is always
31174 dealing with a set of addresses that have the same header-processing
31175 requirements.
31176
31177 The transport starts by writing the original set of header lines that arrived
31178 with the message, possibly modified by the system filter. As it writes out
31179 these lines, it consults the list of header names that were attached to the
31180 recipient address(es) by &%headers_remove%& options in routers, and it also
31181 consults the transport's own &%headers_remove%& option. Header lines whose
31182 names are on either of these lists are not written out. If there are multiple
31183 instances of any listed header, they are all skipped.
31184
31185 After the remaining original header lines have been written, new header
31186 lines that were specified by routers' &%headers_add%& options are written, in
31187 the order in which they were attached to the address. These are followed by any
31188 header lines specified by the transport's &%headers_add%& option.
31189
31190 This way of handling header line modifications in routers and transports has
31191 the following consequences:
31192
31193 .ilist
31194 The original set of header lines, possibly modified by the system filter,
31195 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31196 to it, at all times.
31197 .next
31198 Header lines that are added by a router's
31199 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31200 expansion syntax in subsequent routers or the transport.
31201 .next
31202 Conversely, header lines that are specified for removal by &%headers_remove%&
31203 in a router remain visible to subsequent routers and the transport.
31204 .next
31205 Headers added to an address by &%headers_add%& in a router cannot be removed by
31206 a later router or by a transport.
31207 .next
31208 An added header can refer to the contents of an original header that is to be
31209 removed, even it has the same name as the added header. For example:
31210 .code
31211 headers_remove = subject
31212 headers_add = Subject: new subject (was: $h_subject:)
31213 .endd
31214 .endlist
31215
31216 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31217 for a &(redirect)& router that has the &%one_time%& option set.
31218
31219
31220
31221
31222
31223 .section "Constructed addresses" "SECTconstr"
31224 .cindex "address" "constructed"
31225 .cindex "constructed address"
31226 When Exim constructs a sender address for a locally-generated message, it uses
31227 the form
31228 .display
31229 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31230 .endd
31231 For example:
31232 .code
31233 Zaphod Beeblebrox <zaphod@end.univ.example>
31234 .endd
31235 The user name is obtained from the &%-F%& command line option if set, or
31236 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31237 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31238 ampersand character, this is replaced by the login name with the first letter
31239 upper cased, as is conventional in a number of operating systems. See the
31240 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31241 The &%unknown_username%& option can be used to specify user names in cases when
31242 there is no password file entry.
31243
31244 .cindex "RFC 2047"
31245 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31246 parts of it if necessary. In addition, if it contains any non-printing
31247 characters, it is encoded as described in RFC 2047, which defines a way of
31248 including non-ASCII characters in header lines. The value of the
31249 &%headers_charset%& option specifies the name of the encoding that is used (the
31250 characters are assumed to be in this encoding). The setting of
31251 &%print_topbitchars%& controls whether characters with the top bit set (that
31252 is, with codes greater than 127) count as printing characters or not.
31253
31254
31255
31256 .section "Case of local parts" "SECID230"
31257 .cindex "case of local parts"
31258 .cindex "local part" "case of"
31259 RFC 2822 states that the case of letters in the local parts of addresses cannot
31260 be assumed to be non-significant. Exim preserves the case of local parts of
31261 addresses, but by default it uses a lower-cased form when it is routing,
31262 because on most Unix systems, usernames are in lower case and case-insensitive
31263 routing is required. However, any particular router can be made to use the
31264 original case for local parts by setting the &%caseful_local_part%& generic
31265 router option.
31266
31267 .cindex "mixed-case login names"
31268 If you must have mixed-case user names on your system, the best way to proceed,
31269 assuming you want case-independent handling of incoming email, is to set up
31270 your first router to convert incoming local parts in your domains to the
31271 correct case by means of a file lookup. For example:
31272 .code
31273 correct_case:
31274   driver = redirect
31275   domains = +local_domains
31276   data = ${lookup{$local_part}cdb\
31277               {/etc/usercased.cdb}{$value}fail}\
31278               @$domain
31279 .endd
31280 For this router, the local part is forced to lower case by the default action
31281 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31282 up a new local part in the correct case. If you then set &%caseful_local_part%&
31283 on any subsequent routers which process your domains, they will operate on
31284 local parts with the correct case in a case-sensitive manner.
31285
31286
31287
31288 .section "Dots in local parts" "SECID231"
31289 .cindex "dot" "in local part"
31290 .cindex "local part" "dots in"
31291 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31292 part may not begin or end with a dot, nor have two consecutive dots in the
31293 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31294 empty components for compatibility.
31295
31296
31297
31298 .section "Rewriting addresses" "SECID232"
31299 .cindex "rewriting" "addresses"
31300 Rewriting of sender and recipient addresses, and addresses in headers, can
31301 happen automatically, or as the result of configuration options, as described
31302 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31303 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31304
31305 Automatic rewriting includes qualification, as mentioned above. The other case
31306 in which it can happen is when an incomplete non-local domain is given. The
31307 routing process may cause this to be expanded into the full domain name. For
31308 example, a header such as
31309 .code
31310 To: hare@teaparty
31311 .endd
31312 might get rewritten as
31313 .code
31314 To: hare@teaparty.wonderland.fict.example
31315 .endd
31316 Rewriting as a result of routing is the one kind of message processing that
31317 does not happen at input time, as it cannot be done until the address has
31318 been routed.
31319
31320 Strictly, one should not do &'any'& deliveries of a message until all its
31321 addresses have been routed, in case any of the headers get changed as a
31322 result of routing. However, doing this in practice would hold up many
31323 deliveries for unreasonable amounts of time, just because one address could not
31324 immediately be routed. Exim therefore does not delay other deliveries when
31325 routing of one or more addresses is deferred.
31326 .ecindex IIDmesproc
31327
31328
31329
31330 . ////////////////////////////////////////////////////////////////////////////
31331 . ////////////////////////////////////////////////////////////////////////////
31332
31333 .chapter "SMTP processing" "CHAPSMTP"
31334 .scindex IIDsmtpproc1 "SMTP" "processing details"
31335 .scindex IIDsmtpproc2 "LMTP" "processing details"
31336 Exim supports a number of different ways of using the SMTP protocol, and its
31337 LMTP variant, which is an interactive protocol for transferring messages into a
31338 closed mail store application. This chapter contains details of how SMTP is
31339 processed. For incoming mail, the following are available:
31340
31341 .ilist
31342 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31343 .next
31344 SMTP over the standard input and output (the &%-bs%& option);
31345 .next
31346 Batched SMTP on the standard input (the &%-bS%& option).
31347 .endlist
31348
31349 For mail delivery, the following are available:
31350
31351 .ilist
31352 SMTP over TCP/IP (the &(smtp)& transport);
31353 .next
31354 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31355 &"lmtp"&);
31356 .next
31357 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31358 transport);
31359 .next
31360 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31361 the &%use_bsmtp%& option set).
31362 .endlist
31363
31364 &'Batched SMTP'& is the name for a process in which batches of messages are
31365 stored in or read from files (or pipes), in a format in which SMTP commands are
31366 used to contain the envelope information.
31367
31368
31369
31370 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
31371 .cindex "SMTP" "outgoing over TCP/IP"
31372 .cindex "outgoing SMTP over TCP/IP"
31373 .cindex "LMTP" "over TCP/IP"
31374 .cindex "outgoing LMTP over TCP/IP"
31375 .cindex "EHLO"
31376 .cindex "HELO"
31377 .cindex "SIZE option on MAIL command"
31378 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
31379 The &%protocol%& option selects which protocol is to be used, but the actual
31380 processing is the same in both cases.
31381
31382 If, in response to its EHLO command, Exim is told that the SIZE
31383 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
31384 command. The value of <&'n'&> is the message size plus the value of the
31385 &%size_addition%& option (default 1024) to allow for additions to the message
31386 such as per-transport header lines, or changes made in a
31387 .cindex "transport" "filter"
31388 .cindex "filter" "transport filter"
31389 transport filter. If &%size_addition%& is set negative, the use of SIZE is
31390 suppressed.
31391
31392 If the remote server advertises support for PIPELINING, Exim uses the
31393 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
31394 required for the transaction.
31395
31396 If the remote server advertises support for the STARTTLS command, and Exim
31397 was built to support TLS encryption, it tries to start a TLS session unless the
31398 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
31399
31400 If the remote server advertises support for the AUTH command, Exim scans
31401 the authenticators configuration for any suitable client settings, as described
31402 in chapter &<<CHAPSMTPAUTH>>&.
31403
31404 .cindex "carriage return"
31405 .cindex "linefeed"
31406 Responses from the remote host are supposed to be terminated by CR followed by
31407 LF. However, there are known to be hosts that do not send CR characters, so in
31408 order to be able to interwork with such hosts, Exim treats LF on its own as a
31409 line terminator.
31410
31411 If a message contains a number of different addresses, all those with the same
31412 characteristics (for example, the same envelope sender) that resolve to the
31413 same set of hosts, in the same order, are sent in a single SMTP transaction,
31414 even if they are for different domains, unless there are more than the setting
31415 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
31416 they are split into groups containing no more than &%max_rcpt%&s addresses
31417 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
31418 in parallel sessions. The order of hosts with identical MX values is not
31419 significant when checking whether addresses can be batched in this way.
31420
31421 When the &(smtp)& transport suffers a temporary failure that is not
31422 message-related, Exim updates its transport-specific database, which contains
31423 records indexed by host name that remember which messages are waiting for each
31424 particular host. It also updates the retry database with new retry times.
31425
31426 .cindex "hints database" "retry keys"
31427 Exim's retry hints are based on host name plus IP address, so if one address of
31428 a multi-homed host is broken, it will soon be skipped most of the time.
31429 See the next section for more detail about error handling.
31430
31431 .cindex "SMTP" "passed connection"
31432 .cindex "SMTP" "batching over TCP/IP"
31433 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
31434 looks in the hints database for the transport to see if there are any queued
31435 messages waiting for the host to which it is connected. If it finds one, it
31436 creates a new Exim process using the &%-MC%& option (which can only be used by
31437 a process running as root or the Exim user) and passes the TCP/IP socket to it
31438 so that it can deliver another message using the same socket. The new process
31439 does only those deliveries that are routed to the connected host, and may in
31440 turn pass the socket on to a third process, and so on.
31441
31442 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
31443 limit the number of messages sent down a single TCP/IP connection.
31444
31445 .cindex "asterisk" "after IP address"
31446 The second and subsequent messages delivered down an existing connection are
31447 identified in the main log by the addition of an asterisk after the closing
31448 square bracket of the IP address.
31449
31450
31451
31452
31453 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
31454 .cindex "error" "in outgoing SMTP"
31455 .cindex "SMTP" "errors in outgoing"
31456 .cindex "host" "error"
31457 Three different kinds of error are recognized for outgoing SMTP: host errors,
31458 message errors, and recipient errors.
31459
31460 .vlist
31461 .vitem "&*Host errors*&"
31462 A host error is not associated with a particular message or with a
31463 particular recipient of a message. The host errors are:
31464
31465 .ilist
31466 Connection refused or timed out,
31467 .next
31468 Any error response code on connection,
31469 .next
31470 Any error response code to EHLO or HELO,
31471 .next
31472 Loss of connection at any time, except after &"."&,
31473 .next
31474 I/O errors at any time,
31475 .next
31476 Timeouts during the session, other than in response to MAIL, RCPT or
31477 the &"."& at the end of the data.
31478 .endlist ilist
31479
31480 For a host error, a permanent error response on connection, or in response to
31481 EHLO, causes all addresses routed to the host to be failed. Any other host
31482 error causes all addresses to be deferred, and retry data to be created for the
31483 host. It is not tried again, for any message, until its retry time arrives. If
31484 the current set of addresses are not all delivered in this run (to some
31485 alternative host), the message is added to the list of those waiting for this
31486 host, so if it is still undelivered when a subsequent successful delivery is
31487 made to the host, it will be sent down the same SMTP connection.
31488
31489 .vitem "&*Message errors*&"
31490 .cindex "message" "error"
31491 A message error is associated with a particular message when sent to a
31492 particular host, but not with a particular recipient of the message. The
31493 message errors are:
31494
31495 .ilist
31496 Any error response code to MAIL, DATA, or the &"."& that terminates
31497 the data,
31498 .next
31499 Timeout after MAIL,
31500 .next
31501 Timeout or loss of connection after the &"."& that terminates the data. A
31502 timeout after the DATA command itself is treated as a host error, as is loss of
31503 connection at any other time.
31504 .endlist ilist
31505
31506 For a message error, a permanent error response (5&'xx'&) causes all addresses
31507 to be failed, and a delivery error report to be returned to the sender. A
31508 temporary error response (4&'xx'&), or one of the timeouts, causes all
31509 addresses to be deferred. Retry data is not created for the host, but instead,
31510 a retry record for the combination of host plus message id is created. The
31511 message is not added to the list of those waiting for this host. This ensures
31512 that the failing message will not be sent to this host again until the retry
31513 time arrives. However, other messages that are routed to the host are not
31514 affected, so if it is some property of the message that is causing the error,
31515 it will not stop the delivery of other mail.
31516
31517 If the remote host specified support for the SIZE parameter in its response
31518 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
31519 over-large message will cause a message error because the error arrives as a
31520 response to MAIL.
31521
31522 .vitem "&*Recipient errors*&"
31523 .cindex "recipient" "error"
31524 A recipient error is associated with a particular recipient of a message. The
31525 recipient errors are:
31526
31527 .ilist
31528 Any error response to RCPT,
31529 .next
31530 Timeout after RCPT.
31531 .endlist
31532
31533 For a recipient error, a permanent error response (5&'xx'&) causes the
31534 recipient address to be failed, and a bounce message to be returned to the
31535 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
31536 address to be deferred, and routing retry data to be created for it. This is
31537 used to delay processing of the address in subsequent queue runs, until its
31538 routing retry time arrives. This applies to all messages, but because it
31539 operates only in queue runs, one attempt will be made to deliver a new message
31540 to the failing address before the delay starts to operate. This ensures that,
31541 if the failure is really related to the message rather than the recipient
31542 (&"message too big for this recipient"& is a possible example), other messages
31543 have a chance of getting delivered. If a delivery to the address does succeed,
31544 the retry information gets cleared, so all stuck messages get tried again, and
31545 the retry clock is reset.
31546
31547 The message is not added to the list of those waiting for this host. Use of the
31548 host for other messages is unaffected, and except in the case of a timeout,
31549 other recipients are processed independently, and may be successfully delivered
31550 in the current SMTP session. After a timeout it is of course impossible to
31551 proceed with the session, so all addresses get deferred. However, those other
31552 than the one that failed do not suffer any subsequent retry delays. Therefore,
31553 if one recipient is causing trouble, the others have a chance of getting
31554 through when a subsequent delivery attempt occurs before the failing
31555 recipient's retry time.
31556 .endlist
31557
31558 In all cases, if there are other hosts (or IP addresses) available for the
31559 current set of addresses (for example, from multiple MX records), they are
31560 tried in this run for any undelivered addresses, subject of course to their
31561 own retry data. In other words, recipient error retry data does not take effect
31562 until the next delivery attempt.
31563
31564 Some hosts have been observed to give temporary error responses to every
31565 MAIL command at certain times (&"insufficient space"& has been seen). It
31566 would be nice if such circumstances could be recognized, and defer data for the
31567 host itself created, but this is not possible within the current Exim design.
31568 What actually happens is that retry data for every (host, message) combination
31569 is created.
31570
31571 The reason that timeouts after MAIL and RCPT are treated specially is that
31572 these can sometimes arise as a result of the remote host's verification
31573 procedures. Exim makes this assumption, and treats them as if a temporary error
31574 response had been received. A timeout after &"."& is treated specially because
31575 it is known that some broken implementations fail to recognize the end of the
31576 message if the last character of the last line is a binary zero. Thus, it is
31577 helpful to treat this case as a message error.
31578
31579 Timeouts at other times are treated as host errors, assuming a problem with the
31580 host, or the connection to it. If a timeout after MAIL, RCPT,
31581 or &"."& is really a connection problem, the assumption is that at the next try
31582 the timeout is likely to occur at some other point in the dialogue, causing it
31583 then to be treated as a host error.
31584
31585 There is experimental evidence that some MTAs drop the connection after the
31586 terminating &"."& if they do not like the contents of the message for some
31587 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
31588 should be given. That is why Exim treats this case as a message rather than a
31589 host error, in order not to delay other messages to the same host.
31590
31591
31592
31593
31594 .section "Incoming SMTP messages over TCP/IP" "SECID233"
31595 .cindex "SMTP" "incoming over TCP/IP"
31596 .cindex "incoming SMTP over TCP/IP"
31597 .cindex "inetd"
31598 .cindex "daemon"
31599 Incoming SMTP messages can be accepted in one of two ways: by running a
31600 listening daemon, or by using &'inetd'&. In the latter case, the entry in
31601 &_/etc/inetd.conf_& should be like this:
31602 .code
31603 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
31604 .endd
31605 Exim distinguishes between this case and the case of a locally running user
31606 agent using the &%-bs%& option by checking whether or not the standard input is
31607 a socket. When it is, either the port must be privileged (less than 1024), or
31608 the caller must be root or the Exim user. If any other user passes a socket
31609 with an unprivileged port number, Exim prints a message on the standard error
31610 stream and exits with an error code.
31611
31612 By default, Exim does not make a log entry when a remote host connects or
31613 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
31614 unexpected. It can be made to write such log entries by setting the
31615 &%smtp_connection%& log selector.
31616
31617 .cindex "carriage return"
31618 .cindex "linefeed"
31619 Commands from the remote host are supposed to be terminated by CR followed by
31620 LF. However, there are known to be hosts that do not send CR characters. In
31621 order to be able to interwork with such hosts, Exim treats LF on its own as a
31622 line terminator.
31623 Furthermore, because common code is used for receiving messages from all
31624 sources, a CR on its own is also interpreted as a line terminator. However, the
31625 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
31626
31627 .cindex "EHLO" "invalid data"
31628 .cindex "HELO" "invalid data"
31629 One area that sometimes gives rise to problems concerns the EHLO or
31630 HELO commands. Some clients send syntactically invalid versions of these
31631 commands, which Exim rejects by default. (This is nothing to do with verifying
31632 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
31633 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
31634 match the broken hosts that send invalid commands.
31635
31636 .cindex "SIZE option on MAIL command"
31637 .cindex "MAIL" "SIZE option"
31638 The amount of disk space available is checked whenever SIZE is received on
31639 a MAIL command, independently of whether &%message_size_limit%& or
31640 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
31641 false. A temporary error is given if there is not enough space. If
31642 &%check_spool_space%& is set, the check is for that amount of space plus the
31643 value given with SIZE, that is, it checks that the addition of the incoming
31644 message will not reduce the space below the threshold.
31645
31646 When a message is successfully received, Exim includes the local message id in
31647 its response to the final &"."& that terminates the data. If the remote host
31648 logs this text it can help with tracing what has happened to a message.
31649
31650 The Exim daemon can limit the number of simultaneous incoming connections it is
31651 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
31652 number of simultaneous incoming connections from a single remote host (see the
31653 &%smtp_accept_max_per_host%& option). Additional connection attempts are
31654 rejected using the SMTP temporary error code 421.
31655
31656 The Exim daemon does not rely on the SIGCHLD signal to detect when a
31657 subprocess has finished, as this can get lost at busy times. Instead, it looks
31658 for completed subprocesses every time it wakes up. Provided there are other
31659 things happening (new incoming calls, starts of queue runs), completed
31660 processes will be noticed and tidied away. On very quiet systems you may
31661 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
31662 it will be noticed when the daemon next wakes up.
31663
31664 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
31665 and can also be set up to reject SMTP calls from non-reserved hosts at times of
31666 high system load &-- for details see the &%smtp_accept_reserve%&,
31667 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
31668 applies in both the daemon and &'inetd'& cases.
31669
31670 Exim normally starts a delivery process for each message received, though this
31671 can be varied by means of the &%-odq%& command line option and the
31672 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
31673 number of simultaneously running delivery processes started in this way from
31674 SMTP input can be limited by the &%smtp_accept_queue%& and
31675 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
31676 subsequently received messages are just put on the input queue without starting
31677 a delivery process.
31678
31679 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
31680 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
31681 started up from the &'inetd'& daemon, because in that case each connection is
31682 handled by an entirely independent Exim process. Control by load average is,
31683 however, available with &'inetd'&.
31684
31685 Exim can be configured to verify addresses in incoming SMTP commands as they
31686 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
31687 to rewrite addresses at this time &-- before any syntax checking is done. See
31688 section &<<SECTrewriteS>>&.
31689
31690 Exim can also be configured to limit the rate at which a client host submits
31691 MAIL and RCPT commands in a single SMTP session. See the
31692 &%smtp_ratelimit_hosts%& option.
31693
31694
31695
31696 .section "Unrecognized SMTP commands" "SECID234"
31697 .cindex "SMTP" "unrecognized commands"
31698 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
31699 commands during a single SMTP connection, it drops the connection after sending
31700 the error response to the last command. The default value for
31701 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
31702 abuse that subvert web servers into making connections to SMTP ports; in these
31703 circumstances, a number of non-SMTP lines are sent first.
31704
31705
31706 .section "Syntax and protocol errors in SMTP commands" "SECID235"
31707 .cindex "SMTP" "syntax errors"
31708 .cindex "SMTP" "protocol errors"
31709 A syntax error is detected if an SMTP command is recognized, but there is
31710 something syntactically wrong with its data, for example, a malformed email
31711 address in a RCPT command. Protocol errors include invalid command
31712 sequencing such as RCPT before MAIL. If Exim receives more than
31713 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
31714 drops the connection after sending the error response to the last command. The
31715 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
31716 broken clients that loop sending bad commands (yes, it has been seen).
31717
31718
31719
31720 .section "Use of non-mail SMTP commands" "SECID236"
31721 .cindex "SMTP" "non-mail commands"
31722 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
31723 DATA. Exim counts such commands, and drops the connection if there are too
31724 many of them in a single SMTP session. This action catches some
31725 denial-of-service attempts and things like repeated failing AUTHs, or a mad
31726 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
31727 defines what &"too many"& means. Its default value is 10.
31728
31729 When a new message is expected, one occurrence of RSET is not counted. This
31730 allows a client to send one RSET between messages (this is not necessary,
31731 but some clients do it). Exim also allows one uncounted occurrence of HELO
31732 or EHLO, and one occurrence of STARTTLS between messages. After
31733 starting up a TLS session, another EHLO is expected, and so it too is not
31734 counted.
31735
31736 The first occurrence of AUTH in a connection, or immediately following
31737 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
31738 RCPT, DATA, and QUIT are counted.
31739
31740 You can control which hosts are subject to the limit set by
31741 &%smtp_accept_max_nonmail%& by setting
31742 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
31743 the limit apply to all hosts. This option means that you can exclude any
31744 specific badly-behaved hosts that you have to live with.
31745
31746
31747
31748
31749 .section "The VRFY and EXPN commands" "SECID237"
31750 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
31751 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
31752 appropriate) in order to decide whether the command should be accepted or not.
31753 If no ACL is defined, the command is rejected.
31754
31755 .cindex "VRFY" "processing"
31756 When VRFY is accepted, it runs exactly the same code as when Exim is
31757 called with the &%-bv%& option.
31758
31759 .cindex "EXPN" "processing"
31760 When EXPN is accepted, a single-level expansion of the address is done.
31761 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
31762 than a verification (the &%-bv%& option). If an unqualified local part is given
31763 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
31764 of VRFY and EXPN commands are logged on the main and reject logs, and
31765 VRFY verification failures are logged on the main log for consistency with
31766 RCPT failures.
31767
31768
31769
31770 .section "The ETRN command" "SECTETRN"
31771 .cindex "ETRN" "processing"
31772 RFC 1985 describes an SMTP command called ETRN that is designed to
31773 overcome the security problems of the TURN command (which has fallen into
31774 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
31775 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
31776 should be accepted or not. If no ACL is defined, the command is rejected.
31777
31778 The ETRN command is concerned with &"releasing"& messages that are awaiting
31779 delivery to certain hosts. As Exim does not organize its message queue by host,
31780 the only form of ETRN that is supported by default is the one where the
31781 text starts with the &"#"& prefix, in which case the remainder of the text is
31782 specific to the SMTP server. A valid ETRN command causes a run of Exim with
31783 the &%-R%& option to happen, with the remainder of the ETRN text as its
31784 argument. For example,
31785 .code
31786 ETRN #brigadoon
31787 .endd
31788 runs the command
31789 .code
31790 exim -R brigadoon
31791 .endd
31792 which causes a delivery attempt on all messages with undelivered addresses
31793 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
31794 default), Exim prevents the simultaneous execution of more than one queue run
31795 for the same argument string as a result of an ETRN command. This stops
31796 a misbehaving client from starting more than one queue runner at once.
31797
31798 .cindex "hints database" "ETRN serialization"
31799 Exim implements the serialization by means of a hints database in which a
31800 record is written whenever a process is started by ETRN, and deleted when
31801 the process completes. However, Exim does not keep the SMTP session waiting for
31802 the ETRN process to complete. Once ETRN is accepted, the client is sent
31803 a &"success"& return code. Obviously there is scope for hints records to get
31804 left lying around if there is a system or program crash. To guard against this,
31805 Exim ignores any records that are more than six hours old.
31806
31807 .oindex "&%smtp_etrn_command%&"
31808 For more control over what ETRN does, the &%smtp_etrn_command%& option can
31809 used. This specifies a command that is run whenever ETRN is received,
31810 whatever the form of its argument. For
31811 example:
31812 .code
31813 smtp_etrn_command = /etc/etrn_command $domain \
31814                     $sender_host_address
31815 .endd
31816 .vindex "&$domain$&"
31817 The string is split up into arguments which are independently expanded. The
31818 expansion variable &$domain$& is set to the argument of the ETRN command,
31819 and no syntax checking is done on the contents of this argument. Exim does not
31820 wait for the command to complete, so its status code is not checked. Exim runs
31821 under its own uid and gid when receiving incoming SMTP, so it is not possible
31822 for it to change them before running the command.
31823
31824
31825
31826 .section "Incoming local SMTP" "SECID238"
31827 .cindex "SMTP" "local incoming"
31828 Some user agents use SMTP to pass messages to their local MTA using the
31829 standard input and output, as opposed to passing the envelope on the command
31830 line and writing the message to the standard input. This is supported by the
31831 &%-bs%& option. This form of SMTP is handled in the same way as incoming
31832 messages over TCP/IP (including the use of ACLs), except that the envelope
31833 sender given in a MAIL command is ignored unless the caller is trusted. In
31834 an ACL you can detect this form of SMTP input by testing for an empty host
31835 identification. It is common to have this as the first line in the ACL that
31836 runs for RCPT commands:
31837 .code
31838 accept hosts = :
31839 .endd
31840 This accepts SMTP messages from local processes without doing any other tests.
31841
31842
31843
31844 .section "Outgoing batched SMTP" "SECTbatchSMTP"
31845 .cindex "SMTP" "batched outgoing"
31846 .cindex "batched SMTP output"
31847 Both the &(appendfile)& and &(pipe)& transports can be used for handling
31848 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
31849 be output in BSMTP format. No SMTP responses are possible for this form of
31850 delivery. All it is doing is using SMTP commands as a way of transmitting the
31851 envelope along with the message.
31852
31853 The message is written to the file or pipe preceded by the SMTP commands
31854 MAIL and RCPT, and followed by a line containing a single dot. Lines in
31855 the message that start with a dot have an extra dot added. The SMTP command
31856 HELO is not normally used. If it is required, the &%message_prefix%& option
31857 can be used to specify it.
31858
31859 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
31860 one recipient address at a time by default. However, you can arrange for them
31861 to handle several addresses at once by setting the &%batch_max%& option. When
31862 this is done for BSMTP, messages may contain multiple RCPT commands. See
31863 chapter &<<CHAPbatching>>& for more details.
31864
31865 .vindex "&$host$&"
31866 When one or more addresses are routed to a BSMTP transport by a router that
31867 sets up a host list, the name of the first host on the list is available to the
31868 transport in the variable &$host$&. Here is an example of such a transport and
31869 router:
31870 .code
31871 begin routers
31872 route_append:
31873   driver = manualroute
31874   transport = smtp_appendfile
31875   route_list = domain.example  batch.host.example
31876
31877 begin transports
31878 smtp_appendfile:
31879   driver = appendfile
31880   directory = /var/bsmtp/$host
31881   batch_max = 1000
31882   use_bsmtp
31883   user = exim
31884 .endd
31885 This causes messages addressed to &'domain.example'& to be written in BSMTP
31886 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
31887 message (unless there are more than 1000 recipients).
31888
31889
31890
31891 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
31892 .cindex "SMTP" "batched incoming"
31893 .cindex "batched SMTP input"
31894 The &%-bS%& command line option causes Exim to accept one or more messages by
31895 reading SMTP on the standard input, but to generate no responses. If the caller
31896 is trusted, the senders in the MAIL commands are believed; otherwise the
31897 sender is always the caller of Exim. Unqualified senders and receivers are not
31898 rejected (there seems little point) but instead just get qualified. HELO
31899 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31900 as NOOP; QUIT quits.
31901
31902 Minimal policy checking is done for BSMTP input. Only the non-SMTP
31903 ACL is run in the same way as for non-SMTP local input.
31904
31905 If an error is detected while reading a message, including a missing &"."& at
31906 the end, Exim gives up immediately. It writes details of the error to the
31907 standard output in a stylized way that the calling program should be able to
31908 make some use of automatically, for example:
31909 .code
31910 554 Unexpected end of file
31911 Transaction started in line 10
31912 Error detected in line 14
31913 .endd
31914 It writes a more verbose version, for human consumption, to the standard error
31915 file, for example:
31916 .code
31917 An error was detected while processing a file of BSMTP input.
31918 The error message was:
31919
31920 501 '>' missing at end of address
31921
31922 The SMTP transaction started in line 10.
31923 The error was detected in line 12.
31924 The SMTP command at fault was:
31925
31926 rcpt to:<malformed@in.com.plete
31927
31928 1 previous message was successfully processed.
31929 The rest of the batch was abandoned.
31930 .endd
31931 The return code from Exim is zero only if there were no errors. It is 1 if some
31932 messages were accepted before an error was detected, and 2 if no messages were
31933 accepted.
31934 .ecindex IIDsmtpproc1
31935 .ecindex IIDsmtpproc2
31936
31937
31938
31939 . ////////////////////////////////////////////////////////////////////////////
31940 . ////////////////////////////////////////////////////////////////////////////
31941
31942 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31943          "Customizing messages"
31944 When a message fails to be delivered, or remains on the queue for more than a
31945 configured amount of time, Exim sends a message to the original sender, or
31946 to an alternative configured address. The text of these messages is built into
31947 the code of Exim, but it is possible to change it, either by adding a single
31948 string, or by replacing each of the paragraphs by text supplied in a file.
31949
31950 The &'From:'& and &'To:'& header lines are automatically generated; you can
31951 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31952 option. Exim also adds the line
31953 .code
31954 Auto-Submitted: auto-generated
31955 .endd
31956 to all warning and bounce messages,
31957
31958
31959 .section "Customizing bounce messages" "SECID239"
31960 .cindex "customizing" "bounce message"
31961 .cindex "bounce message" "customizing"
31962 If &%bounce_message_text%& is set, its contents are included in the default
31963 message immediately after &"This message was created automatically by mail
31964 delivery software."& The string is not expanded. It is not used if
31965 &%bounce_message_file%& is set.
31966
31967 When &%bounce_message_file%& is set, it must point to a template file for
31968 constructing error messages. The file consists of a series of text items,
31969 separated by lines consisting of exactly four asterisks. If the file cannot be
31970 opened, default text is used and a message is written to the main and panic
31971 logs. If any text item in the file is empty, default text is used for that
31972 item.
31973
31974 .vindex "&$bounce_recipient$&"
31975 .vindex "&$bounce_return_size_limit$&"
31976 Each item of text that is read from the file is expanded, and there are two
31977 expansion variables which can be of use here: &$bounce_recipient$& is set to
31978 the recipient of an error message while it is being created, and
31979 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31980 option, rounded to a whole number.
31981
31982 The items must appear in the file in the following order:
31983
31984 .ilist
31985 The first item is included in the headers, and should include at least a
31986 &'Subject:'& header. Exim does not check the syntax of these headers.
31987 .next
31988 The second item forms the start of the error message. After it, Exim lists the
31989 failing addresses with their error messages.
31990 .next
31991 The third item is used to introduce any text from pipe transports that is to be
31992 returned to the sender. It is omitted if there is no such text.
31993 .next
31994 The fourth item is used to introduce the copy of the message that is returned
31995 as part of the error report.
31996 .next
31997 The fifth item is added after the fourth one if the returned message is
31998 truncated because it is bigger than &%return_size_limit%&.
31999 .next
32000 The sixth item is added after the copy of the original message.
32001 .endlist
32002
32003 The default state (&%bounce_message_file%& unset) is equivalent to the
32004 following file, in which the sixth item is empty. The &'Subject:'& and some
32005 other lines have been split in order to fit them on the page:
32006 .code
32007 Subject: Mail delivery failed
32008   ${if eq{$sender_address}{$bounce_recipient}
32009   {: returning message to sender}}
32010 ****
32011 This message was created automatically by mail delivery software.
32012
32013 A message ${if eq{$sender_address}{$bounce_recipient}
32014   {that you sent }{sent by
32015
32016 <$sender_address>
32017
32018 }}could not be delivered to all of its recipients.
32019 This is a permanent error. The following address(es) failed:
32020 ****
32021 The following text was generated during the delivery attempt(s):
32022 ****
32023 ------ This is a copy of the message, including all the headers.
32024   ------
32025 ****
32026 ------ The body of the message is $message_size characters long;
32027   only the first
32028 ------ $bounce_return_size_limit or so are included here.
32029 ****
32030 .endd
32031 .section "Customizing warning messages" "SECTcustwarn"
32032 .cindex "customizing" "warning message"
32033 .cindex "warning of delay" "customizing the message"
32034 The option &%warn_message_file%& can be pointed at a template file for use when
32035 warnings about message delays are created. In this case there are only three
32036 text sections:
32037
32038 .ilist
32039 The first item is included in the headers, and should include at least a
32040 &'Subject:'& header. Exim does not check the syntax of these headers.
32041 .next
32042 The second item forms the start of the warning message. After it, Exim lists
32043 the delayed addresses.
32044 .next
32045 The third item then ends the message.
32046 .endlist
32047
32048 The default state is equivalent to the following file, except that some lines
32049 have been split here, in order to fit them on the page:
32050 .code
32051 Subject: Warning: message $message_exim_id delayed
32052   $warn_message_delay
32053 ****
32054 This message was created automatically by mail delivery software.
32055
32056 A message ${if eq{$sender_address}{$warn_message_recipients}
32057 {that you sent }{sent by
32058
32059 <$sender_address>
32060
32061 }}has not been delivered to all of its recipients after
32062 more than $warn_message_delay on the queue on $primary_hostname.
32063
32064 The message identifier is:     $message_exim_id
32065 The subject of the message is: $h_subject
32066 The date of the message is:    $h_date
32067
32068 The following address(es) have not yet been delivered:
32069 ****
32070 No action is required on your part. Delivery attempts will
32071 continue for some time, and this warning may be repeated at
32072 intervals if the message remains undelivered. Eventually the
32073 mail delivery software will give up, and when that happens,
32074 the message will be returned to you.
32075 .endd
32076 .vindex "&$warn_message_delay$&"
32077 .vindex "&$warn_message_recipients$&"
32078 However, in the default state the subject and date lines are omitted if no
32079 appropriate headers exist. During the expansion of this file,
32080 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32081 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32082 of recipients for the warning message. There may be more than one if there are
32083 multiple addresses with different &%errors_to%& settings on the routers that
32084 handled them.
32085
32086
32087
32088
32089 . ////////////////////////////////////////////////////////////////////////////
32090 . ////////////////////////////////////////////////////////////////////////////
32091
32092 .chapter "Some common configuration settings" "CHAPcomconreq"
32093 This chapter discusses some configuration settings that seem to be fairly
32094 common. More examples and discussion can be found in the Exim book.
32095
32096
32097
32098 .section "Sending mail to a smart host" "SECID240"
32099 .cindex "smart host" "example router"
32100 If you want to send all mail for non-local domains to a &"smart host"&, you
32101 should replace the default &(dnslookup)& router with a router which does the
32102 routing explicitly:
32103 .code
32104 send_to_smart_host:
32105   driver = manualroute
32106   route_list = !+local_domains smart.host.name
32107   transport = remote_smtp
32108 .endd
32109 You can use the smart host's IP address instead of the name if you wish.
32110 If you are using Exim only to submit messages to a smart host, and not for
32111 receiving incoming messages, you can arrange for it to do the submission
32112 synchronously by setting the &%mua_wrapper%& option (see chapter
32113 &<<CHAPnonqueueing>>&).
32114
32115
32116
32117
32118 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32119 .cindex "mailing lists"
32120 Exim can be used to run simple mailing lists, but for large and/or complicated
32121 requirements, the use of additional specialized mailing list software such as
32122 Majordomo or Mailman is recommended.
32123
32124 The &(redirect)& router can be used to handle mailing lists where each list
32125 is maintained in a separate file, which can therefore be managed by an
32126 independent manager. The &%domains%& router option can be used to run these
32127 lists in a separate domain from normal mail. For example:
32128 .code
32129 lists:
32130   driver = redirect
32131   domains = lists.example
32132   file = /usr/lists/$local_part
32133   forbid_pipe
32134   forbid_file
32135   errors_to = $local_part-request@lists.example
32136   no_more
32137 .endd
32138 This router is skipped for domains other than &'lists.example'&. For addresses
32139 in that domain, it looks for a file that matches the local part. If there is no
32140 such file, the router declines, but because &%no_more%& is set, no subsequent
32141 routers are tried, and so the whole delivery fails.
32142
32143 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32144 expanded into a file name or a pipe delivery, which is usually inappropriate in
32145 a mailing list.
32146
32147 .oindex "&%errors_to%&"
32148 The &%errors_to%& option specifies that any delivery errors caused by addresses
32149 taken from a mailing list are to be sent to the given address rather than the
32150 original sender of the message. However, before acting on this, Exim verifies
32151 the error address, and ignores it if verification fails.
32152
32153 For example, using the configuration above, mail sent to
32154 &'dicts@lists.example'& is passed on to those addresses contained in
32155 &_/usr/lists/dicts_&, with error reports directed to
32156 &'dicts-request@lists.example'&, provided that this address can be verified.
32157 There could be a file called &_/usr/lists/dicts-request_& containing
32158 the address(es) of this particular list's manager(s), but other approaches,
32159 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32160 or &%local_part_suffix%& options) to handle addresses of the form
32161 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32162
32163
32164
32165 .section "Syntax errors in mailing lists" "SECID241"
32166 .cindex "mailing lists" "syntax errors in"
32167 If an entry in redirection data contains a syntax error, Exim normally defers
32168 delivery of the original address. That means that a syntax error in a mailing
32169 list holds up all deliveries to the list. This may not be appropriate when a
32170 list is being maintained automatically from data supplied by users, and the
32171 addresses are not rigorously checked.
32172
32173 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32174 entries that fail to parse, noting the incident in the log. If in addition
32175 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32176 whenever a broken address is skipped. It is usually appropriate to set
32177 &%syntax_errors_to%& to the same address as &%errors_to%&.
32178
32179
32180
32181 .section "Re-expansion of mailing lists" "SECID242"
32182 .cindex "mailing lists" "re-expansion of"
32183 Exim remembers every individual address to which a message has been delivered,
32184 in order to avoid duplication, but it normally stores only the original
32185 recipient addresses with a message. If all the deliveries to a mailing list
32186 cannot be done at the first attempt, the mailing list is re-expanded when the
32187 delivery is next tried. This means that alterations to the list are taken into
32188 account at each delivery attempt, so addresses that have been added to
32189 the list since the message arrived will therefore receive a copy of the
32190 message, even though it pre-dates their subscription.
32191
32192 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32193 on the &(redirect)& router. If this is done, any addresses generated by the
32194 router that fail to deliver at the first attempt are added to the message as
32195 &"top level"& addresses, and the parent address that generated them is marked
32196 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32197 subsequent delivery attempts. The disadvantage of this is that if any of the
32198 failing addresses are incorrect, correcting them in the file has no effect on
32199 pre-existing messages.
32200
32201 The original top-level address is remembered with each of the generated
32202 addresses, and is output in any log messages. However, any intermediate parent
32203 addresses are not recorded. This makes a difference to the log only if the
32204 &%all_parents%& selector is set, but for mailing lists there is normally only
32205 one level of expansion anyway.
32206
32207
32208
32209 .section "Closed mailing lists" "SECID243"
32210 .cindex "mailing lists" "closed"
32211 The examples so far have assumed open mailing lists, to which anybody may
32212 send mail. It is also possible to set up closed lists, where mail is accepted
32213 from specified senders only. This is done by making use of the generic
32214 &%senders%& option to restrict the router that handles the list.
32215
32216 The following example uses the same file as a list of recipients and as a list
32217 of permitted senders. It requires three routers:
32218 .code
32219 lists_request:
32220   driver = redirect
32221   domains = lists.example
32222   local_part_suffix = -request
32223   file = /usr/lists/$local_part$local_part_suffix
32224   no_more
32225
32226 lists_post:
32227   driver = redirect
32228   domains = lists.example
32229   senders = ${if exists {/usr/lists/$local_part}\
32230              {lsearch;/usr/lists/$local_part}{*}}
32231   file = /usr/lists/$local_part
32232   forbid_pipe
32233   forbid_file
32234   errors_to = $local_part-request@lists.example
32235   no_more
32236
32237 lists_closed:
32238   driver = redirect
32239   domains = lists.example
32240   allow_fail
32241   data = :fail: $local_part@lists.example is a closed mailing list
32242 .endd
32243 All three routers have the same &%domains%& setting, so for any other domains,
32244 they are all skipped. The first router runs only if the local part ends in
32245 &%-request%&. It handles messages to the list manager(s) by means of an open
32246 mailing list.
32247
32248 The second router runs only if the &%senders%& precondition is satisfied. It
32249 checks for the existence of a list that corresponds to the local part, and then
32250 checks that the sender is on the list by means of a linear search. It is
32251 necessary to check for the existence of the file before trying to search it,
32252 because otherwise Exim thinks there is a configuration error. If the file does
32253 not exist, the expansion of &%senders%& is *, which matches all senders. This
32254 means that the router runs, but because there is no list, declines, and
32255 &%no_more%& ensures that no further routers are run. The address fails with an
32256 &"unrouteable address"& error.
32257
32258 The third router runs only if the second router is skipped, which happens when
32259 a mailing list exists, but the sender is not on it. This router forcibly fails
32260 the address, giving a suitable error message.
32261
32262
32263
32264
32265 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32266 .cindex "VERP"
32267 .cindex "Variable Envelope Return Paths"
32268 .cindex "envelope sender"
32269 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32270 are a way of helping mailing list administrators discover which subscription
32271 address is the cause of a particular delivery failure. The idea is to encode
32272 the original recipient address in the outgoing envelope sender address, so that
32273 if the message is forwarded by another host and then subsequently bounces, the
32274 original recipient can be extracted from the recipient address of the bounce.
32275
32276 .oindex &%errors_to%&
32277 .oindex &%return_path%&
32278 Envelope sender addresses can be modified by Exim using two different
32279 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32280 list examples), or the &%return_path%& option on a transport. The second of
32281 these is effective only if the message is successfully delivered to another
32282 host; it is not used for errors detected on the local host (see the description
32283 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32284 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32285 .code
32286 verp_smtp:
32287   driver = smtp
32288   max_rcpt = 1
32289   return_path = \
32290     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32291       {$1-request+$local_part=$domain@your.dom.example}fail}
32292 .endd
32293 This has the effect of rewriting the return path (envelope sender) on outgoing
32294 SMTP messages, if the local part of the original return path ends in
32295 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32296 local part and domain of the recipient into the return path. Suppose, for
32297 example, that a message whose return path has been set to
32298 &'somelist-request@your.dom.example'& is sent to
32299 &'subscriber@other.dom.example'&. In the transport, the return path is
32300 rewritten as
32301 .code
32302 somelist-request+subscriber=other.dom.example@your.dom.example
32303 .endd
32304 .vindex "&$local_part$&"
32305 For this to work, you must tell Exim to send multiple copies of messages that
32306 have more than one recipient, so that each copy has just one recipient. This is
32307 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32308 might be sent to several different recipients in the same domain, in which case
32309 &$local_part$& is not available in the transport, because it is not unique.
32310
32311 Unless your host is doing nothing but mailing list deliveries, you should
32312 probably use a separate transport for the VERP deliveries, so as not to use
32313 extra resources in making one-per-recipient copies for other deliveries. This
32314 can easily be done by expanding the &%transport%& option in the router:
32315 .code
32316 dnslookup:
32317   driver = dnslookup
32318   domains = ! +local_domains
32319   transport = \
32320     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32321       {verp_smtp}{remote_smtp}}
32322   no_more
32323 .endd
32324 If you want to change the return path using &%errors_to%& in a router instead
32325 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32326 routers that handle mailing list addresses. This will ensure that all delivery
32327 errors, including those detected on the local host, are sent to the VERP
32328 address.
32329
32330 On a host that does no local deliveries and has no manual routing, only the
32331 &(dnslookup)& router needs to be changed. A special transport is not needed for
32332 SMTP deliveries. Every mailing list recipient has its own return path value,
32333 and so Exim must hand them to the transport one at a time. Here is an example
32334 of a &(dnslookup)& router that implements VERP:
32335 .code
32336 verp_dnslookup:
32337   driver = dnslookup
32338   domains = ! +local_domains
32339   transport = remote_smtp
32340   errors_to = \
32341     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32342      {$1-request+$local_part=$domain@your.dom.example}fail}
32343   no_more
32344 .endd
32345 Before you start sending out messages with VERPed return paths, you must also
32346 configure Exim to accept the bounce messages that come back to those paths.
32347 Typically this is done by setting a &%local_part_suffix%& option for a
32348 router, and using this to route the messages to wherever you want to handle
32349 them.
32350
32351 The overhead incurred in using VERP depends very much on the size of the
32352 message, the number of recipient addresses that resolve to the same remote
32353 host, and the speed of the connection over which the message is being sent. If
32354 a lot of addresses resolve to the same host and the connection is slow, sending
32355 a separate copy of the message for each address may take substantially longer
32356 than sending a single copy with many recipients (for which VERP cannot be
32357 used).
32358
32359
32360
32361
32362
32363
32364 .section "Virtual domains" "SECTvirtualdomains"
32365 .cindex "virtual domains"
32366 .cindex "domain" "virtual"
32367 The phrase &'virtual domain'& is unfortunately used with two rather different
32368 meanings:
32369
32370 .ilist
32371 A domain for which there are no real mailboxes; all valid local parts are
32372 aliases for other email addresses. Common examples are organizational
32373 top-level domains and &"vanity"& domains.
32374 .next
32375 One of a number of independent domains that are all handled by the same host,
32376 with mailboxes on that host, but where the mailbox owners do not necessarily
32377 have login accounts on that host.
32378 .endlist
32379
32380 The first usage is probably more common, and does seem more &"virtual"& than
32381 the second. This kind of domain can be handled in Exim with a straightforward
32382 aliasing router. One approach is to create a separate alias file for each
32383 virtual domain. Exim can test for the existence of the alias file to determine
32384 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
32385 to a router of this form:
32386 .code
32387 virtual:
32388   driver = redirect
32389   domains = dsearch;/etc/mail/virtual
32390   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
32391   no_more
32392 .endd
32393 The &%domains%& option specifies that the router is to be skipped, unless there
32394 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
32395 domain that is being processed. When the router runs, it looks up the local
32396 part in the file to find a new address (or list of addresses). The &%no_more%&
32397 setting ensures that if the lookup fails (leading to &%data%& being an empty
32398 string), Exim gives up on the address without trying any subsequent routers.
32399
32400 This one router can handle all the virtual domains because the alias file names
32401 follow a fixed pattern. Permissions can be arranged so that appropriate people
32402 can edit the different alias files. A successful aliasing operation results in
32403 a new envelope recipient address, which is then routed from scratch.
32404
32405 The other kind of &"virtual"& domain can also be handled in a straightforward
32406 way. One approach is to create a file for each domain containing a list of
32407 valid local parts, and use it in a router like this:
32408 .code
32409 my_domains:
32410   driver = accept
32411   domains = dsearch;/etc/mail/domains
32412   local_parts = lsearch;/etc/mail/domains/$domain
32413   transport = my_mailboxes
32414 .endd
32415 The address is accepted if there is a file for the domain, and the local part
32416 can be found in the file. The &%domains%& option is used to check for the
32417 file's existence because &%domains%& is tested before the &%local_parts%&
32418 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
32419 because that option is tested after &%local_parts%&. The transport is as
32420 follows:
32421 .code
32422 my_mailboxes:
32423   driver = appendfile
32424   file = /var/mail/$domain/$local_part
32425   user = mail
32426 .endd
32427 This uses a directory of mailboxes for each domain. The &%user%& setting is
32428 required, to specify which uid is to be used for writing to the mailboxes.
32429
32430 The configuration shown here is just one example of how you might support this
32431 requirement. There are many other ways this kind of configuration can be set
32432 up, for example, by using a database instead of separate files to hold all the
32433 information about the domains.
32434
32435
32436
32437 .section "Multiple user mailboxes" "SECTmulbox"
32438 .cindex "multiple mailboxes"
32439 .cindex "mailbox" "multiple"
32440 .cindex "local part" "prefix"
32441 .cindex "local part" "suffix"
32442 Heavy email users often want to operate with multiple mailboxes, into which
32443 incoming mail is automatically sorted. A popular way of handling this is to
32444 allow users to use multiple sender addresses, so that replies can easily be
32445 identified. Users are permitted to add prefixes or suffixes to their local
32446 parts for this purpose. The wildcard facility of the generic router options
32447 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
32448 example, consider this router:
32449 .code
32450 userforward:
32451   driver = redirect
32452   check_local_user
32453   file = $home/.forward
32454   local_part_suffix = -*
32455   local_part_suffix_optional
32456   allow_filter
32457 .endd
32458 .vindex "&$local_part_suffix$&"
32459 It runs a user's &_.forward_& file for all local parts of the form
32460 &'username-*'&. Within the filter file the user can distinguish different
32461 cases by testing the variable &$local_part_suffix$&. For example:
32462 .code
32463 if $local_part_suffix contains -special then
32464 save /home/$local_part/Mail/special
32465 endif
32466 .endd
32467 If the filter file does not exist, or does not deal with such addresses, they
32468 fall through to subsequent routers, and, assuming no subsequent use of the
32469 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
32470 control over which suffixes are valid.
32471
32472 Alternatively, a suffix can be used to trigger the use of a different
32473 &_.forward_& file &-- which is the way a similar facility is implemented in
32474 another MTA:
32475 .code
32476 userforward:
32477   driver = redirect
32478   check_local_user
32479   file = $home/.forward$local_part_suffix
32480   local_part_suffix = -*
32481   local_part_suffix_optional
32482   allow_filter
32483 .endd
32484 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
32485 example, &_.forward-special_& is used. Once again, if the appropriate file
32486 does not exist, or does not deal with the address, it is passed on to
32487 subsequent routers, which could, if required, look for an unqualified
32488 &_.forward_& file to use as a default.
32489
32490
32491
32492 .section "Simplified vacation processing" "SECID244"
32493 .cindex "vacation processing"
32494 The traditional way of running the &'vacation'& program is for a user to set up
32495 a pipe command in a &_.forward_& file
32496 (see section &<<SECTspecitredli>>& for syntax details).
32497 This is prone to error by inexperienced users. There are two features of Exim
32498 that can be used to make this process simpler for users:
32499
32500 .ilist
32501 A local part prefix such as &"vacation-"& can be specified on a router which
32502 can cause the message to be delivered directly to the &'vacation'& program, or
32503 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
32504 &_.forward_& file are then much simpler. For example:
32505 .code
32506 spqr, vacation-spqr
32507 .endd
32508 .next
32509 The &%require_files%& generic router option can be used to trigger a
32510 vacation delivery by checking for the existence of a certain file in the
32511 user's home directory. The &%unseen%& generic option should also be used, to
32512 ensure that the original delivery also proceeds. In this case, all the user has
32513 to do is to create a file called, say, &_.vacation_&, containing a vacation
32514 message.
32515 .endlist
32516
32517 Another advantage of both these methods is that they both work even when the
32518 use of arbitrary pipes by users is locked out.
32519
32520
32521
32522 .section "Taking copies of mail" "SECID245"
32523 .cindex "message" "copying every"
32524 Some installations have policies that require archive copies of all messages to
32525 be made. A single copy of each message can easily be taken by an appropriate
32526 command in a system filter, which could, for example, use a different file for
32527 each day's messages.
32528
32529 There is also a shadow transport mechanism that can be used to take copies of
32530 messages that are successfully delivered by local transports, one copy per
32531 delivery. This could be used, &'inter alia'&, to implement automatic
32532 notification of delivery by sites that insist on doing such things.
32533
32534
32535
32536 .section "Intermittently connected hosts" "SECID246"
32537 .cindex "intermittently connected hosts"
32538 It has become quite common (because it is cheaper) for hosts to connect to the
32539 Internet periodically rather than remain connected all the time. The normal
32540 arrangement is that mail for such hosts accumulates on a system that is
32541 permanently connected.
32542
32543 Exim was designed for use on permanently connected hosts, and so it is not
32544 particularly well-suited to use in an intermittently connected environment.
32545 Nevertheless there are some features that can be used.
32546
32547
32548 .section "Exim on the upstream server host" "SECID247"
32549 It is tempting to arrange for incoming mail for the intermittently connected
32550 host to remain on Exim's queue until the client connects. However, this
32551 approach does not scale very well. Two different kinds of waiting message are
32552 being mixed up in the same queue &-- those that cannot be delivered because of
32553 some temporary problem, and those that are waiting for their destination host
32554 to connect. This makes it hard to manage the queue, as well as wasting
32555 resources, because each queue runner scans the entire queue.
32556
32557 A better approach is to separate off those messages that are waiting for an
32558 intermittently connected host. This can be done by delivering these messages
32559 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
32560 format, from where they are transmitted by other software when their
32561 destination connects. This makes it easy to collect all the mail for one host
32562 in a single directory, and to apply local timeout rules on a per-message basis
32563 if required.
32564
32565 On a very small scale, leaving the mail on Exim's queue can be made to work. If
32566 you are doing this, you should configure Exim with a long retry period for the
32567 intermittent host. For example:
32568 .code
32569 cheshire.wonderland.fict.example    *   F,5d,24h
32570 .endd
32571 This stops a lot of failed delivery attempts from occurring, but Exim remembers
32572 which messages it has queued up for that host. Once the intermittent host comes
32573 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
32574 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
32575 causes all the queued up messages to be delivered, often down a single SMTP
32576 connection. While the host remains connected, any new messages get delivered
32577 immediately.
32578
32579 If the connecting hosts do not have fixed IP addresses, that is, if a host is
32580 issued with a different IP address each time it connects, Exim's retry
32581 mechanisms on the holding host get confused, because the IP address is normally
32582 used as part of the key string for holding retry information. This can be
32583 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
32584 Since this has disadvantages for permanently connected hosts, it is best to
32585 arrange a separate transport for the intermittently connected ones.
32586
32587
32588
32589 .section "Exim on the intermittently connected client host" "SECID248"
32590 The value of &%smtp_accept_queue_per_connection%& should probably be
32591 increased, or even set to zero (that is, disabled) on the intermittently
32592 connected host, so that all incoming messages down a single connection get
32593 delivered immediately.
32594
32595 .cindex "SMTP" "passed connection"
32596 .cindex "SMTP" "multiple deliveries"
32597 .cindex "multiple SMTP deliveries"
32598 Mail waiting to be sent from an intermittently connected host will probably
32599 not have been routed, because without a connection DNS lookups are not
32600 possible. This means that if a normal queue run is done at connection time,
32601 each message is likely to be sent in a separate SMTP session. This can be
32602 avoided by starting the queue run with a command line option beginning with
32603 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
32604 first pass, routing is done but no deliveries take place. The second pass is a
32605 normal queue run; since all the messages have been previously routed, those
32606 destined for the same host are likely to get sent as multiple deliveries in a
32607 single SMTP connection.
32608
32609
32610
32611 . ////////////////////////////////////////////////////////////////////////////
32612 . ////////////////////////////////////////////////////////////////////////////
32613
32614 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
32615          "Exim as a non-queueing client"
32616 .cindex "client, non-queueing"
32617 .cindex "smart host" "suppressing queueing"
32618 On a personal computer, it is a common requirement for all
32619 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
32620 configured to operate that way, for all the popular operating systems.
32621 However, there are some MUAs for Unix-like systems that cannot be so
32622 configured: they submit messages using the command line interface of
32623 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
32624 messages this way.
32625
32626 If the personal computer runs continuously, there is no problem, because it can
32627 run a conventional MTA that handles delivery to the smart host, and deal with
32628 any delays via its queueing mechanism. However, if the computer does not run
32629 continuously or runs different operating systems at different times, queueing
32630 email is not desirable.
32631
32632 There is therefore a requirement for something that can provide the
32633 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
32634 any queueing or retrying facilities. Furthermore, the delivery to the smart
32635 host should be synchronous, so that if it fails, the sending MUA is immediately
32636 informed. In other words, we want something that extends an MUA that submits
32637 to a local MTA via the command line so that it behaves like one that submits
32638 to a remote smart host using TCP/SMTP.
32639
32640 There are a number of applications (for example, there is one called &'ssmtp'&)
32641 that do this job. However, people have found them to be lacking in various
32642 ways. For instance, you might want to allow aliasing and forwarding to be done
32643 before sending a message to the smart host.
32644
32645 Exim already had the necessary infrastructure for doing this job. Just a few
32646 tweaks were needed to make it behave as required, though it is somewhat of an
32647 overkill to use a fully-featured MTA for this purpose.
32648
32649 .oindex "&%mua_wrapper%&"
32650 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
32651 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
32652 assumes that it is being used to &"wrap"& a command-line MUA in the manner
32653 just described. As well as setting &%mua_wrapper%&, you also need to provide a
32654 compatible router and transport configuration. Typically there will be just one
32655 router and one transport, sending everything to a smart host.
32656
32657 When run in MUA wrapping mode, the behaviour of Exim changes in the
32658 following ways:
32659
32660 .ilist
32661 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
32662 In other words, the only way to submit messages is via the command line.
32663 .next
32664 Each message is synchronously delivered as soon as it is received (&%-odi%& is
32665 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
32666 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
32667 does not finish until the delivery attempt is complete. If the delivery is
32668 successful, a zero return code is given.
32669 .next
32670 Address redirection is permitted, but the final routing for all addresses must
32671 be to the same remote transport, and to the same list of hosts. Furthermore,
32672 the return address (envelope sender) must be the same for all recipients, as
32673 must any added or deleted header lines. In other words, it must be possible to
32674 deliver the message in a single SMTP transaction, however many recipients there
32675 are.
32676 .next
32677 If these conditions are not met, or if routing any address results in a
32678 failure or defer status, or if Exim is unable to deliver all the recipients
32679 successfully to one of the smart hosts, delivery of the entire message fails.
32680 .next
32681 Because no queueing is allowed, all failures are treated as permanent; there
32682 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
32683 smart host. Furthermore, because only a single yes/no response can be given to
32684 the caller, it is not possible to deliver to some recipients and not others. If
32685 there is an error (temporary or permanent) for any recipient, all are failed.
32686 .next
32687 If more than one smart host is listed, Exim will try another host after a
32688 connection failure or a timeout, in the normal way. However, if this kind of
32689 failure happens for all the hosts, the delivery fails.
32690 .next
32691 When delivery fails, an error message is written to the standard error stream
32692 (as well as to Exim's log), and Exim exits to the caller with a return code
32693 value 1. The message is expunged from Exim's spool files. No bounce messages
32694 are ever generated.
32695 .next
32696 No retry data is maintained, and any retry rules are ignored.
32697 .next
32698 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
32699 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
32700 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
32701 .endlist
32702
32703 The overall effect is that Exim makes a single synchronous attempt to deliver
32704 the message, failing if there is any kind of problem. Because no local
32705 deliveries are done and no daemon can be run, Exim does not need root
32706 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
32707 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
32708 the advantages and disadvantages of running without root privilege.
32709
32710
32711
32712
32713 . ////////////////////////////////////////////////////////////////////////////
32714 . ////////////////////////////////////////////////////////////////////////////
32715
32716 .chapter "Log files" "CHAPlog"
32717 .scindex IIDloggen "log" "general description"
32718 .cindex "log" "types of"
32719 Exim writes three different logs, referred to as the main log, the reject log,
32720 and the panic log:
32721
32722 .ilist
32723 .cindex "main log"
32724 The main log records the arrival of each message and each delivery in a single
32725 line in each case. The format is as compact as possible, in an attempt to keep
32726 down the size of log files. Two-character flag sequences make it easy to pick
32727 out these lines. A number of other events are recorded in the main log. Some of
32728 them are optional, in which case the &%log_selector%& option controls whether
32729 they are included or not. A Perl script called &'eximstats'&, which does simple
32730 analysis of main log files, is provided in the Exim distribution (see section
32731 &<<SECTmailstat>>&).
32732 .next
32733 .cindex "reject log"
32734 The reject log records information from messages that are rejected as a result
32735 of a configuration option (that is, for policy reasons).
32736 The first line of each rejection is a copy of the line that is also written to
32737 the main log. Then, if the message's header has been read at the time the log
32738 is written, its contents are written to this log. Only the original header
32739 lines are available; header lines added by ACLs are not logged. You can use the
32740 reject log to check that your policy controls are working correctly; on a busy
32741 host this may be easier than scanning the main log for rejection messages. You
32742 can suppress the writing of the reject log by setting &%write_rejectlog%&
32743 false.
32744 .next
32745 .cindex "panic log"
32746 .cindex "system log"
32747 When certain serious errors occur, Exim writes entries to its panic log. If the
32748 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
32749 are usually written to the main log as well, but can get lost amid the mass of
32750 other entries. The panic log should be empty under normal circumstances. It is
32751 therefore a good idea to check it (or to have a &'cron'& script check it)
32752 regularly, in order to become aware of any problems. When Exim cannot open its
32753 panic log, it tries as a last resort to write to the system log (syslog). This
32754 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
32755 message itself is written at priority LOG_CRIT.
32756 .endlist
32757
32758 Every log line starts with a timestamp, in the format shown in the following
32759 example. Note that many of the examples shown in this chapter are line-wrapped.
32760 In the log file, this would be all on one line:
32761 .code
32762 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
32763   by QUIT
32764 .endd
32765 By default, the timestamps are in the local timezone. There are two
32766 ways of changing this:
32767
32768 .ilist
32769 You can set the &%timezone%& option to a different time zone; in particular, if
32770 you set
32771 .code
32772 timezone = UTC
32773 .endd
32774 the timestamps will be in UTC (aka GMT).
32775 .next
32776 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
32777 example:
32778 .code
32779 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
32780 .endd
32781 .endlist
32782
32783 .cindex "log" "process ids in"
32784 .cindex "pid (process id)" "in log lines"
32785 Exim does not include its process id in log lines by default, but you can
32786 request that it does so by specifying the &`pid`& log selector (see section
32787 &<<SECTlogselector>>&). When this is set, the process id is output, in square
32788 brackets, immediately after the time and date.
32789
32790
32791
32792
32793 .section "Where the logs are written" "SECTwhelogwri"
32794 .cindex "log" "destination"
32795 .cindex "log" "to file"
32796 .cindex "log" "to syslog"
32797 .cindex "syslog"
32798 The logs may be written to local files, or to syslog, or both. However, it
32799 should be noted that many syslog implementations use UDP as a transport, and
32800 are therefore unreliable in the sense that messages are not guaranteed to
32801 arrive at the loghost, nor is the ordering of messages necessarily maintained.
32802 It has also been reported that on large log files (tens of megabytes) you may
32803 need to tweak syslog to prevent it syncing the file with each write &-- on
32804 Linux this has been seen to make syslog take 90% plus of CPU time.
32805
32806 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
32807 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
32808 configuration. This latter string is expanded, so it can contain, for example,
32809 references to the host name:
32810 .code
32811 log_file_path = /var/log/$primary_hostname/exim_%slog
32812 .endd
32813 It is generally advisable, however, to set the string in &_Local/Makefile_&
32814 rather than at run time, because then the setting is available right from the
32815 start of Exim's execution. Otherwise, if there's something it wants to log
32816 before it has read the configuration file (for example, an error in the
32817 configuration file) it will not use the path you want, and may not be able to
32818 log at all.
32819
32820 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
32821 list, currently limited to at most two items. This is one option where the
32822 facility for changing a list separator may not be used. The list must always be
32823 colon-separated. If an item in the list is &"syslog"& then syslog is used;
32824 otherwise the item must either be an absolute path, containing &`%s`& at the
32825 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
32826 implying the use of a default path.
32827
32828 When Exim encounters an empty item in the list, it searches the list defined by
32829 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
32830 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
32831 mean &"use the path specified at build time"&. It no such item exists, log
32832 files are written in the &_log_& subdirectory of the spool directory. This is
32833 equivalent to the setting:
32834 .code
32835 log_file_path = $spool_directory/log/%slog
32836 .endd
32837 If you do not specify anything at build time or run time, that is where the
32838 logs are written.
32839
32840 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
32841 are in use &-- see section &<<SECTdatlogfil>>& below.
32842
32843 Here are some examples of possible settings:
32844 .display
32845 &`LOG_FILE_PATH=syslog                    `& syslog only
32846 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
32847 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
32848 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
32849 .endd
32850 If there are more than two paths in the list, the first is used and a panic
32851 error is logged.
32852
32853
32854
32855 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
32856 .cindex "log" "cycling local files"
32857 .cindex "cycling logs"
32858 .cindex "&'exicyclog'&"
32859 .cindex "log" "local files; writing to"
32860 Some operating systems provide centralized and standardized methods for cycling
32861 log files. For those that do not, a utility script called &'exicyclog'& is
32862 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
32863 main and reject logs each time it is called. The maximum number of old logs to
32864 keep can be set. It is suggested this script is run as a daily &'cron'& job.
32865
32866 An Exim delivery process opens the main log when it first needs to write to it,
32867 and it keeps the file open in case subsequent entries are required &-- for
32868 example, if a number of different deliveries are being done for the same
32869 message. However, remote SMTP deliveries can take a long time, and this means
32870 that the file may be kept open long after it is renamed if &'exicyclog'& or
32871 something similar is being used to rename log files on a regular basis. To
32872 ensure that a switch of log files is noticed as soon as possible, Exim calls
32873 &[stat()]& on the main log's name before reusing an open file, and if the file
32874 does not exist, or its inode has changed, the old file is closed and Exim
32875 tries to open the main log from scratch. Thus, an old log file may remain open
32876 for quite some time, but no Exim processes should write to it once it has been
32877 renamed.
32878
32879
32880
32881 .section "Datestamped log files" "SECTdatlogfil"
32882 .cindex "log" "datestamped files"
32883 Instead of cycling the main and reject log files by renaming them
32884 periodically, some sites like to use files whose names contain a datestamp,
32885 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
32886 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
32887 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
32888 point where the datestamp is required. For example:
32889 .code
32890 log_file_path = /var/spool/exim/log/%slog-%D
32891 log_file_path = /var/log/exim-%s-%D.log
32892 log_file_path = /var/spool/exim/log/%D-%slog
32893 log_file_path = /var/log/exim/%s.%M
32894 .endd
32895 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32896 examples of names generated by the above examples:
32897 .code
32898 /var/spool/exim/log/mainlog-20021225
32899 /var/log/exim-reject-20021225.log
32900 /var/spool/exim/log/20021225-mainlog
32901 /var/log/exim/main.200212
32902 .endd
32903 When this form of log file is specified, Exim automatically switches to new
32904 files at midnight. It does not make any attempt to compress old logs; you
32905 will need to write your own script if you require this. You should not
32906 run &'exicyclog'& with this form of logging.
32907
32908 The location of the panic log is also determined by &%log_file_path%&, but it
32909 is not datestamped, because rotation of the panic log does not make sense.
32910 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
32911 the string. In addition, if it immediately follows a slash, a following
32912 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
32913 character is removed. Thus, the four examples above would give these panic
32914 log names:
32915 .code
32916 /var/spool/exim/log/paniclog
32917 /var/log/exim-panic.log
32918 /var/spool/exim/log/paniclog
32919 /var/log/exim/panic
32920 .endd
32921
32922
32923 .section "Logging to syslog" "SECID249"
32924 .cindex "log" "syslog; writing to"
32925 The use of syslog does not change what Exim logs or the format of its messages,
32926 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32927 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32928 that, the same strings are written to syslog as to log files. The syslog
32929 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32930 by default, but you can change these by setting the &%syslog_facility%& and
32931 &%syslog_processname%& options, respectively. If Exim was compiled with
32932 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32933 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32934 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32935 the time and host name to each line.
32936 The three log streams are mapped onto syslog priorities as follows:
32937
32938 .ilist
32939 &'mainlog'& is mapped to LOG_INFO
32940 .next
32941 &'rejectlog'& is mapped to LOG_NOTICE
32942 .next
32943 &'paniclog'& is mapped to LOG_ALERT
32944 .endlist
32945
32946 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32947 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32948 these are routed by syslog to the same place. You can suppress this duplication
32949 by setting &%syslog_duplication%& false.
32950
32951 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32952 entries contain multiple lines when headers are included. To cope with both
32953 these cases, entries written to syslog are split into separate &[syslog()]&
32954 calls at each internal newline, and also after a maximum of
32955 870 data characters. (This allows for a total syslog line length of 1024, when
32956 additions such as timestamps are added.) If you are running a syslog
32957 replacement that can handle lines longer than the 1024 characters allowed by
32958 RFC 3164, you should set
32959 .code
32960 SYSLOG_LONG_LINES=yes
32961 .endd
32962 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32963 lines, but it still splits at internal newlines in &'reject'& log entries.
32964
32965 To make it easy to re-assemble split lines later, each component of a split
32966 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32967 where <&'n'&> is the component number and <&'m'&> is the total number of
32968 components in the entry. The / delimiter is used when the line was split
32969 because it was too long; if it was split because of an internal newline, the \
32970 delimiter is used. For example, supposing the length limit to be 50 instead of
32971 870, the following would be the result of a typical rejection message to
32972 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32973 name, and pid as added by syslog:
32974 .code
32975 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32976 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32977 [3/5]  when scanning for sender: missing or malformed lo
32978 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32979 [5/5] mple>)
32980 .endd
32981 The same error might cause the following lines to be written to &"rejectlog"&
32982 (LOG_NOTICE):
32983 .code
32984 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32985 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32986 [3/18] er when scanning for sender: missing or malformed
32987 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32988 [5\18] .example>)
32989 [6\18] Recipients: ph10@some.domain.cam.example
32990 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32991 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32992 [9\18]        id 16RdAL-0006pc-00
32993 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32994 [11\18] 09:43 +0100
32995 [12\18] F From: <>
32996 [13\18]   Subject: this is a test header
32997 [18\18]   X-something: this is another header
32998 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32999 [16\18] le>
33000 [17\18] B Bcc:
33001 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
33002 .endd
33003 Log lines that are neither too long nor contain newlines are written to syslog
33004 without modification.
33005
33006 If only syslog is being used, the Exim monitor is unable to provide a log tail
33007 display, unless syslog is routing &'mainlog'& to a file on the local host and
33008 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
33009 where it is.
33010
33011
33012
33013 .section "Log line flags" "SECID250"
33014 One line is written to the main log for each message received, and for each
33015 successful, unsuccessful, and delayed delivery. These lines can readily be
33016 picked out by the distinctive two-character flags that immediately follow the
33017 timestamp. The flags are:
33018 .display
33019 &`<=`&     message arrival
33020 &`=>`&     normal message delivery
33021 &`->`&     additional address in same delivery
33022 &`*>`&     delivery suppressed by &%-N%&
33023 &`**`&     delivery failed; address bounced
33024 &`==`&     delivery deferred; temporary problem
33025 .endd
33026
33027
33028 .section "Logging message reception" "SECID251"
33029 .cindex "log" "reception line"
33030 The format of the single-line entry in the main log that is written for every
33031 message received is shown in the basic example below, which is split over
33032 several lines in order to fit it on the page:
33033 .code
33034 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
33035   H=mailer.fict.example [192.168.123.123] U=exim
33036   P=smtp S=5678 id=<incoming message id>
33037 .endd
33038 The address immediately following &"<="& is the envelope sender address. A
33039 bounce message is shown with the sender address &"<>"&, and if it is locally
33040 generated, this is followed by an item of the form
33041 .code
33042 R=<message id>
33043 .endd
33044 which is a reference to the message that caused the bounce to be sent.
33045
33046 .cindex "HELO"
33047 .cindex "EHLO"
33048 For messages from other hosts, the H and U fields identify the remote host and
33049 record the RFC 1413 identity of the user that sent the message, if one was
33050 received. The number given in square brackets is the IP address of the sending
33051 host. If there is a single, unparenthesized  host name in the H field, as
33052 above, it has been verified to correspond to the IP address (see the
33053 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33054 by the remote host in the SMTP HELO or EHLO command, and has not been
33055 verified. If verification yields a different name to that given for HELO or
33056 EHLO, the verified name appears first, followed by the HELO or EHLO
33057 name in parentheses.
33058
33059 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33060 without brackets, in the HELO or EHLO command, leading to entries in
33061 the log containing text like these examples:
33062 .code
33063 H=(10.21.32.43) [192.168.8.34]
33064 H=([10.21.32.43]) [192.168.8.34]
33065 .endd
33066 This can be confusing. Only the final address in square brackets can be relied
33067 on.
33068
33069 For locally generated messages (that is, messages not received over TCP/IP),
33070 the H field is omitted, and the U field contains the login name of the caller
33071 of Exim.
33072
33073 .cindex "authentication" "logging"
33074 .cindex "AUTH" "logging"
33075 For all messages, the P field specifies the protocol used to receive the
33076 message. This is the value that is stored in &$received_protocol$&. In the case
33077 of incoming SMTP messages, the value indicates whether or not any SMTP
33078 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33079 session was encrypted, there is an additional X field that records the cipher
33080 suite that was used.
33081
33082 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33083 hosts that have authenticated themselves using the SMTP AUTH command. The first
33084 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33085 there is an additional item A= followed by the name of the authenticator that
33086 was used. If an authenticated identification was set up by the authenticator's
33087 &%server_set_id%& option, this is logged too, separated by a colon from the
33088 authenticator name.
33089
33090 .cindex "size" "of message"
33091 The id field records the existing message id, if present. The size of the
33092 received message is given by the S field. When the message is delivered,
33093 headers may be removed or added, so that the size of delivered copies of the
33094 message may not correspond with this value (and indeed may be different to each
33095 other).
33096
33097 The &%log_selector%& option can be used to request the logging of additional
33098 data when a message is received. See section &<<SECTlogselector>>& below.
33099
33100
33101
33102 .section "Logging deliveries" "SECID252"
33103 .cindex "log" "delivery line"
33104 The format of the single-line entry in the main log that is written for every
33105 delivery is shown in one of the examples below, for local and remote
33106 deliveries, respectively. Each example has been split into two lines in order
33107 to fit it on the page:
33108 .code
33109 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33110   <marv@hitch.fict.example> R=localuser T=local_delivery
33111 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33112   monk@holistic.fict.example R=dnslookup T=remote_smtp
33113   H=holistic.fict.example [192.168.234.234]
33114 .endd
33115 For ordinary local deliveries, the original address is given in angle brackets
33116 after the final delivery address, which might be a pipe or a file. If
33117 intermediate address(es) exist between the original and the final address, the
33118 last of these is given in parentheses after the final address. The R and T
33119 fields record the router and transport that were used to process the address.
33120
33121 If a shadow transport was run after a successful local delivery, the log line
33122 for the successful delivery has an item added on the end, of the form
33123 .display
33124 &`ST=<`&&'shadow transport name'&&`>`&
33125 .endd
33126 If the shadow transport did not succeed, the error message is put in
33127 parentheses afterwards.
33128
33129 .cindex "asterisk" "after IP address"
33130 When more than one address is included in a single delivery (for example, two
33131 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33132 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33133 down a single SMTP connection, an asterisk follows the IP address in the log
33134 lines for the second and subsequent messages.
33135
33136 The generation of a reply message by a filter file gets logged as a
33137 &"delivery"& to the addressee, preceded by &">"&.
33138
33139 The &%log_selector%& option can be used to request the logging of additional
33140 data when a message is delivered. See section &<<SECTlogselector>>& below.
33141
33142
33143 .section "Discarded deliveries" "SECID253"
33144 .cindex "discarded messages"
33145 .cindex "message" "discarded"
33146 .cindex "delivery" "discarded; logging"
33147 When a message is discarded as a result of the command &"seen finish"& being
33148 obeyed in a filter file which generates no deliveries, a log entry of the form
33149 .code
33150 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33151   <low.club@bridge.example> R=userforward
33152 .endd
33153 is written, to record why no deliveries are logged. When a message is discarded
33154 because it is aliased to &":blackhole:"& the log line is like this:
33155 .code
33156 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33157   <hole@nowhere.example> R=blackhole_router
33158 .endd
33159
33160
33161 .section "Deferred deliveries" "SECID254"
33162 When a delivery is deferred, a line of the following form is logged:
33163 .code
33164 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33165   R=dnslookup T=smtp defer (146): Connection refused
33166 .endd
33167 In the case of remote deliveries, the error is the one that was given for the
33168 last IP address that was tried. Details of individual SMTP failures are also
33169 written to the log, so the above line would be preceded by something like
33170 .code
33171 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33172   mail1.endrest.example [192.168.239.239]: Connection refused
33173 .endd
33174 When a deferred address is skipped because its retry time has not been reached,
33175 a message is written to the log, but this can be suppressed by setting an
33176 appropriate value in &%log_selector%&.
33177
33178
33179
33180 .section "Delivery failures" "SECID255"
33181 .cindex "delivery" "failure; logging"
33182 If a delivery fails because an address cannot be routed, a line of the
33183 following form is logged:
33184 .code
33185 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33186   <jim@trek99.example>: unknown mail domain
33187 .endd
33188 If a delivery fails at transport time, the router and transport are shown, and
33189 the response from the remote host is included, as in this example:
33190 .code
33191 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33192   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33193   after pipelined RCPT TO:<ace400@pb.example>: host
33194   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33195   <ace400@pb.example>...Addressee unknown
33196 .endd
33197 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33198 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33199 disabling PIPELINING. The log lines for all forms of delivery failure are
33200 flagged with &`**`&.
33201
33202
33203
33204 .section "Fake deliveries" "SECID256"
33205 .cindex "delivery" "fake; logging"
33206 If a delivery does not actually take place because the &%-N%& option has been
33207 used to suppress it, a normal delivery line is written to the log, except that
33208 &"=>"& is replaced by &"*>"&.
33209
33210
33211
33212 .section "Completion" "SECID257"
33213 A line of the form
33214 .code
33215 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33216 .endd
33217 is written to the main log when a message is about to be removed from the spool
33218 at the end of its processing.
33219
33220
33221
33222
33223 .section "Summary of Fields in Log Lines" "SECID258"
33224 .cindex "log" "summary of fields"
33225 A summary of the field identifiers that are used in log lines is shown in
33226 the following table:
33227 .display
33228 &`A   `&        authenticator name (and optional id)
33229 &`C   `&        SMTP confirmation on delivery
33230 &`    `&        command list for &"no mail in SMTP session"&
33231 &`CV  `&        certificate verification status
33232 &`D   `&        duration of &"no mail in SMTP session"&
33233 &`DN  `&        distinguished name from peer certificate
33234 &`DT  `&        on &`=>`& lines: time taken for a delivery
33235 &`F   `&        sender address (on delivery lines)
33236 &`H   `&        host name and IP address
33237 &`I   `&        local interface used
33238 &`id  `&        message id for incoming message
33239 &`P   `&        on &`<=`& lines: protocol used
33240 &`    `&        on &`=>`& and &`**`& lines: return path
33241 &`QT  `&        on &`=>`& lines: time spent on queue so far
33242 &`    `&        on &"Completed"& lines: time spent on queue
33243 &`R   `&        on &`<=`& lines: reference for local bounce
33244 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33245 &`S   `&        size of message
33246 &`ST  `&        shadow transport name
33247 &`T   `&        on &`<=`& lines: message subject (topic)
33248 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33249 &`U   `&        local user or RFC 1413 identity
33250 &`X   `&        TLS cipher suite
33251 .endd
33252
33253
33254 .section "Other log entries" "SECID259"
33255 Various other types of log entry are written from time to time. Most should be
33256 self-explanatory. Among the more common are:
33257
33258 .ilist
33259 .cindex "retry" "time not reached"
33260 &'retry time not reached'&&~&~An address previously suffered a temporary error
33261 during routing or local delivery, and the time to retry has not yet arrived.
33262 This message is not written to an individual message log file unless it happens
33263 during the first delivery attempt.
33264 .next
33265 &'retry time not reached for any host'&&~&~An address previously suffered
33266 temporary errors during remote delivery, and the retry time has not yet arrived
33267 for any of the hosts to which it is routed.
33268 .next
33269 .cindex "spool directory" "file locked"
33270 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33271 some other Exim process is already working on the message. This can be quite
33272 common if queue running processes are started at frequent intervals. The
33273 &'exiwhat'& utility script can be used to find out what Exim processes are
33274 doing.
33275 .next
33276 .cindex "error" "ignored"
33277 &'error ignored'&&~&~There are several circumstances that give rise to this
33278 message:
33279 .olist
33280 Exim failed to deliver a bounce message whose age was greater than
33281 &%ignore_bounce_errors_after%&. The bounce was discarded.
33282 .next
33283 A filter file set up a delivery using the &"noerror"& option, and the delivery
33284 failed. The delivery was discarded.
33285 .next
33286 A delivery set up by a router configured with
33287 . ==== As this is a nested list, any displays it contains must be indented
33288 . ==== as otherwise they are too far to the left.
33289 .code
33290     errors_to = <>
33291 .endd
33292 failed. The delivery was discarded.
33293 .endlist olist
33294 .endlist ilist
33295
33296
33297
33298
33299
33300 .section "Reducing or increasing what is logged" "SECTlogselector"
33301 .cindex "log" "selectors"
33302 By setting the &%log_selector%& global option, you can disable some of Exim's
33303 default logging, or you can request additional logging. The value of
33304 &%log_selector%& is made up of names preceded by plus or minus characters. For
33305 example:
33306 .code
33307 log_selector = +arguments -retry_defer
33308 .endd
33309 The list of optional log items is in the following table, with the default
33310 selection marked by asterisks:
33311 .display
33312 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33313 &` address_rewrite            `&  address rewriting
33314 &` all_parents                `&  all parents in => lines
33315 &` arguments                  `&  command line arguments
33316 &`*connection_reject          `&  connection rejections
33317 &`*delay_delivery             `&  immediate delivery delayed
33318 &` deliver_time               `&  time taken to perform delivery
33319 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33320 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33321 &`*etrn                       `&  ETRN commands
33322 &`*host_lookup_failed         `&  as it says
33323 &` ident_timeout              `&  timeout for ident connection
33324 &` incoming_interface         `&  incoming interface on <= lines
33325 &` incoming_port              `&  incoming port on <= lines
33326 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33327 &` outgoing_port              `&  add remote port to => lines
33328 &`*queue_run                  `&  start and end queue runs
33329 &` queue_time                 `&  time on queue for one recipient
33330 &` queue_time_overall         `&  time on queue for whole message
33331 &` pid                        `&  Exim process id
33332 &` received_recipients        `&  recipients on <= lines
33333 &` received_sender            `&  sender on <= lines
33334 &`*rejected_header            `&  header contents on reject log
33335 &`*retry_defer                `&  &"retry time not reached"&
33336 &` return_path_on_delivery    `&  put return path on => and ** lines
33337 &` sender_on_delivery         `&  add sender to => lines
33338 &`*sender_verify_fail         `&  sender verification failures
33339 &`*size_reject                `&  rejection because too big
33340 &`*skip_delivery              `&  delivery skipped in a queue run
33341 &` smtp_confirmation          `&  SMTP confirmation on => lines
33342 &` smtp_connection            `&  SMTP connections
33343 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33344 &` smtp_no_mail               `&  session with no MAIL commands
33345 &` smtp_protocol_error        `&  SMTP protocol errors
33346 &` smtp_syntax_error          `&  SMTP syntax errors
33347 &` subject                    `&  contents of &'Subject:'& on <= lines
33348 &` tls_certificate_verified   `&  certificate verification status
33349 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
33350 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
33351 &` tls_sni                    `&  TLS SNI on <= lines
33352 &` unknown_in_list            `&  DNS lookup failed in list match
33353
33354 &` all                        `&  all of the above
33355 .endd
33356 More details on each of these items follows:
33357
33358 .ilist
33359 .cindex "&%warn%& ACL verb" "log when skipping"
33360 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
33361 its conditions cannot be evaluated, a log line to this effect is written if
33362 this log selector is set.
33363 .next
33364 .cindex "log" "rewriting"
33365 .cindex "rewriting" "logging"
33366 &%address_rewrite%&: This applies both to global rewrites and per-transport
33367 rewrites, but not to rewrites in filters run as an unprivileged user (because
33368 such users cannot access the log).
33369 .next
33370 .cindex "log" "full parentage"
33371 &%all_parents%&: Normally only the original and final addresses are logged on
33372 delivery lines; with this selector, intermediate parents are given in
33373 parentheses between them.
33374 .next
33375 .cindex "log" "Exim arguments"
33376 .cindex "Exim arguments, logging"
33377 &%arguments%&: This causes Exim to write the arguments with which it was called
33378 to the main log, preceded by the current working directory. This is a debugging
33379 feature, added to make it easier to find out how certain MUAs call
33380 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
33381 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
33382 that are empty or that contain white space are quoted. Non-printing characters
33383 are shown as escape sequences. This facility cannot log unrecognized arguments,
33384 because the arguments are checked before the configuration file is read. The
33385 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
33386 between the caller and Exim.
33387 .next
33388 .cindex "log" "connection rejections"
33389 &%connection_reject%&: A log entry is written whenever an incoming SMTP
33390 connection is rejected, for whatever reason.
33391 .next
33392 .cindex "log" "delayed delivery"
33393 .cindex "delayed delivery, logging"
33394 &%delay_delivery%&: A log entry is written whenever a delivery process is not
33395 started for an incoming message because the load is too high or too many
33396 messages were received on one connection. Logging does not occur if no delivery
33397 process is started because &%queue_only%& is set or &%-odq%& was used.
33398 .next
33399 .cindex "log" "delivery duration"
33400 &%deliver_time%&: For each delivery, the amount of real time it has taken to
33401 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
33402 .next
33403 .cindex "log" "message size on delivery"
33404 .cindex "size" "of message"
33405 &%delivery_size%&: For each delivery, the size of message delivered is added to
33406 the &"=>"& line, tagged with S=.
33407 .next
33408 .cindex "log" "dnslist defer"
33409 .cindex "DNS list" "logging defer"
33410 .cindex "black list (DNS)"
33411 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
33412 DNS black list suffers a temporary error.
33413 .next
33414 .cindex "log" "ETRN commands"
33415 .cindex "ETRN" "logging"
33416 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
33417 is run to determine whether or not it is actually accepted. An invalid ETRN
33418 command, or one received within a message transaction is not logged by this
33419 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
33420 .next
33421 .cindex "log" "host lookup failure"
33422 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
33423 any addresses, or when a lookup of an IP address fails to find a host name, a
33424 log line is written. This logging does not apply to direct DNS lookups when
33425 routing email addresses, but it does apply to &"byname"& lookups.
33426 .next
33427 .cindex "log" "ident timeout"
33428 .cindex "RFC 1413" "logging timeout"
33429 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
33430 client's ident port times out.
33431 .next
33432 .cindex "log" "incoming interface"
33433 .cindex "interface" "logging"
33434 &%incoming_interface%&: The interface on which a message was received is added
33435 to the &"<="& line as an IP address in square brackets, tagged by I= and
33436 followed by a colon and the port number. The local interface and port are also
33437 added to other SMTP log lines, for example &"SMTP connection from"&, and to
33438 rejection lines.
33439 .next
33440 .cindex "log" "incoming remote port"
33441 .cindex "port" "logging remote"
33442 .cindex "TCP/IP" "logging incoming remote port"
33443 .vindex "&$sender_fullhost$&"
33444 .vindex "&$sender_rcvhost$&"
33445 &%incoming_port%&: The remote port number from which a message was received is
33446 added to log entries and &'Received:'& header lines, following the IP address
33447 in square brackets, and separated from it by a colon. This is implemented by
33448 changing the value that is put in the &$sender_fullhost$& and
33449 &$sender_rcvhost$& variables. Recording the remote port number has become more
33450 important with the widening use of NAT (see RFC 2505).
33451 .next
33452 .cindex "log" "dropped connection"
33453 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
33454 connection is unexpectedly dropped.
33455 .next
33456 .cindex "log" "outgoing remote port"
33457 .cindex "port" "logging outgoint remote"
33458 .cindex "TCP/IP" "logging ougtoing remote port"
33459 &%outgoing_port%&: The remote port number is added to delivery log lines (those
33460 containing => tags) following the IP address. This option is not included in
33461 the default setting, because for most ordinary configurations, the remote port
33462 number is always 25 (the SMTP port).
33463 .next
33464 .cindex "log" "process ids in"
33465 .cindex "pid (process id)" "in log lines"
33466 &%pid%&: The current process id is added to every log line, in square brackets,
33467 immediately after the time and date.
33468 .next
33469 .cindex "log" "queue run"
33470 .cindex "queue runner" "logging"
33471 &%queue_run%&: The start and end of every queue run are logged.
33472 .next
33473 .cindex "log" "queue time"
33474 &%queue_time%&: The amount of time the message has been in the queue on the
33475 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
33476 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
33477 includes reception time as well as the delivery time for the current address.
33478 This means that it may be longer than the difference between the arrival and
33479 delivery log line times, because the arrival log line is not written until the
33480 message has been successfully received.
33481 .next
33482 &%queue_time_overall%&: The amount of time the message has been in the queue on
33483 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
33484 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
33485 message, so it includes reception time as well as the total delivery time.
33486 .next
33487 .cindex "log" "recipients"
33488 &%received_recipients%&: The recipients of a message are listed in the main log
33489 as soon as the message is received. The list appears at the end of the log line
33490 that is written when a message is received, preceded by the word &"for"&. The
33491 addresses are listed after they have been qualified, but before any rewriting
33492 has taken place.
33493 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
33494 in the list.
33495 .next
33496 .cindex "log" "sender reception"
33497 &%received_sender%&: The unrewritten original sender of a message is added to
33498 the end of the log line that records the message's arrival, after the word
33499 &"from"& (before the recipients if &%received_recipients%& is also set).
33500 .next
33501 .cindex "log" "header lines for rejection"
33502 &%rejected_header%&: If a message's header has been received at the time a
33503 rejection is written to the reject log, the complete header is added to the
33504 log. Header logging can be turned off individually for messages that are
33505 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
33506 .next
33507 .cindex "log" "retry defer"
33508 &%retry_defer%&: A log line is written if a delivery is deferred because a
33509 retry time has not yet been reached. However, this &"retry time not reached"&
33510 message is always omitted from individual message logs after the first delivery
33511 attempt.
33512 .next
33513 .cindex "log" "return path"
33514 &%return_path_on_delivery%&: The return path that is being transmitted with
33515 the message is included in delivery and bounce lines, using the tag P=.
33516 This is omitted if no delivery actually happens, for example, if routing fails,
33517 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
33518 .next
33519 .cindex "log" "sender on delivery"
33520 &%sender_on_delivery%&: The message's sender address is added to every delivery
33521 and bounce line, tagged by F= (for &"from"&).
33522 This is the original sender that was received with the message; it is not
33523 necessarily the same as the outgoing return path.
33524 .next
33525 .cindex "log" "sender verify failure"
33526 &%sender_verify_fail%&: If this selector is unset, the separate log line that
33527 gives details of a sender verification failure is not written. Log lines for
33528 the rejection of SMTP commands contain just &"sender verify failed"&, so some
33529 detail is lost.
33530 .next
33531 .cindex "log" "size rejection"
33532 &%size_reject%&: A log line is written whenever a message is rejected because
33533 it is too big.
33534 .next
33535 .cindex "log" "frozen messages; skipped"
33536 .cindex "frozen messages" "logging skipping"
33537 &%skip_delivery%&: A log line is written whenever a message is skipped during a
33538 queue run because it is frozen or because another process is already delivering
33539 it.
33540 .cindex "&""spool file is locked""&"
33541 The message that is written is &"spool file is locked"&.
33542 .next
33543 .cindex "log" "smtp confirmation"
33544 .cindex "SMTP" "logging confirmation"
33545 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
33546 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
33547 A number of MTAs (including Exim) return an identifying string in this
33548 response.
33549 .next
33550 .cindex "log" "SMTP connections"
33551 .cindex "SMTP" "logging connections"
33552 &%smtp_connection%&: A log line is written whenever an SMTP connection is
33553 established or closed, unless the connection is from a host that matches
33554 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
33555 only when the closure is unexpected.) This applies to connections from local
33556 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
33557 dropped in the middle of a message, a log line is always written, whether or
33558 not this selector is set, but otherwise nothing is written at the start and end
33559 of connections unless this selector is enabled.
33560
33561 For TCP/IP connections to an Exim daemon, the current number of connections is
33562 included in the log message for each new connection, but note that the count is
33563 reset if the daemon is restarted.
33564 Also, because connections are closed (and the closure is logged) in
33565 subprocesses, the count may not include connections that have been closed but
33566 whose termination the daemon has not yet noticed. Thus, while it is possible to
33567 match up the opening and closing of connections in the log, the value of the
33568 logged counts may not be entirely accurate.
33569 .next
33570 .cindex "log" "SMTP transaction; incomplete"
33571 .cindex "SMTP" "logging incomplete transactions"
33572 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
33573 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
33574 and the message sender plus any accepted recipients are included in the log
33575 line. This can provide evidence of dictionary attacks.
33576 .next
33577 .cindex "log" "non-MAIL SMTP sessions"
33578 .cindex "MAIL" "logging session without"
33579 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
33580 connection terminates without having issued a MAIL command. This includes both
33581 the case when the connection is dropped, and the case when QUIT is used. It
33582 does not include cases where the connection is rejected right at the start (by
33583 an ACL, or because there are too many connections, or whatever). These cases
33584 already have their own log lines.
33585
33586 The log line that is written contains the identity of the client in the usual
33587 way, followed by D= and a time, which records the duration of the connection.
33588 If the connection was authenticated, this fact is logged exactly as it is for
33589 an incoming message, with an A= item. If the connection was encrypted, CV=,
33590 DN=, and X= items may appear as they do for an incoming message, controlled by
33591 the same logging options.
33592
33593 Finally, if any SMTP commands were issued during the connection, a C= item
33594 is added to the line, listing the commands that were used. For example,
33595 .code
33596 C=EHLO,QUIT
33597 .endd
33598 shows that the client issued QUIT straight after EHLO. If there were fewer
33599 than 20 commands, they are all listed. If there were more than 20 commands,
33600 the last 20 are listed, preceded by &"..."&. However, with the default
33601 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
33602 have been aborted before 20 non-mail commands are processed.
33603 .next
33604 .cindex "log" "SMTP protocol error"
33605 .cindex "SMTP" "logging protocol error"
33606 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
33607 encountered. Exim does not have perfect detection of all protocol errors
33608 because of transmission delays and the use of pipelining. If PIPELINING has
33609 been advertised to a client, an Exim server assumes that the client will use
33610 it, and therefore it does not count &"expected"& errors (for example, RCPT
33611 received after rejecting MAIL) as protocol errors.
33612 .next
33613 .cindex "SMTP" "logging syntax errors"
33614 .cindex "SMTP" "syntax errors; logging"
33615 .cindex "SMTP" "unknown command; logging"
33616 .cindex "log" "unknown SMTP command"
33617 .cindex "log" "SMTP syntax error"
33618 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
33619 encountered. An unrecognized command is treated as a syntax error. For an
33620 external connection, the host identity is given; for an internal connection
33621 using &%-bs%& the sender identification (normally the calling user) is given.
33622 .next
33623 .cindex "log" "subject"
33624 .cindex "subject, logging"
33625 &%subject%&: The subject of the message is added to the arrival log line,
33626 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
33627 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
33628 specifies whether characters with values greater than 127 should be logged
33629 unchanged, or whether they should be rendered as escape sequences.
33630 .next
33631 .cindex "log" "certificate verification"
33632 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
33633 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
33634 verified, and &`CV=no`& if not.
33635 .next
33636 .cindex "log" "TLS cipher"
33637 .cindex "TLS" "logging cipher"
33638 &%tls_cipher%&: When a message is sent or received over an encrypted
33639 connection, the cipher suite used is added to the log line, preceded by X=.
33640 .next
33641 .cindex "log" "TLS peer DN"
33642 .cindex "TLS" "logging peer DN"
33643 &%tls_peerdn%&: When a message is sent or received over an encrypted
33644 connection, and a certificate is supplied by the remote host, the peer DN is
33645 added to the log line, preceded by DN=.
33646 .next
33647 .cindex "log" "TLS SNI"
33648 .cindex "TLS" "logging SNI"
33649 &%tls_sni%&: When a message is received over an encrypted connection, and
33650 the remote host provided the Server Name Indication extension, the SNI is
33651 added to the log line, preceded by SNI=.
33652 .next
33653 .cindex "log" "DNS failure in list"
33654 &%unknown_in_list%&: This setting causes a log entry to be written when the
33655 result of a list match is failure because a DNS lookup failed.
33656 .endlist
33657
33658
33659 .section "Message log" "SECID260"
33660 .cindex "message" "log file for"
33661 .cindex "log" "message log; description of"
33662 .cindex "&_msglog_& directory"
33663 .oindex "&%preserve_message_logs%&"
33664 In addition to the general log files, Exim writes a log file for each message
33665 that it handles. The names of these per-message logs are the message ids, and
33666 they are kept in the &_msglog_& sub-directory of the spool directory. Each
33667 message log contains copies of the log lines that apply to the message. This
33668 makes it easier to inspect the status of an individual message without having
33669 to search the main log. A message log is deleted when processing of the message
33670 is complete, unless &%preserve_message_logs%& is set, but this should be used
33671 only with great care because they can fill up your disk very quickly.
33672
33673 On a heavily loaded system, it may be desirable to disable the use of
33674 per-message logs, in order to reduce disk I/O. This can be done by setting the
33675 &%message_logs%& option false.
33676 .ecindex IIDloggen
33677
33678
33679
33680
33681 . ////////////////////////////////////////////////////////////////////////////
33682 . ////////////////////////////////////////////////////////////////////////////
33683
33684 .chapter "Exim utilities" "CHAPutils"
33685 .scindex IIDutils "utilities"
33686 A number of utility scripts and programs are supplied with Exim and are
33687 described in this chapter. There is also the Exim Monitor, which is covered in
33688 the next chapter. The utilities described here are:
33689
33690 .itable none 0 0 3  7* left  15* left  40* left
33691 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
33692   "list what Exim processes are doing"
33693 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
33694 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
33695 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
33696 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
33697                                                 various criteria"
33698 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
33699 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
33700   "extract statistics from the log"
33701 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
33702   "check address acceptance from given IP"
33703 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
33704 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
33705 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
33706 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
33707 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
33708 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
33709 .endtable
33710
33711 Another utility that might be of use to sites with many MTAs is Tom Kistner's
33712 &'exilog'&. It provides log visualizations across multiple Exim servers. See
33713 &url(http://duncanthrax.net/exilog/) for details.
33714
33715
33716
33717
33718 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
33719 .cindex "&'exiwhat'&"
33720 .cindex "process, querying"
33721 .cindex "SIGUSR1"
33722 On operating systems that can restart a system call after receiving a signal
33723 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
33724 a line describing what it is doing to the file &_exim-process.info_& in the
33725 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
33726 processes it can find, having first emptied the file. It then waits for one
33727 second to allow the Exim processes to react before displaying the results. In
33728 order to run &'exiwhat'& successfully you have to have sufficient privilege to
33729 send the signal to the Exim processes, so it is normally run as root.
33730
33731 &*Warning*&: This is not an efficient process. It is intended for occasional
33732 use by system administrators. It is not sensible, for example, to set up a
33733 script that sends SIGUSR1 signals to Exim processes at short intervals.
33734
33735
33736 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
33737 varies in different operating systems. Not only are different options used,
33738 but the format of the output is different. For this reason, there are some
33739 system configuration options that configure exactly how &'exiwhat'& works. If
33740 it doesn't seem to be working for you, check the following compile-time
33741 options:
33742 .display
33743 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
33744 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
33745 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
33746 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
33747 .endd
33748 An example of typical output from &'exiwhat'& is
33749 .code
33750 164 daemon: -q1h, listening on port 25
33751 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
33752 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
33753   [10.19.42.42] (editor@ref.example)
33754 10592 handling incoming call from [192.168.243.242]
33755 10628 accepting a local non-SMTP message
33756 .endd
33757 The first number in the output line is the process number. The third line has
33758 been split here, in order to fit it on the page.
33759
33760
33761
33762 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
33763 .cindex "&'exiqgrep'&"
33764 .cindex "queue" "grepping"
33765 This utility is a Perl script contributed by Matt Hubbard. It runs
33766 .code
33767 exim -bpu
33768 .endd
33769 to obtain a queue listing with undelivered recipients only, and then greps the
33770 output to select messages that match given criteria. The following selection
33771 options are available:
33772
33773 .vlist
33774 .vitem &*-f*&&~<&'regex'&>
33775 Match the sender address. The field that is tested is enclosed in angle
33776 brackets, so you can test for bounce messages with
33777 .code
33778 exiqgrep -f '^<>$'
33779 .endd
33780 .vitem &*-r*&&~<&'regex'&>
33781 Match a recipient address. The field that is tested is not enclosed in angle
33782 brackets.
33783
33784 .vitem &*-s*&&~<&'regex'&>
33785 Match against the size field.
33786
33787 .vitem &*-y*&&~<&'seconds'&>
33788 Match messages that are younger than the given time.
33789
33790 .vitem &*-o*&&~<&'seconds'&>
33791 Match messages that are older than the given time.
33792
33793 .vitem &*-z*&
33794 Match only frozen messages.
33795
33796 .vitem &*-x*&
33797 Match only non-frozen messages.
33798 .endlist
33799
33800 The following options control the format of the output:
33801
33802 .vlist
33803 .vitem &*-c*&
33804 Display only the count of matching messages.
33805
33806 .vitem &*-l*&
33807 Long format &-- display the full message information as output by Exim. This is
33808 the default.
33809
33810 .vitem &*-i*&
33811 Display message ids only.
33812
33813 .vitem &*-b*&
33814 Brief format &-- one line per message.
33815
33816 .vitem &*-R*&
33817 Display messages in reverse order.
33818 .endlist
33819
33820 There is one more option, &%-h%&, which outputs a list of options.
33821
33822
33823
33824 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
33825 .cindex "&'exiqsumm'&"
33826 .cindex "queue" "summary"
33827 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
33828 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
33829 running a command such as
33830 .code
33831 exim -bp | exiqsumm
33832 .endd
33833 The output consists of one line for each domain that has messages waiting for
33834 it, as in the following example:
33835 .code
33836 3   2322   74m   66m  msn.com.example
33837 .endd
33838 Each line lists the number of pending deliveries for a domain, their total
33839 volume, and the length of time that the oldest and the newest messages have
33840 been waiting. Note that the number of pending deliveries is greater than the
33841 number of messages when messages have more than one recipient.
33842
33843 A summary line is output at the end. By default the output is sorted on the
33844 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
33845 the output to be sorted by oldest message and by count of messages,
33846 respectively. There are also three options that split the messages for each
33847 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
33848 separates frozen messages, and &%-s%& separates messages according to their
33849 sender.
33850
33851 The output of &'exim -bp'& contains the original addresses in the message, so
33852 this also applies to the output from &'exiqsumm'&. No domains from addresses
33853 generated by aliasing or forwarding are included (unless the &%one_time%&
33854 option of the &(redirect)& router has been used to convert them into &"top
33855 level"& addresses).
33856
33857
33858
33859
33860 .section "Extracting specific information from the log (exigrep)" &&&
33861          "SECTextspeinf"
33862 .cindex "&'exigrep'&"
33863 .cindex "log" "extracts; grepping for"
33864 The &'exigrep'& utility is a Perl script that searches one or more main log
33865 files for entries that match a given pattern. When it finds a match, it
33866 extracts all the log entries for the relevant message, not just those that
33867 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
33868 given message, or all mail for a given user, or for a given host, for example.
33869 The input files can be in Exim log format or syslog format.
33870 If a matching log line is not associated with a specific message, it is
33871 included in &'exigrep'&'s output without any additional lines. The usage is:
33872 .display
33873 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
33874 .endd
33875 If no log file names are given on the command line, the standard input is read.
33876
33877 The &%-t%& argument specifies a number of seconds. It adds an additional
33878 condition for message selection. Messages that are complete are shown only if
33879 they spent more than <&'n'&> seconds on the queue.
33880
33881 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
33882 makes it case-sensitive. This may give a performance improvement when searching
33883 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
33884 option; with &%-I%& they do not. In both cases it is possible to change the
33885 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
33886
33887 The &%-l%& option means &"literal"&, that is, treat all characters in the
33888 pattern as standing for themselves. Otherwise the pattern must be a Perl
33889 regular expression.
33890
33891 The &%-v%& option inverts the matching condition. That is, a line is selected
33892 if it does &'not'& match the pattern.
33893
33894 If the location of a &'zcat'& command is known from the definition of
33895 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
33896 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
33897
33898
33899 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
33900 .cindex "&'exipick'&"
33901 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
33902 lists messages from the queue according to a variety of criteria. For details
33903 of &'exipick'&'s facilities, visit the web page at
33904 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33905 the &%--help%& option.
33906
33907
33908 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33909 .cindex "log" "cycling local files"
33910 .cindex "cycling logs"
33911 .cindex "&'exicyclog'&"
33912 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33913 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33914 you are using log files with datestamps in their names (see section
33915 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33916 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33917 There are two command line options for &'exicyclog'&:
33918 .ilist
33919 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33920 default that is set when Exim is built. The default default is 10.
33921 .next
33922 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33923 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33924 overriding the script's default, which is to find the setting from Exim's
33925 configuration.
33926 .endlist
33927
33928 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33929 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33930 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33931 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33932 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33933 logs are handled similarly.
33934
33935 If the limit is greater than 99, the script uses 3-digit numbers such as
33936 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33937 to one that is greater, or &'vice versa'&, you will have to fix the names of
33938 any existing log files.
33939
33940 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33941 the end are deleted. All files with numbers greater than 01 are compressed,
33942 using a compression command which is configured by the COMPRESS_COMMAND
33943 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33944 root &%crontab%& entry of the form
33945 .code
33946 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33947 .endd
33948 assuming you have used the name &"exim"& for the Exim user. You can run
33949 &'exicyclog'& as root if you wish, but there is no need.
33950
33951
33952
33953 .section "Mail statistics (eximstats)" "SECTmailstat"
33954 .cindex "statistics"
33955 .cindex "&'eximstats'&"
33956 A Perl script called &'eximstats'& is provided for extracting statistical
33957 information from log files. The output is either plain text, or HTML.
33958 Exim log files are also supported by the &'Lire'& system produced by the
33959 LogReport Foundation &url(http://www.logreport.org).
33960
33961 The &'eximstats'& script has been hacked about quite a bit over time. The
33962 latest version is the result of some extensive revision by Steve Campbell. A
33963 lot of information is given by default, but there are options for suppressing
33964 various parts of it. Following any options, the arguments to the script are a
33965 list of files, which should be main log files. For example:
33966 .code
33967 eximstats -nr /var/spool/exim/log/mainlog.01
33968 .endd
33969 By default, &'eximstats'& extracts information about the number and volume of
33970 messages received from or delivered to various hosts. The information is sorted
33971 both by message count and by volume, and the top fifty hosts in each category
33972 are listed on the standard output. Similar information, based on email
33973 addresses or domains instead of hosts can be requested by means of various
33974 options. For messages delivered and received locally, similar statistics are
33975 also produced per user.
33976
33977 The output also includes total counts and statistics about delivery errors, and
33978 histograms showing the number of messages received and deliveries made in each
33979 hour of the day. A delivery with more than one address in its envelope (for
33980 example, an SMTP transaction with more than one RCPT command) is counted
33981 as a single delivery by &'eximstats'&.
33982
33983 Though normally more deliveries than receipts are reported (as messages may
33984 have multiple recipients), it is possible for &'eximstats'& to report more
33985 messages received than delivered, even though the queue is empty at the start
33986 and end of the period in question. If an incoming message contains no valid
33987 recipients, no deliveries are recorded for it. A bounce message is handled as
33988 an entirely separate message.
33989
33990 &'eximstats'& always outputs a grand total summary giving the volume and number
33991 of messages received and deliveries made, and the number of hosts involved in
33992 each case. It also outputs the number of messages that were delayed (that is,
33993 not completely delivered at the first attempt), and the number that had at
33994 least one address that failed.
33995
33996 The remainder of the output is in sections that can be independently disabled
33997 or modified by various options. It consists of a summary of deliveries by
33998 transport, histograms of messages received and delivered per time interval
33999 (default per hour), information about the time messages spent on the queue,
34000 a list of relayed messages, lists of the top fifty sending hosts, local
34001 senders, destination hosts, and destination local users by count and by volume,
34002 and a list of delivery errors that occurred.
34003
34004 The relay information lists messages that were actually relayed, that is, they
34005 came from a remote host and were directly delivered to some other remote host,
34006 without being processed (for example, for aliasing or forwarding) locally.
34007
34008 There are quite a few options for &'eximstats'& to control exactly what it
34009 outputs. These are documented in the Perl script itself, and can be extracted
34010 by running the command &(perldoc)& on the script. For example:
34011 .code
34012 perldoc /usr/exim/bin/eximstats
34013 .endd
34014
34015 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
34016 .cindex "&'exim_checkaccess'&"
34017 .cindex "policy control" "checking access"
34018 .cindex "checking access"
34019 The &%-bh%& command line argument allows you to run a fake SMTP session with
34020 debugging output, in order to check what Exim is doing when it is applying
34021 policy controls to incoming SMTP mail. However, not everybody is sufficiently
34022 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
34023 sometimes you just want to answer the question &"Does this address have
34024 access?"& without bothering with any further details.
34025
34026 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
34027 two arguments, an IP address and an email address:
34028 .code
34029 exim_checkaccess 10.9.8.7 A.User@a.domain.example
34030 .endd
34031 The utility runs a call to Exim with the &%-bh%& option, to test whether the
34032 given email address would be accepted in a RCPT command in a TCP/IP
34033 connection from the host with the given IP address. The output of the utility
34034 is either the word &"accepted"&, or the SMTP error response, for example:
34035 .code
34036 Rejected:
34037 550 Relay not permitted
34038 .endd
34039 When running this test, the utility uses &`<>`& as the envelope sender address
34040 for the MAIL command, but you can change this by providing additional
34041 options. These are passed directly to the Exim command. For example, to specify
34042 that the test is to be run with the sender address &'himself@there.example'&
34043 you can use:
34044 .code
34045 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34046                  -f himself@there.example
34047 .endd
34048 Note that these additional Exim command line items must be given after the two
34049 mandatory arguments.
34050
34051 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34052 while running its checks. You can run checks that include callouts by using
34053 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34054
34055
34056
34057 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34058 .cindex "DBM" "building dbm files"
34059 .cindex "building DBM files"
34060 .cindex "&'exim_dbmbuild'&"
34061 .cindex "lower casing"
34062 .cindex "binary zero" "in lookup key"
34063 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34064 the format used by the &(lsearch)& lookup (see section
34065 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34066 names as keys and the remainder of the information as data. The lower-casing
34067 can be prevented by calling the program with the &%-nolc%& option.
34068
34069 A terminating zero is included as part of the key string. This is expected by
34070 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34071 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34072 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34073 files.
34074
34075 The program requires two arguments: the name of the input file (which can be a
34076 single hyphen to indicate the standard input), and the name of the output file.
34077 It creates the output under a temporary name, and then renames it if all went
34078 well.
34079
34080 .cindex "USE_DB"
34081 If the native DB interface is in use (USE_DB is set in a compile-time
34082 configuration file &-- this is common in free versions of Unix) the two file
34083 names must be different, because in this mode the Berkeley DB functions create
34084 a single output file using exactly the name given. For example,
34085 .code
34086 exim_dbmbuild /etc/aliases /etc/aliases.db
34087 .endd
34088 reads the system alias file and creates a DBM version of it in
34089 &_/etc/aliases.db_&.
34090
34091 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34092 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34093 environment, the suffixes are added to the second argument of
34094 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34095 when the Berkeley functions are used in compatibility mode (though this is not
34096 recommended), because in that case it adds a &_.db_& suffix to the file name.
34097
34098 If a duplicate key is encountered, the program outputs a warning, and when it
34099 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34100 option is used. By default, only the first of a set of duplicates is used &--
34101 this makes it compatible with &(lsearch)& lookups. There is an option
34102 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34103 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34104 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34105 return code is 2.
34106
34107
34108
34109
34110 .section "Finding individual retry times (exinext)" "SECTfinindret"
34111 .cindex "retry" "times"
34112 .cindex "&'exinext'&"
34113 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34114 fish specific information out of the retry database. Given a mail domain (or a
34115 complete address), it looks up the hosts for that domain, and outputs any retry
34116 information for the hosts or for the domain. At present, the retry information
34117 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34118 output. For example:
34119 .code
34120 $ exinext piglet@milne.fict.example
34121 kanga.milne.example:192.168.8.1 error 146: Connection refused
34122   first failed: 21-Feb-1996 14:57:34
34123   last tried:   21-Feb-1996 14:57:34
34124   next try at:  21-Feb-1996 15:02:34
34125 roo.milne.example:192.168.8.3 error 146: Connection refused
34126   first failed: 20-Jan-1996 13:12:08
34127   last tried:   21-Feb-1996 11:42:03
34128   next try at:  21-Feb-1996 19:42:03
34129   past final cutoff time
34130 .endd
34131 You can also give &'exinext'& a local part, without a domain, and it
34132 will give any retry information for that local part in your default domain.
34133 A message id can be used to obtain retry information pertaining to a specific
34134 message. This exists only when an attempt to deliver a message to a remote host
34135 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34136 &'exinext'& is not particularly efficient, but then it is not expected to be
34137 run very often.
34138
34139 The &'exinext'& utility calls Exim to find out information such as the location
34140 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34141 passed on to the &'exim'& commands. The first specifies an alternate Exim
34142 configuration file, and the second sets macros for use within the configuration
34143 file. These features are mainly to help in testing, but might also be useful in
34144 environments where more than one configuration file is in use.
34145
34146
34147
34148 .section "Hints database maintenance" "SECThindatmai"
34149 .cindex "hints database" "maintenance"
34150 .cindex "maintaining Exim's hints database"
34151 Three utility programs are provided for maintaining the DBM files that Exim
34152 uses to contain its delivery hint information. Each program requires two
34153 arguments. The first specifies the name of Exim's spool directory, and the
34154 second is the name of the database it is to operate on. These are as follows:
34155
34156 .ilist
34157 &'retry'&: the database of retry information
34158 .next
34159 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34160 for remote hosts
34161 .next
34162 &'callout'&: the callout cache
34163 .next
34164 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34165 .next
34166 &'misc'&: other hints data
34167 .endlist
34168
34169 The &'misc'& database is used for
34170
34171 .ilist
34172 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34173 .next
34174 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34175 &(smtp)& transport)
34176 .endlist
34177
34178
34179
34180 .section "exim_dumpdb" "SECID261"
34181 .cindex "&'exim_dumpdb'&"
34182 The entire contents of a database are written to the standard output by the
34183 &'exim_dumpdb'& program, which has no options or arguments other than the
34184 spool and database names. For example, to dump the retry database:
34185 .code
34186 exim_dumpdb /var/spool/exim retry
34187 .endd
34188 Two lines of output are produced for each entry:
34189 .code
34190 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34191 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34192 .endd
34193 The first item on the first line is the key of the record. It starts with one
34194 of the letters R, or T, depending on whether it refers to a routing or
34195 transport retry. For a local delivery, the next part is the local address; for
34196 a remote delivery it is the name of the remote host, followed by its failing IP
34197 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34198 transport). If the remote port is not the standard one (port 25), it is added
34199 to the IP address. Then there follows an error code, an additional error code,
34200 and a textual description of the error.
34201
34202 The three times on the second line are the time of first failure, the time of
34203 the last delivery attempt, and the computed time for the next attempt. The line
34204 ends with an asterisk if the cutoff time for the last retry rule has been
34205 exceeded.
34206
34207 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34208 consists of a host name followed by a list of ids for messages that are or were
34209 waiting to be delivered to that host. If there are a very large number for any
34210 one host, continuation records, with a sequence number added to the host name,
34211 may be seen. The data in these records is often out of date, because a message
34212 may be routed to several alternative hosts, and Exim makes no effort to keep
34213 cross-references.
34214
34215
34216
34217 .section "exim_tidydb" "SECID262"
34218 .cindex "&'exim_tidydb'&"
34219 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34220 database. If run with no options, it removes all records that are more than 30
34221 days old. The age is calculated from the date and time that the record was last
34222 updated. Note that, in the case of the retry database, it is &'not'& the time
34223 since the first delivery failure. Information about a host that has been down
34224 for more than 30 days will remain in the database, provided that the record is
34225 updated sufficiently often.
34226
34227 The cutoff date can be altered by means of the &%-t%& option, which must be
34228 followed by a time. For example, to remove all records older than a week from
34229 the retry database:
34230 .code
34231 exim_tidydb -t 7d /var/spool/exim retry
34232 .endd
34233 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34234 message ids. In the former these appear as data in records keyed by host &--
34235 they were messages that were waiting for that host &-- and in the latter they
34236 are the keys for retry information for messages that have suffered certain
34237 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34238 message ids in database records are those of messages that are still on the
34239 queue. Message ids for messages that no longer exist are removed from
34240 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34241 For the &'retry'& database, records whose keys are non-existent message ids are
34242 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34243 whenever it removes information from the database.
34244
34245 Certain records are automatically removed by Exim when they are no longer
34246 needed, but others are not. For example, if all the MX hosts for a domain are
34247 down, a retry record is created for each one. If the primary MX host comes back
34248 first, its record is removed when Exim successfully delivers to it, but the
34249 records for the others remain because Exim has not tried to use those hosts.
34250
34251 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34252 hints databases. You should do this at a quiet time of day, because it requires
34253 a database to be locked (and therefore inaccessible to Exim) while it does its
34254 work. Removing records from a DBM file does not normally make the file smaller,
34255 but all the common DBM libraries are able to re-use the space that is released.
34256 After an initial phase of increasing in size, the databases normally reach a
34257 point at which they no longer get any bigger, as long as they are regularly
34258 tidied.
34259
34260 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34261 databases is likely to keep on increasing.
34262
34263
34264
34265
34266 .section "exim_fixdb" "SECID263"
34267 .cindex "&'exim_fixdb'&"
34268 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34269 Its main use is for testing Exim, but it might also be occasionally useful for
34270 getting round problems in a live system. It has no options, and its interface
34271 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34272 key of a database record can then be entered, and the data for that record is
34273 displayed.
34274
34275 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34276 except the &'retry'& database, that is the only operation that can be carried
34277 out. For the &'retry'& database, each field is output preceded by a number, and
34278 data for individual fields can be changed by typing the field number followed
34279 by new data, for example:
34280 .code
34281 > 4 951102:1000
34282 .endd
34283 resets the time of the next delivery attempt. Time values are given as a
34284 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34285 used as optional separators.
34286
34287
34288
34289
34290 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34291 .cindex "mailbox" "maintenance"
34292 .cindex "&'exim_lock'&"
34293 .cindex "locking mailboxes"
34294 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34295 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34296 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34297 a user agent while investigating a problem. The utility requires the name of
34298 the file as its first argument. If the locking is successful, the second
34299 argument is run as a command (using C's &[system()]& function); if there is no
34300 second argument, the value of the SHELL environment variable is used; if this
34301 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34302 is unlocked and the utility ends. The following options are available:
34303
34304 .vlist
34305 .vitem &%-fcntl%&
34306 Use &[fcntl()]& locking on the open mailbox.
34307
34308 .vitem &%-flock%&
34309 Use &[flock()]& locking on the open mailbox, provided the operating system
34310 supports it.
34311
34312 .vitem &%-interval%&
34313 This must be followed by a number, which is a number of seconds; it sets the
34314 interval to sleep between retries (default 3).
34315
34316 .vitem &%-lockfile%&
34317 Create a lock file before opening the mailbox.
34318
34319 .vitem &%-mbx%&
34320 Lock the mailbox using MBX rules.
34321
34322 .vitem &%-q%&
34323 Suppress verification output.
34324
34325 .vitem &%-retries%&
34326 This must be followed by a number; it sets the number of times to try to get
34327 the lock (default 10).
34328
34329 .vitem &%-restore_time%&
34330 This option causes &%exim_lock%& to restore the modified and read times to the
34331 locked file before exiting. This allows you to access a locked mailbox (for
34332 example, to take a backup copy) without disturbing the times that the user
34333 subsequently sees.
34334
34335 .vitem &%-timeout%&
34336 This must be followed by a number, which is a number of seconds; it sets a
34337 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
34338 default), a non-blocking call is used.
34339
34340 .vitem &%-v%&
34341 Generate verbose output.
34342 .endlist
34343
34344 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
34345 default is to create a lock file and also to use &[fcntl()]& locking on the
34346 mailbox, which is the same as Exim's default. The use of &%-flock%& or
34347 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
34348 requires that the directory containing the file be writeable. Locking by lock
34349 file does not last for ever; Exim assumes that a lock file is expired if it is
34350 more than 30 minutes old.
34351
34352 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
34353 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
34354 to be taken out on the open mailbox, and an exclusive lock on the file
34355 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
34356 number of the mailbox file. When the locking is released, if an exclusive lock
34357 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
34358
34359 The default output contains verification of the locking that takes place. The
34360 &%-v%& option causes some additional information to be given. The &%-q%& option
34361 suppresses all output except error messages.
34362
34363 A command such as
34364 .code
34365 exim_lock /var/spool/mail/spqr
34366 .endd
34367 runs an interactive shell while the file is locked, whereas
34368 .display
34369 &`exim_lock -q /var/spool/mail/spqr <<End`&
34370 <&'some commands'&>
34371 &`End`&
34372 .endd
34373 runs a specific non-interactive sequence of commands while the file is locked,
34374 suppressing all verification output. A single command can be run by a command
34375 such as
34376 .code
34377 exim_lock -q /var/spool/mail/spqr \
34378   "cp /var/spool/mail/spqr /some/where"
34379 .endd
34380 Note that if a command is supplied, it must be entirely contained within the
34381 second argument &-- hence the quotes.
34382 .ecindex IIDutils
34383
34384
34385 . ////////////////////////////////////////////////////////////////////////////
34386 . ////////////////////////////////////////////////////////////////////////////
34387
34388 .chapter "The Exim monitor" "CHAPeximon"
34389 .scindex IIDeximon "Exim monitor" "description"
34390 .cindex "X-windows"
34391 .cindex "&'eximon'&"
34392 .cindex "Local/eximon.conf"
34393 .cindex "&_exim_monitor/EDITME_&"
34394 The Exim monitor is an application which displays in an X window information
34395 about the state of Exim's queue and what Exim is doing. An admin user can
34396 perform certain operations on messages from this GUI interface; however all
34397 such facilities are also available from the command line, and indeed, the
34398 monitor itself makes use of the command line to perform any actions requested.
34399
34400
34401
34402 .section "Running the monitor" "SECID264"
34403 The monitor is started by running the script called &'eximon'&. This is a shell
34404 script that sets up a number of environment variables, and then runs the
34405 binary called &_eximon.bin_&. The default appearance of the monitor window can
34406 be changed by editing the &_Local/eximon.conf_& file created by editing
34407 &_exim_monitor/EDITME_&. Comments in that file describe what the various
34408 parameters are for.
34409
34410 The parameters that get built into the &'eximon'& script can be overridden for
34411 a particular invocation by setting up environment variables of the same names,
34412 preceded by &`EXIMON_`&. For example, a shell command such as
34413 .code
34414 EXIMON_LOG_DEPTH=400 eximon
34415 .endd
34416 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
34417 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
34418 overrides the Exim log file configuration. This makes it possible to have
34419 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
34420 syslog messages are routed to a file on the local host.
34421
34422 X resources can be used to change the appearance of the window in the normal
34423 way. For example, a resource setting of the form
34424 .code
34425 Eximon*background: gray94
34426 .endd
34427 changes the colour of the background to light grey rather than white. The
34428 stripcharts are drawn with both the data lines and the reference lines in
34429 black. This means that the reference lines are not visible when on top of the
34430 data. However, their colour can be changed by setting a resource called
34431 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
34432 For example, if your X server is running Unix, you could set up lighter
34433 reference lines in the stripcharts by obeying
34434 .code
34435 xrdb -merge <<End
34436 Eximon*highlight: gray
34437 End
34438 .endd
34439 .cindex "admin user"
34440 In order to see the contents of messages on the queue, and to operate on them,
34441 &'eximon'& must either be run as root or by an admin user.
34442
34443 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
34444 contain X11 resource parameters interpreted by the X11 library.  In addition,
34445 if the first parameter starts with the string "gdb" then it is removed and the
34446 binary is invoked under gdb (the parameter is used as the gdb command-name, so
34447 versioned variants of gdb can be invoked).
34448
34449 The monitor's window is divided into three parts. The first contains one or
34450 more stripcharts and two action buttons, the second contains a &"tail"& of the
34451 main log file, and the third is a display of the queue of messages awaiting
34452 delivery, with two more action buttons. The following sections describe these
34453 different parts of the display.
34454
34455
34456
34457
34458 .section "The stripcharts" "SECID265"
34459 .cindex "stripchart"
34460 The first stripchart is always a count of messages on the queue. Its name can
34461 be configured by setting QUEUE_STRIPCHART_NAME in the
34462 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
34463 configuration script by regular expression matches on log file entries, making
34464 it possible to display, for example, counts of messages delivered to certain
34465 hosts or using certain transports. The supplied defaults display counts of
34466 received and delivered messages, and of local and SMTP deliveries. The default
34467 period between stripchart updates is one minute; this can be adjusted by a
34468 parameter in the &_Local/eximon.conf_& file.
34469
34470 The stripchart displays rescale themselves automatically as the value they are
34471 displaying changes. There are always 10 horizontal lines in each chart; the
34472 title string indicates the value of each division when it is greater than one.
34473 For example, &"x2"& means that each division represents a value of 2.
34474
34475 It is also possible to have a stripchart which shows the percentage fullness of
34476 a particular disk partition, which is useful when local deliveries are confined
34477 to a single partition.
34478
34479 .cindex "&%statvfs%& function"
34480 This relies on the availability of the &[statvfs()]& function or equivalent in
34481 the operating system. Most, but not all versions of Unix that support Exim have
34482 this. For this particular stripchart, the top of the chart always represents
34483 100%, and the scale is given as &"x10%"&. This chart is configured by setting
34484 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
34485 &_Local/eximon.conf_& file.
34486
34487
34488
34489
34490 .section "Main action buttons" "SECID266"
34491 .cindex "size" "of monitor window"
34492 .cindex "Exim monitor" "window size"
34493 .cindex "window size"
34494 Below the stripcharts there is an action button for quitting the monitor. Next
34495 to this is another button marked &"Size"&. They are placed here so that
34496 shrinking the window to its default minimum size leaves just the queue count
34497 stripchart and these two buttons visible. Pressing the &"Size"& button causes
34498 the window to expand to its maximum size, unless it is already at the maximum,
34499 in which case it is reduced to its minimum.
34500
34501 When expanding to the maximum, if the window cannot be fully seen where it
34502 currently is, it is moved back to where it was the last time it was at full
34503 size. When it is expanding from its minimum size, the old position is
34504 remembered, and next time it is reduced to the minimum it is moved back there.
34505
34506 The idea is that you can keep a reduced window just showing one or two
34507 stripcharts at a convenient place on your screen, easily expand it to show
34508 the full window when required, and just as easily put it back to what it was.
34509 The idea is copied from what the &'twm'& window manager does for its
34510 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
34511 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
34512
34513 Normally, the monitor starts up with the window at its full size, but it can be
34514 built so that it starts up with the window at its smallest size, by setting
34515 START_SMALL=yes in &_Local/eximon.conf_&.
34516
34517
34518
34519 .section "The log display" "SECID267"
34520 .cindex "log" "tail of; in monitor"
34521 The second section of the window is an area in which a display of the tail of
34522 the main log is maintained.
34523 To save space on the screen, the timestamp on each log line is shortened by
34524 removing the date and, if &%log_timezone%& is set, the timezone.
34525 The log tail is not available when the only destination for logging data is
34526 syslog, unless the syslog lines are routed to a local file whose name is passed
34527 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
34528
34529 The log sub-window has a scroll bar at its lefthand side which can be used to
34530 move back to look at earlier text, and the up and down arrow keys also have a
34531 scrolling effect. The amount of log that is kept depends on the setting of
34532 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
34533 to use. When this is full, the earlier 50% of data is discarded &-- this is
34534 much more efficient than throwing it away line by line. The sub-window also has
34535 a horizontal scroll bar for accessing the ends of long log lines. This is the
34536 only means of horizontal scrolling; the right and left arrow keys are not
34537 available. Text can be cut from this part of the window using the mouse in the
34538 normal way. The size of this subwindow is controlled by parameters in the
34539 configuration file &_Local/eximon.conf_&.
34540
34541 Searches of the text in the log window can be carried out by means of the ^R
34542 and ^S keystrokes, which default to a reverse and a forward search,
34543 respectively. The search covers only the text that is displayed in the window.
34544 It cannot go further back up the log.
34545
34546 The point from which the search starts is indicated by a caret marker. This is
34547 normally at the end of the text in the window, but can be positioned explicitly
34548 by pointing and clicking with the left mouse button, and is moved automatically
34549 by a successful search. If new text arrives in the window when it is scrolled
34550 back, the caret remains where it is, but if the window is not scrolled back,
34551 the caret is moved to the end of the new text.
34552
34553 Pressing ^R or ^S pops up a window into which the search text can be typed.
34554 There are buttons for selecting forward or reverse searching, for carrying out
34555 the search, and for cancelling. If the &"Search"& button is pressed, the search
34556 happens and the window remains so that further searches can be done. If the
34557 &"Return"& key is pressed, a single search is done and the window is closed. If
34558 ^C is typed the search is cancelled.
34559
34560 The searching facility is implemented using the facilities of the Athena text
34561 widget. By default this pops up a window containing both &"search"& and
34562 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
34563 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
34564 However, the linkers in BSDI and HP-UX seem unable to handle an externally
34565 provided version of &%TextPop%& when the remaining parts of the text widget
34566 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
34567 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
34568 on these systems, at the expense of having unwanted items in the search popup
34569 window.
34570
34571
34572
34573 .section "The queue display" "SECID268"
34574 .cindex "queue" "display in monitor"
34575 The bottom section of the monitor window contains a list of all messages that
34576 are on the queue, which includes those currently being received or delivered,
34577 as well as those awaiting delivery. The size of this subwindow is controlled by
34578 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
34579 at which it is updated is controlled by another parameter in the same file &--
34580 the default is 5 minutes, since queue scans can be quite expensive. However,
34581 there is an &"Update"& action button just above the display which can be used
34582 to force an update of the queue display at any time.
34583
34584 When a host is down for some time, a lot of pending mail can build up for it,
34585 and this can make it hard to deal with other messages on the queue. To help
34586 with this situation there is a button next to &"Update"& called &"Hide"&. If
34587 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
34588 type anything in here and press &"Return"&, the text is added to a chain of
34589 such texts, and if every undelivered address in a message matches at least one
34590 of the texts, the message is not displayed.
34591
34592 If there is an address that does not match any of the texts, all the addresses
34593 are displayed as normal. The matching happens on the ends of addresses so, for
34594 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
34595 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
34596 has been set up, a button called &"Unhide"& is displayed. If pressed, it
34597 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
34598 a hide request is automatically cancelled after one hour.
34599
34600 While the dialogue box is displayed, you can't press any buttons or do anything
34601 else to the monitor window. For this reason, if you want to cut text from the
34602 queue display to use in the dialogue box, you have to do the cutting before
34603 pressing the &"Hide"& button.
34604
34605 The queue display contains, for each unhidden queued message, the length of
34606 time it has been on the queue, the size of the message, the message id, the
34607 message sender, and the first undelivered recipient, all on one line. If it is
34608 a bounce message, the sender is shown as &"<>"&. If there is more than one
34609 recipient to which the message has not yet been delivered, subsequent ones are
34610 listed on additional lines, up to a maximum configured number, following which
34611 an ellipsis is displayed. Recipients that have already received the message are
34612 not shown.
34613
34614 .cindex "frozen messages" "display"
34615 If a message is frozen, an asterisk is displayed at the left-hand side.
34616
34617 The queue display has a vertical scroll bar, and can also be scrolled by means
34618 of the arrow keys. Text can be cut from it using the mouse in the normal way.
34619 The text searching facilities, as described above for the log window, are also
34620 available, but the caret is always moved to the end of the text when the queue
34621 display is updated.
34622
34623
34624
34625 .section "The queue menu" "SECID269"
34626 .cindex "queue" "menu in monitor"
34627 If the &%shift%& key is held down and the left button is clicked when the mouse
34628 pointer is over the text for any message, an action menu pops up, and the first
34629 line of the queue display for the message is highlighted. This does not affect
34630 any selected text.
34631
34632 If you want to use some other event for popping up the menu, you can set the
34633 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
34634 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
34635 value set in this parameter is a standard X event description. For example, to
34636 run eximon using &%ctrl%& rather than &%shift%& you could use
34637 .code
34638 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
34639 .endd
34640 The title of the menu is the message id, and it contains entries which act as
34641 follows:
34642
34643 .ilist
34644 &'message log'&: The contents of the message log for the message are displayed
34645 in a new text window.
34646 .next
34647 &'headers'&: Information from the spool file that contains the envelope
34648 information and headers is displayed in a new text window. See chapter
34649 &<<CHAPspool>>& for a description of the format of spool files.
34650 .next
34651 &'body'&: The contents of the spool file containing the body of the message are
34652 displayed in a new text window. There is a default limit of 20,000 bytes to the
34653 amount of data displayed. This can be changed by setting the BODY_MAX
34654 option at compile time, or the EXIMON_BODY_MAX option at run time.
34655 .next
34656 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
34657 delivery of the message. This causes an automatic thaw if the message is
34658 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
34659 a new text window. The delivery is run in a separate process, to avoid holding
34660 up the monitor while the delivery proceeds.
34661 .next
34662 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
34663 that the message be frozen.
34664 .next
34665 .cindex "thawing messages"
34666 .cindex "unfreezing messages"
34667 .cindex "frozen messages" "thawing"
34668 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
34669 that the message be thawed.
34670 .next
34671 .cindex "delivery" "forcing failure"
34672 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
34673 that Exim gives up trying to deliver the message. A bounce message is generated
34674 for any remaining undelivered addresses.
34675 .next
34676 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
34677 that the message be deleted from the system without generating a bounce
34678 message.
34679 .next
34680 &'add recipient'&: A dialog box is displayed into which a recipient address can
34681 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34682 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34683 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34684 causes a call to Exim to be made using the &%-Mar%& option to request that an
34685 additional recipient be added to the message, unless the entry box is empty, in
34686 which case no action is taken.
34687 .next
34688 &'mark delivered'&: A dialog box is displayed into which a recipient address
34689 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34690 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34691 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34692 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
34693 recipient address as already delivered, unless the entry box is empty, in which
34694 case no action is taken.
34695 .next
34696 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
34697 mark all recipient addresses as already delivered.
34698 .next
34699 &'edit sender'&: A dialog box is displayed initialized with the current
34700 sender's address. Pressing RETURN causes a call to Exim to be made using the
34701 &%-Mes%& option to replace the sender address, unless the entry box is empty,
34702 in which case no action is taken. If you want to set an empty sender (as in
34703 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
34704 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
34705 the address is qualified with that domain.
34706 .endlist
34707
34708 When a delivery is forced, a window showing the &%-v%& output is displayed. In
34709 other cases when a call to Exim is made, if there is any output from Exim (in
34710 particular, if the command fails) a window containing the command and the
34711 output is displayed. Otherwise, the results of the action are normally apparent
34712 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
34713 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
34714 if no output is generated.
34715
34716 The queue display is automatically updated for actions such as freezing and
34717 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
34718 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
34719 force an update of the display after one of these actions.
34720
34721 In any text window that is displayed as result of a menu action, the normal
34722 cut-and-paste facility is available, and searching can be carried out using ^R
34723 and ^S, as described above for the log tail window.
34724 .ecindex IIDeximon
34725
34726
34727
34728
34729
34730 . ////////////////////////////////////////////////////////////////////////////
34731 . ////////////////////////////////////////////////////////////////////////////
34732
34733 .chapter "Security considerations" "CHAPsecurity"
34734 .scindex IIDsecurcon "security" "discussion of"
34735 This chapter discusses a number of issues concerned with security, some of
34736 which are also covered in other parts of this manual.
34737
34738 For reasons that this author does not understand, some people have promoted
34739 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
34740 existence of this chapter in the documentation. However, the intent of the
34741 chapter is simply to describe the way Exim works in relation to certain
34742 security concerns, not to make any specific claims about the effectiveness of
34743 its security as compared with other MTAs.
34744
34745 What follows is a description of the way Exim is supposed to be. Best efforts
34746 have been made to try to ensure that the code agrees with the theory, but an
34747 absence of bugs can never be guaranteed. Any that are reported will get fixed
34748 as soon as possible.
34749
34750
34751 .section "Building a more &""hardened""& Exim" "SECID286"
34752 .cindex "security" "build-time features"
34753 There are a number of build-time options that can be set in &_Local/Makefile_&
34754 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
34755 Exim administrator who does not have the root password, or by someone who has
34756 penetrated the Exim (but not the root) account. These options are as follows:
34757
34758 .ilist
34759 ALT_CONFIG_PREFIX can be set to a string that is required to match the
34760 start of any file names used with the &%-C%& option. When it is set, these file
34761 names are also not allowed to contain the sequence &"/../"&. (However, if the
34762 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
34763 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
34764 default setting for &%ALT_CONFIG_PREFIX%&.
34765
34766 If the permitted configuration files are confined to a directory to
34767 which only root has access, this guards against someone who has broken
34768 into the Exim account from running a privileged Exim with an arbitrary
34769 configuration file, and using it to break into other accounts.
34770 .next
34771
34772 If a non-trusted configuration file (i.e. not the default configuration file
34773 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
34774 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
34775 the next item), then root privilege is retained only if the caller of Exim is
34776 root. This locks out the possibility of testing a configuration using &%-C%&
34777 right through message reception and delivery, even if the caller is root. The
34778 reception works, but by that time, Exim is running as the Exim user, so when
34779 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
34780 privilege to be lost. However, root can test reception and delivery using two
34781 separate commands.
34782
34783 .next
34784 The WHITELIST_D_MACROS build option declares some macros to be safe to override
34785 with &%-D%& if the real uid is one of root, the Exim run-time user or the
34786 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
34787 requiring the run-time value supplied to &%-D%& to match a regex that errs on
34788 the restrictive side.  Requiring build-time selection of safe macros is onerous
34789 but this option is intended solely as a transition mechanism to permit
34790 previously-working configurations to continue to work after release 4.73.
34791 .next
34792 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
34793 is disabled.
34794 .next
34795 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
34796 never to be used for any deliveries. This is like the &%never_users%& runtime
34797 option, but it cannot be overridden; the runtime option adds additional users
34798 to the list. The default setting is &"root"&; this prevents a non-root user who
34799 is permitted to modify the runtime file from using Exim as a way to get root.
34800 .endlist
34801
34802
34803
34804 .section "Root privilege" "SECID270"
34805 .cindex "setuid"
34806 .cindex "root privilege"
34807 The Exim binary is normally setuid to root, which means that it gains root
34808 privilege (runs as root) when it starts execution. In some special cases (for
34809 example, when the daemon is not in use and there are no local deliveries), it
34810 may be possible to run Exim setuid to some user other than root. This is
34811 discussed in the next section. However, in most installations, root privilege
34812 is required for two things:
34813
34814 .ilist
34815 To set up a socket connected to the standard SMTP port (25) when initialising
34816 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
34817 not required.
34818 .next
34819 To be able to change uid and gid in order to read users' &_.forward_& files and
34820 perform local deliveries as the receiving user or as specified in the
34821 configuration.
34822 .endlist
34823
34824 It is not necessary to be root to do any of the other things Exim does, such as
34825 receiving messages and delivering them externally over SMTP, and it is
34826 obviously more secure if Exim does not run as root except when necessary.
34827 For this reason, a user and group for Exim to use must be defined in
34828 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
34829 group"&. Their values can be changed by the run time configuration, though this
34830 is not recommended. Often a user called &'exim'& is used, but some sites use
34831 &'mail'& or another user name altogether.
34832
34833 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
34834 abdication; the process cannot regain root afterwards. Prior to release 4.00,
34835 &[seteuid()]& was used in some circumstances, but this is no longer the case.
34836
34837 After a new Exim process has interpreted its command line options, it changes
34838 uid and gid in the following cases:
34839
34840 .ilist
34841 .oindex "&%-C%&"
34842 .oindex "&%-D%&"
34843 If the &%-C%& option is used to specify an alternate configuration file, or if
34844 the &%-D%& option is used to define macro values for the configuration, and the
34845 calling process is not running as root, the uid and gid are changed to those of
34846 the calling process.
34847 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
34848 option may not be used at all.
34849 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
34850 can be supplied if the calling process is running as root, the Exim run-time
34851 user or CONFIGURE_OWNER, if defined.
34852 .next
34853 .oindex "&%-be%&"
34854 .oindex "&%-bf%&"
34855 .oindex "&%-bF%&"
34856 If the expansion test option (&%-be%&) or one of the filter testing options
34857 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
34858 calling process.
34859 .next
34860 If the process is not a daemon process or a queue runner process or a delivery
34861 process or a process for testing address routing (started with &%-bt%&), the
34862 uid and gid are changed to the Exim user and group. This means that Exim always
34863 runs under its own uid and gid when receiving messages. This also applies when
34864 testing address verification
34865 .oindex "&%-bv%&"
34866 .oindex "&%-bh%&"
34867 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
34868 option).
34869 .next
34870 For a daemon, queue runner, delivery, or address testing process, the uid
34871 remains as root at this stage, but the gid is changed to the Exim group.
34872 .endlist
34873
34874 The processes that initially retain root privilege behave as follows:
34875
34876 .ilist
34877 A daemon process changes the gid to the Exim group and the uid to the Exim
34878 user after setting up one or more listening sockets. The &[initgroups()]&
34879 function is called, so that if the Exim user is in any additional groups, they
34880 will be used during message reception.
34881 .next
34882 A queue runner process retains root privilege throughout its execution. Its
34883 job is to fork a controlled sequence of delivery processes.
34884 .next
34885 A delivery process retains root privilege throughout most of its execution,
34886 but any actual deliveries (that is, the transports themselves) are run in
34887 subprocesses which always change to a non-root uid and gid. For local
34888 deliveries this is typically the uid and gid of the owner of the mailbox; for
34889 remote deliveries, the Exim uid and gid are used. Once all the delivery
34890 subprocesses have been run, a delivery process changes to the Exim uid and gid
34891 while doing post-delivery tidying up such as updating the retry database and
34892 generating bounce and warning messages.
34893
34894 While the recipient addresses in a message are being routed, the delivery
34895 process runs as root. However, if a user's filter file has to be processed,
34896 this is done in a subprocess that runs under the individual user's uid and
34897 gid. A system filter is run as root unless &%system_filter_user%& is set.
34898 .next
34899 A process that is testing addresses (the &%-bt%& option) runs as root so that
34900 the routing is done in the same environment as a message delivery.
34901 .endlist
34902
34903
34904
34905
34906 .section "Running Exim without privilege" "SECTrunexiwitpri"
34907 .cindex "privilege, running without"
34908 .cindex "unprivileged running"
34909 .cindex "root privilege" "running without"
34910 Some installations like to run Exim in an unprivileged state for more of its
34911 operation, for added security. Support for this mode of operation is provided
34912 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34913 gid are changed to the Exim user and group at the start of a delivery process
34914 (and also queue runner and address testing processes). This means that address
34915 routing is no longer run as root, and the deliveries themselves cannot change
34916 to any other uid.
34917
34918 .cindex SIGHUP
34919 .cindex "daemon" "restarting"
34920 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34921 that the daemon can still be started in the usual way, and it can respond
34922 correctly to SIGHUP because the re-invocation regains root privilege.
34923
34924 An alternative approach is to make Exim setuid to the Exim user and also setgid
34925 to the Exim group. If you do this, the daemon must be started from a root
34926 process. (Calling Exim from a root process makes it behave in the way it does
34927 when it is setuid root.) However, the daemon cannot restart itself after a
34928 SIGHUP signal because it cannot regain privilege.
34929
34930 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34931 stops Exim from trying to re-invoke itself to do a delivery after a message has
34932 been received. Such a re-invocation is a waste of resources because it has no
34933 effect.
34934
34935 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34936 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34937 to the Exim user seems a clean approach, but there is one complication:
34938
34939 In this style of operation, Exim is running with the real uid and gid set to
34940 those of the calling process, and the effective uid/gid set to Exim's values.
34941 Ideally, any association with the calling process' uid/gid should be dropped,
34942 that is, the real uid/gid should be reset to the effective values so as to
34943 discard any privileges that the caller may have. While some operating systems
34944 have a function that permits this action for a non-root effective uid, quite a
34945 number of them do not. Because of this lack of standardization, Exim does not
34946 address this problem at this time.
34947
34948 For this reason, the recommended approach for &"mostly unprivileged"& running
34949 is to keep the Exim binary setuid to root, and to set
34950 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34951 be used in the most straightforward way.
34952
34953 If you configure Exim not to run delivery processes as root, there are a
34954 number of restrictions on what you can do:
34955
34956 .ilist
34957 You can deliver only as the Exim user/group. You should  explicitly use the
34958 &%user%& and &%group%& options to override routers or local transports that
34959 normally deliver as the recipient. This makes sure that configurations that
34960 work in this mode function the same way in normal mode. Any implicit or
34961 explicit specification of another user causes an error.
34962 .next
34963 Use of &_.forward_& files is severely restricted, such that it is usually
34964 not worthwhile to include them in the configuration.
34965 .next
34966 Users who wish to use &_.forward_& would have to make their home directory and
34967 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34968 and their equivalents in Exim filters, cannot be used. While they could be
34969 enabled in the Exim user's name, that would be insecure and not very useful.
34970 .next
34971 Unless the local user mailboxes are all owned by the Exim user (possible in
34972 some POP3 or IMAP-only environments):
34973
34974 .olist
34975 They must be owned by the Exim group and be writeable by that group. This
34976 implies you must set &%mode%& in the appendfile configuration, as well as the
34977 mode of the mailbox files themselves.
34978 .next
34979 You must set &%no_check_owner%&, since most or all of the files will not be
34980 owned by the Exim user.
34981 .next
34982 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34983 on a newly created mailbox when unprivileged. This also implies that new
34984 mailboxes need to be created manually.
34985 .endlist olist
34986 .endlist ilist
34987
34988
34989 These restrictions severely restrict what can be done in local deliveries.
34990 However, there are no restrictions on remote deliveries. If you are running a
34991 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34992 gives more security at essentially no cost.
34993
34994 If you are using the &%mua_wrapper%& facility (see chapter
34995 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34996
34997
34998
34999
35000 .section "Delivering to local files" "SECID271"
35001 Full details of the checks applied by &(appendfile)& before it writes to a file
35002 are given in chapter &<<CHAPappendfile>>&.
35003
35004
35005
35006 .section "IPv4 source routing" "SECID272"
35007 .cindex "source routing" "in IP packets"
35008 .cindex "IP source routing"
35009 Many operating systems suppress IP source-routed packets in the kernel, but
35010 some cannot be made to do this, so Exim does its own check. It logs incoming
35011 IPv4 source-routed TCP calls, and then drops them. Things are all different in
35012 IPv6. No special checking is currently done.
35013
35014
35015
35016 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
35017 Support for these SMTP commands is disabled by default. If required, they can
35018 be enabled by defining suitable ACLs.
35019
35020
35021
35022
35023 .section "Privileged users" "SECID274"
35024 .cindex "trusted users"
35025 .cindex "admin user"
35026 .cindex "privileged user"
35027 .cindex "user" "trusted"
35028 .cindex "user" "admin"
35029 Exim recognizes two sets of users with special privileges. Trusted users are
35030 able to submit new messages to Exim locally, but supply their own sender
35031 addresses and information about a sending host. For other users submitting
35032 local messages, Exim sets up the sender address from the uid, and doesn't
35033 permit a remote host to be specified.
35034
35035 .oindex "&%-f%&"
35036 However, an untrusted user is permitted to use the &%-f%& command line option
35037 in the special form &%-f <>%& to indicate that a delivery failure for the
35038 message should not cause an error report. This affects the message's envelope,
35039 but it does not affect the &'Sender:'& header. Untrusted users may also be
35040 permitted to use specific forms of address with the &%-f%& option by setting
35041 the &%untrusted_set_sender%& option.
35042
35043 Trusted users are used to run processes that receive mail messages from some
35044 other mail domain and pass them on to Exim for delivery either locally, or over
35045 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35046 as any user listed in the &%trusted_users%& configuration option, or under any
35047 group listed in the &%trusted_groups%& option.
35048
35049 Admin users are permitted to do things to the messages on Exim's queue. They
35050 can freeze or thaw messages, cause them to be returned to their senders, remove
35051 them entirely, or modify them in various ways. In addition, admin users can run
35052 the Exim monitor and see all the information it is capable of providing, which
35053 includes the contents of files on the spool.
35054
35055 .oindex "&%-M%&"
35056 .oindex "&%-q%&"
35057 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35058 delivery of messages on its queue is restricted to admin users. This
35059 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35060 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35061 queue is also restricted to admin users. This restriction can be relaxed by
35062 setting &%no_queue_list_requires_admin%&.
35063
35064 Exim recognizes an admin user if the calling process is running as root or as
35065 the Exim user or if any of the groups associated with the calling process is
35066 the Exim group. It is not necessary actually to be running under the Exim
35067 group. However, if admin users who are not root or the Exim user are to access
35068 the contents of files on the spool via the Exim monitor (which runs
35069 unprivileged), Exim must be built to allow group read access to its spool
35070 files.
35071
35072
35073
35074 .section "Spool files" "SECID275"
35075 .cindex "spool directory" "files"
35076 Exim's spool directory and everything it contains is owned by the Exim user and
35077 set to the Exim group. The mode for spool files is defined in the
35078 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35079 any user who is a member of the Exim group can access these files.
35080
35081
35082
35083 .section "Use of argv[0]" "SECID276"
35084 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35085 of specific strings, Exim assumes certain options. For example, calling Exim
35086 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35087 to calling it with the option &%-bS%&. There are no security implications in
35088 this.
35089
35090
35091
35092 .section "Use of %f formatting" "SECID277"
35093 The only use made of &"%f"& by Exim is in formatting load average values. These
35094 are actually stored in integer variables as 1000 times the load average.
35095 Consequently, their range is limited and so therefore is the length of the
35096 converted output.
35097
35098
35099
35100 .section "Embedded Exim path" "SECID278"
35101 Exim uses its own path name, which is embedded in the code, only when it needs
35102 to re-exec in order to regain root privilege. Therefore, it is not root when it
35103 does so. If some bug allowed the path to get overwritten, it would lead to an
35104 arbitrary program's being run as exim, not as root.
35105
35106
35107
35108 .section "Dynamic module directory" "SECTdynmoddir"
35109 Any dynamically loadable modules must be installed into the directory
35110 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35111 loading it.
35112
35113
35114 .section "Use of sprintf()" "SECID279"
35115 .cindex "&[sprintf()]&"
35116 A large number of occurrences of &"sprintf"& in the code are actually calls to
35117 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35118 The intermediate formatting is done into a large fixed buffer by a function
35119 that runs through the format string itself, and checks the length of each
35120 conversion before performing it, thus preventing buffer overruns.
35121
35122 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35123 the output buffer is known to be sufficiently long to contain the converted
35124 string.
35125
35126
35127
35128 .section "Use of debug_printf() and log_write()" "SECID280"
35129 Arbitrary strings are passed to both these functions, but they do their
35130 formatting by calling the function &'string_vformat()'&, which runs through
35131 the format string itself, and checks the length of each conversion.
35132
35133
35134
35135 .section "Use of strcat() and strcpy()" "SECID281"
35136 These are used only in cases where the output buffer is known to be large
35137 enough to hold the result.
35138 .ecindex IIDsecurcon
35139
35140
35141
35142
35143 . ////////////////////////////////////////////////////////////////////////////
35144 . ////////////////////////////////////////////////////////////////////////////
35145
35146 .chapter "Format of spool files" "CHAPspool"
35147 .scindex IIDforspo1 "format" "spool files"
35148 .scindex IIDforspo2 "spool directory" "format of files"
35149 .scindex IIDforspo3 "spool files" "format of"
35150 .cindex "spool files" "editing"
35151 A message on Exim's queue consists of two files, whose names are the message id
35152 followed by -D and -H, respectively. The data portion of the message is kept in
35153 the -D file on its own. The message's envelope, status, and headers are all
35154 kept in the -H file, whose format is described in this chapter. Each of these
35155 two files contains the final component of its own name as its first line. This
35156 is insurance against disk crashes where the directory is lost but the files
35157 themselves are recoverable.
35158
35159 Some people are tempted into editing -D files in order to modify messages. You
35160 need to be extremely careful if you do this; it is not recommended and you are
35161 on your own if you do it. Here are some of the pitfalls:
35162
35163 .ilist
35164 You must ensure that Exim does not try to deliver the message while you are
35165 fiddling with it. The safest way is to take out a write lock on the -D file,
35166 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35167 place, the lock will be retained. If you write a new file and rename it, the
35168 lock will be lost at the instant of rename.
35169 .next
35170 .vindex "&$body_linecount$&"
35171 If you change the number of lines in the file, the value of
35172 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35173 present, this value is not used by Exim, but there is no guarantee that this
35174 will always be the case.
35175 .next
35176 If the message is in MIME format, you must take care not to break it.
35177 .next
35178 If the message is cryptographically signed, any change will invalidate the
35179 signature.
35180 .endlist
35181 All in all, modifying -D files is fraught with danger.
35182
35183 Files whose names end with -J may also be seen in the &_input_& directory (or
35184 its subdirectories when &%split_spool_directory%& is set). These are journal
35185 files, used to record addresses to which the message has been delivered during
35186 the course of a delivery attempt. If there are still undelivered recipients at
35187 the end, the -H file is updated, and the -J file is deleted. If, however, there
35188 is some kind of crash (for example, a power outage) before this happens, the -J
35189 file remains in existence. When Exim next processes the message, it notices the
35190 -J file and uses it to update the -H file before starting the next delivery
35191 attempt.
35192
35193 .section "Format of the -H file" "SECID282"
35194 .cindex "uid (user id)" "in spool file"
35195 .cindex "gid (group id)" "in spool file"
35196 The second line of the -H file contains the login name for the uid of the
35197 process that called Exim to read the message, followed by the numerical uid and
35198 gid. For a locally generated message, this is normally the user who sent the
35199 message. For a message received over TCP/IP via the daemon, it is
35200 normally the Exim user.
35201
35202 The third line of the file contains the address of the message's sender as
35203 transmitted in the envelope, contained in angle brackets. The sender address is
35204 empty for bounce messages. For incoming SMTP mail, the sender address is given
35205 in the MAIL command. For locally generated mail, the sender address is
35206 created by Exim from the login name of the current user and the configured
35207 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35208 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35209 &"<>"& or an address that matches &%untrusted_set_senders%&.
35210
35211 The fourth line contains two numbers. The first is the time that the message
35212 was received, in the conventional Unix form &-- the number of seconds since the
35213 start of the epoch. The second number is a count of the number of messages
35214 warning of delayed delivery that have been sent to the sender.
35215
35216 There follow a number of lines starting with a hyphen. These can appear in any
35217 order, and are omitted when not relevant:
35218
35219 .vlist
35220 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35221 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35222 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35223 recognized, to provide backward compatibility. In the old format, a line of
35224 this form is present for every ACL variable that is not empty. The number
35225 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35226 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35227 the data string for the variable. The string itself starts at the beginning of
35228 the next line, and is followed by a newline character. It may contain internal
35229 newlines.
35230
35231 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35232 A line of this form is present for every ACL connection variable that is
35233 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35234 The length is the length of the data string for the variable. The string itself
35235 starts at the beginning of the next line, and is followed by a newline
35236 character. It may contain internal newlines.
35237
35238 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35239 A line of this form is present for every ACL message variable that is defined.
35240 Note that there is a space between &%-aclm%& and the rest of the name. The
35241 length is the length of the data string for the variable. The string itself
35242 starts at the beginning of the next line, and is followed by a newline
35243 character. It may contain internal newlines.
35244
35245 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35246 This is present if, when the message was received over SMTP, the value of
35247 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35248
35249 .vitem &%-allow_unqualified_recipient%&
35250 This is present if unqualified recipient addresses are permitted in header
35251 lines (to stop such addresses from being qualified if rewriting occurs at
35252 transport time). Local messages that were input using &%-bnq%& and remote
35253 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35254
35255 .vitem &%-allow_unqualified_sender%&
35256 This is present if unqualified sender addresses are permitted in header lines
35257 (to stop such addresses from being qualified if rewriting occurs at transport
35258 time). Local messages that were input using &%-bnq%& and remote messages from
35259 hosts that match &%sender_unqualified_hosts%& set this flag.
35260
35261 .vitem "&%-auth_id%&&~<&'text'&>"
35262 The id information for a message received on an authenticated SMTP connection
35263 &-- the value of the &$authenticated_id$& variable.
35264
35265 .vitem "&%-auth_sender%&&~<&'address'&>"
35266 The address of an authenticated sender &-- the value of the
35267 &$authenticated_sender$& variable.
35268
35269 .vitem "&%-body_linecount%&&~<&'number'&>"
35270 This records the number of lines in the body of the message, and is always
35271 present.
35272
35273 .vitem "&%-body_zerocount%&&~<&'number'&>"
35274 This records the number of binary zero bytes in the body of the message, and is
35275 present if the number is greater than zero.
35276
35277 .vitem &%-deliver_firsttime%&
35278 This is written when a new message is first added to the spool. When the spool
35279 file is updated after a deferral, it is omitted.
35280
35281 .vitem "&%-frozen%&&~<&'time'&>"
35282 .cindex "frozen messages" "spool data"
35283 The message is frozen, and the freezing happened at <&'time'&>.
35284
35285 .vitem "&%-helo_name%&&~<&'text'&>"
35286 This records the host name as specified by a remote host in a HELO or EHLO
35287 command.
35288
35289 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35290 This records the IP address of the host from which the message was received and
35291 the remote port number that was used. It is omitted for locally generated
35292 messages.
35293
35294 .vitem "&%-host_auth%&&~<&'text'&>"
35295 If the message was received on an authenticated SMTP connection, this records
35296 the name of the authenticator &-- the value of the
35297 &$sender_host_authenticated$& variable.
35298
35299 .vitem &%-host_lookup_failed%&
35300 This is present if an attempt to look up the sending host's name from its IP
35301 address failed. It corresponds to the &$host_lookup_failed$& variable.
35302
35303 .vitem "&%-host_name%&&~<&'text'&>"
35304 .cindex "reverse DNS lookup"
35305 .cindex "DNS" "reverse lookup"
35306 This records the name of the remote host from which the message was received,
35307 if the host name was looked up from the IP address when the message was being
35308 received. It is not present if no reverse lookup was done.
35309
35310 .vitem "&%-ident%&&~<&'text'&>"
35311 For locally submitted messages, this records the login of the originating user,
35312 unless it was a trusted user and the &%-oMt%& option was used to specify an
35313 ident value. For messages received over TCP/IP, this records the ident string
35314 supplied by the remote host, if any.
35315
35316 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
35317 This records the IP address of the local interface and the port number through
35318 which a message was received from a remote host. It is omitted for locally
35319 generated messages.
35320
35321 .vitem &%-local%&
35322 The message is from a local sender.
35323
35324 .vitem &%-localerror%&
35325 The message is a locally-generated bounce message.
35326
35327 .vitem "&%-local_scan%&&~<&'string'&>"
35328 This records the data string that was returned by the &[local_scan()]& function
35329 when the message was received &-- the value of the &$local_scan_data$&
35330 variable. It is omitted if no data was returned.
35331
35332 .vitem &%-manual_thaw%&
35333 The message was frozen but has been thawed manually, that is, by an explicit
35334 Exim command rather than via the auto-thaw process.
35335
35336 .vitem &%-N%&
35337 A testing delivery process was started using the &%-N%& option to suppress any
35338 actual deliveries, but delivery was deferred. At any further delivery attempts,
35339 &%-N%& is assumed.
35340
35341 .vitem &%-received_protocol%&
35342 This records the value of the &$received_protocol$& variable, which contains
35343 the name of the protocol by which the message was received.
35344
35345 .vitem &%-sender_set_untrusted%&
35346 The envelope sender of this message was set by an untrusted local caller (used
35347 to ensure that the caller is displayed in queue listings).
35348
35349 .vitem "&%-spam_score_int%&&~<&'number'&>"
35350 If a message was scanned by SpamAssassin, this is present. It records the value
35351 of &$spam_score_int$&.
35352
35353 .vitem &%-tls_certificate_verified%&
35354 A TLS certificate was received from the client that sent this message, and the
35355 certificate was verified by the server.
35356
35357 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
35358 When the message was received over an encrypted connection, this records the
35359 name of the cipher suite that was used.
35360
35361 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
35362 When the message was received over an encrypted connection, and a certificate
35363 was received from the client, this records the Distinguished Name from that
35364 certificate.
35365 .endlist
35366
35367 Following the options there is a list of those addresses to which the message
35368 is not to be delivered. This set of addresses is initialized from the command
35369 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
35370 is set; otherwise it starts out empty. Whenever a successful delivery is made,
35371 the address is added to this set. The addresses are kept internally as a
35372 balanced binary tree, and it is a representation of that tree which is written
35373 to the spool file. If an address is expanded via an alias or forward file, the
35374 original address is added to the tree when deliveries to all its child
35375 addresses are complete.
35376
35377 If the tree is empty, there is a single line in the spool file containing just
35378 the text &"XX"&. Otherwise, each line consists of two letters, which are either
35379 Y or N, followed by an address. The address is the value for the node of the
35380 tree, and the letters indicate whether the node has a left branch and/or a
35381 right branch attached to it, respectively. If branches exist, they immediately
35382 follow. Here is an example of a three-node tree:
35383 .code
35384 YY darcy@austen.fict.example
35385 NN alice@wonderland.fict.example
35386 NN editor@thesaurus.ref.example
35387 .endd
35388 After the non-recipients tree, there is a list of the message's recipients.
35389 This is a simple list, preceded by a count. It includes all the original
35390 recipients of the message, including those to whom the message has already been
35391 delivered. In the simplest case, the list contains one address per line. For
35392 example:
35393 .code
35394 4
35395 editor@thesaurus.ref.example
35396 darcy@austen.fict.example
35397 rdo@foundation
35398 alice@wonderland.fict.example
35399 .endd
35400 However, when a child address has been added to the top-level addresses as a
35401 result of the use of the &%one_time%& option on a &(redirect)& router, each
35402 line is of the following form:
35403 .display
35404 <&'top-level address'&> <&'errors_to address'&> &&&
35405   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
35406 .endd
35407 The 01 flag bit indicates the presence of the three other fields that follow
35408 the top-level address. Other bits may be used in future to support additional
35409 fields. The <&'parent number'&> is the offset in the recipients list of the
35410 original parent of the &"one time"& address. The first two fields are the
35411 envelope sender that is associated with this address and its length. If the
35412 length is zero, there is no special envelope sender (there are then two space
35413 characters in the line). A non-empty field can arise from a &(redirect)& router
35414 that has an &%errors_to%& setting.
35415
35416
35417 A blank line separates the envelope and status information from the headers
35418 which follow. A header may occupy several lines of the file, and to save effort
35419 when reading it in, each header is preceded by a number and an identifying
35420 character. The number is the number of characters in the header, including any
35421 embedded newlines and the terminating newline. The character is one of the
35422 following:
35423
35424 .table2 50pt
35425 .row <&'blank'&>         "header in which Exim has no special interest"
35426 .row &`B`&               "&'Bcc:'& header"
35427 .row &`C`&               "&'Cc:'& header"
35428 .row &`F`&               "&'From:'& header"
35429 .row &`I`&               "&'Message-id:'& header"
35430 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
35431 .row &`R`&               "&'Reply-To:'& header"
35432 .row &`S`&               "&'Sender:'& header"
35433 .row &`T`&               "&'To:'& header"
35434 .row &`*`&               "replaced or deleted header"
35435 .endtable
35436
35437 Deleted or replaced (rewritten) headers remain in the spool file for debugging
35438 purposes. They are not transmitted when the message is delivered. Here is a
35439 typical set of headers:
35440 .code
35441 111P Received: by hobbit.fict.example with local (Exim 4.00)
35442 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
35443 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
35444 038* X-rewrote-sender: bb@hobbit.fict.example
35445 042* From: Bilbo Baggins <bb@hobbit.fict.example>
35446 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
35447 099* To: alice@wonderland.fict.example, rdo@foundation,
35448 darcy@austen.fict.example, editor@thesaurus.ref.example
35449 104T To: alice@wonderland.fict.example, rdo@foundation.example,
35450 darcy@austen.fict.example, editor@thesaurus.ref.example
35451 038  Date: Fri, 11 May 2001 10:28:59 +0100
35452 .endd
35453 The asterisked headers indicate that the envelope sender, &'From:'& header, and
35454 &'To:'& header have been rewritten, the last one because routing expanded the
35455 unqualified domain &'foundation'&.
35456 .ecindex IIDforspo1
35457 .ecindex IIDforspo2
35458 .ecindex IIDforspo3
35459
35460 . ////////////////////////////////////////////////////////////////////////////
35461 . ////////////////////////////////////////////////////////////////////////////
35462
35463 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHID12" &&&
35464          "DKIM Support"
35465 .cindex "DKIM"
35466
35467 DKIM is a mechanism by which messages sent by some entity can be provably
35468 linked to a domain which that entity controls.  It permits reputation to
35469 be tracked on a per-domain basis, rather than merely upon source IP address.
35470 DKIM is documented in RFC 4871.
35471
35472 Since version 4.70, DKIM support is compiled into Exim by default. It can be
35473 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
35474
35475 Exim's DKIM implementation allows to
35476 .olist
35477 Sign outgoing messages: This function is implemented in the SMTP transport.
35478 It can co-exist with all other Exim features, including transport filters.
35479 .next
35480 Verify signatures in incoming messages: This is implemented by an additional
35481 ACL (acl_smtp_dkim), which can be called several times per message, with
35482 different signature contexts.
35483 .endlist
35484
35485 In typical Exim style, the verification implementation does not include any
35486 default "policy". Instead it enables you to build your own policy using
35487 Exim's standard controls.
35488
35489 Please note that verification of DKIM signatures in incoming mail is turned
35490 on by default for logging purposes. For each signature in incoming email,
35491 exim will log a line displaying the most important signature details, and the
35492 signature status. Here is an example (with line-breaks added for clarity):
35493 .code
35494 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
35495     d=facebookmail.com s=q1-2009b
35496     c=relaxed/relaxed a=rsa-sha1
35497     i=@facebookmail.com t=1252484542 [verification succeeded]
35498 .endd
35499 You might want to turn off DKIM verification processing entirely for internal
35500 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
35501 control modifier. This should typically be done in the RCPT ACL, at points
35502 where you accept mail from relay sources (internal hosts or authenticated
35503 senders).
35504
35505
35506 .section "Signing outgoing messages" "SECID513"
35507 .cindex "DKIM" "signing"
35508
35509 Signing is implemented by setting private options on the SMTP transport.
35510 These options take (expandable) strings as arguments.
35511
35512 .option dkim_domain smtp string&!! unset
35513 MANDATORY:
35514 The domain you want to sign with. The result of this expanded
35515 option is put into the &%$dkim_domain%& expansion variable.
35516
35517 .option dkim_selector smtp string&!! unset
35518 MANDATORY:
35519 This sets the key selector string. You can use the &%$dkim_domain%& expansion
35520 variable to look up a matching selector. The result is put in the expansion
35521 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
35522 option along with &%$dkim_domain%&.
35523
35524 .option dkim_private_key smtp string&!! unset
35525 MANDATORY:
35526 This sets the private key to use. You can use the &%$dkim_domain%& and
35527 &%$dkim_selector%& expansion variables to determine the private key to use.
35528 The result can either
35529 .ilist
35530 be a valid RSA private key in ASCII armor, including line breaks.
35531 .next
35532 start with a slash, in which case it is treated as a file that contains
35533 the private key.
35534 .next
35535 be "0", "false" or the empty string, in which case the message will not
35536 be signed. This case will not result in an error, even if &%dkim_strict%&
35537 is set.
35538 .endlist
35539
35540 .option dkim_canon smtp string&!! unset
35541 OPTIONAL:
35542 This option sets the canonicalization method used when signing a message.
35543 The DKIM RFC currently supports two methods: "simple" and "relaxed".
35544 The option defaults to "relaxed" when unset. Note: the current implementation
35545 only supports using the same canonicalization method for both headers and body.
35546
35547 .option dkim_strict smtp string&!! unset
35548 OPTIONAL:
35549 This  option  defines  how  Exim  behaves  when  signing a message that
35550 should be signed fails for some reason.  When the expansion evaluates to
35551 either "1" or "true", Exim will defer. Otherwise Exim will send the message
35552 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
35553 variables here.
35554
35555 .option dkim_sign_headers smtp string&!! unset
35556 OPTIONAL:
35557 When set, this option must expand to (or be specified as) a colon-separated
35558 list of header names. Headers with these names will be included in the message
35559 signature. When unspecified, the header names recommended in RFC4871 will be
35560 used.
35561
35562
35563 .section "Verifying DKIM signatures in incoming mail" "SECID514"
35564 .cindex "DKIM" "verification"
35565
35566 Verification of DKIM signatures in incoming email is implemented via the
35567 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
35568 syntactically(!) correct signature in the incoming message.
35569
35570 To evaluate the signature in the ACL a large number of expansion variables
35571 containing the signature status and its details are set up during the
35572 runtime of the ACL.
35573
35574 Calling the ACL only for existing signatures is not sufficient to build
35575 more advanced policies. For that reason, the global option
35576 &%dkim_verify_signers%&, and a global expansion variable
35577 &%$dkim_signers%& exist.
35578
35579 The global option &%dkim_verify_signers%& can be set to a colon-separated
35580 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
35581 called. It is expanded when the message has been received. At this point,
35582 the expansion variable &%$dkim_signers%& already contains a colon-separated
35583 list of signer domains and identities for the message. When
35584 &%dkim_verify_signers%& is not specified in the main configuration,
35585 it defaults as:
35586 .code
35587 dkim_verify_signers = $dkim_signers
35588 .endd
35589 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
35590 DKIM signature in the message. Current DKIM verifiers may want to explicitly
35591 call the ACL for known domains or identities. This would be achieved as follows:
35592 .code
35593 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
35594 .endd
35595 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
35596 and "ebay.com", plus all domains and identities that have signatures in the message.
35597 You can also be more creative in constructing your policy. For example:
35598 .code
35599 dkim_verify_signers = $sender_address_domain:$dkim_signers
35600 .endd
35601
35602 If a domain or identity is listed several times in the (expanded) value of
35603 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
35604
35605
35606 Inside the &%acl_smtp_dkim%&, the following expansion variables are
35607 available (from most to least important):
35608
35609
35610 .vlist
35611 .vitem &%$dkim_cur_signer%&
35612 The signer that is being evaluated in this ACL run. This can be a domain or
35613 an identity. This is one of the list items from the expanded main option
35614 &%dkim_verify_signers%& (see above).
35615 .vitem &%$dkim_verify_status%&
35616 A string describing the general status of the signature. One of
35617 .ilist
35618 &%none%&: There is no signature in the message for the current domain or
35619 identity (as reflected by &%$dkim_cur_signer%&).
35620 .next
35621 &%invalid%&: The signature could not be verified due to a processing error.
35622 More detail is available in &%$dkim_verify_reason%&.
35623 .next
35624 &%fail%&: Verification of the signature failed.  More detail is
35625 available in &%$dkim_verify_reason%&.
35626 .next
35627 &%pass%&: The signature passed verification. It is valid.
35628 .endlist
35629 .vitem &%$dkim_verify_reason%&
35630 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
35631 "fail" or "invalid". One of
35632 .ilist
35633 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
35634 key for the domain could not be retrieved. This may be a temporary problem.
35635 .next
35636 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
35637 record for the domain is syntactically invalid.
35638 .next
35639 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
35640 body hash does not match the one specified in the signature header. This
35641 means that the message body was modified in transit.
35642 .next
35643 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
35644 could not be verified. This may mean that headers were modified,
35645 re-written or otherwise changed in a way which is incompatible with
35646 DKIM verification. It may of course also mean that the signature is forged.
35647 .endlist
35648 .vitem &%$dkim_domain%&
35649 The signing domain. IMPORTANT: This variable is only populated if there is
35650 an actual signature in the message for the current domain or identity (as
35651 reflected by &%$dkim_cur_signer%&).
35652 .vitem &%$dkim_identity%&
35653 The signing identity, if present. IMPORTANT: This variable is only populated
35654 if there is an actual signature in the message for the current domain or
35655 identity (as reflected by &%$dkim_cur_signer%&).
35656 .vitem &%$dkim_selector%&
35657 The key record selector string.
35658 .vitem &%$dkim_algo%&
35659 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
35660 .vitem &%$dkim_canon_body%&
35661 The body canonicalization method. One of 'relaxed' or 'simple'.
35662 .vitem &%dkim_canon_headers%&
35663 The header canonicalization method. One of 'relaxed' or 'simple'.
35664 .vitem &%$dkim_copiedheaders%&
35665 A transcript of headers and their values which are included in the signature
35666 (copied from the 'z=' tag of the signature).
35667 .vitem &%$dkim_bodylength%&
35668 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
35669 limit was set by the signer, "9999999999999" is returned. This makes sure
35670 that this variable always expands to an integer value.
35671 .vitem &%$dkim_created%&
35672 UNIX timestamp reflecting the date and time when the signature was created.
35673 When this was not specified by the signer, "0" is returned.
35674 .vitem &%$dkim_expires%&
35675 UNIX timestamp reflecting the date and time when the signer wants the
35676 signature to be treated as "expired". When this was not specified by the
35677 signer, "9999999999999" is returned. This makes it possible to do useful
35678 integer size comparisons against this value.
35679 .vitem &%$dkim_headernames%&
35680 A colon-separated list of names of headers included in the signature.
35681 .vitem &%$dkim_key_testing%&
35682 "1" if the key record has the "testing" flag set, "0" if not.
35683 .vitem &%$nosubdomains%&
35684 "1" if the key record forbids subdomaining, "0" otherwise.
35685 .vitem &%$dkim_key_srvtype%&
35686 Service type (tag s=) from the key record. Defaults to "*" if not specified
35687 in the key record.
35688 .vitem &%$dkim_key_granularity%&
35689 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
35690 in the key record.
35691 .vitem &%$dkim_key_notes%&
35692 Notes from the key record (tag n=).
35693 .endlist
35694
35695 In addition, two ACL conditions are provided:
35696
35697 .vlist
35698 .vitem &%dkim_signers%&
35699 ACL condition that checks a colon-separated list of domains or identities
35700 for a match against the domain or identity that the ACL is currently verifying
35701 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
35702 verb to a group of domains or identities. For example:
35703
35704 .code
35705 # Warn when Mail purportedly from GMail has no signature at all
35706 warn log_message = GMail sender without DKIM signature
35707      sender_domains = gmail.com
35708      dkim_signers = gmail.com
35709      dkim_status = none
35710 .endd
35711
35712 .vitem &%dkim_status%&
35713 ACL condition that checks a colon-separated list of possible DKIM verification
35714 results agains the actual result of verification. This is typically used
35715 to restrict an ACL verb to a list of verification outcomes, for example:
35716
35717 .code
35718 deny message = Mail from Paypal with invalid/missing signature
35719      sender_domains = paypal.com:paypal.de
35720      dkim_signers = paypal.com:paypal.de
35721      dkim_status = none:invalid:fail
35722 .endd
35723
35724 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
35725 see the documentation of the &%$dkim_verify_status%& expansion variable above
35726 for more information of what they mean.
35727 .endlist
35728
35729 . ////////////////////////////////////////////////////////////////////////////
35730 . ////////////////////////////////////////////////////////////////////////////
35731
35732 .chapter "Adding new drivers or lookup types" "CHID13" &&&
35733          "Adding drivers or lookups"
35734 .cindex "adding drivers"
35735 .cindex "new drivers, adding"
35736 .cindex "drivers" "adding new"
35737 The following actions have to be taken in order to add a new router, transport,
35738 authenticator, or lookup type to Exim:
35739
35740 .olist
35741 Choose a name for the driver or lookup type that does not conflict with any
35742 existing name; I will use &"newdriver"& in what follows.
35743 .next
35744 Add to &_src/EDITME_& the line:
35745 .display
35746 <&'type'&>&`_NEWDRIVER=yes`&
35747 .endd
35748 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
35749 code is not to be included in the binary by default, comment this line out. You
35750 should also add any relevant comments about the driver or lookup type.
35751 .next
35752 Add to &_src/config.h.defaults_& the line:
35753 .code
35754 #define <type>_NEWDRIVER
35755 .endd
35756 .next
35757 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
35758 and create a table entry as is done for all the other drivers and lookup types.
35759 .next
35760 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
35761 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
35762 driver or lookup type and add it to the definition of OBJ.
35763 .next
35764 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
35765 &_src_&.
35766 .next
35767 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
35768 as for other drivers and lookups.
35769 .endlist
35770
35771 Then all you need to do is write the code! A good way to start is to make a
35772 proforma by copying an existing module of the same type, globally changing all
35773 occurrences of the name, and cutting out most of the code. Note that any
35774 options you create must be listed in alphabetical order, because the tables are
35775 searched using a binary chop procedure.
35776
35777 There is a &_README_& file in each of the sub-directories of &_src_& describing
35778 the interface that is expected.
35779
35780
35781
35782
35783 . ////////////////////////////////////////////////////////////////////////////
35784 . ////////////////////////////////////////////////////////////////////////////
35785
35786 . /////////////////////////////////////////////////////////////////////////////
35787 . These lines are processing instructions for the Simple DocBook Processor that
35788 . Philip Hazel has developed as a less cumbersome way of making PostScript and
35789 . PDFs than using xmlto and fop. They will be ignored by all other XML
35790 . processors.
35791 . /////////////////////////////////////////////////////////////////////////////
35792
35793 .literal xml
35794 <?sdop
35795   format="newpage"
35796   foot_right_recto="&chaptertitle;"
35797   foot_right_verso="&chaptertitle;"
35798 ?>
35799 .literal off
35800
35801 .makeindex "Options index"   "option"
35802 .makeindex "Variables index" "variable"
35803 .makeindex "Concept index"   "concept"
35804
35805
35806 . /////////////////////////////////////////////////////////////////////////////
35807 . /////////////////////////////////////////////////////////////////////////////